@maxim_mazurok/gapi.client.aiplatform-v1 0.0.20240219 → 0.0.20240229

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/index.d.ts +142 -2
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -9,7 +9,7 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://aiplatform.googleapis.com/$discovery/rest?version=v1
12
- // Revision: 20240219
12
+ // Revision: 20240229
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -451,6 +451,10 @@ declare namespace gapi.client {
451
451
  /** Required. Google Cloud Storage location. */
452
452
  gcsSource?: GoogleCloudAiplatformV1GcsSource;
453
453
  }
454
+ interface GoogleCloudAiplatformV1BatchCancelPipelineJobsRequest {
455
+ /** Required. The names of the PipelineJobs to cancel. A maximum of 32 PipelineJobs can be cancelled in a batch. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipelineJob}` */
456
+ names?: string[];
457
+ }
454
458
  interface GoogleCloudAiplatformV1BatchCreateFeaturesOperationMetadata {
455
459
  /** Operation metadata for Feature. */
456
460
  genericMetadata?: GoogleCloudAiplatformV1GenericOperationMetadata;
@@ -487,6 +491,10 @@ declare namespace gapi.client {
487
491
  /** Immutable. The number of machine replicas used at the start of the batch operation. If not set, Vertex AI decides starting number, not greater than max_replica_count */
488
492
  startingReplicaCount?: number;
489
493
  }
494
+ interface GoogleCloudAiplatformV1BatchDeletePipelineJobsRequest {
495
+ /** Required. The names of the PipelineJobs to delete. A maximum of 32 PipelineJobs can be deleted in a batch. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipelineJob}` */
496
+ names?: string[];
497
+ }
490
498
  interface GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsRequest {
491
499
  /** Required. Evaluated annotations resource to be imported. */
492
500
  evaluatedAnnotations?: GoogleCloudAiplatformV1EvaluatedAnnotation[];
@@ -1099,7 +1107,7 @@ declare namespace gapi.client {
1099
1107
  displayName?: string;
1100
1108
  /** Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. */
1101
1109
  etag?: string;
1102
- /** Required. Additional information about the DatasetVersion. */
1110
+ /** Required. Output only. Additional information about the DatasetVersion. */
1103
1111
  metadata?: any;
1104
1112
  /** Output only. The resource name of the DatasetVersion. */
1105
1113
  name?: string;
@@ -2187,6 +2195,10 @@ declare namespace gapi.client {
2187
2195
  /** Output only. Time when the operation was updated for the last time. If the operation has finished (successfully or not), this is the finish time. */
2188
2196
  updateTime?: string;
2189
2197
  }
2198
+ interface GoogleCloudAiplatformV1GenieSource {
2199
+ /** Required. The public base model URI. */
2200
+ baseModelUri?: string;
2201
+ }
2190
2202
  interface GoogleCloudAiplatformV1GroundingAttribution {
2191
2203
  /** Optional. Output only. Confidence score of the attribution. Ranges from 0 to 1. 1 is the most confident. */
2192
2204
  confidenceScore?: number;
@@ -2913,6 +2925,8 @@ declare namespace gapi.client {
2913
2925
  interface GoogleCloudAiplatformV1Model {
2914
2926
  /** Immutable. The path to the directory containing the Model artifact and any of its supporting files. Not required for AutoML Models. */
2915
2927
  artifactUri?: string;
2928
+ /** Optional. User input field to specify the base model source. Currently it only supports specifing the Model Garden models and Genie models. */
2929
+ baseModelSource?: GoogleCloudAiplatformV1ModelBaseModelSource;
2916
2930
  /** Input only. The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models. */
2917
2931
  containerSpec?: GoogleCloudAiplatformV1ModelContainerSpec;
2918
2932
  /** Output only. Timestamp when this Model was uploaded into Vertex AI. */
@@ -2972,6 +2986,12 @@ declare namespace gapi.client {
2972
2986
  /** Output only. Timestamp when this version was most recently updated. */
2973
2987
  versionUpdateTime?: string;
2974
2988
  }
2989
+ interface GoogleCloudAiplatformV1ModelBaseModelSource {
2990
+ /** Information about the base model of Genie models. */
2991
+ genieSource?: GoogleCloudAiplatformV1GenieSource;
2992
+ /** Source information of Model Garden models. */
2993
+ modelGardenSource?: GoogleCloudAiplatformV1ModelGardenSource;
2994
+ }
2975
2995
  interface GoogleCloudAiplatformV1ModelContainerSpec {
2976
2996
  /** Immutable. Specifies arguments for the command that runs when the container starts. This overrides the container's [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd). Specify this field as an array of executable and arguments, similar to a Docker `CMD`'s "default parameters" form. If you don't specify this field but do specify the command field, then the command from the `command` field runs without any additional arguments. See the [Kubernetes documentation about how the `command` and `args` fields interact with a container's `ENTRYPOINT` and `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). If you don't specify this field and don't specify the `command` field, then the container's [`ENTRYPOINT`](https://docs.docker.com/engine/reference/builder/#cmd) and `CMD` determine what runs based on their default behavior. See the Docker documentation about [how `CMD` and `ENTRYPOINT` interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). In this field, you can reference [environment variables set by Vertex AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to the `args` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). */
2977
2997
  args?: string[];
@@ -3176,6 +3196,10 @@ declare namespace gapi.client {
3176
3196
  /** Output only. The ID of the export format. The possible format IDs are: * `tflite` Used for Android mobile devices. * `edgetpu-tflite` Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices. * `tf-saved-model` A tensorflow model in SavedModel format. * `tf-js` A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used in the browser and in Node.js using JavaScript. * `core-ml` Used for iOS mobile devices. * `custom-trained` A Model that was uploaded or trained by custom code. */
3177
3197
  id?: string;
3178
3198
  }
3199
+ interface GoogleCloudAiplatformV1ModelGardenSource {
3200
+ /** Required. The model garden source model resource name. */
3201
+ publicModelName?: string;
3202
+ }
3179
3203
  interface GoogleCloudAiplatformV1ModelMonitoringAlertConfig {
3180
3204
  /** Email alert config. */
3181
3205
  emailAlertConfig?: GoogleCloudAiplatformV1ModelMonitoringAlertConfigEmailAlertConfig;
@@ -20691,6 +20715,122 @@ declare namespace gapi.client {
20691
20715
  }): Request<GoogleLongrunningOperation>;
20692
20716
  }
20693
20717
  interface PipelineJobsResource {
20718
+ /** Batch cancel PipelineJobs. Firstly the server will check if all the jobs are in non-terminal states, and skip the jobs that are already terminated. If the operation failed, none of the pipeline jobs are cancelled. The server will poll the states of all the pipeline jobs periodically to check the cancellation status. This operation will return an LRO. */
20719
+ batchCancel(request: {
20720
+ /** V1 error format. */
20721
+ '$.xgafv'?: string;
20722
+ /** OAuth access token. */
20723
+ access_token?: string;
20724
+ /** Data format for response. */
20725
+ alt?: string;
20726
+ /** JSONP */
20727
+ callback?: string;
20728
+ /** Selector specifying which fields to include in a partial response. */
20729
+ fields?: string;
20730
+ /** 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. */
20731
+ key?: string;
20732
+ /** OAuth 2.0 token for the current user. */
20733
+ oauth_token?: string;
20734
+ /** Required. The name of the PipelineJobs' parent resource. Format: `projects/{project}/locations/{location}` */
20735
+ parent: string;
20736
+ /** Returns response with indentations and line breaks. */
20737
+ prettyPrint?: boolean;
20738
+ /** 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. */
20739
+ quotaUser?: string;
20740
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
20741
+ upload_protocol?: string;
20742
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
20743
+ uploadType?: string;
20744
+ /** Request body */
20745
+ resource: GoogleCloudAiplatformV1BatchCancelPipelineJobsRequest;
20746
+ }): Request<GoogleLongrunningOperation>;
20747
+ batchCancel(
20748
+ request: {
20749
+ /** V1 error format. */
20750
+ '$.xgafv'?: string;
20751
+ /** OAuth access token. */
20752
+ access_token?: string;
20753
+ /** Data format for response. */
20754
+ alt?: string;
20755
+ /** JSONP */
20756
+ callback?: string;
20757
+ /** Selector specifying which fields to include in a partial response. */
20758
+ fields?: string;
20759
+ /** 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. */
20760
+ key?: string;
20761
+ /** OAuth 2.0 token for the current user. */
20762
+ oauth_token?: string;
20763
+ /** Required. The name of the PipelineJobs' parent resource. Format: `projects/{project}/locations/{location}` */
20764
+ parent: string;
20765
+ /** Returns response with indentations and line breaks. */
20766
+ prettyPrint?: boolean;
20767
+ /** 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. */
20768
+ quotaUser?: string;
20769
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
20770
+ upload_protocol?: string;
20771
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
20772
+ uploadType?: string;
20773
+ },
20774
+ body: GoogleCloudAiplatformV1BatchCancelPipelineJobsRequest
20775
+ ): Request<GoogleLongrunningOperation>;
20776
+ /** Batch deletes PipelineJobs The Operation is atomic. If it fails, none of the PipelineJobs are deleted. If it succeeds, all of the PipelineJobs are deleted. */
20777
+ batchDelete(request: {
20778
+ /** V1 error format. */
20779
+ '$.xgafv'?: string;
20780
+ /** OAuth access token. */
20781
+ access_token?: string;
20782
+ /** Data format for response. */
20783
+ alt?: string;
20784
+ /** JSONP */
20785
+ callback?: string;
20786
+ /** Selector specifying which fields to include in a partial response. */
20787
+ fields?: string;
20788
+ /** 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. */
20789
+ key?: string;
20790
+ /** OAuth 2.0 token for the current user. */
20791
+ oauth_token?: string;
20792
+ /** Required. The name of the PipelineJobs' parent resource. Format: `projects/{project}/locations/{location}` */
20793
+ parent: string;
20794
+ /** Returns response with indentations and line breaks. */
20795
+ prettyPrint?: boolean;
20796
+ /** 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. */
20797
+ quotaUser?: string;
20798
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
20799
+ upload_protocol?: string;
20800
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
20801
+ uploadType?: string;
20802
+ /** Request body */
20803
+ resource: GoogleCloudAiplatformV1BatchDeletePipelineJobsRequest;
20804
+ }): Request<GoogleLongrunningOperation>;
20805
+ batchDelete(
20806
+ request: {
20807
+ /** V1 error format. */
20808
+ '$.xgafv'?: string;
20809
+ /** OAuth access token. */
20810
+ access_token?: string;
20811
+ /** Data format for response. */
20812
+ alt?: string;
20813
+ /** JSONP */
20814
+ callback?: string;
20815
+ /** Selector specifying which fields to include in a partial response. */
20816
+ fields?: string;
20817
+ /** 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. */
20818
+ key?: string;
20819
+ /** OAuth 2.0 token for the current user. */
20820
+ oauth_token?: string;
20821
+ /** Required. The name of the PipelineJobs' parent resource. Format: `projects/{project}/locations/{location}` */
20822
+ parent: string;
20823
+ /** Returns response with indentations and line breaks. */
20824
+ prettyPrint?: boolean;
20825
+ /** 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. */
20826
+ quotaUser?: string;
20827
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
20828
+ upload_protocol?: string;
20829
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
20830
+ uploadType?: string;
20831
+ },
20832
+ body: GoogleCloudAiplatformV1BatchDeletePipelineJobsRequest
20833
+ ): Request<GoogleLongrunningOperation>;
20694
20834
  /** Cancels a PipelineJob. Starts asynchronous cancellation on the PipelineJob. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use PipelineService.GetPipelineJob or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the PipelineJob is not deleted; instead it becomes a pipeline with a PipelineJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and PipelineJob.state is set to `CANCELLED`. */
20695
20835
  cancel(request: {
20696
20836
  /** V1 error format. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.aiplatform-v1",
3
- "version": "0.0.20240219",
3
+ "version": "0.0.20240229",
4
4
  "description": "TypeScript typings for Vertex AI API v1",
5
5
  "repository": {
6
6
  "type": "git",