@maxim_mazurok/gapi.client.aiplatform-v1 0.0.20250715 → 0.0.20250728
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 +150 -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:
|
|
12
|
+
// Revision: 20250728
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -990,6 +990,8 @@ declare namespace gapi.client {
|
|
|
990
990
|
deploymentResourcePoolId?: string;
|
|
991
991
|
}
|
|
992
992
|
interface GoogleCloudAiplatformV1CreateEndpointOperationMetadata {
|
|
993
|
+
/** Output only. The deployment stage of the model. Only populated if this CreateEndpoint request deploys a model at the same time. */
|
|
994
|
+
deploymentStage?: string;
|
|
993
995
|
/** The operation generic information. */
|
|
994
996
|
genericMetadata?: GoogleCloudAiplatformV1GenericOperationMetadata;
|
|
995
997
|
}
|
|
@@ -1500,6 +1502,8 @@ declare namespace gapi.client {
|
|
|
1500
1502
|
serviceAccount?: string;
|
|
1501
1503
|
}
|
|
1502
1504
|
interface GoogleCloudAiplatformV1DeployModelOperationMetadata {
|
|
1505
|
+
/** Output only. The deployment stage of the model. */
|
|
1506
|
+
deploymentStage?: string;
|
|
1503
1507
|
/** The operation generic information. */
|
|
1504
1508
|
genericMetadata?: GoogleCloudAiplatformV1GenericOperationMetadata;
|
|
1505
1509
|
}
|
|
@@ -2590,6 +2594,34 @@ declare namespace gapi.client {
|
|
|
2590
2594
|
/** Parts to construct Entity ID. Should match with the same ID columns as defined in FeatureView in the same order. */
|
|
2591
2595
|
parts?: string[];
|
|
2592
2596
|
}
|
|
2597
|
+
interface GoogleCloudAiplatformV1FeatureViewDirectWriteRequest {
|
|
2598
|
+
/** Required. The data keys and associated feature values. */
|
|
2599
|
+
dataKeyAndFeatureValues?: GoogleCloudAiplatformV1FeatureViewDirectWriteRequestDataKeyAndFeatureValues[];
|
|
2600
|
+
}
|
|
2601
|
+
interface GoogleCloudAiplatformV1FeatureViewDirectWriteRequestDataKeyAndFeatureValues {
|
|
2602
|
+
/** The data key. */
|
|
2603
|
+
dataKey?: GoogleCloudAiplatformV1FeatureViewDataKey;
|
|
2604
|
+
/** List of features to write. */
|
|
2605
|
+
features?: GoogleCloudAiplatformV1FeatureViewDirectWriteRequestDataKeyAndFeatureValuesFeature[];
|
|
2606
|
+
}
|
|
2607
|
+
interface GoogleCloudAiplatformV1FeatureViewDirectWriteRequestDataKeyAndFeatureValuesFeature {
|
|
2608
|
+
/** Feature short name. */
|
|
2609
|
+
name?: string;
|
|
2610
|
+
/** Feature value. A user provided timestamp may be set in the `FeatureValue.metadata.generate_time` field. */
|
|
2611
|
+
value?: GoogleCloudAiplatformV1FeatureValue;
|
|
2612
|
+
}
|
|
2613
|
+
interface GoogleCloudAiplatformV1FeatureViewDirectWriteResponse {
|
|
2614
|
+
/** Response status for the keys listed in FeatureViewDirectWriteResponse.write_responses. The error only applies to the listed data keys - the stream will remain open for further FeatureOnlineStoreService.FeatureViewDirectWriteRequest requests. Partial failures (e.g. if the first 10 keys of a request fail, but the rest succeed) from a single request may result in multiple responses - there will be one response for the successful request keys and one response for the failing request keys. */
|
|
2615
|
+
status?: GoogleRpcStatus;
|
|
2616
|
+
/** Details about write for each key. If status is not OK, WriteResponse.data_key will have the key with error, but WriteResponse.online_store_write_time will not be present. */
|
|
2617
|
+
writeResponses?: GoogleCloudAiplatformV1FeatureViewDirectWriteResponseWriteResponse[];
|
|
2618
|
+
}
|
|
2619
|
+
interface GoogleCloudAiplatformV1FeatureViewDirectWriteResponseWriteResponse {
|
|
2620
|
+
/** What key is this write response associated with. */
|
|
2621
|
+
dataKey?: GoogleCloudAiplatformV1FeatureViewDataKey;
|
|
2622
|
+
/** When the feature values were written to the online store. If FeatureViewDirectWriteResponse.status is not OK, this field is not populated. */
|
|
2623
|
+
onlineStoreWriteTime?: string;
|
|
2624
|
+
}
|
|
2593
2625
|
interface GoogleCloudAiplatformV1FeatureViewFeatureRegistrySource {
|
|
2594
2626
|
/** Required. List of features that need to be synced to Online Store. */
|
|
2595
2627
|
featureGroups?: GoogleCloudAiplatformV1FeatureViewFeatureRegistrySourceFeatureGroup[];
|
|
@@ -3031,6 +3063,12 @@ declare namespace gapi.client {
|
|
|
3031
3063
|
/** Required. The type of the Google Drive resource. */
|
|
3032
3064
|
resourceType?: string;
|
|
3033
3065
|
}
|
|
3066
|
+
interface GoogleCloudAiplatformV1GoogleMaps {
|
|
3067
|
+
/** The authentication config to access the API. Deprecated. Please use auth_config instead. */
|
|
3068
|
+
apiAuth?: GoogleCloudAiplatformV1ApiAuth;
|
|
3069
|
+
/** The authentication config to access the API. Only API key is supported. */
|
|
3070
|
+
authConfig?: GoogleCloudAiplatformV1AuthConfig;
|
|
3071
|
+
}
|
|
3034
3072
|
interface GoogleCloudAiplatformV1GoogleSearchRetrieval {
|
|
3035
3073
|
/** Specifies the dynamic retrieval configuration for the given source. */
|
|
3036
3074
|
dynamicRetrievalConfig?: GoogleCloudAiplatformV1DynamicRetrievalConfig;
|
|
@@ -3060,11 +3098,51 @@ declare namespace gapi.client {
|
|
|
3060
3098
|
version?: number;
|
|
3061
3099
|
}
|
|
3062
3100
|
interface GoogleCloudAiplatformV1GroundingChunk {
|
|
3101
|
+
/** Grounding chunk from Google Maps. */
|
|
3102
|
+
maps?: GoogleCloudAiplatformV1GroundingChunkMaps;
|
|
3063
3103
|
/** Grounding chunk from context retrieved by the retrieval tools. */
|
|
3064
3104
|
retrievedContext?: GoogleCloudAiplatformV1GroundingChunkRetrievedContext;
|
|
3065
3105
|
/** Grounding chunk from the web. */
|
|
3066
3106
|
web?: GoogleCloudAiplatformV1GroundingChunkWeb;
|
|
3067
3107
|
}
|
|
3108
|
+
interface GoogleCloudAiplatformV1GroundingChunkMaps {
|
|
3109
|
+
/** Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content. */
|
|
3110
|
+
placeAnswerSources?: GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSources;
|
|
3111
|
+
/** This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place. */
|
|
3112
|
+
placeId?: string;
|
|
3113
|
+
/** Text of the chunk. */
|
|
3114
|
+
text?: string;
|
|
3115
|
+
/** Title of the chunk. */
|
|
3116
|
+
title?: string;
|
|
3117
|
+
/** URI reference of the chunk. */
|
|
3118
|
+
uri?: string;
|
|
3119
|
+
}
|
|
3120
|
+
interface GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSources {
|
|
3121
|
+
/** A link where users can flag a problem with the generated answer. */
|
|
3122
|
+
flagContentUri?: string;
|
|
3123
|
+
/** Snippets of reviews that are used to generate the answer. */
|
|
3124
|
+
reviewSnippets?: GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet[];
|
|
3125
|
+
}
|
|
3126
|
+
interface GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution {
|
|
3127
|
+
/** Name of the author of the Photo or Review. */
|
|
3128
|
+
displayName?: string;
|
|
3129
|
+
/** Profile photo URI of the author of the Photo or Review. */
|
|
3130
|
+
photoUri?: string;
|
|
3131
|
+
/** URI of the author of the Photo or Review. */
|
|
3132
|
+
uri?: string;
|
|
3133
|
+
}
|
|
3134
|
+
interface GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet {
|
|
3135
|
+
/** This review's author. */
|
|
3136
|
+
authorAttribution?: GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution;
|
|
3137
|
+
/** A link where users can flag a problem with the review. */
|
|
3138
|
+
flagContentUri?: string;
|
|
3139
|
+
/** A link to show the review on Google Maps. */
|
|
3140
|
+
googleMapsUri?: string;
|
|
3141
|
+
/** A string of formatted recent time, expressing the review time relative to the current time in a form appropriate for the language and country. */
|
|
3142
|
+
relativePublishTimeDescription?: string;
|
|
3143
|
+
/** A reference representing this place review which may be used to look up this place review again. */
|
|
3144
|
+
review?: string;
|
|
3145
|
+
}
|
|
3068
3146
|
interface GoogleCloudAiplatformV1GroundingChunkRetrievedContext {
|
|
3069
3147
|
/** Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool. */
|
|
3070
3148
|
ragChunk?: GoogleCloudAiplatformV1RagChunk;
|
|
@@ -3084,6 +3162,8 @@ declare namespace gapi.client {
|
|
|
3084
3162
|
uri?: string;
|
|
3085
3163
|
}
|
|
3086
3164
|
interface GoogleCloudAiplatformV1GroundingMetadata {
|
|
3165
|
+
/** Optional. Output only. Resource name of the Google Maps widget context token to be used with the PlacesContextElement widget to render contextual data. This is populated only for Google Maps grounding. */
|
|
3166
|
+
googleMapsWidgetContextToken?: string;
|
|
3087
3167
|
/** List of supporting references retrieved from specified grounding source. */
|
|
3088
3168
|
groundingChunks?: GoogleCloudAiplatformV1GroundingChunk[];
|
|
3089
3169
|
/** Optional. List of grounding support. */
|
|
@@ -3288,6 +3368,8 @@ declare namespace gapi.client {
|
|
|
3288
3368
|
crowdingTag?: GoogleCloudAiplatformV1IndexDatapointCrowdingTag;
|
|
3289
3369
|
/** Required. Unique identifier of the datapoint. */
|
|
3290
3370
|
datapointId?: string;
|
|
3371
|
+
/** Optional. The key-value map of additional metadata for the datapoint. */
|
|
3372
|
+
embeddingMetadata?: {[P in string]: any};
|
|
3291
3373
|
/** Required. Feature embedding vector for dense index. An array of numbers with the length of [NearestNeighborSearchConfig.dimensions]. */
|
|
3292
3374
|
featureVector?: number[];
|
|
3293
3375
|
/** Optional. List of Restrict of the datapoint, used to perform "restricted searches" where boolean rule are used to filter the subset of the database eligible for matching. This uses numeric comparisons. */
|
|
@@ -5445,6 +5527,8 @@ declare namespace gapi.client {
|
|
|
5445
5527
|
notebooks?: GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences[];
|
|
5446
5528
|
}
|
|
5447
5529
|
interface GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences {
|
|
5530
|
+
/** Optional. For notebook resource. When set to true, the Colab Enterprise link will be disabled in the "open notebook" dialog in UI. */
|
|
5531
|
+
colabNotebookDisabled?: boolean;
|
|
5448
5532
|
/** Required. */
|
|
5449
5533
|
references?: {
|
|
5450
5534
|
[P in string]: GoogleCloudAiplatformV1PublisherModelResourceReference;
|
|
@@ -6001,6 +6085,8 @@ declare namespace gapi.client {
|
|
|
6001
6085
|
description?: string;
|
|
6002
6086
|
/** Required. The display name of the ReasoningEngine. */
|
|
6003
6087
|
displayName?: string;
|
|
6088
|
+
/** Customer-managed encryption key spec for a ReasoningEngine. If set, this ReasoningEngine and all sub-resources of this ReasoningEngine will be secured by this key. */
|
|
6089
|
+
encryptionSpec?: GoogleCloudAiplatformV1EncryptionSpec;
|
|
6004
6090
|
/** Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. */
|
|
6005
6091
|
etag?: string;
|
|
6006
6092
|
/** Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` */
|
|
@@ -6019,6 +6105,8 @@ declare namespace gapi.client {
|
|
|
6019
6105
|
deploymentSpec?: GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpec;
|
|
6020
6106
|
/** Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. */
|
|
6021
6107
|
packageSpec?: GoogleCloudAiplatformV1ReasoningEngineSpecPackageSpec;
|
|
6108
|
+
/** Optional. The service account that the Reasoning Engine artifact runs as. It should have "roles/storage.objectViewer" for reading the user project's Cloud Storage and "roles/aiplatform.user" for using Vertex extensions. If not specified, the Vertex AI Reasoning Engine Service Agent in the project will be used. */
|
|
6109
|
+
serviceAccount?: string;
|
|
6022
6110
|
}
|
|
6023
6111
|
interface GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpec {
|
|
6024
6112
|
/** Optional. Environment variables to be set with the Reasoning Engine deployment. The environment variables can be updated through the UpdateReasoningEngine API. */
|
|
@@ -8630,8 +8718,10 @@ declare namespace gapi.client {
|
|
|
8630
8718
|
computerUse?: GoogleCloudAiplatformV1ToolComputerUse;
|
|
8631
8719
|
/** Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. */
|
|
8632
8720
|
enterpriseWebSearch?: any;
|
|
8633
|
-
/** 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
|
|
8721
|
+
/** 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 512 function declarations can be provided. */
|
|
8634
8722
|
functionDeclarations?: GoogleCloudAiplatformV1FunctionDeclaration[];
|
|
8723
|
+
/** Optional. GoogleMaps tool type. Tool to support Google Maps in Model. */
|
|
8724
|
+
googleMaps?: GoogleCloudAiplatformV1GoogleMaps;
|
|
8635
8725
|
/** Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. */
|
|
8636
8726
|
googleSearch?: any;
|
|
8637
8727
|
/** Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. */
|
|
@@ -16057,6 +16147,64 @@ declare namespace gapi.client {
|
|
|
16057
16147
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
16058
16148
|
uploadType?: string;
|
|
16059
16149
|
}): Request<GoogleLongrunningOperation>;
|
|
16150
|
+
/** Bidirectional streaming RPC to directly write to feature values in a feature view. Requests may not have a one-to-one mapping to responses and responses may be returned out-of-order to reduce latency. */
|
|
16151
|
+
directWrite(request: {
|
|
16152
|
+
/** V1 error format. */
|
|
16153
|
+
'$.xgafv'?: string;
|
|
16154
|
+
/** OAuth access token. */
|
|
16155
|
+
access_token?: string;
|
|
16156
|
+
/** Data format for response. */
|
|
16157
|
+
alt?: string;
|
|
16158
|
+
/** JSONP */
|
|
16159
|
+
callback?: string;
|
|
16160
|
+
/** FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}` */
|
|
16161
|
+
featureView: string;
|
|
16162
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
16163
|
+
fields?: string;
|
|
16164
|
+
/** 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. */
|
|
16165
|
+
key?: string;
|
|
16166
|
+
/** OAuth 2.0 token for the current user. */
|
|
16167
|
+
oauth_token?: string;
|
|
16168
|
+
/** Returns response with indentations and line breaks. */
|
|
16169
|
+
prettyPrint?: boolean;
|
|
16170
|
+
/** 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. */
|
|
16171
|
+
quotaUser?: string;
|
|
16172
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
16173
|
+
upload_protocol?: string;
|
|
16174
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
16175
|
+
uploadType?: string;
|
|
16176
|
+
/** Request body */
|
|
16177
|
+
resource: GoogleCloudAiplatformV1FeatureViewDirectWriteRequest;
|
|
16178
|
+
}): Request<GoogleCloudAiplatformV1FeatureViewDirectWriteResponse>;
|
|
16179
|
+
directWrite(
|
|
16180
|
+
request: {
|
|
16181
|
+
/** V1 error format. */
|
|
16182
|
+
'$.xgafv'?: string;
|
|
16183
|
+
/** OAuth access token. */
|
|
16184
|
+
access_token?: string;
|
|
16185
|
+
/** Data format for response. */
|
|
16186
|
+
alt?: string;
|
|
16187
|
+
/** JSONP */
|
|
16188
|
+
callback?: string;
|
|
16189
|
+
/** FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}` */
|
|
16190
|
+
featureView: string;
|
|
16191
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
16192
|
+
fields?: string;
|
|
16193
|
+
/** 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. */
|
|
16194
|
+
key?: string;
|
|
16195
|
+
/** OAuth 2.0 token for the current user. */
|
|
16196
|
+
oauth_token?: string;
|
|
16197
|
+
/** Returns response with indentations and line breaks. */
|
|
16198
|
+
prettyPrint?: boolean;
|
|
16199
|
+
/** 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. */
|
|
16200
|
+
quotaUser?: string;
|
|
16201
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
16202
|
+
upload_protocol?: string;
|
|
16203
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
16204
|
+
uploadType?: string;
|
|
16205
|
+
},
|
|
16206
|
+
body: GoogleCloudAiplatformV1FeatureViewDirectWriteRequest,
|
|
16207
|
+
): Request<GoogleCloudAiplatformV1FeatureViewDirectWriteResponse>;
|
|
16060
16208
|
/** Fetch feature values under a FeatureView. */
|
|
16061
16209
|
fetchFeatureValues(request: {
|
|
16062
16210
|
/** V1 error format. */
|