Merge remote-tracking branch 'main-com/main' into fix_issue2590

Author: Aries-ckt

.pre-commit-config.yaml

@@ -20,22 +20,22 @@ repos:
         stages: [commit]
         pass_filenames: false
         args: []
-      - id: python-test-doc
-        name: Python Doc Test
-        entry: make test-doc
-        language: system
-        exclude: '^dbgpt/app/static/|^web/'
-        types: [python]
-        stages: [commit]
-        pass_filenames: false
-        args: []
-      - id: python-lint-mypy
-        name: Python Lint mypy
-        entry: make mypy
-        language: system
-        exclude: '^dbgpt/app/static/|^web/'
-        types: [python]
-        stages: [commit]
-        pass_filenames: false
-        args: []
-
+#      - id: python-test-doc
+#        name: Python Doc Test
+#        entry: make test-doc
+#        language: system
+#        exclude: '^dbgpt/app/static/|^web/'
+#        types: [python]
+#        stages: [commit]
+#        pass_filenames: false
+#        args: []
+#      - id: python-lint-mypy
+#        name: Python Lint mypy
+#        entry: make mypy
+#        language: system
+#        exclude: '^dbgpt/app/static/|^web/'
+#        types: [python]
+#        stages: [commit]
+#        pass_filenames: false
+#        args: []
+#

Makefile

@@ -91,7 +91,7 @@ test: $(VENV)/.testenv ## Run unit tests
 .PHONY: test-doc
 test-doc: $(VENV)/.testenv ## Run doctests
 	# -k "not test_" skips tests that are not doctests.
-	$(VENV_BIN)/pytest --doctest-modules -k "not test_" dbgpt/core
+	$(VENV_BIN)/pytest --doctest-modules -k "not test_" packages
 
 .PHONY: mypy
 mypy: $(VENV)/.testenv ## Run mypy checks

configs/dbgpt-proxy-siliconflow-mysql.toml

@@ -33,9 +33,8 @@ provider = "proxy/siliconflow"
 api_key = "${env:SILICONFLOW_API_KEY}"
 
 [[models.embeddings]]
-name = "BAAI/bge-large-zh-v1.5"
-provider = "proxy/openai"
-api_url = "https://api.siliconflow.cn/v1/embeddings"
+name = "BAAI/bge-m3"
+provider = "proxy/siliconflow"
 api_key = "${env:SILICONFLOW_API_KEY}"
 
 [[models.rerankers]]

docker/compose_examples/ha-cluster-docker-compose.yml

@@ -154,6 +154,25 @@ services:
     restart: unless-stopped
     networks:
       - dbgptnet
+  apiserver:
+    image: eosphorosai/dbgpt-openai:latest
+    command: dbgpt start apiserver -c /root/configs/ha-model-cluster.toml
+    environment:
+      - CONTROLLER_ADDR=http://controller-1:8000,http://controller-2:8000
+    depends_on:
+      - controller-1
+      - controller-2
+      - llm-worker
+      - embedding-worker
+    volumes:
+      - ../../:/app
+      - ./conf/ha-model-cluster.toml:/root/configs/ha-model-cluster.toml
+    ports:
+      - 8100:8100/tcp
+    restart: unless-stopped
+    networks:
+      - dbgptnet
+    ipc: host
 volumes:
   dbgpt-init-scripts:
   dbgpt-myql-db:

docs/docs/api/chat.md

@@ -22,6 +22,7 @@ import TabItem from '@theme/TabItem';
   values={[
     {label: 'Curl', value: 'curl'},
     {label: 'Python', value: 'python'},
+    {label: 'Python(OpenAI SDK)', value: 'openai-sdk'},
   ]
 }>
 
@@ -54,8 +55,40 @@ async for data in client.chat_stream(
     print(data)
 ```
  </TabItem>
+
+<TabItem value="openai-sdk">
+
+```python
+from openai import OpenAI
+DBGPT_API_KEY = "dbgpt"
+
+client = OpenAI(
+    api_key=DBGPT_API_KEY,
+    base_url="http://localhost:5670/api/v2"
+)
+response = client.chat.completions.create(
+    model="gpt-4o",
+    messages=[
+        {
+            "role": "user",
+            "content": "Hello",
+        },
+    ],
+    extra_body={
+        "chat_mode": "chat_normal",
+    },
+    stream=True,
+    max_tokens=2048,
+)
+
+for chunk in response:
+    delta_content = chunk.choices[0].delta.content
+    print(delta_content, end="", flush=True)
+```
+ </TabItem>
 </Tabs>
 
+
 ### Chat Completion Stream Response
 ```commandline
 data: {"id": "chatcmpl-ba6fb52e-e5b2-11ee-b031-acde48001122", "model": "gpt-4o", "choices": [{"index": 0, "delta": {"role": "assistant", "content": "Hello"}}]}
@@ -110,6 +143,8 @@ from dbgpt_client import Client
 DBGPT_API_KEY = "dbgpt"
 client = Client(api_key=DBGPT_API_KEY)
 response = await client.chat(model="gpt-4o" ,messages="hello")
+print(response)
+await client.aclose()
 ```
  </TabItem>
 </Tabs>

docs/docs/api/datasource.md

@@ -21,6 +21,7 @@ import TabItem from '@theme/TabItem';
   values={[
     {label: 'Curl', value: 'curl'},
     {label: 'Python', value: 'python'},
+    {label: 'Python(OpenAI SDK)', value: 'openai-sdk'},
   ]
 }>
 
@@ -56,6 +57,40 @@ res = client.chat(
 )
 ```
  </TabItem>
+
+<TabItem value="openai-sdk">
+
+```python
+from openai import OpenAI
+
+DBGPT_API_KEY = "dbgpt"
+DB_NAME="{your_db_name}"
+
+client = OpenAI(
+    api_key=DBGPT_API_KEY,
+    base_url="http://localhost:5670/api/v2"
+)
+response = client.chat.completions.create(
+    model="gpt-4o",
+    messages=[
+        {
+            "role": "user",
+            "content": "Hello",
+        },
+    ],
+    extra_body={
+        "chat_mode": "chat_data",
+        "chat_param": DB_NAME,
+    },
+    stream=True,
+    max_tokens=2048,
+)
+
+for chunk in response:
+    delta_content = chunk.choices[0].delta.content
+    print(delta_content, end="", flush=True)
+```
+ </TabItem>
 </Tabs>
 
 #### Chat Completion Response

docs/docs/api/flow.md

@@ -21,6 +21,7 @@ import TabItem from '@theme/TabItem';
   values={[
     {label: 'Curl', value: 'curl'},
     {label: 'Python', value: 'python'},
+    {label: 'Python(OpenAI SDK)', value: 'openai-sdk'},
   ]
 }>
 
@@ -34,7 +35,7 @@ curl -X POST "http://localhost:5670/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\":\"gpt-4o\", \"chat_mode\": \"chat_flow\", \"chat_param\": \"$FLOW_ID\"}"
 
 ```
  </TabItem>
@@ -50,18 +51,53 @@ FLOW_ID="{YOUR_FLOW_ID}"
 client = Client(api_key=DBGPT_API_KEY)
 async for data in client.chat_stream(
     messages="Introduce AWEL", 
-    model="chatgpt_proxyllm", 
+    model="gpt-4o", 
     chat_mode="chat_flow", 
     chat_param=FLOW_ID
 ):
     print(data)
 ```
  </TabItem>
+
+
+<TabItem value="openai-sdk">
+
+```python
+from openai import OpenAI
+
+DBGPT_API_KEY = "dbgpt"
+FLOW_ID="{YOUR_FLOW_ID}"
+
+client = OpenAI(
+    api_key=DBGPT_API_KEY,
+    base_url="http://localhost:5670/api/v2"
+)
+response = client.chat.completions.create(
+    model="gpt-4o",
+    messages=[
+        {
+            "role": "user",
+            "content": "Hello",
+        },
+    ],
+    extra_body={
+        "chat_mode": "chat_flow",
+        "chat_param": FLOW_ID,
+    },
+    stream=True,
+    max_tokens=2048,
+)
+
+for chunk in response:
+    delta_content = chunk.choices[0].delta.content
+    print(delta_content, end="", flush=True)
+```
+ </TabItem>
 </Tabs>
 
 #### Chat Completion Stream Response
 ```commandline
-data: {"id": "579f8862-fc4b-481e-af02-a127e6d036c8", "created": 1710918094, "model": "chatgpt_proxyllm", "choices": [{"index": 0, "delta": {"role": "assistant", "content": "\n\n"}}]}
+data: {"id": "579f8862-fc4b-481e-af02-a127e6d036c8", "created": 1710918094, "model": "gpt-4o", "choices": [{"index": 0, "delta": {"role": "assistant", "content": "\n\n"}}]}
 ```
 ### Create Flow
 

docs/docs/api/introduction.md

@@ -2,7 +2,7 @@
 
 This is the introduction to the DB-GPT API documentation. You can interact with the API through HTTP requests from any language, via our official Python Client bindings.
 
-# Authentication
+## Authentication
 The DB-GPT API uses API keys for authentication. Visit your API Keys page to retrieve the API key you'll use in your requests.
 
 Production requests must be routed through your own backend server where your API key can be securely loaded from an environment variable or key management service.
@@ -34,10 +34,18 @@ API_KEYS - The list of API keys that are allowed to access the API. Each of the
 API_KEYS=dbgpt
 ```
 
-## Installation
+## Using the DB-GPT official Python Client
+
 If you use Python, you should install the official DB-GPT Client package from PyPI:
 
 ```bash
-pip install "dbgpt[client]>=0.5.2"
+pip install "dbgpt-client>=0.7.1rc0"
 ```
 
+## Using the OpenAI Python SDK
+
+In some chat cases, you can use the OpenAI Python SDK to interact with the DB-GPT API. The DB-GPT API is compatible with the OpenAI API.
+
+```bash
+pip install openai
+```

docs/docs/api/knowledge.md

@@ -21,6 +21,7 @@ import TabItem from '@theme/TabItem';
   values={[
     {label: 'Curl', value: 'curl'},
     {label: 'Python', value: 'python'},
+    {label: 'Python(OpenAI SDK)', value: 'openai-sdk'},
   ]
 }>
 
@@ -57,6 +58,41 @@ async for data in client.chat_stream(
     print(data)
 ```
  </TabItem>
+
+
+<TabItem value="openai-sdk">
+
+```python
+from openai import OpenAI
+
+DBGPT_API_KEY = "dbgpt"
+SPACE_NAME="{YOUR_SPACE_NAME}"
+
+client = OpenAI(
+    api_key=DBGPT_API_KEY,
+    base_url="http://localhost:5670/api/v2"
+)
+response = client.chat.completions.create(
+    model="gpt-4o",
+    messages=[
+        {
+            "role": "user",
+            "content": "Hello",
+        },
+    ],
+    extra_body={
+        "chat_mode": "chat_knowledge",
+        "chat_param": SPACE_NAME,
+    },
+    stream=True,
+    max_tokens=2048,
+)
+
+for chunk in response:
+    delta_content = chunk.choices[0].delta.content
+    print(delta_content, end="", flush=True)
+```
+ </TabItem>
 </Tabs>
 
 #### Chat Completion Response

docs/docs/application/advanced_tutorial/api.md

@@ -13,11 +13,13 @@ In the DB-GPT project, we defined a service-oriented multi-model management fram
 
 ```python
 import openai
-openai.api_key = "EMPTY"
-openai.api_base = "http://127.0.0.1:8100/api/v1"
-model = "vicuna-13b-v1.5"
+model = "Qwen/QwQ-32B"
 
-completion = openai.ChatCompletion.create(
+client = openai.OpenAI(
+  api_key="EMPTY",
+  base_url="http://127.0.0.1:8100/api/v1",
+)
+completion = client.chat.completions.create(
   model=model,
   messages=[{"role": "user", "content": "hello"}]
 )