put_enforced_guardrail_configuration¶
Operation¶
put_enforced_guardrail_configuration
¶
put_enforced_guardrail_configuration(request: PutEnforcedGuardrailConfigurationInput | PutEnforcedGuardrailConfigurationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[PutEnforcedGuardrailConfigurationInputDict]) -> PutEnforcedGuardrailConfigurationOutput
Sets the account-level enforced guardrail configuration.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
PutEnforcedGuardrailConfigurationInput | PutEnforcedGuardrailConfigurationInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[PutEnforcedGuardrailConfigurationInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
PutEnforcedGuardrailConfigurationOutput
|
An instance of |
put_enforced_guardrail_configuration
async
¶
put_enforced_guardrail_configuration(request: PutEnforcedGuardrailConfigurationInput | PutEnforcedGuardrailConfigurationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[PutEnforcedGuardrailConfigurationInputDict]) -> PutEnforcedGuardrailConfigurationOutput
Sets the account-level enforced guardrail configuration.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
PutEnforcedGuardrailConfigurationInput | PutEnforcedGuardrailConfigurationInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[PutEnforcedGuardrailConfigurationInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
PutEnforcedGuardrailConfigurationOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
PutEnforcedGuardrailConfigurationInputDict
¶
Bases: TypedDict
Dictionary form of PutEnforcedGuardrailConfigurationInput.
Attributes¶
config_id
instance-attribute
¶
config_id: str | None
Unique ID for the account enforced configuration.
guardrail_inference_config
instance-attribute
¶
guardrail_inference_config: Required[AccountEnforcedGuardrailInferenceInputConfiguration | AccountEnforcedGuardrailInferenceInputConfigurationDict]
Account-level enforced guardrail input configuration.
PutEnforcedGuardrailConfigurationInput
dataclass
¶
Bases: _SerdeShape
Dataclass for PutEnforcedGuardrailConfigurationInput structure.
Attributes¶
config_id
class-attribute
instance-attribute
¶
config_id: str | None = ...
Unique ID for the account enforced configuration.
guardrail_inference_config
class-attribute
instance-attribute
¶
guardrail_inference_config: AccountEnforcedGuardrailInferenceInputConfiguration | None = ...
Account-level enforced guardrail input configuration.
Output¶
PutEnforcedGuardrailConfigurationOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for PutEnforcedGuardrailConfigurationOutput structure.
Attributes¶
config_id
class-attribute
instance-attribute
¶
config_id: str | None = ...
Unique ID for the account enforced configuration.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.