@maxim_mazurok/gapi.client.aiplatform-v1beta1 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 +76 -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=v1beta1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20250728
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -1079,6 +1079,8 @@ declare namespace gapi.client {
|
|
|
1079
1079
|
deploymentResourcePoolId?: string;
|
|
1080
1080
|
}
|
|
1081
1081
|
interface GoogleCloudAiplatformV1beta1CreateEndpointOperationMetadata {
|
|
1082
|
+
/** Output only. The deployment stage of the model. Only populated if this CreateEndpoint request deploys a model at the same time. */
|
|
1083
|
+
deploymentStage?: string;
|
|
1082
1084
|
/** The operation generic information. */
|
|
1083
1085
|
genericMetadata?: GoogleCloudAiplatformV1beta1GenericOperationMetadata;
|
|
1084
1086
|
}
|
|
@@ -1657,6 +1659,8 @@ declare namespace gapi.client {
|
|
|
1657
1659
|
serviceAccount?: string;
|
|
1658
1660
|
}
|
|
1659
1661
|
interface GoogleCloudAiplatformV1beta1DeployModelOperationMetadata {
|
|
1662
|
+
/** Output only. The deployment stage of the model. */
|
|
1663
|
+
deploymentStage?: string;
|
|
1660
1664
|
/** The operation generic information. */
|
|
1661
1665
|
genericMetadata?: GoogleCloudAiplatformV1beta1GenericOperationMetadata;
|
|
1662
1666
|
}
|
|
@@ -3026,6 +3030,8 @@ declare namespace gapi.client {
|
|
|
3026
3030
|
interface GoogleCloudAiplatformV1beta1FeatureViewDirectWriteRequestDataKeyAndFeatureValuesFeature {
|
|
3027
3031
|
/** Feature short name. */
|
|
3028
3032
|
name?: string;
|
|
3033
|
+
/** Feature value. A user provided timestamp may be set in the `FeatureValue.metadata.generate_time` field. */
|
|
3034
|
+
value?: GoogleCloudAiplatformV1beta1FeatureValue;
|
|
3029
3035
|
/** Feature value and timestamp. */
|
|
3030
3036
|
valueAndTimestamp?: GoogleCloudAiplatformV1beta1FeatureViewDirectWriteRequestDataKeyAndFeatureValuesFeatureFeatureValueAndTimestamp;
|
|
3031
3037
|
}
|
|
@@ -3615,6 +3621,12 @@ declare namespace gapi.client {
|
|
|
3615
3621
|
/** Required. The type of the Google Drive resource. */
|
|
3616
3622
|
resourceType?: string;
|
|
3617
3623
|
}
|
|
3624
|
+
interface GoogleCloudAiplatformV1beta1GoogleMaps {
|
|
3625
|
+
/** The authentication config to access the API. Deprecated. Please use auth_config instead. */
|
|
3626
|
+
apiAuth?: GoogleCloudAiplatformV1beta1ApiAuth;
|
|
3627
|
+
/** The authentication config to access the API. Only API key is supported. */
|
|
3628
|
+
authConfig?: GoogleCloudAiplatformV1beta1AuthConfig;
|
|
3629
|
+
}
|
|
3618
3630
|
interface GoogleCloudAiplatformV1beta1GoogleSearchRetrieval {
|
|
3619
3631
|
/** Specifies the dynamic retrieval configuration for the given source. */
|
|
3620
3632
|
dynamicRetrievalConfig?: GoogleCloudAiplatformV1beta1DynamicRetrievalConfig;
|
|
@@ -3644,11 +3656,51 @@ declare namespace gapi.client {
|
|
|
3644
3656
|
version?: number;
|
|
3645
3657
|
}
|
|
3646
3658
|
interface GoogleCloudAiplatformV1beta1GroundingChunk {
|
|
3659
|
+
/** Grounding chunk from Google Maps. */
|
|
3660
|
+
maps?: GoogleCloudAiplatformV1beta1GroundingChunkMaps;
|
|
3647
3661
|
/** Grounding chunk from context retrieved by the retrieval tools. */
|
|
3648
3662
|
retrievedContext?: GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext;
|
|
3649
3663
|
/** Grounding chunk from the web. */
|
|
3650
3664
|
web?: GoogleCloudAiplatformV1beta1GroundingChunkWeb;
|
|
3651
3665
|
}
|
|
3666
|
+
interface GoogleCloudAiplatformV1beta1GroundingChunkMaps {
|
|
3667
|
+
/** 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. */
|
|
3668
|
+
placeAnswerSources?: GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSources;
|
|
3669
|
+
/** This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place. */
|
|
3670
|
+
placeId?: string;
|
|
3671
|
+
/** Text of the chunk. */
|
|
3672
|
+
text?: string;
|
|
3673
|
+
/** Title of the chunk. */
|
|
3674
|
+
title?: string;
|
|
3675
|
+
/** URI reference of the chunk. */
|
|
3676
|
+
uri?: string;
|
|
3677
|
+
}
|
|
3678
|
+
interface GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSources {
|
|
3679
|
+
/** A link where users can flag a problem with the generated answer. */
|
|
3680
|
+
flagContentUri?: string;
|
|
3681
|
+
/** Snippets of reviews that are used to generate the answer. */
|
|
3682
|
+
reviewSnippets?: GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet[];
|
|
3683
|
+
}
|
|
3684
|
+
interface GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution {
|
|
3685
|
+
/** Name of the author of the Photo or Review. */
|
|
3686
|
+
displayName?: string;
|
|
3687
|
+
/** Profile photo URI of the author of the Photo or Review. */
|
|
3688
|
+
photoUri?: string;
|
|
3689
|
+
/** URI of the author of the Photo or Review. */
|
|
3690
|
+
uri?: string;
|
|
3691
|
+
}
|
|
3692
|
+
interface GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet {
|
|
3693
|
+
/** This review's author. */
|
|
3694
|
+
authorAttribution?: GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution;
|
|
3695
|
+
/** A link where users can flag a problem with the review. */
|
|
3696
|
+
flagContentUri?: string;
|
|
3697
|
+
/** A link to show the review on Google Maps. */
|
|
3698
|
+
googleMapsUri?: string;
|
|
3699
|
+
/** A string of formatted recent time, expressing the review time relative to the current time in a form appropriate for the language and country. */
|
|
3700
|
+
relativePublishTimeDescription?: string;
|
|
3701
|
+
/** A reference representing this place review which may be used to look up this place review again. */
|
|
3702
|
+
review?: string;
|
|
3703
|
+
}
|
|
3652
3704
|
interface GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext {
|
|
3653
3705
|
/** Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool. */
|
|
3654
3706
|
ragChunk?: GoogleCloudAiplatformV1beta1RagChunk;
|
|
@@ -3668,6 +3720,8 @@ declare namespace gapi.client {
|
|
|
3668
3720
|
uri?: string;
|
|
3669
3721
|
}
|
|
3670
3722
|
interface GoogleCloudAiplatformV1beta1GroundingMetadata {
|
|
3723
|
+
/** 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. */
|
|
3724
|
+
googleMapsWidgetContextToken?: string;
|
|
3671
3725
|
/** List of supporting references retrieved from specified grounding source. */
|
|
3672
3726
|
groundingChunks?: GoogleCloudAiplatformV1beta1GroundingChunk[];
|
|
3673
3727
|
/** Optional. List of grounding support. */
|
|
@@ -3928,6 +3982,8 @@ declare namespace gapi.client {
|
|
|
3928
3982
|
crowdingTag?: GoogleCloudAiplatformV1beta1IndexDatapointCrowdingTag;
|
|
3929
3983
|
/** Required. Unique identifier of the datapoint. */
|
|
3930
3984
|
datapointId?: string;
|
|
3985
|
+
/** Optional. The key-value map of additional metadata for the datapoint. */
|
|
3986
|
+
embeddingMetadata?: {[P in string]: any};
|
|
3931
3987
|
/** Required. Feature embedding vector for dense index. An array of numbers with the length of [NearestNeighborSearchConfig.dimensions]. */
|
|
3932
3988
|
featureVector?: number[];
|
|
3933
3989
|
/** 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. */
|
|
@@ -6526,6 +6582,8 @@ declare namespace gapi.client {
|
|
|
6526
6582
|
notebooks?: GoogleCloudAiplatformV1beta1PublisherModelCallToActionRegionalResourceReferences[];
|
|
6527
6583
|
}
|
|
6528
6584
|
interface GoogleCloudAiplatformV1beta1PublisherModelCallToActionRegionalResourceReferences {
|
|
6585
|
+
/** Optional. For notebook resource. When set to true, the Colab Enterprise link will be disabled in the "open notebook" dialog in UI. */
|
|
6586
|
+
colabNotebookDisabled?: boolean;
|
|
6529
6587
|
/** Required. */
|
|
6530
6588
|
references?: {
|
|
6531
6589
|
[P in string]: GoogleCloudAiplatformV1beta1PublisherModelResourceReference;
|
|
@@ -7222,6 +7280,8 @@ declare namespace gapi.client {
|
|
|
7222
7280
|
description?: string;
|
|
7223
7281
|
/** Required. The display name of the ReasoningEngine. */
|
|
7224
7282
|
displayName?: string;
|
|
7283
|
+
/** 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. */
|
|
7284
|
+
encryptionSpec?: GoogleCloudAiplatformV1beta1EncryptionSpec;
|
|
7225
7285
|
/** Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. */
|
|
7226
7286
|
etag?: string;
|
|
7227
7287
|
/** Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` */
|
|
@@ -7258,6 +7318,8 @@ declare namespace gapi.client {
|
|
|
7258
7318
|
deploymentSpec?: GoogleCloudAiplatformV1beta1ReasoningEngineSpecDeploymentSpec;
|
|
7259
7319
|
/** 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. */
|
|
7260
7320
|
packageSpec?: GoogleCloudAiplatformV1beta1ReasoningEngineSpecPackageSpec;
|
|
7321
|
+
/** 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. */
|
|
7322
|
+
serviceAccount?: string;
|
|
7261
7323
|
}
|
|
7262
7324
|
interface GoogleCloudAiplatformV1beta1ReasoningEngineSpecDeploymentSpec {
|
|
7263
7325
|
/** Optional. Environment variables to be set with the Reasoning Engine deployment. The environment variables can be updated through the UpdateReasoningEngine API. */
|
|
@@ -9907,8 +9969,12 @@ declare namespace gapi.client {
|
|
|
9907
9969
|
interface GoogleCloudAiplatformV1beta1SupervisedHyperParameters {
|
|
9908
9970
|
/** Optional. Adapter size for tuning. */
|
|
9909
9971
|
adapterSize?: string;
|
|
9972
|
+
/** Optional. Batch size for tuning. This feature is only available for open source models. */
|
|
9973
|
+
batchSize?: string;
|
|
9910
9974
|
/** Optional. Number of complete passes the model makes over the entire training dataset during training. */
|
|
9911
9975
|
epochCount?: string;
|
|
9976
|
+
/** Optional. Learning rate for tuning. Mutually exclusive with `learning_rate_multiplier`. This feature is only available for open source models. */
|
|
9977
|
+
learningRate?: number;
|
|
9912
9978
|
/** Optional. Multiplier for adjusting the default learning rate. Mutually exclusive with `learning_rate`. This feature is only available for 1P models. */
|
|
9913
9979
|
learningRateMultiplier?: number;
|
|
9914
9980
|
}
|
|
@@ -9973,6 +10039,8 @@ declare namespace gapi.client {
|
|
|
9973
10039
|
hyperParameters?: GoogleCloudAiplatformV1beta1SupervisedHyperParameters;
|
|
9974
10040
|
/** Required. Training dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset. */
|
|
9975
10041
|
trainingDatasetUri?: string;
|
|
10042
|
+
/** Tuning mode. */
|
|
10043
|
+
tuningMode?: string;
|
|
9976
10044
|
/** Optional. Validation dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset. */
|
|
9977
10045
|
validationDatasetUri?: string;
|
|
9978
10046
|
}
|
|
@@ -10172,8 +10240,10 @@ declare namespace gapi.client {
|
|
|
10172
10240
|
computerUse?: GoogleCloudAiplatformV1beta1ToolComputerUse;
|
|
10173
10241
|
/** Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. */
|
|
10174
10242
|
enterpriseWebSearch?: any;
|
|
10175
|
-
/** 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
|
|
10243
|
+
/** 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. */
|
|
10176
10244
|
functionDeclarations?: GoogleCloudAiplatformV1beta1FunctionDeclaration[];
|
|
10245
|
+
/** Optional. GoogleMaps tool type. Tool to support Google Maps in Model. */
|
|
10246
|
+
googleMaps?: GoogleCloudAiplatformV1beta1GoogleMaps;
|
|
10177
10247
|
/** Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. */
|
|
10178
10248
|
googleSearch?: any;
|
|
10179
10249
|
/** Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. */
|
|
@@ -10556,6 +10626,8 @@ declare namespace gapi.client {
|
|
|
10556
10626
|
baseModel?: string;
|
|
10557
10627
|
/** Output only. Time when the TuningJob was created. */
|
|
10558
10628
|
createTime?: string;
|
|
10629
|
+
/** Optional. The user-provided path to custom model weights. Set this field to tune a custom model. The path must be a Cloud Storage directory that contains the model weights in .safetensors format along with associated model metadata files. If this field is set, the base_model field must still be set to indicate which base model the custom model is derived from. This feature is only available for open source models. */
|
|
10630
|
+
customBaseModel?: string;
|
|
10559
10631
|
/** Optional. The description of the TuningJob. */
|
|
10560
10632
|
description?: string;
|
|
10561
10633
|
/** Tuning Spec for Distillation. */
|
|
@@ -10572,6 +10644,8 @@ declare namespace gapi.client {
|
|
|
10572
10644
|
labels?: {[P in string]: string};
|
|
10573
10645
|
/** Output only. Identifier. Resource name of a TuningJob. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}` */
|
|
10574
10646
|
name?: string;
|
|
10647
|
+
/** Optional. Cloud Storage path to the directory where tuning job outputs are written to. This field is only available and required for open source models. */
|
|
10648
|
+
outputUri?: string;
|
|
10575
10649
|
/** Tuning Spec for open sourced and third party Partner models. */
|
|
10576
10650
|
partnerModelTuningSpec?: GoogleCloudAiplatformV1beta1PartnerModelTuningSpec;
|
|
10577
10651
|
/** Output only. The resource name of the PipelineJob associated with the TuningJob. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`. */
|