@maxim_mazurok/gapi.client.aiplatform-v1 0.0.20250513 → 0.0.20250516

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/index.d.ts +98 -3
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -9,7 +9,7 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://aiplatform.googleapis.com/$discovery/rest?version=v1
12
- // Revision: 20250513
12
+ // Revision: 20250516
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -226,6 +226,8 @@ declare namespace gapi.client {
226
226
  interface GoogleCloudAiplatformV1ApiAuthApiKeyConfig {
227
227
  /** Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} */
228
228
  apiKeySecretVersion?: string;
229
+ /** The API key string. Either this or `api_key_secret_version` must be set. */
230
+ apiKeyString?: string;
229
231
  }
230
232
  interface GoogleCloudAiplatformV1Artifact {
231
233
  /** Output only. Timestamp when this Artifact was created. */
@@ -303,6 +305,50 @@ declare namespace gapi.client {
303
305
  /** Retrieved facts from RAG data sources. */
304
306
  facts?: GoogleCloudAiplatformV1Fact[];
305
307
  }
308
+ interface GoogleCloudAiplatformV1AuthConfig {
309
+ /** Config for API key auth. */
310
+ apiKeyConfig?: GoogleCloudAiplatformV1AuthConfigApiKeyConfig;
311
+ /** Type of auth scheme. */
312
+ authType?: string;
313
+ /** Config for Google Service Account auth. */
314
+ googleServiceAccountConfig?: GoogleCloudAiplatformV1AuthConfigGoogleServiceAccountConfig;
315
+ /** Config for HTTP Basic auth. */
316
+ httpBasicAuthConfig?: GoogleCloudAiplatformV1AuthConfigHttpBasicAuthConfig;
317
+ /** Config for user oauth. */
318
+ oauthConfig?: GoogleCloudAiplatformV1AuthConfigOauthConfig;
319
+ /** Config for user OIDC auth. */
320
+ oidcConfig?: GoogleCloudAiplatformV1AuthConfigOidcConfig;
321
+ }
322
+ interface GoogleCloudAiplatformV1AuthConfigApiKeyConfig {
323
+ /** Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. */
324
+ apiKeySecret?: string;
325
+ /** Optional. The API key to be used in the request directly. */
326
+ apiKeyString?: string;
327
+ /** Optional. The location of the API key. */
328
+ httpElementLocation?: string;
329
+ /** Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. */
330
+ name?: string;
331
+ }
332
+ interface GoogleCloudAiplatformV1AuthConfigGoogleServiceAccountConfig {
333
+ /** Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. */
334
+ serviceAccount?: string;
335
+ }
336
+ interface GoogleCloudAiplatformV1AuthConfigHttpBasicAuthConfig {
337
+ /** Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. */
338
+ credentialSecret?: string;
339
+ }
340
+ interface GoogleCloudAiplatformV1AuthConfigOauthConfig {
341
+ /** Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. */
342
+ accessToken?: string;
343
+ /** The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. */
344
+ serviceAccount?: string;
345
+ }
346
+ interface GoogleCloudAiplatformV1AuthConfigOidcConfig {
347
+ /** OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. */
348
+ idToken?: string;
349
+ /** The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). */
350
+ serviceAccount?: string;
351
+ }
306
352
  interface GoogleCloudAiplatformV1AutomaticResources {
307
353
  /** 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. */
308
354
  maxReplicaCount?: number;
@@ -2120,6 +2166,29 @@ declare namespace gapi.client {
2120
2166
  /** The returned time series data points. */
2121
2167
  timeSeriesDataPoints?: GoogleCloudAiplatformV1TimeSeriesDataPoint[];
2122
2168
  }
2169
+ interface GoogleCloudAiplatformV1ExternalApi {
2170
+ /** The authentication config to access the API. Deprecated. Please use auth_config instead. */
2171
+ apiAuth?: GoogleCloudAiplatformV1ApiAuth;
2172
+ /** The API spec that the external API implements. */
2173
+ apiSpec?: string;
2174
+ /** The authentication config to access the API. */
2175
+ authConfig?: GoogleCloudAiplatformV1AuthConfig;
2176
+ /** Parameters for the elastic search API. */
2177
+ elasticSearchParams?: GoogleCloudAiplatformV1ExternalApiElasticSearchParams;
2178
+ /** 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 */
2179
+ endpoint?: string;
2180
+ /** Parameters for the simple search API. */
2181
+ simpleSearchParams?: any;
2182
+ }
2183
+ interface GoogleCloudAiplatformV1ExternalApiElasticSearchParams {
2184
+ /** The ElasticSearch index to use. */
2185
+ index?: string;
2186
+ /** Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. */
2187
+ numHits?: number;
2188
+ /** The ElasticSearch search template to use. */
2189
+ searchTemplate?: string;
2190
+ }
2191
+ interface GoogleCloudAiplatformV1ExternalApiSimpleSearchParams {}
2123
2192
  interface GoogleCloudAiplatformV1Fact {
2124
2193
  /** If present, chunk properties. */
2125
2194
  chunk?: GoogleCloudAiplatformV1RagChunk;
@@ -3075,6 +3144,8 @@ declare namespace gapi.client {
3075
3144
  ragFileParsingConfig?: GoogleCloudAiplatformV1RagFileParsingConfig;
3076
3145
  /** Specifies the transformation config for RagFiles. */
3077
3146
  ragFileTransformationConfig?: GoogleCloudAiplatformV1RagFileTransformationConfig;
3147
+ /** 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. */
3148
+ rebuildAnnIndex?: boolean;
3078
3149
  /** SharePoint sources. */
3079
3150
  sharePointSources?: GoogleCloudAiplatformV1SharePointSources;
3080
3151
  /** Slack channels with their corresponding access tokens. */
@@ -4786,6 +4857,8 @@ declare namespace gapi.client {
4786
4857
  inlineData?: GoogleCloudAiplatformV1Blob;
4787
4858
  /** Optional. Text part (can be code). */
4788
4859
  text?: string;
4860
+ /** Output only. Indicates if the part is thought from the model. */
4861
+ thought?: boolean;
4789
4862
  /** Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. */
4790
4863
  videoMetadata?: GoogleCloudAiplatformV1VideoMetadata;
4791
4864
  }
@@ -5647,7 +5720,7 @@ declare namespace gapi.client {
5647
5720
  /** Optional. Immutable. The embedding model config of the Vector DB. */
5648
5721
  ragEmbeddingModelConfig?: GoogleCloudAiplatformV1RagEmbeddingModelConfig;
5649
5722
  /** The config for the RAG-managed Vector DB. */
5650
- ragManagedDb?: any;
5723
+ ragManagedDb?: GoogleCloudAiplatformV1RagVectorDbConfigRagManagedDb;
5651
5724
  /** The config for the Vertex Vector Search. */
5652
5725
  vertexVectorSearch?: GoogleCloudAiplatformV1RagVectorDbConfigVertexVectorSearch;
5653
5726
  }
@@ -5655,7 +5728,19 @@ declare namespace gapi.client {
5655
5728
  /** Pinecone index name. This value cannot be changed after it's set. */
5656
5729
  indexName?: string;
5657
5730
  }
5658
- interface GoogleCloudAiplatformV1RagVectorDbConfigRagManagedDb {}
5731
+ interface GoogleCloudAiplatformV1RagVectorDbConfigRagManagedDb {
5732
+ /** 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. */
5733
+ ann?: GoogleCloudAiplatformV1RagVectorDbConfigRagManagedDbANN;
5734
+ /** Performs a KNN search on RagCorpus. Default choice if not specified. */
5735
+ knn?: any;
5736
+ }
5737
+ interface GoogleCloudAiplatformV1RagVectorDbConfigRagManagedDbANN {
5738
+ /** 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. */
5739
+ leafCount?: number;
5740
+ /** 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. */
5741
+ treeDepth?: number;
5742
+ }
5743
+ interface GoogleCloudAiplatformV1RagVectorDbConfigRagManagedDbKNN {}
5659
5744
  interface GoogleCloudAiplatformV1RagVectorDbConfigVertexVectorSearch {
5660
5745
  /** The resource name of the Index. Format: `projects/{project}/locations/{location}/indexes/{index}` */
5661
5746
  index?: string;
@@ -5885,6 +5970,8 @@ declare namespace gapi.client {
5885
5970
  interface GoogleCloudAiplatformV1Retrieval {
5886
5971
  /** Optional. Deprecated. This option is no longer supported. */
5887
5972
  disableAttribution?: boolean;
5973
+ /** Use data source powered by external API for grounding. */
5974
+ externalApi?: GoogleCloudAiplatformV1ExternalApi;
5888
5975
  /** Set to use data source powered by Vertex AI Search. */
5889
5976
  vertexAiSearch?: GoogleCloudAiplatformV1VertexAISearch;
5890
5977
  /** Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. */
@@ -8937,6 +9024,8 @@ declare namespace gapi.client {
8937
9024
  interface GoogleCloudAiplatformV1VertexAISearch {
8938
9025
  /** Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` */
8939
9026
  datastore?: string;
9027
+ /** 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. */
9028
+ dataStoreSpecs?: GoogleCloudAiplatformV1VertexAISearchDataStoreSpec[];
8940
9029
  /** Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` */
8941
9030
  engine?: string;
8942
9031
  /** Optional. Filter strings to be passed to the search API. */
@@ -8948,6 +9037,12 @@ declare namespace gapi.client {
8948
9037
  /** 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}`. */
8949
9038
  servingConfig?: string;
8950
9039
  }
9040
+ interface GoogleCloudAiplatformV1VertexAISearchDataStoreSpec {
9041
+ /** Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` */
9042
+ dataStore?: string;
9043
+ /** 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) */
9044
+ filter?: string;
9045
+ }
8951
9046
  interface GoogleCloudAiplatformV1VertexRagStore {
8952
9047
  /** Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. */
8953
9048
  ragResources?: GoogleCloudAiplatformV1VertexRagStoreRagResource[];
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.aiplatform-v1",
3
- "version": "0.0.20250513",
3
+ "version": "0.0.20250516",
4
4
  "description": "TypeScript typings for Vertex AI API v1",
5
5
  "repository": {
6
6
  "type": "git",