@maxim_mazurok/gapi.client.aiplatform-v1beta1 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.
- package/index.d.ts +57 -4
- 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=v1beta1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20250516
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -234,6 +234,8 @@ declare namespace gapi.client {
|
|
|
234
234
|
interface GoogleCloudAiplatformV1beta1ApiAuthApiKeyConfig {
|
|
235
235
|
/** Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} */
|
|
236
236
|
apiKeySecretVersion?: string;
|
|
237
|
+
/** The API key string. Either this or `api_key_secret_version` must be set. */
|
|
238
|
+
apiKeyString?: string;
|
|
237
239
|
}
|
|
238
240
|
interface GoogleCloudAiplatformV1beta1AppendEventResponse {}
|
|
239
241
|
interface GoogleCloudAiplatformV1beta1Artifact {
|
|
@@ -2545,6 +2547,29 @@ declare namespace gapi.client {
|
|
|
2545
2547
|
/** 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. */
|
|
2546
2548
|
serviceDirectory?: string;
|
|
2547
2549
|
}
|
|
2550
|
+
interface GoogleCloudAiplatformV1beta1ExternalApi {
|
|
2551
|
+
/** The authentication config to access the API. Deprecated. Please use auth_config instead. */
|
|
2552
|
+
apiAuth?: GoogleCloudAiplatformV1beta1ApiAuth;
|
|
2553
|
+
/** The API spec that the external API implements. */
|
|
2554
|
+
apiSpec?: string;
|
|
2555
|
+
/** The authentication config to access the API. */
|
|
2556
|
+
authConfig?: GoogleCloudAiplatformV1beta1AuthConfig;
|
|
2557
|
+
/** Parameters for the elastic search API. */
|
|
2558
|
+
elasticSearchParams?: GoogleCloudAiplatformV1beta1ExternalApiElasticSearchParams;
|
|
2559
|
+
/** 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 */
|
|
2560
|
+
endpoint?: string;
|
|
2561
|
+
/** Parameters for the simple search API. */
|
|
2562
|
+
simpleSearchParams?: any;
|
|
2563
|
+
}
|
|
2564
|
+
interface GoogleCloudAiplatformV1beta1ExternalApiElasticSearchParams {
|
|
2565
|
+
/** The ElasticSearch index to use. */
|
|
2566
|
+
index?: string;
|
|
2567
|
+
/** Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. */
|
|
2568
|
+
numHits?: number;
|
|
2569
|
+
/** The ElasticSearch search template to use. */
|
|
2570
|
+
searchTemplate?: string;
|
|
2571
|
+
}
|
|
2572
|
+
interface GoogleCloudAiplatformV1beta1ExternalApiSimpleSearchParams {}
|
|
2548
2573
|
interface GoogleCloudAiplatformV1beta1Fact {
|
|
2549
2574
|
/** If present, chunk properties. */
|
|
2550
2575
|
chunk?: GoogleCloudAiplatformV1beta1RagChunk;
|
|
@@ -2751,7 +2776,7 @@ declare namespace gapi.client {
|
|
|
2751
2776
|
featureConfigs?: GoogleCloudAiplatformV1beta1FeatureSelectionConfigFeatureConfig[];
|
|
2752
2777
|
}
|
|
2753
2778
|
interface GoogleCloudAiplatformV1beta1FeatureSelectionConfigFeatureConfig {
|
|
2754
|
-
/** 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. */
|
|
2779
|
+
/** 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). */
|
|
2755
2780
|
driftThreshold?: number;
|
|
2756
2781
|
/** Required. The ID of the feature resource. Final component of the Feature's resource name. */
|
|
2757
2782
|
featureId?: string;
|
|
@@ -3731,6 +3756,8 @@ declare namespace gapi.client {
|
|
|
3731
3756
|
ragFileParsingConfig?: GoogleCloudAiplatformV1beta1RagFileParsingConfig;
|
|
3732
3757
|
/** Specifies the transformation config for RagFiles. */
|
|
3733
3758
|
ragFileTransformationConfig?: GoogleCloudAiplatformV1beta1RagFileTransformationConfig;
|
|
3759
|
+
/** 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. */
|
|
3760
|
+
rebuildAnnIndex?: boolean;
|
|
3734
3761
|
/** SharePoint sources. */
|
|
3735
3762
|
sharePointSources?: GoogleCloudAiplatformV1beta1SharePointSources;
|
|
3736
3763
|
/** Slack channels with their corresponding access tokens. */
|
|
@@ -4833,6 +4860,8 @@ declare namespace gapi.client {
|
|
|
4833
4860
|
createTime?: string;
|
|
4834
4861
|
/** The display name of the ModelMonitor. The name can be up to 128 characters long and can consist of any UTF-8. */
|
|
4835
4862
|
displayName?: string;
|
|
4863
|
+
/** 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. */
|
|
4864
|
+
encryptionSpec?: GoogleCloudAiplatformV1beta1EncryptionSpec;
|
|
4836
4865
|
/** Optional model explanation spec. It is used for feature attribution monitoring. */
|
|
4837
4866
|
explanationSpec?: GoogleCloudAiplatformV1beta1ExplanationSpec;
|
|
4838
4867
|
/** 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. */
|
|
@@ -6637,6 +6666,8 @@ declare namespace gapi.client {
|
|
|
6637
6666
|
description?: string;
|
|
6638
6667
|
/** Required. The display name of the RagCorpus. The name can be up to 128 characters long and can consist of any UTF-8 characters. */
|
|
6639
6668
|
displayName?: string;
|
|
6669
|
+
/** 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. */
|
|
6670
|
+
encryptionSpec?: GoogleCloudAiplatformV1beta1EncryptionSpec;
|
|
6640
6671
|
/** Output only. The resource name of the RagCorpus. */
|
|
6641
6672
|
name?: string;
|
|
6642
6673
|
/** Optional. Immutable. The embedding model config of the RagCorpus. */
|
|
@@ -6836,7 +6867,7 @@ declare namespace gapi.client {
|
|
|
6836
6867
|
/** Optional. Immutable. The embedding model config of the Vector DB. */
|
|
6837
6868
|
ragEmbeddingModelConfig?: GoogleCloudAiplatformV1beta1RagEmbeddingModelConfig;
|
|
6838
6869
|
/** The config for the RAG-managed Vector DB. */
|
|
6839
|
-
ragManagedDb?:
|
|
6870
|
+
ragManagedDb?: GoogleCloudAiplatformV1beta1RagVectorDbConfigRagManagedDb;
|
|
6840
6871
|
/** The config for the Vertex Feature Store. */
|
|
6841
6872
|
vertexFeatureStore?: GoogleCloudAiplatformV1beta1RagVectorDbConfigVertexFeatureStore;
|
|
6842
6873
|
/** The config for the Vertex Vector Search. */
|
|
@@ -6848,7 +6879,19 @@ declare namespace gapi.client {
|
|
|
6848
6879
|
/** Pinecone index name. This value cannot be changed after it's set. */
|
|
6849
6880
|
indexName?: string;
|
|
6850
6881
|
}
|
|
6851
|
-
interface GoogleCloudAiplatformV1beta1RagVectorDbConfigRagManagedDb {
|
|
6882
|
+
interface GoogleCloudAiplatformV1beta1RagVectorDbConfigRagManagedDb {
|
|
6883
|
+
/** 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. */
|
|
6884
|
+
ann?: GoogleCloudAiplatformV1beta1RagVectorDbConfigRagManagedDbANN;
|
|
6885
|
+
/** Performs a KNN search on RagCorpus. Default choice if not specified. */
|
|
6886
|
+
knn?: any;
|
|
6887
|
+
}
|
|
6888
|
+
interface GoogleCloudAiplatformV1beta1RagVectorDbConfigRagManagedDbANN {
|
|
6889
|
+
/** 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. */
|
|
6890
|
+
leafCount?: number;
|
|
6891
|
+
/** 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. */
|
|
6892
|
+
treeDepth?: number;
|
|
6893
|
+
}
|
|
6894
|
+
interface GoogleCloudAiplatformV1beta1RagVectorDbConfigRagManagedDbKNN {}
|
|
6852
6895
|
interface GoogleCloudAiplatformV1beta1RagVectorDbConfigVertexFeatureStore {
|
|
6853
6896
|
/** The resource name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}` */
|
|
6854
6897
|
featureViewResourceName?: string;
|
|
@@ -7127,6 +7170,8 @@ declare namespace gapi.client {
|
|
|
7127
7170
|
interface GoogleCloudAiplatformV1beta1Retrieval {
|
|
7128
7171
|
/** Optional. Deprecated. This option is no longer supported. */
|
|
7129
7172
|
disableAttribution?: boolean;
|
|
7173
|
+
/** Use data source powered by external API for grounding. */
|
|
7174
|
+
externalApi?: GoogleCloudAiplatformV1beta1ExternalApi;
|
|
7130
7175
|
/** Set to use data source powered by Vertex AI Search. */
|
|
7131
7176
|
vertexAiSearch?: GoogleCloudAiplatformV1beta1VertexAISearch;
|
|
7132
7177
|
/** Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. */
|
|
@@ -10465,6 +10510,8 @@ declare namespace gapi.client {
|
|
|
10465
10510
|
interface GoogleCloudAiplatformV1beta1VertexAISearch {
|
|
10466
10511
|
/** Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` */
|
|
10467
10512
|
datastore?: string;
|
|
10513
|
+
/** 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. */
|
|
10514
|
+
dataStoreSpecs?: GoogleCloudAiplatformV1beta1VertexAISearchDataStoreSpec[];
|
|
10468
10515
|
/** Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` */
|
|
10469
10516
|
engine?: string;
|
|
10470
10517
|
/** Optional. Filter strings to be passed to the search API. */
|
|
@@ -10476,6 +10523,12 @@ declare namespace gapi.client {
|
|
|
10476
10523
|
/** 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}`. */
|
|
10477
10524
|
servingConfig?: string;
|
|
10478
10525
|
}
|
|
10526
|
+
interface GoogleCloudAiplatformV1beta1VertexAISearchDataStoreSpec {
|
|
10527
|
+
/** Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` */
|
|
10528
|
+
dataStore?: string;
|
|
10529
|
+
/** 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) */
|
|
10530
|
+
filter?: string;
|
|
10531
|
+
}
|
|
10479
10532
|
interface GoogleCloudAiplatformV1beta1VertexRagStore {
|
|
10480
10533
|
/** Optional. Deprecated. Please use rag_resources instead. */
|
|
10481
10534
|
ragCorpora?: string[];
|