github/DB-GPT
1
0
Fork 0
mirror of https://github.com/csunny/DB-GPT.git synced 2025-09-08 20:39:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc:update api docs

Browse Source
This commit is contained in:
aries_ckt
2024-03-20 18:40:59 +08:00
parent f43abf3155
commit 75f086a41d
5 changed files with 118 additions and 162 deletions
Download Patch File Download Diff File Expand all files Collapse all files

78
docs/docs/api/app.md
View File

@@ -27,14 +27,14 @@ import TabItem from '@theme/TabItem';
<TabItem value="curl">
```shell
DBGPT_API_KEY="dbgpt"
APP_ID="{YOUR_APP_ID}"
DBGPT_API_KEY=dbgpt
APP_ID={YOUR_APP_ID}
curl -X POST "http://localhost:5000/api/v2/chat/completions" \
-H "Authorization: Bearer $DBGPT_API_KEY" \
-H "accept: application/json" \
-H "Content-Type: application/json" \
-d "{\"messages\":\"Hello\",\"model\":\"chatgpt_proxyllm\", \"chat_mode\": \"chat_app\", \"chat_param\": "$APP_ID"}"
-d "{\"messages\":\"Hello\",\"model\":\"chatgpt_proxyllm\", \"chat_mode\": \"chat_app\", \"chat_param\": \"$APP_ID\"}"
```
</TabItem>
@@ -65,6 +65,43 @@ data: [DONE]
GET /api/v2/serve/apps/{app_id}
```
<Tabs
defaultValue="curl_get_app"
groupId="chat1"
values={[
{label: 'Curl', value: 'curl_get_app'},
{label: 'Python', value: 'python_get_app'},
]
}>
<TabItem value="curl_get_app">
```shell
DBGPT_API_KEY=dbgpt
APP_ID={YOUR_APP_ID}
curl -X GET "http://localhost:5000/api/v2/serve/apps/$APP_ID" -H "Authorization: Bearer $DBGPT_API_KEY"
```
</TabItem>
<TabItem value="python_get_app">
```python
from dbgpt.client.client import Client
from dbgpt.client.app import get_app
DBGPT_API_KEY = "dbgpt"
app_id = "{your_app_id}"
client = Client(api_key=DBGPT_API_KEY)
res = await get_app(client=client, app_id=app_id)
```
</TabItem>
</Tabs>
#### Query Parameters
________
<b>app_id</b> <font color="gray"> string </font> <font color="red"> Required </font>
@@ -80,6 +117,41 @@ Return <a href="#the-app-object">App Object</a>
```python
GET /api/v2/serve/apps
```
<Tabs
defaultValue="curl_list_app"
groupId="chat1"
values={[
{label: 'Curl', value: 'curl_list_app'},
{label: 'Python', value: 'python_list_app'},
]
}>
<TabItem value="curl_list_app">
```shell
DBGPT_API_KEY=dbgpt
curl -X GET 'http://localhost:5000/api/v2/serve/apps' -H "Authorization: Bearer $DBGPT_API_KEY"
```
</TabItem>
<TabItem value="python_list_app">
```python
from dbgpt.client.client import Client
from dbgpt.client.app import list_app
DBGPT_API_KEY = "dbgpt"
app_id = "{your_app_id}"
client = Client(api_key=DBGPT_API_KEY)
res = await list_app(client=client)
```
</TabItem>
</Tabs>
#### Response body
Return <a href="#the-app-object">App Object</a> List

58
docs/docs/api/flow.md
View File

@@ -27,14 +27,14 @@ import TabItem from '@theme/TabItem';
<TabItem value="curl">
```shell
DBGPT_API_KEY="dbgpt"
FLOW_ID="{YOUR_FLOW_ID}"
DBGPT_API_KEY=dbgpt
FLOW_ID={YOUR_FLOW_ID}
curl -X POST "http://localhost:5000/api/v2/chat/completions" \
curl -X POST "http://localhost:5000/api/v2/chat/completions" \
-H "Authorization: Bearer $DBGPT_API_KEY" \
-H "accept: application/json" \
-H "Content-Type: application/json" \
-d "{\"messages\":\"Hello\",\"model\":\"chatgpt_proxyllm\", \"chat_mode\": \"chat_flow\", \"chat_param\": "$FLOW_ID"}"
-d "{\"messages\":\"Hello\",\"model\":\"chatgpt_proxyllm\", \"chat_mode\": \"chat_flow\", \"chat_param\": \"$FLOW_ID\"}"
```
</TabItem>
@@ -86,27 +86,27 @@ DELETE /api/v2/serve/awel/flows
```
<Tabs
defaultValue="curl_update_knowledge"
defaultValue="curl_update_flow"
groupId="chat1"
values={[
{label: 'Curl', value: 'curl_update_knowledge'},
{label: 'Python', value: 'python_update_knowledge'},
{label: 'Curl', value: 'curl_update_flow'},
{label: 'Python', value: 'python_update_flow'},
]
}>
<TabItem value="curl_update_knowledge">
<TabItem value="curl_update_flow">
```shell
DBGPT_API_KEY="dbgpt"
FLOW_ID="{YOUR_FLOW_ID}"
DBGPT_API_KEY=dbgpt
FLOW_ID={YOUR_FLOW_ID}
curl -X DELETE "http://localhost:5000/api/v2/serve/knowledge/spaces/$FLOW_ID" \
curl -X DELETE "http://localhost:5000/api/v2/serve/awel/flows/$FLOW_ID" \
-H "Authorization: Bearer $DBGPT_API_KEY" \
```
</TabItem>
<TabItem value="python_update_knowledge">
<TabItem value="python_update_flow">
```python
@@ -140,26 +140,26 @@ Return <a href="#the-flow-object">Flow Object</a>
GET /api/v2/serve/awel/flows/{flow_id}
```
<Tabs
defaultValue="curl_get_knowledge"
defaultValue="curl_get_flow"
groupId="chat1"
values={[
{label: 'Curl', value: 'curl_get_knowledge'},
{label: 'Python', value: 'python_get_knowledge'},
{label: 'Curl', value: 'curl_get_flow'},
{label: 'Python', value: 'python_get_flow'},
]
}>
<TabItem value="curl_get_knowledge">
<TabItem value="curl_get_flow">
```shell
DBGPT_API_KEY="dbgpt"
FLOW_ID="{YOUR_FLOW_ID}"
DBGPT_API_KEY=dbgpt
FLOW_ID={YOUR_FLOW_ID}
curl -X GET "http://localhost:5000/api/v2/serve/awel/flows/$FLOW_ID" -H "Authorization: Bearer $DBGPT_API_KEY"
curl --location --request GET 'http://localhost:5000/api/v2/serve/awel/flows/$FLOW_ID' \
--header 'Authorization: Bearer $DBGPT_API_KEY'
```
</TabItem>
<TabItem value="python_get_knowledge">
<TabItem value="python_get_flow">
```python
@@ -195,25 +195,25 @@ GET /api/v2/serve/awel/flows
<Tabs
defaultValue="curl_list_knowledge"
defaultValue="curl_list_flow"
groupId="chat1"
values={[
{label: 'Curl', value: 'curl_list_knowledge'},
{label: 'Python', value: 'python_list_knowledge'},
{label: 'Curl', value: 'curl_list_flow'},
{label: 'Python', value: 'python_list_flow'},
]
}>
<TabItem value="curl_list_knowledge">
<TabItem value="curl_list_flow">
```shell
DBGPT_API_KEY="dbgpt"
DBGPT_API_KEY=dbgpt
curl -X GET "http://localhost:5000/api/v2/serve/awel/flows" -H "Authorization: Bearer $DBGPT_API_KEY"
curl -X GET "http://localhost:5000/api/v2/serve/awel/flows" \
-H "Authorization: Bearer $DBGPT_API_KEY" \
```
</TabItem>
<TabItem value="python_list_knowledge">
<TabItem value="python_list_flow">
```python

37
docs/docs/api/knowledge.md
View File

@@ -27,20 +27,14 @@ import TabItem from '@theme/TabItem';
<TabItem value="curl">
```shell
DBGPT_API_KEY="dbgpt"
SPACE_NAME="{YOUR_SPACE_NAME}"
curl --location --request POST 'http://127.0.0.1:5000/api/v2/chat/completions' \
--header 'Authorization: Bearer $DBGPT_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
"model": "chatgpt_proxyllm",
"messages": "introduce awel",
"chat_mode":"chat_knowledge",
"chat_param":$SPACE_NAME
}'
DBGPT_API_KEY=dbgpt
SPACE_NAME={YOUR_SPACE_NAME}
curl -X POST "http://localhost:5000/api/v2/chat/completions" \
-H "Authorization: Bearer $DBGPT_API_KEY" \
-H "accept: application/json" \
-H "Content-Type: application/json" \
-d "{\"messages\":\"Hello\",\"model\":\"chatgpt_proxyllm\", \"chat_mode\": \"chat_knowledge\", \"chat_param\": \"$SPACE_NAME\"}"
```
</TabItem>
@@ -490,8 +484,8 @@ DELETE /api/v2/serve/knowledge/spaces
<TabItem value="curl_update_knowledge">
```shell
DBGPT_API_KEY="dbgpt"
SPACE_ID="{YOUR_SPACE_ID}"
DBGPT_API_KEY=dbgpt
SPACE_ID={YOUR_SPACE_ID}
curl -X DELETE "http://localhost:5000/api/v2/serve/knowledge/spaces/$SPACE_ID" \
-H "Authorization: Bearer $DBGPT_API_KEY" \
@@ -546,11 +540,9 @@ GET /api/v2/serve/knowledge/spaces/{space_id}
<TabItem value="curl_get_knowledge">
```shell
DBGPT_API_KEY="dbgpt"
SPACE_ID="{YOUR_SPACE_ID}"
curl --location --request GET 'http://localhost:5000/api/v2/serve/knowledge/spaces/$SPACE_ID' \
--header 'Authorization: Bearer $DBGPT_API_KEY'
DBGPT_API_KEY=dbgpt
SPACE_ID={YOUR_SPACE_ID}
curl -X GET "http://localhost:5000/api/v2/serve/knowledge/spaces/$SPACE_ID" -H "Authorization: Bearer $DBGPT_API_KEY"
```
</TabItem>
@@ -600,10 +592,9 @@ GET /api/v2/serve/knowledge/spaces
<TabItem value="curl_list_knowledge">
```shell
DBGPT_API_KEY="dbgpt"
DBGPT_API_KEY=dbgpt
curl --location --request GET 'http://localhost:5000/api/v2/serve/knowledge/spaces' \
--header 'Authorization: Bearer dbgpt'
curl -X GET 'http://localhost:5000/api/v2/serve/knowledge/spaces' -H "Authorization: Bearer $DBGPT_API_KEY"
```
</TabItem>