@maxim_mazurok/gapi.client.aiplatform-v1 0.0.20240429 → 0.0.20240507

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: 20240429
+// Revision: 20240507
 
 /// <reference types="gapi.client" />
 
@@ -158,6 +158,8 @@ declare namespace gapi.client {
       citations?: CloudAiNlLlmProtoServiceCitation[];
     }
     interface CloudAiNlLlmProtoServiceContent {
+      /** If true, the content is from a cached content. */
+      isCached?: boolean;
       /** The parts of the message. */
       parts?: CloudAiNlLlmProtoServicePart[];
       /** The role of the current conversation participant. */
@@ -276,6 +278,8 @@ declare namespace gapi.client {
       filtered?: boolean;
       /** Language filter result from SAFT LangId. */
       languageFilterResult?: LearningGenaiRootLanguageFilterResult;
+      /** Multi modal recitation results. It will be populated as long as Multi modal Recitation processor is invoked. */
+      mmRecitationResult?: LearningGenaiRecitationMMRecitationCheckResult;
       /** The RAI signals for the text. */
       raiSignals?: CloudAiNlLlmProtoServiceRaiSignal[];
       /** Translation request info during RAI for debugging purpose. Each TranslationRequestInfo corresponds to a request sent to the translation server. */
@@ -1132,6 +1136,8 @@ declare namespace gapi.client {
       metadataArtifact?: string;
       /** Required. Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/. */
       metadataSchemaUri?: string;
+      /** Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets. */
+      modelReference?: string;
       /** Output only. The resource name of the Dataset. */
       name?: string;
       /** All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec. */
@@ -1150,6 +1156,8 @@ declare namespace gapi.client {
       etag?: string;
       /** Required. Output only. Additional information about the DatasetVersion. */
       metadata?: any;
+      /** Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions. */
+      modelReference?: string;
       /** Output only. The resource name of the DatasetVersion. */
       name?: string;
       /** Output only. Timestamp when this DatasetVersion was last updated. */
@@ -1822,7 +1830,7 @@ declare namespace gapi.client {
       versionColumnName?: string;
     }
     interface GoogleCloudAiplatformV1FeatureGroup {
-      /** Indicates that features for this group come from BigQuery Table/View. By default treats the source as a sparse time series source, which is required to have an entity_id and a feature_timestamp column in the source. */
+      /** Indicates that features for this group come from BigQuery Table/View. By default treats the source as a sparse time series source. The BigQuery source table or view must have at least one entity ID column and a column named `feature_timestamp`. */
       bigQuery?: GoogleCloudAiplatformV1FeatureGroupBigQuery;
       /** Output only. Timestamp when this FeatureGroup was created. */
       createTime?: string;
@@ -2263,6 +2271,8 @@ declare namespace gapi.client {
       presencePenalty?: number;
       /** Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. */
       responseMimeType?: string;
+      /** Optional. Control Three levels of creativity in the model output. Default: RESPONSE_STYLE_BALANCED */
+      responseStyle?: string;
       /** Optional. Stop sequences. */
       stopSequences?: string[];
       /** Optional. Controls the randomness of predictions. */
@@ -3553,12 +3563,16 @@ declare namespace gapi.client {
     interface GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataContentValidationStats {
       /** Number of records in this file we skipped due to validate errors. */
       invalidRecordCount?: string;
+      /** Number of sparse records in this file we skipped due to validate errors. */
+      invalidSparseRecordCount?: string;
       /** The detail information of the partial failures encountered for those invalid records that couldn't be parsed. Up to 50 partial errors will be reported. */
       partialErrors?: GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataRecordError[];
       /** Cloud Storage URI pointing to the original file in user's bucket. */
       sourceGcsUri?: string;
       /** Number of records in this file that were successfully processed. */
       validRecordCount?: string;
+      /** Number of sparse records in this file that were successfully processed. */
+      validSparseRecordCount?: string;
     }
     interface GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataRecordError {
       /** Empty if the embedding id is failed to parse. */
@@ -3653,6 +3667,10 @@ declare namespace gapi.client {
       runtimeState?: string;
       /** Required. The user email of the NotebookRuntime. */
       runtimeUser?: string;
+      /** Output only. Reserved for future use. */
+      satisfiesPzi?: boolean;
+      /** Output only. Reserved for future use. */
+      satisfiesPzs?: boolean;
       /** Output only. The service account that the NotebookRuntime workload runs as. */
       serviceAccount?: string;
       /** Output only. Timestamp when this NotebookRuntime was most recently updated. */
@@ -3681,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;
@@ -6107,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 {
@@ -6159,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 {}
@@ -6442,12 +6460,14 @@ 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;
       /** Optional. The description of the TuningJob. */
       description?: string;
+      /** Customer-managed encryption key options for a TuningJob. If this is set, then all resources created by the TuningJob will be encrypted with the provided encryption key. */
+      encryptionSpec?: GoogleCloudAiplatformV1EncryptionSpec;
       /** Output only. Time when the TuningJob entered any of the following JobStates: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`, `JOB_STATE_EXPIRED`. */
       endTime?: string;
       /** Output only. Only populated when job's state is `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`. */
@@ -6875,6 +6895,10 @@ declare namespace gapi.client {
       /** The recitation result against model training data. */
       trainingSegmentResults?: LanguageLabsAidaTrustRecitationProtoSegmentResult[];
     }
+    interface LearningGenaiRecitationContentChunkRecitationCheckResult {
+      imageResult?: LearningGenaiRecitationImageRecitationCheckResult;
+      textResult?: LearningGenaiRecitationRecitationResult;
+    }
     interface LearningGenaiRecitationDocAttribution {
       amarnaId?: string;
       arxivId?: string;
@@ -6916,6 +6940,33 @@ declare namespace gapi.client {
       wikipediaArticleTitle?: string;
       youtubeVideoId?: string;
     }
+    interface LearningGenaiRecitationImageDocAttribution {
+      /** Unique ID of the image. */
+      datasetName?: string;
+      /** Doc ID to identify the image. These could be urls of images or amarna id. */
+      stringDocids?: string;
+    }
+    interface LearningGenaiRecitationImageRecitationCheckResult {
+      /** Only has NO_ACTION or BLOCK to start with. */
+      recitationAction?: string;
+      /** Images that are similar to the requested image. */
+      recitedImages?: LearningGenaiRecitationImageRecitationCheckResultSimilarImage[];
+    }
+    interface LearningGenaiRecitationImageRecitationCheckResultSimilarImage {
+      /** Attribution information about the image */
+      docAttribution?: LearningGenaiRecitationImageDocAttribution;
+      /** The memorization embedding model that returned this image */
+      embeddingModel?: string;
+      /** Image ID corresponding of the image corresponding to the score. `image_id` serves for debugging purposes and can't be used by clients to retrieve an image. */
+      imageId?: string;
+      /** Similarity score of requested image compared with image in training data. */
+      scores?: number;
+    }
+    interface LearningGenaiRecitationMMRecitationCheckResult {
+      chunkResults?: LearningGenaiRecitationContentChunkRecitationCheckResult[];
+      /** Overall recommended recitation action for the content. */
+      recitationAction?: string;
+    }
     interface LearningGenaiRecitationRecitationResult {
       dynamicSegmentResults?: LearningGenaiRecitationSegmentResult[];
       /** The recitation action for one given input. When its segments contain different actions, the overall action will be returned in the precedence of BLOCK > CITE > NO_ACTION. When the given input is not found in any source, the recitation action will be NO_ACTION. */
@@ -7130,6 +7181,8 @@ declare namespace gapi.client {
       factRetrievalMillisecondsByProvider?: {[P in string]: string};
       /** Latency spent on prompt2query. The procedure generates a search-friendly query given the original prompt. */
       prompt2queryMilliseconds?: string;
+      /** Latency if use GroundedGeneration service for the whole retrieval & augmentation. */
+      retrievalAugmentMilliseconds?: string;
     }
     interface LearningGenaiRootRAIOutput {
       allowed?: boolean;
@@ -7143,6 +7196,42 @@ declare namespace gapi.client {
       /** Regex used to decide that query or response should be taken down. Empty when query or response is kept. */
       takedownRegex?: string;
     }
+    interface LearningGenaiRootRequestMetrics {
+      /** Metrics for audio samples in the request. */
+      audioMetrics?: LearningGenaiRootRequestMetricsAudioMetrics;
+      /** Metrics for image samples in the request. */
+      imageMetrics?: LearningGenaiRootRequestMetricsImageMetrics;
+      /** Number of text tokens extracted from the request. */
+      textTokenCount?: number;
+      /** Total number of tokens in the request. */
+      totalTokenCount?: number;
+      /** Metrics for video samples in the request. */
+      videoMetrics?: LearningGenaiRootRequestMetricsVideoMetrics;
+    }
+    interface LearningGenaiRootRequestMetricsAudioMetrics {
+      /** Duration of the audio sample in seconds. */
+      audioDuration?: string;
+      /** Number of tokens derived directly from audio data. */
+      audioTokenCount?: number;
+      /** Number of audio frames in the audio. */
+      numAudioFrames?: number;
+    }
+    interface LearningGenaiRootRequestMetricsImageMetrics {
+      /** Number of tokens extracted from image bytes. */
+      imageTokenCount?: number;
+      /** Number of images in the request. */
+      numImages?: number;
+    }
+    interface LearningGenaiRootRequestMetricsVideoMetrics {
+      /** Metrics associated with audio sample in the video. */
+      audioSample?: LearningGenaiRootRequestMetricsAudioMetrics;
+      /** Number of video frames in the video. */
+      numVideoFrames?: number;
+      /** Duration of the video sample in seconds. */
+      videoDuration?: string;
+      /** Number of tokens extracted from video frames. */
+      videoFramesTokenCount?: number;
+    }
     interface LearningGenaiRootRequestResponseTakedownResult {
       /** False when response has to be taken down per above config. */
       allowed?: boolean;
@@ -7267,7 +7356,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. */
@@ -7292,22 +7386,30 @@ declare namespace gapi.client {
       language?: string;
       /** The LM prefix used to generate this response. */
       lmPrefix?: string;
+      /** FOR LMROOT INTERNAL USE ONLY. Externally, use learning.genai.root.RequestMetadata.RequestMetrics. Request metrics per modality including token count, duration, num_frames. */
+      lmrootInternalRequestMetrics?: LearningGenaiRootRequestMetrics;
+      /** Multi modal recitation results. It will be populated as long as Multi modal Recitation processor is invoked. */
+      mmRecitationResult?: LearningGenaiRecitationMMRecitationCheckResult;
+      /** Number of Controlled Decoding rewind and repeats that have happened for this response. */
+      numRewinds?: number;
       /** 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. */
-      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;
       /** 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 */
@@ -8974,6 +9076,68 @@ declare namespace gapi.client {
         /** Legacy upload protocol for media (e.g. "media", "multipart"). */
         uploadType?: string;
       }): Request<GoogleCloudAiplatformV1ListDatasetVersionsResponse>;
+      /** Updates a DatasetVersion. */
+      patch(request: {
+        /** V1 error format. */
+        '$.xgafv'?: string;
+        /** OAuth access token. */
+        access_token?: string;
+        /** Data format for response. */
+        alt?: string;
+        /** JSONP */
+        callback?: string;
+        /** Selector specifying which fields to include in a partial response. */
+        fields?: string;
+        /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+        key?: string;
+        /** Output only. The resource name of the DatasetVersion. */
+        name: string;
+        /** OAuth 2.0 token for the current user. */
+        oauth_token?: string;
+        /** Returns response with indentations and line breaks. */
+        prettyPrint?: boolean;
+        /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+        quotaUser?: string;
+        /** Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name` */
+        updateMask?: string;
+        /** Upload protocol for media (e.g. "raw", "multipart"). */
+        upload_protocol?: string;
+        /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+        uploadType?: string;
+        /** Request body */
+        resource: GoogleCloudAiplatformV1DatasetVersion;
+      }): Request<GoogleCloudAiplatformV1DatasetVersion>;
+      patch(
+        request: {
+          /** V1 error format. */
+          '$.xgafv'?: string;
+          /** OAuth access token. */
+          access_token?: string;
+          /** Data format for response. */
+          alt?: string;
+          /** JSONP */
+          callback?: string;
+          /** Selector specifying which fields to include in a partial response. */
+          fields?: string;
+          /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+          key?: string;
+          /** Output only. The resource name of the DatasetVersion. */
+          name: string;
+          /** OAuth 2.0 token for the current user. */
+          oauth_token?: string;
+          /** Returns response with indentations and line breaks. */
+          prettyPrint?: boolean;
+          /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+          quotaUser?: string;
+          /** Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name` */
+          updateMask?: string;
+          /** Upload protocol for media (e.g. "raw", "multipart"). */
+          upload_protocol?: string;
+          /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+          uploadType?: string;
+        },
+        body: GoogleCloudAiplatformV1DatasetVersion
+      ): Request<GoogleCloudAiplatformV1DatasetVersion>;
       /** Restores a dataset version. */
       restore(request?: {
         /** V1 error format. */

package/package.json

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