Files
openrouter-python-sdk-retry…/docs/components/chatgenerationparamsprovider.md
T

20 KiB
Raw Blame History

ChatGenerationParamsProvider

Fields

Field Type Required Description
allow_fallbacks OptionalNullable[bool] Whether to allow backup providers to serve requests
- true: (default) when the primary provider (or your custom providers in "order") is unavailable, use the next best provider.
- false: use only the primary/custom provider, and return the upstream error if it's unavailable.
require_parameters OptionalNullable[bool] Whether to filter providers to only those that support the parameters you've provided. If this setting is omitted or set to false, then providers will receive only the parameters they support, and ignore the rest.
data_collection OptionalNullable[components.ChatGenerationParamsDataCollection] Data collection setting. If no available model provider meets the requirement, your request will return an error.
- allow: (default) allow providers which store user data non-transiently and may train on it

- deny: use only providers which do not collect user data.
zdr OptionalNullable[bool] N/A
enforce_distillable_text OptionalNullable[bool] N/A
order List[components.Schema0] An ordered list of provider slugs. The router will attempt to use the first provider in the subset of this list that supports your requested model, and fall back to the next if it is unavailable. If no providers are available, the request will fail with an error message.
only List[components.Schema0] List of provider slugs to allow. If provided, this list is merged with your account-wide allowed provider settings for this request.
ignore List[components.Schema0] List of provider slugs to ignore. If provided, this list is merged with your account-wide ignored provider settings for this request.
quantizations List[components.Quantizations] A list of quantization levels to filter the provider by.
sort OptionalNullable[components.ProviderSortUnion] The sorting strategy to use for this request, if "order" is not specified. When set, no load balancing is performed.
max_price Optional[components.ChatGenerationParamsMaxPrice] The object specifying the maximum price you want to pay for this request. USD price per million tokens, for prompt and completion.
preferred_min_throughput OptionalNullable[components.ChatGenerationParamsPreferredMinThroughputUnion] Preferred minimum throughput (in tokens per second). Can be a number (applies to p50) or an object with percentile-specific cutoffs. Endpoints below the threshold(s) may still be used, but are deprioritized in routing. When using fallback models, this may cause a fallback model to be used instead of the primary model if it meets the threshold.
preferred_max_latency OptionalNullable[components.ChatGenerationParamsPreferredMaxLatencyUnion] Preferred maximum latency (in seconds). Can be a number (applies to p50) or an object with percentile-specific cutoffs. Endpoints above the threshold(s) may still be used, but are deprioritized in routing. When using fallback models, this may cause a fallback model to be used instead of the primary model if it meets the threshold.