Skip to content

Commit 357e5b3

Browse files
authored
Update openai-compatible.md
1 parent 6254338 commit 357e5b3

File tree

1 file changed

+11
-45
lines changed

1 file changed

+11
-45
lines changed

docs/providers/openai-compatible.md

Lines changed: 11 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -16,59 +16,25 @@ The key to using an OpenAI-compatible provider is to configure two main settings
1616
2. **API Key:** This is the secret key you obtain from the provider.
1717
3. **Model ID:** This is the model name of the specific model.
1818

19-
You'll find these settings in the Roo Code settings panel (click the gear icon ⚙️):
19+
You'll find these settings in the Roo Code settings panel (click the <Codicon name="gear" /> icon):
2020

2121
* **API Provider:** Select "OpenAI Compatible".
2222
* **Base URL:** Enter the base URL provided by your chosen provider. **This is crucial.**
2323
* **API Key:** Enter your API key.
24-
* **Model ID:** Enter the model ID that you have access to.
25-
* **Model Configuration:** The settings shown below will automatically be applied.
26-
- **Max Output Tokens:** 4096
27-
- **Context Window:** 8192
28-
- **Supports prompt caching:** False
29-
- **Supports images:** True
30-
- **Input Price:** 0
31-
- **Output Price:** 0
32-
33-
## Provider-Specific Instructions and Examples
34-
35-
Here are some examples of how to configure Roo Code for some popular OpenAI-compatible providers. **Always refer to your provider's documentation for the most up-to-date information.**
36-
37-
### Perplexity
38-
39-
* **Website:** [https://perplexity.ai/](https://perplexity.ai/)
40-
* **API Key:** Obtain your API key from your [Perplexity account settings](https://www.perplexity.ai/).
41-
* **Base URL:** `https://api.perplexity.ai`
42-
* **Supported Models:** The models may vary, but some available models are: `pplx-7b-online`, `pplx-70b-online`, `pplx-7b-chat`, `pplx-70b-chat`, `mistral-7b-instruct`, `codellama-34b-instruct`, `codellama-70b-instruct`, `llama-2-70b-chat`.
43-
44-
### Together AI
45-
46-
* **Website:** [https://together.ai/](https://together.ai/)
47-
* **API Key:** Obtain your API key from your [Together AI account](https://api.together.xyz/settings/api-keys).
48-
* **Base URL:** `https://api.together.xyz/v1`
49-
* **Supported Models:** [See the models list on the Together AI website.](https://docs.together.ai/docs/inference-models)
50-
51-
### Anyscale Endpoints
52-
53-
* **Website:** [https://www.anyscale.com/](https://www.anyscale.com/)
54-
* **API Key:** Obtain your API Key from your [Anyscale Endpoints](https://app.endpoints.anyscale.com/) account.
55-
* **Base URL:** `https://api.endpoints.anyscale.com/v1`
56-
* **Supported Models:** [See the models list on the Anyscale Endpoints website.](https://docs.endpoints.anyscale.com/category/models)
57-
58-
### Using a Custom Provider
59-
60-
If your provider isn't listed above, you can still configure Roo Code to use it, as long as it offers an OpenAI-compatible API.
61-
62-
1. **Obtain the Base URL:** Find the API base URL in your provider's documentation. This is the URL you'll use to make API requests.
63-
2. **Obtain an API Key:** Follow your provider's instructions for creating an API key.
64-
3. **Find the Model ID:** Your provider will list the available model IDs.
65-
4. **Enter the Information:** Enter the Base URL, API Key, and Model ID into the Roo Code settings.
24+
* **Model:** Chooose a model.
25+
* **Model Configuration:** This lets you customize advanced configuration for the model
26+
- Max Output Tokens
27+
- Context Window
28+
- Image Support
29+
- Computer Use
30+
- Input Price
31+
- Output Price
6632

6733
## Troubleshooting
6834

6935
* **"Invalid API Key":** Double-check that you've entered the API key correctly.
7036
* **"Model Not Found":** Make sure you're using a valid model ID for your chosen provider.
7137
* **Connection Errors:** Verify the Base URL is correct and that your provider's API is accessible.
72-
* **Unexpected Results:** If you're getting unexpected results, try a different model or adjust the temperature setting.
38+
* **Unexpected Results:** If you're getting unexpected results, try a different model.
7339

74-
By using an OpenAI-compatible provider, you can leverage the flexibility of Roo Code with a wider range of AI models. Remember to always consult your provider's documentation for the most accurate and up-to-date information.
40+
By using an OpenAI-compatible provider, you can leverage the flexibility of Roo Code with a wider range of AI models. Remember to always consult your provider's documentation for the most accurate and up-to-date information.

0 commit comments

Comments
 (0)