规范摘要
如果你已有与 OpenAI 交互的代码,兼容 OpenAI API 规范的简短说明如下:更改 Base URL,更改密钥,将模型设置为 uncensored。请求和响应体遵循聊天补全格式,因此 SDK 无需修改即可解析。
| 项目 | 说明 |
|---|---|
| Base URL | https://api.unrestrictedaiapi.com/v1 |
| 认证 | Authorization: Bearer YOUR_KEY |
| 接口 | POST /v1/chat/completions, GET /v1/models |
| 模型 ID | uncensored |
| 上下文窗口 | 100,000 token,包含提示词和补全 |
| 最大请求体 | 8 MB |
| 输出 | 仅文本 |
该模型由独立提供商运行,是一个开放权重模型,针对合法成人用途进行了无内容拒绝的优化。它不是任何模型供应商的官方接口,也不在供应商之间路由。因此只有一个模型 ID,且模型列表很短。
接口
GET /v1/models
返回你的密钥可用的模型。这是确认密钥和 Base URL 是否正确最便宜的方法,许多 UI 客户端调用它来填充下拉菜单。
curl https://api.unrestrictedaiapi.com/v1/models \
-H "Authorization: Bearer $KEY"
POST /v1/chat/completions
唯一的生成接口。你发送一个包含 messages 的对象数组,每个对象包含 role(system、user、assistant 或 tool)和 content,以及模型和任何采样选项。最小调用示例:
curl https://api.unrestrictedaiapi.com/v1/chat/completions \
-H "Authorization: Bearer $KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "uncensored",
"messages": [
{"role": "system", "content": "Answer in one sentence."},
{"role": "user", "content": "What is a base URL?"}
]
}'
回复在 choices[0].message.content 中包含生成的文本,在 usage 中包含 token 计数。计费基于这些计数。
未提供:旧版补全接口、嵌入接口、图像、音频和视频接口、微调及文件接口。调用这些接口的客户端会收到错误,因此请在默认使用这些功能的工具中禁用它们。
请求参数
接受以下参数并传递给模型:
temperature和top_p用于采样。stop用于一个或多个停止序列。seed用于在保持其他条件不变时进行可重复采样。presence_penalty和frequency_penalty用于减少重复。max_tokens,可选。如果省略,补全可以使用剩余的 100,000 token 上下文窗口。stream用于服务器发送事件。tools和tool_choice用于函数调用。response_format配合{"type":"json_object"}用于 JSON 模式。
两个实用提示。首先,上下文窗口计算提示词和补全部分,因此 90,000 token 的提示词只留下约 10,000 token 用于回答。其次,请求体限制为 8 MB,这远超 100,000 token 文本的需求,因此只有在消息中嵌入大型编码负载时才会达到此限制。
流式输出
设置 stream: true,响应将以服务器发送事件形式到达。每个事件是一个包含 delta 的 JSON 块,其中包含下一段文本,用量在流结束时报告。SDK 隐藏了帧结构;使用原始协议时,你读取以 data: 开头的行,直到流关闭。
from openai import OpenAI
client = OpenAI(base_url="https://api.unrestrictedaiapi.com/v1", api_key="YOUR_KEY")
with client.chat.completions.create(
model="uncensored",
messages=[{"role": "user", "content": "List five HTTP status codes."}],
stream=True,
) as stream:
for chunk in stream:
if chunk.choices and chunk.choices[0].delta.content:
print(chunk.choices[0].delta.content, end="")
一条规则影响容量规划:流式请求在其流结束前一直占用并发槽位,而不仅仅是第一个 token。如果客户端在读取时停滞,它会保持槽位繁忙。务必关闭或完成流,并设置客户端超时。
工具调用和 JSON 模式
函数调用
将 tools 作为包含 JSON Schema 参数的函数定义列表传入。如果模型决定调用某个函数,消息中将包含 tool_calls,当 stream 开启时,这些调用也会进行流式输出。你执行该函数,并将结果作为消息返回,其中 role: "tool" 和匹配的 tool_call_id 需对应。使用 tool_choice 可强制指定特定函数,或将决策权留给模型。
{
"model": "uncensored",
"messages": [{"role": "user", "content": "Weather in Oslo?"}],
"tools": [{
"type": "function",
"function": {
"name": "get_weather",
"description": "Current weather for a city",
"parameters": {
"type": "object",
"properties": {"city": {"type": "string"}},
"required": ["city"]
}
}
}]
}
模型提出参数;它不执行任何操作。在执行操作前验证参数,就像处理任何用户输入一样。
JSON 模式
添加 "response_format": {"type": "json_object"} 以请求单个有效的 JSON 对象。与其他 OpenAI 风格实现一样,还在提示词中告诉模型你需要的键,例如 "返回一个包含 title 和 tags 键的对象"。无论如何都在 try 块中解析结果,并保持 max_tokens 充足,以免长对象被截断。
限制、响应头和错误
| 密钥类型 | 并发请求 | 每分钟请求数 |
|---|---|---|
| 完整密钥 | 8 | 300 |
| 试用密钥 | 2 | 60 |
每个响应都包含 X-Request-Id(联系 support 时引用它)、X-Balance-USD(你的剩余额度)、X-RateLimit-Limit-Requests 和 X-RateLimit-Limit-Concurrency。
当你超过限制时,API 返回 HTTP 429。错误代码区分了不同情况:
rate_limited:一分钟内请求过多。减慢速度或分散负载。concurrency:同时进行的请求过多。在你这边进行排队。- 带有
Retry-After: 5标头的 429:临时过载。等待五秒后重试。
import time
import httpx
def post_with_retry(payload, key, tries=4):
# payload example: {"model": "uncensored", "messages": [...]}
for attempt in range(tries):
r = httpx.post(
"https://api.unrestrictedaiapi.com/v1/chat/completions",
headers={"Authorization": "Bearer " + key},
json=payload,
timeout=120,
)
if r.status_code == 429:
wait = int(r.headers.get("Retry-After", 2 ** attempt))
time.sleep(wait)
continue
return r
return r
失败或被拒绝的请求不收费。
角色、历史记录和响应对象
API 是无状态的。它不记住之前的请求,因此对话仅存在于你每次发送的 messages 数组中。典型的历史记录以一个设置行为的 system 消息开始,后跟交替的 user 和 assistant 消息。当涉及函数调用时,tool 消息出现在它们之间,每个消息通过 tool_call_id 链接到它回答的调用。
这有两个后果。首先是成本:每一轮都为整个历史记录作为输入付费,因此长对话即使每个问题很短也会变得更昂贵。其次是控制:你可以随时编辑、修剪或重写历史记录。删除最旧的轮次、用摘要替换它们或注入修正后的助手消息都是常规操作,模型将你发送的任何内容视为事实。
在返回时,读取三件事。choices[0].message 包含文本或工具调用。choices[0].finish_reason 告诉你生成停止的原因:自然结束、token 限制或工具调用。usage 包含提示词、补全和总 token 计数。如果完成原因表示达到了 token 限制,文本将被截断,你应该增加限制或在后续轮次中要求模型继续。
简短兼容性检查清单
在向此接口部署客户端之前,请执行以下检查。它们可以在几分钟内捕获大多数集成问题。
- 使用你的密钥调用
GET /v1/models,并确认返回的列表包含uncensored。 - 发送不带选项的普通聊天请求,并确认收到带有
usage块的正常回复。 - 使用
stream: true重复,并确认客户端能处理流结束和最终用量数据。 - 如果使用工具,发送一个端到端的工具调用往返,包括带有
tool消息的后续请求。 - 在试用密钥上同时发送 10 个请求,并确认你的代码能处理第二个并发请求后的 429 错误。
- 为每次调用记录
X-Request-Id,以便日后追踪任何异常结果。
通过所有六项检查意味着你的客户端已准备好处理真实流量。
与完整 OpenAI 平台的区别
兼容性指的是聊天协议,而非整个平台。文本聊天之外的功能均不可用,部分行为由模型决定而非协议决定。模型名称是固定的,其回答风格可能与之前使用过的任何模型不同,且使用相同的 seed 进行采样时,只有在提示词和参数保持不变的情况下才可重复。
唯一不可更改的内容规则是屏蔽涉及未成年人的性内容。除此之外,该模型经过调整,以避免对合法的成人用途进行拒绝,且提示词不会用于训练。
五种语言的代码请参见快速入门,了解提示技巧请阅读对无审查模型进行提示,账户相关请见定价,费率如下:输入 token 每 1M 为 $0.15,输出 token 每 1M 为 $0.50,额度永不失效。文档提供了该规范的简版。
