diff --git a/aiplatform/v1/aiplatform-api.json b/aiplatform/v1/aiplatform-api.json index 3d38c0bfdc..9e4ebde556 100644 --- a/aiplatform/v1/aiplatform-api.json +++ b/aiplatform/v1/aiplatform-api.json @@ -14684,9 +14684,733 @@ } } }, - "revision": "20231129", + "revision": "20231211", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { + "CloudAiLargeModelsVisionEmbedVideoResponse": { + "description": "Video embedding response.", + "id": "CloudAiLargeModelsVisionEmbedVideoResponse", + "properties": { + "videoEmbeddings": { + "description": "The embedding vector for the video.", + "items": { + "type": "any" + }, + "type": "array" + } + }, + "type": "object" + }, + "CloudAiLargeModelsVisionFilteredText": { + "description": "Details for filtered input text.", + "id": "CloudAiLargeModelsVisionFilteredText", + "properties": { + "category": { + "description": "Confidence level", + "enum": [ + "RAI_CATEGORY_UNSPECIFIED", + "OBSCENE", + "SEXUALLY_EXPLICIT", + "IDENTITY_ATTACK", + "VIOLENCE_ABUSE", + "CSAI", + "SPII", + "CELEBRITY", + "FACE_IMG", + "WATERMARK_IMG", + "MEMORIZATION_IMG", + "CSAI_IMG", + "PORN_IMG", + "VIOLENCE_IMG", + "CHILD_IMG", + "TOXIC", + "SENSITIVE_WORD", + "PERSON_IMG", + "ICA_IMG", + "SEXUAL_IMG", + "IU_IMG", + "RACY_IMG", + "PEDO_IMG", + "DEATH_HARM_TRAGEDY", + "HEALTH", + "FIREARMS_WEAPONS", + "RELIGIOUS_BELIEF", + "ILLICIT_DRUGS", + "WAR_CONFLICT", + "POLITICS", + "HATE_SYMBOL_IMG", + "CHILD_TEXT", + "DANGEROUS_CONTENT", + "RECITATION_TEXT" + ], + "enumDescriptions": [ + "", + "", + "Porn", + "Hate", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "SafetyAttributes returned but not filtered on", + "", + "", + "", + "", + "", + "", + "End of list", + "", + "Text category from SafetyCat v3", + "" + ], + "type": "string" + }, + "confidence": { + "description": "Filtered category", + "enum": [ + "CONFIDENCE_UNSPECIFIED", + "CONFIDENCE_LOW", + "CONFIDENCE_MEDIUM", + "CONFIDENCE_HIGH" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ], + "type": "string" + }, + "prompt": { + "description": "Input prompt", + "type": "string" + }, + "score": { + "description": "Score for category", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "CloudAiLargeModelsVisionGenerateVideoResponse": { + "description": "Generate video response.", + "id": "CloudAiLargeModelsVisionGenerateVideoResponse", + "properties": { + "generatedSamples": { + "description": "The generates samples.", + "items": { + "$ref": "CloudAiLargeModelsVisionMedia" + }, + "type": "array" + }, + "raiMediaFilteredCount": { + "description": "Returns if any videos were filtered due to RAI policies.", + "format": "int32", + "type": "integer" + }, + "raiMediaFilteredReasons": { + "description": "Returns rai failure reasons if any.", + "items": { + "type": "string" + }, + "type": "array" + }, + "raiTextFilteredReason": { + "$ref": "CloudAiLargeModelsVisionFilteredText", + "description": "Returns filtered text rai info." + } + }, + "type": "object" + }, + "CloudAiLargeModelsVisionImage": { + "description": "Image.", + "id": "CloudAiLargeModelsVisionImage", + "properties": { + "encoding": { + "description": "Image encoding, encoded as \"image/png\" or \"image/jpg\".", + "type": "string" + }, + "image": { + "description": "Raw bytes.", + "format": "byte", + "type": "string" + }, + "imageRaiScores": { + "$ref": "CloudAiLargeModelsVisionImageRAIScores", + "description": "RAI scores for generated image." + }, + "raiInfo": { + "$ref": "CloudAiLargeModelsVisionRaiInfo", + "description": "RAI info for image" + }, + "semanticFilterResponse": { + "$ref": "CloudAiLargeModelsVisionSemanticFilterResponse", + "description": "Semantic filter info for image." + }, + "uri": { + "description": "Path to another storage (typically Google Cloud Storage).", + "type": "string" + } + }, + "type": "object" + }, + "CloudAiLargeModelsVisionImageRAIScores": { + "description": "RAI scores for generated image returned.", + "id": "CloudAiLargeModelsVisionImageRAIScores", + "properties": { + "agileWatermarkDetectionScore": { + "description": "Agile watermark score for image.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "CloudAiLargeModelsVisionMedia": { + "description": "Media.", + "id": "CloudAiLargeModelsVisionMedia", + "properties": { + "image": { + "$ref": "CloudAiLargeModelsVisionImage", + "description": "Image." + }, + "video": { + "$ref": "CloudAiLargeModelsVisionVideo", + "description": "Video" + } + }, + "type": "object" + }, + "CloudAiLargeModelsVisionMediaGenerateContentResponse": { + "description": "Generate media content response", + "id": "CloudAiLargeModelsVisionMediaGenerateContentResponse", + "properties": { + "response": { + "$ref": "CloudAiNlLlmProtoServiceGenerateMultiModalResponse", + "description": "Response to the user's request." + } + }, + "type": "object" + }, + "CloudAiLargeModelsVisionNamedBoundingBox": { + "id": "CloudAiLargeModelsVisionNamedBoundingBox", + "properties": { + "classes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "entities": { + "items": { + "type": "string" + }, + "type": "array" + }, + "scores": { + "items": { + "format": "float", + "type": "number" + }, + "type": "array" + }, + "x1": { + "format": "float", + "type": "number" + }, + "x2": { + "format": "float", + "type": "number" + }, + "y1": { + "format": "float", + "type": "number" + }, + "y2": { + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "CloudAiLargeModelsVisionRaiInfo": { + "id": "CloudAiLargeModelsVisionRaiInfo", + "properties": { + "raiCategories": { + "description": "List of rai categories' information to return", + "items": { + "type": "string" + }, + "type": "array" + }, + "scores": { + "description": "List of rai scores mapping to the rai categories. Rounded to 1 decimal place.", + "items": { + "format": "float", + "type": "number" + }, + "type": "array" + } + }, + "type": "object" + }, + "CloudAiLargeModelsVisionReasonVideoResponse": { + "description": "Video reasoning response.", + "id": "CloudAiLargeModelsVisionReasonVideoResponse", + "properties": { + "responses": { + "description": "Generated text responses. The generated responses for different segments within the same video.", + "items": { + "$ref": "CloudAiLargeModelsVisionReasonVideoResponseTextResponse" + }, + "type": "array" + } + }, + "type": "object" + }, + "CloudAiLargeModelsVisionReasonVideoResponseTextResponse": { + "description": "Contains text that is the response of the video captioning.", + "id": "CloudAiLargeModelsVisionReasonVideoResponseTextResponse", + "properties": { + "relativeTemporalPartition": { + "$ref": "CloudAiLargeModelsVisionRelativeTemporalPartition", + "description": "Partition of the caption's video in time. This field is intended for video captioning. To represent the start time and end time of the caption's video." + }, + "text": { + "description": "Text information", + "type": "string" + } + }, + "type": "object" + }, + "CloudAiLargeModelsVisionRelativeTemporalPartition": { + "description": "For ease of use, assume that the start_offset is inclusive and the end_offset is exclusive. In mathematical terms, the partition would be written as [start_offset, end_offset).", + "id": "CloudAiLargeModelsVisionRelativeTemporalPartition", + "properties": { + "endOffset": { + "description": "End time offset of the partition.", + "format": "google-duration", + "type": "string" + }, + "startOffset": { + "description": "Start time offset of the partition.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, + "CloudAiLargeModelsVisionSemanticFilterResponse": { + "id": "CloudAiLargeModelsVisionSemanticFilterResponse", + "properties": { + "namedBoundingBoxes": { + "description": "Class labels of the bounding boxes that failed the semantic filtering. Bounding box coordinates.", + "items": { + "$ref": "CloudAiLargeModelsVisionNamedBoundingBox" + }, + "type": "array" + }, + "passedSemanticFilter": { + "description": "This response is added when semantic filter config is turned on in EditConfig. It reports if this image is passed semantic filter response. If passed_semantic_filter is false, the bounding box information will be populated for user to check what caused the semantic filter to fail.", + "type": "boolean" + } + }, + "type": "object" + }, + "CloudAiLargeModelsVisionVideo": { + "description": "Video", + "id": "CloudAiLargeModelsVisionVideo", + "properties": { + "uri": { + "description": "Path to another storage (typically Google Cloud Storage).", + "type": "string" + }, + "video": { + "description": "Raw bytes.", + "format": "byte", + "type": "string" + } + }, + "type": "object" + }, + "CloudAiNlLlmProtoServiceCandidate": { + "id": "CloudAiNlLlmProtoServiceCandidate", + "properties": { + "citationMetadata": { + "$ref": "CloudAiNlLlmProtoServiceCitationMetadata", + "description": "Source attribution of the generated content." + }, + "content": { + "$ref": "CloudAiNlLlmProtoServiceContent", + "description": "Content of the candidate." + }, + "finishMessage": { + "description": "A string that describes the filtering behavior in more detail. Only filled when reason is set.", + "type": "string" + }, + "finishReason": { + "description": "The reason why the model stopped generating tokens.", + "enum": [ + "FINISH_REASON_UNSPECIFIED", + "FINISH_REASON_STOP", + "FINISH_REASON_MAX_TOKENS", + "FINISH_REASON_SAFETY", + "FINISH_REASON_RECITATION", + "FINISH_REASON_OTHER" + ], + "enumDescriptions": [ + "The finish reason is unspecified.", + "Natural stop point of the model or provided stop sequence.", + "The maximum number of tokens as specified in the request was reached.", + "The token generation was stopped as the response was flagged for safety reasons. NOTE: When streaming the Candidate.content will be empty if content filters blocked the output.", + "The token generation was stopped as the response was flagged for unauthorized citations.", + "All other reasons that stopped the token generation." + ], + "type": "string" + }, + "index": { + "description": "Index of the candidate.", + "format": "int32", + "type": "integer" + }, + "safetyRatings": { + "description": "Safety ratings of the generated content.", + "items": { + "$ref": "CloudAiNlLlmProtoServiceSafetyRating" + }, + "type": "array" + } + }, + "type": "object" + }, + "CloudAiNlLlmProtoServiceCitation": { + "description": "Source attributions for content.", + "id": "CloudAiNlLlmProtoServiceCitation", + "properties": { + "endIndex": { + "description": "End index into the content.", + "format": "int32", + "type": "integer" + }, + "license": { + "description": "License of the attribution.", + "type": "string" + }, + "publicationDate": { + "$ref": "GoogleTypeDate", + "description": "Publication date of the attribution." + }, + "startIndex": { + "description": "Start index into the content.", + "format": "int32", + "type": "integer" + }, + "title": { + "description": "Title of the attribution.", + "type": "string" + }, + "uri": { + "description": "Url reference of the attribution.", + "type": "string" + } + }, + "type": "object" + }, + "CloudAiNlLlmProtoServiceCitationMetadata": { + "description": "A collection of source attributions for a piece of content.", + "id": "CloudAiNlLlmProtoServiceCitationMetadata", + "properties": { + "citations": { + "description": "List of citations.", + "items": { + "$ref": "CloudAiNlLlmProtoServiceCitation" + }, + "type": "array" + } + }, + "type": "object" + }, + "CloudAiNlLlmProtoServiceContent": { + "description": "The content of a single message from a participant.", + "id": "CloudAiNlLlmProtoServiceContent", + "properties": { + "parts": { + "description": "The parts of the message.", + "items": { + "$ref": "CloudAiNlLlmProtoServicePart" + }, + "type": "array" + }, + "role": { + "description": "The role of the current conversation participant.", + "type": "string" + } + }, + "type": "object" + }, + "CloudAiNlLlmProtoServiceFunctionCall": { + "description": "Function call details.", + "id": "CloudAiNlLlmProtoServiceFunctionCall", + "properties": { + "args": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The function parameters and values in JSON format.", + "type": "object" + }, + "name": { + "description": "Required. The name of the function to call.", + "type": "string" + } + }, + "type": "object" + }, + "CloudAiNlLlmProtoServiceFunctionResponse": { + "description": "Function response details.", + "id": "CloudAiNlLlmProtoServiceFunctionResponse", + "properties": { + "name": { + "description": "Required. The name of the function to call.", + "type": "string" + }, + "response": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Required. The function response in JSON object format.", + "type": "object" + } + }, + "type": "object" + }, + "CloudAiNlLlmProtoServiceGenerateMultiModalResponse": { + "id": "CloudAiNlLlmProtoServiceGenerateMultiModalResponse", + "properties": { + "candidates": { + "description": "Possible candidate responses to the conversation up until this point.", + "items": { + "$ref": "CloudAiNlLlmProtoServiceCandidate" + }, + "type": "array" + }, + "promptFeedback": { + "$ref": "CloudAiNlLlmProtoServicePromptFeedback", + "description": "Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations." + }, + "reportingMetrics": { + "$ref": "IntelligenceCloudAutomlXpsReportingMetrics", + "description": "Billable prediction metrics." + }, + "usageMetadata": { + "$ref": "CloudAiNlLlmProtoServiceUsageMetadata", + "description": "Usage metadata about the response(s)." + } + }, + "type": "object" + }, + "CloudAiNlLlmProtoServicePart": { + "description": "A single part of a message.", + "id": "CloudAiNlLlmProtoServicePart", + "properties": { + "fileData": { + "$ref": "CloudAiNlLlmProtoServicePartFileData", + "description": "URI-based data." + }, + "functionCall": { + "$ref": "CloudAiNlLlmProtoServiceFunctionCall", + "description": "Function call data." + }, + "functionResponse": { + "$ref": "CloudAiNlLlmProtoServiceFunctionResponse", + "description": "Function response data." + }, + "inlineData": { + "$ref": "CloudAiNlLlmProtoServicePartBlob", + "description": "Inline bytes data" + }, + "text": { + "description": "Text input.", + "type": "string" + }, + "videoMetadata": { + "$ref": "CloudAiNlLlmProtoServicePartVideoMetadata", + "description": "Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data." + } + }, + "type": "object" + }, + "CloudAiNlLlmProtoServicePartBlob": { + "description": "Represents arbitrary blob data input.", + "id": "CloudAiNlLlmProtoServicePartBlob", + "properties": { + "data": { + "description": "Inline data.", + "format": "byte", + "type": "string" + }, + "mimeType": { + "description": "The mime type corresponding to this input.", + "type": "string" + }, + "originalFileData": { + "$ref": "CloudAiNlLlmProtoServicePartFileData", + "description": "Original file data where the blob comes from." + } + }, + "type": "object" + }, + "CloudAiNlLlmProtoServicePartFileData": { + "description": "Represents file data.", + "id": "CloudAiNlLlmProtoServicePartFileData", + "properties": { + "fileUri": { + "description": "Inline data.", + "type": "string" + }, + "mimeType": { + "description": "The mime type corresponding to this input.", + "type": "string" + } + }, + "type": "object" + }, + "CloudAiNlLlmProtoServicePartVideoMetadata": { + "description": "Metadata describes the input video content.", + "id": "CloudAiNlLlmProtoServicePartVideoMetadata", + "properties": { + "endOffset": { + "description": "The end offset of the video.", + "format": "google-duration", + "type": "string" + }, + "startOffset": { + "description": "The start offset of the video.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, + "CloudAiNlLlmProtoServicePromptFeedback": { + "description": "Content filter results for a prompt sent in the request.", + "id": "CloudAiNlLlmProtoServicePromptFeedback", + "properties": { + "blockReason": { + "description": "Blocked reason.", + "enum": [ + "BLOCKED_REASON_UNSPECIFIED", + "SAFETY", + "OTHER" + ], + "enumDescriptions": [ + "Unspecified blocked reason.", + "Candidates blocked due to safety.", + "Candidates blocked due to other reason." + ], + "type": "string" + }, + "blockReasonMessage": { + "description": "A readable block reason message.", + "type": "string" + }, + "safetyRatings": { + "description": "Safety ratings.", + "items": { + "$ref": "CloudAiNlLlmProtoServiceSafetyRating" + }, + "type": "array" + } + }, + "type": "object" + }, + "CloudAiNlLlmProtoServiceSafetyRating": { + "description": "Safety rating corresponding to the generated content.", + "id": "CloudAiNlLlmProtoServiceSafetyRating", + "properties": { + "blocked": { + "description": "Indicates whether the content was filtered out because of this rating.", + "type": "boolean" + }, + "category": { + "description": "Harm category.", + "enum": [ + "HARM_CATEGORY_UNSPECIFIED", + "HARM_CATEGORY_HATE_SPEECH", + "HARM_CATEGORY_DANGEROUS_CONTENT", + "HARM_CATEGORY_HARASSMENT", + "HARM_CATEGORY_SEXUALLY_EXPLICIT" + ], + "enumDescriptions": [ + "The harm category is unspecified.", + "The harm category is hate speech.", + "The harm category is dengerous content.", + "The harm category is harassment.", + "The harm category is sexually explicit." + ], + "type": "string" + }, + "probability": { + "description": "Harm probability levels in the content.", + "enum": [ + "HARM_PROBABILITY_UNSPECIFIED", + "NEGLIGIBLE", + "LOW", + "MEDIUM", + "HIGH" + ], + "enumDescriptions": [ + "Harm probability unspecified.", + "Negligible level of harm.", + "Low level of harm.", + "Medium level of harm.", + "High level of harm." + ], + "type": "string" + } + }, + "type": "object" + }, + "CloudAiNlLlmProtoServiceUsageMetadata": { + "description": "Usage metadata about response(s).", + "id": "CloudAiNlLlmProtoServiceUsageMetadata", + "properties": { + "candidatesTokenCount": { + "description": "Number of tokens in the response(s).", + "format": "int32", + "type": "integer" + }, + "promptTokenCount": { + "description": "Number of tokens in the request.", + "format": "int32", + "type": "integer" + }, + "totalTokenCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "GoogleApiHttpBody": { "description": "Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.", "id": "GoogleApiHttpBody", @@ -15531,14 +16255,14 @@ "id": "GoogleCloudAiplatformV1BatchPredictionJobInstanceConfig", "properties": { "excludedFields": { - "description": "Fields that will be excluded in the prediction instance that is sent to the Model. Excluded will be attached to the batch prediction output if key_field is not specified. When excluded_fields is populated, included_fields must be empty. The input must be JSONL with objects at each line, CSV, BigQuery or TfRecord.", + "description": "Fields that will be excluded in the prediction instance that is sent to the Model. Excluded will be attached to the batch prediction output if key_field is not specified. When excluded_fields is populated, included_fields must be empty. The input must be JSONL with objects at each line, BigQuery or TfRecord.", "items": { "type": "string" }, "type": "array" }, "includedFields": { - "description": "Fields that will be included in the prediction instance that is sent to the Model. If instance_type is `array`, the order of field names in included_fields also determines the order of the values in the array. When included_fields is populated, excluded_fields must be empty. The input must be JSONL with objects at each line, CSV, BigQuery or TfRecord.", + "description": "Fields that will be included in the prediction instance that is sent to the Model. If instance_type is `array`, the order of field names in included_fields also determines the order of the values in the array. When included_fields is populated, excluded_fields must be empty. The input must be JSONL with objects at each line, BigQuery or TfRecord.", "items": { "type": "string" }, @@ -15721,16 +16445,16 @@ "type": "object" }, "GoogleCloudAiplatformV1Blob": { - "description": "Content blob.", + "description": "Raw media bytes. Text should not be sent as raw bytes, use the 'text' field.", "id": "GoogleCloudAiplatformV1Blob", "properties": { "data": { - "description": "Required. Data.", + "description": "Required. Raw bytes for media formats.", "format": "byte", "type": "string" }, "mimeType": { - "description": "Required. Mime type of the data.", + "description": "Required. The IANA standard MIME type of the source data.", "type": "string" } }, @@ -15962,18 +16686,18 @@ "type": "object" }, "GoogleCloudAiplatformV1Content": { - "description": "A single turn in a conversation with the model.", + "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.", "id": "GoogleCloudAiplatformV1Content", "properties": { "parts": { - "description": "Required. Ordered parts that make up a message. Parts may have different MIME types.", + "description": "Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.", "items": { "$ref": "GoogleCloudAiplatformV1Part" }, "type": "array" }, "role": { - "description": "Optional. The role in a conversation associated with this content. Set it only if a content represents a turn in a conversations, otherwise no need to set role. Possible values: user, model.", + "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.", "type": "string" } }, @@ -16566,6 +17290,13 @@ "description": "Optional. The Experiment Run associated with this job. Format: `projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}-{experiment-run-name}`", "type": "string" }, + "models": { + "description": "Optional. The name of the Model resources for which to generate a mapping to artifact URIs. Applicable only to some of the Google-provided custom jobs. Format: `projects/{project}/locations/{location}/models/{model}` In order to retrieve a specific version of the model, also provide the version ID or version alias. Example: `projects/{project}/locations/{location}/models/{model}@2` or `projects/{project}/locations/{location}/models/{model}@golden` If no version ID or alias is specified, the \"default\" version will be returned. The \"default\" version alias is created for the first version of the model, and can be moved to other versions later on. There will be exactly one default version.", + "items": { + "type": "string" + }, + "type": "array" + }, "network": { "description": "Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Job should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the job is not peered with any network.", "type": "string" @@ -18423,7 +19154,7 @@ "id": "GoogleCloudAiplatformV1ExportDataConfig", "properties": { "annotationSchemaUri": { - "description": "Only used for custom training data export use cases. Only applicable to Datasets that have DataItems and Annotations. Cloud Storage URI that points to a YAML file describing the annotation schema. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/annotation/, note that the chosen schema must be consistent with metadata of the Dataset specified by dataset_id. Only Annotations that both match this schema and belong to DataItems not ignored by the split method are used in respectively training, validation or test role, depending on the role of the DataItem they are on. When used in conjunction with annotations_filter, the Annotations used for training are filtered by both annotations_filter and annotation_schema_uri.", + "description": "The Cloud Storage URI that points to a YAML file describing the annotation schema. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/annotation/, note that the chosen schema must be consistent with metadata of the Dataset specified by dataset_id. Only used for custom training data export use cases. Only applicable to Datasets that have DataItems and Annotations. Only Annotations that both match this schema and belong to DataItems not ignored by the split method are used in respectively training, validation or test role, depending on the role of the DataItem they are on. When used in conjunction with annotations_filter, the Annotations used for training are filtered by both annotations_filter and annotation_schema_uri.", "type": "string" }, "annotationsFilter": { @@ -18455,7 +19186,7 @@ "description": "The Google Cloud Storage location where the output is to be written to. In the given directory a new directory will be created with name: `export-data--` where timestamp is in YYYY-MM-DDThh:mm:ss.sssZ ISO-8601 format. All export output will be written into that directory. Inside that directory, annotations with the same schema will be grouped into sub directories which are named with the corresponding annotations' schema title. Inside these sub directories, a schema.yaml will be created to describe the output format." }, "savedQueryId": { - "description": "Only used for custom training data export use cases. Only applicable to Datasets that have SavedQueries. The ID of a SavedQuery (annotation set) under the Dataset specified by dataset_id used for filtering Annotations for training. Only Annotations that are associated with this SavedQuery are used in respectively training. When used in conjunction with annotations_filter, the Annotations used for training are filtered by both saved_query_id and annotations_filter. Only one of saved_query_id and annotation_schema_uri should be specified as both of them represent the same thing: problem type.", + "description": "The ID of a SavedQuery (annotation set) under the Dataset specified by dataset_id used for filtering Annotations for training. Only used for custom training data export use cases. Only applicable to Datasets that have SavedQueries. Only Annotations that are associated with this SavedQuery are used in respectively training. When used in conjunction with annotations_filter, the Annotations used for training are filtered by both saved_query_id and annotations_filter. Only one of saved_query_id and annotation_schema_uri should be specified as both of them represent the same thing: problem type.", "type": "string" } }, @@ -19589,7 +20320,7 @@ "type": "string" }, "mimeType": { - "description": "Required. Mime type of the data.", + "description": "Required. The IANA standard MIME type of the source data.", "type": "string" } }, @@ -19737,44 +20468,6 @@ }, "type": "object" }, - "GoogleCloudAiplatformV1FunctionCall": { - "description": "A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values.", - "id": "GoogleCloudAiplatformV1FunctionCall", - "properties": { - "args": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "Optional. Required. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.", - "type": "object" - }, - "name": { - "description": "Required. The name of the function to call. Matches [FunctionDeclaration.name].", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudAiplatformV1FunctionResponse": { - "description": "The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction.", - "id": "GoogleCloudAiplatformV1FunctionResponse", - "properties": { - "name": { - "description": "Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].", - "type": "string" - }, - "response": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "Required. The function response in JSON object format.", - "type": "object" - } - }, - "type": "object" - }, "GoogleCloudAiplatformV1GcsDestination": { "description": "The Google Cloud Storage location where the output is to be written to.", "id": "GoogleCloudAiplatformV1GcsDestination", @@ -22956,7 +23649,8 @@ "CUSTOM", "BQML", "MODEL_GARDEN", - "GENIE" + "GENIE", + "CUSTOM_TEXT_EMBEDDING" ], "enumDescriptions": [ "Should not be used.", @@ -22964,7 +23658,8 @@ "The Model is uploaded by user or custom training pipeline.", "The Model is registered and sync'ed from BigQuery ML.", "The Model is saved or tuned from Model Garden.", - "The Model is saved or tuned from Genie." + "The Model is saved or tuned from Genie.", + "The Model is uploaded by text embedding finetuning pipeline." ], "type": "string" } @@ -23769,21 +24464,13 @@ "type": "object" }, "GoogleCloudAiplatformV1Part": { - "description": "Content part.", + "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.", "id": "GoogleCloudAiplatformV1Part", "properties": { "fileData": { "$ref": "GoogleCloudAiplatformV1FileData", "description": "Optional. URI based data." }, - "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." - }, - "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." - }, "inlineData": { "$ref": "GoogleCloudAiplatformV1Blob", "description": "Optional. Inlined bytes data." @@ -24596,6 +25283,20 @@ "description": "Output only. Immutable. The version ID of the PublisherModel. A new version is committed when a new model version is uploaded under an existing model id. It is an auto-incrementing decimal number in string representation.", "readOnly": true, "type": "string" + }, + "versionState": { + "description": "Optional. Indicates the state of the model version.", + "enum": [ + "VERSION_STATE_UNSPECIFIED", + "VERSION_STATE_STABLE", + "VERSION_STATE_UNSTABLE" + ], + "enumDescriptions": [ + "The version state is unspecified.", + "Used to indicate the version is stable.", + "Used to indicate the version is unstable." + ], + "type": "string" } }, "type": "object" @@ -24675,6 +25376,10 @@ "description": "Optional. Default model display name.", "type": "string" }, + "publicArtifactUri": { + "description": "Optional. The signed URI for ephemeral Cloud Storage access to model artifact.", + "type": "string" + }, "sharedResources": { "description": "The resource name of the shared DeploymentResourcePool to deploy on. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`", "type": "string" @@ -24741,6 +25446,10 @@ "description": "Reference to a resource.", "id": "GoogleCloudAiplatformV1PublisherModelResourceReference", "properties": { + "description": { + "description": "Description of the resource.", + "type": "string" + }, "resourceName": { "description": "The resource name of the Google Cloud resource.", "type": "string" @@ -24748,6 +25457,10 @@ "uri": { "description": "The URI of the resource.", "type": "string" + }, + "useCase": { + "description": "Use case (CUJ) of the resource.", + "type": "string" } }, "type": "object" @@ -31719,6 +32432,28 @@ }, "type": "object" }, + "GoogleTypeDate": { + "description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp", + "id": "GoogleTypeDate", + "properties": { + "day": { + "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", + "format": "int32", + "type": "integer" + }, + "month": { + "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", + "format": "int32", + "type": "integer" + }, + "year": { + "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "GoogleTypeExpr": { "description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() \u003c 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' \u0026\u0026 document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.", "id": "GoogleTypeExpr", @@ -31779,6 +32514,70 @@ } }, "type": "object" + }, + "IntelligenceCloudAutomlXpsMetricEntry": { + "id": "IntelligenceCloudAutomlXpsMetricEntry", + "properties": { + "argentumMetricId": { + "description": "For billing metrics that are using legacy sku's, set the legacy billing metric id here. This will be sent to Chemist as the \"cloudbilling.googleapis.com/argentum_metric_id\" label. Otherwise leave empty.", + "type": "string" + }, + "doubleValue": { + "description": "A double value.", + "format": "double", + "type": "number" + }, + "int64Value": { + "description": "A signed 64-bit integer value.", + "format": "int64", + "type": "string" + }, + "metricName": { + "description": "The metric name defined in the service configuration.", + "type": "string" + }, + "systemLabels": { + "description": "Billing system labels for this (metric, value) pair.", + "items": { + "$ref": "IntelligenceCloudAutomlXpsMetricEntryLabel" + }, + "type": "array" + } + }, + "type": "object" + }, + "IntelligenceCloudAutomlXpsMetricEntryLabel": { + "id": "IntelligenceCloudAutomlXpsMetricEntryLabel", + "properties": { + "labelName": { + "description": "The name of the label.", + "type": "string" + }, + "labelValue": { + "description": "The value of the label.", + "type": "string" + } + }, + "type": "object" + }, + "IntelligenceCloudAutomlXpsReportingMetrics": { + "id": "IntelligenceCloudAutomlXpsReportingMetrics", + "properties": { + "effectiveTrainingDuration": { + "deprecated": true, + "description": "The effective time training used. If set, this is used for quota management and billing. Deprecated. AutoML BE doesn't use this. Don't set.", + "format": "google-duration", + "type": "string" + }, + "metricEntries": { + "description": "One entry per metric name. The values must be aggregated per metric name.", + "items": { + "$ref": "IntelligenceCloudAutomlXpsMetricEntry" + }, + "type": "array" + } + }, + "type": "object" } }, "servicePath": "", diff --git a/aiplatform/v1/aiplatform-gen.go b/aiplatform/v1/aiplatform-gen.go index 3bca2494c5..a5a32e5672 100644 --- a/aiplatform/v1/aiplatform-gen.go +++ b/aiplatform/v1/aiplatform-gen.go @@ -1190,6 +1190,1130 @@ type PublishersModelsService struct { s *Service } +// CloudAiLargeModelsVisionEmbedVideoResponse: Video embedding response. +type CloudAiLargeModelsVisionEmbedVideoResponse struct { + // VideoEmbeddings: The embedding vector for the video. + VideoEmbeddings []interface{} `json:"videoEmbeddings,omitempty"` + + // ForceSendFields is a list of field names (e.g. "VideoEmbeddings") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "VideoEmbeddings") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *CloudAiLargeModelsVisionEmbedVideoResponse) MarshalJSON() ([]byte, error) { + type NoMethod CloudAiLargeModelsVisionEmbedVideoResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// CloudAiLargeModelsVisionFilteredText: Details for filtered input +// text. +type CloudAiLargeModelsVisionFilteredText struct { + // Category: Confidence level + // + // Possible values: + // "RAI_CATEGORY_UNSPECIFIED" + // "OBSCENE" + // "SEXUALLY_EXPLICIT" - Porn + // "IDENTITY_ATTACK" - Hate + // "VIOLENCE_ABUSE" + // "CSAI" + // "SPII" + // "CELEBRITY" + // "FACE_IMG" + // "WATERMARK_IMG" + // "MEMORIZATION_IMG" + // "CSAI_IMG" + // "PORN_IMG" + // "VIOLENCE_IMG" + // "CHILD_IMG" + // "TOXIC" + // "SENSITIVE_WORD" + // "PERSON_IMG" + // "ICA_IMG" + // "SEXUAL_IMG" + // "IU_IMG" + // "RACY_IMG" + // "PEDO_IMG" + // "DEATH_HARM_TRAGEDY" - SafetyAttributes returned but not filtered + // on + // "HEALTH" + // "FIREARMS_WEAPONS" + // "RELIGIOUS_BELIEF" + // "ILLICIT_DRUGS" + // "WAR_CONFLICT" + // "POLITICS" + // "HATE_SYMBOL_IMG" - End of list + // "CHILD_TEXT" + // "DANGEROUS_CONTENT" - Text category from SafetyCat v3 + // "RECITATION_TEXT" + Category string `json:"category,omitempty"` + + // Confidence: Filtered category + // + // Possible values: + // "CONFIDENCE_UNSPECIFIED" + // "CONFIDENCE_LOW" + // "CONFIDENCE_MEDIUM" + // "CONFIDENCE_HIGH" + Confidence string `json:"confidence,omitempty"` + + // Prompt: Input prompt + Prompt string `json:"prompt,omitempty"` + + // Score: Score for category + Score float64 `json:"score,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Category") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Category") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *CloudAiLargeModelsVisionFilteredText) MarshalJSON() ([]byte, error) { + type NoMethod CloudAiLargeModelsVisionFilteredText + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *CloudAiLargeModelsVisionFilteredText) UnmarshalJSON(data []byte) error { + type NoMethod CloudAiLargeModelsVisionFilteredText + 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 +} + +// CloudAiLargeModelsVisionGenerateVideoResponse: Generate video +// response. +type CloudAiLargeModelsVisionGenerateVideoResponse struct { + // GeneratedSamples: The generates samples. + GeneratedSamples []*CloudAiLargeModelsVisionMedia `json:"generatedSamples,omitempty"` + + // RaiMediaFilteredCount: Returns if any videos were filtered due to RAI + // policies. + RaiMediaFilteredCount int64 `json:"raiMediaFilteredCount,omitempty"` + + // RaiMediaFilteredReasons: Returns rai failure reasons if any. + RaiMediaFilteredReasons []string `json:"raiMediaFilteredReasons,omitempty"` + + // RaiTextFilteredReason: Returns filtered text rai info. + RaiTextFilteredReason *CloudAiLargeModelsVisionFilteredText `json:"raiTextFilteredReason,omitempty"` + + // ForceSendFields is a list of field names (e.g. "GeneratedSamples") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "GeneratedSamples") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *CloudAiLargeModelsVisionGenerateVideoResponse) MarshalJSON() ([]byte, error) { + type NoMethod CloudAiLargeModelsVisionGenerateVideoResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// CloudAiLargeModelsVisionImage: Image. +type CloudAiLargeModelsVisionImage struct { + // Encoding: Image encoding, encoded as "image/png" or "image/jpg". + Encoding string `json:"encoding,omitempty"` + + // Image: Raw bytes. + Image string `json:"image,omitempty"` + + // ImageRaiScores: RAI scores for generated image. + ImageRaiScores *CloudAiLargeModelsVisionImageRAIScores `json:"imageRaiScores,omitempty"` + + // RaiInfo: RAI info for image + RaiInfo *CloudAiLargeModelsVisionRaiInfo `json:"raiInfo,omitempty"` + + // SemanticFilterResponse: Semantic filter info for image. + SemanticFilterResponse *CloudAiLargeModelsVisionSemanticFilterResponse `json:"semanticFilterResponse,omitempty"` + + // Uri: Path to another storage (typically Google Cloud Storage). + Uri string `json:"uri,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Encoding") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Encoding") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *CloudAiLargeModelsVisionImage) MarshalJSON() ([]byte, error) { + type NoMethod CloudAiLargeModelsVisionImage + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// CloudAiLargeModelsVisionImageRAIScores: RAI scores for generated +// image returned. +type CloudAiLargeModelsVisionImageRAIScores struct { + // AgileWatermarkDetectionScore: Agile watermark score for image. + AgileWatermarkDetectionScore float64 `json:"agileWatermarkDetectionScore,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "AgileWatermarkDetectionScore") to unconditionally include in API + // requests. By default, fields with empty or default values are omitted + // from API requests. However, any non-pointer, non-interface field + // appearing in ForceSendFields will be sent to the server regardless of + // whether the field is empty or not. This may be used to include empty + // fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. + // "AgileWatermarkDetectionScore") to include in API requests with the + // JSON null value. By default, fields with empty values are omitted + // from API requests. However, any field with an empty value appearing + // in NullFields will be sent to the server as null. It is an error if a + // field in this list has a non-empty value. This may be used to include + // null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *CloudAiLargeModelsVisionImageRAIScores) MarshalJSON() ([]byte, error) { + type NoMethod CloudAiLargeModelsVisionImageRAIScores + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *CloudAiLargeModelsVisionImageRAIScores) UnmarshalJSON(data []byte) error { + type NoMethod CloudAiLargeModelsVisionImageRAIScores + var s1 struct { + AgileWatermarkDetectionScore gensupport.JSONFloat64 `json:"agileWatermarkDetectionScore"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.AgileWatermarkDetectionScore = float64(s1.AgileWatermarkDetectionScore) + return nil +} + +// CloudAiLargeModelsVisionMedia: Media. +type CloudAiLargeModelsVisionMedia struct { + // Image: Image. + Image *CloudAiLargeModelsVisionImage `json:"image,omitempty"` + + // Video: Video + Video *CloudAiLargeModelsVisionVideo `json:"video,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Image") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Image") to include in API + // requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *CloudAiLargeModelsVisionMedia) MarshalJSON() ([]byte, error) { + type NoMethod CloudAiLargeModelsVisionMedia + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// CloudAiLargeModelsVisionMediaGenerateContentResponse: Generate media +// content response +type CloudAiLargeModelsVisionMediaGenerateContentResponse struct { + // Response: Response to the user's request. + Response *CloudAiNlLlmProtoServiceGenerateMultiModalResponse `json:"response,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Response") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Response") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *CloudAiLargeModelsVisionMediaGenerateContentResponse) MarshalJSON() ([]byte, error) { + type NoMethod CloudAiLargeModelsVisionMediaGenerateContentResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +type CloudAiLargeModelsVisionNamedBoundingBox struct { + Classes []string `json:"classes,omitempty"` + + Entities []string `json:"entities,omitempty"` + + Scores []float64 `json:"scores,omitempty"` + + X1 float64 `json:"x1,omitempty"` + + X2 float64 `json:"x2,omitempty"` + + Y1 float64 `json:"y1,omitempty"` + + Y2 float64 `json:"y2,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Classes") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Classes") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *CloudAiLargeModelsVisionNamedBoundingBox) MarshalJSON() ([]byte, error) { + type NoMethod CloudAiLargeModelsVisionNamedBoundingBox + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *CloudAiLargeModelsVisionNamedBoundingBox) UnmarshalJSON(data []byte) error { + type NoMethod CloudAiLargeModelsVisionNamedBoundingBox + var s1 struct { + Scores []gensupport.JSONFloat64 `json:"scores"` + X1 gensupport.JSONFloat64 `json:"x1"` + X2 gensupport.JSONFloat64 `json:"x2"` + Y1 gensupport.JSONFloat64 `json:"y1"` + Y2 gensupport.JSONFloat64 `json:"y2"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.Scores = make([]float64, len(s1.Scores)) + for i := range s1.Scores { + s.Scores[i] = float64(s1.Scores[i]) + } + s.X1 = float64(s1.X1) + s.X2 = float64(s1.X2) + s.Y1 = float64(s1.Y1) + s.Y2 = float64(s1.Y2) + return nil +} + +type CloudAiLargeModelsVisionRaiInfo struct { + // RaiCategories: List of rai categories' information to return + RaiCategories []string `json:"raiCategories,omitempty"` + + // Scores: List of rai scores mapping to the rai categories. Rounded to + // 1 decimal place. + Scores []float64 `json:"scores,omitempty"` + + // ForceSendFields is a list of field names (e.g. "RaiCategories") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "RaiCategories") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *CloudAiLargeModelsVisionRaiInfo) MarshalJSON() ([]byte, error) { + type NoMethod CloudAiLargeModelsVisionRaiInfo + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *CloudAiLargeModelsVisionRaiInfo) UnmarshalJSON(data []byte) error { + type NoMethod CloudAiLargeModelsVisionRaiInfo + var s1 struct { + Scores []gensupport.JSONFloat64 `json:"scores"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.Scores = make([]float64, len(s1.Scores)) + for i := range s1.Scores { + s.Scores[i] = float64(s1.Scores[i]) + } + return nil +} + +// CloudAiLargeModelsVisionReasonVideoResponse: Video reasoning +// response. +type CloudAiLargeModelsVisionReasonVideoResponse struct { + // Responses: Generated text responses. The generated responses for + // different segments within the same video. + Responses []*CloudAiLargeModelsVisionReasonVideoResponseTextResponse `json:"responses,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Responses") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Responses") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *CloudAiLargeModelsVisionReasonVideoResponse) MarshalJSON() ([]byte, error) { + type NoMethod CloudAiLargeModelsVisionReasonVideoResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// CloudAiLargeModelsVisionReasonVideoResponseTextResponse: Contains +// text that is the response of the video captioning. +type CloudAiLargeModelsVisionReasonVideoResponseTextResponse struct { + // RelativeTemporalPartition: Partition of the caption's video in time. + // This field is intended for video captioning. To represent the start + // time and end time of the caption's video. + RelativeTemporalPartition *CloudAiLargeModelsVisionRelativeTemporalPartition `json:"relativeTemporalPartition,omitempty"` + + // Text: Text information + Text string `json:"text,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "RelativeTemporalPartition") to unconditionally include in API + // requests. By default, fields with empty or default values are omitted + // from API requests. However, any non-pointer, non-interface field + // appearing in ForceSendFields will be sent to the server regardless of + // whether the field is empty or not. This may be used to include empty + // fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. + // "RelativeTemporalPartition") to include in API requests with the JSON + // null value. By default, fields with empty values are omitted from API + // requests. However, any field with an empty value appearing in + // NullFields will be sent to the server as null. It is an error if a + // field in this list has a non-empty value. This may be used to include + // null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *CloudAiLargeModelsVisionReasonVideoResponseTextResponse) MarshalJSON() ([]byte, error) { + type NoMethod CloudAiLargeModelsVisionReasonVideoResponseTextResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// CloudAiLargeModelsVisionRelativeTemporalPartition: For ease of use, +// assume that the start_offset is inclusive and the end_offset is +// exclusive. In mathematical terms, the partition would be written as +// [start_offset, end_offset). +type CloudAiLargeModelsVisionRelativeTemporalPartition struct { + // EndOffset: End time offset of the partition. + EndOffset string `json:"endOffset,omitempty"` + + // StartOffset: Start time offset of the partition. + StartOffset string `json:"startOffset,omitempty"` + + // ForceSendFields is a list of field names (e.g. "EndOffset") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "EndOffset") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *CloudAiLargeModelsVisionRelativeTemporalPartition) MarshalJSON() ([]byte, error) { + type NoMethod CloudAiLargeModelsVisionRelativeTemporalPartition + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +type CloudAiLargeModelsVisionSemanticFilterResponse struct { + // NamedBoundingBoxes: Class labels of the bounding boxes that failed + // the semantic filtering. Bounding box coordinates. + NamedBoundingBoxes []*CloudAiLargeModelsVisionNamedBoundingBox `json:"namedBoundingBoxes,omitempty"` + + // PassedSemanticFilter: This response is added when semantic filter + // config is turned on in EditConfig. It reports if this image is passed + // semantic filter response. If passed_semantic_filter is false, the + // bounding box information will be populated for user to check what + // caused the semantic filter to fail. + PassedSemanticFilter bool `json:"passedSemanticFilter,omitempty"` + + // ForceSendFields is a list of field names (e.g. "NamedBoundingBoxes") + // to unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "NamedBoundingBoxes") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *CloudAiLargeModelsVisionSemanticFilterResponse) MarshalJSON() ([]byte, error) { + type NoMethod CloudAiLargeModelsVisionSemanticFilterResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// CloudAiLargeModelsVisionVideo: Video +type CloudAiLargeModelsVisionVideo struct { + // Uri: Path to another storage (typically Google Cloud Storage). + Uri string `json:"uri,omitempty"` + + // Video: Raw bytes. + Video string `json:"video,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Uri") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Uri") to include in API + // requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *CloudAiLargeModelsVisionVideo) MarshalJSON() ([]byte, error) { + type NoMethod CloudAiLargeModelsVisionVideo + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +type CloudAiNlLlmProtoServiceCandidate struct { + // CitationMetadata: Source attribution of the generated content. + CitationMetadata *CloudAiNlLlmProtoServiceCitationMetadata `json:"citationMetadata,omitempty"` + + // Content: Content of the candidate. + Content *CloudAiNlLlmProtoServiceContent `json:"content,omitempty"` + + // FinishMessage: A string that describes the filtering behavior in more + // detail. Only filled when reason is set. + FinishMessage string `json:"finishMessage,omitempty"` + + // FinishReason: The reason why the model stopped generating tokens. + // + // Possible values: + // "FINISH_REASON_UNSPECIFIED" - The finish reason is unspecified. + // "FINISH_REASON_STOP" - Natural stop point of the model or provided + // stop sequence. + // "FINISH_REASON_MAX_TOKENS" - The maximum number of tokens as + // specified in the request was reached. + // "FINISH_REASON_SAFETY" - The token generation was stopped as the + // response was flagged for safety reasons. NOTE: When streaming the + // Candidate.content will be empty if content filters blocked the + // output. + // "FINISH_REASON_RECITATION" - The token generation was stopped as + // the response was flagged for unauthorized citations. + // "FINISH_REASON_OTHER" - All other reasons that stopped the token + // generation. + FinishReason string `json:"finishReason,omitempty"` + + // Index: Index of the candidate. + Index int64 `json:"index,omitempty"` + + // SafetyRatings: Safety ratings of the generated content. + SafetyRatings []*CloudAiNlLlmProtoServiceSafetyRating `json:"safetyRatings,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CitationMetadata") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "CitationMetadata") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *CloudAiNlLlmProtoServiceCandidate) MarshalJSON() ([]byte, error) { + type NoMethod CloudAiNlLlmProtoServiceCandidate + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// CloudAiNlLlmProtoServiceCitation: Source attributions for content. +type CloudAiNlLlmProtoServiceCitation struct { + // EndIndex: End index into the content. + EndIndex int64 `json:"endIndex,omitempty"` + + // License: License of the attribution. + License string `json:"license,omitempty"` + + // PublicationDate: Publication date of the attribution. + PublicationDate *GoogleTypeDate `json:"publicationDate,omitempty"` + + // StartIndex: Start index into the content. + StartIndex int64 `json:"startIndex,omitempty"` + + // Title: Title of the attribution. + Title string `json:"title,omitempty"` + + // Uri: Url reference of the attribution. + 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 default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "EndIndex") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *CloudAiNlLlmProtoServiceCitation) MarshalJSON() ([]byte, error) { + type NoMethod CloudAiNlLlmProtoServiceCitation + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// CloudAiNlLlmProtoServiceCitationMetadata: A collection of source +// attributions for a piece of content. +type CloudAiNlLlmProtoServiceCitationMetadata struct { + // Citations: List of citations. + Citations []*CloudAiNlLlmProtoServiceCitation `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 default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Citations") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *CloudAiNlLlmProtoServiceCitationMetadata) MarshalJSON() ([]byte, error) { + type NoMethod CloudAiNlLlmProtoServiceCitationMetadata + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// CloudAiNlLlmProtoServiceContent: The content of a single message from +// a participant. +type CloudAiNlLlmProtoServiceContent struct { + // Parts: The parts of the message. + Parts []*CloudAiNlLlmProtoServicePart `json:"parts,omitempty"` + + // Role: The role of the current conversation participant. + 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 omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Parts") to include in API + // requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *CloudAiNlLlmProtoServiceContent) MarshalJSON() ([]byte, error) { + type NoMethod CloudAiNlLlmProtoServiceContent + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// CloudAiNlLlmProtoServiceFunctionCall: Function call details. +type CloudAiNlLlmProtoServiceFunctionCall struct { + // Args: The function parameters and values in JSON format. + Args googleapi.RawMessage `json:"args,omitempty"` + + // Name: Required. The name of the function to call. + Name string `json:"name,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Args") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Args") to include in API + // requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *CloudAiNlLlmProtoServiceFunctionCall) MarshalJSON() ([]byte, error) { + type NoMethod CloudAiNlLlmProtoServiceFunctionCall + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// CloudAiNlLlmProtoServiceFunctionResponse: Function response details. +type CloudAiNlLlmProtoServiceFunctionResponse struct { + // Name: Required. The name of the function to call. + Name string `json:"name,omitempty"` + + // Response: Required. The function response in JSON object format. + Response googleapi.RawMessage `json:"response,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Name") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Name") to include in API + // requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *CloudAiNlLlmProtoServiceFunctionResponse) MarshalJSON() ([]byte, error) { + type NoMethod CloudAiNlLlmProtoServiceFunctionResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +type CloudAiNlLlmProtoServiceGenerateMultiModalResponse struct { + // Candidates: Possible candidate responses to the conversation up until + // this point. + Candidates []*CloudAiNlLlmProtoServiceCandidate `json:"candidates,omitempty"` + + // PromptFeedback: Content filter results for a prompt sent in the + // request. Note: Sent only in the first stream chunk. Only happens when + // no candidates were generated due to content violations. + PromptFeedback *CloudAiNlLlmProtoServicePromptFeedback `json:"promptFeedback,omitempty"` + + // ReportingMetrics: Billable prediction metrics. + ReportingMetrics *IntelligenceCloudAutomlXpsReportingMetrics `json:"reportingMetrics,omitempty"` + + // UsageMetadata: Usage metadata about the response(s). + UsageMetadata *CloudAiNlLlmProtoServiceUsageMetadata `json:"usageMetadata,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Candidates") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Candidates") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *CloudAiNlLlmProtoServiceGenerateMultiModalResponse) MarshalJSON() ([]byte, error) { + type NoMethod CloudAiNlLlmProtoServiceGenerateMultiModalResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// CloudAiNlLlmProtoServicePart: A single part of a message. +type CloudAiNlLlmProtoServicePart struct { + // FileData: URI-based data. + FileData *CloudAiNlLlmProtoServicePartFileData `json:"fileData,omitempty"` + + // FunctionCall: Function call data. + FunctionCall *CloudAiNlLlmProtoServiceFunctionCall `json:"functionCall,omitempty"` + + // FunctionResponse: Function response data. + FunctionResponse *CloudAiNlLlmProtoServiceFunctionResponse `json:"functionResponse,omitempty"` + + // InlineData: Inline bytes data + InlineData *CloudAiNlLlmProtoServicePartBlob `json:"inlineData,omitempty"` + + // Text: Text input. + Text string `json:"text,omitempty"` + + // VideoMetadata: Video metadata. The metadata should only be specified + // while the video data is presented in inline_data or file_data. + VideoMetadata *CloudAiNlLlmProtoServicePartVideoMetadata `json:"videoMetadata,omitempty"` + + // ForceSendFields is a list of field names (e.g. "FileData") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "FileData") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *CloudAiNlLlmProtoServicePart) MarshalJSON() ([]byte, error) { + type NoMethod CloudAiNlLlmProtoServicePart + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// CloudAiNlLlmProtoServicePartBlob: Represents arbitrary blob data +// input. +type CloudAiNlLlmProtoServicePartBlob struct { + // Data: Inline data. + Data string `json:"data,omitempty"` + + // MimeType: The mime type corresponding to this input. + MimeType string `json:"mimeType,omitempty"` + + // OriginalFileData: Original file data where the blob comes from. + OriginalFileData *CloudAiNlLlmProtoServicePartFileData `json:"originalFileData,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Data") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Data") to include in API + // requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *CloudAiNlLlmProtoServicePartBlob) MarshalJSON() ([]byte, error) { + type NoMethod CloudAiNlLlmProtoServicePartBlob + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// CloudAiNlLlmProtoServicePartFileData: Represents file data. +type CloudAiNlLlmProtoServicePartFileData struct { + // FileUri: Inline data. + FileUri string `json:"fileUri,omitempty"` + + // MimeType: The mime type corresponding to this input. + MimeType string `json:"mimeType,omitempty"` + + // ForceSendFields is a list of field names (e.g. "FileUri") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "FileUri") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *CloudAiNlLlmProtoServicePartFileData) MarshalJSON() ([]byte, error) { + type NoMethod CloudAiNlLlmProtoServicePartFileData + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// CloudAiNlLlmProtoServicePartVideoMetadata: Metadata describes the +// input video content. +type CloudAiNlLlmProtoServicePartVideoMetadata struct { + // EndOffset: The end offset of the video. + EndOffset string `json:"endOffset,omitempty"` + + // StartOffset: The start offset of the video. + StartOffset string `json:"startOffset,omitempty"` + + // ForceSendFields is a list of field names (e.g. "EndOffset") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "EndOffset") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *CloudAiNlLlmProtoServicePartVideoMetadata) MarshalJSON() ([]byte, error) { + type NoMethod CloudAiNlLlmProtoServicePartVideoMetadata + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// CloudAiNlLlmProtoServicePromptFeedback: Content filter results for a +// prompt sent in the request. +type CloudAiNlLlmProtoServicePromptFeedback struct { + // BlockReason: Blocked reason. + // + // Possible values: + // "BLOCKED_REASON_UNSPECIFIED" - Unspecified blocked reason. + // "SAFETY" - Candidates blocked due to safety. + // "OTHER" - Candidates blocked due to other reason. + BlockReason string `json:"blockReason,omitempty"` + + // BlockReasonMessage: A readable block reason message. + BlockReasonMessage string `json:"blockReasonMessage,omitempty"` + + // SafetyRatings: Safety ratings. + SafetyRatings []*CloudAiNlLlmProtoServiceSafetyRating `json:"safetyRatings,omitempty"` + + // ForceSendFields is a list of field names (e.g. "BlockReason") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "BlockReason") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *CloudAiNlLlmProtoServicePromptFeedback) MarshalJSON() ([]byte, error) { + type NoMethod CloudAiNlLlmProtoServicePromptFeedback + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// CloudAiNlLlmProtoServiceSafetyRating: Safety rating corresponding to +// the generated content. +type CloudAiNlLlmProtoServiceSafetyRating struct { + // Blocked: Indicates whether the content was filtered out because of + // this rating. + Blocked bool `json:"blocked,omitempty"` + + // Category: Harm category. + // + // 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 dengerous + // content. + // "HARM_CATEGORY_HARASSMENT" - The harm category is harassment. + // "HARM_CATEGORY_SEXUALLY_EXPLICIT" - The harm category is sexually + // explicit. + Category string `json:"category,omitempty"` + + // Probability: Harm probability levels in the content. + // + // 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. + Probability string `json:"probability,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 omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Blocked") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *CloudAiNlLlmProtoServiceSafetyRating) MarshalJSON() ([]byte, error) { + type NoMethod CloudAiNlLlmProtoServiceSafetyRating + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// CloudAiNlLlmProtoServiceUsageMetadata: Usage metadata about +// response(s). +type CloudAiNlLlmProtoServiceUsageMetadata struct { + // CandidatesTokenCount: Number of tokens in the response(s). + CandidatesTokenCount int64 `json:"candidatesTokenCount,omitempty"` + + // PromptTokenCount: Number of tokens in the request. + PromptTokenCount int64 `json:"promptTokenCount,omitempty"` + + TotalTokenCount int64 `json:"totalTokenCount,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "CandidatesTokenCount") to unconditionally include in API requests. + // By default, fields with empty or default values are omitted from API + // requests. However, any non-pointer, non-interface field appearing in + // ForceSendFields will be sent to the server regardless of whether the + // field is empty or not. This may be used to include empty fields in + // Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "CandidatesTokenCount") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *CloudAiNlLlmProtoServiceUsageMetadata) MarshalJSON() ([]byte, error) { + type NoMethod CloudAiNlLlmProtoServiceUsageMetadata + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleApiHttpBody: Message that represents an arbitrary HTTP body. It // should only be used for payload formats that can't be represented as // JSON, such as raw binary or an HTML page. This message can be used @@ -2767,8 +3891,7 @@ type GoogleCloudAiplatformV1BatchPredictionJobInstanceConfig struct { // instance that is sent to the Model. Excluded will be attached to the // batch prediction output if key_field is not specified. When // excluded_fields is populated, included_fields must be empty. The - // input must be JSONL with objects at each line, CSV, BigQuery or - // TfRecord. + // input must be JSONL with objects at each line, BigQuery or TfRecord. ExcludedFields []string `json:"excludedFields,omitempty"` // IncludedFields: Fields that will be included in the prediction @@ -2776,7 +3899,7 @@ type GoogleCloudAiplatformV1BatchPredictionJobInstanceConfig struct { // order of field names in included_fields also determines the order of // the values in the array. When included_fields is populated, // excluded_fields must be empty. The input must be JSONL with objects - // at each line, CSV, BigQuery or TfRecord. + // at each line, BigQuery or TfRecord. IncludedFields []string `json:"includedFields,omitempty"` // InstanceType: The format of the instance that the Model accepts. @@ -3230,12 +4353,13 @@ func (s *GoogleCloudAiplatformV1BigQuerySource) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudAiplatformV1Blob: Content blob. +// GoogleCloudAiplatformV1Blob: Raw media bytes. Text should not be sent +// as raw bytes, use the 'text' field. type GoogleCloudAiplatformV1Blob struct { - // Data: Required. Data. + // Data: Required. Raw bytes for media formats. Data string `json:"data,omitempty"` - // MimeType: Required. Mime type of the data. + // MimeType: Required. The IANA standard MIME type of the source data. MimeType string `json:"mimeType,omitempty"` // ForceSendFields is a list of field names (e.g. "Data") to @@ -3678,17 +4802,19 @@ func (s *GoogleCloudAiplatformV1ContainerSpec) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudAiplatformV1Content: A single turn in a conversation with -// the model. +// 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. type GoogleCloudAiplatformV1Content struct { - // Parts: Required. Ordered parts that make up a message. Parts may have - // different MIME types. + // Parts: Required. Ordered `Parts` that constitute a single message. + // Parts may have different IANA MIME types. Parts []*GoogleCloudAiplatformV1Part `json:"parts,omitempty"` - // Role: Optional. The role in a conversation associated with this - // content. Set it only if a content represents a turn in a - // conversations, otherwise no need to set role. Possible values: user, - // model. + // 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. Role string `json:"role,omitempty"` // ForceSendFields is a list of field names (e.g. "Parts") to @@ -4920,6 +6046,20 @@ type GoogleCloudAiplatformV1CustomJobSpec struct { // s}/contexts/{experiment-name}-{experiment-run-name}` ExperimentRun string `json:"experimentRun,omitempty"` + // Models: Optional. The name of the Model resources for which to + // generate a mapping to artifact URIs. Applicable only to some of the + // Google-provided custom jobs. Format: + // `projects/{project}/locations/{location}/models/{model}` In order to + // retrieve a specific version of the model, also provide the version ID + // or version alias. Example: + // `projects/{project}/locations/{location}/models/{model}@2` or + // `projects/{project}/locations/{location}/models/{model}@golden` If no + // version ID or alias is specified, the "default" version will be + // returned. The "default" version alias is created for the first + // version of the model, and can be moved to other versions later on. + // There will be exactly one default version. + Models []string `json:"models,omitempty"` + // Network: Optional. The full name of the Compute Engine network // (/compute/docs/networks-and-firewalls#networks) to which the Job // should be peered. For example, @@ -8268,19 +9408,19 @@ func (s *GoogleCloudAiplatformV1ExplanationSpecOverride) MarshalJSON() ([]byte, // Dataset is to be exported, the destination of the export and how to // export. type GoogleCloudAiplatformV1ExportDataConfig struct { - // AnnotationSchemaUri: Only used for custom training data export use - // cases. Only applicable to Datasets that have DataItems and - // Annotations. Cloud Storage URI that points to a YAML file describing - // the annotation schema. The schema is defined as an OpenAPI 3.0.2 - // Schema Object + // AnnotationSchemaUri: The Cloud Storage URI that points to a YAML file + // describing the annotation schema. The schema is defined as an OpenAPI + // 3.0.2 Schema Object // (https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). // The schema files that can be used here are found in // gs://google-cloud-aiplatform/schema/dataset/annotation/, note that // the chosen schema must be consistent with metadata of the Dataset - // specified by dataset_id. Only Annotations that both match this schema - // and belong to DataItems not ignored by the split method are used in - // respectively training, validation or test role, depending on the role - // of the DataItem they are on. When used in conjunction with + // specified by dataset_id. Only used for custom training data export + // use cases. Only applicable to Datasets that have DataItems and + // Annotations. Only Annotations that both match this schema and belong + // to DataItems not ignored by the split method are used in respectively + // training, validation or test role, depending on the role of the + // DataItem they are on. When used in conjunction with // annotations_filter, the Annotations used for training are filtered by // both annotations_filter and annotation_schema_uri. AnnotationSchemaUri string `json:"annotationSchemaUri,omitempty"` @@ -8316,10 +9456,10 @@ type GoogleCloudAiplatformV1ExportDataConfig struct { // format. GcsDestination *GoogleCloudAiplatformV1GcsDestination `json:"gcsDestination,omitempty"` - // SavedQueryId: Only used for custom training data export use cases. - // Only applicable to Datasets that have SavedQueries. The ID of a - // SavedQuery (annotation set) under the Dataset specified by dataset_id - // used for filtering Annotations for training. Only Annotations that + // SavedQueryId: The ID of a SavedQuery (annotation set) under the + // Dataset specified by dataset_id used for filtering Annotations for + // training. Only used for custom training data export use cases. Only + // applicable to Datasets that have SavedQueries. Only Annotations that // are associated with this SavedQuery are used in respectively // training. When used in conjunction with annotations_filter, the // Annotations used for training are filtered by both saved_query_id and @@ -10577,7 +11717,7 @@ type GoogleCloudAiplatformV1FileData struct { // FileUri: Required. URI. FileUri string `json:"fileUri,omitempty"` - // MimeType: Required. Mime type of the data. + // MimeType: Required. The IANA standard MIME type of the source data. MimeType string `json:"mimeType,omitempty"` // ForceSendFields is a list of field names (e.g. "FileUri") to @@ -10956,80 +12096,6 @@ func (s *GoogleCloudAiplatformV1FractionSplit) UnmarshalJSON(data []byte) error return nil } -// GoogleCloudAiplatformV1FunctionCall: A predicted [FunctionCall] -// returned from the model that contains a string representing the -// [FunctionDeclaration.name] and a structured JSON object containing -// the parameters and their values. -type GoogleCloudAiplatformV1FunctionCall struct { - // Args: Optional. Required. The function parameters and values in JSON - // object format. See [FunctionDeclaration.parameters] for parameter - // details. - Args googleapi.RawMessage `json:"args,omitempty"` - - // Name: Required. The name of the function to call. Matches - // [FunctionDeclaration.name]. - Name string `json:"name,omitempty"` - - // ForceSendFields is a list of field names (e.g. "Args") to - // unconditionally include in API requests. By default, fields with - // empty or default values are omitted from API requests. However, any - // non-pointer, non-interface field appearing in ForceSendFields will be - // sent to the server regardless of whether the field is empty or not. - // This may be used to include empty fields in Patch requests. - ForceSendFields []string `json:"-"` - - // NullFields is a list of field names (e.g. "Args") to include in API - // requests with the JSON null value. By default, fields with empty - // values are omitted from API requests. However, any field with an - // empty value appearing in NullFields will be sent to the server as - // null. It is an error if a field in this list has a non-empty value. - // This may be used to include null fields in Patch requests. - NullFields []string `json:"-"` -} - -func (s *GoogleCloudAiplatformV1FunctionCall) MarshalJSON() ([]byte, error) { - type NoMethod GoogleCloudAiplatformV1FunctionCall - raw := NoMethod(*s) - return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) -} - -// GoogleCloudAiplatformV1FunctionResponse: The result output from a -// [FunctionCall] that contains a string representing the -// [FunctionDeclaration.name] and a structured JSON object containing -// any output from the function is used as context to the model. This -// should contain the result of a [FunctionCall] made based on model -// prediction. -type GoogleCloudAiplatformV1FunctionResponse struct { - // Name: Required. The name of the function to call. Matches - // [FunctionDeclaration.name] and [FunctionCall.name]. - Name string `json:"name,omitempty"` - - // Response: Required. The function response in JSON object format. - Response googleapi.RawMessage `json:"response,omitempty"` - - // ForceSendFields is a list of field names (e.g. "Name") to - // unconditionally include in API requests. By default, fields with - // empty or default values are omitted from API requests. However, any - // non-pointer, non-interface field appearing in ForceSendFields will be - // sent to the server regardless of whether the field is empty or not. - // This may be used to include empty fields in Patch requests. - ForceSendFields []string `json:"-"` - - // NullFields is a list of field names (e.g. "Name") to include in API - // requests with the JSON null value. By default, fields with empty - // values are omitted from API requests. However, any field with an - // empty value appearing in NullFields will be sent to the server as - // null. It is an error if a field in this list has a non-empty value. - // This may be used to include null fields in Patch requests. - NullFields []string `json:"-"` -} - -func (s *GoogleCloudAiplatformV1FunctionResponse) MarshalJSON() ([]byte, error) { - type NoMethod GoogleCloudAiplatformV1FunctionResponse - raw := NoMethod(*s) - return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) -} - // GoogleCloudAiplatformV1GcsDestination: The Google Cloud Storage // location where the output is to be written to. type GoogleCloudAiplatformV1GcsDestination struct { @@ -16865,6 +17931,8 @@ type GoogleCloudAiplatformV1ModelSourceInfo struct { // "BQML" - The Model is registered and sync'ed from BigQuery ML. // "MODEL_GARDEN" - The Model is saved or tuned from Model Garden. // "GENIE" - The Model is saved or tuned from Genie. + // "CUSTOM_TEXT_EMBEDDING" - The Model is uploaded by text embedding + // finetuning pipeline. SourceType string `json:"sourceType,omitempty"` // ForceSendFields is a list of field names (e.g. "Copy") to @@ -18135,22 +19203,16 @@ func (s *GoogleCloudAiplatformV1NotebookRuntimeTemplateRef) MarshalJSON() ([]byt return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudAiplatformV1Part: Content part. +// GoogleCloudAiplatformV1Part: 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. type GoogleCloudAiplatformV1Part struct { // FileData: Optional. URI based data. 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 *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 *GoogleCloudAiplatformV1FunctionResponse `json:"functionResponse,omitempty"` - // InlineData: Optional. Inlined bytes data. InlineData *GoogleCloudAiplatformV1Blob `json:"inlineData,omitempty"` @@ -19389,6 +20451,15 @@ type GoogleCloudAiplatformV1PublisherModel struct { // decimal number in string representation. VersionId string `json:"versionId,omitempty"` + // VersionState: Optional. Indicates the state of the model version. + // + // Possible values: + // "VERSION_STATE_UNSPECIFIED" - The version state is unspecified. + // "VERSION_STATE_STABLE" - Used to indicate the version is stable. + // "VERSION_STATE_UNSTABLE" - Used to indicate the version is + // unstable. + VersionState string `json:"versionState,omitempty"` + // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` @@ -19507,6 +20578,10 @@ type GoogleCloudAiplatformV1PublisherModelCallToActionDeploy struct { // ModelDisplayName: Optional. Default model display name. ModelDisplayName string `json:"modelDisplayName,omitempty"` + // PublicArtifactUri: Optional. The signed URI for ephemeral Cloud + // Storage access to model artifact. + PublicArtifactUri string `json:"publicArtifactUri,omitempty"` + // SharedResources: The resource name of the shared // DeploymentResourcePool to deploy on. Format: // `projects/{project}/locations/{location}/deploymentResourcePools/{depl @@ -19642,13 +20717,19 @@ func (s *GoogleCloudAiplatformV1PublisherModelDocumentation) MarshalJSON() ([]by // GoogleCloudAiplatformV1PublisherModelResourceReference: Reference to // a resource. type GoogleCloudAiplatformV1PublisherModelResourceReference struct { + // Description: Description of the resource. + Description string `json:"description,omitempty"` + // ResourceName: The resource name of the Google Cloud resource. ResourceName string `json:"resourceName,omitempty"` // Uri: The URI of the resource. Uri string `json:"uri,omitempty"` - // ForceSendFields is a list of field names (e.g. "ResourceName") to + // UseCase: Use case (CUJ) of the resource. + UseCase string `json:"useCase,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Description") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be @@ -19656,7 +20737,7 @@ type GoogleCloudAiplatformV1PublisherModelResourceReference struct { // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "ResourceName") to include + // NullFields is a list of field names (e.g. "Description") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as @@ -33696,6 +34777,53 @@ func (s *GoogleTypeColor) UnmarshalJSON(data []byte) error { return nil } +// GoogleTypeDate: Represents a whole or partial calendar date, such as +// a birthday. The time of day and time zone are either specified +// elsewhere or are insignificant. The date is relative to the Gregorian +// Calendar. This can represent one of the following: * A full date, +// with non-zero year, month, and day values. * A month and day, with a +// zero year (for example, an anniversary). * A year on its own, with a +// zero month and a zero day. * A year and month, with a zero day (for +// example, a credit card expiration date). Related types: * +// google.type.TimeOfDay * google.type.DateTime * +// google.protobuf.Timestamp +type GoogleTypeDate struct { + // Day: Day of a month. Must be from 1 to 31 and valid for the year and + // month, or 0 to specify a year by itself or a year and month where the + // day isn't significant. + Day int64 `json:"day,omitempty"` + + // Month: Month of a year. Must be from 1 to 12, or 0 to specify a year + // without a month and day. + Month int64 `json:"month,omitempty"` + + // Year: Year of the date. Must be from 1 to 9999, or 0 to specify a + // date without a year. + Year int64 `json:"year,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Day") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Day") to include in API + // requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleTypeDate) MarshalJSON() ([]byte, error) { + type NoMethod GoogleTypeDate + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleTypeExpr: Represents a textual expression in the Common // Expression Language (CEL) syntax. CEL is a C-like expression // language. The syntax and semantics of CEL are documented at @@ -33835,6 +34963,128 @@ func (s *GoogleTypeMoney) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +type IntelligenceCloudAutomlXpsMetricEntry struct { + // ArgentumMetricId: For billing metrics that are using legacy sku's, + // set the legacy billing metric id here. This will be sent to Chemist + // as the "cloudbilling.googleapis.com/argentum_metric_id" label. + // Otherwise leave empty. + ArgentumMetricId string `json:"argentumMetricId,omitempty"` + + // DoubleValue: A double value. + DoubleValue float64 `json:"doubleValue,omitempty"` + + // Int64Value: A signed 64-bit integer value. + Int64Value int64 `json:"int64Value,omitempty,string"` + + // MetricName: The metric name defined in the service configuration. + MetricName string `json:"metricName,omitempty"` + + // SystemLabels: Billing system labels for this (metric, value) pair. + SystemLabels []*IntelligenceCloudAutomlXpsMetricEntryLabel `json:"systemLabels,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ArgentumMetricId") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "ArgentumMetricId") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *IntelligenceCloudAutomlXpsMetricEntry) MarshalJSON() ([]byte, error) { + type NoMethod IntelligenceCloudAutomlXpsMetricEntry + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *IntelligenceCloudAutomlXpsMetricEntry) UnmarshalJSON(data []byte) error { + type NoMethod IntelligenceCloudAutomlXpsMetricEntry + var s1 struct { + DoubleValue gensupport.JSONFloat64 `json:"doubleValue"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.DoubleValue = float64(s1.DoubleValue) + return nil +} + +type IntelligenceCloudAutomlXpsMetricEntryLabel struct { + // LabelName: The name of the label. + LabelName string `json:"labelName,omitempty"` + + // LabelValue: The value of the label. + LabelValue string `json:"labelValue,omitempty"` + + // ForceSendFields is a list of field names (e.g. "LabelName") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "LabelName") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *IntelligenceCloudAutomlXpsMetricEntryLabel) MarshalJSON() ([]byte, error) { + type NoMethod IntelligenceCloudAutomlXpsMetricEntryLabel + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +type IntelligenceCloudAutomlXpsReportingMetrics struct { + // EffectiveTrainingDuration: The effective time training used. If set, + // this is used for quota management and billing. Deprecated. AutoML BE + // doesn't use this. Don't set. + EffectiveTrainingDuration string `json:"effectiveTrainingDuration,omitempty"` + + // MetricEntries: One entry per metric name. The values must be + // aggregated per metric name. + MetricEntries []*IntelligenceCloudAutomlXpsMetricEntry `json:"metricEntries,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "EffectiveTrainingDuration") to unconditionally include in API + // requests. By default, fields with empty or default values are omitted + // from API requests. However, any non-pointer, non-interface field + // appearing in ForceSendFields will be sent to the server regardless of + // whether the field is empty or not. This may be used to include empty + // fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. + // "EffectiveTrainingDuration") to include in API requests with the JSON + // null value. By default, fields with empty values are omitted from API + // requests. However, any field with an empty value appearing in + // NullFields will be sent to the server as null. It is an error if a + // field in this list has a non-empty value. This may be used to include + // null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *IntelligenceCloudAutomlXpsReportingMetrics) MarshalJSON() ([]byte, error) { + type NoMethod IntelligenceCloudAutomlXpsReportingMetrics + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // method id "aiplatform.projects.locations.get": type ProjectsLocationsGetCall struct { diff --git a/aiplatform/v1beta1/aiplatform-api.json b/aiplatform/v1beta1/aiplatform-api.json index 31fd05ccb0..da0ebac230 100644 --- a/aiplatform/v1beta1/aiplatform-api.json +++ b/aiplatform/v1beta1/aiplatform-api.json @@ -12818,6 +12818,37 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "getIamPolicy": { + "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:getIamPolicy", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.publishers.models.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "options.requestedPolicyVersion": { + "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+resource}:getIamPolicy", + "response": { + "$ref": "GoogleIamV1Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "predict": { "description": "Perform an online prediction.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:predict", @@ -16375,135 +16406,859 @@ } } } - } + } + }, + "publishers": { + "resources": { + "models": { + "methods": { + "get": { + "description": "Gets a Model Garden publisher model.", + "flatPath": "v1beta1/publishers/{publishersId}/models/{modelsId}", + "httpMethod": "GET", + "id": "aiplatform.publishers.models.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "languageCode": { + "description": "Optional. The IETF BCP-47 language code representing the language in which the publisher model's text information should be written in (see go/bcp47).", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The name of the PublisherModel resource. Format: `publishers/{publisher}/models/{publisher_model}`", + "location": "path", + "pattern": "^publishers/[^/]+/models/[^/]+$", + "required": true, + "type": "string" + }, + "view": { + "description": "Optional. PublisherModel view specifying which fields to read.", + "enum": [ + "PUBLISHER_MODEL_VIEW_UNSPECIFIED", + "PUBLISHER_MODEL_VIEW_BASIC", + "PUBLISHER_MODEL_VIEW_FULL", + "PUBLISHER_MODEL_VERSION_VIEW_BASIC" + ], + "enumDescriptions": [ + "The default / unset value. The API will default to the BASIC view.", + "Include basic metadata about the publisher model, but not the full contents.", + "Include everything.", + "Include: VersionId, ModelVersionExternalName, and SupportedActions." + ], + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1PublisherModel" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists publisher models in Model Garden.", + "flatPath": "v1beta1/publishers/{publishersId}/models", + "httpMethod": "GET", + "id": "aiplatform.publishers.models.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. The standard list filter.", + "location": "query", + "type": "string" + }, + "languageCode": { + "description": "Optional. The IETF BCP-47 language code representing the language in which the publisher models' text information should be written in (see go/bcp47). If not set, by default English (en).", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The standard list page token. Typically obtained via ListPublisherModelsResponse.next_page_token of the previous ModelGardenService.ListPublisherModels call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The name of the Publisher from which to list the PublisherModels. Format: `publishers/{publisher}`", + "location": "path", + "pattern": "^publishers/[^/]+$", + "required": true, + "type": "string" + }, + "view": { + "description": "Optional. PublisherModel view specifying which fields to read.", + "enum": [ + "PUBLISHER_MODEL_VIEW_UNSPECIFIED", + "PUBLISHER_MODEL_VIEW_BASIC", + "PUBLISHER_MODEL_VIEW_FULL", + "PUBLISHER_MODEL_VERSION_VIEW_BASIC" + ], + "enumDescriptions": [ + "The default / unset value. The API will default to the BASIC view.", + "Include basic metadata about the publisher model, but not the full contents.", + "Include everything.", + "Include: VersionId, ModelVersionExternalName, and SupportedActions." + ], + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+parent}/models", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListPublisherModelsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + }, + "revision": "20231211", + "rootUrl": "https://aiplatform.googleapis.com/", + "schemas": { + "CloudAiLargeModelsVisionEmbedVideoResponse": { + "description": "Video embedding response.", + "id": "CloudAiLargeModelsVisionEmbedVideoResponse", + "properties": { + "videoEmbeddings": { + "description": "The embedding vector for the video.", + "items": { + "type": "any" + }, + "type": "array" + } + }, + "type": "object" + }, + "CloudAiLargeModelsVisionFilteredText": { + "description": "Details for filtered input text.", + "id": "CloudAiLargeModelsVisionFilteredText", + "properties": { + "category": { + "description": "Confidence level", + "enum": [ + "RAI_CATEGORY_UNSPECIFIED", + "OBSCENE", + "SEXUALLY_EXPLICIT", + "IDENTITY_ATTACK", + "VIOLENCE_ABUSE", + "CSAI", + "SPII", + "CELEBRITY", + "FACE_IMG", + "WATERMARK_IMG", + "MEMORIZATION_IMG", + "CSAI_IMG", + "PORN_IMG", + "VIOLENCE_IMG", + "CHILD_IMG", + "TOXIC", + "SENSITIVE_WORD", + "PERSON_IMG", + "ICA_IMG", + "SEXUAL_IMG", + "IU_IMG", + "RACY_IMG", + "PEDO_IMG", + "DEATH_HARM_TRAGEDY", + "HEALTH", + "FIREARMS_WEAPONS", + "RELIGIOUS_BELIEF", + "ILLICIT_DRUGS", + "WAR_CONFLICT", + "POLITICS", + "HATE_SYMBOL_IMG", + "CHILD_TEXT", + "DANGEROUS_CONTENT", + "RECITATION_TEXT" + ], + "enumDescriptions": [ + "", + "", + "Porn", + "Hate", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "SafetyAttributes returned but not filtered on", + "", + "", + "", + "", + "", + "", + "End of list", + "", + "Text category from SafetyCat v3", + "" + ], + "type": "string" + }, + "confidence": { + "description": "Filtered category", + "enum": [ + "CONFIDENCE_UNSPECIFIED", + "CONFIDENCE_LOW", + "CONFIDENCE_MEDIUM", + "CONFIDENCE_HIGH" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ], + "type": "string" + }, + "prompt": { + "description": "Input prompt", + "type": "string" + }, + "score": { + "description": "Score for category", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "CloudAiLargeModelsVisionGenerateVideoResponse": { + "description": "Generate video response.", + "id": "CloudAiLargeModelsVisionGenerateVideoResponse", + "properties": { + "generatedSamples": { + "description": "The generates samples.", + "items": { + "$ref": "CloudAiLargeModelsVisionMedia" + }, + "type": "array" + }, + "raiMediaFilteredCount": { + "description": "Returns if any videos were filtered due to RAI policies.", + "format": "int32", + "type": "integer" + }, + "raiMediaFilteredReasons": { + "description": "Returns rai failure reasons if any.", + "items": { + "type": "string" + }, + "type": "array" + }, + "raiTextFilteredReason": { + "$ref": "CloudAiLargeModelsVisionFilteredText", + "description": "Returns filtered text rai info." + } + }, + "type": "object" + }, + "CloudAiLargeModelsVisionImage": { + "description": "Image.", + "id": "CloudAiLargeModelsVisionImage", + "properties": { + "encoding": { + "description": "Image encoding, encoded as \"image/png\" or \"image/jpg\".", + "type": "string" + }, + "image": { + "description": "Raw bytes.", + "format": "byte", + "type": "string" + }, + "imageRaiScores": { + "$ref": "CloudAiLargeModelsVisionImageRAIScores", + "description": "RAI scores for generated image." + }, + "raiInfo": { + "$ref": "CloudAiLargeModelsVisionRaiInfo", + "description": "RAI info for image" + }, + "semanticFilterResponse": { + "$ref": "CloudAiLargeModelsVisionSemanticFilterResponse", + "description": "Semantic filter info for image." + }, + "uri": { + "description": "Path to another storage (typically Google Cloud Storage).", + "type": "string" + } + }, + "type": "object" + }, + "CloudAiLargeModelsVisionImageRAIScores": { + "description": "RAI scores for generated image returned.", + "id": "CloudAiLargeModelsVisionImageRAIScores", + "properties": { + "agileWatermarkDetectionScore": { + "description": "Agile watermark score for image.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "CloudAiLargeModelsVisionMedia": { + "description": "Media.", + "id": "CloudAiLargeModelsVisionMedia", + "properties": { + "image": { + "$ref": "CloudAiLargeModelsVisionImage", + "description": "Image." + }, + "video": { + "$ref": "CloudAiLargeModelsVisionVideo", + "description": "Video" + } + }, + "type": "object" + }, + "CloudAiLargeModelsVisionMediaGenerateContentResponse": { + "description": "Generate media content response", + "id": "CloudAiLargeModelsVisionMediaGenerateContentResponse", + "properties": { + "response": { + "$ref": "CloudAiNlLlmProtoServiceGenerateMultiModalResponse", + "description": "Response to the user's request." + } + }, + "type": "object" + }, + "CloudAiLargeModelsVisionNamedBoundingBox": { + "id": "CloudAiLargeModelsVisionNamedBoundingBox", + "properties": { + "classes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "entities": { + "items": { + "type": "string" + }, + "type": "array" + }, + "scores": { + "items": { + "format": "float", + "type": "number" + }, + "type": "array" + }, + "x1": { + "format": "float", + "type": "number" + }, + "x2": { + "format": "float", + "type": "number" + }, + "y1": { + "format": "float", + "type": "number" + }, + "y2": { + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "CloudAiLargeModelsVisionRaiInfo": { + "id": "CloudAiLargeModelsVisionRaiInfo", + "properties": { + "raiCategories": { + "description": "List of rai categories' information to return", + "items": { + "type": "string" + }, + "type": "array" + }, + "scores": { + "description": "List of rai scores mapping to the rai categories. Rounded to 1 decimal place.", + "items": { + "format": "float", + "type": "number" + }, + "type": "array" + } + }, + "type": "object" + }, + "CloudAiLargeModelsVisionReasonVideoResponse": { + "description": "Video reasoning response.", + "id": "CloudAiLargeModelsVisionReasonVideoResponse", + "properties": { + "responses": { + "description": "Generated text responses. The generated responses for different segments within the same video.", + "items": { + "$ref": "CloudAiLargeModelsVisionReasonVideoResponseTextResponse" + }, + "type": "array" + } + }, + "type": "object" + }, + "CloudAiLargeModelsVisionReasonVideoResponseTextResponse": { + "description": "Contains text that is the response of the video captioning.", + "id": "CloudAiLargeModelsVisionReasonVideoResponseTextResponse", + "properties": { + "relativeTemporalPartition": { + "$ref": "CloudAiLargeModelsVisionRelativeTemporalPartition", + "description": "Partition of the caption's video in time. This field is intended for video captioning. To represent the start time and end time of the caption's video." + }, + "text": { + "description": "Text information", + "type": "string" + } + }, + "type": "object" + }, + "CloudAiLargeModelsVisionRelativeTemporalPartition": { + "description": "For ease of use, assume that the start_offset is inclusive and the end_offset is exclusive. In mathematical terms, the partition would be written as [start_offset, end_offset).", + "id": "CloudAiLargeModelsVisionRelativeTemporalPartition", + "properties": { + "endOffset": { + "description": "End time offset of the partition.", + "format": "google-duration", + "type": "string" + }, + "startOffset": { + "description": "Start time offset of the partition.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, + "CloudAiLargeModelsVisionSemanticFilterResponse": { + "id": "CloudAiLargeModelsVisionSemanticFilterResponse", + "properties": { + "namedBoundingBoxes": { + "description": "Class labels of the bounding boxes that failed the semantic filtering. Bounding box coordinates.", + "items": { + "$ref": "CloudAiLargeModelsVisionNamedBoundingBox" + }, + "type": "array" + }, + "passedSemanticFilter": { + "description": "This response is added when semantic filter config is turned on in EditConfig. It reports if this image is passed semantic filter response. If passed_semantic_filter is false, the bounding box information will be populated for user to check what caused the semantic filter to fail.", + "type": "boolean" + } + }, + "type": "object" + }, + "CloudAiLargeModelsVisionVideo": { + "description": "Video", + "id": "CloudAiLargeModelsVisionVideo", + "properties": { + "uri": { + "description": "Path to another storage (typically Google Cloud Storage).", + "type": "string" + }, + "video": { + "description": "Raw bytes.", + "format": "byte", + "type": "string" + } + }, + "type": "object" + }, + "CloudAiNlLlmProtoServiceCandidate": { + "id": "CloudAiNlLlmProtoServiceCandidate", + "properties": { + "citationMetadata": { + "$ref": "CloudAiNlLlmProtoServiceCitationMetadata", + "description": "Source attribution of the generated content." + }, + "content": { + "$ref": "CloudAiNlLlmProtoServiceContent", + "description": "Content of the candidate." + }, + "finishMessage": { + "description": "A string that describes the filtering behavior in more detail. Only filled when reason is set.", + "type": "string" + }, + "finishReason": { + "description": "The reason why the model stopped generating tokens.", + "enum": [ + "FINISH_REASON_UNSPECIFIED", + "FINISH_REASON_STOP", + "FINISH_REASON_MAX_TOKENS", + "FINISH_REASON_SAFETY", + "FINISH_REASON_RECITATION", + "FINISH_REASON_OTHER" + ], + "enumDescriptions": [ + "The finish reason is unspecified.", + "Natural stop point of the model or provided stop sequence.", + "The maximum number of tokens as specified in the request was reached.", + "The token generation was stopped as the response was flagged for safety reasons. NOTE: When streaming the Candidate.content will be empty if content filters blocked the output.", + "The token generation was stopped as the response was flagged for unauthorized citations.", + "All other reasons that stopped the token generation." + ], + "type": "string" + }, + "index": { + "description": "Index of the candidate.", + "format": "int32", + "type": "integer" + }, + "safetyRatings": { + "description": "Safety ratings of the generated content.", + "items": { + "$ref": "CloudAiNlLlmProtoServiceSafetyRating" + }, + "type": "array" + } + }, + "type": "object" + }, + "CloudAiNlLlmProtoServiceCitation": { + "description": "Source attributions for content.", + "id": "CloudAiNlLlmProtoServiceCitation", + "properties": { + "endIndex": { + "description": "End index into the content.", + "format": "int32", + "type": "integer" + }, + "license": { + "description": "License of the attribution.", + "type": "string" + }, + "publicationDate": { + "$ref": "GoogleTypeDate", + "description": "Publication date of the attribution." + }, + "startIndex": { + "description": "Start index into the content.", + "format": "int32", + "type": "integer" + }, + "title": { + "description": "Title of the attribution.", + "type": "string" + }, + "uri": { + "description": "Url reference of the attribution.", + "type": "string" + } + }, + "type": "object" + }, + "CloudAiNlLlmProtoServiceCitationMetadata": { + "description": "A collection of source attributions for a piece of content.", + "id": "CloudAiNlLlmProtoServiceCitationMetadata", + "properties": { + "citations": { + "description": "List of citations.", + "items": { + "$ref": "CloudAiNlLlmProtoServiceCitation" + }, + "type": "array" + } + }, + "type": "object" + }, + "CloudAiNlLlmProtoServiceContent": { + "description": "The content of a single message from a participant.", + "id": "CloudAiNlLlmProtoServiceContent", + "properties": { + "parts": { + "description": "The parts of the message.", + "items": { + "$ref": "CloudAiNlLlmProtoServicePart" + }, + "type": "array" + }, + "role": { + "description": "The role of the current conversation participant.", + "type": "string" + } + }, + "type": "object" + }, + "CloudAiNlLlmProtoServiceFunctionCall": { + "description": "Function call details.", + "id": "CloudAiNlLlmProtoServiceFunctionCall", + "properties": { + "args": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The function parameters and values in JSON format.", + "type": "object" + }, + "name": { + "description": "Required. The name of the function to call.", + "type": "string" + } + }, + "type": "object" + }, + "CloudAiNlLlmProtoServiceFunctionResponse": { + "description": "Function response details.", + "id": "CloudAiNlLlmProtoServiceFunctionResponse", + "properties": { + "name": { + "description": "Required. The name of the function to call.", + "type": "string" + }, + "response": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Required. The function response in JSON object format.", + "type": "object" + } + }, + "type": "object" + }, + "CloudAiNlLlmProtoServiceGenerateMultiModalResponse": { + "id": "CloudAiNlLlmProtoServiceGenerateMultiModalResponse", + "properties": { + "candidates": { + "description": "Possible candidate responses to the conversation up until this point.", + "items": { + "$ref": "CloudAiNlLlmProtoServiceCandidate" + }, + "type": "array" + }, + "promptFeedback": { + "$ref": "CloudAiNlLlmProtoServicePromptFeedback", + "description": "Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations." + }, + "reportingMetrics": { + "$ref": "IntelligenceCloudAutomlXpsReportingMetrics", + "description": "Billable prediction metrics." + }, + "usageMetadata": { + "$ref": "CloudAiNlLlmProtoServiceUsageMetadata", + "description": "Usage metadata about the response(s)." + } + }, + "type": "object" + }, + "CloudAiNlLlmProtoServicePart": { + "description": "A single part of a message.", + "id": "CloudAiNlLlmProtoServicePart", + "properties": { + "fileData": { + "$ref": "CloudAiNlLlmProtoServicePartFileData", + "description": "URI-based data." + }, + "functionCall": { + "$ref": "CloudAiNlLlmProtoServiceFunctionCall", + "description": "Function call data." + }, + "functionResponse": { + "$ref": "CloudAiNlLlmProtoServiceFunctionResponse", + "description": "Function response data." + }, + "inlineData": { + "$ref": "CloudAiNlLlmProtoServicePartBlob", + "description": "Inline bytes data" + }, + "text": { + "description": "Text input.", + "type": "string" + }, + "videoMetadata": { + "$ref": "CloudAiNlLlmProtoServicePartVideoMetadata", + "description": "Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data." + } + }, + "type": "object" + }, + "CloudAiNlLlmProtoServicePartBlob": { + "description": "Represents arbitrary blob data input.", + "id": "CloudAiNlLlmProtoServicePartBlob", + "properties": { + "data": { + "description": "Inline data.", + "format": "byte", + "type": "string" + }, + "mimeType": { + "description": "The mime type corresponding to this input.", + "type": "string" + }, + "originalFileData": { + "$ref": "CloudAiNlLlmProtoServicePartFileData", + "description": "Original file data where the blob comes from." + } + }, + "type": "object" + }, + "CloudAiNlLlmProtoServicePartFileData": { + "description": "Represents file data.", + "id": "CloudAiNlLlmProtoServicePartFileData", + "properties": { + "fileUri": { + "description": "Inline data.", + "type": "string" + }, + "mimeType": { + "description": "The mime type corresponding to this input.", + "type": "string" + } + }, + "type": "object" + }, + "CloudAiNlLlmProtoServicePartVideoMetadata": { + "description": "Metadata describes the input video content.", + "id": "CloudAiNlLlmProtoServicePartVideoMetadata", + "properties": { + "endOffset": { + "description": "The end offset of the video.", + "format": "google-duration", + "type": "string" + }, + "startOffset": { + "description": "The start offset of the video.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, + "CloudAiNlLlmProtoServicePromptFeedback": { + "description": "Content filter results for a prompt sent in the request.", + "id": "CloudAiNlLlmProtoServicePromptFeedback", + "properties": { + "blockReason": { + "description": "Blocked reason.", + "enum": [ + "BLOCKED_REASON_UNSPECIFIED", + "SAFETY", + "OTHER" + ], + "enumDescriptions": [ + "Unspecified blocked reason.", + "Candidates blocked due to safety.", + "Candidates blocked due to other reason." + ], + "type": "string" + }, + "blockReasonMessage": { + "description": "A readable block reason message.", + "type": "string" + }, + "safetyRatings": { + "description": "Safety ratings.", + "items": { + "$ref": "CloudAiNlLlmProtoServiceSafetyRating" + }, + "type": "array" + } + }, + "type": "object" + }, + "CloudAiNlLlmProtoServiceSafetyRating": { + "description": "Safety rating corresponding to the generated content.", + "id": "CloudAiNlLlmProtoServiceSafetyRating", + "properties": { + "blocked": { + "description": "Indicates whether the content was filtered out because of this rating.", + "type": "boolean" + }, + "category": { + "description": "Harm category.", + "enum": [ + "HARM_CATEGORY_UNSPECIFIED", + "HARM_CATEGORY_HATE_SPEECH", + "HARM_CATEGORY_DANGEROUS_CONTENT", + "HARM_CATEGORY_HARASSMENT", + "HARM_CATEGORY_SEXUALLY_EXPLICIT" + ], + "enumDescriptions": [ + "The harm category is unspecified.", + "The harm category is hate speech.", + "The harm category is dengerous content.", + "The harm category is harassment.", + "The harm category is sexually explicit." + ], + "type": "string" + }, + "probability": { + "description": "Harm probability levels in the content.", + "enum": [ + "HARM_PROBABILITY_UNSPECIFIED", + "NEGLIGIBLE", + "LOW", + "MEDIUM", + "HIGH" + ], + "enumDescriptions": [ + "Harm probability unspecified.", + "Negligible level of harm.", + "Low level of harm.", + "Medium level of harm.", + "High level of harm." + ], + "type": "string" + } + }, + "type": "object" }, - "publishers": { - "resources": { - "models": { - "methods": { - "get": { - "description": "Gets a Model Garden publisher model.", - "flatPath": "v1beta1/publishers/{publishersId}/models/{modelsId}", - "httpMethod": "GET", - "id": "aiplatform.publishers.models.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "languageCode": { - "description": "Optional. The IETF BCP-47 language code representing the language in which the publisher model's text information should be written in (see go/bcp47).", - "location": "query", - "type": "string" - }, - "name": { - "description": "Required. The name of the PublisherModel resource. Format: `publishers/{publisher}/models/{publisher_model}`", - "location": "path", - "pattern": "^publishers/[^/]+/models/[^/]+$", - "required": true, - "type": "string" - }, - "view": { - "description": "Optional. PublisherModel view specifying which fields to read.", - "enum": [ - "PUBLISHER_MODEL_VIEW_UNSPECIFIED", - "PUBLISHER_MODEL_VIEW_BASIC", - "PUBLISHER_MODEL_VIEW_FULL", - "PUBLISHER_MODEL_VERSION_VIEW_BASIC" - ], - "enumDescriptions": [ - "The default / unset value. The API will default to the BASIC view.", - "Include basic metadata about the publisher model, but not the full contents.", - "Include everything.", - "Include: VersionId, ModelVersionExternalName, and SupportedActions." - ], - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1PublisherModel" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists publisher models in Model Garden.", - "flatPath": "v1beta1/publishers/{publishersId}/models", - "httpMethod": "GET", - "id": "aiplatform.publishers.models.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "Optional. The standard list filter.", - "location": "query", - "type": "string" - }, - "languageCode": { - "description": "Optional. The IETF BCP-47 language code representing the language in which the publisher models' text information should be written in (see go/bcp47). If not set, by default English (en).", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "Optional. The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. The standard list page token. Typically obtained via ListPublisherModelsResponse.next_page_token of the previous ModelGardenService.ListPublisherModels call.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The name of the Publisher from which to list the PublisherModels. Format: `publishers/{publisher}`", - "location": "path", - "pattern": "^publishers/[^/]+$", - "required": true, - "type": "string" - }, - "view": { - "description": "Optional. PublisherModel view specifying which fields to read.", - "enum": [ - "PUBLISHER_MODEL_VIEW_UNSPECIFIED", - "PUBLISHER_MODEL_VIEW_BASIC", - "PUBLISHER_MODEL_VIEW_FULL", - "PUBLISHER_MODEL_VERSION_VIEW_BASIC" - ], - "enumDescriptions": [ - "The default / unset value. The API will default to the BASIC view.", - "Include basic metadata about the publisher model, but not the full contents.", - "Include everything.", - "Include: VersionId, ModelVersionExternalName, and SupportedActions." - ], - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+parent}/models", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListPublisherModelsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } + "CloudAiNlLlmProtoServiceUsageMetadata": { + "description": "Usage metadata about response(s).", + "id": "CloudAiNlLlmProtoServiceUsageMetadata", + "properties": { + "candidatesTokenCount": { + "description": "Number of tokens in the response(s).", + "format": "int32", + "type": "integer" + }, + "promptTokenCount": { + "description": "Number of tokens in the request.", + "format": "int32", + "type": "integer" + }, + "totalTokenCount": { + "format": "int32", + "type": "integer" } - } - } - }, - "revision": "20231129", - "rootUrl": "https://aiplatform.googleapis.com/", - "schemas": { + }, + "type": "object" + }, "GoogleApiHttpBody": { "description": "Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.", "id": "GoogleApiHttpBody", @@ -17392,14 +18147,14 @@ "id": "GoogleCloudAiplatformV1beta1BatchPredictionJobInstanceConfig", "properties": { "excludedFields": { - "description": "Fields that will be excluded in the prediction instance that is sent to the Model. Excluded will be attached to the batch prediction output if key_field is not specified. When excluded_fields is populated, included_fields must be empty. The input must be JSONL with objects at each line, CSV, BigQuery or TfRecord.", + "description": "Fields that will be excluded in the prediction instance that is sent to the Model. Excluded will be attached to the batch prediction output if key_field is not specified. When excluded_fields is populated, included_fields must be empty. The input must be JSONL with objects at each line, BigQuery or TfRecord.", "items": { "type": "string" }, "type": "array" }, "includedFields": { - "description": "Fields that will be included in the prediction instance that is sent to the Model. If instance_type is `array`, the order of field names in included_fields also determines the order of the values in the array. When included_fields is populated, excluded_fields must be empty. The input must be JSONL with objects at each line, CSV, BigQuery or TfRecord.", + "description": "Fields that will be included in the prediction instance that is sent to the Model. If instance_type is `array`, the order of field names in included_fields also determines the order of the values in the array. When included_fields is populated, excluded_fields must be empty. The input must be JSONL with objects at each line, BigQuery or TfRecord.", "items": { "type": "string" }, @@ -17582,16 +18337,16 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1Blob": { - "description": "Content blob.", + "description": "Raw media bytes. Text should not be sent as raw bytes, use the 'text' field.", "id": "GoogleCloudAiplatformV1beta1Blob", "properties": { "data": { - "description": "Required. Data.", + "description": "Required. Raw bytes for media formats.", "format": "byte", "type": "string" }, "mimeType": { - "description": "Required. Mime type of the data.", + "description": "Required. The IANA standard MIME type of the source data.", "type": "string" } }, @@ -17666,7 +18421,7 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1Candidate": { - "description": "Generated candidate.", + "description": "A response candidate generated from the model.", "id": "GoogleCloudAiplatformV1beta1Candidate", "properties": { "citationMetadata": { @@ -17680,12 +18435,12 @@ "readOnly": true }, "finishMessage": { - "description": "Output only. A string that describes the filtering behavior in more detail. Only filled when reason is set.", + "description": "Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when `finish_reason` is set.", "readOnly": true, "type": "string" }, "finishReason": { - "description": "Output only. The reason why the model stopped generating tokens.", + "description": "Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens.", "enum": [ "FINISH_REASON_UNSPECIFIED", "STOP", @@ -17712,7 +18467,7 @@ "type": "integer" }, "safetyRatings": { - "description": "Output only. Safety ratings of the generated content.", + "description": "Output only. List of ratings for the safety of a response candidate. There is at most one rating per category.", "items": { "$ref": "GoogleCloudAiplatformV1beta1SafetyRating" }, @@ -17934,18 +18689,18 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1Content": { - "description": "A single turn in a conversation with the model.", + "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.", "id": "GoogleCloudAiplatformV1beta1Content", "properties": { "parts": { - "description": "Required. Ordered parts that make up a message. Parts may have different MIME types.", + "description": "Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.", "items": { "$ref": "GoogleCloudAiplatformV1beta1Part" }, "type": "array" }, "role": { - "description": "Optional. The role in a conversation associated with this content. Set it only if a content represents a turn in a conversations, otherwise no need to set role. Possible values: user, model.", + "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.", "type": "string" } }, @@ -18597,6 +19352,13 @@ "description": "Optional. The Experiment Run associated with this job. Format: `projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}-{experiment-run-name}`", "type": "string" }, + "models": { + "description": "Optional. The name of the Model resources for which to generate a mapping to artifact URIs. Applicable only to some of the Google-provided custom jobs. Format: `projects/{project}/locations/{location}/models/{model}` In order to retrieve a specific version of the model, also provide the version ID or version alias. Example: `projects/{project}/locations/{location}/models/{model}@2` or `projects/{project}/locations/{location}/models/{model}@golden` If no version ID or alias is specified, the \"default\" version will be returned. The \"default\" version alias is created for the first version of the model, and can be moved to other versions later on. There will be exactly one default version.", + "items": { + "type": "string" + }, + "type": "array" + }, "network": { "description": "Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Job should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the job is not peered with any network.", "type": "string" @@ -21817,7 +22579,7 @@ "type": "string" }, "mimeType": { - "description": "Required. Mime type of the data.", + "description": "Required. The IANA standard MIME type of the source data.", "type": "string" } }, @@ -21985,7 +22747,7 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1FunctionDeclaration": { - "description": "Function declaration details.", + "description": "Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name and parameters. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client.", "id": "GoogleCloudAiplatformV1beta1FunctionDeclaration", "properties": { "description": { @@ -21998,7 +22760,7 @@ }, "parameters": { "$ref": "GoogleCloudAiplatformV1beta1Schema", - "description": "Optional. Describes the parameters to this function. Reflects the Open API 3.03 Parameter Object string Key: the name of the parameter. Parameter names are case sensitive. For function with no parameters, this can be left unset." + "description": "Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1" } }, "type": "object" @@ -22087,13 +22849,14 @@ "id": "GoogleCloudAiplatformV1beta1GenerateContentRequest", "properties": { "contents": { - "description": "Required. Input content.", + "description": "Required. The content of the current conversation with the model. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request.", "items": { "$ref": "GoogleCloudAiplatformV1beta1Content" }, "type": "array" }, "endpoint": { + "deprecated": true, "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", "type": "string" }, @@ -22109,7 +22872,7 @@ "type": "array" }, "tools": { - "description": "Optional. Tools that the model may use to generate response.", + "description": "Optional. A list of `Tools` the model may use to generate the next response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. The only supported tool is currently `Function`", "items": { "$ref": "GoogleCloudAiplatformV1beta1Tool" }, @@ -22207,38 +22970,11 @@ "format": "int32", "type": "integer" }, - "echo": { - "description": "Optional. Echo.", - "type": "boolean" - }, - "frequencyPenalty": { - "description": "Optional. Frequency penalties.", - "format": "float", - "type": "number" - }, - "logitBias": { - "additionalProperties": { - "format": "float", - "type": "number" - }, - "description": "Optional. Logit bias.", - "type": "object" - }, - "logprobs": { - "description": "Optional. Logit probabilities.", - "format": "int32", - "type": "integer" - }, "maxOutputTokens": { "description": "Optional. The maximum number of output tokens to generate per message.", "format": "int32", "type": "integer" }, - "presencePenalty": { - "description": "Optional. Positive penalties.", - "format": "float", - "type": "number" - }, "stopSequences": { "description": "Optional. Stop sequences.", "items": { @@ -25465,7 +26201,8 @@ "CUSTOM", "BQML", "MODEL_GARDEN", - "GENIE" + "GENIE", + "CUSTOM_TEXT_EMBEDDING" ], "enumDescriptions": [ "Should not be used.", @@ -25473,7 +26210,8 @@ "The Model is uploaded by user or custom training pipeline.", "The Model is registered and sync'ed from BigQuery ML.", "The Model is saved or tuned from Model Garden.", - "The Model is saved or tuned from Genie." + "The Model is saved or tuned from Genie.", + "The Model is uploaded by text embedding finetuning pipeline." ], "type": "string" } @@ -26405,7 +27143,7 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1Part": { - "description": "Content part.", + "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.", "id": "GoogleCloudAiplatformV1beta1Part", "properties": { "fileData": { @@ -27333,6 +28071,20 @@ "description": "Output only. Immutable. The version ID of the PublisherModel. A new version is committed when a new model version is uploaded under an existing model id. It is an auto-incrementing decimal number in string representation.", "readOnly": true, "type": "string" + }, + "versionState": { + "description": "Optional. Indicates the state of the model version.", + "enum": [ + "VERSION_STATE_UNSPECIFIED", + "VERSION_STATE_STABLE", + "VERSION_STATE_UNSTABLE" + ], + "enumDescriptions": [ + "The version state is unspecified.", + "Used to indicate the version is stable.", + "Used to indicate the version is unstable." + ], + "type": "string" } }, "type": "object" @@ -27412,6 +28164,10 @@ "description": "Optional. Default model display name.", "type": "string" }, + "publicArtifactUri": { + "description": "Optional. The signed URI for ephemeral Cloud Storage access to model artifact.", + "type": "string" + }, "sharedResources": { "description": "The resource name of the shared DeploymentResourcePool to deploy on. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`", "type": "string" @@ -27493,6 +28249,10 @@ "description": "Reference to a resource.", "id": "GoogleCloudAiplatformV1beta1PublisherModelResourceReference", "properties": { + "description": { + "description": "Description of the resource.", + "type": "string" + }, "resourceName": { "description": "The resource name of the Google Cloud resource.", "type": "string" @@ -27500,6 +28260,10 @@ "uri": { "description": "The URI of the resource.", "type": "string" + }, + "useCase": { + "description": "Use case (CUJ) of the resource.", + "type": "string" } }, "type": "object" @@ -28579,7 +29343,7 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1Schema": { - "description": "Represents a select subset of an OpenAPI 3.0 Schema object. Schema is used to define the format of input/output data. More fields may be added in the future as needed. https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#schemaObject", + "description": "Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). More fields may be added in the future as needed.", "id": "GoogleCloudAiplatformV1beta1Schema", "properties": { "description": { @@ -33808,7 +34572,7 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1Tool": { - "description": "Tool details that the model may use to generate response.", + "description": "Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model.", "id": "GoogleCloudAiplatformV1beta1Tool", "properties": { "functionDeclarations": { @@ -34966,6 +35730,70 @@ } }, "type": "object" + }, + "IntelligenceCloudAutomlXpsMetricEntry": { + "id": "IntelligenceCloudAutomlXpsMetricEntry", + "properties": { + "argentumMetricId": { + "description": "For billing metrics that are using legacy sku's, set the legacy billing metric id here. This will be sent to Chemist as the \"cloudbilling.googleapis.com/argentum_metric_id\" label. Otherwise leave empty.", + "type": "string" + }, + "doubleValue": { + "description": "A double value.", + "format": "double", + "type": "number" + }, + "int64Value": { + "description": "A signed 64-bit integer value.", + "format": "int64", + "type": "string" + }, + "metricName": { + "description": "The metric name defined in the service configuration.", + "type": "string" + }, + "systemLabels": { + "description": "Billing system labels for this (metric, value) pair.", + "items": { + "$ref": "IntelligenceCloudAutomlXpsMetricEntryLabel" + }, + "type": "array" + } + }, + "type": "object" + }, + "IntelligenceCloudAutomlXpsMetricEntryLabel": { + "id": "IntelligenceCloudAutomlXpsMetricEntryLabel", + "properties": { + "labelName": { + "description": "The name of the label.", + "type": "string" + }, + "labelValue": { + "description": "The value of the label.", + "type": "string" + } + }, + "type": "object" + }, + "IntelligenceCloudAutomlXpsReportingMetrics": { + "id": "IntelligenceCloudAutomlXpsReportingMetrics", + "properties": { + "effectiveTrainingDuration": { + "deprecated": true, + "description": "The effective time training used. If set, this is used for quota management and billing. Deprecated. AutoML BE doesn't use this. Don't set.", + "format": "google-duration", + "type": "string" + }, + "metricEntries": { + "description": "One entry per metric name. The values must be aggregated per metric name.", + "items": { + "$ref": "IntelligenceCloudAutomlXpsMetricEntry" + }, + "type": "array" + } + }, + "type": "object" } }, "servicePath": "", diff --git a/aiplatform/v1beta1/aiplatform-gen.go b/aiplatform/v1beta1/aiplatform-gen.go index 6baeda5963..f50bfb41a1 100644 --- a/aiplatform/v1beta1/aiplatform-gen.go +++ b/aiplatform/v1beta1/aiplatform-gen.go @@ -1394,6 +1394,1130 @@ type PublishersModelsService struct { s *Service } +// CloudAiLargeModelsVisionEmbedVideoResponse: Video embedding response. +type CloudAiLargeModelsVisionEmbedVideoResponse struct { + // VideoEmbeddings: The embedding vector for the video. + VideoEmbeddings []interface{} `json:"videoEmbeddings,omitempty"` + + // ForceSendFields is a list of field names (e.g. "VideoEmbeddings") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "VideoEmbeddings") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *CloudAiLargeModelsVisionEmbedVideoResponse) MarshalJSON() ([]byte, error) { + type NoMethod CloudAiLargeModelsVisionEmbedVideoResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// CloudAiLargeModelsVisionFilteredText: Details for filtered input +// text. +type CloudAiLargeModelsVisionFilteredText struct { + // Category: Confidence level + // + // Possible values: + // "RAI_CATEGORY_UNSPECIFIED" + // "OBSCENE" + // "SEXUALLY_EXPLICIT" - Porn + // "IDENTITY_ATTACK" - Hate + // "VIOLENCE_ABUSE" + // "CSAI" + // "SPII" + // "CELEBRITY" + // "FACE_IMG" + // "WATERMARK_IMG" + // "MEMORIZATION_IMG" + // "CSAI_IMG" + // "PORN_IMG" + // "VIOLENCE_IMG" + // "CHILD_IMG" + // "TOXIC" + // "SENSITIVE_WORD" + // "PERSON_IMG" + // "ICA_IMG" + // "SEXUAL_IMG" + // "IU_IMG" + // "RACY_IMG" + // "PEDO_IMG" + // "DEATH_HARM_TRAGEDY" - SafetyAttributes returned but not filtered + // on + // "HEALTH" + // "FIREARMS_WEAPONS" + // "RELIGIOUS_BELIEF" + // "ILLICIT_DRUGS" + // "WAR_CONFLICT" + // "POLITICS" + // "HATE_SYMBOL_IMG" - End of list + // "CHILD_TEXT" + // "DANGEROUS_CONTENT" - Text category from SafetyCat v3 + // "RECITATION_TEXT" + Category string `json:"category,omitempty"` + + // Confidence: Filtered category + // + // Possible values: + // "CONFIDENCE_UNSPECIFIED" + // "CONFIDENCE_LOW" + // "CONFIDENCE_MEDIUM" + // "CONFIDENCE_HIGH" + Confidence string `json:"confidence,omitempty"` + + // Prompt: Input prompt + Prompt string `json:"prompt,omitempty"` + + // Score: Score for category + Score float64 `json:"score,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Category") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Category") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *CloudAiLargeModelsVisionFilteredText) MarshalJSON() ([]byte, error) { + type NoMethod CloudAiLargeModelsVisionFilteredText + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *CloudAiLargeModelsVisionFilteredText) UnmarshalJSON(data []byte) error { + type NoMethod CloudAiLargeModelsVisionFilteredText + 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 +} + +// CloudAiLargeModelsVisionGenerateVideoResponse: Generate video +// response. +type CloudAiLargeModelsVisionGenerateVideoResponse struct { + // GeneratedSamples: The generates samples. + GeneratedSamples []*CloudAiLargeModelsVisionMedia `json:"generatedSamples,omitempty"` + + // RaiMediaFilteredCount: Returns if any videos were filtered due to RAI + // policies. + RaiMediaFilteredCount int64 `json:"raiMediaFilteredCount,omitempty"` + + // RaiMediaFilteredReasons: Returns rai failure reasons if any. + RaiMediaFilteredReasons []string `json:"raiMediaFilteredReasons,omitempty"` + + // RaiTextFilteredReason: Returns filtered text rai info. + RaiTextFilteredReason *CloudAiLargeModelsVisionFilteredText `json:"raiTextFilteredReason,omitempty"` + + // ForceSendFields is a list of field names (e.g. "GeneratedSamples") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "GeneratedSamples") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *CloudAiLargeModelsVisionGenerateVideoResponse) MarshalJSON() ([]byte, error) { + type NoMethod CloudAiLargeModelsVisionGenerateVideoResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// CloudAiLargeModelsVisionImage: Image. +type CloudAiLargeModelsVisionImage struct { + // Encoding: Image encoding, encoded as "image/png" or "image/jpg". + Encoding string `json:"encoding,omitempty"` + + // Image: Raw bytes. + Image string `json:"image,omitempty"` + + // ImageRaiScores: RAI scores for generated image. + ImageRaiScores *CloudAiLargeModelsVisionImageRAIScores `json:"imageRaiScores,omitempty"` + + // RaiInfo: RAI info for image + RaiInfo *CloudAiLargeModelsVisionRaiInfo `json:"raiInfo,omitempty"` + + // SemanticFilterResponse: Semantic filter info for image. + SemanticFilterResponse *CloudAiLargeModelsVisionSemanticFilterResponse `json:"semanticFilterResponse,omitempty"` + + // Uri: Path to another storage (typically Google Cloud Storage). + Uri string `json:"uri,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Encoding") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Encoding") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *CloudAiLargeModelsVisionImage) MarshalJSON() ([]byte, error) { + type NoMethod CloudAiLargeModelsVisionImage + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// CloudAiLargeModelsVisionImageRAIScores: RAI scores for generated +// image returned. +type CloudAiLargeModelsVisionImageRAIScores struct { + // AgileWatermarkDetectionScore: Agile watermark score for image. + AgileWatermarkDetectionScore float64 `json:"agileWatermarkDetectionScore,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "AgileWatermarkDetectionScore") to unconditionally include in API + // requests. By default, fields with empty or default values are omitted + // from API requests. However, any non-pointer, non-interface field + // appearing in ForceSendFields will be sent to the server regardless of + // whether the field is empty or not. This may be used to include empty + // fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. + // "AgileWatermarkDetectionScore") to include in API requests with the + // JSON null value. By default, fields with empty values are omitted + // from API requests. However, any field with an empty value appearing + // in NullFields will be sent to the server as null. It is an error if a + // field in this list has a non-empty value. This may be used to include + // null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *CloudAiLargeModelsVisionImageRAIScores) MarshalJSON() ([]byte, error) { + type NoMethod CloudAiLargeModelsVisionImageRAIScores + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *CloudAiLargeModelsVisionImageRAIScores) UnmarshalJSON(data []byte) error { + type NoMethod CloudAiLargeModelsVisionImageRAIScores + var s1 struct { + AgileWatermarkDetectionScore gensupport.JSONFloat64 `json:"agileWatermarkDetectionScore"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.AgileWatermarkDetectionScore = float64(s1.AgileWatermarkDetectionScore) + return nil +} + +// CloudAiLargeModelsVisionMedia: Media. +type CloudAiLargeModelsVisionMedia struct { + // Image: Image. + Image *CloudAiLargeModelsVisionImage `json:"image,omitempty"` + + // Video: Video + Video *CloudAiLargeModelsVisionVideo `json:"video,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Image") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Image") to include in API + // requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *CloudAiLargeModelsVisionMedia) MarshalJSON() ([]byte, error) { + type NoMethod CloudAiLargeModelsVisionMedia + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// CloudAiLargeModelsVisionMediaGenerateContentResponse: Generate media +// content response +type CloudAiLargeModelsVisionMediaGenerateContentResponse struct { + // Response: Response to the user's request. + Response *CloudAiNlLlmProtoServiceGenerateMultiModalResponse `json:"response,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Response") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Response") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *CloudAiLargeModelsVisionMediaGenerateContentResponse) MarshalJSON() ([]byte, error) { + type NoMethod CloudAiLargeModelsVisionMediaGenerateContentResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +type CloudAiLargeModelsVisionNamedBoundingBox struct { + Classes []string `json:"classes,omitempty"` + + Entities []string `json:"entities,omitempty"` + + Scores []float64 `json:"scores,omitempty"` + + X1 float64 `json:"x1,omitempty"` + + X2 float64 `json:"x2,omitempty"` + + Y1 float64 `json:"y1,omitempty"` + + Y2 float64 `json:"y2,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Classes") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Classes") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *CloudAiLargeModelsVisionNamedBoundingBox) MarshalJSON() ([]byte, error) { + type NoMethod CloudAiLargeModelsVisionNamedBoundingBox + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *CloudAiLargeModelsVisionNamedBoundingBox) UnmarshalJSON(data []byte) error { + type NoMethod CloudAiLargeModelsVisionNamedBoundingBox + var s1 struct { + Scores []gensupport.JSONFloat64 `json:"scores"` + X1 gensupport.JSONFloat64 `json:"x1"` + X2 gensupport.JSONFloat64 `json:"x2"` + Y1 gensupport.JSONFloat64 `json:"y1"` + Y2 gensupport.JSONFloat64 `json:"y2"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.Scores = make([]float64, len(s1.Scores)) + for i := range s1.Scores { + s.Scores[i] = float64(s1.Scores[i]) + } + s.X1 = float64(s1.X1) + s.X2 = float64(s1.X2) + s.Y1 = float64(s1.Y1) + s.Y2 = float64(s1.Y2) + return nil +} + +type CloudAiLargeModelsVisionRaiInfo struct { + // RaiCategories: List of rai categories' information to return + RaiCategories []string `json:"raiCategories,omitempty"` + + // Scores: List of rai scores mapping to the rai categories. Rounded to + // 1 decimal place. + Scores []float64 `json:"scores,omitempty"` + + // ForceSendFields is a list of field names (e.g. "RaiCategories") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "RaiCategories") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *CloudAiLargeModelsVisionRaiInfo) MarshalJSON() ([]byte, error) { + type NoMethod CloudAiLargeModelsVisionRaiInfo + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *CloudAiLargeModelsVisionRaiInfo) UnmarshalJSON(data []byte) error { + type NoMethod CloudAiLargeModelsVisionRaiInfo + var s1 struct { + Scores []gensupport.JSONFloat64 `json:"scores"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.Scores = make([]float64, len(s1.Scores)) + for i := range s1.Scores { + s.Scores[i] = float64(s1.Scores[i]) + } + return nil +} + +// CloudAiLargeModelsVisionReasonVideoResponse: Video reasoning +// response. +type CloudAiLargeModelsVisionReasonVideoResponse struct { + // Responses: Generated text responses. The generated responses for + // different segments within the same video. + Responses []*CloudAiLargeModelsVisionReasonVideoResponseTextResponse `json:"responses,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Responses") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Responses") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *CloudAiLargeModelsVisionReasonVideoResponse) MarshalJSON() ([]byte, error) { + type NoMethod CloudAiLargeModelsVisionReasonVideoResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// CloudAiLargeModelsVisionReasonVideoResponseTextResponse: Contains +// text that is the response of the video captioning. +type CloudAiLargeModelsVisionReasonVideoResponseTextResponse struct { + // RelativeTemporalPartition: Partition of the caption's video in time. + // This field is intended for video captioning. To represent the start + // time and end time of the caption's video. + RelativeTemporalPartition *CloudAiLargeModelsVisionRelativeTemporalPartition `json:"relativeTemporalPartition,omitempty"` + + // Text: Text information + Text string `json:"text,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "RelativeTemporalPartition") to unconditionally include in API + // requests. By default, fields with empty or default values are omitted + // from API requests. However, any non-pointer, non-interface field + // appearing in ForceSendFields will be sent to the server regardless of + // whether the field is empty or not. This may be used to include empty + // fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. + // "RelativeTemporalPartition") to include in API requests with the JSON + // null value. By default, fields with empty values are omitted from API + // requests. However, any field with an empty value appearing in + // NullFields will be sent to the server as null. It is an error if a + // field in this list has a non-empty value. This may be used to include + // null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *CloudAiLargeModelsVisionReasonVideoResponseTextResponse) MarshalJSON() ([]byte, error) { + type NoMethod CloudAiLargeModelsVisionReasonVideoResponseTextResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// CloudAiLargeModelsVisionRelativeTemporalPartition: For ease of use, +// assume that the start_offset is inclusive and the end_offset is +// exclusive. In mathematical terms, the partition would be written as +// [start_offset, end_offset). +type CloudAiLargeModelsVisionRelativeTemporalPartition struct { + // EndOffset: End time offset of the partition. + EndOffset string `json:"endOffset,omitempty"` + + // StartOffset: Start time offset of the partition. + StartOffset string `json:"startOffset,omitempty"` + + // ForceSendFields is a list of field names (e.g. "EndOffset") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "EndOffset") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *CloudAiLargeModelsVisionRelativeTemporalPartition) MarshalJSON() ([]byte, error) { + type NoMethod CloudAiLargeModelsVisionRelativeTemporalPartition + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +type CloudAiLargeModelsVisionSemanticFilterResponse struct { + // NamedBoundingBoxes: Class labels of the bounding boxes that failed + // the semantic filtering. Bounding box coordinates. + NamedBoundingBoxes []*CloudAiLargeModelsVisionNamedBoundingBox `json:"namedBoundingBoxes,omitempty"` + + // PassedSemanticFilter: This response is added when semantic filter + // config is turned on in EditConfig. It reports if this image is passed + // semantic filter response. If passed_semantic_filter is false, the + // bounding box information will be populated for user to check what + // caused the semantic filter to fail. + PassedSemanticFilter bool `json:"passedSemanticFilter,omitempty"` + + // ForceSendFields is a list of field names (e.g. "NamedBoundingBoxes") + // to unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "NamedBoundingBoxes") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *CloudAiLargeModelsVisionSemanticFilterResponse) MarshalJSON() ([]byte, error) { + type NoMethod CloudAiLargeModelsVisionSemanticFilterResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// CloudAiLargeModelsVisionVideo: Video +type CloudAiLargeModelsVisionVideo struct { + // Uri: Path to another storage (typically Google Cloud Storage). + Uri string `json:"uri,omitempty"` + + // Video: Raw bytes. + Video string `json:"video,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Uri") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Uri") to include in API + // requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *CloudAiLargeModelsVisionVideo) MarshalJSON() ([]byte, error) { + type NoMethod CloudAiLargeModelsVisionVideo + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +type CloudAiNlLlmProtoServiceCandidate struct { + // CitationMetadata: Source attribution of the generated content. + CitationMetadata *CloudAiNlLlmProtoServiceCitationMetadata `json:"citationMetadata,omitempty"` + + // Content: Content of the candidate. + Content *CloudAiNlLlmProtoServiceContent `json:"content,omitempty"` + + // FinishMessage: A string that describes the filtering behavior in more + // detail. Only filled when reason is set. + FinishMessage string `json:"finishMessage,omitempty"` + + // FinishReason: The reason why the model stopped generating tokens. + // + // Possible values: + // "FINISH_REASON_UNSPECIFIED" - The finish reason is unspecified. + // "FINISH_REASON_STOP" - Natural stop point of the model or provided + // stop sequence. + // "FINISH_REASON_MAX_TOKENS" - The maximum number of tokens as + // specified in the request was reached. + // "FINISH_REASON_SAFETY" - The token generation was stopped as the + // response was flagged for safety reasons. NOTE: When streaming the + // Candidate.content will be empty if content filters blocked the + // output. + // "FINISH_REASON_RECITATION" - The token generation was stopped as + // the response was flagged for unauthorized citations. + // "FINISH_REASON_OTHER" - All other reasons that stopped the token + // generation. + FinishReason string `json:"finishReason,omitempty"` + + // Index: Index of the candidate. + Index int64 `json:"index,omitempty"` + + // SafetyRatings: Safety ratings of the generated content. + SafetyRatings []*CloudAiNlLlmProtoServiceSafetyRating `json:"safetyRatings,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CitationMetadata") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "CitationMetadata") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *CloudAiNlLlmProtoServiceCandidate) MarshalJSON() ([]byte, error) { + type NoMethod CloudAiNlLlmProtoServiceCandidate + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// CloudAiNlLlmProtoServiceCitation: Source attributions for content. +type CloudAiNlLlmProtoServiceCitation struct { + // EndIndex: End index into the content. + EndIndex int64 `json:"endIndex,omitempty"` + + // License: License of the attribution. + License string `json:"license,omitempty"` + + // PublicationDate: Publication date of the attribution. + PublicationDate *GoogleTypeDate `json:"publicationDate,omitempty"` + + // StartIndex: Start index into the content. + StartIndex int64 `json:"startIndex,omitempty"` + + // Title: Title of the attribution. + Title string `json:"title,omitempty"` + + // Uri: Url reference of the attribution. + 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 default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "EndIndex") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *CloudAiNlLlmProtoServiceCitation) MarshalJSON() ([]byte, error) { + type NoMethod CloudAiNlLlmProtoServiceCitation + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// CloudAiNlLlmProtoServiceCitationMetadata: A collection of source +// attributions for a piece of content. +type CloudAiNlLlmProtoServiceCitationMetadata struct { + // Citations: List of citations. + Citations []*CloudAiNlLlmProtoServiceCitation `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 default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Citations") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *CloudAiNlLlmProtoServiceCitationMetadata) MarshalJSON() ([]byte, error) { + type NoMethod CloudAiNlLlmProtoServiceCitationMetadata + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// CloudAiNlLlmProtoServiceContent: The content of a single message from +// a participant. +type CloudAiNlLlmProtoServiceContent struct { + // Parts: The parts of the message. + Parts []*CloudAiNlLlmProtoServicePart `json:"parts,omitempty"` + + // Role: The role of the current conversation participant. + 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 omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Parts") to include in API + // requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *CloudAiNlLlmProtoServiceContent) MarshalJSON() ([]byte, error) { + type NoMethod CloudAiNlLlmProtoServiceContent + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// CloudAiNlLlmProtoServiceFunctionCall: Function call details. +type CloudAiNlLlmProtoServiceFunctionCall struct { + // Args: The function parameters and values in JSON format. + Args googleapi.RawMessage `json:"args,omitempty"` + + // Name: Required. The name of the function to call. + Name string `json:"name,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Args") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Args") to include in API + // requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *CloudAiNlLlmProtoServiceFunctionCall) MarshalJSON() ([]byte, error) { + type NoMethod CloudAiNlLlmProtoServiceFunctionCall + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// CloudAiNlLlmProtoServiceFunctionResponse: Function response details. +type CloudAiNlLlmProtoServiceFunctionResponse struct { + // Name: Required. The name of the function to call. + Name string `json:"name,omitempty"` + + // Response: Required. The function response in JSON object format. + Response googleapi.RawMessage `json:"response,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Name") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Name") to include in API + // requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *CloudAiNlLlmProtoServiceFunctionResponse) MarshalJSON() ([]byte, error) { + type NoMethod CloudAiNlLlmProtoServiceFunctionResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +type CloudAiNlLlmProtoServiceGenerateMultiModalResponse struct { + // Candidates: Possible candidate responses to the conversation up until + // this point. + Candidates []*CloudAiNlLlmProtoServiceCandidate `json:"candidates,omitempty"` + + // PromptFeedback: Content filter results for a prompt sent in the + // request. Note: Sent only in the first stream chunk. Only happens when + // no candidates were generated due to content violations. + PromptFeedback *CloudAiNlLlmProtoServicePromptFeedback `json:"promptFeedback,omitempty"` + + // ReportingMetrics: Billable prediction metrics. + ReportingMetrics *IntelligenceCloudAutomlXpsReportingMetrics `json:"reportingMetrics,omitempty"` + + // UsageMetadata: Usage metadata about the response(s). + UsageMetadata *CloudAiNlLlmProtoServiceUsageMetadata `json:"usageMetadata,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Candidates") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Candidates") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *CloudAiNlLlmProtoServiceGenerateMultiModalResponse) MarshalJSON() ([]byte, error) { + type NoMethod CloudAiNlLlmProtoServiceGenerateMultiModalResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// CloudAiNlLlmProtoServicePart: A single part of a message. +type CloudAiNlLlmProtoServicePart struct { + // FileData: URI-based data. + FileData *CloudAiNlLlmProtoServicePartFileData `json:"fileData,omitempty"` + + // FunctionCall: Function call data. + FunctionCall *CloudAiNlLlmProtoServiceFunctionCall `json:"functionCall,omitempty"` + + // FunctionResponse: Function response data. + FunctionResponse *CloudAiNlLlmProtoServiceFunctionResponse `json:"functionResponse,omitempty"` + + // InlineData: Inline bytes data + InlineData *CloudAiNlLlmProtoServicePartBlob `json:"inlineData,omitempty"` + + // Text: Text input. + Text string `json:"text,omitempty"` + + // VideoMetadata: Video metadata. The metadata should only be specified + // while the video data is presented in inline_data or file_data. + VideoMetadata *CloudAiNlLlmProtoServicePartVideoMetadata `json:"videoMetadata,omitempty"` + + // ForceSendFields is a list of field names (e.g. "FileData") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "FileData") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *CloudAiNlLlmProtoServicePart) MarshalJSON() ([]byte, error) { + type NoMethod CloudAiNlLlmProtoServicePart + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// CloudAiNlLlmProtoServicePartBlob: Represents arbitrary blob data +// input. +type CloudAiNlLlmProtoServicePartBlob struct { + // Data: Inline data. + Data string `json:"data,omitempty"` + + // MimeType: The mime type corresponding to this input. + MimeType string `json:"mimeType,omitempty"` + + // OriginalFileData: Original file data where the blob comes from. + OriginalFileData *CloudAiNlLlmProtoServicePartFileData `json:"originalFileData,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Data") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Data") to include in API + // requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *CloudAiNlLlmProtoServicePartBlob) MarshalJSON() ([]byte, error) { + type NoMethod CloudAiNlLlmProtoServicePartBlob + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// CloudAiNlLlmProtoServicePartFileData: Represents file data. +type CloudAiNlLlmProtoServicePartFileData struct { + // FileUri: Inline data. + FileUri string `json:"fileUri,omitempty"` + + // MimeType: The mime type corresponding to this input. + MimeType string `json:"mimeType,omitempty"` + + // ForceSendFields is a list of field names (e.g. "FileUri") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "FileUri") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *CloudAiNlLlmProtoServicePartFileData) MarshalJSON() ([]byte, error) { + type NoMethod CloudAiNlLlmProtoServicePartFileData + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// CloudAiNlLlmProtoServicePartVideoMetadata: Metadata describes the +// input video content. +type CloudAiNlLlmProtoServicePartVideoMetadata struct { + // EndOffset: The end offset of the video. + EndOffset string `json:"endOffset,omitempty"` + + // StartOffset: The start offset of the video. + StartOffset string `json:"startOffset,omitempty"` + + // ForceSendFields is a list of field names (e.g. "EndOffset") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "EndOffset") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *CloudAiNlLlmProtoServicePartVideoMetadata) MarshalJSON() ([]byte, error) { + type NoMethod CloudAiNlLlmProtoServicePartVideoMetadata + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// CloudAiNlLlmProtoServicePromptFeedback: Content filter results for a +// prompt sent in the request. +type CloudAiNlLlmProtoServicePromptFeedback struct { + // BlockReason: Blocked reason. + // + // Possible values: + // "BLOCKED_REASON_UNSPECIFIED" - Unspecified blocked reason. + // "SAFETY" - Candidates blocked due to safety. + // "OTHER" - Candidates blocked due to other reason. + BlockReason string `json:"blockReason,omitempty"` + + // BlockReasonMessage: A readable block reason message. + BlockReasonMessage string `json:"blockReasonMessage,omitempty"` + + // SafetyRatings: Safety ratings. + SafetyRatings []*CloudAiNlLlmProtoServiceSafetyRating `json:"safetyRatings,omitempty"` + + // ForceSendFields is a list of field names (e.g. "BlockReason") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "BlockReason") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *CloudAiNlLlmProtoServicePromptFeedback) MarshalJSON() ([]byte, error) { + type NoMethod CloudAiNlLlmProtoServicePromptFeedback + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// CloudAiNlLlmProtoServiceSafetyRating: Safety rating corresponding to +// the generated content. +type CloudAiNlLlmProtoServiceSafetyRating struct { + // Blocked: Indicates whether the content was filtered out because of + // this rating. + Blocked bool `json:"blocked,omitempty"` + + // Category: Harm category. + // + // 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 dengerous + // content. + // "HARM_CATEGORY_HARASSMENT" - The harm category is harassment. + // "HARM_CATEGORY_SEXUALLY_EXPLICIT" - The harm category is sexually + // explicit. + Category string `json:"category,omitempty"` + + // Probability: Harm probability levels in the content. + // + // 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. + Probability string `json:"probability,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 omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Blocked") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *CloudAiNlLlmProtoServiceSafetyRating) MarshalJSON() ([]byte, error) { + type NoMethod CloudAiNlLlmProtoServiceSafetyRating + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// CloudAiNlLlmProtoServiceUsageMetadata: Usage metadata about +// response(s). +type CloudAiNlLlmProtoServiceUsageMetadata struct { + // CandidatesTokenCount: Number of tokens in the response(s). + CandidatesTokenCount int64 `json:"candidatesTokenCount,omitempty"` + + // PromptTokenCount: Number of tokens in the request. + PromptTokenCount int64 `json:"promptTokenCount,omitempty"` + + TotalTokenCount int64 `json:"totalTokenCount,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "CandidatesTokenCount") to unconditionally include in API requests. + // By default, fields with empty or default values are omitted from API + // requests. However, any non-pointer, non-interface field appearing in + // ForceSendFields will be sent to the server regardless of whether the + // field is empty or not. This may be used to include empty fields in + // Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "CandidatesTokenCount") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *CloudAiNlLlmProtoServiceUsageMetadata) MarshalJSON() ([]byte, error) { + type NoMethod CloudAiNlLlmProtoServiceUsageMetadata + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleApiHttpBody: Message that represents an arbitrary HTTP body. It // should only be used for payload formats that can't be represented as // JSON, such as raw binary or an HTML page. This message can be used @@ -3047,8 +4171,7 @@ type GoogleCloudAiplatformV1beta1BatchPredictionJobInstanceConfig struct { // instance that is sent to the Model. Excluded will be attached to the // batch prediction output if key_field is not specified. When // excluded_fields is populated, included_fields must be empty. The - // input must be JSONL with objects at each line, CSV, BigQuery or - // TfRecord. + // input must be JSONL with objects at each line, BigQuery or TfRecord. ExcludedFields []string `json:"excludedFields,omitempty"` // IncludedFields: Fields that will be included in the prediction @@ -3056,7 +4179,7 @@ type GoogleCloudAiplatformV1beta1BatchPredictionJobInstanceConfig struct { // order of field names in included_fields also determines the order of // the values in the array. When included_fields is populated, // excluded_fields must be empty. The input must be JSONL with objects - // at each line, CSV, BigQuery or TfRecord. + // at each line, BigQuery or TfRecord. IncludedFields []string `json:"includedFields,omitempty"` // InstanceType: The format of the instance that the Model accepts. @@ -3510,12 +4633,13 @@ func (s *GoogleCloudAiplatformV1beta1BigQuerySource) MarshalJSON() ([]byte, erro return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudAiplatformV1beta1Blob: Content blob. +// GoogleCloudAiplatformV1beta1Blob: Raw media bytes. Text should not be +// sent as raw bytes, use the 'text' field. type GoogleCloudAiplatformV1beta1Blob struct { - // Data: Required. Data. + // Data: Required. Raw bytes for media formats. Data string `json:"data,omitempty"` - // MimeType: Required. Mime type of the data. + // MimeType: Required. The IANA standard MIME type of the source data. MimeType string `json:"mimeType,omitempty"` // ForceSendFields is a list of field names (e.g. "Data") to @@ -3653,7 +4777,8 @@ type GoogleCloudAiplatformV1beta1CancelPipelineJobRequest struct { type GoogleCloudAiplatformV1beta1CancelTrainingPipelineRequest struct { } -// GoogleCloudAiplatformV1beta1Candidate: Generated candidate. +// GoogleCloudAiplatformV1beta1Candidate: A response candidate generated +// from the model. type GoogleCloudAiplatformV1beta1Candidate struct { // CitationMetadata: Output only. Source attribution of the generated // content. @@ -3662,12 +4787,14 @@ type GoogleCloudAiplatformV1beta1Candidate struct { // Content: Output only. Content parts of the candidate. Content *GoogleCloudAiplatformV1beta1Content `json:"content,omitempty"` - // FinishMessage: Output only. A string that describes the filtering - // behavior in more detail. Only filled when reason is set. + // FinishMessage: Output only. Describes the reason the mode stopped + // generating tokens in more detail. This is only filled when + // `finish_reason` is set. FinishMessage string `json:"finishMessage,omitempty"` // FinishReason: Output only. The reason why the model stopped - // generating tokens. + // generating tokens. If empty, the model has not stopped generating the + // tokens. // // Possible values: // "FINISH_REASON_UNSPECIFIED" - The finish reason is unspecified. @@ -3686,7 +4813,8 @@ type GoogleCloudAiplatformV1beta1Candidate struct { // Index: Output only. Index of the candidate. Index int64 `json:"index,omitempty"` - // SafetyRatings: Output only. Safety ratings of the generated content. + // SafetyRatings: Output only. List of ratings for the safety of a + // response candidate. There is at most one rating per category. SafetyRatings []*GoogleCloudAiplatformV1beta1SafetyRating `json:"safetyRatings,omitempty"` // ForceSendFields is a list of field names (e.g. "CitationMetadata") to @@ -4091,17 +5219,19 @@ func (s *GoogleCloudAiplatformV1beta1ContainerSpec) MarshalJSON() ([]byte, error return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudAiplatformV1beta1Content: A single turn in a conversation -// with the model. +// GoogleCloudAiplatformV1beta1Content: 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. type GoogleCloudAiplatformV1beta1Content struct { - // Parts: Required. Ordered parts that make up a message. Parts may have - // different MIME types. + // Parts: Required. Ordered `Parts` that constitute a single message. + // Parts may have different IANA MIME types. Parts []*GoogleCloudAiplatformV1beta1Part `json:"parts,omitempty"` - // Role: Optional. The role in a conversation associated with this - // content. Set it only if a content represents a turn in a - // conversations, otherwise no need to set role. Possible values: user, - // model. + // 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. Role string `json:"role,omitempty"` // ForceSendFields is a list of field names (e.g. "Parts") to @@ -5494,6 +6624,20 @@ type GoogleCloudAiplatformV1beta1CustomJobSpec struct { // s}/contexts/{experiment-name}-{experiment-run-name}` ExperimentRun string `json:"experimentRun,omitempty"` + // Models: Optional. The name of the Model resources for which to + // generate a mapping to artifact URIs. Applicable only to some of the + // Google-provided custom jobs. Format: + // `projects/{project}/locations/{location}/models/{model}` In order to + // retrieve a specific version of the model, also provide the version ID + // or version alias. Example: + // `projects/{project}/locations/{location}/models/{model}@2` or + // `projects/{project}/locations/{location}/models/{model}@golden` If no + // version ID or alias is specified, the "default" version will be + // returned. The "default" version alias is created for the first + // version of the model, and can be moved to other versions later on. + // There will be exactly one default version. + Models []string `json:"models,omitempty"` + // Network: Optional. The full name of the Compute Engine network // (/compute/docs/networks-and-firewalls#networks) to which the Job // should be peered. For example, @@ -11493,7 +12637,7 @@ type GoogleCloudAiplatformV1beta1FileData struct { // FileUri: Required. URI. FileUri string `json:"fileUri,omitempty"` - // MimeType: Required. Mime type of the data. + // MimeType: Required. The IANA standard MIME type of the source data. MimeType string `json:"mimeType,omitempty"` // ForceSendFields is a list of field names (e.g. "FileUri") to @@ -11910,8 +13054,12 @@ func (s *GoogleCloudAiplatformV1beta1FunctionCall) MarshalJSON() ([]byte, error) return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudAiplatformV1beta1FunctionDeclaration: Function declaration -// details. +// GoogleCloudAiplatformV1beta1FunctionDeclaration: Structured +// representation of a function declaration as defined by the OpenAPI +// 3.0 specification (https://spec.openapis.org/oas/v3.0.3). Included in +// this declaration are the function name and parameters. This +// FunctionDeclaration is a representation of a block of code that can +// be used as a `Tool` by the model and executed by the client. type GoogleCloudAiplatformV1beta1FunctionDeclaration struct { // Description: Optional. Description and purpose of the function. Model // uses it to decide how and whether to call the function. @@ -11922,10 +13070,14 @@ type GoogleCloudAiplatformV1beta1FunctionDeclaration struct { // underscores and dashes, with a maximum length of 64. Name string `json:"name,omitempty"` - // Parameters: Optional. Describes the parameters to this function. - // Reflects the Open API 3.03 Parameter Object string Key: the name of - // the parameter. Parameter names are case sensitive. For function with - // no parameters, this can be left unset. + // Parameters: Optional. Describes the parameters to this function in + // JSON Schema Object format. Reflects the Open API 3.03 Parameter + // Object. string Key: the name of the parameter. Parameter names are + // case sensitive. Schema Value: the Schema defining the type used for + // the parameter. For function with no parameters, this can be left + // unset. Example with 1 required and 1 optional parameter: type: OBJECT + // properties: param1: type: STRING param2: type: INTEGER required: - + // param1 Parameters *GoogleCloudAiplatformV1beta1Schema `json:"parameters,omitempty"` // ForceSendFields is a list of field names (e.g. "Description") to @@ -12133,7 +13285,10 @@ func (s *GoogleCloudAiplatformV1beta1GenerateAccessTokenResponse) MarshalJSON() // GoogleCloudAiplatformV1beta1GenerateContentRequest: Request message // for [PredictionService.GenerateContent]. type GoogleCloudAiplatformV1beta1GenerateContentRequest struct { - // Contents: Required. Input content. + // Contents: Required. The content of the current conversation with the + // model. For single-turn queries, this is a single instance. For + // multi-turn queries, this is a repeated field that contains + // conversation history + latest request. Contents []*GoogleCloudAiplatformV1beta1Content `json:"contents,omitempty"` // Endpoint: Required. The name of the Endpoint requested to serve the @@ -12148,7 +13303,11 @@ type GoogleCloudAiplatformV1beta1GenerateContentRequest struct { // content. Enforced on GenerateContentResponse.candidates. SafetySettings []*GoogleCloudAiplatformV1beta1SafetySetting `json:"safetySettings,omitempty"` - // Tools: Optional. Tools that the model may use to generate response. + // Tools: Optional. A list of `Tools` the model may use to generate the + // next response. A `Tool` is a piece of code that enables the system to + // interact with external systems to perform an action, or set of + // actions, outside of knowledge and scope of the model. The only + // supported tool is currently `Function` Tools []*GoogleCloudAiplatformV1beta1Tool `json:"tools,omitempty"` // ForceSendFields is a list of field names (e.g. "Contents") to @@ -12296,25 +13455,10 @@ type GoogleCloudAiplatformV1beta1GenerationConfig struct { // CandidateCount: Optional. Number of candidates to generate. CandidateCount int64 `json:"candidateCount,omitempty"` - // Echo: Optional. Echo. - Echo bool `json:"echo,omitempty"` - - // FrequencyPenalty: Optional. Frequency penalties. - FrequencyPenalty float64 `json:"frequencyPenalty,omitempty"` - - // LogitBias: Optional. Logit bias. - LogitBias map[string]float64 `json:"logitBias,omitempty"` - - // Logprobs: Optional. Logit probabilities. - Logprobs int64 `json:"logprobs,omitempty"` - // MaxOutputTokens: Optional. The maximum number of output tokens to // generate per message. MaxOutputTokens int64 `json:"maxOutputTokens,omitempty"` - // PresencePenalty: Optional. Positive penalties. - PresencePenalty float64 `json:"presencePenalty,omitempty"` - // StopSequences: Optional. Stop sequences. StopSequences []string `json:"stopSequences,omitempty"` @@ -12354,19 +13498,15 @@ func (s *GoogleCloudAiplatformV1beta1GenerationConfig) MarshalJSON() ([]byte, er func (s *GoogleCloudAiplatformV1beta1GenerationConfig) UnmarshalJSON(data []byte) error { type NoMethod GoogleCloudAiplatformV1beta1GenerationConfig var s1 struct { - FrequencyPenalty gensupport.JSONFloat64 `json:"frequencyPenalty"` - PresencePenalty gensupport.JSONFloat64 `json:"presencePenalty"` - Temperature gensupport.JSONFloat64 `json:"temperature"` - TopK gensupport.JSONFloat64 `json:"topK"` - TopP gensupport.JSONFloat64 `json:"topP"` + Temperature gensupport.JSONFloat64 `json:"temperature"` + TopK gensupport.JSONFloat64 `json:"topK"` + TopP gensupport.JSONFloat64 `json:"topP"` *NoMethod } s1.NoMethod = (*NoMethod)(s) if err := json.Unmarshal(data, &s1); err != nil { return err } - s.FrequencyPenalty = float64(s1.FrequencyPenalty) - s.PresencePenalty = float64(s1.PresencePenalty) s.Temperature = float64(s1.Temperature) s.TopK = float64(s1.TopK) s.TopP = float64(s1.TopP) @@ -18262,6 +19402,8 @@ type GoogleCloudAiplatformV1beta1ModelSourceInfo struct { // "BQML" - The Model is registered and sync'ed from BigQuery ML. // "MODEL_GARDEN" - The Model is saved or tuned from Model Garden. // "GENIE" - The Model is saved or tuned from Genie. + // "CUSTOM_TEXT_EMBEDDING" - The Model is uploaded by text embedding + // finetuning pipeline. SourceType string `json:"sourceType,omitempty"` // ForceSendFields is a list of field names (e.g. "Copy") to @@ -19811,7 +20953,12 @@ func (s *GoogleCloudAiplatformV1beta1NotebookRuntimeTemplateRef) MarshalJSON() ( return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudAiplatformV1beta1Part: Content part. +// GoogleCloudAiplatformV1beta1Part: 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. type GoogleCloudAiplatformV1beta1Part struct { // FileData: Optional. URI based data. FileData *GoogleCloudAiplatformV1beta1FileData `json:"fileData,omitempty"` @@ -21194,6 +22341,15 @@ type GoogleCloudAiplatformV1beta1PublisherModel struct { // decimal number in string representation. VersionId string `json:"versionId,omitempty"` + // VersionState: Optional. Indicates the state of the model version. + // + // Possible values: + // "VERSION_STATE_UNSPECIFIED" - The version state is unspecified. + // "VERSION_STATE_STABLE" - Used to indicate the version is stable. + // "VERSION_STATE_UNSTABLE" - Used to indicate the version is + // unstable. + VersionState string `json:"versionState,omitempty"` + // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` @@ -21312,6 +22468,10 @@ type GoogleCloudAiplatformV1beta1PublisherModelCallToActionDeploy struct { // ModelDisplayName: Optional. Default model display name. ModelDisplayName string `json:"modelDisplayName,omitempty"` + // PublicArtifactUri: Optional. The signed URI for ephemeral Cloud + // Storage access to model artifact. + PublicArtifactUri string `json:"publicArtifactUri,omitempty"` + // SharedResources: The resource name of the shared // DeploymentResourcePool to deploy on. Format: // `projects/{project}/locations/{location}/deploymentResourcePools/{depl @@ -21481,13 +22641,19 @@ func (s *GoogleCloudAiplatformV1beta1PublisherModelParent) MarshalJSON() ([]byte // GoogleCloudAiplatformV1beta1PublisherModelResourceReference: // Reference to a resource. type GoogleCloudAiplatformV1beta1PublisherModelResourceReference struct { + // Description: Description of the resource. + Description string `json:"description,omitempty"` + // ResourceName: The resource name of the Google Cloud resource. ResourceName string `json:"resourceName,omitempty"` // Uri: The URI of the resource. Uri string `json:"uri,omitempty"` - // ForceSendFields is a list of field names (e.g. "ResourceName") to + // UseCase: Use case (CUJ) of the resource. + UseCase string `json:"useCase,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Description") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be @@ -21495,7 +22661,7 @@ type GoogleCloudAiplatformV1beta1PublisherModelResourceReference struct { // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "ResourceName") to include + // NullFields is a list of field names (e.g. "Description") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as @@ -23570,10 +24736,10 @@ func (s *GoogleCloudAiplatformV1beta1Scheduling) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudAiplatformV1beta1Schema: Represents a select subset of an -// OpenAPI 3.0 Schema object. Schema is used to define the format of -// input/output data. More fields may be added in the future as needed. -// https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#schemaObject +// GoogleCloudAiplatformV1beta1Schema: Schema is used to define the +// format of input/output data. Represents a select subset of an OpenAPI +// 3.0 schema object (https://spec.openapis.org/oas/v3.0.3#schema). More +// fields may be added in the future as needed. type GoogleCloudAiplatformV1beta1Schema struct { // Description: Optional. The description of the data. Description string `json:"description,omitempty"` @@ -34046,7 +35212,9 @@ func (s *GoogleCloudAiplatformV1beta1TokensInfo) MarshalJSON() ([]byte, error) { } // GoogleCloudAiplatformV1beta1Tool: Tool details that the model may use -// to generate response. +// to generate response. A `Tool` is a piece of code that enables the +// system to interact with external systems to perform an action, or set +// of actions, outside of knowledge and scope of the model. type GoogleCloudAiplatformV1beta1Tool struct { // FunctionDeclarations: Optional. One or more function declarations to // be passed to the model along with the current user query. Model may @@ -36546,6 +37714,128 @@ func (s *GoogleTypeMoney) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +type IntelligenceCloudAutomlXpsMetricEntry struct { + // ArgentumMetricId: For billing metrics that are using legacy sku's, + // set the legacy billing metric id here. This will be sent to Chemist + // as the "cloudbilling.googleapis.com/argentum_metric_id" label. + // Otherwise leave empty. + ArgentumMetricId string `json:"argentumMetricId,omitempty"` + + // DoubleValue: A double value. + DoubleValue float64 `json:"doubleValue,omitempty"` + + // Int64Value: A signed 64-bit integer value. + Int64Value int64 `json:"int64Value,omitempty,string"` + + // MetricName: The metric name defined in the service configuration. + MetricName string `json:"metricName,omitempty"` + + // SystemLabels: Billing system labels for this (metric, value) pair. + SystemLabels []*IntelligenceCloudAutomlXpsMetricEntryLabel `json:"systemLabels,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ArgentumMetricId") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "ArgentumMetricId") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *IntelligenceCloudAutomlXpsMetricEntry) MarshalJSON() ([]byte, error) { + type NoMethod IntelligenceCloudAutomlXpsMetricEntry + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *IntelligenceCloudAutomlXpsMetricEntry) UnmarshalJSON(data []byte) error { + type NoMethod IntelligenceCloudAutomlXpsMetricEntry + var s1 struct { + DoubleValue gensupport.JSONFloat64 `json:"doubleValue"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.DoubleValue = float64(s1.DoubleValue) + return nil +} + +type IntelligenceCloudAutomlXpsMetricEntryLabel struct { + // LabelName: The name of the label. + LabelName string `json:"labelName,omitempty"` + + // LabelValue: The value of the label. + LabelValue string `json:"labelValue,omitempty"` + + // ForceSendFields is a list of field names (e.g. "LabelName") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "LabelName") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *IntelligenceCloudAutomlXpsMetricEntryLabel) MarshalJSON() ([]byte, error) { + type NoMethod IntelligenceCloudAutomlXpsMetricEntryLabel + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +type IntelligenceCloudAutomlXpsReportingMetrics struct { + // EffectiveTrainingDuration: The effective time training used. If set, + // this is used for quota management and billing. Deprecated. AutoML BE + // doesn't use this. Don't set. + EffectiveTrainingDuration string `json:"effectiveTrainingDuration,omitempty"` + + // MetricEntries: One entry per metric name. The values must be + // aggregated per metric name. + MetricEntries []*IntelligenceCloudAutomlXpsMetricEntry `json:"metricEntries,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "EffectiveTrainingDuration") to unconditionally include in API + // requests. By default, fields with empty or default values are omitted + // from API requests. However, any non-pointer, non-interface field + // appearing in ForceSendFields will be sent to the server regardless of + // whether the field is empty or not. This may be used to include empty + // fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. + // "EffectiveTrainingDuration") to include in API requests with the JSON + // null value. By default, fields with empty values are omitted from API + // requests. However, any field with an empty value appearing in + // NullFields will be sent to the server as null. It is an error if a + // field in this list has a non-empty value. This may be used to include + // null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *IntelligenceCloudAutomlXpsReportingMetrics) MarshalJSON() ([]byte, error) { + type NoMethod IntelligenceCloudAutomlXpsReportingMetrics + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // method id "aiplatform.projects.locations.get": type ProjectsLocationsGetCall struct { @@ -100378,6 +101668,167 @@ func (c *ProjectsLocationsPublishersModelsCountTokensCall) Do(opts ...googleapi. } +// method id "aiplatform.projects.locations.publishers.models.getIamPolicy": + +type ProjectsLocationsPublishersModelsGetIamPolicyCall struct { + s *Service + resource string + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header +} + +// GetIamPolicy: Gets the access control policy for a resource. Returns +// an empty policy if the resource exists and does not have a policy +// set. +// +// - resource: REQUIRED: The resource for which the policy is being +// requested. See Resource names +// (https://cloud.google.com/apis/design/resource_names) for the +// appropriate value for this field. +func (r *ProjectsLocationsPublishersModelsService) GetIamPolicy(resource string) *ProjectsLocationsPublishersModelsGetIamPolicyCall { + c := &ProjectsLocationsPublishersModelsGetIamPolicyCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.resource = resource + return c +} + +// OptionsRequestedPolicyVersion sets the optional parameter +// "options.requestedPolicyVersion": The maximum policy version that +// will be used to format the policy. Valid values are 0, 1, and 3. +// Requests specifying an invalid value will be rejected. Requests for +// policies with any conditional role bindings must specify version 3. +// Policies with no conditional role bindings may specify any valid +// value or leave the field unset. The policy in the response might use +// the policy version that you specified, or it might use a lower policy +// version. For example, if you specify version 3, but the policy has no +// conditional role bindings, the response uses version 1. To learn +// which resources support conditions in their IAM policies, see the IAM +// documentation +// (https://cloud.google.com/iam/help/conditions/resource-policies). +func (c *ProjectsLocationsPublishersModelsGetIamPolicyCall) OptionsRequestedPolicyVersion(optionsRequestedPolicyVersion int64) *ProjectsLocationsPublishersModelsGetIamPolicyCall { + c.urlParams_.Set("options.requestedPolicyVersion", fmt.Sprint(optionsRequestedPolicyVersion)) + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *ProjectsLocationsPublishersModelsGetIamPolicyCall) Fields(s ...googleapi.Field) *ProjectsLocationsPublishersModelsGetIamPolicyCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *ProjectsLocationsPublishersModelsGetIamPolicyCall) Context(ctx context.Context) *ProjectsLocationsPublishersModelsGetIamPolicyCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *ProjectsLocationsPublishersModelsGetIamPolicyCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsPublishersModelsGetIamPolicyCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + var body io.Reader = nil + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta1/{+resource}:getIamPolicy") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("POST", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "resource": c.resource, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "aiplatform.projects.locations.publishers.models.getIamPolicy" call. +// Exactly one of *GoogleIamV1Policy or error will be non-nil. Any +// non-2xx status code is an error. Response headers are in either +// *GoogleIamV1Policy.ServerResponse.Header or (if a response was +// returned at all) in error.(*googleapi.Error).Header. Use +// googleapi.IsNotModified to check whether the returned error was +// because http.StatusNotModified was returned. +func (c *ProjectsLocationsPublishersModelsGetIamPolicyCall) Do(opts ...googleapi.CallOption) (*GoogleIamV1Policy, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &GoogleIamV1Policy{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + // "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:getIamPolicy", + // "httpMethod": "POST", + // "id": "aiplatform.projects.locations.publishers.models.getIamPolicy", + // "parameterOrder": [ + // "resource" + // ], + // "parameters": { + // "options.requestedPolicyVersion": { + // "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + // "format": "int32", + // "location": "query", + // "type": "integer" + // }, + // "resource": { + // "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + // "location": "path", + // "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", + // "required": true, + // "type": "string" + // } + // }, + // "path": "v1beta1/{+resource}:getIamPolicy", + // "response": { + // "$ref": "GoogleIamV1Policy" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] + // } + +} + // method id "aiplatform.projects.locations.publishers.models.predict": type ProjectsLocationsPublishersModelsPredictCall struct { diff --git a/analyticsadmin/v1alpha/analyticsadmin-api.json b/analyticsadmin/v1alpha/analyticsadmin-api.json index 5b508fd4e9..2877d4750e 100644 --- a/analyticsadmin/v1alpha/analyticsadmin-api.json +++ b/analyticsadmin/v1alpha/analyticsadmin-api.json @@ -311,7 +311,7 @@ ] }, "runAccessReport": { - "description": "Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access Reports can be requested for a property. The property must be in Google Analytics 360. This method is only available to Administrators. These data access records include GA4 UI Reporting, GA4 UI Explorations, GA4 Data API, and other products like Firebase \u0026 Admob that can retrieve data from Google Analytics through a linkage. These records don't include property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents).", + "description": "Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access Reports can be requested for a property. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360 properties. This method is only available to Administrators. These data access records include GA4 UI Reporting, GA4 UI Explorations, GA4 Data API, and other products like Firebase \u0026 Admob that can retrieve data from Google Analytics through a linkage. These records don't include property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents).", "flatPath": "v1alpha/accounts/{accountsId}:runAccessReport", "httpMethod": "POST", "id": "analyticsadmin.accounts.runAccessReport", @@ -1017,7 +1017,7 @@ ] }, "runAccessReport": { - "description": "Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access Reports can be requested for a property. The property must be in Google Analytics 360. This method is only available to Administrators. These data access records include GA4 UI Reporting, GA4 UI Explorations, GA4 Data API, and other products like Firebase \u0026 Admob that can retrieve data from Google Analytics through a linkage. These records don't include property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents).", + "description": "Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access Reports can be requested for a property. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360 properties. This method is only available to Administrators. These data access records include GA4 UI Reporting, GA4 UI Explorations, GA4 Data API, and other products like Firebase \u0026 Admob that can retrieve data from Google Analytics through a linkage. These records don't include property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents).", "flatPath": "v1alpha/properties/{propertiesId}:runAccessReport", "httpMethod": "POST", "id": "analyticsadmin.properties.runAccessReport", @@ -4298,7 +4298,7 @@ } } }, - "revision": "20231112", + "revision": "20231212", "rootUrl": "https://analyticsadmin.googleapis.com/", "schemas": { "GoogleAnalyticsAdminV1alphaAccessBetweenFilter": { diff --git a/analyticsadmin/v1alpha/analyticsadmin-gen.go b/analyticsadmin/v1alpha/analyticsadmin-gen.go index b69b712ce6..67473d4655 100644 --- a/analyticsadmin/v1alpha/analyticsadmin-gen.go +++ b/analyticsadmin/v1alpha/analyticsadmin-gen.go @@ -8442,14 +8442,16 @@ type AccountsRunAccessReportCall struct { // RunAccessReport: Returns a customized report of data access records. // The report provides records of each time a user reads Google // Analytics reporting data. Access records are retained for up to 2 -// years. Data Access Reports can be requested for a property. The -// property must be in Google Analytics 360. This method is only -// available to Administrators. These data access records include GA4 UI -// Reporting, GA4 UI Explorations, GA4 Data API, and other products like -// Firebase & Admob that can retrieve data from Google Analytics through -// a linkage. These records don't include property configuration changes -// like adding a stream or changing a property's time zone. For -// configuration change history, see searchChangeHistoryEvents +// years. Data Access Reports can be requested for a property. Reports +// may be requested for any property, but dimensions that aren't related +// to quota can only be requested on Google Analytics 360 properties. +// This method is only available to Administrators. These data access +// records include GA4 UI Reporting, GA4 UI Explorations, GA4 Data API, +// and other products like Firebase & Admob that can retrieve data from +// Google Analytics through a linkage. These records don't include +// property configuration changes like adding a stream or changing a +// property's time zone. For configuration change history, see +// searchChangeHistoryEvents // (https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents). // // - entity: The Data Access Report supports requesting at the property @@ -8559,7 +8561,7 @@ func (c *AccountsRunAccessReportCall) Do(opts ...googleapi.CallOption) (*GoogleA } return ret, nil // { - // "description": "Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access Reports can be requested for a property. The property must be in Google Analytics 360. This method is only available to Administrators. These data access records include GA4 UI Reporting, GA4 UI Explorations, GA4 Data API, and other products like Firebase \u0026 Admob that can retrieve data from Google Analytics through a linkage. These records don't include property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents).", + // "description": "Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access Reports can be requested for a property. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360 properties. This method is only available to Administrators. These data access records include GA4 UI Reporting, GA4 UI Explorations, GA4 Data API, and other products like Firebase \u0026 Admob that can retrieve data from Google Analytics through a linkage. These records don't include property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents).", // "flatPath": "v1alpha/accounts/{accountsId}:runAccessReport", // "httpMethod": "POST", // "id": "analyticsadmin.accounts.runAccessReport", @@ -12494,14 +12496,16 @@ type PropertiesRunAccessReportCall struct { // RunAccessReport: Returns a customized report of data access records. // The report provides records of each time a user reads Google // Analytics reporting data. Access records are retained for up to 2 -// years. Data Access Reports can be requested for a property. The -// property must be in Google Analytics 360. This method is only -// available to Administrators. These data access records include GA4 UI -// Reporting, GA4 UI Explorations, GA4 Data API, and other products like -// Firebase & Admob that can retrieve data from Google Analytics through -// a linkage. These records don't include property configuration changes -// like adding a stream or changing a property's time zone. For -// configuration change history, see searchChangeHistoryEvents +// years. Data Access Reports can be requested for a property. Reports +// may be requested for any property, but dimensions that aren't related +// to quota can only be requested on Google Analytics 360 properties. +// This method is only available to Administrators. These data access +// records include GA4 UI Reporting, GA4 UI Explorations, GA4 Data API, +// and other products like Firebase & Admob that can retrieve data from +// Google Analytics through a linkage. These records don't include +// property configuration changes like adding a stream or changing a +// property's time zone. For configuration change history, see +// searchChangeHistoryEvents // (https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents). // // - entity: The Data Access Report supports requesting at the property @@ -12611,7 +12615,7 @@ func (c *PropertiesRunAccessReportCall) Do(opts ...googleapi.CallOption) (*Googl } return ret, nil // { - // "description": "Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access Reports can be requested for a property. The property must be in Google Analytics 360. This method is only available to Administrators. These data access records include GA4 UI Reporting, GA4 UI Explorations, GA4 Data API, and other products like Firebase \u0026 Admob that can retrieve data from Google Analytics through a linkage. These records don't include property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents).", + // "description": "Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access Reports can be requested for a property. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360 properties. This method is only available to Administrators. These data access records include GA4 UI Reporting, GA4 UI Explorations, GA4 Data API, and other products like Firebase \u0026 Admob that can retrieve data from Google Analytics through a linkage. These records don't include property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents).", // "flatPath": "v1alpha/properties/{propertiesId}:runAccessReport", // "httpMethod": "POST", // "id": "analyticsadmin.properties.runAccessReport", diff --git a/analyticsadmin/v1beta/analyticsadmin-api.json b/analyticsadmin/v1beta/analyticsadmin-api.json index af9a0a7e74..fa58f20ff3 100644 --- a/analyticsadmin/v1beta/analyticsadmin-api.json +++ b/analyticsadmin/v1beta/analyticsadmin-api.json @@ -305,7 +305,7 @@ ] }, "runAccessReport": { - "description": "Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access Reports can be requested for a property. The property must be in Google Analytics 360. This method is only available to Administrators. These data access records include GA4 UI Reporting, GA4 UI Explorations, GA4 Data API, and other products like Firebase \u0026 Admob that can retrieve data from Google Analytics through a linkage. These records don't include property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents).", + "description": "Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access Reports can be requested for a property. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360 properties. This method is only available to Administrators. These data access records include GA4 UI Reporting, GA4 UI Explorations, GA4 Data API, and other products like Firebase \u0026 Admob that can retrieve data from Google Analytics through a linkage. These records don't include property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents).", "flatPath": "v1beta/accounts/{accountsId}:runAccessReport", "httpMethod": "POST", "id": "analyticsadmin.accounts.runAccessReport", @@ -561,7 +561,7 @@ ] }, "runAccessReport": { - "description": "Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access Reports can be requested for a property. The property must be in Google Analytics 360. This method is only available to Administrators. These data access records include GA4 UI Reporting, GA4 UI Explorations, GA4 Data API, and other products like Firebase \u0026 Admob that can retrieve data from Google Analytics through a linkage. These records don't include property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents).", + "description": "Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access Reports can be requested for a property. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360 properties. This method is only available to Administrators. These data access records include GA4 UI Reporting, GA4 UI Explorations, GA4 Data API, and other products like Firebase \u0026 Admob that can retrieve data from Google Analytics through a linkage. These records don't include property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents).", "flatPath": "v1beta/properties/{propertiesId}:runAccessReport", "httpMethod": "POST", "id": "analyticsadmin.properties.runAccessReport", @@ -1628,7 +1628,7 @@ } } }, - "revision": "20231027", + "revision": "20231212", "rootUrl": "https://analyticsadmin.googleapis.com/", "schemas": { "GoogleAnalyticsAdminV1betaAccessBetweenFilter": { diff --git a/analyticsadmin/v1beta/analyticsadmin-gen.go b/analyticsadmin/v1beta/analyticsadmin-gen.go index 745911577f..d0921d0774 100644 --- a/analyticsadmin/v1beta/analyticsadmin-gen.go +++ b/analyticsadmin/v1beta/analyticsadmin-gen.go @@ -4154,14 +4154,16 @@ type AccountsRunAccessReportCall struct { // RunAccessReport: Returns a customized report of data access records. // The report provides records of each time a user reads Google // Analytics reporting data. Access records are retained for up to 2 -// years. Data Access Reports can be requested for a property. The -// property must be in Google Analytics 360. This method is only -// available to Administrators. These data access records include GA4 UI -// Reporting, GA4 UI Explorations, GA4 Data API, and other products like -// Firebase & Admob that can retrieve data from Google Analytics through -// a linkage. These records don't include property configuration changes -// like adding a stream or changing a property's time zone. For -// configuration change history, see searchChangeHistoryEvents +// years. Data Access Reports can be requested for a property. Reports +// may be requested for any property, but dimensions that aren't related +// to quota can only be requested on Google Analytics 360 properties. +// This method is only available to Administrators. These data access +// records include GA4 UI Reporting, GA4 UI Explorations, GA4 Data API, +// and other products like Firebase & Admob that can retrieve data from +// Google Analytics through a linkage. These records don't include +// property configuration changes like adding a stream or changing a +// property's time zone. For configuration change history, see +// searchChangeHistoryEvents // (https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents). // // - entity: The Data Access Report supports requesting at the property @@ -4271,7 +4273,7 @@ func (c *AccountsRunAccessReportCall) Do(opts ...googleapi.CallOption) (*GoogleA } return ret, nil // { - // "description": "Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access Reports can be requested for a property. The property must be in Google Analytics 360. This method is only available to Administrators. These data access records include GA4 UI Reporting, GA4 UI Explorations, GA4 Data API, and other products like Firebase \u0026 Admob that can retrieve data from Google Analytics through a linkage. These records don't include property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents).", + // "description": "Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access Reports can be requested for a property. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360 properties. This method is only available to Administrators. These data access records include GA4 UI Reporting, GA4 UI Explorations, GA4 Data API, and other products like Firebase \u0026 Admob that can retrieve data from Google Analytics through a linkage. These records don't include property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents).", // "flatPath": "v1beta/accounts/{accountsId}:runAccessReport", // "httpMethod": "POST", // "id": "analyticsadmin.accounts.runAccessReport", @@ -5591,14 +5593,16 @@ type PropertiesRunAccessReportCall struct { // RunAccessReport: Returns a customized report of data access records. // The report provides records of each time a user reads Google // Analytics reporting data. Access records are retained for up to 2 -// years. Data Access Reports can be requested for a property. The -// property must be in Google Analytics 360. This method is only -// available to Administrators. These data access records include GA4 UI -// Reporting, GA4 UI Explorations, GA4 Data API, and other products like -// Firebase & Admob that can retrieve data from Google Analytics through -// a linkage. These records don't include property configuration changes -// like adding a stream or changing a property's time zone. For -// configuration change history, see searchChangeHistoryEvents +// years. Data Access Reports can be requested for a property. Reports +// may be requested for any property, but dimensions that aren't related +// to quota can only be requested on Google Analytics 360 properties. +// This method is only available to Administrators. These data access +// records include GA4 UI Reporting, GA4 UI Explorations, GA4 Data API, +// and other products like Firebase & Admob that can retrieve data from +// Google Analytics through a linkage. These records don't include +// property configuration changes like adding a stream or changing a +// property's time zone. For configuration change history, see +// searchChangeHistoryEvents // (https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents). // // - entity: The Data Access Report supports requesting at the property @@ -5708,7 +5712,7 @@ func (c *PropertiesRunAccessReportCall) Do(opts ...googleapi.CallOption) (*Googl } return ret, nil // { - // "description": "Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access Reports can be requested for a property. The property must be in Google Analytics 360. This method is only available to Administrators. These data access records include GA4 UI Reporting, GA4 UI Explorations, GA4 Data API, and other products like Firebase \u0026 Admob that can retrieve data from Google Analytics through a linkage. These records don't include property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents).", + // "description": "Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access Reports can be requested for a property. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360 properties. This method is only available to Administrators. These data access records include GA4 UI Reporting, GA4 UI Explorations, GA4 Data API, and other products like Firebase \u0026 Admob that can retrieve data from Google Analytics through a linkage. These records don't include property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents).", // "flatPath": "v1beta/properties/{propertiesId}:runAccessReport", // "httpMethod": "POST", // "id": "analyticsadmin.properties.runAccessReport", diff --git a/container/v1beta1/container-api.json b/container/v1beta1/container-api.json index c4d3edb957..f23137b47e 100644 --- a/container/v1beta1/container-api.json +++ b/container/v1beta1/container-api.json @@ -2565,7 +2565,7 @@ } } }, - "revision": "20231030", + "revision": "20231201", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -2728,6 +2728,10 @@ "description": "Expose flow metrics on nodes", "type": "boolean" }, + "enableRelay": { + "description": "Enable Relay component", + "type": "boolean" + }, "relayMode": { "description": "Method used to make Relay available", "enum": [ @@ -2931,6 +2935,12 @@ }, "type": "object" }, + "AutoscaledRolloutPolicy": { + "description": "Autoscaled rollout policy uses cluster autoscaler during blue-green upgrades to scale both the green and blue pools.", + "id": "AutoscaledRolloutPolicy", + "properties": {}, + "type": "object" + }, "AvailableVersion": { "deprecated": true, "description": "Deprecated.", @@ -2996,8 +3006,8 @@ "Default value", "Disable BinaryAuthorization", "Enforce Kubernetes admission requests with BinaryAuthorization using the project's singleton policy. This is equivalent to setting the enabled boolean to true.", - "Use Binary Authorization with the policies specified in policy_bindings.", - "Use Binary Authorization with the policies specified in policy_bindings, and also with the project's singleton policy in enforcement mode." + "Use Binary Authorization Continuous Validation with the policies specified in policy_bindings.", + "Use Binary Authorization Continuous Validation with the policies specified in policy_bindings and enforce Kubernetes admission requests with Binary Authorization using the project's singleton policy." ], "type": "string" }, @@ -3070,6 +3080,10 @@ "description": "Settings for blue-green upgrade.", "id": "BlueGreenSettings", "properties": { + "autoscaledRolloutPolicy": { + "$ref": "AutoscaledRolloutPolicy", + "description": "Autoscaled policy for cluster autoscaler enabled blue-green upgrade." + }, "nodePoolSoakDuration": { "description": "Time needed after draining entire blue pool. After this period, blue pool will be cleaned up.", "format": "google-duration", diff --git a/container/v1beta1/container-gen.go b/container/v1beta1/container-gen.go index 5d8cdb0ca9..607508520d 100644 --- a/container/v1beta1/container-gen.go +++ b/container/v1beta1/container-gen.go @@ -548,6 +548,9 @@ type AdvancedDatapathObservabilityConfig struct { // EnableMetrics: Expose flow metrics on nodes EnableMetrics bool `json:"enableMetrics,omitempty"` + // EnableRelay: Enable Relay component + EnableRelay bool `json:"enableRelay,omitempty"` + // RelayMode: Method used to make Relay available // // Possible values: @@ -908,6 +911,12 @@ func (s *AutoprovisioningNodePoolDefaults) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// AutoscaledRolloutPolicy: Autoscaled rollout policy uses cluster +// autoscaler during blue-green upgrades to scale both the green and +// blue pools. +type AutoscaledRolloutPolicy struct { +} + // AvailableVersion: Deprecated. type AvailableVersion struct { // Reason: Reason for availability. @@ -1021,11 +1030,12 @@ type BinaryAuthorization struct { // "PROJECT_SINGLETON_POLICY_ENFORCE" - Enforce Kubernetes admission // requests with BinaryAuthorization using the project's singleton // policy. This is equivalent to setting the enabled boolean to true. - // "POLICY_BINDINGS" - Use Binary Authorization with the policies - // specified in policy_bindings. + // "POLICY_BINDINGS" - Use Binary Authorization Continuous Validation + // with the policies specified in policy_bindings. // "POLICY_BINDINGS_AND_PROJECT_SINGLETON_POLICY_ENFORCE" - Use Binary - // Authorization with the policies specified in policy_bindings, and - // also with the project's singleton policy in enforcement mode. + // Authorization Continuous Validation with the policies specified in + // policy_bindings and enforce Kubernetes admission requests with Binary + // Authorization using the project's singleton policy. EvaluationMode string `json:"evaluationMode,omitempty"` // PolicyBindings: Optional. Binauthz policies that apply to this @@ -1120,6 +1130,10 @@ func (s *BlueGreenInfo) MarshalJSON() ([]byte, error) { // BlueGreenSettings: Settings for blue-green upgrade. type BlueGreenSettings struct { + // AutoscaledRolloutPolicy: Autoscaled policy for cluster autoscaler + // enabled blue-green upgrade. + AutoscaledRolloutPolicy *AutoscaledRolloutPolicy `json:"autoscaledRolloutPolicy,omitempty"` + // NodePoolSoakDuration: Time needed after draining entire blue pool. // After this period, blue pool will be cleaned up. NodePoolSoakDuration string `json:"nodePoolSoakDuration,omitempty"` @@ -1128,18 +1142,18 @@ type BlueGreenSettings struct { StandardRolloutPolicy *StandardRolloutPolicy `json:"standardRolloutPolicy,omitempty"` // ForceSendFields is a list of field names (e.g. - // "NodePoolSoakDuration") to unconditionally include in API requests. - // By default, fields with empty or default values are omitted from API - // requests. However, any non-pointer, non-interface field appearing in - // ForceSendFields will be sent to the server regardless of whether the - // field is empty or not. This may be used to include empty fields in - // Patch requests. + // "AutoscaledRolloutPolicy") to unconditionally include in API + // requests. By default, fields with empty or default values are omitted + // from API requests. However, any non-pointer, non-interface field + // appearing in ForceSendFields will be sent to the server regardless of + // whether the field is empty or not. This may be used to include empty + // fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "NodePoolSoakDuration") to - // include in API requests with the JSON null value. By default, fields - // with empty values are omitted from API requests. However, any field - // with an empty value appearing in NullFields will be sent to the + // NullFields is a list of field names (e.g. "AutoscaledRolloutPolicy") + // to include in API requests with the JSON null value. By default, + // fields with empty values are omitted from API requests. However, any + // field with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. diff --git a/discoveryengine/v1alpha/discoveryengine-api.json b/discoveryengine/v1alpha/discoveryengine-api.json index 6b01cd7f39..4fbed0e6bb 100644 --- a/discoveryengine/v1alpha/discoveryengine-api.json +++ b/discoveryengine/v1alpha/discoveryengine-api.json @@ -224,6 +224,36 @@ "projects": { "resources": { "locations": { + "methods": { + "estimateDataSize": { + "description": "Estimates the data size to be used by a customer.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}:estimateDataSize", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.estimateDataSize", + "parameterOrder": [ + "location" + ], + "parameters": { + "location": { + "description": "Required. Full resource name of the Location, such as `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+location}:estimateDataSize", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, "resources": { "collections": { "resources": { @@ -535,6 +565,34 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "trainCustomModel": { + "description": "Trains a custom model.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}:trainCustomModel", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.collections.dataStores.trainCustomModel", + "parameterOrder": [ + "dataStore" + ], + "parameters": { + "dataStore": { + "description": "Required. The resource name of the Data Store, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to train the models.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+dataStore}:trainCustomModel", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { @@ -4300,7 +4358,7 @@ } } }, - "revision": "20231130", + "revision": "20231209", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -4947,6 +5005,10 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaConversation", "description": "The conversation to be used by auto session only. The name field will be ignored as we automatically assign new name for the conversation in auto session." }, + "filter": { + "description": "The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the summary response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --\u003e name:'ANY(\"king kong\")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)", + "type": "string" + }, "name": { "description": "Required. The resource name of the Conversation to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session.", "type": "string" @@ -5717,6 +5779,98 @@ "properties": {}, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata": { + "description": "Metadata related to the progress of the EstimateDataSize operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequest": { + "description": "Request message for EstimateBillingService.EstimateDataSize method", + "id": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequest", + "properties": { + "fileDataSource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestFileDataSource", + "description": "Structured or unstructured data." + }, + "websiteDataSource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSource", + "description": "Website data." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestFileDataSource": { + "description": "Data source contains files either in GCS or BigQuery.", + "id": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestFileDataSource", + "properties": { + "bigquerySource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaBigQuerySource", + "description": "BigQuery input source." + }, + "gcsSource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaGcsSource", + "description": "Cloud Storage location for the input content." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSource": { + "description": "Data source is a set of website patterns that we crawl to get the total number of websites.", + "id": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSource", + "properties": { + "estimatorUriPatterns": { + "description": "Required. The URI patterns to estimate the data sizes. At most 10 patterns are allowed, otherwise an INVALID_ARGUMENT error is thrown.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSourceEstimatorUriPattern" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSourceEstimatorUriPattern": { + "description": "URI patterns that we use to crawl.", + "id": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSourceEstimatorUriPattern", + "properties": { + "exactMatch": { + "description": "Whether we infer the generated URI or use the exact provided one.", + "type": "boolean" + }, + "exclusive": { + "description": "Whether the pattern is exclusive or not. If set to true, the pattern is considered exclusive. If unset or set to false, the pattern is considered inclusive by default.", + "type": "boolean" + }, + "providedUriPattern": { + "description": "User provided URI pattern. For example, `foo.com/bar/*`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse": { + "description": "Response of the EstimateDataSize request. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", + "id": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse", + "properties": { + "dataSizeBytes": { + "description": "Data size in terms of bytes.", + "format": "int64", + "type": "string" + }, + "documentCount": { + "description": "Total number of documents.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse": { "description": "Response message for SiteSearchEngineService.FetchDomainVerificationStatus method.", "id": "GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse", @@ -6978,6 +7132,10 @@ "description": "Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.", "type": "string" }, + "modelPromptSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec", + "description": "If specified, the spec will be used to modify the prompt provided to the LLM." + }, "modelSpec": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec", "description": "If specified, the spec will be used to modify the model specification provided to the LLM." @@ -6990,12 +7148,23 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec": { + "description": "Specification of the prompt to use with the model.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec", + "properties": { + "preamble": { + "description": "Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec": { "description": "Specification of the model.", "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec", "properties": { "version": { - "description": "The string format of the model version. e.g. stable, latest, etc.", + "description": "The string format of the model version. e.g. stable, preview, etc.", "type": "string" } }, @@ -7397,6 +7566,78 @@ "summaryText": { "description": "The summary content.", "type": "string" + }, + "summaryWithMetadata": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummaryWithMetadata" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitation": { + "description": "Citation info for a segment.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitation", + "properties": { + "endIndex": { + "description": "End of the attributed segment, exclusive.", + "format": "int64", + "type": "string" + }, + "sources": { + "description": "Citation sources for the attributed segment.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationSource" + }, + "type": "array" + }, + "startIndex": { + "description": "Index indicates the start of the segment, measured in bytes/unicode.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationMetadata": { + "description": "Citation metadata.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationMetadata", + "properties": { + "citations": { + "description": "Citations for segments.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitation" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationSource": { + "description": "Citation source.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationSource", + "properties": { + "referenceIndex": { + "description": "Document reference index from SummaryWithMetadata.references. It is 0-indexed and the value will be zero if the reference_index is not set explicitly.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReference": { + "description": "Document reference.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReference", + "properties": { + "document": { + "description": "Required. Document.name of the document. Full resource name of the referenced document, in the format `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.", + "type": "string" + }, + "title": { + "description": "Title of the document.", + "type": "string" + }, + "uri": { + "description": "GCS or HTTP uri for the document.", + "type": "string" } }, "type": "object" @@ -7423,6 +7664,28 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummaryWithMetadata": { + "description": "Summary with metadata information.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummaryWithMetadata", + "properties": { + "citationMetadata": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationMetadata", + "description": "Citation metadata for given summary." + }, + "references": { + "description": "Document References.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReference" + }, + "type": "array" + }, + "summary": { + "description": "Summary text with no citation information.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaSiteSearchEngine": { "description": "SiteSearchEngine captures DataStore level site search persisting configurations. It is a singleton value per data store.", "id": "GoogleCloudDiscoveryengineV1alphaSiteSearchEngine", @@ -7567,6 +7830,87 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata": { + "description": "Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequest": { + "description": "Request message for SearchTuningService.TrainCustomModel method.", + "id": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequest", + "properties": { + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", + "description": "The desired location of errors incurred during the data ingestion and training." + }, + "gcsTrainingInput": { + "$ref": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequestGcsTrainingInput", + "description": "Gcs training input." + }, + "modelType": { + "description": "Model to be trained. Supported values are: * **search-tuning**: Fine tuning the search system based on data provided.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequestGcsTrainingInput": { + "description": "Gcs training data input.", + "id": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequestGcsTrainingInput", + "properties": { + "corpusDataPath": { + "description": "The gcs corpus data which could be associated in train data. The data path format is gs:///. A newline delimited jsonl/ndjson file. * For search-tuning model, each line should have the _id, title and text. Example: {\"_id\": \"doc1\", title: \"relevant doc\", \"text\": \"relevant text\"}", + "type": "string" + }, + "queryDataPath": { + "description": "The gcs query data which could be associated in train data. The data path format is gs:///. A newline delimited jsonl/ndjson file. * For search-tuning model, each line should have the _id and text. Example: {\"_id\": \"query1\", \"text\": \"example query\"}", + "type": "string" + }, + "testDataPath": { + "description": "Gcs test data. Same format as train_data_path. If not provided, a random 80/20 train/test split will be performed on train_data_path.", + "type": "string" + }, + "trainDataPath": { + "description": "Gcs training data path whose format should be gs:///. The file should be in tsv format. Each line should have the doc_id and query_id and score (number). * For search-tuning model, it should have the query-id corpus-id score as tsv file header. The score should be a number in [0, inf+). The larger the number is, the more relevant the pair is. Example: query-id\\tcorpus-id\\tscore query1\\tdoc1\\t1", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse": { + "description": "Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field.", + "id": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse", + "properties": { + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", + "description": "Echoes the destination for the complete errors in the request if set." + }, + "errorSamples": { + "description": "A sample of errors encountered while processing the data.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "modelStatus": { + "description": "The trained model status. Possible values are: * **bad-data**: The training data quality is bad. * **no-improvement**: Tuning didn't improve performance. Won't deploy. * **in-progress**: Model training is in progress. * **ready**: The model is ready for serving.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaTransactionInfo": { "description": "A transaction represents the entire purchase transaction.", "id": "GoogleCloudDiscoveryengineV1alphaTransactionInfo", @@ -7850,13 +8194,15 @@ "DATA_STORE_TYPE_UNSPECIFIED", "SITE_SEARCH", "STRUCTURED", - "UNSTRUCTURED" + "UNSTRUCTURED", + "BLENDED" ], "enumDescriptions": [ "Unspecified data store type.", "The parent data store contains a site search engine.", "The parent data store contains a search engine for structured data.", - "The parent data store contains a search engine for unstructured data." + "The parent data store contains a search engine for unstructured data.", + "The parent data store is served for blended search with multiple data stores." ], "readOnly": true, "type": "string" diff --git a/discoveryengine/v1alpha/discoveryengine-gen.go b/discoveryengine/v1alpha/discoveryengine-gen.go index f8a6950d61..0f458e5e48 100644 --- a/discoveryengine/v1alpha/discoveryengine-gen.go +++ b/discoveryengine/v1alpha/discoveryengine-gen.go @@ -1868,6 +1868,21 @@ type GoogleCloudDiscoveryengineV1alphaConverseConversationRequest struct { // the conversation in auto session. Conversation *GoogleCloudDiscoveryengineV1alphaConversation `json:"conversation,omitempty"` + // Filter: The filter syntax consists of an expression language for + // constructing a predicate from one or more fields of the documents + // being filtered. Filter expression is case-sensitive. This will be + // used to filter search results which may affect the summary response. + // If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. + // Filtering in Vertex AI Search is done by mapping the LHS filter key + // to a key property defined in the Vertex AI Search backend -- this + // mapping is defined by the customer in their schema. For example a + // media customer might have a field 'name' in their schema. In this + // case the filter would look like this: filter --> name:'ANY("king + // kong")' For more information about filtering including syntax and + // filter operators, see Filter + // (https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + Filter string `json:"filter,omitempty"` + // Name: Required. The resource name of the Conversation to get. Format: // `projects/{project_number}/locations/{location_id}/collections/{collec // tion}/dataStores/{data_store_id}/conversations/{conversation_id}`. @@ -3233,6 +3248,210 @@ func (s *GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig) MarshalJSON( type GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig struct { } +// GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata: Metadata +// related to the progress of the EstimateDataSize operation. This is +// returned by the google.longrunning.Operation.metadata field. +type GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata struct { + // CreateTime: Operation create time. + CreateTime string `json:"createTime,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CreateTime") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "CreateTime") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequest: Request +// message for EstimateBillingService.EstimateDataSize method +type GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequest struct { + // FileDataSource: Structured or unstructured data. + FileDataSource *GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestFileDataSource `json:"fileDataSource,omitempty"` + + // WebsiteDataSource: Website data. + WebsiteDataSource *GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSource `json:"websiteDataSource,omitempty"` + + // ForceSendFields is a list of field names (e.g. "FileDataSource") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "FileDataSource") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequest) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequest + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestFileDataSource +// : Data source contains files either in GCS or BigQuery. +type GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestFileDataSource struct { + // BigquerySource: BigQuery input source. + BigquerySource *GoogleCloudDiscoveryengineV1alphaBigQuerySource `json:"bigquerySource,omitempty"` + + // GcsSource: Cloud Storage location for the input content. + GcsSource *GoogleCloudDiscoveryengineV1alphaGcsSource `json:"gcsSource,omitempty"` + + // ForceSendFields is a list of field names (e.g. "BigquerySource") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "BigquerySource") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestFileDataSource) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestFileDataSource + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSou +// rce: Data source is a set of website patterns that we crawl to get +// the total number of websites. +type GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSource struct { + // EstimatorUriPatterns: Required. The URI patterns to estimate the data + // sizes. At most 10 patterns are allowed, otherwise an INVALID_ARGUMENT + // error is thrown. + EstimatorUriPatterns []*GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSourceEstimatorUriPattern `json:"estimatorUriPatterns,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "EstimatorUriPatterns") to unconditionally include in API requests. + // By default, fields with empty or default values are omitted from API + // requests. However, any non-pointer, non-interface field appearing in + // ForceSendFields will be sent to the server regardless of whether the + // field is empty or not. This may be used to include empty fields in + // Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "EstimatorUriPatterns") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSource) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSource + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSou +// rceEstimatorUriPattern: URI patterns that we use to crawl. +type GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSourceEstimatorUriPattern struct { + // ExactMatch: Whether we infer the generated URI or use the exact + // provided one. + ExactMatch bool `json:"exactMatch,omitempty"` + + // Exclusive: Whether the pattern is exclusive or not. If set to true, + // the pattern is considered exclusive. If unset or set to false, the + // pattern is considered inclusive by default. + Exclusive bool `json:"exclusive,omitempty"` + + // ProvidedUriPattern: User provided URI pattern. For example, + // `foo.com/bar/*`. + ProvidedUriPattern string `json:"providedUriPattern,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ExactMatch") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "ExactMatch") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSourceEstimatorUriPattern) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSourceEstimatorUriPattern + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse: Response +// of the EstimateDataSize request. If the long running operation was +// successful, then this message is returned by the +// google.longrunning.Operations.response field if the operation was +// successful. +type GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse struct { + // DataSizeBytes: Data size in terms of bytes. + DataSizeBytes int64 `json:"dataSizeBytes,omitempty,string"` + + // DocumentCount: Total number of documents. + DocumentCount int64 `json:"documentCount,omitempty,string"` + + // ForceSendFields is a list of field names (e.g. "DataSizeBytes") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "DataSizeBytes") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse // : Response message for // SiteSearchEngineService.FetchDomainVerificationStatus method. @@ -5651,6 +5870,10 @@ type GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec // an experimental feature. LanguageCode string `json:"languageCode,omitempty"` + // ModelPromptSpec: If specified, the spec will be used to modify the + // prompt provided to the LLM. + ModelPromptSpec *GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec `json:"modelPromptSpec,omitempty"` + // ModelSpec: If specified, the spec will be used to modify the model // specification provided to the LLM. ModelSpec *GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec `json:"modelSpec,omitempty"` @@ -5686,11 +5909,42 @@ func (s *GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummaryS return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummary +// SpecModelPromptSpec: Specification of the prompt to use with the +// model. +type GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec struct { + // Preamble: Text at the beginning of the prompt that instructs the + // assistant. Examples are available in the user guide. + Preamble string `json:"preamble,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Preamble") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Preamble") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummary // SpecModelSpec: Specification of the model. type GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec struct { - // Version: The string format of the model version. e.g. stable, latest, - // etc. + // Version: The string format of the model version. e.g. stable, + // preview, etc. Version string `json:"version,omitempty"` // ForceSendFields is a list of field names (e.g. "Version") to @@ -6420,6 +6674,8 @@ type GoogleCloudDiscoveryengineV1alphaSearchResponseSummary struct { // SummaryText: The summary content. SummaryText string `json:"summaryText,omitempty"` + SummaryWithMetadata *GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummaryWithMetadata `json:"summaryWithMetadata,omitempty"` + // ForceSendFields is a list of field names (e.g. "SafetyAttributes") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any @@ -6444,18 +6700,20 @@ func (s *GoogleCloudDiscoveryengineV1alphaSearchResponseSummary) MarshalJSON() ( return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes -// : Safety Attribute categories and their associated confidence scores. -type GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes struct { - // Categories: The display names of Safety Attribute categories - // associated with the generated content. Order matches the Scores. - Categories []string `json:"categories,omitempty"` +// GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitation: +// Citation info for a segment. +type GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitation struct { + // EndIndex: End of the attributed segment, exclusive. + EndIndex int64 `json:"endIndex,omitempty,string"` - // Scores: The confidence scores of the each category, higher value - // means higher confidence. Order matches the Categories. - Scores []float64 `json:"scores,omitempty"` + // Sources: Citation sources for the attributed segment. + Sources []*GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationSource `json:"sources,omitempty"` - // ForceSendFields is a list of field names (e.g. "Categories") to + // StartIndex: Index indicates the start of the segment, measured in + // bytes/unicode. + StartIndex int64 `json:"startIndex,omitempty,string"` + + // ForceSendFields is a list of field names (e.g. "EndIndex") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be @@ -6463,7 +6721,7 @@ type GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes stru // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "Categories") to include in + // NullFields is a list of field names (e.g. "EndIndex") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as @@ -6472,42 +6730,19 @@ type GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes stru NullFields []string `json:"-"` } -func (s *GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes) MarshalJSON() ([]byte, error) { - type NoMethod GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes +func (s *GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitation) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitation raw := NoMethod(*s) return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -func (s *GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes) UnmarshalJSON(data []byte) error { - type NoMethod GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes - var s1 struct { - Scores []gensupport.JSONFloat64 `json:"scores"` - *NoMethod - } - s1.NoMethod = (*NoMethod)(s) - if err := json.Unmarshal(data, &s1); err != nil { - return err - } - s.Scores = make([]float64, len(s1.Scores)) - for i := range s1.Scores { - s.Scores[i] = float64(s1.Scores[i]) - } - return nil -} - -// GoogleCloudDiscoveryengineV1alphaSiteSearchEngine: SiteSearchEngine -// captures DataStore level site search persisting configurations. It is -// a singleton value per data store. -type GoogleCloudDiscoveryengineV1alphaSiteSearchEngine struct { - // Name: The fully qualified resource name of the site search engine. - // Format: `projects/*/locations/*/dataStores/*/siteSearchEngine` - Name string `json:"name,omitempty"` - - // ServerResponse contains the HTTP response code and headers from the - // server. - googleapi.ServerResponse `json:"-"` +// GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationMetadata +// : Citation metadata. +type GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationMetadata struct { + // Citations: Citations for segments. + Citations []*GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitation `json:"citations,omitempty"` - // ForceSendFields is a list of field names (e.g. "Name") to + // ForceSendFields is a list of field names (e.g. "Citations") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be @@ -6515,8 +6750,8 @@ type GoogleCloudDiscoveryengineV1alphaSiteSearchEngine struct { // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "Name") to include in API - // requests with the JSON null value. By default, fields with empty + // NullFields is a list of field names (e.g. "Citations") to include in + // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. @@ -6524,40 +6759,29 @@ type GoogleCloudDiscoveryengineV1alphaSiteSearchEngine struct { NullFields []string `json:"-"` } -func (s *GoogleCloudDiscoveryengineV1alphaSiteSearchEngine) MarshalJSON() ([]byte, error) { - type NoMethod GoogleCloudDiscoveryengineV1alphaSiteSearchEngine +func (s *GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationMetadata) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationMetadata raw := NoMethod(*s) return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo: Verification -// information for target sites in advanced site search. -type GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo struct { - // SiteVerificationState: Site verification state indicating the - // ownership and validity. - // - // Possible values: - // "SITE_VERIFICATION_STATE_UNSPECIFIED" - Defaults to VERIFIED. - // "VERIFIED" - Site ownership verified. - // "UNVERIFIED" - Site ownership pending verification or verification - // failed. - // "EXEMPTED" - Site exempt from verification, e.g. a public website - // that opens to all. - SiteVerificationState string `json:"siteVerificationState,omitempty"` - - // VerifyTime: Latest site verification time. - VerifyTime string `json:"verifyTime,omitempty"` +// GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationSource: +// Citation source. +type GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationSource struct { + // ReferenceIndex: Document reference index from + // SummaryWithMetadata.references. It is 0-indexed and the value will be + // zero if the reference_index is not set explicitly. + ReferenceIndex int64 `json:"referenceIndex,omitempty,string"` - // ForceSendFields is a list of field names (e.g. - // "SiteVerificationState") to unconditionally include in API requests. - // By default, fields with empty or default values are omitted from API - // requests. However, any non-pointer, non-interface field appearing in - // ForceSendFields will be sent to the server regardless of whether the - // field is empty or not. This may be used to include empty fields in - // Patch requests. + // ForceSendFields is a list of field names (e.g. "ReferenceIndex") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "SiteVerificationState") to + // NullFields is a list of field names (e.g. "ReferenceIndex") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the @@ -6567,14 +6791,217 @@ type GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo struct { NullFields []string `json:"-"` } -func (s *GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo) MarshalJSON() ([]byte, error) { - type NoMethod GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo +func (s *GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationSource) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationSource raw := NoMethod(*s) return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudDiscoveryengineV1alphaTargetSite: A target site for the -// SiteSearchEngine. +// GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReference: +// Document reference. +type GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReference struct { + // Document: Required. Document.name of the document. Full resource name + // of the referenced document, in the format + // `projects/*/locations/*/collections/*/dataStores/*/branches/*/document + // s/*`. + Document string `json:"document,omitempty"` + + // Title: Title of the document. + Title string `json:"title,omitempty"` + + // Uri: GCS or HTTP uri for the document. + Uri string `json:"uri,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Document") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Document") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReference) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReference + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes +// : Safety Attribute categories and their associated confidence scores. +type GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes struct { + // Categories: The display names of Safety Attribute categories + // associated with the generated content. Order matches the Scores. + Categories []string `json:"categories,omitempty"` + + // Scores: The confidence scores of the each category, higher value + // means higher confidence. Order matches the Categories. + Scores []float64 `json:"scores,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Categories") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Categories") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes) UnmarshalJSON(data []byte) error { + type NoMethod GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes + var s1 struct { + Scores []gensupport.JSONFloat64 `json:"scores"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.Scores = make([]float64, len(s1.Scores)) + for i := range s1.Scores { + s.Scores[i] = float64(s1.Scores[i]) + } + return nil +} + +// GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummaryWithMetad +// ata: Summary with metadata information. +type GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummaryWithMetadata struct { + // CitationMetadata: Citation metadata for given summary. + CitationMetadata *GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationMetadata `json:"citationMetadata,omitempty"` + + // References: Document References. + References []*GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReference `json:"references,omitempty"` + + // Summary: Summary text with no citation information. + Summary string `json:"summary,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CitationMetadata") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "CitationMetadata") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummaryWithMetadata) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummaryWithMetadata + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDiscoveryengineV1alphaSiteSearchEngine: SiteSearchEngine +// captures DataStore level site search persisting configurations. It is +// a singleton value per data store. +type GoogleCloudDiscoveryengineV1alphaSiteSearchEngine struct { + // Name: The fully qualified resource name of the site search engine. + // Format: `projects/*/locations/*/dataStores/*/siteSearchEngine` + Name string `json:"name,omitempty"` + + // ServerResponse contains the HTTP response code and headers from the + // server. + googleapi.ServerResponse `json:"-"` + + // ForceSendFields is a list of field names (e.g. "Name") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Name") to include in API + // requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDiscoveryengineV1alphaSiteSearchEngine) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1alphaSiteSearchEngine + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo: Verification +// information for target sites in advanced site search. +type GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo struct { + // SiteVerificationState: Site verification state indicating the + // ownership and validity. + // + // Possible values: + // "SITE_VERIFICATION_STATE_UNSPECIFIED" - Defaults to VERIFIED. + // "VERIFIED" - Site ownership verified. + // "UNVERIFIED" - Site ownership pending verification or verification + // failed. + // "EXEMPTED" - Site exempt from verification, e.g. a public website + // that opens to all. + SiteVerificationState string `json:"siteVerificationState,omitempty"` + + // VerifyTime: Latest site verification time. + VerifyTime string `json:"verifyTime,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "SiteVerificationState") to unconditionally include in API requests. + // By default, fields with empty or default values are omitted from API + // requests. However, any non-pointer, non-interface field appearing in + // ForceSendFields will be sent to the server regardless of whether the + // field is empty or not. This may be used to include empty fields in + // Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "SiteVerificationState") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDiscoveryengineV1alphaTargetSite: A target site for the +// SiteSearchEngine. type GoogleCloudDiscoveryengineV1alphaTargetSite struct { // ExactMatch: Input only. If set to false, a uri_pattern is generated // to include all pages whose address contains the provided_uri_pattern. @@ -6698,10 +7125,178 @@ type GoogleCloudDiscoveryengineV1alphaTextInput struct { // Context: Conversation context of the input. Context *GoogleCloudDiscoveryengineV1alphaConversationContext `json:"context,omitempty"` - // Input: Text input. - Input string `json:"input,omitempty"` + // Input: Text input. + Input string `json:"input,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Context") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Context") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDiscoveryengineV1alphaTextInput) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1alphaTextInput + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata: Metadata +// related to the progress of the TrainCustomModel operation. This is +// returned by the google.longrunning.Operation.metadata field. +type GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata struct { + // CreateTime: Operation create time. + CreateTime string `json:"createTime,omitempty"` + + // UpdateTime: Operation last update time. If the operation is done, + // this is also the finish time. + UpdateTime string `json:"updateTime,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CreateTime") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "CreateTime") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequest: Request +// message for SearchTuningService.TrainCustomModel method. +type GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequest struct { + // ErrorConfig: The desired location of errors incurred during the data + // ingestion and training. + ErrorConfig *GoogleCloudDiscoveryengineV1alphaImportErrorConfig `json:"errorConfig,omitempty"` + + // GcsTrainingInput: Gcs training input. + GcsTrainingInput *GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequestGcsTrainingInput `json:"gcsTrainingInput,omitempty"` + + // ModelType: Model to be trained. Supported values are: * + // **search-tuning**: Fine tuning the search system based on data + // provided. + ModelType string `json:"modelType,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ErrorConfig") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "ErrorConfig") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequest) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequest + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequestGcsTrainingInp +// ut: Gcs training data input. +type GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequestGcsTrainingInput struct { + // CorpusDataPath: The gcs corpus data which could be associated in + // train data. The data path format is gs:///. A newline delimited + // jsonl/ndjson file. * For search-tuning model, each line should have + // the _id, title and text. Example: {"_id": "doc1", title: "relevant + // doc", "text": "relevant text"} + CorpusDataPath string `json:"corpusDataPath,omitempty"` + + // QueryDataPath: The gcs query data which could be associated in train + // data. The data path format is gs:///. A newline delimited + // jsonl/ndjson file. * For search-tuning model, each line should have + // the _id and text. Example: {"_id": "query1", "text": "example query"} + QueryDataPath string `json:"queryDataPath,omitempty"` + + // TestDataPath: Gcs test data. Same format as train_data_path. If not + // provided, a random 80/20 train/test split will be performed on + // train_data_path. + TestDataPath string `json:"testDataPath,omitempty"` + + // TrainDataPath: Gcs training data path whose format should be gs:///. + // The file should be in tsv format. Each line should have the doc_id + // and query_id and score (number). * For search-tuning model, it should + // have the query-id corpus-id score as tsv file header. The score + // should be a number in [0, inf+). The larger the number is, the more + // relevant the pair is. Example: query-id\tcorpus-id\tscore + // query1\tdoc1\t1 + TrainDataPath string `json:"trainDataPath,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CorpusDataPath") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "CorpusDataPath") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequestGcsTrainingInput) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequestGcsTrainingInput + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse: Response +// of the TrainCustomModelRequest. This message is returned by the +// google.longrunning.Operations.response field. +type GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse struct { + // ErrorConfig: Echoes the destination for the complete errors in the + // request if set. + ErrorConfig *GoogleCloudDiscoveryengineV1alphaImportErrorConfig `json:"errorConfig,omitempty"` + + // ErrorSamples: A sample of errors encountered while processing the + // data. + ErrorSamples []*GoogleRpcStatus `json:"errorSamples,omitempty"` - // ForceSendFields is a list of field names (e.g. "Context") to + // ModelStatus: The trained model status. Possible values are: * + // **bad-data**: The training data quality is bad. * **no-improvement**: + // Tuning didn't improve performance. Won't deploy. * **in-progress**: + // Model training is in progress. * **ready**: The model is ready for + // serving. + ModelStatus string `json:"modelStatus,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ErrorConfig") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be @@ -6709,17 +7304,17 @@ type GoogleCloudDiscoveryengineV1alphaTextInput struct { // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "Context") to include in - // API requests with the JSON null value. By default, fields with empty - // values are omitted from API requests. However, any field with an - // empty value appearing in NullFields will be sent to the server as + // NullFields is a list of field names (e.g. "ErrorConfig") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` } -func (s *GoogleCloudDiscoveryengineV1alphaTextInput) MarshalJSON() ([]byte, error) { - type NoMethod GoogleCloudDiscoveryengineV1alphaTextInput +func (s *GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse raw := NoMethod(*s) return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } @@ -7270,6 +7865,8 @@ type GoogleCloudDiscoveryengineV1alphaWidgetConfig struct { // structured data. // "UNSTRUCTURED" - The parent data store contains a search engine for // unstructured data. + // "BLENDED" - The parent data store is served for blended search with + // multiple data stores. DataStoreType string `json:"dataStoreType,omitempty"` // DisplayName: Required. The human readable widget config display name. @@ -8822,6 +9419,149 @@ func (c *LocationsWidgetSearchCall) Do(opts ...googleapi.CallOption) (*GoogleClo } +// method id "discoveryengine.projects.locations.estimateDataSize": + +type ProjectsLocationsEstimateDataSizeCall struct { + s *Service + location string + googleclouddiscoveryenginev1alphaestimatedatasizerequest *GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequest + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header +} + +// EstimateDataSize: Estimates the data size to be used by a customer. +// +// - location: Full resource name of the Location, such as +// `projects/{project}/locations/{location}`. +func (r *ProjectsLocationsService) EstimateDataSize(location string, googleclouddiscoveryenginev1alphaestimatedatasizerequest *GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequest) *ProjectsLocationsEstimateDataSizeCall { + c := &ProjectsLocationsEstimateDataSizeCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.location = location + c.googleclouddiscoveryenginev1alphaestimatedatasizerequest = googleclouddiscoveryenginev1alphaestimatedatasizerequest + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *ProjectsLocationsEstimateDataSizeCall) Fields(s ...googleapi.Field) *ProjectsLocationsEstimateDataSizeCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *ProjectsLocationsEstimateDataSizeCall) Context(ctx context.Context) *ProjectsLocationsEstimateDataSizeCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *ProjectsLocationsEstimateDataSizeCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsEstimateDataSizeCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + var body io.Reader = nil + body, err := googleapi.WithoutDataWrapper.JSONReader(c.googleclouddiscoveryenginev1alphaestimatedatasizerequest) + if err != nil { + return nil, err + } + reqHeaders.Set("Content-Type", "application/json") + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1alpha/{+location}:estimateDataSize") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("POST", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "location": c.location, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "discoveryengine.projects.locations.estimateDataSize" call. +// Exactly one of *GoogleLongrunningOperation or error will be non-nil. +// Any non-2xx status code is an error. Response headers are in either +// *GoogleLongrunningOperation.ServerResponse.Header or (if a response +// was returned at all) in error.(*googleapi.Error).Header. Use +// googleapi.IsNotModified to check whether the returned error was +// because http.StatusNotModified was returned. +func (c *ProjectsLocationsEstimateDataSizeCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &GoogleLongrunningOperation{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Estimates the data size to be used by a customer.", + // "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}:estimateDataSize", + // "httpMethod": "POST", + // "id": "discoveryengine.projects.locations.estimateDataSize", + // "parameterOrder": [ + // "location" + // ], + // "parameters": { + // "location": { + // "description": "Required. Full resource name of the Location, such as `projects/{project}/locations/{location}`.", + // "location": "path", + // "pattern": "^projects/[^/]+/locations/[^/]+$", + // "required": true, + // "type": "string" + // } + // }, + // "path": "v1alpha/{+location}:estimateDataSize", + // "request": { + // "$ref": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequest" + // }, + // "response": { + // "$ref": "GoogleLongrunningOperation" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] + // } + +} + // method id "discoveryengine.projects.locations.collections.dataConnector.operations.get": type ProjectsLocationsCollectionsDataConnectorOperationsGetCall struct { @@ -10393,6 +11133,151 @@ func (c *ProjectsLocationsCollectionsDataStoresPatchCall) Do(opts ...googleapi.C } +// method id "discoveryengine.projects.locations.collections.dataStores.trainCustomModel": + +type ProjectsLocationsCollectionsDataStoresTrainCustomModelCall struct { + s *Service + dataStore string + googleclouddiscoveryenginev1alphatraincustommodelrequest *GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequest + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header +} + +// TrainCustomModel: Trains a custom model. +// +// - dataStore: The resource name of the Data Store, such as +// `projects/*/locations/global/collections/default_collection/dataStor +// es/default_data_store`. This field is used to identify the data +// store where to train the models. +func (r *ProjectsLocationsCollectionsDataStoresService) TrainCustomModel(dataStore string, googleclouddiscoveryenginev1alphatraincustommodelrequest *GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequest) *ProjectsLocationsCollectionsDataStoresTrainCustomModelCall { + c := &ProjectsLocationsCollectionsDataStoresTrainCustomModelCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.dataStore = dataStore + c.googleclouddiscoveryenginev1alphatraincustommodelrequest = googleclouddiscoveryenginev1alphatraincustommodelrequest + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *ProjectsLocationsCollectionsDataStoresTrainCustomModelCall) Fields(s ...googleapi.Field) *ProjectsLocationsCollectionsDataStoresTrainCustomModelCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *ProjectsLocationsCollectionsDataStoresTrainCustomModelCall) Context(ctx context.Context) *ProjectsLocationsCollectionsDataStoresTrainCustomModelCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *ProjectsLocationsCollectionsDataStoresTrainCustomModelCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsCollectionsDataStoresTrainCustomModelCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + var body io.Reader = nil + body, err := googleapi.WithoutDataWrapper.JSONReader(c.googleclouddiscoveryenginev1alphatraincustommodelrequest) + if err != nil { + return nil, err + } + reqHeaders.Set("Content-Type", "application/json") + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1alpha/{+dataStore}:trainCustomModel") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("POST", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "dataStore": c.dataStore, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "discoveryengine.projects.locations.collections.dataStores.trainCustomModel" call. +// Exactly one of *GoogleLongrunningOperation or error will be non-nil. +// Any non-2xx status code is an error. Response headers are in either +// *GoogleLongrunningOperation.ServerResponse.Header or (if a response +// was returned at all) in error.(*googleapi.Error).Header. Use +// googleapi.IsNotModified to check whether the returned error was +// because http.StatusNotModified was returned. +func (c *ProjectsLocationsCollectionsDataStoresTrainCustomModelCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &GoogleLongrunningOperation{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Trains a custom model.", + // "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}:trainCustomModel", + // "httpMethod": "POST", + // "id": "discoveryengine.projects.locations.collections.dataStores.trainCustomModel", + // "parameterOrder": [ + // "dataStore" + // ], + // "parameters": { + // "dataStore": { + // "description": "Required. The resource name of the Data Store, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to train the models.", + // "location": "path", + // "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", + // "required": true, + // "type": "string" + // } + // }, + // "path": "v1alpha/{+dataStore}:trainCustomModel", + // "request": { + // "$ref": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequest" + // }, + // "response": { + // "$ref": "GoogleLongrunningOperation" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] + // } + +} + // method id "discoveryengine.projects.locations.collections.dataStores.branches.documents.create": type ProjectsLocationsCollectionsDataStoresBranchesDocumentsCreateCall struct { diff --git a/discoveryengine/v1beta/discoveryengine-api.json b/discoveryengine/v1beta/discoveryengine-api.json index aca85162cc..b7633d4c36 100644 --- a/discoveryengine/v1beta/discoveryengine-api.json +++ b/discoveryengine/v1beta/discoveryengine-api.json @@ -2922,7 +2922,7 @@ } } }, - "revision": "20231130", + "revision": "20231209", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -3881,6 +3881,35 @@ "properties": {}, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata": { + "description": "Metadata related to the progress of the EstimateDataSize operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse": { + "description": "Response of the EstimateDataSize request. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", + "id": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse", + "properties": { + "dataSizeBytes": { + "description": "Data size in terms of bytes.", + "format": "int64", + "type": "string" + }, + "documentCount": { + "description": "Total number of documents.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaFieldConfig": { "description": "Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.", "id": "GoogleCloudDiscoveryengineV1alphaFieldConfig", @@ -4457,6 +4486,45 @@ "properties": {}, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata": { + "description": "Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse": { + "description": "Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field.", + "id": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse", + "properties": { + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", + "description": "Echoes the destination for the complete errors in the request if set." + }, + "errorSamples": { + "description": "A sample of errors encountered while processing the data.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "modelStatus": { + "description": "The trained model status. Possible values are: * **bad-data**: The training data quality is bad. * **no-improvement**: Tuning didn't improve performance. Won't deploy. * **in-progress**: Model training is in progress. * **ready**: The model is ready for serving.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata": { "description": "Metadata associated with a tune operation.", "id": "GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata", @@ -4686,6 +4754,10 @@ "$ref": "GoogleCloudDiscoveryengineV1betaConversation", "description": "The conversation to be used by auto session only. The name field will be ignored as we automatically assign new name for the conversation in auto session." }, + "filter": { + "description": "The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the summary response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --\u003e name:'ANY(\"king kong\")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)", + "type": "string" + }, "query": { "$ref": "GoogleCloudDiscoveryengineV1betaTextInput", "description": "Required. Current user input." @@ -5745,6 +5817,10 @@ "description": "Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.", "type": "string" }, + "modelPromptSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec", + "description": "If specified, the spec will be used to modify the prompt provided to the LLM." + }, "modelSpec": { "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec", "description": "If specified, the spec will be used to modify the model specification provided to the LLM." @@ -5757,12 +5833,23 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec": { + "description": "Specification of the prompt to use with the model.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec", + "properties": { + "preamble": { + "description": "Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec": { "description": "Specification of the model.", "id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec", "properties": { "version": { - "description": "The string format of the model version. e.g. stable, latest, etc.", + "description": "The string format of the model version. e.g. stable, preview, etc.", "type": "string" } }, @@ -6164,6 +6251,78 @@ "summaryText": { "description": "The summary content.", "type": "string" + }, + "summaryWithMetadata": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseSummarySummaryWithMetadata" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitation": { + "description": "Citation info for a segment.", + "id": "GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitation", + "properties": { + "endIndex": { + "description": "End of the attributed segment, exclusive.", + "format": "int64", + "type": "string" + }, + "sources": { + "description": "Citation sources for the attributed segment.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationSource" + }, + "type": "array" + }, + "startIndex": { + "description": "Index indicates the start of the segment, measured in bytes/unicode.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationMetadata": { + "description": "Citation metadata.", + "id": "GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationMetadata", + "properties": { + "citations": { + "description": "Citations for segments.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitation" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationSource": { + "description": "Citation source.", + "id": "GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationSource", + "properties": { + "referenceIndex": { + "description": "Document reference index from SummaryWithMetadata.references. It is 0-indexed and the value will be zero if the reference_index is not set explicitly.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaSearchResponseSummaryReference": { + "description": "Document reference.", + "id": "GoogleCloudDiscoveryengineV1betaSearchResponseSummaryReference", + "properties": { + "document": { + "description": "Required. Document.name of the document. Full resource name of the referenced document, in the format `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.", + "type": "string" + }, + "title": { + "description": "Title of the document.", + "type": "string" + }, + "uri": { + "description": "GCS or HTTP uri for the document.", + "type": "string" } }, "type": "object" @@ -6190,6 +6349,28 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaSearchResponseSummarySummaryWithMetadata": { + "description": "Summary with metadata information.", + "id": "GoogleCloudDiscoveryengineV1betaSearchResponseSummarySummaryWithMetadata", + "properties": { + "citationMetadata": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationMetadata", + "description": "Citation metadata for given summary." + }, + "references": { + "description": "Document References.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseSummaryReference" + }, + "type": "array" + }, + "summary": { + "description": "Summary text with no citation information.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaTextInput": { "description": "Defines text input.", "id": "GoogleCloudDiscoveryengineV1betaTextInput", diff --git a/discoveryengine/v1beta/discoveryengine-gen.go b/discoveryengine/v1beta/discoveryengine-gen.go index 3937b75540..11700ca0a5 100644 --- a/discoveryengine/v1beta/discoveryengine-gen.go +++ b/discoveryengine/v1beta/discoveryengine-gen.go @@ -2324,6 +2324,71 @@ func (s *GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig) MarshalJSON( type GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig struct { } +// GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata: Metadata +// related to the progress of the EstimateDataSize operation. This is +// returned by the google.longrunning.Operation.metadata field. +type GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata struct { + // CreateTime: Operation create time. + CreateTime string `json:"createTime,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CreateTime") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "CreateTime") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse: Response +// of the EstimateDataSize request. If the long running operation was +// successful, then this message is returned by the +// google.longrunning.Operations.response field if the operation was +// successful. +type GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse struct { + // DataSizeBytes: Data size in terms of bytes. + DataSizeBytes int64 `json:"dataSizeBytes,omitempty,string"` + + // DocumentCount: Total number of documents. + DocumentCount int64 `json:"documentCount,omitempty,string"` + + // ForceSendFields is a list of field names (e.g. "DataSizeBytes") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "DataSizeBytes") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleCloudDiscoveryengineV1alphaFieldConfig: Configurations for // fields of a schema. For example, configuring a field is indexable, or // searchable. @@ -3199,6 +3264,82 @@ func (s *GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason) MarshalJSON() type GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure struct { } +// GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata: Metadata +// related to the progress of the TrainCustomModel operation. This is +// returned by the google.longrunning.Operation.metadata field. +type GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata struct { + // CreateTime: Operation create time. + CreateTime string `json:"createTime,omitempty"` + + // UpdateTime: Operation last update time. If the operation is done, + // this is also the finish time. + UpdateTime string `json:"updateTime,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CreateTime") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "CreateTime") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse: Response +// of the TrainCustomModelRequest. This message is returned by the +// google.longrunning.Operations.response field. +type GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse struct { + // ErrorConfig: Echoes the destination for the complete errors in the + // request if set. + ErrorConfig *GoogleCloudDiscoveryengineV1alphaImportErrorConfig `json:"errorConfig,omitempty"` + + // ErrorSamples: A sample of errors encountered while processing the + // data. + ErrorSamples []*GoogleRpcStatus `json:"errorSamples,omitempty"` + + // ModelStatus: The trained model status. Possible values are: * + // **bad-data**: The training data quality is bad. * **no-improvement**: + // Tuning didn't improve performance. Won't deploy. * **in-progress**: + // Model training is in progress. * **ready**: The model is ready for + // serving. + ModelStatus string `json:"modelStatus,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ErrorConfig") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "ErrorConfig") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata: Metadata // associated with a tune operation. type GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata struct { @@ -3613,6 +3754,21 @@ type GoogleCloudDiscoveryengineV1betaConverseConversationRequest struct { // the conversation in auto session. Conversation *GoogleCloudDiscoveryengineV1betaConversation `json:"conversation,omitempty"` + // Filter: The filter syntax consists of an expression language for + // constructing a predicate from one or more fields of the documents + // being filtered. Filter expression is case-sensitive. This will be + // used to filter search results which may affect the summary response. + // If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. + // Filtering in Vertex AI Search is done by mapping the LHS filter key + // to a key property defined in the Vertex AI Search backend -- this + // mapping is defined by the customer in their schema. For example a + // media customer might have a field 'name' in their schema. In this + // case the filter would look like this: filter --> name:'ANY("king + // kong")' For more information about filtering including syntax and + // filter operators, see Filter + // (https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + Filter string `json:"filter,omitempty"` + // Query: Required. Current user input. Query *GoogleCloudDiscoveryengineV1betaTextInput `json:"query,omitempty"` @@ -5739,6 +5895,10 @@ type GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec s // an experimental feature. LanguageCode string `json:"languageCode,omitempty"` + // ModelPromptSpec: If specified, the spec will be used to modify the + // prompt provided to the LLM. + ModelPromptSpec *GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec `json:"modelPromptSpec,omitempty"` + // ModelSpec: If specified, the spec will be used to modify the model // specification provided to the LLM. ModelSpec *GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec `json:"modelSpec,omitempty"` @@ -5774,11 +5934,42 @@ func (s *GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySp return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummaryS +// pecModelPromptSpec: Specification of the prompt to use with the +// model. +type GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec struct { + // Preamble: Text at the beginning of the prompt that instructs the + // assistant. Examples are available in the user guide. + Preamble string `json:"preamble,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Preamble") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Preamble") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummaryS // pecModelSpec: Specification of the model. type GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec struct { - // Version: The string format of the model version. e.g. stable, latest, - // etc. + // Version: The string format of the model version. e.g. stable, + // preview, etc. Version string `json:"version,omitempty"` // ForceSendFields is a list of field names (e.g. "Version") to @@ -6508,6 +6699,8 @@ type GoogleCloudDiscoveryengineV1betaSearchResponseSummary struct { // SummaryText: The summary content. SummaryText string `json:"summaryText,omitempty"` + SummaryWithMetadata *GoogleCloudDiscoveryengineV1betaSearchResponseSummarySummaryWithMetadata `json:"summaryWithMetadata,omitempty"` + // ForceSendFields is a list of field names (e.g. "SafetyAttributes") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any @@ -6532,6 +6725,142 @@ func (s *GoogleCloudDiscoveryengineV1betaSearchResponseSummary) MarshalJSON() ([ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitation: +// Citation info for a segment. +type GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitation struct { + // EndIndex: End of the attributed segment, exclusive. + EndIndex int64 `json:"endIndex,omitempty,string"` + + // Sources: Citation sources for the attributed segment. + Sources []*GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationSource `json:"sources,omitempty"` + + // StartIndex: Index indicates the start of the segment, measured in + // bytes/unicode. + StartIndex int64 `json:"startIndex,omitempty,string"` + + // ForceSendFields is a list of field names (e.g. "EndIndex") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "EndIndex") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitation) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitation + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationMetadata: +// +// Citation metadata. +type GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationMetadata struct { + // Citations: Citations for segments. + Citations []*GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitation `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 default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Citations") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationMetadata) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationMetadata + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationSource: +// Citation source. +type GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationSource struct { + // ReferenceIndex: Document reference index from + // SummaryWithMetadata.references. It is 0-indexed and the value will be + // zero if the reference_index is not set explicitly. + ReferenceIndex int64 `json:"referenceIndex,omitempty,string"` + + // ForceSendFields is a list of field names (e.g. "ReferenceIndex") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "ReferenceIndex") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationSource) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationSource + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDiscoveryengineV1betaSearchResponseSummaryReference: +// Document reference. +type GoogleCloudDiscoveryengineV1betaSearchResponseSummaryReference struct { + // Document: Required. Document.name of the document. Full resource name + // of the referenced document, in the format + // `projects/*/locations/*/collections/*/dataStores/*/branches/*/document + // s/*`. + Document string `json:"document,omitempty"` + + // Title: Title of the document. + Title string `json:"title,omitempty"` + + // Uri: GCS or HTTP uri for the document. + Uri string `json:"uri,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Document") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Document") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDiscoveryengineV1betaSearchResponseSummaryReference) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1betaSearchResponseSummaryReference + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleCloudDiscoveryengineV1betaSearchResponseSummarySafetyAttributes: // // Safety Attribute categories and their associated confidence scores. @@ -6584,6 +6913,42 @@ func (s *GoogleCloudDiscoveryengineV1betaSearchResponseSummarySafetyAttributes) return nil } +// GoogleCloudDiscoveryengineV1betaSearchResponseSummarySummaryWithMetada +// ta: Summary with metadata information. +type GoogleCloudDiscoveryengineV1betaSearchResponseSummarySummaryWithMetadata struct { + // CitationMetadata: Citation metadata for given summary. + CitationMetadata *GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationMetadata `json:"citationMetadata,omitempty"` + + // References: Document References. + References []*GoogleCloudDiscoveryengineV1betaSearchResponseSummaryReference `json:"references,omitempty"` + + // Summary: Summary text with no citation information. + Summary string `json:"summary,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CitationMetadata") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "CitationMetadata") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDiscoveryengineV1betaSearchResponseSummarySummaryWithMetadata) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1betaSearchResponseSummarySummaryWithMetadata + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleCloudDiscoveryengineV1betaTextInput: Defines text input. type GoogleCloudDiscoveryengineV1betaTextInput struct { // Context: Conversation context of the input.