SDK · 接入
OpenAI SDK 接入 Tikway:Python 与 Node.js 配置指南
更新日期:
如果应用已经使用 OpenAI SDK,可以先保留 SDK 和业务代码,为客户端设置 Tikway 的请求地址、Key 与目录中的模型 ID。本文以 Chat Completions 文本请求为例;切换地址后仍需要核对参数和返回格式,不能直接推定 Responses、工具调用或图像接口都已兼容。
1. 接入前准备
在模型目录选择支持 OpenAI 协议和 Chat Completions 的文本型号,复制完整模型 ID。从控制台创建自己的 Tikway API Key。这里使用的地址是 https://api.tikway.ai/v1,SDK 会追加 /chat/completions,得到完整路径 /v1/chat/completions。
不要把完整 /v1/chat/completions 填进 SDK 的基础地址,也不要把 OpenAI 官方账户的 Key 当作 Tikway Key。以下命令适用于 Bash、macOS、Linux 或 WSL;在 Windows PowerShell 中可用 $env:TIKWAY_API_KEY='你的 Key' 和 $env:TIKWAY_MODEL='目录中的模型 ID' 设置当前会话环境。
export TIKWAY_API_KEY='替换为你的 Tikway API Key'
export TIKWAY_MODEL='替换为目录中的完整模型 ID'
2. Python 示例
在自己的应用虚拟环境中安装 openai:
python -m pip install openai
保存为 sdk_chat.py,执行会发送真实模型请求并按适用规则计费。API Key 只从环境变量读取。
import os
from openai import OpenAI
client = OpenAI(
api_key=os.environ["TIKWAY_API_KEY"],
base_url="https://api.tikway.ai/v1",
timeout=60.0,
max_retries=0,
)
response = client.chat.completions.create(
model=os.environ["TIKWAY_MODEL"],
messages=[{"role": "user", "content": "只回复 OK"}],
)
print(response.choices[0].message.content)
print(response.usage)
python sdk_chat.py
3. Node.js 示例
在自己的 Node.js 项目中安装 SDK,然后保存代码为 sdk_chat.mjs。本例使用 ESM:
npm install openai
import OpenAI from 'openai'
if (!process.env.TIKWAY_API_KEY || !process.env.TIKWAY_MODEL) {
throw new Error('请先设置 TIKWAY_API_KEY 和 TIKWAY_MODEL')
}
const client = new OpenAI({
apiKey: process.env.TIKWAY_API_KEY,
baseURL: 'https://api.tikway.ai/v1',
timeout: 60000,
maxRetries: 0
})
const response = await client.chat.completions.create({
model: process.env.TIKWAY_MODEL,
messages: [{ role: 'user', content: '只回复 OK' }]
})
console.log(response.choices[0].message.content)
console.log(response.usage)
node sdk_chat.mjs
这里关闭 SDK 自动重试是为了方便定位首次请求。正式应用应根据错误种类设置有限重试;客户端超时不代表服务端未处理请求。
4. 怎么确认切换成功?
核对实际请求域名、客户端显式设置的地址和模型 ID,再查看同一时间的 Tikway 调用记录。记录中的模型、协议、Token 用量与费用用于核对本次请求;一条文本回答不能证明客户端所有功能均可用。
需要流式输出时,先阅读Node.js SSE 解析教程。需要工具调用时,独立测试工具定义、返回参数和工具结果回传;需要 Responses 时,先确认所选型号的端点。
5. 常见问题
更换地址后为什么仍返回 401? 检查实际使用的是哪一个 Key,以及 SDK 实例是否仍读取旧配置。参考401 排查。
能不能直接复制别家的模型名? 应复制 Tikway 目录中的完整 ID。营销名称、官方 ID 与网关 ID 可能不同,不能自行增删前缀。
不用 SDK 可以调用吗? 可以。已有Python 标准库教程不需要第三方 Python 包。
预算如何估算? 使用免费 Token 费用计算器,再用实际 usage 与调用记录复算。