API Tài liệu

Base URL và Xác thực

API nằm ở https://api.ollamaapidoc.com/v1. Bạn xác thực bằng một Bearer token trong Authorization header. Tạo khóa của bạn ngay lập tức qua Google hoặc email trên bảng điều khiển. Không cần số điện thoại. Khóa hoạt động với các SDK OpenAI tiêu chuẩn bằng cách đặt URL cơ sở.

Yêu cầu đầu tiên của bạn

Gửi yêu cầu POST đến /v1/chat/completions với ID mô hình uncensored. Điểm cuối này xử lý đầu vào văn bản và đầu ra văn bản. Nó hỗ trợ stream, chế độ JSON và gọi hàm. Bạn có thể kiểm tra kết nối mà không tiêu tốn tín dụng bằng cách kiểm tra điểm cuối models trước.

Copycurl https://api.ollamaapidoc.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "list all installed models"}]
  }'

Phản hồi trả về định dạng OpenAI tiêu chuẩn. Lỗi trả về các mã HTTP phù hợp. Kiểm tra phần thân để error chi tiết nếu có lỗi. Các phản hồi streaming sử dụng Sự kiện Gửi qua Máy chủ (SSE).

Tích hợp SDK Python

Cài đặt thư viện OpenAI chính thức. Cấu hình client với URL cơ sở và khóa API của bạn. Gọi điểm cuối hoàn thành trò chuyện. Mã vẫn giống hệt với việc sử dụng OpenAI tiêu chuẩn. Điều này đảm bảo di chuyển dễ dàng cho các dự án hiện có. Bạn có thể điều chỉnh các tham số như nhiệt độ và top_p trực tiếp trong lời gọi.

Copyfrom openai import OpenAI

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

Xử lý ngoại lệ cho giới hạn tốc độ hoặc khóa không hợp lệ. Thư viện phát trực tuyến token nếu bạn đặt stream thành true. Cách tiếp cận này giữ cho cơ sở mã của bạn sạch sẽ và tương thích.

Thiết lập SDK Node.js

Sử dụng openai gói npm. Khởi tạo máy khách với URL cơ sở tùy chỉnh. Truyền khóa API của bạn. Cú pháp giống với ví dụ Python. Sự nhất quán này giúp giảm thời gian gỡ lỗi. Bạn có thể gửi nhiều tin nhắn trong một mảng lịch sử hội thoại.

Copyimport OpenAI from "openai";

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

Phân tích phản hồi cẩn thận. API trả về JSON có cấu trúc. Xử lý lỗi là rất quan trọng đối với các ứng dụng sản xuất. Bắt lỗi mạng và lỗi cụ thể của API riêng biệt. Điều này đảm bảo ứng dụng của bạn vẫn phản hồi nhanh trong thời gian lưu lượng truy cập cao.

Chế Độ JSON và Streaming

Bật chế độ streaming bằng cách đặt stream tham số thành true. API gửi token thông qua Sự kiện gửi bởi máy chủ. Bạn nhận được phản hồi một phần theo thời gian thực. Điều này cải thiện trải nghiệm người dùng cho các kết quả đầu ra dài. Bạn cũng có thể buộc đầu ra JSON bằng response_format. Điều này hữu ích cho việc trích xuất dữ liệu có cấu trúc.

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)

Gọi hàm hoạt động tương tự. Xác định các công cụ trong yêu cầu của bạn. Mô hình trả về các lệnh gọi công cụ. Phân tích cú pháp các lệnh gọi này trong mã của bạn. Thực thi chúng và đưa kết quả lại cho mô hình. Vòng lặp này cho phép các quy trình làm việc phức tạp.

Giới hạn, Lỗi và Ngữ cảnh

Cửa sổ ngữ cảnh là 100,000 token. Output tối đa là 16,000 token mỗi yêu cầu. Lỗi bao gồm 401 cho key không hợp lệ và 402 cho tín dụng không đủ. Giới hạn tốc độ tối đa là 300 yêu cầu mỗi phút. Xử lý các lỗi này một cách khéo léo trong ứng dụng của bạn. API không bao giờ sử dụng prompt của bạn để huấn luyện. Quyền riêng tư được duy trì. Tín dụng không hết hạn.