--- title: "POST /v1/projects/{projectsId}/locations/{locationsId}/evaluationMetrics" method: POST path: "/v1/projects/{projectsId}/locations/{locationsId}/evaluationMetrics" tags: ["projects"] --- # POST /v1/projects/{projectsId}/locations/{locationsId}/evaluationMetrics `POST /v1/projects/{projectsId}/locations/{locationsId}/evaluationMetrics` ## Request - Base URL: `https://aiplatform.googleapis.com` - URL: `https://aiplatform.googleapis.com/v1/projects/{projectsId}/locations/{locationsId}/evaluationMetrics` - Auth: OAuth 2 and OAuth 2 - Implicit: `https://accounts.google.com/o/oauth2/auth` - Scopes: `https://www.googleapis.com/auth/cloud-platform` - Authorization code: `https://accounts.google.com/o/oauth2/auth` - Token URL: `https://accounts.google.com/o/oauth2/token` scopes: `https://www.googleapis.com/auth/cloud-platform` Creates an EvaluationMetric. ## Path parameters - `projectsId` string, required - `locationsId` string, required ## Query parameters - `evaluationMetricId` string ## Request body - GoogleCloudAiplatformV1EvaluationMetric: EvaluationMetric is a resource that represents a reusable metric configuration. - `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` GoogleCloudAiplatformV1EncryptionSpec: Represents a customer-managed encryption key specification that can be applied to a Vertex AI resource. - `kmsKeyName` string: Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. - `gcsUri` string: Optional. The Google Cloud Storage URI that stores the metric specification.. - `labels` object: Optional. Labels for the evaluation metric. - `metric` GoogleCloudAiplatformV1Metric: The metric used for running evaluations. - `aggregationMetrics` string[]: Optional. The aggregation metrics to use. - `bleuSpec` GoogleCloudAiplatformV1BleuSpec: Spec for bleu score metric - calculates the precision of n-grams in the prediction as compared to reference - returns a score ranging between 0 to 1. - `useEffectiveOrder` boolean: Optional. Whether to use_effective_order to compute bleu score. - `computationBasedMetricSpec` GoogleCloudAiplatformV1ComputationBasedMetricSpec: Specification for a computation based metric. - `parameters` object: Optional. A map of parameters for the metric, e.g. {"rouge_type": "rougeL"}. - `type` 'COMPUTATION_BASED_METRIC_TYPE_UNSPECIFIED' | 'EXACT_MATCH' | 'BLEU' | 'ROUGE': Required. The type of the computation based metric. - `customCodeExecutionSpec` GoogleCloudAiplatformV1CustomCodeExecutionSpec: Specificies a metric that is populated by evaluating user-defined Python code. - `evaluationFunction` string: Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -> float: Please include this function signature in the code snippet. Instance is the evaluation instance, any fields populated in the instance are available to the function as instance[field_name]. Example: Example input: ``` instance= EvaluationInstance( response=EvaluationInstance.InstanceData(text="The answer is 4."), reference=EvaluationInstance.InstanceData(text="4") ) ``` Example converted input: ``` { 'response': {'text': 'The answer is 4.'}, 'reference': {'text': '4'} } ``` Example python function: ``` def evaluate(instance: dict[str, Any]) -> float: if instance'response' == instance'reference': return 1.0 return 0.0 ``` CustomCodeExecutionSpec is also supported in Batch Evaluation (EvalDataset RPC) and Tuning Evaluation. Each line in the input jsonl file will be converted to dict[str, Any] and passed to the evaluation function. - `exactMatchSpec` GoogleCloudAiplatformV1ExactMatchSpec: Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. - `llmBasedMetricSpec` GoogleCloudAiplatformV1LLMBasedMetricSpec: Specification for an LLM based metric. - `additionalConfig` object: Optional. Optional additional configuration for the metric. - `judgeAutoraterConfig` GoogleCloudAiplatformV1AutoraterConfig: The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. - `autoraterModel` string: Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` - `flipEnabled` boolean: Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. - `generationConfig` GoogleCloudAiplatformV1GenerationConfig: Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. - `audioTimestamp` boolean: Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. - `audioTranscriptionConfig` GoogleCloudAiplatformV1AudioTranscriptionConfig: Configuration for speech recognition (transcription). - `adaptationPhrases` string[]: Optional. Deprecated: Use `custom_vocabulary` instead. A list of phrases to bias the speech recognition model towards. - `customVocabulary` string[]: Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. - `diarization` boolean: Optional. Configures speaker diarization. - `languageAuto` GoogleCloudAiplatformV1AudioTranscriptionConfigLanguageAuto: Deprecated: Use top-level `language_codes` instead. Indicates the language of the audio should be automatically detected. - `languageCodes` string[]: Optional. BCP-47 language codes providing hints about the languages present in the audio. If omitted or empty, defaults to automatic language detection. - `languageHints` GoogleCloudAiplatformV1AudioTranscriptionConfigLanguageHints: Deprecated: Use top-level `language_codes` instead. Provides hints to the model about possible languages present in the audio. - … - `mode` 'MODE_UNSPECIFIED' | 'VERBATIM' | 'SMART': Optional. Configures transcription mode. Supported values: `VERBATIM`, `SMART`. If unspecified, defaults to `VERBATIM` transcription. In `SMART` mode, the model performs disfluency removal (eliminating filler words, repetitions, and false starts), light grammatical cleanup, automatic formatting (paragraphs, bullet points, numbered lists), and minor user edits (inline self-corrections). Timestamps and diarization are incompatible with mode `SMART`. - `sourceText` string: Optional. The source text to be edited or rewritten via voice instructions. When provided in `SMART` mode, the model evaluates the audio input against this text and emits the complete replacement text in the candidate response rather than appending to it. - `wordTimestamp` boolean: Optional. Configures word-level timestamp generation. - `candidateCount` integer: Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. - `enableAffectiveDialog` boolean: Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. - `frequencyPenalty` number, float: Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. - `imageConfig` GoogleCloudAiplatformV1ImageConfig: Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. - `aspectRatio` string: Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" - `imageOutputOptions` GoogleCloudAiplatformV1ImageConfigImageOutputOptions: The image output format for generated images. - … - `imageSize` string: Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. - `personGeneration` 'PERSON_GENERATION_UNSPECIFIED' | 'ALLOW_ALL' | 'ALLOW_ADULT' | 'ALLOW_NONE': Optional. Controls whether the model can generate people. - `prominentPeople` 'PROMINENT_PEOPLE_UNSPECIFIED' | 'ALLOW_PROMINENT_PEOPLE' | 'BLOCK_PROMINENT_PEOPLE': Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. - `logprobs` integer: Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. - `maxOutputTokens` integer: Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. - `mediaResolution` 'MEDIA_RESOLUTION_UNSPECIFIED' | 'MEDIA_RESOLUTION_LOW' | 'MEDIA_RESOLUTION_MEDIUM' | 'MEDIA_RESOLUTION_HIGH': Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. - `presencePenalty` number, float: Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. - `responseFormat` GoogleCloudAiplatformV1ResponseFormat[]: Optional. New response format field for the model to configure output formatting and delivery. - `audio` GoogleCloudAiplatformV1AudioResponseFormat: Configuration for audio-specific output formatting. - … - `image` GoogleCloudAiplatformV1ImageResponseFormat: Configuration for image-specific output formatting. - … - `text` GoogleCloudAiplatformV1TextResponseFormat: Configuration for text-specific output formatting. - … - `video` GoogleCloudAiplatformV1VideoResponseFormat: Configuration for video-specific output formatting. - … - `responseJsonSchema` unknown - `responseLogprobs` boolean: Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. - `responseMimeType` string: Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. Deprecated: Use `response_format` instead. - `responseModalities` string[]: Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. - `responseSchema` GoogleCloudAiplatformV1Schema: Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). - `additionalProperties` unknown - `anyOf` GoogleCloudAiplatformV1Schema[]: Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. - `default` unknown - `defs` object: Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. - `description` string: Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. - `enum` string[]: Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` - `example` unknown - `format` string: Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. - `items` GoogleCloudAiplatformV1Schema (recursive) - `maxItems` string, int64: Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. - `maxLength` string, int64: Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. - `maxProperties` string, int64: Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. - `maximum` number, double: Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. - `minItems` string, int64: Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. - `minLength` string, int64: Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. - `minProperties` string, int64: Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. - `minimum` number, double: Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. - `nullable` boolean: Optional. Indicates if the value of this field can be null. - `pattern` string: Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. - `properties` object: Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. - `propertyOrdering` string[]: Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. - `ref` string: Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring - `required` string[]: Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. - `title` string: Optional. Title for the schema. - `type` 'TYPE_UNSPECIFIED' | 'STRING' | 'NUMBER' | 'INTEGER' | 'BOOLEAN' | 'ARRAY' | 'OBJECT' | 'NULL': Optional. Data type of the schema field. - `routingConfig` GoogleCloudAiplatformV1GenerationConfigRoutingConfig: The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. - `autoMode` GoogleCloudAiplatformV1GenerationConfigRoutingConfigAutoRoutingMode: The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. - … - `manualMode` GoogleCloudAiplatformV1GenerationConfigRoutingConfigManualRoutingMode: The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. - … - `seed` integer: Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. - `speechConfig` GoogleCloudAiplatformV1SpeechConfig: Configuration for speech generation. - `languageCode` string: Optional. The language code (ISO 639-1) for the speech synthesis. - `multiSpeakerVoiceConfig` GoogleCloudAiplatformV1MultiSpeakerVoiceConfig: Configuration for a multi-speaker text-to-speech request. - … - `voiceConfig` GoogleCloudAiplatformV1VoiceConfig: Configuration for a voice. - … - `stopSequences` string[]: Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. - `temperature` number, float: Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. - `thinkingConfig` GoogleCloudAiplatformV1GenerationConfigThinkingConfig: Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. - `includeThoughts` boolean: Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. - `thinkingBudget` integer: Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. - `thinkingLevel` 'THINKING_LEVEL_UNSPECIFIED' | 'LOW' | 'MEDIUM' | 'HIGH' | 'MINIMAL': Optional. The number of thoughts tokens that the model should generate. - `topK` number, float: Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. - `topP` number, float: Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. - `translationConfig` GoogleCloudAiplatformV1TranslationConfig: Config for translation features. - `echoTargetLanguage` boolean: Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. - `targetLanguageCode` string: Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). - `samplingCount` integer: Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. - `metricPromptTemplate` string: Required. Template for the prompt sent to the judge model. - `predefinedRubricGenerationSpec` GoogleCloudAiplatformV1PredefinedMetricSpec: The spec for a pre-defined metric. - `metricSpecName` string: Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". - `metricSpecParameters` object: Optional. The parameters needed to run the pre-defined metric. - `resultParserConfig` GoogleCloudAiplatformV1EvaluationParserConfig: Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. - `customCodeParserConfig` GoogleCloudAiplatformV1EvaluationParserConfigCustomCodeParserConfig: Configuration for parsing the LLM response using custom code. - `parsingFunction` string: Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation - `rubricGenerationSpec` GoogleCloudAiplatformV1RubricGenerationSpec: Specification for how rubrics should be generated. - `modelConfig` GoogleCloudAiplatformV1AutoraterConfig: The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. - `autoraterModel` string: Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` - `flipEnabled` boolean: Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. - `generationConfig` GoogleCloudAiplatformV1GenerationConfig: Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. - `audioTimestamp` boolean: Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. - `audioTranscriptionConfig` GoogleCloudAiplatformV1AudioTranscriptionConfig: Configuration for speech recognition (transcription). - … - `candidateCount` integer: Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. - `enableAffectiveDialog` boolean: Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. - `frequencyPenalty` number, float: Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. - `imageConfig` GoogleCloudAiplatformV1ImageConfig: Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. - … - `logprobs` integer: Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. - `maxOutputTokens` integer: Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. - `mediaResolution` 'MEDIA_RESOLUTION_UNSPECIFIED' | 'MEDIA_RESOLUTION_LOW' | 'MEDIA_RESOLUTION_MEDIUM' | 'MEDIA_RESOLUTION_HIGH': Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. - `presencePenalty` number, float: Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. - `responseFormat` GoogleCloudAiplatformV1ResponseFormat[]: Optional. New response format field for the model to configure output formatting and delivery. - … - `responseJsonSchema` unknown - `responseLogprobs` boolean: Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. - `responseMimeType` string: Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. Deprecated: Use `response_format` instead. - `responseModalities` string[]: Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. - `responseSchema` GoogleCloudAiplatformV1Schema: Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). - … - `routingConfig` GoogleCloudAiplatformV1GenerationConfigRoutingConfig: The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. - … - `seed` integer: Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. - `speechConfig` GoogleCloudAiplatformV1SpeechConfig: Configuration for speech generation. - … - `stopSequences` string[]: Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. - `temperature` number, float: Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. - `thinkingConfig` GoogleCloudAiplatformV1GenerationConfigThinkingConfig: Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. - … - `topK` number, float: Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. - `topP` number, float: Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. - `translationConfig` GoogleCloudAiplatformV1TranslationConfig: Config for translation features. - … - `samplingCount` integer: Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. - `promptTemplate` string: Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements. - `rubricContentType` 'RUBRIC_CONTENT_TYPE_UNSPECIFIED' | 'PROPERTY' | 'NL_QUESTION_ANSWER' | 'PYTHON_CODE_ASSERTION': The type of rubric content to be generated. - `rubricTypeOntology` string[]: Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology. - `rubricGroupKey` string: Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance. - `systemInstruction` string: Optional. System instructions for the judge model. - `metadata` GoogleCloudAiplatformV1MetricMetadata: Metadata about the metric, used for visualization and organization. - `otherMetadata` object: Optional. Flexible metadata for user-defined attributes. - `scoreRange` GoogleCloudAiplatformV1MetricMetadataScoreRange: The range of possible scores for this metric, used for plotting. - `description` string: Optional. The description of the score explaining the directionality etc. - `max` number, double: Required. The maximum value of the score range (inclusive). - `min` number, double: Required. The minimum value of the score range (inclusive). - `step` number, double: Optional. The distance between discrete steps in the range. If unset, the range is assumed to be continuous. - `title` string: Optional. The user-friendly name for the metric. If not set for a registered metric, it will default to the metric's display name. - `pairwiseMetricSpec` GoogleCloudAiplatformV1PairwiseMetricSpec: Spec for pairwise metric. - `baselineResponseFieldName` string: Optional. The field name of the baseline response. - `candidateResponseFieldName` string: Optional. The field name of the candidate response. - `customOutputFormatConfig` GoogleCloudAiplatformV1CustomOutputFormatConfig: Spec for custom output format configuration. - `returnRawOutput` boolean: Optional. Whether to return raw output. - `metricPromptTemplate` string: Required. Metric prompt template for pairwise metric. - `systemInstruction` string: Optional. System instructions for pairwise metric. - `pointwiseMetricSpec` GoogleCloudAiplatformV1PointwiseMetricSpec: Spec for pointwise metric. - `customOutputFormatConfig` GoogleCloudAiplatformV1CustomOutputFormatConfig: Spec for custom output format configuration. - `returnRawOutput` boolean: Optional. Whether to return raw output. - `metricPromptTemplate` string: Required. Metric prompt template for pointwise metric. - `systemInstruction` string: Optional. System instructions for pointwise metric. - `predefinedMetricSpec` GoogleCloudAiplatformV1PredefinedMetricSpec: The spec for a pre-defined metric. - `metricSpecName` string: Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". - `metricSpecParameters` object: Optional. The parameters needed to run the pre-defined metric. - `rougeSpec` GoogleCloudAiplatformV1RougeSpec: Spec for rouge score metric - calculates the recall of n-grams in prediction as compared to reference - returns a score ranging between 0 and 1. - `rougeType` string: Optional. Supported rouge types are rougen[1-9], rougeL, and rougeLsum. - `splitSummaries` boolean: Optional. Whether to split summaries while using rougeLsum. - `useStemmer` boolean: Optional. Whether to use stemmer to compute rouge score. - `name` string: Identifier. The resource name of the EvaluationMetric. Format: `projects/{project}/locations/{location}/evaluationMetrics/{evaluation_metric}` - `updateTime` string, google-datetime: Output only. The time when the EvaluationMetric was last updated. ## Response `200` Successful response - GoogleCloudAiplatformV1EvaluationMetric: EvaluationMetric is a resource that represents a reusable metric configuration. - `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` GoogleCloudAiplatformV1EncryptionSpec: Represents a customer-managed encryption key specification that can be applied to a Vertex AI resource. - `kmsKeyName` string: Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. - `gcsUri` string: Optional. The Google Cloud Storage URI that stores the metric specification.. - `labels` object: Optional. Labels for the evaluation metric. - `metric` GoogleCloudAiplatformV1Metric: The metric used for running evaluations. - `aggregationMetrics` string[]: Optional. The aggregation metrics to use. - `bleuSpec` GoogleCloudAiplatformV1BleuSpec: Spec for bleu score metric - calculates the precision of n-grams in the prediction as compared to reference - returns a score ranging between 0 to 1. - `useEffectiveOrder` boolean: Optional. Whether to use_effective_order to compute bleu score. - `computationBasedMetricSpec` GoogleCloudAiplatformV1ComputationBasedMetricSpec: Specification for a computation based metric. - `parameters` object: Optional. A map of parameters for the metric, e.g. {"rouge_type": "rougeL"}. - `type` 'COMPUTATION_BASED_METRIC_TYPE_UNSPECIFIED' | 'EXACT_MATCH' | 'BLEU' | 'ROUGE': Required. The type of the computation based metric. - `customCodeExecutionSpec` GoogleCloudAiplatformV1CustomCodeExecutionSpec: Specificies a metric that is populated by evaluating user-defined Python code. - `evaluationFunction` string: Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -> float: Please include this function signature in the code snippet. Instance is the evaluation instance, any fields populated in the instance are available to the function as instance[field_name]. Example: Example input: ``` instance= EvaluationInstance( response=EvaluationInstance.InstanceData(text="The answer is 4."), reference=EvaluationInstance.InstanceData(text="4") ) ``` Example converted input: ``` { 'response': {'text': 'The answer is 4.'}, 'reference': {'text': '4'} } ``` Example python function: ``` def evaluate(instance: dict[str, Any]) -> float: if instance'response' == instance'reference': return 1.0 return 0.0 ``` CustomCodeExecutionSpec is also supported in Batch Evaluation (EvalDataset RPC) and Tuning Evaluation. Each line in the input jsonl file will be converted to dict[str, Any] and passed to the evaluation function. - `exactMatchSpec` GoogleCloudAiplatformV1ExactMatchSpec: Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. - `llmBasedMetricSpec` GoogleCloudAiplatformV1LLMBasedMetricSpec: Specification for an LLM based metric. - `additionalConfig` object: Optional. Optional additional configuration for the metric. - `judgeAutoraterConfig` GoogleCloudAiplatformV1AutoraterConfig: The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. - `autoraterModel` string: Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` - `flipEnabled` boolean: Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. - `generationConfig` GoogleCloudAiplatformV1GenerationConfig: Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. - `audioTimestamp` boolean: Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. - `audioTranscriptionConfig` GoogleCloudAiplatformV1AudioTranscriptionConfig: Configuration for speech recognition (transcription). - `adaptationPhrases` string[]: Optional. Deprecated: Use `custom_vocabulary` instead. A list of phrases to bias the speech recognition model towards. - `customVocabulary` string[]: Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. - `diarization` boolean: Optional. Configures speaker diarization. - `languageAuto` GoogleCloudAiplatformV1AudioTranscriptionConfigLanguageAuto: Deprecated: Use top-level `language_codes` instead. Indicates the language of the audio should be automatically detected. - `languageCodes` string[]: Optional. BCP-47 language codes providing hints about the languages present in the audio. If omitted or empty, defaults to automatic language detection. - `languageHints` GoogleCloudAiplatformV1AudioTranscriptionConfigLanguageHints: Deprecated: Use top-level `language_codes` instead. Provides hints to the model about possible languages present in the audio. - … - `mode` 'MODE_UNSPECIFIED' | 'VERBATIM' | 'SMART': Optional. Configures transcription mode. Supported values: `VERBATIM`, `SMART`. If unspecified, defaults to `VERBATIM` transcription. In `SMART` mode, the model performs disfluency removal (eliminating filler words, repetitions, and false starts), light grammatical cleanup, automatic formatting (paragraphs, bullet points, numbered lists), and minor user edits (inline self-corrections). Timestamps and diarization are incompatible with mode `SMART`. - `sourceText` string: Optional. The source text to be edited or rewritten via voice instructions. When provided in `SMART` mode, the model evaluates the audio input against this text and emits the complete replacement text in the candidate response rather than appending to it. - `wordTimestamp` boolean: Optional. Configures word-level timestamp generation. - `candidateCount` integer: Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. - `enableAffectiveDialog` boolean: Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. - `frequencyPenalty` number, float: Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. - `imageConfig` GoogleCloudAiplatformV1ImageConfig: Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. - `aspectRatio` string: Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" - `imageOutputOptions` GoogleCloudAiplatformV1ImageConfigImageOutputOptions: The image output format for generated images. - … - `imageSize` string: Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. - `personGeneration` 'PERSON_GENERATION_UNSPECIFIED' | 'ALLOW_ALL' | 'ALLOW_ADULT' | 'ALLOW_NONE': Optional. Controls whether the model can generate people. - `prominentPeople` 'PROMINENT_PEOPLE_UNSPECIFIED' | 'ALLOW_PROMINENT_PEOPLE' | 'BLOCK_PROMINENT_PEOPLE': Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. - `logprobs` integer: Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. - `maxOutputTokens` integer: Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. - `mediaResolution` 'MEDIA_RESOLUTION_UNSPECIFIED' | 'MEDIA_RESOLUTION_LOW' | 'MEDIA_RESOLUTION_MEDIUM' | 'MEDIA_RESOLUTION_HIGH': Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. - `presencePenalty` number, float: Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. - `responseFormat` GoogleCloudAiplatformV1ResponseFormat[]: Optional. New response format field for the model to configure output formatting and delivery. - `audio` GoogleCloudAiplatformV1AudioResponseFormat: Configuration for audio-specific output formatting. - … - `image` GoogleCloudAiplatformV1ImageResponseFormat: Configuration for image-specific output formatting. - … - `text` GoogleCloudAiplatformV1TextResponseFormat: Configuration for text-specific output formatting. - … - `video` GoogleCloudAiplatformV1VideoResponseFormat: Configuration for video-specific output formatting. - … - `responseJsonSchema` unknown - `responseLogprobs` boolean: Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. - `responseMimeType` string: Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. Deprecated: Use `response_format` instead. - `responseModalities` string[]: Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. - `responseSchema` GoogleCloudAiplatformV1Schema: Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). - `additionalProperties` unknown - `anyOf` GoogleCloudAiplatformV1Schema[]: Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. - `default` unknown - `defs` object: Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. - `description` string: Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. - `enum` string[]: Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` - `example` unknown - `format` string: Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. - `items` GoogleCloudAiplatformV1Schema (recursive) - `maxItems` string, int64: Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. - `maxLength` string, int64: Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. - `maxProperties` string, int64: Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. - `maximum` number, double: Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. - `minItems` string, int64: Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. - `minLength` string, int64: Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. - `minProperties` string, int64: Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. - `minimum` number, double: Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. - `nullable` boolean: Optional. Indicates if the value of this field can be null. - `pattern` string: Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. - `properties` object: Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. - `propertyOrdering` string[]: Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. - `ref` string: Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring - `required` string[]: Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. - `title` string: Optional. Title for the schema. - `type` 'TYPE_UNSPECIFIED' | 'STRING' | 'NUMBER' | 'INTEGER' | 'BOOLEAN' | 'ARRAY' | 'OBJECT' | 'NULL': Optional. Data type of the schema field. - `routingConfig` GoogleCloudAiplatformV1GenerationConfigRoutingConfig: The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. - `autoMode` GoogleCloudAiplatformV1GenerationConfigRoutingConfigAutoRoutingMode: The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. - … - `manualMode` GoogleCloudAiplatformV1GenerationConfigRoutingConfigManualRoutingMode: The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. - … - `seed` integer: Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. - `speechConfig` GoogleCloudAiplatformV1SpeechConfig: Configuration for speech generation. - `languageCode` string: Optional. The language code (ISO 639-1) for the speech synthesis. - `multiSpeakerVoiceConfig` GoogleCloudAiplatformV1MultiSpeakerVoiceConfig: Configuration for a multi-speaker text-to-speech request. - … - `voiceConfig` GoogleCloudAiplatformV1VoiceConfig: Configuration for a voice. - … - `stopSequences` string[]: Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. - `temperature` number, float: Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. - `thinkingConfig` GoogleCloudAiplatformV1GenerationConfigThinkingConfig: Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. - `includeThoughts` boolean: Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. - `thinkingBudget` integer: Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. - `thinkingLevel` 'THINKING_LEVEL_UNSPECIFIED' | 'LOW' | 'MEDIUM' | 'HIGH' | 'MINIMAL': Optional. The number of thoughts tokens that the model should generate. - `topK` number, float: Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. - `topP` number, float: Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. - `translationConfig` GoogleCloudAiplatformV1TranslationConfig: Config for translation features. - `echoTargetLanguage` boolean: Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. - `targetLanguageCode` string: Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). - `samplingCount` integer: Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. - `metricPromptTemplate` string: Required. Template for the prompt sent to the judge model. - `predefinedRubricGenerationSpec` GoogleCloudAiplatformV1PredefinedMetricSpec: The spec for a pre-defined metric. - `metricSpecName` string: Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". - `metricSpecParameters` object: Optional. The parameters needed to run the pre-defined metric. - `resultParserConfig` GoogleCloudAiplatformV1EvaluationParserConfig: Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. - `customCodeParserConfig` GoogleCloudAiplatformV1EvaluationParserConfigCustomCodeParserConfig: Configuration for parsing the LLM response using custom code. - `parsingFunction` string: Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation - `rubricGenerationSpec` GoogleCloudAiplatformV1RubricGenerationSpec: Specification for how rubrics should be generated. - `modelConfig` GoogleCloudAiplatformV1AutoraterConfig: The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. - `autoraterModel` string: Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` - `flipEnabled` boolean: Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. - `generationConfig` GoogleCloudAiplatformV1GenerationConfig: Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. - `audioTimestamp` boolean: Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. - `audioTranscriptionConfig` GoogleCloudAiplatformV1AudioTranscriptionConfig: Configuration for speech recognition (transcription). - … - `candidateCount` integer: Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. - `enableAffectiveDialog` boolean: Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. - `frequencyPenalty` number, float: Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. - `imageConfig` GoogleCloudAiplatformV1ImageConfig: Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. - … - `logprobs` integer: Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. - `maxOutputTokens` integer: Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. - `mediaResolution` 'MEDIA_RESOLUTION_UNSPECIFIED' | 'MEDIA_RESOLUTION_LOW' | 'MEDIA_RESOLUTION_MEDIUM' | 'MEDIA_RESOLUTION_HIGH': Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. - `presencePenalty` number, float: Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. - `responseFormat` GoogleCloudAiplatformV1ResponseFormat[]: Optional. New response format field for the model to configure output formatting and delivery. - … - `responseJsonSchema` unknown - `responseLogprobs` boolean: Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. - `responseMimeType` string: Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. Deprecated: Use `response_format` instead. - `responseModalities` string[]: Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. - `responseSchema` GoogleCloudAiplatformV1Schema: Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). - … - `routingConfig` GoogleCloudAiplatformV1GenerationConfigRoutingConfig: The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. - … - `seed` integer: Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. - `speechConfig` GoogleCloudAiplatformV1SpeechConfig: Configuration for speech generation. - … - `stopSequences` string[]: Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. - `temperature` number, float: Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. - `thinkingConfig` GoogleCloudAiplatformV1GenerationConfigThinkingConfig: Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. - … - `topK` number, float: Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. - `topP` number, float: Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. - `translationConfig` GoogleCloudAiplatformV1TranslationConfig: Config for translation features. - … - `samplingCount` integer: Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. - `promptTemplate` string: Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements. - `rubricContentType` 'RUBRIC_CONTENT_TYPE_UNSPECIFIED' | 'PROPERTY' | 'NL_QUESTION_ANSWER' | 'PYTHON_CODE_ASSERTION': The type of rubric content to be generated. - `rubricTypeOntology` string[]: Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology. - `rubricGroupKey` string: Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance. - `systemInstruction` string: Optional. System instructions for the judge model. - `metadata` GoogleCloudAiplatformV1MetricMetadata: Metadata about the metric, used for visualization and organization. - `otherMetadata` object: Optional. Flexible metadata for user-defined attributes. - `scoreRange` GoogleCloudAiplatformV1MetricMetadataScoreRange: The range of possible scores for this metric, used for plotting. - `description` string: Optional. The description of the score explaining the directionality etc. - `max` number, double: Required. The maximum value of the score range (inclusive). - `min` number, double: Required. The minimum value of the score range (inclusive). - `step` number, double: Optional. The distance between discrete steps in the range. If unset, the range is assumed to be continuous. - `title` string: Optional. The user-friendly name for the metric. If not set for a registered metric, it will default to the metric's display name. - `pairwiseMetricSpec` GoogleCloudAiplatformV1PairwiseMetricSpec: Spec for pairwise metric. - `baselineResponseFieldName` string: Optional. The field name of the baseline response. - `candidateResponseFieldName` string: Optional. The field name of the candidate response. - `customOutputFormatConfig` GoogleCloudAiplatformV1CustomOutputFormatConfig: Spec for custom output format configuration. - `returnRawOutput` boolean: Optional. Whether to return raw output. - `metricPromptTemplate` string: Required. Metric prompt template for pairwise metric. - `systemInstruction` string: Optional. System instructions for pairwise metric. - `pointwiseMetricSpec` GoogleCloudAiplatformV1PointwiseMetricSpec: Spec for pointwise metric. - `customOutputFormatConfig` GoogleCloudAiplatformV1CustomOutputFormatConfig: Spec for custom output format configuration. - `returnRawOutput` boolean: Optional. Whether to return raw output. - `metricPromptTemplate` string: Required. Metric prompt template for pointwise metric. - `systemInstruction` string: Optional. System instructions for pointwise metric. - `predefinedMetricSpec` GoogleCloudAiplatformV1PredefinedMetricSpec: The spec for a pre-defined metric. - `metricSpecName` string: Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". - `metricSpecParameters` object: Optional. The parameters needed to run the pre-defined metric. - `rougeSpec` GoogleCloudAiplatformV1RougeSpec: Spec for rouge score metric - calculates the recall of n-grams in prediction as compared to reference - returns a score ranging between 0 and 1. - `rougeType` string: Optional. Supported rouge types are rougen[1-9], rougeL, and rougeLsum. - `splitSummaries` boolean: Optional. Whether to split summaries while using rougeLsum. - `useStemmer` boolean: Optional. Whether to use stemmer to compute rouge score. - `name` string: Identifier. The resource name of the EvaluationMetric. Format: `projects/{project}/locations/{location}/evaluationMetrics/{evaluation_metric}` - `updateTime` string, google-datetime: Output only. The time when the EvaluationMetric was last updated. --- [API](https://skmtc.dev/google/apis/aiplatform.md) - [All operations](https://skmtc.dev/google/apis/aiplatform/llms.txt) - [OpenAPI document](https://skmtc.dev/google/apis/aiplatform/revisions/3aca3b348f0c?raw)