LangSmith 会在移除 API 端点和 SDK 方法之前先将其弃用,以便你有时间迁移到替代方案。本页面介绍弃用通知的发布方式,以及弃用内容会继续获得支持的时长。
此政策仅适用于 LangSmith API 参考 和 Agent Server API 参考 中记录的公共端点。内部的未公开端点不在此政策范围内,可能会随时发生变化,包括进行不兼容变更。

弃用生命周期

每次弃用都会经历相同的阶段:
  1. 已公告:弃用信息会发布在变更日志中,并注明移除日期(如果已确定);如果需要修改调用方代码,还会发布迁移指南,说明替代方案。
  2. 已标记:已弃用的 API 端点会返回 Deprecation: true 和 Sunset: <date> 响应标头。已弃用的 SDK 方法会在文档中标明,并且在支持的情况下,会在调用时发出弃用警告。
  3. 受支持:已弃用的端点会继续运行一段最低期限,该期限取决于你的部署方式。请参阅不同部署方式的弃用窗口。
  4. 已移除:支持期限结束后,该端点将被移除。
在云端部署中,如果临近移除日期时仍有活跃使用者,LangSmith 可能会对已弃用的端点实施速率限制并增加延迟,同时对部分请求返回明确的错误消息,以此作为最后手段,在移除前提醒仍在使用该端点的用户。受影响的客户会提前收到直接通知。

不同部署方式的弃用窗口

自托管主要版本大约每六周发布一次。详情请参阅发布政策。

SDK 方法弃用

大多数 SDK 方法都是 API 端点的简单封装,因此方法会与其调用的端点按照相同的时间线弃用,并在端点移除时从 SDK 中移除。 如果某个方法不与单个端点一一对应,或者该方法的弃用独立于任何端点变更,则其弃用时间线可能不同。此类弃用会在两个位置明确公告:在 SDK 中通过文档和弃用警告进行说明,在 API 中则按照上述流程处理。

字段级别的弃用

已弃用的字段会在版本边界处移除,而不是在某个日期移除:
  • API 字段和参数:已弃用的响应字段、请求正文字段或查询参数,在同一端点版本中会继续工作。移除属于不兼容变更,因此只能随下一个端点版本发布,例如从 v1 升级到 v2。
  • SDK 方法字段和参数:在当前 SDK 主要版本中会继续工作。移除需要发布新的 SDK 主要版本,与 API 自身的版本控制相互独立。

另请参阅

  • 变更日志,查看 LangSmith 的最新更新
  • 发布阶段,了解功能如何从 alpha 发展到 GA
  • 发布政策,了解自托管发布渠道、发布节奏和版本支持情况