Skip to main content
Version: dev

OpenAI

Configure DB-GPT to use OpenAI's GPT models and embedding models.

Prerequisites​

Install dependencies​

uv sync --all-packages \
--extra "base" \
--extra "proxy_openai" \
--extra "rag" \
--extra "storage_chromadb" \
--extra "dbgpts"

Configuration​

Edit configs/dbgpt-proxy-openai.toml:

[models]
[[models.llms]]
name = "gpt-4o"
provider = "proxy/openai"
api_base = "https://api.openai.com/v1"
api_key = "sk-your-openai-api-key"

[[models.embeddings]]
name = "text-embedding-3-small"
provider = "proxy/openai"
api_url = "https://api.openai.com/v1/embeddings"
api_key = "sk-your-openai-api-key"
Use environment variables

Instead of hardcoding your API key, use environment variables:

api_key = "${env:OPENAI_API_KEY}"
export OPENAI_API_KEY="sk-your-openai-api-key"

Available models​

LLMs​

ModelConfig nameNotes
GPT-4ogpt-4oRecommended — best quality
GPT-4o minigpt-4o-miniFaster and cheaper
GPT-4 Turbogpt-4-turboPrevious generation
GPT-3.5 Turbogpt-3.5-turboBudget option

Embeddings​

ModelConfig nameDimensions
text-embedding-3-smalltext-embedding-3-small1536
text-embedding-3-largetext-embedding-3-large3072
text-embedding-ada-002text-embedding-ada-0021536

Start the server​

uv run dbgpt start webserver --config configs/dbgpt-proxy-openai.toml

Azure OpenAI​

To use Azure OpenAI, change the api_base to your Azure endpoint:

[[models.llms]]
name = "gpt-4o"
provider = "proxy/openai"
api_base = "https://your-resource.openai.azure.com/openai/deployments/your-deployment"
api_key = "your-azure-api-key"

Troubleshooting​

IssueSolution
AuthenticationErrorCheck that your API key is valid and has billing enabled
RateLimitErrorReduce request frequency or upgrade your OpenAI plan
Connection timeoutCheck network connectivity; configure proxy if needed
Model not foundVerify the model name matches OpenAI's current offerings

What's next​