Skip to content

list_evaluators

Operation

list_evaluators

list_evaluators(request: ListEvaluatorsInput | ListEvaluatorsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListEvaluatorsInputDict]) -> ListEvaluatorsOutput

Lists all available evaluators, including both builtin evaluators provided by the service and custom evaluators created by the user.

Parameters:

Name Type Description Default
request ListEvaluatorsInput | ListEvaluatorsInputDict | 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[ListEvaluatorsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListEvaluatorsOutput

An instance of ListEvaluatorsOutput.

list_evaluators async

list_evaluators(request: ListEvaluatorsInput | ListEvaluatorsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListEvaluatorsInputDict]) -> ListEvaluatorsOutput

Lists all available evaluators, including both builtin evaluators provided by the service and custom evaluators created by the user.

Parameters:

Name Type Description Default
request ListEvaluatorsInput | ListEvaluatorsInputDict | 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[ListEvaluatorsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListEvaluatorsOutput

An instance of ListEvaluatorsOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

ListEvaluatorsInputDict

Bases: TypedDict

Dictionary form of ListEvaluatorsInput.

Attributes

max_results instance-attribute
max_results: int | None

The maximum number of evaluators to return in a single response.

next_token instance-attribute
next_token: str | None

The pagination token from a previous request to retrieve the next page of results.

ListEvaluatorsInput dataclass

Bases: _SerdeShape

Dataclass for ListEvaluatorsInput structure.

Attributes

max_results class-attribute instance-attribute
max_results: int | None = ...

The maximum number of evaluators to return in a single response.

next_token class-attribute instance-attribute
next_token: str | None = ...

The pagination token from a previous request to retrieve the next page of results.

Output

ListEvaluatorsOutput dataclass

Bases: _SerdeShape

Dataclass for ListEvaluatorsOutput structure.

Attributes

evaluators instance-attribute
evaluators: list[EvaluatorSummary]

The list of evaluator summaries containing basic information about each evaluator.

next_token class-attribute instance-attribute
next_token: str | None = ...

The pagination token to use in a subsequent request to retrieve the next page of results.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

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.