@maxim_mazurok/gapi.client.discoveryengine-v1beta 0.0.20240229 → 0.0.20240307
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 +37 -29
- 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: 20240307
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -185,8 +185,6 @@ declare namespace gapi.client {
|
|
|
185
185
|
defaultParsingConfig?: GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig;
|
|
186
186
|
/** The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`. */
|
|
187
187
|
name?: string;
|
|
188
|
-
/** [DEPRECATED] This field is deprecated. To specify OCR parsing config, please specify `ocr_parsing_config` in `default_parsing_config` field The OCR config. Currently it only applies to PDFs. */
|
|
189
|
-
ocrConfig?: GoogleCloudDiscoveryengineV1alphaOcrConfig;
|
|
190
188
|
/** Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported. */
|
|
191
189
|
parsingConfigOverrides?: {
|
|
192
190
|
[P in string]: GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig;
|
|
@@ -218,8 +216,6 @@ declare namespace gapi.client {
|
|
|
218
216
|
}
|
|
219
217
|
interface GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchResponse {}
|
|
220
218
|
interface GoogleCloudDiscoveryengineV1alphaEngine {
|
|
221
|
-
/** Whether the search engine can associate with multiple data stores. If true, the generic search engine can associate with one or more data stores. This is an input-only field. */
|
|
222
|
-
allowMultipleDataStoresSearchEngine?: boolean;
|
|
223
219
|
/** Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. */
|
|
224
220
|
chatEngineConfig?: GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig;
|
|
225
221
|
/** Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. */
|
|
@@ -401,14 +397,6 @@ declare namespace gapi.client {
|
|
|
401
397
|
unjoinedEventsCount?: string;
|
|
402
398
|
}
|
|
403
399
|
interface GoogleCloudDiscoveryengineV1alphaLayoutParsingConfig {}
|
|
404
|
-
interface GoogleCloudDiscoveryengineV1alphaOcrConfig {
|
|
405
|
-
/** Required. If OCR is enabled or not. OCR must be enabled for other OcrConfig options to apply. We will only perform OCR on the first 80 pages of the PDF files. */
|
|
406
|
-
enabled?: boolean;
|
|
407
|
-
/** Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. */
|
|
408
|
-
enhancedDocumentElements?: string[];
|
|
409
|
-
/** If true, will use native text instead of OCR text on pages containing native text. */
|
|
410
|
-
useNativeText?: boolean;
|
|
411
|
-
}
|
|
412
400
|
interface GoogleCloudDiscoveryengineV1alphaOcrParsingConfig {
|
|
413
401
|
/** Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. */
|
|
414
402
|
enhancedDocumentElements?: string[];
|
|
@@ -1210,6 +1198,8 @@ declare namespace gapi.client {
|
|
|
1210
1198
|
canonicalFilter?: string;
|
|
1211
1199
|
/** A specification for configuring the behavior of content search. */
|
|
1212
1200
|
contentSearchSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec;
|
|
1201
|
+
/** A list of data store specs to apply on a search call. */
|
|
1202
|
+
dataStoreSpecs?: GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec[];
|
|
1213
1203
|
/** Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path. */
|
|
1214
1204
|
embeddingSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec;
|
|
1215
1205
|
/** Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. */
|
|
@@ -1294,7 +1284,7 @@ declare namespace gapi.client {
|
|
|
1294
1284
|
modelPromptSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec;
|
|
1295
1285
|
/** If specified, the spec will be used to modify the model specification provided to the LLM. */
|
|
1296
1286
|
modelSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec;
|
|
1297
|
-
/** The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most
|
|
1287
|
+
/** The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results can be used to generate a summary. */
|
|
1298
1288
|
summaryResultCount?: number;
|
|
1299
1289
|
}
|
|
1300
1290
|
interface GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec {
|
|
@@ -1305,6 +1295,10 @@ declare namespace gapi.client {
|
|
|
1305
1295
|
/** The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned version of the text-bison@001 model. * `preview`: string. (Public preview) Uses a fine-tuned version of the text-bison@002 model. This model works only for summaries in English. */
|
|
1306
1296
|
version?: string;
|
|
1307
1297
|
}
|
|
1298
|
+
interface GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec {
|
|
1299
|
+
/** Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. */
|
|
1300
|
+
dataStore?: string;
|
|
1301
|
+
}
|
|
1308
1302
|
interface GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec {
|
|
1309
1303
|
/** The embedding vector used for retrieval. Limit to 1. */
|
|
1310
1304
|
embeddingVectors?: GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector[];
|
|
@@ -1499,7 +1493,7 @@ declare namespace gapi.client {
|
|
|
1499
1493
|
mediaConfig?: GoogleCloudDiscoveryengineV1betaServingConfigMediaConfig;
|
|
1500
1494
|
/** The id of the model to use at serving time. Currently only RecommendationModels are supported. Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when SolutionType is SOLUTION_TYPE_RECOMMENDATION. */
|
|
1501
1495
|
modelId?: string;
|
|
1502
|
-
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/
|
|
1496
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}` */
|
|
1503
1497
|
name?: string;
|
|
1504
1498
|
/** Condition oneway synonyms specifications. If multiple oneway synonyms conditions match, all matching oneway synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. */
|
|
1505
1499
|
onewaySynonymsControlIds?: string[];
|
|
@@ -1582,6 +1576,20 @@ declare namespace gapi.client {
|
|
|
1582
1576
|
/** Text input. */
|
|
1583
1577
|
input?: string;
|
|
1584
1578
|
}
|
|
1579
|
+
interface GoogleCloudDiscoveryengineV1betaTrainCustomModelMetadata {
|
|
1580
|
+
/** Operation create time. */
|
|
1581
|
+
createTime?: string;
|
|
1582
|
+
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
1583
|
+
updateTime?: string;
|
|
1584
|
+
}
|
|
1585
|
+
interface GoogleCloudDiscoveryengineV1betaTrainCustomModelResponse {
|
|
1586
|
+
/** Echoes the destination for the complete errors in the request if set. */
|
|
1587
|
+
errorConfig?: GoogleCloudDiscoveryengineV1betaImportErrorConfig;
|
|
1588
|
+
/** A sample of errors encountered while processing the data. */
|
|
1589
|
+
errorSamples?: GoogleRpcStatus[];
|
|
1590
|
+
/** The trained model status. Possible values are: * **bad-data**: The training data quality is bad. * **no-improvement**: Tuning didn't improve performance. Won't deploy. * **in-progress**: Model training is in progress. * **ready**: The model is ready for serving. */
|
|
1591
|
+
modelStatus?: string;
|
|
1592
|
+
}
|
|
1585
1593
|
interface GoogleCloudDiscoveryengineV1betaTransactionInfo {
|
|
1586
1594
|
/** All the costs associated with the products. These can be manufacturing costs, shipping expenses not borne by the end user, or any other costs, such that: * Profit = value - tax - cost */
|
|
1587
1595
|
cost?: number;
|
|
@@ -3129,7 +3137,7 @@ declare namespace gapi.client {
|
|
|
3129
3137
|
fields?: string;
|
|
3130
3138
|
/** 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. */
|
|
3131
3139
|
key?: string;
|
|
3132
|
-
/** Required. The resource name of the ServingConfig to get. Format: `projects/{project_number}/locations/{location}/collections/{collection}/
|
|
3140
|
+
/** Required. The resource name of the ServingConfig to get. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}` */
|
|
3133
3141
|
name: string;
|
|
3134
3142
|
/** OAuth 2.0 token for the current user. */
|
|
3135
3143
|
oauth_token?: string;
|
|
@@ -3162,7 +3170,7 @@ declare namespace gapi.client {
|
|
|
3162
3170
|
pageSize?: number;
|
|
3163
3171
|
/** Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. */
|
|
3164
3172
|
pageToken?: string;
|
|
3165
|
-
/** Required.
|
|
3173
|
+
/** Required. Full resource name of the parent resource. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` */
|
|
3166
3174
|
parent: string;
|
|
3167
3175
|
/** Returns response with indentations and line breaks. */
|
|
3168
3176
|
prettyPrint?: boolean;
|
|
@@ -3187,7 +3195,7 @@ declare namespace gapi.client {
|
|
|
3187
3195
|
fields?: string;
|
|
3188
3196
|
/** 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. */
|
|
3189
3197
|
key?: string;
|
|
3190
|
-
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/
|
|
3198
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}` */
|
|
3191
3199
|
name: string;
|
|
3192
3200
|
/** OAuth 2.0 token for the current user. */
|
|
3193
3201
|
oauth_token?: string;
|
|
@@ -3218,7 +3226,7 @@ declare namespace gapi.client {
|
|
|
3218
3226
|
fields?: string;
|
|
3219
3227
|
/** 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. */
|
|
3220
3228
|
key?: string;
|
|
3221
|
-
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/
|
|
3229
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}` */
|
|
3222
3230
|
name: string;
|
|
3223
3231
|
/** OAuth 2.0 token for the current user. */
|
|
3224
3232
|
oauth_token?: string;
|
|
@@ -4299,7 +4307,7 @@ declare namespace gapi.client {
|
|
|
4299
4307
|
prettyPrint?: boolean;
|
|
4300
4308
|
/** Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. */
|
|
4301
4309
|
query?: string;
|
|
4302
|
-
/** Specifies the autocomplete data model. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.
|
|
4310
|
+
/** Specifies the autocomplete data model. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores. */
|
|
4303
4311
|
queryModel?: string;
|
|
4304
4312
|
/** 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. */
|
|
4305
4313
|
quotaUser?: string;
|
|
@@ -4908,7 +4916,7 @@ declare namespace gapi.client {
|
|
|
4908
4916
|
fields?: string;
|
|
4909
4917
|
/** 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. */
|
|
4910
4918
|
key?: string;
|
|
4911
|
-
/** Required. The resource name of the ServingConfig to get. Format: `projects/{project_number}/locations/{location}/collections/{collection}/
|
|
4919
|
+
/** Required. The resource name of the ServingConfig to get. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}` */
|
|
4912
4920
|
name: string;
|
|
4913
4921
|
/** OAuth 2.0 token for the current user. */
|
|
4914
4922
|
oauth_token?: string;
|
|
@@ -4941,7 +4949,7 @@ declare namespace gapi.client {
|
|
|
4941
4949
|
pageSize?: number;
|
|
4942
4950
|
/** Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. */
|
|
4943
4951
|
pageToken?: string;
|
|
4944
|
-
/** Required.
|
|
4952
|
+
/** Required. Full resource name of the parent resource. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` */
|
|
4945
4953
|
parent: string;
|
|
4946
4954
|
/** Returns response with indentations and line breaks. */
|
|
4947
4955
|
prettyPrint?: boolean;
|
|
@@ -4966,7 +4974,7 @@ declare namespace gapi.client {
|
|
|
4966
4974
|
fields?: string;
|
|
4967
4975
|
/** 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. */
|
|
4968
4976
|
key?: string;
|
|
4969
|
-
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/
|
|
4977
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}` */
|
|
4970
4978
|
name: string;
|
|
4971
4979
|
/** OAuth 2.0 token for the current user. */
|
|
4972
4980
|
oauth_token?: string;
|
|
@@ -4997,7 +5005,7 @@ declare namespace gapi.client {
|
|
|
4997
5005
|
fields?: string;
|
|
4998
5006
|
/** 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. */
|
|
4999
5007
|
key?: string;
|
|
5000
|
-
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/
|
|
5008
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}` */
|
|
5001
5009
|
name: string;
|
|
5002
5010
|
/** OAuth 2.0 token for the current user. */
|
|
5003
5011
|
oauth_token?: string;
|
|
@@ -6430,7 +6438,7 @@ declare namespace gapi.client {
|
|
|
6430
6438
|
fields?: string;
|
|
6431
6439
|
/** 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. */
|
|
6432
6440
|
key?: string;
|
|
6433
|
-
/** Required. The resource name of the ServingConfig to get. Format: `projects/{project_number}/locations/{location}/collections/{collection}/
|
|
6441
|
+
/** Required. The resource name of the ServingConfig to get. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}` */
|
|
6434
6442
|
name: string;
|
|
6435
6443
|
/** OAuth 2.0 token for the current user. */
|
|
6436
6444
|
oauth_token?: string;
|
|
@@ -6463,7 +6471,7 @@ declare namespace gapi.client {
|
|
|
6463
6471
|
pageSize?: number;
|
|
6464
6472
|
/** Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. */
|
|
6465
6473
|
pageToken?: string;
|
|
6466
|
-
/** Required.
|
|
6474
|
+
/** Required. Full resource name of the parent resource. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` */
|
|
6467
6475
|
parent: string;
|
|
6468
6476
|
/** Returns response with indentations and line breaks. */
|
|
6469
6477
|
prettyPrint?: boolean;
|
|
@@ -6488,7 +6496,7 @@ declare namespace gapi.client {
|
|
|
6488
6496
|
fields?: string;
|
|
6489
6497
|
/** 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. */
|
|
6490
6498
|
key?: string;
|
|
6491
|
-
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/
|
|
6499
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}` */
|
|
6492
6500
|
name: string;
|
|
6493
6501
|
/** OAuth 2.0 token for the current user. */
|
|
6494
6502
|
oauth_token?: string;
|
|
@@ -6519,7 +6527,7 @@ declare namespace gapi.client {
|
|
|
6519
6527
|
fields?: string;
|
|
6520
6528
|
/** 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. */
|
|
6521
6529
|
key?: string;
|
|
6522
|
-
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/
|
|
6530
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}` */
|
|
6523
6531
|
name: string;
|
|
6524
6532
|
/** OAuth 2.0 token for the current user. */
|
|
6525
6533
|
oauth_token?: string;
|
|
@@ -7385,7 +7393,7 @@ declare namespace gapi.client {
|
|
|
7385
7393
|
prettyPrint?: boolean;
|
|
7386
7394
|
/** Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. */
|
|
7387
7395
|
query?: string;
|
|
7388
|
-
/** Specifies the autocomplete data model. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.
|
|
7396
|
+
/** Specifies the autocomplete data model. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores. */
|
|
7389
7397
|
queryModel?: string;
|
|
7390
7398
|
/** 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. */
|
|
7391
7399
|
quotaUser?: string;
|