Skip to content

Commit

Permalink
docs(models): emphasize the deprecation of OpenAI completion API (#3700)
Browse files Browse the repository at this point in the history
* docs(models): emphasize the deprecation of OpenAI completion API

Signed-off-by: Wei Zhang <[email protected]>

* docs(models): mark completion for openai not supported

Signed-off-by: Wei Zhang <[email protected]>

---------

Signed-off-by: Wei Zhang <[email protected]>
  • Loading branch information
zwpaper authored Jan 15, 2025
1 parent 3ec356b commit 6951fe7
Showing 1 changed file with 11 additions and 10 deletions.
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

0 comments on commit 6951fe7

Please sign in to comment.