Просмотр исходного кода

docs(readme): add note section about `openai` vs. `openai-compat`

Andrey Nering 3 месяцев назад
Родитель
Сommit
85c57a4148
1 измененных файлов с 6 добавлено и 0 удалено
  1. 6 0
      README.md

+ 6 - 0
README.md

@@ -408,6 +408,12 @@ Local models can also be configured via OpenAI-compatible API. Here are two comm
 Crush supports custom provider configurations for both OpenAI-compatible and
 Anthropic-compatible APIs.
 
+> [!NOTE]
+> Note that we support two "types" for OpenAI. Make sure to choose the right one
+> to ensure the best experience!
+> * `openai` should be used when proxying or routing requests through OpenAI.
+> * `openai-compat` should be used when using non-OpenAI providers that have OpenAI-compatible APIs.
+
 #### OpenAI-Compatible APIs
 
 Here’s an example configuration for Deepseek, which uses an OpenAI-compatible