Skip to content

Chore/update config #472

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Chore/update config #472

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3e49c25
chore/udpate-config-object
siddharthsambharia-portkey Aug 25, 2025
9fa50a5
small fix
siddharthsambharia-portkey Aug 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 30 additions & 38 deletions api-reference/inference-api/config-object.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -350,44 +350,6 @@ The `config` object is used to configure API interactions with various providers
},
provider: {
type: 'string',
enum: [
'openai',
'anthropic',
'azure-openai',
'azure-ai',
'anyscale',
'cohere',
'palm',
'google',
'together-ai',
'mistral-ai',
'perplexity-ai',
'stability-ai',
'nomic',
'ollama',
'bedrock',
'ai21',
'groq',
'segmind',
'vertex-ai',
'deepinfra',
'novita-ai',
'fireworks-ai',
'deepseek',
'voyage',
'jina',
'reka-ai',
'moonshot',
'openrouter',
'lingyi',
'zhipu',
'monsterapi',
'predibase',
'huggingface',
'github',
'deepbricks',
'siliconflow',
],
},
resource_name: {
type: 'string',
Expand Down Expand Up @@ -452,6 +414,27 @@ The `config` object is used to configure API interactions with various providers
},
required: ['mode'],
},
cb_config: {
type: 'object',
properties: {
failure_threshold: {
type: 'number',
minimum: 1,
},
cooldown_interval: {
type: 'number',
minimum: 30000,
},
failure_status_codes: {
type: 'array',
items: {
type: 'integer',
},
optional: true,
},
},
required: ['failure_threshold', 'cooldown_interval'],
},
retry: {
type: 'object',
properties: {
Expand Down Expand Up @@ -683,6 +666,15 @@ You can find more examples of schemas [below](/api-reference/inference-api/confi
| `on_status_codes` | Status codes to trigger retries | array of strings | No | - | Optional |
| `use_retry_after_headers`| Whether to respect provider's Retry-After and Retry-After-ms headers| boolean| Default: false |

### Circuit Breaker Object Details

| Key Name | Description | Type | Required | Enum Values | Additional Info |
| --- | --- | --- | --- | --- | --- |
| `failure_threshold` | Number of failures after which the circuit opens | number | Yes | - | Minimum value: 1 |
| `cooldown_interval` | Time (in milliseconds) to wait before allowing retries | number | Yes | - | Minimum value: 30000 (30 seconds) |
| `failure_status_codes` | Specific HTTP status codes considered as failures | array of integers | No | - | Optional, defaults to status codes >500 |


### Cloud Provider Params (Azure OpenAI, Google Vertex, AWS Bedrock)

#### Azure OpenAI
Expand Down