From 6951fe746718a69bb4daca8241fc58f5185d25a3 Mon Sep 17 00:00:00 2001 From: Wei Zhang Date: Thu, 16 Jan 2025 01:00:48 +0800 Subject: [PATCH] docs(models): emphasize the deprecation of OpenAI completion API (#3700) * docs(models): emphasize the deprecation of OpenAI completion API Signed-off-by: Wei Zhang * docs(models): mark completion for openai not supported Signed-off-by: Wei Zhang --------- Signed-off-by: Wei Zhang --- .../docs/references/models-http-api/openai.md | 21 ++++++++++--------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/website/docs/references/models-http-api/openai.md b/website/docs/references/models-http-api/openai.md index 940845798dd9..0d428c19d236 100644 --- a/website/docs/references/models-http-api/openai.md +++ b/website/docs/references/models-http-api/openai.md @@ -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"