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 |
Google\Cloud\AIPlatform\V1\ExactMatchInput
Auto metric instances. Instances and metric spec for exact match metric. |
↳ bleu_input |
Google\Cloud\AIPlatform\V1\BleuInput
Instances and metric spec for bleu metric. |
↳ rouge_input |
Google\Cloud\AIPlatform\V1\RougeInput
Instances and metric spec for rouge metric. |
↳ fluency_input |
Google\Cloud\AIPlatform\V1\FluencyInput
LLM-based metric instance. General text generation metrics, applicable to other categories. Input for fluency metric. |
↳ coherence_input |
Google\Cloud\AIPlatform\V1\CoherenceInput
Input for coherence metric. |
↳ safety_input |
Google\Cloud\AIPlatform\V1\SafetyInput
Input for safety metric. |
↳ groundedness_input |
Google\Cloud\AIPlatform\V1\GroundednessInput
Input for groundedness metric. |
↳ fulfillment_input |
Google\Cloud\AIPlatform\V1\FulfillmentInput
Input for fulfillment metric. |
↳ summarization_quality_input |
Google\Cloud\AIPlatform\V1\SummarizationQualityInput
Input for summarization quality metric. |
↳ pairwise_summarization_quality_input |
Google\Cloud\AIPlatform\V1\PairwiseSummarizationQualityInput
Input for pairwise summarization quality metric. |
↳ summarization_helpfulness_input |
Google\Cloud\AIPlatform\V1\SummarizationHelpfulnessInput
Input for summarization helpfulness metric. |
↳ summarization_verbosity_input |
Google\Cloud\AIPlatform\V1\SummarizationVerbosityInput
Input for summarization verbosity metric. |
↳ question_answering_quality_input |
Google\Cloud\AIPlatform\V1\QuestionAnsweringQualityInput
Input for question answering quality metric. |
↳ pairwise_question_answering_quality_input |
Google\Cloud\AIPlatform\V1\PairwiseQuestionAnsweringQualityInput
Input for pairwise question answering quality metric. |
↳ question_answering_relevance_input |
Google\Cloud\AIPlatform\V1\QuestionAnsweringRelevanceInput
Input for question answering relevance metric. |
↳ question_answering_helpfulness_input |
Google\Cloud\AIPlatform\V1\QuestionAnsweringHelpfulnessInput
Input for question answering helpfulness metric. |
↳ question_answering_correctness_input |
Google\Cloud\AIPlatform\V1\QuestionAnsweringCorrectnessInput
Input for question answering correctness metric. |
↳ pointwise_metric_input |
Google\Cloud\AIPlatform\V1\PointwiseMetricInput
Input for pointwise metric. |
↳ pairwise_metric_input |
Google\Cloud\AIPlatform\V1\PairwiseMetricInput
Input for pairwise metric. |
↳ tool_call_valid_input |
Google\Cloud\AIPlatform\V1\ToolCallValidInput
Tool call metric instances. Input for tool call valid metric. |
↳ tool_name_match_input |
Google\Cloud\AIPlatform\V1\ToolNameMatchInput
Input for tool name match metric. |
↳ tool_parameter_key_match_input |
Google\Cloud\AIPlatform\V1\ToolParameterKeyMatchInput
Input for tool parameter key match metric. |
↳ tool_parameter_kv_match_input |
Google\Cloud\AIPlatform\V1\ToolParameterKVMatchInput
Input for tool parameter key value match 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 |
Google\Cloud\AIPlatform\V1\ExactMatchInput|null |
hasExactMatchInput
setExactMatchInput
Auto metric instances.
Instances and metric spec for exact match metric.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\AIPlatform\V1\ExactMatchInput
|
Returns | |
---|---|
Type | Description |
$this |
getBleuInput
Instances and metric spec for bleu metric.
Returns | |
---|---|
Type | Description |
Google\Cloud\AIPlatform\V1\BleuInput|null |
hasBleuInput
setBleuInput
Instances and metric spec for bleu metric.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\AIPlatform\V1\BleuInput
|
Returns | |
---|---|
Type | Description |
$this |
getRougeInput
Instances and metric spec for rouge metric.
Returns | |
---|---|
Type | Description |
Google\Cloud\AIPlatform\V1\RougeInput|null |
hasRougeInput
setRougeInput
Instances and metric spec for rouge metric.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\AIPlatform\V1\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 |
Google\Cloud\AIPlatform\V1\FluencyInput|null |
hasFluencyInput
setFluencyInput
LLM-based metric instance.
General text generation metrics, applicable to other categories. Input for fluency metric.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\AIPlatform\V1\FluencyInput
|
Returns | |
---|---|
Type | Description |
$this |
getCoherenceInput
Input for coherence metric.
Returns | |
---|---|
Type | Description |
Google\Cloud\AIPlatform\V1\CoherenceInput|null |
hasCoherenceInput
setCoherenceInput
Input for coherence metric.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\AIPlatform\V1\CoherenceInput
|
Returns | |
---|---|
Type | Description |
$this |
getSafetyInput
Input for safety metric.
Returns | |
---|---|
Type | Description |
Google\Cloud\AIPlatform\V1\SafetyInput|null |
hasSafetyInput
setSafetyInput
Input for safety metric.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\AIPlatform\V1\SafetyInput
|
Returns | |
---|---|
Type | Description |
$this |
getGroundednessInput
Input for groundedness metric.
Returns | |
---|---|
Type | Description |
Google\Cloud\AIPlatform\V1\GroundednessInput|null |
hasGroundednessInput
setGroundednessInput
Input for groundedness metric.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\AIPlatform\V1\GroundednessInput
|
Returns | |
---|---|
Type | Description |
$this |
getFulfillmentInput
Input for fulfillment metric.
Returns | |
---|---|
Type | Description |
Google\Cloud\AIPlatform\V1\FulfillmentInput|null |
hasFulfillmentInput
setFulfillmentInput
Input for fulfillment metric.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\AIPlatform\V1\FulfillmentInput
|
Returns | |
---|---|
Type | Description |
$this |
getSummarizationQualityInput
Input for summarization quality metric.
Returns | |
---|---|
Type | Description |
Google\Cloud\AIPlatform\V1\SummarizationQualityInput|null |
hasSummarizationQualityInput
setSummarizationQualityInput
Input for summarization quality metric.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\AIPlatform\V1\SummarizationQualityInput
|
Returns | |
---|---|
Type | Description |
$this |
getPairwiseSummarizationQualityInput
Input for pairwise summarization quality metric.
Returns | |
---|---|
Type | Description |
Google\Cloud\AIPlatform\V1\PairwiseSummarizationQualityInput|null |
hasPairwiseSummarizationQualityInput
setPairwiseSummarizationQualityInput
Input for pairwise summarization quality metric.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\AIPlatform\V1\PairwiseSummarizationQualityInput
|
Returns | |
---|---|
Type | Description |
$this |
getSummarizationHelpfulnessInput
Input for summarization helpfulness metric.
Returns | |
---|---|
Type | Description |
Google\Cloud\AIPlatform\V1\SummarizationHelpfulnessInput|null |
hasSummarizationHelpfulnessInput
setSummarizationHelpfulnessInput
Input for summarization helpfulness metric.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\AIPlatform\V1\SummarizationHelpfulnessInput
|
Returns | |
---|---|
Type | Description |
$this |
getSummarizationVerbosityInput
Input for summarization verbosity metric.
Returns | |
---|---|
Type | Description |
Google\Cloud\AIPlatform\V1\SummarizationVerbosityInput|null |
hasSummarizationVerbosityInput
setSummarizationVerbosityInput
Input for summarization verbosity metric.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\AIPlatform\V1\SummarizationVerbosityInput
|
Returns | |
---|---|
Type | Description |
$this |
getQuestionAnsweringQualityInput
Input for question answering quality metric.
Returns | |
---|---|
Type | Description |
Google\Cloud\AIPlatform\V1\QuestionAnsweringQualityInput|null |
hasQuestionAnsweringQualityInput
setQuestionAnsweringQualityInput
Input for question answering quality metric.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\AIPlatform\V1\QuestionAnsweringQualityInput
|
Returns | |
---|---|
Type | Description |
$this |
getPairwiseQuestionAnsweringQualityInput
Input for pairwise question answering quality metric.
Returns | |
---|---|
Type | Description |
Google\Cloud\AIPlatform\V1\PairwiseQuestionAnsweringQualityInput|null |
hasPairwiseQuestionAnsweringQualityInput
setPairwiseQuestionAnsweringQualityInput
Input for pairwise question answering quality metric.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\AIPlatform\V1\PairwiseQuestionAnsweringQualityInput
|
Returns | |
---|---|
Type | Description |
$this |
getQuestionAnsweringRelevanceInput
Input for question answering relevance metric.
Returns | |
---|---|
Type | Description |
Google\Cloud\AIPlatform\V1\QuestionAnsweringRelevanceInput|null |
hasQuestionAnsweringRelevanceInput
setQuestionAnsweringRelevanceInput
Input for question answering relevance metric.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\AIPlatform\V1\QuestionAnsweringRelevanceInput
|
Returns | |
---|---|
Type | Description |
$this |
getQuestionAnsweringHelpfulnessInput
Input for question answering helpfulness metric.
Returns | |
---|---|
Type | Description |
Google\Cloud\AIPlatform\V1\QuestionAnsweringHelpfulnessInput|null |
hasQuestionAnsweringHelpfulnessInput
setQuestionAnsweringHelpfulnessInput
Input for question answering helpfulness metric.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\AIPlatform\V1\QuestionAnsweringHelpfulnessInput
|
Returns | |
---|---|
Type | Description |
$this |
getQuestionAnsweringCorrectnessInput
Input for question answering correctness metric.
Returns | |
---|---|
Type | Description |
Google\Cloud\AIPlatform\V1\QuestionAnsweringCorrectnessInput|null |
hasQuestionAnsweringCorrectnessInput
setQuestionAnsweringCorrectnessInput
Input for question answering correctness metric.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\AIPlatform\V1\QuestionAnsweringCorrectnessInput
|
Returns | |
---|---|
Type | Description |
$this |
getPointwiseMetricInput
Input for pointwise metric.
Returns | |
---|---|
Type | Description |
Google\Cloud\AIPlatform\V1\PointwiseMetricInput|null |
hasPointwiseMetricInput
setPointwiseMetricInput
Input for pointwise metric.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\AIPlatform\V1\PointwiseMetricInput
|
Returns | |
---|---|
Type | Description |
$this |
getPairwiseMetricInput
Input for pairwise metric.
Returns | |
---|---|
Type | Description |
Google\Cloud\AIPlatform\V1\PairwiseMetricInput|null |
hasPairwiseMetricInput
setPairwiseMetricInput
Input for pairwise metric.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\AIPlatform\V1\PairwiseMetricInput
|
Returns | |
---|---|
Type | Description |
$this |
getToolCallValidInput
Tool call metric instances.
Input for tool call valid metric.
Returns | |
---|---|
Type | Description |
Google\Cloud\AIPlatform\V1\ToolCallValidInput|null |
hasToolCallValidInput
setToolCallValidInput
Tool call metric instances.
Input for tool call valid metric.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\AIPlatform\V1\ToolCallValidInput
|
Returns | |
---|---|
Type | Description |
$this |
getToolNameMatchInput
Input for tool name match metric.
Returns | |
---|---|
Type | Description |
Google\Cloud\AIPlatform\V1\ToolNameMatchInput|null |
hasToolNameMatchInput
setToolNameMatchInput
Input for tool name match metric.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\AIPlatform\V1\ToolNameMatchInput
|
Returns | |
---|---|
Type | Description |
$this |
getToolParameterKeyMatchInput
Input for tool parameter key match metric.
Returns | |
---|---|
Type | Description |
Google\Cloud\AIPlatform\V1\ToolParameterKeyMatchInput|null |
hasToolParameterKeyMatchInput
setToolParameterKeyMatchInput
Input for tool parameter key match metric.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\AIPlatform\V1\ToolParameterKeyMatchInput
|
Returns | |
---|---|
Type | Description |
$this |
getToolParameterKvMatchInput
Input for tool parameter key value match metric.
Returns | |
---|---|
Type | Description |
Google\Cloud\AIPlatform\V1\ToolParameterKVMatchInput|null |
hasToolParameterKvMatchInput
setToolParameterKvMatchInput
Input for tool parameter key value match metric.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\AIPlatform\V1\ToolParameterKVMatchInput
|
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 |