weiweiw
/
Langchain-Chatchat
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

add api.py

This commit is contained in:
imClumsyPanda 2023-05-03 22:35:05 +08:00
parent 2c1fd2bdd5
commit b03634fb7c
1 changed files with 19 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
docs/API.md
View File

@ -49,7 +49,7 @@ Accept: application/json
```javascript ```javascript
const inputBody = '{ const inputBody = '{
"local_doc_id": "string", "knowledge_base_id": "string",
"question": "string", "question": "string",
"history": [] "history": []
}'; }';
@ -185,7 +185,7 @@ func main() {
```json ```json
{ {
"local_doc_id": "string", "knowledge_base_id": "string",
"question": "string", "question": "string",
"history": [] "history": []
} }
@ -257,7 +257,7 @@ const inputBody = '{
"files": [ "files": [
"string" "string"
], ],
"local_doc_id": "string" "knowledge_base_id": "string"
}'; }';
const headers = { const headers = {
'Content-Type':'multipart/form-data', 'Content-Type':'multipart/form-data',
@ -392,7 +392,7 @@ func main() {
```yaml ```yaml
files: files:
- string - string
local_doc_id: string knowledge_base_id: string
``` ```
@ -432,13 +432,13 @@ This operation does not require authentication
```shell ```shell
# You can also use wget # You can also use wget
curl -X GET /chat-docs/list?local_doc_id=doc_id1 \ curl -X GET /chat-docs/list?knowledge_base_id=doc_id1 \
-H 'Accept: application/json' -H 'Accept: application/json'
``` ```
```http ```http
GET /chat-docs/list?local_doc_id=doc_id1 HTTP/1.1 GET /chat-docs/list?knowledge_base_id=doc_id1 HTTP/1.1
Accept: application/json Accept: application/json
@ -450,7 +450,7 @@ const headers = {
'Accept':'application/json' 'Accept':'application/json'
}; };
fetch('/chat-docs/list?local_doc_id=doc_id1', fetch('/chat-docs/list?knowledge_base_id=doc_id1',
{ {
method: 'GET', method: 'GET',
@ -474,7 +474,7 @@ headers = {
result = RestClient.get '/chat-docs/list', result = RestClient.get '/chat-docs/list',
params: { params: {
'local_doc_id' => 'string' 'knowledge_base_id' => 'string'
}, headers: headers }, headers: headers
p JSON.parse(result) p JSON.parse(result)
@ -488,7 +488,7 @@ headers = {
} }
r = requests.get('/chat-docs/list', params={ r = requests.get('/chat-docs/list', params={
'local_doc_id': 'doc_id1' 'knowledge_base_id': 'doc_id1'
}, headers = headers) }, headers = headers)
print(r.json()) print(r.json())
@ -527,7 +527,7 @@ try {
``` ```
```java ```java
URL obj = new URL("/chat-docs/list?local_doc_id=doc_id1"); URL obj = new URL("/chat-docs/list?knowledge_base_id=doc_id1");
HttpURLConnection con = (HttpURLConnection) obj.openConnection(); HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET"); con.setRequestMethod("GET");
int responseCode = con.getResponseCode(); int responseCode = con.getResponseCode();
@ -576,7 +576,7 @@ func main() {
|Name|In|Type|Required|Description| |Name|In|Type|Required|Description|
|---|---|---|---|---| |---|---|---|---|---|
|local_doc_id|query|string|true|Document ID| |knowledge_base_id|query|string|true|Document ID|
> Example responses > Example responses
@ -629,7 +629,7 @@ Accept: application/json
```javascript ```javascript
const inputBody = '{ const inputBody = '{
"local_doc_id": "string", "knowledge_base_id": "string",
"doc_name": "string" "doc_name": "string"
}'; }';
const headers = { const headers = {
@ -763,7 +763,7 @@ func main() {
> Body parameter > Body parameter
```yaml ```yaml
local_doc_id: string knowledge_base_id: string
doc_name: string doc_name: string
``` ```
@ -831,7 +831,7 @@ BaseResponse
```json ```json
{ {
"local_doc_id": "string", "knowledge_base_id": "string",
"question": "string", "question": "string",
"history": [] "history": []
} }
@ -844,7 +844,7 @@ Body_chat_chat_docs_chat_post
|Name|Type|Required|Restrictions|Description| |Name|Type|Required|Restrictions|Description|
|---|---|---|---|---| |---|---|---|---|---|
|local_doc_id|string|true|none|Document ID| |knowledge_base_id|string|true|none|Knowledge Base Name|
|question|string|true|none|Question| |question|string|true|none|Question|
|history|[array]|false|none|History of previous questions and answers| |history|[array]|false|none|History of previous questions and answers|
@ -857,7 +857,7 @@ Body_chat_chat_docs_chat_post
```json ```json
{ {
"local_doc_id": "string", "knowledge_base_id": "string",
"doc_name": "string" "doc_name": "string"
} }
@ -869,7 +869,7 @@ Body_delete_docs_chat_docs_delete_delete
|Name|Type|Required|Restrictions|Description| |Name|Type|Required|Restrictions|Description|
|---|---|---|---|---| |---|---|---|---|---|
|local_doc_id|string|true|none|local doc id| |knowledge_base_id|string|true|none|Knowledge Base Name|
|doc_name|string|false|none|doc name| |doc_name|string|false|none|doc name|
<h2 id="tocS_Body_upload_file_chat_docs_upload_post">Body_upload_file_chat_docs_upload_post</h2> <h2 id="tocS_Body_upload_file_chat_docs_upload_post">Body_upload_file_chat_docs_upload_post</h2>
@ -884,7 +884,7 @@ Body_delete_docs_chat_docs_delete_delete
"files": [ "files": [
"string" "string"
], ],
"local_doc_id": "string" "knowledge_base_id": "string"
} }
``` ```
@ -896,7 +896,7 @@ Body_upload_file_chat_docs_upload_post
|Name|Type|Required|Restrictions|Description| |Name|Type|Required|Restrictions|Description|
|---|---|---|---|---| |---|---|---|---|---|
|files|[string]|true|none|none| |files|[string]|true|none|none|
|local_doc_id|string|true|none|Local document ID| |knowledge_base_id|string|true|none|Knowledge Base Name|
<h2 id="tocS_ChatMessage">ChatMessage</h2> <h2 id="tocS_ChatMessage">ChatMessage</h2>
<!-- backwards compatibility --> <!-- backwards compatibility -->