Google Cloud Ai Platform V1 Client - Class EvaluateInstancesResponse (1.58.0)

1.58.0 (latest) 1.57.0 1.56.0 1.55.0 1.54.0 1.53.0 1.52.0 1.51.0 1.50.0 1.49.0 1.48.0 1.47.0 1.46.0 1.45.0 1.44.0 1.43.0 1.42.0 1.41.0 1.40.0 1.39.0 1.38.0 1.37.0 1.36.0 1.35.0 1.34.0 1.33.0 1.32.1 1.31.0 1.30.0 1.26.0 1.23.0 1.22.0 1.21.0 1.20.0 1.19.0 1.18.0 1.17.0 1.16.0 1.15.0 1.14.0 1.13.1 1.12.0 1.11.0 1.10.0 1.9.0 1.8.0 1.7.0 1.6.0 1.5.0 1.4.0 1.3.0 1.2.0 1.1.0 1.0.0 0.39.0 0.38.0 0.37.1 0.32.0 0.31.0 0.30.0 0.29.0 0.28.0 0.27.0 0.26.2 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.13.0 0.12.0 0.11.1 0.10.0

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class EvaluateInstancesResponse.

Response message for EvaluationService.EvaluateInstances.

Generated from protobuf message google.cloud.aiplatform.v1.EvaluateInstancesResponse

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ exact_match_results	ExactMatchResults Auto metric evaluation results. Results for exact match metric.
↳ bleu_results	BleuResults Results for bleu metric.
↳ rouge_results	RougeResults Results for rouge metric.
↳ fluency_result	FluencyResult LLM-based metric evaluation result. General text generation metrics, applicable to other categories. Result for fluency metric.
↳ coherence_result	CoherenceResult Result for coherence metric.
↳ safety_result	SafetyResult Result for safety metric.
↳ groundedness_result	GroundednessResult Result for groundedness metric.
↳ fulfillment_result	FulfillmentResult Result for fulfillment metric.
↳ summarization_quality_result	SummarizationQualityResult Summarization only metrics. Result for summarization quality metric.
↳ pairwise_summarization_quality_result	PairwiseSummarizationQualityResult Result for pairwise summarization quality metric.
↳ summarization_helpfulness_result	SummarizationHelpfulnessResult Result for summarization helpfulness metric.
↳ summarization_verbosity_result	SummarizationVerbosityResult Result for summarization verbosity metric.
↳ question_answering_quality_result	QuestionAnsweringQualityResult Question answering only metrics. Result for question answering quality metric.
↳ pairwise_question_answering_quality_result	PairwiseQuestionAnsweringQualityResult Result for pairwise question answering quality metric.
↳ question_answering_relevance_result	QuestionAnsweringRelevanceResult Result for question answering relevance metric.
↳ question_answering_helpfulness_result	QuestionAnsweringHelpfulnessResult Result for question answering helpfulness metric.
↳ question_answering_correctness_result	QuestionAnsweringCorrectnessResult Result for question answering correctness metric.
↳ pointwise_metric_result	PointwiseMetricResult Generic metrics. Result for pointwise metric.
↳ pairwise_metric_result	PairwiseMetricResult Result for pairwise metric.
↳ tool_call_valid_results	ToolCallValidResults Tool call metrics. Results for tool call valid metric.
↳ tool_name_match_results	ToolNameMatchResults Results for tool name match metric.
↳ tool_parameter_key_match_results	ToolParameterKeyMatchResults Results for tool parameter key match metric.
↳ tool_parameter_kv_match_results	ToolParameterKVMatchResults Results for tool parameter key value match metric.
↳ comet_result	CometResult Translation metrics. Result for Comet metric.
↳ metricx_result	MetricxResult Result for Metricx metric.
↳ metric_results	array<MetricResult> Metric results for each instance. The order of the metric results is guaranteed to be the same as the order of the instances in the request.

getExactMatchResults

Auto metric evaluation results.

Results for exact match metric.

Returns
Type	Description
ExactMatchResults|null

hasExactMatchResults

setExactMatchResults

Auto metric evaluation results.

Results for exact match metric.

Parameter
Name	Description
var	ExactMatchResults

Returns
Type	Description
$this

getBleuResults

Results for bleu metric.

Returns
Type	Description
BleuResults|null

hasBleuResults

setBleuResults

Results for bleu metric.

Parameter
Name	Description
var	BleuResults

Returns
Type	Description
$this

getRougeResults

Results for rouge metric.

Returns
Type	Description
RougeResults|null

hasRougeResults

setRougeResults

Results for rouge metric.

Parameter
Name	Description
var	RougeResults

Returns
Type	Description
$this

getFluencyResult

LLM-based metric evaluation result.

General text generation metrics, applicable to other categories. Result for fluency metric.

Returns
Type	Description
FluencyResult|null

hasFluencyResult

setFluencyResult

LLM-based metric evaluation result.

General text generation metrics, applicable to other categories. Result for fluency metric.

Parameter
Name	Description
var	FluencyResult

Returns
Type	Description
$this

getCoherenceResult

Result for coherence metric.

Returns
Type	Description
CoherenceResult|null

hasCoherenceResult

setCoherenceResult

Result for coherence metric.

Parameter
Name	Description
var	CoherenceResult

Returns
Type	Description
$this

getSafetyResult

Result for safety metric.

Returns
Type	Description
SafetyResult|null

hasSafetyResult

setSafetyResult

Result for safety metric.

Parameter
Name	Description
var	SafetyResult

Returns
Type	Description
$this

getGroundednessResult

Result for groundedness metric.

Returns
Type	Description
GroundednessResult|null

hasGroundednessResult

setGroundednessResult

Result for groundedness metric.

Parameter
Name	Description
var	GroundednessResult

Returns
Type	Description
$this

getFulfillmentResult

Result for fulfillment metric.

Returns
Type	Description
FulfillmentResult|null

hasFulfillmentResult

setFulfillmentResult

Result for fulfillment metric.

Parameter
Name	Description
var	FulfillmentResult

Returns
Type	Description
$this

getSummarizationQualityResult

Summarization only metrics.

Result for summarization quality metric.

Returns
Type	Description
SummarizationQualityResult|null

hasSummarizationQualityResult

setSummarizationQualityResult

Summarization only metrics.

Result for summarization quality metric.

Parameter
Name	Description
var	SummarizationQualityResult

Returns
Type	Description
$this

getPairwiseSummarizationQualityResult

Result for pairwise summarization quality metric.

Returns
Type	Description
PairwiseSummarizationQualityResult|null

hasPairwiseSummarizationQualityResult

setPairwiseSummarizationQualityResult

Result for pairwise summarization quality metric.

Parameter
Name	Description
var	PairwiseSummarizationQualityResult

Returns
Type	Description
$this

getSummarizationHelpfulnessResult

Result for summarization helpfulness metric.

Returns
Type	Description
SummarizationHelpfulnessResult|null

hasSummarizationHelpfulnessResult

setSummarizationHelpfulnessResult

Result for summarization helpfulness metric.

Parameter
Name	Description
var	SummarizationHelpfulnessResult

Returns
Type	Description
$this

getSummarizationVerbosityResult

Result for summarization verbosity metric.

Returns
Type	Description
SummarizationVerbosityResult|null

hasSummarizationVerbosityResult

setSummarizationVerbosityResult

Result for summarization verbosity metric.

Parameter
Name	Description
var	SummarizationVerbosityResult

Returns
Type	Description
$this

getQuestionAnsweringQualityResult

Question answering only metrics.

Result for question answering quality metric.

Returns
Type	Description
QuestionAnsweringQualityResult|null

hasQuestionAnsweringQualityResult

setQuestionAnsweringQualityResult

Question answering only metrics.

Result for question answering quality metric.

Parameter
Name	Description
var	QuestionAnsweringQualityResult

Returns
Type	Description
$this

getPairwiseQuestionAnsweringQualityResult

Result for pairwise question answering quality metric.

Returns
Type	Description
PairwiseQuestionAnsweringQualityResult|null

hasPairwiseQuestionAnsweringQualityResult

setPairwiseQuestionAnsweringQualityResult

Result for pairwise question answering quality metric.

Parameter
Name	Description
var	PairwiseQuestionAnsweringQualityResult

Returns
Type	Description
$this

getQuestionAnsweringRelevanceResult

Result for question answering relevance metric.

Returns
Type	Description
QuestionAnsweringRelevanceResult|null

hasQuestionAnsweringRelevanceResult

setQuestionAnsweringRelevanceResult

Result for question answering relevance metric.

Parameter
Name	Description
var	QuestionAnsweringRelevanceResult

Returns
Type	Description
$this

getQuestionAnsweringHelpfulnessResult

Result for question answering helpfulness metric.

Returns
Type	Description
QuestionAnsweringHelpfulnessResult|null

hasQuestionAnsweringHelpfulnessResult

setQuestionAnsweringHelpfulnessResult

Result for question answering helpfulness metric.

Parameter
Name	Description
var	QuestionAnsweringHelpfulnessResult

Returns
Type	Description
$this

getQuestionAnsweringCorrectnessResult

Result for question answering correctness metric.

Returns
Type	Description
QuestionAnsweringCorrectnessResult|null

hasQuestionAnsweringCorrectnessResult

setQuestionAnsweringCorrectnessResult

Result for question answering correctness metric.

Parameter
Name	Description
var	QuestionAnsweringCorrectnessResult

Returns
Type	Description
$this

getPointwiseMetricResult

Generic metrics.

Result for pointwise metric.

Returns
Type	Description
PointwiseMetricResult|null

hasPointwiseMetricResult

setPointwiseMetricResult

Generic metrics.

Result for pointwise metric.

Parameter
Name	Description
var	PointwiseMetricResult

Returns
Type	Description
$this

getPairwiseMetricResult

Result for pairwise metric.

Returns
Type	Description
PairwiseMetricResult|null

hasPairwiseMetricResult

setPairwiseMetricResult

Result for pairwise metric.

Parameter
Name	Description
var	PairwiseMetricResult

Returns
Type	Description
$this

getToolCallValidResults

Tool call metrics.

Results for tool call valid metric.

Returns
Type	Description
ToolCallValidResults|null

hasToolCallValidResults

setToolCallValidResults

Tool call metrics.

Results for tool call valid metric.

Parameter
Name	Description
var	ToolCallValidResults

Returns
Type	Description
$this

getToolNameMatchResults

Results for tool name match metric.

Returns
Type	Description
ToolNameMatchResults|null

hasToolNameMatchResults

setToolNameMatchResults

Results for tool name match metric.

Parameter
Name	Description
var	ToolNameMatchResults

Returns
Type	Description
$this

getToolParameterKeyMatchResults

Results for tool parameter key match metric.

Returns
Type	Description
ToolParameterKeyMatchResults|null

hasToolParameterKeyMatchResults

setToolParameterKeyMatchResults

Results for tool parameter key match metric.

Parameter
Name	Description
var	ToolParameterKeyMatchResults

Returns
Type	Description
$this

getToolParameterKvMatchResults

Results for tool parameter key value match metric.

Returns
Type	Description
ToolParameterKVMatchResults|null

hasToolParameterKvMatchResults

setToolParameterKvMatchResults

Results for tool parameter key value match metric.

Parameter
Name	Description
var	ToolParameterKVMatchResults

Returns
Type	Description
$this

getCometResult

Translation metrics.

Result for Comet metric.

Returns
Type	Description
CometResult|null

hasCometResult

setCometResult

Translation metrics.

Result for Comet metric.

Parameter
Name	Description
var	CometResult

Returns
Type	Description
$this

getMetricxResult

Result for Metricx metric.

Returns
Type	Description
MetricxResult|null

hasMetricxResult

setMetricxResult

Result for Metricx metric.

Parameter
Name	Description
var	MetricxResult

Returns
Type	Description
$this

getMetricResults

Metric results for each instance.

The order of the metric results is guaranteed to be the same as the order of the instances in the request.

Returns
Type	Description
Google\Protobuf\RepeatedField<MetricResult>

setMetricResults

Metric results for each instance.

The order of the metric results is guaranteed to be the same as the order of the instances in the request.

Parameter
Name	Description
var	array<MetricResult>

Returns
Type	Description
$this

getEvaluationResults

Returns
Type	Description
string