Tài liệu API

Xác thực và Base URL

API yêu cầu một khóa API hợp lệ để xác thực. Bạn nhận được khóa này ngay sau khi đăng ký bằng Google hoặc địa chỉ email. Truyền nó vào Authorization header dưới dạng mã Bearer. URL cơ sở là https://api.topuncensored.com/v1. URL này hoạt động với bất kỳ SDK hoặc thư viện máy khách tương thích OpenAI nào.

• Sử dụng tiêu đề: Authorization: Bearer YOUR_API_KEY
• Thiết lập URL cơ sở của client của bạn thành điểm cuối được cung cấp.

Cấu hình này đảm bảo bạn có thể thay đổi thư viện mà không cần thay đổi logic cốt lõi của mình.

Copycurl https://api.topuncensored.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Generate a list of ten distinct UI layout patterns."}]
  }'

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

Gửi các prompt văn bản đến /v1/chat/completions endpoint. endpoint. ID mô hình là uncensored. Điểm cuối này xử lý định dạng chat tiêu chuẩn với các tin nhắn. Nó trả về các phản hồi văn bản trực tiếp. Không có lớp trung gian hoặc lớp bọc nào. Bạn kiểm soát cửa sổ ngữ cảnh 100,000 token. Các yêu cầu dưới 8 MB hoạt động đáng tin cậy. Sử dụng tính năng này cho việc tạo văn bản trực tiếp.

Cấu trúc yêu cầu của bạn với một lời nhắc system và thông điệp user. Mô hình phản hồi mà không lọc nội dung người lớn hợp pháp. Lỗi như thiếu khóa trả về 401. Hết tín dụng? Bạn nhận được lỗi 402. Đây là những tín hiệu rõ ràng.

Phản hồi luồng

Bật phát trực tiếp bằng cách đặt stream: true. Bạn nhận được các chunk văn bản khi chúng được tạo ra. Điều này giảm độ trễ cảm nhận đối với các đầu ra dài. Chunk cuối cùng bao gồm dữ liệu sử dụng token. Sử dụng điều này cho hiển thị theo thời gian thực hoặc hiển thị từng phần. Nó hiệu quả cho các ứng dụng có khối lượng lớn.

Phân tích từng chunk để xây dựng phản hồi cuối cùng của bạn. Phương pháp này xử lý các đầu ra lớn một cách mượt mà. API hỗ trợ chuẩn Server-Sent Events. Đây là phương pháp được khuyến nghị cho các ứng dụng tương tác.

Copyfrom openai import OpenAI

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

Gọi công cụ và chế độ JSON

Sử dụng gọi hàm cho các tương tác có cấu trúc. Xác định công cụ trong yêu cầu của bạn. Mô hình trả về các đối số có cấu trúc. Đặt response_format để {"type": "json_object"} cho đầu ra JSON nghiêm ngặt. Điều này đảm bảo các định dạng dữ liệu dự đoán được. Kết hợp các tính năng này để có các tích hợp mạnh mẽ. Bạn có được sự kiểm soát chính xác về cấu trúc đầu ra.

Gọi công cụ hoạt động với lược đồ OpenAI tiêu chuẩn. Chế độ JSON bắt buộc JSON hợp lệ. Sử dụng những tính năng này cho các tích hợp API hoặc trích xuất dữ liệu. Sự linh hoạt này hỗ trợ các quy trình làm việc phức tạp.

Copyimport OpenAI from "openai";

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

Tham số và Giới hạn

Điều chỉnh temperature, top_p, và stop chuỗi. Đặt max_tokens đến 16.000. Mặc định là 2.048 nếu bỏ qua. Kiểm soát sự lặp lại với presence_penalty và frequency_penalty. Sử dụng seed để đầu ra xác định. Các tham số này tinh chỉnh chất lượng tạo ra. Bạn có toàn quyền kiểm soát phong cách đầu ra.

Giới hạn tốc độ là 300 yêu cầu mỗi phút. Yêu cầu đồng thời giới hạn ở 8. Những giới hạn này đảm bảo hiệu suất ổn định. Theo dõi mức sử dụng qua bảng điều khiển. Điều chỉnh tham số để tối ưu hóa cho trường hợp sử dụng cụ thể của bạn.

Lỗi và Cửa sổ ngữ cảnh

Xử lý lỗi một cách mượt mà. Lỗi 401 có nghĩa là khóa không hợp lệ. Lỗi 402 cho biết số dư không đủ. Lỗi 429 báo hiệu đã vượt quá giới hạn tốc độ. Cửa sổ ngữ cảnh là 100,000 token tổng cộng. Số token tối đa cho đầu ra là 16,000 token. Hãy quản lý token của bạn một cách hợp lý. Lỗi không tiêu tốn tiền. Điều này giúp tiết kiệm chi phí trong quá trình gỡ lỗi. Hãy sử dụng phần cuối cùng để xem thống kê sử dụng.

Theo dõi mức sử dụng của bạn. Tránh vượt quá giới hạn tốc độ. Thử lại với độ trễ tăng dần theo cấp số nhân. Điều này đảm bảo hoạt động đáng tin cậy. API được thiết kế để có tính bền vững. Xử lý lỗi như một phần của luồng bình thường.

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)