@maxim_mazurok/gapi.client.aiplatform-v1 0.0.20241007 → 0.0.20241026

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 +483 -8
  2. package/package.json +1 -1
  3. package/readme.md +10 -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=v1
12
- // Revision: 20241007
12
+ // Revision: 20241026
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -123,6 +123,10 @@ declare namespace gapi.client {
123
123
  passedSemanticFilter?: boolean;
124
124
  }
125
125
  interface CloudAiLargeModelsVisionVideo {
126
+ /** Base 64 encoded video bytes. */
127
+ encodedVideo?: string;
128
+ /** Video encoding, for example "video/mp4". */
129
+ encoding?: string;
126
130
  /** Path to another storage (typically Google Cloud Storage). */
127
131
  uri?: string;
128
132
  /** Raw bytes. */
@@ -534,6 +538,12 @@ declare namespace gapi.client {
534
538
  /** A list of bool values. */
535
539
  values?: boolean[];
536
540
  }
541
+ interface GoogleCloudAiplatformV1CacheConfig {
542
+ /** If set to true, disables GenAI caching. Otherwise caching is enabled. */
543
+ disableCache?: boolean;
544
+ /** Identifier. Name of the cache config. Format: - `projects/{project}/cacheConfig`. */
545
+ name?: string;
546
+ }
537
547
  interface GoogleCloudAiplatformV1CancelBatchPredictionJobRequest {}
538
548
  interface GoogleCloudAiplatformV1CancelCustomJobRequest {}
539
549
  interface GoogleCloudAiplatformV1CancelDataLabelingJobRequest {}
@@ -593,6 +603,10 @@ declare namespace gapi.client {
593
603
  /** Output only. List of citations. */
594
604
  citations?: GoogleCloudAiplatformV1Citation[];
595
605
  }
606
+ interface GoogleCloudAiplatformV1ClientConnectionConfig {
607
+ /** Customizable online prediction request timeout. */
608
+ inferenceTimeout?: string;
609
+ }
596
610
  interface GoogleCloudAiplatformV1CoherenceInput {
597
611
  /** Required. Coherence instance. */
598
612
  instance?: GoogleCloudAiplatformV1CoherenceInstance;
@@ -914,8 +928,6 @@ declare namespace gapi.client {
914
928
  persistentResourceId?: string;
915
929
  /** The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location. List of supported locations: https://cloud.google.com/vertex-ai/docs/general/locations */
916
930
  protectedArtifactLocationId?: string;
917
- /** Optional. Configuration for PSC-I for CustomJob. */
918
- pscInterfaceConfig?: any;
919
931
  /** Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this job. If set, we will deploy the job within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. */
920
932
  reservedIpRanges?: string[];
921
933
  /** Scheduling options for a CustomJob. */
@@ -1184,6 +1196,8 @@ declare namespace gapi.client {
1184
1196
  serviceAccount?: string;
1185
1197
  /** The resource name of the shared DeploymentResourcePool to deploy on. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}` */
1186
1198
  sharedResources?: string;
1199
+ /** System labels to apply to Model Garden deployments. System labels are managed by Google for internal use only. */
1200
+ systemLabels?: {[P in string]: string};
1187
1201
  }
1188
1202
  interface GoogleCloudAiplatformV1DeployedModelRef {
1189
1203
  /** Immutable. An ID of a DeployedModel in the above Endpoint. */
@@ -1286,6 +1300,8 @@ declare namespace gapi.client {
1286
1300
  kmsKeyName?: string;
1287
1301
  }
1288
1302
  interface GoogleCloudAiplatformV1Endpoint {
1303
+ /** Configurations that are applied to the endpoint for online prediction. */
1304
+ clientConnectionConfig?: GoogleCloudAiplatformV1ClientConnectionConfig;
1289
1305
  /** Output only. Timestamp when this Endpoint was created. */
1290
1306
  createTime?: string;
1291
1307
  /** Output only. DNS of the dedicated endpoint. Will only be populated if dedicated_endpoint_enabled is true. Format: `https://{endpoint_id}.{region}-{project_number}.prediction.vertexai.goog`. */
@@ -2098,6 +2114,8 @@ declare namespace gapi.client {
2098
2114
  labels?: {[P in string]: string};
2099
2115
  /** Identifier. Name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}` */
2100
2116
  name?: string;
2117
+ /** Optional. Configuration for FeatureView created under Optimized FeatureOnlineStore. */
2118
+ optimizedConfig?: GoogleCloudAiplatformV1FeatureViewOptimizedConfig;
2101
2119
  /** Output only. Reserved for future use. */
2102
2120
  satisfiesPzi?: boolean;
2103
2121
  /** Output only. Reserved for future use. */
@@ -2158,6 +2176,10 @@ declare namespace gapi.client {
2158
2176
  /** Optional. Number of embeddings on each leaf node. The default value is 1000 if not set. */
2159
2177
  leafNodeEmbeddingCount?: string;
2160
2178
  }
2179
+ interface GoogleCloudAiplatformV1FeatureViewOptimizedConfig {
2180
+ /** Optional. A description of resources that the FeatureView uses, which to large degree are decided by Vertex AI, and optionally allows only a modest additional configuration. If min_replica_count is not set, the default value is 2. If max_replica_count is not set, the default value is 6. The max allowed replica count is 1000. */
2181
+ automaticResources?: GoogleCloudAiplatformV1AutomaticResources;
2182
+ }
2161
2183
  interface GoogleCloudAiplatformV1FeatureViewSync {
2162
2184
  /** Output only. Time when this FeatureViewSync is created. Creation of a FeatureViewSync means that the job is pending / waiting for sufficient resources but may not have started the actual data transfer yet. */
2163
2185
  createTime?: string;
@@ -2218,6 +2240,10 @@ declare namespace gapi.client {
2218
2240
  /** Feature value. */
2219
2241
  value?: GoogleCloudAiplatformV1FeatureValue;
2220
2242
  }
2243
+ interface GoogleCloudAiplatformV1FetchPredictOperationRequest {
2244
+ /** Required. The server-assigned name for the operation. */
2245
+ operationName?: string;
2246
+ }
2221
2247
  interface GoogleCloudAiplatformV1FileData {
2222
2248
  /** Required. URI. */
2223
2249
  fileUri?: string;
@@ -2501,6 +2527,8 @@ declare namespace gapi.client {
2501
2527
  web?: GoogleCloudAiplatformV1GroundingChunkWeb;
2502
2528
  }
2503
2529
  interface GoogleCloudAiplatformV1GroundingChunkRetrievedContext {
2530
+ /** Text of the attribution. */
2531
+ text?: string;
2504
2532
  /** Title of the attribution. */
2505
2533
  title?: string;
2506
2534
  /** URI reference of the attribution. */
@@ -3937,6 +3965,8 @@ declare namespace gapi.client {
3937
3965
  interface GoogleCloudAiplatformV1NotebookExecutionJob {
3938
3966
  /** Output only. Timestamp when this NotebookExecutionJob was created. */
3939
3967
  createTime?: string;
3968
+ /** The custom compute configuration for an execution job. */
3969
+ customEnvironmentSpec?: GoogleCloudAiplatformV1NotebookExecutionJobCustomEnvironmentSpec;
3940
3970
  /** The Dataform Repository pointing to a single file notebook repository. */
3941
3971
  dataformRepositorySource?: GoogleCloudAiplatformV1NotebookExecutionJobDataformRepositorySource;
3942
3972
  /** The contents of an input notebook file. */
@@ -3970,6 +4000,14 @@ declare namespace gapi.client {
3970
4000
  /** Output only. Timestamp when this NotebookExecutionJob was most recently updated. */
3971
4001
  updateTime?: string;
3972
4002
  }
4003
+ interface GoogleCloudAiplatformV1NotebookExecutionJobCustomEnvironmentSpec {
4004
+ /** The specification of a single machine for the execution job. */
4005
+ machineSpec?: GoogleCloudAiplatformV1MachineSpec;
4006
+ /** The network configuration to use for the execution job. */
4007
+ networkSpec?: GoogleCloudAiplatformV1NetworkSpec;
4008
+ /** The specification of a persistent disk to attach for the execution job. */
4009
+ persistentDiskSpec?: GoogleCloudAiplatformV1PersistentDiskSpec;
4010
+ }
3973
4011
  interface GoogleCloudAiplatformV1NotebookExecutionJobDataformRepositorySource {
3974
4012
  /** The commit SHA to read repository with. If unset, the file will be read at HEAD. */
3975
4013
  commitSha?: string;
@@ -4384,6 +4422,12 @@ declare namespace gapi.client {
4384
4422
  /** Required. The key is a name of one of the Dataset's data columns. The value of the key (either the label's value or value in the column) must be one of {`training`, `validation`, `test`}, and it defines to which set the given piece of data is assigned. If for a piece of data the key is not present or has an invalid value, that piece is ignored by the pipeline. */
4385
4423
  key?: string;
4386
4424
  }
4425
+ interface GoogleCloudAiplatformV1PredictLongRunningRequest {
4426
+ /** Required. The instances that are the input to the prediction call. A DeployedModel may have an upper limit on the number of instances it supports per request, and when it is exceeded the prediction call errors in case of AutoML Models, or, in case of customer created Models, the behaviour is as documented by that Model. The schema of any single instance may be specified via Endpoint's DeployedModels' Model's PredictSchemata's instance_schema_uri. */
4427
+ instances?: any[];
4428
+ /** Optional. The parameters that govern the prediction. The schema of the parameters may be specified via Endpoint's DeployedModels' Model's PredictSchemata's parameters_schema_uri. */
4429
+ parameters?: any;
4430
+ }
4387
4431
  interface GoogleCloudAiplatformV1PredictRequest {
4388
4432
  /** Required. The instances that are the input to the prediction call. A DeployedModel may have an upper limit on the number of instances it supports per request, and when it is exceeded the prediction call errors in case of AutoML Models, or, in case of customer created Models, the behaviour is as documented by that Model. The schema of any single instance may be specified via Endpoint's DeployedModels' Model's PredictSchemata's instance_schema_uri. */
4389
4433
  instances?: any[];
@@ -4470,7 +4514,6 @@ declare namespace gapi.client {
4470
4514
  /** Required. Project id used to create forwarding rule. */
4471
4515
  projectId?: string;
4472
4516
  }
4473
- interface GoogleCloudAiplatformV1PscInterfaceConfig {}
4474
4517
  interface GoogleCloudAiplatformV1PublisherModel {
4475
4518
  /** Optional. Additional information about the model's Frameworks. */
4476
4519
  frameworks?: string[];
@@ -4546,7 +4589,7 @@ declare namespace gapi.client {
4546
4589
  title?: string;
4547
4590
  }
4548
4591
  interface GoogleCloudAiplatformV1PublisherModelCallToActionDeployDeployMetadata {
4549
- /** Optional. Labels for the deployment. For managing deployment config like verifying, source of deployment config, etc. */
4592
+ /** Optional. Labels for the deployment config. For managing deployment config like verifying, source of deployment config, etc. */
4550
4593
  labels?: {[P in string]: string};
4551
4594
  /** Optional. Sample request for deployed endpoint. */
4552
4595
  sampleRequest?: string;
@@ -5839,6 +5882,8 @@ declare namespace gapi.client {
5839
5882
  multimodalPrompt?: GoogleCloudAiplatformV1SchemaPromptSpecMultimodalPrompt;
5840
5883
  /** The prompt variation that stores preambles in separate fields. */
5841
5884
  structuredPrompt?: GoogleCloudAiplatformV1SchemaPromptSpecStructuredPrompt;
5885
+ /** The prompt variation for Translation use case. */
5886
+ translationPrompt?: GoogleCloudAiplatformV1SchemaPromptSpecTranslationPrompt;
5842
5887
  }
5843
5888
  interface GoogleCloudAiplatformV1SchemaPromptInstancePromptExecution {
5844
5889
  /** Maps variable names to their value. */
@@ -5874,18 +5919,74 @@ declare namespace gapi.client {
5874
5919
  /** A list of `Tools` the model may use to generate the next response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. */
5875
5920
  tools?: GoogleCloudAiplatformV1Tool[];
5876
5921
  }
5922
+ interface GoogleCloudAiplatformV1SchemaPromptSpecReferenceSentencePair {
5923
+ /** Source sentence in the sentence pair. */
5924
+ sourceSentence?: string;
5925
+ /** Target sentence in the sentence pair. */
5926
+ targetSentence?: string;
5927
+ }
5928
+ interface GoogleCloudAiplatformV1SchemaPromptSpecReferenceSentencePairList {
5929
+ /** Reference sentence pairs. */
5930
+ referenceSentencePairs?: GoogleCloudAiplatformV1SchemaPromptSpecReferenceSentencePair[];
5931
+ }
5877
5932
  interface GoogleCloudAiplatformV1SchemaPromptSpecStructuredPrompt {
5878
5933
  /** Preamble: The context of the prompt. */
5879
5934
  context?: GoogleCloudAiplatformV1Content;
5880
5935
  /** Preamble: A set of examples for expected model response. */
5881
5936
  examples?: GoogleCloudAiplatformV1SchemaPromptSpecPartList[];
5937
+ /** Preamble: For infill prompt, the prefix before expected model response. */
5938
+ infillPrefix?: string;
5939
+ /** Preamble: For infill prompt, the suffix after expected model response. */
5940
+ infillSuffix?: string;
5882
5941
  /** Preamble: The input prefixes before each example input. */
5883
5942
  inputPrefixes?: string[];
5884
5943
  /** Preamble: The output prefixes before each example output. */
5885
5944
  outputPrefixes?: string[];
5945
+ /** Preamble: The input test data for prediction. Each PartList in this field represents one text-only input set for a single model request. */
5946
+ predictionInputs?: GoogleCloudAiplatformV1SchemaPromptSpecPartList[];
5886
5947
  /** The prompt message. */
5887
5948
  promptMessage?: GoogleCloudAiplatformV1SchemaPromptSpecPromptMessage;
5888
5949
  }
5950
+ interface GoogleCloudAiplatformV1SchemaPromptSpecTranslationExample {
5951
+ /** The reference sentences from inline text. */
5952
+ referenceSentencePairLists?: GoogleCloudAiplatformV1SchemaPromptSpecReferenceSentencePairList[];
5953
+ /** The reference sentences from file. */
5954
+ referenceSentencesFileInputs?: GoogleCloudAiplatformV1SchemaPromptSpecTranslationSentenceFileInput[];
5955
+ }
5956
+ interface GoogleCloudAiplatformV1SchemaPromptSpecTranslationFileInputSource {
5957
+ /** The file's contents. */
5958
+ content?: string;
5959
+ /** The file's display name. */
5960
+ displayName?: string;
5961
+ /** The file's mime type. */
5962
+ mimeType?: string;
5963
+ }
5964
+ interface GoogleCloudAiplatformV1SchemaPromptSpecTranslationGcsInputSource {
5965
+ /** Source data URI. For example, `gs://my_bucket/my_object`. */
5966
+ inputUri?: string;
5967
+ }
5968
+ interface GoogleCloudAiplatformV1SchemaPromptSpecTranslationOption {
5969
+ /** How many shots to use. */
5970
+ numberOfShots?: number;
5971
+ }
5972
+ interface GoogleCloudAiplatformV1SchemaPromptSpecTranslationPrompt {
5973
+ /** The translation example. */
5974
+ example?: GoogleCloudAiplatformV1SchemaPromptSpecTranslationExample;
5975
+ /** The translation option. */
5976
+ option?: GoogleCloudAiplatformV1SchemaPromptSpecTranslationOption;
5977
+ /** The prompt message. */
5978
+ promptMessage?: GoogleCloudAiplatformV1SchemaPromptSpecPromptMessage;
5979
+ /** The source language code. */
5980
+ sourceLanguageCode?: string;
5981
+ /** The target language code. */
5982
+ targetLanguageCode?: string;
5983
+ }
5984
+ interface GoogleCloudAiplatformV1SchemaPromptSpecTranslationSentenceFileInput {
5985
+ /** Inlined file source. */
5986
+ fileInputSource?: GoogleCloudAiplatformV1SchemaPromptSpecTranslationFileInputSource;
5987
+ /** Cloud Storage file source. */
5988
+ gcsInputSource?: GoogleCloudAiplatformV1SchemaPromptSpecTranslationGcsInputSource;
5989
+ }
5889
5990
  interface GoogleCloudAiplatformV1SchemaTablesDatasetMetadata {
5890
5991
  inputConfig?: GoogleCloudAiplatformV1SchemaTablesDatasetMetadataInputConfig;
5891
5992
  }
@@ -6696,6 +6797,7 @@ declare namespace gapi.client {
6696
6797
  progressMessage?: string;
6697
6798
  }
6698
6799
  interface GoogleCloudAiplatformV1StartNotebookRuntimeRequest {}
6800
+ interface GoogleCloudAiplatformV1StopNotebookRuntimeRequest {}
6699
6801
  interface GoogleCloudAiplatformV1StopTrialRequest {}
6700
6802
  interface GoogleCloudAiplatformV1StratifiedSplit {
6701
6803
  /** Required. The key is a name of one of the Dataset's data columns. The key provided must be for a categorical column. */
@@ -7468,7 +7570,7 @@ declare namespace gapi.client {
7468
7570
  supervisedTuningDataStats?: GoogleCloudAiplatformV1SupervisedTuningDataStats;
7469
7571
  }
7470
7572
  interface GoogleCloudAiplatformV1TuningJob {
7471
- /** The base model that is being tuned, e.g., "gemini-1.0-pro-002". */
7573
+ /** The base model that is being tuned, e.g., "gemini-1.0-pro-002". . */
7472
7574
  baseModel?: string;
7473
7575
  /** Output only. Time when the TuningJob was created. */
7474
7576
  createTime?: string;
@@ -11990,6 +12092,64 @@ declare namespace gapi.client {
11990
12092
  },
11991
12093
  body: GoogleCloudAiplatformV1ExplainRequest
11992
12094
  ): Request<GoogleCloudAiplatformV1ExplainResponse>;
12095
+ /** Fetch an asynchronous online prediction operation. */
12096
+ fetchPredictOperation(request: {
12097
+ /** V1 error format. */
12098
+ '$.xgafv'?: string;
12099
+ /** OAuth access token. */
12100
+ access_token?: string;
12101
+ /** Data format for response. */
12102
+ alt?: string;
12103
+ /** JSONP */
12104
+ callback?: string;
12105
+ /** Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}` */
12106
+ endpoint: string;
12107
+ /** Selector specifying which fields to include in a partial response. */
12108
+ fields?: string;
12109
+ /** 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. */
12110
+ key?: string;
12111
+ /** OAuth 2.0 token for the current user. */
12112
+ oauth_token?: string;
12113
+ /** Returns response with indentations and line breaks. */
12114
+ prettyPrint?: boolean;
12115
+ /** 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. */
12116
+ quotaUser?: string;
12117
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
12118
+ upload_protocol?: string;
12119
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
12120
+ uploadType?: string;
12121
+ /** Request body */
12122
+ resource: GoogleCloudAiplatformV1FetchPredictOperationRequest;
12123
+ }): Request<GoogleLongrunningOperation>;
12124
+ fetchPredictOperation(
12125
+ request: {
12126
+ /** V1 error format. */
12127
+ '$.xgafv'?: string;
12128
+ /** OAuth access token. */
12129
+ access_token?: string;
12130
+ /** Data format for response. */
12131
+ alt?: string;
12132
+ /** JSONP */
12133
+ callback?: string;
12134
+ /** Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}` */
12135
+ endpoint: string;
12136
+ /** Selector specifying which fields to include in a partial response. */
12137
+ fields?: string;
12138
+ /** 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. */
12139
+ key?: string;
12140
+ /** OAuth 2.0 token for the current user. */
12141
+ oauth_token?: string;
12142
+ /** Returns response with indentations and line breaks. */
12143
+ prettyPrint?: boolean;
12144
+ /** 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. */
12145
+ quotaUser?: string;
12146
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
12147
+ upload_protocol?: string;
12148
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
12149
+ uploadType?: string;
12150
+ },
12151
+ body: GoogleCloudAiplatformV1FetchPredictOperationRequest
12152
+ ): Request<GoogleLongrunningOperation>;
11993
12153
  /** Generate content with multimodal inputs. */
11994
12154
  generateContent(request: {
11995
12155
  /** V1 error format. */
@@ -12290,6 +12450,63 @@ declare namespace gapi.client {
12290
12450
  },
12291
12451
  body: GoogleCloudAiplatformV1PredictRequest
12292
12452
  ): Request<GoogleCloudAiplatformV1PredictResponse>;
12453
+ predictLongRunning(request: {
12454
+ /** V1 error format. */
12455
+ '$.xgafv'?: string;
12456
+ /** OAuth access token. */
12457
+ access_token?: string;
12458
+ /** Data format for response. */
12459
+ alt?: string;
12460
+ /** JSONP */
12461
+ callback?: string;
12462
+ /** Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}` */
12463
+ endpoint: string;
12464
+ /** Selector specifying which fields to include in a partial response. */
12465
+ fields?: string;
12466
+ /** 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. */
12467
+ key?: string;
12468
+ /** OAuth 2.0 token for the current user. */
12469
+ oauth_token?: string;
12470
+ /** Returns response with indentations and line breaks. */
12471
+ prettyPrint?: boolean;
12472
+ /** 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. */
12473
+ quotaUser?: string;
12474
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
12475
+ upload_protocol?: string;
12476
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
12477
+ uploadType?: string;
12478
+ /** Request body */
12479
+ resource: GoogleCloudAiplatformV1PredictLongRunningRequest;
12480
+ }): Request<GoogleLongrunningOperation>;
12481
+ predictLongRunning(
12482
+ request: {
12483
+ /** V1 error format. */
12484
+ '$.xgafv'?: string;
12485
+ /** OAuth access token. */
12486
+ access_token?: string;
12487
+ /** Data format for response. */
12488
+ alt?: string;
12489
+ /** JSONP */
12490
+ callback?: string;
12491
+ /** Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}` */
12492
+ endpoint: string;
12493
+ /** Selector specifying which fields to include in a partial response. */
12494
+ fields?: string;
12495
+ /** 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. */
12496
+ key?: string;
12497
+ /** OAuth 2.0 token for the current user. */
12498
+ oauth_token?: string;
12499
+ /** Returns response with indentations and line breaks. */
12500
+ prettyPrint?: boolean;
12501
+ /** 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. */
12502
+ quotaUser?: string;
12503
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
12504
+ upload_protocol?: string;
12505
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
12506
+ uploadType?: string;
12507
+ },
12508
+ body: GoogleCloudAiplatformV1PredictLongRunningRequest
12509
+ ): Request<GoogleLongrunningOperation>;
12293
12510
  /** Perform an online prediction with an arbitrary HTTP payload. The response includes the following HTTP headers: * `X-Vertex-AI-Endpoint-Id`: ID of the Endpoint that served this prediction. * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's DeployedModel that served this prediction. */
12294
12511
  rawPredict(request: {
12295
12512
  /** V1 error format. */
@@ -13763,7 +13980,7 @@ declare namespace gapi.client {
13763
13980
  prettyPrint?: boolean;
13764
13981
  /** 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. */
13765
13982
  quotaUser?: string;
13766
- /** Field mask is used to specify the fields to be overwritten in the FeatureView resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `service_agent_type` * `big_query_source` * `big_query_source.uri` * `big_query_source.entity_id_columns` * `feature_registry_source` * `feature_registry_source.feature_groups` * `sync_config` * `sync_config.cron` */
13983
+ /** Field mask is used to specify the fields to be overwritten in the FeatureView resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `service_agent_type` * `big_query_source` * `big_query_source.uri` * `big_query_source.entity_id_columns` * `feature_registry_source` * `feature_registry_source.feature_groups` * `sync_config` * `sync_config.cron` * `optimized_config.automatic_resources` */
13767
13984
  updateMask?: string;
13768
13985
  /** Upload protocol for media (e.g. "raw", "multipart"). */
13769
13986
  upload_protocol?: string;
@@ -13794,7 +14011,7 @@ declare namespace gapi.client {
13794
14011
  prettyPrint?: boolean;
13795
14012
  /** 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. */
13796
14013
  quotaUser?: string;
13797
- /** Field mask is used to specify the fields to be overwritten in the FeatureView resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `service_agent_type` * `big_query_source` * `big_query_source.uri` * `big_query_source.entity_id_columns` * `feature_registry_source` * `feature_registry_source.feature_groups` * `sync_config` * `sync_config.cron` */
14014
+ /** Field mask is used to specify the fields to be overwritten in the FeatureView resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `service_agent_type` * `big_query_source` * `big_query_source.uri` * `big_query_source.entity_id_columns` * `feature_registry_source` * `feature_registry_source.feature_groups` * `sync_config` * `sync_config.cron` * `optimized_config.automatic_resources` */
13798
14015
  updateMask?: string;
13799
14016
  /** Upload protocol for media (e.g. "raw", "multipart"). */
13800
14017
  upload_protocol?: string;
@@ -22522,6 +22739,64 @@ declare namespace gapi.client {
22522
22739
  },
22523
22740
  body: GoogleCloudAiplatformV1StartNotebookRuntimeRequest
22524
22741
  ): Request<GoogleLongrunningOperation>;
22742
+ /** Stops a NotebookRuntime. */
22743
+ stop(request: {
22744
+ /** V1 error format. */
22745
+ '$.xgafv'?: string;
22746
+ /** OAuth access token. */
22747
+ access_token?: string;
22748
+ /** Data format for response. */
22749
+ alt?: string;
22750
+ /** JSONP */
22751
+ callback?: string;
22752
+ /** Selector specifying which fields to include in a partial response. */
22753
+ fields?: string;
22754
+ /** 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. */
22755
+ key?: string;
22756
+ /** Required. The name of the NotebookRuntime resource to be stopped. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner. */
22757
+ name: string;
22758
+ /** OAuth 2.0 token for the current user. */
22759
+ oauth_token?: string;
22760
+ /** Returns response with indentations and line breaks. */
22761
+ prettyPrint?: boolean;
22762
+ /** 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. */
22763
+ quotaUser?: string;
22764
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
22765
+ upload_protocol?: string;
22766
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
22767
+ uploadType?: string;
22768
+ /** Request body */
22769
+ resource: GoogleCloudAiplatformV1StopNotebookRuntimeRequest;
22770
+ }): Request<GoogleLongrunningOperation>;
22771
+ stop(
22772
+ request: {
22773
+ /** V1 error format. */
22774
+ '$.xgafv'?: string;
22775
+ /** OAuth access token. */
22776
+ access_token?: string;
22777
+ /** Data format for response. */
22778
+ alt?: string;
22779
+ /** JSONP */
22780
+ callback?: string;
22781
+ /** Selector specifying which fields to include in a partial response. */
22782
+ fields?: string;
22783
+ /** 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. */
22784
+ key?: string;
22785
+ /** Required. The name of the NotebookRuntime resource to be stopped. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner. */
22786
+ name: string;
22787
+ /** OAuth 2.0 token for the current user. */
22788
+ oauth_token?: string;
22789
+ /** Returns response with indentations and line breaks. */
22790
+ prettyPrint?: boolean;
22791
+ /** 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. */
22792
+ quotaUser?: string;
22793
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
22794
+ upload_protocol?: string;
22795
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
22796
+ uploadType?: string;
22797
+ },
22798
+ body: GoogleCloudAiplatformV1StopNotebookRuntimeRequest
22799
+ ): Request<GoogleLongrunningOperation>;
22525
22800
  /** Upgrades a NotebookRuntime. */
22526
22801
  upgrade(request: {
22527
22802
  /** V1 error format. */
@@ -24185,6 +24460,64 @@ declare namespace gapi.client {
24185
24460
  },
24186
24461
  body: GoogleCloudAiplatformV1CountTokensRequest
24187
24462
  ): Request<GoogleCloudAiplatformV1CountTokensResponse>;
24463
+ /** Fetch an asynchronous online prediction operation. */
24464
+ fetchPredictOperation(request: {
24465
+ /** V1 error format. */
24466
+ '$.xgafv'?: string;
24467
+ /** OAuth access token. */
24468
+ access_token?: string;
24469
+ /** Data format for response. */
24470
+ alt?: string;
24471
+ /** JSONP */
24472
+ callback?: string;
24473
+ /** Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}` */
24474
+ endpoint: string;
24475
+ /** Selector specifying which fields to include in a partial response. */
24476
+ fields?: string;
24477
+ /** 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. */
24478
+ key?: string;
24479
+ /** OAuth 2.0 token for the current user. */
24480
+ oauth_token?: string;
24481
+ /** Returns response with indentations and line breaks. */
24482
+ prettyPrint?: boolean;
24483
+ /** 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. */
24484
+ quotaUser?: string;
24485
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
24486
+ upload_protocol?: string;
24487
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
24488
+ uploadType?: string;
24489
+ /** Request body */
24490
+ resource: GoogleCloudAiplatformV1FetchPredictOperationRequest;
24491
+ }): Request<GoogleLongrunningOperation>;
24492
+ fetchPredictOperation(
24493
+ request: {
24494
+ /** V1 error format. */
24495
+ '$.xgafv'?: string;
24496
+ /** OAuth access token. */
24497
+ access_token?: string;
24498
+ /** Data format for response. */
24499
+ alt?: string;
24500
+ /** JSONP */
24501
+ callback?: string;
24502
+ /** Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}` */
24503
+ endpoint: string;
24504
+ /** Selector specifying which fields to include in a partial response. */
24505
+ fields?: string;
24506
+ /** 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. */
24507
+ key?: string;
24508
+ /** OAuth 2.0 token for the current user. */
24509
+ oauth_token?: string;
24510
+ /** Returns response with indentations and line breaks. */
24511
+ prettyPrint?: boolean;
24512
+ /** 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. */
24513
+ quotaUser?: string;
24514
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
24515
+ upload_protocol?: string;
24516
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
24517
+ uploadType?: string;
24518
+ },
24519
+ body: GoogleCloudAiplatformV1FetchPredictOperationRequest
24520
+ ): Request<GoogleLongrunningOperation>;
24188
24521
  /** Generate content with multimodal inputs. */
24189
24522
  generateContent(request: {
24190
24523
  /** V1 error format. */
@@ -24301,6 +24634,63 @@ declare namespace gapi.client {
24301
24634
  },
24302
24635
  body: GoogleCloudAiplatformV1PredictRequest
24303
24636
  ): Request<GoogleCloudAiplatformV1PredictResponse>;
24637
+ predictLongRunning(request: {
24638
+ /** V1 error format. */
24639
+ '$.xgafv'?: string;
24640
+ /** OAuth access token. */
24641
+ access_token?: string;
24642
+ /** Data format for response. */
24643
+ alt?: string;
24644
+ /** JSONP */
24645
+ callback?: string;
24646
+ /** Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}` */
24647
+ endpoint: string;
24648
+ /** Selector specifying which fields to include in a partial response. */
24649
+ fields?: string;
24650
+ /** 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. */
24651
+ key?: string;
24652
+ /** OAuth 2.0 token for the current user. */
24653
+ oauth_token?: string;
24654
+ /** Returns response with indentations and line breaks. */
24655
+ prettyPrint?: boolean;
24656
+ /** 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. */
24657
+ quotaUser?: string;
24658
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
24659
+ upload_protocol?: string;
24660
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
24661
+ uploadType?: string;
24662
+ /** Request body */
24663
+ resource: GoogleCloudAiplatformV1PredictLongRunningRequest;
24664
+ }): Request<GoogleLongrunningOperation>;
24665
+ predictLongRunning(
24666
+ request: {
24667
+ /** V1 error format. */
24668
+ '$.xgafv'?: string;
24669
+ /** OAuth access token. */
24670
+ access_token?: string;
24671
+ /** Data format for response. */
24672
+ alt?: string;
24673
+ /** JSONP */
24674
+ callback?: string;
24675
+ /** Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}` */
24676
+ endpoint: string;
24677
+ /** Selector specifying which fields to include in a partial response. */
24678
+ fields?: string;
24679
+ /** 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. */
24680
+ key?: string;
24681
+ /** OAuth 2.0 token for the current user. */
24682
+ oauth_token?: string;
24683
+ /** Returns response with indentations and line breaks. */
24684
+ prettyPrint?: boolean;
24685
+ /** 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. */
24686
+ quotaUser?: string;
24687
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
24688
+ upload_protocol?: string;
24689
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
24690
+ uploadType?: string;
24691
+ },
24692
+ body: GoogleCloudAiplatformV1PredictLongRunningRequest
24693
+ ): Request<GoogleLongrunningOperation>;
24304
24694
  /** Perform an online prediction with an arbitrary HTTP payload. The response includes the following HTTP headers: * `X-Vertex-AI-Endpoint-Id`: ID of the Endpoint that served this prediction. * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's DeployedModel that served this prediction. */
24305
24695
  rawPredict(request: {
24306
24696
  /** V1 error format. */
@@ -29097,6 +29487,91 @@ declare namespace gapi.client {
29097
29487
  tuningJobs: TuningJobsResource;
29098
29488
  }
29099
29489
  interface ProjectsResource {
29490
+ /** Gets a GenAI cache config. */
29491
+ getCacheConfig(request?: {
29492
+ /** V1 error format. */
29493
+ '$.xgafv'?: string;
29494
+ /** OAuth access token. */
29495
+ access_token?: string;
29496
+ /** Data format for response. */
29497
+ alt?: string;
29498
+ /** JSONP */
29499
+ callback?: string;
29500
+ /** Selector specifying which fields to include in a partial response. */
29501
+ fields?: string;
29502
+ /** 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. */
29503
+ key?: string;
29504
+ /** Required. Name of the cache config. Format: - `projects/{project}/cacheConfig`. */
29505
+ name: string;
29506
+ /** OAuth 2.0 token for the current user. */
29507
+ oauth_token?: string;
29508
+ /** Returns response with indentations and line breaks. */
29509
+ prettyPrint?: boolean;
29510
+ /** 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. */
29511
+ quotaUser?: string;
29512
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
29513
+ upload_protocol?: string;
29514
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
29515
+ uploadType?: string;
29516
+ }): Request<GoogleCloudAiplatformV1CacheConfig>;
29517
+ /** Updates a cache config. */
29518
+ updateCacheConfig(request: {
29519
+ /** V1 error format. */
29520
+ '$.xgafv'?: string;
29521
+ /** OAuth access token. */
29522
+ access_token?: string;
29523
+ /** Data format for response. */
29524
+ alt?: string;
29525
+ /** JSONP */
29526
+ callback?: string;
29527
+ /** Selector specifying which fields to include in a partial response. */
29528
+ fields?: string;
29529
+ /** 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. */
29530
+ key?: string;
29531
+ /** Identifier. Name of the cache config. Format: - `projects/{project}/cacheConfig`. */
29532
+ name: string;
29533
+ /** OAuth 2.0 token for the current user. */
29534
+ oauth_token?: string;
29535
+ /** Returns response with indentations and line breaks. */
29536
+ prettyPrint?: boolean;
29537
+ /** 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. */
29538
+ quotaUser?: string;
29539
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
29540
+ upload_protocol?: string;
29541
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
29542
+ uploadType?: string;
29543
+ /** Request body */
29544
+ resource: GoogleCloudAiplatformV1CacheConfig;
29545
+ }): Request<GoogleLongrunningOperation>;
29546
+ updateCacheConfig(
29547
+ request: {
29548
+ /** V1 error format. */
29549
+ '$.xgafv'?: string;
29550
+ /** OAuth access token. */
29551
+ access_token?: string;
29552
+ /** Data format for response. */
29553
+ alt?: string;
29554
+ /** JSONP */
29555
+ callback?: string;
29556
+ /** Selector specifying which fields to include in a partial response. */
29557
+ fields?: string;
29558
+ /** 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. */
29559
+ key?: string;
29560
+ /** Identifier. Name of the cache config. Format: - `projects/{project}/cacheConfig`. */
29561
+ name: string;
29562
+ /** OAuth 2.0 token for the current user. */
29563
+ oauth_token?: string;
29564
+ /** Returns response with indentations and line breaks. */
29565
+ prettyPrint?: boolean;
29566
+ /** 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. */
29567
+ quotaUser?: string;
29568
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
29569
+ upload_protocol?: string;
29570
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
29571
+ uploadType?: string;
29572
+ },
29573
+ body: GoogleCloudAiplatformV1CacheConfig
29574
+ ): Request<GoogleLongrunningOperation>;
29100
29575
  locations: LocationsResource;
29101
29576
  }
29102
29577
  interface ModelsResource {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.aiplatform-v1",
3
- "version": "0.0.20241007",
3
+ "version": "0.0.20241026",
4
4
  "description": "TypeScript typings for Vertex AI API v1",
5
5
  "repository": {
6
6
  "type": "git",
package/readme.md CHANGED
@@ -116,4 +116,14 @@ await gapi.client.aiplatform.endpoints.generateContent({model: 'model'});
116
116
  Generate content with multimodal inputs with streaming support.
117
117
  */
118
118
  await gapi.client.aiplatform.endpoints.streamGenerateContent({model: 'model'});
119
+
120
+ /*
121
+ Gets a GenAI cache config.
122
+ */
123
+ await gapi.client.aiplatform.projects.getCacheConfig({name: 'name'});
124
+
125
+ /*
126
+ Updates a cache config.
127
+ */
128
+ await gapi.client.aiplatform.projects.updateCacheConfig({name: 'name'});
119
129
  ```