Tài liệu API Tương thích OpenAI

Điều kiện tiên quyết: SDK và Base URL

Bắt đầu bằng cách cài đặt thư viện mà bạn yêu thích và trỏ nó vào điểm cuối của chúng tôi. Các base_url là https://api.apicompatible.com/v1. Tài liệu API tương thích OpenAI này xác nhận rằng các thư viện tiêu chuẩn hoạt động ngay lập tức. Bạn không cần bộ định tuyến hoặc thiết bị cổng phức tạp. Thay đổi URL và khóa, sau đó chạy mã hiện có của bạn.

Xác thực: Định dạng Tiêu đề và Khóa

Gửi khóa của bạn trong Authorization header. Sử dụng định dạng Bearer your_api_key. API của chúng tôi sử dụng cấu trúc khóa API tương thích chuẩn với OpenAI. Khóa được tạo ngay lập tức thông qua đăng nhập bằng Google hoặc email. Hãy giữ khóa của bạn an toàn vì nó cấp quyền truy cập vào số dư đã trả trước của bạn.

Endpoint Hoàn thành Trò chuyện

Gửi yêu cầu đến /v1/chat/completions. Chỉ định model là uncensored. API trả về các phản hồi văn bản trực tiếp. Sử dụng lệnh curl sau để xác minh kết nối:

Copycurl https://api.apicompatible.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "List available models"}]
  }'

Cách tiếp cận tương thích SDK OpenAI này đảm bảo bạn nhận được việc tạo văn bản không hạn chế. Mô hình xử lý các câu lệnh phức tạp mà không từ chối không cần thiết đối với nội dung hợp pháp.

Phản hồi luồng với SSE

Bật phát trực tiếp bằng cách đặt stream: true. Phản hồi được gửi qua Server-Sent Events (SSE). Chi tiết sử dụng token xuất hiện trong chunk cuối cùng. Tài liệu API tương thích OpenAI này hỗ trợ các giao thức streaming tiêu chuẩn. Sử dụng điều này cho trải nghiệm người dùng theo thời gian thực:

Copyfrom openai import OpenAI

client = OpenAI(base_url="https://api.apicompatible.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)

Streaming giảm độ trễ cảm nhận đáng kể. Nó hoạt động liền mạch với các thư viện phía máy khách tiêu chuẩn.

Tham số: Nhiệt độ, Top-P và Công cụ

Kiểm soát quá trình sinh văn bản bằng các tham số tiêu chuẩn. Đặt temperature cho tính ngẫu nhiên hoặc top_p để lấy mẫu nucleus. Bật tools cho gọi hàm. Chế độ JSON có sẵn qua response_format. The uncensored model tôn trọng các ràng buộc này một cách hiệu quả:

Copyimport OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.apicompatible.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);

Các tham số này cho phép kiểm soát tinh tế phong cách đầu ra. Bạn có thể buộc các cấu trúc JSON nghiêm ngặt cho các trường hợp sử dụng lập trình.

Giới hạn: Giới hạn tốc độ và Kích thước thân

Mỗi khóa cho phép 300 yêu cầu mỗi phút. Yêu cầu đồng thời được giới hạn ở 8 cho mỗi khóa. Kích thước thân yêu cầu tối đa là 8 MB. Cửa sổ ngữ cảnh hỗ trợ tổng cộng 100,000 tokens. Xử lý lỗi 401 bằng cách kiểm tra khóa của bạn. Giải quyết lỗi 402 bằng cách nạp thêm tín dụng. Quản lý lỗi 429 bằng cách triển khai logic backoff.

Phát trực tiếp

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)