Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Google Cloud (GCP) Classic
  4. API Docs
  5. vertex
  6. AiEvaluationMetric
Viewing docs for Google Cloud v9.36.1
published on Thursday, Sep 3, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-gcp

gcp.vertex.AiEvaluationMetric

gcp logo
Viewing docs for Google Cloud v9.36.1
published on Thursday, Sep 3, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-gcp

    A reusable metric configuration for Vertex AI evaluation. EvaluationMetrics define how model outputs are scored, supporting predefined metrics, LLM-based metrics, pointwise and pairwise comparisons, and custom code execution metrics.

    To get more information about EvaluationMetric, see:

    Example Usage

    Vertex Ai Evaluation Metric

    import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const example = new gcp.vertex.AiEvaluationMetric("example", {
    evaluationMetricId: "example-metric",
    region: "us-central1",
    displayName: "Test Evaluation Metric",
    description: "An evaluation metric for Terraform acceptance testing",
    metric: JSON.stringify({
        llmBasedMetricSpec: {
            metricPromptTemplate: "Rate the quality of the following response on a scale of 1 to 5. Response: {response}",
        },
    }),
});

    import pulumi
import json
import pulumi_gcp as gcp

example = gcp.vertex.AiEvaluationMetric("example",
    evaluation_metric_id="example-metric",
    region="us-central1",
    display_name="Test Evaluation Metric",
    description="An evaluation metric for Terraform acceptance testing",
    metric=json.dumps({
        "llmBasedMetricSpec": {
            "metricPromptTemplate": "Rate the quality of the following response on a scale of 1 to 5. Response: {response}",
        },
    }))

    package main

import (
	"encoding/json"

	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/vertex"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		tmpJSON0, err := json.Marshal(map[string]map[string]string{
			"llmBasedMetricSpec": map[string]string{
				"metricPromptTemplate": "Rate the quality of the following response on a scale of 1 to 5. Response: {response}",
			},
		})
		if err != nil {
			return err
		}
		json0 := string(tmpJSON0)
		_, err = vertex.NewAiEvaluationMetric(ctx, "example", &vertex.AiEvaluationMetricArgs{
			EvaluationMetricId: pulumi.String("example-metric"),
			Region:             pulumi.String("us-central1"),
			DisplayName:        pulumi.String("Test Evaluation Metric"),
			Description:        pulumi.String("An evaluation metric for Terraform acceptance testing"),
			Metric:             pulumi.String(json0),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var example = new Gcp.Vertex.AiEvaluationMetric("example", new()
    {
        EvaluationMetricId = "example-metric",
        Region = "us-central1",
        DisplayName = "Test Evaluation Metric",
        Description = "An evaluation metric for Terraform acceptance testing",
        Metric = JsonSerializer.Serialize(new Dictionary<string, object?>
        {
            ["llmBasedMetricSpec"] = new Dictionary<string, object?>
            {
                ["metricPromptTemplate"] = "Rate the quality of the following response on a scale of 1 to 5. Response: {response}",
            },
        }),
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.vertex.AiEvaluationMetric;
import com.pulumi.gcp.vertex.AiEvaluationMetricArgs;
import static com.pulumi.codegen.internal.Serialization.*;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new AiEvaluationMetric("example", AiEvaluationMetricArgs.builder()
            .evaluationMetricId("example-metric")
            .region("us-central1")
            .displayName("Test Evaluation Metric")
            .description("An evaluation metric for Terraform acceptance testing")
            .metric(serializeJson(
                jsonObject(
                    jsonProperty("llmBasedMetricSpec", jsonObject(
                        jsonProperty("metricPromptTemplate", "Rate the quality of the following response on a scale of 1 to 5. Response: {response}")
                    ))
                )))
            .build());

    }
}

    resources:
  example:
    type: gcp:vertex:AiEvaluationMetric
    properties:
      evaluationMetricId: example-metric
      region: us-central1
      displayName: Test Evaluation Metric
      description: An evaluation metric for Terraform acceptance testing
      metric:
        fn::toJSON:
          llmBasedMetricSpec:
            metricPromptTemplate: 'Rate the quality of the following response on a scale of 1 to 5. Response: {response}'

    pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_vertex_aievaluationmetric" "example" {
  evaluation_metric_id = "example-metric"
  region               = "us-central1"
  display_name         = "Test Evaluation Metric"
  description          = "An evaluation metric for Terraform acceptance testing"
  metric = jsonencode({
    "llmBasedMetricSpec" = {
      "metricPromptTemplate" = "Rate the quality of the following response on a scale of 1 to 5. Response: {response}"
    }
  })
}

    Vertex Ai Evaluation Metric Full

    import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const example = new gcp.vertex.AiEvaluationMetric("example", {
    evaluationMetricId: "example-metric-full",
    region: "us-central1",
    displayName: "Full Test Evaluation Metric",
    description: "An evaluation metric with all fields for Terraform acceptance testing",
    metric: JSON.stringify({
        llmBasedMetricSpec: {
            metricPromptTemplate: "Rate the quality of the following response on a scale of 1 to 5. Response: {response}",
        },
    }),
    labels: {
        env: "test",
        team: "evaluation",
    },
    encryptionSpec: {
        kmsKeyName: "kms-key",
    },
    gcsUri: "gs://eval-metric-test-bucket/metric-spec.json",
});
const metricBucket = new gcp.storage.Bucket("metric_bucket", {
    name: "eval-metric-test-bucket",
    location: "us-central1",
    uniformBucketLevelAccess: true,
    forceDestroy: true,
});

    import pulumi
import json
import pulumi_gcp as gcp

example = gcp.vertex.AiEvaluationMetric("example",
    evaluation_metric_id="example-metric-full",
    region="us-central1",
    display_name="Full Test Evaluation Metric",
    description="An evaluation metric with all fields for Terraform acceptance testing",
    metric=json.dumps({
        "llmBasedMetricSpec": {
            "metricPromptTemplate": "Rate the quality of the following response on a scale of 1 to 5. Response: {response}",
        },
    }),
    labels={
        "env": "test",
        "team": "evaluation",
    },
    encryption_spec={
        "kms_key_name": "kms-key",
    },
    gcs_uri="gs://eval-metric-test-bucket/metric-spec.json")
metric_bucket = gcp.storage.Bucket("metric_bucket",
    name="eval-metric-test-bucket",
    location="us-central1",
    uniform_bucket_level_access=True,
    force_destroy=True)

    package main

import (
	"encoding/json"

	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/storage"
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/vertex"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		tmpJSON0, err := json.Marshal(map[string]map[string]string{
			"llmBasedMetricSpec": map[string]string{
				"metricPromptTemplate": "Rate the quality of the following response on a scale of 1 to 5. Response: {response}",
			},
		})
		if err != nil {
			return err
		}
		json0 := string(tmpJSON0)
		_, err = vertex.NewAiEvaluationMetric(ctx, "example", &vertex.AiEvaluationMetricArgs{
			EvaluationMetricId: pulumi.String("example-metric-full"),
			Region:             pulumi.String("us-central1"),
			DisplayName:        pulumi.String("Full Test Evaluation Metric"),
			Description:        pulumi.String("An evaluation metric with all fields for Terraform acceptance testing"),
			Metric:             pulumi.String(json0),
			Labels: pulumi.StringMap{
				"env":  pulumi.String("test"),
				"team": pulumi.String("evaluation"),
			},
			EncryptionSpec: &vertex.AiEvaluationMetricEncryptionSpecArgs{
				KmsKeyName: pulumi.String("kms-key"),
			},
			GcsUri: pulumi.String("gs://eval-metric-test-bucket/metric-spec.json"),
		})
		if err != nil {
			return err
		}
		_, err = storage.NewBucket(ctx, "metric_bucket", &storage.BucketArgs{
			Name:                     pulumi.String("eval-metric-test-bucket"),
			Location:                 pulumi.String("us-central1"),
			UniformBucketLevelAccess: pulumi.Bool(true),
			ForceDestroy:             pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var example = new Gcp.Vertex.AiEvaluationMetric("example", new()
    {
        EvaluationMetricId = "example-metric-full",
        Region = "us-central1",
        DisplayName = "Full Test Evaluation Metric",
        Description = "An evaluation metric with all fields for Terraform acceptance testing",
        Metric = JsonSerializer.Serialize(new Dictionary<string, object?>
        {
            ["llmBasedMetricSpec"] = new Dictionary<string, object?>
            {
                ["metricPromptTemplate"] = "Rate the quality of the following response on a scale of 1 to 5. Response: {response}",
            },
        }),
        Labels = 
        {
            { "env", "test" },
            { "team", "evaluation" },
        },
        EncryptionSpec = new Gcp.Vertex.Inputs.AiEvaluationMetricEncryptionSpecArgs
        {
            KmsKeyName = "kms-key",
        },
        GcsUri = "gs://eval-metric-test-bucket/metric-spec.json",
    });

    var metricBucket = new Gcp.Storage.Bucket("metric_bucket", new()
    {
        Name = "eval-metric-test-bucket",
        Location = "us-central1",
        UniformBucketLevelAccess = true,
        ForceDestroy = true,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.vertex.AiEvaluationMetric;
import com.pulumi.gcp.vertex.AiEvaluationMetricArgs;
import com.pulumi.gcp.vertex.inputs.AiEvaluationMetricEncryptionSpecArgs;
import com.pulumi.gcp.storage.Bucket;
import com.pulumi.gcp.storage.BucketArgs;
import static com.pulumi.codegen.internal.Serialization.*;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new AiEvaluationMetric("example", AiEvaluationMetricArgs.builder()
            .evaluationMetricId("example-metric-full")
            .region("us-central1")
            .displayName("Full Test Evaluation Metric")
            .description("An evaluation metric with all fields for Terraform acceptance testing")
            .metric(serializeJson(
                jsonObject(
                    jsonProperty("llmBasedMetricSpec", jsonObject(
                        jsonProperty("metricPromptTemplate", "Rate the quality of the following response on a scale of 1 to 5. Response: {response}")
                    ))
                )))
            .labels(Map.ofEntries(
                Map.entry("env", "test"),
                Map.entry("team", "evaluation")
            ))
            .encryptionSpec(AiEvaluationMetricEncryptionSpecArgs.builder()
                .kmsKeyName("kms-key")
                .build())
            .gcsUri("gs://eval-metric-test-bucket/metric-spec.json")
            .build());

        var metricBucket = new Bucket("metricBucket", BucketArgs.builder()
            .name("eval-metric-test-bucket")
            .location("us-central1")
            .uniformBucketLevelAccess(true)
            .forceDestroy(true)
            .build());

    }
}

    resources:
  example:
    type: gcp:vertex:AiEvaluationMetric
    properties:
      evaluationMetricId: example-metric-full
      region: us-central1
      displayName: Full Test Evaluation Metric
      description: An evaluation metric with all fields for Terraform acceptance testing
      metric:
        fn::toJSON:
          llmBasedMetricSpec:
            metricPromptTemplate: 'Rate the quality of the following response on a scale of 1 to 5. Response: {response}'
      labels:
        env: test
        team: evaluation
      encryptionSpec:
        kmsKeyName: kms-key
      gcsUri: gs://eval-metric-test-bucket/metric-spec.json
  metricBucket:
    type: gcp:storage:Bucket
    name: metric_bucket
    properties:
      name: eval-metric-test-bucket
      location: us-central1
      uniformBucketLevelAccess: true
      forceDestroy: true

    pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_vertex_aievaluationmetric" "example" {
  evaluation_metric_id = "example-metric-full"
  region               = "us-central1"
  display_name         = "Full Test Evaluation Metric"
  description          = "An evaluation metric with all fields for Terraform acceptance testing"
  metric = jsonencode({
    "llmBasedMetricSpec" = {
      "metricPromptTemplate" = "Rate the quality of the following response on a scale of 1 to 5. Response: {response}"
    }
  })
  labels = {
    "env"  = "test"
    "team" = "evaluation"
  }
  encryption_spec = {
    kms_key_name = "kms-key"
  }
  gcs_uri = "gs://eval-metric-test-bucket/metric-spec.json"
}
resource "gcp_storage_bucket" "metric_bucket" {
  name                        = "eval-metric-test-bucket"
  location                    = "us-central1"
  uniform_bucket_level_access = true
  force_destroy               = true
}

    Create AiEvaluationMetric Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new AiEvaluationMetric(name: string, args: AiEvaluationMetricArgs, opts?: CustomResourceOptions);
    @overload
def AiEvaluationMetric(resource_name: str,
                       args: AiEvaluationMetricArgs,
                       opts: Optional[ResourceOptions] = None)

@overload
def AiEvaluationMetric(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       display_name: Optional[str] = None,
                       region: Optional[str] = None,
                       deletion_policy: Optional[str] = None,
                       description: Optional[str] = None,
                       encryption_spec: Optional[AiEvaluationMetricEncryptionSpecArgs] = None,
                       evaluation_metric_id: Optional[str] = None,
                       gcs_uri: Optional[str] = None,
                       labels: Optional[Mapping[str, str]] = None,
                       metric: Optional[str] = None,
                       project: Optional[str] = None)
    func NewAiEvaluationMetric(ctx *Context, name string, args AiEvaluationMetricArgs, opts ...ResourceOption) (*AiEvaluationMetric, error)
    public AiEvaluationMetric(string name, AiEvaluationMetricArgs args, CustomResourceOptions? opts = null)
    public AiEvaluationMetric(String name, AiEvaluationMetricArgs args)
public AiEvaluationMetric(String name, AiEvaluationMetricArgs args, CustomResourceOptions options)

    type: gcp:vertex:AiEvaluationMetric
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "gcp_vertex_ai_evaluation_metric" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args AiEvaluationMetricArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args AiEvaluationMetricArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args AiEvaluationMetricArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AiEvaluationMetricArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AiEvaluationMetricArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var aiEvaluationMetricResource = new Gcp.Vertex.AiEvaluationMetric("aiEvaluationMetricResource", new()
{
    DisplayName = "string",
    Region = "string",
    DeletionPolicy = "string",
    Description = "string",
    EncryptionSpec = new Gcp.Vertex.Inputs.AiEvaluationMetricEncryptionSpecArgs
    {
        KmsKeyName = "string",
    },
    EvaluationMetricId = "string",
    GcsUri = "string",
    Labels = 
    {
        { "string", "string" },
    },
    Metric = "string",
    Project = "string",
});

    example, err := vertex.NewAiEvaluationMetric(ctx, "aiEvaluationMetricResource", &vertex.AiEvaluationMetricArgs{
	DisplayName:    pulumi.String("string"),
	Region:         pulumi.String("string"),
	DeletionPolicy: pulumi.String("string"),
	Description:    pulumi.String("string"),
	EncryptionSpec: &vertex.AiEvaluationMetricEncryptionSpecArgs{
		KmsKeyName: pulumi.String("string"),
	},
	EvaluationMetricId: pulumi.String("string"),
	GcsUri:             pulumi.String("string"),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Metric:  pulumi.String("string"),
	Project: pulumi.String("string"),
})

    resource "gcp_vertex_ai_evaluation_metric" "aiEvaluationMetricResource" {
  lifecycle {
    create_before_destroy = true
  }
  display_name    = "string"
  region          = "string"
  deletion_policy = "string"
  description     = "string"
  encryption_spec = {
    kms_key_name = "string"
  }
  evaluation_metric_id = "string"
  gcs_uri              = "string"
  labels = {
    "string" = "string"
  }
  metric  = "string"
  project = "string"
}

    var aiEvaluationMetricResource = new AiEvaluationMetric("aiEvaluationMetricResource", AiEvaluationMetricArgs.builder()
    .displayName("string")
    .region("string")
    .deletionPolicy("string")
    .description("string")
    .encryptionSpec(AiEvaluationMetricEncryptionSpecArgs.builder()
        .kmsKeyName("string")
        .build())
    .evaluationMetricId("string")
    .gcsUri("string")
    .labels(Map.of("string", "string"))
    .metric("string")
    .project("string")
    .build());

    ai_evaluation_metric_resource = gcp.vertex.AiEvaluationMetric("aiEvaluationMetricResource",
    display_name="string",
    region="string",
    deletion_policy="string",
    description="string",
    encryption_spec={
        "kms_key_name": "string",
    },
    evaluation_metric_id="string",
    gcs_uri="string",
    labels={
        "string": "string",
    },
    metric="string",
    project="string")

    const aiEvaluationMetricResource = new gcp.vertex.AiEvaluationMetric("aiEvaluationMetricResource", {
    displayName: "string",
    region: "string",
    deletionPolicy: "string",
    description: "string",
    encryptionSpec: {
        kmsKeyName: "string",
    },
    evaluationMetricId: "string",
    gcsUri: "string",
    labels: {
        string: "string",
    },
    metric: "string",
    project: "string",
});

    type: gcp:vertex:AiEvaluationMetric
properties:
    deletionPolicy: string
    description: string
    displayName: string
    encryptionSpec:
        kmsKeyName: string
    evaluationMetricId: string
    gcsUri: string
    labels:
        string: string
    metric: string
    project: string
    region: string

    AiEvaluationMetric Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The AiEvaluationMetric resource accepts the following input properties:

    DisplayName string
    The user-friendly display name for the EvaluationMetric.
    Region string
    The region of the EvaluationMetric. eg us-central1
    DeletionPolicy string
    Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
    Description string
    A description of the EvaluationMetric.
    EncryptionSpec AiEvaluationMetricEncryptionSpec
    Customer-managed encryption key spec for this EvaluationMetric. If set, this EvaluationMetric will be secured by this key. Structure is documented below.
    EvaluationMetricId string
    The ID to use for the EvaluationMetric, which will become the final component of the resource name. This value should be 1-63 characters, and valid characters are /[a-z][0-9]-/. The first character must be a lowercase letter, and the last character must be a lowercase letter or number. If not provided, the server will generate a unique ID.
    GcsUri string
    The Google Cloud Storage URI that stores the metric specification.
    Labels Dictionary<string, string>

    Labels for the EvaluationMetric.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effectiveLabels for all of the labels present on the resource.

    Metric string
    The metric configuration as a JSON string. Uses camelCase field names to match the API format. Supports LLM-based metrics and custom code execution metrics. See the API documentation for the full schema.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    DisplayName string
    The user-friendly display name for the EvaluationMetric.
    Region string
    The region of the EvaluationMetric. eg us-central1
    DeletionPolicy string
    Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
    Description string
    A description of the EvaluationMetric.
    EncryptionSpec AiEvaluationMetricEncryptionSpecArgs
    Customer-managed encryption key spec for this EvaluationMetric. If set, this EvaluationMetric will be secured by this key. Structure is documented below.
    EvaluationMetricId string
    The ID to use for the EvaluationMetric, which will become the final component of the resource name. This value should be 1-63 characters, and valid characters are /[a-z][0-9]-/. The first character must be a lowercase letter, and the last character must be a lowercase letter or number. If not provided, the server will generate a unique ID.
    GcsUri string
    The Google Cloud Storage URI that stores the metric specification.
    Labels map[string]string

    Labels for the EvaluationMetric.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effectiveLabels for all of the labels present on the resource.

    Metric string
    The metric configuration as a JSON string. Uses camelCase field names to match the API format. Supports LLM-based metrics and custom code execution metrics. See the API documentation for the full schema.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    display_name string
    The user-friendly display name for the EvaluationMetric.
    region string
    The region of the EvaluationMetric. eg us-central1
    deletion_policy string
    Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
    description string
    A description of the EvaluationMetric.
    encryption_spec object
    Customer-managed encryption key spec for this EvaluationMetric. If set, this EvaluationMetric will be secured by this key. Structure is documented below.
    evaluation_metric_id string
    The ID to use for the EvaluationMetric, which will become the final component of the resource name. This value should be 1-63 characters, and valid characters are /[a-z][0-9]-/. The first character must be a lowercase letter, and the last character must be a lowercase letter or number. If not provided, the server will generate a unique ID.
    gcs_uri string
    The Google Cloud Storage URI that stores the metric specification.
    labels map(string)

    Labels for the EvaluationMetric.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effectiveLabels for all of the labels present on the resource.

    metric string
    The metric configuration as a JSON string. Uses camelCase field names to match the API format. Supports LLM-based metrics and custom code execution metrics. See the API documentation for the full schema.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    displayName String
    The user-friendly display name for the EvaluationMetric.
    region String
    The region of the EvaluationMetric. eg us-central1
    deletionPolicy String
    Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
    description String
    A description of the EvaluationMetric.
    encryptionSpec AiEvaluationMetricEncryptionSpec
    Customer-managed encryption key spec for this EvaluationMetric. If set, this EvaluationMetric will be secured by this key. Structure is documented below.
    evaluationMetricId String
    The ID to use for the EvaluationMetric, which will become the final component of the resource name. This value should be 1-63 characters, and valid characters are /[a-z][0-9]-/. The first character must be a lowercase letter, and the last character must be a lowercase letter or number. If not provided, the server will generate a unique ID.
    gcsUri String
    The Google Cloud Storage URI that stores the metric specification.
    labels Map<String,String>

    Labels for the EvaluationMetric.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effectiveLabels for all of the labels present on the resource.

    metric String
    The metric configuration as a JSON string. Uses camelCase field names to match the API format. Supports LLM-based metrics and custom code execution metrics. See the API documentation for the full schema.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    displayName string
    The user-friendly display name for the EvaluationMetric.
    region string
    The region of the EvaluationMetric. eg us-central1
    deletionPolicy string
    Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
    description string
    A description of the EvaluationMetric.
    encryptionSpec AiEvaluationMetricEncryptionSpec
    Customer-managed encryption key spec for this EvaluationMetric. If set, this EvaluationMetric will be secured by this key. Structure is documented below.
    evaluationMetricId string
    The ID to use for the EvaluationMetric, which will become the final component of the resource name. This value should be 1-63 characters, and valid characters are /[a-z][0-9]-/. The first character must be a lowercase letter, and the last character must be a lowercase letter or number. If not provided, the server will generate a unique ID.
    gcsUri string
    The Google Cloud Storage URI that stores the metric specification.
    labels {[key: string]: string}

    Labels for the EvaluationMetric.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effectiveLabels for all of the labels present on the resource.

    metric string
    The metric configuration as a JSON string. Uses camelCase field names to match the API format. Supports LLM-based metrics and custom code execution metrics. See the API documentation for the full schema.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    display_name str
    The user-friendly display name for the EvaluationMetric.
    region str
    The region of the EvaluationMetric. eg us-central1
    deletion_policy str
    Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
    description str
    A description of the EvaluationMetric.
    encryption_spec AiEvaluationMetricEncryptionSpecArgs
    Customer-managed encryption key spec for this EvaluationMetric. If set, this EvaluationMetric will be secured by this key. Structure is documented below.
    evaluation_metric_id str
    The ID to use for the EvaluationMetric, which will become the final component of the resource name. This value should be 1-63 characters, and valid characters are /[a-z][0-9]-/. The first character must be a lowercase letter, and the last character must be a lowercase letter or number. If not provided, the server will generate a unique ID.
    gcs_uri str
    The Google Cloud Storage URI that stores the metric specification.
    labels Mapping[str, str]

    Labels for the EvaluationMetric.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effectiveLabels for all of the labels present on the resource.

    metric str
    The metric configuration as a JSON string. Uses camelCase field names to match the API format. Supports LLM-based metrics and custom code execution metrics. See the API documentation for the full schema.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    displayName String
    The user-friendly display name for the EvaluationMetric.
    region String
    The region of the EvaluationMetric. eg us-central1
    deletionPolicy String
    Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
    description String
    A description of the EvaluationMetric.
    encryptionSpec Property Map
    Customer-managed encryption key spec for this EvaluationMetric. If set, this EvaluationMetric will be secured by this key. Structure is documented below.
    evaluationMetricId String
    The ID to use for the EvaluationMetric, which will become the final component of the resource name. This value should be 1-63 characters, and valid characters are /[a-z][0-9]-/. The first character must be a lowercase letter, and the last character must be a lowercase letter or number. If not provided, the server will generate a unique ID.
    gcsUri String
    The Google Cloud Storage URI that stores the metric specification.
    labels Map<String>

    Labels for the EvaluationMetric.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effectiveLabels for all of the labels present on the resource.

    metric String
    The metric configuration as a JSON string. Uses camelCase field names to match the API format. Supports LLM-based metrics and custom code execution metrics. See the API documentation for the full schema.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the AiEvaluationMetric resource produces the following output properties:

    CreateTime string
    The timestamp of when the EvaluationMetric was created in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    EffectiveLabels Dictionary<string, string>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The short name of the EvaluationMetric (the final component of the resource name).
    PulumiLabels Dictionary<string, string>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    UpdateTime string
    The timestamp of when the EvaluationMetric was last updated in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    CreateTime string
    The timestamp of when the EvaluationMetric was created in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    EffectiveLabels map[string]string
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The short name of the EvaluationMetric (the final component of the resource name).
    PulumiLabels map[string]string
    The combination of labels configured directly on the resource and default labels configured on the provider.
    UpdateTime string
    The timestamp of when the EvaluationMetric was last updated in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    create_time string
    The timestamp of when the EvaluationMetric was created in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    effective_labels map(string)
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The short name of the EvaluationMetric (the final component of the resource name).
    pulumi_labels map(string)
    The combination of labels configured directly on the resource and default labels configured on the provider.
    update_time string
    The timestamp of when the EvaluationMetric was last updated in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    createTime String
    The timestamp of when the EvaluationMetric was created in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    effectiveLabels Map<String,String>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The short name of the EvaluationMetric (the final component of the resource name).
    pulumiLabels Map<String,String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    updateTime String
    The timestamp of when the EvaluationMetric was last updated in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    createTime string
    The timestamp of when the EvaluationMetric was created in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    effectiveLabels {[key: string]: string}
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The short name of the EvaluationMetric (the final component of the resource name).
    pulumiLabels {[key: string]: string}
    The combination of labels configured directly on the resource and default labels configured on the provider.
    updateTime string
    The timestamp of when the EvaluationMetric was last updated in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    create_time str
    The timestamp of when the EvaluationMetric was created in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    effective_labels Mapping[str, str]
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The short name of the EvaluationMetric (the final component of the resource name).
    pulumi_labels Mapping[str, str]
    The combination of labels configured directly on the resource and default labels configured on the provider.
    update_time str
    The timestamp of when the EvaluationMetric was last updated in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    createTime String
    The timestamp of when the EvaluationMetric was created in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    effectiveLabels Map<String>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The short name of the EvaluationMetric (the final component of the resource name).
    pulumiLabels Map<String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    updateTime String
    The timestamp of when the EvaluationMetric was last updated in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.

    Look up Existing AiEvaluationMetric Resource

    Get an existing AiEvaluationMetric resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: AiEvaluationMetricState, opts?: CustomResourceOptions): AiEvaluationMetric
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        create_time: Optional[str] = None,
        deletion_policy: Optional[str] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        effective_labels: Optional[Mapping[str, str]] = None,
        encryption_spec: Optional[AiEvaluationMetricEncryptionSpecArgs] = None,
        evaluation_metric_id: Optional[str] = None,
        gcs_uri: Optional[str] = None,
        labels: Optional[Mapping[str, str]] = None,
        metric: Optional[str] = None,
        name: Optional[str] = None,
        project: Optional[str] = None,
        pulumi_labels: Optional[Mapping[str, str]] = None,
        region: Optional[str] = None,
        update_time: Optional[str] = None) -> AiEvaluationMetric
    func GetAiEvaluationMetric(ctx *Context, name string, id IDInput, state *AiEvaluationMetricState, opts ...ResourceOption) (*AiEvaluationMetric, error)
    public static AiEvaluationMetric Get(string name, Input<string> id, AiEvaluationMetricState? state, CustomResourceOptions? opts = null)
    public static AiEvaluationMetric get(String name, Output<String> id, AiEvaluationMetricState state, CustomResourceOptions options)
    resources:  _:    type: gcp:vertex:AiEvaluationMetric    get:      id: ${id}
    import {
  to = gcp_vertex_ai_evaluation_metric.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CreateTime string
    The timestamp of when the EvaluationMetric was created in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    DeletionPolicy string
    Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
    Description string
    A description of the EvaluationMetric.
    DisplayName string
    The user-friendly display name for the EvaluationMetric.
    EffectiveLabels Dictionary<string, string>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    EncryptionSpec AiEvaluationMetricEncryptionSpec
    Customer-managed encryption key spec for this EvaluationMetric. If set, this EvaluationMetric will be secured by this key. Structure is documented below.
    EvaluationMetricId string
    The ID to use for the EvaluationMetric, which will become the final component of the resource name. This value should be 1-63 characters, and valid characters are /[a-z][0-9]-/. The first character must be a lowercase letter, and the last character must be a lowercase letter or number. If not provided, the server will generate a unique ID.
    GcsUri string
    The Google Cloud Storage URI that stores the metric specification.
    Labels Dictionary<string, string>

    Labels for the EvaluationMetric.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effectiveLabels for all of the labels present on the resource.

    Metric string
    The metric configuration as a JSON string. Uses camelCase field names to match the API format. Supports LLM-based metrics and custom code execution metrics. See the API documentation for the full schema.
    Name string
    The short name of the EvaluationMetric (the final component of the resource name).
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    PulumiLabels Dictionary<string, string>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    Region string
    The region of the EvaluationMetric. eg us-central1
    UpdateTime string
    The timestamp of when the EvaluationMetric was last updated in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    CreateTime string
    The timestamp of when the EvaluationMetric was created in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    DeletionPolicy string
    Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
    Description string
    A description of the EvaluationMetric.
    DisplayName string
    The user-friendly display name for the EvaluationMetric.
    EffectiveLabels map[string]string
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    EncryptionSpec AiEvaluationMetricEncryptionSpecArgs
    Customer-managed encryption key spec for this EvaluationMetric. If set, this EvaluationMetric will be secured by this key. Structure is documented below.
    EvaluationMetricId string
    The ID to use for the EvaluationMetric, which will become the final component of the resource name. This value should be 1-63 characters, and valid characters are /[a-z][0-9]-/. The first character must be a lowercase letter, and the last character must be a lowercase letter or number. If not provided, the server will generate a unique ID.
    GcsUri string
    The Google Cloud Storage URI that stores the metric specification.
    Labels map[string]string

    Labels for the EvaluationMetric.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effectiveLabels for all of the labels present on the resource.

    Metric string
    The metric configuration as a JSON string. Uses camelCase field names to match the API format. Supports LLM-based metrics and custom code execution metrics. See the API documentation for the full schema.
    Name string
    The short name of the EvaluationMetric (the final component of the resource name).
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    PulumiLabels map[string]string
    The combination of labels configured directly on the resource and default labels configured on the provider.
    Region string
    The region of the EvaluationMetric. eg us-central1
    UpdateTime string
    The timestamp of when the EvaluationMetric was last updated in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    create_time string
    The timestamp of when the EvaluationMetric was created in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    deletion_policy string
    Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
    description string
    A description of the EvaluationMetric.
    display_name string
    The user-friendly display name for the EvaluationMetric.
    effective_labels map(string)
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    encryption_spec object
    Customer-managed encryption key spec for this EvaluationMetric. If set, this EvaluationMetric will be secured by this key. Structure is documented below.
    evaluation_metric_id string
    The ID to use for the EvaluationMetric, which will become the final component of the resource name. This value should be 1-63 characters, and valid characters are /[a-z][0-9]-/. The first character must be a lowercase letter, and the last character must be a lowercase letter or number. If not provided, the server will generate a unique ID.
    gcs_uri string
    The Google Cloud Storage URI that stores the metric specification.
    labels map(string)

    Labels for the EvaluationMetric.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effectiveLabels for all of the labels present on the resource.

    metric string
    The metric configuration as a JSON string. Uses camelCase field names to match the API format. Supports LLM-based metrics and custom code execution metrics. See the API documentation for the full schema.
    name string
    The short name of the EvaluationMetric (the final component of the resource name).
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    pulumi_labels map(string)
    The combination of labels configured directly on the resource and default labels configured on the provider.
    region string
    The region of the EvaluationMetric. eg us-central1
    update_time string
    The timestamp of when the EvaluationMetric was last updated in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    createTime String
    The timestamp of when the EvaluationMetric was created in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    deletionPolicy String
    Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
    description String
    A description of the EvaluationMetric.
    displayName String
    The user-friendly display name for the EvaluationMetric.
    effectiveLabels Map<String,String>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    encryptionSpec AiEvaluationMetricEncryptionSpec
    Customer-managed encryption key spec for this EvaluationMetric. If set, this EvaluationMetric will be secured by this key. Structure is documented below.
    evaluationMetricId String
    The ID to use for the EvaluationMetric, which will become the final component of the resource name. This value should be 1-63 characters, and valid characters are /[a-z][0-9]-/. The first character must be a lowercase letter, and the last character must be a lowercase letter or number. If not provided, the server will generate a unique ID.
    gcsUri String
    The Google Cloud Storage URI that stores the metric specification.
    labels Map<String,String>

    Labels for the EvaluationMetric.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effectiveLabels for all of the labels present on the resource.

    metric String
    The metric configuration as a JSON string. Uses camelCase field names to match the API format. Supports LLM-based metrics and custom code execution metrics. See the API documentation for the full schema.
    name String
    The short name of the EvaluationMetric (the final component of the resource name).
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    pulumiLabels Map<String,String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    region String
    The region of the EvaluationMetric. eg us-central1
    updateTime String
    The timestamp of when the EvaluationMetric was last updated in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    createTime string
    The timestamp of when the EvaluationMetric was created in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    deletionPolicy string
    Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
    description string
    A description of the EvaluationMetric.
    displayName string
    The user-friendly display name for the EvaluationMetric.
    effectiveLabels {[key: string]: string}
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    encryptionSpec AiEvaluationMetricEncryptionSpec
    Customer-managed encryption key spec for this EvaluationMetric. If set, this EvaluationMetric will be secured by this key. Structure is documented below.
    evaluationMetricId string
    The ID to use for the EvaluationMetric, which will become the final component of the resource name. This value should be 1-63 characters, and valid characters are /[a-z][0-9]-/. The first character must be a lowercase letter, and the last character must be a lowercase letter or number. If not provided, the server will generate a unique ID.
    gcsUri string
    The Google Cloud Storage URI that stores the metric specification.
    labels {[key: string]: string}

    Labels for the EvaluationMetric.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effectiveLabels for all of the labels present on the resource.

    metric string
    The metric configuration as a JSON string. Uses camelCase field names to match the API format. Supports LLM-based metrics and custom code execution metrics. See the API documentation for the full schema.
    name string
    The short name of the EvaluationMetric (the final component of the resource name).
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    pulumiLabels {[key: string]: string}
    The combination of labels configured directly on the resource and default labels configured on the provider.
    region string
    The region of the EvaluationMetric. eg us-central1
    updateTime string
    The timestamp of when the EvaluationMetric was last updated in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    create_time str
    The timestamp of when the EvaluationMetric was created in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    deletion_policy str
    Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
    description str
    A description of the EvaluationMetric.
    display_name str
    The user-friendly display name for the EvaluationMetric.
    effective_labels Mapping[str, str]
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    encryption_spec AiEvaluationMetricEncryptionSpecArgs
    Customer-managed encryption key spec for this EvaluationMetric. If set, this EvaluationMetric will be secured by this key. Structure is documented below.
    evaluation_metric_id str
    The ID to use for the EvaluationMetric, which will become the final component of the resource name. This value should be 1-63 characters, and valid characters are /[a-z][0-9]-/. The first character must be a lowercase letter, and the last character must be a lowercase letter or number. If not provided, the server will generate a unique ID.
    gcs_uri str
    The Google Cloud Storage URI that stores the metric specification.
    labels Mapping[str, str]

    Labels for the EvaluationMetric.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effectiveLabels for all of the labels present on the resource.

    metric str
    The metric configuration as a JSON string. Uses camelCase field names to match the API format. Supports LLM-based metrics and custom code execution metrics. See the API documentation for the full schema.
    name str
    The short name of the EvaluationMetric (the final component of the resource name).
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    pulumi_labels Mapping[str, str]
    The combination of labels configured directly on the resource and default labels configured on the provider.
    region str
    The region of the EvaluationMetric. eg us-central1
    update_time str
    The timestamp of when the EvaluationMetric was last updated in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    createTime String
    The timestamp of when the EvaluationMetric was created in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    deletionPolicy String
    Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
    description String
    A description of the EvaluationMetric.
    displayName String
    The user-friendly display name for the EvaluationMetric.
    effectiveLabels Map<String>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    encryptionSpec Property Map
    Customer-managed encryption key spec for this EvaluationMetric. If set, this EvaluationMetric will be secured by this key. Structure is documented below.
    evaluationMetricId String
    The ID to use for the EvaluationMetric, which will become the final component of the resource name. This value should be 1-63 characters, and valid characters are /[a-z][0-9]-/. The first character must be a lowercase letter, and the last character must be a lowercase letter or number. If not provided, the server will generate a unique ID.
    gcsUri String
    The Google Cloud Storage URI that stores the metric specification.
    labels Map<String>

    Labels for the EvaluationMetric.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effectiveLabels for all of the labels present on the resource.

    metric String
    The metric configuration as a JSON string. Uses camelCase field names to match the API format. Supports LLM-based metrics and custom code execution metrics. See the API documentation for the full schema.
    name String
    The short name of the EvaluationMetric (the final component of the resource name).
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    pulumiLabels Map<String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    region String
    The region of the EvaluationMetric. eg us-central1
    updateTime String
    The timestamp of when the EvaluationMetric was last updated in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.

    Supporting Types

    AiEvaluationMetricEncryptionSpec, AiEvaluationMetricEncryptionSpecArgs

    KmsKeyName string
    Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the resource is created.
    KmsKeyName string
    Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the resource is created.
    kms_key_name string
    Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the resource is created.
    kmsKeyName String
    Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the resource is created.
    kmsKeyName string
    Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the resource is created.
    kms_key_name str
    Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the resource is created.
    kmsKeyName String
    Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the resource is created.

    Import

    EvaluationMetric can be imported using any of these accepted formats:

    • projects/{{project}}/locations/{{region}}/evaluationMetrics/{{name}}
    • {{project}}/{{region}}/{{name}}
    • {{region}}/{{name}}
    • {{name}}

    When using the pulumi import command, EvaluationMetric can be imported using one of the formats above. For example:

    $ pulumi import gcp:vertex/aiEvaluationMetric:AiEvaluationMetric default projects/{{project}}/locations/{{region}}/evaluationMetrics/{{name}}
$ pulumi import gcp:vertex/aiEvaluationMetric:AiEvaluationMetric default {{project}}/{{region}}/{{name}}
$ pulumi import gcp:vertex/aiEvaluationMetric:AiEvaluationMetric default {{region}}/{{name}}
$ pulumi import gcp:vertex/aiEvaluationMetric:AiEvaluationMetric default {{name}}

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Viewing docs for Google Cloud v9.36.1
    published on Thursday, Sep 3, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-gcp

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial