diff --git a/aiplatform/v1/aiplatform-api.json b/aiplatform/v1/aiplatform-api.json index 4740b56cc6..b9cccb0afd 100644 --- a/aiplatform/v1/aiplatform-api.json +++ b/aiplatform/v1/aiplatform-api.json @@ -104,6 +104,11 @@ "endpointUrl": "https://europe-west10-aiplatform.googleapis.com/", "location": "europe-west10" }, + { + "description": "Locational Endpoint", + "endpointUrl": "https://europe-west15-aiplatform.googleapis.com/", + "location": "europe-west15" + }, { "description": "Locational Endpoint", "endpointUrl": "https://europe-west2-aiplatform.googleapis.com/", @@ -6561,7 +6566,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -28598,7 +28603,7 @@ } } }, - "revision": "20251027", + "revision": "20251028", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoResponse": { @@ -30463,16 +30468,16 @@ "type": "object" }, "GoogleCloudAiplatformV1Blob": { - "description": "Content blob.", + "description": "A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video.", "id": "GoogleCloudAiplatformV1Blob", "properties": { "data": { - "description": "Required. Raw bytes.", + "description": "Required. The raw bytes of the data.", "format": "byte", "type": "string" }, "displayName": { - "description": "Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.", + "description": "Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled.", "type": "string" }, "mimeType": { @@ -30686,28 +30691,28 @@ "id": "GoogleCloudAiplatformV1Candidate", "properties": { "avgLogprobs": { - "description": "Output only. Average log probability score of the candidate.", + "description": "Output only. The average log probability of the tokens in this candidate. This is a length-normalized score that can be used to compare the quality of candidates of different lengths. A higher average log probability suggests a more confident and coherent response.", "format": "double", "readOnly": true, "type": "number" }, "citationMetadata": { "$ref": "GoogleCloudAiplatformV1CitationMetadata", - "description": "Output only. Source attribution of the generated content.", + "description": "Output only. A collection of citations that apply to the generated content.", "readOnly": true }, "content": { "$ref": "GoogleCloudAiplatformV1Content", - "description": "Output only. Content parts of the candidate.", + "description": "Output only. The content of the candidate.", "readOnly": true }, "finishMessage": { - "description": "Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when `finish_reason` is set.", + "description": "Output only. Describes the reason the model stopped generating tokens in more detail. This field is returned only when `finish_reason` is set.", "readOnly": true, "type": "string" }, "finishReason": { - "description": "Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens.", + "description": "Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating.", "enum": [ "FINISH_REASON_UNSPECIFIED", "STOP", @@ -30729,44 +30734,44 @@ ], "enumDescriptions": [ "The finish reason is unspecified.", - "Token generation reached a natural stopping point or a configured stop sequence.", - "Token generation reached the configured maximum output tokens.", - "Token generation stopped because the content potentially contains safety violations. NOTE: When streaming, content is empty if content filters blocks the output.", - "The token generation stopped because of potential recitation.", - "All other reasons that stopped the token generation.", - "Token generation stopped because the content contains forbidden terms.", - "Token generation stopped for potentially containing prohibited content.", - "Token generation stopped because the content potentially contains Sensitive Personally Identifiable Information (SPII).", - "The function call generated by the model is syntaxtically invalid (e.g. the function call generated is not parsable).", + "The model reached a natural stopping point or a configured stop sequence.", + "The model generated the maximum number of tokens allowed by the `max_output_tokens` parameter.", + "The model stopped generating because the content potentially violates safety policies. NOTE: When streaming, the `content` field is empty if content filters block the output.", + "The model stopped generating because the content may be a recitation from a source.", + "The model stopped generating for a reason not otherwise specified.", + "The model stopped generating because the content contains a term from a configured blocklist.", + "The model stopped generating because the content may be prohibited.", + "The model stopped generating because the content may contain sensitive personally identifiable information (SPII).", + "The model generated a function call that is syntactically invalid and can't be parsed.", "The model response was blocked by Model Armor.", - "Token generation stopped because generated images has safety violations.", - "Image generation stopped because generated images has other prohibited content.", - "Image generation stopped due to recitation.", - "Image generation stopped because of other miscellaneous issue.", - "The function call generated by the model is semantically invalid (e.g. a function call is generated when function calling is not enabled or the function is not in the function declaration).", - "The model was expected to generate an image, but none was generated." + "The generated image potentially violates safety policies.", + "The generated image may contain prohibited content.", + "The generated image may be a recitation from a source.", + "The image generation stopped for a reason not otherwise specified.", + "The model generated a function call that is semantically invalid. This can happen, for example, if function calling is not enabled or the generated function is not in the function declaration.", + "The model was expected to generate an image, but didn't." ], "readOnly": true, "type": "string" }, "groundingMetadata": { "$ref": "GoogleCloudAiplatformV1GroundingMetadata", - "description": "Output only. Metadata specifies sources used to ground generated content.", + "description": "Output only. Metadata returned when grounding is enabled. It contains the sources used to ground the generated content.", "readOnly": true }, "index": { - "description": "Output only. Index of the candidate.", + "description": "Output only. The 0-based index of this candidate in the list of generated responses. This is useful for distinguishing between multiple candidates when `candidate_count` \u003e 1.", "format": "int32", "readOnly": true, "type": "integer" }, "logprobsResult": { "$ref": "GoogleCloudAiplatformV1LogprobsResult", - "description": "Output only. Log-likelihood scores for the response tokens and top tokens", + "description": "Output only. The detailed log probability information for the tokens in this candidate. This is useful for debugging, understanding model uncertainty, and identifying potential \"hallucinations\".", "readOnly": true }, "safetyRatings": { - "description": "Output only. List of ratings for the safety of a response candidate. There is at most one rating per category.", + "description": "Output only. A list of ratings for the safety of a response candidate. There is at most one rating per category.", "items": { "$ref": "GoogleCloudAiplatformV1SafetyRating" }, @@ -30775,7 +30780,7 @@ }, "urlContextMetadata": { "$ref": "GoogleCloudAiplatformV1UrlContextMetadata", - "description": "Output only. Metadata related to url context retrieval tool.", + "description": "Output only. Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL.", "readOnly": true } }, @@ -30893,38 +30898,38 @@ "type": "object" }, "GoogleCloudAiplatformV1Citation": { - "description": "Source attributions for content.", + "description": "A citation for a piece of generatedcontent.", "id": "GoogleCloudAiplatformV1Citation", "properties": { "endIndex": { - "description": "Output only. End index into the content.", + "description": "Output only. The end index of the citation in the content.", "format": "int32", "readOnly": true, "type": "integer" }, "license": { - "description": "Output only. License of the attribution.", + "description": "Output only. The license of the source of the citation.", "readOnly": true, "type": "string" }, "publicationDate": { "$ref": "GoogleTypeDate", - "description": "Output only. Publication date of the attribution.", + "description": "Output only. The publication date of the source of the citation.", "readOnly": true }, "startIndex": { - "description": "Output only. Start index into the content.", + "description": "Output only. The start index of the citation in the content.", "format": "int32", "readOnly": true, "type": "integer" }, "title": { - "description": "Output only. Title of the attribution.", + "description": "Output only. The title of the source of the citation.", "readOnly": true, "type": "string" }, "uri": { - "description": "Output only. Url reference of the attribution.", + "description": "Output only. The URI of the source of the citation.", "readOnly": true, "type": "string" } @@ -30932,11 +30937,11 @@ "type": "object" }, "GoogleCloudAiplatformV1CitationMetadata": { - "description": "A collection of source attributions for a piece of content.", + "description": "A collection of citations that apply to a piece of generated content.", "id": "GoogleCloudAiplatformV1CitationMetadata", "properties": { "citations": { - "description": "Output only. List of citations.", + "description": "Output only. A list of citations for the content.", "items": { "$ref": "GoogleCloudAiplatformV1Citation" }, @@ -31300,18 +31305,18 @@ "type": "object" }, "GoogleCloudAiplatformV1Content": { - "description": "The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn.", + "description": "The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message.", "id": "GoogleCloudAiplatformV1Content", "properties": { "parts": { - "description": "Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.", + "description": "Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.", "items": { "$ref": "GoogleCloudAiplatformV1Part" }, "type": "array" }, "role": { - "description": "Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.", + "description": "Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.", "type": "string" } }, @@ -31992,6 +31997,17 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1CustomCodeExecutionSpec": { + "description": "Specificies a metric that is populated by evaluating user-defined Python code.", + "id": "GoogleCloudAiplatformV1CustomCodeExecutionSpec", + "properties": { + "evaluationFunction": { + "description": "Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -\u003e 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]) -\u003e float: if instance'response' == instance'reference': return 1.0 return 0.0 ```", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1CustomJob": { "description": "Represents a job that runs custom workloads such as a Docker container or a Python package. A CustomJob can have multiple worker pools and each worker pool can have its own machine and input spec. A CustomJob will be cleaned up once the job enters terminal state (failed or succeeded).", "id": "GoogleCloudAiplatformV1CustomJob", @@ -32490,6 +32506,88 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1DatasetDistribution": { + "description": "Distribution computed over a tuning dataset.", + "id": "GoogleCloudAiplatformV1DatasetDistribution", + "properties": { + "buckets": { + "description": "Output only. Defines the histogram bucket.", + "items": { + "$ref": "GoogleCloudAiplatformV1DatasetDistributionDistributionBucket" + }, + "readOnly": true, + "type": "array" + }, + "max": { + "description": "Output only. The maximum of the population values.", + "format": "double", + "readOnly": true, + "type": "number" + }, + "mean": { + "description": "Output only. The arithmetic mean of the values in the population.", + "format": "double", + "readOnly": true, + "type": "number" + }, + "median": { + "description": "Output only. The median of the values in the population.", + "format": "double", + "readOnly": true, + "type": "number" + }, + "min": { + "description": "Output only. The minimum of the population values.", + "format": "double", + "readOnly": true, + "type": "number" + }, + "p5": { + "description": "Output only. The 5th percentile of the values in the population.", + "format": "double", + "readOnly": true, + "type": "number" + }, + "p95": { + "description": "Output only. The 95th percentile of the values in the population.", + "format": "double", + "readOnly": true, + "type": "number" + }, + "sum": { + "description": "Output only. Sum of a given population of values.", + "format": "double", + "readOnly": true, + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1DatasetDistributionDistributionBucket": { + "description": "Dataset bucket used to create a histogram for the distribution given a population of values.", + "id": "GoogleCloudAiplatformV1DatasetDistributionDistributionBucket", + "properties": { + "count": { + "description": "Output only. Number of values in the bucket.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "left": { + "description": "Output only. Left bound of the bucket.", + "format": "double", + "readOnly": true, + "type": "number" + }, + "right": { + "description": "Output only. Right bound of the bucket.", + "format": "double", + "readOnly": true, + "type": "number" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1DatasetVersion": { "description": "Describes the dataset version.", "id": "GoogleCloudAiplatformV1DatasetVersion", @@ -37525,15 +37623,15 @@ "type": "object" }, "GoogleCloudAiplatformV1FileData": { - "description": "URI based data.", + "description": "URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage.", "id": "GoogleCloudAiplatformV1FileData", "properties": { "displayName": { - "description": "Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.", + "description": "Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled.", "type": "string" }, "fileUri": { - "description": "Required. URI.", + "description": "Required. The URI of the file in Google Cloud Storage.", "type": "string" }, "mimeType": { @@ -38057,6 +38155,43 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1GeminiPreferenceExample": { + "description": "Input example for preference optimization.", + "id": "GoogleCloudAiplatformV1GeminiPreferenceExample", + "properties": { + "completions": { + "description": "List of completions for a given prompt.", + "items": { + "$ref": "GoogleCloudAiplatformV1GeminiPreferenceExampleCompletion" + }, + "type": "array" + }, + "contents": { + "description": "Multi-turn contents that represents the Prompt.", + "items": { + "$ref": "GoogleCloudAiplatformV1Content" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1GeminiPreferenceExampleCompletion": { + "description": "Completion and its preference score.", + "id": "GoogleCloudAiplatformV1GeminiPreferenceExampleCompletion", + "properties": { + "completion": { + "$ref": "GoogleCloudAiplatformV1Content", + "description": "Single turn completion for the given prompt." + }, + "score": { + "description": "The score for the given completion.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1GenAiAdvancedFeaturesConfig": { "description": "Configuration for GenAiAdvancedFeatures.", "id": "GoogleCloudAiplatformV1GenAiAdvancedFeaturesConfig", @@ -38467,24 +38602,24 @@ "type": "object" }, "GoogleCloudAiplatformV1GenerationConfig": { - "description": "Generation config.", + "description": "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.", "id": "GoogleCloudAiplatformV1GenerationConfig", "properties": { "audioTimestamp": { - "description": "Optional. If enabled, audio timestamp will be included in the request to the model.", + "description": "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.", "type": "boolean" }, "candidateCount": { - "description": "Optional. Number of candidates to generate.", + "description": "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.", "format": "int32", "type": "integer" }, "enableAffectiveDialog": { - "description": "Optional. If enabled, the model will detect emotions and adapt its responses accordingly.", + "description": "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.", "type": "boolean" }, "frequencyPenalty": { - "description": "Optional. Frequency penalties.", + "description": "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].", "format": "float", "type": "number" }, @@ -38493,17 +38628,17 @@ "description": "Optional. Config for image generation features." }, "logprobs": { - "description": "Optional. Logit probabilities.", + "description": "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.", "format": "int32", "type": "integer" }, "maxOutputTokens": { - "description": "Optional. The maximum number of output tokens to generate per message.", + "description": "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.", "format": "int32", "type": "integer" }, "mediaResolution": { - "description": "Optional. If specified, the media resolution specified will be used.", + "description": "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.", "enum": [ "MEDIA_RESOLUTION_UNSPECIFIED", "MEDIA_RESOLUTION_LOW", @@ -38519,24 +38654,24 @@ "type": "string" }, "presencePenalty": { - "description": "Optional. Positive penalties.", + "description": "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].", "format": "float", "type": "number" }, "responseJsonSchema": { - "description": "Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.", + "description": "Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`.", "type": "any" }, "responseLogprobs": { - "description": "Optional. If true, export the logprobs results in response.", + "description": "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.", "type": "boolean" }, "responseMimeType": { - "description": "Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.", + "description": "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. This is a preview feature.", "type": "string" }, "responseModalities": { - "description": "Optional. The modalities of the response.", + "description": "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.", "items": { "enum": [ "MODALITY_UNSPECIFIED", @@ -38556,14 +38691,14 @@ }, "responseSchema": { "$ref": "GoogleCloudAiplatformV1Schema", - "description": "Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response." + "description": "Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`." }, "routingConfig": { "$ref": "GoogleCloudAiplatformV1GenerationConfigRoutingConfig", "description": "Optional. Routing configuration." }, "seed": { - "description": "Optional. Seed.", + "description": "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.", "format": "int32", "type": "integer" }, @@ -38572,28 +38707,28 @@ "description": "Optional. The speech generation config." }, "stopSequences": { - "description": "Optional. Stop sequences.", + "description": "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.", "items": { "type": "string" }, "type": "array" }, "temperature": { - "description": "Optional. Controls the randomness of predictions.", + "description": "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].", "format": "float", "type": "number" }, "thinkingConfig": { "$ref": "GoogleCloudAiplatformV1GenerationConfigThinkingConfig", - "description": "Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking." + "description": "Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking." }, "topK": { - "description": "Optional. If specified, top-k sampling will be used.", + "description": "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.", "format": "float", "type": "number" }, "topP": { - "description": "Optional. If specified, nucleus sampling will be used.", + "description": "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.", "format": "float", "type": "number" } @@ -38601,22 +38736,22 @@ "type": "object" }, "GoogleCloudAiplatformV1GenerationConfigRoutingConfig": { - "description": "The configuration for routing the request to a specific model.", + "description": "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.", "id": "GoogleCloudAiplatformV1GenerationConfigRoutingConfig", "properties": { "autoMode": { "$ref": "GoogleCloudAiplatformV1GenerationConfigRoutingConfigAutoRoutingMode", - "description": "Automated routing." + "description": "In this mode, the model is selected automatically based on the content of the request." }, "manualMode": { "$ref": "GoogleCloudAiplatformV1GenerationConfigRoutingConfigManualRoutingMode", - "description": "Manual routing." + "description": "In this mode, the model is specified manually." } }, "type": "object" }, "GoogleCloudAiplatformV1GenerationConfigRoutingConfigAutoRoutingMode": { - "description": "When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference.", + "description": "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.", "id": "GoogleCloudAiplatformV1GenerationConfigRoutingConfigAutoRoutingMode", "properties": { "modelRoutingPreference": { @@ -38629,9 +38764,9 @@ ], "enumDescriptions": [ "Unspecified model routing preference.", - "Prefer higher quality over low cost.", - "Balanced model routing preference.", - "Prefer lower cost over higher quality." + "The model will be selected to prioritize the quality of the response.", + "The model will be selected to balance quality and cost.", + "The model will be selected to prioritize the cost of the request." ], "type": "string" } @@ -38639,26 +38774,26 @@ "type": "object" }, "GoogleCloudAiplatformV1GenerationConfigRoutingConfigManualRoutingMode": { - "description": "When manual routing is set, the specified model will be used directly.", + "description": "The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided.", "id": "GoogleCloudAiplatformV1GenerationConfigRoutingConfigManualRoutingMode", "properties": { "modelName": { - "description": "The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).", + "description": "The name of the model to use. Only public LLM models are accepted.", "type": "string" } }, "type": "object" }, "GoogleCloudAiplatformV1GenerationConfigThinkingConfig": { - "description": "Config for thinking features.", + "description": "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.", "id": "GoogleCloudAiplatformV1GenerationConfigThinkingConfig", "properties": { "includeThoughts": { - "description": "Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.", + "description": "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.", "type": "boolean" }, "thinkingBudget": { - "description": "Optional. Indicates the thinking budget in tokens.", + "description": "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.", "format": "int32", "type": "integer" } @@ -38831,57 +38966,57 @@ "type": "object" }, "GoogleCloudAiplatformV1GroundingChunk": { - "description": "Grounding chunk.", + "description": "A piece of evidence that supports a claim made by the model. This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a `GroundingChunk` that contains a reference to the source of the information.", "id": "GoogleCloudAiplatformV1GroundingChunk", "properties": { "maps": { "$ref": "GoogleCloudAiplatformV1GroundingChunkMaps", - "description": "Grounding chunk from Google Maps." + "description": "A grounding chunk from Google Maps. See the `Maps` message for details." }, "retrievedContext": { "$ref": "GoogleCloudAiplatformV1GroundingChunkRetrievedContext", - "description": "Grounding chunk from context retrieved by the retrieval tools." + "description": "A grounding chunk from a data source retrieved by a retrieval tool, such as Vertex AI Search. See the `RetrievedContext` message for details" }, "web": { "$ref": "GoogleCloudAiplatformV1GroundingChunkWeb", - "description": "Grounding chunk from the web." + "description": "A grounding chunk from a web page, typically from Google Search. See the `Web` message for details." } }, "type": "object" }, "GoogleCloudAiplatformV1GroundingChunkMaps": { - "description": "Chunk from Google Maps.", + "description": "A `Maps` chunk is a piece of evidence that comes from Google Maps. It contains information about a place, such as its name, address, and reviews. This is used to provide the user with rich, location-based information.", "id": "GoogleCloudAiplatformV1GroundingChunkMaps", "properties": { "placeAnswerSources": { "$ref": "GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSources", - "description": "Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content." + "description": "The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content." }, "placeId": { - "description": "This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place.", + "description": "This Place's resource name, in `places/{place_id}` format. This can be used to look up the place in the Google Maps API.", "type": "string" }, "text": { - "description": "Text of the place answer.", + "description": "The text of the place answer.", "type": "string" }, "title": { - "description": "Title of the place.", + "description": "The title of the place.", "type": "string" }, "uri": { - "description": "URI reference of the place.", + "description": "The URI of the place.", "type": "string" } }, "type": "object" }, "GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSources": { - "description": "Sources used to generate the place answer.", + "description": "The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content.", "id": "GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSources", "properties": { "reviewSnippets": { - "description": "Snippets of reviews that are used to generate the answer.", + "description": "Snippets of reviews that were used to generate the answer.", "items": { "$ref": "GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet" }, @@ -38891,7 +39026,7 @@ "type": "object" }, "GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet": { - "description": "Encapsulates a review snippet.", + "description": "A review snippet that is used to generate the answer.", "id": "GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet", "properties": { "googleMapsUri": { @@ -38899,81 +39034,81 @@ "type": "string" }, "reviewId": { - "description": "Id of the review referencing the place.", + "description": "The ID of the review that is being referenced.", "type": "string" }, "title": { - "description": "Title of the review.", + "description": "The title of the review.", "type": "string" } }, "type": "object" }, "GoogleCloudAiplatformV1GroundingChunkRetrievedContext": { - "description": "Chunk from context retrieved by the retrieval tools.", + "description": "Context retrieved from a data source to ground the model's response. This is used when a retrieval tool fetches information from a user-provided corpus or a public dataset.", "id": "GoogleCloudAiplatformV1GroundingChunkRetrievedContext", "properties": { "documentName": { - "description": "Output only. The full document name for the referenced Vertex AI Search document.", + "description": "Output only. The full resource name of the referenced Vertex AI Search document. This is used to identify the specific document that was retrieved. The format is `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`.", "readOnly": true, "type": "string" }, "ragChunk": { "$ref": "GoogleCloudAiplatformV1RagChunk", - "description": "Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool." + "description": "Additional context for a Retrieval-Augmented Generation (RAG) retrieval result. This is populated only when the RAG retrieval tool is used." }, "text": { - "description": "Text of the attribution.", + "description": "The content of the retrieved data source.", "type": "string" }, "title": { - "description": "Title of the attribution.", + "description": "The title of the retrieved data source.", "type": "string" }, "uri": { - "description": "URI reference of the attribution.", + "description": "The URI of the retrieved data source.", "type": "string" } }, "type": "object" }, "GoogleCloudAiplatformV1GroundingChunkWeb": { - "description": "Chunk from the web.", + "description": "A `Web` chunk is a piece of evidence that comes from a web page. It contains the URI of the web page, the title of the page, and the domain of the page. This is used to provide the user with a link to the source of the information.", "id": "GoogleCloudAiplatformV1GroundingChunkWeb", "properties": { "domain": { - "description": "Domain of the (original) URI.", + "description": "The domain of the web page that contains the evidence. This can be used to filter out low-quality sources.", "type": "string" }, "title": { - "description": "Title of the chunk.", + "description": "The title of the web page that contains the evidence.", "type": "string" }, "uri": { - "description": "URI reference of the chunk.", + "description": "The URI of the web page that contains the evidence.", "type": "string" } }, "type": "object" }, "GoogleCloudAiplatformV1GroundingMetadata": { - "description": "Metadata returned to client when grounding is enabled.", + "description": "Information about the sources that support the content of a response. When grounding is enabled, the model returns citations for claims in the response. This object contains the retrieved sources.", "id": "GoogleCloudAiplatformV1GroundingMetadata", "properties": { "googleMapsWidgetContextToken": { - "description": "Optional. Output only. Resource name of the Google Maps widget context token to be used with the PlacesContextElement widget to render contextual data. This is populated only for Google Maps grounding.", + "description": "Optional. Output only. A token that can be used to render a Google Maps widget with the contextual data. This field is populated only when the grounding source is Google Maps.", "readOnly": true, "type": "string" }, "groundingChunks": { - "description": "List of supporting references retrieved from specified grounding source.", + "description": "A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps.", "items": { "$ref": "GoogleCloudAiplatformV1GroundingChunk" }, "type": "array" }, "groundingSupports": { - "description": "Optional. List of grounding support.", + "description": "Optional. A list of grounding supports that connect the generated content to the grounding chunks. This field is populated when the grounding source is Google Search or Vertex AI Search.", "items": { "$ref": "GoogleCloudAiplatformV1GroundingSupport" }, @@ -38981,15 +39116,15 @@ }, "retrievalMetadata": { "$ref": "GoogleCloudAiplatformV1RetrievalMetadata", - "description": "Optional. Output only. Retrieval metadata.", + "description": "Optional. Output only. Metadata related to the retrieval grounding source.", "readOnly": true }, "searchEntryPoint": { "$ref": "GoogleCloudAiplatformV1SearchEntryPoint", - "description": "Optional. Google search entry for the following-up web searches." + "description": "Optional. A web search entry point that can be used to display search results. This field is populated only when the grounding source is Google Search." }, "sourceFlaggingUris": { - "description": "Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding.", + "description": "Optional. Output only. A list of URIs that can be used to flag a place or review for inappropriate content. This field is populated only when the grounding source is Google Maps.", "items": { "$ref": "GoogleCloudAiplatformV1GroundingMetadataSourceFlaggingUri" }, @@ -38997,7 +39132,7 @@ "type": "array" }, "webSearchQueries": { - "description": "Optional. Web search queries for the following-up web search.", + "description": "Optional. The web search queries that were used to generate the content. This field is populated only when the grounding source is Google Search.", "items": { "type": "string" }, @@ -39007,26 +39142,26 @@ "type": "object" }, "GoogleCloudAiplatformV1GroundingMetadataSourceFlaggingUri": { - "description": "Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding.", + "description": "A URI that can be used to flag a place or review for inappropriate content. This is populated only when the grounding source is Google Maps.", "id": "GoogleCloudAiplatformV1GroundingMetadataSourceFlaggingUri", "properties": { "flagContentUri": { - "description": "A link where users can flag a problem with the source (place or review).", + "description": "The URI that can be used to flag the content.", "type": "string" }, "sourceId": { - "description": "Id of the place or review.", + "description": "The ID of the place or review.", "type": "string" } }, "type": "object" }, "GoogleCloudAiplatformV1GroundingSupport": { - "description": "Grounding support.", + "description": "A collection of supporting references for a segment of the model's response.", "id": "GoogleCloudAiplatformV1GroundingSupport", "properties": { "confidenceScores": { - "description": "Confidence score of the support references. Ranges from 0 to 1. 1 is the most confident. For Gemini 2.0 and before, this list must have the same size as the grounding_chunk_indices. For Gemini 2.5 and after, this list will be empty and should be ignored.", + "description": "The confidence scores for the support references. This list is parallel to the `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a higher score indicating a higher confidence that the reference supports the claim. For Gemini 2.0 and before, this list has the same size as `grounding_chunk_indices`. For Gemini 2.5 and later, this list is empty and should be ignored.", "items": { "format": "float", "type": "number" @@ -39034,7 +39169,7 @@ "type": "array" }, "groundingChunkIndices": { - "description": "A list of indices (into 'grounding_chunk') specifying the citations associated with the claim. For instance [1,3,4] means that grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to the claim.", + "description": "A list of indices into the `grounding_chunks` field of the `GroundingMetadata` message. These indices specify which grounding chunks support the claim made in the content segment. For example, if this field has the values `[1, 3]`, it means that `grounding_chunks[1]` and `grounding_chunks[3]` are the sources for the claim in the content segment.", "items": { "format": "int32", "type": "integer" @@ -39043,7 +39178,7 @@ }, "segment": { "$ref": "GoogleCloudAiplatformV1Segment", - "description": "Segment of the content this support belongs to." + "description": "The content segment that this support message applies to." } }, "type": "object" @@ -39193,7 +39328,7 @@ "type": "object" }, "GoogleCloudAiplatformV1ImageConfig": { - "description": "Config for image generation features.", + "description": "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.", "id": "GoogleCloudAiplatformV1ImageConfig", "properties": { "aspectRatio": { @@ -39213,10 +39348,10 @@ "ALLOW_NONE" ], "enumDescriptions": [ - "Generation images of people unspecified.", - "Generate images that include adults and children.", - "Generate images of adults, but not children.", - "Block generation of images of people." + "The default behavior is unspecified. The model will decide whether to generate images of people.", + "Allows the model to generate images of people, including adults and children.", + "Allows the model to generate images of adults, but not children.", + "Prevents the model from generating images of people." ], "type": "string" } @@ -41145,18 +41280,18 @@ "type": "object" }, "GoogleCloudAiplatformV1LogprobsResult": { - "description": "Logprobs Result", + "description": "The log probabilities of the tokens generated by the model. This is useful for understanding the model's confidence in its predictions and for debugging. For example, you can use log probabilities to identify when the model is making a less confident prediction or to explore alternative responses that the model considered. A low log probability can also indicate that the model is \"hallucinating\" or generating factually incorrect information.", "id": "GoogleCloudAiplatformV1LogprobsResult", "properties": { "chosenCandidates": { - "description": "Length = total number of decoding steps. The chosen candidates may or may not be in top_candidates.", + "description": "A list of the chosen candidate tokens at each decoding step. The length of this list is equal to the total number of decoding steps. Note that the chosen candidate might not be in `top_candidates`.", "items": { "$ref": "GoogleCloudAiplatformV1LogprobsResultCandidate" }, "type": "array" }, "topCandidates": { - "description": "Length = total number of decoding steps.", + "description": "A list of the top candidate tokens at each decoding step. The length of this list is equal to the total number of decoding steps.", "items": { "$ref": "GoogleCloudAiplatformV1LogprobsResultTopCandidates" }, @@ -41166,20 +41301,20 @@ "type": "object" }, "GoogleCloudAiplatformV1LogprobsResultCandidate": { - "description": "Candidate for the logprobs token and score.", + "description": "A single token and its associated log probability.", "id": "GoogleCloudAiplatformV1LogprobsResultCandidate", "properties": { "logProbability": { - "description": "The candidate's log probability.", + "description": "The log probability of this token. A higher value indicates that the model was more confident in this token. The log probability can be used to assess the relative likelihood of different tokens and to identify when the model is uncertain.", "format": "float", "type": "number" }, "token": { - "description": "The candidate's token string value.", + "description": "The token's string representation.", "type": "string" }, "tokenId": { - "description": "The candidate's token id value.", + "description": "The token's numerical ID. While the `token` field provides the string representation of the token, the `token_id` is the numerical representation that the model uses internally. This can be useful for developers who want to build custom logic based on the model's vocabulary.", "format": "int32", "type": "integer" } @@ -41187,11 +41322,11 @@ "type": "object" }, "GoogleCloudAiplatformV1LogprobsResultTopCandidates": { - "description": "Candidates with top log probabilities at each decoding step.", + "description": "A list of the top candidate tokens and their log probabilities at each decoding step. This can be used to see what other tokens the model considered.", "id": "GoogleCloudAiplatformV1LogprobsResultTopCandidates", "properties": { "candidates": { - "description": "Sorted by log probability in descending order.", + "description": "The list of candidate tokens, sorted by log probability in descending order.", "items": { "$ref": "GoogleCloudAiplatformV1LogprobsResultCandidate" }, @@ -41547,6 +41682,10 @@ "$ref": "GoogleCloudAiplatformV1BleuSpec", "description": "Spec for bleu metric." }, + "customCodeExecutionSpec": { + "$ref": "GoogleCloudAiplatformV1CustomCodeExecutionSpec", + "description": "Spec for Custom Code Execution metric." + }, "exactMatchSpec": { "$ref": "GoogleCloudAiplatformV1ExactMatchSpec", "description": "Spec for exact match metric." @@ -41929,11 +42068,11 @@ "type": "object" }, "GoogleCloudAiplatformV1ModalityTokenCount": { - "description": "Represents token counting info for a single modality.", + "description": "Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes.", "id": "GoogleCloudAiplatformV1ModalityTokenCount", "properties": { "modality": { - "description": "The modality associated with this token count.", + "description": "The modality that this token count applies to.", "enum": [ "MODALITY_UNSPECIFIED", "TEXT", @@ -41943,17 +42082,17 @@ "DOCUMENT" ], "enumDescriptions": [ - "Unspecified modality.", - "Plain text.", - "Image.", - "Video.", - "Audio.", - "Document, e.g. PDF." + "When a modality is not specified, it is treated as `TEXT`.", + "The `Part` contains plain text.", + "The `Part` contains an image.", + "The `Part` contains a video.", + "The `Part` contains audio.", + "The `Part` contains a document, such as a PDF." ], "type": "string" }, "tokenCount": { - "description": "Number of tokens.", + "description": "The number of tokens counted for this modality.", "format": "int32", "type": "integer" } @@ -42165,15 +42304,15 @@ "type": "object" }, "GoogleCloudAiplatformV1ModelArmorConfig": { - "description": "Configuration for Model Armor integrations of prompt and responses.", + "description": "Configuration for Model Armor. Model Armor is a Google Cloud service that provides safety and security filtering for prompts and responses. It helps protect your AI applications from risks such as harmful content, sensitive data leakage, and prompt injection attacks.", "id": "GoogleCloudAiplatformV1ModelArmorConfig", "properties": { "promptTemplateName": { - "description": "Optional. The name of the Model Armor template to use for prompt sanitization.", + "description": "Optional. The resource name of the Model Armor template to use for prompt screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the user's prompt for safety and security risks before it is sent to the model. The name must be in the format `projects/{project}/locations/{location}/templates/{template}`.", "type": "string" }, "responseTemplateName": { - "description": "Optional. The name of the Model Armor template to use for response sanitization.", + "description": "Optional. The resource name of the Model Armor template to use for response screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the model's response for safety and security risks before it is returned to the user. The name must be in the format `projects/{project}/locations/{location}/templates/{template}`.", "type": "string" } }, @@ -43159,7 +43298,7 @@ "type": "object" }, "GoogleCloudAiplatformV1MultiSpeakerVoiceConfig": { - "description": "Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request.", + "description": "Configuration for a multi-speaker text-to-speech request.", "id": "GoogleCloudAiplatformV1MultiSpeakerVoiceConfig", "properties": { "speakerVoiceConfigs": { @@ -44906,39 +45045,39 @@ "type": "object" }, "GoogleCloudAiplatformV1Part": { - "description": "A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.", + "description": "A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.", "id": "GoogleCloudAiplatformV1Part", "properties": { "codeExecutionResult": { "$ref": "GoogleCloudAiplatformV1CodeExecutionResult", - "description": "Optional. Result of executing the [ExecutableCode]." + "description": "Optional. The result of executing the ExecutableCode." }, "executableCode": { "$ref": "GoogleCloudAiplatformV1ExecutableCode", - "description": "Optional. Code generated by the model that is meant to be executed." + "description": "Optional. Code generated by the model that is intended to be executed." }, "fileData": { "$ref": "GoogleCloudAiplatformV1FileData", - "description": "Optional. URI based data." + "description": "Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage." }, "functionCall": { "$ref": "GoogleCloudAiplatformV1FunctionCall", - "description": "Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values." + "description": "Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function." }, "functionResponse": { "$ref": "GoogleCloudAiplatformV1FunctionResponse", - "description": "Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model." + "description": "Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted." }, "inlineData": { "$ref": "GoogleCloudAiplatformV1Blob", - "description": "Optional. Inlined bytes data." + "description": "Optional. The inline data content of the part. This can be used to include images, audio, or video in a request." }, "text": { - "description": "Optional. Text part (can be code).", + "description": "Optional. The text content of the part.", "type": "string" }, "thought": { - "description": "Optional. Indicates if the part is thought from the model.", + "description": "Optional. Indicates whether the `part` represents the model's thought process or reasoning.", "type": "boolean" }, "thoughtSignature": { @@ -45708,11 +45847,11 @@ "type": "object" }, "GoogleCloudAiplatformV1PrebuiltVoiceConfig": { - "description": "The configuration for the prebuilt speaker to use.", + "description": "Configuration for a prebuilt voice.", "id": "GoogleCloudAiplatformV1PrebuiltVoiceConfig", "properties": { "voiceName": { - "description": "The name of the preset voice to use.", + "description": "The name of the prebuilt voice to use.", "type": "string" } }, @@ -45868,6 +46007,143 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1PreferenceOptimizationDataStats": { + "description": "Statistics computed for datasets used for preference optimization.", + "id": "GoogleCloudAiplatformV1PreferenceOptimizationDataStats", + "properties": { + "droppedExampleIndices": { + "description": "Output only. A partial sample of the indices (starting from 1) of the dropped examples.", + "items": { + "format": "int64", + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "droppedExampleReasons": { + "description": "Output only. For each index in `dropped_example_indices`, the user-facing reason why the example was dropped.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "scoreVariancePerExampleDistribution": { + "$ref": "GoogleCloudAiplatformV1DatasetDistribution", + "description": "Output only. Dataset distributions for scores variance per example.", + "readOnly": true + }, + "scoresDistribution": { + "$ref": "GoogleCloudAiplatformV1DatasetDistribution", + "description": "Output only. Dataset distributions for scores.", + "readOnly": true + }, + "totalBillableTokenCount": { + "description": "Output only. Number of billable tokens in the tuning dataset.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "tuningDatasetExampleCount": { + "description": "Output only. Number of examples in the tuning dataset.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "tuningStepCount": { + "description": "Output only. Number of tuning steps for this Tuning Job.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "userDatasetExamples": { + "description": "Output only. Sample user examples in the training dataset.", + "items": { + "$ref": "GoogleCloudAiplatformV1GeminiPreferenceExample" + }, + "readOnly": true, + "type": "array" + }, + "userInputTokenDistribution": { + "$ref": "GoogleCloudAiplatformV1DatasetDistribution", + "description": "Output only. Dataset distributions for the user input tokens.", + "readOnly": true + }, + "userOutputTokenDistribution": { + "$ref": "GoogleCloudAiplatformV1DatasetDistribution", + "description": "Output only. Dataset distributions for the user output tokens.", + "readOnly": true + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1PreferenceOptimizationHyperParameters": { + "description": "Hyperparameters for Preference Optimization.", + "id": "GoogleCloudAiplatformV1PreferenceOptimizationHyperParameters", + "properties": { + "adapterSize": { + "description": "Optional. Adapter size for preference optimization.", + "enum": [ + "ADAPTER_SIZE_UNSPECIFIED", + "ADAPTER_SIZE_ONE", + "ADAPTER_SIZE_TWO", + "ADAPTER_SIZE_FOUR", + "ADAPTER_SIZE_EIGHT", + "ADAPTER_SIZE_SIXTEEN", + "ADAPTER_SIZE_THIRTY_TWO" + ], + "enumDescriptions": [ + "Adapter size is unspecified.", + "Adapter size 1.", + "Adapter size 2.", + "Adapter size 4.", + "Adapter size 8.", + "Adapter size 16.", + "Adapter size 32." + ], + "type": "string" + }, + "beta": { + "description": "Optional. Weight for KL Divergence regularization.", + "format": "double", + "type": "number" + }, + "epochCount": { + "description": "Optional. Number of complete passes the model makes over the entire training dataset during training.", + "format": "int64", + "type": "string" + }, + "learningRateMultiplier": { + "description": "Optional. Multiplier for adjusting the default learning rate.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1PreferenceOptimizationSpec": { + "description": "Tuning Spec for Preference Optimization.", + "id": "GoogleCloudAiplatformV1PreferenceOptimizationSpec", + "properties": { + "exportLastCheckpointOnly": { + "description": "Optional. If set to true, disable intermediate checkpoints for Preference Optimization and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for Preference Optimization. Default is false.", + "type": "boolean" + }, + "hyperParameters": { + "$ref": "GoogleCloudAiplatformV1PreferenceOptimizationHyperParameters", + "description": "Optional. Hyperparameters for Preference Optimization." + }, + "trainingDatasetUri": { + "description": "Required. Cloud Storage path to file containing training dataset for preference optimization tuning. The dataset must be formatted as a JSONL file.", + "type": "string" + }, + "validationDatasetUri": { + "description": "Optional. Cloud Storage path to file containing validation dataset for preference optimization tuning. The dataset must be formatted as a JSONL file.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1Presets": { "description": "Preset configuration for example-based explanations", "id": "GoogleCloudAiplatformV1Presets", @@ -47165,6 +47441,16 @@ "readOnly": true, "type": "string" }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "updateTime": { "description": "Output only. Timestamp when this RagCorpus was last updated.", "format": "google-datetime", @@ -48040,7 +48326,7 @@ "type": "string" }, "pythonVersion": { - "description": "Optional. The Python version. Currently support 3.8, 3.9, 3.10, 3.11. If not specified, default value is 3.10.", + "description": "Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, the default value is 3.10.", "type": "string" }, "requirementsGcsUri": { @@ -48380,11 +48666,11 @@ "type": "object" }, "GoogleCloudAiplatformV1RetrievalMetadata": { - "description": "Metadata related to retrieval in the grounding flow.", + "description": "Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled.", "id": "GoogleCloudAiplatformV1RetrievalMetadata", "properties": { "googleSearchDynamicRetrievalScore": { - "description": "Optional. Score indicating how likely information from Google Search could help answer the prompt. The score is in the range `[0, 1]`, where 0 is the least likely and 1 is the most likely. This score is only populated when Google Search grounding and dynamic retrieval is enabled. It will be compared to the threshold to determine whether to trigger Google Search.", + "description": "Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search.", "format": "float", "type": "number" } @@ -48768,16 +49054,16 @@ "type": "object" }, "GoogleCloudAiplatformV1SafetyRating": { - "description": "Safety rating corresponding to the generated content.", + "description": "A safety rating for a piece of content. The safety rating contains the harm category and the harm probability level.", "id": "GoogleCloudAiplatformV1SafetyRating", "properties": { "blocked": { - "description": "Output only. Indicates whether the content was filtered out because of this rating.", + "description": "Output only. Indicates whether the content was blocked because of this rating.", "readOnly": true, "type": "boolean" }, "category": { - "description": "Output only. Harm category.", + "description": "Output only. The harm category of this rating.", "enum": [ "HARM_CATEGORY_UNSPECIFIED", "HARM_CATEGORY_HATE_SPEECH", @@ -48805,17 +49091,17 @@ false ], "enumDescriptions": [ - "The harm category is unspecified.", - "The harm category is hate speech.", - "The harm category is dangerous content.", - "The harm category is harassment.", - "The harm category is sexually explicit content.", + "Default value. This value is unused.", + "Content that promotes violence or incites hatred against individuals or groups based on certain attributes.", + "Content that promotes, facilitates, or enables dangerous activities.", + "Abusive, threatening, or content intended to bully, torment, or ridicule.", + "Content that contains sexually explicit material.", "Deprecated: Election filter is not longer supported. The harm category is civic integrity.", - "The harm category is image hate.", - "The harm category is image dangerous content.", - "The harm category is image harassment.", - "The harm category is image sexually explicit content.", - "The harm category is for jailbreak prompts." + "Images that contain hate speech.", + "Images that contain dangerous content.", + "Images that contain harassment.", + "Images that contain sexually explicit content.", + "Prompts designed to bypass safety filters." ], "readOnly": true, "type": "string" @@ -48831,18 +49117,18 @@ "OFF" ], "enumDescriptions": [ - "Unspecified harm block threshold.", - "Block low threshold and above (i.e. block more).", - "Block medium threshold and above.", - "Block only high threshold (i.e. block less).", - "Block none.", - "Turn off the safety filter." + "The harm block threshold is unspecified.", + "Block content with a low harm probability or higher.", + "Block content with a medium harm probability or higher.", + "Block content with a high harm probability.", + "Do not block any content, regardless of its harm probability.", + "Turn off the safety filter entirely." ], "readOnly": true, "type": "string" }, "probability": { - "description": "Output only. Harm probability levels in the content.", + "description": "Output only. The probability of harm for this category.", "enum": [ "HARM_PROBABILITY_UNSPECIFIED", "NEGLIGIBLE", @@ -48851,23 +49137,23 @@ "HIGH" ], "enumDescriptions": [ - "Harm probability unspecified.", - "Negligible level of harm.", - "Low level of harm.", - "Medium level of harm.", - "High level of harm." + "The harm probability is unspecified.", + "The harm probability is negligible.", + "The harm probability is low.", + "The harm probability is medium.", + "The harm probability is high." ], "readOnly": true, "type": "string" }, "probabilityScore": { - "description": "Output only. Harm probability score.", + "description": "Output only. The probability score of harm for this category.", "format": "float", "readOnly": true, "type": "number" }, "severity": { - "description": "Output only. Harm severity levels in the content.", + "description": "Output only. The severity of harm for this category.", "enum": [ "HARM_SEVERITY_UNSPECIFIED", "HARM_SEVERITY_NEGLIGIBLE", @@ -48876,17 +49162,17 @@ "HARM_SEVERITY_HIGH" ], "enumDescriptions": [ - "Harm severity unspecified.", - "Negligible level of harm severity.", - "Low level of harm severity.", - "Medium level of harm severity.", - "High level of harm severity." + "The harm severity is unspecified.", + "The harm severity is negligible.", + "The harm severity is low.", + "The harm severity is medium.", + "The harm severity is high." ], "readOnly": true, "type": "string" }, "severityScore": { - "description": "Output only. Harm severity score.", + "description": "Output only. The severity score of harm for this category.", "format": "float", "readOnly": true, "type": "number" @@ -48919,11 +49205,11 @@ "type": "object" }, "GoogleCloudAiplatformV1SafetySetting": { - "description": "Safety settings.", + "description": "A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category.", "id": "GoogleCloudAiplatformV1SafetySetting", "properties": { "category": { - "description": "Required. Harm category.", + "description": "Required. The harm category to be blocked.", "enum": [ "HARM_CATEGORY_UNSPECIFIED", "HARM_CATEGORY_HATE_SPEECH", @@ -48951,22 +49237,22 @@ false ], "enumDescriptions": [ - "The harm category is unspecified.", - "The harm category is hate speech.", - "The harm category is dangerous content.", - "The harm category is harassment.", - "The harm category is sexually explicit content.", + "Default value. This value is unused.", + "Content that promotes violence or incites hatred against individuals or groups based on certain attributes.", + "Content that promotes, facilitates, or enables dangerous activities.", + "Abusive, threatening, or content intended to bully, torment, or ridicule.", + "Content that contains sexually explicit material.", "Deprecated: Election filter is not longer supported. The harm category is civic integrity.", - "The harm category is image hate.", - "The harm category is image dangerous content.", - "The harm category is image harassment.", - "The harm category is image sexually explicit content.", - "The harm category is for jailbreak prompts." + "Images that contain hate speech.", + "Images that contain dangerous content.", + "Images that contain harassment.", + "Images that contain sexually explicit content.", + "Prompts designed to bypass safety filters." ], "type": "string" }, "method": { - "description": "Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score.", + "description": "Optional. The method for blocking content. If not specified, the default behavior is to use the probability score.", "enum": [ "HARM_BLOCK_METHOD_UNSPECIFIED", "SEVERITY", @@ -48980,7 +49266,7 @@ "type": "string" }, "threshold": { - "description": "Required. The harm block threshold.", + "description": "Required. The threshold for blocking content. If the harm probability exceeds this threshold, the content will be blocked.", "enum": [ "HARM_BLOCK_THRESHOLD_UNSPECIFIED", "BLOCK_LOW_AND_ABOVE", @@ -48990,12 +49276,12 @@ "OFF" ], "enumDescriptions": [ - "Unspecified harm block threshold.", - "Block low threshold and above (i.e. block more).", - "Block medium threshold and above.", - "Block only high threshold (i.e. block less).", - "Block none.", - "Turn off the safety filter." + "The harm block threshold is unspecified.", + "Block content with a low harm probability or higher.", + "Block content with a medium harm probability or higher.", + "Block content with a high harm probability.", + "Do not block any content, regardless of its harm probability.", + "Turn off the safety filter entirely." ], "type": "string" } @@ -53600,15 +53886,15 @@ "type": "object" }, "GoogleCloudAiplatformV1SearchEntryPoint": { - "description": "Google search entry point.", + "description": "An entry point for displaying Google Search results. A `SearchEntryPoint` is populated when the grounding source for a model's response is Google Search. It provides information that you can use to display the search results in your application.", "id": "GoogleCloudAiplatformV1SearchEntryPoint", "properties": { "renderedContent": { - "description": "Optional. Web content snippet that can be embedded in a web page or an app webview.", + "description": "Optional. An HTML snippet that can be embedded in a web page or an application's webview. This snippet displays a search result, including the title, URL, and a brief description of the search result.", "type": "string" }, "sdkBlob": { - "description": "Optional. Base64 encoded JSON representing array of tuple.", + "description": "Optional. A base64-encoded JSON object that contains a list of search queries and their corresponding search URLs. This information can be used to build a custom search UI.", "format": "byte", "type": "string" } @@ -53816,29 +54102,29 @@ "type": "object" }, "GoogleCloudAiplatformV1Segment": { - "description": "Segment of the content.", + "description": "A segment of the content.", "id": "GoogleCloudAiplatformV1Segment", "properties": { "endIndex": { - "description": "Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero.", + "description": "Output only. The end index of the segment in the `Part`, measured in bytes. This marks the end of the segment and is exclusive, meaning the segment includes content up to, but not including, the byte at this index.", "format": "int32", "readOnly": true, "type": "integer" }, "partIndex": { - "description": "Output only. The index of a Part object within its parent Content object.", + "description": "Output only. The index of the `Part` object that this segment belongs to. This is useful for associating the segment with a specific part of the content.", "format": "int32", "readOnly": true, "type": "integer" }, "startIndex": { - "description": "Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero.", + "description": "Output only. The start index of the segment in the `Part`, measured in bytes. This marks the beginning of the segment and is inclusive, meaning the byte at this index is the first byte of the segment.", "format": "int32", "readOnly": true, "type": "integer" }, "text": { - "description": "Output only. The text corresponding to the segment from the response.", + "description": "Output only. The text of the segment.", "readOnly": true, "type": "string" } @@ -54004,7 +54290,7 @@ "type": "object" }, "GoogleCloudAiplatformV1SpeakerVoiceConfig": { - "description": "Configuration for a single speaker in a multi speaker setup.", + "description": "Configuration for a single speaker in a multi-speaker setup.", "id": "GoogleCloudAiplatformV1SpeakerVoiceConfig", "properties": { "speaker": { @@ -54105,11 +54391,11 @@ "type": "object" }, "GoogleCloudAiplatformV1SpeechConfig": { - "description": "The speech generation config.", + "description": "Configuration for speech generation.", "id": "GoogleCloudAiplatformV1SpeechConfig", "properties": { "languageCode": { - "description": "Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.", + "description": "Optional. The language code (ISO 639-1) for the speech synthesis.", "type": "string" }, "multiSpeakerVoiceConfig": { @@ -54118,7 +54404,7 @@ }, "voiceConfig": { "$ref": "GoogleCloudAiplatformV1VoiceConfig", - "description": "The configuration for the speaker to use." + "description": "The configuration for the voice to use." } }, "type": "object" @@ -57158,6 +57444,11 @@ "description": "The tuning data statistic values for TuningJob.", "id": "GoogleCloudAiplatformV1TuningDataStats", "properties": { + "preferenceOptimizationDataStats": { + "$ref": "GoogleCloudAiplatformV1PreferenceOptimizationDataStats", + "description": "Output only. Statistics for preference optimization.", + "readOnly": true + }, "supervisedTuningDataStats": { "$ref": "GoogleCloudAiplatformV1SupervisedTuningDataStats", "description": "The SFT Tuning data stats." @@ -57219,6 +57510,10 @@ "$ref": "GoogleCloudAiplatformV1PreTunedModel", "description": "The pre-tuned model for continuous tuning." }, + "preferenceOptimizationSpec": { + "$ref": "GoogleCloudAiplatformV1PreferenceOptimizationSpec", + "description": "Tuning Spec for Preference Optimization." + }, "serviceAccount": { "description": "The service account that the tuningJob workload runs as. If not specified, the Vertex AI Secure Fine-Tuned Service Agent in the project will be used. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-secure-fine-tuning-service-agent Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account.", "type": "string" @@ -57689,11 +57984,11 @@ "type": "object" }, "GoogleCloudAiplatformV1UrlContextMetadata": { - "description": "Metadata related to url context retrieval tool.", + "description": "Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL.", "id": "GoogleCloudAiplatformV1UrlContextMetadata", "properties": { "urlMetadata": { - "description": "Output only. List of url context.", + "description": "Output only. A list of URL metadata, with one entry for each URL retrieved by the tool.", "items": { "$ref": "GoogleCloudAiplatformV1UrlMetadata" }, @@ -57704,15 +57999,15 @@ "type": "object" }, "GoogleCloudAiplatformV1UrlMetadata": { - "description": "Context of the a single url retrieval.", + "description": "The metadata for a single URL retrieval.", "id": "GoogleCloudAiplatformV1UrlMetadata", "properties": { "retrievedUrl": { - "description": "Retrieved url by the tool.", + "description": "The URL retrieved by the tool.", "type": "string" }, "urlRetrievalStatus": { - "description": "Status of the url retrieval.", + "description": "The status of the URL retrieval.", "enum": [ "URL_RETRIEVAL_STATUS_UNSPECIFIED", "URL_RETRIEVAL_STATUS_SUCCESS", @@ -57720,8 +58015,8 @@ ], "enumDescriptions": [ "Default value. This value is unused.", - "Url retrieval is successful.", - "Url retrieval is failed due to error." + "The URL was retrieved successfully.", + "The URL retrieval failed." ], "type": "string" } @@ -57961,7 +58256,7 @@ "type": "object" }, "GoogleCloudAiplatformV1VideoMetadata": { - "description": "Metadata describes the input video content.", + "description": "Provides metadata for a video, including the start and end offsets for clipping and the frame rate.", "id": "GoogleCloudAiplatformV1VideoMetadata", "properties": { "endOffset": { @@ -57970,7 +58265,7 @@ "type": "string" }, "fps": { - "description": "Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].", + "description": "Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0].", "format": "double", "type": "number" }, @@ -57983,12 +58278,12 @@ "type": "object" }, "GoogleCloudAiplatformV1VoiceConfig": { - "description": "The configuration for the voice to use.", + "description": "Configuration for a voice.", "id": "GoogleCloudAiplatformV1VoiceConfig", "properties": { "prebuiltVoiceConfig": { "$ref": "GoogleCloudAiplatformV1PrebuiltVoiceConfig", - "description": "The configuration for the prebuilt voice to use." + "description": "The configuration for a prebuilt voice." } }, "type": "object" diff --git a/aiplatform/v1/aiplatform-gen.go b/aiplatform/v1/aiplatform-gen.go index 2585161728..5b4e177958 100644 --- a/aiplatform/v1/aiplatform-gen.go +++ b/aiplatform/v1/aiplatform-gen.go @@ -5435,15 +5435,16 @@ func (s GoogleCloudAiplatformV1BleuSpec) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// GoogleCloudAiplatformV1Blob: Content blob. +// GoogleCloudAiplatformV1Blob: A content blob. A Blob contains data of a +// specific media type. It is used to represent images, audio, and video. type GoogleCloudAiplatformV1Blob struct { - // Data: Required. Raw bytes. + // Data: Required. The raw bytes of the data. Data string `json:"data,omitempty"` - // DisplayName: Optional. Display name of the blob. Used to provide a label or - // filename to distinguish blobs. This field is only returned in PromptMessage - // for prompt management. It is currently used in the Gemini GenerateContent - // calls only when server side tools (code_execution, google_search, and - // url_context) are enabled. + // DisplayName: Optional. The display name of the blob. Used to provide a label + // or filename to distinguish blobs. This field is only returned in + // `PromptMessage` for prompt management. It is used in the Gemini calls only + // when server-side tools (`code_execution`, `google_search`, and + // `url_context`) are enabled. DisplayName string `json:"displayName,omitempty"` // MimeType: Required. The IANA standard MIME type of the source data. MimeType string `json:"mimeType,omitempty"` @@ -5701,65 +5702,73 @@ type GoogleCloudAiplatformV1CancelTuningJobRequest struct { // GoogleCloudAiplatformV1Candidate: A response candidate generated from the // model. type GoogleCloudAiplatformV1Candidate struct { - // AvgLogprobs: Output only. Average log probability score of the candidate. + // AvgLogprobs: Output only. The average log probability of the tokens in this + // candidate. This is a length-normalized score that can be used to compare the + // quality of candidates of different lengths. A higher average log probability + // suggests a more confident and coherent response. AvgLogprobs float64 `json:"avgLogprobs,omitempty"` - // CitationMetadata: Output only. Source attribution of the generated content. + // CitationMetadata: Output only. A collection of citations that apply to the + // generated content. CitationMetadata *GoogleCloudAiplatformV1CitationMetadata `json:"citationMetadata,omitempty"` - // Content: Output only. Content parts of the candidate. + // Content: Output only. The content of the candidate. Content *GoogleCloudAiplatformV1Content `json:"content,omitempty"` - // FinishMessage: Output only. Describes the reason the mode stopped generating - // tokens in more detail. This is only filled when `finish_reason` is set. + // FinishMessage: Output only. Describes the reason the model stopped + // generating tokens in more detail. This field is returned only when + // `finish_reason` is set. FinishMessage string `json:"finishMessage,omitempty"` // FinishReason: Output only. The reason why the model stopped generating - // tokens. If empty, the model has not stopped generating the tokens. + // tokens. If empty, the model has not stopped generating. // // Possible values: // "FINISH_REASON_UNSPECIFIED" - The finish reason is unspecified. - // "STOP" - Token generation reached a natural stopping point or a configured - // stop sequence. - // "MAX_TOKENS" - Token generation reached the configured maximum output - // tokens. - // "SAFETY" - Token generation stopped because the content potentially - // contains safety violations. NOTE: When streaming, content is empty if - // content filters blocks the output. - // "RECITATION" - The token generation stopped because of potential - // recitation. - // "OTHER" - All other reasons that stopped the token generation. - // "BLOCKLIST" - Token generation stopped because the content contains - // forbidden terms. - // "PROHIBITED_CONTENT" - Token generation stopped for potentially containing - // prohibited content. - // "SPII" - Token generation stopped because the content potentially contains - // Sensitive Personally Identifiable Information (SPII). - // "MALFORMED_FUNCTION_CALL" - The function call generated by the model is - // syntaxtically invalid (e.g. the function call generated is not parsable). + // "STOP" - The model reached a natural stopping point or a configured stop + // sequence. + // "MAX_TOKENS" - The model generated the maximum number of tokens allowed by + // the `max_output_tokens` parameter. + // "SAFETY" - The model stopped generating because the content potentially + // violates safety policies. NOTE: When streaming, the `content` field is empty + // if content filters block the output. + // "RECITATION" - The model stopped generating because the content may be a + // recitation from a source. + // "OTHER" - The model stopped generating for a reason not otherwise + // specified. + // "BLOCKLIST" - The model stopped generating because the content contains a + // term from a configured blocklist. + // "PROHIBITED_CONTENT" - The model stopped generating because the content + // may be prohibited. + // "SPII" - The model stopped generating because the content may contain + // sensitive personally identifiable information (SPII). + // "MALFORMED_FUNCTION_CALL" - The model generated a function call that is + // syntactically invalid and can't be parsed. // "MODEL_ARMOR" - The model response was blocked by Model Armor. - // "IMAGE_SAFETY" - Token generation stopped because generated images has - // safety violations. - // "IMAGE_PROHIBITED_CONTENT" - Image generation stopped because generated - // images has other prohibited content. - // "IMAGE_RECITATION" - Image generation stopped due to recitation. - // "IMAGE_OTHER" - Image generation stopped because of other miscellaneous - // issue. - // "UNEXPECTED_TOOL_CALL" - The function call generated by the model is - // semantically invalid (e.g. a function call is generated when function - // calling is not enabled or the function is not in the function declaration). - // "NO_IMAGE" - The model was expected to generate an image, but none was - // generated. + // "IMAGE_SAFETY" - The generated image potentially violates safety policies. + // "IMAGE_PROHIBITED_CONTENT" - The generated image may contain prohibited + // content. + // "IMAGE_RECITATION" - The generated image may be a recitation from a + // source. + // "IMAGE_OTHER" - The image generation stopped for a reason not otherwise + // specified. + // "UNEXPECTED_TOOL_CALL" - The model generated a function call that is + // semantically invalid. This can happen, for example, if function calling is + // not enabled or the generated function is not in the function declaration. + // "NO_IMAGE" - The model was expected to generate an image, but didn't. FinishReason string `json:"finishReason,omitempty"` - // GroundingMetadata: Output only. Metadata specifies sources used to ground - // generated content. + // GroundingMetadata: Output only. Metadata returned when grounding is enabled. + // It contains the sources used to ground the generated content. GroundingMetadata *GoogleCloudAiplatformV1GroundingMetadata `json:"groundingMetadata,omitempty"` - // Index: Output only. Index of the candidate. + // Index: Output only. The 0-based index of this candidate in the list of + // generated responses. This is useful for distinguishing between multiple + // candidates when `candidate_count` > 1. Index int64 `json:"index,omitempty"` - // LogprobsResult: Output only. Log-likelihood scores for the response tokens - // and top tokens + // LogprobsResult: Output only. The detailed log probability information for + // the tokens in this candidate. This is useful for debugging, understanding + // model uncertainty, and identifying potential "hallucinations". LogprobsResult *GoogleCloudAiplatformV1LogprobsResult `json:"logprobsResult,omitempty"` - // SafetyRatings: Output only. List of ratings for the safety of a response + // SafetyRatings: Output only. A list of ratings for the safety of a response // candidate. There is at most one rating per category. SafetyRatings []*GoogleCloudAiplatformV1SafetyRating `json:"safetyRatings,omitempty"` - // UrlContextMetadata: Output only. Metadata related to url context retrieval - // tool. + // UrlContextMetadata: Output only. Metadata returned when the model uses the + // `url_context` tool to get information from a user-provided URL. UrlContextMetadata *GoogleCloudAiplatformV1UrlContextMetadata `json:"urlContextMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "AvgLogprobs") to // unconditionally include in API requests. By default, fields with empty or @@ -5949,19 +5958,20 @@ func (s GoogleCloudAiplatformV1Checkpoint) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// GoogleCloudAiplatformV1Citation: Source attributions for content. +// GoogleCloudAiplatformV1Citation: A citation for a piece of generatedcontent. type GoogleCloudAiplatformV1Citation struct { - // EndIndex: Output only. End index into the content. + // EndIndex: Output only. The end index of the citation in the content. EndIndex int64 `json:"endIndex,omitempty"` - // License: Output only. License of the attribution. + // License: Output only. The license of the source of the citation. License string `json:"license,omitempty"` - // PublicationDate: Output only. Publication date of the attribution. + // PublicationDate: Output only. The publication date of the source of the + // citation. PublicationDate *GoogleTypeDate `json:"publicationDate,omitempty"` - // StartIndex: Output only. Start index into the content. + // StartIndex: Output only. The start index of the citation in the content. StartIndex int64 `json:"startIndex,omitempty"` - // Title: Output only. Title of the attribution. + // Title: Output only. The title of the source of the citation. Title string `json:"title,omitempty"` - // Uri: Output only. Url reference of the attribution. + // Uri: Output only. The URI of the source of the citation. Uri string `json:"uri,omitempty"` // ForceSendFields is a list of field names (e.g. "EndIndex") to // unconditionally include in API requests. By default, fields with empty or @@ -5981,10 +5991,10 @@ func (s GoogleCloudAiplatformV1Citation) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// GoogleCloudAiplatformV1CitationMetadata: A collection of source attributions -// for a piece of content. +// GoogleCloudAiplatformV1CitationMetadata: A collection of citations that +// apply to a piece of generated content. type GoogleCloudAiplatformV1CitationMetadata struct { - // Citations: Output only. List of citations. + // Citations: Output only. A list of citations for the content. Citations []*GoogleCloudAiplatformV1Citation `json:"citations,omitempty"` // ForceSendFields is a list of field names (e.g. "Citations") to // unconditionally include in API requests. By default, fields with empty or @@ -6550,17 +6560,17 @@ func (s GoogleCloudAiplatformV1ContainerSpec) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// GoogleCloudAiplatformV1Content: The base structured datatype containing -// multi-part content of a message. A `Content` includes a `role` field -// designating the producer of the `Content` and a `parts` field containing -// multi-part data that contains the content of the message turn. +// GoogleCloudAiplatformV1Content: The structured data content of a message. A +// Content message contains a `role` field, which indicates the producer of the +// content, and a `parts` field, which contains the multi-part data of the +// message. type GoogleCloudAiplatformV1Content struct { - // Parts: Required. Ordered `Parts` that constitute a single message. Parts may - // have different IANA MIME types. + // Parts: Required. A list of Part objects that make up a single message. Parts + // of a message can have different MIME types. A Content message must have at + // least one Part. Parts []*GoogleCloudAiplatformV1Part `json:"parts,omitempty"` // Role: Optional. The producer of the content. Must be either 'user' or - // 'model'. Useful to set for multi-turn conversations, otherwise can be left - // blank or unset. + // 'model'. If not set, the service will default to 'user'. Role string `json:"role,omitempty"` // ForceSendFields is a list of field names (e.g. "Parts") to unconditionally // include in API requests. By default, fields with empty or default values are @@ -7689,6 +7699,39 @@ func (s GoogleCloudAiplatformV1CsvSource) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// GoogleCloudAiplatformV1CustomCodeExecutionSpec: Specificies a metric that is +// populated by evaluating user-defined Python code. +type GoogleCloudAiplatformV1CustomCodeExecutionSpec struct { + // EvaluationFunction: 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 ``` + EvaluationFunction string `json:"evaluationFunction,omitempty"` + // ForceSendFields is a list of field names (e.g. "EvaluationFunction") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "EvaluationFunction") to include + // in API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudAiplatformV1CustomCodeExecutionSpec) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudAiplatformV1CustomCodeExecutionSpec + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudAiplatformV1CustomJob: Represents a job that runs custom // workloads such as a Docker container or a Python package. A CustomJob can // have multiple worker pools and each worker pool can have its own machine and @@ -8220,6 +8263,113 @@ func (s GoogleCloudAiplatformV1Dataset) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// GoogleCloudAiplatformV1DatasetDistribution: Distribution computed over a +// tuning dataset. +type GoogleCloudAiplatformV1DatasetDistribution struct { + // Buckets: Output only. Defines the histogram bucket. + Buckets []*GoogleCloudAiplatformV1DatasetDistributionDistributionBucket `json:"buckets,omitempty"` + // Max: Output only. The maximum of the population values. + Max float64 `json:"max,omitempty"` + // Mean: Output only. The arithmetic mean of the values in the population. + Mean float64 `json:"mean,omitempty"` + // Median: Output only. The median of the values in the population. + Median float64 `json:"median,omitempty"` + // Min: Output only. The minimum of the population values. + Min float64 `json:"min,omitempty"` + // P5: Output only. The 5th percentile of the values in the population. + P5 float64 `json:"p5,omitempty"` + // P95: Output only. The 95th percentile of the values in the population. + P95 float64 `json:"p95,omitempty"` + // Sum: Output only. Sum of a given population of values. + Sum float64 `json:"sum,omitempty"` + // ForceSendFields is a list of field names (e.g. "Buckets") to unconditionally + // include in API requests. By default, fields with empty or default values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "Buckets") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudAiplatformV1DatasetDistribution) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudAiplatformV1DatasetDistribution + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + +func (s *GoogleCloudAiplatformV1DatasetDistribution) UnmarshalJSON(data []byte) error { + type NoMethod GoogleCloudAiplatformV1DatasetDistribution + var s1 struct { + Max gensupport.JSONFloat64 `json:"max"` + Mean gensupport.JSONFloat64 `json:"mean"` + Median gensupport.JSONFloat64 `json:"median"` + Min gensupport.JSONFloat64 `json:"min"` + P5 gensupport.JSONFloat64 `json:"p5"` + P95 gensupport.JSONFloat64 `json:"p95"` + Sum gensupport.JSONFloat64 `json:"sum"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.Max = float64(s1.Max) + s.Mean = float64(s1.Mean) + s.Median = float64(s1.Median) + s.Min = float64(s1.Min) + s.P5 = float64(s1.P5) + s.P95 = float64(s1.P95) + s.Sum = float64(s1.Sum) + return nil +} + +// GoogleCloudAiplatformV1DatasetDistributionDistributionBucket: Dataset bucket +// used to create a histogram for the distribution given a population of +// values. +type GoogleCloudAiplatformV1DatasetDistributionDistributionBucket struct { + // Count: Output only. Number of values in the bucket. + Count int64 `json:"count,omitempty,string"` + // Left: Output only. Left bound of the bucket. + Left float64 `json:"left,omitempty"` + // Right: Output only. Right bound of the bucket. + Right float64 `json:"right,omitempty"` + // ForceSendFields is a list of field names (e.g. "Count") to unconditionally + // include in API requests. By default, fields with empty or default values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "Count") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudAiplatformV1DatasetDistributionDistributionBucket) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudAiplatformV1DatasetDistributionDistributionBucket + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + +func (s *GoogleCloudAiplatformV1DatasetDistributionDistributionBucket) UnmarshalJSON(data []byte) error { + type NoMethod GoogleCloudAiplatformV1DatasetDistributionDistributionBucket + var s1 struct { + Left gensupport.JSONFloat64 `json:"left"` + Right gensupport.JSONFloat64 `json:"right"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.Left = float64(s1.Left) + s.Right = float64(s1.Right) + return nil +} + // GoogleCloudAiplatformV1DatasetVersion: Describes the dataset version. type GoogleCloudAiplatformV1DatasetVersion struct { // BigQueryDatasetName: Output only. Name of the associated BigQuery dataset. @@ -15152,15 +15302,17 @@ func (s GoogleCloudAiplatformV1FetchPredictOperationRequest) MarshalJSON() ([]by return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// GoogleCloudAiplatformV1FileData: URI based data. +// GoogleCloudAiplatformV1FileData: URI-based data. A FileData message contains +// a URI pointing to data of a specific media type. It is used to represent +// images, audio, and video stored in Google Cloud Storage. type GoogleCloudAiplatformV1FileData struct { - // DisplayName: Optional. Display name of the file data. Used to provide a - // label or filename to distinguish file datas. This field is only returned in - // PromptMessage for prompt management. It is currently used in the Gemini - // GenerateContent calls only when server side tools (code_execution, - // google_search, and url_context) are enabled. + // DisplayName: Optional. The display name of the file. Used to provide a label + // or filename to distinguish files. This field is only returned in + // `PromptMessage` for prompt management. It is used in the Gemini calls only + // when server side tools (`code_execution`, `google_search`, and + // `url_context`) are enabled. DisplayName string `json:"displayName,omitempty"` - // FileUri: Required. URI. + // FileUri: Required. The URI of the file in Google Cloud Storage. FileUri string `json:"fileUri,omitempty"` // MimeType: Required. The IANA standard MIME type of the source data. MimeType string `json:"mimeType,omitempty"` @@ -16093,6 +16245,70 @@ func (s GoogleCloudAiplatformV1GdcConfig) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// GoogleCloudAiplatformV1GeminiPreferenceExample: Input example for preference +// optimization. +type GoogleCloudAiplatformV1GeminiPreferenceExample struct { + // Completions: List of completions for a given prompt. + Completions []*GoogleCloudAiplatformV1GeminiPreferenceExampleCompletion `json:"completions,omitempty"` + // Contents: Multi-turn contents that represents the Prompt. + Contents []*GoogleCloudAiplatformV1Content `json:"contents,omitempty"` + // ForceSendFields is a list of field names (e.g. "Completions") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "Completions") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudAiplatformV1GeminiPreferenceExample) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudAiplatformV1GeminiPreferenceExample + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudAiplatformV1GeminiPreferenceExampleCompletion: Completion and its +// preference score. +type GoogleCloudAiplatformV1GeminiPreferenceExampleCompletion struct { + // Completion: Single turn completion for the given prompt. + Completion *GoogleCloudAiplatformV1Content `json:"completion,omitempty"` + // Score: The score for the given completion. + Score float64 `json:"score,omitempty"` + // ForceSendFields is a list of field names (e.g. "Completion") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "Completion") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudAiplatformV1GeminiPreferenceExampleCompletion) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudAiplatformV1GeminiPreferenceExampleCompletion + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + +func (s *GoogleCloudAiplatformV1GeminiPreferenceExampleCompletion) UnmarshalJSON(data []byte) error { + type NoMethod GoogleCloudAiplatformV1GeminiPreferenceExampleCompletion + var s1 struct { + Score gensupport.JSONFloat64 `json:"score"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.Score = float64(s1.Score) + return nil +} + // GoogleCloudAiplatformV1GenAiAdvancedFeaturesConfig: Configuration for // GenAiAdvancedFeatures. type GoogleCloudAiplatformV1GenAiAdvancedFeaturesConfig struct { @@ -16559,27 +16775,46 @@ func (s GoogleCloudAiplatformV1GenerateVideoResponseVideo) MarshalJSON() ([]byte return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// GoogleCloudAiplatformV1GenerationConfig: Generation config. +// 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. type GoogleCloudAiplatformV1GenerationConfig struct { - // AudioTimestamp: Optional. If enabled, audio timestamp will be included in - // the request to the model. + // AudioTimestamp: 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. AudioTimestamp bool `json:"audioTimestamp,omitempty"` - // CandidateCount: Optional. Number of candidates to generate. + // CandidateCount: 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. CandidateCount int64 `json:"candidateCount,omitempty"` // EnableAffectiveDialog: Optional. If enabled, the model will detect emotions - // and adapt its responses accordingly. + // and adapt its responses accordingly. For example, if the model detects that + // the user is frustrated, it may provide a more empathetic response. EnableAffectiveDialog bool `json:"enableAffectiveDialog,omitempty"` - // FrequencyPenalty: Optional. Frequency penalties. + // FrequencyPenalty: 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]. FrequencyPenalty float64 `json:"frequencyPenalty,omitempty"` // ImageConfig: Optional. Config for image generation features. ImageConfig *GoogleCloudAiplatformV1ImageConfig `json:"imageConfig,omitempty"` - // Logprobs: Optional. Logit probabilities. + // Logprobs: 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. Logprobs int64 `json:"logprobs,omitempty"` - // MaxOutputTokens: Optional. The maximum number of output tokens to generate - // per message. + // MaxOutputTokens: 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. MaxOutputTokens int64 `json:"maxOutputTokens,omitempty"` - // MediaResolution: Optional. If specified, the media resolution specified will - // be used. + // MediaResolution: 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. // // Possible values: // "MEDIA_RESOLUTION_UNSPECIFIED" - Media resolution has not been set. @@ -16588,33 +16823,29 @@ type GoogleCloudAiplatformV1GenerationConfig struct { // "MEDIA_RESOLUTION_HIGH" - Media resolution set to high (zoomed reframing // with 256 tokens). MediaResolution string `json:"mediaResolution,omitempty"` - // PresencePenalty: Optional. Positive penalties. + // PresencePenalty: 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]. PresencePenalty float64 `json:"presencePenalty,omitempty"` - // ResponseJsonSchema: Optional. Output schema of the generated response. This - // is an alternative to `response_schema` that accepts JSON Schema - // (https://json-schema.org/). If set, `response_schema` must be omitted, but - // `response_mime_type` is required. While the full JSON Schema may be sent, - // not all features are supported. Specifically, only the following properties - // are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - - // `title` - `description` - `enum` (for strings and numbers) - `items` - - // `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - - // `oneOf` (interpreted the same as `anyOf`) - `properties` - - // `additionalProperties` - `required` The non-standard `propertyOrdering` - // property may also be set. Cyclic references are unrolled to a limited degree - // and, as such, may only be used within non-required properties. (Nullable - // properties are not sufficient.) If `$ref` is set on a sub-schema, no other - // properties, except for than those starting as a `$`, may be set. + // ResponseJsonSchema: Optional. When this field is set, response_schema must + // be omitted and response_mime_type must be set to `application/json`. ResponseJsonSchema interface{} `json:"responseJsonSchema,omitempty"` - // ResponseLogprobs: Optional. If true, export the logprobs results in - // response. + // ResponseLogprobs: 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. ResponseLogprobs bool `json:"responseLogprobs,omitempty"` - // ResponseMimeType: Optional. Output response mimetype of the generated - // candidate text. Supported mimetype: - `text/plain`: (default) Text output. - - // `application/json`: JSON response in the candidates. The model needs to be + // ResponseMimeType: 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. This is a preview feature. ResponseMimeType string `json:"responseMimeType,omitempty"` - // ResponseModalities: Optional. The modalities of the response. + // ResponseModalities: 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. // // Possible values: // "MODALITY_UNSPECIFIED" - Unspecified modality. Will be processed as text. @@ -16622,29 +16853,51 @@ type GoogleCloudAiplatformV1GenerationConfig struct { // "IMAGE" - Image modality. // "AUDIO" - Audio modality. ResponseModalities []string `json:"responseModalities,omitempty"` - // ResponseSchema: Optional. The `Schema` object allows the definition of input - // and output data types. These types can be objects, but also primitives and - // arrays. Represents a select subset of an OpenAPI 3.0 schema object - // (https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible - // response_mime_type must also be set. Compatible mimetypes: - // `application/json`: Schema for JSON response. + // ResponseSchema: Optional. Lets you to specify a schema for the model's + // response, ensuring that the output conforms to a particular structure. This + // is useful for generating structured data such as JSON. The schema is a + // subset of the OpenAPI 3.0 schema object + // (https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is + // set, you must also set the `response_mime_type` to `application/json`. ResponseSchema *GoogleCloudAiplatformV1Schema `json:"responseSchema,omitempty"` // RoutingConfig: Optional. Routing configuration. RoutingConfig *GoogleCloudAiplatformV1GenerationConfigRoutingConfig `json:"routingConfig,omitempty"` - // Seed: Optional. Seed. + // Seed: 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. Seed int64 `json:"seed,omitempty"` // SpeechConfig: Optional. The speech generation config. SpeechConfig *GoogleCloudAiplatformV1SpeechConfig `json:"speechConfig,omitempty"` - // StopSequences: Optional. Stop sequences. + // StopSequences: 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. StopSequences []string `json:"stopSequences,omitempty"` - // Temperature: Optional. Controls the randomness of predictions. + // Temperature: 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]. Temperature float64 `json:"temperature,omitempty"` - // ThinkingConfig: Optional. Config for thinking features. An error will be - // returned if this field is set for models that don't support thinking. + // ThinkingConfig: Optional. Configuration for thinking features. An error will + // be returned if this field is set for models that don't support thinking. ThinkingConfig *GoogleCloudAiplatformV1GenerationConfigThinkingConfig `json:"thinkingConfig,omitempty"` - // TopK: Optional. If specified, top-k sampling will be used. + // TopK: 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. TopK float64 `json:"topK,omitempty"` - // TopP: Optional. If specified, nucleus sampling will be used. + // TopP: 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. TopP float64 `json:"topP,omitempty"` // ForceSendFields is a list of field names (e.g. "AudioTimestamp") to // unconditionally include in API requests. By default, fields with empty or @@ -16687,11 +16940,14 @@ func (s *GoogleCloudAiplatformV1GenerationConfig) UnmarshalJSON(data []byte) err } // GoogleCloudAiplatformV1GenerationConfigRoutingConfig: The configuration for -// routing the request to a specific model. +// 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. type GoogleCloudAiplatformV1GenerationConfigRoutingConfig struct { - // AutoMode: Automated routing. + // AutoMode: In this mode, the model is selected automatically based on the + // content of the request. AutoMode *GoogleCloudAiplatformV1GenerationConfigRoutingConfigAutoRoutingMode `json:"autoMode,omitempty"` - // ManualMode: Manual routing. + // ManualMode: In this mode, the model is specified manually. ManualMode *GoogleCloudAiplatformV1GenerationConfigRoutingConfigManualRoutingMode `json:"manualMode,omitempty"` // ForceSendFields is a list of field names (e.g. "AutoMode") to // unconditionally include in API requests. By default, fields with empty or @@ -16711,17 +16967,20 @@ func (s GoogleCloudAiplatformV1GenerationConfigRoutingConfig) MarshalJSON() ([]b return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// GoogleCloudAiplatformV1GenerationConfigRoutingConfigAutoRoutingMode: When -// automated routing is specified, the routing will be determined by the -// pretrained routing model and customer provided model routing preference. +// 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. type GoogleCloudAiplatformV1GenerationConfigRoutingConfigAutoRoutingMode struct { // ModelRoutingPreference: The model routing preference. // // Possible values: // "UNKNOWN" - Unspecified model routing preference. - // "PRIORITIZE_QUALITY" - Prefer higher quality over low cost. - // "BALANCED" - Balanced model routing preference. - // "PRIORITIZE_COST" - Prefer lower cost over higher quality. + // "PRIORITIZE_QUALITY" - The model will be selected to prioritize the + // quality of the response. + // "BALANCED" - The model will be selected to balance quality and cost. + // "PRIORITIZE_COST" - The model will be selected to prioritize the cost of + // the request. ModelRoutingPreference string `json:"modelRoutingPreference,omitempty"` // ForceSendFields is a list of field names (e.g. "ModelRoutingPreference") to // unconditionally include in API requests. By default, fields with empty or @@ -16741,12 +17000,12 @@ func (s GoogleCloudAiplatformV1GenerationConfigRoutingConfigAutoRoutingMode) Mar return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// GoogleCloudAiplatformV1GenerationConfigRoutingConfigManualRoutingMode: When -// manual routing is set, the specified model will be used directly. +// GoogleCloudAiplatformV1GenerationConfigRoutingConfigManualRoutingMode: The +// configuration for manual routing. When manual routing is specified, the +// model will be selected based on the model name provided. type GoogleCloudAiplatformV1GenerationConfigRoutingConfigManualRoutingMode struct { - // ModelName: The model name to use. Only the public LLM models are accepted. - // See Supported models - // (https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + // ModelName: The name of the model to use. Only public LLM models are + // accepted. ModelName string `json:"modelName,omitempty"` // ForceSendFields is a list of field names (e.g. "ModelName") to // unconditionally include in API requests. By default, fields with empty or @@ -16766,13 +17025,21 @@ func (s GoogleCloudAiplatformV1GenerationConfigRoutingConfigManualRoutingMode) M return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// GoogleCloudAiplatformV1GenerationConfigThinkingConfig: Config for thinking -// features. +// 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. type GoogleCloudAiplatformV1GenerationConfigThinkingConfig struct { - // IncludeThoughts: Optional. Indicates whether to include thoughts in the - // response. If true, thoughts are returned only when available. + // IncludeThoughts: 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. IncludeThoughts bool `json:"includeThoughts,omitempty"` - // ThinkingBudget: Optional. Indicates the thinking budget in tokens. + // ThinkingBudget: 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. ThinkingBudget int64 `json:"thinkingBudget,omitempty"` // ForceSendFields is a list of field names (e.g. "IncludeThoughts") to // unconditionally include in API requests. By default, fields with empty or @@ -17060,14 +17327,20 @@ func (s GoogleCloudAiplatformV1GroundednessSpec) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// GoogleCloudAiplatformV1GroundingChunk: Grounding chunk. +// GoogleCloudAiplatformV1GroundingChunk: A piece of evidence that supports a +// claim made by the model. This is used to show a citation for a claim made by +// the model. When grounding is enabled, the model returns a `GroundingChunk` +// that contains a reference to the source of the information. type GoogleCloudAiplatformV1GroundingChunk struct { - // Maps: Grounding chunk from Google Maps. + // Maps: A grounding chunk from Google Maps. See the `Maps` message for + // details. Maps *GoogleCloudAiplatformV1GroundingChunkMaps `json:"maps,omitempty"` - // RetrievedContext: Grounding chunk from context retrieved by the retrieval - // tools. + // RetrievedContext: A grounding chunk from a data source retrieved by a + // retrieval tool, such as Vertex AI Search. See the `RetrievedContext` message + // for details RetrievedContext *GoogleCloudAiplatformV1GroundingChunkRetrievedContext `json:"retrievedContext,omitempty"` - // Web: Grounding chunk from the web. + // Web: A grounding chunk from a web page, typically from Google Search. See + // the `Web` message for details. Web *GoogleCloudAiplatformV1GroundingChunkWeb `json:"web,omitempty"` // ForceSendFields is a list of field names (e.g. "Maps") to unconditionally // include in API requests. By default, fields with empty or default values are @@ -17087,20 +17360,23 @@ func (s GoogleCloudAiplatformV1GroundingChunk) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// GoogleCloudAiplatformV1GroundingChunkMaps: Chunk from Google Maps. +// GoogleCloudAiplatformV1GroundingChunkMaps: A `Maps` chunk is a piece of +// evidence that comes from Google Maps. It contains information about a place, +// such as its name, address, and reviews. This is used to provide the user +// with rich, location-based information. type GoogleCloudAiplatformV1GroundingChunkMaps struct { - // PlaceAnswerSources: Sources used to generate the place answer. This includes - // review snippets and photos that were used to generate the answer, as well as - // uris to flag content. + // PlaceAnswerSources: The sources that were used to generate the place answer. + // This includes review snippets and photos that were used to generate the + // answer, as well as URIs to flag content. PlaceAnswerSources *GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSources `json:"placeAnswerSources,omitempty"` - // PlaceId: This Place's resource name, in `places/{place_id}` format. Can be - // used to look up the Place. + // PlaceId: This Place's resource name, in `places/{place_id}` format. This can + // be used to look up the place in the Google Maps API. PlaceId string `json:"placeId,omitempty"` - // Text: Text of the place answer. + // Text: The text of the place answer. Text string `json:"text,omitempty"` - // Title: Title of the place. + // Title: The title of the place. Title string `json:"title,omitempty"` - // Uri: URI reference of the place. + // Uri: The URI of the place. Uri string `json:"uri,omitempty"` // ForceSendFields is a list of field names (e.g. "PlaceAnswerSources") to // unconditionally include in API requests. By default, fields with empty or @@ -17120,10 +17396,12 @@ func (s GoogleCloudAiplatformV1GroundingChunkMaps) MarshalJSON() ([]byte, error) return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSources: Sources used to -// generate the place answer. +// GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSources: The sources +// that were used to generate the place answer. This includes review snippets +// and photos that were used to generate the answer, as well as URIs to flag +// content. type GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSources struct { - // ReviewSnippets: Snippets of reviews that are used to generate the answer. + // ReviewSnippets: Snippets of reviews that were used to generate the answer. ReviewSnippets []*GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet `json:"reviewSnippets,omitempty"` // ForceSendFields is a list of field names (e.g. "ReviewSnippets") to // unconditionally include in API requests. By default, fields with empty or @@ -17143,14 +17421,14 @@ func (s GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSources) MarshalJSON return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet: -// Encapsulates a review snippet. +// GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet: A +// review snippet that is used to generate the answer. type GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet struct { // GoogleMapsUri: A link to show the review on Google Maps. GoogleMapsUri string `json:"googleMapsUri,omitempty"` - // ReviewId: Id of the review referencing the place. + // ReviewId: The ID of the review that is being referenced. ReviewId string `json:"reviewId,omitempty"` - // Title: Title of the review. + // Title: The title of the review. Title string `json:"title,omitempty"` // ForceSendFields is a list of field names (e.g. "GoogleMapsUri") to // unconditionally include in API requests. By default, fields with empty or @@ -17170,20 +17448,26 @@ func (s GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// GoogleCloudAiplatformV1GroundingChunkRetrievedContext: Chunk from context -// retrieved by the retrieval tools. +// GoogleCloudAiplatformV1GroundingChunkRetrievedContext: Context retrieved +// from a data source to ground the model's response. This is used when a +// retrieval tool fetches information from a user-provided corpus or a public +// dataset. type GoogleCloudAiplatformV1GroundingChunkRetrievedContext struct { - // DocumentName: Output only. The full document name for the referenced Vertex - // AI Search document. + // DocumentName: Output only. The full resource name of the referenced Vertex + // AI Search document. This is used to identify the specific document that was + // retrieved. The format is + // `projects/{project}/locations/{location}/collections/{collection}/dataStores/ + // {data_store}/branches/{branch}/documents/{document}`. DocumentName string `json:"documentName,omitempty"` - // RagChunk: Additional context for the RAG retrieval result. This is only - // populated when using the RAG retrieval tool. + // RagChunk: Additional context for a Retrieval-Augmented Generation (RAG) + // retrieval result. This is populated only when the RAG retrieval tool is + // used. RagChunk *GoogleCloudAiplatformV1RagChunk `json:"ragChunk,omitempty"` - // Text: Text of the attribution. + // Text: The content of the retrieved data source. Text string `json:"text,omitempty"` - // Title: Title of the attribution. + // Title: The title of the retrieved data source. Title string `json:"title,omitempty"` - // Uri: URI reference of the attribution. + // Uri: The URI of the retrieved data source. Uri string `json:"uri,omitempty"` // ForceSendFields is a list of field names (e.g. "DocumentName") to // unconditionally include in API requests. By default, fields with empty or @@ -17203,13 +17487,17 @@ func (s GoogleCloudAiplatformV1GroundingChunkRetrievedContext) MarshalJSON() ([] return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// GoogleCloudAiplatformV1GroundingChunkWeb: Chunk from the web. +// GoogleCloudAiplatformV1GroundingChunkWeb: A `Web` chunk is a piece of +// evidence that comes from a web page. It contains the URI of the web page, +// the title of the page, and the domain of the page. This is used to provide +// the user with a link to the source of the information. type GoogleCloudAiplatformV1GroundingChunkWeb struct { - // Domain: Domain of the (original) URI. + // Domain: The domain of the web page that contains the evidence. This can be + // used to filter out low-quality sources. Domain string `json:"domain,omitempty"` - // Title: Title of the chunk. + // Title: The title of the web page that contains the evidence. Title string `json:"title,omitempty"` - // Uri: URI reference of the chunk. + // Uri: The URI of the web page that contains the evidence. Uri string `json:"uri,omitempty"` // ForceSendFields is a list of field names (e.g. "Domain") to unconditionally // include in API requests. By default, fields with empty or default values are @@ -17229,29 +17517,37 @@ func (s GoogleCloudAiplatformV1GroundingChunkWeb) MarshalJSON() ([]byte, error) return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// GoogleCloudAiplatformV1GroundingMetadata: Metadata returned to client when -// grounding is enabled. +// GoogleCloudAiplatformV1GroundingMetadata: Information about the sources that +// support the content of a response. When grounding is enabled, the model +// returns citations for claims in the response. This object contains the +// retrieved sources. type GoogleCloudAiplatformV1GroundingMetadata struct { - // GoogleMapsWidgetContextToken: Optional. Output only. Resource name of the - // Google Maps widget context token to be used with the PlacesContextElement - // widget to render contextual data. This is populated only for Google Maps - // grounding. + // GoogleMapsWidgetContextToken: Optional. Output only. A token that can be + // used to render a Google Maps widget with the contextual data. This field is + // populated only when the grounding source is Google Maps. GoogleMapsWidgetContextToken string `json:"googleMapsWidgetContextToken,omitempty"` - // GroundingChunks: List of supporting references retrieved from specified - // grounding source. + // GroundingChunks: A list of supporting references retrieved from the + // grounding source. This field is populated when the grounding source is + // Google Search, Vertex AI Search, or Google Maps. GroundingChunks []*GoogleCloudAiplatformV1GroundingChunk `json:"groundingChunks,omitempty"` - // GroundingSupports: Optional. List of grounding support. + // GroundingSupports: Optional. A list of grounding supports that connect the + // generated content to the grounding chunks. This field is populated when the + // grounding source is Google Search or Vertex AI Search. GroundingSupports []*GoogleCloudAiplatformV1GroundingSupport `json:"groundingSupports,omitempty"` - // RetrievalMetadata: Optional. Output only. Retrieval metadata. + // RetrievalMetadata: Optional. Output only. Metadata related to the retrieval + // grounding source. RetrievalMetadata *GoogleCloudAiplatformV1RetrievalMetadata `json:"retrievalMetadata,omitempty"` - // SearchEntryPoint: Optional. Google search entry for the following-up web - // searches. + // SearchEntryPoint: Optional. A web search entry point that can be used to + // display search results. This field is populated only when the grounding + // source is Google Search. SearchEntryPoint *GoogleCloudAiplatformV1SearchEntryPoint `json:"searchEntryPoint,omitempty"` - // SourceFlaggingUris: Optional. Output only. List of source flagging uris. - // This is currently populated only for Google Maps grounding. + // SourceFlaggingUris: Optional. Output only. A list of URIs that can be used + // to flag a place or review for inappropriate content. This field is populated + // only when the grounding source is Google Maps. SourceFlaggingUris []*GoogleCloudAiplatformV1GroundingMetadataSourceFlaggingUri `json:"sourceFlaggingUris,omitempty"` - // WebSearchQueries: Optional. Web search queries for the following-up web - // search. + // WebSearchQueries: Optional. The web search queries that were used to + // generate the content. This field is populated only when the grounding source + // is Google Search. WebSearchQueries []string `json:"webSearchQueries,omitempty"` // ForceSendFields is a list of field names (e.g. // "GoogleMapsWidgetContextToken") to unconditionally include in API requests. @@ -17271,14 +17567,13 @@ func (s GoogleCloudAiplatformV1GroundingMetadata) MarshalJSON() ([]byte, error) return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// GoogleCloudAiplatformV1GroundingMetadataSourceFlaggingUri: Source content -// flagging uri for a place or review. This is currently populated only for -// Google Maps grounding. +// GoogleCloudAiplatformV1GroundingMetadataSourceFlaggingUri: A URI that can be +// used to flag a place or review for inappropriate content. This is populated +// only when the grounding source is Google Maps. type GoogleCloudAiplatformV1GroundingMetadataSourceFlaggingUri struct { - // FlagContentUri: A link where users can flag a problem with the source (place - // or review). + // FlagContentUri: The URI that can be used to flag the content. FlagContentUri string `json:"flagContentUri,omitempty"` - // SourceId: Id of the place or review. + // SourceId: The ID of the place or review. SourceId string `json:"sourceId,omitempty"` // ForceSendFields is a list of field names (e.g. "FlagContentUri") to // unconditionally include in API requests. By default, fields with empty or @@ -17298,19 +17593,23 @@ func (s GoogleCloudAiplatformV1GroundingMetadataSourceFlaggingUri) MarshalJSON() return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// GoogleCloudAiplatformV1GroundingSupport: Grounding support. +// GoogleCloudAiplatformV1GroundingSupport: A collection of supporting +// references for a segment of the model's response. type GoogleCloudAiplatformV1GroundingSupport struct { - // ConfidenceScores: Confidence score of the support references. Ranges from 0 - // to 1. 1 is the most confident. For Gemini 2.0 and before, this list must - // have the same size as the grounding_chunk_indices. For Gemini 2.5 and after, - // this list will be empty and should be ignored. + // ConfidenceScores: The confidence scores for the support references. This + // list is parallel to the `grounding_chunk_indices` list. A score is a value + // between 0.0 and 1.0, with a higher score indicating a higher confidence that + // the reference supports the claim. For Gemini 2.0 and before, this list has + // the same size as `grounding_chunk_indices`. For Gemini 2.5 and later, this + // list is empty and should be ignored. ConfidenceScores []float64 `json:"confidenceScores,omitempty"` - // GroundingChunkIndices: A list of indices (into 'grounding_chunk') specifying - // the citations associated with the claim. For instance [1,3,4] means that - // grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the retrieved - // content attributed to the claim. + // GroundingChunkIndices: A list of indices into the `grounding_chunks` field + // of the `GroundingMetadata` message. These indices specify which grounding + // chunks support the claim made in the content segment. For example, if this + // field has the values `[1, 3]`, it means that `grounding_chunks[1]` and + // `grounding_chunks[3]` are the sources for the claim in the content segment. GroundingChunkIndices []int64 `json:"groundingChunkIndices,omitempty"` - // Segment: Segment of the content this support belongs to. + // Segment: The content segment that this support message applies to. Segment *GoogleCloudAiplatformV1Segment `json:"segment,omitempty"` // ForceSendFields is a list of field names (e.g. "ConfidenceScores") to // unconditionally include in API requests. By default, fields with empty or @@ -17471,7 +17770,10 @@ func (s GoogleCloudAiplatformV1IdMatcher) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// GoogleCloudAiplatformV1ImageConfig: Config for image generation features. +// 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. type GoogleCloudAiplatformV1ImageConfig struct { // AspectRatio: 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" @@ -17482,10 +17784,13 @@ type GoogleCloudAiplatformV1ImageConfig struct { // PersonGeneration: Optional. Controls whether the model can generate people. // // Possible values: - // "PERSON_GENERATION_UNSPECIFIED" - Generation images of people unspecified. - // "ALLOW_ALL" - Generate images that include adults and children. - // "ALLOW_ADULT" - Generate images of adults, but not children. - // "ALLOW_NONE" - Block generation of images of people. + // "PERSON_GENERATION_UNSPECIFIED" - The default behavior is unspecified. The + // model will decide whether to generate images of people. + // "ALLOW_ALL" - Allows the model to generate images of people, including + // adults and children. + // "ALLOW_ADULT" - Allows the model to generate images of adults, but not + // children. + // "ALLOW_NONE" - Prevents the model from generating images of people. PersonGeneration string `json:"personGeneration,omitempty"` // ForceSendFields is a list of field names (e.g. "AspectRatio") to // unconditionally include in API requests. By default, fields with empty or @@ -20335,12 +20640,20 @@ func (s GoogleCloudAiplatformV1ListTuningJobsResponse) MarshalJSON() ([]byte, er return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// GoogleCloudAiplatformV1LogprobsResult: Logprobs Result +// GoogleCloudAiplatformV1LogprobsResult: The log probabilities of the tokens +// generated by the model. This is useful for understanding the model's +// confidence in its predictions and for debugging. For example, you can use +// log probabilities to identify when the model is making a less confident +// prediction or to explore alternative responses that the model considered. A +// low log probability can also indicate that the model is "hallucinating" or +// generating factually incorrect information. type GoogleCloudAiplatformV1LogprobsResult struct { - // ChosenCandidates: Length = total number of decoding steps. The chosen - // candidates may or may not be in top_candidates. + // ChosenCandidates: A list of the chosen candidate tokens at each decoding + // step. The length of this list is equal to the total number of decoding + // steps. Note that the chosen candidate might not be in `top_candidates`. ChosenCandidates []*GoogleCloudAiplatformV1LogprobsResultCandidate `json:"chosenCandidates,omitempty"` - // TopCandidates: Length = total number of decoding steps. + // TopCandidates: A list of the top candidate tokens at each decoding step. The + // length of this list is equal to the total number of decoding steps. TopCandidates []*GoogleCloudAiplatformV1LogprobsResultTopCandidates `json:"topCandidates,omitempty"` // ForceSendFields is a list of field names (e.g. "ChosenCandidates") to // unconditionally include in API requests. By default, fields with empty or @@ -20360,14 +20673,20 @@ func (s GoogleCloudAiplatformV1LogprobsResult) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// GoogleCloudAiplatformV1LogprobsResultCandidate: Candidate for the logprobs -// token and score. +// GoogleCloudAiplatformV1LogprobsResultCandidate: A single token and its +// associated log probability. type GoogleCloudAiplatformV1LogprobsResultCandidate struct { - // LogProbability: The candidate's log probability. + // LogProbability: The log probability of this token. A higher value indicates + // that the model was more confident in this token. The log probability can be + // used to assess the relative likelihood of different tokens and to identify + // when the model is uncertain. LogProbability float64 `json:"logProbability,omitempty"` - // Token: The candidate's token string value. + // Token: The token's string representation. Token string `json:"token,omitempty"` - // TokenId: The candidate's token id value. + // TokenId: The token's numerical ID. While the `token` field provides the + // string representation of the token, the `token_id` is the numerical + // representation that the model uses internally. This can be useful for + // developers who want to build custom logic based on the model's vocabulary. TokenId int64 `json:"tokenId,omitempty"` // ForceSendFields is a list of field names (e.g. "LogProbability") to // unconditionally include in API requests. By default, fields with empty or @@ -20401,10 +20720,12 @@ func (s *GoogleCloudAiplatformV1LogprobsResultCandidate) UnmarshalJSON(data []by return nil } -// GoogleCloudAiplatformV1LogprobsResultTopCandidates: Candidates with top log -// probabilities at each decoding step. +// GoogleCloudAiplatformV1LogprobsResultTopCandidates: A list of the top +// candidate tokens and their log probabilities at each decoding step. This can +// be used to see what other tokens the model considered. type GoogleCloudAiplatformV1LogprobsResultTopCandidates struct { - // Candidates: Sorted by log probability in descending order. + // Candidates: The list of candidate tokens, sorted by log probability in + // descending order. Candidates []*GoogleCloudAiplatformV1LogprobsResultCandidate `json:"candidates,omitempty"` // ForceSendFields is a list of field names (e.g. "Candidates") to // unconditionally include in API requests. By default, fields with empty or @@ -20833,6 +21154,8 @@ type GoogleCloudAiplatformV1Metric struct { AggregationMetrics []string `json:"aggregationMetrics,omitempty"` // BleuSpec: Spec for bleu metric. BleuSpec *GoogleCloudAiplatformV1BleuSpec `json:"bleuSpec,omitempty"` + // CustomCodeExecutionSpec: Spec for Custom Code Execution metric. + CustomCodeExecutionSpec *GoogleCloudAiplatformV1CustomCodeExecutionSpec `json:"customCodeExecutionSpec,omitempty"` // ExactMatchSpec: Spec for exact match metric. ExactMatchSpec *GoogleCloudAiplatformV1ExactMatchSpec `json:"exactMatchSpec,omitempty"` // LlmBasedMetricSpec: Spec for an LLM based metric. @@ -21419,20 +21742,25 @@ func (s GoogleCloudAiplatformV1MigrateResourceResponse) MarshalJSON() ([]byte, e return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// GoogleCloudAiplatformV1ModalityTokenCount: Represents token counting info -// for a single modality. +// GoogleCloudAiplatformV1ModalityTokenCount: Represents a breakdown of token +// usage by modality. This message is used in CountTokensResponse and +// GenerateContentResponse.UsageMetadata to provide a detailed view of how many +// tokens are used by each modality (e.g., text, image, video) in a request. +// This is particularly useful for multimodal models, allowing you to track and +// manage token consumption for billing and quota purposes. type GoogleCloudAiplatformV1ModalityTokenCount struct { - // Modality: The modality associated with this token count. + // Modality: The modality that this token count applies to. // // Possible values: - // "MODALITY_UNSPECIFIED" - Unspecified modality. - // "TEXT" - Plain text. - // "IMAGE" - Image. - // "VIDEO" - Video. - // "AUDIO" - Audio. - // "DOCUMENT" - Document, e.g. PDF. + // "MODALITY_UNSPECIFIED" - When a modality is not specified, it is treated + // as `TEXT`. + // "TEXT" - The `Part` contains plain text. + // "IMAGE" - The `Part` contains an image. + // "VIDEO" - The `Part` contains a video. + // "AUDIO" - The `Part` contains audio. + // "DOCUMENT" - The `Part` contains a document, such as a PDF. Modality string `json:"modality,omitempty"` - // TokenCount: Number of tokens. + // TokenCount: The number of tokens counted for this modality. TokenCount int64 `json:"tokenCount,omitempty"` // ForceSendFields is a list of field names (e.g. "Modality") to // unconditionally include in API requests. By default, fields with empty or @@ -21653,14 +21981,27 @@ func (s GoogleCloudAiplatformV1Model) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// GoogleCloudAiplatformV1ModelArmorConfig: Configuration for Model Armor -// integrations of prompt and responses. +// GoogleCloudAiplatformV1ModelArmorConfig: Configuration for Model Armor. +// Model Armor is a Google Cloud service that provides safety and security +// filtering for prompts and responses. It helps protect your AI applications +// from risks such as harmful content, sensitive data leakage, and prompt +// injection attacks. type GoogleCloudAiplatformV1ModelArmorConfig struct { - // PromptTemplateName: Optional. The name of the Model Armor template to use - // for prompt sanitization. + // PromptTemplateName: Optional. The resource name of the Model Armor template + // to use for prompt screening. A Model Armor template is a set of customized + // filters and thresholds that define how Model Armor screens content. If + // specified, Model Armor will use this template to check the user's prompt for + // safety and security risks before it is sent to the model. The name must be + // in the format + // `projects/{project}/locations/{location}/templates/{template}`. PromptTemplateName string `json:"promptTemplateName,omitempty"` - // ResponseTemplateName: Optional. The name of the Model Armor template to use - // for response sanitization. + // ResponseTemplateName: Optional. The resource name of the Model Armor + // template to use for response screening. A Model Armor template is a set of + // customized filters and thresholds that define how Model Armor screens + // content. If specified, Model Armor will use this template to check the + // model's response for safety and security risks before it is returned to the + // user. The name must be in the format + // `projects/{project}/locations/{location}/templates/{template}`. ResponseTemplateName string `json:"responseTemplateName,omitempty"` // ForceSendFields is a list of field names (e.g. "PromptTemplateName") to // unconditionally include in API requests. By default, fields with empty or @@ -23071,8 +23412,7 @@ func (s GoogleCloudAiplatformV1ModelVersionCheckpoint) MarshalJSON() ([]byte, er } // GoogleCloudAiplatformV1MultiSpeakerVoiceConfig: Configuration for a -// multi-speaker text-to-speech setup. Enables the use of up to two distinct -// voices in a single synthesis request. +// multi-speaker text-to-speech request. type GoogleCloudAiplatformV1MultiSpeakerVoiceConfig struct { // SpeakerVoiceConfigs: Required. A list of configurations for the voices of // the speakers. Exactly two speaker voice configurations must be provided. @@ -25220,33 +25560,34 @@ func (s GoogleCloudAiplatformV1PairwiseSummarizationQualitySpec) MarshalJSON() ( } // GoogleCloudAiplatformV1Part: A datatype containing media that is part of a -// multi-part `Content` message. A `Part` consists of data which has an +// multi-part Content message. A `Part` consists of data which has an // associated datatype. A `Part` can only contain one of the accepted types in -// `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type -// and subtype of the media if `inline_data` or `file_data` field is filled -// with raw bytes. +// `Part.data`. For media types that are not text, `Part` must have a fixed +// IANA MIME type identifying the type and subtype of the media if +// `inline_data` or `file_data` field is filled with raw bytes. type GoogleCloudAiplatformV1Part struct { - // CodeExecutionResult: Optional. Result of executing the [ExecutableCode]. + // CodeExecutionResult: Optional. The result of executing the ExecutableCode. CodeExecutionResult *GoogleCloudAiplatformV1CodeExecutionResult `json:"codeExecutionResult,omitempty"` - // ExecutableCode: Optional. Code generated by the model that is meant to be + // ExecutableCode: Optional. Code generated by the model that is intended to be // executed. ExecutableCode *GoogleCloudAiplatformV1ExecutableCode `json:"executableCode,omitempty"` - // FileData: Optional. URI based data. + // FileData: Optional. The URI-based data of the part. This can be used to + // include files from Google Cloud Storage. FileData *GoogleCloudAiplatformV1FileData `json:"fileData,omitempty"` - // FunctionCall: Optional. A predicted [FunctionCall] returned from the model - // that contains a string representing the [FunctionDeclaration.name] with the - // parameters and their values. + // FunctionCall: Optional. A predicted function call returned from the model. + // This contains the name of the function to call and the arguments to pass to + // the function. FunctionCall *GoogleCloudAiplatformV1FunctionCall `json:"functionCall,omitempty"` - // FunctionResponse: Optional. The result output of a [FunctionCall] that - // contains a string representing the [FunctionDeclaration.name] and a - // structured JSON object containing any output from the function call. It is - // used as context to the model. + // FunctionResponse: Optional. The result of a function call. This is used to + // provide the model with the result of a function call that it predicted. FunctionResponse *GoogleCloudAiplatformV1FunctionResponse `json:"functionResponse,omitempty"` - // InlineData: Optional. Inlined bytes data. + // InlineData: Optional. The inline data content of the part. This can be used + // to include images, audio, or video in a request. InlineData *GoogleCloudAiplatformV1Blob `json:"inlineData,omitempty"` - // Text: Optional. Text part (can be code). + // Text: Optional. The text content of the part. Text string `json:"text,omitempty"` - // Thought: Optional. Indicates if the part is thought from the model. + // Thought: Optional. Indicates whether the `part` represents the model's + // thought process or reasoning. Thought bool `json:"thought,omitempty"` // ThoughtSignature: Optional. An opaque signature for the thought so it can be // reused in subsequent requests. @@ -26121,10 +26462,10 @@ func (s GoogleCloudAiplatformV1PreTunedModel) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// GoogleCloudAiplatformV1PrebuiltVoiceConfig: The configuration for the -// prebuilt speaker to use. +// GoogleCloudAiplatformV1PrebuiltVoiceConfig: Configuration for a prebuilt +// voice. type GoogleCloudAiplatformV1PrebuiltVoiceConfig struct { - // VoiceName: The name of the preset voice to use. + // VoiceName: The name of the prebuilt voice to use. VoiceName string `json:"voiceName,omitempty"` // ForceSendFields is a list of field names (e.g. "VoiceName") to // unconditionally include in API requests. By default, fields with empty or @@ -26413,6 +26754,148 @@ func (s GoogleCloudAiplatformV1PredictSchemata) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// GoogleCloudAiplatformV1PreferenceOptimizationDataStats: Statistics computed +// for datasets used for preference optimization. +type GoogleCloudAiplatformV1PreferenceOptimizationDataStats struct { + // DroppedExampleIndices: Output only. A partial sample of the indices + // (starting from 1) of the dropped examples. + DroppedExampleIndices googleapi.Int64s `json:"droppedExampleIndices,omitempty"` + // DroppedExampleReasons: Output only. For each index in + // `dropped_example_indices`, the user-facing reason why the example was + // dropped. + DroppedExampleReasons []string `json:"droppedExampleReasons,omitempty"` + // ScoreVariancePerExampleDistribution: Output only. Dataset distributions for + // scores variance per example. + ScoreVariancePerExampleDistribution *GoogleCloudAiplatformV1DatasetDistribution `json:"scoreVariancePerExampleDistribution,omitempty"` + // ScoresDistribution: Output only. Dataset distributions for scores. + ScoresDistribution *GoogleCloudAiplatformV1DatasetDistribution `json:"scoresDistribution,omitempty"` + // TotalBillableTokenCount: Output only. Number of billable tokens in the + // tuning dataset. + TotalBillableTokenCount int64 `json:"totalBillableTokenCount,omitempty,string"` + // TuningDatasetExampleCount: Output only. Number of examples in the tuning + // dataset. + TuningDatasetExampleCount int64 `json:"tuningDatasetExampleCount,omitempty,string"` + // TuningStepCount: Output only. Number of tuning steps for this Tuning Job. + TuningStepCount int64 `json:"tuningStepCount,omitempty,string"` + // UserDatasetExamples: Output only. Sample user examples in the training + // dataset. + UserDatasetExamples []*GoogleCloudAiplatformV1GeminiPreferenceExample `json:"userDatasetExamples,omitempty"` + // UserInputTokenDistribution: Output only. Dataset distributions for the user + // input tokens. + UserInputTokenDistribution *GoogleCloudAiplatformV1DatasetDistribution `json:"userInputTokenDistribution,omitempty"` + // UserOutputTokenDistribution: Output only. Dataset distributions for the user + // output tokens. + UserOutputTokenDistribution *GoogleCloudAiplatformV1DatasetDistribution `json:"userOutputTokenDistribution,omitempty"` + // ForceSendFields is a list of field names (e.g. "DroppedExampleIndices") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "DroppedExampleIndices") to + // include in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudAiplatformV1PreferenceOptimizationDataStats) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudAiplatformV1PreferenceOptimizationDataStats + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudAiplatformV1PreferenceOptimizationHyperParameters: +// Hyperparameters for Preference Optimization. +type GoogleCloudAiplatformV1PreferenceOptimizationHyperParameters struct { + // AdapterSize: Optional. Adapter size for preference optimization. + // + // Possible values: + // "ADAPTER_SIZE_UNSPECIFIED" - Adapter size is unspecified. + // "ADAPTER_SIZE_ONE" - Adapter size 1. + // "ADAPTER_SIZE_TWO" - Adapter size 2. + // "ADAPTER_SIZE_FOUR" - Adapter size 4. + // "ADAPTER_SIZE_EIGHT" - Adapter size 8. + // "ADAPTER_SIZE_SIXTEEN" - Adapter size 16. + // "ADAPTER_SIZE_THIRTY_TWO" - Adapter size 32. + AdapterSize string `json:"adapterSize,omitempty"` + // Beta: Optional. Weight for KL Divergence regularization. + Beta float64 `json:"beta,omitempty"` + // EpochCount: Optional. Number of complete passes the model makes over the + // entire training dataset during training. + EpochCount int64 `json:"epochCount,omitempty,string"` + // LearningRateMultiplier: Optional. Multiplier for adjusting the default + // learning rate. + LearningRateMultiplier float64 `json:"learningRateMultiplier,omitempty"` + // ForceSendFields is a list of field names (e.g. "AdapterSize") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "AdapterSize") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudAiplatformV1PreferenceOptimizationHyperParameters) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudAiplatformV1PreferenceOptimizationHyperParameters + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + +func (s *GoogleCloudAiplatformV1PreferenceOptimizationHyperParameters) UnmarshalJSON(data []byte) error { + type NoMethod GoogleCloudAiplatformV1PreferenceOptimizationHyperParameters + var s1 struct { + Beta gensupport.JSONFloat64 `json:"beta"` + LearningRateMultiplier gensupport.JSONFloat64 `json:"learningRateMultiplier"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.Beta = float64(s1.Beta) + s.LearningRateMultiplier = float64(s1.LearningRateMultiplier) + return nil +} + +// GoogleCloudAiplatformV1PreferenceOptimizationSpec: Tuning Spec for +// Preference Optimization. +type GoogleCloudAiplatformV1PreferenceOptimizationSpec struct { + // ExportLastCheckpointOnly: Optional. If set to true, disable intermediate + // checkpoints for Preference Optimization and only the last checkpoint will be + // exported. Otherwise, enable intermediate checkpoints for Preference + // Optimization. Default is false. + ExportLastCheckpointOnly bool `json:"exportLastCheckpointOnly,omitempty"` + // HyperParameters: Optional. Hyperparameters for Preference Optimization. + HyperParameters *GoogleCloudAiplatformV1PreferenceOptimizationHyperParameters `json:"hyperParameters,omitempty"` + // TrainingDatasetUri: Required. Cloud Storage path to file containing training + // dataset for preference optimization tuning. The dataset must be formatted as + // a JSONL file. + TrainingDatasetUri string `json:"trainingDatasetUri,omitempty"` + // ValidationDatasetUri: Optional. Cloud Storage path to file containing + // validation dataset for preference optimization tuning. The dataset must be + // formatted as a JSONL file. + ValidationDatasetUri string `json:"validationDatasetUri,omitempty"` + // ForceSendFields is a list of field names (e.g. "ExportLastCheckpointOnly") + // to unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "ExportLastCheckpointOnly") to + // include in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudAiplatformV1PreferenceOptimizationSpec) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudAiplatformV1PreferenceOptimizationSpec + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudAiplatformV1Presets: Preset configuration for example-based // explanations type GoogleCloudAiplatformV1Presets struct { @@ -28219,6 +28702,10 @@ type GoogleCloudAiplatformV1RagCorpus struct { EncryptionSpec *GoogleCloudAiplatformV1EncryptionSpec `json:"encryptionSpec,omitempty"` // Name: Output only. The resource name of the RagCorpus. Name string `json:"name,omitempty"` + // SatisfiesPzi: Output only. Reserved for future use. + SatisfiesPzi bool `json:"satisfiesPzi,omitempty"` + // SatisfiesPzs: Output only. Reserved for future use. + SatisfiesPzs bool `json:"satisfiesPzs,omitempty"` // UpdateTime: Output only. Timestamp when this RagCorpus was last updated. UpdateTime string `json:"updateTime,omitempty"` // VectorDbConfig: Optional. Immutable. The config for the Vector DBs. @@ -29585,8 +30072,8 @@ type GoogleCloudAiplatformV1ReasoningEngineSpecPackageSpec struct { // PickleObjectGcsUri: Optional. The Cloud Storage URI of the pickled python // object. PickleObjectGcsUri string `json:"pickleObjectGcsUri,omitempty"` - // PythonVersion: Optional. The Python version. Currently support 3.8, 3.9, - // 3.10, 3.11. If not specified, default value is 3.10. + // PythonVersion: Optional. The Python version. Supported values are 3.9, 3.10, + // 3.11, 3.12, 3.13. If not specified, the default value is 3.10. PythonVersion string `json:"pythonVersion,omitempty"` // RequirementsGcsUri: Optional. The Cloud Storage URI of the // `requirements.txt` file @@ -30135,15 +30622,16 @@ func (s GoogleCloudAiplatformV1RetrievalConfig) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// GoogleCloudAiplatformV1RetrievalMetadata: Metadata related to retrieval in -// the grounding flow. +// GoogleCloudAiplatformV1RetrievalMetadata: Metadata related to the retrieval +// grounding source. This is part of the `GroundingMetadata` returned when +// grounding is enabled. type GoogleCloudAiplatformV1RetrievalMetadata struct { - // GoogleSearchDynamicRetrievalScore: Optional. Score indicating how likely - // information from Google Search could help answer the prompt. The score is in - // the range `[0, 1]`, where 0 is the least likely and 1 is the most likely. - // This score is only populated when Google Search grounding and dynamic - // retrieval is enabled. It will be compared to the threshold to determine - // whether to trigger Google Search. + // GoogleSearchDynamicRetrievalScore: Optional. A score indicating how likely + // it is that a Google Search query could help answer the prompt. The score is + // in the range of `[0, 1]`. A score of 1 means the model is confident that a + // search will be helpful, and 0 means it is not. This score is populated only + // when Google Search grounding and dynamic retrieval are enabled. The score is + // used to determine whether to trigger a search. GoogleSearchDynamicRetrievalScore float64 `json:"googleSearchDynamicRetrievalScore,omitempty"` // ForceSendFields is a list of field names (e.g. // "GoogleSearchDynamicRetrievalScore") to unconditionally include in API @@ -30792,31 +31280,33 @@ func (s GoogleCloudAiplatformV1SafetyInstance) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// GoogleCloudAiplatformV1SafetyRating: Safety rating corresponding to the -// generated content. +// GoogleCloudAiplatformV1SafetyRating: A safety rating for a piece of content. +// The safety rating contains the harm category and the harm probability level. type GoogleCloudAiplatformV1SafetyRating struct { - // Blocked: Output only. Indicates whether the content was filtered out because - // of this rating. + // Blocked: Output only. Indicates whether the content was blocked because of + // this rating. Blocked bool `json:"blocked,omitempty"` - // Category: Output only. Harm category. + // Category: Output only. The harm category of this rating. // // Possible values: - // "HARM_CATEGORY_UNSPECIFIED" - The harm category is unspecified. - // "HARM_CATEGORY_HATE_SPEECH" - The harm category is hate speech. - // "HARM_CATEGORY_DANGEROUS_CONTENT" - The harm category is dangerous - // content. - // "HARM_CATEGORY_HARASSMENT" - The harm category is harassment. - // "HARM_CATEGORY_SEXUALLY_EXPLICIT" - The harm category is sexually explicit - // content. + // "HARM_CATEGORY_UNSPECIFIED" - Default value. This value is unused. + // "HARM_CATEGORY_HATE_SPEECH" - Content that promotes violence or incites + // hatred against individuals or groups based on certain attributes. + // "HARM_CATEGORY_DANGEROUS_CONTENT" - Content that promotes, facilitates, or + // enables dangerous activities. + // "HARM_CATEGORY_HARASSMENT" - Abusive, threatening, or content intended to + // bully, torment, or ridicule. + // "HARM_CATEGORY_SEXUALLY_EXPLICIT" - Content that contains sexually + // explicit material. // "HARM_CATEGORY_CIVIC_INTEGRITY" - Deprecated: Election filter is not // longer supported. The harm category is civic integrity. - // "HARM_CATEGORY_IMAGE_HATE" - The harm category is image hate. - // "HARM_CATEGORY_IMAGE_DANGEROUS_CONTENT" - The harm category is image - // dangerous content. - // "HARM_CATEGORY_IMAGE_HARASSMENT" - The harm category is image harassment. - // "HARM_CATEGORY_IMAGE_SEXUALLY_EXPLICIT" - The harm category is image - // sexually explicit content. - // "HARM_CATEGORY_JAILBREAK" - The harm category is for jailbreak prompts. + // "HARM_CATEGORY_IMAGE_HATE" - Images that contain hate speech. + // "HARM_CATEGORY_IMAGE_DANGEROUS_CONTENT" - Images that contain dangerous + // content. + // "HARM_CATEGORY_IMAGE_HARASSMENT" - Images that contain harassment. + // "HARM_CATEGORY_IMAGE_SEXUALLY_EXPLICIT" - Images that contain sexually + // explicit content. + // "HARM_CATEGORY_JAILBREAK" - Prompts designed to bypass safety filters. Category string `json:"category,omitempty"` // OverwrittenThreshold: Output only. The overwritten threshold for the safety // category of Gemini 2.0 image out. If minors are detected in the output @@ -30824,34 +31314,39 @@ type GoogleCloudAiplatformV1SafetyRating struct { // sets a lower threshold. // // Possible values: - // "HARM_BLOCK_THRESHOLD_UNSPECIFIED" - Unspecified harm block threshold. - // "BLOCK_LOW_AND_ABOVE" - Block low threshold and above (i.e. block more). - // "BLOCK_MEDIUM_AND_ABOVE" - Block medium threshold and above. - // "BLOCK_ONLY_HIGH" - Block only high threshold (i.e. block less). - // "BLOCK_NONE" - Block none. - // "OFF" - Turn off the safety filter. + // "HARM_BLOCK_THRESHOLD_UNSPECIFIED" - The harm block threshold is + // unspecified. + // "BLOCK_LOW_AND_ABOVE" - Block content with a low harm probability or + // higher. + // "BLOCK_MEDIUM_AND_ABOVE" - Block content with a medium harm probability or + // higher. + // "BLOCK_ONLY_HIGH" - Block content with a high harm probability. + // "BLOCK_NONE" - Do not block any content, regardless of its harm + // probability. + // "OFF" - Turn off the safety filter entirely. OverwrittenThreshold string `json:"overwrittenThreshold,omitempty"` - // Probability: Output only. Harm probability levels in the content. + // Probability: Output only. The probability of harm for this category. // // Possible values: - // "HARM_PROBABILITY_UNSPECIFIED" - Harm probability unspecified. - // "NEGLIGIBLE" - Negligible level of harm. - // "LOW" - Low level of harm. - // "MEDIUM" - Medium level of harm. - // "HIGH" - High level of harm. + // "HARM_PROBABILITY_UNSPECIFIED" - The harm probability is unspecified. + // "NEGLIGIBLE" - The harm probability is negligible. + // "LOW" - The harm probability is low. + // "MEDIUM" - The harm probability is medium. + // "HIGH" - The harm probability is high. Probability string `json:"probability,omitempty"` - // ProbabilityScore: Output only. Harm probability score. + // ProbabilityScore: Output only. The probability score of harm for this + // category. ProbabilityScore float64 `json:"probabilityScore,omitempty"` - // Severity: Output only. Harm severity levels in the content. + // Severity: Output only. The severity of harm for this category. // // Possible values: - // "HARM_SEVERITY_UNSPECIFIED" - Harm severity unspecified. - // "HARM_SEVERITY_NEGLIGIBLE" - Negligible level of harm severity. - // "HARM_SEVERITY_LOW" - Low level of harm severity. - // "HARM_SEVERITY_MEDIUM" - Medium level of harm severity. - // "HARM_SEVERITY_HIGH" - High level of harm severity. + // "HARM_SEVERITY_UNSPECIFIED" - The harm severity is unspecified. + // "HARM_SEVERITY_NEGLIGIBLE" - The harm severity is negligible. + // "HARM_SEVERITY_LOW" - The harm severity is low. + // "HARM_SEVERITY_MEDIUM" - The harm severity is medium. + // "HARM_SEVERITY_HIGH" - The harm severity is high. Severity string `json:"severity,omitempty"` - // SeverityScore: Output only. Harm severity score. + // SeverityScore: Output only. The severity score of harm for this category. SeverityScore float64 `json:"severityScore,omitempty"` // ForceSendFields is a list of field names (e.g. "Blocked") to unconditionally // include in API requests. By default, fields with empty or default values are @@ -30929,31 +31424,34 @@ func (s *GoogleCloudAiplatformV1SafetyResult) UnmarshalJSON(data []byte) error { return nil } -// GoogleCloudAiplatformV1SafetySetting: Safety settings. +// GoogleCloudAiplatformV1SafetySetting: A safety setting that affects the +// safety-blocking behavior. A SafetySetting consists of a harm category and a +// threshold for that category. type GoogleCloudAiplatformV1SafetySetting struct { - // Category: Required. Harm category. + // Category: Required. The harm category to be blocked. // // Possible values: - // "HARM_CATEGORY_UNSPECIFIED" - The harm category is unspecified. - // "HARM_CATEGORY_HATE_SPEECH" - The harm category is hate speech. - // "HARM_CATEGORY_DANGEROUS_CONTENT" - The harm category is dangerous - // content. - // "HARM_CATEGORY_HARASSMENT" - The harm category is harassment. - // "HARM_CATEGORY_SEXUALLY_EXPLICIT" - The harm category is sexually explicit - // content. + // "HARM_CATEGORY_UNSPECIFIED" - Default value. This value is unused. + // "HARM_CATEGORY_HATE_SPEECH" - Content that promotes violence or incites + // hatred against individuals or groups based on certain attributes. + // "HARM_CATEGORY_DANGEROUS_CONTENT" - Content that promotes, facilitates, or + // enables dangerous activities. + // "HARM_CATEGORY_HARASSMENT" - Abusive, threatening, or content intended to + // bully, torment, or ridicule. + // "HARM_CATEGORY_SEXUALLY_EXPLICIT" - Content that contains sexually + // explicit material. // "HARM_CATEGORY_CIVIC_INTEGRITY" - Deprecated: Election filter is not // longer supported. The harm category is civic integrity. - // "HARM_CATEGORY_IMAGE_HATE" - The harm category is image hate. - // "HARM_CATEGORY_IMAGE_DANGEROUS_CONTENT" - The harm category is image - // dangerous content. - // "HARM_CATEGORY_IMAGE_HARASSMENT" - The harm category is image harassment. - // "HARM_CATEGORY_IMAGE_SEXUALLY_EXPLICIT" - The harm category is image - // sexually explicit content. - // "HARM_CATEGORY_JAILBREAK" - The harm category is for jailbreak prompts. + // "HARM_CATEGORY_IMAGE_HATE" - Images that contain hate speech. + // "HARM_CATEGORY_IMAGE_DANGEROUS_CONTENT" - Images that contain dangerous + // content. + // "HARM_CATEGORY_IMAGE_HARASSMENT" - Images that contain harassment. + // "HARM_CATEGORY_IMAGE_SEXUALLY_EXPLICIT" - Images that contain sexually + // explicit content. + // "HARM_CATEGORY_JAILBREAK" - Prompts designed to bypass safety filters. Category string `json:"category,omitempty"` - // Method: Optional. Specify if the threshold is used for probability or - // severity score. If not specified, the threshold is used for probability - // score. + // Method: Optional. The method for blocking content. If not specified, the + // default behavior is to use the probability score. // // Possible values: // "HARM_BLOCK_METHOD_UNSPECIFIED" - The harm block method is unspecified. @@ -30961,15 +31459,20 @@ type GoogleCloudAiplatformV1SafetySetting struct { // scores. // "PROBABILITY" - The harm block method uses the probability score. Method string `json:"method,omitempty"` - // Threshold: Required. The harm block threshold. + // Threshold: Required. The threshold for blocking content. If the harm + // probability exceeds this threshold, the content will be blocked. // // Possible values: - // "HARM_BLOCK_THRESHOLD_UNSPECIFIED" - Unspecified harm block threshold. - // "BLOCK_LOW_AND_ABOVE" - Block low threshold and above (i.e. block more). - // "BLOCK_MEDIUM_AND_ABOVE" - Block medium threshold and above. - // "BLOCK_ONLY_HIGH" - Block only high threshold (i.e. block less). - // "BLOCK_NONE" - Block none. - // "OFF" - Turn off the safety filter. + // "HARM_BLOCK_THRESHOLD_UNSPECIFIED" - The harm block threshold is + // unspecified. + // "BLOCK_LOW_AND_ABOVE" - Block content with a low harm probability or + // higher. + // "BLOCK_MEDIUM_AND_ABOVE" - Block content with a medium harm probability or + // higher. + // "BLOCK_ONLY_HIGH" - Block content with a high harm probability. + // "BLOCK_NONE" - Do not block any content, regardless of its harm + // probability. + // "OFF" - Turn off the safety filter entirely. Threshold string `json:"threshold,omitempty"` // ForceSendFields is a list of field names (e.g. "Category") to // unconditionally include in API requests. By default, fields with empty or @@ -38217,12 +38720,18 @@ func (s GoogleCloudAiplatformV1SearchDataItemsResponse) MarshalJSON() ([]byte, e return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// GoogleCloudAiplatformV1SearchEntryPoint: Google search entry point. +// GoogleCloudAiplatformV1SearchEntryPoint: An entry point for displaying +// Google Search results. A `SearchEntryPoint` is populated when the grounding +// source for a model's response is Google Search. It provides information that +// you can use to display the search results in your application. type GoogleCloudAiplatformV1SearchEntryPoint struct { - // RenderedContent: Optional. Web content snippet that can be embedded in a web - // page or an app webview. + // RenderedContent: Optional. An HTML snippet that can be embedded in a web + // page or an application's webview. This snippet displays a search result, + // including the title, URL, and a brief description of the search result. RenderedContent string `json:"renderedContent,omitempty"` - // SdkBlob: Optional. Base64 encoded JSON representing array of tuple. + // SdkBlob: Optional. A base64-encoded JSON object that contains a list of + // search queries and their corresponding search URLs. This information can be + // used to build a custom search UI. SdkBlob string `json:"sdkBlob,omitempty"` // ForceSendFields is a list of field names (e.g. "RenderedContent") to // unconditionally include in API requests. By default, fields with empty or @@ -38564,18 +39073,21 @@ func (s GoogleCloudAiplatformV1SecretRef) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// GoogleCloudAiplatformV1Segment: Segment of the content. +// GoogleCloudAiplatformV1Segment: A segment of the content. type GoogleCloudAiplatformV1Segment struct { - // EndIndex: Output only. End index in the given Part, measured in bytes. - // Offset from the start of the Part, exclusive, starting at zero. + // EndIndex: Output only. The end index of the segment in the `Part`, measured + // in bytes. This marks the end of the segment and is exclusive, meaning the + // segment includes content up to, but not including, the byte at this index. EndIndex int64 `json:"endIndex,omitempty"` - // PartIndex: Output only. The index of a Part object within its parent Content - // object. + // PartIndex: Output only. The index of the `Part` object that this segment + // belongs to. This is useful for associating the segment with a specific part + // of the content. PartIndex int64 `json:"partIndex,omitempty"` - // StartIndex: Output only. Start index in the given Part, measured in bytes. - // Offset from the start of the Part, inclusive, starting at zero. + // StartIndex: Output only. The start index of the segment in the `Part`, + // measured in bytes. This marks the beginning of the segment and is inclusive, + // meaning the byte at this index is the first byte of the segment. StartIndex int64 `json:"startIndex,omitempty"` - // Text: Output only. The text corresponding to the segment from the response. + // Text: Output only. The text of the segment. Text string `json:"text,omitempty"` // ForceSendFields is a list of field names (e.g. "EndIndex") to // unconditionally include in API requests. By default, fields with empty or @@ -38862,7 +39374,7 @@ func (s *GoogleCloudAiplatformV1SmoothGradConfig) UnmarshalJSON(data []byte) err } // GoogleCloudAiplatformV1SpeakerVoiceConfig: Configuration for a single -// speaker in a multi speaker setup. +// speaker in a multi-speaker setup. type GoogleCloudAiplatformV1SpeakerVoiceConfig struct { // Speaker: Required. The name of the speaker. This should be the same as the // speaker name used in the prompt. @@ -39012,16 +39524,16 @@ func (s GoogleCloudAiplatformV1SpeculativeDecodingSpecNgramSpeculation) MarshalJ return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// GoogleCloudAiplatformV1SpeechConfig: The speech generation config. +// GoogleCloudAiplatformV1SpeechConfig: Configuration for speech generation. type GoogleCloudAiplatformV1SpeechConfig struct { - // LanguageCode: Optional. Language code (ISO 639. e.g. en-US) for the speech - // synthesization. + // LanguageCode: Optional. The language code (ISO 639-1) for the speech + // synthesis. LanguageCode string `json:"languageCode,omitempty"` // MultiSpeakerVoiceConfig: The configuration for a multi-speaker // text-to-speech request. This field is mutually exclusive with // `voice_config`. MultiSpeakerVoiceConfig *GoogleCloudAiplatformV1MultiSpeakerVoiceConfig `json:"multiSpeakerVoiceConfig,omitempty"` - // VoiceConfig: The configuration for the speaker to use. + // VoiceConfig: The configuration for the voice to use. VoiceConfig *GoogleCloudAiplatformV1VoiceConfig `json:"voiceConfig,omitempty"` // ForceSendFields is a list of field names (e.g. "LanguageCode") to // unconditionally include in API requests. By default, fields with empty or @@ -43436,16 +43948,20 @@ func (s GoogleCloudAiplatformV1TunedModelRef) MarshalJSON() ([]byte, error) { // GoogleCloudAiplatformV1TuningDataStats: The tuning data statistic values for // TuningJob. type GoogleCloudAiplatformV1TuningDataStats struct { + // PreferenceOptimizationDataStats: Output only. Statistics for preference + // optimization. + PreferenceOptimizationDataStats *GoogleCloudAiplatformV1PreferenceOptimizationDataStats `json:"preferenceOptimizationDataStats,omitempty"` // SupervisedTuningDataStats: The SFT Tuning data stats. SupervisedTuningDataStats *GoogleCloudAiplatformV1SupervisedTuningDataStats `json:"supervisedTuningDataStats,omitempty"` - // ForceSendFields is a list of field names (e.g. "SupervisedTuningDataStats") - // to unconditionally include in API requests. By default, fields with empty or - // default values are omitted from API requests. See + // ForceSendFields is a list of field names (e.g. + // "PreferenceOptimizationDataStats") to unconditionally include in API + // requests. By default, fields with empty or default values are omitted from + // API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more // details. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "SupervisedTuningDataStats") to - // include in API requests with the JSON null value. By default, fields with + // NullFields is a list of field names (e.g. "PreferenceOptimizationDataStats") + // to include in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. NullFields []string `json:"-"` @@ -43491,6 +44007,8 @@ type GoogleCloudAiplatformV1TuningJob struct { Name string `json:"name,omitempty"` // PreTunedModel: The pre-tuned model for continuous tuning. PreTunedModel *GoogleCloudAiplatformV1PreTunedModel `json:"preTunedModel,omitempty"` + // PreferenceOptimizationSpec: Tuning Spec for Preference Optimization. + PreferenceOptimizationSpec *GoogleCloudAiplatformV1PreferenceOptimizationSpec `json:"preferenceOptimizationSpec,omitempty"` // ServiceAccount: The service account that the tuningJob workload runs as. If // not specified, the Vertex AI Secure Fine-Tuned Service Agent in the project // will be used. See @@ -44277,10 +44795,11 @@ type GoogleCloudAiplatformV1UpsertDatapointsResponse struct { type GoogleCloudAiplatformV1UrlContext struct { } -// GoogleCloudAiplatformV1UrlContextMetadata: Metadata related to url context -// retrieval tool. +// GoogleCloudAiplatformV1UrlContextMetadata: Metadata returned when the model +// uses the `url_context` tool to get information from a user-provided URL. type GoogleCloudAiplatformV1UrlContextMetadata struct { - // UrlMetadata: Output only. List of url context. + // UrlMetadata: Output only. A list of URL metadata, with one entry for each + // URL retrieved by the tool. UrlMetadata []*GoogleCloudAiplatformV1UrlMetadata `json:"urlMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "UrlMetadata") to // unconditionally include in API requests. By default, fields with empty or @@ -44300,16 +44819,16 @@ func (s GoogleCloudAiplatformV1UrlContextMetadata) MarshalJSON() ([]byte, error) return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// GoogleCloudAiplatformV1UrlMetadata: Context of the a single url retrieval. +// GoogleCloudAiplatformV1UrlMetadata: The metadata for a single URL retrieval. type GoogleCloudAiplatformV1UrlMetadata struct { - // RetrievedUrl: Retrieved url by the tool. + // RetrievedUrl: The URL retrieved by the tool. RetrievedUrl string `json:"retrievedUrl,omitempty"` - // UrlRetrievalStatus: Status of the url retrieval. + // UrlRetrievalStatus: The status of the URL retrieval. // // Possible values: // "URL_RETRIEVAL_STATUS_UNSPECIFIED" - Default value. This value is unused. - // "URL_RETRIEVAL_STATUS_SUCCESS" - Url retrieval is successful. - // "URL_RETRIEVAL_STATUS_ERROR" - Url retrieval is failed due to error. + // "URL_RETRIEVAL_STATUS_SUCCESS" - The URL was retrieved successfully. + // "URL_RETRIEVAL_STATUS_ERROR" - The URL retrieval failed. UrlRetrievalStatus string `json:"urlRetrievalStatus,omitempty"` // ForceSendFields is a list of field names (e.g. "RetrievedUrl") to // unconditionally include in API requests. By default, fields with empty or @@ -44644,13 +45163,13 @@ func (s GoogleCloudAiplatformV1VertexRagStoreRagResource) MarshalJSON() ([]byte, return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// GoogleCloudAiplatformV1VideoMetadata: Metadata describes the input video -// content. +// GoogleCloudAiplatformV1VideoMetadata: Provides metadata for a video, +// including the start and end offsets for clipping and the frame rate. type GoogleCloudAiplatformV1VideoMetadata struct { // EndOffset: Optional. The end offset of the video. EndOffset string `json:"endOffset,omitempty"` // Fps: Optional. The frame rate of the video sent to the model. If not - // specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + // specified, the default value is 1.0. The valid range is (0.0, 24.0]. Fps float64 `json:"fps,omitempty"` // StartOffset: Optional. The start offset of the video. StartOffset string `json:"startOffset,omitempty"` @@ -44686,9 +45205,9 @@ func (s *GoogleCloudAiplatformV1VideoMetadata) UnmarshalJSON(data []byte) error return nil } -// GoogleCloudAiplatformV1VoiceConfig: The configuration for the voice to use. +// GoogleCloudAiplatformV1VoiceConfig: Configuration for a voice. type GoogleCloudAiplatformV1VoiceConfig struct { - // PrebuiltVoiceConfig: The configuration for the prebuilt voice to use. + // PrebuiltVoiceConfig: The configuration for a prebuilt voice. PrebuiltVoiceConfig *GoogleCloudAiplatformV1PrebuiltVoiceConfig `json:"prebuiltVoiceConfig,omitempty"` // ForceSendFields is a list of field names (e.g. "PrebuiltVoiceConfig") to // unconditionally include in API requests. By default, fields with empty or @@ -68923,9 +69442,9 @@ func (r *ProjectsLocationsService) List(name string) *ProjectsLocationsListCall return c } -// ExtraLocationTypes sets the optional parameter "extraLocationTypes": Unless -// explicitly documented otherwise, don't use this unsupported field which is -// primarily intended for internal usage. +// ExtraLocationTypes sets the optional parameter "extraLocationTypes": Do not +// use this field. It is unsupported and is ignored unless explicitly +// documented otherwise. This is primarily for internal usage. func (c *ProjectsLocationsListCall) ExtraLocationTypes(extraLocationTypes ...string) *ProjectsLocationsListCall { c.urlParams_.SetMulti("extraLocationTypes", append([]string{}, extraLocationTypes...)) return c diff --git a/travelimpactmodel/v1/travelimpactmodel-api.json b/travelimpactmodel/v1/travelimpactmodel-api.json index 2f547f894d..b6e06852f3 100644 --- a/travelimpactmodel/v1/travelimpactmodel-api.json +++ b/travelimpactmodel/v1/travelimpactmodel-api.json @@ -146,7 +146,7 @@ } } }, - "revision": "20251008", + "revision": "20251102", "rootUrl": "https://travelimpactmodel.googleapis.com/", "schemas": { "ComputeFlightEmissionsRequest": { @@ -505,7 +505,7 @@ "type": "string" }, "carrierCode": { - "description": "Optional. IATA carrier code, e.g. `KE`. This is required if specific flight matching is desired. Otherwise, this is unused for typical flight and distance-based emissions models. This could be both operating and marketing carrier code (i.e. codeshare is covered).", + "description": "Optional. 2-character [IATA carrier code](https://www.iata.org/en/publications/directories/code-search/), e.g. `KE`. This is required if specific flight matching is desired. Otherwise, this is unused for typical flight and distance-based emissions models. This could be both operating and marketing carrier code (i.e. codeshare is covered).", "type": "string" }, "departureDate": { @@ -513,21 +513,21 @@ "description": "Required. Date of the flight in the time zone of the origin airport. Only year is required for typical flight and distance-based emissions models (month and day values are ignored and therefore, can be either omitted, set to 0, or set to a valid date for those cases). Correspondingly, if a specific date is not provided for TIM emissions, we will fallback to typical flight (or distance-based) emissions." }, "destination": { - "description": "Optional. IATA airport code for flight destination, e.g. `ICN`. This is used to match specific flight if provided alongside origin, carrier, and flight number. If there is no match, we will first try to match the flight to a typical flight between the provided origin and destination airports. Otherwise, we will use the distance-based emissions model if the flight distance is provided.", + "description": "Optional. 3-character [IATA airport code](https://www.iata.org/en/publications/directories/code-search/) for flight destination, e.g. `ICN`. This is used to match specific flight if provided alongside origin, carrier, and flight number. If there is no match, we will first try to match the flight to a typical flight between the provided origin and destination airports. Otherwise, we will use the distance-based emissions model if the flight distance is provided.", "type": "string" }, "distanceKm": { - "description": "Optional. Distance in kilometers, e.g. `2423`. This is used to match a flight to distance-based emissions when origin and destination are not provided or there are no matching typical flights. This field supports values between 0 and 2.5e16 km.", + "description": "Optional. Distance in kilometers, e.g. `2423`, from [1, 2.5e16) km. This is used to match a flight to distance-based emissions when origin and destination are not provided or there are no matching typical flights.", "format": "int64", "type": "string" }, "flightNumber": { - "description": "Optional. Flight number, e.g. `71`. This is first used to match a specific flight if a flight number is specified alongside origin, destination, and carrier. If a flight number is not specified, we will first try to match the flight to a typical flight between the provided origin and destination airports. If that fails and/or origin \u0026 destination are not provided, we will use the distance-based emissions model based on the flight distance provided.", + "description": "Optional. Up to 4-digit [flight number](https://en.wikipedia.org/wiki/Flight_number), e.g. `71`, from [1, 9999]. This is first used to match a specific flight if a flight number is specified alongside origin, destination, and carrier. If a flight number is not specified, we will first try to match the flight to a typical flight between the provided origin and destination airports. If that fails and/or origin \u0026 destination are not provided, we will use the distance-based emissions model based on the flight distance provided.", "format": "int32", "type": "integer" }, "origin": { - "description": "Optional. IATA airport code for flight origin, e.g. `YVR`. This is used to match specific flight if provided alongside destination, carrier, and flight number. If there is no match, we will first try to match the flight to a typical flight between the provided origin and destination airports. Otherwise, we will use the distance-based emissions model if the flight distance is provided.", + "description": "Optional. 3-character [IATA airport code](https://www.iata.org/en/publications/directories/code-search/) for flight origin, e.g. `YVR`. This is used to match specific flight if provided alongside destination, carrier, and flight number. If there is no match, we will first try to match the flight to a typical flight between the provided origin and destination airports. Otherwise, we will use the distance-based emissions model if the flight distance is provided.", "type": "string" } }, diff --git a/travelimpactmodel/v1/travelimpactmodel-gen.go b/travelimpactmodel/v1/travelimpactmodel-gen.go index fa65288073..9250f2fb9f 100644 --- a/travelimpactmodel/v1/travelimpactmodel-gen.go +++ b/travelimpactmodel/v1/travelimpactmodel-gen.go @@ -630,10 +630,11 @@ type Scope3FlightSegment struct { // "BUSINESS" - Business class. // "FIRST" - First class. CabinClass string `json:"cabinClass,omitempty"` - // CarrierCode: Optional. IATA carrier code, e.g. `KE`. This is required if - // specific flight matching is desired. Otherwise, this is unused for typical - // flight and distance-based emissions models. This could be both operating and - // marketing carrier code (i.e. codeshare is covered). + // CarrierCode: Optional. 2-character IATA carrier code + // (https://www.iata.org/en/publications/directories/code-search/), e.g. `KE`. + // This is required if specific flight matching is desired. Otherwise, this is + // unused for typical flight and distance-based emissions models. This could be + // both operating and marketing carrier code (i.e. codeshare is covered). CarrierCode string `json:"carrierCode,omitempty"` // DepartureDate: Required. Date of the flight in the time zone of the origin // airport. Only year is required for typical flight and distance-based @@ -642,32 +643,34 @@ type Scope3FlightSegment struct { // Correspondingly, if a specific date is not provided for TIM emissions, we // will fallback to typical flight (or distance-based) emissions. DepartureDate *Date `json:"departureDate,omitempty"` - // Destination: Optional. IATA airport code for flight destination, e.g. `ICN`. - // This is used to match specific flight if provided alongside origin, carrier, - // and flight number. If there is no match, we will first try to match the - // flight to a typical flight between the provided origin and destination - // airports. Otherwise, we will use the distance-based emissions model if the - // flight distance is provided. + // Destination: Optional. 3-character IATA airport code + // (https://www.iata.org/en/publications/directories/code-search/) for flight + // destination, e.g. `ICN`. This is used to match specific flight if provided + // alongside origin, carrier, and flight number. If there is no match, we will + // first try to match the flight to a typical flight between the provided + // origin and destination airports. Otherwise, we will use the distance-based + // emissions model if the flight distance is provided. Destination string `json:"destination,omitempty"` - // DistanceKm: Optional. Distance in kilometers, e.g. `2423`. This is used to - // match a flight to distance-based emissions when origin and destination are - // not provided or there are no matching typical flights. This field supports - // values between 0 and 2.5e16 km. + // DistanceKm: Optional. Distance in kilometers, e.g. `2423`, from [1, 2.5e16) + // km. This is used to match a flight to distance-based emissions when origin + // and destination are not provided or there are no matching typical flights. DistanceKm int64 `json:"distanceKm,omitempty,string"` - // FlightNumber: Optional. Flight number, e.g. `71`. This is first used to - // match a specific flight if a flight number is specified alongside origin, - // destination, and carrier. If a flight number is not specified, we will first - // try to match the flight to a typical flight between the provided origin and - // destination airports. If that fails and/or origin & destination are not - // provided, we will use the distance-based emissions model based on the flight - // distance provided. + // FlightNumber: Optional. Up to 4-digit flight number + // (https://en.wikipedia.org/wiki/Flight_number), e.g. `71`, from [1, 9999]. + // This is first used to match a specific flight if a flight number is + // specified alongside origin, destination, and carrier. If a flight number is + // not specified, we will first try to match the flight to a typical flight + // between the provided origin and destination airports. If that fails and/or + // origin & destination are not provided, we will use the distance-based + // emissions model based on the flight distance provided. FlightNumber int64 `json:"flightNumber,omitempty"` - // Origin: Optional. IATA airport code for flight origin, e.g. `YVR`. This is - // used to match specific flight if provided alongside destination, carrier, - // and flight number. If there is no match, we will first try to match the - // flight to a typical flight between the provided origin and destination - // airports. Otherwise, we will use the distance-based emissions model if the - // flight distance is provided. + // Origin: Optional. 3-character IATA airport code + // (https://www.iata.org/en/publications/directories/code-search/) for flight + // origin, e.g. `YVR`. This is used to match specific flight if provided + // alongside destination, carrier, and flight number. If there is no match, we + // will first try to match the flight to a typical flight between the provided + // origin and destination airports. Otherwise, we will use the distance-based + // emissions model if the flight distance is provided. Origin string `json:"origin,omitempty"` // ForceSendFields is a list of field names (e.g. "CabinClass") to // unconditionally include in API requests. By default, fields with empty or diff --git a/vmmigration/v1/vmmigration-api.json b/vmmigration/v1/vmmigration-api.json index d4ddaa133f..24d6149ccb 100644 --- a/vmmigration/v1/vmmigration-api.json +++ b/vmmigration/v1/vmmigration-api.json @@ -2548,7 +2548,7 @@ } } }, - "revision": "20251023", + "revision": "20251030", "rootUrl": "https://vmmigration.googleapis.com/", "schemas": { "AccessKeyCredentials": { @@ -3736,6 +3736,10 @@ "description": "Optional. The service account to associate the VM with.", "type": "string" }, + "storagePool": { + "description": "Optional. If specified this will be the storage pool in which the disk is created. This is the full path of the storage pool resource, for example: \"projects/my-project/zones/us-central1-a/storagePools/my-storage-pool\". The storage pool must be in the same project and zone as the target disks. The storage pool's type must match the disk type.", + "type": "string" + }, "targetProject": { "description": "The full path of the resource of type TargetProject which represents the Compute Engine project in which to create this VM.", "type": "string" @@ -3908,6 +3912,10 @@ "description": "The service account to associate the VM with.", "type": "string" }, + "storagePool": { + "description": "Optional. The storage pool used for the VM disks. If specified this will be the storage pool in which the disk is created. This is the full path of the storage pool resource, for example: \"projects/my-project/zones/us-central1-a/storagePools/my-storage-pool\". The storage pool must be in the same project and zone as the target disks. The storage pool's type must match the disk type.", + "type": "string" + }, "vmName": { "description": "The name of the VM to create.", "type": "string" @@ -4153,7 +4161,7 @@ "type": "object" }, "DataDiskImageImport": { - "description": "Mentions that the image import is not using OS adaptation process.", + "description": "Used when the image import is not using OS adaptation process.", "id": "DataDiskImageImport", "properties": {}, "type": "object" diff --git a/vmmigration/v1/vmmigration-gen.go b/vmmigration/v1/vmmigration-gen.go index 032c783f3c..2e056cead4 100644 --- a/vmmigration/v1/vmmigration-gen.go +++ b/vmmigration/v1/vmmigration-gen.go @@ -1388,6 +1388,13 @@ type ComputeEngineTargetDefaults struct { SecureBoot bool `json:"secureBoot,omitempty"` // ServiceAccount: Optional. The service account to associate the VM with. ServiceAccount string `json:"serviceAccount,omitempty"` + // StoragePool: Optional. If specified this will be the storage pool in which + // the disk is created. This is the full path of the storage pool resource, for + // example: + // "projects/my-project/zones/us-central1-a/storagePools/my-storage-pool". The + // storage pool must be in the same project and zone as the target disks. The + // storage pool's type must match the disk type. + StoragePool string `json:"storagePool,omitempty"` // TargetProject: The full path of the resource of type TargetProject which // represents the Compute Engine project in which to create this VM. TargetProject string `json:"targetProject,omitempty"` @@ -1501,6 +1508,13 @@ type ComputeEngineTargetDetails struct { SecureBoot bool `json:"secureBoot,omitempty"` // ServiceAccount: The service account to associate the VM with. ServiceAccount string `json:"serviceAccount,omitempty"` + // StoragePool: Optional. The storage pool used for the VM disks. If specified + // this will be the storage pool in which the disk is created. This is the full + // path of the storage pool resource, for example: + // "projects/my-project/zones/us-central1-a/storagePools/my-storage-pool". The + // storage pool must be in the same project and zone as the target disks. The + // storage pool's type must match the disk type. + StoragePool string `json:"storagePool,omitempty"` // VmName: The name of the VM to create. VmName string `json:"vmName,omitempty"` // Zone: The zone in which to create the VM. @@ -1746,8 +1760,8 @@ func (s CycleStep) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// DataDiskImageImport: Mentions that the image import is not using OS -// adaptation process. +// DataDiskImageImport: Used when the image import is not using OS adaptation +// process. type DataDiskImageImport struct { }