Skip to main content
Version: v0.5.6

API Interface Usage

The DB-GPT project currently also provides various APIs for use. Currently APIs are mainly divided into two categories. 1. Model API 2. Application service layer AP

Model API mainly means that DB-GPT adapts to various models and is uniformly packaged into models compatible with OpenAI SDK output. The service layer API refers to the API exposed by the DB-GPT service layer. The following is a brief introduction to the use of both.

Model API​

In the DB-GPT project, we defined a service-oriented multi-model management framework (SMMF). Through the capabilities of SMMF, we can deploy multiple models, and these models provide external services through services. In order to allow clients to achieve seamless switching, we uniformly support the OpenAI SDK standards.

Example: The following is an example of calling through openai sdk

import openai
openai.api_key = "EMPTY"
openai.api_base = "http://127.0.0.1:8100/api/v1"
model = "vicuna-13b-v1.5"

completion = openai.ChatCompletion.create(
  model=model,
  messages=[{"role": "user", "content": "hello"}]
)
# print the completion
print(completion.choices[0].message.content)

Application service layer API​

The service layer API refers to the API exposed on port 5670 after starting the webserver, which is mainly focused on the application layer. It can be divided into the following parts according to categories

  • Chat API
  • Editor API
  • LLM Manage API
  • Agent API
  • AWEL API
  • Model API
info

Note: After starting the webserver, open http://127.0.0.1:5670/docs to view details

Regarding the service layer API, in terms of strategy in the early days, we maintained the principle of minimum availability and openness. APIs that are stably exposed to the outside world will carry version information, such as

  • /api/v1/
  • /api/v2/

Due to the rapid development of the entire field, different versions of the API will not be considered fully compatible in terms of compatibility. In subsequent new versions of the API, we will provide instructions in the documentation for incompatible APIs.

API Description​

Chat API Lists

  api/v1/chat/db/list
  api/v1/chat/db/add
  api/v1/chat/db/edit
  api/v1/chat/db/delete
  api/v1/chat/db/test/connect
  api/v1/chat/db/summary
  api/v1/chat/db/support/type
  api/v1/chat/dialogue/list
  api/v1/chat/dialogue/scenes
  api/v1/chat/dialogue/new
  api/v1/chat/mode/params/list
  api/v1/chat/mode/params/file/load
  api/v1/chat/dialogue/delete
  api/v1/chat/dialogue/messages
  api/v1/chat/prepare
  api/v1/chat/completions
note

⚠️ Knowledge and Prompt API

Currently, due to frequent changes in Knowledge and Prompt, the relevant APIs are still in the testing stage and will be gradually opened later

More detailed interface parameters can be viewed at http://127.0.0.1:5670/docs