@maxim_mazurok/gapi.client.aiplatform-v1beta1 0.0.20240725 → 0.0.20240809

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 +295 -6
  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: 20240725
12
+ // Revision: 20240809
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -39,6 +39,8 @@ declare namespace gapi.client {
39
39
  interface CloudAiLargeModelsVisionImage {
40
40
  /** Image encoding, encoded as "image/png" or "image/jpg". */
41
41
  encoding?: string;
42
+ /** Generation seed for the sampled image. This parameter is exposed to the user only if one of the following is true: 1. The user specified per-example seeds in the request. 2. The user doesn't specify the generation seed in the request. */
43
+ generationSeed?: number;
42
44
  /** Raw bytes. */
43
45
  image?: string;
44
46
  /** RAI scores for generated image. */
@@ -457,6 +459,10 @@ declare namespace gapi.client {
457
459
  partialFailures?: GoogleRpcStatus[];
458
460
  /** Output only. Information about resources that had been consumed by this job. Provided in real time at best effort basis, as well as a final value once the job completes. Note: This field currently may be not populated for batch predictions that use AutoML Models. */
459
461
  resourcesConsumed?: GoogleCloudAiplatformV1beta1ResourcesConsumed;
462
+ /** Output only. Reserved for future use. */
463
+ satisfiesPzi?: boolean;
464
+ /** Output only. Reserved for future use. */
465
+ satisfiesPzs?: boolean;
460
466
  /** The service account that the DeployedModel's container runs as. If not specified, a system generated one will be used, which has minimal permissions and the custom container, if used, may not have enough permission to access other Google Cloud resources. Users deploying the Model must have the `iam.serviceAccounts.actAs` permission on this service account. */
461
467
  serviceAccount?: string;
462
468
  /** Output only. Time when the BatchPredictionJob for the first time entered the `JOB_STATE_RUNNING` state. */
@@ -622,6 +628,8 @@ declare namespace gapi.client {
622
628
  interface GoogleCloudAiplatformV1beta1CancelTrainingPipelineRequest {}
623
629
  interface GoogleCloudAiplatformV1beta1CancelTuningJobRequest {}
624
630
  interface GoogleCloudAiplatformV1beta1Candidate {
631
+ /** Output only. Average log probability score of the candidate. */
632
+ avgLogprobs?: number;
625
633
  /** Output only. Source attribution of the generated content. */
626
634
  citationMetadata?: GoogleCloudAiplatformV1beta1CitationMetadata;
627
635
  /** Output only. Content parts of the candidate. */
@@ -636,8 +644,6 @@ declare namespace gapi.client {
636
644
  index?: number;
637
645
  /** Output only. List of ratings for the safety of a response candidate. There is at most one rating per category. */
638
646
  safetyRatings?: GoogleCloudAiplatformV1beta1SafetyRating[];
639
- /** Output only. Confidence score of the candidate. */
640
- score?: number;
641
647
  }
642
648
  interface GoogleCloudAiplatformV1beta1CheckTrialEarlyStoppingStateMetatdata {
643
649
  /** Operation metadata for suggesting Trials. */
@@ -977,6 +983,10 @@ declare namespace gapi.client {
977
983
  labels?: {[P in string]: string};
978
984
  /** Output only. Resource name of a CustomJob. */
979
985
  name?: string;
986
+ /** Output only. Reserved for future use. */
987
+ satisfiesPzi?: boolean;
988
+ /** Output only. Reserved for future use. */
989
+ satisfiesPzs?: boolean;
980
990
  /** Output only. Time when the CustomJob for the first time entered the `JOB_STATE_RUNNING` state. */
981
991
  startTime?: string;
982
992
  /** Output only. The detailed state of the job. */
@@ -1027,6 +1037,10 @@ declare namespace gapi.client {
1027
1037
  name?: string;
1028
1038
  /** Required. The data that the DataItem represents (for example, an image or a text snippet). The schema of the payload is stored in the parent Dataset's metadata schema's dataItemSchemaUri field. */
1029
1039
  payload?: any;
1040
+ /** Output only. Reserved for future use. */
1041
+ satisfiesPzi?: boolean;
1042
+ /** Output only. Reserved for future use. */
1043
+ satisfiesPzs?: boolean;
1030
1044
  /** Output only. Timestamp when this DataItem was last updated. */
1031
1045
  updateTime?: string;
1032
1046
  }
@@ -1101,11 +1115,59 @@ declare namespace gapi.client {
1101
1115
  modelReference?: string;
1102
1116
  /** Output only. Identifier. The resource name of the Dataset. */
1103
1117
  name?: string;
1118
+ /** Output only. Reserved for future use. */
1119
+ satisfiesPzi?: boolean;
1120
+ /** Output only. Reserved for future use. */
1121
+ satisfiesPzs?: boolean;
1104
1122
  /** All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec. */
1105
1123
  savedQueries?: GoogleCloudAiplatformV1beta1SavedQuery[];
1106
1124
  /** Output only. Timestamp when this Dataset was last updated. */
1107
1125
  updateTime?: string;
1108
1126
  }
1127
+ interface GoogleCloudAiplatformV1beta1DatasetDistribution {
1128
+ /** Output only. Defines the histogram bucket. */
1129
+ buckets?: GoogleCloudAiplatformV1beta1DatasetDistributionDistributionBucket[];
1130
+ /** Output only. The maximum of the population values. */
1131
+ max?: number;
1132
+ /** Output only. The arithmetic mean of the values in the population. */
1133
+ mean?: number;
1134
+ /** Output only. The median of the values in the population. */
1135
+ median?: number;
1136
+ /** Output only. The minimum of the population values. */
1137
+ min?: number;
1138
+ /** Output only. The 5th percentile of the values in the population. */
1139
+ p5?: number;
1140
+ /** Output only. The 95th percentile of the values in the population. */
1141
+ p95?: number;
1142
+ /** Output only. Sum of a given population of values. */
1143
+ sum?: number;
1144
+ }
1145
+ interface GoogleCloudAiplatformV1beta1DatasetDistributionDistributionBucket {
1146
+ /** Output only. Number of values in the bucket. */
1147
+ count?: string;
1148
+ /** Output only. Left bound of the bucket. */
1149
+ left?: number;
1150
+ /** Output only. Right bound of the bucket. */
1151
+ right?: number;
1152
+ }
1153
+ interface GoogleCloudAiplatformV1beta1DatasetStats {
1154
+ /** Output only. Number of billable characters in the tuning dataset. */
1155
+ totalBillableCharacterCount?: string;
1156
+ /** Output only. Number of tuning characters in the tuning dataset. */
1157
+ totalTuningCharacterCount?: string;
1158
+ /** Output only. Number of examples in the tuning dataset. */
1159
+ tuningDatasetExampleCount?: string;
1160
+ /** Output only. Number of tuning steps for this Tuning Job. */
1161
+ tuningStepCount?: string;
1162
+ /** Output only. Sample user messages in the training dataset uri. */
1163
+ userDatasetExamples?: GoogleCloudAiplatformV1beta1Content[];
1164
+ /** Output only. Dataset distributions for the user input tokens. */
1165
+ userInputTokenDistribution?: GoogleCloudAiplatformV1beta1DatasetDistribution;
1166
+ /** Output only. Dataset distributions for the messages per example. */
1167
+ userMessagePerExampleDistribution?: GoogleCloudAiplatformV1beta1DatasetDistribution;
1168
+ /** Output only. Dataset distributions for the user output tokens. */
1169
+ userOutputTokenDistribution?: GoogleCloudAiplatformV1beta1DatasetDistribution;
1170
+ }
1109
1171
  interface GoogleCloudAiplatformV1beta1DatasetVersion {
1110
1172
  /** Output only. Name of the associated BigQuery dataset. */
1111
1173
  bigQueryDatasetName?: string;
@@ -1121,6 +1183,10 @@ declare namespace gapi.client {
1121
1183
  modelReference?: string;
1122
1184
  /** Output only. Identifier. The resource name of the DatasetVersion. */
1123
1185
  name?: string;
1186
+ /** Output only. Reserved for future use. */
1187
+ satisfiesPzi?: boolean;
1188
+ /** Output only. Reserved for future use. */
1189
+ satisfiesPzs?: boolean;
1124
1190
  /** Output only. Timestamp when this DatasetVersion was last updated. */
1125
1191
  updateTime?: string;
1126
1192
  }
@@ -1133,6 +1199,8 @@ declare namespace gapi.client {
1133
1199
  maxReplicaCount?: number;
1134
1200
  /** Required. Immutable. The minimum number of machine replicas this DeployedModel will be always deployed on. This value must be greater than or equal to 1. If traffic against the DeployedModel increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. */
1135
1201
  minReplicaCount?: number;
1202
+ /** Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). */
1203
+ spot?: boolean;
1136
1204
  }
1137
1205
  interface GoogleCloudAiplatformV1beta1DeleteFeatureValuesOperationMetadata {
1138
1206
  /** Operation metadata for Featurestore delete Features values. */
@@ -1289,6 +1357,10 @@ declare namespace gapi.client {
1289
1357
  encryptionSpec?: GoogleCloudAiplatformV1beta1EncryptionSpec;
1290
1358
  /** Immutable. The resource name of the DeploymentResourcePool. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}` */
1291
1359
  name?: string;
1360
+ /** Output only. Reserved for future use. */
1361
+ satisfiesPzi?: boolean;
1362
+ /** Output only. Reserved for future use. */
1363
+ satisfiesPzs?: boolean;
1292
1364
  /** The service account that the DeploymentResourcePool's container(s) run as. Specify the email address of the service account. If this service account is not specified, the container(s) run as a service account that doesn't have access to the resource project. Users deploying the Models to this DeploymentResourcePool must have the `iam.serviceAccounts.actAs` permission on this service account. */
1293
1365
  serviceAccount?: string;
1294
1366
  }
@@ -1345,6 +1417,34 @@ declare namespace gapi.client {
1345
1417
  /** Type of the boot disk (default is "pd-ssd"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive). */
1346
1418
  bootDiskType?: string;
1347
1419
  }
1420
+ interface GoogleCloudAiplatformV1beta1DistillationDataStats {
1421
+ /** Output only. Statistics computed for the training dataset. */
1422
+ trainingDatasetStats?: GoogleCloudAiplatformV1beta1DatasetStats;
1423
+ }
1424
+ interface GoogleCloudAiplatformV1beta1DistillationHyperParameters {
1425
+ /** Optional. Adapter size for distillation. */
1426
+ adapterSize?: string;
1427
+ /** Optional. Number of complete passes the model makes over the entire training dataset during training. */
1428
+ epochCount?: string;
1429
+ /** Optional. Multiplier for adjusting the default learning rate. */
1430
+ learningRateMultiplier?: number;
1431
+ }
1432
+ interface GoogleCloudAiplatformV1beta1DistillationSpec {
1433
+ /** The base teacher model that is being distilled, e.g., "gemini-1.0-pro-002". */
1434
+ baseTeacherModel?: string;
1435
+ /** Optional. Hyperparameters for Distillation. */
1436
+ hyperParameters?: GoogleCloudAiplatformV1beta1DistillationHyperParameters;
1437
+ /** Required. A path in a Cloud Storage bucket, which will be treated as the root output directory of the distillation pipeline. It is used by the system to generate the paths of output artifacts. */
1438
+ pipelineRootDirectory?: string;
1439
+ /** The student model that is being tuned, e.g., "google/gemma-2b-1.1-it". */
1440
+ studentModel?: string;
1441
+ /** Required. Cloud Storage path to file containing training dataset for tuning. The dataset must be formatted as a JSONL file. */
1442
+ trainingDatasetUri?: string;
1443
+ /** The resource name of the Tuned teacher model. Format: `projects/{project}/locations/{location}/models/{model}`. */
1444
+ tunedTeacherModelSource?: string;
1445
+ /** Optional. Cloud Storage path to file containing validation dataset for tuning. The dataset must be formatted as a JSONL file. */
1446
+ validationDatasetUri?: string;
1447
+ }
1348
1448
  interface GoogleCloudAiplatformV1beta1DoubleArray {
1349
1449
  /** A list of double values. */
1350
1450
  values?: number[];
@@ -1384,6 +1484,10 @@ declare namespace gapi.client {
1384
1484
  predictRequestResponseLoggingConfig?: GoogleCloudAiplatformV1beta1PredictRequestResponseLoggingConfig;
1385
1485
  /** Optional. Configuration for private service connect. network and private_service_connect_config are mutually exclusive. */
1386
1486
  privateServiceConnectConfig?: GoogleCloudAiplatformV1beta1PrivateServiceConnectConfig;
1487
+ /** Output only. Reserved for future use. */
1488
+ satisfiesPzi?: boolean;
1489
+ /** Output only. Reserved for future use. */
1490
+ satisfiesPzs?: boolean;
1387
1491
  /** A map from a DeployedModel's ID to the percentage of this Endpoint's traffic that should be forwarded to that DeployedModel. If a DeployedModel's ID is not listed in this map, then it receives no traffic. The traffic percentage values must add up to 100, or map must be empty if the Endpoint is to not accept any traffic at a moment. */
1388
1492
  trafficSplit?: {[P in string]: number};
1389
1493
  /** Output only. Timestamp when this Endpoint was last updated. */
@@ -1410,6 +1514,10 @@ declare namespace gapi.client {
1410
1514
  name?: string;
1411
1515
  /** Optional. Config for data retention policy in offline storage. TTL in days for feature values that will be stored in offline storage. The Feature Store offline storage periodically removes obsolete feature values older than `offline_storage_ttl_days` since the feature generation time. If unset (or explicitly set to 0), default to 4000 days TTL. */
1412
1516
  offlineStorageTtlDays?: number;
1517
+ /** Output only. Reserved for future use. */
1518
+ satisfiesPzi?: boolean;
1519
+ /** Output only. Reserved for future use. */
1520
+ satisfiesPzs?: boolean;
1413
1521
  /** Output only. Timestamp when this EntityType was most recently updated. */
1414
1522
  updateTime?: string;
1415
1523
  }
@@ -1470,10 +1578,14 @@ declare namespace gapi.client {
1470
1578
  fulfillmentInput?: GoogleCloudAiplatformV1beta1FulfillmentInput;
1471
1579
  /** Input for groundedness metric. */
1472
1580
  groundednessInput?: GoogleCloudAiplatformV1beta1GroundednessInput;
1581
+ /** Input for pairwise metric. */
1582
+ pairwiseMetricInput?: GoogleCloudAiplatformV1beta1PairwiseMetricInput;
1473
1583
  /** Input for pairwise question answering quality metric. */
1474
1584
  pairwiseQuestionAnsweringQualityInput?: GoogleCloudAiplatformV1beta1PairwiseQuestionAnsweringQualityInput;
1475
1585
  /** Input for pairwise summarization quality metric. */
1476
1586
  pairwiseSummarizationQualityInput?: GoogleCloudAiplatformV1beta1PairwiseSummarizationQualityInput;
1587
+ /** Input for pointwise metric. */
1588
+ pointwiseMetricInput?: GoogleCloudAiplatformV1beta1PointwiseMetricInput;
1477
1589
  /** Input for question answering correctness metric. */
1478
1590
  questionAnsweringCorrectnessInput?: GoogleCloudAiplatformV1beta1QuestionAnsweringCorrectnessInput;
1479
1591
  /** Input for question answering helpfulness metric. */
@@ -1514,10 +1626,14 @@ declare namespace gapi.client {
1514
1626
  fulfillmentResult?: GoogleCloudAiplatformV1beta1FulfillmentResult;
1515
1627
  /** Result for groundedness metric. */
1516
1628
  groundednessResult?: GoogleCloudAiplatformV1beta1GroundednessResult;
1629
+ /** Result for pairwise metric. */
1630
+ pairwiseMetricResult?: GoogleCloudAiplatformV1beta1PairwiseMetricResult;
1517
1631
  /** Result for pairwise question answering quality metric. */
1518
1632
  pairwiseQuestionAnsweringQualityResult?: GoogleCloudAiplatformV1beta1PairwiseQuestionAnsweringQualityResult;
1519
1633
  /** Result for pairwise summarization quality metric. */
1520
1634
  pairwiseSummarizationQualityResult?: GoogleCloudAiplatformV1beta1PairwiseSummarizationQualityResult;
1635
+ /** Generic metrics. Result for pointwise metric. */
1636
+ pointwiseMetricResult?: GoogleCloudAiplatformV1beta1PointwiseMetricResult;
1521
1637
  /** Result for question answering correctness metric. */
1522
1638
  questionAnsweringCorrectnessResult?: GoogleCloudAiplatformV1beta1QuestionAnsweringCorrectnessResult;
1523
1639
  /** Result for question answering helpfulness metric. */
@@ -1997,6 +2113,12 @@ declare namespace gapi.client {
1997
2113
  bigQuerySource?: GoogleCloudAiplatformV1beta1BigQuerySource;
1998
2114
  /** Optional. Columns to construct entity_id / row keys. If not provided defaults to `entity_id`. */
1999
2115
  entityIdColumns?: string[];
2116
+ /** Optional. If the source is a time-series source, this can be set to control how downstream sources (ex: FeatureOnlineStore.FeatureView) will treat time series sources. If not set, will treat the source as a time-series source with feature_timestamp as timestamp column and no scan boundary. */
2117
+ timeSeries?: GoogleCloudAiplatformV1beta1FeatureGroupBigQueryTimeSeries;
2118
+ }
2119
+ interface GoogleCloudAiplatformV1beta1FeatureGroupBigQueryTimeSeries {
2120
+ /** Optional. Column hosting timestamp values for a time-series source. Will be used to determine the latest featureValues for each entity. Optional. If not provided, a feature_timestamp column of type TIMESTAMP will be used. */
2121
+ timestampColumn?: string;
2000
2122
  }
2001
2123
  interface GoogleCloudAiplatformV1beta1FeatureMonitoringStatsAnomaly {
2002
2124
  /** Output only. The stats and anomalies generated at specific timestamp. */
@@ -2033,6 +2155,10 @@ declare namespace gapi.client {
2033
2155
  name?: string;
2034
2156
  /** Contains settings for the Optimized store that will be created to serve featureValues for all FeatureViews under this FeatureOnlineStore. When choose Optimized storage type, need to set PrivateServiceConnectConfig.enable_private_service_connect to use private endpoint. Otherwise will use public endpoint by default. */
2035
2157
  optimized?: any;
2158
+ /** Output only. Reserved for future use. */
2159
+ satisfiesPzi?: boolean;
2160
+ /** Output only. Reserved for future use. */
2161
+ satisfiesPzs?: boolean;
2036
2162
  /** Output only. State of the featureOnlineStore. */
2037
2163
  state?: string;
2038
2164
  /** Output only. Timestamp when this FeatureOnlineStore was last updated. */
@@ -2098,6 +2224,10 @@ declare namespace gapi.client {
2098
2224
  onlineServingConfig?: GoogleCloudAiplatformV1beta1FeaturestoreOnlineServingConfig;
2099
2225
  /** Optional. TTL in days for feature values that will be stored in online serving storage. The Feature Store online storage periodically removes obsolete feature values older than `online_storage_ttl_days` since the feature generation time. Note that `online_storage_ttl_days` should be less than or equal to `offline_storage_ttl_days` for each EntityType under a featurestore. If not set, default to 4000 days */
2100
2226
  onlineStorageTtlDays?: number;
2227
+ /** Output only. Reserved for future use. */
2228
+ satisfiesPzi?: boolean;
2229
+ /** Output only. Reserved for future use. */
2230
+ satisfiesPzs?: boolean;
2101
2231
  /** Output only. State of the featurestore. */
2102
2232
  state?: string;
2103
2233
  /** Output only. Timestamp when this Featurestore was last updated. */
@@ -2202,6 +2332,10 @@ declare namespace gapi.client {
2202
2332
  labels?: {[P in string]: string};
2203
2333
  /** Identifier. Name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}` */
2204
2334
  name?: string;
2335
+ /** Output only. Reserved for future use. */
2336
+ satisfiesPzi?: boolean;
2337
+ /** Output only. Reserved for future use. */
2338
+ satisfiesPzs?: boolean;
2205
2339
  /** Output only. A Service Account unique to this FeatureView. The role bigquery.dataViewer should be granted to this service account to allow Vertex AI Feature Store to sync data to the online store. */
2206
2340
  serviceAccountEmail?: string;
2207
2341
  /** Optional. Service agent type used during data sync. By default, the Vertex AI Service Agent is used. When using an IAM Policy to isolate this FeatureView within a project, a separate service account should be provisioned by setting this field to `SERVICE_AGENT_TYPE_FEATURE_VIEW`. This will generate a separate service account to access the BigQuery source table. */
@@ -2271,6 +2405,10 @@ declare namespace gapi.client {
2271
2405
  name?: string;
2272
2406
  /** Output only. Time when this FeatureViewSync is finished. */
2273
2407
  runTime?: GoogleTypeInterval;
2408
+ /** Output only. Reserved for future use. */
2409
+ satisfiesPzi?: boolean;
2410
+ /** Output only. Reserved for future use. */
2411
+ satisfiesPzs?: boolean;
2274
2412
  /** Output only. Summary of the sync job. */
2275
2413
  syncSummary?: GoogleCloudAiplatformV1beta1FeatureViewSyncSyncSummary;
2276
2414
  }
@@ -2530,10 +2668,18 @@ declare namespace gapi.client {
2530
2668
  interface GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata {
2531
2669
  /** Number of tokens in the response(s). */
2532
2670
  candidatesTokenCount?: number;
2533
- /** Number of tokens in the request. */
2671
+ /** Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content. */
2534
2672
  promptTokenCount?: number;
2535
2673
  totalTokenCount?: number;
2536
2674
  }
2675
+ interface GoogleCloudAiplatformV1beta1GenerateVideoResponse {
2676
+ /** The cloud storage uris of the generated videos. */
2677
+ generatedSamples?: string[];
2678
+ /** Returns if any videos were filtered due to RAI policies. */
2679
+ raiMediaFilteredCount?: number;
2680
+ /** Returns rai failure reasons if any. */
2681
+ raiMediaFilteredReasons?: string[];
2682
+ }
2537
2683
  interface GoogleCloudAiplatformV1beta1GenerationConfig {
2538
2684
  /** Optional. Number of candidates to generate. */
2539
2685
  candidateCount?: number;
@@ -2547,6 +2693,10 @@ declare namespace gapi.client {
2547
2693
  responseMimeType?: string;
2548
2694
  /** Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. */
2549
2695
  responseSchema?: GoogleCloudAiplatformV1beta1Schema;
2696
+ /** Optional. Routing configuration. */
2697
+ routingConfig?: GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfig;
2698
+ /** Optional. Seed. */
2699
+ seed?: number;
2550
2700
  /** Optional. Stop sequences. */
2551
2701
  stopSequences?: string[];
2552
2702
  /** Optional. Controls the randomness of predictions. */
@@ -2556,6 +2706,20 @@ declare namespace gapi.client {
2556
2706
  /** Optional. If specified, nucleus sampling will be used. */
2557
2707
  topP?: number;
2558
2708
  }
2709
+ interface GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfig {
2710
+ /** Automated routing. */
2711
+ autoMode?: GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigAutoRoutingMode;
2712
+ /** Manual routing. */
2713
+ manualMode?: GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigManualRoutingMode;
2714
+ }
2715
+ interface GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigAutoRoutingMode {
2716
+ /** The model routing preference. */
2717
+ modelRoutingPreference?: string;
2718
+ }
2719
+ interface GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigManualRoutingMode {
2720
+ /** The model name to use. Only the public LLM models are accepted. e.g. gemini-1.5-pro-001. */
2721
+ modelName?: string;
2722
+ }
2559
2723
  interface GoogleCloudAiplatformV1beta1GenericOperationMetadata {
2560
2724
  /** Output only. Time when the operation was created. */
2561
2725
  createTime?: string;
@@ -2662,6 +2826,10 @@ declare namespace gapi.client {
2662
2826
  name?: string;
2663
2827
  /** Required. The desired number of Trials to run in parallel. */
2664
2828
  parallelTrialCount?: number;
2829
+ /** Output only. Reserved for future use. */
2830
+ satisfiesPzi?: boolean;
2831
+ /** Output only. Reserved for future use. */
2832
+ satisfiesPzs?: boolean;
2665
2833
  /** Output only. Time when the HyperparameterTuningJob for the first time entered the `JOB_STATE_RUNNING` state. */
2666
2834
  startTime?: string;
2667
2835
  /** Output only. The detailed state of the job. */
@@ -2768,6 +2936,8 @@ declare namespace gapi.client {
2768
2936
  maxEmbeddingRequestsPerMin?: number;
2769
2937
  /** Specifies the size and overlap of chunks after importing RagFiles. */
2770
2938
  ragFileChunkingConfig?: GoogleCloudAiplatformV1beta1RagFileChunkingConfig;
2939
+ /** Specifies the parsing config for RagFiles. */
2940
+ ragFileParsingConfig?: GoogleCloudAiplatformV1beta1RagFileParsingConfig;
2771
2941
  /** Slack channels with their corresponding access tokens. */
2772
2942
  slackSource?: GoogleCloudAiplatformV1beta1SlackSource;
2773
2943
  }
@@ -2800,6 +2970,10 @@ declare namespace gapi.client {
2800
2970
  metadataSchemaUri?: string;
2801
2971
  /** Output only. The resource name of the Index. */
2802
2972
  name?: string;
2973
+ /** Output only. Reserved for future use. */
2974
+ satisfiesPzi?: boolean;
2975
+ /** Output only. Reserved for future use. */
2976
+ satisfiesPzs?: boolean;
2803
2977
  /** Output only. Timestamp when this Index was most recently updated. This also includes any update to the contents of the Index. Note that Operations working on this Index may have their Operations.metadata.generic_metadata.update_time a little after the value of this timestamp, yet that does not mean their results are not already reflected in the Index. Result of any successfully completed Operation on the Index is reflected in it. */
2804
2978
  updateTime?: string;
2805
2979
  }
@@ -2874,6 +3048,10 @@ declare namespace gapi.client {
2874
3048
  publicEndpointDomainName?: string;
2875
3049
  /** Optional. If true, the deployed index will be accessible through public endpoint. */
2876
3050
  publicEndpointEnabled?: boolean;
3051
+ /** Output only. Reserved for future use. */
3052
+ satisfiesPzi?: boolean;
3053
+ /** Output only. Reserved for future use. */
3054
+ satisfiesPzs?: boolean;
2877
3055
  /** Output only. Timestamp when this IndexEndpoint was last updated. This timestamp is not updated when the endpoint's DeployedIndexes are updated, e.g. due to updates of the original Indexes they are the deployments of. */
2878
3056
  updateTime?: string;
2879
3057
  }
@@ -3310,6 +3488,8 @@ declare namespace gapi.client {
3310
3488
  acceleratorType?: string;
3311
3489
  /** Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. */
3312
3490
  machineType?: string;
3491
+ /** Optional. Immutable. Configuration controlling how this resource pool consumes reservation. */
3492
+ reservationAffinity?: GoogleCloudAiplatformV1beta1ReservationAffinity;
3313
3493
  /** Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1"). */
3314
3494
  tpuTopology?: string;
3315
3495
  }
@@ -3614,6 +3794,10 @@ declare namespace gapi.client {
3614
3794
  predictInstanceSchemaUri?: string;
3615
3795
  /** Sample Predict instance, same format as PredictRequest.instances, this can be set as a replacement of ModelDeploymentMonitoringJob.predict_instance_schema_uri. If not set, we will generate predict schema from collected predict requests. */
3616
3796
  samplePredictInstance?: any;
3797
+ /** Output only. Reserved for future use. */
3798
+ satisfiesPzi?: boolean;
3799
+ /** Output only. Reserved for future use. */
3800
+ satisfiesPzs?: boolean;
3617
3801
  /** Output only. Schedule state when the monitoring job is in Running state. */
3618
3802
  scheduleState?: string;
3619
3803
  /** Output only. The detailed state of the monitoring job. When the job is still creating, the state will be 'PENDING'. Once the job is successfully created, the state will be 'RUNNING'. Pause the job, the state will be 'PAUSED'. Resume the job, the state will return to 'RUNNING'. */
@@ -4184,6 +4368,10 @@ declare namespace gapi.client {
4184
4368
  nasJobOutput?: GoogleCloudAiplatformV1beta1NasJobOutput;
4185
4369
  /** Required. The specification of a NasJob. */
4186
4370
  nasJobSpec?: GoogleCloudAiplatformV1beta1NasJobSpec;
4371
+ /** Output only. Reserved for future use. */
4372
+ satisfiesPzi?: boolean;
4373
+ /** Output only. Reserved for future use. */
4374
+ satisfiesPzs?: boolean;
4187
4375
  /** Output only. Time when the NasJob for the first time entered the `JOB_STATE_RUNNING` state. */
4188
4376
  startTime?: string;
4189
4377
  /** Output only. The detailed state of the job. */
@@ -4392,6 +4580,8 @@ declare namespace gapi.client {
4392
4580
  directNotebookSource?: GoogleCloudAiplatformV1beta1NotebookExecutionJobDirectNotebookSource;
4393
4581
  /** The display name of the NotebookExecutionJob. The name can be up to 128 characters long and can consist of any UTF-8 characters. */
4394
4582
  displayName?: string;
4583
+ /** Customer-managed encryption key spec for the notebook execution job. This field is auto-populated if the NotebookRuntimeTemplate has an encryption spec. */
4584
+ encryptionSpec?: GoogleCloudAiplatformV1beta1EncryptionSpec;
4395
4585
  /** Max running time of the execution job in seconds (default 86400s / 24 hrs). */
4396
4586
  executionTimeout?: string;
4397
4587
  /** The user email to run the execution as. Only supported by Colab runtimes. */
@@ -4525,6 +4715,26 @@ declare namespace gapi.client {
4525
4715
  /** Immutable. A resource name of the NotebookRuntimeTemplate. */
4526
4716
  notebookRuntimeTemplate?: string;
4527
4717
  }
4718
+ interface GoogleCloudAiplatformV1beta1PairwiseMetricInput {
4719
+ /** Required. Pairwise metric instance. */
4720
+ instance?: GoogleCloudAiplatformV1beta1PairwiseMetricInstance;
4721
+ /** Required. Spec for pairwise metric. */
4722
+ metricSpec?: GoogleCloudAiplatformV1beta1PairwiseMetricSpec;
4723
+ }
4724
+ interface GoogleCloudAiplatformV1beta1PairwiseMetricInstance {
4725
+ /** Instance specified as a json string. String key-value pairs are expected in the json_instance to render PairwiseMetricSpec.instance_prompt_template. */
4726
+ jsonInstance?: string;
4727
+ }
4728
+ interface GoogleCloudAiplatformV1beta1PairwiseMetricResult {
4729
+ /** Output only. Explanation for pairwise metric score. */
4730
+ explanation?: string;
4731
+ /** Output only. Pairwise metric choice. */
4732
+ pairwiseChoice?: string;
4733
+ }
4734
+ interface GoogleCloudAiplatformV1beta1PairwiseMetricSpec {
4735
+ /** Required. Metric prompt template for pairwise metric. */
4736
+ metricPromptTemplate?: string;
4737
+ }
4528
4738
  interface GoogleCloudAiplatformV1beta1PairwiseQuestionAnsweringQualityInput {
4529
4739
  /** Required. Pairwise question answering quality instance. */
4530
4740
  instance?: GoogleCloudAiplatformV1beta1PairwiseQuestionAnsweringQualityInstance;
@@ -4785,6 +4995,26 @@ declare namespace gapi.client {
4785
4995
  /** The version_name in artifact registry. Will always be presented in output if the PipelineJob.template_uri is from supported template registry. Format is "sha256:abcdef123456...". */
4786
4996
  version?: string;
4787
4997
  }
4998
+ interface GoogleCloudAiplatformV1beta1PointwiseMetricInput {
4999
+ /** Required. Pointwise metric instance. */
5000
+ instance?: GoogleCloudAiplatformV1beta1PointwiseMetricInstance;
5001
+ /** Required. Spec for pointwise metric. */
5002
+ metricSpec?: GoogleCloudAiplatformV1beta1PointwiseMetricSpec;
5003
+ }
5004
+ interface GoogleCloudAiplatformV1beta1PointwiseMetricInstance {
5005
+ /** Instance specified as a json string. String key-value pairs are expected in the json_instance to render PointwiseMetricSpec.instance_prompt_template. */
5006
+ jsonInstance?: string;
5007
+ }
5008
+ interface GoogleCloudAiplatformV1beta1PointwiseMetricResult {
5009
+ /** Output only. Explanation for pointwise metric score. */
5010
+ explanation?: string;
5011
+ /** Output only. Pointwise metric score. */
5012
+ score?: number;
5013
+ }
5014
+ interface GoogleCloudAiplatformV1beta1PointwiseMetricSpec {
5015
+ /** Required. Metric prompt template for pointwise metric. */
5016
+ metricPromptTemplate?: string;
5017
+ }
4788
5018
  interface GoogleCloudAiplatformV1beta1Port {
4789
5019
  /** The number of the port to expose on the pod's IP address. Must be a valid port number, between 1 and 65535 inclusive. */
4790
5020
  containerPort?: number;
@@ -4793,6 +5023,11 @@ declare namespace gapi.client {
4793
5023
  /** Required. The key is a name of one of the Dataset's data columns. The value of the key (either the label's value or value in the column) must be one of {`training`, `validation`, `test`}, and it defines to which set the given piece of data is assigned. If for a piece of data the key is not present or has an invalid value, that piece is ignored by the pipeline. */
4794
5024
  key?: string;
4795
5025
  }
5026
+ interface GoogleCloudAiplatformV1beta1PredictLongRunningMetadata {}
5027
+ interface GoogleCloudAiplatformV1beta1PredictLongRunningResponse {
5028
+ /** The response of the video generation prediction. */
5029
+ generateVideoResponse?: GoogleCloudAiplatformV1beta1GenerateVideoResponse;
5030
+ }
4796
5031
  interface GoogleCloudAiplatformV1beta1PredictRequest {
4797
5032
  /** Required. The instances that are the input to the prediction call. A DeployedModel may have an upper limit on the number of instances it supports per request, and when it is exceeded the prediction call errors in case of AutoML Models, or, in case of customer created Models, the behaviour is as documented by that Model. The schema of any single instance may be specified via Endpoint's DeployedModels' Model's PredictSchemata's instance_schema_uri. */
4798
5033
  instances?: any[];
@@ -4850,6 +5085,8 @@ declare namespace gapi.client {
4850
5085
  enablePrivateServiceConnect?: boolean;
4851
5086
  /** A list of Projects from which the forwarding rule will target the service attachment. */
4852
5087
  projectAllowlist?: string[];
5088
+ /** Output only. The name of the generated service attachment resource. This is only populated if the endpoint is deployed with PrivateServiceConnect. */
5089
+ serviceAttachment?: string;
4853
5090
  }
4854
5091
  interface GoogleCloudAiplatformV1beta1Probe {
4855
5092
  /** ExecAction probes the health of a container by executing a command. */
@@ -4952,6 +5189,8 @@ declare namespace gapi.client {
4952
5189
  interface GoogleCloudAiplatformV1beta1PublisherModelCallToActionDeployDeployMetadata {
4953
5190
  /** Optional. Labels for the deployment. For managing deployment config like verifying, source of deployment config, etc. */
4954
5191
  labels?: {[P in string]: string};
5192
+ /** Optional. Sample request for deployed endpoint. */
5193
+ sampleRequest?: string;
4955
5194
  }
4956
5195
  interface GoogleCloudAiplatformV1beta1PublisherModelCallToActionDeployGke {
4957
5196
  /** Optional. GKE deployment configuration in yaml format. */
@@ -5222,10 +5461,12 @@ declare namespace gapi.client {
5222
5461
  contexts?: GoogleCloudAiplatformV1beta1RagContextsContext[];
5223
5462
  }
5224
5463
  interface GoogleCloudAiplatformV1beta1RagContextsContext {
5225
- /** The distance between the query vector and the context text vector. */
5464
+ /** The distance between the query dense embedding vector and the context text vector. */
5226
5465
  distance?: number;
5227
5466
  /** For vertex RagStore, if the file is imported from Cloud Storage or Google Drive, source_uri will be original file URI in Cloud Storage or Google Drive; if file is uploaded, source_uri will be file display name. */
5228
5467
  sourceUri?: string;
5468
+ /** The distance between the query sparse embedding vector and the context text vector. */
5469
+ sparseDistance?: number;
5229
5470
  /** The text chunk. */
5230
5471
  text?: string;
5231
5472
  }
@@ -5244,9 +5485,29 @@ declare namespace gapi.client {
5244
5485
  updateTime?: string;
5245
5486
  }
5246
5487
  interface GoogleCloudAiplatformV1beta1RagEmbeddingModelConfig {
5247
- /** The Vertex AI Prediction Endpoint that either refers to a publisher model or an endpoint that is hosting a 1P fine-tuned text embedding model. Endpoints hosting non-1P fine-tuned text embedding models are currently not supported. */
5488
+ /** Configuration for hybrid search. */
5489
+ hybridSearchConfig?: GoogleCloudAiplatformV1beta1RagEmbeddingModelConfigHybridSearchConfig;
5490
+ /** The Vertex AI Prediction Endpoint that either refers to a publisher model or an endpoint that is hosting a 1P fine-tuned text embedding model. Endpoints hosting non-1P fine-tuned text embedding models are currently not supported. This is used for dense vector search. */
5248
5491
  vertexPredictionEndpoint?: GoogleCloudAiplatformV1beta1RagEmbeddingModelConfigVertexPredictionEndpoint;
5249
5492
  }
5493
+ interface GoogleCloudAiplatformV1beta1RagEmbeddingModelConfigHybridSearchConfig {
5494
+ /** Required. The Vertex AI Prediction Endpoint that hosts the embedding model for dense embedding generations. */
5495
+ denseEmbeddingModelPredictionEndpoint?: GoogleCloudAiplatformV1beta1RagEmbeddingModelConfigVertexPredictionEndpoint;
5496
+ /** Optional. The configuration for sparse embedding generation. This field is optional the default behavior depends on the vector database choice on the RagCorpus. */
5497
+ sparseEmbeddingConfig?: GoogleCloudAiplatformV1beta1RagEmbeddingModelConfigSparseEmbeddingConfig;
5498
+ }
5499
+ interface GoogleCloudAiplatformV1beta1RagEmbeddingModelConfigSparseEmbeddingConfig {
5500
+ /** Use BM25 scoring algorithm. */
5501
+ bm25?: GoogleCloudAiplatformV1beta1RagEmbeddingModelConfigSparseEmbeddingConfigBm25;
5502
+ }
5503
+ interface GoogleCloudAiplatformV1beta1RagEmbeddingModelConfigSparseEmbeddingConfigBm25 {
5504
+ /** Optional. The parameter to control document length normalization. It determines how much the document length affects the final score. b is in the range of [0, 1]. The default value is 0.75. */
5505
+ b?: number;
5506
+ /** Optional. The parameter to control term frequency saturation. It determines the scaling between the matching term frequency and final score. k1 is in the range of [1.2, 3]. The default value is 1.2. */
5507
+ k1?: number;
5508
+ /** Optional. Use multilingual tokenizer if set to true. */
5509
+ multilingual?: boolean;
5510
+ }
5250
5511
  interface GoogleCloudAiplatformV1beta1RagEmbeddingModelConfigVertexPredictionEndpoint {
5251
5512
  /** Required. The endpoint resource name. Format: `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}` or `projects/{project}/locations/{location}/endpoints/{endpoint}` */
5252
5513
  endpoint?: string;
@@ -5287,6 +5548,12 @@ declare namespace gapi.client {
5287
5548
  /** The size of the chunks. */
5288
5549
  chunkSize?: number;
5289
5550
  }
5551
+ interface GoogleCloudAiplatformV1beta1RagFileParsingConfig {
5552
+ /** Whether to use OCR for PDFs. */
5553
+ parsePdfsUsingOcr?: boolean;
5554
+ /** Whether to use advanced PDF parsing. */
5555
+ useAdvancedPdfParsing?: boolean;
5556
+ }
5290
5557
  interface GoogleCloudAiplatformV1beta1RagQuery {
5291
5558
  /** Optional. The number of contexts to retrieve. */
5292
5559
  similarityTopK?: number;
@@ -5463,6 +5730,14 @@ declare namespace gapi.client {
5463
5730
  /** If the idle shutdown is blocked by CP, CP will send the block message. Otherwise, this field is not set. */
5464
5731
  idleShutdownMessage?: string;
5465
5732
  }
5733
+ interface GoogleCloudAiplatformV1beta1ReservationAffinity {
5734
+ /** Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. */
5735
+ key?: string;
5736
+ /** Required. Specifies the reservation affinity type. */
5737
+ reservationAffinityType?: string;
5738
+ /** Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation. */
5739
+ values?: string[];
5740
+ }
5466
5741
  interface GoogleCloudAiplatformV1beta1ResourcePool {
5467
5742
  /** Optional. Optional spec to configure GKE or Ray-on-Vertex autoscaling */
5468
5743
  autoscalingSpec?: GoogleCloudAiplatformV1beta1ResourcePoolAutoscalingSpec;
@@ -5527,6 +5802,8 @@ declare namespace gapi.client {
5527
5802
  ragCorpora?: string[];
5528
5803
  /** 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. */
5529
5804
  ragResources?: GoogleCloudAiplatformV1beta1RetrieveContextsRequestVertexRagStoreRagResource[];
5805
+ /** Optional. Configurations for hybrid search results ranking. */
5806
+ ranking?: GoogleCloudAiplatformV1beta1RetrieveContextsRequestVertexRagStoreRanking;
5530
5807
  /** Optional. Only return contexts with vector distance smaller than the threshold. */
5531
5808
  vectorDistanceThreshold?: number;
5532
5809
  }
@@ -5536,6 +5813,10 @@ declare namespace gapi.client {
5536
5813
  /** Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. */
5537
5814
  ragFileIds?: string[];
5538
5815
  }
5816
+ interface GoogleCloudAiplatformV1beta1RetrieveContextsRequestVertexRagStoreRanking {
5817
+ /** Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally. */
5818
+ alpha?: number;
5819
+ }
5539
5820
  interface GoogleCloudAiplatformV1beta1RetrieveContextsResponse {
5540
5821
  /** The contexts of the query. */
5541
5822
  contexts?: GoogleCloudAiplatformV1beta1RagContexts;
@@ -8044,6 +8325,8 @@ declare namespace gapi.client {
8044
8325
  model?: string;
8045
8326
  }
8046
8327
  interface GoogleCloudAiplatformV1beta1TuningDataStats {
8328
+ /** Output only. Statistics for distillation. */
8329
+ distillationDataStats?: GoogleCloudAiplatformV1beta1DistillationDataStats;
8047
8330
  /** The SFT Tuning data stats. */
8048
8331
  supervisedTuningDataStats?: GoogleCloudAiplatformV1beta1SupervisedTuningDataStats;
8049
8332
  }
@@ -8054,6 +8337,8 @@ declare namespace gapi.client {
8054
8337
  createTime?: string;
8055
8338
  /** Optional. The description of the TuningJob. */
8056
8339
  description?: string;
8340
+ /** Tuning Spec for Distillation. */
8341
+ distillationSpec?: GoogleCloudAiplatformV1beta1DistillationSpec;
8057
8342
  /** Customer-managed encryption key options for a TuningJob. If this is set, then all resources created by the TuningJob will be encrypted with the provided encryption key. */
8058
8343
  encryptionSpec?: GoogleCloudAiplatformV1beta1EncryptionSpec;
8059
8344
  /** Output only. Time when the TuningJob entered any of the following JobStates: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`, `JOB_STATE_EXPIRED`. */
@@ -8066,6 +8351,8 @@ declare namespace gapi.client {
8066
8351
  labels?: {[P in string]: string};
8067
8352
  /** Output only. Identifier. Resource name of a TuningJob. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}` */
8068
8353
  name?: string;
8354
+ /** Output only. The resource name of the PipelineJob associated with the TuningJob. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`. */
8355
+ pipelineJob?: string;
8069
8356
  /** Output only. Time when the TuningJob for the first time entered the `JOB_STATE_RUNNING` state. */
8070
8357
  startTime?: string;
8071
8358
  /** Output only. The detailed state of the job. */
@@ -32685,6 +32972,8 @@ declare namespace gapi.client {
32685
32972
  callback?: string;
32686
32973
  /** Selector specifying which fields to include in a partial response. */
32687
32974
  fields?: string;
32975
+ /** Optional. Token used to access Hugging Face gated models. */
32976
+ huggingFaceToken?: string;
32688
32977
  /** Optional. Boolean indicates whether the requested model is a Hugging Face model. */
32689
32978
  isHuggingFaceModel?: boolean;
32690
32979
  /** 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. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.aiplatform-v1beta1",
3
- "version": "0.0.20240725",
3
+ "version": "0.0.20240809",
4
4
  "description": "TypeScript typings for Vertex AI API v1beta1",
5
5
  "repository": {
6
6
  "type": "git",