Skip to content

Commit 635c951

Browse files
authored
added info about open ai compatible for indexing (#239)
1 parent fbad5dd commit 635c951

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

docs/features/experimental/codebase-indexing.mdx

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,12 @@ Choose one of these options for generating embeddings:
5050
- Supports any Ollama-compatible embedding model
5151
- Requires Ollama base URL configuration
5252

53+
**OpenAI Compatible**
54+
- Works with any OpenAI-compatible API endpoint
55+
- Supports providers like Google Gemini, Azure OpenAI, and others
56+
- Requires base URL and API key configuration
57+
- Uses OpenAI-style request/response format
58+
5359
### Setting Up Ollama for Embeddings
5460

5561
1. **Install Ollama**
@@ -79,6 +85,28 @@ Choose one of these options for generating embeddings:
7985
- Set Ollama Base URL: `http://localhost:11434`
8086
- Select Model: `nomic-embed-text`
8187

88+
### Setting Up OpenAI Compatible Providers
89+
90+
OpenAI Compatible providers use the same API format as OpenAI but with different endpoints. This includes Google Gemini, Azure OpenAI, and other compatible services.
91+
92+
**Example: Google Gemini**
93+
94+
1. **Get API Key**
95+
- Visit [Google AI Studio](https://aistudio.google.com/)
96+
- Create or select a project
97+
- Generate an API key
98+
99+
2. **Configure in Roo Code**
100+
- **Provider**: Select "OpenAI Compatible"
101+
- **Base URL**: `https://generativelanguage.googleapis.com/v1beta/openai/`
102+
- **API Key**: Your Google AI Studio API key
103+
- **Model**: `text-embedding-004`
104+
- **Embedding Dimension**: `768`
105+
106+
**Other Compatible Providers:**
107+
- **Azure OpenAI**: `https://your-resource.openai.azure.com/openai/deployments/your-deployment/`
108+
- **Local OpenAI-compatible servers**: Custom endpoints running compatible APIs
109+
82110
### Vector Database
83111

84112
**Qdrant** is required for storing and searching embeddings:
@@ -128,6 +156,7 @@ For team or production use:
128156
4. Configure your embedding provider:
129157
- **OpenAI**: Enter API key and select model
130158
- **Ollama**: Enter base URL and select model
159+
- **OpenAI Compatible**: Enter base URL, API key, and select model
131160
5. Set Qdrant URL and optional API key
132161
6. Click **Save** to start initial indexing
133162

0 commit comments

Comments
 (0)