Yomi APIYomi API帮助文档 返回控制台

English

Yomi API / 帮助文档 / SDK 集成

开发集成

SDK 集成

Yomi API 完全兼容 OpenAI API 标准,直接使用 OpenAI 官方 SDK,只需修改 base_url 与 api_key 两项配置即可接入平台全部模型。

安装

Python

pip install openai

Node.js

npm install openai

Python 调用

from openai import OpenAI

client = OpenAI(
    api_key="YOUR_API_KEY",
    base_url="https://api.yomiapi.com/v1"
)

response = client.chat.completions.create(
    model="deepseek-v4-flash",
    messages=[{"role": "user", "content": "用一句话介绍 API 网关的作用"}]
)
print(response.choices[0].message.content)

Node.js 调用

import OpenAI from "openai";

const client = new OpenAI({
  apiKey: "YOUR_API_KEY",
  baseURL: "https://api.yomiapi.com/v1"
});

const completion = await client.chat.completions.create({
  model: "deepseek-v4-flash",
  messages: [{ role: "user", content: "用一句话介绍 API 网关的作用" }]
});
console.log(completion.choices[0].message.content);

流式输出

设置 stream=True 后逐段接收内容,适合聊天界面等需要即时反馈的场景:

stream = client.chat.completions.create(
    model="deepseek-v4-flash",
    messages=[{"role": "user", "content": "写一段 100 字的产品介绍"}],
    stream=True
)
for chunk in stream:
    if chunk.choices and chunk.choices[0].delta.content:
        print(chunk.choices[0].delta.content, end="")

支持的能力

  • Function Calling: 标准 tools 参数定义工具,模型返回结构化调用请求。
  • 多模态输入: 通过 image_url 内容块传入图像,配合 claude-sonnet-5 等多模态模型使用。
  • Embeddings: client.embeddings.create 配合模型广场在售的嵌入模型生成向量。
  • 语音: 转写、翻译与合成接口(/v1/audio 系列)均可通过 SDK 调用。
  • Responses API: client.responses 可直接使用,见「OpenAI Responses API」篇。
两个 SDK 均支持环境变量配置:设置 OPENAI_API_KEY 与 OPENAI_BASE_URL 后,代码中无需硬编码密钥与地址,便于在不同环境间切换。