Tài liệu API

Hướng dẫn nhanh: Yêu cầu đầu tiên của bạn

Gửi tin nhắn đầu tiên đến model không kiểm duyệt ngay lập tức. Sử dụng điểm cuối hoàn tất cuộc trò chuyện tiêu chuẩn để tạo văn bản. Model phản hồi các lời nhắc ngôn ngữ tự nhiên mà không có từ chối nội dung cho mục đích người trưởng thành hợp pháp. Cấu hình này hoạt động với bất kỳ khách hàng tương thích OpenAI nào.

Bắt đầu bằng cách cài đặt SDK cho ngôn ngữ ưa thích của bạn. Sau đó, cấu hình khóa API của bạn. Ví dụ sau đây hiển thị một yêu cầu curl cơ bản để kiểm tra kết nối.

Bạn có thể điều chỉnh các tham số như nhiệt độ để kiểm soát độ ngẫu nhiên. Phản hồi trả về văn bản được tạo trực tiếp. Luồng đơn giản này cho phép bạn xác minh API hoạt động trước khi xây dựng logic phức tạp.

Copycurl https://api.apiaicharacter.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "What is the current API rate limit status?"}]
  }'

Base URL và Xác thực

Kết nối bằng URL cơ sở chuyên dụng cho API này. Thay thế điểm cuối mặc định bằng địa chỉ máy chủ được lưu trữ của chúng tôi. Điều này đảm bảo các yêu cầu của bạn đến trực tiếp với mô hình không hạn chế. Xác thực dựa trên một khóa API duy nhất cho mỗi tài khoản.

Tạo khóa của bạn qua bảng điều khiển. Truyền khóa này trong tiêu đề Authorization dưới dạng mã thông báo Bearer. Phương pháp này tương thích với các SDK OpenAI tiêu chuẩn. Bạn có thể chuyển đổi nhà cung cấp bằng cách chỉ thay đổi URL cơ sở và khóa.

Giữ khóa của bạn an toàn. Nó cấp quyền truy cập đầy đủ vào khoản tín dụng trả trước của bạn. Khóa thay thế bất kỳ khóa hoạt động trước đó ngay lập tức sau khi tạo.

Các điểm cuối: Chat Completions

Tương tác với mô hình thông qua endpoint chat completions. Đây là endpoint tạo văn bản duy nhất có sẵn. Endpoint chấp nhận các thông điệp và trả về văn bản được tạo. Không hỗ trợ embeddings, hình ảnh hoặc âm thanh.

Gửi yêu cầu POST đến tuyến chat. Bao gồm lời nhắc hệ thống và tin nhắn của người dùng trong phần thân. Mô hình xử lý ngữ cảnh và tạo phản hồi. Bạn có thể sử dụng chế độ JSON cho đầu ra có cấu trúc.

Gọi hàm cũng được hỗ trợ. Định nghĩa các công cụ và để mô hình quyết định khi nào sử dụng chúng. Sự linh hoạt này cho phép các quy trình tác nhân phức tạp. Phản hồi bao gồm nội dung được tạo và việc sử dụng token.

Copyfrom openai import OpenAI

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

Tham số: Nhiệt độ, Top P và Dừng

Kiểm soát phong cách đầu ra bằng các tham số tiêu chuẩn. Điều chỉnh temperature để thay đổi mức độ sáng tạo. Giá trị thấp hơn giúp phản hồi mang tính xác định cao hơn. Giá trị cao hơn tạo ra nhiều biến thể hơn.

Sử dụng top P để lọc các từ ít khả năng xảy ra. Điều này giúp duy trì sự mạch lạc trong khi vẫn cho phép sáng tạo. Đặt các trình tự dừng để kết thúc việc tạo văn bản tại các dấu hiệu cụ thể. Điều này hữu ích cho việc kiểm soát cấu trúc hội thoại.

Tham số seed cho phép tạo ra kết quả có thể tái lập. Hãy sử dụng nó khi gỡ lỗi các prompt của bạn. Các tham số này cho phép bạn kiểm soát chính xác hành vi của mô hình. Điều chỉnh chúng để phù hợp với nhu cầu của ứng dụng của bạn.

Copyimport OpenAI from "openai";

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

Streaming và Việc Sử Dụng Token

Nhận phản hồi theo thời gian thực bằng các sự kiện gửi máy chủ. Phát trực tiếp giảm độ trễ cảm nhận cho người dùng. API gửi token khi chúng được tạo. Điều này tạo ra trải nghiệm đọc mượt mà hơn.

Sử dụng token được báo cáo trong chunk cuối cùng. Điều này cho phép bạn theo dõi chi phí một cách chính xác. Việc tính phí dựa trên số token thực tế đã tiêu thụ. Lỗi và từ chối không phát sinh chi phí.

Triển khai trình xử lý luồng để xử lý dữ liệu. Cập nhật giao diện người dùng của bạn khi các token đến. Phương pháp này lý tưởng cho các giao diện trò chuyện. Mô hình hỗ trợ phát trực tiếp cho tất cả các loại yêu cầu.

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)

Giới hạn tốc độ và Ràng buộc

Hiểu các giới hạn để tránh gián đoạn dịch vụ. Bạn có thể thực hiện 300 yêu cầu mỗi phút mỗi khóa. Yêu cầu đồng thời được giới hạn ở tám yêu cầu cùng lúc. Thân yêu cầu không được vượt quá 8 MB.

Xử lý lỗi một cách mượt mà. Trạng thái 401 có nghĩa là khóa của bạn không hợp lệ. Trạng thái 402 cho biết số dư không đủ. Trạng thái 429 báo hiệu bạn đã vượt quá giới hạn tốc độ.

Cửa sổ ngữ cảnh hỗ trợ tối đa 100,000 token cho tổng cộng. Điều này bao gồm cả prompt và completion. Lượng output tối đa là 16,000 token mỗi yêu cầu. Đặt max_tokens để kiểm soát độ dài output. Lỗi miễn phí, nên logic thử lại an toàn.