@maxim_mazurok/gapi.client.aiplatform-v1beta1 0.0.20240510 → 0.0.20240520

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=v1beta1
-// Revision: 20240510
+// Revision: 20240520
 
 /// <reference types="gapi.client" />
 
@@ -29,9 +29,9 @@ declare namespace gapi.client {
 
   namespace aiplatform {
     interface CloudAiLargeModelsVisionFilteredText {
-      /** Confidence level */
-      category?: string;
       /** Filtered category */
+      category?: string;
+      /** Confidence score */
       confidence?: string;
       /** Input prompt */
       prompt?: string;
@@ -86,11 +86,20 @@ declare namespace gapi.client {
       y2?: number;
     }
     interface CloudAiLargeModelsVisionRaiInfo {
+      detectedLabels?: CloudAiLargeModelsVisionRaiInfoDetectedLabels[];
       /** List of rai categories' information to return */
       raiCategories?: string[];
       /** List of rai scores mapping to the rai categories. Rounded to 1 decimal place. */
       scores?: number[];
     }
+    interface CloudAiLargeModelsVisionRaiInfoDetectedLabels {
+      /** Descriptions of the detected labels. */
+      descriptions?: string[];
+      /** The RAI category for the deteceted labels. */
+      raiCategory?: string;
+      /** Confidence scores mapping to the labels. */
+      scores?: number[];
+    }
     interface CloudAiLargeModelsVisionSemanticFilterResponse {
       /** Class labels of the bounding boxes that failed the semantic filtering. Bounding box coordinates. */
       namedBoundingBoxes?: CloudAiLargeModelsVisionNamedBoundingBox[];
@@ -1212,8 +1221,14 @@ declare namespace gapi.client {
       createTime?: string;
       /** Required. The underlying DedicatedResources that the DeploymentResourcePool uses. */
       dedicatedResources?: GoogleCloudAiplatformV1beta1DedicatedResources;
+      /** If the DeploymentResourcePool is deployed with custom-trained Models or AutoML Tabular Models, the container(s) of the DeploymentResourcePool will send `stderr` and `stdout` streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging/pricing). User can disable container logging by setting this flag to true. */
+      disableContainerLogging?: boolean;
+      /** Customer-managed encryption key spec for a DeploymentResourcePool. If set, this DeploymentResourcePool will be secured by this key. Endpoints and the DeploymentResourcePool they deploy in need to have the same EncryptionSpec. */
+      encryptionSpec?: GoogleCloudAiplatformV1beta1EncryptionSpec;
       /** Immutable. The resource name of the DeploymentResourcePool. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}` */
       name?: string;
+      /** The service account that the DeploymentResourcePool's container(s) run as. Specify the email address of the service account. If this service account is not specified, the container(s) run as a service account that doesn't have access to the resource project. Users deploying the Models to this DeploymentResourcePool must have the `iam.serviceAccounts.actAs` permission on this service account. */
+      serviceAccount?: string;
     }
     interface GoogleCloudAiplatformV1beta1DeployModelOperationMetadata {
       /** The operation generic information. */
@@ -1268,6 +1283,30 @@ declare namespace gapi.client {
       /** Type of the boot disk (default is "pd-ssd"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive). */
       bootDiskType?: string;
     }
+    interface GoogleCloudAiplatformV1beta1DistillationHyperParameters {
+      /** Optional. Adapter size for distillation. */
+      adapterSize?: string;
+      /** Optional. Number of complete passes the model makes over the entire training dataset during training. */
+      epochCount?: string;
+      /** Optional. Multiplier for adjusting the default learning rate. */
+      learningRateMultiplier?: number;
+    }
+    interface GoogleCloudAiplatformV1beta1DistillationSpec {
+      /** The base teacher model that is being distilled, e.g., "gemini-1.0-pro-002". */
+      baseTeacherModel?: string;
+      /** Optional. Hyperparameters for Distillation. */
+      hyperParameters?: GoogleCloudAiplatformV1beta1DistillationHyperParameters;
+      /** Required. A path in a Cloud Storage bucket, which will be treated as the root output directory of the distillation pipeline. It is used by the system to generate the paths of output artifacts. */
+      pipelineRootDirectory?: string;
+      /** The student model that is being tuned, e.g., "google/gemma-2b-it". */
+      studentModel?: string;
+      /** Required. Cloud Storage path to file containing training dataset for tuning. The dataset must be formatted as a JSONL file. */
+      trainingDatasetUri?: string;
+      /** The resource name of the Tuned teacher model. Format: `projects/{project}/locations/{location}/models/{model}`. */
+      tunedTeacherModelSource?: string;
+      /** Optional. Cloud Storage path to file containing validation dataset for tuning. The dataset must be formatted as a JSONL file. */
+      validationDatasetUri?: string;
+    }
     interface GoogleCloudAiplatformV1beta1DoubleArray {
       /** A list of double values. */
       values?: number[];
@@ -2085,6 +2124,8 @@ declare namespace gapi.client {
       stringArrayValue?: GoogleCloudAiplatformV1beta1StringArray;
       /** String feature value. */
       stringValue?: string;
+      /** A struct type feature value. */
+      structValue?: GoogleCloudAiplatformV1beta1StructValue;
     }
     interface GoogleCloudAiplatformV1beta1FeatureValueDestination {
       /** Output in BigQuery format. BigQueryDestination.output_uri in FeatureValueDestination.bigquery_destination must refer to a table. */
@@ -2458,8 +2499,6 @@ declare namespace gapi.client {
       presencePenalty?: number;
       /** 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. */
       responseMimeType?: string;
-      /** Optional. Control Three levels of creativity in the model output. Default: RESPONSE_STYLE_BALANCED */
-      responseStyle?: string;
       /** Optional. Stop sequences. */
       stopSequences?: string[];
       /** Optional. Controls the randomness of predictions. */
@@ -2491,6 +2530,7 @@ declare namespace gapi.client {
       /** Required. The type of the Google Drive resource. */
       resourceType?: string;
     }
+    interface GoogleCloudAiplatformV1beta1GoogleSearchRetrieval {}
     interface GoogleCloudAiplatformV1beta1GroundednessInput {
       /** Required. Groundedness instance. */
       instance?: GoogleCloudAiplatformV1beta1GroundednessInstance;
@@ -3206,6 +3246,8 @@ declare namespace gapi.client {
     interface GoogleCloudAiplatformV1beta1MetadataStore {
       /** Output only. Timestamp when this MetadataStore was created. */
       createTime?: string;
+      /** Optional. Dataplex integration settings. */
+      dataplexConfig?: GoogleCloudAiplatformV1beta1MetadataStoreDataplexConfig;
       /** Description of the MetadataStore. */
       description?: string;
       /** Customer-managed encryption key spec for a Metadata Store. If set, this Metadata Store and all sub-resources of this Metadata Store are secured using this key. */
@@ -3217,6 +3259,10 @@ declare namespace gapi.client {
       /** Output only. Timestamp when this MetadataStore was last updated. */
       updateTime?: string;
     }
+    interface GoogleCloudAiplatformV1beta1MetadataStoreDataplexConfig {
+      /** Optional. Whether or not Data Lineage synchronization is enabled for Vertex Pipelines. */
+      enabledPipelinesLineage?: boolean;
+    }
     interface GoogleCloudAiplatformV1beta1MetadataStoreMetadataStoreState {
       /** The disk utilization of the MetadataStore in bytes. */
       diskUtilizationBytes?: string;
@@ -3946,7 +3992,7 @@ declare namespace gapi.client {
       doubleValue?: number;
     }
     interface GoogleCloudAiplatformV1beta1ModelMonitoringStatsDataPointTypedValueDistributionDataValue {
-      /** tensorflow.metadata.v0.DatasetFeatureStatistics format. */
+      /** Predictive monitoring drift distribution in `tensorflow.metadata.v0.DatasetFeatureStatistics` format. */
       distribution?: any;
       /** Distribution distance deviation from the current dataset's statistics to baseline dataset's statistics. * For categorical feature, the distribution distance is calculated by L-inifinity norm or Jensen–Shannon divergence. * For numerical feature, the distribution distance is calculated by Jensen–Shannon divergence. */
       distributionDeviation?: number;
@@ -4212,8 +4258,6 @@ declare namespace gapi.client {
     interface GoogleCloudAiplatformV1beta1NotebookExecutionJob {
       /** Output only. Timestamp when this NotebookExecutionJob was created. */
       createTime?: string;
-      /** The custom compute configuration for an execution job. */
-      customEnvironmentSpec?: GoogleCloudAiplatformV1beta1NotebookExecutionJobCustomEnvironmentSpec;
       /** The Dataform Repository pointing to a single file notebook repository. */
       dataformRepositorySource?: GoogleCloudAiplatformV1beta1NotebookExecutionJobDataformRepositorySource;
       /** The contents of an input notebook file. */
@@ -4245,14 +4289,6 @@ declare namespace gapi.client {
       /** Output only. Timestamp when this NotebookExecutionJob was most recently updated. */
       updateTime?: string;
     }
-    interface GoogleCloudAiplatformV1beta1NotebookExecutionJobCustomEnvironmentSpec {
-      /** The specification of a single machine for the execution job. */
-      machineSpec?: GoogleCloudAiplatformV1beta1MachineSpec;
-      /** The network configuration to use for the execution job. */
-      networkSpec?: GoogleCloudAiplatformV1beta1NetworkSpec;
-      /** The specification of a persistent disk to attach for the execution job. */
-      persistentDiskSpec?: GoogleCloudAiplatformV1beta1PersistentDiskSpec;
-    }
     interface GoogleCloudAiplatformV1beta1NotebookExecutionJobDataformRepositorySource {
       /** The commit SHA to read repository with. If unset, the file will be read at HEAD. */
       commitSha?: string;
@@ -4290,10 +4326,14 @@ declare namespace gapi.client {
       description?: string;
       /** Required. The display name of the NotebookRuntime. The name can be up to 128 characters long and can consist of any UTF-8 characters. */
       displayName?: string;
+      /** Output only. Customer-managed encryption key spec for the notebook runtime. */
+      encryptionSpec?: GoogleCloudAiplatformV1beta1EncryptionSpec;
       /** Output only. Timestamp when this NotebookRuntime will be expired: 1. System Predefined NotebookRuntime: 24 hours after creation. After expiration, system predifined runtime will be deleted. 2. User created NotebookRuntime: 6 months after last upgrade. After expiration, user created runtime will be stopped and allowed for upgrade. */
       expirationTime?: string;
       /** Output only. The health state of the NotebookRuntime. */
       healthState?: string;
+      /** Output only. The idle shutdown configuration of the notebook runtime. */
+      idleShutdownConfig?: GoogleCloudAiplatformV1beta1NotebookIdleShutdownConfig;
       /** Output only. Whether NotebookRuntime is upgradable. */
       isUpgradable?: boolean;
       /** The labels with user-defined metadata to organize your NotebookRuntime. 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. No more than 64 user labels can be associated with one NotebookRuntime (System labels are excluded). 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. Following system labels exist for NotebookRuntime: * "aiplatform.googleapis.com/notebook_runtime_gce_instance_id": output only, its value is the Compute Engine instance id. * "aiplatform.googleapis.com/colab_enterprise_entry_service": its value is either "bigquery" or "vertex"; if absent, it should be "vertex". This is to describe the entry service, either BigQuery or Vertex. */
@@ -4334,6 +4374,8 @@ declare namespace gapi.client {
       description?: string;
       /** Required. The display name of the NotebookRuntimeTemplate. The name can be up to 128 characters long and can consist of any UTF-8 characters. */
       displayName?: string;
+      /** Customer-managed encryption key spec for the notebook runtime. */
+      encryptionSpec?: GoogleCloudAiplatformV1beta1EncryptionSpec;
       /** Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. */
       etag?: string;
       /** EUC configuration of the NotebookRuntimeTemplate. */
@@ -4688,7 +4730,7 @@ declare namespace gapi.client {
       projectAllowlist?: string[];
     }
     interface GoogleCloudAiplatformV1beta1Probe {
-      /** Exec specifies the action to take. */
+      /** ExecAction probes the health of a container by executing a command. */
       exec?: GoogleCloudAiplatformV1beta1ProbeExecAction;
       /** How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Must be less than timeout_seconds. Maps to Kubernetes probe argument 'periodSeconds'. */
       periodSeconds?: number;
@@ -5387,9 +5429,9 @@ declare namespace gapi.client {
       fileOutputGcsBucket?: string;
     }
     interface GoogleCloudAiplatformV1beta1RuntimeConfigVertexAISearchRuntimeConfig {
-      /** 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. */
-      appId?: string;
-      /** [Deprecated] Please use app_id instead. Vertex AI Search serving config name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config}` */
+      /** Optional. Vertex AI Search engine ID. This is used to construct the search request. By setting this engine_id, API will construct the serving config using the default value to call search API for the user. The engine_id and serving_config_name cannot both be empty at the same time. */
+      engineId?: string;
+      /** Optional. Vertex AI Search serving config name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config}` */
       servingConfigName?: string;
     }
     interface GoogleCloudAiplatformV1beta1SafetyInput {
@@ -7051,6 +7093,16 @@ declare namespace gapi.client {
       /** A list of string values. */
       values?: string[];
     }
+    interface GoogleCloudAiplatformV1beta1StructFieldValue {
+      /** Name of the field in the struct feature. */
+      name?: string;
+      /** The value for this field. */
+      value?: GoogleCloudAiplatformV1beta1FeatureValue;
+    }
+    interface GoogleCloudAiplatformV1beta1StructValue {
+      /** A list of field values. */
+      values?: GoogleCloudAiplatformV1beta1StructFieldValue[];
+    }
     interface GoogleCloudAiplatformV1beta1Study {
       /** Output only. Time at which the study was created. */
       createTime?: string;
@@ -7591,6 +7643,8 @@ declare namespace gapi.client {
     interface GoogleCloudAiplatformV1beta1Tool {
       /** Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 64 function declarations can be provided. */
       functionDeclarations?: GoogleCloudAiplatformV1beta1FunctionDeclaration[];
+      /** Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. */
+      googleSearchRetrieval?: any;
       /** Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. */
       retrieval?: GoogleCloudAiplatformV1beta1Retrieval;
     }
@@ -7802,6 +7856,8 @@ declare namespace gapi.client {
       createTime?: string;
       /** Optional. The description of the TuningJob. */
       description?: string;
+      /** Tuning Spec for Distillation. */
+      distillationSpec?: GoogleCloudAiplatformV1beta1DistillationSpec;
       /** 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. */
       encryptionSpec?: GoogleCloudAiplatformV1beta1EncryptionSpec;
       /** Output only. Time when the TuningJob entered any of the following JobStates: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`, `JOB_STATE_EXPIRED`. */
@@ -7814,6 +7870,8 @@ declare namespace gapi.client {
       labels?: {[P in string]: string};
       /** Output only. Identifier. Resource name of a TuningJob. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}` */
       name?: string;
+      /** Output only. The resource name of the PipelineJob associated with the TuningJob. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`. */
+      pipelineJob?: string;
       /** Output only. Time when the TuningJob for the first time entered the `JOB_STATE_RUNNING` state. */
       startTime?: string;
       /** Output only. The detailed state of the job. */
@@ -11461,6 +11519,66 @@ declare namespace gapi.client {
     interface EdgeDevicesResource {
       operations: OperationsResource;
     }
+    interface ChatResource {
+      /** Exposes an OpenAI-compatible endpoint for chat completions. */
+      completions(request: {
+        /** V1 error format. */
+        '$.xgafv'?: string;
+        /** OAuth access token. */
+        access_token?: string;
+        /** Data format for response. */
+        alt?: string;
+        /** JSONP */
+        callback?: string;
+        /** Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/openapi` */
+        endpoint: 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;
+        /** 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: GoogleApiHttpBody;
+      }): Request<GoogleApiHttpBody>;
+      completions(
+        request: {
+          /** V1 error format. */
+          '$.xgafv'?: string;
+          /** OAuth access token. */
+          access_token?: string;
+          /** Data format for response. */
+          alt?: string;
+          /** JSONP */
+          callback?: string;
+          /** Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/openapi` */
+          endpoint: 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;
+          /** 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: GoogleApiHttpBody
+      ): Request<GoogleApiHttpBody>;
+    }
     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?: {
@@ -12662,6 +12780,7 @@ declare namespace gapi.client {
         },
         body: GoogleCloudAiplatformV1beta1UndeployModelRequest
       ): Request<GoogleLongrunningOperation>;
+      chat: ChatResource;
       operations: OperationsResource;
     }
     interface OperationsResource {
@@ -26656,6 +26775,68 @@ declare namespace gapi.client {
         /** Legacy upload protocol for media (e.g. "media", "multipart"). */
         uploadType?: string;
       }): Request<GoogleCloudAiplatformV1beta1ListReasoningEnginesResponse>;
+      /** Updates a reasoning engine. */
+      patch(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;
+        /** Identifier. The resource name of the ReasoningEngine. */
+        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;
+        /** Required. Mask specifying which fields to update. */
+        updateMask?: 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: GoogleCloudAiplatformV1beta1ReasoningEngine;
+      }): Request<GoogleLongrunningOperation>;
+      patch(
+        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;
+          /** Identifier. The resource name of the ReasoningEngine. */
+          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;
+          /** Required. Mask specifying which fields to update. */
+          updateMask?: string;
+          /** Upload protocol for media (e.g. "raw", "multipart"). */
+          upload_protocol?: string;
+          /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+          uploadType?: string;
+        },
+        body: GoogleCloudAiplatformV1beta1ReasoningEngine
+      ): Request<GoogleLongrunningOperation>;
       /** Queries using a reasoning engine. */
       query(request: {
         /** V1 error format. */

package/package.json

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