Google Cloud Ai Platform V1 Client - Class EvaluateInstancesResponse (1.3.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 Google\Cloud\AIPlatform\V1\ExactMatchResults

Auto metric evaluation results. Results for exact match metric.

↳ bleu_results Google\Cloud\AIPlatform\V1\BleuResults

Results for bleu metric.

↳ rouge_results Google\Cloud\AIPlatform\V1\RougeResults

Results for rouge metric.

↳ fluency_result Google\Cloud\AIPlatform\V1\FluencyResult

LLM-based metric evaluation result. General text generation metrics, applicable to other categories. Result for fluency metric.

↳ coherence_result Google\Cloud\AIPlatform\V1\CoherenceResult

Result for coherence metric.

↳ safety_result Google\Cloud\AIPlatform\V1\SafetyResult

Result for safety metric.

↳ groundedness_result Google\Cloud\AIPlatform\V1\GroundednessResult

Result for groundedness metric.

↳ fulfillment_result Google\Cloud\AIPlatform\V1\FulfillmentResult

Result for fulfillment metric.

↳ summarization_quality_result Google\Cloud\AIPlatform\V1\SummarizationQualityResult

Summarization only metrics. Result for summarization quality metric.

↳ pairwise_summarization_quality_result Google\Cloud\AIPlatform\V1\PairwiseSummarizationQualityResult

Result for pairwise summarization quality metric.

↳ summarization_helpfulness_result Google\Cloud\AIPlatform\V1\SummarizationHelpfulnessResult

Result for summarization helpfulness metric.

↳ summarization_verbosity_result Google\Cloud\AIPlatform\V1\SummarizationVerbosityResult

Result for summarization verbosity metric.

↳ question_answering_quality_result Google\Cloud\AIPlatform\V1\QuestionAnsweringQualityResult

Question answering only metrics. Result for question answering quality metric.

↳ pairwise_question_answering_quality_result Google\Cloud\AIPlatform\V1\PairwiseQuestionAnsweringQualityResult

Result for pairwise question answering quality metric.

↳ question_answering_relevance_result Google\Cloud\AIPlatform\V1\QuestionAnsweringRelevanceResult

Result for question answering relevance metric.

↳ question_answering_helpfulness_result Google\Cloud\AIPlatform\V1\QuestionAnsweringHelpfulnessResult

Result for question answering helpfulness metric.

↳ question_answering_correctness_result Google\Cloud\AIPlatform\V1\QuestionAnsweringCorrectnessResult

Result for question answering correctness metric.

↳ pointwise_metric_result Google\Cloud\AIPlatform\V1\PointwiseMetricResult

Generic metrics. Result for pointwise metric.

↳ pairwise_metric_result Google\Cloud\AIPlatform\V1\PairwiseMetricResult

Result for pairwise metric.

↳ tool_call_valid_results Google\Cloud\AIPlatform\V1\ToolCallValidResults

Tool call metrics. Results for tool call valid metric.

↳ tool_name_match_results Google\Cloud\AIPlatform\V1\ToolNameMatchResults

Results for tool name match metric.

↳ tool_parameter_key_match_results Google\Cloud\AIPlatform\V1\ToolParameterKeyMatchResults

Results for tool parameter key match metric.

↳ tool_parameter_kv_match_results Google\Cloud\AIPlatform\V1\ToolParameterKVMatchResults

Results for tool parameter key value match metric.

getExactMatchResults

Auto metric evaluation results.

Results for exact match metric.

Returns
Type Description
Google\Cloud\AIPlatform\V1\ExactMatchResults|null

hasExactMatchResults

setExactMatchResults

Auto metric evaluation results.

Results for exact match metric.

Parameter
Name Description
var Google\Cloud\AIPlatform\V1\ExactMatchResults
Returns
Type Description
$this

getBleuResults

Results for bleu metric.

Returns
Type Description
Google\Cloud\AIPlatform\V1\BleuResults|null

hasBleuResults

setBleuResults

Results for bleu metric.

Parameter
Name Description
var Google\Cloud\AIPlatform\V1\BleuResults
Returns
Type Description
$this

getRougeResults

Results for rouge metric.

Returns
Type Description
Google\Cloud\AIPlatform\V1\RougeResults|null

hasRougeResults

setRougeResults

Results for rouge metric.

Parameter
Name Description
var Google\Cloud\AIPlatform\V1\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
Google\Cloud\AIPlatform\V1\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 Google\Cloud\AIPlatform\V1\FluencyResult
Returns
Type Description
$this

getCoherenceResult

Result for coherence metric.

Returns
Type Description
Google\Cloud\AIPlatform\V1\CoherenceResult|null

hasCoherenceResult

setCoherenceResult

Result for coherence metric.

Parameter
Name Description
var Google\Cloud\AIPlatform\V1\CoherenceResult
Returns
Type Description
$this

getSafetyResult

Result for safety metric.

Returns
Type Description
Google\Cloud\AIPlatform\V1\SafetyResult|null

hasSafetyResult

setSafetyResult

Result for safety metric.

Parameter
Name Description
var Google\Cloud\AIPlatform\V1\SafetyResult
Returns
Type Description
$this

getGroundednessResult

Result for groundedness metric.

Returns
Type Description
Google\Cloud\AIPlatform\V1\GroundednessResult|null

hasGroundednessResult

setGroundednessResult

Result for groundedness metric.

Parameter
Name Description
var Google\Cloud\AIPlatform\V1\GroundednessResult
Returns
Type Description
$this

getFulfillmentResult

Result for fulfillment metric.

Returns
Type Description
Google\Cloud\AIPlatform\V1\FulfillmentResult|null

hasFulfillmentResult

setFulfillmentResult

Result for fulfillment metric.

Parameter
Name Description
var Google\Cloud\AIPlatform\V1\FulfillmentResult
Returns
Type Description
$this

getSummarizationQualityResult

Summarization only metrics.

Result for summarization quality metric.

Returns
Type Description
Google\Cloud\AIPlatform\V1\SummarizationQualityResult|null

hasSummarizationQualityResult

setSummarizationQualityResult

Summarization only metrics.

Result for summarization quality metric.

Parameter
Name Description
var Google\Cloud\AIPlatform\V1\SummarizationQualityResult
Returns
Type Description
$this

getPairwiseSummarizationQualityResult

Result for pairwise summarization quality metric.

Returns
Type Description
Google\Cloud\AIPlatform\V1\PairwiseSummarizationQualityResult|null

hasPairwiseSummarizationQualityResult

setPairwiseSummarizationQualityResult

Result for pairwise summarization quality metric.

Parameter
Name Description
var Google\Cloud\AIPlatform\V1\PairwiseSummarizationQualityResult
Returns
Type Description
$this

getSummarizationHelpfulnessResult

Result for summarization helpfulness metric.

Returns
Type Description
Google\Cloud\AIPlatform\V1\SummarizationHelpfulnessResult|null

hasSummarizationHelpfulnessResult

setSummarizationHelpfulnessResult

Result for summarization helpfulness metric.

Parameter
Name Description
var Google\Cloud\AIPlatform\V1\SummarizationHelpfulnessResult
Returns
Type Description
$this

getSummarizationVerbosityResult

Result for summarization verbosity metric.

Returns
Type Description
Google\Cloud\AIPlatform\V1\SummarizationVerbosityResult|null

hasSummarizationVerbosityResult

setSummarizationVerbosityResult

Result for summarization verbosity metric.

Parameter
Name Description
var Google\Cloud\AIPlatform\V1\SummarizationVerbosityResult
Returns
Type Description
$this

getQuestionAnsweringQualityResult

Question answering only metrics.

Result for question answering quality metric.

Returns
Type Description
Google\Cloud\AIPlatform\V1\QuestionAnsweringQualityResult|null

hasQuestionAnsweringQualityResult

setQuestionAnsweringQualityResult

Question answering only metrics.

Result for question answering quality metric.

Parameter
Name Description
var Google\Cloud\AIPlatform\V1\QuestionAnsweringQualityResult
Returns
Type Description
$this

getPairwiseQuestionAnsweringQualityResult

Result for pairwise question answering quality metric.

Returns
Type Description
Google\Cloud\AIPlatform\V1\PairwiseQuestionAnsweringQualityResult|null

hasPairwiseQuestionAnsweringQualityResult

setPairwiseQuestionAnsweringQualityResult

Result for pairwise question answering quality metric.

Parameter
Name Description
var Google\Cloud\AIPlatform\V1\PairwiseQuestionAnsweringQualityResult
Returns
Type Description
$this

getQuestionAnsweringRelevanceResult

Result for question answering relevance metric.

Returns
Type Description
Google\Cloud\AIPlatform\V1\QuestionAnsweringRelevanceResult|null

hasQuestionAnsweringRelevanceResult

setQuestionAnsweringRelevanceResult

Result for question answering relevance metric.

Parameter
Name Description
var Google\Cloud\AIPlatform\V1\QuestionAnsweringRelevanceResult
Returns
Type Description
$this

getQuestionAnsweringHelpfulnessResult

Result for question answering helpfulness metric.

Returns
Type Description
Google\Cloud\AIPlatform\V1\QuestionAnsweringHelpfulnessResult|null

hasQuestionAnsweringHelpfulnessResult

setQuestionAnsweringHelpfulnessResult

Result for question answering helpfulness metric.

Parameter
Name Description
var Google\Cloud\AIPlatform\V1\QuestionAnsweringHelpfulnessResult
Returns
Type Description
$this

getQuestionAnsweringCorrectnessResult

Result for question answering correctness metric.

Returns
Type Description
Google\Cloud\AIPlatform\V1\QuestionAnsweringCorrectnessResult|null

hasQuestionAnsweringCorrectnessResult

setQuestionAnsweringCorrectnessResult

Result for question answering correctness metric.

Parameter
Name Description
var Google\Cloud\AIPlatform\V1\QuestionAnsweringCorrectnessResult
Returns
Type Description
$this

getPointwiseMetricResult

Generic metrics.

Result for pointwise metric.

Returns
Type Description
Google\Cloud\AIPlatform\V1\PointwiseMetricResult|null

hasPointwiseMetricResult

setPointwiseMetricResult

Generic metrics.

Result for pointwise metric.

Parameter
Name Description
var Google\Cloud\AIPlatform\V1\PointwiseMetricResult
Returns
Type Description
$this

getPairwiseMetricResult

Result for pairwise metric.

Returns
Type Description
Google\Cloud\AIPlatform\V1\PairwiseMetricResult|null

hasPairwiseMetricResult

setPairwiseMetricResult

Result for pairwise metric.

Parameter
Name Description
var Google\Cloud\AIPlatform\V1\PairwiseMetricResult
Returns
Type Description
$this

getToolCallValidResults

Tool call metrics.

Results for tool call valid metric.

Returns
Type Description
Google\Cloud\AIPlatform\V1\ToolCallValidResults|null

hasToolCallValidResults

setToolCallValidResults

Tool call metrics.

Results for tool call valid metric.

Parameter
Name Description
var Google\Cloud\AIPlatform\V1\ToolCallValidResults
Returns
Type Description
$this

getToolNameMatchResults

Results for tool name match metric.

Returns
Type Description
Google\Cloud\AIPlatform\V1\ToolNameMatchResults|null

hasToolNameMatchResults

setToolNameMatchResults

Results for tool name match metric.

Parameter
Name Description
var Google\Cloud\AIPlatform\V1\ToolNameMatchResults
Returns
Type Description
$this

getToolParameterKeyMatchResults

Results for tool parameter key match metric.

Returns
Type Description
Google\Cloud\AIPlatform\V1\ToolParameterKeyMatchResults|null

hasToolParameterKeyMatchResults

setToolParameterKeyMatchResults

Results for tool parameter key match metric.

Parameter
Name Description
var Google\Cloud\AIPlatform\V1\ToolParameterKeyMatchResults
Returns
Type Description
$this

getToolParameterKvMatchResults

Results for tool parameter key value match metric.

Returns
Type Description
Google\Cloud\AIPlatform\V1\ToolParameterKVMatchResults|null

hasToolParameterKvMatchResults

setToolParameterKvMatchResults

Results for tool parameter key value match metric.

Parameter
Name Description
var Google\Cloud\AIPlatform\V1\ToolParameterKVMatchResults
Returns
Type Description
$this

getEvaluationResults

Returns
Type Description
string