@maxim_mazurok/gapi.client.aiplatform-v1beta1 0.0.20240727 → 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 +102 -2
  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: 20240727
12
+ // Revision: 20240809
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -628,6 +628,8 @@ declare namespace gapi.client {
628
628
  interface GoogleCloudAiplatformV1beta1CancelTrainingPipelineRequest {}
629
629
  interface GoogleCloudAiplatformV1beta1CancelTuningJobRequest {}
630
630
  interface GoogleCloudAiplatformV1beta1Candidate {
631
+ /** Output only. Average log probability score of the candidate. */
632
+ avgLogprobs?: number;
631
633
  /** Output only. Source attribution of the generated content. */
632
634
  citationMetadata?: GoogleCloudAiplatformV1beta1CitationMetadata;
633
635
  /** Output only. Content parts of the candidate. */
@@ -1512,6 +1514,10 @@ declare namespace gapi.client {
1512
1514
  name?: string;
1513
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. */
1514
1516
  offlineStorageTtlDays?: number;
1517
+ /** Output only. Reserved for future use. */
1518
+ satisfiesPzi?: boolean;
1519
+ /** Output only. Reserved for future use. */
1520
+ satisfiesPzs?: boolean;
1515
1521
  /** Output only. Timestamp when this EntityType was most recently updated. */
1516
1522
  updateTime?: string;
1517
1523
  }
@@ -1572,10 +1578,14 @@ declare namespace gapi.client {
1572
1578
  fulfillmentInput?: GoogleCloudAiplatformV1beta1FulfillmentInput;
1573
1579
  /** Input for groundedness metric. */
1574
1580
  groundednessInput?: GoogleCloudAiplatformV1beta1GroundednessInput;
1581
+ /** Input for pairwise metric. */
1582
+ pairwiseMetricInput?: GoogleCloudAiplatformV1beta1PairwiseMetricInput;
1575
1583
  /** Input for pairwise question answering quality metric. */
1576
1584
  pairwiseQuestionAnsweringQualityInput?: GoogleCloudAiplatformV1beta1PairwiseQuestionAnsweringQualityInput;
1577
1585
  /** Input for pairwise summarization quality metric. */
1578
1586
  pairwiseSummarizationQualityInput?: GoogleCloudAiplatformV1beta1PairwiseSummarizationQualityInput;
1587
+ /** Input for pointwise metric. */
1588
+ pointwiseMetricInput?: GoogleCloudAiplatformV1beta1PointwiseMetricInput;
1579
1589
  /** Input for question answering correctness metric. */
1580
1590
  questionAnsweringCorrectnessInput?: GoogleCloudAiplatformV1beta1QuestionAnsweringCorrectnessInput;
1581
1591
  /** Input for question answering helpfulness metric. */
@@ -1616,10 +1626,14 @@ declare namespace gapi.client {
1616
1626
  fulfillmentResult?: GoogleCloudAiplatformV1beta1FulfillmentResult;
1617
1627
  /** Result for groundedness metric. */
1618
1628
  groundednessResult?: GoogleCloudAiplatformV1beta1GroundednessResult;
1629
+ /** Result for pairwise metric. */
1630
+ pairwiseMetricResult?: GoogleCloudAiplatformV1beta1PairwiseMetricResult;
1619
1631
  /** Result for pairwise question answering quality metric. */
1620
1632
  pairwiseQuestionAnsweringQualityResult?: GoogleCloudAiplatformV1beta1PairwiseQuestionAnsweringQualityResult;
1621
1633
  /** Result for pairwise summarization quality metric. */
1622
1634
  pairwiseSummarizationQualityResult?: GoogleCloudAiplatformV1beta1PairwiseSummarizationQualityResult;
1635
+ /** Generic metrics. Result for pointwise metric. */
1636
+ pointwiseMetricResult?: GoogleCloudAiplatformV1beta1PointwiseMetricResult;
1623
1637
  /** Result for question answering correctness metric. */
1624
1638
  questionAnsweringCorrectnessResult?: GoogleCloudAiplatformV1beta1QuestionAnsweringCorrectnessResult;
1625
1639
  /** Result for question answering helpfulness metric. */
@@ -2099,6 +2113,12 @@ declare namespace gapi.client {
2099
2113
  bigQuerySource?: GoogleCloudAiplatformV1beta1BigQuerySource;
2100
2114
  /** Optional. Columns to construct entity_id / row keys. If not provided defaults to `entity_id`. */
2101
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;
2102
2122
  }
2103
2123
  interface GoogleCloudAiplatformV1beta1FeatureMonitoringStatsAnomaly {
2104
2124
  /** Output only. The stats and anomalies generated at specific timestamp. */
@@ -2135,6 +2155,10 @@ declare namespace gapi.client {
2135
2155
  name?: string;
2136
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. */
2137
2157
  optimized?: any;
2158
+ /** Output only. Reserved for future use. */
2159
+ satisfiesPzi?: boolean;
2160
+ /** Output only. Reserved for future use. */
2161
+ satisfiesPzs?: boolean;
2138
2162
  /** Output only. State of the featureOnlineStore. */
2139
2163
  state?: string;
2140
2164
  /** Output only. Timestamp when this FeatureOnlineStore was last updated. */
@@ -2200,6 +2224,10 @@ declare namespace gapi.client {
2200
2224
  onlineServingConfig?: GoogleCloudAiplatformV1beta1FeaturestoreOnlineServingConfig;
2201
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 */
2202
2226
  onlineStorageTtlDays?: number;
2227
+ /** Output only. Reserved for future use. */
2228
+ satisfiesPzi?: boolean;
2229
+ /** Output only. Reserved for future use. */
2230
+ satisfiesPzs?: boolean;
2203
2231
  /** Output only. State of the featurestore. */
2204
2232
  state?: string;
2205
2233
  /** Output only. Timestamp when this Featurestore was last updated. */
@@ -2304,6 +2332,10 @@ declare namespace gapi.client {
2304
2332
  labels?: {[P in string]: string};
2305
2333
  /** Identifier. Name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}` */
2306
2334
  name?: string;
2335
+ /** Output only. Reserved for future use. */
2336
+ satisfiesPzi?: boolean;
2337
+ /** Output only. Reserved for future use. */
2338
+ satisfiesPzs?: boolean;
2307
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. */
2308
2340
  serviceAccountEmail?: string;
2309
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. */
@@ -2373,6 +2405,10 @@ declare namespace gapi.client {
2373
2405
  name?: string;
2374
2406
  /** Output only. Time when this FeatureViewSync is finished. */
2375
2407
  runTime?: GoogleTypeInterval;
2408
+ /** Output only. Reserved for future use. */
2409
+ satisfiesPzi?: boolean;
2410
+ /** Output only. Reserved for future use. */
2411
+ satisfiesPzs?: boolean;
2376
2412
  /** Output only. Summary of the sync job. */
2377
2413
  syncSummary?: GoogleCloudAiplatformV1beta1FeatureViewSyncSyncSummary;
2378
2414
  }
@@ -2632,7 +2668,7 @@ declare namespace gapi.client {
2632
2668
  interface GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata {
2633
2669
  /** Number of tokens in the response(s). */
2634
2670
  candidatesTokenCount?: number;
2635
- /** 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. */
2636
2672
  promptTokenCount?: number;
2637
2673
  totalTokenCount?: number;
2638
2674
  }
@@ -2659,6 +2695,8 @@ declare namespace gapi.client {
2659
2695
  responseSchema?: GoogleCloudAiplatformV1beta1Schema;
2660
2696
  /** Optional. Routing configuration. */
2661
2697
  routingConfig?: GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfig;
2698
+ /** Optional. Seed. */
2699
+ seed?: number;
2662
2700
  /** Optional. Stop sequences. */
2663
2701
  stopSequences?: string[];
2664
2702
  /** Optional. Controls the randomness of predictions. */
@@ -2898,6 +2936,8 @@ declare namespace gapi.client {
2898
2936
  maxEmbeddingRequestsPerMin?: number;
2899
2937
  /** Specifies the size and overlap of chunks after importing RagFiles. */
2900
2938
  ragFileChunkingConfig?: GoogleCloudAiplatformV1beta1RagFileChunkingConfig;
2939
+ /** Specifies the parsing config for RagFiles. */
2940
+ ragFileParsingConfig?: GoogleCloudAiplatformV1beta1RagFileParsingConfig;
2901
2941
  /** Slack channels with their corresponding access tokens. */
2902
2942
  slackSource?: GoogleCloudAiplatformV1beta1SlackSource;
2903
2943
  }
@@ -2930,6 +2970,10 @@ declare namespace gapi.client {
2930
2970
  metadataSchemaUri?: string;
2931
2971
  /** Output only. The resource name of the Index. */
2932
2972
  name?: string;
2973
+ /** Output only. Reserved for future use. */
2974
+ satisfiesPzi?: boolean;
2975
+ /** Output only. Reserved for future use. */
2976
+ satisfiesPzs?: boolean;
2933
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. */
2934
2978
  updateTime?: string;
2935
2979
  }
@@ -3004,6 +3048,10 @@ declare namespace gapi.client {
3004
3048
  publicEndpointDomainName?: string;
3005
3049
  /** Optional. If true, the deployed index will be accessible through public endpoint. */
3006
3050
  publicEndpointEnabled?: boolean;
3051
+ /** Output only. Reserved for future use. */
3052
+ satisfiesPzi?: boolean;
3053
+ /** Output only. Reserved for future use. */
3054
+ satisfiesPzs?: boolean;
3007
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. */
3008
3056
  updateTime?: string;
3009
3057
  }
@@ -3746,6 +3794,10 @@ declare namespace gapi.client {
3746
3794
  predictInstanceSchemaUri?: string;
3747
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. */
3748
3796
  samplePredictInstance?: any;
3797
+ /** Output only. Reserved for future use. */
3798
+ satisfiesPzi?: boolean;
3799
+ /** Output only. Reserved for future use. */
3800
+ satisfiesPzs?: boolean;
3749
3801
  /** Output only. Schedule state when the monitoring job is in Running state. */
3750
3802
  scheduleState?: string;
3751
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'. */
@@ -4663,6 +4715,26 @@ declare namespace gapi.client {
4663
4715
  /** Immutable. A resource name of the NotebookRuntimeTemplate. */
4664
4716
  notebookRuntimeTemplate?: string;
4665
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
+ }
4666
4738
  interface GoogleCloudAiplatformV1beta1PairwiseQuestionAnsweringQualityInput {
4667
4739
  /** Required. Pairwise question answering quality instance. */
4668
4740
  instance?: GoogleCloudAiplatformV1beta1PairwiseQuestionAnsweringQualityInstance;
@@ -4923,6 +4995,26 @@ declare namespace gapi.client {
4923
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...". */
4924
4996
  version?: string;
4925
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
+ }
4926
5018
  interface GoogleCloudAiplatformV1beta1Port {
4927
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. */
4928
5020
  containerPort?: number;
@@ -5456,6 +5548,12 @@ declare namespace gapi.client {
5456
5548
  /** The size of the chunks. */
5457
5549
  chunkSize?: number;
5458
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
+ }
5459
5557
  interface GoogleCloudAiplatformV1beta1RagQuery {
5460
5558
  /** Optional. The number of contexts to retrieve. */
5461
5559
  similarityTopK?: number;
@@ -32874,6 +32972,8 @@ declare namespace gapi.client {
32874
32972
  callback?: string;
32875
32973
  /** Selector specifying which fields to include in a partial response. */
32876
32974
  fields?: string;
32975
+ /** Optional. Token used to access Hugging Face gated models. */
32976
+ huggingFaceToken?: string;
32877
32977
  /** Optional. Boolean indicates whether the requested model is a Hugging Face model. */
32878
32978
  isHuggingFaceModel?: boolean;
32879
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.20240727",
3
+ "version": "0.0.20240809",
4
4
  "description": "TypeScript typings for Vertex AI API v1beta1",
5
5
  "repository": {
6
6
  "type": "git",