@maxim_mazurok/gapi.client.discoveryengine-v1beta 0.0.20240526 → 0.0.20240530
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 +58 -10
- 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://discoveryengine.googleapis.com/$discovery/rest?version=v1beta
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20240530
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -851,6 +851,20 @@ declare namespace gapi.client {
|
|
|
851
851
|
/** TargetSites created. */
|
|
852
852
|
targetSites?: GoogleCloudDiscoveryengineV1TargetSite[];
|
|
853
853
|
}
|
|
854
|
+
interface GoogleCloudDiscoveryengineV1betaAlloyDbSource {
|
|
855
|
+
/** Required. The AlloyDB cluster to copy the data from with a length limit of 256 characters. */
|
|
856
|
+
clusterId?: string;
|
|
857
|
+
/** Required. The AlloyDB database to copy the data from with a length limit of 256 characters. */
|
|
858
|
+
databaseId?: string;
|
|
859
|
+
/** Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the AlloyDB export to a specific Cloud Storage directory. Ensure that the AlloyDB service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. */
|
|
860
|
+
gcsStagingDir?: string;
|
|
861
|
+
/** Required. The AlloyDB location to copy the data from with a length limit of 256 characters. */
|
|
862
|
+
locationId?: string;
|
|
863
|
+
/** The project ID that the AlloyDB source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. */
|
|
864
|
+
projectId?: string;
|
|
865
|
+
/** Required. The AlloyDB table to copy the data from with a length limit of 256 characters. */
|
|
866
|
+
tableId?: string;
|
|
867
|
+
}
|
|
854
868
|
interface GoogleCloudDiscoveryengineV1betaAnswer {
|
|
855
869
|
/** Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. */
|
|
856
870
|
answerSkippedReasons?: string[];
|
|
@@ -904,6 +918,8 @@ declare namespace gapi.client {
|
|
|
904
918
|
searchSpec?: GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpec;
|
|
905
919
|
/** The session resource name. Not required. When session field is not set, the API is in sessionless mode. We support auto session mode: users can use the wildcard symbol `-` as session ID. A new ID will be automatically generated and assigned. */
|
|
906
920
|
session?: string;
|
|
921
|
+
/** The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. */
|
|
922
|
+
userLabels?: {[P in string]: string};
|
|
907
923
|
/** A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
|
|
908
924
|
userPseudoId?: string;
|
|
909
925
|
}
|
|
@@ -1529,6 +1545,8 @@ declare namespace gapi.client {
|
|
|
1529
1545
|
uri?: string;
|
|
1530
1546
|
}
|
|
1531
1547
|
interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig {
|
|
1548
|
+
/** Whether chunking mode is enabled. */
|
|
1549
|
+
chunkingConfig?: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig;
|
|
1532
1550
|
/** Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing. */
|
|
1533
1551
|
defaultParsingConfig?: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig;
|
|
1534
1552
|
/** The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`. */
|
|
@@ -1538,13 +1556,26 @@ declare namespace gapi.client {
|
|
|
1538
1556
|
[P in string]: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig;
|
|
1539
1557
|
};
|
|
1540
1558
|
}
|
|
1559
|
+
interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig {
|
|
1560
|
+
/** Configuration for the layout based chunking. */
|
|
1561
|
+
layoutBasedChunkingConfig?: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig;
|
|
1562
|
+
}
|
|
1563
|
+
interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig {
|
|
1564
|
+
/** The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500. */
|
|
1565
|
+
chunkSize?: number;
|
|
1566
|
+
/** Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False. */
|
|
1567
|
+
includeAncestorHeadings?: boolean;
|
|
1568
|
+
}
|
|
1541
1569
|
interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig {
|
|
1542
1570
|
/** Configurations applied to digital parser. */
|
|
1543
1571
|
digitalParsingConfig?: any;
|
|
1572
|
+
/** Configurations applied to layout parser. */
|
|
1573
|
+
layoutParsingConfig?: any;
|
|
1544
1574
|
/** Configurations applied to OCR parser. Currently it only applies to PDFs. */
|
|
1545
1575
|
ocrParsingConfig?: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig;
|
|
1546
1576
|
}
|
|
1547
1577
|
interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig {}
|
|
1578
|
+
interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig {}
|
|
1548
1579
|
interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig {
|
|
1549
1580
|
/** [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. */
|
|
1550
1581
|
enhancedDocumentElements?: string[];
|
|
@@ -1680,6 +1711,8 @@ declare namespace gapi.client {
|
|
|
1680
1711
|
updateTime?: string;
|
|
1681
1712
|
}
|
|
1682
1713
|
interface GoogleCloudDiscoveryengineV1betaImportDocumentsRequest {
|
|
1714
|
+
/** AlloyDB input source. */
|
|
1715
|
+
alloyDbSource?: GoogleCloudDiscoveryengineV1betaAlloyDbSource;
|
|
1683
1716
|
/** Whether to automatically generate IDs for the documents if absent. If set to `true`, Document.ids are automatically generated based on the hash of the payload, where IDs may not be consistent during multiple imports. In which case ReconciliationMode.FULL is highly recommended to avoid duplicate contents. If unset or set to `false`, Document.ids have to be specified using id_field, otherwise, documents without IDs fail to be imported. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. * FirestoreSource. * BigtableSource. */
|
|
1684
1717
|
autoGenerateIds?: boolean;
|
|
1685
1718
|
/** BigQuery input source. */
|
|
@@ -2756,6 +2789,8 @@ declare namespace gapi.client {
|
|
|
2756
2789
|
}
|
|
2757
2790
|
interface GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse {}
|
|
2758
2791
|
interface GoogleCloudDiscoveryengineV1DocumentProcessingConfig {
|
|
2792
|
+
/** Whether chunking mode is enabled. */
|
|
2793
|
+
chunkingConfig?: GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig;
|
|
2759
2794
|
/** Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing. */
|
|
2760
2795
|
defaultParsingConfig?: GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig;
|
|
2761
2796
|
/** The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`. */
|
|
@@ -2765,13 +2800,26 @@ declare namespace gapi.client {
|
|
|
2765
2800
|
[P in string]: GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig;
|
|
2766
2801
|
};
|
|
2767
2802
|
}
|
|
2803
|
+
interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig {
|
|
2804
|
+
/** Configuration for the layout based chunking. */
|
|
2805
|
+
layoutBasedChunkingConfig?: GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig;
|
|
2806
|
+
}
|
|
2807
|
+
interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig {
|
|
2808
|
+
/** The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500. */
|
|
2809
|
+
chunkSize?: number;
|
|
2810
|
+
/** Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False. */
|
|
2811
|
+
includeAncestorHeadings?: boolean;
|
|
2812
|
+
}
|
|
2768
2813
|
interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig {
|
|
2769
2814
|
/** Configurations applied to digital parser. */
|
|
2770
2815
|
digitalParsingConfig?: any;
|
|
2816
|
+
/** Configurations applied to layout parser. */
|
|
2817
|
+
layoutParsingConfig?: any;
|
|
2771
2818
|
/** Configurations applied to OCR parser. Currently it only applies to PDFs. */
|
|
2772
2819
|
ocrParsingConfig?: GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig;
|
|
2773
2820
|
}
|
|
2774
2821
|
interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig {}
|
|
2822
|
+
interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig {}
|
|
2775
2823
|
interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig {
|
|
2776
2824
|
/** [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. */
|
|
2777
2825
|
enhancedDocumentElements?: string[];
|
|
@@ -3581,7 +3629,7 @@ declare namespace gapi.client {
|
|
|
3581
3629
|
key?: string;
|
|
3582
3630
|
/** OAuth 2.0 token for the current user. */
|
|
3583
3631
|
oauth_token?: string;
|
|
3584
|
-
/** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` */
|
|
3632
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. */
|
|
3585
3633
|
parent: string;
|
|
3586
3634
|
/** Returns response with indentations and line breaks. */
|
|
3587
3635
|
prettyPrint?: boolean;
|
|
@@ -3612,7 +3660,7 @@ declare namespace gapi.client {
|
|
|
3612
3660
|
key?: string;
|
|
3613
3661
|
/** OAuth 2.0 token for the current user. */
|
|
3614
3662
|
oauth_token?: string;
|
|
3615
|
-
/** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` */
|
|
3663
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. */
|
|
3616
3664
|
parent: string;
|
|
3617
3665
|
/** Returns response with indentations and line breaks. */
|
|
3618
3666
|
prettyPrint?: boolean;
|
|
@@ -3701,7 +3749,7 @@ declare namespace gapi.client {
|
|
|
3701
3749
|
pageSize?: number;
|
|
3702
3750
|
/** Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. */
|
|
3703
3751
|
pageToken?: string;
|
|
3704
|
-
/** Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` */
|
|
3752
|
+
/** Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. */
|
|
3705
3753
|
parent: string;
|
|
3706
3754
|
/** Returns response with indentations and line breaks. */
|
|
3707
3755
|
prettyPrint?: boolean;
|
|
@@ -6305,7 +6353,7 @@ declare namespace gapi.client {
|
|
|
6305
6353
|
key?: string;
|
|
6306
6354
|
/** OAuth 2.0 token for the current user. */
|
|
6307
6355
|
oauth_token?: string;
|
|
6308
|
-
/** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` */
|
|
6356
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. */
|
|
6309
6357
|
parent: string;
|
|
6310
6358
|
/** Returns response with indentations and line breaks. */
|
|
6311
6359
|
prettyPrint?: boolean;
|
|
@@ -6336,7 +6384,7 @@ declare namespace gapi.client {
|
|
|
6336
6384
|
key?: string;
|
|
6337
6385
|
/** OAuth 2.0 token for the current user. */
|
|
6338
6386
|
oauth_token?: string;
|
|
6339
|
-
/** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` */
|
|
6387
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. */
|
|
6340
6388
|
parent: string;
|
|
6341
6389
|
/** Returns response with indentations and line breaks. */
|
|
6342
6390
|
prettyPrint?: boolean;
|
|
@@ -6425,7 +6473,7 @@ declare namespace gapi.client {
|
|
|
6425
6473
|
pageSize?: number;
|
|
6426
6474
|
/** Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. */
|
|
6427
6475
|
pageToken?: string;
|
|
6428
|
-
/** Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` */
|
|
6476
|
+
/** Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. */
|
|
6429
6477
|
parent: string;
|
|
6430
6478
|
/** Returns response with indentations and line breaks. */
|
|
6431
6479
|
prettyPrint?: boolean;
|
|
@@ -8301,7 +8349,7 @@ declare namespace gapi.client {
|
|
|
8301
8349
|
key?: string;
|
|
8302
8350
|
/** OAuth 2.0 token for the current user. */
|
|
8303
8351
|
oauth_token?: string;
|
|
8304
|
-
/** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` */
|
|
8352
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. */
|
|
8305
8353
|
parent: string;
|
|
8306
8354
|
/** Returns response with indentations and line breaks. */
|
|
8307
8355
|
prettyPrint?: boolean;
|
|
@@ -8332,7 +8380,7 @@ declare namespace gapi.client {
|
|
|
8332
8380
|
key?: string;
|
|
8333
8381
|
/** OAuth 2.0 token for the current user. */
|
|
8334
8382
|
oauth_token?: string;
|
|
8335
|
-
/** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` */
|
|
8383
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. */
|
|
8336
8384
|
parent: string;
|
|
8337
8385
|
/** Returns response with indentations and line breaks. */
|
|
8338
8386
|
prettyPrint?: boolean;
|
|
@@ -8421,7 +8469,7 @@ declare namespace gapi.client {
|
|
|
8421
8469
|
pageSize?: number;
|
|
8422
8470
|
/** Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. */
|
|
8423
8471
|
pageToken?: string;
|
|
8424
|
-
/** Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` */
|
|
8472
|
+
/** Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. */
|
|
8425
8473
|
parent: string;
|
|
8426
8474
|
/** Returns response with indentations and line breaks. */
|
|
8427
8475
|
prettyPrint?: boolean;
|