Skip to content

Commit 6cd04cc

Browse files
committed
Add GenAi configuration docs
1 parent beaa244 commit 6cd04cc

File tree

1 file changed

+27
-1
lines changed

1 file changed

+27
-1
lines changed

guide/configuration.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -163,4 +163,30 @@ services:
163163
- SECURITY_API-KEYS-PROVIDER_API-KEYS_0_KEY=TEST_API_SECRET
164164
- SECURITY_API-KEYS-PROVIDER_API-KEYS_0_USER=admin
165165
- SECURITY_API-KEYS-PROVIDER_API-KEYS_0_AUTHORITIES=TB_ALLOW_READ, TB_ALLOW_WRITE
166-
```
166+
```
167+
168+
## Gen AI Configuration
169+
170+
TimeBase Web Administrator can generate QQL queries with the help of an external Gen AI provider.
171+
The feature reads its settings from the `ai-api` section of `application.yaml`.
172+
173+
Example config:
174+
175+
```yaml
176+
ai-api:
177+
enabled: true
178+
endpointUrl: "https://YOUR-RESOURCE-NAME.openai.azure.com" # endpoint must support Azure OpenAI API
179+
deploymentName: gpt-5-mini-2025-08-07 # deployment for QQL generation
180+
embeddingDeploymentName: text-embedding-3-small-1 # deployment for embeddings
181+
keys: # ai api keys per user
182+
- username: admin
183+
key: ${ADMIN_AI_KEY} # resolves from environment variable
184+
- username: reader
185+
key: READER_AI_KEY # takes priority over key from security.oauth2.users section
186+
maxAttempts: 3 # max attempts allowed for an AI to produce a valid QQL query
187+
```
188+
189+
If a user is not present in `ai-api.keys`, the system falls back to `security.oauth2.users[].aiApiKey` when it is defined.
190+
191+
> [!IMPORTANT]
192+
> The Gen AI endpoint must be compatible with the Azure OpenAI API.

0 commit comments

Comments
 (0)