@maxim_mazurok/gapi.client.aiplatform-v1beta1 0.0.20250715 → 0.0.20250731
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 +251 -21
- 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: 20250731
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -277,10 +277,6 @@ declare namespace gapi.client {
|
|
|
277
277
|
interface GoogleCloudAiplatformV1beta1AssembleDataRequest {
|
|
278
278
|
/** Optional. The read config for the dataset. */
|
|
279
279
|
geminiRequestReadConfig?: GoogleCloudAiplatformV1beta1GeminiRequestReadConfig;
|
|
280
|
-
/** Optional. Config for assembling templates with a Gemini API structure. */
|
|
281
|
-
geminiTemplateConfig?: GoogleCloudAiplatformV1beta1GeminiTemplateConfig;
|
|
282
|
-
/** Optional. The column name in the underlying table that contains already fully assembled requests. If this field is set, the original request will be copied to the output table. */
|
|
283
|
-
requestColumnName?: string;
|
|
284
280
|
}
|
|
285
281
|
interface GoogleCloudAiplatformV1beta1AssessDataRequest {
|
|
286
282
|
/** Optional. Configuration for the batch prediction resource usage assessment. */
|
|
@@ -289,10 +285,6 @@ declare namespace gapi.client {
|
|
|
289
285
|
batchPredictionValidationAssessmentConfig?: GoogleCloudAiplatformV1beta1AssessDataRequestBatchPredictionValidationAssessmentConfig;
|
|
290
286
|
/** Optional. The Gemini request read config for the dataset. */
|
|
291
287
|
geminiRequestReadConfig?: GoogleCloudAiplatformV1beta1GeminiRequestReadConfig;
|
|
292
|
-
/** Optional. Config for assembling templates with a Gemini API structure to assess assembled data. */
|
|
293
|
-
geminiTemplateConfig?: GoogleCloudAiplatformV1beta1GeminiTemplateConfig;
|
|
294
|
-
/** Optional. The column name in the underlying table that contains already fully assembled requests. */
|
|
295
|
-
requestColumnName?: string;
|
|
296
288
|
/** Optional. Configuration for the tuning resource usage assessment. */
|
|
297
289
|
tuningResourceUsageAssessmentConfig?: GoogleCloudAiplatformV1beta1AssessDataRequestTuningResourceUsageAssessmentConfig;
|
|
298
290
|
/** Optional. Configuration for the tuning validation assessment. */
|
|
@@ -425,7 +417,7 @@ declare namespace gapi.client {
|
|
|
425
417
|
samplingCount?: number;
|
|
426
418
|
}
|
|
427
419
|
interface GoogleCloudAiplatformV1beta1AutoscalingMetricSpec {
|
|
428
|
-
/** Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` */
|
|
420
|
+
/** Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` */
|
|
429
421
|
metricName?: string;
|
|
430
422
|
/** The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. */
|
|
431
423
|
target?: number;
|
|
@@ -471,10 +463,14 @@ declare namespace gapi.client {
|
|
|
471
463
|
tensorboardTimeSeries?: GoogleCloudAiplatformV1beta1TensorboardTimeSeries[];
|
|
472
464
|
}
|
|
473
465
|
interface GoogleCloudAiplatformV1beta1BatchDedicatedResources {
|
|
466
|
+
/** Optional. Immutable. If set, use DWS resource to schedule the deployment workload. reference: (https://cloud.google.com/blog/products/compute/introducing-dynamic-workload-scheduler) */
|
|
467
|
+
flexStart?: GoogleCloudAiplatformV1beta1FlexStart;
|
|
474
468
|
/** Required. Immutable. The specification of a single machine. */
|
|
475
469
|
machineSpec?: GoogleCloudAiplatformV1beta1MachineSpec;
|
|
476
470
|
/** Immutable. The maximum number of machine replicas the batch operation may be scaled to. The default value is 10. */
|
|
477
471
|
maxReplicaCount?: number;
|
|
472
|
+
/** Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). */
|
|
473
|
+
spot?: boolean;
|
|
478
474
|
/** Immutable. The number of machine replicas used at the start of the batch operation. If not set, Vertex AI decides starting number, not greater than max_replica_count */
|
|
479
475
|
startingReplicaCount?: number;
|
|
480
476
|
}
|
|
@@ -1079,6 +1075,8 @@ declare namespace gapi.client {
|
|
|
1079
1075
|
deploymentResourcePoolId?: string;
|
|
1080
1076
|
}
|
|
1081
1077
|
interface GoogleCloudAiplatformV1beta1CreateEndpointOperationMetadata {
|
|
1078
|
+
/** Output only. The deployment stage of the model. Only populated if this CreateEndpoint request deploys a model at the same time. */
|
|
1079
|
+
deploymentStage?: string;
|
|
1082
1080
|
/** The operation generic information. */
|
|
1083
1081
|
genericMetadata?: GoogleCloudAiplatformV1beta1GenericOperationMetadata;
|
|
1084
1082
|
}
|
|
@@ -1527,6 +1525,8 @@ declare namespace gapi.client {
|
|
|
1527
1525
|
deployedIndexAuthConfig?: GoogleCloudAiplatformV1beta1DeployedIndexAuthConfig;
|
|
1528
1526
|
/** Optional. The deployment group can be no longer than 64 characters (eg: 'test', 'prod'). If not set, we will use the 'default' deployment group. Creating `deployment_groups` with `reserved_ip_ranges` is a recommended practice when the peered network has multiple peering ranges. This creates your deployments from predictable IP spaces for easier traffic administration. Also, one deployment_group (except 'default') can only be used with the same reserved_ip_ranges which means if the deployment_group has been used with reserved_ip_ranges: [a, b, c], using it with [a, b] or [d, e] is disallowed. Note: we only support up to 5 deployment groups(not including 'default'). */
|
|
1529
1527
|
deploymentGroup?: string;
|
|
1528
|
+
/** Optional. The deployment tier that the index is deployed to. DEPLOYMENT_TIER_UNSPECIFIED defaults to PERFORMANCE. */
|
|
1529
|
+
deploymentTier?: string;
|
|
1530
1530
|
/** The display name of the DeployedIndex. If not provided upon creation, the Index's display_name is used. */
|
|
1531
1531
|
displayName?: string;
|
|
1532
1532
|
/** Optional. If true, private endpoint's access logs are sent to Cloud Logging. These logs are like standard server access logs, containing information like timestamp and latency for each MatchRequest. Note that logs may incur a cost, especially if the deployed index receives a high queries per second rate (QPS). Estimate your costs before enabling this option. */
|
|
@@ -1657,6 +1657,8 @@ declare namespace gapi.client {
|
|
|
1657
1657
|
serviceAccount?: string;
|
|
1658
1658
|
}
|
|
1659
1659
|
interface GoogleCloudAiplatformV1beta1DeployModelOperationMetadata {
|
|
1660
|
+
/** Output only. The deployment stage of the model. */
|
|
1661
|
+
deploymentStage?: string;
|
|
1660
1662
|
/** The operation generic information. */
|
|
1661
1663
|
genericMetadata?: GoogleCloudAiplatformV1beta1GenericOperationMetadata;
|
|
1662
1664
|
}
|
|
@@ -1867,7 +1869,10 @@ declare namespace gapi.client {
|
|
|
1867
1869
|
/** Output only. Timestamp when this Endpoint was last updated. */
|
|
1868
1870
|
updateTime?: string;
|
|
1869
1871
|
}
|
|
1870
|
-
interface GoogleCloudAiplatformV1beta1EnterpriseWebSearch {
|
|
1872
|
+
interface GoogleCloudAiplatformV1beta1EnterpriseWebSearch {
|
|
1873
|
+
/** Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. */
|
|
1874
|
+
excludeDomains?: string[];
|
|
1875
|
+
}
|
|
1871
1876
|
interface GoogleCloudAiplatformV1beta1EntityIdSelector {
|
|
1872
1877
|
/** Source of Csv */
|
|
1873
1878
|
csvSource?: GoogleCloudAiplatformV1beta1CsvSource;
|
|
@@ -3026,6 +3031,8 @@ declare namespace gapi.client {
|
|
|
3026
3031
|
interface GoogleCloudAiplatformV1beta1FeatureViewDirectWriteRequestDataKeyAndFeatureValuesFeature {
|
|
3027
3032
|
/** Feature short name. */
|
|
3028
3033
|
name?: string;
|
|
3034
|
+
/** Feature value. A user provided timestamp may be set in the `FeatureValue.metadata.generate_time` field. */
|
|
3035
|
+
value?: GoogleCloudAiplatformV1beta1FeatureValue;
|
|
3029
3036
|
/** Feature value and timestamp. */
|
|
3030
3037
|
valueAndTimestamp?: GoogleCloudAiplatformV1beta1FeatureViewDirectWriteRequestDataKeyAndFeatureValuesFeatureFeatureValueAndTimestamp;
|
|
3031
3038
|
}
|
|
@@ -3381,6 +3388,18 @@ declare namespace gapi.client {
|
|
|
3381
3388
|
/** Optional. A list of `Tools` the model may use to generate the next response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. */
|
|
3382
3389
|
tools?: GoogleCloudAiplatformV1beta1Tool[];
|
|
3383
3390
|
}
|
|
3391
|
+
interface GoogleCloudAiplatformV1beta1GeminiPreferenceExample {
|
|
3392
|
+
/** List of completions for a given prompt. */
|
|
3393
|
+
completions?: GoogleCloudAiplatformV1beta1GeminiPreferenceExampleCompletion[];
|
|
3394
|
+
/** Multi-turn contents that represents the Prompt. */
|
|
3395
|
+
contents?: GoogleCloudAiplatformV1beta1Content[];
|
|
3396
|
+
}
|
|
3397
|
+
interface GoogleCloudAiplatformV1beta1GeminiPreferenceExampleCompletion {
|
|
3398
|
+
/** Single turn completion for the given prompt. */
|
|
3399
|
+
completion?: GoogleCloudAiplatformV1beta1Content;
|
|
3400
|
+
/** The score for the given completion. */
|
|
3401
|
+
score?: number;
|
|
3402
|
+
}
|
|
3384
3403
|
interface GoogleCloudAiplatformV1beta1GeminiRequestReadConfig {
|
|
3385
3404
|
/** Optional. Column name in the dataset table that contains already fully assembled Gemini requests. */
|
|
3386
3405
|
assembledRequestColumnName?: string;
|
|
@@ -3482,6 +3501,8 @@ declare namespace gapi.client {
|
|
|
3482
3501
|
interface GoogleCloudAiplatformV1beta1GenerateMemoriesRequest {
|
|
3483
3502
|
/** Defines a direct source of content as the source content from which to generate memories. */
|
|
3484
3503
|
directContentsSource?: GoogleCloudAiplatformV1beta1GenerateMemoriesRequestDirectContentsSource;
|
|
3504
|
+
/** Defines a direct source of memories that should be uploaded to Memory Bank. This is similar to `CreateMemory`, but it allows for consolidation between these new memories and existing memories for the same scope. */
|
|
3505
|
+
directMemoriesSource?: GoogleCloudAiplatformV1beta1GenerateMemoriesRequestDirectMemoriesSource;
|
|
3485
3506
|
/** Optional. If true, generated memories will not be consolidated with existing memories; all generated memories will be added as new memories regardless of whether they are duplicates of or contradictory to existing memories. By default, memory consolidation is enabled. */
|
|
3486
3507
|
disableConsolidation?: boolean;
|
|
3487
3508
|
/** Optional. The scope of the memories that should be generated. Memories will be consolidated across memories with the same scope. Must be provided unless the scope is defined in the source content. If `scope` is provided, it will override the scope defined in the source content. Scope values cannot contain the wildcard character '*'. */
|
|
@@ -3497,6 +3518,14 @@ declare namespace gapi.client {
|
|
|
3497
3518
|
/** Required. A single piece of content from which to generate memories. */
|
|
3498
3519
|
content?: GoogleCloudAiplatformV1beta1Content;
|
|
3499
3520
|
}
|
|
3521
|
+
interface GoogleCloudAiplatformV1beta1GenerateMemoriesRequestDirectMemoriesSource {
|
|
3522
|
+
/** Required. The direct memories to upload to Memory Bank. At most 5 direct memories are allowed per request. */
|
|
3523
|
+
directMemories?: GoogleCloudAiplatformV1beta1GenerateMemoriesRequestDirectMemoriesSourceDirectMemory[];
|
|
3524
|
+
}
|
|
3525
|
+
interface GoogleCloudAiplatformV1beta1GenerateMemoriesRequestDirectMemoriesSourceDirectMemory {
|
|
3526
|
+
/** Required. The fact to consolidate with existing memories. */
|
|
3527
|
+
fact?: string;
|
|
3528
|
+
}
|
|
3500
3529
|
interface GoogleCloudAiplatformV1beta1GenerateMemoriesRequestVertexSessionSource {
|
|
3501
3530
|
/** Optional. End time (exclusive) of the time range. If not set, the end time is unbounded. */
|
|
3502
3531
|
endTime?: string;
|
|
@@ -3615,6 +3644,12 @@ declare namespace gapi.client {
|
|
|
3615
3644
|
/** Required. The type of the Google Drive resource. */
|
|
3616
3645
|
resourceType?: string;
|
|
3617
3646
|
}
|
|
3647
|
+
interface GoogleCloudAiplatformV1beta1GoogleMaps {
|
|
3648
|
+
/** The authentication config to access the API. Deprecated. Please use auth_config instead. */
|
|
3649
|
+
apiAuth?: GoogleCloudAiplatformV1beta1ApiAuth;
|
|
3650
|
+
/** The authentication config to access the API. Only API key is supported. */
|
|
3651
|
+
authConfig?: GoogleCloudAiplatformV1beta1AuthConfig;
|
|
3652
|
+
}
|
|
3618
3653
|
interface GoogleCloudAiplatformV1beta1GoogleSearchRetrieval {
|
|
3619
3654
|
/** Specifies the dynamic retrieval configuration for the given source. */
|
|
3620
3655
|
dynamicRetrievalConfig?: GoogleCloudAiplatformV1beta1DynamicRetrievalConfig;
|
|
@@ -3644,11 +3679,51 @@ declare namespace gapi.client {
|
|
|
3644
3679
|
version?: number;
|
|
3645
3680
|
}
|
|
3646
3681
|
interface GoogleCloudAiplatformV1beta1GroundingChunk {
|
|
3682
|
+
/** Grounding chunk from Google Maps. */
|
|
3683
|
+
maps?: GoogleCloudAiplatformV1beta1GroundingChunkMaps;
|
|
3647
3684
|
/** Grounding chunk from context retrieved by the retrieval tools. */
|
|
3648
3685
|
retrievedContext?: GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext;
|
|
3649
3686
|
/** Grounding chunk from the web. */
|
|
3650
3687
|
web?: GoogleCloudAiplatformV1beta1GroundingChunkWeb;
|
|
3651
3688
|
}
|
|
3689
|
+
interface GoogleCloudAiplatformV1beta1GroundingChunkMaps {
|
|
3690
|
+
/** 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. */
|
|
3691
|
+
placeAnswerSources?: GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSources;
|
|
3692
|
+
/** This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place. */
|
|
3693
|
+
placeId?: string;
|
|
3694
|
+
/** Text of the chunk. */
|
|
3695
|
+
text?: string;
|
|
3696
|
+
/** Title of the chunk. */
|
|
3697
|
+
title?: string;
|
|
3698
|
+
/** URI reference of the chunk. */
|
|
3699
|
+
uri?: string;
|
|
3700
|
+
}
|
|
3701
|
+
interface GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSources {
|
|
3702
|
+
/** A link where users can flag a problem with the generated answer. */
|
|
3703
|
+
flagContentUri?: string;
|
|
3704
|
+
/** Snippets of reviews that are used to generate the answer. */
|
|
3705
|
+
reviewSnippets?: GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet[];
|
|
3706
|
+
}
|
|
3707
|
+
interface GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution {
|
|
3708
|
+
/** Name of the author of the Photo or Review. */
|
|
3709
|
+
displayName?: string;
|
|
3710
|
+
/** Profile photo URI of the author of the Photo or Review. */
|
|
3711
|
+
photoUri?: string;
|
|
3712
|
+
/** URI of the author of the Photo or Review. */
|
|
3713
|
+
uri?: string;
|
|
3714
|
+
}
|
|
3715
|
+
interface GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet {
|
|
3716
|
+
/** This review's author. */
|
|
3717
|
+
authorAttribution?: GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution;
|
|
3718
|
+
/** A link where users can flag a problem with the review. */
|
|
3719
|
+
flagContentUri?: string;
|
|
3720
|
+
/** A link to show the review on Google Maps. */
|
|
3721
|
+
googleMapsUri?: string;
|
|
3722
|
+
/** A string of formatted recent time, expressing the review time relative to the current time in a form appropriate for the language and country. */
|
|
3723
|
+
relativePublishTimeDescription?: string;
|
|
3724
|
+
/** A reference representing this place review which may be used to look up this place review again. */
|
|
3725
|
+
review?: string;
|
|
3726
|
+
}
|
|
3652
3727
|
interface GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext {
|
|
3653
3728
|
/** Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool. */
|
|
3654
3729
|
ragChunk?: GoogleCloudAiplatformV1beta1RagChunk;
|
|
@@ -3668,6 +3743,8 @@ declare namespace gapi.client {
|
|
|
3668
3743
|
uri?: string;
|
|
3669
3744
|
}
|
|
3670
3745
|
interface GoogleCloudAiplatformV1beta1GroundingMetadata {
|
|
3746
|
+
/** 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. */
|
|
3747
|
+
googleMapsWidgetContextToken?: string;
|
|
3671
3748
|
/** List of supporting references retrieved from specified grounding source. */
|
|
3672
3749
|
groundingChunks?: GoogleCloudAiplatformV1beta1GroundingChunk[];
|
|
3673
3750
|
/** Optional. List of grounding support. */
|
|
@@ -3928,6 +4005,8 @@ declare namespace gapi.client {
|
|
|
3928
4005
|
crowdingTag?: GoogleCloudAiplatformV1beta1IndexDatapointCrowdingTag;
|
|
3929
4006
|
/** Required. Unique identifier of the datapoint. */
|
|
3930
4007
|
datapointId?: string;
|
|
4008
|
+
/** Optional. The key-value map of additional metadata for the datapoint. */
|
|
4009
|
+
embeddingMetadata?: {[P in string]: any};
|
|
3931
4010
|
/** Required. Feature embedding vector for dense index. An array of numbers with the length of [NearestNeighborSearchConfig.dimensions]. */
|
|
3932
4011
|
featureVector?: number[];
|
|
3933
4012
|
/** 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. */
|
|
@@ -5856,6 +5935,14 @@ declare namespace gapi.client {
|
|
|
5856
5935
|
/** Optional. Post startup script config. */
|
|
5857
5936
|
postStartupScriptConfig?: GoogleCloudAiplatformV1beta1PostStartupScriptConfig;
|
|
5858
5937
|
}
|
|
5938
|
+
interface GoogleCloudAiplatformV1beta1OptimizePromptRequest {
|
|
5939
|
+
/** Required. The content to optimize. */
|
|
5940
|
+
content?: GoogleCloudAiplatformV1beta1Content;
|
|
5941
|
+
}
|
|
5942
|
+
interface GoogleCloudAiplatformV1beta1OptimizePromptResponse {
|
|
5943
|
+
/** Output only. The optimized prompt content. */
|
|
5944
|
+
content?: GoogleCloudAiplatformV1beta1Content;
|
|
5945
|
+
}
|
|
5859
5946
|
interface GoogleCloudAiplatformV1beta1OutputConfig {
|
|
5860
5947
|
/** Cloud storage destination for evaluation output. */
|
|
5861
5948
|
gcsDestination?: GoogleCloudAiplatformV1beta1GcsDestination;
|
|
@@ -6317,12 +6404,56 @@ declare namespace gapi.client {
|
|
|
6317
6404
|
/** Immutable. Points to a YAML file stored on Google Cloud Storage describing the format of a single prediction produced by this Model, which are returned via PredictResponse.predictions, ExplainResponse.explanations, and BatchPredictionJob.output_config. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). AutoML Models always have this field populated by Vertex AI. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access. */
|
|
6318
6405
|
predictionSchemaUri?: string;
|
|
6319
6406
|
}
|
|
6407
|
+
interface GoogleCloudAiplatformV1beta1PreferenceOptimizationDataStats {
|
|
6408
|
+
/** Output only. Dataset distributions for scores. */
|
|
6409
|
+
scoresDistribution?: GoogleCloudAiplatformV1beta1DatasetDistribution;
|
|
6410
|
+
/** Output only. Dataset distributions for scores variance per example. */
|
|
6411
|
+
scoreVariancePerExampleDistribution?: GoogleCloudAiplatformV1beta1DatasetDistribution;
|
|
6412
|
+
/** Output only. Number of billable tokens in the tuning dataset. */
|
|
6413
|
+
totalBillableTokenCount?: string;
|
|
6414
|
+
/** Output only. Number of examples in the tuning dataset. */
|
|
6415
|
+
tuningDatasetExampleCount?: string;
|
|
6416
|
+
/** Output only. Number of tuning steps for this Tuning Job. */
|
|
6417
|
+
tuningStepCount?: string;
|
|
6418
|
+
/** Output only. Sample user examples in the training dataset. */
|
|
6419
|
+
userDatasetExamples?: GoogleCloudAiplatformV1beta1GeminiPreferenceExample[];
|
|
6420
|
+
/** Output only. Dataset distributions for the user input tokens. */
|
|
6421
|
+
userInputTokenDistribution?: GoogleCloudAiplatformV1beta1DatasetDistribution;
|
|
6422
|
+
/** Output only. Dataset distributions for the user output tokens. */
|
|
6423
|
+
userOutputTokenDistribution?: GoogleCloudAiplatformV1beta1DatasetDistribution;
|
|
6424
|
+
}
|
|
6425
|
+
interface GoogleCloudAiplatformV1beta1PreferenceOptimizationHyperParameters {
|
|
6426
|
+
/** Optional. Adapter size for preference optimization. */
|
|
6427
|
+
adapterSize?: string;
|
|
6428
|
+
/** Optional. Weight for KL Divergence regularization. */
|
|
6429
|
+
beta?: number;
|
|
6430
|
+
/** Optional. Number of complete passes the model makes over the entire training dataset during training. */
|
|
6431
|
+
epochCount?: string;
|
|
6432
|
+
/** Optional. Multiplier for adjusting the default learning rate. */
|
|
6433
|
+
learningRateMultiplier?: number;
|
|
6434
|
+
}
|
|
6435
|
+
interface GoogleCloudAiplatformV1beta1PreferenceOptimizationSpec {
|
|
6436
|
+
/** Optional. Hyperparameters for Preference Optimization. */
|
|
6437
|
+
hyperParameters?: GoogleCloudAiplatformV1beta1PreferenceOptimizationHyperParameters;
|
|
6438
|
+
/** Required. Cloud Storage path to file containing training dataset for preference optimization tuning. The dataset must be formatted as a JSONL file. */
|
|
6439
|
+
trainingDatasetUri?: string;
|
|
6440
|
+
/** Optional. Cloud Storage path to file containing validation dataset for preference optimization tuning. The dataset must be formatted as a JSONL file. */
|
|
6441
|
+
validationDatasetUri?: string;
|
|
6442
|
+
}
|
|
6320
6443
|
interface GoogleCloudAiplatformV1beta1Presets {
|
|
6321
6444
|
/** The modality of the uploaded model, which automatically configures the distance measurement and feature normalization for the underlying example index and queries. If your model does not precisely fit one of these types, it is okay to choose the closest type. */
|
|
6322
6445
|
modality?: string;
|
|
6323
6446
|
/** Preset option controlling parameters for speed-precision trade-off when querying for examples. If omitted, defaults to `PRECISE`. */
|
|
6324
6447
|
query?: string;
|
|
6325
6448
|
}
|
|
6449
|
+
interface GoogleCloudAiplatformV1beta1PreTunedModel {
|
|
6450
|
+
/** Output only. The name of the base model this PreTunedModel was tuned from. */
|
|
6451
|
+
baseModel?: string;
|
|
6452
|
+
/** Optional. The source checkpoint id. If not specified, the default checkpoint will be used. */
|
|
6453
|
+
checkpointId?: string;
|
|
6454
|
+
/** The resource name of the Model. E.g., a model resource name with a specified version id or alias: `projects/{project}/locations/{location}/models/{model}@{version_id}` `projects/{project}/locations/{location}/models/{model}@{alias}` Or, omit the version id to use the default version: `projects/{project}/locations/{location}/models/{model}` */
|
|
6455
|
+
tunedModelName?: string;
|
|
6456
|
+
}
|
|
6326
6457
|
interface GoogleCloudAiplatformV1beta1PrivateEndpoints {
|
|
6327
6458
|
/** Output only. Http(s) path to send explain requests. */
|
|
6328
6459
|
explainHttpUri?: string;
|
|
@@ -6526,6 +6657,8 @@ declare namespace gapi.client {
|
|
|
6526
6657
|
notebooks?: GoogleCloudAiplatformV1beta1PublisherModelCallToActionRegionalResourceReferences[];
|
|
6527
6658
|
}
|
|
6528
6659
|
interface GoogleCloudAiplatformV1beta1PublisherModelCallToActionRegionalResourceReferences {
|
|
6660
|
+
/** Optional. For notebook resource. When set to true, the Colab Enterprise link will be disabled in the "open notebook" dialog in UI. */
|
|
6661
|
+
colabNotebookDisabled?: boolean;
|
|
6529
6662
|
/** Required. */
|
|
6530
6663
|
references?: {
|
|
6531
6664
|
[P in string]: GoogleCloudAiplatformV1beta1PublisherModelResourceReference;
|
|
@@ -7222,6 +7355,8 @@ declare namespace gapi.client {
|
|
|
7222
7355
|
description?: string;
|
|
7223
7356
|
/** Required. The display name of the ReasoningEngine. */
|
|
7224
7357
|
displayName?: string;
|
|
7358
|
+
/** 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. */
|
|
7359
|
+
encryptionSpec?: GoogleCloudAiplatformV1beta1EncryptionSpec;
|
|
7225
7360
|
/** Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. */
|
|
7226
7361
|
etag?: string;
|
|
7227
7362
|
/** Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` */
|
|
@@ -7258,6 +7393,8 @@ declare namespace gapi.client {
|
|
|
7258
7393
|
deploymentSpec?: GoogleCloudAiplatformV1beta1ReasoningEngineSpecDeploymentSpec;
|
|
7259
7394
|
/** 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
7395
|
packageSpec?: GoogleCloudAiplatformV1beta1ReasoningEngineSpecPackageSpec;
|
|
7396
|
+
/** 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. */
|
|
7397
|
+
serviceAccount?: string;
|
|
7261
7398
|
}
|
|
7262
7399
|
interface GoogleCloudAiplatformV1beta1ReasoningEngineSpecDeploymentSpec {
|
|
7263
7400
|
/** Optional. Environment variables to be set with the Reasoning Engine deployment. The environment variables can be updated through the UpdateReasoningEngine API. */
|
|
@@ -9907,8 +10044,12 @@ declare namespace gapi.client {
|
|
|
9907
10044
|
interface GoogleCloudAiplatformV1beta1SupervisedHyperParameters {
|
|
9908
10045
|
/** Optional. Adapter size for tuning. */
|
|
9909
10046
|
adapterSize?: string;
|
|
10047
|
+
/** Optional. Batch size for tuning. This feature is only available for open source models. */
|
|
10048
|
+
batchSize?: string;
|
|
9910
10049
|
/** Optional. Number of complete passes the model makes over the entire training dataset during training. */
|
|
9911
10050
|
epochCount?: string;
|
|
10051
|
+
/** Optional. Learning rate for tuning. Mutually exclusive with `learning_rate_multiplier`. This feature is only available for open source models. */
|
|
10052
|
+
learningRate?: number;
|
|
9912
10053
|
/** Optional. Multiplier for adjusting the default learning rate. Mutually exclusive with `learning_rate`. This feature is only available for 1P models. */
|
|
9913
10054
|
learningRateMultiplier?: number;
|
|
9914
10055
|
}
|
|
@@ -9973,6 +10114,8 @@ declare namespace gapi.client {
|
|
|
9973
10114
|
hyperParameters?: GoogleCloudAiplatformV1beta1SupervisedHyperParameters;
|
|
9974
10115
|
/** 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
10116
|
trainingDatasetUri?: string;
|
|
10117
|
+
/** Tuning mode. */
|
|
10118
|
+
tuningMode?: string;
|
|
9976
10119
|
/** 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
10120
|
validationDatasetUri?: string;
|
|
9978
10121
|
}
|
|
@@ -10168,14 +10311,14 @@ declare namespace gapi.client {
|
|
|
10168
10311
|
interface GoogleCloudAiplatformV1beta1Tool {
|
|
10169
10312
|
/** Optional. CodeExecution tool type. Enables the model to execute code as part of generation. */
|
|
10170
10313
|
codeExecution?: any;
|
|
10171
|
-
/** Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. */
|
|
10172
|
-
computerUse?: GoogleCloudAiplatformV1beta1ToolComputerUse;
|
|
10173
10314
|
/** Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. */
|
|
10174
|
-
enterpriseWebSearch?:
|
|
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
|
|
10315
|
+
enterpriseWebSearch?: GoogleCloudAiplatformV1beta1EnterpriseWebSearch;
|
|
10316
|
+
/** 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
10317
|
functionDeclarations?: GoogleCloudAiplatformV1beta1FunctionDeclaration[];
|
|
10318
|
+
/** Optional. GoogleMaps tool type. Tool to support Google Maps in Model. */
|
|
10319
|
+
googleMaps?: GoogleCloudAiplatformV1beta1GoogleMaps;
|
|
10177
10320
|
/** Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. */
|
|
10178
|
-
googleSearch?:
|
|
10321
|
+
googleSearch?: GoogleCloudAiplatformV1beta1ToolGoogleSearch;
|
|
10179
10322
|
/** Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. */
|
|
10180
10323
|
googleSearchRetrieval?: GoogleCloudAiplatformV1beta1GoogleSearchRetrieval;
|
|
10181
10324
|
/** Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. */
|
|
@@ -10211,17 +10354,16 @@ declare namespace gapi.client {
|
|
|
10211
10354
|
}
|
|
10212
10355
|
interface GoogleCloudAiplatformV1beta1ToolCallValidSpec {}
|
|
10213
10356
|
interface GoogleCloudAiplatformV1beta1ToolCodeExecution {}
|
|
10214
|
-
interface GoogleCloudAiplatformV1beta1ToolComputerUse {
|
|
10215
|
-
/** Required. The environment being operated. */
|
|
10216
|
-
environment?: string;
|
|
10217
|
-
}
|
|
10218
10357
|
interface GoogleCloudAiplatformV1beta1ToolConfig {
|
|
10219
10358
|
/** Optional. Function calling config. */
|
|
10220
10359
|
functionCallingConfig?: GoogleCloudAiplatformV1beta1FunctionCallingConfig;
|
|
10221
10360
|
/** Optional. Retrieval config. */
|
|
10222
10361
|
retrievalConfig?: GoogleCloudAiplatformV1beta1RetrievalConfig;
|
|
10223
10362
|
}
|
|
10224
|
-
interface GoogleCloudAiplatformV1beta1ToolGoogleSearch {
|
|
10363
|
+
interface GoogleCloudAiplatformV1beta1ToolGoogleSearch {
|
|
10364
|
+
/** Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. */
|
|
10365
|
+
excludeDomains?: string[];
|
|
10366
|
+
}
|
|
10225
10367
|
interface GoogleCloudAiplatformV1beta1ToolNameMatchInput {
|
|
10226
10368
|
/** Required. Repeated tool name match instances. */
|
|
10227
10369
|
instances?: GoogleCloudAiplatformV1beta1ToolNameMatchInstance[];
|
|
@@ -10548,6 +10690,8 @@ declare namespace gapi.client {
|
|
|
10548
10690
|
interface GoogleCloudAiplatformV1beta1TuningDataStats {
|
|
10549
10691
|
/** Output only. Statistics for distillation. */
|
|
10550
10692
|
distillationDataStats?: GoogleCloudAiplatformV1beta1DistillationDataStats;
|
|
10693
|
+
/** Output only. Statistics for preference optimization. */
|
|
10694
|
+
preferenceOptimizationDataStats?: GoogleCloudAiplatformV1beta1PreferenceOptimizationDataStats;
|
|
10551
10695
|
/** The SFT Tuning data stats. */
|
|
10552
10696
|
supervisedTuningDataStats?: GoogleCloudAiplatformV1beta1SupervisedTuningDataStats;
|
|
10553
10697
|
}
|
|
@@ -10556,6 +10700,8 @@ declare namespace gapi.client {
|
|
|
10556
10700
|
baseModel?: string;
|
|
10557
10701
|
/** Output only. Time when the TuningJob was created. */
|
|
10558
10702
|
createTime?: string;
|
|
10703
|
+
/** 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. */
|
|
10704
|
+
customBaseModel?: string;
|
|
10559
10705
|
/** Optional. The description of the TuningJob. */
|
|
10560
10706
|
description?: string;
|
|
10561
10707
|
/** Tuning Spec for Distillation. */
|
|
@@ -10572,10 +10718,16 @@ declare namespace gapi.client {
|
|
|
10572
10718
|
labels?: {[P in string]: string};
|
|
10573
10719
|
/** Output only. Identifier. Resource name of a TuningJob. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}` */
|
|
10574
10720
|
name?: string;
|
|
10721
|
+
/** 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. */
|
|
10722
|
+
outputUri?: string;
|
|
10575
10723
|
/** Tuning Spec for open sourced and third party Partner models. */
|
|
10576
10724
|
partnerModelTuningSpec?: GoogleCloudAiplatformV1beta1PartnerModelTuningSpec;
|
|
10577
10725
|
/** Output only. The resource name of the PipelineJob associated with the TuningJob. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`. */
|
|
10578
10726
|
pipelineJob?: string;
|
|
10727
|
+
/** Tuning Spec for Preference Optimization. */
|
|
10728
|
+
preferenceOptimizationSpec?: GoogleCloudAiplatformV1beta1PreferenceOptimizationSpec;
|
|
10729
|
+
/** The pre-tuned model for continuous tuning. */
|
|
10730
|
+
preTunedModel?: GoogleCloudAiplatformV1beta1PreTunedModel;
|
|
10579
10731
|
/** Output only. Reserved for future use. */
|
|
10580
10732
|
satisfiesPzi?: boolean;
|
|
10581
10733
|
/** Output only. Reserved for future use. */
|
|
@@ -10596,6 +10748,8 @@ declare namespace gapi.client {
|
|
|
10596
10748
|
tuningDataStats?: GoogleCloudAiplatformV1beta1TuningDataStats;
|
|
10597
10749
|
/** Output only. Time when the TuningJob was most recently updated. */
|
|
10598
10750
|
updateTime?: string;
|
|
10751
|
+
/** Tuning Spec for Veo Tuning. */
|
|
10752
|
+
veoTuningSpec?: GoogleCloudAiplatformV1beta1VeoTuningSpec;
|
|
10599
10753
|
}
|
|
10600
10754
|
interface GoogleCloudAiplatformV1beta1UndeployIndexOperationMetadata {
|
|
10601
10755
|
/** The operation generic information. */
|
|
@@ -10795,6 +10949,22 @@ declare namespace gapi.client {
|
|
|
10795
10949
|
/** A string value. */
|
|
10796
10950
|
stringValue?: string;
|
|
10797
10951
|
}
|
|
10952
|
+
interface GoogleCloudAiplatformV1beta1VeoHyperParameters {
|
|
10953
|
+
/** Optional. Number of complete passes the model makes over the entire training dataset during training. */
|
|
10954
|
+
epochCount?: string;
|
|
10955
|
+
/** Optional. Multiplier for adjusting the default learning rate. */
|
|
10956
|
+
learningRateMultiplier?: number;
|
|
10957
|
+
/** Optional. The tuning task. Either I2V or T2V. */
|
|
10958
|
+
tuningTask?: string;
|
|
10959
|
+
}
|
|
10960
|
+
interface GoogleCloudAiplatformV1beta1VeoTuningSpec {
|
|
10961
|
+
/** Optional. Hyperparameters for Veo. */
|
|
10962
|
+
hyperParameters?: GoogleCloudAiplatformV1beta1VeoHyperParameters;
|
|
10963
|
+
/** 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. */
|
|
10964
|
+
trainingDatasetUri?: string;
|
|
10965
|
+
/** 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. */
|
|
10966
|
+
validationDatasetUri?: string;
|
|
10967
|
+
}
|
|
10798
10968
|
interface GoogleCloudAiplatformV1beta1VertexAISearch {
|
|
10799
10969
|
/** Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` */
|
|
10800
10970
|
datastore?: string;
|
|
@@ -10840,6 +11010,8 @@ declare namespace gapi.client {
|
|
|
10840
11010
|
interface GoogleCloudAiplatformV1beta1VideoMetadata {
|
|
10841
11011
|
/** Optional. The end offset of the video. */
|
|
10842
11012
|
endOffset?: string;
|
|
11013
|
+
/** Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. */
|
|
11014
|
+
fps?: number;
|
|
10843
11015
|
/** Optional. The start offset of the video. */
|
|
10844
11016
|
startOffset?: string;
|
|
10845
11017
|
}
|
|
@@ -39641,6 +39813,64 @@ declare namespace gapi.client {
|
|
|
39641
39813
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
39642
39814
|
uploadType?: string;
|
|
39643
39815
|
}): Request<GoogleCloudAiplatformV1beta1ListTuningJobsResponse>;
|
|
39816
|
+
/** Optimizes a prompt. */
|
|
39817
|
+
optimizePrompt(request: {
|
|
39818
|
+
/** V1 error format. */
|
|
39819
|
+
'$.xgafv'?: string;
|
|
39820
|
+
/** OAuth access token. */
|
|
39821
|
+
access_token?: string;
|
|
39822
|
+
/** Data format for response. */
|
|
39823
|
+
alt?: string;
|
|
39824
|
+
/** JSONP */
|
|
39825
|
+
callback?: string;
|
|
39826
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
39827
|
+
fields?: string;
|
|
39828
|
+
/** 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. */
|
|
39829
|
+
key?: string;
|
|
39830
|
+
/** OAuth 2.0 token for the current user. */
|
|
39831
|
+
oauth_token?: string;
|
|
39832
|
+
/** Required. The resource name of the Location to optimize the prompt in. Format: `projects/{project}/locations/{location}` */
|
|
39833
|
+
parent: string;
|
|
39834
|
+
/** Returns response with indentations and line breaks. */
|
|
39835
|
+
prettyPrint?: boolean;
|
|
39836
|
+
/** 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. */
|
|
39837
|
+
quotaUser?: string;
|
|
39838
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
39839
|
+
upload_protocol?: string;
|
|
39840
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
39841
|
+
uploadType?: string;
|
|
39842
|
+
/** Request body */
|
|
39843
|
+
resource: GoogleCloudAiplatformV1beta1OptimizePromptRequest;
|
|
39844
|
+
}): Request<GoogleCloudAiplatformV1beta1OptimizePromptResponse>;
|
|
39845
|
+
optimizePrompt(
|
|
39846
|
+
request: {
|
|
39847
|
+
/** V1 error format. */
|
|
39848
|
+
'$.xgafv'?: string;
|
|
39849
|
+
/** OAuth access token. */
|
|
39850
|
+
access_token?: string;
|
|
39851
|
+
/** Data format for response. */
|
|
39852
|
+
alt?: string;
|
|
39853
|
+
/** JSONP */
|
|
39854
|
+
callback?: string;
|
|
39855
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
39856
|
+
fields?: string;
|
|
39857
|
+
/** 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. */
|
|
39858
|
+
key?: string;
|
|
39859
|
+
/** OAuth 2.0 token for the current user. */
|
|
39860
|
+
oauth_token?: string;
|
|
39861
|
+
/** Required. The resource name of the Location to optimize the prompt in. Format: `projects/{project}/locations/{location}` */
|
|
39862
|
+
parent: string;
|
|
39863
|
+
/** Returns response with indentations and line breaks. */
|
|
39864
|
+
prettyPrint?: boolean;
|
|
39865
|
+
/** 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. */
|
|
39866
|
+
quotaUser?: string;
|
|
39867
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
39868
|
+
upload_protocol?: string;
|
|
39869
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
39870
|
+
uploadType?: string;
|
|
39871
|
+
},
|
|
39872
|
+
body: GoogleCloudAiplatformV1beta1OptimizePromptRequest,
|
|
39873
|
+
): Request<GoogleCloudAiplatformV1beta1OptimizePromptResponse>;
|
|
39644
39874
|
/** Rebase a TunedModel. */
|
|
39645
39875
|
rebaseTunedModel(request: {
|
|
39646
39876
|
/** V1 error format. */
|