@maxim_mazurok/gapi.client.aiplatform-v1 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=v1
-// Revision: 20240510
+// Revision: 20240520
 
 /// <reference types="gapi.client" />
 
@@ -25,9 +25,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;
@@ -82,11 +82,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[];
@@ -1075,8 +1084,14 @@ declare namespace gapi.client {
       createTime?: string;
       /** Required. The underlying DedicatedResources that the DeploymentResourcePool uses. */
       dedicatedResources?: GoogleCloudAiplatformV1DedicatedResources;
+      /** 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?: GoogleCloudAiplatformV1EncryptionSpec;
       /** 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 GoogleCloudAiplatformV1DeployModelOperationMetadata {
       /** The operation generic information. */
@@ -1760,6 +1775,8 @@ declare namespace gapi.client {
       stringArrayValue?: GoogleCloudAiplatformV1StringArray;
       /** String feature value. */
       stringValue?: string;
+      /** A struct type feature value. */
+      structValue?: GoogleCloudAiplatformV1StructValue;
     }
     interface GoogleCloudAiplatformV1FeatureValueDestination {
       /** Output in BigQuery format. BigQueryDestination.output_uri in FeatureValueDestination.bigquery_destination must refer to a table. */
@@ -2032,8 +2049,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. */
@@ -2055,6 +2070,7 @@ declare namespace gapi.client {
       /** Required. The public base model URI. */
       baseModelUri?: string;
     }
+    interface GoogleCloudAiplatformV1GoogleSearchRetrieval {}
     interface GoogleCloudAiplatformV1GroundingMetadata {
       /** Optional. Google search entry for the following-up web searches. */
       searchEntryPoint?: GoogleCloudAiplatformV1SearchEntryPoint;
@@ -2674,6 +2690,8 @@ declare namespace gapi.client {
     interface GoogleCloudAiplatformV1MetadataStore {
       /** Output only. Timestamp when this MetadataStore was created. */
       createTime?: string;
+      /** Optional. Dataplex integration settings. */
+      dataplexConfig?: GoogleCloudAiplatformV1MetadataStoreDataplexConfig;
       /** 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. */
@@ -2685,6 +2703,10 @@ declare namespace gapi.client {
       /** Output only. Timestamp when this MetadataStore was last updated. */
       updateTime?: string;
     }
+    interface GoogleCloudAiplatformV1MetadataStoreDataplexConfig {
+      /** Optional. Whether or not Data Lineage synchronization is enabled for Vertex Pipelines. */
+      enabledPipelinesLineage?: boolean;
+    }
     interface GoogleCloudAiplatformV1MetadataStoreMetadataStoreState {
       /** The disk utilization of the MetadataStore in bytes. */
       diskUtilizationBytes?: string;
@@ -3399,14 +3421,6 @@ declare namespace gapi.client {
       /** Required. Duration is accurate to the second. In Notebook, Idle Timeout is accurate to minute so the range of idle_timeout (second) is: 10 * 60 ~ 1440 * 60. */
       idleTimeout?: string;
     }
-    interface GoogleCloudAiplatformV1NotebookReservationAffinity {
-      /** Required. Specifies the type of reservation from which this instance can consume resources: RESERVATION_ANY (default), RESERVATION_SPECIFIC, or RESERVATION_NONE. See Consuming reserved instances for examples. */
-      consumeReservationType?: string;
-      /** Optional. Corresponds to the label key of a reservation resource. To target a RESERVATION_SPECIFIC by name, use compute.googleapis.com/reservation-name as the key and specify the name of your reservation as its value. */
-      key?: string;
-      /** Optional. Corresponds to the label values of a reservation resource. This must be the full path name of Reservation. */
-      values?: string[];
-    }
     interface GoogleCloudAiplatformV1NotebookRuntime {
       /** Output only. Timestamp when this NotebookRuntime was created. */
       createTime?: string;
@@ -3418,6 +3432,8 @@ declare namespace gapi.client {
       expirationTime?: string;
       /** Output only. The health state of the NotebookRuntime. */
       healthState?: string;
+      /** Output only. The idle shutdown configuration of the notebook runtime. */
+      idleShutdownConfig?: GoogleCloudAiplatformV1NotebookIdleShutdownConfig;
       /** 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. */
@@ -3432,8 +3448,6 @@ declare namespace gapi.client {
       notebookRuntimeType?: string;
       /** Output only. The proxy endpoint used to access the NotebookRuntime. */
       proxyUri?: string;
-      /** Output only. Reservation Affinity of the notebook runtime. */
-      reservationAffinity?: GoogleCloudAiplatformV1NotebookReservationAffinity;
       /** Output only. The runtime (instance) state of the NotebookRuntime. */
       runtimeState?: string;
       /** Required. The user email of the NotebookRuntime. */
@@ -3458,6 +3472,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?: GoogleCloudAiplatformV1EncryptionSpec;
       /** Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. */
       etag?: string;
       /** EUC configuration of the NotebookRuntimeTemplate. */
@@ -3478,8 +3494,6 @@ declare namespace gapi.client {
       networkTags?: string[];
       /** Optional. Immutable. The type of the notebook runtime template. */
       notebookRuntimeType?: string;
-      /** Optional. Reservation Affinity of the notebook runtime template. */
-      reservationAffinity?: GoogleCloudAiplatformV1NotebookReservationAffinity;
       /** The service account that the runtime workload runs as. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the [Compute Engine default service account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used. */
       serviceAccount?: string;
       /** Optional. Immutable. Runtime Shielded VM spec. */
@@ -3533,7 +3547,7 @@ declare namespace gapi.client {
       /** Required. The spec of the pools of different resources. */
       resourcePools?: GoogleCloudAiplatformV1ResourcePool[];
       /** Output only. Runtime information of the Persistent Resource. */
-      resourceRuntime?: any;
+      resourceRuntime?: GoogleCloudAiplatformV1ResourceRuntime;
       /** Optional. Persistent Resource runtime spec. For example, used for Ray cluster configuration. */
       resourceRuntimeSpec?: GoogleCloudAiplatformV1ResourceRuntimeSpec;
       /** Output only. Time when the PersistentResource for the first time entered the `RUNNING` state. */
@@ -3746,7 +3760,7 @@ declare namespace gapi.client {
       projectAllowlist?: string[];
     }
     interface GoogleCloudAiplatformV1Probe {
-      /** Exec specifies the action to take. */
+      /** ExecAction probes the health of a container by executing a command. */
       exec?: GoogleCloudAiplatformV1ProbeExecAction;
       /** 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;
@@ -3961,7 +3975,20 @@ declare namespace gapi.client {
       /** The prediction input. Supports HTTP headers and arbitrary data payload. A DeployedModel may have an upper limit on the number of instances it supports per request. When this limit it is exceeded for an AutoML model, the RawPredict method returns an error. When this limit is exceeded for a custom-trained model, the behavior varies depending on the model. You can specify the schema for each instance in the predict_schemata.instance_schema_uri field when you create a Model. This schema applies when you deploy the `Model` as a `DeployedModel` to an Endpoint and use the `RawPredict` method. */
       httpBody?: GoogleApiHttpBody;
     }
-    interface GoogleCloudAiplatformV1RaySpec {}
+    interface GoogleCloudAiplatformV1RayMetricSpec {
+      /** Optional. Flag to disable the Ray metrics collection. */
+      disabled?: boolean;
+    }
+    interface GoogleCloudAiplatformV1RaySpec {
+      /** Optional. This will be used to indicate which resource pool will serve as the Ray head node(the first node within that pool). Will use the machine from the first workerpool as the head node by default if this field isn't set. */
+      headNodeResourcePoolId?: string;
+      /** Optional. Default image for user to choose a preferred ML framework (for example, TensorFlow or Pytorch) by choosing from [Vertex prebuilt images](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). Either this or the resource_pool_images is required. Use this field if you need all the resource pools to have the same Ray image. Otherwise, use the {@code resource_pool_images} field. */
+      imageUri?: string;
+      /** Optional. Ray metrics configurations. */
+      rayMetricSpec?: GoogleCloudAiplatformV1RayMetricSpec;
+      /** Optional. Required if image_uri isn't set. A map of resource_pool_id to prebuild Ray image if user need to use different images for different head/worker pools. This map needs to cover all the resource pool ids. Example: { "ray_head_node_pool": "head image" "ray_worker_node_pool1": "worker image" "ray_worker_node_pool2": "another worker image" } */
+      resourcePoolImages?: {[P in string]: string};
+    }
     interface GoogleCloudAiplatformV1ReadFeatureValuesRequest {
       /** Required. ID for a specific entity. For example, for a machine learning model predicting user clicks on a website, an entity ID could be `user_123`. */
       entityId?: string;
@@ -4071,10 +4098,13 @@ declare namespace gapi.client {
       /** Optional. min replicas in the node pool, must be ≤ replica_count and < max_replica_count or will throw error */
       minReplicaCount?: string;
     }
-    interface GoogleCloudAiplatformV1ResourceRuntime {}
+    interface GoogleCloudAiplatformV1ResourceRuntime {
+      /** Output only. URIs for user to connect to the Cluster. Example: { "RAY_HEAD_NODE_INTERNAL_IP": "head-node-IP:10001" "RAY_DASHBOARD_URI": "ray-dashboard-address:8888" } */
+      accessUris?: {[P in string]: string};
+    }
     interface GoogleCloudAiplatformV1ResourceRuntimeSpec {
       /** Optional. Ray cluster configuration. Required when creating a dedicated RayCluster on the PersistentResource. */
-      raySpec?: any;
+      raySpec?: GoogleCloudAiplatformV1RaySpec;
       /** Optional. Configure the use of workload identity on the PersistentResource */
       serviceAccountSpec?: GoogleCloudAiplatformV1ServiceAccountSpec;
     }
@@ -4932,6 +4962,8 @@ declare namespace gapi.client {
       gcsUri?: string;
       /** Grounding checking configuration. */
       groundingConfig?: GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfig;
+      /** Whether the prompt dataset has prompt variable. */
+      hasPromptVariable?: boolean;
       /** Value of the maximum number of tokens generated set when the dataset was saved. */
       maxOutputTokens?: string;
       /** User-created prompt note. Note size limit is 2KB. */
@@ -5711,6 +5743,16 @@ declare namespace gapi.client {
       /** A list of string values. */
       values?: string[];
     }
+    interface GoogleCloudAiplatformV1StructFieldValue {
+      /** Name of the field in the struct feature. */
+      name?: string;
+      /** The value for this field. */
+      value?: GoogleCloudAiplatformV1FeatureValue;
+    }
+    interface GoogleCloudAiplatformV1StructValue {
+      /** A list of field values. */
+      values?: GoogleCloudAiplatformV1StructFieldValue[];
+    }
     interface GoogleCloudAiplatformV1Study {
       /** Output only. Time at which the study was created. */
       createTime?: string;
@@ -6139,6 +6181,8 @@ declare namespace gapi.client {
     interface GoogleCloudAiplatformV1Tool {
       /** 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?: GoogleCloudAiplatformV1FunctionDeclaration[];
+      /** 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?: GoogleCloudAiplatformV1Retrieval;
     }

package/package.json

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