evaluation_metrics

Creates, updates, deletes, gets or lists an evaluation_metrics resource.

Overview

Name	evaluation_metrics
Type	Resource
Id	google.aiplatform.evaluation_metrics

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Identifier. The resource name of the EvaluationMetric. Format: projects/{project}/locations/{location}/evaluationMetrics/{evaluation_metric}
createTime	string (google-datetime)	Output only. The time when the EvaluationMetric was created.
description	string	Optional. A description of the EvaluationMetric.
displayName	string	Required. The user-friendly display name for the EvaluationMetric.
encryptionSpec	object	Optional. Customer-managed encryption key spec for this EvaluationMetric. If set, this EvaluationMetric will be secured by this key. (id: GoogleCloudAiplatformV1EncryptionSpec)
gcsUri	string	Optional. The Google Cloud Storage URI that stores the metric specification..
labels	object	Optional. Labels for the evaluation metric.
metric	object	The metric used for running evaluations. (id: GoogleCloudAiplatformV1Metric)
updateTime	string (google-datetime)	Output only. The time when the EvaluationMetric was last updated.

list

Name	Datatype	Description
name	string	Identifier. The resource name of the EvaluationMetric. Format: projects/{project}/locations/{location}/evaluationMetrics/{evaluation_metric}
createTime	string (google-datetime)	Output only. The time when the EvaluationMetric was created.
description	string	Optional. A description of the EvaluationMetric.
displayName	string	Required. The user-friendly display name for the EvaluationMetric.
encryptionSpec	object	Optional. Customer-managed encryption key spec for this EvaluationMetric. If set, this EvaluationMetric will be secured by this key. (id: GoogleCloudAiplatformV1EncryptionSpec)
gcsUri	string	Optional. The Google Cloud Storage URI that stores the metric specification..
labels	object	Optional. Labels for the evaluation metric.
metric	object	The metric used for running evaluations. (id: GoogleCloudAiplatformV1Metric)
updateTime	string (google-datetime)	Output only. The time when the EvaluationMetric was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, evaluationMetricsId		Gets an EvaluationMetric.
list	select	projectsId, locationsId	filter, orderBy, pageSize, pageToken	Lists EvaluationMetrics.
create	insert	projectsId, locationsId	evaluationMetricId	Creates an EvaluationMetric.
delete	delete	projectsId, locationsId, evaluationMetricsId		Deletes an EvaluationMetric.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
evaluationMetricsId	string
locationsId	string
projectsId	string
evaluationMetricId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string

SELECT examples

get

Gets an EvaluationMetric.

SELECT
name,
createTime,
description,
displayName,
encryptionSpec,
gcsUri,
labels,
metric,
updateTime
FROM google.aiplatform.evaluation_metrics
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND evaluationMetricsId = '{{ evaluationMetricsId }}' -- required
;

list

Lists EvaluationMetrics.

SELECT
name,
createTime,
description,
displayName,
encryptionSpec,
gcsUri,
labels,
metric,
updateTime
FROM google.aiplatform.evaluation_metrics
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
;

INSERT examples

create

Creates an EvaluationMetric.

INSERT INTO google.aiplatform.evaluation_metrics (
data__description,
data__displayName,
data__encryptionSpec,
data__gcsUri,
data__labels,
data__metric,
data__name,
projectsId,
locationsId,
evaluationMetricId
)
SELECT 
'{{ description }}',
'{{ displayName }}',
'{{ encryptionSpec }}',
'{{ gcsUri }}',
'{{ labels }}',
'{{ metric }}',
'{{ name }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ evaluationMetricId }}'
RETURNING
name,
createTime,
description,
displayName,
encryptionSpec,
gcsUri,
labels,
metric,
updateTime
;

Manifest

# Description fields are for documentation purposes
- name: evaluation_metrics
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the evaluation_metrics resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the evaluation_metrics resource.
  - name: description
    value: "{{ description }}"
    description: |
      Optional. A description of the EvaluationMetric.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      Required. The user-friendly display name for the EvaluationMetric.
  - name: encryptionSpec
    description: |
      Optional. Customer-managed encryption key spec for this EvaluationMetric. If set, this EvaluationMetric will be secured by this key.
    value:
      kmsKeyName: "{{ kmsKeyName }}"
  - name: gcsUri
    value: "{{ gcsUri }}"
    description: |
      Optional. The Google Cloud Storage URI that stores the metric specification..
  - name: labels
    value: "{{ labels }}"
    description: |
      Optional. Labels for the evaluation metric.
  - name: metric
    description: |
      The metric used for running evaluations.
    value:
      aggregationMetrics:
        - "{{ aggregationMetrics }}"
      bleuSpec:
        useEffectiveOrder: {{ useEffectiveOrder }}
      computationBasedMetricSpec:
        parameters: "{{ parameters }}"
        type: "{{ type }}"
      customCodeExecutionSpec:
        evaluationFunction: "{{ evaluationFunction }}"
      exactMatchSpec: "{{ exactMatchSpec }}"
      llmBasedMetricSpec:
        additionalConfig: "{{ additionalConfig }}"
        judgeAutoraterConfig:
          autoraterModel: "{{ autoraterModel }}"
          flipEnabled: {{ flipEnabled }}
          generationConfig:
            audioTimestamp: {{ audioTimestamp }}
            audioTranscriptionConfig:
              adaptationPhrases: "{{ adaptationPhrases }}"
              customVocabulary: "{{ customVocabulary }}"
              diarization: {{ diarization }}
              languageAuto: "{{ languageAuto }}"
              languageCodes: "{{ languageCodes }}"
              languageHints: "{{ languageHints }}"
              wordTimestamp: {{ wordTimestamp }}
            candidateCount: {{ candidateCount }}
            enableAffectiveDialog: {{ enableAffectiveDialog }}
            frequencyPenalty: {{ frequencyPenalty }}
            imageConfig:
              aspectRatio: "{{ aspectRatio }}"
              imageOutputOptions: "{{ imageOutputOptions }}"
              imageSize: "{{ imageSize }}"
              personGeneration: "{{ personGeneration }}"
              prominentPeople: "{{ prominentPeople }}"
            logprobs: {{ logprobs }}
            maxOutputTokens: {{ maxOutputTokens }}
            mediaResolution: "{{ mediaResolution }}"
            presencePenalty: {{ presencePenalty }}
            responseFormat:
              - audio:
                  bitRate: {{ bitRate }}
                  delivery: "{{ delivery }}"
                  mimeType: "{{ mimeType }}"
                  sampleRate: {{ sampleRate }}
                image:
                  aspectRatio: "{{ aspectRatio }}"
                  delivery: "{{ delivery }}"
                  imageSize: "{{ imageSize }}"
                  mimeType: "{{ mimeType }}"
                text:
                  mimeType: "{{ mimeType }}"
                  schema: "{{ schema }}"
                video:
                  aspectRatio: "{{ aspectRatio }}"
                  delivery: "{{ delivery }}"
                  duration: "{{ duration }}"
                  gcsUri: "{{ gcsUri }}"
                  resolution: "{{ resolution }}"
            responseJsonSchema: "{{ responseJsonSchema }}"
            responseLogprobs: {{ responseLogprobs }}
            responseMimeType: "{{ responseMimeType }}"
            responseModalities:
              - "{{ responseModalities }}"
            responseSchema:
              additionalProperties: "{{ additionalProperties }}"
              anyOf: "{{ anyOf }}"
              default: "{{ default }}"
              defs: "{{ defs }}"
              description: "{{ description }}"
              enum: "{{ enum }}"
              example: "{{ example }}"
              format: "{{ format }}"
              items: "{{ items }}"
              maxItems: "{{ maxItems }}"
              maxLength: "{{ maxLength }}"
              maxProperties: "{{ maxProperties }}"
              maximum: {{ maximum }}
              minItems: "{{ minItems }}"
              minLength: "{{ minLength }}"
              minProperties: "{{ minProperties }}"
              minimum: {{ minimum }}
              nullable: {{ nullable }}
              pattern: "{{ pattern }}"
              properties: "{{ properties }}"
              propertyOrdering: "{{ propertyOrdering }}"
              ref: "{{ ref }}"
              required: "{{ required }}"
              title: "{{ title }}"
              type: "{{ type }}"
            routingConfig:
              autoMode: "{{ autoMode }}"
              manualMode: "{{ manualMode }}"
            seed: {{ seed }}
            speechConfig:
              languageCode: "{{ languageCode }}"
              multiSpeakerVoiceConfig: "{{ multiSpeakerVoiceConfig }}"
              voiceConfig: "{{ voiceConfig }}"
            stopSequences:
              - "{{ stopSequences }}"
            temperature: {{ temperature }}
            thinkingConfig:
              includeThoughts: {{ includeThoughts }}
              thinkingBudget: {{ thinkingBudget }}
              thinkingLevel: "{{ thinkingLevel }}"
            topK: {{ topK }}
            topP: {{ topP }}
          samplingCount: {{ samplingCount }}
        metricPromptTemplate: "{{ metricPromptTemplate }}"
        predefinedRubricGenerationSpec:
          metricSpecName: "{{ metricSpecName }}"
          metricSpecParameters: "{{ metricSpecParameters }}"
        resultParserConfig:
          customCodeParserConfig:
            parsingFunction: "{{ parsingFunction }}"
        rubricGenerationSpec:
          modelConfig:
            autoraterModel: "{{ autoraterModel }}"
            flipEnabled: {{ flipEnabled }}
            generationConfig:
              audioTimestamp: {{ audioTimestamp }}
              audioTranscriptionConfig: "{{ audioTranscriptionConfig }}"
              candidateCount: {{ candidateCount }}
              enableAffectiveDialog: {{ enableAffectiveDialog }}
              frequencyPenalty: {{ frequencyPenalty }}
              imageConfig: "{{ imageConfig }}"
              logprobs: {{ logprobs }}
              maxOutputTokens: {{ maxOutputTokens }}
              mediaResolution: "{{ mediaResolution }}"
              presencePenalty: {{ presencePenalty }}
              responseFormat: "{{ responseFormat }}"
              responseJsonSchema: "{{ responseJsonSchema }}"
              responseLogprobs: {{ responseLogprobs }}
              responseMimeType: "{{ responseMimeType }}"
              responseModalities: "{{ responseModalities }}"
              responseSchema: "{{ responseSchema }}"
              routingConfig: "{{ routingConfig }}"
              seed: {{ seed }}
              speechConfig: "{{ speechConfig }}"
              stopSequences: "{{ stopSequences }}"
              temperature: {{ temperature }}
              thinkingConfig: "{{ thinkingConfig }}"
              topK: {{ topK }}
              topP: {{ topP }}
            samplingCount: {{ samplingCount }}
          promptTemplate: "{{ promptTemplate }}"
          rubricContentType: "{{ rubricContentType }}"
          rubricTypeOntology:
            - "{{ rubricTypeOntology }}"
        rubricGroupKey: "{{ rubricGroupKey }}"
        systemInstruction: "{{ systemInstruction }}"
      metadata:
        otherMetadata: "{{ otherMetadata }}"
        scoreRange:
          description: "{{ description }}"
          max: {{ max }}
          min: {{ min }}
          step: {{ step }}
        title: "{{ title }}"
      pairwiseMetricSpec:
        baselineResponseFieldName: "{{ baselineResponseFieldName }}"
        candidateResponseFieldName: "{{ candidateResponseFieldName }}"
        customOutputFormatConfig:
          returnRawOutput: {{ returnRawOutput }}
        metricPromptTemplate: "{{ metricPromptTemplate }}"
        systemInstruction: "{{ systemInstruction }}"
      pointwiseMetricSpec:
        customOutputFormatConfig:
          returnRawOutput: {{ returnRawOutput }}
        metricPromptTemplate: "{{ metricPromptTemplate }}"
        systemInstruction: "{{ systemInstruction }}"
      predefinedMetricSpec:
        metricSpecName: "{{ metricSpecName }}"
        metricSpecParameters: "{{ metricSpecParameters }}"
      rougeSpec:
        rougeType: "{{ rougeType }}"
        splitSummaries: {{ splitSummaries }}
        useStemmer: {{ useStemmer }}
  - name: name
    value: "{{ name }}"
    description: |
      Identifier. The resource name of the EvaluationMetric. Format: `projects/{project}/locations/{location}/evaluationMetrics/{evaluation_metric}`
  - name: evaluationMetricId
    value: "{{ evaluationMetricId }}"

DELETE examples

delete

Deletes an EvaluationMetric.

DELETE FROM google.aiplatform.evaluation_metrics
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND evaluationMetricsId = '{{ evaluationMetricsId }}' --required
;