~/docs/getting-started/sdk/

SDK 接入

蜀农 API 兼容 OpenAI API,因此可以优先使用 OpenAI 官方 SDK,并通过 base_url 指向蜀农 API。

Python

pip install -U openai
import os
from openai import OpenAI

client = OpenAI(
    api_key=os.environ["SHUNONG_API_KEY"],
    base_url="https://ai.agriwis.com/api/v1",
)

response = client.chat.completions.create(
    model="auto",
    messages=[{"role": "user", "content": "你好"}],
)
print(response.choices[0].message.content)

JavaScript / TypeScript

npm install openai
import OpenAI from "openai";

const client = new OpenAI({
  apiKey: process.env.SHUNONG_API_KEY,
  baseURL: "https://ai.agriwis.com/api/v1",
});

const response = await client.chat.completions.create({
  model: "auto",
  messages: [{ role: "user", content: "你好" }],
});

console.log(response.choices[0].message.content);

其他语言

对于没有兼容 SDK 的语言,可以直接使用 HTTP 客户端调用接口。请求方法、请求头和 JSON 结构请参考 Chat Completions。

SDK 配置建议

  • 从环境变量读取密钥和 Base URL。
  • 为请求设置超时和有限次数的重试。
  • 对流式响应逐段消费,避免一次性缓存全部内容。
  • 将 SDK 和模型名称固定在依赖配置中,升级前先验证兼容性。