Tài liệu API: Hướng dẫn bắt đầu nhanh

Base URL và Xác thực

API Heretic AI hoàn toàn tương thích OpenAI. Bạn tương tác với nó bằng cách trỏ máy khách của bạn đến URL cơ sở của chúng tôi: https://api.hereticai.cc/v1. Xác thực dựa trên một khóa API duy nhất cho mỗi tài khoản, được tạo ngay lập tức khi đăng ký qua Google hoặc email. Truyền khóa này trong Authorization header dưới dạng mã Bearer. Định danh mô hình đơn giản chỉ là uncensored. Mô hình đơn lẻ này xử lý tất cả các yêu cầu của bạn mà không có độ phức tạp về định tuyến. Lỗi 401 cho biết khóa không hợp lệ, trong khi 402 có nghĩa là bạn cần thêm số dư tiền điện tử trả trước.

Copycurl https://api.hereticai.cc/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "generate twenty test cases"}]
  }'

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

Gửi các yêu cầu tạo văn bản bằng cách sử dụng POST /v1/chat/completions endpoint. endpoint. API mong đợi một mảng messages tiêu chuẩn chứa lịch sử hội thoại hoặc prompt của bạn. Nó trả về văn bản được tạo trong choices mảng. Đây là một API tiện ích thuần túy: văn bản vào, văn bản ra. Bạn chỉ trả tiền cho các token đã tiêu thụ. Tín dụng trả trước không bao giờ hết hạn, và việc từ chối hoặc lỗi không tốn token. Cách tiếp cận này loại bỏ các gói đăng ký khóa chặt và các gói miễn phí không dự đoán được.

Copyfrom openai import OpenAI

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

Phản hồi luồng (SSE)

Bật phát trực tiếp token bằng cách đặt stream: true trong yêu cầu của bạn. API trả về các Sự kiện gửi từ máy chủ (SSE) cho mỗi token được tạo. Điều này cho phép bạn hiển thị đầu ra dần dần, điều rất quan trọng đối với các ứng dụng nhạy cảm với độ trễ. Thống kê sử dụng token xuất hiện trong chunk cuối cùng của luồng. Tính năng này hoạt động liền mạch với các SDK OpenAI tiêu chuẩn xử lý SSE tự động. Nó cung cấp phản hồi ngay lập tức mà không cần chờ phần hoàn tất đầy đủ.

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)

Function Calling và các công cụ

API hỗ trợ gọi hàm với tools và tool_choice tham số. Xác định lược đồ công cụ của bạn trong yêu cầu, và mô hình sẽ trả về các lệnh gọi hàm có cấu trúc khi phù hợp. Điều này cho phép các quy trình làm việc phức tạp nơi LLM quyết định hành động tiếp theo là gì. Bạn có thể buộc sử dụng công cụ cụ thể hoặc để mô hình tự do lựa chọn. Khả năng này rất quan trọng để xây dựng các ứng dụng tác nhân tương tác với các hệ thống bên ngoài hoặc cơ sở dữ liệu.

Chế độ JSON

Đảm bảo đầu ra xác định bằng cách đặt response_format để {"type": "json_object"}. Mô hình sẽ hạn chế phản hồi của nó ở JSON hợp lệ, điều rất quan trọng cho việc phân tích cú pháp lập trình. Điều này giảm nhu cầu sửa chữa regex sau xử lý. Nó đảm bảo rằng đầu ra có thể được tiêu thụ trực tiếp bởi mã của bạn. Điều này đặc biệt hữu ích cho các tác vụ trích xuất dữ liệu có cấu trúc hoặc tạo cấu hình.

Tham số và Giới hạn

Kiểm soát quá trình sinh văn bản bằng các tham số tiêu chuẩn như temperature, top_p, và seed. Cửa sổ ngữ cảnh là 100,000 token cho prompt cộng với hoàn thiện. Đầu ra tối đa là 16,000 token mỗi yêu cầu, hoặc 2,048 nếu max_tokens chưa được đặt. Giới hạn tốc độ là 300 yêu cầu mỗi phút và 8 yêu cầu đồng thời trên mỗi khóa. Thân yêu cầu phải dưới 8 MB. Các giới hạn này đảm bảo việc sử dụng khối lượng lớn ổn định cho các nhà phát triển.

Node.js

Copyimport OpenAI from "openai";

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