From 2bfacd0469e580ee89a4ae81f9bdceda9a0ea60d Mon Sep 17 00:00:00 2001 From: KevinHuSh Date: Fri, 17 May 2024 18:06:20 +0800 Subject: [PATCH] refine doc about API: completion (#829) ### What problem does this PR solve? #808 ### Type of change - [x] Documentation Update --- docs/conversation_api.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/conversation_api.md b/docs/conversation_api.md index bc40983e3..8166ec267 100644 --- a/docs/conversation_api.md +++ b/docs/conversation_api.md @@ -220,8 +220,10 @@ This will be called to get the answer to users' questions. | name | type | optional | description| |------|-------|----|----| | conversation_id| string | No | This is from calling /new_conversation.| -| messages| json | No | All the conversation history stored here including the latest user's question.| +| messages| json | No | The latest question, such as `[{"role": "user", "content": "How are you doing!"}]`| | quote | bool | Yes | Default: true | +| stream | bool | Yes | Default: true | +| doc_ids | string | Yes | Document IDs which is delimited by comma, like `c790da40ea8911ee928e0242ac180005,c790da40ea8911ee928e0242ac180005`. The retrieved content is limited in these documents. | ### Response ```json