Base URL và Xác thực
Kết nối với API bằng cách sử dụng URL cơ sở được cung cấp và khóa token trả trước. Bạn xác thực bằng cách truyền khóa API của mình trong tiêu đề yêu cầu, đảm bảo chỉ tài khoản của bạn mới có thể truy cập vào số dư của mình. Đăng ký qua Google hoặc email để nhận khóa ngay lập tức mà không cần xác minh số điện thoại.
curl https://api.kimicodeapi.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 rate limit for free tier users?"}]
}'Yêu cầu của bạn nhắm vào điểm cuối tương thích OpenAI tiêu chuẩn. Thiết kế này cho phép bạn thay thế dịch vụ của chúng tôi mà không cần viết lại mã máy khách hiện có, miễn là bạn cập nhật URL cơ sở và thông tin xác thực.
Endpoint Hoàn thành Trò chuyện
Gửi tin nhắn đến mô hình bằng cách sử dụng POST /v1/chat/completions endpoint. Bạn phải chỉ định ID mô hình là uncensored để truy cập mô hình ngôn ngữ lớn được tối ưu hóa đang chạy trên máy chủ của chúng tôi. Hệ thống chấp nhận các vai trò tin nhắn tiêu chuẩn như người dùng hoặc trợ lý cho các cuộc trò chuyện nhiều lượt.
from openai import OpenAI
client = OpenAI(base_url="https://api.kimicodeapi.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)Điểm cuối này xử lý đầu vào văn bản và trả về văn bản được tạo. Nó không hỗ trợ embedding, hình ảnh hoặc âm thanh. Hãy tập trung vào cấu trúc lời nhắc của bạn để nhận kết quả tốt nhất từ mô hình không kiểm duyệt.
Phản hồi luồng (SSE)
Bật giao tiếp token theo thời gian thực bằng cách đặt tham số stream thành true trong yêu cầu. API trả về các chunk Sự kiện được gửi bởi máy chủ (SSE), cho phép ứng dụng của bạn hiển thị văn bản ngay khi nó được tạo. Chunk cuối cùng chứa thống kê sử dụng token đầy đủ để tính phí.
stream = 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)Streaming làm giảm độ trễ cảm nhận cho người dùng cuối. Bạn có thể xử lý từng token khi nó đến, điều này rất lý tưởng cho các giao diện chat. Hãy nhớ rằng streaming không thay đổi hành vi của mô hình nền hoặc giá token.
Function Calling và các công cụ
Định nghĩa các công cụ trong yêu cầu của bạn để cho phép mô hình xuất các cuộc gọi hàm có cấu trúc. API hỗ trợ các tham số tool_choice, cho phép bạn buộc mô hình sử dụng một công cụ cụ thể hoặc tự quyết định. Tính năng này hoạt động với các định dạng công cụ chuẩn của OpenAI, giúp việc tích hợp trở nên đơn giản.
import OpenAI from "openai";
const client = new OpenAI({ baseURL: "https://api.kimicodeapi.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);Sử dụng gọi hàm để trích xuất dữ liệu hoặc kích hoạt các hành động trong ứng dụng của bạn. Mô hình diễn giải các định nghĩa công cụ và trả về các đối tượng JSON chứa các đối số cần thiết. Khả năng này mở rộng API vượt ra ngoài việc tạo văn bản đơn thuần.
Chế độ JSON và tham số
Bắt buộc đầu ra JSON nghiêm ngặt bằng cách đặt response_format để {"type": "json_object"}. Điều này đảm bảo mô hình trả về JSON, điều rất quan trọng cho việc phân tích cú pháp theo chương trình. Bạn cũng có thể điều chỉnh các tham số như nhiệt độ, top_p và các chuỗi dừng để kiểm soát sự sáng tạo và độ dài đầu ra.
Mô hình hỗ trợ cửa sổ ngữ cảnh 100.000 token. Điều này cho phép bạn truyền lượng lớn ngữ cảnh trong một yêu cầu duy nhất. Đầu ra tối đa là 16.000 token mỗi yêu cầu, hoặc 2.048 nếu bạn không chỉ định max_tokens.
Giới hạn, Lỗi và Ngữ cảnh
Theo dõi giới hạn yêu cầu của bạn để tránh gián đoạn dịch vụ. API cho phép 300 yêu cầu mỗi phút mỗi khóa và tối đa 8 yêu cầu đồng thời. Thân yêu cầu của bạn phải nằm dưới 8 MB. Nếu vượt quá các giới hạn này, bạn sẽ nhận được lỗi giới hạn tốc độ 429.
Lỗi xác thực trả về lỗi 401 nếu khóa không hợp lệ. Lỗi 402 cho biết tín dụng trả trước không đủ. Lỗi trong quá trình tạo không tiêu thụ token của bạn. Cửa sổ ngữ cảnh bao gồm cả token prompt và token hoàn thành. Tín dụng chưa sử dụng không bao giờ hết hạn, đảm bảo số dư trả trước của bạn vẫn khả dụng cho các dự án trong tương lai.
