Tóm tắt thông số
Nếu bạn đã có mã giao tiếp với OpenAI, phiên bản ngắn của thông số API tương thích OpenAI như sau: thay đổi base URL, thay đổi khóa, đặt mô hình thành uncensored. Thân yêu cầu và phản hồi tuân theo định dạng chat completions, nên các thư viện SDK sẽ phân tích chúng mà không cần thay đổi.
| Mục | Giá trị |
|---|---|
| URL gốc | https://api.unrestrictedaiapi.com/v1 |
| Xác thực | Authorization: Bearer YOUR_KEY |
| Phương thức | POST /v1/chat/completions, GET /v1/models |
| ID mô hình | uncensored |
| Cửa sổ ngữ cảnh | 100.000 token, bao gồm prompt và phần hoàn tất |
| Kích thước tối đa của thân yêu cầu | 8 MB |
| Đầu ra | Chỉ văn bản |
Mô hình là một mô hình trọng số mở duy nhất do nhà cung cấp độc lập vận hành và được tinh chỉnh để trả lời mà không có sự từ chối nội dung cho mục đích người lớn hợp pháp. Nó không phải là endpoint chính thức của bất kỳ nhà cung cấp mô hình nào và không định tuyến giữa các nhà cung cấp. Đó là lý do tại sao chỉ có một ID mô hình và danh sách mô hình ngắn.
Phương thức
GET /v1/models
Trả về các mô hình khả dụng cho khóa của bạn. Đây là cách rẻ nhất để xác nhận khóa và base URL của bạn đúng, và nhiều ứng dụng khách UI gọi nó để điền vào danh sách thả xuống.
curl https://api.unrestrictedaiapi.com/v1/models \
-H "Authorization: Bearer $KEY"
POST /v1/chat/completions
Endpoint tạo nội dung duy nhất. Bạn gửi một mảng messages các đối tượng với role (system, user, assistant hoặc tool) và content, cùng với mô hình và bất kỳ tùy chọn lấy mẫu nào. Một lệnh gọi tối giản:
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?"}
]
}'
Phản hồi chứa văn bản được tạo trong choices[0].message.content và số lượng token trong usage. Những số đếm này là cơ sở để tính phí.
Không hỗ trợ: endpoint completions cũ, các endpoint embeddings, image, audio và video, fine-tuning và file. Client gọi các endpoint này sẽ nhận lỗi, vì vậy hãy tắt các tính năng đó trong các công cụ mặc định sử dụng chúng.
Tham số yêu cầu
Các tham số sau được chấp nhận và chuyển tiếp đến mô hình:
temperaturevàtop_pđể lấy mẫu.stopcho một hoặc nhiều chuỗi dừng.seedđể lấy mẫu có thể lặp lại khi bạn giữ mọi thứ khác bằng nhau.presence_penaltyvàfrequency_penaltyđể giảm sự lặp lại.max_tokens, tùy chọn. Nếu bạn bỏ qua nó, phần văn bản được tạo ra có thể sử dụng phần còn lại của cửa sổ 100.000 token.streamcho sự kiện gửi từ máy chủ.toolsvàtool_choicecho gọi hàm.response_formatvới{"type":"json_object"}cho chế độ JSON.
Hai ghi chú thực tế. Thứ nhất, cửa sổ ngữ cảnh tính prompt và phần hoàn tất cùng nhau, nên prompt 90.000 token chỉ còn khoảng 10.000 token cho câu trả lời. Thứ hai, giới hạn phần thân là 8 MB, lớn hơn nhiều so với nhu cầu của 100.000 token văn bản, nên bạn chỉ đạt giới hạn này khi nhúng các tải trọng mã hóa lớn vào các tin nhắn.
Truyền phát
Đặt stream: true và phản hồi đến dưới dạng sự kiện gửi từ máy chủ. Mỗi sự kiện là một đoạn JSON chứa delta giữ phần văn bản tiếp theo, và thông tin sử dụng được báo cáo ở cuối luồng. Các thư viện SDK ẩn khung giao thức; với giao thức thô, bạn đọc các dòng bắt đầu bằng data: cho đến khi luồng đóng.
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="")
Một quy tắc ảnh hưởng đến việc lập kế hoạch dung lượng: một yêu cầu truyền phát giữ slot đồng thời của nó cho đến khi luồng kết thúc, không phải cho đến khi token đầu tiên. Nếu một client bị treo trong khi đọc, nó vẫn giữ slot đó bận. Luôn đóng hoặc kết thúc luồng, và đặt thời gian chờ cho client.
Gọi công cụ và chế độ JSON
Gọi hàm
Truyền tools dưới dạng danh sách các định nghĩa hàm với tham số JSON Schema. Nếu mô hình quyết định gọi một hàm, thông báo sẽ chứa tool_calls, cũng được truyền phát khi stream được bật. Bạn chạy hàm và gửi lại kết quả dưới dạng thông báo với role: "tool" và tool_call_id tương ứng. Sử dụng tool_choice để buộc một hàm cụ thể hoặc để mô hình tự quyết định.
{
"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"]
}
}
}]
}
Mô hình đề xuất các đối số; nó không thực thi bất cứ thứ gì. Xác thực chúng trước khi hành động, như bạn vẫn làm với bất kỳ đầu vào người dùng nào.
Chế độ JSON
Thêm "response_format": {"type": "json_object"} để yêu cầu một đối tượng JSON hợp lệ duy nhất. Tương tự như các triển khai kiểu OpenAI khác, hãy cho mô hình biết trong prompt các khóa bạn muốn, ví dụ "Trả về một đối tượng với các khóa title và tags". Phân tích kết quả trong khối try dù sao, và đặt max_tokens rộng rãi để đối tượng dài không bị cắt ngắn.
Giới hạn, tiêu đề và lỗi
| Loại khóa | Yêu cầu đồng thời | Yêu cầu mỗi phút |
|---|---|---|
| Khóa đầy đủ | 8 | 300 |
| Khóa dùng thử | 2 | 60 |
Mọi phản hồi đều bao gồm X-Request-Id (trích dẫn nó khi liên hệ hỗ trợ), X-Balance-USD (tín dụng còn lại của bạn), X-RateLimit-Limit-Requests và X-RateLimit-Limit-Concurrency.
Khi bạn vượt qua giới hạn, API trả về HTTP 429. Mã lỗi phân tách các trường hợp:
rate_limited: quá nhiều yêu cầu trong một phút. Làm chậm lại hoặc phân tán tải.concurrency: quá nhiều yêu cầu đang xử lý cùng lúc. Hãy đưa chúng vào hàng đợi ở phía bạn.- 429 với tiêu đề
Retry-After: 5: quá tải tạm thời. Chờ năm giây và thử lại.
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
Các yêu cầu thất bại hoặc bị từ chối không bị tính phí.
Vai trò, lịch sử và đối tượng phản hồi
API không có trạng thái. Nó không nhớ các yêu cầu trước đó, vì vậy một cuộc trò chuyện chỉ tồn tại dưới dạng mảng messages bạn gửi mỗi lần. Lịch sử điển hình bắt đầu với một thông báo system thiết lập hành vi, theo sau là các thông báo user và assistant xen kẽ. Khi gọi hàm được kích hoạt, các thông báo tool xuất hiện giữa chúng, mỗi thông báo được liên kết với cuộc gọi mà nó trả lời bằng tool_call_id.
Điều này có hai hệ quả. Thứ nhất là chi phí: mỗi lượt trả lời phải trả cho toàn bộ lịch sử dưới dạng đầu vào, vì vậy một cuộc trò chuyện dài sẽ tốn kém hơn mỗi thông báo ngay cả khi mỗi câu hỏi ngắn. Thứ hai là kiểm soát: bạn có thể chỉnh sửa, cắt bớt hoặc viết lại lịch sử tùy ý. Loại bỏ các lượt cũ nhất, thay thế chúng bằng bản tóm tắt hoặc tiêm một thông báo trợ lý đã sửa đều là các thao tác thông thường, và mô hình coi bất cứ thứ gì bạn gửi là sự thật.
Khi nhận lại, đọc ba thứ. choices[0].message giữ văn bản hoặc các cuộc gọi công cụ. choices[0].finish_reason cho bạn biết lý do tạo kết thúc: kết thúc tự nhiên, giới hạn token hoặc gọi công cụ. usage giữ số lượng token prompt, hoàn thành và tổng cộng. Nếu lý do kết thúc cho biết giới hạn token đã bị vượt quá, văn bản bị cắt ngắn, và bạn nên tăng giới hạn hoặc yêu cầu mô hình tiếp tục trong một lượt theo dõi.
Danh sách kiểm tra tương thích ngắn
Trước khi phát hành client cho endpoint này, hãy chạy qua các kiểm tra này. Chúng bắt hầu hết các vấn đề tích hợp trong vài phút.
- Gọi
GET /v1/modelsvới khóa của bạn và xác nhận bạn nhận được danh sách bao gồmuncensored. - Gửi một yêu cầu chat đơn giản không có tùy chọn và xác nhận một phản hồi bình thường với khối
usage. - Lặp lại với
stream: truevà xác nhận rằng client của bạn xử lý cuối luồng và dữ liệu usage cuối cùng. - Nếu bạn sử dụng công cụ, gửi một vòng lặp gọi công cụ từ đầu đến cuối, bao gồm yêu cầu theo dõi với thông báo
tool. - Gửi 10 yêu cầu cùng lúc trên khóa dùng thử và xác nhận mã của bạn xử lý được mã 429 theo sau yêu cầu đồng thời thứ hai.
- Ghi lại
X-Request-Idcho mọi lệnh gọi để bất kỳ kết quả kỳ lạ nào có thể được truy vết sau này.
Vượt qua tất cả sáu nghĩa là client của bạn đã sẵn sàng cho lưu lượng thực tế.
Nơi khác biệt so với nền tảng OpenAI đầy đủ
Tính tương thích nghĩa là giao thức chat, không phải toàn bộ nền tảng. Mọi thứ ngoài chat văn bản đều không có, và một vài hành vi đến từ mô hình chứ không phải từ giao thức. Tên mô hình là cố định, câu trả lời có thể khác biệt về phong cách so với bất kỳ mô hình nào bạn đã dùng trước đây, và việc lấy mẫu với cùng seed chỉ lặp lại được khi prompt và các tham số vẫn giữ nguyên.
Quy tắc nội dung duy nhất bạn không thể thay đổi là nội dung tình dục liên quan đến người chưa thành niên bị chặn. Ngoài ra, mô hình được tinh chỉnh để tránh từ chối cho việc sử dụng người lớn hợp pháp, và các prompt không được dùng để huấn luyện.
Đối với mã trong năm ngôn ngữ, xem bắt đầu nhanh, về kỹ thuật prompt, đọc viết prompt cho mô hình không hạn chế, và về phía tài khoản, bảng giá liệt kê các mức giá: $0.15 cho mỗi 1M token đầu vào và $0.50 cho mỗi 1M token đầu ra, với tín dụng không bao giờ hết hạn. tài liệu giữ cùng đặc tả ở dạng ngắn gọn.
