Class AsyncEvals (1.121.0)

AsyncEvals(api_client_: google.genai._api_client.BaseApiClient)

API documentation for AsyncEvals class.

Methods

batch_evaluate

batch_evaluate(
    *,
    dataset: typing.Union[
        vertexai._genai.types.EvaluationDataset,
        vertexai._genai.types.EvaluationDatasetDict,
    ],
    metrics: list[
        typing.Union[vertexai._genai.types.Metric, vertexai._genai.types.MetricDict]
    ],
    dest: str,
    config: typing.Optional[
        typing.Union[
            vertexai._genai.types.EvaluateDatasetConfig,
            vertexai._genai.types.EvaluateDatasetConfigDict,
        ]
    ] = None
) -> vertexai._genai.types.EvaluateDatasetOperation

Evaluates a dataset based on a set of given metrics.

create_evaluation_run

create_evaluation_run(
    *,
    name: str,
    display_name: typing.Optional[str] = None,
    data_source: vertexai._genai.types.EvaluationRunDataSource,
    dest: str,
    config: typing.Optional[
        typing.Union[
            vertexai._genai.types.CreateEvaluationRunConfig,
            vertexai._genai.types.CreateEvaluationRunConfigDict,
        ]
    ] = None
) -> vertexai._genai.types.EvaluationRun

Creates an EvaluationRun.

evaluate_instances

evaluate_instances(
    *, metric_config: vertexai._genai.types._EvaluateInstancesRequestParameters
) -> vertexai._genai.types.EvaluateInstancesResponse

Evaluates an instance of a model.

get_evaluation_item

get_evaluation_item(
    *,
    name: str,
    config: typing.Optional[
        typing.Union[
            vertexai._genai.types.GetEvaluationItemConfig,
            vertexai._genai.types.GetEvaluationItemConfigDict,
        ]
    ] = None
) -> vertexai._genai.types.EvaluationItem

Retrieves an EvaluationItem from the resource name.

get_evaluation_run

get_evaluation_run(
    *,
    name: str,
    config: typing.Optional[
        typing.Union[
            vertexai._genai.types.GetEvaluationRunConfig,
            vertexai._genai.types.GetEvaluationRunConfigDict,
        ]
    ] = None
) -> vertexai._genai.types.EvaluationRun

Retrieves an EvaluationRun from the resource name.

get_evaluation_set

get_evaluation_set(
    *,
    name: str,
    config: typing.Optional[
        typing.Union[
            vertexai._genai.types.GetEvaluationSetConfig,
            vertexai._genai.types.GetEvaluationSetConfigDict,
        ]
    ] = None
) -> vertexai._genai.types.EvaluationSet

Retrieves an EvaluationSet from the resource name.