OpenAI 兼容 API 快速入门

前提条件与环境配置

您需要 API 密钥和正确的 base URL 才能连接客户端。在“获取 API 密钥”页面使用 Google 或邮箱注册，即可立即获得凭证。试用期间赠送 $0.50，有效期为 7 天，您还可以通过加密货币充值 USDT 或 USDC。请妥善保管您的密钥，并确保其与您的账户设置一致。

确保您的环境支持标准 HTTP 请求。我们的服务运行在一个 uncensored 模型上，因此您不需要管理多个模型端点。将您的 base URL 设置为 HTTPS://api.openaiapicompatibility.com/v1，然后再进行任何调用。这确保所有请求正确路由到我们的调优推理服务器。

安装官方 OpenAI SDK

使用官方 SDK 保持与现有 OpenAI 工作流的兼容性。Python 和 Node 库直接支持我们的端点，因为我们遵循标准 API 模式。使用您首选的包管理器在您的项目目录中安装该包。此方法避免了编写自定义 HTTP 客户端代码的需要。

我们支持 temperature、top_p 和 stop sequences 等标准参数。SDK 会自动处理 JSON 序列化和请求标头。您可以在客户端配置中交换 base URL 以指向我们的服务器。这允许您在不同提供商之间切换，而无需更改应用程序逻辑。

配置基础 URL 和 API 密钥

在客户端配置对象中设置基础 URL 和 API 密钥。基础 URL 为 HTTPS://api.openaiapicompatibility.com/v1。在 Authorization 标头中以 Bearer 令牌形式传递 API 密钥。此配置确保请求经过身份验证并路由到正确的服务。

Copycurl https://api.openaiapicompatibility.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "list all python packages for data science"}]
  }'

通过调用 GET /v1/models 端点来验证您的连接。这将返回可用模型列表，包括 uncensored 模型标识符。在此步骤中，请确认您的网络访问和凭据正确无误，然后再发送复杂的提示。

发起首次聊天补全请求

向 /v1/chat/completions 发送 POST 请求，附带你的提示消息。将模型定义为 uncensored 以访问无过滤的推理引擎。包含你的 system prompt 以设置行为，并添加用户消息以生成所需内容。

Copyfrom openai import OpenAI

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

resp = client.chat.completions.create(
    model="uncensored",
    messages=[{"role": "user", "content": "Summarise this thread without softening it."}],
)
print(resp.choices[0].message.content)

响应包含生成的文本和令牌使用统计信息。你可以调整 temperature 等参数来控制创造性。该模型不会拒绝合法的成人内容或争议性话题，因此适用于各种用例。请检查响应对象中的 content 字段以获取输出。

使用 SSE 的流式响应

通过在请求中将 stream 参数设置为 true 启用流式传输。这将作为服务器发送事件 (SSE) 发送部分响应。它通过显示生成的文本来改善用户体验。

Copystream = client.chat.completions.create(
    model="uncensored",
    messages=[{"role": "user", "content": "Tell the story in second person."}],
    stream=True,
)
for chunk in stream:
    if chunk.choices and chunk.choices[0].delta.content:
        print(chunk.choices[0].delta.content, end="", flush=True)

每个块包含响应的增量。累积这些增量以重建完整文本。最后一个块包含请求的总令牌使用情况。此方法适用于任何标准 SSE 客户端或库。它减少了长文本内容生成的感知延迟。

处理 JSON 模式和函数调用

通过设置 response_format 为 json_object 使用 JSON 模式。这强制模型输出有效的 JSON 而不是自由文本。这对于结构化数据提取或 API 响应很有用。结合函数调用用于工具使用场景。

在 tools 数组中定义您的工具。指定函数名、描述和参数。模型将在响应中返回函数调用详情。然后您可以执行该函数并将结果发送回模型。这使 uncensored 模型能够执行复杂的多步工作流。

Node.js

Copyimport OpenAI from "openai";

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

const resp = await client.chat.completions.create({
  model: "uncensored",
  messages: [{ role: "user", content: "Draft a villain monologue for my game." }],
});
console.log(resp.choices[0].message.content);