@maxim_mazurok/gapi.client.aiplatform-v1beta1 0.0.20240816 → 0.0.20240828

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 +133 -3
  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: 20240816
12
+ // Revision: 20240828
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -198,6 +198,10 @@ declare namespace gapi.client {
198
198
  /** Output only. Timestamp when AnnotationSpec was last updated. */
199
199
  updateTime?: string;
200
200
  }
201
+ interface GoogleCloudAiplatformV1beta1ApiAuth {
202
+ /** The API secret. */
203
+ apiKeyConfig?: GoogleCloudAiplatformV1beta1ApiAuthApiKeyConfig;
204
+ }
201
205
  interface GoogleCloudAiplatformV1beta1ApiAuthApiKeyConfig {
202
206
  /** Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} */
203
207
  apiKeySecretVersion?: string;
@@ -618,6 +622,20 @@ declare namespace gapi.client {
618
622
  ttl?: string;
619
623
  /** Output only. When the cache entry was last updated in UTC time. */
620
624
  updateTime?: string;
625
+ /** Output only. Metadata on the usage of the cached content. */
626
+ usageMetadata?: GoogleCloudAiplatformV1beta1CachedContentUsageMetadata;
627
+ }
628
+ interface GoogleCloudAiplatformV1beta1CachedContentUsageMetadata {
629
+ /** Duration of audio in seconds. */
630
+ audioDurationSeconds?: number;
631
+ /** Number of images. */
632
+ imageCount?: number;
633
+ /** Number of text characters. */
634
+ textCount?: number;
635
+ /** Total number of tokens that the cached content consumes. */
636
+ totalTokenCount?: number;
637
+ /** Duration of video in seconds. */
638
+ videoDurationSeconds?: number;
621
639
  }
622
640
  interface GoogleCloudAiplatformV1beta1CancelBatchPredictionJobRequest {}
623
641
  interface GoogleCloudAiplatformV1beta1CancelCustomJobRequest {}
@@ -792,6 +810,12 @@ declare namespace gapi.client {
792
810
  /** Output only. The version ID of the model that is copied. */
793
811
  modelVersionId?: string;
794
812
  }
813
+ interface GoogleCloudAiplatformV1beta1CorpusStatus {
814
+ /** Output only. Only when the `state` field is ERROR. */
815
+ errorStatus?: string;
816
+ /** Output only. RagCorpus life state. */
817
+ state?: string;
818
+ }
795
819
  interface GoogleCloudAiplatformV1beta1CountTokensRequest {
796
820
  /** Optional. Input content. */
797
821
  contents?: GoogleCloudAiplatformV1beta1Content[];
@@ -2111,8 +2135,12 @@ declare namespace gapi.client {
2111
2135
  interface GoogleCloudAiplatformV1beta1FeatureGroupBigQuery {
2112
2136
  /** Required. Immutable. The BigQuery source URI that points to either a BigQuery Table or View. */
2113
2137
  bigQuerySource?: GoogleCloudAiplatformV1beta1BigQuerySource;
2138
+ /** Optional. If set, all feature values will be fetched from a single row per unique entityId including nulls. If not set, will collapse all rows for each unique entityId into a singe row with any non-null values if present, if no non-null values are present will sync null. ex: If source has schema (entity_id, feature_timestamp, f0, f1) and values (e1, 2020-01-01T10:00:00.123Z, 10, 15) (e1, 2020-02-01T10:00:00.123Z, 20, null) If dense is set, (e1, 20, null) is synced to online stores. If dense is not set, (e1, 20, 15) is synced to online stores. */
2139
+ dense?: boolean;
2114
2140
  /** Optional. Columns to construct entity_id / row keys. If not provided defaults to `entity_id`. */
2115
2141
  entityIdColumns?: string[];
2142
+ /** Optional. Set if the data source is not a time-series. */
2143
+ staticDataSource?: boolean;
2116
2144
  /** Optional. If the source is a time-series source, this can be set to control how downstream sources (ex: 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
2145
  timeSeries?: GoogleCloudAiplatformV1beta1FeatureGroupBigQueryTimeSeries;
2118
2146
  }
@@ -2346,6 +2374,8 @@ declare namespace gapi.client {
2346
2374
  updateTime?: string;
2347
2375
  /** Optional. Deprecated: please use FeatureView.index_config instead. */
2348
2376
  vectorSearchConfig?: GoogleCloudAiplatformV1beta1FeatureViewVectorSearchConfig;
2377
+ /** Optional. The Vertex RAG Source that the FeatureView is linked to. */
2378
+ vertexRagSource?: GoogleCloudAiplatformV1beta1FeatureViewVertexRagSource;
2349
2379
  }
2350
2380
  interface GoogleCloudAiplatformV1beta1FeatureViewBigQuerySource {
2351
2381
  /** Required. Columns to construct entity_id / row keys. */
@@ -2445,6 +2475,12 @@ declare namespace gapi.client {
2445
2475
  /** Optional. Number of embeddings on each leaf node. The default value is 1000 if not set. */
2446
2476
  leafNodeEmbeddingCount?: string;
2447
2477
  }
2478
+ interface GoogleCloudAiplatformV1beta1FeatureViewVertexRagSource {
2479
+ /** Optional. The RAG corpus id corresponding to this FeatureView. */
2480
+ ragCorpusId?: string;
2481
+ /** Required. The BigQuery view/table URI that will be materialized on each manual sync trigger. The table/view is expected to have the following columns at least: Field name Type Mode corpus_id STRING REQUIRED/NULLABLE file_id STRING REQUIRED/NULLABLE chunk_id STRING REQUIRED/NULLABLE chunk_data_type STRING REQUIRED/NULLABLE chunk_data STRING REQUIRED/NULLABLE embeddings FLOAT REPEATED file_original_uri STRING REQUIRED/NULLABLE */
2482
+ uri?: string;
2483
+ }
2448
2484
  interface GoogleCloudAiplatformV1beta1FetchFeatureValuesRequest {
2449
2485
  /** Optional. Response data format. If not set, FeatureViewDataFormat.KEY_VALUE will be used. */
2450
2486
  dataFormat?: string;
@@ -2479,6 +2515,12 @@ declare namespace gapi.client {
2479
2515
  /** Required. The IANA standard MIME type of the source data. */
2480
2516
  mimeType?: string;
2481
2517
  }
2518
+ interface GoogleCloudAiplatformV1beta1FileStatus {
2519
+ /** Output only. Only when the `state` field is ERROR. */
2520
+ errorStatus?: string;
2521
+ /** Output only. RagFile state. */
2522
+ state?: string;
2523
+ }
2482
2524
  interface GoogleCloudAiplatformV1beta1FilterSplit {
2483
2525
  /** Required. A filter on DataItems of the Dataset. DataItems that match this filter are used to test the Model. A filter with same syntax as the one used in DatasetService.ListDataItems may be used. If a single DataItem is matched by more than one of the FilterSplit filters, then it is assigned to the first set that applies to it in the training, validation, test order. */
2484
2526
  testFilter?: string;
@@ -2610,7 +2652,7 @@ declare namespace gapi.client {
2610
2652
  interface GoogleCloudAiplatformV1beta1FunctionResponse {
2611
2653
  /** Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. */
2612
2654
  name?: string;
2613
- /** Required. The function response in JSON object format. */
2655
+ /** Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. */
2614
2656
  response?: {[P in string]: any};
2615
2657
  }
2616
2658
  interface GoogleCloudAiplatformV1beta1GcsDestination {
@@ -2668,10 +2710,13 @@ declare namespace gapi.client {
2668
2710
  safetyRatings?: GoogleCloudAiplatformV1beta1SafetyRating[];
2669
2711
  }
2670
2712
  interface GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata {
2713
+ /** Output only. Number of tokens in the cached part in the input (the cached content). */
2714
+ cachedContentTokenCount?: number;
2671
2715
  /** Number of tokens in the response(s). */
2672
2716
  candidatesTokenCount?: number;
2673
2717
  /** 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. */
2674
2718
  promptTokenCount?: number;
2719
+ /** Total token count for prompt and response candidates. */
2675
2720
  totalTokenCount?: number;
2676
2721
  }
2677
2722
  interface GoogleCloudAiplatformV1beta1GenerateVideoResponse {
@@ -5483,6 +5528,8 @@ declare namespace gapi.client {
5483
5528
  text?: string;
5484
5529
  }
5485
5530
  interface GoogleCloudAiplatformV1beta1RagCorpus {
5531
+ /** Output only. RagCorpus state. */
5532
+ corpusStatus?: GoogleCloudAiplatformV1beta1CorpusStatus;
5486
5533
  /** Output only. Timestamp when this RagCorpus was created. */
5487
5534
  createTime?: string;
5488
5535
  /** Optional. The description of the RagCorpus. */
@@ -5493,6 +5540,8 @@ declare namespace gapi.client {
5493
5540
  name?: string;
5494
5541
  /** Optional. Immutable. The embedding model config of the RagCorpus. */
5495
5542
  ragEmbeddingModelConfig?: GoogleCloudAiplatformV1beta1RagEmbeddingModelConfig;
5543
+ /** Optional. Immutable. The Vector DB config of the RagCorpus. */
5544
+ ragVectorDbConfig?: GoogleCloudAiplatformV1beta1RagVectorDbConfig;
5496
5545
  /** Output only. Timestamp when this RagCorpus was last updated. */
5497
5546
  updateTime?: string;
5498
5547
  }
@@ -5537,6 +5586,8 @@ declare namespace gapi.client {
5537
5586
  directUploadSource?: any;
5538
5587
  /** Required. The display name of the RagFile. The name can be up to 128 characters long and can consist of any UTF-8 characters. */
5539
5588
  displayName?: string;
5589
+ /** Output only. State of the RagFile. */
5590
+ fileStatus?: GoogleCloudAiplatformV1beta1FileStatus;
5540
5591
  /** Output only. Google Cloud Storage location of the RagFile. It does not support wildcards in the Cloud Storage uri for now. */
5541
5592
  gcsSource?: GoogleCloudAiplatformV1beta1GcsSource;
5542
5593
  /** Output only. Google Drive location. Supports importing individual files as well as Google Drive folders. */
@@ -5576,6 +5627,27 @@ declare namespace gapi.client {
5576
5627
  /** 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. */
5577
5628
  alpha?: number;
5578
5629
  }
5630
+ interface GoogleCloudAiplatformV1beta1RagVectorDbConfig {
5631
+ /** Authentication config for the chosen Vector DB. */
5632
+ apiAuth?: GoogleCloudAiplatformV1beta1ApiAuth;
5633
+ /** The config for the RAG-managed Vector DB. */
5634
+ ragManagedDb?: any;
5635
+ /** The config for the Vertex Feature Store. */
5636
+ vertexFeatureStore?: GoogleCloudAiplatformV1beta1RagVectorDbConfigVertexFeatureStore;
5637
+ /** The config for the Weaviate. */
5638
+ weaviate?: GoogleCloudAiplatformV1beta1RagVectorDbConfigWeaviate;
5639
+ }
5640
+ interface GoogleCloudAiplatformV1beta1RagVectorDbConfigRagManagedDb {}
5641
+ interface GoogleCloudAiplatformV1beta1RagVectorDbConfigVertexFeatureStore {
5642
+ /** The resource name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}` */
5643
+ featureViewResourceName?: string;
5644
+ }
5645
+ interface GoogleCloudAiplatformV1beta1RagVectorDbConfigWeaviate {
5646
+ /** The corresponding collection this corpus maps to. This value cannot be changed after it's set. */
5647
+ collectionName?: string;
5648
+ /** Weaviate DB instance HTTP endpoint. e.g. 34.56.78.90:8080 Vertex RAG only supports HTTP connection to Weaviate. This value cannot be changed after it's set. */
5649
+ httpEndpoint?: string;
5650
+ }
5579
5651
  interface GoogleCloudAiplatformV1beta1RawPredictRequest {
5580
5652
  /** The prediction input. Supports HTTP headers and arbitrary data payload. A DeployedModel may have an upper limit on the number of instances it supports per request. When this limit it is exceeded for an AutoML model, the RawPredict method returns an error. When this limit is exceeded for a custom-trained model, the behavior varies depending on the model. You can specify the schema for each instance in the predict_schemata.instance_schema_uri field when you create a Model. This schema applies when you deploy the `Model` as a `DeployedModel` to an Endpoint and use the `RawPredict` method. */
5581
5653
  httpBody?: GoogleApiHttpBody;
@@ -11232,7 +11304,7 @@ declare namespace gapi.client {
11232
11304
  }): Request<GoogleLongrunningOperation>;
11233
11305
  }
11234
11306
  interface AnnotationsResource {
11235
- /** Lists Annotations belongs to a dataitem */
11307
+ /** Lists Annotations belongs to a dataitem This RPC is only available in InternalDatasetService. It is only used for exporting conversation data to CCAI Insights. */
11236
11308
  list(request?: {
11237
11309
  /** V1 error format. */
11238
11310
  '$.xgafv'?: string;
@@ -28617,6 +28689,64 @@ declare namespace gapi.client {
28617
28689
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
28618
28690
  uploadType?: string;
28619
28691
  }): Request<GoogleCloudAiplatformV1beta1ListRagCorporaResponse>;
28692
+ /** Updates a RagCorpus. */
28693
+ patch(request: {
28694
+ /** V1 error format. */
28695
+ '$.xgafv'?: string;
28696
+ /** OAuth access token. */
28697
+ access_token?: string;
28698
+ /** Data format for response. */
28699
+ alt?: string;
28700
+ /** JSONP */
28701
+ callback?: string;
28702
+ /** Selector specifying which fields to include in a partial response. */
28703
+ fields?: string;
28704
+ /** 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. */
28705
+ key?: string;
28706
+ /** Output only. The resource name of the RagCorpus. */
28707
+ name: string;
28708
+ /** OAuth 2.0 token for the current user. */
28709
+ oauth_token?: string;
28710
+ /** Returns response with indentations and line breaks. */
28711
+ prettyPrint?: boolean;
28712
+ /** 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. */
28713
+ quotaUser?: string;
28714
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
28715
+ upload_protocol?: string;
28716
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
28717
+ uploadType?: string;
28718
+ /** Request body */
28719
+ resource: GoogleCloudAiplatformV1beta1RagCorpus;
28720
+ }): Request<GoogleLongrunningOperation>;
28721
+ patch(
28722
+ request: {
28723
+ /** V1 error format. */
28724
+ '$.xgafv'?: string;
28725
+ /** OAuth access token. */
28726
+ access_token?: string;
28727
+ /** Data format for response. */
28728
+ alt?: string;
28729
+ /** JSONP */
28730
+ callback?: string;
28731
+ /** Selector specifying which fields to include in a partial response. */
28732
+ fields?: string;
28733
+ /** 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. */
28734
+ key?: string;
28735
+ /** Output only. The resource name of the RagCorpus. */
28736
+ name: string;
28737
+ /** OAuth 2.0 token for the current user. */
28738
+ oauth_token?: string;
28739
+ /** Returns response with indentations and line breaks. */
28740
+ prettyPrint?: boolean;
28741
+ /** 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. */
28742
+ quotaUser?: string;
28743
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
28744
+ upload_protocol?: string;
28745
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
28746
+ uploadType?: string;
28747
+ },
28748
+ body: GoogleCloudAiplatformV1beta1RagCorpus
28749
+ ): Request<GoogleLongrunningOperation>;
28620
28750
  operations: OperationsResource;
28621
28751
  ragFiles: RagFilesResource;
28622
28752
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.aiplatform-v1beta1",
3
- "version": "0.0.20240816",
3
+ "version": "0.0.20240828",
4
4
  "description": "TypeScript typings for Vertex AI API v1beta1",
5
5
  "repository": {
6
6
  "type": "git",