本指南涵盖了数据达到LangSmith云服务器后可用的各种功能,以帮助您实现隐私目标。
数据保留
LangSmith 提供自动数据保留功能,以帮助符合规范和存储管理。数据保留策略可以在组织和项目级别进行配置。
有关数据保留配置和管理的详细信息,请参阅数据保留概念文档。
跟踪删除
您可以使用API完成跟踪删除。API支持两种删除跟踪的方法:
- 通过跟踪ID和会话ID:通过提供跟踪ID及其对应的会话ID列表(每个请求最多1000个跟踪)来删除特定的跟踪
- 通过元数据:删除与指定元数据键值对匹配的工作空间中的跟踪
有关更多详细信息,请参阅API规范。
所有痕迹删除将删除相关的实体,如反馈、聚合和统计信息,这些信息将跨所有数据存储进行删除。
删除时间表
追踪删除在非高峰使用时间处理,通常不是即时完成,通常需要几小时。没有删除确认——您需要再次查询数据以验证其已被删除。
删除特定痕迹
从单个会话中通过跟踪ID删除特定跟踪:
curl -X POST "https://api.smith.langchain.com/api/v1/runs/delete" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"run_ids": ["trace-id-1", "trace-id-2", "trace-id-3"],
"session_id": "session-id-1"
}'
根据元数据删除
当按元数据删除时:
- 接受一个
metadata 对象,包含键/值对。键值对匹配使用 或 条件。如果跟踪信息包含元数据中指定的任意一个键值对(不一定是所有),则匹配成功。
- 当通过元数据删除时,无需指定会话 ID。删除操作将应用于整个工作区。
根据工作空间中的元数据删除痕迹(匹配任何元数据键值对):
curl -X POST "https://api.smith.langchain.com/api/v1/runs/delete" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"metadata": {
"user_id": "user123",
"environment": "staging"
}
}'
这将删除其元数据中包含 user_id: "user123" 或 environment: "staging" 的痕迹。
请记住,每个会话每个请求最多只能安排1000个跟踪。对于更大的删除操作,您需要发起多个请求。
示例删除
您可以通过我们的API自助删除数据集示例,该API支持软删除和硬删除两种方法,具体取决于您的数据保留需求。
硬删除将永久从整个数据集历史中指定示例的所有版本中删除输入、输出和元数据。
删除示例是一个两步过程
对于批量操作,例如删除操作遵循两步流程:
1. 通过元数据搜索示例
在所有工作区数据集中查找所有具有匹配元数据的示例。
获取 /examples
as_of 必须明确指定为时间戳。只有创建于 as_of 日期之前的示例将被返回
curl -X GET "https://api.smith.langchain.com/api/v1/examples?as_of=2024-01-01T00:00:00Z" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"metadata": {
"user_id": "user123",
"environment": "staging"
}
}'
这将返回在其元数据中包含 user_id: "user123" 或 environment: "staging" 的示例,这些示例位于您工作区中的所有数据集中。
2. 强制删除示例
一旦获取到示例ID,发送删除请求。这将清除该示例数据集所有版本的输入、输出和元数据。
删除 /examples
- 指定示例ID并添加
"hard_delete": true 到请求的查询参数中
curl -X DELETE "https://api.smith.langchain.com/api/v1/examples?hard_delete=true" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"example_ids": ["example-id-1", "example-id-2", "example-id-3"]
}'
删除类型
软删除(默认)
- 在数据集中创建具有 NULL 输入/输出的 tombstoned 条目
- 保留历史数据并维护数据集版本控制
- 仅影响数据集的当前版本
硬删除
- 永久删除所有数据集版本中的输入、输出和元数据
- 当合规性要求所有版本归零时,完成数据删除
- 将
"hard_delete": true 添加到查询参数中
有关更多详细信息,请参阅API规范。