@maxim_mazurok/gapi.client.discoveryengine-v1beta 0.0.20240305 → 0.0.20240312
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 +142 -58
- 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: 20240312
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -170,7 +170,6 @@ declare namespace gapi.client {
|
|
|
170
170
|
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
171
171
|
updateTime?: string;
|
|
172
172
|
}
|
|
173
|
-
interface GoogleCloudDiscoveryengineV1alphaDigitalParsingConfig {}
|
|
174
173
|
interface GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata {
|
|
175
174
|
/** Operation create time. */
|
|
176
175
|
createTime?: string;
|
|
@@ -185,8 +184,6 @@ declare namespace gapi.client {
|
|
|
185
184
|
defaultParsingConfig?: GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig;
|
|
186
185
|
/** The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`. */
|
|
187
186
|
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
187
|
/** 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
188
|
parsingConfigOverrides?: {
|
|
192
189
|
[P in string]: GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig;
|
|
@@ -208,7 +205,15 @@ declare namespace gapi.client {
|
|
|
208
205
|
/** Configurations applied to layout parser. */
|
|
209
206
|
layoutParsingConfig?: any;
|
|
210
207
|
/** Configurations applied to OCR parser. Currently it only applies to PDFs. */
|
|
211
|
-
ocrParsingConfig?:
|
|
208
|
+
ocrParsingConfig?: GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig;
|
|
209
|
+
}
|
|
210
|
+
interface GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig {}
|
|
211
|
+
interface GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig {}
|
|
212
|
+
interface GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig {
|
|
213
|
+
/** Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. */
|
|
214
|
+
enhancedDocumentElements?: string[];
|
|
215
|
+
/** If true, will use native text instead of OCR text on pages containing native text. */
|
|
216
|
+
useNativeText?: boolean;
|
|
212
217
|
}
|
|
213
218
|
interface GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchMetadata {
|
|
214
219
|
/** Operation create time. */
|
|
@@ -218,8 +223,6 @@ declare namespace gapi.client {
|
|
|
218
223
|
}
|
|
219
224
|
interface GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchResponse {}
|
|
220
225
|
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
226
|
/** Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. */
|
|
224
227
|
chatEngineConfig?: GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig;
|
|
225
228
|
/** Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. */
|
|
@@ -400,21 +403,6 @@ declare namespace gapi.client {
|
|
|
400
403
|
/** Count of user events imported, but with Document information not found in the existing Branch. */
|
|
401
404
|
unjoinedEventsCount?: string;
|
|
402
405
|
}
|
|
403
|
-
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
|
-
interface GoogleCloudDiscoveryengineV1alphaOcrParsingConfig {
|
|
413
|
-
/** Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. */
|
|
414
|
-
enhancedDocumentElements?: string[];
|
|
415
|
-
/** If true, will use native text instead of OCR text on pages containing native text. */
|
|
416
|
-
useNativeText?: boolean;
|
|
417
|
-
}
|
|
418
406
|
interface GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata {
|
|
419
407
|
/** Operation create time. */
|
|
420
408
|
createTime?: string;
|
|
@@ -761,7 +749,6 @@ declare namespace gapi.client {
|
|
|
761
749
|
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
762
750
|
updateTime?: string;
|
|
763
751
|
}
|
|
764
|
-
interface GoogleCloudDiscoveryengineV1betaDigitalParsingConfig {}
|
|
765
752
|
interface GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata {
|
|
766
753
|
/** Operation create time. */
|
|
767
754
|
createTime?: string;
|
|
@@ -824,7 +811,14 @@ declare namespace gapi.client {
|
|
|
824
811
|
/** Configurations applied to digital parser. */
|
|
825
812
|
digitalParsingConfig?: any;
|
|
826
813
|
/** Configurations applied to OCR parser. Currently it only applies to PDFs. */
|
|
827
|
-
ocrParsingConfig?:
|
|
814
|
+
ocrParsingConfig?: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig;
|
|
815
|
+
}
|
|
816
|
+
interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig {}
|
|
817
|
+
interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig {
|
|
818
|
+
/** Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. */
|
|
819
|
+
enhancedDocumentElements?: string[];
|
|
820
|
+
/** If true, will use native text instead of OCR text on pages containing native text. */
|
|
821
|
+
useNativeText?: boolean;
|
|
828
822
|
}
|
|
829
823
|
interface GoogleCloudDiscoveryengineV1betaDoubleList {
|
|
830
824
|
/** Double values. */
|
|
@@ -1068,12 +1062,6 @@ declare namespace gapi.client {
|
|
|
1068
1062
|
/** Media progress should be computed using only the media_progress_duration relative to the media total length. This value must be between `[0, 1.0]` inclusive. If this is not a playback or the progress cannot be computed (e.g. ongoing livestream), this field should be unset. */
|
|
1069
1063
|
mediaProgressPercentage?: number;
|
|
1070
1064
|
}
|
|
1071
|
-
interface GoogleCloudDiscoveryengineV1betaOcrParsingConfig {
|
|
1072
|
-
/** Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. */
|
|
1073
|
-
enhancedDocumentElements?: string[];
|
|
1074
|
-
/** If true, will use native text instead of OCR text on pages containing native text. */
|
|
1075
|
-
useNativeText?: boolean;
|
|
1076
|
-
}
|
|
1077
1065
|
interface GoogleCloudDiscoveryengineV1betaPageInfo {
|
|
1078
1066
|
/** The most specific category associated with a category page. To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, please replace it with other character(s). Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: `"pageCategory" : "Sales > 2017 Black Friday Deals"`. Required for `view-category-page` events. Other event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error is returned. */
|
|
1079
1067
|
pageCategory?: 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. */
|
|
@@ -1252,7 +1242,7 @@ declare namespace gapi.client {
|
|
|
1252
1242
|
interface GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec {
|
|
1253
1243
|
/** Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. */
|
|
1254
1244
|
boost?: number;
|
|
1255
|
-
/** An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue":
|
|
1245
|
+
/** An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": `(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))` */
|
|
1256
1246
|
condition?: string;
|
|
1257
1247
|
}
|
|
1258
1248
|
interface GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec {
|
|
@@ -1272,6 +1262,8 @@ declare namespace gapi.client {
|
|
|
1272
1262
|
numNextSegments?: number;
|
|
1273
1263
|
/** Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. */
|
|
1274
1264
|
numPreviousSegments?: number;
|
|
1265
|
+
/** Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, please contact your Customer Engineer. The default value is `false`. */
|
|
1266
|
+
returnExtractiveSegmentScore?: boolean;
|
|
1275
1267
|
}
|
|
1276
1268
|
interface GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec {
|
|
1277
1269
|
/** [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. */
|
|
@@ -1294,7 +1286,7 @@ declare namespace gapi.client {
|
|
|
1294
1286
|
modelPromptSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec;
|
|
1295
1287
|
/** If specified, the spec will be used to modify the model specification provided to the LLM. */
|
|
1296
1288
|
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
|
|
1289
|
+
/** 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
1290
|
summaryResultCount?: number;
|
|
1299
1291
|
}
|
|
1300
1292
|
interface GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec {
|
|
@@ -1302,9 +1294,13 @@ declare namespace gapi.client {
|
|
|
1302
1294
|
preamble?: string;
|
|
1303
1295
|
}
|
|
1304
1296
|
interface GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec {
|
|
1305
|
-
/** 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
|
|
1297
|
+
/** 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 model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). */
|
|
1306
1298
|
version?: string;
|
|
1307
1299
|
}
|
|
1300
|
+
interface GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec {
|
|
1301
|
+
/** Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. */
|
|
1302
|
+
dataStore?: string;
|
|
1303
|
+
}
|
|
1308
1304
|
interface GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec {
|
|
1309
1305
|
/** The embedding vector used for retrieval. Limit to 1. */
|
|
1310
1306
|
embeddingVectors?: GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector[];
|
|
@@ -1499,7 +1495,7 @@ declare namespace gapi.client {
|
|
|
1499
1495
|
mediaConfig?: GoogleCloudDiscoveryengineV1betaServingConfigMediaConfig;
|
|
1500
1496
|
/** 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
1497
|
modelId?: string;
|
|
1502
|
-
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/
|
|
1498
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}` */
|
|
1503
1499
|
name?: string;
|
|
1504
1500
|
/** 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
1501
|
onewaySynonymsControlIds?: string[];
|
|
@@ -1523,8 +1519,6 @@ declare namespace gapi.client {
|
|
|
1523
1519
|
interface GoogleCloudDiscoveryengineV1betaServingConfigMediaConfig {
|
|
1524
1520
|
/** Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days. */
|
|
1525
1521
|
contentFreshnessCutoffDays?: number;
|
|
1526
|
-
/** Specifies the content watched minutes threshold for demotion. */
|
|
1527
|
-
contentWatchedMinutesThreshold?: number;
|
|
1528
1522
|
/** Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive. */
|
|
1529
1523
|
contentWatchedPercentageThreshold?: number;
|
|
1530
1524
|
/** Specifies the content watched minutes threshold for demotion. */
|
|
@@ -1582,6 +1576,38 @@ 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 GoogleCloudDiscoveryengineV1betaTrainCustomModelRequest {
|
|
1586
|
+
/** The desired location of errors incurred during the data ingestion and training. */
|
|
1587
|
+
errorConfig?: GoogleCloudDiscoveryengineV1betaImportErrorConfig;
|
|
1588
|
+
/** Cloud Storage training input. */
|
|
1589
|
+
gcsTrainingInput?: GoogleCloudDiscoveryengineV1betaTrainCustomModelRequestGcsTrainingInput;
|
|
1590
|
+
/** Model to be trained. Supported values are: * **search-tuning**: Fine tuning the search system based on data provided. */
|
|
1591
|
+
modelType?: string;
|
|
1592
|
+
}
|
|
1593
|
+
interface GoogleCloudDiscoveryengineV1betaTrainCustomModelRequestGcsTrainingInput {
|
|
1594
|
+
/** The Cloud Storage corpus data which could be associated in train data. The data path format is `gs:///`. A newline delimited jsonl/ndjson file. For search-tuning model, each line should have the _id, title and text. Example: `{"_id": "doc1", title: "relevant doc", "text": "relevant text"}` */
|
|
1595
|
+
corpusDataPath?: string;
|
|
1596
|
+
/** The gcs query data which could be associated in train data. The data path format is `gs:///`. A newline delimited jsonl/ndjson file. For search-tuning model, each line should have the _id and text. Example: {"_id": "query1", "text": "example query"} */
|
|
1597
|
+
queryDataPath?: string;
|
|
1598
|
+
/** Cloud Storage test data. Same format as train_data_path. If not provided, a random 80/20 train/test split will be performed on train_data_path. */
|
|
1599
|
+
testDataPath?: string;
|
|
1600
|
+
/** Cloud Storage training data path whose format should be `gs:///`. The file should be in tsv format. Each line should have the doc_id and query_id and score (number). For search-tuning model, it should have the query-id corpus-id score as tsv file header. The score should be a number in `[0, inf+)`. The larger the number is, the more relevant the pair is. Example: * `query-id\tcorpus-id\tscore` * `query1\tdoc1\t1` */
|
|
1601
|
+
trainDataPath?: string;
|
|
1602
|
+
}
|
|
1603
|
+
interface GoogleCloudDiscoveryengineV1betaTrainCustomModelResponse {
|
|
1604
|
+
/** Echoes the destination for the complete errors in the request if set. */
|
|
1605
|
+
errorConfig?: GoogleCloudDiscoveryengineV1betaImportErrorConfig;
|
|
1606
|
+
/** A sample of errors encountered while processing the data. */
|
|
1607
|
+
errorSamples?: GoogleRpcStatus[];
|
|
1608
|
+
/** 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. */
|
|
1609
|
+
modelStatus?: string;
|
|
1610
|
+
}
|
|
1585
1611
|
interface GoogleCloudDiscoveryengineV1betaTransactionInfo {
|
|
1586
1612
|
/** 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
1613
|
cost?: number;
|
|
@@ -1722,7 +1748,6 @@ declare namespace gapi.client {
|
|
|
1722
1748
|
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
1723
1749
|
updateTime?: string;
|
|
1724
1750
|
}
|
|
1725
|
-
interface GoogleCloudDiscoveryengineV1DigitalParsingConfig {}
|
|
1726
1751
|
interface GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata {
|
|
1727
1752
|
/** Operation create time. */
|
|
1728
1753
|
createTime?: string;
|
|
@@ -1744,7 +1769,14 @@ declare namespace gapi.client {
|
|
|
1744
1769
|
/** Configurations applied to digital parser. */
|
|
1745
1770
|
digitalParsingConfig?: any;
|
|
1746
1771
|
/** Configurations applied to OCR parser. Currently it only applies to PDFs. */
|
|
1747
|
-
ocrParsingConfig?:
|
|
1772
|
+
ocrParsingConfig?: GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig;
|
|
1773
|
+
}
|
|
1774
|
+
interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig {}
|
|
1775
|
+
interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig {
|
|
1776
|
+
/** Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. */
|
|
1777
|
+
enhancedDocumentElements?: string[];
|
|
1778
|
+
/** If true, will use native text instead of OCR text on pages containing native text. */
|
|
1779
|
+
useNativeText?: boolean;
|
|
1748
1780
|
}
|
|
1749
1781
|
interface GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata {
|
|
1750
1782
|
/** Operation create time. */
|
|
@@ -1861,12 +1893,6 @@ declare namespace gapi.client {
|
|
|
1861
1893
|
/** Count of user events imported, but with Document information not found in the existing Branch. */
|
|
1862
1894
|
unjoinedEventsCount?: string;
|
|
1863
1895
|
}
|
|
1864
|
-
interface GoogleCloudDiscoveryengineV1OcrParsingConfig {
|
|
1865
|
-
/** Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. */
|
|
1866
|
-
enhancedDocumentElements?: string[];
|
|
1867
|
-
/** If true, will use native text instead of OCR text on pages containing native text. */
|
|
1868
|
-
useNativeText?: boolean;
|
|
1869
|
-
}
|
|
1870
1896
|
interface GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata {
|
|
1871
1897
|
/** Operation create time. */
|
|
1872
1898
|
createTime?: string;
|
|
@@ -3129,7 +3155,7 @@ declare namespace gapi.client {
|
|
|
3129
3155
|
fields?: string;
|
|
3130
3156
|
/** 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
3157
|
key?: string;
|
|
3132
|
-
/** Required. The resource name of the ServingConfig to get. Format: `projects/{project_number}/locations/{location}/collections/{collection}/
|
|
3158
|
+
/** Required. The resource name of the ServingConfig to get. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}` */
|
|
3133
3159
|
name: string;
|
|
3134
3160
|
/** OAuth 2.0 token for the current user. */
|
|
3135
3161
|
oauth_token?: string;
|
|
@@ -3162,7 +3188,7 @@ declare namespace gapi.client {
|
|
|
3162
3188
|
pageSize?: number;
|
|
3163
3189
|
/** Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. */
|
|
3164
3190
|
pageToken?: string;
|
|
3165
|
-
/** Required.
|
|
3191
|
+
/** Required. Full resource name of the parent resource. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` */
|
|
3166
3192
|
parent: string;
|
|
3167
3193
|
/** Returns response with indentations and line breaks. */
|
|
3168
3194
|
prettyPrint?: boolean;
|
|
@@ -3187,7 +3213,7 @@ declare namespace gapi.client {
|
|
|
3187
3213
|
fields?: string;
|
|
3188
3214
|
/** 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
3215
|
key?: string;
|
|
3190
|
-
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/
|
|
3216
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}` */
|
|
3191
3217
|
name: string;
|
|
3192
3218
|
/** OAuth 2.0 token for the current user. */
|
|
3193
3219
|
oauth_token?: string;
|
|
@@ -3218,7 +3244,7 @@ declare namespace gapi.client {
|
|
|
3218
3244
|
fields?: string;
|
|
3219
3245
|
/** 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
3246
|
key?: string;
|
|
3221
|
-
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/
|
|
3247
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}` */
|
|
3222
3248
|
name: string;
|
|
3223
3249
|
/** OAuth 2.0 token for the current user. */
|
|
3224
3250
|
oauth_token?: string;
|
|
@@ -4299,7 +4325,7 @@ declare namespace gapi.client {
|
|
|
4299
4325
|
prettyPrint?: boolean;
|
|
4300
4326
|
/** Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. */
|
|
4301
4327
|
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.
|
|
4328
|
+
/** 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
4329
|
queryModel?: string;
|
|
4304
4330
|
/** 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
4331
|
quotaUser?: string;
|
|
@@ -4552,6 +4578,64 @@ declare namespace gapi.client {
|
|
|
4552
4578
|
},
|
|
4553
4579
|
body: GoogleCloudDiscoveryengineV1betaDataStore
|
|
4554
4580
|
): Request<GoogleCloudDiscoveryengineV1betaDataStore>;
|
|
4581
|
+
/** Trains a custom model. */
|
|
4582
|
+
trainCustomModel(request: {
|
|
4583
|
+
/** V1 error format. */
|
|
4584
|
+
'$.xgafv'?: string;
|
|
4585
|
+
/** OAuth access token. */
|
|
4586
|
+
access_token?: string;
|
|
4587
|
+
/** Data format for response. */
|
|
4588
|
+
alt?: string;
|
|
4589
|
+
/** JSONP */
|
|
4590
|
+
callback?: string;
|
|
4591
|
+
/** Required. The resource name of the Data Store, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to train the models. */
|
|
4592
|
+
dataStore: string;
|
|
4593
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4594
|
+
fields?: string;
|
|
4595
|
+
/** 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. */
|
|
4596
|
+
key?: string;
|
|
4597
|
+
/** OAuth 2.0 token for the current user. */
|
|
4598
|
+
oauth_token?: string;
|
|
4599
|
+
/** Returns response with indentations and line breaks. */
|
|
4600
|
+
prettyPrint?: boolean;
|
|
4601
|
+
/** 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. */
|
|
4602
|
+
quotaUser?: string;
|
|
4603
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4604
|
+
upload_protocol?: string;
|
|
4605
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4606
|
+
uploadType?: string;
|
|
4607
|
+
/** Request body */
|
|
4608
|
+
resource: GoogleCloudDiscoveryengineV1betaTrainCustomModelRequest;
|
|
4609
|
+
}): Request<GoogleLongrunningOperation>;
|
|
4610
|
+
trainCustomModel(
|
|
4611
|
+
request: {
|
|
4612
|
+
/** V1 error format. */
|
|
4613
|
+
'$.xgafv'?: string;
|
|
4614
|
+
/** OAuth access token. */
|
|
4615
|
+
access_token?: string;
|
|
4616
|
+
/** Data format for response. */
|
|
4617
|
+
alt?: string;
|
|
4618
|
+
/** JSONP */
|
|
4619
|
+
callback?: string;
|
|
4620
|
+
/** Required. The resource name of the Data Store, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to train the models. */
|
|
4621
|
+
dataStore: string;
|
|
4622
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4623
|
+
fields?: string;
|
|
4624
|
+
/** 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. */
|
|
4625
|
+
key?: string;
|
|
4626
|
+
/** OAuth 2.0 token for the current user. */
|
|
4627
|
+
oauth_token?: string;
|
|
4628
|
+
/** Returns response with indentations and line breaks. */
|
|
4629
|
+
prettyPrint?: boolean;
|
|
4630
|
+
/** 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. */
|
|
4631
|
+
quotaUser?: string;
|
|
4632
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4633
|
+
upload_protocol?: string;
|
|
4634
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4635
|
+
uploadType?: string;
|
|
4636
|
+
},
|
|
4637
|
+
body: GoogleCloudDiscoveryengineV1betaTrainCustomModelRequest
|
|
4638
|
+
): Request<GoogleLongrunningOperation>;
|
|
4555
4639
|
branches: BranchesResource;
|
|
4556
4640
|
conversations: ConversationsResource;
|
|
4557
4641
|
models: ModelsResource;
|
|
@@ -4908,7 +4992,7 @@ declare namespace gapi.client {
|
|
|
4908
4992
|
fields?: string;
|
|
4909
4993
|
/** 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
4994
|
key?: string;
|
|
4911
|
-
/** Required. The resource name of the ServingConfig to get. Format: `projects/{project_number}/locations/{location}/collections/{collection}/
|
|
4995
|
+
/** Required. The resource name of the ServingConfig to get. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}` */
|
|
4912
4996
|
name: string;
|
|
4913
4997
|
/** OAuth 2.0 token for the current user. */
|
|
4914
4998
|
oauth_token?: string;
|
|
@@ -4941,7 +5025,7 @@ declare namespace gapi.client {
|
|
|
4941
5025
|
pageSize?: number;
|
|
4942
5026
|
/** Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. */
|
|
4943
5027
|
pageToken?: string;
|
|
4944
|
-
/** Required.
|
|
5028
|
+
/** Required. Full resource name of the parent resource. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` */
|
|
4945
5029
|
parent: string;
|
|
4946
5030
|
/** Returns response with indentations and line breaks. */
|
|
4947
5031
|
prettyPrint?: boolean;
|
|
@@ -4966,7 +5050,7 @@ declare namespace gapi.client {
|
|
|
4966
5050
|
fields?: string;
|
|
4967
5051
|
/** 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
5052
|
key?: string;
|
|
4969
|
-
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/
|
|
5053
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}` */
|
|
4970
5054
|
name: string;
|
|
4971
5055
|
/** OAuth 2.0 token for the current user. */
|
|
4972
5056
|
oauth_token?: string;
|
|
@@ -4997,7 +5081,7 @@ declare namespace gapi.client {
|
|
|
4997
5081
|
fields?: string;
|
|
4998
5082
|
/** 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
5083
|
key?: string;
|
|
5000
|
-
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/
|
|
5084
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}` */
|
|
5001
5085
|
name: string;
|
|
5002
5086
|
/** OAuth 2.0 token for the current user. */
|
|
5003
5087
|
oauth_token?: string;
|
|
@@ -6430,7 +6514,7 @@ declare namespace gapi.client {
|
|
|
6430
6514
|
fields?: string;
|
|
6431
6515
|
/** 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
6516
|
key?: string;
|
|
6433
|
-
/** Required. The resource name of the ServingConfig to get. Format: `projects/{project_number}/locations/{location}/collections/{collection}/
|
|
6517
|
+
/** Required. The resource name of the ServingConfig to get. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}` */
|
|
6434
6518
|
name: string;
|
|
6435
6519
|
/** OAuth 2.0 token for the current user. */
|
|
6436
6520
|
oauth_token?: string;
|
|
@@ -6463,7 +6547,7 @@ declare namespace gapi.client {
|
|
|
6463
6547
|
pageSize?: number;
|
|
6464
6548
|
/** Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. */
|
|
6465
6549
|
pageToken?: string;
|
|
6466
|
-
/** Required.
|
|
6550
|
+
/** Required. Full resource name of the parent resource. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` */
|
|
6467
6551
|
parent: string;
|
|
6468
6552
|
/** Returns response with indentations and line breaks. */
|
|
6469
6553
|
prettyPrint?: boolean;
|
|
@@ -6488,7 +6572,7 @@ declare namespace gapi.client {
|
|
|
6488
6572
|
fields?: string;
|
|
6489
6573
|
/** 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
6574
|
key?: string;
|
|
6491
|
-
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/
|
|
6575
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}` */
|
|
6492
6576
|
name: string;
|
|
6493
6577
|
/** OAuth 2.0 token for the current user. */
|
|
6494
6578
|
oauth_token?: string;
|
|
@@ -6519,7 +6603,7 @@ declare namespace gapi.client {
|
|
|
6519
6603
|
fields?: string;
|
|
6520
6604
|
/** 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
6605
|
key?: string;
|
|
6522
|
-
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/
|
|
6606
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}` */
|
|
6523
6607
|
name: string;
|
|
6524
6608
|
/** OAuth 2.0 token for the current user. */
|
|
6525
6609
|
oauth_token?: string;
|
|
@@ -7385,7 +7469,7 @@ declare namespace gapi.client {
|
|
|
7385
7469
|
prettyPrint?: boolean;
|
|
7386
7470
|
/** Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. */
|
|
7387
7471
|
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.
|
|
7472
|
+
/** 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
7473
|
queryModel?: string;
|
|
7390
7474
|
/** 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
7475
|
quotaUser?: string;
|