@maxim_mazurok/gapi.client.aiplatform-v1 0.0.20250205 → 0.0.20250226

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: 20250205
+// Revision: 20250226
 
 /// <reference types="gapi.client" />
 
@@ -31,6 +31,16 @@ declare namespace gapi.client {
       raiMediaFilteredCount?: number;
       /** Returns rai failure reasons if any. */
       raiMediaFilteredReasons?: string[];
+      /** List of videos, used to align naming with the external response. */
+      videos?: CloudAiLargeModelsVisionGenerateVideoResponseVideo[];
+    }
+    interface CloudAiLargeModelsVisionGenerateVideoResponseVideo {
+      /** Base64 encoded bytes string representing the video. */
+      bytesBase64Encoded?: string;
+      /** Cloud Storage URI where the generated video is written. */
+      gcsUri?: string;
+      /** The MIME type of the content of the video. - video/mp4 */
+      mimeType?: string;
     }
     interface CloudAiLargeModelsVisionImage {
       /** Image encoding, encoded as "image/png" or "image/jpg". */
@@ -127,6 +137,8 @@ declare namespace gapi.client {
       encodedVideo?: string;
       /** Video encoding, for example "video/mp4". */
       encoding?: string;
+      /** Text/Expanded text input for Help Me Write. */
+      text?: string;
       /** Path to another storage (typically Google Cloud Storage). */
       uri?: string;
       /** Raw bytes. */
@@ -292,9 +304,9 @@ declare namespace gapi.client {
       facts?: GoogleCloudAiplatformV1Fact[];
     }
     interface GoogleCloudAiplatformV1AutomaticResources {
-      /** Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. */
+      /** Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. */
       maxReplicaCount?: number;
-      /** Immutable. The minimum number of replicas this DeployedModel will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. */
+      /** Immutable. The minimum number of replicas that will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. */
       minReplicaCount?: number;
     }
     interface GoogleCloudAiplatformV1AutoraterConfig {
@@ -591,7 +603,7 @@ declare namespace gapi.client {
       displayName?: string;
       /** Timestamp of when this resource is considered expired. This is *always* provided on output, regardless of what was sent on input. */
       expireTime?: string;
-      /** Immutable. The name of the publisher model to use for cached content. Format: projects/{project}/locations/{location}/publishers/{publisher}/models/{model} */
+      /** Immutable. The name of the `Model` to use for cached content. Currently, only the published Gemini base models are supported, in form of projects/{PROJECT}/locations/{LOCATION}/publishers/google/models/{MODEL} */
       model?: string;
       /** Immutable. Identifier. The server-generated resource name of the cached content Format: projects/{project}/locations/{location}/cachedContents/{cached_content} */
       name?: string;
@@ -1206,13 +1218,13 @@ declare namespace gapi.client {
     interface GoogleCloudAiplatformV1DedicatedResources {
       /** Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. */
       autoscalingMetricSpecs?: GoogleCloudAiplatformV1AutoscalingMetricSpec[];
-      /** Required. Immutable. The specification of a single machine used by the prediction. */
+      /** Required. Immutable. The specification of a single machine being used. */
       machineSpec?: GoogleCloudAiplatformV1MachineSpec;
-      /** Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). */
+      /** Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). */
       maxReplicaCount?: number;
-      /** Required. Immutable. The minimum number of machine replicas this DeployedModel will be always deployed on. This value must be greater than or equal to 1. If traffic against the DeployedModel increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. */
+      /** Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. */
       minReplicaCount?: number;
-      /** Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial model deployment/mutation is desired. If set, the model deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. */
+      /** Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. */
       requiredReplicaCount?: number;
       /** Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). */
       spot?: boolean;
@@ -1504,6 +1516,7 @@ declare namespace gapi.client {
       /** Output only. Timestamp when this Endpoint was last updated. */
       updateTime?: string;
     }
+    interface GoogleCloudAiplatformV1EnterpriseWebSearch {}
     interface GoogleCloudAiplatformV1EntityIdSelector {
       /** Source of Csv */
       csvSource?: GoogleCloudAiplatformV1CsvSource;
@@ -1576,6 +1589,16 @@ declare namespace gapi.client {
       /** Explanation type. For AutoML Image Classification models, possible values are: * `image-integrated-gradients` * `image-xrai` */
       explanationType?: string;
     }
+    interface GoogleCloudAiplatformV1EvaluateDatasetRequest {
+      /** Optional. Autorater config used for evaluation. */
+      autoraterConfig?: GoogleCloudAiplatformV1AutoraterConfig;
+      /** Required. The dataset used for evaluation. */
+      dataset?: GoogleCloudAiplatformV1EvaluationDataset;
+      /** Required. The metrics used for evaluation. */
+      metrics?: GoogleCloudAiplatformV1Metric[];
+      /** Required. Config for evaluation output. */
+      outputConfig?: GoogleCloudAiplatformV1OutputConfig;
+    }
     interface GoogleCloudAiplatformV1EvaluateInstancesRequest {
       /** Optional. Autorater config used for evaluation. */
       autoraterConfig?: GoogleCloudAiplatformV1AutoraterConfig;
@@ -1706,6 +1729,12 @@ declare namespace gapi.client {
       /** Results for trajectory single tool use metric. */
       trajectorySingleToolUseResults?: GoogleCloudAiplatformV1TrajectorySingleToolUseResults;
     }
+    interface GoogleCloudAiplatformV1EvaluationDataset {
+      /** BigQuery source holds the dataset. */
+      bigquerySource?: GoogleCloudAiplatformV1BigQuerySource;
+      /** Cloud storage source holds the dataset. */
+      gcsSource?: GoogleCloudAiplatformV1GcsSource;
+    }
     interface GoogleCloudAiplatformV1Event {
       /** Required. The relative resource name of the Artifact in the Event. */
       artifact?: string;
@@ -2686,9 +2715,31 @@ declare namespace gapi.client {
       promptTokenCount?: number;
       /** Output only. List of modalities that were processed in the request input. */
       promptTokensDetails?: GoogleCloudAiplatformV1ModalityTokenCount[];
-      /** Total token count for prompt and response candidates. */
+      /** Output only. Number of tokens present in tool-use prompt(s). */
+      toolUsePromptTokenCount?: number;
+      /** Output only. List of modalities that were processed for tool-use request inputs. */
+      toolUsePromptTokensDetails?: GoogleCloudAiplatformV1ModalityTokenCount[];
+      /** Total token count for prompt, response candidates, and tool-use prompts (if present). */
       totalTokenCount?: number;
     }
+    interface GoogleCloudAiplatformV1GenerateVideoResponse {
+      /** The cloud storage uris of the generated videos. */
+      generatedSamples?: string[];
+      /** Returns if any videos were filtered due to RAI policies. */
+      raiMediaFilteredCount?: number;
+      /** Returns rai failure reasons if any. */
+      raiMediaFilteredReasons?: string[];
+      /** List of video bytes or Cloud Storage URIs of the generated videos. */
+      videos?: GoogleCloudAiplatformV1GenerateVideoResponseVideo[];
+    }
+    interface GoogleCloudAiplatformV1GenerateVideoResponseVideo {
+      /** Base64 encoded bytes string representing the video. */
+      bytesBase64Encoded?: string;
+      /** Cloud Storage URI where the generated video is written. */
+      gcsUri?: string;
+      /** The MIME type of the content of the video. - video/mp4 */
+      mimeType?: string;
+    }
     interface GoogleCloudAiplatformV1GenerationConfig {
       /** Optional. If enabled, audio timestamp will be included in the request to the model. */
       audioTimestamp?: boolean;
@@ -3508,8 +3559,6 @@ declare namespace gapi.client {
       acceleratorType?: string;
       /** Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. */
       machineType?: string;
-      /** Optional. Immutable. The number of nodes per replica for multihost GPU deployments. */
-      multihostGpuNodeCount?: number;
       /** Optional. Immutable. Configuration controlling how this resource pool consumes reservation. */
       reservationAffinity?: GoogleCloudAiplatformV1ReservationAffinity;
       /** Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1"). */
@@ -3575,6 +3624,20 @@ declare namespace gapi.client {
       /** The disk utilization of the MetadataStore in bytes. */
       diskUtilizationBytes?: string;
     }
+    interface GoogleCloudAiplatformV1Metric {
+      /** Optional. The aggregation metrics to use. */
+      aggregationMetrics?: string[];
+      /** Spec for bleu metric. */
+      bleuSpec?: GoogleCloudAiplatformV1BleuSpec;
+      /** Spec for exact match metric. */
+      exactMatchSpec?: any;
+      /** Spec for pairwise metric. */
+      pairwiseMetricSpec?: GoogleCloudAiplatformV1PairwiseMetricSpec;
+      /** Spec for pointwise metric. */
+      pointwiseMetricSpec?: GoogleCloudAiplatformV1PointwiseMetricSpec;
+      /** Spec for rouge metric. */
+      rougeSpec?: GoogleCloudAiplatformV1RougeSpec;
+    }
     interface GoogleCloudAiplatformV1MetricxInput {
       /** Required. Metricx instance. */
       instance?: GoogleCloudAiplatformV1MetricxInstance;
@@ -4102,6 +4165,8 @@ declare namespace gapi.client {
       checkpointId?: string;
       /** The epoch of the checkpoint. */
       epoch?: string;
+      /** Identifier. The resource name of the ModelVersionCheckpoint. Format: `projects/{project}/locations/{location}/models/{model}/versions/{version}/checkpoints/{checkpoint}` */
+      name?: string;
       /** The step of the checkpoint. */
       step?: string;
     }
@@ -4532,6 +4597,10 @@ declare namespace gapi.client {
       /** Optional. Post startup script config. */
       postStartupScriptConfig?: GoogleCloudAiplatformV1PostStartupScriptConfig;
     }
+    interface GoogleCloudAiplatformV1OutputConfig {
+      /** Cloud storage destination for evaluation output. */
+      gcsDestination?: GoogleCloudAiplatformV1GcsDestination;
+    }
     interface GoogleCloudAiplatformV1PairwiseMetricInput {
       /** Required. Pairwise metric instance. */
       instance?: GoogleCloudAiplatformV1PairwiseMetricInstance;
@@ -5570,9 +5639,17 @@ declare namespace gapi.client {
     interface GoogleCloudAiplatformV1ReasoningEngineSpec {
       /** Optional. Declarations for object class methods in OpenAPI specification format. */
       classMethods?: Array<{[P in string]: any}>;
+      /** Optional. The specification of a Reasoning Engine deployment. */
+      deploymentSpec?: GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpec;
       /** Required. User provided package spec of the ReasoningEngine. */
       packageSpec?: GoogleCloudAiplatformV1ReasoningEngineSpecPackageSpec;
     }
+    interface GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpec {
+      /** Optional. Environment variables to be set with the Reasoning Engine deployment. The environment variables can be updated through the UpdateReasoningEngine API. */
+      env?: GoogleCloudAiplatformV1EnvVar[];
+      /** Optional. Environment variables where the value is a secret in Cloud Secret Manager. To use this feature, add 'Secret Manager Secret Accessor' role (roles/secretmanager.secretAccessor) to AI Platform Reasoning Engine Service Agent. */
+      secretEnv?: GoogleCloudAiplatformV1SecretEnvVar[];
+    }
     interface GoogleCloudAiplatformV1ReasoningEngineSpecPackageSpec {
       /** Optional. The Cloud Storage URI of the dependency files in tar.gz format. */
       dependencyFilesGcsUri?: string;
@@ -5615,7 +5692,7 @@ declare namespace gapi.client {
       key?: string;
       /** Required. Specifies the reservation affinity type. */
       reservationAffinityType?: string;
-      /** Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation. */
+      /** Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation or reservation block. */
       values?: string[];
     }
     interface GoogleCloudAiplatformV1ResourcePool {
@@ -6686,7 +6763,7 @@ declare namespace gapi.client {
       displayName?: string;
     }
     interface GoogleCloudAiplatformV1SchemaTextDataItem {
-      /** Output only. Google Cloud Storage URI points to the original text in user's bucket. The text file is up to 10MB in size. */
+      /** Output only. Google Cloud Storage URI points to a copy of the original text in the Vertex-managed bucket in the user's project. The text file is up to 10MB in size. */
       gcsUri?: string;
     }
     interface GoogleCloudAiplatformV1SchemaTextDatasetMetadata {
@@ -7425,6 +7502,18 @@ declare namespace gapi.client {
       /** The nearest neighbors of the query entity. */
       nearestNeighbors?: GoogleCloudAiplatformV1NearestNeighbors;
     }
+    interface GoogleCloudAiplatformV1SecretEnvVar {
+      /** Required. Name of the secret environment variable. */
+      name?: string;
+      /** Required. Reference to a secret stored in the Cloud Secret Manager that will provide the value for this environment variable. */
+      secretRef?: GoogleCloudAiplatformV1SecretRef;
+    }
+    interface GoogleCloudAiplatformV1SecretRef {
+      /** Required. The name of the secret in Cloud Secret Manager. Format: {secret_name} if the secret is in the same project. projects/{project}/secrets/{secret_name} if the secret is in a different project. */
+      secret?: string;
+      /** The Cloud Secret Manager secret version. Can be 'latest' for the latest version, an integer for a specific version, or a version alias. */
+      version?: string;
+    }
     interface GoogleCloudAiplatformV1Segment {
       /** Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero. */
       endIndex?: number;
@@ -8122,8 +8211,10 @@ declare namespace gapi.client {
       tokens?: string[];
     }
     interface GoogleCloudAiplatformV1Tool {
-      /** Optional. CodeExecution tool type. Enables the model to execute code as part of generation. This field is only used by the Gemini Developer API services. */
+      /** Optional. CodeExecution tool type. Enables the model to execute code as part of generation. */
       codeExecution?: any;
+      /** Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. */
+      enterpriseWebSearch?: any;
       /** 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 128 function declarations can be provided. */
       functionDeclarations?: GoogleCloudAiplatformV1FunctionDeclaration[];
       /** Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. */
@@ -8655,7 +8746,7 @@ declare namespace gapi.client {
       stringValue?: string;
     }
     interface GoogleCloudAiplatformV1VertexAISearch {
-      /** Required. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` */
+      /** Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` */
       datastore?: string;
     }
     interface GoogleCloudAiplatformV1VertexRagStore {
@@ -31905,6 +31996,64 @@ declare namespace gapi.client {
         },
         body: GoogleCloudAiplatformV1CorroborateContentRequest,
       ): Request<GoogleCloudAiplatformV1CorroborateContentResponse>;
+      /** Evaluates a dataset based on a set of given metrics. */
+      evaluateDataset(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;
+        /** Required. The resource name of the Location to evaluate the dataset. Format: `projects/{project}/locations/{location}` */
+        location: 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: GoogleCloudAiplatformV1EvaluateDatasetRequest;
+      }): Request<GoogleLongrunningOperation>;
+      evaluateDataset(
+        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;
+          /** Required. The resource name of the Location to evaluate the dataset. Format: `projects/{project}/locations/{location}` */
+          location: 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: GoogleCloudAiplatformV1EvaluateDatasetRequest,
+      ): Request<GoogleLongrunningOperation>;
       /** Evaluates instances based on a given metric. */
       evaluateInstances(request: {
         /** V1 error format. */

package/package.json

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