update_evaluator¶
Operation¶
update_evaluator
¶
update_evaluator(request: UpdateEvaluatorInput | UpdateEvaluatorInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateEvaluatorInputDict]) -> UpdateEvaluatorOutput
Updates a custom evaluator's configuration, description, or evaluation level. Built-in evaluators cannot be updated. The evaluator must not be locked for modification.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
UpdateEvaluatorInput | UpdateEvaluatorInputDict | 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[UpdateEvaluatorInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
UpdateEvaluatorOutput
|
An instance of |
update_evaluator
async
¶
update_evaluator(request: UpdateEvaluatorInput | UpdateEvaluatorInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateEvaluatorInputDict]) -> UpdateEvaluatorOutput
Updates a custom evaluator's configuration, description, or evaluation level. Built-in evaluators cannot be updated. The evaluator must not be locked for modification.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
UpdateEvaluatorInput | UpdateEvaluatorInputDict | 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[UpdateEvaluatorInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
UpdateEvaluatorOutput
|
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.
UpdateEvaluatorInputDict
¶
Bases: TypedDict
Dictionary form of UpdateEvaluatorInput.
Attributes¶
client_token
instance-attribute
¶
client_token: str | None
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
This field is autopopulated if not provided.
evaluator_config
instance-attribute
¶
evaluator_config: EvaluatorConfig | EvaluatorConfigDict | None
The updated configuration for the evaluator. Specify either LLM-as-a-Judge settings with instructions, rating scale, and model configuration, or code-based settings with a customer-managed Lambda function.
evaluator_id
instance-attribute
¶
The unique identifier of the evaluator to update.
kms_key_arn
instance-attribute
¶
kms_key_arn: str | None
The Amazon Resource Name (ARN) of a customer managed KMS key to use for encrypting sensitive evaluator data. Specify a new key ARN to rotate the encryption key, or specify a key ARN to add encryption to an evaluator that was previously created without one. When you rotate to a new key, the service decrypts the existing data with the old key and re-encrypts it with the new key. Only symmetric encryption KMS keys are supported. For more information, see Encryption at rest for AgentCore Evaluations.
UpdateEvaluatorInput
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateEvaluatorInput structure.
Attributes¶
client_token
class-attribute
instance-attribute
¶
client_token: str | None = ...
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
This field is autopopulated if not provided.
description
class-attribute
instance-attribute
¶
description: str | None = ...
The updated description of the evaluator.
evaluator_config
class-attribute
instance-attribute
¶
evaluator_config: EvaluatorConfig | None = ...
The updated configuration for the evaluator. Specify either LLM-as-a-Judge settings with instructions, rating scale, and model configuration, or code-based settings with a customer-managed Lambda function.
evaluator_id
class-attribute
instance-attribute
¶
evaluator_id: str | None = ...
The unique identifier of the evaluator to update.
kms_key_arn
class-attribute
instance-attribute
¶
kms_key_arn: str | None = ...
The Amazon Resource Name (ARN) of a customer managed KMS key to use for encrypting sensitive evaluator data. Specify a new key ARN to rotate the encryption key, or specify a key ARN to add encryption to an evaluator that was previously created without one. When you rotate to a new key, the service decrypts the existing data with the old key and re-encrypts it with the new key. Only symmetric encryption KMS keys are supported. For more information, see Encryption at rest for AgentCore Evaluations.
Output¶
UpdateEvaluatorOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateEvaluatorOutput structure.
Attributes¶
evaluator_arn
instance-attribute
¶
evaluator_arn: str
The Amazon Resource Name (ARN) of the updated evaluator.
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.