cleveragents/cleveragents-core
4
0
Fork 3
Code Issues 6.0k Pull Requests 115 Actions Packages Projects Releases Wiki Activity

docs(spec): update Azure OpenAI API version default to 2024-05-01-preview
CI / lint (pull_request) Successful in 28s
Details
CI / quality (pull_request) Successful in 34s
Details
CI / typecheck (pull_request) Successful in 1m32s
Details
CI / security (pull_request) Successful in 1m29s
Details
CI / build (pull_request) Successful in 31s
Details
CI / helm (pull_request) Successful in 30s
Details
CI / push-validation (pull_request) Successful in 29s
Details
CI / e2e_tests (pull_request) Successful in 3m10s
Details
CI / integration_tests (pull_request) Successful in 4m6s
Details
CI / unit_tests (pull_request) Successful in 8m42s
Details
CI / docker (pull_request) Successful in 25s
Details
CI / coverage (pull_request) Successful in 11m6s
Details
CI / status-check (pull_request) Successful in 1s
Details
CI / benchmark-publish (pull_request) Has been skipped
Details
CI / benchmark-regression (pull_request) Successful in 58m27s
Details

Browse Source 
The implementation (providers/registry.py line 519) uses 2024-05-01-preview
as the default Azure OpenAI API version, but the spec documented 2024-02-01.

The implementation's choice is correct — 2024-05-01-preview supports the
latest features including structured outputs and improved tool calling.
Update the spec to match the implementation and add guidance for users
who need a stable API version.

Fixes the discrepancy reported in UAT issue #5807.
This commit is contained in:
HAL 9000
2026-04-09 11:06:09 +00:00
parent a3762a4cc2
commit 5da2baef49
1 changed files with 1 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/specification.md
+1 -1
View File
@@ -30811,7 +30811,7 @@ Provider credential keys follow the pattern `provider.<name>.<field>`. Each prov
| `provider.google.api-key` | string | *(not set)* | `GOOGLE_API_KEY` | API key for Google AI models. Required when using Google-based actors. |
| `provider.azure.endpoint` | string | *(not set)* | `AZURE_OPENAI_ENDPOINT` | Azure OpenAI endpoint URL. Required when using Azure-hosted OpenAI models. |
| `provider.azure.api-key` | string | *(not set)* | `AZURE_OPENAI_API_KEY` | API key for Azure OpenAI. Required alongside `provider.azure.endpoint`. |
| `provider.azure.api-version` | string | `2024-02-01` | `AZURE_OPENAI_API_VERSION` | Azure OpenAI API version string. |
| `provider.azure.api-version` | string | `2024-05-01-preview` | `AZURE_OPENAI_API_VERSION` | Azure OpenAI API version string. The default `2024-05-01-preview` supports the latest features including structured outputs and tool calling improvements. Use a stable version (e.g., `2024-02-01`) for production deployments requiring API stability. |
| `provider.google.gemini-api-key` | string | *(not set)* | `GEMINI_API_KEY` | API key for Google Gemini models. Required when using Gemini-based actors. The standard `GEMINI_API_KEY` environment variable is checked for compatibility with Google's tooling. |
| `provider.huggingface.token` | string | *(not set)* | `HF_TOKEN` | Access token for Hugging Face Inference API. Required when using Hugging Face-hosted models. The standard `HF_TOKEN` environment variable is checked for compatibility with Hugging Face tooling. |
| `provider.openrouter.api-key` | string | *(not set)* | `OPENROUTER_API_KEY` | API key for OpenRouter. Required when using OpenRouter as a provider. |