diff --git a/discovery/aiplatform-v1.json b/discovery/aiplatform-v1.json index 4b340ba0a99..36d9692d8c3 100644 --- a/discovery/aiplatform-v1.json +++ b/discovery/aiplatform-v1.json @@ -25,39 +25,39 @@ "location": "africa-south1" }, { - "location": "asia-east1", "endpointUrl": "https://asia-east1-aiplatform.googleapis.com/", + "location": "asia-east1", "description": "Locational Endpoint" }, { - "endpointUrl": "https://asia-east2-aiplatform.googleapis.com/", + "description": "Locational Endpoint", "location": "asia-east2", - "description": "Locational Endpoint" + "endpointUrl": "https://asia-east2-aiplatform.googleapis.com/" }, { - "description": "Locational Endpoint", "location": "asia-northeast1", + "description": "Locational Endpoint", "endpointUrl": "https://asia-northeast1-aiplatform.googleapis.com/" }, { - "endpointUrl": "https://asia-northeast2-aiplatform.googleapis.com/", "location": "asia-northeast2", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "endpointUrl": "https://asia-northeast2-aiplatform.googleapis.com/" }, { + "description": "Locational Endpoint", "endpointUrl": "https://asia-northeast3-aiplatform.googleapis.com/", - "location": "asia-northeast3", - "description": "Locational Endpoint" + "location": "asia-northeast3" }, { + "description": "Locational Endpoint", "location": "asia-south1", - "endpointUrl": "https://asia-south1-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "endpointUrl": "https://asia-south1-aiplatform.googleapis.com/" }, { - "endpointUrl": "https://asia-southeast1-aiplatform.googleapis.com/", + "location": "asia-southeast1", "description": "Locational Endpoint", - "location": "asia-southeast1" + "endpointUrl": "https://asia-southeast1-aiplatform.googleapis.com/" }, { "description": "Locational Endpoint", @@ -66,12 +66,12 @@ }, { "description": "Locational Endpoint", - "endpointUrl": "https://australia-southeast1-aiplatform.googleapis.com/", - "location": "australia-southeast1" + "location": "australia-southeast1", + "endpointUrl": "https://australia-southeast1-aiplatform.googleapis.com/" }, { - "location": "australia-southeast2", "endpointUrl": "https://australia-southeast2-aiplatform.googleapis.com/", + "location": "australia-southeast2", "description": "Locational Endpoint" }, { @@ -81,83 +81,83 @@ }, { "endpointUrl": "https://europe-north1-aiplatform.googleapis.com/", - "location": "europe-north1", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "location": "europe-north1" }, { "location": "europe-southwest1", - "description": "Locational Endpoint", - "endpointUrl": "https://europe-southwest1-aiplatform.googleapis.com/" + "endpointUrl": "https://europe-southwest1-aiplatform.googleapis.com/", + "description": "Locational Endpoint" }, { - "endpointUrl": "https://europe-west1-aiplatform.googleapis.com/", + "location": "europe-west1", "description": "Locational Endpoint", - "location": "europe-west1" + "endpointUrl": "https://europe-west1-aiplatform.googleapis.com/" }, { - "endpointUrl": "https://europe-west2-aiplatform.googleapis.com/", + "location": "europe-west2", "description": "Locational Endpoint", - "location": "europe-west2" + "endpointUrl": "https://europe-west2-aiplatform.googleapis.com/" }, { "location": "europe-west3", - "description": "Locational Endpoint", - "endpointUrl": "https://europe-west3-aiplatform.googleapis.com/" + "endpointUrl": "https://europe-west3-aiplatform.googleapis.com/", + "description": "Locational Endpoint" }, { - "location": "europe-west4", "description": "Locational Endpoint", + "location": "europe-west4", "endpointUrl": "https://europe-west4-aiplatform.googleapis.com/" }, { + "endpointUrl": "https://europe-west6-aiplatform.googleapis.com/", "location": "europe-west6", - "description": "Locational Endpoint", - "endpointUrl": "https://europe-west6-aiplatform.googleapis.com/" + "description": "Locational Endpoint" }, { - "description": "Locational Endpoint", "location": "europe-west8", + "description": "Locational Endpoint", "endpointUrl": "https://europe-west8-aiplatform.googleapis.com/" }, { + "location": "europe-west9", "endpointUrl": "https://europe-west9-aiplatform.googleapis.com/", - "description": "Locational Endpoint", - "location": "europe-west9" + "description": "Locational Endpoint" }, { "location": "europe-west12", - "description": "Locational Endpoint", - "endpointUrl": "https://europe-west12-aiplatform.googleapis.com/" + "endpointUrl": "https://europe-west12-aiplatform.googleapis.com/", + "description": "Locational Endpoint" }, { - "description": "Locational Endpoint", "endpointUrl": "https://me-central1-aiplatform.googleapis.com/", - "location": "me-central1" + "location": "me-central1", + "description": "Locational Endpoint" }, { - "location": "me-central2", + "description": "Locational Endpoint", "endpointUrl": "https://me-central2-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "location": "me-central2" }, { + "location": "me-west1", "description": "Locational Endpoint", - "endpointUrl": "https://me-west1-aiplatform.googleapis.com/", - "location": "me-west1" + "endpointUrl": "https://me-west1-aiplatform.googleapis.com/" }, { - "description": "Locational Endpoint", + "endpointUrl": "https://northamerica-northeast1-aiplatform.googleapis.com/", "location": "northamerica-northeast1", - "endpointUrl": "https://northamerica-northeast1-aiplatform.googleapis.com/" + "description": "Locational Endpoint" }, { - "endpointUrl": "https://northamerica-northeast2-aiplatform.googleapis.com/", "description": "Locational Endpoint", + "endpointUrl": "https://northamerica-northeast2-aiplatform.googleapis.com/", "location": "northamerica-northeast2" }, { + "description": "Locational Endpoint", "location": "southamerica-east1", - "endpointUrl": "https://southamerica-east1-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "endpointUrl": "https://southamerica-east1-aiplatform.googleapis.com/" }, { "description": "Locational Endpoint", @@ -165,54 +165,54 @@ "endpointUrl": "https://southamerica-west1-aiplatform.googleapis.com/" }, { - "endpointUrl": "https://us-central1-aiplatform.googleapis.com/", "description": "Locational Endpoint", - "location": "us-central1" + "location": "us-central1", + "endpointUrl": "https://us-central1-aiplatform.googleapis.com/" }, { - "location": "us-central2", + "description": "Locational Endpoint", "endpointUrl": "https://us-central2-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "location": "us-central2" }, { - "endpointUrl": "https://us-east1-aiplatform.googleapis.com/", "description": "Locational Endpoint", + "endpointUrl": "https://us-east1-aiplatform.googleapis.com/", "location": "us-east1" }, { "description": "Locational Endpoint", - "location": "us-east4", - "endpointUrl": "https://us-east4-aiplatform.googleapis.com/" + "endpointUrl": "https://us-east4-aiplatform.googleapis.com/", + "location": "us-east4" }, { - "endpointUrl": "https://us-south1-aiplatform.googleapis.com/", "location": "us-south1", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "endpointUrl": "https://us-south1-aiplatform.googleapis.com/" }, { - "location": "us-west1", "endpointUrl": "https://us-west1-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "location": "us-west1" }, { - "location": "us-west2", "description": "Locational Endpoint", + "location": "us-west2", "endpointUrl": "https://us-west2-aiplatform.googleapis.com/" }, { "description": "Locational Endpoint", - "endpointUrl": "https://us-west3-aiplatform.googleapis.com/", - "location": "us-west3" + "location": "us-west3", + "endpointUrl": "https://us-west3-aiplatform.googleapis.com/" }, { - "location": "us-west4", "endpointUrl": "https://us-west4-aiplatform.googleapis.com/", + "location": "us-west4", "description": "Locational Endpoint" }, { - "description": "Locational Endpoint", "location": "us-east5", - "endpointUrl": "https://us-east5-aiplatform.googleapis.com/" + "endpointUrl": "https://us-east5-aiplatform.googleapis.com/", + "description": "Locational Endpoint" } ], "fullyEncodeReservedExpansion": true, @@ -16204,7 +16204,7 @@ } } }, - "revision": "20240429", + "revision": "20240501", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionEmbedVideoResponse": { @@ -16262,7 +16262,8 @@ "CHILD_TEXT", "DANGEROUS_CONTENT", "RECITATION_TEXT", - "CELEBRITY_IMG" + "CELEBRITY_IMG", + "WATERMARK_IMG_REMOVAL" ], "enumDescriptions": [ "", @@ -16299,7 +16300,8 @@ "", "Text category from SafetyCat v3", "", - "" + "", + "Error message when user attempts to remove watermark from editing image" ], "type": "string" }, @@ -16614,9 +16616,9 @@ "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.", + "All other reasons that stopped the token generation (currently only language filter).", "The token generation was stopped as the response was flagged for the terms which are included from the terminology blocklist.", - "The token generation was stopped as the response was flagged for the prohibited contents.", + "The token generation was stopped as the response was flagged for the prohibited contents (currently only CSAM).", "The token generation was stopped as the response was flagged for Sensitive Personally Identifiable Information (SPII) contents." ], "type": "string" @@ -16961,9 +16963,9 @@ "enumDescriptions": [ "Unspecified blocked reason.", "Candidates blocked due to safety.", - "Candidates blocked due to other reason.", + "Candidates blocked due to other reason (currently only language filter).", "Candidates blocked due to the terms which are included from the terminology blocklist.", - "Candidates blocked due to prohibited content." + "Candidates blocked due to prohibited content (currently only CSAM)." ], "type": "string" }, @@ -22662,6 +22664,22 @@ "description": "Crowding is a constraint on a neighbor list produced by nearest neighbor search requiring that no more than some value k' of the k neighbors returned have the same value of crowding_attribute. It's used for improving result diversity. This field is the maximum number of matches with the same crowding tag.", "format": "int32", "type": "integer" + }, + "rrf": { + "$ref": "GoogleCloudAiplatformV1FindNeighborsRequestQueryRRF", + "description": "Optional. Represents RRF algorithm that combines search results." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1FindNeighborsRequestQueryRRF": { + "description": "Parameters for RRF algorithm that combines search results.", + "id": "GoogleCloudAiplatformV1FindNeighborsRequestQueryRRF", + "properties": { + "alpha": { + "description": "Required. Users can provide an alpha value to give more weight to dense vs sparse results. For example, if the alpha is 0, we only return sparse and if the alpha is 1, we only return dense.", + "format": "float", + "type": "number" } }, "type": "object" @@ -22710,6 +22728,11 @@ "description": "The distance between the neighbor and the dense embedding query.", "format": "double", "type": "number" + }, + "sparseDistance": { + "description": "The distance between the neighbor and the query sparse_embedding.", + "format": "double", + "type": "number" } }, "type": "object" @@ -23504,6 +23527,10 @@ "$ref": "GoogleCloudAiplatformV1IndexDatapointRestriction" }, "type": "array" + }, + "sparseEmbedding": { + "$ref": "GoogleCloudAiplatformV1IndexDatapointSparseEmbedding", + "description": "Optional. Feature embedding vector for sparse index." } }, "type": "object" @@ -23592,6 +23619,29 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1IndexDatapointSparseEmbedding": { + "description": "Feature embedding vector for sparse index. An array of numbers whose values are located in the specified dimensions.", + "id": "GoogleCloudAiplatformV1IndexDatapointSparseEmbedding", + "properties": { + "dimensions": { + "description": "Optional. The list of indexes for the embedding values of the sparse vector.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "values": { + "description": "Optional. The list of embedding values of the sparse vector.", + "items": { + "format": "float", + "type": "number" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1IndexEndpoint": { "description": "Indexes are deployed into it. An IndexEndpoint can have multiple DeployedIndexes.", "id": "GoogleCloudAiplatformV1IndexEndpoint", @@ -23704,6 +23754,12 @@ "readOnly": true, "type": "integer" }, + "sparseVectorsCount": { + "description": "Output only. The number of sparse vectors in the Index.", + "format": "int64", + "readOnly": true, + "type": "string" + }, "vectorsCount": { "description": "Output only. The number of dense vectors in the Index.", "format": "int64", @@ -26847,7 +26903,9 @@ "MULTIPLE_VALUES", "INVALID_NUMERIC_VALUE", "INVALID_ENCODING", - "INVALID_TOKEN_VALUE" + "INVALID_SPARSE_DIMENSIONS", + "INVALID_TOKEN_VALUE", + "INVALID_SPARSE_EMBEDDING" ], "enumDescriptions": [ "Default, shall not be used.", @@ -26864,7 +26922,9 @@ "Numeric restrict has multiple values specified.", "Numeric restrict has invalid numeric value specified.", "File is not in UTF_8 format.", - "Token restrict value is invalid." + "Error parsing sparse dimensions field.", + "Token restrict value is invalid.", + "Invalid sparse embedding." ], "type": "string" }, @@ -27227,8 +27287,7 @@ "description": "Optional. Immutable. The specification of a single machine for the template." }, "name": { - "description": "Output only. The resource name of the NotebookRuntimeTemplate.", - "readOnly": true, + "description": "The resource name of the NotebookRuntimeTemplate.", "type": "string" }, "networkSpec": { @@ -34426,12 +34485,12 @@ "type": "string" }, "epochCount": { - "description": "Optional. Number of training epoches for this tuning job.", + "description": "Optional. Number of complete passes the model makes over the entire training dataset during training.", "format": "int64", "type": "string" }, "learningRateMultiplier": { - "description": "Optional. Learning rate multiplier for tuning.", + "description": "Optional. Multiplier for adjusting the default learning rate.", "format": "double", "type": "number" } @@ -34583,11 +34642,11 @@ "description": "Optional. Hyperparameters for SFT." }, "trainingDatasetUri": { - "description": "Required. Cloud Storage path to file containing training dataset for tuning.", + "description": "Required. Cloud Storage path to file containing training dataset for tuning. The dataset must be formatted as a JSONL file.", "type": "string" }, "validationDatasetUri": { - "description": "Optional. Cloud Storage path to file containing validation dataset for tuning.", + "description": "Optional. Cloud Storage path to file containing validation dataset for tuning. The dataset must be formatted as a JSONL file.", "type": "string" } }, @@ -35478,7 +35537,7 @@ "id": "GoogleCloudAiplatformV1TuningJob", "properties": { "baseModel": { - "description": "Model name for tuning, e.g., \"gemini-1.0-pro-002\".", + "description": "The base model that is being tuned, e.g., \"gemini-1.0-pro-002\".", "type": "string" }, "createTime": { @@ -36910,7 +36969,14 @@ "GEMINI_V2_TAIL_PATCH_OPEN_BOOKS_QA_UNANSWERABLE", "GEMINI_V2_TAIL_PATCH_PMC", "GEMINI_V2_TAIL_PATCH_VOXPOPULI", - "GEMINI_V2_TAIL_PATCH_FLEURS" + "GEMINI_V2_TAIL_PATCH_FLEURS", + "GEMINI_V2_SSFS", + "GEMINI_V2_CODE_TRANSFORM_SYNTHETIC_ERROR_FIX", + "GEMINI_V2_CODE_TRANSFORM_GITHUB_COMMITS", + "GEMINI_V2_CODE_TRANSFORM_GITHUB_PR", + "GEMINI_V2_SQL_REPAIR_SFT", + "GEMINI_V2_JSON_MODE_SYS_INSTRUCTION", + "YT_CONTENT_INSPIRATION" ], "enumDescriptions": [ "", @@ -37260,7 +37326,14 @@ "", "Gemini V2 only tail patch.", "", - "" + "", + "Gemini V2 rev10", + "", + "", + "", + "", + "", + "Youtube Content Inpsiration." ], "type": "string" }, @@ -37724,7 +37797,14 @@ "GEMINI_V2_TAIL_PATCH_OPEN_BOOKS_QA_UNANSWERABLE", "GEMINI_V2_TAIL_PATCH_PMC", "GEMINI_V2_TAIL_PATCH_VOXPOPULI", - "GEMINI_V2_TAIL_PATCH_FLEURS" + "GEMINI_V2_TAIL_PATCH_FLEURS", + "GEMINI_V2_SSFS", + "GEMINI_V2_CODE_TRANSFORM_SYNTHETIC_ERROR_FIX", + "GEMINI_V2_CODE_TRANSFORM_GITHUB_COMMITS", + "GEMINI_V2_CODE_TRANSFORM_GITHUB_PR", + "GEMINI_V2_SQL_REPAIR_SFT", + "GEMINI_V2_JSON_MODE_SYS_INSTRUCTION", + "YT_CONTENT_INSPIRATION" ], "enumDescriptions": [ "", @@ -38074,7 +38154,14 @@ "", "Gemini V2 only tail patch.", "", - "" + "", + "Gemini V2 rev10", + "", + "", + "", + "", + "", + "Youtube Content Inpsiration." ], "type": "string" }, @@ -38574,7 +38661,14 @@ "GEMINI_V2_TAIL_PATCH_OPEN_BOOKS_QA_UNANSWERABLE", "GEMINI_V2_TAIL_PATCH_PMC", "GEMINI_V2_TAIL_PATCH_VOXPOPULI", - "GEMINI_V2_TAIL_PATCH_FLEURS" + "GEMINI_V2_TAIL_PATCH_FLEURS", + "GEMINI_V2_SSFS", + "GEMINI_V2_CODE_TRANSFORM_SYNTHETIC_ERROR_FIX", + "GEMINI_V2_CODE_TRANSFORM_GITHUB_COMMITS", + "GEMINI_V2_CODE_TRANSFORM_GITHUB_PR", + "GEMINI_V2_SQL_REPAIR_SFT", + "GEMINI_V2_JSON_MODE_SYS_INSTRUCTION", + "YT_CONTENT_INSPIRATION" ], "enumDescriptions": [ "", @@ -38924,7 +39018,14 @@ "", "Gemini V2 only tail patch.", "", - "" + "", + "Gemini V2 rev10", + "", + "", + "", + "", + "", + "Youtube Content Inspiration FT datasets." ], "type": "string" }, @@ -39388,7 +39489,14 @@ "GEMINI_V2_TAIL_PATCH_OPEN_BOOKS_QA_UNANSWERABLE", "GEMINI_V2_TAIL_PATCH_PMC", "GEMINI_V2_TAIL_PATCH_VOXPOPULI", - "GEMINI_V2_TAIL_PATCH_FLEURS" + "GEMINI_V2_TAIL_PATCH_FLEURS", + "GEMINI_V2_SSFS", + "GEMINI_V2_CODE_TRANSFORM_SYNTHETIC_ERROR_FIX", + "GEMINI_V2_CODE_TRANSFORM_GITHUB_COMMITS", + "GEMINI_V2_CODE_TRANSFORM_GITHUB_PR", + "GEMINI_V2_SQL_REPAIR_SFT", + "GEMINI_V2_JSON_MODE_SYS_INSTRUCTION", + "YT_CONTENT_INSPIRATION" ], "enumDescriptions": [ "", @@ -39738,7 +39846,14 @@ "", "Gemini V2 only tail patch.", "", - "" + "", + "Gemini V2 rev10", + "", + "", + "", + "", + "", + "Youtube Content Inspiration FT datasets." ], "type": "string" }, @@ -41284,10 +41399,37 @@ }, "type": "object" }, + "LearningServingLlmAtlasOutputMetadata": { + "id": "LearningServingLlmAtlasOutputMetadata", + "properties": { + "requestTopic": { + "type": "string" + }, + "source": { + "enum": [ + "UNKNOWN", + "FACTUALITY", + "INFOBOT", + "LLM" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, "LearningServingLlmMessageMetadata": { - "description": "LINT.IfChange This metadata contains additional information required for debugging.", + "description": "LINT.IfChange This metadata contains additional information required for debugging. Next ID: 28", "id": "LearningServingLlmMessageMetadata", "properties": { + "atlasMetadata": { + "$ref": "LearningServingLlmAtlasOutputMetadata" + }, "classifierSummary": { "$ref": "LearningGenaiRootClassifierOutputSummary", "description": "Summary of classifier output. We attach this to all messages regardless of whether classification rules triggered or not." @@ -41363,7 +41505,12 @@ "type": "string" }, "perStreamDecodedTokenCount": { - "description": "NOT YET IMPLEMENTED. Applies to streaming only. Number of tokens decoded / emitted by the model as part of this stream. This may be different from token_count, which contains number of tokens returned in this response after any response rewriting / truncation.", + "description": "Number of tokens decoded by the model as part of a stream. This count may be different from `per_stream_returned_token_count` which, is counted after any response rewriting or truncation. Applies to streaming response only.", + "format": "int32", + "type": "integer" + }, + "perStreamReturnedTokenCount": { + "description": "Number of tokens returned per stream in a response candidate after any response rewriting or truncation. Applies to streaming response only. Applies to Gemini models only.", "format": "int32", "type": "integer" }, @@ -41379,7 +41526,7 @@ "description": "Recitation Results. It will be populated as long as Recitation processing is enabled, regardless of recitation outcome." }, "returnTokenCount": { - "description": "NOT YET IMPLEMENTED. Number of tokens returned as part of this candidate.", + "description": "NOT IMPLEMENTED TODO (b/334187574) Remove this field after Labs migrates to per_stream_returned_token_count and total_returned_token_count.", "format": "int32", "type": "integer" }, @@ -41399,6 +41546,11 @@ "format": "int32", "type": "integer" }, + "totalReturnedTokenCount": { + "description": "Total number of tokens returned in a response candidate. For streaming, it is the aggregated count (i.e. total so far) Applies to Gemini models only.", + "format": "int32", + "type": "integer" + }, "translatedUserPrompts": { "description": "Translated user-prompt used for RAI post processing. This is for internal processing only. We will translate in pre-processor and pass the translated text to the post processor using this field. It will be empty if non of the signals requested need translation.", "items": { diff --git a/discovery/aiplatform-v1beta1.json b/discovery/aiplatform-v1beta1.json index bbbe8f41b95..d2610c75489 100644 --- a/discovery/aiplatform-v1beta1.json +++ b/discovery/aiplatform-v1beta1.json @@ -20,19 +20,19 @@ "documentationLink": "https://cloud.google.com/vertex-ai/", "endpoints": [ { + "description": "Locational Endpoint", "location": "africa-south1", - "endpointUrl": "https://africa-south1-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "endpointUrl": "https://africa-south1-aiplatform.googleapis.com/" }, { - "endpointUrl": "https://asia-east1-aiplatform.googleapis.com/", "description": "Locational Endpoint", + "endpointUrl": "https://asia-east1-aiplatform.googleapis.com/", "location": "asia-east1" }, { "description": "Locational Endpoint", - "endpointUrl": "https://asia-east2-aiplatform.googleapis.com/", - "location": "asia-east2" + "location": "asia-east2", + "endpointUrl": "https://asia-east2-aiplatform.googleapis.com/" }, { "location": "asia-northeast1", @@ -40,88 +40,88 @@ "endpointUrl": "https://asia-northeast1-aiplatform.googleapis.com/" }, { - "description": "Locational Endpoint", "location": "asia-northeast2", - "endpointUrl": "https://asia-northeast2-aiplatform.googleapis.com/" + "endpointUrl": "https://asia-northeast2-aiplatform.googleapis.com/", + "description": "Locational Endpoint" }, { + "endpointUrl": "https://asia-northeast3-aiplatform.googleapis.com/", "description": "Locational Endpoint", - "location": "asia-northeast3", - "endpointUrl": "https://asia-northeast3-aiplatform.googleapis.com/" + "location": "asia-northeast3" }, { - "location": "asia-south1", "endpointUrl": "https://asia-south1-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "location": "asia-south1" }, { - "endpointUrl": "https://asia-southeast1-aiplatform.googleapis.com/", "location": "asia-southeast1", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "endpointUrl": "https://asia-southeast1-aiplatform.googleapis.com/" }, { "endpointUrl": "https://asia-southeast2-aiplatform.googleapis.com/", - "location": "asia-southeast2", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "location": "asia-southeast2" }, { - "description": "Locational Endpoint", "endpointUrl": "https://australia-southeast1-aiplatform.googleapis.com/", + "description": "Locational Endpoint", "location": "australia-southeast1" }, { + "location": "australia-southeast2", "endpointUrl": "https://australia-southeast2-aiplatform.googleapis.com/", - "description": "Locational Endpoint", - "location": "australia-southeast2" + "description": "Locational Endpoint" }, { "location": "europe-central2", - "description": "Locational Endpoint", - "endpointUrl": "https://europe-central2-aiplatform.googleapis.com/" + "endpointUrl": "https://europe-central2-aiplatform.googleapis.com/", + "description": "Locational Endpoint" }, { - "endpointUrl": "https://europe-north1-aiplatform.googleapis.com/", "location": "europe-north1", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "endpointUrl": "https://europe-north1-aiplatform.googleapis.com/" }, { - "location": "europe-southwest1", + "description": "Locational Endpoint", "endpointUrl": "https://europe-southwest1-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "location": "europe-southwest1" }, { - "endpointUrl": "https://europe-west1-aiplatform.googleapis.com/", + "location": "europe-west1", "description": "Locational Endpoint", - "location": "europe-west1" + "endpointUrl": "https://europe-west1-aiplatform.googleapis.com/" }, { - "endpointUrl": "https://europe-west2-aiplatform.googleapis.com/", + "location": "europe-west2", "description": "Locational Endpoint", - "location": "europe-west2" + "endpointUrl": "https://europe-west2-aiplatform.googleapis.com/" }, { "location": "europe-west3", - "endpointUrl": "https://europe-west3-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "endpointUrl": "https://europe-west3-aiplatform.googleapis.com/" }, { - "location": "europe-west4", + "endpointUrl": "https://europe-west4-aiplatform.googleapis.com/", "description": "Locational Endpoint", - "endpointUrl": "https://europe-west4-aiplatform.googleapis.com/" + "location": "europe-west4" }, { - "description": "Locational Endpoint", "location": "europe-west6", + "description": "Locational Endpoint", "endpointUrl": "https://europe-west6-aiplatform.googleapis.com/" }, { - "location": "europe-west8", + "description": "Locational Endpoint", "endpointUrl": "https://europe-west8-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "location": "europe-west8" }, { - "location": "europe-west9", "endpointUrl": "https://europe-west9-aiplatform.googleapis.com/", + "location": "europe-west9", "description": "Locational Endpoint" }, { @@ -130,29 +130,29 @@ "endpointUrl": "https://europe-west12-aiplatform.googleapis.com/" }, { - "description": "Locational Endpoint", "location": "me-central1", - "endpointUrl": "https://me-central1-aiplatform.googleapis.com/" + "endpointUrl": "https://me-central1-aiplatform.googleapis.com/", + "description": "Locational Endpoint" }, { - "description": "Locational Endpoint", "location": "me-central2", + "description": "Locational Endpoint", "endpointUrl": "https://me-central2-aiplatform.googleapis.com/" }, { - "location": "me-west1", "endpointUrl": "https://me-west1-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "location": "me-west1" }, { - "description": "Locational Endpoint", "endpointUrl": "https://northamerica-northeast1-aiplatform.googleapis.com/", + "description": "Locational Endpoint", "location": "northamerica-northeast1" }, { - "endpointUrl": "https://northamerica-northeast2-aiplatform.googleapis.com/", "description": "Locational Endpoint", - "location": "northamerica-northeast2" + "location": "northamerica-northeast2", + "endpointUrl": "https://northamerica-northeast2-aiplatform.googleapis.com/" }, { "endpointUrl": "https://southamerica-east1-aiplatform.googleapis.com/", @@ -160,24 +160,24 @@ "description": "Locational Endpoint" }, { + "description": "Locational Endpoint", "endpointUrl": "https://southamerica-west1-aiplatform.googleapis.com/", - "location": "southamerica-west1", - "description": "Locational Endpoint" + "location": "southamerica-west1" }, { - "endpointUrl": "https://us-central1-aiplatform.googleapis.com/", "location": "us-central1", + "endpointUrl": "https://us-central1-aiplatform.googleapis.com/", "description": "Locational Endpoint" }, { - "description": "Locational Endpoint", "location": "us-central2", - "endpointUrl": "https://us-central2-aiplatform.googleapis.com/" + "endpointUrl": "https://us-central2-aiplatform.googleapis.com/", + "description": "Locational Endpoint" }, { "endpointUrl": "https://us-east1-aiplatform.googleapis.com/", - "location": "us-east1", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "location": "us-east1" }, { "endpointUrl": "https://us-east4-aiplatform.googleapis.com/", @@ -185,19 +185,19 @@ "description": "Locational Endpoint" }, { - "description": "Locational Endpoint", "endpointUrl": "https://us-south1-aiplatform.googleapis.com/", - "location": "us-south1" + "location": "us-south1", + "description": "Locational Endpoint" }, { - "endpointUrl": "https://us-west1-aiplatform.googleapis.com/", "description": "Locational Endpoint", + "endpointUrl": "https://us-west1-aiplatform.googleapis.com/", "location": "us-west1" }, { - "description": "Locational Endpoint", + "endpointUrl": "https://us-west2-aiplatform.googleapis.com/", "location": "us-west2", - "endpointUrl": "https://us-west2-aiplatform.googleapis.com/" + "description": "Locational Endpoint" }, { "description": "Locational Endpoint", @@ -205,9 +205,9 @@ "endpointUrl": "https://us-west3-aiplatform.googleapis.com/" }, { - "endpointUrl": "https://us-west4-aiplatform.googleapis.com/", + "location": "us-west4", "description": "Locational Endpoint", - "location": "us-west4" + "endpointUrl": "https://us-west4-aiplatform.googleapis.com/" }, { "location": "us-east5", @@ -305,6 +305,50 @@ }, "protocol": "rest", "resources": { + "media": { + "methods": { + "upload": { + "description": "Upload a file into a RagCorpus.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles:upload", + "httpMethod": "POST", + "id": "aiplatform.media.upload", + "mediaUpload": { + "accept": [ + "*/*" + ], + "protocols": { + "simple": { + "multipart": true, + "path": "/upload/v1beta1/{+parent}/ragFiles:upload" + } + } + }, + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The name of the RagCorpus resource into which to upload the file. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/ragFiles:upload", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1UploadRagFileRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1UploadRagFileResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "supportsMediaUpload": true + } + } + }, "projects": { "methods": { "getCacheConfig": { @@ -457,6 +501,34 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "retrieveContexts": { + "description": "Retrieves relevant contexts for a query.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:retrieveContexts", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.retrieveContexts", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location from which to retrieve RagContexts. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}:retrieveContexts", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1RetrieveContextsRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1RetrieveContextsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { @@ -14964,6 +15036,127 @@ } }, "ragCorpora": { + "methods": { + "create": { + "description": "Creates a RagCorpus.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.ragCorpora.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location to create the RagCorpus in. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/ragCorpora", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1RagCorpus" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a RagCorpus.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.ragCorpora.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "force": { + "description": "Optional. If set to true, any RagFiles in this RagCorpus will also be deleted. Otherwise, the request will only work if the RagCorpus has no RagFiles.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. The name of the RagCorpus resource to be deleted. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a RagCorpus.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.ragCorpora.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the RagCorpus resource. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1RagCorpus" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists RagCorpora in a Location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.ragCorpora.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "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 ListRagCorporaResponse.next_page_token of the previous VertexRagDataService.ListRagCorpora call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location from which to list the RagCorpora. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/ragCorpora", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListRagCorporaResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, "resources": { "operations": { "methods": { @@ -15117,6 +15310,122 @@ } }, "ragFiles": { + "methods": { + "delete": { + "description": "Deletes a RagFile.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.ragCorpora.ragFiles.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the RagFile resource to be deleted. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a RagFile.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.ragCorpora.ragFiles.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the RagFile resource. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1RagFile" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "import": { + "description": "Import files from Google Cloud Storage or Google Drive into a RagCorpus.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles:import", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.ragCorpora.ragFiles.import", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The name of the RagCorpus resource into which to import files. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/ragFiles:import", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1ImportRagFilesRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists RagFiles in a RagCorpus.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.ragCorpora.ragFiles.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "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 ListRagFilesResponse.next_page_token of the previous VertexRagDataService.ListRagFiles call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the RagCorpus from which to list the RagFiles. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/ragFiles", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListRagFilesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, "resources": { "operations": { "methods": { @@ -19126,7 +19435,7 @@ } } }, - "revision": "20240429", + "revision": "20240501", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionEmbedVideoResponse": { @@ -19184,7 +19493,8 @@ "CHILD_TEXT", "DANGEROUS_CONTENT", "RECITATION_TEXT", - "CELEBRITY_IMG" + "CELEBRITY_IMG", + "WATERMARK_IMG_REMOVAL" ], "enumDescriptions": [ "", @@ -19221,7 +19531,8 @@ "", "Text category from SafetyCat v3", "", - "" + "", + "Error message when user attempts to remove watermark from editing image" ], "type": "string" }, @@ -19536,9 +19847,9 @@ "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.", + "All other reasons that stopped the token generation (currently only language filter).", "The token generation was stopped as the response was flagged for the terms which are included from the terminology blocklist.", - "The token generation was stopped as the response was flagged for the prohibited contents.", + "The token generation was stopped as the response was flagged for the prohibited contents (currently only CSAM).", "The token generation was stopped as the response was flagged for Sensitive Personally Identifiable Information (SPII) contents." ], "type": "string" @@ -19883,9 +20194,9 @@ "enumDescriptions": [ "Unspecified blocked reason.", "Candidates blocked due to safety.", - "Candidates blocked due to other reason.", + "Candidates blocked due to other reason (currently only language filter).", "Candidates blocked due to the terms which are included from the terminology blocklist.", - "Candidates blocked due to prohibited content." + "Candidates blocked due to prohibited content (currently only CSAM)." ], "type": "string" }, @@ -22401,6 +22712,25 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1CreateNotebookExecutionJobRequest": { + "description": "Request message for [NotebookService.CreateNotebookExecutionJob]", + "id": "GoogleCloudAiplatformV1beta1CreateNotebookExecutionJobRequest", + "properties": { + "notebookExecutionJob": { + "$ref": "GoogleCloudAiplatformV1beta1NotebookExecutionJob", + "description": "Required. The NotebookExecutionJob to create." + }, + "notebookExecutionJobId": { + "description": "Optional. User specified ID for the NotebookExecutionJob.", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to create the NotebookExecutionJob. Format: `projects/{project}/locations/{location}`", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1CreateNotebookRuntimeTemplateOperationMetadata": { "description": "Metadata information for NotebookService.CreateNotebookRuntimeTemplate.", "id": "GoogleCloudAiplatformV1beta1CreateNotebookRuntimeTemplateOperationMetadata", @@ -23574,6 +23904,12 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1DirectUploadSource": { + "description": "The input content is encapsulated and uploaded in the request.", + "id": "GoogleCloudAiplatformV1beta1DirectUploadSource", + "properties": {}, + "type": "object" + }, "GoogleCloudAiplatformV1beta1DiskSpec": { "description": "Represents the spec of disk options.", "id": "GoogleCloudAiplatformV1beta1DiskSpec", @@ -26517,6 +26853,22 @@ "description": "Crowding is a constraint on a neighbor list produced by nearest neighbor search requiring that no more than some value k' of the k neighbors returned have the same value of crowding_attribute. It's used for improving result diversity. This field is the maximum number of matches with the same crowding tag.", "format": "int32", "type": "integer" + }, + "rrf": { + "$ref": "GoogleCloudAiplatformV1beta1FindNeighborsRequestQueryRRF", + "description": "Optional. Represents RRF algorithm that combines search results." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1FindNeighborsRequestQueryRRF": { + "description": "Parameters for RRF algorithm that combines search results.", + "id": "GoogleCloudAiplatformV1beta1FindNeighborsRequestQueryRRF", + "properties": { + "alpha": { + "description": "Required. Users can provide an alpha value to give more weight to dense vs sparse results. For example, if the alpha is 0, we only return sparse and if the alpha is 1, we only return dense.", + "format": "float", + "type": "number" } }, "type": "object" @@ -26565,6 +26917,11 @@ "description": "The distance between the neighbor and the dense embedding query.", "format": "double", "type": "number" + }, + "sparseDistance": { + "description": "The distance between the neighbor and the query sparse_embedding.", + "format": "double", + "type": "number" } }, "type": "object" @@ -27085,6 +27442,45 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1GoogleDriveSource": { + "description": "The Google Drive location for the input content.", + "id": "GoogleCloudAiplatformV1beta1GoogleDriveSource", + "properties": { + "resourceIds": { + "description": "Required. Google Drive resource IDs.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1GoogleDriveSourceResourceId" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1GoogleDriveSourceResourceId": { + "description": "The type and ID of the Google Drive resource.", + "id": "GoogleCloudAiplatformV1beta1GoogleDriveSourceResourceId", + "properties": { + "resourceId": { + "description": "Required. The ID of the Google Drive resource.", + "type": "string" + }, + "resourceType": { + "description": "Required. The type of the Google Drive resource.", + "enum": [ + "RESOURCE_TYPE_UNSPECIFIED", + "RESOURCE_TYPE_FILE", + "RESOURCE_TYPE_FOLDER" + ], + "enumDescriptions": [ + "Unspecified resource type.", + "File resource type.", + "Folder resource type." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1GroundednessInput": { "description": "Input for groundedness metric.", "id": "GoogleCloudAiplatformV1beta1GroundednessInput", @@ -27529,6 +27925,36 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1ImportRagFilesConfig": { + "description": "Config for importing RagFiles.", + "id": "GoogleCloudAiplatformV1beta1ImportRagFilesConfig", + "properties": { + "gcsSource": { + "$ref": "GoogleCloudAiplatformV1beta1GcsSource", + "description": "Google Cloud Storage location. Supports importing individual files as well as entire Google Cloud Storage directories. Sample formats: - `gs://bucket_name/my_directory/object_name/my_file.txt` - `gs://bucket_name/my_directory`" + }, + "googleDriveSource": { + "$ref": "GoogleCloudAiplatformV1beta1GoogleDriveSource", + "description": "Google Drive location. Supports importing individual files as well as Google Drive folders." + }, + "ragFileChunkingConfig": { + "$ref": "GoogleCloudAiplatformV1beta1RagFileChunkingConfig", + "description": "Specifies the size and overlap of chunks after importing RagFiles." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1ImportRagFilesRequest": { + "description": "Request message for VertexRagDataService.ImportRagFiles.", + "id": "GoogleCloudAiplatformV1beta1ImportRagFilesRequest", + "properties": { + "importRagFilesConfig": { + "$ref": "GoogleCloudAiplatformV1beta1ImportRagFilesConfig", + "description": "Required. The config for the RagFiles to be synced and imported into the RagCorpus. VertexRagDataService.ImportRagFiles." + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1Index": { "description": "A representation of a collection of database items organized in a way that allows for approximate nearest neighbor (a.k.a ANN) algorithms search.", "id": "GoogleCloudAiplatformV1beta1Index", @@ -27644,6 +28070,10 @@ "$ref": "GoogleCloudAiplatformV1beta1IndexDatapointRestriction" }, "type": "array" + }, + "sparseEmbedding": { + "$ref": "GoogleCloudAiplatformV1beta1IndexDatapointSparseEmbedding", + "description": "Optional. Feature embedding vector for sparse index." } }, "type": "object" @@ -27732,6 +28162,29 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1IndexDatapointSparseEmbedding": { + "description": "Feature embedding vector for sparse index. An array of numbers whose values are located in the specified dimensions.", + "id": "GoogleCloudAiplatformV1beta1IndexDatapointSparseEmbedding", + "properties": { + "dimensions": { + "description": "Optional. The list of indexes for the embedding values of the sparse vector.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "values": { + "description": "Optional. The list of embedding values of the sparse vector.", + "items": { + "format": "float", + "type": "number" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1IndexEndpoint": { "description": "Indexes are deployed into it. An IndexEndpoint can have multiple DeployedIndexes.", "id": "GoogleCloudAiplatformV1beta1IndexEndpoint", @@ -27844,6 +28297,12 @@ "readOnly": true, "type": "integer" }, + "sparseVectorsCount": { + "description": "Output only. The number of sparse vectors in the Index.", + "format": "int64", + "readOnly": true, + "type": "string" + }, "vectorsCount": { "description": "Output only. The number of dense vectors in the Index.", "format": "int64", @@ -28770,6 +29229,42 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1ListRagCorporaResponse": { + "description": "Response message for VertexRagDataService.ListRagCorpora.", + "id": "GoogleCloudAiplatformV1beta1ListRagCorporaResponse", + "properties": { + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass to ListRagCorporaRequest.page_token to obtain that page.", + "type": "string" + }, + "ragCorpora": { + "description": "List of RagCorpora in the requested page.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1RagCorpus" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1ListRagFilesResponse": { + "description": "Response message for VertexRagDataService.ListRagFiles.", + "id": "GoogleCloudAiplatformV1beta1ListRagFilesResponse", + "properties": { + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass to ListRagFilesRequest.page_token to obtain that page.", + "type": "string" + }, + "ragFiles": { + "description": "List of RagFiles in the requested page.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1RagFile" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1ListReasoningEnginesResponse": { "description": "Response message for ReasoningEngineService.ListReasoningEngines", "id": "GoogleCloudAiplatformV1beta1ListReasoningEnginesResponse", @@ -31883,7 +32378,9 @@ "MULTIPLE_VALUES", "INVALID_NUMERIC_VALUE", "INVALID_ENCODING", - "INVALID_TOKEN_VALUE" + "INVALID_SPARSE_DIMENSIONS", + "INVALID_TOKEN_VALUE", + "INVALID_SPARSE_EMBEDDING" ], "enumDescriptions": [ "Default, shall not be used.", @@ -31900,7 +32397,9 @@ "Numeric restrict has multiple values specified.", "Numeric restrict has invalid numeric value specified.", "File is not in UTF_8 format.", - "Token restrict value is invalid." + "Error parsing sparse dimensions field.", + "Token restrict value is invalid.", + "Invalid sparse embedding." ], "type": "string" }, @@ -32432,8 +32931,7 @@ "description": "Optional. Immutable. The specification of a single machine for the template." }, "name": { - "description": "Output only. The resource name of the NotebookRuntimeTemplate.", - "readOnly": true, + "description": "The resource name of the NotebookRuntimeTemplate.", "type": "string" }, "networkSpec": { @@ -34483,6 +34981,173 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1RagContexts": { + "description": "Relevant contexts for one query.", + "id": "GoogleCloudAiplatformV1beta1RagContexts", + "properties": { + "contexts": { + "description": "All its contexts.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1RagContextsContext" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1RagContextsContext": { + "description": "A context of the query.", + "id": "GoogleCloudAiplatformV1beta1RagContextsContext", + "properties": { + "distance": { + "description": "The distance between the query vector and the context text vector.", + "format": "double", + "type": "number" + }, + "sourceUri": { + "description": "For vertex RagStore, if the file is imported from Cloud Storage or Google Drive, source_uri will be original file URI in Cloud Storage or Google Drive; if file is uploaded, source_uri will be file display name.", + "type": "string" + }, + "text": { + "description": "The text chunk.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1RagCorpus": { + "description": "A RagCorpus is a RagFile container and a project can have multiple RagCorpora.", + "id": "GoogleCloudAiplatformV1beta1RagCorpus", + "properties": { + "createTime": { + "description": "Output only. Timestamp when this RagCorpus was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Optional. The description of the RagCorpus.", + "type": "string" + }, + "displayName": { + "description": "Required. The display name of the RagCorpus. The name can be up to 128 characters long and can consist of any UTF-8 characters.", + "type": "string" + }, + "name": { + "description": "Output only. The resource name of the RagCorpus.", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. Timestamp when this RagCorpus was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1RagFile": { + "description": "A RagFile contains user data for chunking, embedding and indexing.", + "id": "GoogleCloudAiplatformV1beta1RagFile", + "properties": { + "createTime": { + "description": "Output only. Timestamp when this RagFile was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Optional. The description of the RagFile.", + "type": "string" + }, + "directUploadSource": { + "$ref": "GoogleCloudAiplatformV1beta1DirectUploadSource", + "description": "Output only. The RagFile is encapsulated and uploaded in the UploadRagFile request.", + "readOnly": true + }, + "displayName": { + "description": "Required. The display name of the RagFile. The name can be up to 128 characters long and can consist of any UTF-8 characters.", + "type": "string" + }, + "gcsSource": { + "$ref": "GoogleCloudAiplatformV1beta1GcsSource", + "description": "Output only. Google Cloud Storage location of the RagFile. It does not support wildcards in the Cloud Storage uri for now.", + "readOnly": true + }, + "googleDriveSource": { + "$ref": "GoogleCloudAiplatformV1beta1GoogleDriveSource", + "description": "Output only. Google Drive location. Supports importing individual files as well as Google Drive folders.", + "readOnly": true + }, + "name": { + "description": "Output only. The resource name of the RagFile.", + "readOnly": true, + "type": "string" + }, + "ragFileType": { + "description": "Output only. The type of the RagFile.", + "enum": [ + "RAG_FILE_TYPE_UNSPECIFIED", + "RAG_FILE_TYPE_TXT", + "RAG_FILE_TYPE_PDF" + ], + "enumDescriptions": [ + "RagFile type is unspecified.", + "RagFile type is TXT.", + "RagFile type is PDF." + ], + "readOnly": true, + "type": "string" + }, + "sizeBytes": { + "description": "Output only. The size of the RagFile in bytes.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. Timestamp when this RagFile was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1RagFileChunkingConfig": { + "description": "Specifies the size and overlap of chunks for RagFiles.", + "id": "GoogleCloudAiplatformV1beta1RagFileChunkingConfig", + "properties": { + "chunkOverlap": { + "description": "The overlap between chunks.", + "format": "int32", + "type": "integer" + }, + "chunkSize": { + "description": "The size of the chunks.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1RagQuery": { + "description": "A query to retrieve relevant contexts.", + "id": "GoogleCloudAiplatformV1beta1RagQuery", + "properties": { + "similarityTopK": { + "description": "Optional. The number of contexts to retrieve.", + "format": "int32", + "type": "integer" + }, + "text": { + "description": "Optional. The query in text format to get relevant contexts.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1RawPredictRequest": { "description": "Request message for PredictionService.RawPredict.", "id": "GoogleCloudAiplatformV1beta1RawPredictRequest", @@ -35122,6 +35787,77 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1RetrieveContextsRequest": { + "description": "Request message for VertexRagService.RetrieveContexts.", + "id": "GoogleCloudAiplatformV1beta1RetrieveContextsRequest", + "properties": { + "query": { + "$ref": "GoogleCloudAiplatformV1beta1RagQuery", + "description": "Required. Single RAG retrieve query." + }, + "vertexRagStore": { + "$ref": "GoogleCloudAiplatformV1beta1RetrieveContextsRequestVertexRagStore", + "description": "The data source for Vertex RagStore." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1RetrieveContextsRequestVertexRagStore": { + "description": "The data source for Vertex RagStore.", + "id": "GoogleCloudAiplatformV1beta1RetrieveContextsRequestVertexRagStore", + "properties": { + "ragCorpora": { + "deprecated": true, + "description": "Optional. Deprecated. Please use rag_resources to specify the data source.", + "items": { + "type": "string" + }, + "type": "array" + }, + "ragResources": { + "description": "Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1RetrieveContextsRequestVertexRagStoreRagResource" + }, + "type": "array" + }, + "vectorDistanceThreshold": { + "description": "Optional. Only return contexts with vector distance smaller than the threshold.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1RetrieveContextsRequestVertexRagStoreRagResource": { + "description": "The definition of the Rag resource.", + "id": "GoogleCloudAiplatformV1beta1RetrieveContextsRequestVertexRagStoreRagResource", + "properties": { + "ragCorpus": { + "description": "Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`", + "type": "string" + }, + "ragFileIds": { + "description": "Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1RetrieveContextsResponse": { + "description": "Response message for VertexRagService.RetrieveContexts.", + "id": "GoogleCloudAiplatformV1beta1RetrieveContextsResponse", + "properties": { + "contexts": { + "$ref": "GoogleCloudAiplatformV1beta1RagContexts", + "description": "The contexts of the query." + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1RougeInput": { "description": "Input for rouge metric.", "id": "GoogleCloudAiplatformV1beta1RougeInput", @@ -35242,8 +35978,13 @@ "GoogleCloudAiplatformV1beta1RuntimeConfigVertexAISearchRuntimeConfig": { "id": "GoogleCloudAiplatformV1beta1RuntimeConfigVertexAISearchRuntimeConfig", "properties": { + "appId": { + "description": "Vertex AI Search App ID. This is used to construct the search request. By setting this app_id, API will construct the serving config which is required to call search API for the user. The app_id and serving_config_name cannot both be empty at the same time.", + "type": "string" + }, "servingConfigName": { - "description": "Required. Vertext AI Search serving config name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config}`", + "deprecated": true, + "description": "[Deprecated] Please use app_id instead. Vertex AI Search serving config name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config}`", "type": "string" } }, @@ -35598,6 +36339,10 @@ "$ref": "GoogleCloudAiplatformV1beta1CreateModelMonitoringJobRequest", "description": "Request for ModelMonitoringService.CreateModelMonitoringJob." }, + "createNotebookExecutionJobRequest": { + "$ref": "GoogleCloudAiplatformV1beta1CreateNotebookExecutionJobRequest", + "description": "Request for NotebookService.CreateNotebookExecutionJob." + }, "createPipelineJobRequest": { "$ref": "GoogleCloudAiplatformV1beta1CreatePipelineJobRequest", "description": "Request for PipelineService.CreatePipelineJob. CreatePipelineJobRequest.parent field is required (format: projects/{project}/locations/{location})." @@ -42481,6 +43226,47 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1UploadRagFileConfig": { + "description": "Config for uploading RagFile.", + "id": "GoogleCloudAiplatformV1beta1UploadRagFileConfig", + "properties": { + "ragFileChunkingConfig": { + "$ref": "GoogleCloudAiplatformV1beta1RagFileChunkingConfig", + "description": "Specifies the size and overlap of chunks after uploading RagFile." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1UploadRagFileRequest": { + "description": "Request message for VertexRagDataService.UploadRagFile.", + "id": "GoogleCloudAiplatformV1beta1UploadRagFileRequest", + "properties": { + "ragFile": { + "$ref": "GoogleCloudAiplatformV1beta1RagFile", + "description": "Required. The RagFile to upload." + }, + "uploadRagFileConfig": { + "$ref": "GoogleCloudAiplatformV1beta1UploadRagFileConfig", + "description": "Required. The config for the RagFiles to be uploaded into the RagCorpus. VertexRagDataService.UploadRagFile." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1UploadRagFileResponse": { + "description": "Response message for VertexRagDataService.UploadRagFile.", + "id": "GoogleCloudAiplatformV1beta1UploadRagFileResponse", + "properties": { + "error": { + "$ref": "GoogleRpcStatus", + "description": "The error that occurred while processing the RagFile." + }, + "ragFile": { + "$ref": "GoogleCloudAiplatformV1beta1RagFile", + "description": "The RagFile that had been uploaded into the RagCorpus." + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1UpsertDatapointsRequest": { "description": "Request message for IndexService.UpsertDatapoints", "id": "GoogleCloudAiplatformV1beta1UpsertDatapointsRequest", @@ -42562,12 +43348,19 @@ "id": "GoogleCloudAiplatformV1beta1VertexRagStore", "properties": { "ragCorpora": { - "description": "Required. Vertex RAG Store corpus resource name: `projects/{project}/locations/{location}/ragCorpora/{ragCorpus}` Currently only one corpus is allowed. In the future we may open up multiple corpora support. However, they should be from the same project and location.", + "description": "Optional. Deprecated. Please use rag_resources instead.", "items": { "type": "string" }, "type": "array" }, + "ragResources": { + "description": "Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1VertexRagStoreRagResource" + }, + "type": "array" + }, "similarityTopK": { "description": "Optional. Number of top k results to return from the selected corpora.", "format": "int32", @@ -42581,6 +43374,24 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1VertexRagStoreRagResource": { + "description": "The definition of the Rag resource.", + "id": "GoogleCloudAiplatformV1beta1VertexRagStoreRagResource", + "properties": { + "ragCorpus": { + "description": "Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`", + "type": "string" + }, + "ragFileIds": { + "description": "Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1VideoMetadata": { "description": "Metadata describes the input video content.", "id": "GoogleCloudAiplatformV1beta1VideoMetadata", @@ -43551,7 +44362,14 @@ "GEMINI_V2_TAIL_PATCH_OPEN_BOOKS_QA_UNANSWERABLE", "GEMINI_V2_TAIL_PATCH_PMC", "GEMINI_V2_TAIL_PATCH_VOXPOPULI", - "GEMINI_V2_TAIL_PATCH_FLEURS" + "GEMINI_V2_TAIL_PATCH_FLEURS", + "GEMINI_V2_SSFS", + "GEMINI_V2_CODE_TRANSFORM_SYNTHETIC_ERROR_FIX", + "GEMINI_V2_CODE_TRANSFORM_GITHUB_COMMITS", + "GEMINI_V2_CODE_TRANSFORM_GITHUB_PR", + "GEMINI_V2_SQL_REPAIR_SFT", + "GEMINI_V2_JSON_MODE_SYS_INSTRUCTION", + "YT_CONTENT_INSPIRATION" ], "enumDescriptions": [ "", @@ -43901,7 +44719,14 @@ "", "Gemini V2 only tail patch.", "", - "" + "", + "Gemini V2 rev10", + "", + "", + "", + "", + "", + "Youtube Content Inpsiration." ], "type": "string" }, @@ -44365,7 +45190,14 @@ "GEMINI_V2_TAIL_PATCH_OPEN_BOOKS_QA_UNANSWERABLE", "GEMINI_V2_TAIL_PATCH_PMC", "GEMINI_V2_TAIL_PATCH_VOXPOPULI", - "GEMINI_V2_TAIL_PATCH_FLEURS" + "GEMINI_V2_TAIL_PATCH_FLEURS", + "GEMINI_V2_SSFS", + "GEMINI_V2_CODE_TRANSFORM_SYNTHETIC_ERROR_FIX", + "GEMINI_V2_CODE_TRANSFORM_GITHUB_COMMITS", + "GEMINI_V2_CODE_TRANSFORM_GITHUB_PR", + "GEMINI_V2_SQL_REPAIR_SFT", + "GEMINI_V2_JSON_MODE_SYS_INSTRUCTION", + "YT_CONTENT_INSPIRATION" ], "enumDescriptions": [ "", @@ -44715,7 +45547,14 @@ "", "Gemini V2 only tail patch.", "", - "" + "", + "Gemini V2 rev10", + "", + "", + "", + "", + "", + "Youtube Content Inpsiration." ], "type": "string" }, @@ -45215,7 +46054,14 @@ "GEMINI_V2_TAIL_PATCH_OPEN_BOOKS_QA_UNANSWERABLE", "GEMINI_V2_TAIL_PATCH_PMC", "GEMINI_V2_TAIL_PATCH_VOXPOPULI", - "GEMINI_V2_TAIL_PATCH_FLEURS" + "GEMINI_V2_TAIL_PATCH_FLEURS", + "GEMINI_V2_SSFS", + "GEMINI_V2_CODE_TRANSFORM_SYNTHETIC_ERROR_FIX", + "GEMINI_V2_CODE_TRANSFORM_GITHUB_COMMITS", + "GEMINI_V2_CODE_TRANSFORM_GITHUB_PR", + "GEMINI_V2_SQL_REPAIR_SFT", + "GEMINI_V2_JSON_MODE_SYS_INSTRUCTION", + "YT_CONTENT_INSPIRATION" ], "enumDescriptions": [ "", @@ -45565,7 +46411,14 @@ "", "Gemini V2 only tail patch.", "", - "" + "", + "Gemini V2 rev10", + "", + "", + "", + "", + "", + "Youtube Content Inspiration FT datasets." ], "type": "string" }, @@ -46029,7 +46882,14 @@ "GEMINI_V2_TAIL_PATCH_OPEN_BOOKS_QA_UNANSWERABLE", "GEMINI_V2_TAIL_PATCH_PMC", "GEMINI_V2_TAIL_PATCH_VOXPOPULI", - "GEMINI_V2_TAIL_PATCH_FLEURS" + "GEMINI_V2_TAIL_PATCH_FLEURS", + "GEMINI_V2_SSFS", + "GEMINI_V2_CODE_TRANSFORM_SYNTHETIC_ERROR_FIX", + "GEMINI_V2_CODE_TRANSFORM_GITHUB_COMMITS", + "GEMINI_V2_CODE_TRANSFORM_GITHUB_PR", + "GEMINI_V2_SQL_REPAIR_SFT", + "GEMINI_V2_JSON_MODE_SYS_INSTRUCTION", + "YT_CONTENT_INSPIRATION" ], "enumDescriptions": [ "", @@ -46379,7 +47239,14 @@ "", "Gemini V2 only tail patch.", "", - "" + "", + "Gemini V2 rev10", + "", + "", + "", + "", + "", + "Youtube Content Inspiration FT datasets." ], "type": "string" }, @@ -47925,10 +48792,37 @@ }, "type": "object" }, + "LearningServingLlmAtlasOutputMetadata": { + "id": "LearningServingLlmAtlasOutputMetadata", + "properties": { + "requestTopic": { + "type": "string" + }, + "source": { + "enum": [ + "UNKNOWN", + "FACTUALITY", + "INFOBOT", + "LLM" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, "LearningServingLlmMessageMetadata": { - "description": "LINT.IfChange This metadata contains additional information required for debugging.", + "description": "LINT.IfChange This metadata contains additional information required for debugging. Next ID: 28", "id": "LearningServingLlmMessageMetadata", "properties": { + "atlasMetadata": { + "$ref": "LearningServingLlmAtlasOutputMetadata" + }, "classifierSummary": { "$ref": "LearningGenaiRootClassifierOutputSummary", "description": "Summary of classifier output. We attach this to all messages regardless of whether classification rules triggered or not." @@ -48004,7 +48898,12 @@ "type": "string" }, "perStreamDecodedTokenCount": { - "description": "NOT YET IMPLEMENTED. Applies to streaming only. Number of tokens decoded / emitted by the model as part of this stream. This may be different from token_count, which contains number of tokens returned in this response after any response rewriting / truncation.", + "description": "Number of tokens decoded by the model as part of a stream. This count may be different from `per_stream_returned_token_count` which, is counted after any response rewriting or truncation. Applies to streaming response only.", + "format": "int32", + "type": "integer" + }, + "perStreamReturnedTokenCount": { + "description": "Number of tokens returned per stream in a response candidate after any response rewriting or truncation. Applies to streaming response only. Applies to Gemini models only.", "format": "int32", "type": "integer" }, @@ -48020,7 +48919,7 @@ "description": "Recitation Results. It will be populated as long as Recitation processing is enabled, regardless of recitation outcome." }, "returnTokenCount": { - "description": "NOT YET IMPLEMENTED. Number of tokens returned as part of this candidate.", + "description": "NOT IMPLEMENTED TODO (b/334187574) Remove this field after Labs migrates to per_stream_returned_token_count and total_returned_token_count.", "format": "int32", "type": "integer" }, @@ -48040,6 +48939,11 @@ "format": "int32", "type": "integer" }, + "totalReturnedTokenCount": { + "description": "Total number of tokens returned in a response candidate. For streaming, it is the aggregated count (i.e. total so far) Applies to Gemini models only.", + "format": "int32", + "type": "integer" + }, "translatedUserPrompts": { "description": "Translated user-prompt used for RAI post processing. This is for internal processing only. We will translate in pre-processor and pass the translated text to the post processor using this field. It will be empty if non of the signals requested need translation.", "items": { diff --git a/src/apis/aiplatform/v1.ts b/src/apis/aiplatform/v1.ts index 34415033e17..dc1b0d6d1db 100644 --- a/src/apis/aiplatform/v1.ts +++ b/src/apis/aiplatform/v1.ts @@ -4653,6 +4653,19 @@ export namespace aiplatform_v1 { * Crowding is a constraint on a neighbor list produced by nearest neighbor search requiring that no more than some value k' of the k neighbors returned have the same value of crowding_attribute. It's used for improving result diversity. This field is the maximum number of matches with the same crowding tag. */ perCrowdingAttributeNeighborCount?: number | null; + /** + * Optional. Represents RRF algorithm that combines search results. + */ + rrf?: Schema$GoogleCloudAiplatformV1FindNeighborsRequestQueryRRF; + } + /** + * Parameters for RRF algorithm that combines search results. + */ + export interface Schema$GoogleCloudAiplatformV1FindNeighborsRequestQueryRRF { + /** + * Required. Users can provide an alpha value to give more weight to dense vs sparse results. For example, if the alpha is 0, we only return sparse and if the alpha is 1, we only return dense. + */ + alpha?: number | null; } /** * The response message for MatchService.FindNeighbors. @@ -4688,6 +4701,10 @@ export namespace aiplatform_v1 { * The distance between the neighbor and the dense embedding query. */ distance?: number | null; + /** + * The distance between the neighbor and the query sparse_embedding. + */ + sparseDistance?: number | null; } /** * Assigns the input data to training, validation, and test sets as per the given fractions. Any of `training_fraction`, `validation_fraction` and `test_fraction` may optionally be provided, they must sum to up to 1. If the provided ones sum to less than 1, the remainder is assigned to sets as decided by Vertex AI. If none of the fractions are set, by default roughly 80% of data is used for training, 10% for validation, and 10% for test. @@ -5234,6 +5251,10 @@ export namespace aiplatform_v1 { * Optional. List of Restrict of the datapoint, used to perform "restricted searches" where boolean rule are used to filter the subset of the database eligible for matching. This uses categorical tokens. See: https://cloud.google.com/vertex-ai/docs/matching-engine/filtering */ restricts?: Schema$GoogleCloudAiplatformV1IndexDatapointRestriction[]; + /** + * Optional. Feature embedding vector for sparse index. + */ + sparseEmbedding?: Schema$GoogleCloudAiplatformV1IndexDatapointSparseEmbedding; } /** * Crowding tag is a constraint on a neighbor list produced by nearest neighbor search requiring that no more than some value k' of the k neighbors returned have the same value of crowding_attribute. @@ -5286,6 +5307,19 @@ export namespace aiplatform_v1 { */ namespace?: string | null; } + /** + * Feature embedding vector for sparse index. An array of numbers whose values are located in the specified dimensions. + */ + export interface Schema$GoogleCloudAiplatformV1IndexDatapointSparseEmbedding { + /** + * Optional. The list of indexes for the embedding values of the sparse vector. + */ + dimensions?: string[] | null; + /** + * Optional. The list of embedding values of the sparse vector. + */ + values?: number[] | null; + } /** * Indexes are deployed into it. An IndexEndpoint can have multiple DeployedIndexes. */ @@ -5372,6 +5406,10 @@ export namespace aiplatform_v1 { * Output only. The number of shards in the Index. */ shardsCount?: number | null; + /** + * Output only. The number of sparse vectors in the Index. + */ + sparseVectorsCount?: string | null; /** * Output only. The number of dense vectors in the Index. */ @@ -7851,7 +7889,7 @@ export namespace aiplatform_v1 { */ machineSpec?: Schema$GoogleCloudAiplatformV1MachineSpec; /** - * Output only. The resource name of the NotebookRuntimeTemplate. + * The resource name of the NotebookRuntimeTemplate. */ name?: string | null; /** @@ -12833,11 +12871,11 @@ export namespace aiplatform_v1 { */ adapterSize?: string | null; /** - * Optional. Number of training epoches for this tuning job. + * Optional. Number of complete passes the model makes over the entire training dataset during training. */ epochCount?: string | null; /** - * Optional. Learning rate multiplier for tuning. + * Optional. Multiplier for adjusting the default learning rate. */ learningRateMultiplier?: number | null; } @@ -12941,11 +12979,11 @@ export namespace aiplatform_v1 { */ hyperParameters?: Schema$GoogleCloudAiplatformV1SupervisedHyperParameters; /** - * Required. Cloud Storage path to file containing training dataset for tuning. + * Required. Cloud Storage path to file containing training dataset for tuning. The dataset must be formatted as a JSONL file. */ trainingDatasetUri?: string | null; /** - * Optional. Cloud Storage path to file containing validation dataset for tuning. + * Optional. Cloud Storage path to file containing validation dataset for tuning. The dataset must be formatted as a JSONL file. */ validationDatasetUri?: string | null; } @@ -13534,7 +13572,7 @@ export namespace aiplatform_v1 { */ export interface Schema$GoogleCloudAiplatformV1TuningJob { /** - * Model name for tuning, e.g., "gemini-1.0-pro-002". + * The base model that is being tuned, e.g., "gemini-1.0-pro-002". */ baseModel?: string | null; /** @@ -15097,10 +15135,15 @@ export namespace aiplatform_v1 { */ totalContentSize?: string | null; } + export interface Schema$LearningServingLlmAtlasOutputMetadata { + requestTopic?: string | null; + source?: string | null; + } /** - * LINT.IfChange This metadata contains additional information required for debugging. + * LINT.IfChange This metadata contains additional information required for debugging. Next ID: 28 */ export interface Schema$LearningServingLlmMessageMetadata { + atlasMetadata?: Schema$LearningServingLlmAtlasOutputMetadata; /** * Summary of classifier output. We attach this to all messages regardless of whether classification rules triggered or not. */ @@ -15152,9 +15195,13 @@ export namespace aiplatform_v1 { */ originalText?: string | null; /** - * NOT YET IMPLEMENTED. Applies to streaming only. Number of tokens decoded / emitted by the model as part of this stream. This may be different from token_count, which contains number of tokens returned in this response after any response rewriting / truncation. + * Number of tokens decoded by the model as part of a stream. This count may be different from `per_stream_returned_token_count` which, is counted after any response rewriting or truncation. Applies to streaming response only. */ perStreamDecodedTokenCount?: number | null; + /** + * Number of tokens returned per stream in a response candidate after any response rewriting or truncation. Applies to streaming response only. Applies to Gemini models only. + */ + perStreamReturnedTokenCount?: number | null; /** * Results of running RAI on the query or this response candidate. One output per rai_config. It will be populated regardless of whether the threshold is exceeded or not. */ @@ -15164,7 +15211,7 @@ export namespace aiplatform_v1 { */ recitationResult?: Schema$LearningGenaiRecitationRecitationResult; /** - * NOT YET IMPLEMENTED. Number of tokens returned as part of this candidate. + * NOT IMPLEMENTED TODO (b/334187574) Remove this field after Labs migrates to per_stream_returned_token_count and total_returned_token_count. */ returnTokenCount?: number | null; /** @@ -15179,6 +15226,10 @@ export namespace aiplatform_v1 { * Total tokens decoded so far per response_candidate. For streaming: Count of all the tokens decoded so far (aggregated count). For unary: Count of all the tokens decoded per response_candidate. */ totalDecodedTokenCount?: number | null; + /** + * Total number of tokens returned in a response candidate. For streaming, it is the aggregated count (i.e. total so far) Applies to Gemini models only. + */ + totalReturnedTokenCount?: number | null; /** * Translated user-prompt used for RAI post processing. This is for internal processing only. We will translate in pre-processor and pass the translated text to the post processor using this field. It will be empty if non of the signals requested need translation. */ diff --git a/src/apis/aiplatform/v1beta1.ts b/src/apis/aiplatform/v1beta1.ts index 2dcebc16eda..a9cc605e94c 100644 --- a/src/apis/aiplatform/v1beta1.ts +++ b/src/apis/aiplatform/v1beta1.ts @@ -112,6 +112,7 @@ export namespace aiplatform_v1beta1 { */ export class Aiplatform { context: APIRequestContext; + media: Resource$Media; projects: Resource$Projects; publishers: Resource$Publishers; @@ -121,6 +122,7 @@ export namespace aiplatform_v1beta1 { google, }; + this.media = new Resource$Media(this.context); this.projects = new Resource$Projects(this.context); this.publishers = new Resource$Publishers(this.context); } @@ -2337,6 +2339,23 @@ export namespace aiplatform_v1beta1 { */ genericMetadata?: Schema$GoogleCloudAiplatformV1beta1GenericOperationMetadata; } + /** + * Request message for [NotebookService.CreateNotebookExecutionJob] + */ + export interface Schema$GoogleCloudAiplatformV1beta1CreateNotebookExecutionJobRequest { + /** + * Required. The NotebookExecutionJob to create. + */ + notebookExecutionJob?: Schema$GoogleCloudAiplatformV1beta1NotebookExecutionJob; + /** + * Optional. User specified ID for the NotebookExecutionJob. + */ + notebookExecutionJobId?: string | null; + /** + * Required. The resource name of the Location to create the NotebookExecutionJob. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string | null; + } /** * Metadata information for NotebookService.CreateNotebookRuntimeTemplate. */ @@ -3233,6 +3252,10 @@ export namespace aiplatform_v1beta1 { */ output?: string | null; } + /** + * The input content is encapsulated and uploaded in the request. + */ + export interface Schema$GoogleCloudAiplatformV1beta1DirectUploadSource {} /** * Represents the spec of disk options. */ @@ -5371,6 +5394,19 @@ export namespace aiplatform_v1beta1 { * Crowding is a constraint on a neighbor list produced by nearest neighbor search requiring that no more than some value k' of the k neighbors returned have the same value of crowding_attribute. It's used for improving result diversity. This field is the maximum number of matches with the same crowding tag. */ perCrowdingAttributeNeighborCount?: number | null; + /** + * Optional. Represents RRF algorithm that combines search results. + */ + rrf?: Schema$GoogleCloudAiplatformV1beta1FindNeighborsRequestQueryRRF; + } + /** + * Parameters for RRF algorithm that combines search results. + */ + export interface Schema$GoogleCloudAiplatformV1beta1FindNeighborsRequestQueryRRF { + /** + * Required. Users can provide an alpha value to give more weight to dense vs sparse results. For example, if the alpha is 0, we only return sparse and if the alpha is 1, we only return dense. + */ + alpha?: number | null; } /** * The response message for MatchService.FindNeighbors. @@ -5406,6 +5442,10 @@ export namespace aiplatform_v1beta1 { * The distance between the neighbor and the dense embedding query. */ distance?: number | null; + /** + * The distance between the neighbor and the query sparse_embedding. + */ + sparseDistance?: number | null; } /** * Input for fluency metric. @@ -5776,6 +5816,28 @@ export namespace aiplatform_v1beta1 { */ baseModelUri?: string | null; } + /** + * The Google Drive location for the input content. + */ + export interface Schema$GoogleCloudAiplatformV1beta1GoogleDriveSource { + /** + * Required. Google Drive resource IDs. + */ + resourceIds?: Schema$GoogleCloudAiplatformV1beta1GoogleDriveSourceResourceId[]; + } + /** + * The type and ID of the Google Drive resource. + */ + export interface Schema$GoogleCloudAiplatformV1beta1GoogleDriveSourceResourceId { + /** + * Required. The ID of the Google Drive resource. + */ + resourceId?: string | null; + /** + * Required. The type of the Google Drive resource. + */ + resourceType?: string | null; + } /** * Input for groundedness metric. */ @@ -6087,6 +6149,32 @@ export namespace aiplatform_v1beta1 { */ modelEvaluation?: Schema$GoogleCloudAiplatformV1beta1ModelEvaluation; } + /** + * Config for importing RagFiles. + */ + export interface Schema$GoogleCloudAiplatformV1beta1ImportRagFilesConfig { + /** + * Google Cloud Storage location. Supports importing individual files as well as entire Google Cloud Storage directories. Sample formats: - `gs://bucket_name/my_directory/object_name/my_file.txt` - `gs://bucket_name/my_directory` + */ + gcsSource?: Schema$GoogleCloudAiplatformV1beta1GcsSource; + /** + * Google Drive location. Supports importing individual files as well as Google Drive folders. + */ + googleDriveSource?: Schema$GoogleCloudAiplatformV1beta1GoogleDriveSource; + /** + * Specifies the size and overlap of chunks after importing RagFiles. + */ + ragFileChunkingConfig?: Schema$GoogleCloudAiplatformV1beta1RagFileChunkingConfig; + } + /** + * Request message for VertexRagDataService.ImportRagFiles. + */ + export interface Schema$GoogleCloudAiplatformV1beta1ImportRagFilesRequest { + /** + * Required. The config for the RagFiles to be synced and imported into the RagCorpus. VertexRagDataService.ImportRagFiles. + */ + importRagFilesConfig?: Schema$GoogleCloudAiplatformV1beta1ImportRagFilesConfig; + } /** * A representation of a collection of database items organized in a way that allows for approximate nearest neighbor (a.k.a ANN) algorithms search. */ @@ -6168,6 +6256,10 @@ export namespace aiplatform_v1beta1 { * Optional. List of Restrict of the datapoint, used to perform "restricted searches" where boolean rule are used to filter the subset of the database eligible for matching. This uses categorical tokens. See: https://cloud.google.com/vertex-ai/docs/matching-engine/filtering */ restricts?: Schema$GoogleCloudAiplatformV1beta1IndexDatapointRestriction[]; + /** + * Optional. Feature embedding vector for sparse index. + */ + sparseEmbedding?: Schema$GoogleCloudAiplatformV1beta1IndexDatapointSparseEmbedding; } /** * Crowding tag is a constraint on a neighbor list produced by nearest neighbor search requiring that no more than some value k' of the k neighbors returned have the same value of crowding_attribute. @@ -6220,6 +6312,19 @@ export namespace aiplatform_v1beta1 { */ namespace?: string | null; } + /** + * Feature embedding vector for sparse index. An array of numbers whose values are located in the specified dimensions. + */ + export interface Schema$GoogleCloudAiplatformV1beta1IndexDatapointSparseEmbedding { + /** + * Optional. The list of indexes for the embedding values of the sparse vector. + */ + dimensions?: string[] | null; + /** + * Optional. The list of embedding values of the sparse vector. + */ + values?: number[] | null; + } /** * Indexes are deployed into it. An IndexEndpoint can have multiple DeployedIndexes. */ @@ -6306,6 +6411,10 @@ export namespace aiplatform_v1beta1 { * Output only. The number of shards in the Index. */ shardsCount?: number | null; + /** + * Output only. The number of sparse vectors in the Index. + */ + sparseVectorsCount?: string | null; /** * Output only. The number of dense vectors in the Index. */ @@ -6959,6 +7068,32 @@ export namespace aiplatform_v1beta1 { */ publisherModels?: Schema$GoogleCloudAiplatformV1beta1PublisherModel[]; } + /** + * Response message for VertexRagDataService.ListRagCorpora. + */ + export interface Schema$GoogleCloudAiplatformV1beta1ListRagCorporaResponse { + /** + * A token to retrieve the next page of results. Pass to ListRagCorporaRequest.page_token to obtain that page. + */ + nextPageToken?: string | null; + /** + * List of RagCorpora in the requested page. + */ + ragCorpora?: Schema$GoogleCloudAiplatformV1beta1RagCorpus[]; + } + /** + * Response message for VertexRagDataService.ListRagFiles. + */ + export interface Schema$GoogleCloudAiplatformV1beta1ListRagFilesResponse { + /** + * A token to retrieve the next page of results. Pass to ListRagFilesRequest.page_token to obtain that page. + */ + nextPageToken?: string | null; + /** + * List of RagFiles in the requested page. + */ + ragFiles?: Schema$GoogleCloudAiplatformV1beta1RagFile[]; + } /** * Response message for ReasoningEngineService.ListReasoningEngines */ @@ -9578,7 +9713,7 @@ export namespace aiplatform_v1beta1 { */ machineSpec?: Schema$GoogleCloudAiplatformV1beta1MachineSpec; /** - * Output only. The resource name of the NotebookRuntimeTemplate. + * The resource name of the NotebookRuntimeTemplate. */ name?: string | null; /** @@ -11057,6 +11192,128 @@ export namespace aiplatform_v1beta1 { */ version?: number | null; } + /** + * Relevant contexts for one query. + */ + export interface Schema$GoogleCloudAiplatformV1beta1RagContexts { + /** + * All its contexts. + */ + contexts?: Schema$GoogleCloudAiplatformV1beta1RagContextsContext[]; + } + /** + * A context of the query. + */ + export interface Schema$GoogleCloudAiplatformV1beta1RagContextsContext { + /** + * The distance between the query vector and the context text vector. + */ + distance?: number | null; + /** + * For vertex RagStore, if the file is imported from Cloud Storage or Google Drive, source_uri will be original file URI in Cloud Storage or Google Drive; if file is uploaded, source_uri will be file display name. + */ + sourceUri?: string | null; + /** + * The text chunk. + */ + text?: string | null; + } + /** + * A RagCorpus is a RagFile container and a project can have multiple RagCorpora. + */ + export interface Schema$GoogleCloudAiplatformV1beta1RagCorpus { + /** + * Output only. Timestamp when this RagCorpus was created. + */ + createTime?: string | null; + /** + * Optional. The description of the RagCorpus. + */ + description?: string | null; + /** + * Required. The display name of the RagCorpus. The name can be up to 128 characters long and can consist of any UTF-8 characters. + */ + displayName?: string | null; + /** + * Output only. The resource name of the RagCorpus. + */ + name?: string | null; + /** + * Output only. Timestamp when this RagCorpus was last updated. + */ + updateTime?: string | null; + } + /** + * A RagFile contains user data for chunking, embedding and indexing. + */ + export interface Schema$GoogleCloudAiplatformV1beta1RagFile { + /** + * Output only. Timestamp when this RagFile was created. + */ + createTime?: string | null; + /** + * Optional. The description of the RagFile. + */ + description?: string | null; + /** + * Output only. The RagFile is encapsulated and uploaded in the UploadRagFile request. + */ + directUploadSource?: Schema$GoogleCloudAiplatformV1beta1DirectUploadSource; + /** + * Required. The display name of the RagFile. The name can be up to 128 characters long and can consist of any UTF-8 characters. + */ + displayName?: string | null; + /** + * Output only. Google Cloud Storage location of the RagFile. It does not support wildcards in the Cloud Storage uri for now. + */ + gcsSource?: Schema$GoogleCloudAiplatformV1beta1GcsSource; + /** + * Output only. Google Drive location. Supports importing individual files as well as Google Drive folders. + */ + googleDriveSource?: Schema$GoogleCloudAiplatformV1beta1GoogleDriveSource; + /** + * Output only. The resource name of the RagFile. + */ + name?: string | null; + /** + * Output only. The type of the RagFile. + */ + ragFileType?: string | null; + /** + * Output only. The size of the RagFile in bytes. + */ + sizeBytes?: string | null; + /** + * Output only. Timestamp when this RagFile was last updated. + */ + updateTime?: string | null; + } + /** + * Specifies the size and overlap of chunks for RagFiles. + */ + export interface Schema$GoogleCloudAiplatformV1beta1RagFileChunkingConfig { + /** + * The overlap between chunks. + */ + chunkOverlap?: number | null; + /** + * The size of the chunks. + */ + chunkSize?: number | null; + } + /** + * A query to retrieve relevant contexts. + */ + export interface Schema$GoogleCloudAiplatformV1beta1RagQuery { + /** + * Optional. The number of contexts to retrieve. + */ + similarityTopK?: number | null; + /** + * Optional. The query in text format to get relevant contexts. + */ + text?: string | null; + } /** * Request message for PredictionService.RawPredict. */ @@ -11535,6 +11792,58 @@ export namespace aiplatform_v1beta1 { */ vertexRagStore?: Schema$GoogleCloudAiplatformV1beta1VertexRagStore; } + /** + * Request message for VertexRagService.RetrieveContexts. + */ + export interface Schema$GoogleCloudAiplatformV1beta1RetrieveContextsRequest { + /** + * Required. Single RAG retrieve query. + */ + query?: Schema$GoogleCloudAiplatformV1beta1RagQuery; + /** + * The data source for Vertex RagStore. + */ + vertexRagStore?: Schema$GoogleCloudAiplatformV1beta1RetrieveContextsRequestVertexRagStore; + } + /** + * The data source for Vertex RagStore. + */ + export interface Schema$GoogleCloudAiplatformV1beta1RetrieveContextsRequestVertexRagStore { + /** + * Optional. Deprecated. Please use rag_resources to specify the data source. + */ + ragCorpora?: string[] | null; + /** + * Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + */ + ragResources?: Schema$GoogleCloudAiplatformV1beta1RetrieveContextsRequestVertexRagStoreRagResource[]; + /** + * Optional. Only return contexts with vector distance smaller than the threshold. + */ + vectorDistanceThreshold?: number | null; + } + /** + * The definition of the Rag resource. + */ + export interface Schema$GoogleCloudAiplatformV1beta1RetrieveContextsRequestVertexRagStoreRagResource { + /** + * Optional. RagCorpora resource name. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}` + */ + ragCorpus?: string | null; + /** + * Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + */ + ragFileIds?: string[] | null; + } + /** + * Response message for VertexRagService.RetrieveContexts. + */ + export interface Schema$GoogleCloudAiplatformV1beta1RetrieveContextsResponse { + /** + * The contexts of the query. + */ + contexts?: Schema$GoogleCloudAiplatformV1beta1RagContexts; + } /** * Input for rouge metric. */ @@ -11625,7 +11934,11 @@ export namespace aiplatform_v1beta1 { } export interface Schema$GoogleCloudAiplatformV1beta1RuntimeConfigVertexAISearchRuntimeConfig { /** - * Required. Vertext AI Search serving config name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config\}` + * Vertex AI Search App ID. This is used to construct the search request. By setting this app_id, API will construct the serving config which is required to call search API for the user. The app_id and serving_config_name cannot both be empty at the same time. + */ + appId?: string | null; + /** + * [Deprecated] Please use app_id instead. Vertex AI Search serving config name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config\}` */ servingConfigName?: string | null; } @@ -11837,6 +12150,10 @@ export namespace aiplatform_v1beta1 { * Request for ModelMonitoringService.CreateModelMonitoringJob. */ createModelMonitoringJobRequest?: Schema$GoogleCloudAiplatformV1beta1CreateModelMonitoringJobRequest; + /** + * Request for NotebookService.CreateNotebookExecutionJob. + */ + createNotebookExecutionJobRequest?: Schema$GoogleCloudAiplatformV1beta1CreateNotebookExecutionJobRequest; /** * Request for PipelineService.CreatePipelineJob. CreatePipelineJobRequest.parent field is required (format: projects/{project\}/locations/{location\}). */ @@ -16680,6 +16997,41 @@ export namespace aiplatform_v1beta1 { */ modelVersionId?: string | null; } + /** + * Config for uploading RagFile. + */ + export interface Schema$GoogleCloudAiplatformV1beta1UploadRagFileConfig { + /** + * Specifies the size and overlap of chunks after uploading RagFile. + */ + ragFileChunkingConfig?: Schema$GoogleCloudAiplatformV1beta1RagFileChunkingConfig; + } + /** + * Request message for VertexRagDataService.UploadRagFile. + */ + export interface Schema$GoogleCloudAiplatformV1beta1UploadRagFileRequest { + /** + * Required. The RagFile to upload. + */ + ragFile?: Schema$GoogleCloudAiplatformV1beta1RagFile; + /** + * Required. The config for the RagFiles to be uploaded into the RagCorpus. VertexRagDataService.UploadRagFile. + */ + uploadRagFileConfig?: Schema$GoogleCloudAiplatformV1beta1UploadRagFileConfig; + } + /** + * Response message for VertexRagDataService.UploadRagFile. + */ + export interface Schema$GoogleCloudAiplatformV1beta1UploadRagFileResponse { + /** + * The error that occurred while processing the RagFile. + */ + error?: Schema$GoogleRpcStatus; + /** + * The RagFile that had been uploaded into the RagCorpus. + */ + ragFile?: Schema$GoogleCloudAiplatformV1beta1RagFile; + } /** * Request message for IndexService.UpsertDatapoints */ @@ -16745,9 +17097,13 @@ export namespace aiplatform_v1beta1 { */ export interface Schema$GoogleCloudAiplatformV1beta1VertexRagStore { /** - * Required. Vertex RAG Store corpus resource name: `projects/{project\}/locations/{location\}/ragCorpora/{ragCorpus\}` Currently only one corpus is allowed. In the future we may open up multiple corpora support. However, they should be from the same project and location. + * Optional. Deprecated. Please use rag_resources instead. */ ragCorpora?: string[] | null; + /** + * Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + */ + ragResources?: Schema$GoogleCloudAiplatformV1beta1VertexRagStoreRagResource[]; /** * Optional. Number of top k results to return from the selected corpora. */ @@ -16757,6 +17113,19 @@ export namespace aiplatform_v1beta1 { */ vectorDistanceThreshold?: number | null; } + /** + * The definition of the Rag resource. + */ + export interface Schema$GoogleCloudAiplatformV1beta1VertexRagStoreRagResource { + /** + * Optional. RagCorpora resource name. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}` + */ + ragCorpus?: string | null; + /** + * Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + */ + ragFileIds?: string[] | null; + } /** * Metadata describes the input video content. */ @@ -17969,10 +18338,15 @@ export namespace aiplatform_v1beta1 { */ totalContentSize?: string | null; } + export interface Schema$LearningServingLlmAtlasOutputMetadata { + requestTopic?: string | null; + source?: string | null; + } /** - * LINT.IfChange This metadata contains additional information required for debugging. + * LINT.IfChange This metadata contains additional information required for debugging. Next ID: 28 */ export interface Schema$LearningServingLlmMessageMetadata { + atlasMetadata?: Schema$LearningServingLlmAtlasOutputMetadata; /** * Summary of classifier output. We attach this to all messages regardless of whether classification rules triggered or not. */ @@ -18024,9 +18398,13 @@ export namespace aiplatform_v1beta1 { */ originalText?: string | null; /** - * NOT YET IMPLEMENTED. Applies to streaming only. Number of tokens decoded / emitted by the model as part of this stream. This may be different from token_count, which contains number of tokens returned in this response after any response rewriting / truncation. + * Number of tokens decoded by the model as part of a stream. This count may be different from `per_stream_returned_token_count` which, is counted after any response rewriting or truncation. Applies to streaming response only. */ perStreamDecodedTokenCount?: number | null; + /** + * Number of tokens returned per stream in a response candidate after any response rewriting or truncation. Applies to streaming response only. Applies to Gemini models only. + */ + perStreamReturnedTokenCount?: number | null; /** * Results of running RAI on the query or this response candidate. One output per rai_config. It will be populated regardless of whether the threshold is exceeded or not. */ @@ -18036,7 +18414,7 @@ export namespace aiplatform_v1beta1 { */ recitationResult?: Schema$LearningGenaiRecitationRecitationResult; /** - * NOT YET IMPLEMENTED. Number of tokens returned as part of this candidate. + * NOT IMPLEMENTED TODO (b/334187574) Remove this field after Labs migrates to per_stream_returned_token_count and total_returned_token_count. */ returnTokenCount?: number | null; /** @@ -18051,6 +18429,10 @@ export namespace aiplatform_v1beta1 { * Total tokens decoded so far per response_candidate. For streaming: Count of all the tokens decoded so far (aggregated count). For unary: Count of all the tokens decoded per response_candidate. */ totalDecodedTokenCount?: number | null; + /** + * Total number of tokens returned in a response candidate. For streaming, it is the aggregated count (i.e. total so far) Applies to Gemini models only. + */ + totalReturnedTokenCount?: number | null; /** * Translated user-prompt used for RAI post processing. This is for internal processing only. We will translate in pre-processor and pass the translated text to the post processor using this field. It will be empty if non of the signals requested need translation. */ @@ -18145,6 +18527,139 @@ export namespace aiplatform_v1beta1 { space?: string | null; } + export class Resource$Media { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Upload a file into a RagCorpus. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + upload( + params: Params$Resource$Media$Upload, + options: StreamMethodOptions + ): GaxiosPromise; + upload( + params?: Params$Resource$Media$Upload, + options?: MethodOptions + ): GaxiosPromise; + upload( + params: Params$Resource$Media$Upload, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + upload( + params: Params$Resource$Media$Upload, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + upload( + params: Params$Resource$Media$Upload, + callback: BodyResponseCallback + ): void; + upload( + callback: BodyResponseCallback + ): void; + upload( + paramsOrCallback?: + | Params$Resource$Media$Upload + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Media$Upload; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Media$Upload; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/ragFiles:upload').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + mediaUrl: ( + rootUrl + '/upload/v1beta1/{+parent}/ragFiles:upload' + ).replace(/([^:]\/)\/+/g, '$1'), + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Media$Upload extends StandardParameters { + /** + * Required. The name of the RagCorpus resource into which to upload the file. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1UploadRagFileRequest; + + /** + * Media metadata + */ + media?: { + /** + * Media mime-type + */ + mimeType?: string; + + /** + * Media body contents + */ + body?: any; + }; + } + export class Resource$Projects { context: APIRequestContext; locations: Resource$Projects$Locations; @@ -18782,6 +19297,103 @@ export namespace aiplatform_v1beta1 { ); } } + + /** + * Retrieves relevant contexts for a query. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + retrieveContexts( + params: Params$Resource$Projects$Locations$Retrievecontexts, + options: StreamMethodOptions + ): GaxiosPromise; + retrieveContexts( + params?: Params$Resource$Projects$Locations$Retrievecontexts, + options?: MethodOptions + ): GaxiosPromise; + retrieveContexts( + params: Params$Resource$Projects$Locations$Retrievecontexts, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + retrieveContexts( + params: Params$Resource$Projects$Locations$Retrievecontexts, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + retrieveContexts( + params: Params$Resource$Projects$Locations$Retrievecontexts, + callback: BodyResponseCallback + ): void; + retrieveContexts( + callback: BodyResponseCallback + ): void; + retrieveContexts( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Retrievecontexts + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Retrievecontexts; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Retrievecontexts; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}:retrieveContexts').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } } export interface Params$Resource$Projects$Locations$Evaluateinstances @@ -18822,6 +19434,18 @@ export namespace aiplatform_v1beta1 { */ pageToken?: string; } + export interface Params$Resource$Projects$Locations$Retrievecontexts + extends StandardParameters { + /** + * Required. The resource name of the Location from which to retrieve RagContexts. The users must have permission to make a call in the project. Format: `projects/{project\}/locations/{location\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1RetrieveContextsRequest; + } export class Resource$Projects$Locations$Agents { context: APIRequestContext; @@ -68486,6 +69110,430 @@ export namespace aiplatform_v1beta1 { this.context ); } + + /** + * Creates a RagCorpus. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Ragcorpora$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Ragcorpora$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Ragcorpora$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Ragcorpora$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Ragcorpora$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Ragcorpora$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Ragcorpora$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Ragcorpora$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/ragCorpora').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a RagCorpus. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Ragcorpora$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Ragcorpora$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Ragcorpora$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Ragcorpora$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Ragcorpora$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Ragcorpora$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Ragcorpora$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Ragcorpora$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a RagCorpus. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Ragcorpora$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Ragcorpora$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Ragcorpora$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Ragcorpora$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Ragcorpora$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Ragcorpora$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Ragcorpora$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Ragcorpora$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Lists RagCorpora in a Location. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Ragcorpora$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Ragcorpora$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Ragcorpora$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Ragcorpora$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Ragcorpora$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Ragcorpora$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Ragcorpora$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Ragcorpora$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/ragCorpora').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Ragcorpora$Create + extends StandardParameters { + /** + * Required. The resource name of the Location to create the RagCorpus in. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1RagCorpus; + } + export interface Params$Resource$Projects$Locations$Ragcorpora$Delete + extends StandardParameters { + /** + * Optional. If set to true, any RagFiles in this RagCorpus will also be deleted. Otherwise, the request will only work if the RagCorpus has no RagFiles. + */ + force?: boolean; + /** + * Required. The name of the RagCorpus resource to be deleted. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Ragcorpora$Get + extends StandardParameters { + /** + * Required. The name of the RagCorpus resource. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Ragcorpora$List + extends StandardParameters { + /** + * Optional. The standard list page size. + */ + pageSize?: number; + /** + * Optional. The standard list page token. Typically obtained via ListRagCorporaResponse.next_page_token of the previous VertexRagDataService.ListRagCorpora call. + */ + pageToken?: string; + /** + * Required. The resource name of the Location from which to list the RagCorpora. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; } export class Resource$Projects$Locations$Ragcorpora$Operations { @@ -69025,6 +70073,430 @@ export namespace aiplatform_v1beta1 { this.context ); } + + /** + * Deletes a RagFile. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a RagFile. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Import files from Google Cloud Storage or Google Drive into a RagCorpus. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + import( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import, + options: StreamMethodOptions + ): GaxiosPromise; + import( + params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import, + options?: MethodOptions + ): GaxiosPromise; + import( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + import( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + import( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import, + callback: BodyResponseCallback + ): void; + import( + callback: BodyResponseCallback + ): void; + import( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/ragFiles:import').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists RagFiles in a RagCorpus. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/ragFiles').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Delete + extends StandardParameters { + /** + * Required. The name of the RagFile resource to be deleted. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}/ragFiles/{rag_file\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get + extends StandardParameters { + /** + * Required. The name of the RagFile resource. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}/ragFiles/{rag_file\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import + extends StandardParameters { + /** + * Required. The name of the RagCorpus resource into which to import files. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1ImportRagFilesRequest; + } + export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List + extends StandardParameters { + /** + * Optional. The standard list page size. + */ + pageSize?: number; + /** + * Optional. The standard list page token. Typically obtained via ListRagFilesResponse.next_page_token of the previous VertexRagDataService.ListRagFiles call. + */ + pageToken?: string; + /** + * Required. The resource name of the RagCorpus from which to list the RagFiles. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}` + */ + parent?: string; } export class Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations {