主题
API 和 SDK 弃用政策
介绍 LangSmith 如何在 Cloud 和自托管部署中弃用并移除 API 端点和 SDK 方法。
LangSmith 会先弃用 API 端点和 SDK 方法，然后再将其移除，以便你有时间迁移到替代方案。本页介绍弃用的公布方式以及弃用后仍受支持的时长。
NOTE
本政策仅适用于 LangSmith API 参考和 Agent Server API 参考中记录的公共端点。内部未记录的端点不在覆盖范围内，可能随时更改，包括发生破坏性更改。
弃用生命周期
每次弃用都遵循相同的阶段：
- 已公布：弃用信息会发布在变更日志中，并在已知时附上移除日期；在需要更改调用方代码时，还会发布迁移指南说明替代方案。
- 已标记：被弃用的 API 端点会返回
Deprecation: true和Sunset: <date>响应头。被弃用的 SDK 方法会在文档中标记，并在支持的情况下于调用时发出弃用警告。 - 受支持：被弃用的端点会在最短窗口期内继续工作，该窗口期取决于你的部署方式。请参阅按部署方式划分的弃用窗口。
- 已移除：支持窗口结束后，端点将被移除。
在 Cloud 中，如果在接近移除日期时仍有活跃使用者，LangSmith 可能会对被弃用的端点施加速率限制并增加延迟，还会对一部分请求返回明确的错误消息，作为移除前引起剩余使用者注意的最后手段。受影响的客户会提前收到直接联系。
按部署方式划分的弃用窗口
| 部署方式 | 最短支持窗口 |
|---|---|
| Cloud | 从公布到移除 6 个月 |
| 自托管 | 至少一个主要版本 |
自托管主要版本大约每六周发布一次。详情请参阅发布政策。
SDK 方法弃用
大多数 SDK 方法都是 API 端点的薄封装，因此方法的弃用时间线与它所调用的端点相同，并在端点移除时从 SDK 中移除。
与端点并非一一对应，或独立于任何端点变更而弃用的方法，可能具有不同的弃用时间线。此类弃用会在两处明确公布：在 SDK 中通过文档和弃用警告公布，在 API 中则通过上述流程公布。
字段级弃用
被弃用的字段会在版本边界移除，而不是按日期移除：
- API 字段和参数：被弃用的响应字段、请求体字段或查询参数在同一端点版本内继续有效。移除属于破坏性更改，因此只会随下一个端点版本发布，例如从 v1 到 v2。
- SDK 方法字段和参数：在当前主要 SDK 版本内继续有效。移除需要新的主要 SDK 版本，与 API 自身的版本管理无关。