Skip to main content
我们的开源版本号遵循以下格式：主版本.次版本.补丁版本，如 语义化版本控制 中定义。
  • 主版本：需要代码更改的重大 API 更新。
  • 次版本：保持向后兼容的新功能和改进。
  • 补丁版本：错误修复和小改进。
例如：
  • 1.0.0：第一个稳定版本，具有生产就绪的 API。
  • 1.1.0：以向后兼容的方式添加新功能。
  • 1.0.1：向后兼容的错误修复。

​
API 稳定性

我们通过以下方式传达 API 的稳定性：

​
稳定 API

所有没有特殊前缀的 API 都被认为是稳定的，可以用于生产环境。我们会维护稳定功能的向后兼容性，仅在主要版本发布中引入重大更改。

​
Beta API

标记为 beta 的 API 功能完整，但可能会根据用户反馈进行小幅更改。它们适合用于生产，但未来版本可能需要进行小调整。

​
Alpha API

标记为 alpha 的 API 是实验性的，可能会发生重大更改。在生产环境中使用这些 API 时需谨慎。

​
弃用 API

标记为 deprecated 的 API 将在未来的主要版本中移除。可能的话，我们会指定移除的目标版本。处理弃用的方法：
  1. 切换到推荐的替代 API。
  2. 遵循迁移指南（与主要版本一起发布）。
  3. 在可用时使用自动迁移工具。

​
内部 API

某些 API 通过以下方式明确标记为“内部”：
  • 某些文档提到内部内容并将其标记为内部。如果文档中提到某些内容是内部的，则可能会发生更改。
  • 函数、方法和其他对象以单个下划线（_）为前缀。这是 Python 的标准约定，表示某些内容是私有的；如果任何方法以单个 _ 开头，则它是内部 API。
    • 例外情况：某些方法以 _ 为前缀，但不包含实现。这些方法旨在由提供实现的子类覆盖。这些方法通常是 LangChain 的 公共 API 的一部分。

​
发布周期

<userPrompt>
Provide the fully rewritten file, incorporating the suggested code change. You must produce the complete file.
</userPrompt>