@maxim_mazurok/gapi.client.aiplatform-v1 0.0.20240424 → 0.0.20240501

package/index.d.ts

@@ -9,7 +9,7 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 // Generated from: https://aiplatform.googleapis.com/$discovery/rest?version=v1
-// Revision: 20240424
+// Revision: 20240501
 
 /// <reference types="gapi.client" />
 
@@ -2164,6 +2164,12 @@ declare namespace gapi.client {
       neighborCount?: number;
       /** 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;
+      /** Optional. Represents RRF algorithm that combines search results. */
+      rrf?: GoogleCloudAiplatformV1FindNeighborsRequestQueryRRF;
+    }
+    interface 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;
     }
     interface GoogleCloudAiplatformV1FindNeighborsResponse {
       /** The nearest neighbors of the query datapoints. */
@@ -2178,8 +2184,10 @@ declare namespace gapi.client {
     interface GoogleCloudAiplatformV1FindNeighborsResponseNeighbor {
       /** The datapoint of the neighbor. Note that full datapoints are returned only when "return_full_datapoint" is set to true. Otherwise, only the "datapoint_id" and "crowding_tag" fields are populated. */
       datapoint?: GoogleCloudAiplatformV1IndexDatapoint;
-      /** The distance between the neighbor and the query vector. */
+      /** The distance between the neighbor and the dense embedding query. */
       distance?: number;
+      /** The distance between the neighbor and the query sparse_embedding. */
+      sparseDistance?: number;
     }
     interface GoogleCloudAiplatformV1FractionSplit {
       /** The fraction of the input data that is to be used to evaluate the Model. */
@@ -2285,6 +2293,8 @@ declare namespace gapi.client {
       baseModelUri?: string;
     }
     interface GoogleCloudAiplatformV1GroundingMetadata {
+      /** Optional. Google search entry for the following-up web searches. */
+      searchEntryPoint?: GoogleCloudAiplatformV1SearchEntryPoint;
       /** Optional. Web search queries for the following-up web search. */
       webSearchQueries?: string[];
     }
@@ -2433,12 +2443,14 @@ declare namespace gapi.client {
       crowdingTag?: GoogleCloudAiplatformV1IndexDatapointCrowdingTag;
       /** Required. Unique identifier of the datapoint. */
       datapointId?: string;
-      /** Required. Feature embedding vector. An array of numbers with the length of [NearestNeighborSearchConfig.dimensions]. */
+      /** Required. Feature embedding vector for dense index. An array of numbers with the length of [NearestNeighborSearchConfig.dimensions]. */
       featureVector?: number[];
       /** 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 numeric comparisons. */
       numericRestricts?: GoogleCloudAiplatformV1IndexDatapointNumericRestriction[];
       /** 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?: GoogleCloudAiplatformV1IndexDatapointRestriction[];
+      /** Optional. Feature embedding vector for sparse index. */
+      sparseEmbedding?: GoogleCloudAiplatformV1IndexDatapointSparseEmbedding;
     }
     interface GoogleCloudAiplatformV1IndexDatapointCrowdingTag {
       /** The attribute value used for crowding. The maximum number of neighbors to return per crowding attribute value (per_crowding_attribute_num_neighbors) is configured per-query. This field is ignored if per_crowding_attribute_num_neighbors is larger than the total number of neighbors to return for a given query. */
@@ -2464,6 +2476,12 @@ declare namespace gapi.client {
       /** The namespace of this restriction. e.g.: color. */
       namespace?: string;
     }
+    interface GoogleCloudAiplatformV1IndexDatapointSparseEmbedding {
+      /** Optional. The list of indexes for the embedding values of the sparse vector. */
+      dimensions?: string[];
+      /** Optional. The list of embedding values of the sparse vector. */
+      values?: number[];
+    }
     interface GoogleCloudAiplatformV1IndexEndpoint {
       /** Output only. Timestamp when this IndexEndpoint was created. */
       createTime?: string;
@@ -2505,7 +2523,9 @@ declare namespace gapi.client {
     interface GoogleCloudAiplatformV1IndexStats {
       /** Output only. The number of shards in the Index. */
       shardsCount?: number;
-      /** Output only. The number of vectors in the Index. */
+      /** Output only. The number of sparse vectors in the Index. */
+      sparseVectorsCount?: string;
+      /** Output only. The number of dense vectors in the Index. */
       vectorsCount?: string;
     }
     interface GoogleCloudAiplatformV1InputDataConfig {
@@ -3679,7 +3699,7 @@ declare namespace gapi.client {
       labels?: {[P in string]: string};
       /** Optional. Immutable. The specification of a single machine for the template. */
       machineSpec?: GoogleCloudAiplatformV1MachineSpec;
-      /** Output only. The resource name of the NotebookRuntimeTemplate. */
+      /** The resource name of the NotebookRuntimeTemplate. */
       name?: string;
       /** Optional. Network spec. */
       networkSpec?: GoogleCloudAiplatformV1NetworkSpec;
@@ -4001,6 +4021,8 @@ declare namespace gapi.client {
       deploy?: GoogleCloudAiplatformV1PublisherModelCallToActionDeploy;
       /** Optional. Deploy PublisherModel to Google Kubernetes Engine. */
       deployGke?: GoogleCloudAiplatformV1PublisherModelCallToActionDeployGke;
+      /** Optional. Fine tune the PublisherModel with the third-party model tuning UI. */
+      fineTune?: GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences;
       /** Optional. Open evaluation pipeline of the PublisherModel. */
       openEvaluationPipeline?: GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences;
       /** Optional. Open fine-tuning pipeline of the PublisherModel. */
@@ -4031,6 +4053,8 @@ declare namespace gapi.client {
       containerSpec?: GoogleCloudAiplatformV1ModelContainerSpec;
       /** A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. */
       dedicatedResources?: GoogleCloudAiplatformV1DedicatedResources;
+      /** Optional. The name of the deploy task (e.g., "text to image generation"). */
+      deployTaskName?: string;
       /** Optional. Large model reference. When this is set, model_artifact_spec is not needed. */
       largeModelReference?: GoogleCloudAiplatformV1LargeModelReference;
       /** Optional. Default model display name. */
@@ -5145,6 +5169,8 @@ declare namespace gapi.client {
       promptType?: string;
       /** Customized stop sequences. */
       stopSequences?: string[];
+      /** The Google Cloud Storage URI that stores the system instruction, starting with gs://. */
+      systemInstructionGcsUri?: string;
       /** Temperature value used for sampling set when the dataset was saved. This value is used to tune the degree of randomness. */
       temperature?: number;
       /** The content of the prompt dataset. */
@@ -5775,6 +5801,12 @@ declare namespace gapi.client {
       /** A token to retrieve next page of results. Pass to SearchDataItemsRequest.page_token to obtain that page. */
       nextPageToken?: string;
     }
+    interface GoogleCloudAiplatformV1SearchEntryPoint {
+      /** Optional. Web content snippet that can be embedded in a web page or an app webview. */
+      renderedContent?: string;
+      /** Optional. Base64 encoded JSON representing array of tuple. */
+      sdkBlob?: string;
+    }
     interface GoogleCloudAiplatformV1SearchFeaturesResponse {
       /** The Features matching the request. Fields returned: * `name` * `description` * `labels` * `create_time` * `update_time` */
       features?: GoogleCloudAiplatformV1Feature[];
@@ -6093,9 +6125,9 @@ declare namespace gapi.client {
     interface GoogleCloudAiplatformV1SupervisedHyperParameters {
       /** Optional. Adapter size for tuning. */
       adapterSize?: string;
-      /** 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;
-      /** Optional. Learning rate multiplier for tuning. */
+      /** Optional. Multiplier for adjusting the default learning rate. */
       learningRateMultiplier?: number;
     }
     interface GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution {
@@ -6145,9 +6177,9 @@ declare namespace gapi.client {
     interface GoogleCloudAiplatformV1SupervisedTuningSpec {
       /** Optional. Hyperparameters for SFT. */
       hyperParameters?: 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;
-      /** 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;
     }
     interface GoogleCloudAiplatformV1SyncFeatureViewRequest {}
@@ -6428,7 +6460,7 @@ declare namespace gapi.client {
       supervisedTuningDataStats?: GoogleCloudAiplatformV1SupervisedTuningDataStats;
     }
     interface 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;
       /** Output only. Time when the TuningJob was created. */
       createTime?: string;
@@ -6835,11 +6867,10 @@ declare namespace gapi.client {
       trainingSegmentResults?: LanguageLabsAidaTrustRecitationProtoSegmentResult[];
     }
     interface LanguageLabsAidaTrustRecitationProtoSegmentResult {
-      /** The dataset the segment came from. */
+      /** The dataset the segment came from. Datasets change often as model evolves. Treat this field as informational only and avoid depending on it directly. */
       attributionDataset?: string;
       /** human-friendly string that contains information from doc_attribution which could be shown by clients */
       displayAttributionMessage?: string;
-      /** populated when recitation_action == CITE */
       docAttribution?: LanguageLabsAidaTrustRecitationProtoDocAttribution;
       /** number of documents that contained this segment */
       docOccurrences?: number;
@@ -6847,6 +6878,8 @@ declare namespace gapi.client {
       /** The raw text in the given input that is corresponding to the segment. It will be available only when 'return_segment_raw_text' is enabled in the request options. */
       rawText?: string;
       segmentRecitationAction?: string;
+      /** The category of the source dataset where the segment came from. This is more stable than Dataset. */
+      sourceCategory?: string;
       /** The segment boundary start (inclusive) and end index (exclusive) in the given text. In the streaming RPC, the indexes always start from the beginning of the first text in the entire stream. The indexes are measured in UTF-16 code units. */
       startIndex?: number;
     }
@@ -6908,11 +6941,10 @@ declare namespace gapi.client {
       trainingSegmentResults?: LearningGenaiRecitationSegmentResult[];
     }
     interface LearningGenaiRecitationSegmentResult {
-      /** The dataset the segment came from. */
+      /** The dataset the segment came from. Datasets change often as model evolves. Treat this field as informational only and avoid depending on it directly. */
       attributionDataset?: string;
       /** human-friendly string that contains information from doc_attribution which could be shown by clients */
       displayAttributionMessage?: string;
-      /** populated when recitation_action == CITE */
       docAttribution?: LearningGenaiRecitationDocAttribution;
       /** number of documents that contained this segment */
       docOccurrences?: number;
@@ -6920,6 +6952,8 @@ declare namespace gapi.client {
       /** The raw text in the given input that is corresponding to the segment. It will be available only when 'return_segment_raw_text' is enabled in the request options. */
       rawText?: string;
       segmentRecitationAction?: string;
+      /** The category of the source dataset where the segment came from. This is more stable than Dataset. */
+      sourceCategory?: string;
       /** The segment boundary start (inclusive) and end index (exclusive) in the given text. In the streaming RPC, the indexes always start from the beginning of the first text in the entire stream. The indexes are measured in UTF-16 code units. */
       startIndex?: number;
     }
@@ -7251,7 +7285,12 @@ declare namespace gapi.client {
       /** The sum of the size of all the contents in the request. */
       totalContentSize?: string;
     }
+    interface LearningServingLlmAtlasOutputMetadata {
+      requestTopic?: string;
+      source?: string;
+    }
     interface LearningServingLlmMessageMetadata {
+      atlasMetadata?: LearningServingLlmAtlasOutputMetadata;
       /** Summary of classifier output. We attach this to all messages regardless of whether classification rules triggered or not. */
       classifierSummary?: LearningGenaiRootClassifierOutputSummary;
       /** Contains metadata related to Codey Processors. */
@@ -7278,20 +7317,24 @@ declare namespace gapi.client {
       lmPrefix?: string;
       /** The original text generated by LLM. This is the raw output for debugging purposes. */
       originalText?: string;
-      /** 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;
+      /** 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;
       /** 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. */
       raiOutputs?: LearningGenaiRootRAIOutput[];
       /** Recitation Results. It will be populated as long as Recitation processing is enabled, regardless of recitation outcome. */
       recitationResult?: 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;
       /** All the different scores for a message are logged here. */
       scores?: LearningGenaiRootScore[];
       /** Whether the response is terminated during streaming return. Only used for streaming requests. */
       streamTerminated?: boolean;
-      /** NOT YET IMPLEMENTED. Aggregated number of total tokens decoded so far. For streaming, this is sum of all the tokens decoded so far i.e. aggregated count. */
+      /** 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;
+      /** 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;
       /** 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. */
       translatedUserPrompts?: string[];
       /** The metadata from Vertex SafetyCat processors */
@@ -11704,7 +11747,7 @@ declare namespace gapi.client {
         key?: string;
         /** OAuth 2.0 token for the current user. */
         oauth_token?: string;
-        /** Required. The resource name of the Location to create FeatureGroups. Format: `projects/{project}/locations/{location}'` */
+        /** Required. The resource name of the Location to create FeatureGroups. Format: `projects/{project}/locations/{location}` */
         parent: string;
         /** Returns response with indentations and line breaks. */
         prettyPrint?: boolean;
@@ -11735,7 +11778,7 @@ declare namespace gapi.client {
           key?: string;
           /** OAuth 2.0 token for the current user. */
           oauth_token?: string;
-          /** Required. The resource name of the Location to create FeatureGroups. Format: `projects/{project}/locations/{location}'` */
+          /** Required. The resource name of the Location to create FeatureGroups. Format: `projects/{project}/locations/{location}` */
           parent: string;
           /** Returns response with indentations and line breaks. */
           prettyPrint?: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.aiplatform-v1",
-  "version": "0.0.20240424",
+  "version": "0.0.20240501",
   "description": "TypeScript typings for Vertex AI API v1",
   "repository": {
     "type": "git",