首页SDK

SDK

继续使用团队已经熟悉的客户端。

Octoryn 面向 OpenAI SDK 及其他支持兼容 base URL 的客户端设计。开始接入不需要 Octoryn 专属包,本指南也不会声称已经发布不存在的自有 SDK。

01PythonOpenAI 客户端兼容
02TypeScriptOpenAI 客户端兼容
03HTTP直接兼容接入
01

配置,而不是重写。

将兼容客户端 base URL 设置为 https://api.octoryn.dev/v1,并提供对应环境的 API key。客户端其余生命周期仍由应用负责。

  • 使用团队已经批准的 OpenAI SDK 版本展开详情

    这是「配置,而不是重写。」能力的一部分。Octoryn 会把配置、执行结果与相关路由上下文保留在同一条受治理链路中,便于团队独立验证和审查。

    查看实现文档
  • 从受保护的运行环境加载 API key展开详情

    这是「配置,而不是重写。」能力的一部分。Octoryn 会把配置、执行结果与相关路由上下文保留在同一条受治理链路中,便于团队独立验证和审查。

    查看实现文档
  • 让应用掌控网络超时展开详情

    这是「配置,而不是重写。」能力的一部分。Octoryn 会把配置、执行结果与相关路由上下文保留在同一条受治理链路中,便于团队独立验证和审查。

    查看实现文档
02

在 Python 中沿用同一模式。

Python 服务可以为 OpenAI 官方客户端配置 Octoryn base URL 与凭证。请求字段仍需符合所选路由支持的能力。

  • 根据应用生命周期创建适当作用域的客户端展开详情

    这是「在 Python 中沿用同一模式。」能力的一部分。Octoryn 会把配置、执行结果与相关路由上下文保留在同一条受治理链路中,便于团队独立验证和审查。

    查看实现文档
  • 传入符合条件的模型或稳定策略别名展开详情

    这是「在 Python 中沿用同一模式。」能力的一部分。Octoryn 会把配置、执行结果与相关路由上下文保留在同一条受治理链路中,便于团队独立验证和审查。

    查看实现文档
  • 按客户端指引关闭或复用网络资源展开详情

    这是「在 Python 中沿用同一模式。」能力的一部分。Octoryn 会把配置、执行结果与相关路由上下文保留在同一条受治理链路中,便于团队独立验证和审查。

    查看实现文档
03

在 TypeScript 中沿用同一模式。

服务端 TypeScript 可以在兼容模式下配置 OpenAI 客户端。Router 凭证应留在服务端,不能通过客户端应用代码暴露。

  • 在可信的服务端运行环境中实例化客户端展开详情

    这是「在 TypeScript 中沿用同一模式。」能力的一部分。Octoryn 会把配置、执行结果与相关路由上下文保留在同一条受治理链路中,便于团队独立验证和审查。

    查看实现文档
  • 避免在浏览器 JavaScript 中交付 API key展开详情

    这是「在 TypeScript 中沿用同一模式。」能力的一部分。Octoryn 会把配置、执行结果与相关路由上下文保留在同一条受治理链路中,便于团队独立验证和审查。

    查看实现文档
  • 通过外围运行时处理取消与超时展开详情

    这是「在 TypeScript 中沿用同一模式。」能力的一部分。Octoryn 会把配置、执行结果与相关路由上下文保留在同一条受治理链路中,便于团队独立验证和审查。

    查看实现文档
04

需要时直接通过 HTTP 接入。

无法使用 OpenAI SDK 的服务可以采用兼容 HTTP 接入。遵循带认证的 JSON 契约,并且仅在路由和客户端都支持时实现流式解析。

  • 通过 TLS 发送 Bearer 令牌认证展开详情

    这是「需要时直接通过 HTTP 接入。」能力的一部分。Octoryn 会把配置、执行结果与相关路由上下文保留在同一条受治理链路中,便于团队独立验证和审查。

    查看实现文档
  • 明确设置内容类型与请求截止时间展开详情

    这是「需要时直接通过 HTTP 接入。」能力的一部分。Octoryn 会把配置、执行结果与相关路由上下文保留在同一条受治理链路中,便于团队独立验证和审查。

    查看实现文档
  • 将流式事件按增量解析,而不是当成单个 JSON 文档展开详情

    这是「需要时直接通过 HTTP 接入。」能力的一部分。Octoryn 会把配置、执行结果与相关路由上下文保留在同一条受治理链路中,便于团队独立验证和审查。

    查看实现文档
05

固定版本并测试客户端边界。

把客户端库升级视作应用变更。交付流程需要可复现时应固定版本,并在发布前测试兼容性、流式响应和错误路径。

  • 在 CI 或预生产执行非流式请求展开详情

    这是「固定版本并测试客户端边界。」能力的一部分。Octoryn 会把配置、执行结果与相关路由上下文保留在同一条受治理链路中,便于团队独立验证和审查。

    查看实现文档
  • 测试取消、超时与限流处理展开详情

    这是「固定版本并测试客户端边界。」能力的一部分。Octoryn 会把配置、执行结果与相关路由上下文保留在同一条受治理链路中,便于团队独立验证和审查。

    查看实现文档
  • 升级前阅读上游 SDK Release Notes展开详情

    这是「固定版本并测试客户端边界。」能力的一部分。Octoryn 会把配置、执行结果与相关路由上下文保留在同一条受治理链路中,便于团队独立验证和审查。

    查看实现文档

OCTORYN ROUTER

查看完整接入契约。

结合所选 SDK 阅读 API Reference,并在生产发布前验证路由能力支持。

阅读 API Reference