AI AssistantTrò chuyện

Gửi tin nhắn

Gửi request đến ứng dụng trò chuyện.

Khi responseMode là blocking, trả về một ChatCompletionResponse. Khi responseMode là streaming, trả về luồng các sự kiện SSE.

Headers

X-Api-KeystringRequired

Request

This endpoint expects an object.
messagestringRequired

Nội dung đầu vào/câu hỏi của người dùng gửi tới trợ lý.

userIdstringRequired

Định danh người dùng cuối phía đối tác, dùng để xác định danh tính phục vụ cho việc tính toán thống kê và truy xuất. Nên được định nghĩa duy nhất bởi nhà phát triển trong ứng dụng — dùng chung userId này cho các API liên quan (cuộc trò chuyện, feedback, upload file…) của cùng một người dùng.

inputsmap from strings to anyOptionalDefaults to {}

Cho phép nhập các giá trị biến do App định nghĩa. Tham số inputs chứa nhiều cặp key/value, với mỗi key tương ứng với một biến cụ thể và mỗi value là giá trị cụ thể cho biến đó.

responseModeenumOptionalDefaults to streaming

Chế độ trả về phản hồi, hỗ trợ:

  • streaming — Chế độ streaming (khuyên dùng), trả kết quả dần theo dạng SSE (text/event-stream) — dùng taskId để gọi Dừng khởi tạo luồng văn bản nếu cần dừng giữa chừng.
  • blocking — Chế độ blocking, chờ xử lý xong mới trả kết quả trong 1 response duy nhất. Request có thể bị gián đoạn nếu quá trình xử lý dài — do giới hạn hạ tầng, request sẽ bị gián đoạn mà không có phản hồi sau 100 giây. Lưu ý: chế độ blocking không được hỗ trợ khi bật Agent Assistant.
conversationIdstring or nullOptional

Mã cuộc trò chuyện — bỏ trống (hoặc chuỗi rỗng "") để bắt đầu cuộc trò chuyện mới; hệ thống sẽ tự sinh và trả về một conversationId mới trong response. Để tiếp tục cuộc trò chuyện đã có (giữ ngữ cảnh các tin nhắn trước), truyền vào đúng conversationId đã nhận được ở lần gọi trước đó.

fileslist of objects or nullOptional
autoGenerateNamebooleanOptionalDefaults to true

Tự động tạo tiêu đề cuộc trò chuyện dựa theo nội dung tin nhắn đầu tiên, mặc định là true. Nếu đặt là false, có thể tự đặt tên cuộc trò chuyện sau bằng cách gọi API Conversation Rename.

Response

Khi `responseMode` là `blocking`, trả về `application/json` chứa `ChatCompletionResponse`. Khi `responseMode` là `streaming`, trả về `text/event-stream` — mỗi streaming chunk bắt đầu bằng `data:`, ngăn cách bởi hai ký tự xuống dòng `\n\n`. Cấu trúc của streaming chunk thay đổi tuỳ thuộc vào `event`: - `message` — LLM trả về text chunk, tức văn bản hoàn chỉnh được xuất ra theo từng đoạn nhỏ. Gồm `taskId`, `messageId`, `conversationId`, `answer` (đoạn văn bản), `createdAt`. - `agent_message` — tương tự `message` nhưng dùng khi bật chế độ Agent Assistant (chỉ hỗ trợ trong chế độ Agent). - `agent_thought` — luồng suy luận của Agent, chứa các bước suy luận của LLM cùng kết quả input/output khi gọi tools (chỉ hỗ trợ trong chế độ Agent). Gồm `id`, `taskId`, `messageId`, `position`, `thought`, `observation`, `tool`, `toolInput` (JSON), `messageFiles`, `createdAt`. - `message_file` — một tệp mới vừa được công cụ tạo ra. Gồm `id`, `type` (hiện chỉ `image`), `belongsTo` (`assistant`), `url`, `conversationId`. - `message_end` — sự kiện kết thúc tin nhắn, nhận sự kiện này nghĩa là quá trình stream đã kết thúc. Gồm `taskId`, `messageId`, `conversationId`, `metadata` (`usage`, `retrieverResources`). - `message_replace` — sự kiện thay thế nội dung tin nhắn. Khi tính năng kiểm duyệt nội dung đầu ra được bật, nếu nội dung bị cấm kỵ, nội dung tin nhắn sẽ được thay thế bằng một câu trả lời được cài đặt trước qua sự kiện này. Gồm `taskId`, `messageId`, `conversationId`, `answer` (nội dung thay thế), `createdAt`. - `error` — các ngoại lệ xảy ra trong quá trình streaming sẽ được xuất ra dưới dạng sự kiện, và khi nhận được sẽ kết thúc luồng stream. Gồm `taskId`, `messageId`, `status` (HTTP status code), `code`, `message`. - `ping` — sự kiện giữ kết nối, gửi mỗi 10 giây để tránh bị đóng kết nối.
messageIdstring

Mã tin nhắn — dùng cho Message Feedback, Next Suggested Questions.

conversationIdstring

Mã cuộc trò chuyện — dùng cho các tin nhắn tiếp theo trong cùng cuộc trò chuyện, hoặc cho các API quản lý cuộc trò chuyện (lịch sử tin nhắn, đổi tên, xoá).

modestring

Chế độ ứng dụng, cố định là chat.

answerstring

Nội dung câu trả lời hoàn chỉnh của trợ lý.

metadataobject
createdAtlong

Thời điểm tạo tin nhắn, dạng Unix timestamp (giây). VD: 1705395332.

Errors

400
Bad Request Error
404
Not Found Error
500
Internal Server Error