Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(models): emphasize the deprecation of OpenAI completion API #3700

Merged
merged 2 commits into from
Jan 15, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 11 additions & 10 deletions website/docs/references/models-http-api/openai.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,26 +6,27 @@ Tabby supports OpenAI's API specifications for chat, completion, and embedding t
The OpenAI API is widely used and is also provided by other vendors,
such as vLLM, Nvidia NIM, and LocalAI.

OpenAI has designated its `/v1/completions` API for code completion as legacy,
and **OpenAI itself no longer supports it**.

Tabby continues to support the OpenAI Completion API specifications due to its widespread usage.

## Chat model

```toml title="~/.tabby/config.toml"
# Chat model
[model.chat.http]
kind = "openai/chat"
model_name = "gpt-3.5-turbo" # Please make sure to use a chat model, such as gpt-4o
model_name = "gpt-4o" # Please make sure to use a chat model, such as gpt-4o
api_endpoint = "https://api.openai.com/v1" # DO NOT append the `/chat/completions` suffix
api_key = "secret-api-key"
```

# Completion model
[model.completion.http]
kind = "openai/completion"
model_name = "gpt-3.5-turbo-instruct" # Please make sure to use a completion model, such as gpt-3.5-turbo-instruct
api_endpoint = "https://api.openai.com/v1" # DO NOT append the `/completions` suffix
api_key = "secret-api-key"
## Completion model

OpenAI has designated its `/v1/completions` API for code completion as legacy,
and using OpenAI models for completion is no longer supported.

## Embeddings model

```toml title="~/.tabby/config.toml"
# Embedding model
[model.embedding.http]
kind = "openai/embedding"
Expand Down
Loading