Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::EvaluateInstancesRequest (v0.56.0)

Version 0.56.0

• 0.61.0 (latest)
• 0.60.0
• 0.59.0
• 0.58.0
• 0.57.0
• 0.56.0
• 0.55.0
• 0.54.0
• 0.53.0
• 0.52.0
• 0.51.0
• 0.50.0
• 0.49.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.1
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::EvaluateInstancesRequest.

Request message for EvaluationService.EvaluateInstances.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#bleu_input

def bleu_input() -> ::Google::Cloud::AIPlatform::V1::BleuInput

Returns

• (::Google::Cloud::AIPlatform::V1::BleuInput) — Instances and metric spec for bleu metric.

#bleu_input=

def bleu_input=(value) -> ::Google::Cloud::AIPlatform::V1::BleuInput

Parameter

• value (::Google::Cloud::AIPlatform::V1::BleuInput) — Instances and metric spec for bleu metric.

Returns

• (::Google::Cloud::AIPlatform::V1::BleuInput) — Instances and metric spec for bleu metric.

#coherence_input

def coherence_input() -> ::Google::Cloud::AIPlatform::V1::CoherenceInput

Returns

• (::Google::Cloud::AIPlatform::V1::CoherenceInput) — Input for coherence metric.

#coherence_input=

def coherence_input=(value) -> ::Google::Cloud::AIPlatform::V1::CoherenceInput

Parameter

• value (::Google::Cloud::AIPlatform::V1::CoherenceInput) — Input for coherence metric.

Returns

• (::Google::Cloud::AIPlatform::V1::CoherenceInput) — Input for coherence metric.

#exact_match_input

def exact_match_input() -> ::Google::Cloud::AIPlatform::V1::ExactMatchInput

Returns

• (::Google::Cloud::AIPlatform::V1::ExactMatchInput) — Auto metric instances. Instances and metric spec for exact match metric.

#exact_match_input=

def exact_match_input=(value) -> ::Google::Cloud::AIPlatform::V1::ExactMatchInput

Parameter

• value (::Google::Cloud::AIPlatform::V1::ExactMatchInput) — Auto metric instances. Instances and metric spec for exact match metric.

Returns

• (::Google::Cloud::AIPlatform::V1::ExactMatchInput) — Auto metric instances. Instances and metric spec for exact match metric.

#fluency_input

def fluency_input() -> ::Google::Cloud::AIPlatform::V1::FluencyInput

Returns

• (::Google::Cloud::AIPlatform::V1::FluencyInput) — LLM-based metric instance. General text generation metrics, applicable to other categories. Input for fluency metric.

#fluency_input=

def fluency_input=(value) -> ::Google::Cloud::AIPlatform::V1::FluencyInput

Parameter

• value (::Google::Cloud::AIPlatform::V1::FluencyInput) — LLM-based metric instance. General text generation metrics, applicable to other categories. Input for fluency metric.

Returns

• (::Google::Cloud::AIPlatform::V1::FluencyInput) — LLM-based metric instance. General text generation metrics, applicable to other categories. Input for fluency metric.

#fulfillment_input

def fulfillment_input() -> ::Google::Cloud::AIPlatform::V1::FulfillmentInput

Returns

• (::Google::Cloud::AIPlatform::V1::FulfillmentInput) — Input for fulfillment metric.

#fulfillment_input=

def fulfillment_input=(value) -> ::Google::Cloud::AIPlatform::V1::FulfillmentInput

Parameter

• value (::Google::Cloud::AIPlatform::V1::FulfillmentInput) — Input for fulfillment metric.

Returns

• (::Google::Cloud::AIPlatform::V1::FulfillmentInput) — Input for fulfillment metric.

#groundedness_input

def groundedness_input() -> ::Google::Cloud::AIPlatform::V1::GroundednessInput

Returns

• (::Google::Cloud::AIPlatform::V1::GroundednessInput) — Input for groundedness metric.

#groundedness_input=

def groundedness_input=(value) -> ::Google::Cloud::AIPlatform::V1::GroundednessInput

Parameter

• value (::Google::Cloud::AIPlatform::V1::GroundednessInput) — Input for groundedness metric.

Returns

• (::Google::Cloud::AIPlatform::V1::GroundednessInput) — Input for groundedness metric.

#location

def location() -> ::String

Returns

• (::String) — Required. The resource name of the Location to evaluate the instances. Format: projects/{project}/locations/{location}

#location=

def location=(value) -> ::String

Parameter

• value (::String) — Required. The resource name of the Location to evaluate the instances. Format: projects/{project}/locations/{location}

Returns

• (::String) — Required. The resource name of the Location to evaluate the instances. Format: projects/{project}/locations/{location}

#pairwise_metric_input

def pairwise_metric_input() -> ::Google::Cloud::AIPlatform::V1::PairwiseMetricInput

Returns

• (::Google::Cloud::AIPlatform::V1::PairwiseMetricInput) — Input for pairwise metric.

#pairwise_metric_input=

def pairwise_metric_input=(value) -> ::Google::Cloud::AIPlatform::V1::PairwiseMetricInput

Parameter

• value (::Google::Cloud::AIPlatform::V1::PairwiseMetricInput) — Input for pairwise metric.

Returns

• (::Google::Cloud::AIPlatform::V1::PairwiseMetricInput) — Input for pairwise metric.

#pairwise_question_answering_quality_input

def pairwise_question_answering_quality_input() -> ::Google::Cloud::AIPlatform::V1::PairwiseQuestionAnsweringQualityInput

Returns

• (::Google::Cloud::AIPlatform::V1::PairwiseQuestionAnsweringQualityInput) — Input for pairwise question answering quality metric.

#pairwise_question_answering_quality_input=

def pairwise_question_answering_quality_input=(value) -> ::Google::Cloud::AIPlatform::V1::PairwiseQuestionAnsweringQualityInput

Parameter

• value (::Google::Cloud::AIPlatform::V1::PairwiseQuestionAnsweringQualityInput) — Input for pairwise question answering quality metric.

Returns

• (::Google::Cloud::AIPlatform::V1::PairwiseQuestionAnsweringQualityInput) — Input for pairwise question answering quality metric.

#pairwise_summarization_quality_input

def pairwise_summarization_quality_input() -> ::Google::Cloud::AIPlatform::V1::PairwiseSummarizationQualityInput

Returns

• (::Google::Cloud::AIPlatform::V1::PairwiseSummarizationQualityInput) — Input for pairwise summarization quality metric.

#pairwise_summarization_quality_input=

def pairwise_summarization_quality_input=(value) -> ::Google::Cloud::AIPlatform::V1::PairwiseSummarizationQualityInput

Parameter

• value (::Google::Cloud::AIPlatform::V1::PairwiseSummarizationQualityInput) — Input for pairwise summarization quality metric.

Returns

• (::Google::Cloud::AIPlatform::V1::PairwiseSummarizationQualityInput) — Input for pairwise summarization quality metric.

#pointwise_metric_input

def pointwise_metric_input() -> ::Google::Cloud::AIPlatform::V1::PointwiseMetricInput

Returns

• (::Google::Cloud::AIPlatform::V1::PointwiseMetricInput) — Input for pointwise metric.

#pointwise_metric_input=

def pointwise_metric_input=(value) -> ::Google::Cloud::AIPlatform::V1::PointwiseMetricInput

Parameter

• value (::Google::Cloud::AIPlatform::V1::PointwiseMetricInput) — Input for pointwise metric.

Returns

• (::Google::Cloud::AIPlatform::V1::PointwiseMetricInput) — Input for pointwise metric.

#question_answering_correctness_input

def question_answering_correctness_input() -> ::Google::Cloud::AIPlatform::V1::QuestionAnsweringCorrectnessInput

Returns

• (::Google::Cloud::AIPlatform::V1::QuestionAnsweringCorrectnessInput) — Input for question answering correctness metric.

#question_answering_correctness_input=

def question_answering_correctness_input=(value) -> ::Google::Cloud::AIPlatform::V1::QuestionAnsweringCorrectnessInput

Parameter

• value (::Google::Cloud::AIPlatform::V1::QuestionAnsweringCorrectnessInput) — Input for question answering correctness metric.

Returns

• (::Google::Cloud::AIPlatform::V1::QuestionAnsweringCorrectnessInput) — Input for question answering correctness metric.

#question_answering_helpfulness_input

def question_answering_helpfulness_input() -> ::Google::Cloud::AIPlatform::V1::QuestionAnsweringHelpfulnessInput

Returns

• (::Google::Cloud::AIPlatform::V1::QuestionAnsweringHelpfulnessInput) — Input for question answering helpfulness metric.

#question_answering_helpfulness_input=

def question_answering_helpfulness_input=(value) -> ::Google::Cloud::AIPlatform::V1::QuestionAnsweringHelpfulnessInput

Parameter

• value (::Google::Cloud::AIPlatform::V1::QuestionAnsweringHelpfulnessInput) — Input for question answering helpfulness metric.

Returns

• (::Google::Cloud::AIPlatform::V1::QuestionAnsweringHelpfulnessInput) — Input for question answering helpfulness metric.

#question_answering_quality_input

def question_answering_quality_input() -> ::Google::Cloud::AIPlatform::V1::QuestionAnsweringQualityInput

Returns

• (::Google::Cloud::AIPlatform::V1::QuestionAnsweringQualityInput) — Input for question answering quality metric.

#question_answering_quality_input=

def question_answering_quality_input=(value) -> ::Google::Cloud::AIPlatform::V1::QuestionAnsweringQualityInput

Parameter

• value (::Google::Cloud::AIPlatform::V1::QuestionAnsweringQualityInput) — Input for question answering quality metric.

Returns

• (::Google::Cloud::AIPlatform::V1::QuestionAnsweringQualityInput) — Input for question answering quality metric.

#question_answering_relevance_input

def question_answering_relevance_input() -> ::Google::Cloud::AIPlatform::V1::QuestionAnsweringRelevanceInput

Returns

• (::Google::Cloud::AIPlatform::V1::QuestionAnsweringRelevanceInput) — Input for question answering relevance metric.

#question_answering_relevance_input=

def question_answering_relevance_input=(value) -> ::Google::Cloud::AIPlatform::V1::QuestionAnsweringRelevanceInput

Parameter

• value (::Google::Cloud::AIPlatform::V1::QuestionAnsweringRelevanceInput) — Input for question answering relevance metric.

Returns

• (::Google::Cloud::AIPlatform::V1::QuestionAnsweringRelevanceInput) — Input for question answering relevance metric.

#rouge_input

def rouge_input() -> ::Google::Cloud::AIPlatform::V1::RougeInput

Returns

• (::Google::Cloud::AIPlatform::V1::RougeInput) — Instances and metric spec for rouge metric.

#rouge_input=

def rouge_input=(value) -> ::Google::Cloud::AIPlatform::V1::RougeInput

Parameter

• value (::Google::Cloud::AIPlatform::V1::RougeInput) — Instances and metric spec for rouge metric.

Returns

• (::Google::Cloud::AIPlatform::V1::RougeInput) — Instances and metric spec for rouge metric.

#safety_input

def safety_input() -> ::Google::Cloud::AIPlatform::V1::SafetyInput

Returns

• (::Google::Cloud::AIPlatform::V1::SafetyInput) — Input for safety metric.

#safety_input=

def safety_input=(value) -> ::Google::Cloud::AIPlatform::V1::SafetyInput

Parameter

• value (::Google::Cloud::AIPlatform::V1::SafetyInput) — Input for safety metric.

Returns

• (::Google::Cloud::AIPlatform::V1::SafetyInput) — Input for safety metric.

#summarization_helpfulness_input

def summarization_helpfulness_input() -> ::Google::Cloud::AIPlatform::V1::SummarizationHelpfulnessInput

Returns

• (::Google::Cloud::AIPlatform::V1::SummarizationHelpfulnessInput) — Input for summarization helpfulness metric.

#summarization_helpfulness_input=

def summarization_helpfulness_input=(value) -> ::Google::Cloud::AIPlatform::V1::SummarizationHelpfulnessInput

Parameter

• value (::Google::Cloud::AIPlatform::V1::SummarizationHelpfulnessInput) — Input for summarization helpfulness metric.

Returns

• (::Google::Cloud::AIPlatform::V1::SummarizationHelpfulnessInput) — Input for summarization helpfulness metric.

#summarization_quality_input

def summarization_quality_input() -> ::Google::Cloud::AIPlatform::V1::SummarizationQualityInput

Returns

• (::Google::Cloud::AIPlatform::V1::SummarizationQualityInput) — Input for summarization quality metric.

#summarization_quality_input=

def summarization_quality_input=(value) -> ::Google::Cloud::AIPlatform::V1::SummarizationQualityInput

Parameter

• value (::Google::Cloud::AIPlatform::V1::SummarizationQualityInput) — Input for summarization quality metric.

Returns

• (::Google::Cloud::AIPlatform::V1::SummarizationQualityInput) — Input for summarization quality metric.

#summarization_verbosity_input

def summarization_verbosity_input() -> ::Google::Cloud::AIPlatform::V1::SummarizationVerbosityInput

Returns

• (::Google::Cloud::AIPlatform::V1::SummarizationVerbosityInput) — Input for summarization verbosity metric.

#summarization_verbosity_input=

def summarization_verbosity_input=(value) -> ::Google::Cloud::AIPlatform::V1::SummarizationVerbosityInput

Parameter

• value (::Google::Cloud::AIPlatform::V1::SummarizationVerbosityInput) — Input for summarization verbosity metric.

Returns

• (::Google::Cloud::AIPlatform::V1::SummarizationVerbosityInput) — Input for summarization verbosity metric.

#tool_call_valid_input

def tool_call_valid_input() -> ::Google::Cloud::AIPlatform::V1::ToolCallValidInput

Returns

• (::Google::Cloud::AIPlatform::V1::ToolCallValidInput) — Tool call metric instances. Input for tool call valid metric.

#tool_call_valid_input=

def tool_call_valid_input=(value) -> ::Google::Cloud::AIPlatform::V1::ToolCallValidInput

Parameter

• value (::Google::Cloud::AIPlatform::V1::ToolCallValidInput) — Tool call metric instances. Input for tool call valid metric.

Returns

• (::Google::Cloud::AIPlatform::V1::ToolCallValidInput) — Tool call metric instances. Input for tool call valid metric.

#tool_name_match_input

def tool_name_match_input() -> ::Google::Cloud::AIPlatform::V1::ToolNameMatchInput

Returns

• (::Google::Cloud::AIPlatform::V1::ToolNameMatchInput) — Input for tool name match metric.

#tool_name_match_input=

def tool_name_match_input=(value) -> ::Google::Cloud::AIPlatform::V1::ToolNameMatchInput

Parameter

• value (::Google::Cloud::AIPlatform::V1::ToolNameMatchInput) — Input for tool name match metric.

Returns

• (::Google::Cloud::AIPlatform::V1::ToolNameMatchInput) — Input for tool name match metric.

#tool_parameter_key_match_input

def tool_parameter_key_match_input() -> ::Google::Cloud::AIPlatform::V1::ToolParameterKeyMatchInput

Returns

• (::Google::Cloud::AIPlatform::V1::ToolParameterKeyMatchInput) — Input for tool parameter key match metric.

#tool_parameter_key_match_input=

def tool_parameter_key_match_input=(value) -> ::Google::Cloud::AIPlatform::V1::ToolParameterKeyMatchInput

Parameter

• value (::Google::Cloud::AIPlatform::V1::ToolParameterKeyMatchInput) — Input for tool parameter key match metric.

Returns

• (::Google::Cloud::AIPlatform::V1::ToolParameterKeyMatchInput) — Input for tool parameter key match metric.

#tool_parameter_kv_match_input

def tool_parameter_kv_match_input() -> ::Google::Cloud::AIPlatform::V1::ToolParameterKVMatchInput

Returns

• (::Google::Cloud::AIPlatform::V1::ToolParameterKVMatchInput) — Input for tool parameter key value match metric.

#tool_parameter_kv_match_input=

def tool_parameter_kv_match_input=(value) -> ::Google::Cloud::AIPlatform::V1::ToolParameterKVMatchInput

Parameter

• value (::Google::Cloud::AIPlatform::V1::ToolParameterKVMatchInput) — Input for tool parameter key value match metric.

Returns

• (::Google::Cloud::AIPlatform::V1::ToolParameterKVMatchInput) — Input for tool parameter key value match metric.