@maxim_mazurok/gapi.client.aiplatform-v1beta1 0.0.20240429 → 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 (3) hide show
  1. package/index.d.ts +1058 -43
  2. package/package.json +1 -1
  3. package/readme.md +5 -0
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: 20240429
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;
@@ -1065,6 +1070,14 @@ declare namespace gapi.client {
1065
1070
  /** The operation generic information. */
1066
1071
  genericMetadata?: GoogleCloudAiplatformV1beta1GenericOperationMetadata;
1067
1072
  }
1073
+ interface GoogleCloudAiplatformV1beta1CreateNotebookExecutionJobRequest {
1074
+ /** Required. The NotebookExecutionJob to create. */
1075
+ notebookExecutionJob?: GoogleCloudAiplatformV1beta1NotebookExecutionJob;
1076
+ /** Optional. User specified ID for the NotebookExecutionJob. */
1077
+ notebookExecutionJobId?: string;
1078
+ /** Required. The resource name of the Location to create the NotebookExecutionJob. Format: `projects/{project}/locations/{location}` */
1079
+ parent?: string;
1080
+ }
1068
1081
  interface GoogleCloudAiplatformV1beta1CreateNotebookRuntimeTemplateOperationMetadata {
1069
1082
  /** The operation generic information. */
1070
1083
  genericMetadata?: GoogleCloudAiplatformV1beta1GenericOperationMetadata;
@@ -1260,6 +1273,8 @@ declare namespace gapi.client {
1260
1273
  metadataArtifact?: string;
1261
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/. */
1262
1275
  metadataSchemaUri?: string;
1276
+ /** Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets. */
1277
+ modelReference?: string;
1263
1278
  /** Output only. The resource name of the Dataset. */
1264
1279
  name?: string;
1265
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. */
@@ -1278,6 +1293,8 @@ declare namespace gapi.client {
1278
1293
  etag?: string;
1279
1294
  /** Required. Output only. Additional information about the DatasetVersion. */
1280
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;
1281
1298
  /** Output only. The resource name of the DatasetVersion. */
1282
1299
  name?: string;
1283
1300
  /** Output only. Timestamp when this DatasetVersion was last updated. */
@@ -1491,6 +1508,7 @@ declare namespace gapi.client {
1491
1508
  /** The prediction output. */
1492
1509
  output?: string;
1493
1510
  }
1511
+ interface GoogleCloudAiplatformV1beta1DirectUploadSource {}
1494
1512
  interface GoogleCloudAiplatformV1beta1DiskSpec {
1495
1513
  /** Size in GB of the boot disk (default is 100GB). */
1496
1514
  bootDiskSizeGb?: number;
@@ -2125,7 +2143,7 @@ declare namespace gapi.client {
2125
2143
  versionColumnName?: string;
2126
2144
  }
2127
2145
  interface GoogleCloudAiplatformV1beta1FeatureGroup {
2128
- /** 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`. */
2129
2147
  bigQuery?: GoogleCloudAiplatformV1beta1FeatureGroupBigQuery;
2130
2148
  /** Output only. Timestamp when this FeatureGroup was created. */
2131
2149
  createTime?: string;
@@ -2679,6 +2697,8 @@ declare namespace gapi.client {
2679
2697
  presencePenalty?: number;
2680
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. */
2681
2699
  responseMimeType?: string;
2700
+ /** Optional. Control Three levels of creativity in the model output. Default: RESPONSE_STYLE_BALANCED */
2701
+ responseStyle?: string;
2682
2702
  /** Optional. Stop sequences. */
2683
2703
  stopSequences?: string[];
2684
2704
  /** Optional. Controls the randomness of predictions. */
@@ -2700,6 +2720,16 @@ declare namespace gapi.client {
2700
2720
  /** Required. The public base model URI. */
2701
2721
  baseModelUri?: string;
2702
2722
  }
2723
+ interface GoogleCloudAiplatformV1beta1GoogleDriveSource {
2724
+ /** Required. Google Drive resource IDs. */
2725
+ resourceIds?: GoogleCloudAiplatformV1beta1GoogleDriveSourceResourceId[];
2726
+ }
2727
+ interface GoogleCloudAiplatformV1beta1GoogleDriveSourceResourceId {
2728
+ /** Required. The ID of the Google Drive resource. */
2729
+ resourceId?: string;
2730
+ /** Required. The type of the Google Drive resource. */
2731
+ resourceType?: string;
2732
+ }
2703
2733
  interface GoogleCloudAiplatformV1beta1GroundednessInput {
2704
2734
  /** Required. Groundedness instance. */
2705
2735
  instance?: GoogleCloudAiplatformV1beta1GroundednessInstance;
@@ -2848,6 +2878,18 @@ declare namespace gapi.client {
2848
2878
  /** Required. Model evaluation resource to be imported. */
2849
2879
  modelEvaluation?: GoogleCloudAiplatformV1beta1ModelEvaluation;
2850
2880
  }
2881
+ interface GoogleCloudAiplatformV1beta1ImportRagFilesConfig {
2882
+ /** 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` */
2883
+ gcsSource?: GoogleCloudAiplatformV1beta1GcsSource;
2884
+ /** Google Drive location. Supports importing individual files as well as Google Drive folders. */
2885
+ googleDriveSource?: GoogleCloudAiplatformV1beta1GoogleDriveSource;
2886
+ /** Specifies the size and overlap of chunks after importing RagFiles. */
2887
+ ragFileChunkingConfig?: GoogleCloudAiplatformV1beta1RagFileChunkingConfig;
2888
+ }
2889
+ interface GoogleCloudAiplatformV1beta1ImportRagFilesRequest {
2890
+ /** Required. The config for the RagFiles to be synced and imported into the RagCorpus. VertexRagDataService.ImportRagFiles. */
2891
+ importRagFilesConfig?: GoogleCloudAiplatformV1beta1ImportRagFilesConfig;
2892
+ }
2851
2893
  interface GoogleCloudAiplatformV1beta1Index {
2852
2894
  /** Output only. Timestamp when this Index was created. */
2853
2895
  createTime?: string;
@@ -3256,6 +3298,18 @@ declare namespace gapi.client {
3256
3298
  /** List of PublisherModels in the requested page. */
3257
3299
  publisherModels?: GoogleCloudAiplatformV1beta1PublisherModel[];
3258
3300
  }
3301
+ interface GoogleCloudAiplatformV1beta1ListRagCorporaResponse {
3302
+ /** A token to retrieve the next page of results. Pass to ListRagCorporaRequest.page_token to obtain that page. */
3303
+ nextPageToken?: string;
3304
+ /** List of RagCorpora in the requested page. */
3305
+ ragCorpora?: GoogleCloudAiplatformV1beta1RagCorpus[];
3306
+ }
3307
+ interface GoogleCloudAiplatformV1beta1ListRagFilesResponse {
3308
+ /** A token to retrieve the next page of results. Pass to ListRagFilesRequest.page_token to obtain that page. */
3309
+ nextPageToken?: string;
3310
+ /** List of RagFiles in the requested page. */
3311
+ ragFiles?: GoogleCloudAiplatformV1beta1RagFile[];
3312
+ }
3259
3313
  interface GoogleCloudAiplatformV1beta1ListReasoningEnginesResponse {
3260
3314
  /** A token to retrieve the next page of results. Pass to ListReasoningEnginesRequest.page_token to obtain that page. */
3261
3315
  nextPageToken?: string;
@@ -3322,6 +3376,12 @@ declare namespace gapi.client {
3322
3376
  /** The Trials associated with the Study. */
3323
3377
  trials?: GoogleCloudAiplatformV1beta1Trial[];
3324
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
+ }
3325
3385
  interface GoogleCloudAiplatformV1beta1LookupStudyRequest {
3326
3386
  /** Required. The user-defined display name of the Study */
3327
3387
  displayName?: string;
@@ -4319,12 +4379,16 @@ declare namespace gapi.client {
4319
4379
  interface GoogleCloudAiplatformV1beta1NearestNeighborSearchOperationMetadataContentValidationStats {
4320
4380
  /** Number of records in this file we skipped due to validate errors. */
4321
4381
  invalidRecordCount?: string;
4382
+ /** Number of sparse records in this file we skipped due to validate errors. */
4383
+ invalidSparseRecordCount?: string;
4322
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. */
4323
4385
  partialErrors?: GoogleCloudAiplatformV1beta1NearestNeighborSearchOperationMetadataRecordError[];
4324
4386
  /** Cloud Storage URI pointing to the original file in user's bucket. */
4325
4387
  sourceGcsUri?: string;
4326
4388
  /** Number of records in this file that were successfully processed. */
4327
4389
  validRecordCount?: string;
4390
+ /** Number of sparse records in this file that were successfully processed. */
4391
+ validSparseRecordCount?: string;
4328
4392
  }
4329
4393
  interface GoogleCloudAiplatformV1beta1NearestNeighborSearchOperationMetadataRecordError {
4330
4394
  /** Empty if the embedding id is failed to parse. */
@@ -4389,12 +4453,14 @@ declare namespace gapi.client {
4389
4453
  executionTimeout?: string;
4390
4454
  /** The user email to run the execution as. Only supported by Colab runtimes. */
4391
4455
  executionUser?: string;
4392
- /** 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` */
4393
4457
  gcsNotebookSource?: GoogleCloudAiplatformV1beta1NotebookExecutionJobGcsNotebookSource;
4394
- /** 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` */
4395
4459
  gcsOutputUri?: string;
4396
4460
  /** Output only. The state of the NotebookExecutionJob. */
4397
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};
4398
4464
  /** Output only. The resource name of this NotebookExecutionJob. Format: `projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}` */
4399
4465
  name?: string;
4400
4466
  /** The NotebookRuntimeTemplate to source compute configuration from. */
@@ -4477,6 +4543,10 @@ declare namespace gapi.client {
4477
4543
  runtimeState?: string;
4478
4544
  /** Required. The user email of the NotebookRuntime. */
4479
4545
  runtimeUser?: string;
4546
+ /** Output only. Reserved for future use. */
4547
+ satisfiesPzi?: boolean;
4548
+ /** Output only. Reserved for future use. */
4549
+ satisfiesPzs?: boolean;
4480
4550
  /** Output only. The service account that the NotebookRuntime workload runs as. */
4481
4551
  serviceAccount?: string;
4482
4552
  /** Output only. Timestamp when this NotebookRuntime was most recently updated. */
@@ -4505,7 +4575,7 @@ declare namespace gapi.client {
4505
4575
  labels?: {[P in string]: string};
4506
4576
  /** Optional. Immutable. The specification of a single machine for the template. */
4507
4577
  machineSpec?: GoogleCloudAiplatformV1beta1MachineSpec;
4508
- /** Output only. The resource name of the NotebookRuntimeTemplate. */
4578
+ /** The resource name of the NotebookRuntimeTemplate. */
4509
4579
  name?: string;
4510
4580
  /** Optional. Network spec. */
4511
4581
  networkSpec?: GoogleCloudAiplatformV1beta1NetworkSpec;
@@ -5204,6 +5274,64 @@ declare namespace gapi.client {
5204
5274
  /** Optional. Which version to use for evaluation. */
5205
5275
  version?: number;
5206
5276
  }
5277
+ interface GoogleCloudAiplatformV1beta1RagContexts {
5278
+ /** All its contexts. */
5279
+ contexts?: GoogleCloudAiplatformV1beta1RagContextsContext[];
5280
+ }
5281
+ interface GoogleCloudAiplatformV1beta1RagContextsContext {
5282
+ /** The distance between the query vector and the context text vector. */
5283
+ distance?: number;
5284
+ /** 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. */
5285
+ sourceUri?: string;
5286
+ /** The text chunk. */
5287
+ text?: string;
5288
+ }
5289
+ interface GoogleCloudAiplatformV1beta1RagCorpus {
5290
+ /** Output only. Timestamp when this RagCorpus was created. */
5291
+ createTime?: string;
5292
+ /** Optional. The description of the RagCorpus. */
5293
+ description?: string;
5294
+ /** Required. The display name of the RagCorpus. The name can be up to 128 characters long and can consist of any UTF-8 characters. */
5295
+ displayName?: string;
5296
+ /** Output only. The resource name of the RagCorpus. */
5297
+ name?: string;
5298
+ /** Output only. Timestamp when this RagCorpus was last updated. */
5299
+ updateTime?: string;
5300
+ }
5301
+ interface GoogleCloudAiplatformV1beta1RagFile {
5302
+ /** Output only. Timestamp when this RagFile was created. */
5303
+ createTime?: string;
5304
+ /** Optional. The description of the RagFile. */
5305
+ description?: string;
5306
+ /** Output only. The RagFile is encapsulated and uploaded in the UploadRagFile request. */
5307
+ directUploadSource?: any;
5308
+ /** Required. The display name of the RagFile. The name can be up to 128 characters long and can consist of any UTF-8 characters. */
5309
+ displayName?: string;
5310
+ /** Output only. Google Cloud Storage location of the RagFile. It does not support wildcards in the Cloud Storage uri for now. */
5311
+ gcsSource?: GoogleCloudAiplatformV1beta1GcsSource;
5312
+ /** Output only. Google Drive location. Supports importing individual files as well as Google Drive folders. */
5313
+ googleDriveSource?: GoogleCloudAiplatformV1beta1GoogleDriveSource;
5314
+ /** Output only. The resource name of the RagFile. */
5315
+ name?: string;
5316
+ /** Output only. The type of the RagFile. */
5317
+ ragFileType?: string;
5318
+ /** Output only. The size of the RagFile in bytes. */
5319
+ sizeBytes?: string;
5320
+ /** Output only. Timestamp when this RagFile was last updated. */
5321
+ updateTime?: string;
5322
+ }
5323
+ interface GoogleCloudAiplatformV1beta1RagFileChunkingConfig {
5324
+ /** The overlap between chunks. */
5325
+ chunkOverlap?: number;
5326
+ /** The size of the chunks. */
5327
+ chunkSize?: number;
5328
+ }
5329
+ interface GoogleCloudAiplatformV1beta1RagQuery {
5330
+ /** Optional. The number of contexts to retrieve. */
5331
+ similarityTopK?: number;
5332
+ /** Optional. The query in text format to get relevant contexts. */
5333
+ text?: string;
5334
+ }
5207
5335
  interface GoogleCloudAiplatformV1beta1RawPredictRequest {
5208
5336
  /** The prediction input. Supports HTTP headers and arbitrary data payload. A DeployedModel may have an upper limit on the number of instances it supports per request. When this limit it is exceeded for an AutoML model, the RawPredict method returns an error. When this limit is exceeded for a custom-trained model, the behavior varies depending on the model. You can specify the schema for each instance in the predict_schemata.instance_schema_uri field when you create a Model. This schema applies when you deploy the `Model` as a `DeployedModel` to an Endpoint and use the `RawPredict` method. */
5209
5337
  httpBody?: GoogleApiHttpBody;
@@ -5421,6 +5549,30 @@ declare namespace gapi.client {
5421
5549
  /** Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. */
5422
5550
  vertexRagStore?: GoogleCloudAiplatformV1beta1VertexRagStore;
5423
5551
  }
5552
+ interface GoogleCloudAiplatformV1beta1RetrieveContextsRequest {
5553
+ /** Required. Single RAG retrieve query. */
5554
+ query?: GoogleCloudAiplatformV1beta1RagQuery;
5555
+ /** The data source for Vertex RagStore. */
5556
+ vertexRagStore?: GoogleCloudAiplatformV1beta1RetrieveContextsRequestVertexRagStore;
5557
+ }
5558
+ interface GoogleCloudAiplatformV1beta1RetrieveContextsRequestVertexRagStore {
5559
+ /** Optional. Deprecated. Please use rag_resources to specify the data source. */
5560
+ ragCorpora?: string[];
5561
+ /** 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. */
5562
+ ragResources?: GoogleCloudAiplatformV1beta1RetrieveContextsRequestVertexRagStoreRagResource[];
5563
+ /** Optional. Only return contexts with vector distance smaller than the threshold. */
5564
+ vectorDistanceThreshold?: number;
5565
+ }
5566
+ interface GoogleCloudAiplatformV1beta1RetrieveContextsRequestVertexRagStoreRagResource {
5567
+ /** Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` */
5568
+ ragCorpus?: string;
5569
+ /** Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. */
5570
+ ragFileIds?: string[];
5571
+ }
5572
+ interface GoogleCloudAiplatformV1beta1RetrieveContextsResponse {
5573
+ /** The contexts of the query. */
5574
+ contexts?: GoogleCloudAiplatformV1beta1RagContexts;
5575
+ }
5424
5576
  interface GoogleCloudAiplatformV1beta1RougeInput {
5425
5577
  /** Required. Repeated rouge instances. */
5426
5578
  instances?: GoogleCloudAiplatformV1beta1RougeInstance[];
@@ -5464,7 +5616,9 @@ declare namespace gapi.client {
5464
5616
  fileOutputGcsBucket?: string;
5465
5617
  }
5466
5618
  interface GoogleCloudAiplatformV1beta1RuntimeConfigVertexAISearchRuntimeConfig {
5467
- /** Required. Vertext AI Search serving config name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config}` */
5619
+ /** 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. */
5620
+ appId?: string;
5621
+ /** [Deprecated] Please use app_id instead. Vertex AI Search serving config name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config}` */
5468
5622
  servingConfigName?: string;
5469
5623
  }
5470
5624
  interface GoogleCloudAiplatformV1beta1SafetyInput {
@@ -5564,6 +5718,8 @@ declare namespace gapi.client {
5564
5718
  catchUp?: boolean;
5565
5719
  /** Request for ModelMonitoringService.CreateModelMonitoringJob. */
5566
5720
  createModelMonitoringJobRequest?: GoogleCloudAiplatformV1beta1CreateModelMonitoringJobRequest;
5721
+ /** Request for NotebookService.CreateNotebookExecutionJob. */
5722
+ createNotebookExecutionJobRequest?: GoogleCloudAiplatformV1beta1CreateNotebookExecutionJobRequest;
5567
5723
  /** Request for PipelineService.CreatePipelineJob. CreatePipelineJobRequest.parent field is required (format: projects/{project}/locations/{location}). */
5568
5724
  createPipelineJobRequest?: GoogleCloudAiplatformV1beta1CreatePipelineJobRequest;
5569
5725
  /** Output only. Timestamp when this Schedule was created. */
@@ -7418,6 +7574,66 @@ declare namespace gapi.client {
7418
7574
  /** Optional. Which version to use for evaluation. */
7419
7575
  version?: number;
7420
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
+ }
7421
7637
  interface GoogleCloudAiplatformV1beta1SyncFeatureViewRequest {}
7422
7638
  interface GoogleCloudAiplatformV1beta1SyncFeatureViewResponse {
7423
7639
  /** Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}/featureViewSyncs/{feature_view_sync}` */
@@ -7798,6 +8014,50 @@ declare namespace gapi.client {
7798
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'. */
7799
8015
  value?: any;
7800
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
+ }
7801
8061
  interface GoogleCloudAiplatformV1beta1UndeployIndexOperationMetadata {
7802
8062
  /** The operation generic information. */
7803
8063
  genericMetadata?: GoogleCloudAiplatformV1beta1GenericOperationMetadata;
@@ -7920,6 +8180,22 @@ declare namespace gapi.client {
7920
8180
  /** Output only. The version ID of the model that is uploaded. */
7921
8181
  modelVersionId?: string;
7922
8182
  }
8183
+ interface GoogleCloudAiplatformV1beta1UploadRagFileConfig {
8184
+ /** Specifies the size and overlap of chunks after uploading RagFile. */
8185
+ ragFileChunkingConfig?: GoogleCloudAiplatformV1beta1RagFileChunkingConfig;
8186
+ }
8187
+ interface GoogleCloudAiplatformV1beta1UploadRagFileRequest {
8188
+ /** Required. The RagFile to upload. */
8189
+ ragFile?: GoogleCloudAiplatformV1beta1RagFile;
8190
+ /** Required. The config for the RagFiles to be uploaded into the RagCorpus. VertexRagDataService.UploadRagFile. */
8191
+ uploadRagFileConfig?: GoogleCloudAiplatformV1beta1UploadRagFileConfig;
8192
+ }
8193
+ interface GoogleCloudAiplatformV1beta1UploadRagFileResponse {
8194
+ /** The error that occurred while processing the RagFile. */
8195
+ error?: GoogleRpcStatus;
8196
+ /** The RagFile that had been uploaded into the RagCorpus. */
8197
+ ragFile?: GoogleCloudAiplatformV1beta1RagFile;
8198
+ }
7923
8199
  interface GoogleCloudAiplatformV1beta1UpsertDatapointsRequest {
7924
8200
  /** A list of datapoints to be created/updated. */
7925
8201
  datapoints?: GoogleCloudAiplatformV1beta1IndexDatapoint[];
@@ -7948,13 +8224,21 @@ declare namespace gapi.client {
7948
8224
  datastore?: string;
7949
8225
  }
7950
8226
  interface GoogleCloudAiplatformV1beta1VertexRagStore {
7951
- /** 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. */
8227
+ /** Optional. Deprecated. Please use rag_resources instead. */
7952
8228
  ragCorpora?: string[];
8229
+ /** 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. */
8230
+ ragResources?: GoogleCloudAiplatformV1beta1VertexRagStoreRagResource[];
7953
8231
  /** Optional. Number of top k results to return from the selected corpora. */
7954
8232
  similarityTopK?: number;
7955
8233
  /** Optional. Only return results with vector distance smaller than the threshold. */
7956
8234
  vectorDistanceThreshold?: number;
7957
8235
  }
8236
+ interface GoogleCloudAiplatformV1beta1VertexRagStoreRagResource {
8237
+ /** Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` */
8238
+ ragCorpus?: string;
8239
+ /** Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. */
8240
+ ragFileIds?: string[];
8241
+ }
7958
8242
  interface GoogleCloudAiplatformV1beta1VideoMetadata {
7959
8243
  /** Optional. The end offset of the video. */
7960
8244
  endOffset?: string;
@@ -8228,6 +8512,10 @@ declare namespace gapi.client {
8228
8512
  /** The recitation result against model training data. */
8229
8513
  trainingSegmentResults?: LanguageLabsAidaTrustRecitationProtoSegmentResult[];
8230
8514
  }
8515
+ interface LearningGenaiRecitationContentChunkRecitationCheckResult {
8516
+ imageResult?: LearningGenaiRecitationImageRecitationCheckResult;
8517
+ textResult?: LearningGenaiRecitationRecitationResult;
8518
+ }
8231
8519
  interface LearningGenaiRecitationDocAttribution {
8232
8520
  amarnaId?: string;
8233
8521
  arxivId?: string;
@@ -8269,6 +8557,33 @@ declare namespace gapi.client {
8269
8557
  wikipediaArticleTitle?: string;
8270
8558
  youtubeVideoId?: string;
8271
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
+ }
8272
8587
  interface LearningGenaiRecitationRecitationResult {
8273
8588
  dynamicSegmentResults?: LearningGenaiRecitationSegmentResult[];
8274
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. */
@@ -8483,6 +8798,8 @@ declare namespace gapi.client {
8483
8798
  factRetrievalMillisecondsByProvider?: {[P in string]: string};
8484
8799
  /** Latency spent on prompt2query. The procedure generates a search-friendly query given the original prompt. */
8485
8800
  prompt2queryMilliseconds?: string;
8801
+ /** Latency if use GroundedGeneration service for the whole retrieval & augmentation. */
8802
+ retrievalAugmentMilliseconds?: string;
8486
8803
  }
8487
8804
  interface LearningGenaiRootRAIOutput {
8488
8805
  allowed?: boolean;
@@ -8496,6 +8813,42 @@ declare namespace gapi.client {
8496
8813
  /** Regex used to decide that query or response should be taken down. Empty when query or response is kept. */
8497
8814
  takedownRegex?: string;
8498
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
+ }
8499
8852
  interface LearningGenaiRootRequestResponseTakedownResult {
8500
8853
  /** False when response has to be taken down per above config. */
8501
8854
  allowed?: boolean;
@@ -8620,7 +8973,12 @@ declare namespace gapi.client {
8620
8973
  /** The sum of the size of all the contents in the request. */
8621
8974
  totalContentSize?: string;
8622
8975
  }
8976
+ interface LearningServingLlmAtlasOutputMetadata {
8977
+ requestTopic?: string;
8978
+ source?: string;
8979
+ }
8623
8980
  interface LearningServingLlmMessageMetadata {
8981
+ atlasMetadata?: LearningServingLlmAtlasOutputMetadata;
8624
8982
  /** Summary of classifier output. We attach this to all messages regardless of whether classification rules triggered or not. */
8625
8983
  classifierSummary?: LearningGenaiRootClassifierOutputSummary;
8626
8984
  /** Contains metadata related to Codey Processors. */
@@ -8645,22 +9003,30 @@ declare namespace gapi.client {
8645
9003
  language?: string;
8646
9004
  /** The LM prefix used to generate this response. */
8647
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;
8648
9012
  /** The original text generated by LLM. This is the raw output for debugging purposes. */
8649
9013
  originalText?: string;
8650
- /** 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. */
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. */
8651
9015
  perStreamDecodedTokenCount?: number;
9016
+ /** 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. */
9017
+ perStreamReturnedTokenCount?: number;
8652
9018
  /** 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. */
8653
9019
  raiOutputs?: LearningGenaiRootRAIOutput[];
8654
9020
  /** Recitation Results. It will be populated as long as Recitation processing is enabled, regardless of recitation outcome. */
8655
9021
  recitationResult?: LearningGenaiRecitationRecitationResult;
8656
- /** NOT YET IMPLEMENTED. Number of tokens returned as part of this candidate. */
8657
- returnTokenCount?: number;
8658
9022
  /** All the different scores for a message are logged here. */
8659
9023
  scores?: LearningGenaiRootScore[];
8660
9024
  /** Whether the response is terminated during streaming return. Only used for streaming requests. */
8661
9025
  streamTerminated?: boolean;
8662
9026
  /** 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. */
8663
9027
  totalDecodedTokenCount?: number;
9028
+ /** 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. */
9029
+ totalReturnedTokenCount?: number;
8664
9030
  /** 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. */
8665
9031
  translatedUserPrompts?: string[];
8666
9032
  /** The metadata from Vertex SafetyCat processors */
@@ -8712,6 +9078,66 @@ declare namespace gapi.client {
8712
9078
  /** The following are usually only present when code != 0 Space to which this status belongs */
8713
9079
  space?: string;
8714
9080
  }
9081
+ interface MediaResource {
9082
+ /** Upload a file into a RagCorpus. */
9083
+ upload(request: {
9084
+ /** V1 error format. */
9085
+ '$.xgafv'?: string;
9086
+ /** OAuth access token. */
9087
+ access_token?: string;
9088
+ /** Data format for response. */
9089
+ alt?: string;
9090
+ /** JSONP */
9091
+ callback?: string;
9092
+ /** Selector specifying which fields to include in a partial response. */
9093
+ fields?: string;
9094
+ /** 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. */
9095
+ key?: string;
9096
+ /** OAuth 2.0 token for the current user. */
9097
+ oauth_token?: string;
9098
+ /** Required. The name of the RagCorpus resource into which to upload the file. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` */
9099
+ parent: string;
9100
+ /** Returns response with indentations and line breaks. */
9101
+ prettyPrint?: boolean;
9102
+ /** 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. */
9103
+ quotaUser?: string;
9104
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
9105
+ upload_protocol?: string;
9106
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
9107
+ uploadType?: string;
9108
+ /** Request body */
9109
+ resource: GoogleCloudAiplatformV1beta1UploadRagFileRequest;
9110
+ }): Request<GoogleCloudAiplatformV1beta1UploadRagFileResponse>;
9111
+ upload(
9112
+ request: {
9113
+ /** V1 error format. */
9114
+ '$.xgafv'?: string;
9115
+ /** OAuth access token. */
9116
+ access_token?: string;
9117
+ /** Data format for response. */
9118
+ alt?: string;
9119
+ /** JSONP */
9120
+ callback?: string;
9121
+ /** Selector specifying which fields to include in a partial response. */
9122
+ fields?: string;
9123
+ /** 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. */
9124
+ key?: string;
9125
+ /** OAuth 2.0 token for the current user. */
9126
+ oauth_token?: string;
9127
+ /** Required. The name of the RagCorpus resource into which to upload the file. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` */
9128
+ parent: string;
9129
+ /** Returns response with indentations and line breaks. */
9130
+ prettyPrint?: boolean;
9131
+ /** 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. */
9132
+ quotaUser?: string;
9133
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
9134
+ upload_protocol?: string;
9135
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
9136
+ uploadType?: string;
9137
+ },
9138
+ body: GoogleCloudAiplatformV1beta1UploadRagFileRequest
9139
+ ): Request<GoogleCloudAiplatformV1beta1UploadRagFileResponse>;
9140
+ }
8715
9141
  interface OperationsResource {
8716
9142
  /** Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. */
8717
9143
  cancel(request?: {
@@ -10623,6 +11049,68 @@ declare namespace gapi.client {
10623
11049
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
10624
11050
  uploadType?: string;
10625
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>;
10626
11114
  /** Restores a dataset version. */
10627
11115
  restore(request?: {
10628
11116
  /** V1 error format. */
@@ -26477,15 +26965,8 @@ declare namespace gapi.client {
26477
26965
  }): Request<GoogleLongrunningOperation>;
26478
26966
  }
26479
26967
  interface RagFilesResource {
26480
- operations: OperationsResource;
26481
- }
26482
- interface RagCorporaResource {
26483
- operations: OperationsResource;
26484
- ragFiles: RagFilesResource;
26485
- }
26486
- interface OperationsResource {
26487
- /** Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. */
26488
- cancel(request?: {
26968
+ /** Deletes a RagFile. */
26969
+ delete(request?: {
26489
26970
  /** V1 error format. */
26490
26971
  '$.xgafv'?: string;
26491
26972
  /** OAuth access token. */
@@ -26498,7 +26979,7 @@ declare namespace gapi.client {
26498
26979
  fields?: string;
26499
26980
  /** 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. */
26500
26981
  key?: string;
26501
- /** The name of the operation resource to be cancelled. */
26982
+ /** Required. The name of the RagFile resource to be deleted. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}` */
26502
26983
  name: string;
26503
26984
  /** OAuth 2.0 token for the current user. */
26504
26985
  oauth_token?: string;
@@ -26510,9 +26991,9 @@ declare namespace gapi.client {
26510
26991
  upload_protocol?: string;
26511
26992
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
26512
26993
  uploadType?: string;
26513
- }): Request<{}>;
26514
- /** Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. */
26515
- delete(request?: {
26994
+ }): Request<GoogleLongrunningOperation>;
26995
+ /** Gets a RagFile. */
26996
+ get(request?: {
26516
26997
  /** V1 error format. */
26517
26998
  '$.xgafv'?: string;
26518
26999
  /** OAuth access token. */
@@ -26525,7 +27006,7 @@ declare namespace gapi.client {
26525
27006
  fields?: string;
26526
27007
  /** 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. */
26527
27008
  key?: string;
26528
- /** The name of the operation resource to be deleted. */
27009
+ /** Required. The name of the RagFile resource. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}` */
26529
27010
  name: string;
26530
27011
  /** OAuth 2.0 token for the current user. */
26531
27012
  oauth_token?: string;
@@ -26537,9 +27018,9 @@ declare namespace gapi.client {
26537
27018
  upload_protocol?: string;
26538
27019
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
26539
27020
  uploadType?: string;
26540
- }): Request<{}>;
26541
- /** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
26542
- get(request?: {
27021
+ }): Request<GoogleCloudAiplatformV1beta1RagFile>;
27022
+ /** Import files from Google Cloud Storage or Google Drive into a RagCorpus. */
27023
+ import(request: {
26543
27024
  /** V1 error format. */
26544
27025
  '$.xgafv'?: string;
26545
27026
  /** OAuth access token. */
@@ -26552,10 +27033,10 @@ declare namespace gapi.client {
26552
27033
  fields?: string;
26553
27034
  /** 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. */
26554
27035
  key?: string;
26555
- /** The name of the operation resource. */
26556
- name: string;
26557
27036
  /** OAuth 2.0 token for the current user. */
26558
27037
  oauth_token?: string;
27038
+ /** Required. The name of the RagCorpus resource into which to import files. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` */
27039
+ parent: string;
26559
27040
  /** Returns response with indentations and line breaks. */
26560
27041
  prettyPrint?: boolean;
26561
27042
  /** 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. */
@@ -26564,8 +27045,39 @@ declare namespace gapi.client {
26564
27045
  upload_protocol?: string;
26565
27046
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
26566
27047
  uploadType?: string;
27048
+ /** Request body */
27049
+ resource: GoogleCloudAiplatformV1beta1ImportRagFilesRequest;
26567
27050
  }): Request<GoogleLongrunningOperation>;
26568
- /** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
27051
+ import(
27052
+ request: {
27053
+ /** V1 error format. */
27054
+ '$.xgafv'?: string;
27055
+ /** OAuth access token. */
27056
+ access_token?: string;
27057
+ /** Data format for response. */
27058
+ alt?: string;
27059
+ /** JSONP */
27060
+ callback?: string;
27061
+ /** Selector specifying which fields to include in a partial response. */
27062
+ fields?: string;
27063
+ /** 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. */
27064
+ key?: string;
27065
+ /** OAuth 2.0 token for the current user. */
27066
+ oauth_token?: string;
27067
+ /** Required. The name of the RagCorpus resource into which to import files. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` */
27068
+ parent: string;
27069
+ /** Returns response with indentations and line breaks. */
27070
+ prettyPrint?: boolean;
27071
+ /** 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. */
27072
+ quotaUser?: string;
27073
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
27074
+ upload_protocol?: string;
27075
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
27076
+ uploadType?: string;
27077
+ },
27078
+ body: GoogleCloudAiplatformV1beta1ImportRagFilesRequest
27079
+ ): Request<GoogleLongrunningOperation>;
27080
+ /** Lists RagFiles in a RagCorpus. */
26569
27081
  list(request?: {
26570
27082
  /** V1 error format. */
26571
27083
  '$.xgafv'?: string;
@@ -26577,18 +27089,16 @@ declare namespace gapi.client {
26577
27089
  callback?: string;
26578
27090
  /** Selector specifying which fields to include in a partial response. */
26579
27091
  fields?: string;
26580
- /** The standard list filter. */
26581
- filter?: string;
26582
27092
  /** 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. */
26583
27093
  key?: string;
26584
- /** The name of the operation's parent resource. */
26585
- name: string;
26586
27094
  /** OAuth 2.0 token for the current user. */
26587
27095
  oauth_token?: string;
26588
- /** The standard list page size. */
27096
+ /** Optional. The standard list page size. */
26589
27097
  pageSize?: number;
26590
- /** The standard list page token. */
27098
+ /** Optional. The standard list page token. Typically obtained via ListRagFilesResponse.next_page_token of the previous VertexRagDataService.ListRagFiles call. */
26591
27099
  pageToken?: string;
27100
+ /** Required. The resource name of the RagCorpus from which to list the RagFiles. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` */
27101
+ parent: string;
26592
27102
  /** Returns response with indentations and line breaks. */
26593
27103
  prettyPrint?: boolean;
26594
27104
  /** 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. */
@@ -26597,9 +27107,12 @@ declare namespace gapi.client {
26597
27107
  upload_protocol?: string;
26598
27108
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
26599
27109
  uploadType?: string;
26600
- }): Request<GoogleLongrunningListOperationsResponse>;
26601
- /** Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. */
26602
- wait(request?: {
27110
+ }): Request<GoogleCloudAiplatformV1beta1ListRagFilesResponse>;
27111
+ operations: OperationsResource;
27112
+ }
27113
+ interface RagCorporaResource {
27114
+ /** Creates a RagCorpus. */
27115
+ create(request: {
26603
27116
  /** V1 error format. */
26604
27117
  '$.xgafv'?: string;
26605
27118
  /** OAuth access token. */
@@ -26612,16 +27125,279 @@ declare namespace gapi.client {
26612
27125
  fields?: string;
26613
27126
  /** 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. */
26614
27127
  key?: string;
26615
- /** The name of the operation resource to wait on. */
26616
- name: string;
26617
27128
  /** OAuth 2.0 token for the current user. */
26618
27129
  oauth_token?: string;
27130
+ /** Required. The resource name of the Location to create the RagCorpus in. Format: `projects/{project}/locations/{location}` */
27131
+ parent: string;
26619
27132
  /** Returns response with indentations and line breaks. */
26620
27133
  prettyPrint?: boolean;
26621
27134
  /** 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. */
26622
27135
  quotaUser?: string;
26623
- /** The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. */
26624
- timeout?: string;
27136
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
27137
+ upload_protocol?: string;
27138
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
27139
+ uploadType?: string;
27140
+ /** Request body */
27141
+ resource: GoogleCloudAiplatformV1beta1RagCorpus;
27142
+ }): Request<GoogleLongrunningOperation>;
27143
+ create(
27144
+ request: {
27145
+ /** V1 error format. */
27146
+ '$.xgafv'?: string;
27147
+ /** OAuth access token. */
27148
+ access_token?: string;
27149
+ /** Data format for response. */
27150
+ alt?: string;
27151
+ /** JSONP */
27152
+ callback?: string;
27153
+ /** Selector specifying which fields to include in a partial response. */
27154
+ fields?: string;
27155
+ /** 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. */
27156
+ key?: string;
27157
+ /** OAuth 2.0 token for the current user. */
27158
+ oauth_token?: string;
27159
+ /** Required. The resource name of the Location to create the RagCorpus in. Format: `projects/{project}/locations/{location}` */
27160
+ parent: string;
27161
+ /** Returns response with indentations and line breaks. */
27162
+ prettyPrint?: boolean;
27163
+ /** 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. */
27164
+ quotaUser?: string;
27165
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
27166
+ upload_protocol?: string;
27167
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
27168
+ uploadType?: string;
27169
+ },
27170
+ body: GoogleCloudAiplatformV1beta1RagCorpus
27171
+ ): Request<GoogleLongrunningOperation>;
27172
+ /** Deletes a RagCorpus. */
27173
+ delete(request?: {
27174
+ /** V1 error format. */
27175
+ '$.xgafv'?: string;
27176
+ /** OAuth access token. */
27177
+ access_token?: string;
27178
+ /** Data format for response. */
27179
+ alt?: string;
27180
+ /** JSONP */
27181
+ callback?: string;
27182
+ /** Selector specifying which fields to include in a partial response. */
27183
+ fields?: string;
27184
+ /** 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. */
27185
+ force?: boolean;
27186
+ /** 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. */
27187
+ key?: string;
27188
+ /** Required. The name of the RagCorpus resource to be deleted. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` */
27189
+ name: string;
27190
+ /** OAuth 2.0 token for the current user. */
27191
+ oauth_token?: string;
27192
+ /** Returns response with indentations and line breaks. */
27193
+ prettyPrint?: boolean;
27194
+ /** 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. */
27195
+ quotaUser?: string;
27196
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
27197
+ upload_protocol?: string;
27198
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
27199
+ uploadType?: string;
27200
+ }): Request<GoogleLongrunningOperation>;
27201
+ /** Gets a RagCorpus. */
27202
+ get(request?: {
27203
+ /** V1 error format. */
27204
+ '$.xgafv'?: string;
27205
+ /** OAuth access token. */
27206
+ access_token?: string;
27207
+ /** Data format for response. */
27208
+ alt?: string;
27209
+ /** JSONP */
27210
+ callback?: string;
27211
+ /** Selector specifying which fields to include in a partial response. */
27212
+ fields?: string;
27213
+ /** 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. */
27214
+ key?: string;
27215
+ /** Required. The name of the RagCorpus resource. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` */
27216
+ name: string;
27217
+ /** OAuth 2.0 token for the current user. */
27218
+ oauth_token?: string;
27219
+ /** Returns response with indentations and line breaks. */
27220
+ prettyPrint?: boolean;
27221
+ /** 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. */
27222
+ quotaUser?: string;
27223
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
27224
+ upload_protocol?: string;
27225
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
27226
+ uploadType?: string;
27227
+ }): Request<GoogleCloudAiplatformV1beta1RagCorpus>;
27228
+ /** Lists RagCorpora in a Location. */
27229
+ list(request?: {
27230
+ /** V1 error format. */
27231
+ '$.xgafv'?: string;
27232
+ /** OAuth access token. */
27233
+ access_token?: string;
27234
+ /** Data format for response. */
27235
+ alt?: string;
27236
+ /** JSONP */
27237
+ callback?: string;
27238
+ /** Selector specifying which fields to include in a partial response. */
27239
+ fields?: string;
27240
+ /** 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. */
27241
+ key?: string;
27242
+ /** OAuth 2.0 token for the current user. */
27243
+ oauth_token?: string;
27244
+ /** Optional. The standard list page size. */
27245
+ pageSize?: number;
27246
+ /** Optional. The standard list page token. Typically obtained via ListRagCorporaResponse.next_page_token of the previous VertexRagDataService.ListRagCorpora call. */
27247
+ pageToken?: string;
27248
+ /** Required. The resource name of the Location from which to list the RagCorpora. Format: `projects/{project}/locations/{location}` */
27249
+ parent: string;
27250
+ /** Returns response with indentations and line breaks. */
27251
+ prettyPrint?: boolean;
27252
+ /** 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. */
27253
+ quotaUser?: string;
27254
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
27255
+ upload_protocol?: string;
27256
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
27257
+ uploadType?: string;
27258
+ }): Request<GoogleCloudAiplatformV1beta1ListRagCorporaResponse>;
27259
+ operations: OperationsResource;
27260
+ ragFiles: RagFilesResource;
27261
+ }
27262
+ interface OperationsResource {
27263
+ /** Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. */
27264
+ cancel(request?: {
27265
+ /** V1 error format. */
27266
+ '$.xgafv'?: string;
27267
+ /** OAuth access token. */
27268
+ access_token?: string;
27269
+ /** Data format for response. */
27270
+ alt?: string;
27271
+ /** JSONP */
27272
+ callback?: string;
27273
+ /** Selector specifying which fields to include in a partial response. */
27274
+ fields?: string;
27275
+ /** 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. */
27276
+ key?: string;
27277
+ /** The name of the operation resource to be cancelled. */
27278
+ name: string;
27279
+ /** OAuth 2.0 token for the current user. */
27280
+ oauth_token?: string;
27281
+ /** Returns response with indentations and line breaks. */
27282
+ prettyPrint?: boolean;
27283
+ /** 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. */
27284
+ quotaUser?: string;
27285
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
27286
+ upload_protocol?: string;
27287
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
27288
+ uploadType?: string;
27289
+ }): Request<{}>;
27290
+ /** Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. */
27291
+ delete(request?: {
27292
+ /** V1 error format. */
27293
+ '$.xgafv'?: string;
27294
+ /** OAuth access token. */
27295
+ access_token?: string;
27296
+ /** Data format for response. */
27297
+ alt?: string;
27298
+ /** JSONP */
27299
+ callback?: string;
27300
+ /** Selector specifying which fields to include in a partial response. */
27301
+ fields?: string;
27302
+ /** 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. */
27303
+ key?: string;
27304
+ /** The name of the operation resource to be deleted. */
27305
+ name: string;
27306
+ /** OAuth 2.0 token for the current user. */
27307
+ oauth_token?: string;
27308
+ /** Returns response with indentations and line breaks. */
27309
+ prettyPrint?: boolean;
27310
+ /** 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. */
27311
+ quotaUser?: string;
27312
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
27313
+ upload_protocol?: string;
27314
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
27315
+ uploadType?: string;
27316
+ }): Request<{}>;
27317
+ /** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
27318
+ get(request?: {
27319
+ /** V1 error format. */
27320
+ '$.xgafv'?: string;
27321
+ /** OAuth access token. */
27322
+ access_token?: string;
27323
+ /** Data format for response. */
27324
+ alt?: string;
27325
+ /** JSONP */
27326
+ callback?: string;
27327
+ /** Selector specifying which fields to include in a partial response. */
27328
+ fields?: string;
27329
+ /** 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. */
27330
+ key?: string;
27331
+ /** The name of the operation resource. */
27332
+ name: string;
27333
+ /** OAuth 2.0 token for the current user. */
27334
+ oauth_token?: string;
27335
+ /** Returns response with indentations and line breaks. */
27336
+ prettyPrint?: boolean;
27337
+ /** 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. */
27338
+ quotaUser?: string;
27339
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
27340
+ upload_protocol?: string;
27341
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
27342
+ uploadType?: string;
27343
+ }): Request<GoogleLongrunningOperation>;
27344
+ /** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
27345
+ list(request?: {
27346
+ /** V1 error format. */
27347
+ '$.xgafv'?: string;
27348
+ /** OAuth access token. */
27349
+ access_token?: string;
27350
+ /** Data format for response. */
27351
+ alt?: string;
27352
+ /** JSONP */
27353
+ callback?: string;
27354
+ /** Selector specifying which fields to include in a partial response. */
27355
+ fields?: string;
27356
+ /** The standard list filter. */
27357
+ filter?: string;
27358
+ /** 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. */
27359
+ key?: string;
27360
+ /** The name of the operation's parent resource. */
27361
+ name: string;
27362
+ /** OAuth 2.0 token for the current user. */
27363
+ oauth_token?: string;
27364
+ /** The standard list page size. */
27365
+ pageSize?: number;
27366
+ /** The standard list page token. */
27367
+ pageToken?: string;
27368
+ /** Returns response with indentations and line breaks. */
27369
+ prettyPrint?: boolean;
27370
+ /** 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. */
27371
+ quotaUser?: string;
27372
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
27373
+ upload_protocol?: string;
27374
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
27375
+ uploadType?: string;
27376
+ }): Request<GoogleLongrunningListOperationsResponse>;
27377
+ /** Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. */
27378
+ wait(request?: {
27379
+ /** V1 error format. */
27380
+ '$.xgafv'?: string;
27381
+ /** OAuth access token. */
27382
+ access_token?: string;
27383
+ /** Data format for response. */
27384
+ alt?: string;
27385
+ /** JSONP */
27386
+ callback?: string;
27387
+ /** Selector specifying which fields to include in a partial response. */
27388
+ fields?: string;
27389
+ /** 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. */
27390
+ key?: string;
27391
+ /** The name of the operation resource to wait on. */
27392
+ name: string;
27393
+ /** OAuth 2.0 token for the current user. */
27394
+ oauth_token?: string;
27395
+ /** Returns response with indentations and line breaks. */
27396
+ prettyPrint?: boolean;
27397
+ /** 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. */
27398
+ quotaUser?: string;
27399
+ /** The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. */
27400
+ timeout?: string;
26625
27401
  /** Upload protocol for media (e.g. "raw", "multipart"). */
26626
27402
  upload_protocol?: string;
26627
27403
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
@@ -30982,6 +31758,184 @@ declare namespace gapi.client {
30982
31758
  }): Request<GoogleCloudAiplatformV1beta1ListTrainingPipelinesResponse>;
30983
31759
  operations: OperationsResource;
30984
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
+ }
30985
31939
  interface LocationsResource {
30986
31940
  /** Evaluates instances based on a given metric. */
30987
31941
  evaluateInstances(request: {
@@ -31101,6 +32055,64 @@ declare namespace gapi.client {
31101
32055
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
31102
32056
  uploadType?: string;
31103
32057
  }): Request<GoogleCloudLocationListLocationsResponse>;
32058
+ /** Retrieves relevant contexts for a query. */
32059
+ retrieveContexts(request: {
32060
+ /** V1 error format. */
32061
+ '$.xgafv'?: string;
32062
+ /** OAuth access token. */
32063
+ access_token?: string;
32064
+ /** Data format for response. */
32065
+ alt?: string;
32066
+ /** JSONP */
32067
+ callback?: string;
32068
+ /** Selector specifying which fields to include in a partial response. */
32069
+ fields?: string;
32070
+ /** 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. */
32071
+ key?: string;
32072
+ /** OAuth 2.0 token for the current user. */
32073
+ oauth_token?: string;
32074
+ /** 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}`. */
32075
+ parent: string;
32076
+ /** Returns response with indentations and line breaks. */
32077
+ prettyPrint?: boolean;
32078
+ /** 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. */
32079
+ quotaUser?: string;
32080
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
32081
+ upload_protocol?: string;
32082
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
32083
+ uploadType?: string;
32084
+ /** Request body */
32085
+ resource: GoogleCloudAiplatformV1beta1RetrieveContextsRequest;
32086
+ }): Request<GoogleCloudAiplatformV1beta1RetrieveContextsResponse>;
32087
+ retrieveContexts(
32088
+ request: {
32089
+ /** V1 error format. */
32090
+ '$.xgafv'?: string;
32091
+ /** OAuth access token. */
32092
+ access_token?: string;
32093
+ /** Data format for response. */
32094
+ alt?: string;
32095
+ /** JSONP */
32096
+ callback?: string;
32097
+ /** Selector specifying which fields to include in a partial response. */
32098
+ fields?: string;
32099
+ /** 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. */
32100
+ key?: string;
32101
+ /** OAuth 2.0 token for the current user. */
32102
+ oauth_token?: string;
32103
+ /** 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}`. */
32104
+ parent: string;
32105
+ /** Returns response with indentations and line breaks. */
32106
+ prettyPrint?: boolean;
32107
+ /** 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. */
32108
+ quotaUser?: string;
32109
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
32110
+ upload_protocol?: string;
32111
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
32112
+ uploadType?: string;
32113
+ },
32114
+ body: GoogleCloudAiplatformV1beta1RetrieveContextsRequest
32115
+ ): Request<GoogleCloudAiplatformV1beta1RetrieveContextsResponse>;
31104
32116
  agents: AgentsResource;
31105
32117
  apps: AppsResource;
31106
32118
  batchPredictionJobs: BatchPredictionJobsResource;
@@ -31141,6 +32153,7 @@ declare namespace gapi.client {
31141
32153
  studies: StudiesResource;
31142
32154
  tensorboards: TensorboardsResource;
31143
32155
  trainingPipelines: TrainingPipelinesResource;
32156
+ tuningJobs: TuningJobsResource;
31144
32157
  }
31145
32158
  interface ProjectsResource {
31146
32159
  /** Gets a GenAI cache config. */
@@ -31306,6 +32319,8 @@ declare namespace gapi.client {
31306
32319
  models: ModelsResource;
31307
32320
  }
31308
32321
 
32322
+ const media: MediaResource;
32323
+
31309
32324
  const projects: ProjectsResource;
31310
32325
 
31311
32326
  const publishers: PublishersResource;