yujunjun/ragflow
1
0
Fork 0
mirror of https://github.com/infiniflow/ragflow.git synced 2025-09-26 00:24:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

refine doc about API: completion (#829)

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

### Type of change

- [x] Documentation Update
This commit is contained in:
KevinHuSh 2024-05-17 18:06:20 +08:00 committed by GitHub
parent b3c923da6b
commit 2bfacd0469
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/conversation_api.md
View File

@ -220,8 +220,10 @@ This will be called to get the answer to users' questions.
| name | type | optional | description| | name | type | optional | description|
|------|-------|----|----| |------|-------|----|----|
| conversation_id| string | No | This is from calling /new_conversation.| | 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 | | 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 ### Response
```json ```json