Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class EvaluateInstancesRequest.
Request message for EvaluationService.EvaluateInstances.
Generated from protobuf message google.cloud.aiplatform.v1.EvaluateInstancesRequest
Namespace
Google \ Cloud \ AIPlatform \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ exact_match_input |
ExactMatchInput
Auto metric instances. Instances and metric spec for exact match metric. |
↳ bleu_input |
BleuInput
Instances and metric spec for bleu metric. |
↳ rouge_input |
RougeInput
Instances and metric spec for rouge metric. |
↳ fluency_input |
FluencyInput
LLM-based metric instance. General text generation metrics, applicable to other categories. Input for fluency metric. |
↳ coherence_input |
CoherenceInput
Input for coherence metric. |
↳ safety_input |
SafetyInput
Input for safety metric. |
↳ groundedness_input |
GroundednessInput
Input for groundedness metric. |
↳ fulfillment_input |
FulfillmentInput
Input for fulfillment metric. |
↳ summarization_quality_input |
SummarizationQualityInput
Input for summarization quality metric. |
↳ pairwise_summarization_quality_input |
PairwiseSummarizationQualityInput
Input for pairwise summarization quality metric. |
↳ summarization_helpfulness_input |
SummarizationHelpfulnessInput
Input for summarization helpfulness metric. |
↳ summarization_verbosity_input |
SummarizationVerbosityInput
Input for summarization verbosity metric. |
↳ question_answering_quality_input |
QuestionAnsweringQualityInput
Input for question answering quality metric. |
↳ pairwise_question_answering_quality_input |
PairwiseQuestionAnsweringQualityInput
Input for pairwise question answering quality metric. |
↳ question_answering_relevance_input |
QuestionAnsweringRelevanceInput
Input for question answering relevance metric. |
↳ question_answering_helpfulness_input |
QuestionAnsweringHelpfulnessInput
Input for question answering helpfulness metric. |
↳ question_answering_correctness_input |
QuestionAnsweringCorrectnessInput
Input for question answering correctness metric. |
↳ pointwise_metric_input |
PointwiseMetricInput
Input for pointwise metric. |
↳ pairwise_metric_input |
PairwiseMetricInput
Input for pairwise metric. |
↳ tool_call_valid_input |
ToolCallValidInput
Tool call metric instances. Input for tool call valid metric. |
↳ tool_name_match_input |
ToolNameMatchInput
Input for tool name match metric. |
↳ tool_parameter_key_match_input |
ToolParameterKeyMatchInput
Input for tool parameter key match metric. |
↳ tool_parameter_kv_match_input |
ToolParameterKVMatchInput
Input for tool parameter key value match metric. |
↳ comet_input |
CometInput
Translation metrics. Input for Comet metric. |
↳ metricx_input |
MetricxInput
Input for Metricx metric. |
↳ location |
string
Required. The resource name of the Location to evaluate the instances. Format: |
getExactMatchInput
Auto metric instances.
Instances and metric spec for exact match metric.
| Returns | |
|---|---|
| Type | Description |
ExactMatchInput|null |
|
hasExactMatchInput
setExactMatchInput
Auto metric instances.
Instances and metric spec for exact match metric.
| Parameter | |
|---|---|
| Name | Description |
var |
ExactMatchInput
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getBleuInput
Instances and metric spec for bleu metric.
| Returns | |
|---|---|
| Type | Description |
BleuInput|null |
|
hasBleuInput
setBleuInput
Instances and metric spec for bleu metric.
| Parameter | |
|---|---|
| Name | Description |
var |
BleuInput
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRougeInput
Instances and metric spec for rouge metric.
| Returns | |
|---|---|
| Type | Description |
RougeInput|null |
|
hasRougeInput
setRougeInput
Instances and metric spec for rouge metric.
| Parameter | |
|---|---|
| Name | Description |
var |
RougeInput
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFluencyInput
LLM-based metric instance.
General text generation metrics, applicable to other categories. Input for fluency metric.
| Returns | |
|---|---|
| Type | Description |
FluencyInput|null |
|
hasFluencyInput
setFluencyInput
LLM-based metric instance.
General text generation metrics, applicable to other categories. Input for fluency metric.
| Parameter | |
|---|---|
| Name | Description |
var |
FluencyInput
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCoherenceInput
Input for coherence metric.
| Returns | |
|---|---|
| Type | Description |
CoherenceInput|null |
|
hasCoherenceInput
setCoherenceInput
Input for coherence metric.
| Parameter | |
|---|---|
| Name | Description |
var |
CoherenceInput
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSafetyInput
Input for safety metric.
| Returns | |
|---|---|
| Type | Description |
SafetyInput|null |
|
hasSafetyInput
setSafetyInput
Input for safety metric.
| Parameter | |
|---|---|
| Name | Description |
var |
SafetyInput
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getGroundednessInput
Input for groundedness metric.
| Returns | |
|---|---|
| Type | Description |
GroundednessInput|null |
|
hasGroundednessInput
setGroundednessInput
Input for groundedness metric.
| Parameter | |
|---|---|
| Name | Description |
var |
GroundednessInput
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFulfillmentInput
Input for fulfillment metric.
| Returns | |
|---|---|
| Type | Description |
FulfillmentInput|null |
|
hasFulfillmentInput
setFulfillmentInput
Input for fulfillment metric.
| Parameter | |
|---|---|
| Name | Description |
var |
FulfillmentInput
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSummarizationQualityInput
Input for summarization quality metric.
| Returns | |
|---|---|
| Type | Description |
SummarizationQualityInput|null |
|
hasSummarizationQualityInput
setSummarizationQualityInput
Input for summarization quality metric.
| Parameter | |
|---|---|
| Name | Description |
var |
SummarizationQualityInput
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPairwiseSummarizationQualityInput
Input for pairwise summarization quality metric.
| Returns | |
|---|---|
| Type | Description |
PairwiseSummarizationQualityInput|null |
|
hasPairwiseSummarizationQualityInput
setPairwiseSummarizationQualityInput
Input for pairwise summarization quality metric.
| Parameter | |
|---|---|
| Name | Description |
var |
PairwiseSummarizationQualityInput
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSummarizationHelpfulnessInput
Input for summarization helpfulness metric.
| Returns | |
|---|---|
| Type | Description |
SummarizationHelpfulnessInput|null |
|
hasSummarizationHelpfulnessInput
setSummarizationHelpfulnessInput
Input for summarization helpfulness metric.
| Parameter | |
|---|---|
| Name | Description |
var |
SummarizationHelpfulnessInput
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSummarizationVerbosityInput
Input for summarization verbosity metric.
| Returns | |
|---|---|
| Type | Description |
SummarizationVerbosityInput|null |
|
hasSummarizationVerbosityInput
setSummarizationVerbosityInput
Input for summarization verbosity metric.
| Parameter | |
|---|---|
| Name | Description |
var |
SummarizationVerbosityInput
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getQuestionAnsweringQualityInput
Input for question answering quality metric.
| Returns | |
|---|---|
| Type | Description |
QuestionAnsweringQualityInput|null |
|
hasQuestionAnsweringQualityInput
setQuestionAnsweringQualityInput
Input for question answering quality metric.
| Parameter | |
|---|---|
| Name | Description |
var |
QuestionAnsweringQualityInput
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPairwiseQuestionAnsweringQualityInput
Input for pairwise question answering quality metric.
| Returns | |
|---|---|
| Type | Description |
PairwiseQuestionAnsweringQualityInput|null |
|
hasPairwiseQuestionAnsweringQualityInput
setPairwiseQuestionAnsweringQualityInput
Input for pairwise question answering quality metric.
| Parameter | |
|---|---|
| Name | Description |
var |
PairwiseQuestionAnsweringQualityInput
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getQuestionAnsweringRelevanceInput
Input for question answering relevance metric.
| Returns | |
|---|---|
| Type | Description |
QuestionAnsweringRelevanceInput|null |
|
hasQuestionAnsweringRelevanceInput
setQuestionAnsweringRelevanceInput
Input for question answering relevance metric.
| Parameter | |
|---|---|
| Name | Description |
var |
QuestionAnsweringRelevanceInput
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getQuestionAnsweringHelpfulnessInput
Input for question answering helpfulness metric.
| Returns | |
|---|---|
| Type | Description |
QuestionAnsweringHelpfulnessInput|null |
|
hasQuestionAnsweringHelpfulnessInput
setQuestionAnsweringHelpfulnessInput
Input for question answering helpfulness metric.
| Parameter | |
|---|---|
| Name | Description |
var |
QuestionAnsweringHelpfulnessInput
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getQuestionAnsweringCorrectnessInput
Input for question answering correctness metric.
| Returns | |
|---|---|
| Type | Description |
QuestionAnsweringCorrectnessInput|null |
|
hasQuestionAnsweringCorrectnessInput
setQuestionAnsweringCorrectnessInput
Input for question answering correctness metric.
| Parameter | |
|---|---|
| Name | Description |
var |
QuestionAnsweringCorrectnessInput
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPointwiseMetricInput
Input for pointwise metric.
| Returns | |
|---|---|
| Type | Description |
PointwiseMetricInput|null |
|
hasPointwiseMetricInput
setPointwiseMetricInput
Input for pointwise metric.
| Parameter | |
|---|---|
| Name | Description |
var |
PointwiseMetricInput
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPairwiseMetricInput
Input for pairwise metric.
| Returns | |
|---|---|
| Type | Description |
PairwiseMetricInput|null |
|
hasPairwiseMetricInput
setPairwiseMetricInput
Input for pairwise metric.
| Parameter | |
|---|---|
| Name | Description |
var |
PairwiseMetricInput
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getToolCallValidInput
Tool call metric instances.
Input for tool call valid metric.
| Returns | |
|---|---|
| Type | Description |
ToolCallValidInput|null |
|
hasToolCallValidInput
setToolCallValidInput
Tool call metric instances.
Input for tool call valid metric.
| Parameter | |
|---|---|
| Name | Description |
var |
ToolCallValidInput
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getToolNameMatchInput
Input for tool name match metric.
| Returns | |
|---|---|
| Type | Description |
ToolNameMatchInput|null |
|
hasToolNameMatchInput
setToolNameMatchInput
Input for tool name match metric.
| Parameter | |
|---|---|
| Name | Description |
var |
ToolNameMatchInput
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getToolParameterKeyMatchInput
Input for tool parameter key match metric.
| Returns | |
|---|---|
| Type | Description |
ToolParameterKeyMatchInput|null |
|
hasToolParameterKeyMatchInput
setToolParameterKeyMatchInput
Input for tool parameter key match metric.
| Parameter | |
|---|---|
| Name | Description |
var |
ToolParameterKeyMatchInput
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getToolParameterKvMatchInput
Input for tool parameter key value match metric.
| Returns | |
|---|---|
| Type | Description |
ToolParameterKVMatchInput|null |
|
hasToolParameterKvMatchInput
setToolParameterKvMatchInput
Input for tool parameter key value match metric.
| Parameter | |
|---|---|
| Name | Description |
var |
ToolParameterKVMatchInput
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCometInput
Translation metrics.
Input for Comet metric.
| Returns | |
|---|---|
| Type | Description |
CometInput|null |
|
hasCometInput
setCometInput
Translation metrics.
Input for Comet metric.
| Parameter | |
|---|---|
| Name | Description |
var |
CometInput
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMetricxInput
Input for Metricx metric.
| Returns | |
|---|---|
| Type | Description |
MetricxInput|null |
|
hasMetricxInput
setMetricxInput
Input for Metricx metric.
| Parameter | |
|---|---|
| Name | Description |
var |
MetricxInput
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLocation
Required. The resource name of the Location to evaluate the instances.
Format: projects/{project}/locations/{location}
| Returns | |
|---|---|
| Type | Description |
string |
|
setLocation
Required. The resource name of the Location to evaluate the instances.
Format: projects/{project}/locations/{location}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMetricInputs
| Returns | |
|---|---|
| Type | Description |
string |
|