@maxim_mazurok/gapi.client.aiplatform-v1beta1 0.0.20250505 → 0.0.20250516

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: 20250505
+// Revision: 20250516
 
 /// <reference types="gapi.client" />
 
@@ -234,6 +234,8 @@ declare namespace gapi.client {
     interface GoogleCloudAiplatformV1beta1ApiAuthApiKeyConfig {
       /** Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} */
       apiKeySecretVersion?: string;
+      /** The API key string. Either this or `api_key_secret_version` must be set. */
+      apiKeyString?: string;
     }
     interface GoogleCloudAiplatformV1beta1AppendEventResponse {}
     interface GoogleCloudAiplatformV1beta1Artifact {
@@ -720,6 +722,8 @@ declare namespace gapi.client {
       createTime?: string;
       /** Optional. Immutable. The user-generated meaningful display name of the cached content. */
       displayName?: string;
+      /** Input only. Immutable. Customer-managed encryption key spec for a `CachedContent`. If set, this `CachedContent` and all its sub-resources will be secured by this key. */
+      encryptionSpec?: GoogleCloudAiplatformV1beta1EncryptionSpec;
       /** 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 `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} */
@@ -1591,6 +1595,8 @@ declare namespace gapi.client {
       systemLabels?: {[P in string]: string};
     }
     interface GoogleCloudAiplatformV1beta1DeployedModelRef {
+      /** Immutable. The ID of the Checkpoint deployed in the DeployedModel. */
+      checkpointId?: string;
       /** Immutable. An ID of a DeployedModel in the above Endpoint. */
       deployedModelId?: string;
       /** Immutable. A resource name of an Endpoint. */
@@ -2120,8 +2126,6 @@ declare namespace gapi.client {
       displayName?: string;
       /** Optional. Immutable. Unique identifier of an example. If not specified when upserting new examples, the example_id will be generated. */
       exampleId?: string;
-      /** Identifier. The resource name of the Example. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/examples/{example}` */
-      name?: string;
       /** An example of chat history and its expected outcome to be used with GenerateContent. */
       storedContentsExample?: GoogleCloudAiplatformV1beta1StoredContentsExample;
     }
@@ -2543,6 +2547,29 @@ declare namespace gapi.client {
       /** Required. The Service Directory resource name in which the service endpoints associated to the extension are registered. Format: `projects/{project_id}/locations/{location_id}/namespaces/{namespace_id}/services/{service_id}` - The Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) should be granted `servicedirectory.viewer` and `servicedirectory.pscAuthorizedService` roles on the resource. */
       serviceDirectory?: string;
     }
+    interface GoogleCloudAiplatformV1beta1ExternalApi {
+      /** The authentication config to access the API. Deprecated. Please use auth_config instead. */
+      apiAuth?: GoogleCloudAiplatformV1beta1ApiAuth;
+      /** The API spec that the external API implements. */
+      apiSpec?: string;
+      /** The authentication config to access the API. */
+      authConfig?: GoogleCloudAiplatformV1beta1AuthConfig;
+      /** Parameters for the elastic search API. */
+      elasticSearchParams?: GoogleCloudAiplatformV1beta1ExternalApiElasticSearchParams;
+      /** The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search */
+      endpoint?: string;
+      /** Parameters for the simple search API. */
+      simpleSearchParams?: any;
+    }
+    interface GoogleCloudAiplatformV1beta1ExternalApiElasticSearchParams {
+      /** The ElasticSearch index to use. */
+      index?: string;
+      /** Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. */
+      numHits?: number;
+      /** The ElasticSearch search template to use. */
+      searchTemplate?: string;
+    }
+    interface GoogleCloudAiplatformV1beta1ExternalApiSimpleSearchParams {}
     interface GoogleCloudAiplatformV1beta1Fact {
       /** If present, chunk properties. */
       chunk?: GoogleCloudAiplatformV1beta1RagChunk;
@@ -2749,7 +2776,7 @@ declare namespace gapi.client {
       featureConfigs?: GoogleCloudAiplatformV1beta1FeatureSelectionConfigFeatureConfig[];
     }
     interface GoogleCloudAiplatformV1beta1FeatureSelectionConfigFeatureConfig {
-      /** Optional. Drift threshold. If calculated difference with baseline data larger than threshold, it will be considered as the feature has drift. If not present, the threshold will be default to 0.3. */
+      /** Optional. Drift threshold. If calculated difference with baseline data larger than threshold, it will be considered as the feature has drift. If not present, the threshold will be default to 0.3. Must be in range [0, 1). */
       driftThreshold?: number;
       /** Required. The ID of the feature resource. Final component of the Feature's resource name. */
       featureId?: string;
@@ -3483,6 +3510,8 @@ declare namespace gapi.client {
       modelName?: string;
     }
     interface GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig {
+      /** Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. */
+      includeThoughts?: boolean;
       /** Optional. Indicates the thinking budget in tokens. This is only applied when enable_thinking is true. */
       thinkingBudget?: number;
     }
@@ -3727,6 +3756,8 @@ declare namespace gapi.client {
       ragFileParsingConfig?: GoogleCloudAiplatformV1beta1RagFileParsingConfig;
       /** Specifies the transformation config for RagFiles. */
       ragFileTransformationConfig?: GoogleCloudAiplatformV1beta1RagFileTransformationConfig;
+      /** Rebuilds the ANN index to optimize for recall on the imported data. Only applicable for RagCorpora running on RagManagedDb with `retrieval_strategy` set to `ANN`. The rebuild will be performed using the existing ANN config set on the RagCorpus. To change the ANN config, please use the UpdateRagCorpus API. Default is false, i.e., index is not rebuilt. */
+      rebuildAnnIndex?: boolean;
       /** SharePoint sources. */
       sharePointSources?: GoogleCloudAiplatformV1beta1SharePointSources;
       /** Slack channels with their corresponding access tokens. */
@@ -4829,6 +4860,8 @@ declare namespace gapi.client {
       createTime?: string;
       /** The display name of the ModelMonitor. The name can be up to 128 characters long and can consist of any UTF-8. */
       displayName?: string;
+      /** Customer-managed encryption key spec for a ModelMonitor. If set, this ModelMonitor and all sub-resources of this ModelMonitor will be secured by this key. */
+      encryptionSpec?: GoogleCloudAiplatformV1beta1EncryptionSpec;
       /** Optional model explanation spec. It is used for feature attribution monitoring. */
       explanationSpec?: GoogleCloudAiplatformV1beta1ExplanationSpec;
       /** Monitoring Schema is to specify the model's features, prediction outputs and ground truth properties. It is used to extract pertinent data from the dataset and to process features based on their properties. Make sure that the schema aligns with your dataset, if it does not, we will be unable to extract data from the dataset. It is required for most models, but optional for Vertex AI AutoML Tables unless the schem information is not available. */
@@ -6633,6 +6666,8 @@ declare namespace gapi.client {
       description?: string;
       /** Required. The display name of the RagCorpus. The name can be up to 128 characters long and can consist of any UTF-8 characters. */
       displayName?: string;
+      /** Optional. Immutable. The CMEK key name used to encrypt at-rest data related to this Corpus. Only applicable to RagManagedDb option for Vector DB. This field can only be set at corpus creation time, and cannot be updated or deleted. */
+      encryptionSpec?: GoogleCloudAiplatformV1beta1EncryptionSpec;
       /** Output only. The resource name of the RagCorpus. */
       name?: string;
       /** Optional. Immutable. The embedding model config of the RagCorpus. */
@@ -6832,7 +6867,7 @@ declare namespace gapi.client {
       /** Optional. Immutable. The embedding model config of the Vector DB. */
       ragEmbeddingModelConfig?: GoogleCloudAiplatformV1beta1RagEmbeddingModelConfig;
       /** The config for the RAG-managed Vector DB. */
-      ragManagedDb?: any;
+      ragManagedDb?: GoogleCloudAiplatformV1beta1RagVectorDbConfigRagManagedDb;
       /** The config for the Vertex Feature Store. */
       vertexFeatureStore?: GoogleCloudAiplatformV1beta1RagVectorDbConfigVertexFeatureStore;
       /** The config for the Vertex Vector Search. */
@@ -6844,7 +6879,19 @@ declare namespace gapi.client {
       /** Pinecone index name. This value cannot be changed after it's set. */
       indexName?: string;
     }
-    interface GoogleCloudAiplatformV1beta1RagVectorDbConfigRagManagedDb {}
+    interface GoogleCloudAiplatformV1beta1RagVectorDbConfigRagManagedDb {
+      /** Performs an ANN search on RagCorpus. Use this if you have a lot of files (> 10K) in your RagCorpus and want to reduce the search latency. */
+      ann?: GoogleCloudAiplatformV1beta1RagVectorDbConfigRagManagedDbANN;
+      /** Performs a KNN search on RagCorpus. Default choice if not specified. */
+      knn?: any;
+    }
+    interface GoogleCloudAiplatformV1beta1RagVectorDbConfigRagManagedDbANN {
+      /** Number of leaf nodes in the tree-based structure. Each leaf node contains groups of closely related vectors along with their corresponding centroid. Recommended value is 10 * sqrt(num of RagFiles in your RagCorpus). Default value is 500. */
+      leafCount?: number;
+      /** The depth of the tree-based structure. Only depth values of 2 and 3 are supported. Recommended value is 2 if you have if you have O(10K) files in the RagCorpus and set this to 3 if more than that. Default value is 2. */
+      treeDepth?: number;
+    }
+    interface GoogleCloudAiplatformV1beta1RagVectorDbConfigRagManagedDbKNN {}
     interface GoogleCloudAiplatformV1beta1RagVectorDbConfigVertexFeatureStore {
       /** The resource name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}` */
       featureViewResourceName?: string;
@@ -6972,7 +7019,7 @@ declare namespace gapi.client {
       displayName?: string;
       /** Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. */
       etag?: string;
-      /** Identifier. The resource name of the ReasoningEngine. */
+      /** Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` */
       name?: string;
       /** Optional. Configurations of the ReasoningEngine */
       spec?: GoogleCloudAiplatformV1beta1ReasoningEngineSpec;
@@ -7123,6 +7170,8 @@ declare namespace gapi.client {
     interface GoogleCloudAiplatformV1beta1Retrieval {
       /** Optional. Deprecated. This option is no longer supported. */
       disableAttribution?: boolean;
+      /** Use data source powered by external API for grounding. */
+      externalApi?: GoogleCloudAiplatformV1beta1ExternalApi;
       /** Set to use data source powered by Vertex AI Search. */
       vertexAiSearch?: GoogleCloudAiplatformV1beta1VertexAISearch;
       /** Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. */
@@ -10461,13 +10510,25 @@ declare namespace gapi.client {
     interface GoogleCloudAiplatformV1beta1VertexAISearch {
       /** Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` */
       datastore?: string;
+      /** Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. */
+      dataStoreSpecs?: GoogleCloudAiplatformV1beta1VertexAISearchDataStoreSpec[];
       /** Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` */
       engine?: string;
+      /** Optional. Filter strings to be passed to the search API. */
+      filter?: string;
+      /** Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. */
+      maxResults?: number;
     }
     interface GoogleCloudAiplatformV1beta1VertexAiSearchConfig {
       /** Vertex AI Search Serving Config resource full name. For example, `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config}` or `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config}`. */
       servingConfig?: string;
     }
+    interface GoogleCloudAiplatformV1beta1VertexAISearchDataStoreSpec {
+      /** Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` */
+      dataStore?: string;
+      /** Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) */
+      filter?: string;
+    }
     interface GoogleCloudAiplatformV1beta1VertexRagStore {
       /** Optional. Deprecated. Please use rag_resources instead. */
       ragCorpora?: string[];
@@ -32881,6 +32942,154 @@ declare namespace gapi.client {
         uploadType?: string;
       }): Request<GoogleLongrunningOperation>;
     }
+    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<{}>;
+      /** Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. */
+      delete(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 deleted. */
+        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>;
+      /** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
+      list(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;
+        /** The standard list filter. */
+        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;
+        /** The name of the operation's parent resource. */
+        name: string;
+        /** OAuth 2.0 token for the current user. */
+        oauth_token?: string;
+        /** The standard list page size. */
+        pageSize?: number;
+        /** The standard list page token. */
+        pageToken?: 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<GoogleLongrunningListOperationsResponse>;
+      /** Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. */
+      wait(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 wait on. */
+        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;
+        /** The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. */
+        timeout?: 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 SandboxEnvironmentsResource {
+      operations: OperationsResource;
+    }
     interface EventsResource {
       /** Lists Events in a given session. */
       list(request?: {
@@ -33346,7 +33555,7 @@ declare namespace gapi.client {
         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. */
+        /** Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` */
         name: string;
         /** OAuth 2.0 token for the current user. */
         oauth_token?: string;
@@ -33377,7 +33586,7 @@ declare namespace gapi.client {
           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. */
+          /** Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` */
           name: string;
           /** OAuth 2.0 token for the current user. */
           oauth_token?: string;
@@ -33511,6 +33720,7 @@ declare namespace gapi.client {
         body: GoogleCloudAiplatformV1beta1StreamQueryReasoningEngineRequest,
       ): Request<GoogleApiHttpBody>;
       operations: OperationsResource;
+      sandboxEnvironments: SandboxEnvironmentsResource;
       sessions: SessionsResource;
     }
     interface OperationsResource {

package/package.json

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