@maxim_mazurok/gapi.client.aiplatform-v1 0.0.20240727 → 0.0.20240814
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 +94 -2
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
10
10
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
11
11
|
// Generated from: https://aiplatform.googleapis.com/$discovery/rest?version=v1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20240814
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -534,6 +534,8 @@ declare namespace gapi.client {
|
|
|
534
534
|
interface GoogleCloudAiplatformV1CancelTrainingPipelineRequest {}
|
|
535
535
|
interface GoogleCloudAiplatformV1CancelTuningJobRequest {}
|
|
536
536
|
interface GoogleCloudAiplatformV1Candidate {
|
|
537
|
+
/** Output only. Average log probability score of the candidate. */
|
|
538
|
+
avgLogprobs?: number;
|
|
537
539
|
/** Output only. Source attribution of the generated content. */
|
|
538
540
|
citationMetadata?: GoogleCloudAiplatformV1CitationMetadata;
|
|
539
541
|
/** Output only. Content parts of the candidate. */
|
|
@@ -1313,6 +1315,10 @@ declare namespace gapi.client {
|
|
|
1313
1315
|
name?: string;
|
|
1314
1316
|
/** 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. */
|
|
1315
1317
|
offlineStorageTtlDays?: number;
|
|
1318
|
+
/** Output only. Reserved for future use. */
|
|
1319
|
+
satisfiesPzi?: boolean;
|
|
1320
|
+
/** Output only. Reserved for future use. */
|
|
1321
|
+
satisfiesPzs?: boolean;
|
|
1316
1322
|
/** Output only. Timestamp when this EntityType was most recently updated. */
|
|
1317
1323
|
updateTime?: string;
|
|
1318
1324
|
}
|
|
@@ -1373,10 +1379,14 @@ declare namespace gapi.client {
|
|
|
1373
1379
|
fulfillmentInput?: GoogleCloudAiplatformV1FulfillmentInput;
|
|
1374
1380
|
/** Input for groundedness metric. */
|
|
1375
1381
|
groundednessInput?: GoogleCloudAiplatformV1GroundednessInput;
|
|
1382
|
+
/** Input for pairwise metric. */
|
|
1383
|
+
pairwiseMetricInput?: GoogleCloudAiplatformV1PairwiseMetricInput;
|
|
1376
1384
|
/** Input for pairwise question answering quality metric. */
|
|
1377
1385
|
pairwiseQuestionAnsweringQualityInput?: GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityInput;
|
|
1378
1386
|
/** Input for pairwise summarization quality metric. */
|
|
1379
1387
|
pairwiseSummarizationQualityInput?: GoogleCloudAiplatformV1PairwiseSummarizationQualityInput;
|
|
1388
|
+
/** Input for pointwise metric. */
|
|
1389
|
+
pointwiseMetricInput?: GoogleCloudAiplatformV1PointwiseMetricInput;
|
|
1380
1390
|
/** Input for question answering correctness metric. */
|
|
1381
1391
|
questionAnsweringCorrectnessInput?: GoogleCloudAiplatformV1QuestionAnsweringCorrectnessInput;
|
|
1382
1392
|
/** Input for question answering helpfulness metric. */
|
|
@@ -1417,10 +1427,14 @@ declare namespace gapi.client {
|
|
|
1417
1427
|
fulfillmentResult?: GoogleCloudAiplatformV1FulfillmentResult;
|
|
1418
1428
|
/** Result for groundedness metric. */
|
|
1419
1429
|
groundednessResult?: GoogleCloudAiplatformV1GroundednessResult;
|
|
1430
|
+
/** Result for pairwise metric. */
|
|
1431
|
+
pairwiseMetricResult?: GoogleCloudAiplatformV1PairwiseMetricResult;
|
|
1420
1432
|
/** Result for pairwise question answering quality metric. */
|
|
1421
1433
|
pairwiseQuestionAnsweringQualityResult?: GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityResult;
|
|
1422
1434
|
/** Result for pairwise summarization quality metric. */
|
|
1423
1435
|
pairwiseSummarizationQualityResult?: GoogleCloudAiplatformV1PairwiseSummarizationQualityResult;
|
|
1436
|
+
/** Generic metrics. Result for pointwise metric. */
|
|
1437
|
+
pointwiseMetricResult?: GoogleCloudAiplatformV1PointwiseMetricResult;
|
|
1424
1438
|
/** Result for question answering correctness metric. */
|
|
1425
1439
|
questionAnsweringCorrectnessResult?: GoogleCloudAiplatformV1QuestionAnsweringCorrectnessResult;
|
|
1426
1440
|
/** Result for question answering helpfulness metric. */
|
|
@@ -1838,6 +1852,12 @@ declare namespace gapi.client {
|
|
|
1838
1852
|
bigQuerySource?: GoogleCloudAiplatformV1BigQuerySource;
|
|
1839
1853
|
/** Optional. Columns to construct entity_id / row keys. If not provided defaults to `entity_id`. */
|
|
1840
1854
|
entityIdColumns?: string[];
|
|
1855
|
+
/** 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. */
|
|
1856
|
+
timeSeries?: GoogleCloudAiplatformV1FeatureGroupBigQueryTimeSeries;
|
|
1857
|
+
}
|
|
1858
|
+
interface GoogleCloudAiplatformV1FeatureGroupBigQueryTimeSeries {
|
|
1859
|
+
/** 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. */
|
|
1860
|
+
timestampColumn?: string;
|
|
1841
1861
|
}
|
|
1842
1862
|
interface GoogleCloudAiplatformV1FeatureMonitoringStatsAnomaly {
|
|
1843
1863
|
/** Output only. The stats and anomalies generated at specific timestamp. */
|
|
@@ -1872,6 +1892,10 @@ declare namespace gapi.client {
|
|
|
1872
1892
|
name?: string;
|
|
1873
1893
|
/** 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. */
|
|
1874
1894
|
optimized?: any;
|
|
1895
|
+
/** Output only. Reserved for future use. */
|
|
1896
|
+
satisfiesPzi?: boolean;
|
|
1897
|
+
/** Output only. Reserved for future use. */
|
|
1898
|
+
satisfiesPzs?: boolean;
|
|
1875
1899
|
/** Output only. State of the featureOnlineStore. */
|
|
1876
1900
|
state?: string;
|
|
1877
1901
|
/** Output only. Timestamp when this FeatureOnlineStore was last updated. */
|
|
@@ -1933,6 +1957,10 @@ declare namespace gapi.client {
|
|
|
1933
1957
|
onlineServingConfig?: GoogleCloudAiplatformV1FeaturestoreOnlineServingConfig;
|
|
1934
1958
|
/** 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 */
|
|
1935
1959
|
onlineStorageTtlDays?: number;
|
|
1960
|
+
/** Output only. Reserved for future use. */
|
|
1961
|
+
satisfiesPzi?: boolean;
|
|
1962
|
+
/** Output only. Reserved for future use. */
|
|
1963
|
+
satisfiesPzs?: boolean;
|
|
1936
1964
|
/** Output only. State of the featurestore. */
|
|
1937
1965
|
state?: string;
|
|
1938
1966
|
/** Output only. Timestamp when this Featurestore was last updated. */
|
|
@@ -2035,6 +2063,10 @@ declare namespace gapi.client {
|
|
|
2035
2063
|
labels?: {[P in string]: string};
|
|
2036
2064
|
/** Identifier. Name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}` */
|
|
2037
2065
|
name?: string;
|
|
2066
|
+
/** Output only. Reserved for future use. */
|
|
2067
|
+
satisfiesPzi?: boolean;
|
|
2068
|
+
/** Output only. Reserved for future use. */
|
|
2069
|
+
satisfiesPzs?: boolean;
|
|
2038
2070
|
/** Configures when data is to be synced/updated for this FeatureView. At the end of the sync the latest featureValues for each entityId of this FeatureView are made ready for online serving. */
|
|
2039
2071
|
syncConfig?: GoogleCloudAiplatformV1FeatureViewSyncConfig;
|
|
2040
2072
|
/** Output only. Timestamp when this FeatureView was last updated. */
|
|
@@ -2098,6 +2130,10 @@ declare namespace gapi.client {
|
|
|
2098
2130
|
name?: string;
|
|
2099
2131
|
/** Output only. Time when this FeatureViewSync is finished. */
|
|
2100
2132
|
runTime?: GoogleTypeInterval;
|
|
2133
|
+
/** Output only. Reserved for future use. */
|
|
2134
|
+
satisfiesPzi?: boolean;
|
|
2135
|
+
/** Output only. Reserved for future use. */
|
|
2136
|
+
satisfiesPzs?: boolean;
|
|
2101
2137
|
/** Output only. Summary of the sync job. */
|
|
2102
2138
|
syncSummary?: GoogleCloudAiplatformV1FeatureViewSyncSyncSummary;
|
|
2103
2139
|
}
|
|
@@ -2314,7 +2350,7 @@ declare namespace gapi.client {
|
|
|
2314
2350
|
interface GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata {
|
|
2315
2351
|
/** Number of tokens in the response(s). */
|
|
2316
2352
|
candidatesTokenCount?: number;
|
|
2317
|
-
/** Number of tokens in the request. */
|
|
2353
|
+
/** 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. */
|
|
2318
2354
|
promptTokenCount?: number;
|
|
2319
2355
|
totalTokenCount?: number;
|
|
2320
2356
|
}
|
|
@@ -2333,6 +2369,8 @@ declare namespace gapi.client {
|
|
|
2333
2369
|
responseSchema?: GoogleCloudAiplatformV1Schema;
|
|
2334
2370
|
/** Optional. Routing configuration. */
|
|
2335
2371
|
routingConfig?: GoogleCloudAiplatformV1GenerationConfigRoutingConfig;
|
|
2372
|
+
/** Optional. Seed. */
|
|
2373
|
+
seed?: number;
|
|
2336
2374
|
/** Optional. Stop sequences. */
|
|
2337
2375
|
stopSequences?: string[];
|
|
2338
2376
|
/** Optional. Controls the randomness of predictions. */
|
|
@@ -2570,6 +2608,10 @@ declare namespace gapi.client {
|
|
|
2570
2608
|
metadataSchemaUri?: string;
|
|
2571
2609
|
/** Output only. The resource name of the Index. */
|
|
2572
2610
|
name?: string;
|
|
2611
|
+
/** Output only. Reserved for future use. */
|
|
2612
|
+
satisfiesPzi?: boolean;
|
|
2613
|
+
/** Output only. Reserved for future use. */
|
|
2614
|
+
satisfiesPzs?: boolean;
|
|
2573
2615
|
/** 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. */
|
|
2574
2616
|
updateTime?: string;
|
|
2575
2617
|
}
|
|
@@ -2644,6 +2686,10 @@ declare namespace gapi.client {
|
|
|
2644
2686
|
publicEndpointDomainName?: string;
|
|
2645
2687
|
/** Optional. If true, the deployed index will be accessible through public endpoint. */
|
|
2646
2688
|
publicEndpointEnabled?: boolean;
|
|
2689
|
+
/** Output only. Reserved for future use. */
|
|
2690
|
+
satisfiesPzi?: boolean;
|
|
2691
|
+
/** Output only. Reserved for future use. */
|
|
2692
|
+
satisfiesPzs?: boolean;
|
|
2647
2693
|
/** 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. */
|
|
2648
2694
|
updateTime?: string;
|
|
2649
2695
|
}
|
|
@@ -3334,6 +3380,10 @@ declare namespace gapi.client {
|
|
|
3334
3380
|
predictInstanceSchemaUri?: string;
|
|
3335
3381
|
/** 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. */
|
|
3336
3382
|
samplePredictInstance?: any;
|
|
3383
|
+
/** Output only. Reserved for future use. */
|
|
3384
|
+
satisfiesPzi?: boolean;
|
|
3385
|
+
/** Output only. Reserved for future use. */
|
|
3386
|
+
satisfiesPzs?: boolean;
|
|
3337
3387
|
/** Output only. Schedule state when the monitoring job is in Running state. */
|
|
3338
3388
|
scheduleState?: string;
|
|
3339
3389
|
/** 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'. */
|
|
@@ -3945,6 +3995,26 @@ declare namespace gapi.client {
|
|
|
3945
3995
|
/** Immutable. A resource name of the NotebookRuntimeTemplate. */
|
|
3946
3996
|
notebookRuntimeTemplate?: string;
|
|
3947
3997
|
}
|
|
3998
|
+
interface GoogleCloudAiplatformV1PairwiseMetricInput {
|
|
3999
|
+
/** Required. Pairwise metric instance. */
|
|
4000
|
+
instance?: GoogleCloudAiplatformV1PairwiseMetricInstance;
|
|
4001
|
+
/** Required. Spec for pairwise metric. */
|
|
4002
|
+
metricSpec?: GoogleCloudAiplatformV1PairwiseMetricSpec;
|
|
4003
|
+
}
|
|
4004
|
+
interface GoogleCloudAiplatformV1PairwiseMetricInstance {
|
|
4005
|
+
/** Instance specified as a json string. String key-value pairs are expected in the json_instance to render PairwiseMetricSpec.instance_prompt_template. */
|
|
4006
|
+
jsonInstance?: string;
|
|
4007
|
+
}
|
|
4008
|
+
interface GoogleCloudAiplatformV1PairwiseMetricResult {
|
|
4009
|
+
/** Output only. Explanation for pairwise metric score. */
|
|
4010
|
+
explanation?: string;
|
|
4011
|
+
/** Output only. Pairwise metric choice. */
|
|
4012
|
+
pairwiseChoice?: string;
|
|
4013
|
+
}
|
|
4014
|
+
interface GoogleCloudAiplatformV1PairwiseMetricSpec {
|
|
4015
|
+
/** Required. Metric prompt template for pairwise metric. */
|
|
4016
|
+
metricPromptTemplate?: string;
|
|
4017
|
+
}
|
|
3948
4018
|
interface GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityInput {
|
|
3949
4019
|
/** Required. Pairwise question answering quality instance. */
|
|
3950
4020
|
instance?: GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityInstance;
|
|
@@ -4199,6 +4269,26 @@ declare namespace gapi.client {
|
|
|
4199
4269
|
/** 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...". */
|
|
4200
4270
|
version?: string;
|
|
4201
4271
|
}
|
|
4272
|
+
interface GoogleCloudAiplatformV1PointwiseMetricInput {
|
|
4273
|
+
/** Required. Pointwise metric instance. */
|
|
4274
|
+
instance?: GoogleCloudAiplatformV1PointwiseMetricInstance;
|
|
4275
|
+
/** Required. Spec for pointwise metric. */
|
|
4276
|
+
metricSpec?: GoogleCloudAiplatformV1PointwiseMetricSpec;
|
|
4277
|
+
}
|
|
4278
|
+
interface GoogleCloudAiplatformV1PointwiseMetricInstance {
|
|
4279
|
+
/** Instance specified as a json string. String key-value pairs are expected in the json_instance to render PointwiseMetricSpec.instance_prompt_template. */
|
|
4280
|
+
jsonInstance?: string;
|
|
4281
|
+
}
|
|
4282
|
+
interface GoogleCloudAiplatformV1PointwiseMetricResult {
|
|
4283
|
+
/** Output only. Explanation for pointwise metric score. */
|
|
4284
|
+
explanation?: string;
|
|
4285
|
+
/** Output only. Pointwise metric score. */
|
|
4286
|
+
score?: number;
|
|
4287
|
+
}
|
|
4288
|
+
interface GoogleCloudAiplatformV1PointwiseMetricSpec {
|
|
4289
|
+
/** Required. Metric prompt template for pointwise metric. */
|
|
4290
|
+
metricPromptTemplate?: string;
|
|
4291
|
+
}
|
|
4202
4292
|
interface GoogleCloudAiplatformV1Port {
|
|
4203
4293
|
/** The number of the port to expose on the pod's IP address. Must be a valid port number, between 1 and 65535 inclusive. */
|
|
4204
4294
|
containerPort?: number;
|
|
@@ -27734,6 +27824,8 @@ declare namespace gapi.client {
|
|
|
27734
27824
|
callback?: string;
|
|
27735
27825
|
/** Selector specifying which fields to include in a partial response. */
|
|
27736
27826
|
fields?: string;
|
|
27827
|
+
/** Optional. Token used to access Hugging Face gated models. */
|
|
27828
|
+
huggingFaceToken?: string;
|
|
27737
27829
|
/** Optional. Boolean indicates whether the requested model is a Hugging Face model. */
|
|
27738
27830
|
isHuggingFaceModel?: boolean;
|
|
27739
27831
|
/** 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. */
|