以编程方式使用文档

本指南涵盖了数据到达 LangSmith Cloud 服务器后可用的各种功能,帮助您实现隐私目标。

数据保留

LangSmith 提供自动数据保留功能,以帮助实现合规性和存储管理。数据保留策略可在两个级别配置:

  • 工作区级别:具有所需权限的企业客户可以将扩展保留设置为工作区默认值,并自定义保留期限(最长 400 天)。请参阅 自定义扩展保留策略.
  • 项目级别:具有所需权限的客户可以为每个追踪项目设置默认保留层级,在基础保留(14 天)或扩展保留(400 天)之间选择。请参阅 更改项目级默认保留.

有关数据保留配置和管理的详细信息,请参阅 数据保留概念 documentation.

自定义扩展保留策略

企业版 客户可以在 工作区 级别自定义追踪的扩展数据保留期限,以满足特定合规要求。默认情况下,扩展保留设置为 400 天,但您可以根据组织需求进行调整。保留期限的更改仅适用于新的追踪。

配置扩展保留

组织管理员和操作员(organization:manage)可以为任何工作区配置保留期。工作区管理员可以配置自己的工作区(workspaces:manage)。有关完整权限参考,请参阅 组织和workspace操作.

UI

LangSmith UI:

1. 导航至 **设置** 在页面底部。 1. 从左侧菜单中选择 **用量配置** 。 1. 在列表中找到您想要配置的工作区。 1. 点击该工作区 **数据保留策略** 列下的值。 1. 在 **workspace用量配置** 模态框中,使用 **扩展 - 所有追踪保留** 选项的下拉菜单自定义扩展策略。可用期限为:30天、60天、90天、120天、150天、180天、240天、300天、365天和400天。 1. 选择 **保存**.

API

读取当前设置:

组织级别 (organization:manage)

    curl -X GET "https://api.smith.langchain.com/api/v1/orgs/ttl-settings" \
      -H "x-api-key: YOUR_API_KEY"
    

工作区级别 (workspaces:manage)

    curl -X GET "https://api.smith.langchain.com/api/v1/ttl-settings" \
      -H "x-api-key: YOUR_API_KEY"
    

要更新保留期,请设置 resource_type to "run" 用于追踪和 ttl_days 为您期望的持续时间。可用的持续时间为:30、60、90、120、150、180、240、300、365 和 400 天。

组织级别 (organization:manage)

    curl -X PUT "https://api.smith.langchain.com/api/v1/orgs/ttl-settings" \
      -H "x-api-key: YOUR_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{"resource_type": "run", "ttl_days": 90}'
    

工作区级别 (workspaces:manage)

    curl -X PUT "https://api.smith.langchain.com/api/v1/ttl-settings" \
      -H "x-api-key: YOUR_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{"resource_type": "run", "ttl_days": 90}'
    

自托管的工作区级扩展保留

Self-hosted 企业版 客户也可以使用工作区级扩展保留配置,而不是系统范围的 TTL 设置。这可以更精细地控制不同工作区的数据保留,而无需更改环境变量。

要为自托管部署配置此功能,请参阅 自托管 TTL 文档 了解传统的系统范围方法或联系 支持.

追踪删除

您可以使用 API 完成追踪删除。该 API 支持两种删除追踪的方法:

  1. **按追踪 ID 和会话 ID**:通过提供追踪 ID 列表及其对应的会话 ID 删除特定追踪(每次请求最多 1000 条追踪)
  2. **按元数据**:删除与指定元数据键值对匹配的工作区中的追踪

更多详情请参阅 API 规范.

删除时间线

追踪删除在非高峰使用时间处理,不会立即执行。LangChain 在周末运行删除任务。删除没有确认——您需要再次查询数据以验证它已被删除。

删除特定追踪

要从单个会话中按追踪 ID 删除特定追踪:

curl -X POST "https://api.smith.langchain.com/api/v1/runs/delete" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "trace_ids": ["trace-id-1", "trace-id-2", "trace-id-3"],
    "session_id": "session-id-1"
  }'

删除示例

您可以通过我们的 API 自助删除数据集示例,该 API 支持软删除和硬删除两种方法,具体取决于您的数据保留需求。

删除示例是一个两步过程

对于批量操作,示例删除遵循两步过程:

1. 按元数据搜索示例

在工作区中跨所有数据集查找具有匹配元数据的所有示例。

GET /examples

  • - as_of 必须显式指定为时间戳。仅返回在 as_of 之前创建的示例
curl -X GET "https://api.smith.langchain.com/api/v1/examples?as_of=2024-01-01T00:00:00Z" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "metadata": {
      "user_id": "user123",
      "environment": "staging"
    }
  }'

这将返回在您工作区中所有数据集的元数据中具有 user_id: "user123" **or** environment: "staging" 的示例。

2. 硬删除示例

获取示例 ID 后,发送删除请求。这将从该示例的所有数据集版本中清除输入、输出和元数据。

POST /v1/platform/datasets/examples/delete/

  • - 在请求正文中指定 example_ids (示例 ID 列表)和 hard_delete (布尔值)
curl -X POST "https://api.smith.langchain.com/v1/platform/datasets/examples/delete/" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "example_ids": ["example-id-1", "example-id-2", "example-id-3"],
    "hard_delete": true
  }'

删除类型

软删除(默认)

  • - Creates tombstoned entries with NULL inputs/outputs in the dataset
  • - 保留历史数据并维护数据集版本控制
  • - 仅影响数据集的当前版本

硬删除

  • - 从所有数据集版本中永久删除输入、输出和元数据
  • - 当合规性要求在所有版本中完全清除数据时进行完整数据删除
  • - 在请求正文中设置 "hard_delete": true 参数