@maxim_mazurok/gapi.client.aiplatform-v1beta1 0.0.20240501 → 0.0.20240507

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/index.d.ts +451 -24
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -9,7 +9,7 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://aiplatform.googleapis.com/$discovery/rest?version=v1beta1
12
- // Revision: 20240501
12
+ // Revision: 20240507
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -162,6 +162,8 @@ declare namespace gapi.client {
162
162
  citations?: CloudAiNlLlmProtoServiceCitation[];
163
163
  }
164
164
  interface CloudAiNlLlmProtoServiceContent {
165
+ /** If true, the content is from a cached content. */
166
+ isCached?: boolean;
165
167
  /** The parts of the message. */
166
168
  parts?: CloudAiNlLlmProtoServicePart[];
167
169
  /** The role of the current conversation participant. */
@@ -280,6 +282,8 @@ declare namespace gapi.client {
280
282
  filtered?: boolean;
281
283
  /** Language filter result from SAFT LangId. */
282
284
  languageFilterResult?: LearningGenaiRootLanguageFilterResult;
285
+ /** Multi modal recitation results. It will be populated as long as Multi modal Recitation processor is invoked. */
286
+ mmRecitationResult?: LearningGenaiRecitationMMRecitationCheckResult;
283
287
  /** The RAI signals for the text. */
284
288
  raiSignals?: CloudAiNlLlmProtoServiceRaiSignal[];
285
289
  /** Translation request info during RAI for debugging purpose. Each TranslationRequestInfo corresponds to a request sent to the translation server. */
@@ -808,6 +812,7 @@ declare namespace gapi.client {
808
812
  interface GoogleCloudAiplatformV1beta1CancelNasJobRequest {}
809
813
  interface GoogleCloudAiplatformV1beta1CancelPipelineJobRequest {}
810
814
  interface GoogleCloudAiplatformV1beta1CancelTrainingPipelineRequest {}
815
+ interface GoogleCloudAiplatformV1beta1CancelTuningJobRequest {}
811
816
  interface GoogleCloudAiplatformV1beta1Candidate {
812
817
  /** Output only. Source attribution of the generated content. */
813
818
  citationMetadata?: GoogleCloudAiplatformV1beta1CitationMetadata;
@@ -1268,6 +1273,8 @@ declare namespace gapi.client {
1268
1273
  metadataArtifact?: string;
1269
1274
  /** 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/. */
1270
1275
  metadataSchemaUri?: string;
1276
+ /** Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets. */
1277
+ modelReference?: string;
1271
1278
  /** Output only. The resource name of the Dataset. */
1272
1279
  name?: string;
1273
1280
  /** 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. */
@@ -1286,6 +1293,8 @@ declare namespace gapi.client {
1286
1293
  etag?: string;
1287
1294
  /** Required. Output only. Additional information about the DatasetVersion. */
1288
1295
  metadata?: any;
1296
+ /** Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions. */
1297
+ modelReference?: string;
1289
1298
  /** Output only. The resource name of the DatasetVersion. */
1290
1299
  name?: string;
1291
1300
  /** Output only. Timestamp when this DatasetVersion was last updated. */
@@ -2134,7 +2143,7 @@ declare namespace gapi.client {
2134
2143
  versionColumnName?: string;
2135
2144
  }
2136
2145
  interface GoogleCloudAiplatformV1beta1FeatureGroup {
2137
- /** 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. */
2146
+ /** 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`. */
2138
2147
  bigQuery?: GoogleCloudAiplatformV1beta1FeatureGroupBigQuery;
2139
2148
  /** Output only. Timestamp when this FeatureGroup was created. */
2140
2149
  createTime?: string;
@@ -2519,12 +2528,6 @@ declare namespace gapi.client {
2519
2528
  neighborCount?: number;
2520
2529
  /** 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. */
2521
2530
  perCrowdingAttributeNeighborCount?: number;
2522
- /** Optional. Represents RRF algorithm that combines search results. */
2523
- rrf?: GoogleCloudAiplatformV1beta1FindNeighborsRequestQueryRRF;
2524
- }
2525
- interface GoogleCloudAiplatformV1beta1FindNeighborsRequestQueryRRF {
2526
- /** 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. */
2527
- alpha?: number;
2528
2531
  }
2529
2532
  interface GoogleCloudAiplatformV1beta1FindNeighborsResponse {
2530
2533
  /** The nearest neighbors of the query datapoints. */
@@ -2541,8 +2544,6 @@ declare namespace gapi.client {
2541
2544
  datapoint?: GoogleCloudAiplatformV1beta1IndexDatapoint;
2542
2545
  /** The distance between the neighbor and the dense embedding query. */
2543
2546
  distance?: number;
2544
- /** The distance between the neighbor and the query sparse_embedding. */
2545
- sparseDistance?: number;
2546
2547
  }
2547
2548
  interface GoogleCloudAiplatformV1beta1FluencyInput {
2548
2549
  /** Required. Fluency instance. */
@@ -2696,6 +2697,8 @@ declare namespace gapi.client {
2696
2697
  presencePenalty?: number;
2697
2698
  /** 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. */
2698
2699
  responseMimeType?: string;
2700
+ /** Optional. Control Three levels of creativity in the model output. Default: RESPONSE_STYLE_BALANCED */
2701
+ responseStyle?: string;
2699
2702
  /** Optional. Stop sequences. */
2700
2703
  stopSequences?: string[];
2701
2704
  /** Optional. Controls the randomness of predictions. */
@@ -2926,8 +2929,6 @@ declare namespace gapi.client {
2926
2929
  numericRestricts?: GoogleCloudAiplatformV1beta1IndexDatapointNumericRestriction[];
2927
2930
  /** 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 */
2928
2931
  restricts?: GoogleCloudAiplatformV1beta1IndexDatapointRestriction[];
2929
- /** Optional. Feature embedding vector for sparse index. */
2930
- sparseEmbedding?: GoogleCloudAiplatformV1beta1IndexDatapointSparseEmbedding;
2931
2932
  }
2932
2933
  interface GoogleCloudAiplatformV1beta1IndexDatapointCrowdingTag {
2933
2934
  /** 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. */
@@ -2953,12 +2954,6 @@ declare namespace gapi.client {
2953
2954
  /** The namespace of this restriction. e.g.: color. */
2954
2955
  namespace?: string;
2955
2956
  }
2956
- interface GoogleCloudAiplatformV1beta1IndexDatapointSparseEmbedding {
2957
- /** Optional. The list of indexes for the embedding values of the sparse vector. */
2958
- dimensions?: string[];
2959
- /** Optional. The list of embedding values of the sparse vector. */
2960
- values?: number[];
2961
- }
2962
2957
  interface GoogleCloudAiplatformV1beta1IndexEndpoint {
2963
2958
  /** Output only. Timestamp when this IndexEndpoint was created. */
2964
2959
  createTime?: string;
@@ -3000,8 +2995,6 @@ declare namespace gapi.client {
3000
2995
  interface GoogleCloudAiplatformV1beta1IndexStats {
3001
2996
  /** Output only. The number of shards in the Index. */
3002
2997
  shardsCount?: number;
3003
- /** Output only. The number of sparse vectors in the Index. */
3004
- sparseVectorsCount?: string;
3005
2998
  /** Output only. The number of dense vectors in the Index. */
3006
2999
  vectorsCount?: string;
3007
3000
  }
@@ -3383,6 +3376,12 @@ declare namespace gapi.client {
3383
3376
  /** The Trials associated with the Study. */
3384
3377
  trials?: GoogleCloudAiplatformV1beta1Trial[];
3385
3378
  }
3379
+ interface GoogleCloudAiplatformV1beta1ListTuningJobsResponse {
3380
+ /** A token to retrieve the next page of results. Pass to ListTuningJobsRequest.page_token to obtain that page. */
3381
+ nextPageToken?: string;
3382
+ /** List of TuningJobs in the requested page. */
3383
+ tuningJobs?: GoogleCloudAiplatformV1beta1TuningJob[];
3384
+ }
3386
3385
  interface GoogleCloudAiplatformV1beta1LookupStudyRequest {
3387
3386
  /** Required. The user-defined display name of the Study */
3388
3387
  displayName?: string;
@@ -4380,12 +4379,16 @@ declare namespace gapi.client {
4380
4379
  interface GoogleCloudAiplatformV1beta1NearestNeighborSearchOperationMetadataContentValidationStats {
4381
4380
  /** Number of records in this file we skipped due to validate errors. */
4382
4381
  invalidRecordCount?: string;
4382
+ /** Number of sparse records in this file we skipped due to validate errors. */
4383
+ invalidSparseRecordCount?: string;
4383
4384
  /** 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. */
4384
4385
  partialErrors?: GoogleCloudAiplatformV1beta1NearestNeighborSearchOperationMetadataRecordError[];
4385
4386
  /** Cloud Storage URI pointing to the original file in user's bucket. */
4386
4387
  sourceGcsUri?: string;
4387
4388
  /** Number of records in this file that were successfully processed. */
4388
4389
  validRecordCount?: string;
4390
+ /** Number of sparse records in this file that were successfully processed. */
4391
+ validSparseRecordCount?: string;
4389
4392
  }
4390
4393
  interface GoogleCloudAiplatformV1beta1NearestNeighborSearchOperationMetadataRecordError {
4391
4394
  /** Empty if the embedding id is failed to parse. */
@@ -4450,12 +4453,14 @@ declare namespace gapi.client {
4450
4453
  executionTimeout?: string;
4451
4454
  /** The user email to run the execution as. Only supported by Colab runtimes. */
4452
4455
  executionUser?: string;
4453
- /** The GCS url pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb` */
4456
+ /** The Cloud Storage url pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb` */
4454
4457
  gcsNotebookSource?: GoogleCloudAiplatformV1beta1NotebookExecutionJobGcsNotebookSource;
4455
- /** The GCS location to upload the result to. Format: `gs://bucket-name` */
4458
+ /** The Cloud Storage location to upload the result to. Format: `gs://bucket-name` */
4456
4459
  gcsOutputUri?: string;
4457
4460
  /** Output only. The state of the NotebookExecutionJob. */
4458
4461
  jobState?: string;
4462
+ /** The labels with user-defined metadata to organize NotebookExecutionJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. */
4463
+ labels?: {[P in string]: string};
4459
4464
  /** Output only. The resource name of this NotebookExecutionJob. Format: `projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}` */
4460
4465
  name?: string;
4461
4466
  /** The NotebookRuntimeTemplate to source compute configuration from. */
@@ -4538,6 +4543,10 @@ declare namespace gapi.client {
4538
4543
  runtimeState?: string;
4539
4544
  /** Required. The user email of the NotebookRuntime. */
4540
4545
  runtimeUser?: string;
4546
+ /** Output only. Reserved for future use. */
4547
+ satisfiesPzi?: boolean;
4548
+ /** Output only. Reserved for future use. */
4549
+ satisfiesPzs?: boolean;
4541
4550
  /** Output only. The service account that the NotebookRuntime workload runs as. */
4542
4551
  serviceAccount?: string;
4543
4552
  /** Output only. Timestamp when this NotebookRuntime was most recently updated. */
@@ -7565,6 +7574,66 @@ declare namespace gapi.client {
7565
7574
  /** Optional. Which version to use for evaluation. */
7566
7575
  version?: number;
7567
7576
  }
7577
+ interface GoogleCloudAiplatformV1beta1SupervisedHyperParameters {
7578
+ /** Optional. Adapter size for tuning. */
7579
+ adapterSize?: string;
7580
+ /** Optional. Number of complete passes the model makes over the entire training dataset during training. */
7581
+ epochCount?: string;
7582
+ /** Optional. Multiplier for adjusting the default learning rate. */
7583
+ learningRateMultiplier?: number;
7584
+ }
7585
+ interface GoogleCloudAiplatformV1beta1SupervisedTuningDatasetDistribution {
7586
+ /** Output only. Defines the histogram bucket. */
7587
+ buckets?: GoogleCloudAiplatformV1beta1SupervisedTuningDatasetDistributionDatasetBucket[];
7588
+ /** Output only. The maximum of the population values. */
7589
+ max?: number;
7590
+ /** Output only. The arithmetic mean of the values in the population. */
7591
+ mean?: number;
7592
+ /** Output only. The median of the values in the population. */
7593
+ median?: number;
7594
+ /** Output only. The minimum of the population values. */
7595
+ min?: number;
7596
+ /** Output only. The 5th percentile of the values in the population. */
7597
+ p5?: number;
7598
+ /** Output only. The 95th percentile of the values in the population. */
7599
+ p95?: number;
7600
+ /** Output only. Sum of a given population of values. */
7601
+ sum?: string;
7602
+ }
7603
+ interface GoogleCloudAiplatformV1beta1SupervisedTuningDatasetDistributionDatasetBucket {
7604
+ /** Output only. Number of values in the bucket. */
7605
+ count?: number;
7606
+ /** Output only. Left bound of the bucket. */
7607
+ left?: number;
7608
+ /** Output only. Right bound of the bucket. */
7609
+ right?: number;
7610
+ }
7611
+ interface GoogleCloudAiplatformV1beta1SupervisedTuningDataStats {
7612
+ /** Output only. Number of billable characters in the tuning dataset. */
7613
+ totalBillableCharacterCount?: string;
7614
+ /** Output only. Number of tuning characters in the tuning dataset. */
7615
+ totalTuningCharacterCount?: string;
7616
+ /** Output only. Number of examples in the tuning dataset. */
7617
+ tuningDatasetExampleCount?: string;
7618
+ /** Output only. Number of tuning steps for this Tuning Job. */
7619
+ tuningStepCount?: string;
7620
+ /** Output only. Sample user messages in the training dataset uri. */
7621
+ userDatasetExamples?: GoogleCloudAiplatformV1beta1Content[];
7622
+ /** Output only. Dataset distributions for the user input tokens. */
7623
+ userInputTokenDistribution?: GoogleCloudAiplatformV1beta1SupervisedTuningDatasetDistribution;
7624
+ /** Output only. Dataset distributions for the messages per example. */
7625
+ userMessagePerExampleDistribution?: GoogleCloudAiplatformV1beta1SupervisedTuningDatasetDistribution;
7626
+ /** Output only. Dataset distributions for the user output tokens. */
7627
+ userOutputTokenDistribution?: GoogleCloudAiplatformV1beta1SupervisedTuningDatasetDistribution;
7628
+ }
7629
+ interface GoogleCloudAiplatformV1beta1SupervisedTuningSpec {
7630
+ /** Optional. Hyperparameters for SFT. */
7631
+ hyperParameters?: GoogleCloudAiplatformV1beta1SupervisedHyperParameters;
7632
+ /** Required. Cloud Storage path to file containing training dataset for tuning. The dataset must be formatted as a JSONL file. */
7633
+ trainingDatasetUri?: string;
7634
+ /** Optional. Cloud Storage path to file containing validation dataset for tuning. The dataset must be formatted as a JSONL file. */
7635
+ validationDatasetUri?: string;
7636
+ }
7568
7637
  interface GoogleCloudAiplatformV1beta1SyncFeatureViewRequest {}
7569
7638
  interface GoogleCloudAiplatformV1beta1SyncFeatureViewResponse {
7570
7639
  /** Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}/featureViewSyncs/{feature_view_sync}` */
@@ -7945,6 +8014,50 @@ declare namespace gapi.client {
7945
8014
  /** Output only. The value of the parameter. `number_value` will be set if a parameter defined in StudySpec is in type 'INTEGER', 'DOUBLE' or 'DISCRETE'. `string_value` will be set if a parameter defined in StudySpec is in type 'CATEGORICAL'. */
7946
8015
  value?: any;
7947
8016
  }
8017
+ interface GoogleCloudAiplatformV1beta1TunedModel {
8018
+ /** Output only. A resource name of an Endpoint. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`. */
8019
+ endpoint?: string;
8020
+ /** Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}`. */
8021
+ model?: string;
8022
+ }
8023
+ interface GoogleCloudAiplatformV1beta1TuningDataStats {
8024
+ /** The SFT Tuning data stats. */
8025
+ supervisedTuningDataStats?: GoogleCloudAiplatformV1beta1SupervisedTuningDataStats;
8026
+ }
8027
+ interface GoogleCloudAiplatformV1beta1TuningJob {
8028
+ /** The base model that is being tuned, e.g., "gemini-1.0-pro-002". */
8029
+ baseModel?: string;
8030
+ /** Output only. Time when the TuningJob was created. */
8031
+ createTime?: string;
8032
+ /** Optional. The description of the TuningJob. */
8033
+ description?: string;
8034
+ /** 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. */
8035
+ encryptionSpec?: GoogleCloudAiplatformV1beta1EncryptionSpec;
8036
+ /** Output only. Time when the TuningJob entered any of the following JobStates: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`, `JOB_STATE_EXPIRED`. */
8037
+ endTime?: string;
8038
+ /** Output only. Only populated when job's state is `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`. */
8039
+ error?: GoogleRpcStatus;
8040
+ /** Output only. The Experiment associated with this TuningJob. */
8041
+ experiment?: string;
8042
+ /** Optional. The labels with user-defined metadata to organize TuningJob and generated resources such as Model and Endpoint. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. */
8043
+ labels?: {[P in string]: string};
8044
+ /** Output only. Identifier. Resource name of a TuningJob. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}` */
8045
+ name?: string;
8046
+ /** Output only. Time when the TuningJob for the first time entered the `JOB_STATE_RUNNING` state. */
8047
+ startTime?: string;
8048
+ /** Output only. The detailed state of the job. */
8049
+ state?: string;
8050
+ /** Tuning Spec for Supervised Fine Tuning. */
8051
+ supervisedTuningSpec?: GoogleCloudAiplatformV1beta1SupervisedTuningSpec;
8052
+ /** Output only. The tuned model resources assiociated with this TuningJob. */
8053
+ tunedModel?: GoogleCloudAiplatformV1beta1TunedModel;
8054
+ /** Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters. */
8055
+ tunedModelDisplayName?: string;
8056
+ /** Output only. The tuning data statistics associated with this TuningJob. */
8057
+ tuningDataStats?: GoogleCloudAiplatformV1beta1TuningDataStats;
8058
+ /** Output only. Time when the TuningJob was most recently updated. */
8059
+ updateTime?: string;
8060
+ }
7948
8061
  interface GoogleCloudAiplatformV1beta1UndeployIndexOperationMetadata {
7949
8062
  /** The operation generic information. */
7950
8063
  genericMetadata?: GoogleCloudAiplatformV1beta1GenericOperationMetadata;
@@ -8399,6 +8512,10 @@ declare namespace gapi.client {
8399
8512
  /** The recitation result against model training data. */
8400
8513
  trainingSegmentResults?: LanguageLabsAidaTrustRecitationProtoSegmentResult[];
8401
8514
  }
8515
+ interface LearningGenaiRecitationContentChunkRecitationCheckResult {
8516
+ imageResult?: LearningGenaiRecitationImageRecitationCheckResult;
8517
+ textResult?: LearningGenaiRecitationRecitationResult;
8518
+ }
8402
8519
  interface LearningGenaiRecitationDocAttribution {
8403
8520
  amarnaId?: string;
8404
8521
  arxivId?: string;
@@ -8440,6 +8557,33 @@ declare namespace gapi.client {
8440
8557
  wikipediaArticleTitle?: string;
8441
8558
  youtubeVideoId?: string;
8442
8559
  }
8560
+ interface LearningGenaiRecitationImageDocAttribution {
8561
+ /** Unique ID of the image. */
8562
+ datasetName?: string;
8563
+ /** Doc ID to identify the image. These could be urls of images or amarna id. */
8564
+ stringDocids?: string;
8565
+ }
8566
+ interface LearningGenaiRecitationImageRecitationCheckResult {
8567
+ /** Only has NO_ACTION or BLOCK to start with. */
8568
+ recitationAction?: string;
8569
+ /** Images that are similar to the requested image. */
8570
+ recitedImages?: LearningGenaiRecitationImageRecitationCheckResultSimilarImage[];
8571
+ }
8572
+ interface LearningGenaiRecitationImageRecitationCheckResultSimilarImage {
8573
+ /** Attribution information about the image */
8574
+ docAttribution?: LearningGenaiRecitationImageDocAttribution;
8575
+ /** The memorization embedding model that returned this image */
8576
+ embeddingModel?: string;
8577
+ /** 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. */
8578
+ imageId?: string;
8579
+ /** Similarity score of requested image compared with image in training data. */
8580
+ scores?: number;
8581
+ }
8582
+ interface LearningGenaiRecitationMMRecitationCheckResult {
8583
+ chunkResults?: LearningGenaiRecitationContentChunkRecitationCheckResult[];
8584
+ /** Overall recommended recitation action for the content. */
8585
+ recitationAction?: string;
8586
+ }
8443
8587
  interface LearningGenaiRecitationRecitationResult {
8444
8588
  dynamicSegmentResults?: LearningGenaiRecitationSegmentResult[];
8445
8589
  /** 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. */
@@ -8654,6 +8798,8 @@ declare namespace gapi.client {
8654
8798
  factRetrievalMillisecondsByProvider?: {[P in string]: string};
8655
8799
  /** Latency spent on prompt2query. The procedure generates a search-friendly query given the original prompt. */
8656
8800
  prompt2queryMilliseconds?: string;
8801
+ /** Latency if use GroundedGeneration service for the whole retrieval & augmentation. */
8802
+ retrievalAugmentMilliseconds?: string;
8657
8803
  }
8658
8804
  interface LearningGenaiRootRAIOutput {
8659
8805
  allowed?: boolean;
@@ -8667,6 +8813,42 @@ declare namespace gapi.client {
8667
8813
  /** Regex used to decide that query or response should be taken down. Empty when query or response is kept. */
8668
8814
  takedownRegex?: string;
8669
8815
  }
8816
+ interface LearningGenaiRootRequestMetrics {
8817
+ /** Metrics for audio samples in the request. */
8818
+ audioMetrics?: LearningGenaiRootRequestMetricsAudioMetrics;
8819
+ /** Metrics for image samples in the request. */
8820
+ imageMetrics?: LearningGenaiRootRequestMetricsImageMetrics;
8821
+ /** Number of text tokens extracted from the request. */
8822
+ textTokenCount?: number;
8823
+ /** Total number of tokens in the request. */
8824
+ totalTokenCount?: number;
8825
+ /** Metrics for video samples in the request. */
8826
+ videoMetrics?: LearningGenaiRootRequestMetricsVideoMetrics;
8827
+ }
8828
+ interface LearningGenaiRootRequestMetricsAudioMetrics {
8829
+ /** Duration of the audio sample in seconds. */
8830
+ audioDuration?: string;
8831
+ /** Number of tokens derived directly from audio data. */
8832
+ audioTokenCount?: number;
8833
+ /** Number of audio frames in the audio. */
8834
+ numAudioFrames?: number;
8835
+ }
8836
+ interface LearningGenaiRootRequestMetricsImageMetrics {
8837
+ /** Number of tokens extracted from image bytes. */
8838
+ imageTokenCount?: number;
8839
+ /** Number of images in the request. */
8840
+ numImages?: number;
8841
+ }
8842
+ interface LearningGenaiRootRequestMetricsVideoMetrics {
8843
+ /** Metrics associated with audio sample in the video. */
8844
+ audioSample?: LearningGenaiRootRequestMetricsAudioMetrics;
8845
+ /** Number of video frames in the video. */
8846
+ numVideoFrames?: number;
8847
+ /** Duration of the video sample in seconds. */
8848
+ videoDuration?: string;
8849
+ /** Number of tokens extracted from video frames. */
8850
+ videoFramesTokenCount?: number;
8851
+ }
8670
8852
  interface LearningGenaiRootRequestResponseTakedownResult {
8671
8853
  /** False when response has to be taken down per above config. */
8672
8854
  allowed?: boolean;
@@ -8821,6 +9003,12 @@ declare namespace gapi.client {
8821
9003
  language?: string;
8822
9004
  /** The LM prefix used to generate this response. */
8823
9005
  lmPrefix?: string;
9006
+ /** FOR LMROOT INTERNAL USE ONLY. Externally, use learning.genai.root.RequestMetadata.RequestMetrics. Request metrics per modality including token count, duration, num_frames. */
9007
+ lmrootInternalRequestMetrics?: LearningGenaiRootRequestMetrics;
9008
+ /** Multi modal recitation results. It will be populated as long as Multi modal Recitation processor is invoked. */
9009
+ mmRecitationResult?: LearningGenaiRecitationMMRecitationCheckResult;
9010
+ /** Number of Controlled Decoding rewind and repeats that have happened for this response. */
9011
+ numRewinds?: number;
8824
9012
  /** The original text generated by LLM. This is the raw output for debugging purposes. */
8825
9013
  originalText?: string;
8826
9014
  /** 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. */
@@ -8831,8 +9019,6 @@ declare namespace gapi.client {
8831
9019
  raiOutputs?: LearningGenaiRootRAIOutput[];
8832
9020
  /** Recitation Results. It will be populated as long as Recitation processing is enabled, regardless of recitation outcome. */
8833
9021
  recitationResult?: LearningGenaiRecitationRecitationResult;
8834
- /** NOT IMPLEMENTED TODO (b/334187574) Remove this field after Labs migrates to per_stream_returned_token_count and total_returned_token_count. */
8835
- returnTokenCount?: number;
8836
9022
  /** All the different scores for a message are logged here. */
8837
9023
  scores?: LearningGenaiRootScore[];
8838
9024
  /** Whether the response is terminated during streaming return. Only used for streaming requests. */
@@ -10863,6 +11049,68 @@ declare namespace gapi.client {
10863
11049
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
10864
11050
  uploadType?: string;
10865
11051
  }): Request<GoogleCloudAiplatformV1beta1ListDatasetVersionsResponse>;
11052
+ /** Updates a DatasetVersion. */
11053
+ patch(request: {
11054
+ /** V1 error format. */
11055
+ '$.xgafv'?: string;
11056
+ /** OAuth access token. */
11057
+ access_token?: string;
11058
+ /** Data format for response. */
11059
+ alt?: string;
11060
+ /** JSONP */
11061
+ callback?: string;
11062
+ /** Selector specifying which fields to include in a partial response. */
11063
+ fields?: string;
11064
+ /** 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. */
11065
+ key?: string;
11066
+ /** Output only. The resource name of the DatasetVersion. */
11067
+ name: string;
11068
+ /** OAuth 2.0 token for the current user. */
11069
+ oauth_token?: string;
11070
+ /** Returns response with indentations and line breaks. */
11071
+ prettyPrint?: boolean;
11072
+ /** 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. */
11073
+ quotaUser?: string;
11074
+ /** Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name` */
11075
+ updateMask?: string;
11076
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
11077
+ upload_protocol?: string;
11078
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
11079
+ uploadType?: string;
11080
+ /** Request body */
11081
+ resource: GoogleCloudAiplatformV1beta1DatasetVersion;
11082
+ }): Request<GoogleCloudAiplatformV1beta1DatasetVersion>;
11083
+ patch(
11084
+ request: {
11085
+ /** V1 error format. */
11086
+ '$.xgafv'?: string;
11087
+ /** OAuth access token. */
11088
+ access_token?: string;
11089
+ /** Data format for response. */
11090
+ alt?: string;
11091
+ /** JSONP */
11092
+ callback?: string;
11093
+ /** Selector specifying which fields to include in a partial response. */
11094
+ fields?: string;
11095
+ /** 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. */
11096
+ key?: string;
11097
+ /** Output only. The resource name of the DatasetVersion. */
11098
+ name: string;
11099
+ /** OAuth 2.0 token for the current user. */
11100
+ oauth_token?: string;
11101
+ /** Returns response with indentations and line breaks. */
11102
+ prettyPrint?: boolean;
11103
+ /** 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. */
11104
+ quotaUser?: string;
11105
+ /** Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name` */
11106
+ updateMask?: string;
11107
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
11108
+ upload_protocol?: string;
11109
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
11110
+ uploadType?: string;
11111
+ },
11112
+ body: GoogleCloudAiplatformV1beta1DatasetVersion
11113
+ ): Request<GoogleCloudAiplatformV1beta1DatasetVersion>;
10866
11114
  /** Restores a dataset version. */
10867
11115
  restore(request?: {
10868
11116
  /** V1 error format. */
@@ -31510,6 +31758,184 @@ declare namespace gapi.client {
31510
31758
  }): Request<GoogleCloudAiplatformV1beta1ListTrainingPipelinesResponse>;
31511
31759
  operations: OperationsResource;
31512
31760
  }
31761
+ interface TuningJobsResource {
31762
+ /** Cancels a TuningJob. Starts asynchronous cancellation on the TuningJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use GenAiTuningService.GetTuningJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the TuningJob is not deleted; instead it becomes a job with a TuningJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and TuningJob.state is set to `CANCELLED`. */
31763
+ cancel(request: {
31764
+ /** V1 error format. */
31765
+ '$.xgafv'?: string;
31766
+ /** OAuth access token. */
31767
+ access_token?: string;
31768
+ /** Data format for response. */
31769
+ alt?: string;
31770
+ /** JSONP */
31771
+ callback?: string;
31772
+ /** Selector specifying which fields to include in a partial response. */
31773
+ fields?: string;
31774
+ /** 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. */
31775
+ key?: string;
31776
+ /** Required. The name of the TuningJob to cancel. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}` */
31777
+ name: string;
31778
+ /** OAuth 2.0 token for the current user. */
31779
+ oauth_token?: string;
31780
+ /** Returns response with indentations and line breaks. */
31781
+ prettyPrint?: boolean;
31782
+ /** 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. */
31783
+ quotaUser?: string;
31784
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
31785
+ upload_protocol?: string;
31786
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
31787
+ uploadType?: string;
31788
+ /** Request body */
31789
+ resource: GoogleCloudAiplatformV1beta1CancelTuningJobRequest;
31790
+ }): Request<{}>;
31791
+ cancel(
31792
+ request: {
31793
+ /** V1 error format. */
31794
+ '$.xgafv'?: string;
31795
+ /** OAuth access token. */
31796
+ access_token?: string;
31797
+ /** Data format for response. */
31798
+ alt?: string;
31799
+ /** JSONP */
31800
+ callback?: string;
31801
+ /** Selector specifying which fields to include in a partial response. */
31802
+ fields?: string;
31803
+ /** 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. */
31804
+ key?: string;
31805
+ /** Required. The name of the TuningJob to cancel. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}` */
31806
+ name: string;
31807
+ /** OAuth 2.0 token for the current user. */
31808
+ oauth_token?: string;
31809
+ /** Returns response with indentations and line breaks. */
31810
+ prettyPrint?: boolean;
31811
+ /** 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. */
31812
+ quotaUser?: string;
31813
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
31814
+ upload_protocol?: string;
31815
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
31816
+ uploadType?: string;
31817
+ },
31818
+ body: GoogleCloudAiplatformV1beta1CancelTuningJobRequest
31819
+ ): Request<{}>;
31820
+ /** Creates a TuningJob. A created TuningJob right away will be attempted to be run. */
31821
+ create(request: {
31822
+ /** V1 error format. */
31823
+ '$.xgafv'?: string;
31824
+ /** OAuth access token. */
31825
+ access_token?: string;
31826
+ /** Data format for response. */
31827
+ alt?: string;
31828
+ /** JSONP */
31829
+ callback?: string;
31830
+ /** Selector specifying which fields to include in a partial response. */
31831
+ fields?: string;
31832
+ /** 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. */
31833
+ key?: string;
31834
+ /** OAuth 2.0 token for the current user. */
31835
+ oauth_token?: string;
31836
+ /** Required. The resource name of the Location to create the TuningJob in. Format: `projects/{project}/locations/{location}` */
31837
+ parent: string;
31838
+ /** Returns response with indentations and line breaks. */
31839
+ prettyPrint?: boolean;
31840
+ /** 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. */
31841
+ quotaUser?: string;
31842
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
31843
+ upload_protocol?: string;
31844
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
31845
+ uploadType?: string;
31846
+ /** Request body */
31847
+ resource: GoogleCloudAiplatformV1beta1TuningJob;
31848
+ }): Request<GoogleCloudAiplatformV1beta1TuningJob>;
31849
+ create(
31850
+ request: {
31851
+ /** V1 error format. */
31852
+ '$.xgafv'?: string;
31853
+ /** OAuth access token. */
31854
+ access_token?: string;
31855
+ /** Data format for response. */
31856
+ alt?: string;
31857
+ /** JSONP */
31858
+ callback?: string;
31859
+ /** Selector specifying which fields to include in a partial response. */
31860
+ fields?: string;
31861
+ /** 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. */
31862
+ key?: string;
31863
+ /** OAuth 2.0 token for the current user. */
31864
+ oauth_token?: string;
31865
+ /** Required. The resource name of the Location to create the TuningJob in. Format: `projects/{project}/locations/{location}` */
31866
+ parent: string;
31867
+ /** Returns response with indentations and line breaks. */
31868
+ prettyPrint?: boolean;
31869
+ /** 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. */
31870
+ quotaUser?: string;
31871
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
31872
+ upload_protocol?: string;
31873
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
31874
+ uploadType?: string;
31875
+ },
31876
+ body: GoogleCloudAiplatformV1beta1TuningJob
31877
+ ): Request<GoogleCloudAiplatformV1beta1TuningJob>;
31878
+ /** Gets a TuningJob. */
31879
+ get(request?: {
31880
+ /** V1 error format. */
31881
+ '$.xgafv'?: string;
31882
+ /** OAuth access token. */
31883
+ access_token?: string;
31884
+ /** Data format for response. */
31885
+ alt?: string;
31886
+ /** JSONP */
31887
+ callback?: string;
31888
+ /** Selector specifying which fields to include in a partial response. */
31889
+ fields?: string;
31890
+ /** 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. */
31891
+ key?: string;
31892
+ /** Required. The name of the TuningJob resource. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}` */
31893
+ name: string;
31894
+ /** OAuth 2.0 token for the current user. */
31895
+ oauth_token?: string;
31896
+ /** Returns response with indentations and line breaks. */
31897
+ prettyPrint?: boolean;
31898
+ /** 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. */
31899
+ quotaUser?: string;
31900
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
31901
+ upload_protocol?: string;
31902
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
31903
+ uploadType?: string;
31904
+ }): Request<GoogleCloudAiplatformV1beta1TuningJob>;
31905
+ /** Lists TuningJobs in a Location. */
31906
+ list(request?: {
31907
+ /** V1 error format. */
31908
+ '$.xgafv'?: string;
31909
+ /** OAuth access token. */
31910
+ access_token?: string;
31911
+ /** Data format for response. */
31912
+ alt?: string;
31913
+ /** JSONP */
31914
+ callback?: string;
31915
+ /** Selector specifying which fields to include in a partial response. */
31916
+ fields?: string;
31917
+ /** Optional. The standard list filter. */
31918
+ filter?: string;
31919
+ /** 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. */
31920
+ key?: string;
31921
+ /** OAuth 2.0 token for the current user. */
31922
+ oauth_token?: string;
31923
+ /** Optional. The standard list page size. */
31924
+ pageSize?: number;
31925
+ /** Optional. The standard list page token. Typically obtained via ListTuningJob.next_page_token of the previous GenAiTuningService.ListTuningJob][] call. */
31926
+ pageToken?: string;
31927
+ /** Required. The resource name of the Location to list the TuningJobs from. Format: `projects/{project}/locations/{location}` */
31928
+ parent: string;
31929
+ /** Returns response with indentations and line breaks. */
31930
+ prettyPrint?: boolean;
31931
+ /** 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. */
31932
+ quotaUser?: string;
31933
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
31934
+ upload_protocol?: string;
31935
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
31936
+ uploadType?: string;
31937
+ }): Request<GoogleCloudAiplatformV1beta1ListTuningJobsResponse>;
31938
+ }
31513
31939
  interface LocationsResource {
31514
31940
  /** Evaluates instances based on a given metric. */
31515
31941
  evaluateInstances(request: {
@@ -31727,6 +32153,7 @@ declare namespace gapi.client {
31727
32153
  studies: StudiesResource;
31728
32154
  tensorboards: TensorboardsResource;
31729
32155
  trainingPipelines: TrainingPipelinesResource;
32156
+ tuningJobs: TuningJobsResource;
31730
32157
  }
31731
32158
  interface ProjectsResource {
31732
32159
  /** Gets a GenAI cache config. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.aiplatform-v1beta1",
3
- "version": "0.0.20240501",
3
+ "version": "0.0.20240507",
4
4
  "description": "TypeScript typings for Vertex AI API v1beta1",
5
5
  "repository": {
6
6
  "type": "git",