KevinHuSh commited on
Commit
719cc35
·
1 Parent(s): 22b2836

refine doc about API: completion (#829)

Browse files

### What problem does this PR solve?
#808

### Type of change

- [x] Documentation Update

Files changed (1) hide show
  1. docs/conversation_api.md +3 -1
docs/conversation_api.md CHANGED
@@ -220,8 +220,10 @@ This will be called to get the answer to users' questions.
220
  | name | type | optional | description|
221
  |------|-------|----|----|
222
  | conversation_id| string | No | This is from calling /new_conversation.|
223
- | messages| json | No | All the conversation history stored here including the latest user's question.|
224
  | quote | bool | Yes | Default: true |
 
 
225
 
226
  ### Response
227
  ```json
 
220
  | name | type | optional | description|
221
  |------|-------|----|----|
222
  | conversation_id| string | No | This is from calling /new_conversation.|
223
+ | messages| json | No | The latest question, such as `[{"role": "user", "content": "How are you doing!"}]`|
224
  | quote | bool | Yes | Default: true |
225
+ | stream | bool | Yes | Default: true |
226
+ | doc_ids | string | Yes | Document IDs which is delimited by comma, like `c790da40ea8911ee928e0242ac180005,c790da40ea8911ee928e0242ac180005`. The retrieved content is limited in these documents. |
227
 
228
  ### Response
229
  ```json