cicora.ai
Đặc tả APIĐầu ra an toàn theo lược đồ

Đầu ra có cấu trúc

Yêu cầu đối tượng JSON hoặc JSON Schema khi phần mềm, thay vì con người, sẽ sử dụng phản hồi.

Tài liệu tham khảo tích hợp: chọn tham số và năng lực khả dụng từ cài đặt API tài khoản và danh mục mô hình cho môi trường của bạn.

Đặt response_format

Chế độ JSON hữu ích cho đối tượng đơn giản. JSON Schema bổ sung tên lược đồ, cấu trúc trường, thuộc tính bắt buộc và cách từ chối thuộc tính thừa.

Lược đồ nghiêm ngặt giảm nhu cầu phân tích phòng vệ, nhưng không bao giờ thay thế việc kiểm tra tính hợp lệ ở phía ứng dụng.

Định dạng phản hồi JSON Schema
json
{
  "model": "openai/gpt-5.6-sol",
  "messages": [{"role": "user", "content": "Extract an order summary."}],
  "response_format": {
    "type": "json_schema",
    "json_schema": {
      "name": "order_summary",
      "strict": true,
      "schema": {
        "type": "object",
        "properties": {"items": {"type": "array"}, "total": {"type": "number"}},
        "required": ["items", "total"],
        "additionalProperties": false
      }
    }
  }
}

Thiết kế lược đồ

  • Giữ trường và mô tả ngắn gọn, cụ thể theo miền.
  • Đặt additionalProperties: false khi không chấp nhận các trường không xác định.
  • Quản lý phiên bản lược đồ trong mã của bạn thay vì âm thầm thay đổi hợp đồng với bên sử dụng.

Xử lý kết quả

Kiểm tra tính hợp lệ của JSON trả về bằng cùng trình kiểm tra hợp lệ mà API hoặc cơ sở dữ liệu của bạn sử dụng.

Nếu mô hình hoặc tuyến không nhận định dạng được yêu cầu, hãy hiển thị lỗi có kiểm soát và chọn tùy chọn tương thích qua danh mục mô hình.