@maxim_mazurok/gapi.client.aiplatform-v1 0.0.20240224 → 0.0.20240301

package/index.d.ts

@@ -9,7 +9,7 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 // Generated from: https://aiplatform.googleapis.com/$discovery/rest?version=v1
-// Revision: 20240224
+// Revision: 20240301
 
 /// <reference types="gapi.client" />
 
@@ -206,6 +206,8 @@ declare namespace gapi.client {
       outputFilterInfo?: LearningServingLlmMessageMetadata[];
     }
     interface CloudAiNlLlmProtoServicePart {
+      /** Document metadata. The metadata should only be used by the Cloud LLM when supporting document mime types. It will only be populated when this image input part is converted from a document input part. */
+      documentMetadata?: CloudAiNlLlmProtoServicePartDocumentMetadata;
       /** URI-based data. */
       fileData?: CloudAiNlLlmProtoServicePartFileData;
       /** Function call data. */
@@ -227,6 +229,12 @@ declare namespace gapi.client {
       /** Original file data where the blob comes from. */
       originalFileData?: CloudAiNlLlmProtoServicePartFileData;
     }
+    interface CloudAiNlLlmProtoServicePartDocumentMetadata {
+      /** The original document blob. */
+      originalDocumentBlob?: CloudAiNlLlmProtoServicePartBlob;
+      /** The (1-indexed) page number of the image in the original document. The first page carries the original document content and mime type. */
+      pageNumber?: number;
+    }
     interface CloudAiNlLlmProtoServicePartFileData {
       /** Inline data. */
       fileUri?: string;
@@ -272,11 +280,23 @@ declare namespace gapi.client {
       confidence?: string;
       /** Whether the category is flagged as being present. Currently, this is set to true if score >= 0.5. */
       flagged?: boolean;
+      /** The influential terms that could potentially block the response. */
+      influentialTerms?: CloudAiNlLlmProtoServiceRaiSignalInfluentialTerm[];
       /** The RAI category. */
       raiCategory?: string;
       /** The score for the category, in the range [0.0, 1.0]. */
       score?: number;
     }
+    interface CloudAiNlLlmProtoServiceRaiSignalInfluentialTerm {
+      /** The beginning offset of the influential term. */
+      beginOffset?: number;
+      /** The confidence score of the influential term. */
+      confidence?: number;
+      /** The source of the influential term, prompt or response. */
+      source?: string;
+      /** The influential term. */
+      term?: string;
+    }
     interface CloudAiNlLlmProtoServiceSafetyRating {
       /** Indicates whether the content was filtered out because of this rating. */
       blocked?: boolean;
@@ -451,6 +471,10 @@ declare namespace gapi.client {
       /** Required. Google Cloud Storage location. */
       gcsSource?: GoogleCloudAiplatformV1GcsSource;
     }
+    interface GoogleCloudAiplatformV1BatchCancelPipelineJobsRequest {
+      /** 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}` */
+      names?: string[];
+    }
     interface GoogleCloudAiplatformV1BatchCreateFeaturesOperationMetadata {
       /** Operation metadata for Feature. */
       genericMetadata?: GoogleCloudAiplatformV1GenericOperationMetadata;
@@ -487,6 +511,10 @@ declare namespace gapi.client {
       /** 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 */
       startingReplicaCount?: number;
     }
+    interface GoogleCloudAiplatformV1BatchDeletePipelineJobsRequest {
+      /** 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}` */
+      names?: string[];
+    }
     interface GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsRequest {
       /** Required. Evaluated annotations resource to be imported. */
       evaluatedAnnotations?: GoogleCloudAiplatformV1EvaluatedAnnotation[];
@@ -1099,7 +1127,7 @@ declare namespace gapi.client {
       displayName?: string;
       /** Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. */
       etag?: string;
-      /** Required. Additional information about the DatasetVersion. */
+      /** Required. Output only. Additional information about the DatasetVersion. */
       metadata?: any;
       /** Output only. The resource name of the DatasetVersion. */
       name?: string;
@@ -2187,6 +2215,10 @@ declare namespace gapi.client {
       /** 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. */
       updateTime?: string;
     }
+    interface GoogleCloudAiplatformV1GenieSource {
+      /** Required. The public base model URI. */
+      baseModelUri?: string;
+    }
     interface GoogleCloudAiplatformV1GroundingAttribution {
       /** Optional. Output only. Confidence score of the attribution. Ranges from 0 to 1. 1 is the most confident. */
       confidenceScore?: number;
@@ -2913,6 +2945,8 @@ declare namespace gapi.client {
     interface GoogleCloudAiplatformV1Model {
       /** Immutable. The path to the directory containing the Model artifact and any of its supporting files. Not required for AutoML Models. */
       artifactUri?: string;
+      /** Optional. User input field to specify the base model source. Currently it only supports specifing the Model Garden models and Genie models. */
+      baseModelSource?: GoogleCloudAiplatformV1ModelBaseModelSource;
       /** 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. */
       containerSpec?: GoogleCloudAiplatformV1ModelContainerSpec;
       /** Output only. Timestamp when this Model was uploaded into Vertex AI. */
@@ -2972,6 +3006,12 @@ declare namespace gapi.client {
       /** Output only. Timestamp when this version was most recently updated. */
       versionUpdateTime?: string;
     }
+    interface GoogleCloudAiplatformV1ModelBaseModelSource {
+      /** Information about the base model of Genie models. */
+      genieSource?: GoogleCloudAiplatformV1GenieSource;
+      /** Source information of Model Garden models. */
+      modelGardenSource?: GoogleCloudAiplatformV1ModelGardenSource;
+    }
     interface GoogleCloudAiplatformV1ModelContainerSpec {
       /** 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). */
       args?: string[];
@@ -3176,6 +3216,10 @@ declare namespace gapi.client {
       /** 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. */
       id?: string;
     }
+    interface GoogleCloudAiplatformV1ModelGardenSource {
+      /** Required. The model garden source model resource name. */
+      publicModelName?: string;
+    }
     interface GoogleCloudAiplatformV1ModelMonitoringAlertConfig {
       /** Email alert config. */
       emailAlertConfig?: GoogleCloudAiplatformV1ModelMonitoringAlertConfigEmailAlertConfig;
@@ -10346,7 +10390,7 @@ declare namespace gapi.client {
         callback?: string;
         /** Selector specifying which fields to include in a partial response. */
         fields?: string;
-        /** Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `endpoint` supports = and !=. `endpoint` represents the Endpoint ID, i.e. the last segment of the Endpoint's resource name. * `display_name` supports = and, != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. Some examples: * `endpoint=1` * `displayName="myDisplayName"` * `labels.myKey="myValue"` */
+        /** Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `endpoint` supports = and !=. `endpoint` represents the Endpoint ID, i.e. the last segment of the Endpoint's resource name. * `display_name` supports = and, != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. * `base_model_name` only supports = Some examples: * `endpoint=1` * `displayName="myDisplayName"` * `labels.myKey="myValue"` * `baseModelName="text-bison"` */
         filter?: string;
         /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
         key?: string;
@@ -19262,7 +19306,7 @@ declare namespace gapi.client {
         callback?: string;
         /** Selector specifying which fields to include in a partial response. */
         fields?: string;
-        /** An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `model` supports = and !=. `model` represents the Model ID, i.e. the last segment of the Model's resource name. * `display_name` supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. Some examples: * `model=1234` * `displayName="myDisplayName"` * `labels.myKey="myValue"` */
+        /** An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `model` supports = and !=. `model` represents the Model ID, i.e. the last segment of the Model's resource name. * `display_name` supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. * `base_model_name` only supports = Some examples: * `model=1234` * `displayName="myDisplayName"` * `labels.myKey="myValue"` * `baseModelName="text-bison"` */
         filter?: string;
         /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
         key?: string;
@@ -20691,6 +20735,122 @@ declare namespace gapi.client {
       }): Request<GoogleLongrunningOperation>;
     }
     interface PipelineJobsResource {
+      /** 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. */
+      batchCancel(request: {
+        /** V1 error format. */
+        '$.xgafv'?: string;
+        /** OAuth access token. */
+        access_token?: string;
+        /** Data format for response. */
+        alt?: string;
+        /** JSONP */
+        callback?: string;
+        /** Selector specifying which fields to include in a partial response. */
+        fields?: string;
+        /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+        key?: string;
+        /** OAuth 2.0 token for the current user. */
+        oauth_token?: string;
+        /** Required. The name of the PipelineJobs' parent resource. Format: `projects/{project}/locations/{location}` */
+        parent: string;
+        /** Returns response with indentations and line breaks. */
+        prettyPrint?: boolean;
+        /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+        quotaUser?: string;
+        /** Upload protocol for media (e.g. "raw", "multipart"). */
+        upload_protocol?: string;
+        /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+        uploadType?: string;
+        /** Request body */
+        resource: GoogleCloudAiplatformV1BatchCancelPipelineJobsRequest;
+      }): Request<GoogleLongrunningOperation>;
+      batchCancel(
+        request: {
+          /** V1 error format. */
+          '$.xgafv'?: string;
+          /** OAuth access token. */
+          access_token?: string;
+          /** Data format for response. */
+          alt?: string;
+          /** JSONP */
+          callback?: string;
+          /** Selector specifying which fields to include in a partial response. */
+          fields?: string;
+          /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+          key?: string;
+          /** OAuth 2.0 token for the current user. */
+          oauth_token?: string;
+          /** Required. The name of the PipelineJobs' parent resource. Format: `projects/{project}/locations/{location}` */
+          parent: string;
+          /** Returns response with indentations and line breaks. */
+          prettyPrint?: boolean;
+          /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+          quotaUser?: string;
+          /** Upload protocol for media (e.g. "raw", "multipart"). */
+          upload_protocol?: string;
+          /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+          uploadType?: string;
+        },
+        body: GoogleCloudAiplatformV1BatchCancelPipelineJobsRequest
+      ): Request<GoogleLongrunningOperation>;
+      /** 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. */
+      batchDelete(request: {
+        /** V1 error format. */
+        '$.xgafv'?: string;
+        /** OAuth access token. */
+        access_token?: string;
+        /** Data format for response. */
+        alt?: string;
+        /** JSONP */
+        callback?: string;
+        /** Selector specifying which fields to include in a partial response. */
+        fields?: string;
+        /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+        key?: string;
+        /** OAuth 2.0 token for the current user. */
+        oauth_token?: string;
+        /** Required. The name of the PipelineJobs' parent resource. Format: `projects/{project}/locations/{location}` */
+        parent: string;
+        /** Returns response with indentations and line breaks. */
+        prettyPrint?: boolean;
+        /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+        quotaUser?: string;
+        /** Upload protocol for media (e.g. "raw", "multipart"). */
+        upload_protocol?: string;
+        /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+        uploadType?: string;
+        /** Request body */
+        resource: GoogleCloudAiplatformV1BatchDeletePipelineJobsRequest;
+      }): Request<GoogleLongrunningOperation>;
+      batchDelete(
+        request: {
+          /** V1 error format. */
+          '$.xgafv'?: string;
+          /** OAuth access token. */
+          access_token?: string;
+          /** Data format for response. */
+          alt?: string;
+          /** JSONP */
+          callback?: string;
+          /** Selector specifying which fields to include in a partial response. */
+          fields?: string;
+          /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+          key?: string;
+          /** OAuth 2.0 token for the current user. */
+          oauth_token?: string;
+          /** Required. The name of the PipelineJobs' parent resource. Format: `projects/{project}/locations/{location}` */
+          parent: string;
+          /** Returns response with indentations and line breaks. */
+          prettyPrint?: boolean;
+          /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+          quotaUser?: string;
+          /** Upload protocol for media (e.g. "raw", "multipart"). */
+          upload_protocol?: string;
+          /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+          uploadType?: string;
+        },
+        body: GoogleCloudAiplatformV1BatchDeletePipelineJobsRequest
+      ): Request<GoogleLongrunningOperation>;
       /** 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`. */
       cancel(request: {
         /** V1 error format. */
@@ -25429,6 +25589,65 @@ declare namespace gapi.client {
       }): Request<GoogleCloudAiplatformV1ListTrainingPipelinesResponse>;
       operations: OperationsResource;
     }
+    interface OperationsResource {
+      /** 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`. */
+      cancel(request?: {
+        /** V1 error format. */
+        '$.xgafv'?: string;
+        /** OAuth access token. */
+        access_token?: string;
+        /** Data format for response. */
+        alt?: string;
+        /** JSONP */
+        callback?: string;
+        /** Selector specifying which fields to include in a partial response. */
+        fields?: string;
+        /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+        key?: string;
+        /** The name of the operation resource to be cancelled. */
+        name: string;
+        /** OAuth 2.0 token for the current user. */
+        oauth_token?: string;
+        /** Returns response with indentations and line breaks. */
+        prettyPrint?: boolean;
+        /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+        quotaUser?: string;
+        /** Upload protocol for media (e.g. "raw", "multipart"). */
+        upload_protocol?: string;
+        /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+        uploadType?: string;
+      }): Request<{}>;
+      /** 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. */
+      get(request?: {
+        /** V1 error format. */
+        '$.xgafv'?: string;
+        /** OAuth access token. */
+        access_token?: string;
+        /** Data format for response. */
+        alt?: string;
+        /** JSONP */
+        callback?: string;
+        /** Selector specifying which fields to include in a partial response. */
+        fields?: string;
+        /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+        key?: string;
+        /** The name of the operation resource. */
+        name: string;
+        /** OAuth 2.0 token for the current user. */
+        oauth_token?: string;
+        /** Returns response with indentations and line breaks. */
+        prettyPrint?: boolean;
+        /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+        quotaUser?: string;
+        /** Upload protocol for media (e.g. "raw", "multipart"). */
+        upload_protocol?: string;
+        /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+        uploadType?: string;
+      }): Request<GoogleLongrunningOperation>;
+    }
+    interface TuningJobsResource {
+      operations: OperationsResource;
+    }
     interface LocationsResource {
       /** Gets information about a location. */
       get(request?: {
@@ -25517,6 +25736,7 @@ declare namespace gapi.client {
       studies: StudiesResource;
       tensorboards: TensorboardsResource;
       trainingPipelines: TrainingPipelinesResource;
+      tuningJobs: TuningJobsResource;
     }
     interface ProjectsResource {
       locations: LocationsResource;

package/package.json

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