Chat Completions

Tạo phản hồi văn bản, đa phương thức và gọi công cụ bằng API Chat Completions tương thích OpenAI.

API Chat Completions tạo phản hồi của mô hình từ danh sách tin nhắn, phù hợp với hội thoại văn bản, đầu vào đa phương thức, đầu ra dạng luồng, đầu ra có cấu trúc và gọi công cụ hàm. Các kiểu đầu vào và tham số nâng cao có thể khác nhau giữa các mô hình; hãy căn cứ vào mô hình khả dụng với API Key hiện tại và kết quả gọi thực tế.

POST/v1/chat/completions

Tạo phản hồi của mô hình từ danh sách tin nhắn đã cho. API hỗ trợ phản hồi thông thường và phản hồi dạng luồng SSE; các chức năng nâng cao như hình ảnh, âm thanh, gọi công cụ và đầu ra có cấu trúc phụ thuộc vào mô hình đã chọn.

Khi đổi mô hình, nên kiểm tra chức năng cơ bản bằng yêu cầu văn bản tối thiểu trước, rồi bật từng tham số nâng cao.

Xác thực

bearerAuth

Xác thựcBearer <token>

Sử dụng Bearer your-api-key trong Header Authorization.

Vị trí truyền: header

Nội dung yêu cầu

Chọn cấu trúc yêu cầu theo phương thức đầu vào của mô hình. Cả ba chế độ đều sử dụng cùng endpoint Chat Completions và cùng các tham số tạo nội dung.

application/json

Hội thoại văn bản

Dùng cho hội thoại thông thường, tạo nội dung và suy luận văn bản. Nội dung tin nhắn có thể là chuỗi ký tự.

model: ID mô hình văn bản khả dụng với tài khoản hiện tại.
messages[].role: Vai trò tin nhắn, chẳng hạn user, system hoặc assistant.
messages[].content: Tin nhắn văn bản ở dạng chuỗi ký tự.

application/json

{
  "model": "MODEL_ID",
  "messages": [
    {
      "role": "user",
      "content": "Xin chào! Hãy giới thiệu bản thân bằng một câu."
    }
  ]
}

Yêu cầu hội thoại văn bản. Tin nhắn người dùng có thể là chuỗi ký tự hoặc mảng nội dung chỉ chứa text.

model*string

ID mô hình văn bản cần dùng. Sao chép ID mô hình hỗ trợ đầu vào văn bản và khả dụng với tài khoản hiện tại từ danh mục mô hình.

Độ dài1 <= length

messages*array<|||||>

Danh sách tin nhắn hội thoại văn bản theo thứ tự gửi.

Số phần tử1 <= items

store?boolean|null

Có lưu đầu ra của chat completion này hay không. Việc áp dụng phụ thuộc vào mô hình và kênh đã chọn.

Giá trị mặc địnhfalse

reasoning_effort?string|null

Mức suy luận của mô hình suy luận. Giá trị khả dụng phụ thuộc vào mô hình đã chọn; none tắt rõ ràng mức suy luận.

Giá trị mặc định"medium"

Giá trị được phép

"none"
"minimal"
"low"
"medium"
"high"
"xhigh"
"max"
null

metadata?|null

Thông tin khóa–giá trị đính kèm yêu cầu. Khóa tối đa 64 ký tự, giá trị tối đa 512 ký tự.

Số thuộc tínhproperties <= 16

modalities?array<>|null

Các kiểu đầu ra muốn mô hình tạo. Mặc định chỉ tạo văn bản.

prediction?|null

Cấu hình nội dung dự đoán khi đã biết phần lớn đầu ra mong đợi.

audio?|null

Cấu hình định dạng và giọng nói khi yêu cầu đầu ra âm thanh.

temperature?number|null

Nhiệt độ lấy mẫu. Thường chỉ điều chỉnh một trong hai tham số temperature hoặc top_p; mức hỗ trợ phụ thuộc vào mô hình đã chọn.

Phạm vi0 <= value <= 2

Giá trị mặc định1

top_p?number|null

Khối xác suất cho lấy mẫu nucleus. Thường chỉ điều chỉnh một trong hai tham số temperature hoặc top_p; mức hỗ trợ phụ thuộc vào mô hình đã chọn.

Phạm vi0 <= value <= 1

Giá trị mặc định1

n?integer|null

Số phản hồi ứng viên được tạo cho mỗi đầu vào. Tạo nhiều ứng viên sẽ làm tăng mức sử dụng.

Phạm vi1 <= value <= 128

Giá trị mặc định1

stop?string|array<string>|null

Tối đa bốn chuỗi dừng. Mức hỗ trợ và hành vi cụ thể phụ thuộc vào mô hình đã chọn.

max_tokens?integer|null

Đã ngừng khuyến nghị

Tham số giới hạn token đầu ra kiểu cũ. Nên sử dụng max_completion_tokens.

Phạm vi1 <= value

max_completion_tokens?integer|null

Giới hạn token được tạo trong completion, bao gồm đầu ra hiển thị và token suy luận.

presence_penalty?number|null

Áp dụng mức phạt dựa trên việc token đã xuất hiện hay chưa để tăng khả năng thảo luận chủ đề mới. Mức hỗ trợ phụ thuộc vào mô hình đã chọn.

Phạm vi-2 <= value <= 2

Giá trị mặc định0

frequency_penalty?number|null

Áp dụng mức phạt dựa trên tần suất xuất hiện của token để giảm nội dung lặp lại. Mức hỗ trợ phụ thuộc vào mô hình đã chọn.

Phạm vi-2 <= value <= 2

Giá trị mặc định0

logit_bias?|null

Ánh xạ ID token sang giá trị độ lệch từ -100 đến 100.

logprobs?boolean|null

Có trả về log xác suất của token đầu ra hay không. Mức hỗ trợ phụ thuộc vào mô hình đã chọn.

Giá trị mặc địnhfalse

user?string

Đã ngừng khuyến nghị

Định danh người dùng cuối đã ngừng khuyến nghị. Dùng safety_identifier để giám sát an toàn và prompt_cache_key để định tuyến bộ nhớ đệm.

safety_identifier?string|null

Định danh người dùng cuối ổn định để giám sát an toàn và hành vi lạm dụng. Nên dùng giá trị đã băm và không chứa thông tin cá nhân.

Độ dàilength <= 64

prompt_cache_key?string|null

Khóa ổn định để tăng tỷ lệ trúng bộ nhớ đệm cho các yêu cầu tương tự. Không chứa thông tin cá nhân hoặc dữ liệu nhạy cảm khác.

prompt_cache_options?|null

Cấu hình bộ nhớ đệm prompt ở cấp yêu cầu.

prompt_cache_retention?string|null

Đã ngừng khuyến nghị

Cấu hình thời gian lưu bộ nhớ đệm đã ngừng khuyến nghị. Thay bằng prompt_cache_options.ttl.

Giá trị được phép

"in_memory"
"24h"
null

verbosity?string|null

Điều khiển mức độ chi tiết của câu trả lời văn bản. Mức hỗ trợ phụ thuộc vào mô hình đã chọn.

Giá trị mặc định"medium"

Giá trị được phép

"low"
"medium"
"high"
null

moderation?|null

Cấu hình chính sách kiểm duyệt nội dung đầu vào và đầu ra.

service_tier?string|null

Cấp dịch vụ sử dụng cho yêu cầu. Khả năng sử dụng phụ thuộc vào tài khoản và chức năng phía nhà cung cấp.

Giá trị mặc định"auto"

Giá trị được phép

"auto"
"default"
"flex"
"scale"
"priority"
"fast"
null

stream_options?|null

Tùy chọn phản hồi dạng luồng chỉ sử dụng khi stream: true.

response_format?||

Chỉ định định dạng đầu ra của mô hình. Mức hỗ trợ đầu ra có cấu trúc phụ thuộc vào mô hình đã chọn.

seed?integer|null

Đã ngừng khuyến nghị

Tham số Beta cố gắng lấy mẫu có tính xác định; không bảo đảm kết quả hoàn toàn xác định.

tools?array<|>

Danh sách công cụ mô hình có thể gọi.

Số phần tửitems <= 128

functions?array<>

Đã ngừng khuyến nghị

Định nghĩa hàm kiểu cũ. Nên chuyển sang tools.

tool_choice?|||

Điều khiển việc mô hình gọi công cụ, buộc gọi công cụ chỉ định hoặc giới hạn phạm vi công cụ được phép sử dụng.

function_call?|

Đã ngừng khuyến nghị

Tham số chọn hàm kiểu cũ. Nên chuyển sang tool_choice.

parallel_tool_calls?boolean

Có cho phép mô hình gọi nhiều công cụ song song trong một phản hồi hay không.

Giá trị mặc địnhtrue

stream?boolean|null

Khi là true, trả về các khối dữ liệu chat completion tăng dần qua Server-Sent Events.

Giá trị mặc địnhfalse

top_logprobs?integer|null

Số token có xác suất cao nhất được trả về tại mỗi vị trí token. Đồng thời đặt logprobs: true khi sử dụng; mức hỗ trợ phụ thuộc vào mô hình đã chọn.

Phạm vi0 <= value <= 20

web_search_options?

Đầu vào hình ảnh và âm thanh chỉ dùng được với mô hình hỗ trợ phương thức tương ứng; hãy kiểm tra các mô hình khả dụng với tài khoản hiện tại và chức năng API thực tế.

Nội dung phản hồi

`application/json`

curl -X POST "https://example.com/v1/chat/completions" \  -H "Content-Type: application/json" \  -d '{    "model": "MODEL_ID",    "messages": [      {        "role": "user",        "content": "Xin chào! Hãy giới thiệu bản thân bằng một câu."      }    ]  }'

{
  "id": "chatcmpl_example",
  "object": "chat.completion",
  "created": 1741569952,
  "model": "MODEL_ID",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "Xin chào! Tôi có thể giúp gì cho bạn?",
        "refusal": null,
        "annotations": []
      },
      "logprobs": null,
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 19,
    "completion_tokens": 10,
    "total_tokens": 29,
    "prompt_tokens_details": {
      "cached_tokens": 0,
      "audio_tokens": 0
    },
    "completion_tokens_details": {
      "reasoning_tokens": 0,
      "audio_tokens": 0,
      "accepted_prediction_tokens": 0,
      "rejected_prediction_tokens": 0
    }
  }
}

Tài liệu chính thức về OpenAI Chat CompletionsXem định nghĩa giao thức của nhà cung cấp và các thay đổi mới nhất về trường.

Xác thực

Nội dung yêu cầu

Nội dung phản hồi

200application/json

400application/json

401application/json

403application/json

404application/json

429application/json

500application/json

502application/json

503application/json

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`