@maxim_mazurok/gapi.client.discoveryengine-v1 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=v1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20240530
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -82,6 +82,20 @@ declare namespace gapi.client {
|
|
|
82
82
|
/** Human-readable name of a function or method—for example, `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend`. */
|
|
83
83
|
functionName?: string;
|
|
84
84
|
}
|
|
85
|
+
interface GoogleCloudDiscoveryengineV1AlloyDbSource {
|
|
86
|
+
/** Required. The AlloyDB cluster to copy the data from with a length limit of 256 characters. */
|
|
87
|
+
clusterId?: string;
|
|
88
|
+
/** Required. The AlloyDB database to copy the data from with a length limit of 256 characters. */
|
|
89
|
+
databaseId?: string;
|
|
90
|
+
/** 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. */
|
|
91
|
+
gcsStagingDir?: string;
|
|
92
|
+
/** Required. The AlloyDB location to copy the data from with a length limit of 256 characters. */
|
|
93
|
+
locationId?: string;
|
|
94
|
+
/** 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. */
|
|
95
|
+
projectId?: string;
|
|
96
|
+
/** Required. The AlloyDB table to copy the data from with a length limit of 256 characters. */
|
|
97
|
+
tableId?: string;
|
|
98
|
+
}
|
|
85
99
|
interface GoogleCloudDiscoveryengineV1alphaAclConfig {
|
|
86
100
|
/** Identity provider config. */
|
|
87
101
|
idpConfig?: GoogleCloudDiscoveryengineV1alphaIdpConfig;
|
|
@@ -894,6 +908,8 @@ declare namespace gapi.client {
|
|
|
894
908
|
searchSpec?: GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpec;
|
|
895
909
|
/** 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. */
|
|
896
910
|
session?: string;
|
|
911
|
+
/** 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. */
|
|
912
|
+
userLabels?: {[P in string]: string};
|
|
897
913
|
/** 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. */
|
|
898
914
|
userPseudoId?: string;
|
|
899
915
|
}
|
|
@@ -1300,6 +1316,8 @@ declare namespace gapi.client {
|
|
|
1300
1316
|
}
|
|
1301
1317
|
interface GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse {}
|
|
1302
1318
|
interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig {
|
|
1319
|
+
/** Whether chunking mode is enabled. */
|
|
1320
|
+
chunkingConfig?: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig;
|
|
1303
1321
|
/** 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. */
|
|
1304
1322
|
defaultParsingConfig?: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig;
|
|
1305
1323
|
/** The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`. */
|
|
@@ -1309,13 +1327,26 @@ declare namespace gapi.client {
|
|
|
1309
1327
|
[P in string]: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig;
|
|
1310
1328
|
};
|
|
1311
1329
|
}
|
|
1330
|
+
interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig {
|
|
1331
|
+
/** Configuration for the layout based chunking. */
|
|
1332
|
+
layoutBasedChunkingConfig?: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig;
|
|
1333
|
+
}
|
|
1334
|
+
interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig {
|
|
1335
|
+
/** The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500. */
|
|
1336
|
+
chunkSize?: number;
|
|
1337
|
+
/** Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False. */
|
|
1338
|
+
includeAncestorHeadings?: boolean;
|
|
1339
|
+
}
|
|
1312
1340
|
interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig {
|
|
1313
1341
|
/** Configurations applied to digital parser. */
|
|
1314
1342
|
digitalParsingConfig?: any;
|
|
1343
|
+
/** Configurations applied to layout parser. */
|
|
1344
|
+
layoutParsingConfig?: any;
|
|
1315
1345
|
/** Configurations applied to OCR parser. Currently it only applies to PDFs. */
|
|
1316
1346
|
ocrParsingConfig?: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig;
|
|
1317
1347
|
}
|
|
1318
1348
|
interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig {}
|
|
1349
|
+
interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig {}
|
|
1319
1350
|
interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig {
|
|
1320
1351
|
/** [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. */
|
|
1321
1352
|
enhancedDocumentElements?: string[];
|
|
@@ -1940,6 +1971,8 @@ declare namespace gapi.client {
|
|
|
1940
1971
|
uri?: string;
|
|
1941
1972
|
}
|
|
1942
1973
|
interface GoogleCloudDiscoveryengineV1DocumentProcessingConfig {
|
|
1974
|
+
/** Whether chunking mode is enabled. */
|
|
1975
|
+
chunkingConfig?: GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig;
|
|
1943
1976
|
/** 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. */
|
|
1944
1977
|
defaultParsingConfig?: GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig;
|
|
1945
1978
|
/** The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`. */
|
|
@@ -1949,13 +1982,26 @@ declare namespace gapi.client {
|
|
|
1949
1982
|
[P in string]: GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig;
|
|
1950
1983
|
};
|
|
1951
1984
|
}
|
|
1985
|
+
interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig {
|
|
1986
|
+
/** Configuration for the layout based chunking. */
|
|
1987
|
+
layoutBasedChunkingConfig?: GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig;
|
|
1988
|
+
}
|
|
1989
|
+
interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig {
|
|
1990
|
+
/** The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500. */
|
|
1991
|
+
chunkSize?: number;
|
|
1992
|
+
/** Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False. */
|
|
1993
|
+
includeAncestorHeadings?: boolean;
|
|
1994
|
+
}
|
|
1952
1995
|
interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig {
|
|
1953
1996
|
/** Configurations applied to digital parser. */
|
|
1954
1997
|
digitalParsingConfig?: any;
|
|
1998
|
+
/** Configurations applied to layout parser. */
|
|
1999
|
+
layoutParsingConfig?: any;
|
|
1955
2000
|
/** Configurations applied to OCR parser. Currently it only applies to PDFs. */
|
|
1956
2001
|
ocrParsingConfig?: GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig;
|
|
1957
2002
|
}
|
|
1958
2003
|
interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig {}
|
|
2004
|
+
interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig {}
|
|
1959
2005
|
interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig {
|
|
1960
2006
|
/** [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. */
|
|
1961
2007
|
enhancedDocumentElements?: string[];
|
|
@@ -2083,6 +2129,8 @@ declare namespace gapi.client {
|
|
|
2083
2129
|
updateTime?: string;
|
|
2084
2130
|
}
|
|
2085
2131
|
interface GoogleCloudDiscoveryengineV1ImportDocumentsRequest {
|
|
2132
|
+
/** AlloyDB input source. */
|
|
2133
|
+
alloyDbSource?: GoogleCloudDiscoveryengineV1AlloyDbSource;
|
|
2086
2134
|
/** 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. */
|
|
2087
2135
|
autoGenerateIds?: boolean;
|
|
2088
2136
|
/** BigQuery input source. */
|
|
@@ -3413,7 +3461,7 @@ declare namespace gapi.client {
|
|
|
3413
3461
|
key?: string;
|
|
3414
3462
|
/** OAuth 2.0 token for the current user. */
|
|
3415
3463
|
oauth_token?: string;
|
|
3416
|
-
/** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` */
|
|
3464
|
+
/** 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}`. */
|
|
3417
3465
|
parent: string;
|
|
3418
3466
|
/** Returns response with indentations and line breaks. */
|
|
3419
3467
|
prettyPrint?: boolean;
|
|
@@ -3444,7 +3492,7 @@ declare namespace gapi.client {
|
|
|
3444
3492
|
key?: string;
|
|
3445
3493
|
/** OAuth 2.0 token for the current user. */
|
|
3446
3494
|
oauth_token?: string;
|
|
3447
|
-
/** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` */
|
|
3495
|
+
/** 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}`. */
|
|
3448
3496
|
parent: string;
|
|
3449
3497
|
/** Returns response with indentations and line breaks. */
|
|
3450
3498
|
prettyPrint?: boolean;
|
|
@@ -3533,7 +3581,7 @@ declare namespace gapi.client {
|
|
|
3533
3581
|
pageSize?: number;
|
|
3534
3582
|
/** Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. */
|
|
3535
3583
|
pageToken?: string;
|
|
3536
|
-
/** Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` */
|
|
3584
|
+
/** 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}`. */
|
|
3537
3585
|
parent: string;
|
|
3538
3586
|
/** Returns response with indentations and line breaks. */
|
|
3539
3587
|
prettyPrint?: boolean;
|
|
@@ -5929,7 +5977,7 @@ declare namespace gapi.client {
|
|
|
5929
5977
|
key?: string;
|
|
5930
5978
|
/** OAuth 2.0 token for the current user. */
|
|
5931
5979
|
oauth_token?: string;
|
|
5932
|
-
/** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` */
|
|
5980
|
+
/** 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}`. */
|
|
5933
5981
|
parent: string;
|
|
5934
5982
|
/** Returns response with indentations and line breaks. */
|
|
5935
5983
|
prettyPrint?: boolean;
|
|
@@ -5960,7 +6008,7 @@ declare namespace gapi.client {
|
|
|
5960
6008
|
key?: string;
|
|
5961
6009
|
/** OAuth 2.0 token for the current user. */
|
|
5962
6010
|
oauth_token?: string;
|
|
5963
|
-
/** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` */
|
|
6011
|
+
/** 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}`. */
|
|
5964
6012
|
parent: string;
|
|
5965
6013
|
/** Returns response with indentations and line breaks. */
|
|
5966
6014
|
prettyPrint?: boolean;
|
|
@@ -6049,7 +6097,7 @@ declare namespace gapi.client {
|
|
|
6049
6097
|
pageSize?: number;
|
|
6050
6098
|
/** Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. */
|
|
6051
6099
|
pageToken?: string;
|
|
6052
|
-
/** Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` */
|
|
6100
|
+
/** 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}`. */
|
|
6053
6101
|
parent: string;
|
|
6054
6102
|
/** Returns response with indentations and line breaks. */
|
|
6055
6103
|
prettyPrint?: boolean;
|
|
@@ -7631,7 +7679,7 @@ declare namespace gapi.client {
|
|
|
7631
7679
|
key?: string;
|
|
7632
7680
|
/** OAuth 2.0 token for the current user. */
|
|
7633
7681
|
oauth_token?: string;
|
|
7634
|
-
/** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` */
|
|
7682
|
+
/** 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}`. */
|
|
7635
7683
|
parent: string;
|
|
7636
7684
|
/** Returns response with indentations and line breaks. */
|
|
7637
7685
|
prettyPrint?: boolean;
|
|
@@ -7662,7 +7710,7 @@ declare namespace gapi.client {
|
|
|
7662
7710
|
key?: string;
|
|
7663
7711
|
/** OAuth 2.0 token for the current user. */
|
|
7664
7712
|
oauth_token?: string;
|
|
7665
|
-
/** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` */
|
|
7713
|
+
/** 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}`. */
|
|
7666
7714
|
parent: string;
|
|
7667
7715
|
/** Returns response with indentations and line breaks. */
|
|
7668
7716
|
prettyPrint?: boolean;
|
|
@@ -7751,7 +7799,7 @@ declare namespace gapi.client {
|
|
|
7751
7799
|
pageSize?: number;
|
|
7752
7800
|
/** Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. */
|
|
7753
7801
|
pageToken?: string;
|
|
7754
|
-
/** Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` */
|
|
7802
|
+
/** 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}`. */
|
|
7755
7803
|
parent: string;
|
|
7756
7804
|
/** Returns response with indentations and line breaks. */
|
|
7757
7805
|
prettyPrint?: boolean;
|