Skip to content

Tạo đầu ra có cấu trúc

POST
/v1/messages
  • Điểm cuối Structured Outputs (đầu ra có cấu trúc) của Anthropic Messages API
  • Dùng output_format với json_schema để ràng buộc mô hình trả về JSON khớp schema
  • Tiêu đề yêu cầu anthropic-beta: structured-outputs-2025-11-13 để bật khả năng này
  • Tài liệu chính thức: Structured Outputs

Authorizations

bearer
Type
HTTP (bearer)

Request Body

application/json
object

ID mô hình cần dùng. Xem bảng tương thích endpoint mô hình cho các mô hình dùng được với Chat API.

object[]
Required

Danh sách tin nhắn tạo thành cuộc hội thoại. Ví dụ mã Python.

Nhiệt độ lấy mẫu từ 0 đến 2. Giá trị cao hơn (vd. 0,8) làm đầu ra ngẫu nhiên hơn; thấp hơn (vd. 0,2) tập trung và xác định hơn. Nên chỉ thay đổi tham số này hoặc top_p, không cả hai.

Lấy mẫu nucleus thay cho nhiệt độ: mô hình xét các token có khối lượng xác suất tích lũy trong top_p. 0,1 nghĩa là chỉ 10% khối lượng xác suất trên cùng. Nên chỉ thay đổi tham số này hoặc temperature, không cả hai.

Mặc định 1
Số lựa chọn hoàn thành chat sinh ra cho mỗi tin nhắn đầu vào.

Mặc định false. Nếu bật, delta tin nhắn từng phần được gửi qua SSE như ChatGPT, đến khi luồng kết thúc bằng data: [DONE]. Ví dụ mã Python.

Mặc định null. Tối đa 4 chuỗi mà API dừng sinh token tiếp theo.

Mặc định inf
Số token tối đa sinh trong hoàn thành chat.

Tổng độ dài token đầu vào và sinh bị giới hạn bởi ngữ cảnh mô hình. Ví dụ đếm token bằng Python.

Số từ -2,0 đến 2,0. Giá trị dương phạt token mới theo việc đã xuất hiện trong văn bản, tăng khả năng chủ đề mới. Chi tiết phạt tần suất và hiện diện

Mặc định 0. Số từ -2,0 đến 2,0. Giá trị dương phạt token mới theo tần suất trong văn bản, giảm lặp. Chi tiết phạt tần suất và hiện diện.

Sửa xác suất token chỉ định xuất hiện trong hoàn thành.

Nhận đối tượng JSON ánh xạ ID token (từ tokenizer) sang bias từ -100 đến 100. Bias cộng vào logit trước lấy mẫu; hiệu ứng tùy mô hình. Giá trị -1 đến 1 giảm/tăng khả năng chọn; -100 hoặc 100 nên vô hiệu hóa hoặc chỉ chọn token đó.

Định danh duy nhất người dùng cuối. Giúp OpenAI giám sát và phát hiện lạm dụng. Tìm hiểu thêm

Đối tượng chỉ định định dạng mô hình phải xuất. { "type": "json_object" } bật chế độ JSON. Quan trọng: với chế độ JSON cần hướng dẫn mô hình sinh JSON qua system hoặc user; nếu không mô hình có thể stream khoảng trắng đến giới hạn token. Nếu finish_reason="length", nội dung có thể bị cắt khi vượt max_tokens hoặc ngữ cảnh.

Tính năng beta. Nếu chỉ định, hệ thống cố gắng lấy mẫu xác định để yêu cầu lặp cùng seed và tham số trả cùng kết quả. Không đảm bảo; dùng system_fingerprint để theo dõi thay đổi backend.

Danh sách công cụ mô hình có thể gọi. Hiện chỉ hỗ trợ hàm. Cung cấp hàm mà mô hình có thể sinh đầu vào JSON.

Điều khiển hàm (nếu có) mô hình gọi. none: không gọi hàm, chỉ tin nhắn. auto: mô hình chọn tin nhắn hoặc hàm. Ép hàm bằng {"type": "function", "function": {"name": "my_function"}}. Mặc định none nếu không có hàm; auto nếu có hàm.

object

Cấu hình đầu ra có cấu trúc; khi typejson_schema, schema ràng buộc JSON trả về.

Responses

application/json
object
object[]
Required
object
Required

Playground

Authorization
Body

Samples