跳转到主要内容

Documentation Index

Fetch the complete documentation index at: https://ag2dev.com/llms.txt

Use this file to discover all available pages before exploring further.

​
什么是 OpenAI 兼容 API？

OpenAI 兼容 API 是指实现了与 OpenAI API 相同规范的 API 端点。这种标准化使开发者能够通过熟悉的接口使用多个 AI 提供商，而无需重写代码。

​
为什么重要

您不再被锁定在单一提供商上，只需在现有的 OpenAI 客户端代码中更改 API 端点和凭据，即可在不同 LLM 服务之间切换。
切勿在代码中硬编码 API 密钥。 始终使用环境变量或安全的密钥管理服务来存储凭据。

​
工作原理

配置项说明
Base URL提供商的 API 端点（而非 OpenAI 服务器）
API Key您在提供商处的身份验证凭据
Model Name该提供商的特定模型标识符
所有兼容的提供商都支持标准的 OpenAI SDK。安装命令：
pip install openai
# 或
npm install openai

​
推荐配置

使用环境变量来配置 API 客户端： 
export OPENAI_COMPATIBLE_BASE_URL="https://api.provider.com/v1"
export OPENAI_COMPATIBLE_API_KEY="your_api_key_here"
export OPENAI_COMPATIBLE_MODEL_NAME="provider-model-name"
然后在代码中使用： 
from openai import OpenAI

client = OpenAI(
    base_url=os.environ["OPENAI_COMPATIBLE_BASE_URL"],
    api_key=os.environ["OPENAI_COMPATIBLE_API_KEY"],
)
具体配置详情请参阅各个提供商页面。