Tài liệu KiApi: Tích hợp trong 5 phút

Bắt đầu: Base URL và xác thực

KiApi hoàn toàn tương thích với API OpenAI. Bạn có thể sử dụng hệ sinh thái SDK và client hiện có bằng cách điều chỉnh base_url. Base URL cho tất cả yêu cầu là https://api.kiapis.com/v1. Xác thực chỉ sử dụng khóa API, bạn nhận được sau khi đăng ký trên trang dashboard. Khóa này phải được truyền trong tiêu đề HTTP Authorization: Bearer <IHR_API_SCHLÜSSEL>. Bạn có thể tạo khóa mới bất cứ lúc nào, khóa cũ sẽ mất hiệu lực.

Khác với các dịch vụ khác, chúng tôi không cung cấp các endpoint phức tạp cho embedding hoặc fine-tuning. Trọng tâm của chúng tôi là tạo văn bản thuần túy. KiApi là kết nối trực tiếp của bạn với một mô hình được tối ưu hóa cho phản hồi không kiểm duyệt. Hãy đảm bảo cấu hình môi trường của bạn đúng trước khi gửi yêu cầu đầu tiên.

POST /v1/chat/completions: Tạo văn bản

Trọng tâm của API là endpoint POST /v1/chat/completions. Tại đây, bạn gửi danh sách tin nhắn (hệ thống, người dùng, trợ lý) và nhận phản hồi văn bản. Tham số model-id phải được đặt thành uncensored. Phản hồi là đồng bộ và bao gồm ngay lập tức đoạn văn bản được tạo cùng với siêu dữ liệu về việc sử dụng token.

Cấu trúc yêu cầu tuân theo định dạng tiêu chuẩn. Bạn có thể xác định các vai trò để cấu trúc ngữ cảnh rõ ràng. Hệ thống xử lý đầu vào và tạo phản hồi dựa trên hành vi đã học của mô hình. Đây là phương pháp chính cho hầu hết các ứng dụng văn bản, từ chatbot đến phân tích văn bản.

Kopierencurl https://api.kiapis.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Write a blunt product review of a cheap VPN."}]
  }'

Phản hồi chứa một đối tượng JSON với nội dung được tạo. Hãy đảm bảo trích xuất phần content từ phản hồi để sử dụng tiếp trong ứng dụng của bạn. Không có siêu dữ liệu bổ sung như chi phí cho mỗi yêu cầu được trả về trong phản hồi tiêu chuẩn; thông tin này có trong dashboard.

Truyền phát với Sự kiện gửi bởi máy chủ (SSE)

Đối với các ứng dụng cần đầu ra ngay lập tức, KiApi hỗ trợ streaming qua Server-Sent Events (SSE). Kích hoạt bằng cách đặt "stream": true trong thân yêu cầu. Thay vì chờ phản hồi đầy đủ, bạn nhận được luồng các bản vá JSON chứa dần dần đoạn văn bản được tạo.

Điều này đặc biệt hữu ích cho giao diện chat, nơi phản hồi ngay lập tức cải thiện trải nghiệm người dùng. KiApi với khả năng streaming api cho phép bạn giảm độ trễ và tạo cảm giác trò chuyện thời gian thực. Client phải phân tích cú pháp luồng và ghép các mảnh lại cho đến khi kết thúc luồng được báo hiệu.

Kopierenstream = 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)

Khi streaming, thống kê sử dụng token thường được trả về ở cuối luồng trong sự kiện cuối cùng. Điều này cho phép tính toán chính xác dựa trên độ dài tạo thực tế. Hãy đảm bảo mã client của bạn xử lý kết thúc luồng để giải phóng tài nguyên đúng cách.

Gọi công cụ và gọi hàm

Mô hình hỗ trợ gọi công cụ (tool calling), còn được gọi là gọi hàm. Điều này cho phép LLM trả về dữ liệu JSON có cấu trúc đại diện cho các chức năng hoặc hành động cụ thể trong ứng dụng của bạn. Bạn xác định các công cụ có sẵn trong thân yêu cầu, và mô hình quyết định khi nào gọi công cụ dựa trên đầu vào của người dùng.

Cấu trúc định nghĩa công cụ tuân theo tiêu chuẩn OpenAI. Bạn có thể chỉ định nhiều công cụ, và mô hình sẽ chọn công cụ phù hợp nhất. Phản hồi chứa danh sách các lệnh gọi công cụ mà bạn có thể thực hiện trong logic backend của mình. Điều này mở rộng đáng kể khả năng của KiApi vượt ra ngoài việc tạo văn bản thuần túy.

Kopierenfrom openai import OpenAI

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

Sử dụng gọi công cụ để tự động hóa các quy trình làm việc phức tạp. Mô hình cung cấp các tham số cho công cụ trực tiếp dưới dạng JSON. Bạn không cần sử dụng trình phân tích cú pháp bên ngoài cho phản hồi vì cấu trúc đến trực tiếp từ mô hình. Điều này làm cho việc tích hợp vào các hệ thống hiện có trở nên đơn giản và đáng tin cậy hơn nhiều.

GET /v1/models: Mô hình khả dụng

Endpoint GET /v1/models liệt kê các mô hình có sẵn có thể truy cập qua API. Điều này hữu ích để kiểm tra động các mô hình có sẵn hoặc xác nhận ID mô hình. Thông thường, bạn sẽ nhận được danh sách với mô hình uncensored.

Phản hồi chứa siêu dữ liệu về mô hình, như ID, chủ sở hữu và ngày tạo. Khác với một số API khác, phản hồi tiêu chuẩn không chứa trực tiếp độ dài ngữ cảnh tối đa hoặc giá cụ thể. Thông tin này phải được lấy từ tài liệu hoặc dashboard. Tuy nhiên, endpoint này không thể thiếu để cấu hình tự động client.

Kopierenimport OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.kiapis.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 endpoint này để thích ứng ứng dụng của bạn với các thay đổi trong tương lai. Khi các mô hình mới được thêm vào, chúng sẽ tự động xuất hiện trong danh sách này. Mô hình hiện tại uncensored là mô hình khả dụng duy nhất và được đặc trưng bởi mô tả là mô hình ngôn ngữ lớn được tối ưu hóa cho nội dung không kiểm duyệt.

Giới hạn tốc độ và mã lỗi

Để đảm bảo sự ổn định của dịch vụ, có các giới hạn nhất định. Mỗi khóa API được phép 300 yêu cầu mỗi phút. Thân yêu cầu tối đa là 8 MB. Nếu vượt quá giới hạn này, bạn sẽ nhận được mã trạng thái HTTP 429 Too Many Requests. Hãy lập kế hoạch ứng dụng của bạn để triển khai các yêu cầu thử lại với backoff theo cấp số nhân.

Các mã lỗi phổ biến khác là 401 Unauthorized khi khóa API không hợp lệ và 402 Payment Required khi tín dụng của bạn đã hết. KiApi sử dụng mô hình trả trước, vì vậy các yêu cầu không có tín dụng sẽ bị từ chối ngay lập tức. Hãy đảm bảo kiểm tra số dư tài khoản của bạn thường xuyên.

Cửa sổ ngữ cảnh là 100.000 token cho cả đầu vào và đầu ra cộng lại. Vượt quá giới hạn này sẽ trả về thông báo lỗi. KiApi là giải pháp đáng tin cậy cho các nhà phát triển đánh giá cao các quy tắc rõ ràng và giới hạn minh bạch.