@googleapis/discoveryengine 5.0.0 → 6.0.0
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/CHANGELOG.md +11 -0
- package/build/v1alpha.d.ts +1233 -127
- package/build/v1alpha.js +144 -0
- package/build/v1alpha.js.map +1 -1
- package/build/v1beta.d.ts +2284 -149
- package/build/v1beta.js +1558 -218
- package/build/v1beta.js.map +1 -1
- package/package.json +1 -1
- package/v1alpha.ts +1662 -212
- package/v1beta.ts +8829 -3274
package/v1alpha.ts
CHANGED
|
@@ -251,7 +251,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
251
251
|
token?: string | null;
|
|
252
252
|
}
|
|
253
253
|
/**
|
|
254
|
-
* Metadata related to the progress of the SiteSearchEngineService.
|
|
254
|
+
* Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
255
255
|
*/
|
|
256
256
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata {
|
|
257
257
|
/**
|
|
@@ -264,7 +264,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
264
264
|
updateTime?: string | null;
|
|
265
265
|
}
|
|
266
266
|
/**
|
|
267
|
-
* Request message for SiteSearchEngineService.
|
|
267
|
+
* Request message for SiteSearchEngineService.BatchCreateTargetSites method.
|
|
268
268
|
*/
|
|
269
269
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesRequest {
|
|
270
270
|
/**
|
|
@@ -331,7 +331,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
331
331
|
*/
|
|
332
332
|
query?: string | null;
|
|
333
333
|
/**
|
|
334
|
-
*
|
|
334
|
+
* 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.
|
|
335
335
|
*/
|
|
336
336
|
queryModel?: string | null;
|
|
337
337
|
/**
|
|
@@ -658,6 +658,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
658
658
|
*/
|
|
659
659
|
updateTime?: string | null;
|
|
660
660
|
}
|
|
661
|
+
/**
|
|
662
|
+
* The digital parsing configurations for documents.
|
|
663
|
+
*/
|
|
664
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaDigitalParsingConfig {}
|
|
661
665
|
/**
|
|
662
666
|
* Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
663
667
|
*/
|
|
@@ -729,7 +733,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
729
733
|
*/
|
|
730
734
|
rawBytes?: string | null;
|
|
731
735
|
/**
|
|
732
|
-
* The URI of the content. Only Cloud Storage URIs (e.g. `gs://bucket-name/path/to/file`) are supported. The maximum file size is 100 MB.
|
|
736
|
+
* The URI of the content. Only Cloud Storage URIs (e.g. `gs://bucket-name/path/to/file`) are supported. The maximum file size is 2.5 MB for text-based formats, 100 MB for other formats.
|
|
733
737
|
*/
|
|
734
738
|
uri?: string | null;
|
|
735
739
|
}
|
|
@@ -763,13 +767,42 @@ export namespace discoveryengine_v1alpha {
|
|
|
763
767
|
*/
|
|
764
768
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig {
|
|
765
769
|
/**
|
|
766
|
-
*
|
|
770
|
+
* 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.
|
|
771
|
+
*/
|
|
772
|
+
defaultParsingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig;
|
|
773
|
+
/**
|
|
774
|
+
* The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`.
|
|
767
775
|
*/
|
|
768
776
|
name?: string | null;
|
|
769
777
|
/**
|
|
770
|
-
* The OCR config. Currently it only applies to PDFs.
|
|
778
|
+
* [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.
|
|
771
779
|
*/
|
|
772
780
|
ocrConfig?: Schema$GoogleCloudDiscoveryengineV1alphaOcrConfig;
|
|
781
|
+
/**
|
|
782
|
+
* 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.
|
|
783
|
+
*/
|
|
784
|
+
parsingConfigOverrides?: {
|
|
785
|
+
[
|
|
786
|
+
key: string
|
|
787
|
+
]: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig;
|
|
788
|
+
} | null;
|
|
789
|
+
}
|
|
790
|
+
/**
|
|
791
|
+
* Related configurations applied to a specific type of document parser.
|
|
792
|
+
*/
|
|
793
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig {
|
|
794
|
+
/**
|
|
795
|
+
* Configurations applied to digital parser.
|
|
796
|
+
*/
|
|
797
|
+
digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDigitalParsingConfig;
|
|
798
|
+
/**
|
|
799
|
+
* Configurations applied to layout parser.
|
|
800
|
+
*/
|
|
801
|
+
layoutParsingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaLayoutParsingConfig;
|
|
802
|
+
/**
|
|
803
|
+
* Configurations applied to OCR parser. Currently it only applies to PDFs.
|
|
804
|
+
*/
|
|
805
|
+
ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaOcrParsingConfig;
|
|
773
806
|
}
|
|
774
807
|
/**
|
|
775
808
|
* Double list.
|
|
@@ -822,7 +855,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
822
855
|
*/
|
|
823
856
|
createTime?: string | null;
|
|
824
857
|
/**
|
|
825
|
-
* The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary
|
|
858
|
+
* The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.
|
|
826
859
|
*/
|
|
827
860
|
dataStoreIds?: string[] | null;
|
|
828
861
|
/**
|
|
@@ -871,7 +904,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
871
904
|
*/
|
|
872
905
|
agentCreationConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig;
|
|
873
906
|
/**
|
|
874
|
-
* The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Please use
|
|
907
|
+
* The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Please use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.
|
|
875
908
|
*/
|
|
876
909
|
dialogflowAgentToLink?: string | null;
|
|
877
910
|
}
|
|
@@ -887,6 +920,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
887
920
|
* Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.
|
|
888
921
|
*/
|
|
889
922
|
defaultLanguageCode?: string | null;
|
|
923
|
+
/**
|
|
924
|
+
* Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default.
|
|
925
|
+
*/
|
|
926
|
+
location?: string | null;
|
|
890
927
|
/**
|
|
891
928
|
* Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.
|
|
892
929
|
*/
|
|
@@ -906,7 +943,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
906
943
|
*/
|
|
907
944
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaEngineCommonConfig {
|
|
908
945
|
/**
|
|
909
|
-
* The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.
|
|
946
|
+
* Immutable. The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.
|
|
910
947
|
*/
|
|
911
948
|
companyName?: string | null;
|
|
912
949
|
}
|
|
@@ -915,7 +952,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
915
952
|
*/
|
|
916
953
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig {
|
|
917
954
|
/**
|
|
918
|
-
* The optimization objective e.g
|
|
955
|
+
* The optimization objective. e.g., `cvr`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `ctr`, `cvr`. If not specified, we choose default based on engine type. Default depends on type of recommendation: `recommended-for-you` =\> `ctr` `others-you-may-like` =\> `ctr`
|
|
919
956
|
*/
|
|
920
957
|
optimizationObjective?: string | null;
|
|
921
958
|
/**
|
|
@@ -927,7 +964,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
927
964
|
*/
|
|
928
965
|
trainingState?: string | null;
|
|
929
966
|
/**
|
|
930
|
-
* Required. The type of engine e.g
|
|
967
|
+
* Required. The type of engine. e.g., `recommended-for-you`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `recommended-for-you`, `others-you-may-like`, `more-like-this`, `most-popular-items`.
|
|
931
968
|
*/
|
|
932
969
|
type?: string | null;
|
|
933
970
|
}
|
|
@@ -1005,7 +1042,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
1005
1042
|
websiteDataSource?: Schema$GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSource;
|
|
1006
1043
|
}
|
|
1007
1044
|
/**
|
|
1008
|
-
* Data source contains files either in
|
|
1045
|
+
* Data source contains files either in Cloud Storage or BigQuery.
|
|
1009
1046
|
*/
|
|
1010
1047
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestFileDataSource {
|
|
1011
1048
|
/**
|
|
@@ -1212,6 +1249,58 @@ export namespace discoveryengine_v1alpha {
|
|
|
1212
1249
|
*/
|
|
1213
1250
|
gcsPrefix?: string | null;
|
|
1214
1251
|
}
|
|
1252
|
+
/**
|
|
1253
|
+
* Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
1254
|
+
*/
|
|
1255
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata {
|
|
1256
|
+
/**
|
|
1257
|
+
* Operation create time.
|
|
1258
|
+
*/
|
|
1259
|
+
createTime?: string | null;
|
|
1260
|
+
/**
|
|
1261
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
1262
|
+
*/
|
|
1263
|
+
updateTime?: string | null;
|
|
1264
|
+
}
|
|
1265
|
+
/**
|
|
1266
|
+
* Request message for CompletionService.ImportSuggestionDenyListEntries method.
|
|
1267
|
+
*/
|
|
1268
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequest {
|
|
1269
|
+
/**
|
|
1270
|
+
* Cloud Storage location for the input content. Only 1 file can be specified that contains all entries to import. Supported values `gcs_source.schema` for autocomplete suggestion deny list entry imports: * `suggestion_deny_list` (default): One JSON [SuggestionDenyListEntry] per line.
|
|
1271
|
+
*/
|
|
1272
|
+
gcsSource?: Schema$GoogleCloudDiscoveryengineV1alphaGcsSource;
|
|
1273
|
+
/**
|
|
1274
|
+
* The Inline source for the input content for suggestion deny list entries.
|
|
1275
|
+
*/
|
|
1276
|
+
inlineSource?: Schema$GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequestInlineSource;
|
|
1277
|
+
}
|
|
1278
|
+
/**
|
|
1279
|
+
* The inline source for SuggestionDenyListEntry.
|
|
1280
|
+
*/
|
|
1281
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequestInlineSource {
|
|
1282
|
+
/**
|
|
1283
|
+
* Required. A list of all denylist entries to import. Max of 1000 items.
|
|
1284
|
+
*/
|
|
1285
|
+
entries?: Schema$GoogleCloudDiscoveryengineV1alphaSuggestionDenyListEntry[];
|
|
1286
|
+
}
|
|
1287
|
+
/**
|
|
1288
|
+
* Response message for CompletionService.ImportSuggestionDenyListEntries method.
|
|
1289
|
+
*/
|
|
1290
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse {
|
|
1291
|
+
/**
|
|
1292
|
+
* A sample of errors encountered while processing the request.
|
|
1293
|
+
*/
|
|
1294
|
+
errorSamples?: Schema$GoogleRpcStatus[];
|
|
1295
|
+
/**
|
|
1296
|
+
* Count of deny list entries that failed to be imported.
|
|
1297
|
+
*/
|
|
1298
|
+
failedEntriesCount?: string | null;
|
|
1299
|
+
/**
|
|
1300
|
+
* Count of deny list entries successfully imported.
|
|
1301
|
+
*/
|
|
1302
|
+
importedEntriesCount?: string | null;
|
|
1303
|
+
}
|
|
1215
1304
|
/**
|
|
1216
1305
|
* Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
1217
1306
|
*/
|
|
@@ -1305,6 +1394,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
1305
1394
|
*/
|
|
1306
1395
|
minimum?: number | null;
|
|
1307
1396
|
}
|
|
1397
|
+
/**
|
|
1398
|
+
* The layout parsing configurations for documents.
|
|
1399
|
+
*/
|
|
1400
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaLayoutParsingConfig {}
|
|
1308
1401
|
/**
|
|
1309
1402
|
* Response for ListConversations method.
|
|
1310
1403
|
*/
|
|
@@ -1423,7 +1516,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
1423
1516
|
*/
|
|
1424
1517
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaOcrConfig {
|
|
1425
1518
|
/**
|
|
1426
|
-
* Required. If OCR is enabled or not. OCR must be enabled for other OcrConfig options to apply.
|
|
1519
|
+
* 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.
|
|
1427
1520
|
*/
|
|
1428
1521
|
enabled?: boolean | null;
|
|
1429
1522
|
/**
|
|
@@ -1435,6 +1528,19 @@ export namespace discoveryengine_v1alpha {
|
|
|
1435
1528
|
*/
|
|
1436
1529
|
useNativeText?: boolean | null;
|
|
1437
1530
|
}
|
|
1531
|
+
/**
|
|
1532
|
+
* The OCR parsing configurations for documents.
|
|
1533
|
+
*/
|
|
1534
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaOcrParsingConfig {
|
|
1535
|
+
/**
|
|
1536
|
+
* Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.
|
|
1537
|
+
*/
|
|
1538
|
+
enhancedDocumentElements?: string[] | null;
|
|
1539
|
+
/**
|
|
1540
|
+
* If true, will use native text instead of OCR text on pages containing native text.
|
|
1541
|
+
*/
|
|
1542
|
+
useNativeText?: boolean | null;
|
|
1543
|
+
}
|
|
1438
1544
|
/**
|
|
1439
1545
|
* Detailed page information.
|
|
1440
1546
|
*/
|
|
@@ -1528,6 +1634,36 @@ export namespace discoveryengine_v1alpha {
|
|
|
1528
1634
|
*/
|
|
1529
1635
|
purgeSample?: string[] | null;
|
|
1530
1636
|
}
|
|
1637
|
+
/**
|
|
1638
|
+
* Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
1639
|
+
*/
|
|
1640
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesMetadata {
|
|
1641
|
+
/**
|
|
1642
|
+
* Operation create time.
|
|
1643
|
+
*/
|
|
1644
|
+
createTime?: string | null;
|
|
1645
|
+
/**
|
|
1646
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
1647
|
+
*/
|
|
1648
|
+
updateTime?: string | null;
|
|
1649
|
+
}
|
|
1650
|
+
/**
|
|
1651
|
+
* Request message for CompletionService.PurgeSuggestionDenyListEntries method.
|
|
1652
|
+
*/
|
|
1653
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesRequest {}
|
|
1654
|
+
/**
|
|
1655
|
+
* Response message for CompletionService.PurgeSuggestionDenyListEntries method.
|
|
1656
|
+
*/
|
|
1657
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesResponse {
|
|
1658
|
+
/**
|
|
1659
|
+
* A sample of errors encountered while processing the request.
|
|
1660
|
+
*/
|
|
1661
|
+
errorSamples?: Schema$GoogleRpcStatus[];
|
|
1662
|
+
/**
|
|
1663
|
+
* Number of suggestion deny list entries purged.
|
|
1664
|
+
*/
|
|
1665
|
+
purgeCount?: string | null;
|
|
1666
|
+
}
|
|
1531
1667
|
/**
|
|
1532
1668
|
* Metadata related to the progress of the PurgeUserEvents operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
1533
1669
|
*/
|
|
@@ -1707,7 +1843,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
1707
1843
|
uri?: string | null;
|
|
1708
1844
|
}
|
|
1709
1845
|
/**
|
|
1710
|
-
* Details about why crawling failed for a particular CorpusType, e.g
|
|
1846
|
+
* Details about why crawling failed for a particular CorpusType, e.g., DESKTOP and MOBILE crawling may fail for different reasons.
|
|
1711
1847
|
*/
|
|
1712
1848
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason {
|
|
1713
1849
|
/**
|
|
@@ -1820,7 +1956,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
1820
1956
|
*/
|
|
1821
1957
|
contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec;
|
|
1822
1958
|
/**
|
|
1823
|
-
* Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.
|
|
1959
|
+
* 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.
|
|
1824
1960
|
*/
|
|
1825
1961
|
embeddingSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec;
|
|
1826
1962
|
/**
|
|
@@ -1936,7 +2072,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
1936
2072
|
*/
|
|
1937
2073
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec {
|
|
1938
2074
|
/**
|
|
1939
|
-
* The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most
|
|
2075
|
+
* The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult.
|
|
1940
2076
|
*/
|
|
1941
2077
|
maxExtractiveAnswerCount?: number | null;
|
|
1942
2078
|
/**
|
|
@@ -2016,7 +2152,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
2016
2152
|
*/
|
|
2017
2153
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec {
|
|
2018
2154
|
/**
|
|
2019
|
-
* The string
|
|
2155
|
+
* 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.
|
|
2020
2156
|
*/
|
|
2021
2157
|
version?: string | null;
|
|
2022
2158
|
}
|
|
@@ -2348,7 +2484,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
2348
2484
|
*/
|
|
2349
2485
|
title?: string | null;
|
|
2350
2486
|
/**
|
|
2351
|
-
*
|
|
2487
|
+
* Cloud Storage or HTTP uri for the document.
|
|
2352
2488
|
*/
|
|
2353
2489
|
uri?: string | null;
|
|
2354
2490
|
}
|
|
@@ -2404,6 +2540,19 @@ export namespace discoveryengine_v1alpha {
|
|
|
2404
2540
|
*/
|
|
2405
2541
|
verifyTime?: string | null;
|
|
2406
2542
|
}
|
|
2543
|
+
/**
|
|
2544
|
+
* Suggestion deny list entry identifying the phrase to block from suggestions and the applied operation for the phrase.
|
|
2545
|
+
*/
|
|
2546
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaSuggestionDenyListEntry {
|
|
2547
|
+
/**
|
|
2548
|
+
* Required. Phrase to block from suggestions served. Can be maximum 125 characters.
|
|
2549
|
+
*/
|
|
2550
|
+
blockPhrase?: string | null;
|
|
2551
|
+
/**
|
|
2552
|
+
* Required. The match operator to apply for this phrase. Whether to block the exact phrase, or block any suggestions containing this phrase.
|
|
2553
|
+
*/
|
|
2554
|
+
matchOperator?: string | null;
|
|
2555
|
+
}
|
|
2407
2556
|
/**
|
|
2408
2557
|
* A target site for the SiteSearchEngine.
|
|
2409
2558
|
*/
|
|
@@ -2437,7 +2586,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
2437
2586
|
*/
|
|
2438
2587
|
siteVerificationInfo?: Schema$GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo;
|
|
2439
2588
|
/**
|
|
2440
|
-
* The type of the target site, e.g
|
|
2589
|
+
* The type of the target site, e.g., whether the site is to be included or excluded.
|
|
2441
2590
|
*/
|
|
2442
2591
|
type?: string | null;
|
|
2443
2592
|
/**
|
|
@@ -2454,7 +2603,12 @@ export namespace discoveryengine_v1alpha {
|
|
|
2454
2603
|
*/
|
|
2455
2604
|
quotaFailure?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure;
|
|
2456
2605
|
}
|
|
2457
|
-
export interface Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure {
|
|
2606
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure {
|
|
2607
|
+
/**
|
|
2608
|
+
* This number is an estimation on how much total quota this project needs to successfully complete indexing.
|
|
2609
|
+
*/
|
|
2610
|
+
totalRequiredQuota?: string | null;
|
|
2611
|
+
}
|
|
2458
2612
|
/**
|
|
2459
2613
|
* Defines text input.
|
|
2460
2614
|
*/
|
|
@@ -2490,7 +2644,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
2490
2644
|
*/
|
|
2491
2645
|
errorConfig?: Schema$GoogleCloudDiscoveryengineV1alphaImportErrorConfig;
|
|
2492
2646
|
/**
|
|
2493
|
-
*
|
|
2647
|
+
* Cloud Storage training input.
|
|
2494
2648
|
*/
|
|
2495
2649
|
gcsTrainingInput?: Schema$GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequestGcsTrainingInput;
|
|
2496
2650
|
/**
|
|
@@ -2499,23 +2653,23 @@ export namespace discoveryengine_v1alpha {
|
|
|
2499
2653
|
modelType?: string | null;
|
|
2500
2654
|
}
|
|
2501
2655
|
/**
|
|
2502
|
-
*
|
|
2656
|
+
* Cloud Storage training data input.
|
|
2503
2657
|
*/
|
|
2504
2658
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequestGcsTrainingInput {
|
|
2505
2659
|
/**
|
|
2506
|
-
* The
|
|
2660
|
+
* 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"\}
|
|
2507
2661
|
*/
|
|
2508
2662
|
corpusDataPath?: string | null;
|
|
2509
2663
|
/**
|
|
2510
|
-
* The gcs query data which could be associated in train data. The data path format is gs:///. A newline delimited jsonl/ndjson file.
|
|
2664
|
+
* 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"\}
|
|
2511
2665
|
*/
|
|
2512
2666
|
queryDataPath?: string | null;
|
|
2513
2667
|
/**
|
|
2514
|
-
*
|
|
2668
|
+
* 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.
|
|
2515
2669
|
*/
|
|
2516
2670
|
testDataPath?: string | null;
|
|
2517
2671
|
/**
|
|
2518
|
-
*
|
|
2672
|
+
* 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
|
|
2519
2673
|
*/
|
|
2520
2674
|
trainDataPath?: string | null;
|
|
2521
2675
|
}
|
|
@@ -2643,7 +2797,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
2643
2797
|
*/
|
|
2644
2798
|
eventType?: string | null;
|
|
2645
2799
|
/**
|
|
2646
|
-
* The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a
|
|
2800
|
+
* The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
|
2647
2801
|
*/
|
|
2648
2802
|
filter?: string | null;
|
|
2649
2803
|
/**
|
|
@@ -2811,6 +2965,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
2811
2965
|
key: string
|
|
2812
2966
|
]: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigUIComponentField;
|
|
2813
2967
|
} | null;
|
|
2968
|
+
/**
|
|
2969
|
+
* Output only. The industry vertical that the WidgetConfig registers. The WidgetConfig industry vertical is based on the associated Engine.
|
|
2970
|
+
*/
|
|
2971
|
+
industryVertical?: string | null;
|
|
2814
2972
|
/**
|
|
2815
2973
|
* Output only. Whether LLM is enabled in the corresponding data store.
|
|
2816
2974
|
*/
|
|
@@ -2935,9 +3093,9 @@ export namespace discoveryengine_v1alpha {
|
|
|
2935
3093
|
uToken?: string | null;
|
|
2936
3094
|
}
|
|
2937
3095
|
/**
|
|
2938
|
-
* Metadata
|
|
3096
|
+
* Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
2939
3097
|
*/
|
|
2940
|
-
export interface Schema$
|
|
3098
|
+
export interface Schema$GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata {
|
|
2941
3099
|
/**
|
|
2942
3100
|
* Operation create time.
|
|
2943
3101
|
*/
|
|
@@ -2948,158 +3106,125 @@ export namespace discoveryengine_v1alpha {
|
|
|
2948
3106
|
updateTime?: string | null;
|
|
2949
3107
|
}
|
|
2950
3108
|
/**
|
|
2951
|
-
*
|
|
3109
|
+
* Response message for SiteSearchEngineService.BatchCreateTargetSites method.
|
|
2952
3110
|
*/
|
|
2953
|
-
export interface Schema$
|
|
2954
|
-
/**
|
|
2955
|
-
* Operation create time.
|
|
2956
|
-
*/
|
|
2957
|
-
createTime?: string | null;
|
|
3111
|
+
export interface Schema$GoogleCloudDiscoveryengineV1BatchCreateTargetSitesResponse {
|
|
2958
3112
|
/**
|
|
2959
|
-
*
|
|
3113
|
+
* TargetSites created.
|
|
2960
3114
|
*/
|
|
2961
|
-
|
|
3115
|
+
targetSites?: Schema$GoogleCloudDiscoveryengineV1TargetSite[];
|
|
2962
3116
|
}
|
|
2963
3117
|
/**
|
|
2964
|
-
* Metadata related to the progress of the
|
|
3118
|
+
* Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
2965
3119
|
*/
|
|
2966
|
-
export interface Schema$
|
|
3120
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata {
|
|
2967
3121
|
/**
|
|
2968
3122
|
* Operation create time.
|
|
2969
3123
|
*/
|
|
2970
3124
|
createTime?: string | null;
|
|
2971
|
-
/**
|
|
2972
|
-
* Count of entries that encountered errors while processing.
|
|
2973
|
-
*/
|
|
2974
|
-
failureCount?: string | null;
|
|
2975
|
-
/**
|
|
2976
|
-
* Count of entries that were processed successfully.
|
|
2977
|
-
*/
|
|
2978
|
-
successCount?: string | null;
|
|
2979
3125
|
/**
|
|
2980
3126
|
* Operation last update time. If the operation is done, this is also the finish time.
|
|
2981
3127
|
*/
|
|
2982
3128
|
updateTime?: string | null;
|
|
2983
3129
|
}
|
|
2984
3130
|
/**
|
|
2985
|
-
* Response
|
|
3131
|
+
* Response message for SiteSearchEngineService.BatchCreateTargetSites method.
|
|
2986
3132
|
*/
|
|
2987
|
-
export interface Schema$
|
|
2988
|
-
/**
|
|
2989
|
-
* Echoes the destination for the complete errors in the request if set.
|
|
2990
|
-
*/
|
|
2991
|
-
errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig;
|
|
3133
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesResponse {
|
|
2992
3134
|
/**
|
|
2993
|
-
*
|
|
3135
|
+
* TargetSites created.
|
|
2994
3136
|
*/
|
|
2995
|
-
|
|
3137
|
+
targetSites?: Schema$GoogleCloudDiscoveryengineV1betaTargetSite[];
|
|
2996
3138
|
}
|
|
2997
3139
|
/**
|
|
2998
|
-
*
|
|
3140
|
+
* Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
2999
3141
|
*/
|
|
3000
|
-
export interface Schema$
|
|
3142
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata {
|
|
3001
3143
|
/**
|
|
3002
|
-
*
|
|
3144
|
+
* Operation create time.
|
|
3003
3145
|
*/
|
|
3004
|
-
|
|
3146
|
+
createTime?: string | null;
|
|
3147
|
+
/**
|
|
3148
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3149
|
+
*/
|
|
3150
|
+
updateTime?: string | null;
|
|
3005
3151
|
}
|
|
3006
3152
|
/**
|
|
3007
|
-
* Metadata related to the progress of the
|
|
3153
|
+
* Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3008
3154
|
*/
|
|
3009
|
-
export interface Schema$
|
|
3155
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaCreateEngineMetadata {
|
|
3010
3156
|
/**
|
|
3011
3157
|
* Operation create time.
|
|
3012
3158
|
*/
|
|
3013
3159
|
createTime?: string | null;
|
|
3014
|
-
/**
|
|
3015
|
-
* Count of entries that encountered errors while processing.
|
|
3016
|
-
*/
|
|
3017
|
-
failureCount?: string | null;
|
|
3018
|
-
/**
|
|
3019
|
-
* Count of entries that were processed successfully.
|
|
3020
|
-
*/
|
|
3021
|
-
successCount?: string | null;
|
|
3022
3160
|
/**
|
|
3023
3161
|
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3024
3162
|
*/
|
|
3025
3163
|
updateTime?: string | null;
|
|
3026
3164
|
}
|
|
3027
3165
|
/**
|
|
3028
|
-
*
|
|
3166
|
+
* Metadata for Create Schema LRO.
|
|
3029
3167
|
*/
|
|
3030
|
-
export interface Schema$
|
|
3031
|
-
/**
|
|
3032
|
-
* Echoes the destination for the complete errors if this field was set in the request.
|
|
3033
|
-
*/
|
|
3034
|
-
errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig;
|
|
3035
|
-
/**
|
|
3036
|
-
* A sample of errors encountered while processing the request.
|
|
3037
|
-
*/
|
|
3038
|
-
errorSamples?: Schema$GoogleRpcStatus[];
|
|
3168
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata {
|
|
3039
3169
|
/**
|
|
3040
|
-
*
|
|
3170
|
+
* Operation create time.
|
|
3041
3171
|
*/
|
|
3042
|
-
|
|
3172
|
+
createTime?: string | null;
|
|
3043
3173
|
/**
|
|
3044
|
-
*
|
|
3174
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3045
3175
|
*/
|
|
3046
|
-
|
|
3176
|
+
updateTime?: string | null;
|
|
3047
3177
|
}
|
|
3048
3178
|
/**
|
|
3049
|
-
* Metadata related to the progress of the
|
|
3179
|
+
* Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3050
3180
|
*/
|
|
3051
|
-
export interface Schema$
|
|
3181
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaCreateTargetSiteMetadata {
|
|
3052
3182
|
/**
|
|
3053
3183
|
* Operation create time.
|
|
3054
3184
|
*/
|
|
3055
3185
|
createTime?: string | null;
|
|
3056
|
-
/**
|
|
3057
|
-
* Count of entries that encountered errors while processing.
|
|
3058
|
-
*/
|
|
3059
|
-
failureCount?: string | null;
|
|
3060
|
-
/**
|
|
3061
|
-
* Count of entries that were deleted successfully.
|
|
3062
|
-
*/
|
|
3063
|
-
successCount?: string | null;
|
|
3064
3186
|
/**
|
|
3065
3187
|
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3066
3188
|
*/
|
|
3067
3189
|
updateTime?: string | null;
|
|
3068
3190
|
}
|
|
3069
3191
|
/**
|
|
3070
|
-
*
|
|
3192
|
+
* DataStore captures global settings and configs at the DataStore level.
|
|
3071
3193
|
*/
|
|
3072
|
-
export interface Schema$
|
|
3194
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaDataStore {
|
|
3073
3195
|
/**
|
|
3074
|
-
* The
|
|
3196
|
+
* Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
|
|
3075
3197
|
*/
|
|
3076
|
-
|
|
3198
|
+
contentConfig?: string | null;
|
|
3077
3199
|
/**
|
|
3078
|
-
*
|
|
3200
|
+
* Output only. Timestamp the DataStore was created at.
|
|
3079
3201
|
*/
|
|
3080
|
-
|
|
3081
|
-
}
|
|
3082
|
-
/**
|
|
3083
|
-
* Defines the structure and layout of a type of document data.
|
|
3084
|
-
*/
|
|
3085
|
-
export interface Schema$GoogleCloudDiscoveryengineV1betaSchema {
|
|
3202
|
+
createTime?: string | null;
|
|
3086
3203
|
/**
|
|
3087
|
-
* The
|
|
3204
|
+
* Output only. The id of the default Schema asscociated to this data store.
|
|
3088
3205
|
*/
|
|
3089
|
-
|
|
3206
|
+
defaultSchemaId?: string | null;
|
|
3090
3207
|
/**
|
|
3091
|
-
*
|
|
3208
|
+
* Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
|
3209
|
+
*/
|
|
3210
|
+
displayName?: string | null;
|
|
3211
|
+
/**
|
|
3212
|
+
* Immutable. The industry vertical that the data store registers.
|
|
3213
|
+
*/
|
|
3214
|
+
industryVertical?: string | null;
|
|
3215
|
+
/**
|
|
3216
|
+
* Immutable. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
3092
3217
|
*/
|
|
3093
3218
|
name?: string | null;
|
|
3094
3219
|
/**
|
|
3095
|
-
* The
|
|
3220
|
+
* The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.
|
|
3096
3221
|
*/
|
|
3097
|
-
|
|
3222
|
+
solutionTypes?: string[] | null;
|
|
3098
3223
|
}
|
|
3099
3224
|
/**
|
|
3100
|
-
* Metadata
|
|
3225
|
+
* Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3101
3226
|
*/
|
|
3102
|
-
export interface Schema$
|
|
3227
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata {
|
|
3103
3228
|
/**
|
|
3104
3229
|
* Operation create time.
|
|
3105
3230
|
*/
|
|
@@ -3110,9 +3235,9 @@ export namespace discoveryengine_v1alpha {
|
|
|
3110
3235
|
updateTime?: string | null;
|
|
3111
3236
|
}
|
|
3112
3237
|
/**
|
|
3113
|
-
* Metadata
|
|
3238
|
+
* Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3114
3239
|
*/
|
|
3115
|
-
export interface Schema$
|
|
3240
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaDeleteEngineMetadata {
|
|
3116
3241
|
/**
|
|
3117
3242
|
* Operation create time.
|
|
3118
3243
|
*/
|
|
@@ -3125,7 +3250,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
3125
3250
|
/**
|
|
3126
3251
|
* Metadata for DeleteSchema LRO.
|
|
3127
3252
|
*/
|
|
3128
|
-
export interface Schema$
|
|
3253
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata {
|
|
3129
3254
|
/**
|
|
3130
3255
|
* Operation create time.
|
|
3131
3256
|
*/
|
|
@@ -3136,48 +3261,811 @@ export namespace discoveryengine_v1alpha {
|
|
|
3136
3261
|
updateTime?: string | null;
|
|
3137
3262
|
}
|
|
3138
3263
|
/**
|
|
3139
|
-
* Metadata related to the progress of the
|
|
3264
|
+
* Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3140
3265
|
*/
|
|
3141
|
-
export interface Schema$
|
|
3266
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaDeleteTargetSiteMetadata {
|
|
3142
3267
|
/**
|
|
3143
3268
|
* Operation create time.
|
|
3144
3269
|
*/
|
|
3145
3270
|
createTime?: string | null;
|
|
3146
|
-
/**
|
|
3147
|
-
* Count of entries that encountered errors while processing.
|
|
3148
|
-
*/
|
|
3149
|
-
failureCount?: string | null;
|
|
3150
|
-
/**
|
|
3151
|
-
* Count of entries that were processed successfully.
|
|
3152
|
-
*/
|
|
3153
|
-
successCount?: string | null;
|
|
3154
3271
|
/**
|
|
3155
3272
|
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3156
3273
|
*/
|
|
3157
3274
|
updateTime?: string | null;
|
|
3158
3275
|
}
|
|
3159
3276
|
/**
|
|
3160
|
-
*
|
|
3277
|
+
* Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3161
3278
|
*/
|
|
3162
|
-
export interface Schema$
|
|
3279
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata {
|
|
3163
3280
|
/**
|
|
3164
|
-
*
|
|
3281
|
+
* Operation create time.
|
|
3165
3282
|
*/
|
|
3166
|
-
|
|
3283
|
+
createTime?: string | null;
|
|
3167
3284
|
/**
|
|
3168
|
-
*
|
|
3285
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3169
3286
|
*/
|
|
3170
|
-
|
|
3287
|
+
updateTime?: string | null;
|
|
3171
3288
|
}
|
|
3172
3289
|
/**
|
|
3173
|
-
*
|
|
3290
|
+
* Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.
|
|
3174
3291
|
*/
|
|
3175
|
-
export interface Schema$
|
|
3292
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse {}
|
|
3293
|
+
/**
|
|
3294
|
+
* Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3295
|
+
*/
|
|
3296
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata {
|
|
3297
|
+
/**
|
|
3298
|
+
* Operation create time.
|
|
3299
|
+
*/
|
|
3300
|
+
createTime?: string | null;
|
|
3301
|
+
/**
|
|
3302
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3303
|
+
*/
|
|
3304
|
+
updateTime?: string | null;
|
|
3305
|
+
}
|
|
3306
|
+
/**
|
|
3307
|
+
* Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.
|
|
3308
|
+
*/
|
|
3309
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchResponse {}
|
|
3310
|
+
/**
|
|
3311
|
+
* Metadata that describes the training and serving parameters of an Engine.
|
|
3312
|
+
*/
|
|
3313
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaEngine {
|
|
3314
|
+
/**
|
|
3315
|
+
* Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
|
|
3316
|
+
*/
|
|
3317
|
+
chatEngineConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig;
|
|
3318
|
+
/**
|
|
3319
|
+
* Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
|
|
3320
|
+
*/
|
|
3321
|
+
chatEngineMetadata?: Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata;
|
|
3322
|
+
/**
|
|
3323
|
+
* Common config spec that specifies the metadata of the engine.
|
|
3324
|
+
*/
|
|
3325
|
+
commonConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineCommonConfig;
|
|
3326
|
+
/**
|
|
3327
|
+
* Output only. Timestamp the Recommendation Engine was created at.
|
|
3328
|
+
*/
|
|
3329
|
+
createTime?: string | null;
|
|
3330
|
+
/**
|
|
3331
|
+
* The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.
|
|
3332
|
+
*/
|
|
3333
|
+
dataStoreIds?: string[] | null;
|
|
3334
|
+
/**
|
|
3335
|
+
* Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
|
|
3336
|
+
*/
|
|
3337
|
+
displayName?: string | null;
|
|
3338
|
+
/**
|
|
3339
|
+
* The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore liniked to the engine.
|
|
3340
|
+
*/
|
|
3341
|
+
industryVertical?: string | null;
|
|
3342
|
+
/**
|
|
3343
|
+
* Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned.
|
|
3344
|
+
*/
|
|
3345
|
+
name?: string | null;
|
|
3346
|
+
/**
|
|
3347
|
+
* Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
|
|
3348
|
+
*/
|
|
3349
|
+
searchEngineConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig;
|
|
3350
|
+
/**
|
|
3351
|
+
* Required. The solutions of the engine.
|
|
3352
|
+
*/
|
|
3353
|
+
solutionType?: string | null;
|
|
3354
|
+
/**
|
|
3355
|
+
* Output only. Timestamp the Recommendation Engine was last updated.
|
|
3356
|
+
*/
|
|
3357
|
+
updateTime?: string | null;
|
|
3358
|
+
}
|
|
3359
|
+
/**
|
|
3360
|
+
* Configurations for a Chat Engine.
|
|
3361
|
+
*/
|
|
3362
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig {
|
|
3363
|
+
/**
|
|
3364
|
+
* The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.
|
|
3365
|
+
*/
|
|
3366
|
+
agentCreationConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig;
|
|
3367
|
+
/**
|
|
3368
|
+
* The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Please use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.
|
|
3369
|
+
*/
|
|
3370
|
+
dialogflowAgentToLink?: string | null;
|
|
3371
|
+
}
|
|
3372
|
+
/**
|
|
3373
|
+
* Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.
|
|
3374
|
+
*/
|
|
3375
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig {
|
|
3376
|
+
/**
|
|
3377
|
+
* Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.
|
|
3378
|
+
*/
|
|
3379
|
+
business?: string | null;
|
|
3380
|
+
/**
|
|
3381
|
+
* Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.
|
|
3382
|
+
*/
|
|
3383
|
+
defaultLanguageCode?: string | null;
|
|
3384
|
+
/**
|
|
3385
|
+
* Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default.
|
|
3386
|
+
*/
|
|
3387
|
+
location?: string | null;
|
|
3388
|
+
/**
|
|
3389
|
+
* Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.
|
|
3390
|
+
*/
|
|
3391
|
+
timeZone?: string | null;
|
|
3392
|
+
}
|
|
3393
|
+
/**
|
|
3394
|
+
* Additional information of a Chat Engine. Fields in this message are output only.
|
|
3395
|
+
*/
|
|
3396
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata {
|
|
3397
|
+
/**
|
|
3398
|
+
* The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.
|
|
3399
|
+
*/
|
|
3400
|
+
dialogflowAgent?: string | null;
|
|
3401
|
+
}
|
|
3402
|
+
/**
|
|
3403
|
+
* Common configurations for an Engine.
|
|
3404
|
+
*/
|
|
3405
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaEngineCommonConfig {
|
|
3406
|
+
/**
|
|
3407
|
+
* Immutable. The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.
|
|
3408
|
+
*/
|
|
3409
|
+
companyName?: string | null;
|
|
3410
|
+
}
|
|
3411
|
+
/**
|
|
3412
|
+
* Configurations for a Search Engine.
|
|
3413
|
+
*/
|
|
3414
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig {
|
|
3415
|
+
/**
|
|
3416
|
+
* The add-on that this search engine enables.
|
|
3417
|
+
*/
|
|
3418
|
+
searchAddOns?: string[] | null;
|
|
3419
|
+
/**
|
|
3420
|
+
* The search feature tier of this engine. Different tiers might have different pricing. To learn more, please check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.
|
|
3421
|
+
*/
|
|
3422
|
+
searchTier?: string | null;
|
|
3423
|
+
}
|
|
3424
|
+
/**
|
|
3425
|
+
* Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
3426
|
+
*/
|
|
3427
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata {
|
|
3428
|
+
/**
|
|
3429
|
+
* Operation create time.
|
|
3430
|
+
*/
|
|
3431
|
+
createTime?: string | null;
|
|
3432
|
+
/**
|
|
3433
|
+
* Count of entries that encountered errors while processing.
|
|
3434
|
+
*/
|
|
3435
|
+
failureCount?: string | null;
|
|
3436
|
+
/**
|
|
3437
|
+
* Count of entries that were processed successfully.
|
|
3438
|
+
*/
|
|
3439
|
+
successCount?: string | null;
|
|
3440
|
+
/**
|
|
3441
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3442
|
+
*/
|
|
3443
|
+
updateTime?: string | null;
|
|
3444
|
+
}
|
|
3445
|
+
/**
|
|
3446
|
+
* Response of the ImportDocumentsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.
|
|
3447
|
+
*/
|
|
3448
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaImportDocumentsResponse {
|
|
3449
|
+
/**
|
|
3450
|
+
* Echoes the destination for the complete errors in the request if set.
|
|
3451
|
+
*/
|
|
3452
|
+
errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig;
|
|
3453
|
+
/**
|
|
3454
|
+
* A sample of errors encountered while processing the request.
|
|
3455
|
+
*/
|
|
3456
|
+
errorSamples?: Schema$GoogleRpcStatus[];
|
|
3457
|
+
}
|
|
3458
|
+
/**
|
|
3459
|
+
* Configuration of destination for Import related errors.
|
|
3460
|
+
*/
|
|
3461
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig {
|
|
3462
|
+
/**
|
|
3463
|
+
* Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.
|
|
3464
|
+
*/
|
|
3465
|
+
gcsPrefix?: string | null;
|
|
3466
|
+
}
|
|
3467
|
+
/**
|
|
3468
|
+
* Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
3469
|
+
*/
|
|
3470
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata {
|
|
3471
|
+
/**
|
|
3472
|
+
* Operation create time.
|
|
3473
|
+
*/
|
|
3474
|
+
createTime?: string | null;
|
|
3475
|
+
/**
|
|
3476
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3477
|
+
*/
|
|
3478
|
+
updateTime?: string | null;
|
|
3479
|
+
}
|
|
3480
|
+
/**
|
|
3481
|
+
* Response message for CompletionService.ImportSuggestionDenyListEntries method.
|
|
3482
|
+
*/
|
|
3483
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesResponse {
|
|
3484
|
+
/**
|
|
3485
|
+
* A sample of errors encountered while processing the request.
|
|
3486
|
+
*/
|
|
3487
|
+
errorSamples?: Schema$GoogleRpcStatus[];
|
|
3488
|
+
/**
|
|
3489
|
+
* Count of deny list entries that failed to be imported.
|
|
3490
|
+
*/
|
|
3491
|
+
failedEntriesCount?: string | null;
|
|
3492
|
+
/**
|
|
3493
|
+
* Count of deny list entries successfully imported.
|
|
3494
|
+
*/
|
|
3495
|
+
importedEntriesCount?: string | null;
|
|
3496
|
+
}
|
|
3497
|
+
/**
|
|
3498
|
+
* Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
3499
|
+
*/
|
|
3500
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata {
|
|
3501
|
+
/**
|
|
3502
|
+
* Operation create time.
|
|
3503
|
+
*/
|
|
3504
|
+
createTime?: string | null;
|
|
3505
|
+
/**
|
|
3506
|
+
* Count of entries that encountered errors while processing.
|
|
3507
|
+
*/
|
|
3508
|
+
failureCount?: string | null;
|
|
3509
|
+
/**
|
|
3510
|
+
* Count of entries that were processed successfully.
|
|
3511
|
+
*/
|
|
3512
|
+
successCount?: string | null;
|
|
3513
|
+
/**
|
|
3514
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3515
|
+
*/
|
|
3516
|
+
updateTime?: string | null;
|
|
3517
|
+
}
|
|
3518
|
+
/**
|
|
3519
|
+
* Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.
|
|
3520
|
+
*/
|
|
3521
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaImportUserEventsResponse {
|
|
3522
|
+
/**
|
|
3523
|
+
* Echoes the destination for the complete errors if this field was set in the request.
|
|
3524
|
+
*/
|
|
3525
|
+
errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig;
|
|
3526
|
+
/**
|
|
3527
|
+
* A sample of errors encountered while processing the request.
|
|
3528
|
+
*/
|
|
3529
|
+
errorSamples?: Schema$GoogleRpcStatus[];
|
|
3530
|
+
/**
|
|
3531
|
+
* Count of user events imported with complete existing Documents.
|
|
3532
|
+
*/
|
|
3533
|
+
joinedEventsCount?: string | null;
|
|
3534
|
+
/**
|
|
3535
|
+
* Count of user events imported, but with Document information not found in the existing Branch.
|
|
3536
|
+
*/
|
|
3537
|
+
unjoinedEventsCount?: string | null;
|
|
3538
|
+
}
|
|
3539
|
+
/**
|
|
3540
|
+
* Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3541
|
+
*/
|
|
3542
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata {
|
|
3543
|
+
/**
|
|
3544
|
+
* Operation create time.
|
|
3545
|
+
*/
|
|
3546
|
+
createTime?: string | null;
|
|
3547
|
+
/**
|
|
3548
|
+
* Count of entries that encountered errors while processing.
|
|
3549
|
+
*/
|
|
3550
|
+
failureCount?: string | null;
|
|
3551
|
+
/**
|
|
3552
|
+
* Count of entries that were deleted successfully.
|
|
3553
|
+
*/
|
|
3554
|
+
successCount?: string | null;
|
|
3555
|
+
/**
|
|
3556
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3557
|
+
*/
|
|
3558
|
+
updateTime?: string | null;
|
|
3559
|
+
}
|
|
3560
|
+
/**
|
|
3561
|
+
* Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.
|
|
3562
|
+
*/
|
|
3563
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse {
|
|
3564
|
+
/**
|
|
3565
|
+
* The total count of documents purged as a result of the operation.
|
|
3566
|
+
*/
|
|
3567
|
+
purgeCount?: string | null;
|
|
3568
|
+
/**
|
|
3569
|
+
* A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random.
|
|
3570
|
+
*/
|
|
3571
|
+
purgeSample?: string[] | null;
|
|
3572
|
+
}
|
|
3573
|
+
/**
|
|
3574
|
+
* Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
3575
|
+
*/
|
|
3576
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata {
|
|
3577
|
+
/**
|
|
3578
|
+
* Operation create time.
|
|
3579
|
+
*/
|
|
3580
|
+
createTime?: string | null;
|
|
3581
|
+
/**
|
|
3582
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3583
|
+
*/
|
|
3584
|
+
updateTime?: string | null;
|
|
3585
|
+
}
|
|
3586
|
+
/**
|
|
3587
|
+
* Response message for CompletionService.PurgeSuggestionDenyListEntries method.
|
|
3588
|
+
*/
|
|
3589
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse {
|
|
3590
|
+
/**
|
|
3591
|
+
* A sample of errors encountered while processing the request.
|
|
3592
|
+
*/
|
|
3593
|
+
errorSamples?: Schema$GoogleRpcStatus[];
|
|
3594
|
+
/**
|
|
3595
|
+
* Number of suggestion deny list entries purged.
|
|
3596
|
+
*/
|
|
3597
|
+
purgeCount?: string | null;
|
|
3598
|
+
}
|
|
3599
|
+
/**
|
|
3600
|
+
* Defines the structure and layout of a type of document data.
|
|
3601
|
+
*/
|
|
3602
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaSchema {
|
|
3603
|
+
/**
|
|
3604
|
+
* The JSON representation of the schema.
|
|
3605
|
+
*/
|
|
3606
|
+
jsonSchema?: string | null;
|
|
3607
|
+
/**
|
|
3608
|
+
* Immutable. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
3609
|
+
*/
|
|
3610
|
+
name?: string | null;
|
|
3611
|
+
/**
|
|
3612
|
+
* The structured representation of the schema.
|
|
3613
|
+
*/
|
|
3614
|
+
structSchema?: {[key: string]: any} | null;
|
|
3615
|
+
}
|
|
3616
|
+
/**
|
|
3617
|
+
* Verification information for target sites in advanced site search.
|
|
3618
|
+
*/
|
|
3619
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaSiteVerificationInfo {
|
|
3620
|
+
/**
|
|
3621
|
+
* Site verification state indicating the ownership and validity.
|
|
3622
|
+
*/
|
|
3623
|
+
siteVerificationState?: string | null;
|
|
3624
|
+
/**
|
|
3625
|
+
* Latest site verification time.
|
|
3626
|
+
*/
|
|
3627
|
+
verifyTime?: string | null;
|
|
3628
|
+
}
|
|
3629
|
+
/**
|
|
3630
|
+
* A target site for the SiteSearchEngine.
|
|
3631
|
+
*/
|
|
3632
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaTargetSite {
|
|
3633
|
+
/**
|
|
3634
|
+
* Input only. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern is always normalized to generate the URI pattern to be used by the search engine.
|
|
3635
|
+
*/
|
|
3636
|
+
exactMatch?: boolean | null;
|
|
3637
|
+
/**
|
|
3638
|
+
* Output only. Failure reason.
|
|
3639
|
+
*/
|
|
3640
|
+
failureReason?: Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReason;
|
|
3641
|
+
/**
|
|
3642
|
+
* Output only. This is system-generated based on the provided_uri_pattern.
|
|
3643
|
+
*/
|
|
3644
|
+
generatedUriPattern?: string | null;
|
|
3645
|
+
/**
|
|
3646
|
+
* Output only. Indexing status.
|
|
3647
|
+
*/
|
|
3648
|
+
indexingStatus?: string | null;
|
|
3649
|
+
/**
|
|
3650
|
+
* Output only. The fully qualified resource name of the target site. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}` The `target_site_id` is system-generated.
|
|
3651
|
+
*/
|
|
3652
|
+
name?: string | null;
|
|
3653
|
+
/**
|
|
3654
|
+
* Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated.
|
|
3655
|
+
*/
|
|
3656
|
+
providedUriPattern?: string | null;
|
|
3657
|
+
/**
|
|
3658
|
+
* Output only. Site ownership and validity verification status.
|
|
3659
|
+
*/
|
|
3660
|
+
siteVerificationInfo?: Schema$GoogleCloudDiscoveryengineV1betaSiteVerificationInfo;
|
|
3661
|
+
/**
|
|
3662
|
+
* The type of the target site, e.g., whether the site is to be included or excluded.
|
|
3663
|
+
*/
|
|
3664
|
+
type?: string | null;
|
|
3665
|
+
/**
|
|
3666
|
+
* Output only. The target site's last updated time.
|
|
3667
|
+
*/
|
|
3668
|
+
updateTime?: string | null;
|
|
3669
|
+
}
|
|
3670
|
+
/**
|
|
3671
|
+
* Site search indexing failure reasons.
|
|
3672
|
+
*/
|
|
3673
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReason {
|
|
3674
|
+
/**
|
|
3675
|
+
* Failed due to insufficient quota.
|
|
3676
|
+
*/
|
|
3677
|
+
quotaFailure?: Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure;
|
|
3678
|
+
}
|
|
3679
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure {
|
|
3680
|
+
/**
|
|
3681
|
+
* This number is an estimation on how much total quota this project needs to successfully complete indexing.
|
|
3682
|
+
*/
|
|
3683
|
+
totalRequiredQuota?: string | null;
|
|
3684
|
+
}
|
|
3685
|
+
/**
|
|
3686
|
+
* Metadata for UpdateSchema LRO.
|
|
3687
|
+
*/
|
|
3688
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaUpdateSchemaMetadata {
|
|
3689
|
+
/**
|
|
3690
|
+
* Operation create time.
|
|
3691
|
+
*/
|
|
3692
|
+
createTime?: string | null;
|
|
3693
|
+
/**
|
|
3694
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3695
|
+
*/
|
|
3696
|
+
updateTime?: string | null;
|
|
3697
|
+
}
|
|
3698
|
+
/**
|
|
3699
|
+
* Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3700
|
+
*/
|
|
3701
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaUpdateTargetSiteMetadata {
|
|
3702
|
+
/**
|
|
3703
|
+
* Operation create time.
|
|
3704
|
+
*/
|
|
3705
|
+
createTime?: string | null;
|
|
3706
|
+
/**
|
|
3707
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3708
|
+
*/
|
|
3709
|
+
updateTime?: string | null;
|
|
3710
|
+
}
|
|
3711
|
+
/**
|
|
3712
|
+
* Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3713
|
+
*/
|
|
3714
|
+
export interface Schema$GoogleCloudDiscoveryengineV1CreateDataStoreMetadata {
|
|
3715
|
+
/**
|
|
3716
|
+
* Operation create time.
|
|
3717
|
+
*/
|
|
3718
|
+
createTime?: string | null;
|
|
3719
|
+
/**
|
|
3720
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3721
|
+
*/
|
|
3722
|
+
updateTime?: string | null;
|
|
3723
|
+
}
|
|
3724
|
+
/**
|
|
3725
|
+
* Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3726
|
+
*/
|
|
3727
|
+
export interface Schema$GoogleCloudDiscoveryengineV1CreateEngineMetadata {
|
|
3728
|
+
/**
|
|
3729
|
+
* Operation create time.
|
|
3730
|
+
*/
|
|
3731
|
+
createTime?: string | null;
|
|
3732
|
+
/**
|
|
3733
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3734
|
+
*/
|
|
3735
|
+
updateTime?: string | null;
|
|
3736
|
+
}
|
|
3737
|
+
/**
|
|
3738
|
+
* Metadata for Create Schema LRO.
|
|
3739
|
+
*/
|
|
3740
|
+
export interface Schema$GoogleCloudDiscoveryengineV1CreateSchemaMetadata {
|
|
3741
|
+
/**
|
|
3742
|
+
* Operation create time.
|
|
3743
|
+
*/
|
|
3744
|
+
createTime?: string | null;
|
|
3745
|
+
/**
|
|
3746
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3747
|
+
*/
|
|
3748
|
+
updateTime?: string | null;
|
|
3749
|
+
}
|
|
3750
|
+
/**
|
|
3751
|
+
* Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3752
|
+
*/
|
|
3753
|
+
export interface Schema$GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata {
|
|
3754
|
+
/**
|
|
3755
|
+
* Operation create time.
|
|
3756
|
+
*/
|
|
3757
|
+
createTime?: string | null;
|
|
3758
|
+
/**
|
|
3759
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3760
|
+
*/
|
|
3761
|
+
updateTime?: string | null;
|
|
3762
|
+
}
|
|
3763
|
+
/**
|
|
3764
|
+
* DataStore captures global settings and configs at the DataStore level.
|
|
3765
|
+
*/
|
|
3766
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DataStore {
|
|
3767
|
+
/**
|
|
3768
|
+
* Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
|
|
3769
|
+
*/
|
|
3770
|
+
contentConfig?: string | null;
|
|
3771
|
+
/**
|
|
3772
|
+
* Output only. Timestamp the DataStore was created at.
|
|
3773
|
+
*/
|
|
3774
|
+
createTime?: string | null;
|
|
3775
|
+
/**
|
|
3776
|
+
* Output only. The id of the default Schema asscociated to this data store.
|
|
3777
|
+
*/
|
|
3778
|
+
defaultSchemaId?: string | null;
|
|
3779
|
+
/**
|
|
3780
|
+
* Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
|
3781
|
+
*/
|
|
3782
|
+
displayName?: string | null;
|
|
3783
|
+
/**
|
|
3784
|
+
* Immutable. The industry vertical that the data store registers.
|
|
3785
|
+
*/
|
|
3786
|
+
industryVertical?: string | null;
|
|
3787
|
+
/**
|
|
3788
|
+
* Immutable. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
3789
|
+
*/
|
|
3790
|
+
name?: string | null;
|
|
3791
|
+
/**
|
|
3792
|
+
* The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.
|
|
3793
|
+
*/
|
|
3794
|
+
solutionTypes?: string[] | null;
|
|
3795
|
+
}
|
|
3796
|
+
/**
|
|
3797
|
+
* Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3798
|
+
*/
|
|
3799
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata {
|
|
3800
|
+
/**
|
|
3801
|
+
* Operation create time.
|
|
3802
|
+
*/
|
|
3803
|
+
createTime?: string | null;
|
|
3804
|
+
/**
|
|
3805
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3806
|
+
*/
|
|
3807
|
+
updateTime?: string | null;
|
|
3808
|
+
}
|
|
3809
|
+
/**
|
|
3810
|
+
* Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3811
|
+
*/
|
|
3812
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DeleteEngineMetadata {
|
|
3813
|
+
/**
|
|
3814
|
+
* Operation create time.
|
|
3815
|
+
*/
|
|
3816
|
+
createTime?: string | null;
|
|
3817
|
+
/**
|
|
3818
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3819
|
+
*/
|
|
3820
|
+
updateTime?: string | null;
|
|
3821
|
+
}
|
|
3822
|
+
/**
|
|
3823
|
+
* Metadata for DeleteSchema LRO.
|
|
3824
|
+
*/
|
|
3825
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DeleteSchemaMetadata {
|
|
3826
|
+
/**
|
|
3827
|
+
* Operation create time.
|
|
3828
|
+
*/
|
|
3829
|
+
createTime?: string | null;
|
|
3830
|
+
/**
|
|
3831
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3832
|
+
*/
|
|
3833
|
+
updateTime?: string | null;
|
|
3834
|
+
}
|
|
3835
|
+
/**
|
|
3836
|
+
* Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3837
|
+
*/
|
|
3838
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata {
|
|
3839
|
+
/**
|
|
3840
|
+
* Operation create time.
|
|
3841
|
+
*/
|
|
3842
|
+
createTime?: string | null;
|
|
3843
|
+
/**
|
|
3844
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3845
|
+
*/
|
|
3846
|
+
updateTime?: string | null;
|
|
3847
|
+
}
|
|
3848
|
+
/**
|
|
3849
|
+
* Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3850
|
+
*/
|
|
3851
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata {
|
|
3852
|
+
/**
|
|
3853
|
+
* Operation create time.
|
|
3854
|
+
*/
|
|
3855
|
+
createTime?: string | null;
|
|
3856
|
+
/**
|
|
3857
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3858
|
+
*/
|
|
3859
|
+
updateTime?: string | null;
|
|
3860
|
+
}
|
|
3861
|
+
/**
|
|
3862
|
+
* Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.
|
|
3863
|
+
*/
|
|
3864
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse {}
|
|
3865
|
+
/**
|
|
3866
|
+
* Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3867
|
+
*/
|
|
3868
|
+
export interface Schema$GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata {
|
|
3869
|
+
/**
|
|
3870
|
+
* Operation create time.
|
|
3871
|
+
*/
|
|
3872
|
+
createTime?: string | null;
|
|
3873
|
+
/**
|
|
3874
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3875
|
+
*/
|
|
3876
|
+
updateTime?: string | null;
|
|
3877
|
+
}
|
|
3878
|
+
/**
|
|
3879
|
+
* Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.
|
|
3880
|
+
*/
|
|
3881
|
+
export interface Schema$GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchResponse {}
|
|
3882
|
+
/**
|
|
3883
|
+
* Metadata that describes the training and serving parameters of an Engine.
|
|
3884
|
+
*/
|
|
3885
|
+
export interface Schema$GoogleCloudDiscoveryengineV1Engine {
|
|
3886
|
+
/**
|
|
3887
|
+
* Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
|
|
3888
|
+
*/
|
|
3889
|
+
chatEngineConfig?: Schema$GoogleCloudDiscoveryengineV1EngineChatEngineConfig;
|
|
3890
|
+
/**
|
|
3891
|
+
* Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
|
|
3892
|
+
*/
|
|
3893
|
+
chatEngineMetadata?: Schema$GoogleCloudDiscoveryengineV1EngineChatEngineMetadata;
|
|
3894
|
+
/**
|
|
3895
|
+
* Common config spec that specifies the metadata of the engine.
|
|
3896
|
+
*/
|
|
3897
|
+
commonConfig?: Schema$GoogleCloudDiscoveryengineV1EngineCommonConfig;
|
|
3898
|
+
/**
|
|
3899
|
+
* Output only. Timestamp the Recommendation Engine was created at.
|
|
3900
|
+
*/
|
|
3901
|
+
createTime?: string | null;
|
|
3902
|
+
/**
|
|
3903
|
+
* The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.
|
|
3904
|
+
*/
|
|
3905
|
+
dataStoreIds?: string[] | null;
|
|
3906
|
+
/**
|
|
3907
|
+
* Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
|
|
3908
|
+
*/
|
|
3909
|
+
displayName?: string | null;
|
|
3910
|
+
/**
|
|
3911
|
+
* The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore liniked to the engine.
|
|
3912
|
+
*/
|
|
3913
|
+
industryVertical?: string | null;
|
|
3914
|
+
/**
|
|
3915
|
+
* Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned.
|
|
3916
|
+
*/
|
|
3917
|
+
name?: string | null;
|
|
3918
|
+
/**
|
|
3919
|
+
* Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
|
|
3920
|
+
*/
|
|
3921
|
+
searchEngineConfig?: Schema$GoogleCloudDiscoveryengineV1EngineSearchEngineConfig;
|
|
3922
|
+
/**
|
|
3923
|
+
* Required. The solutions of the engine.
|
|
3924
|
+
*/
|
|
3925
|
+
solutionType?: string | null;
|
|
3926
|
+
/**
|
|
3927
|
+
* Output only. Timestamp the Recommendation Engine was last updated.
|
|
3928
|
+
*/
|
|
3929
|
+
updateTime?: string | null;
|
|
3930
|
+
}
|
|
3931
|
+
/**
|
|
3932
|
+
* Configurations for a Chat Engine.
|
|
3933
|
+
*/
|
|
3934
|
+
export interface Schema$GoogleCloudDiscoveryengineV1EngineChatEngineConfig {
|
|
3935
|
+
/**
|
|
3936
|
+
* The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.
|
|
3937
|
+
*/
|
|
3938
|
+
agentCreationConfig?: Schema$GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig;
|
|
3939
|
+
/**
|
|
3940
|
+
* The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Please use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.
|
|
3941
|
+
*/
|
|
3942
|
+
dialogflowAgentToLink?: string | null;
|
|
3943
|
+
}
|
|
3944
|
+
/**
|
|
3945
|
+
* Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.
|
|
3946
|
+
*/
|
|
3947
|
+
export interface Schema$GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig {
|
|
3948
|
+
/**
|
|
3949
|
+
* Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.
|
|
3950
|
+
*/
|
|
3951
|
+
business?: string | null;
|
|
3952
|
+
/**
|
|
3953
|
+
* Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.
|
|
3954
|
+
*/
|
|
3955
|
+
defaultLanguageCode?: string | null;
|
|
3956
|
+
/**
|
|
3957
|
+
* Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default.
|
|
3958
|
+
*/
|
|
3959
|
+
location?: string | null;
|
|
3960
|
+
/**
|
|
3961
|
+
* Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.
|
|
3962
|
+
*/
|
|
3963
|
+
timeZone?: string | null;
|
|
3964
|
+
}
|
|
3965
|
+
/**
|
|
3966
|
+
* Additional information of a Chat Engine. Fields in this message are output only.
|
|
3967
|
+
*/
|
|
3968
|
+
export interface Schema$GoogleCloudDiscoveryengineV1EngineChatEngineMetadata {
|
|
3969
|
+
/**
|
|
3970
|
+
* The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.
|
|
3971
|
+
*/
|
|
3972
|
+
dialogflowAgent?: string | null;
|
|
3973
|
+
}
|
|
3974
|
+
/**
|
|
3975
|
+
* Common configurations for an Engine.
|
|
3976
|
+
*/
|
|
3977
|
+
export interface Schema$GoogleCloudDiscoveryengineV1EngineCommonConfig {
|
|
3978
|
+
/**
|
|
3979
|
+
* Immutable. The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.
|
|
3980
|
+
*/
|
|
3981
|
+
companyName?: string | null;
|
|
3982
|
+
}
|
|
3983
|
+
/**
|
|
3984
|
+
* Configurations for a Search Engine.
|
|
3985
|
+
*/
|
|
3986
|
+
export interface Schema$GoogleCloudDiscoveryengineV1EngineSearchEngineConfig {
|
|
3987
|
+
/**
|
|
3988
|
+
* The add-on that this search engine enables.
|
|
3989
|
+
*/
|
|
3990
|
+
searchAddOns?: string[] | null;
|
|
3991
|
+
/**
|
|
3992
|
+
* The search feature tier of this engine. Different tiers might have different pricing. To learn more, please check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.
|
|
3993
|
+
*/
|
|
3994
|
+
searchTier?: string | null;
|
|
3995
|
+
}
|
|
3996
|
+
/**
|
|
3997
|
+
* Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
3998
|
+
*/
|
|
3999
|
+
export interface Schema$GoogleCloudDiscoveryengineV1ImportDocumentsMetadata {
|
|
4000
|
+
/**
|
|
4001
|
+
* Operation create time.
|
|
4002
|
+
*/
|
|
4003
|
+
createTime?: string | null;
|
|
4004
|
+
/**
|
|
4005
|
+
* Count of entries that encountered errors while processing.
|
|
4006
|
+
*/
|
|
4007
|
+
failureCount?: string | null;
|
|
4008
|
+
/**
|
|
4009
|
+
* Count of entries that were processed successfully.
|
|
4010
|
+
*/
|
|
4011
|
+
successCount?: string | null;
|
|
4012
|
+
/**
|
|
4013
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
4014
|
+
*/
|
|
4015
|
+
updateTime?: string | null;
|
|
4016
|
+
}
|
|
4017
|
+
/**
|
|
4018
|
+
* Response of the ImportDocumentsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.
|
|
4019
|
+
*/
|
|
4020
|
+
export interface Schema$GoogleCloudDiscoveryengineV1ImportDocumentsResponse {
|
|
4021
|
+
/**
|
|
4022
|
+
* Echoes the destination for the complete errors in the request if set.
|
|
4023
|
+
*/
|
|
4024
|
+
errorConfig?: Schema$GoogleCloudDiscoveryengineV1ImportErrorConfig;
|
|
4025
|
+
/**
|
|
4026
|
+
* A sample of errors encountered while processing the request.
|
|
4027
|
+
*/
|
|
4028
|
+
errorSamples?: Schema$GoogleRpcStatus[];
|
|
4029
|
+
}
|
|
4030
|
+
/**
|
|
4031
|
+
* Configuration of destination for Import related errors.
|
|
4032
|
+
*/
|
|
4033
|
+
export interface Schema$GoogleCloudDiscoveryengineV1ImportErrorConfig {
|
|
3176
4034
|
/**
|
|
3177
4035
|
* Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.
|
|
3178
4036
|
*/
|
|
3179
4037
|
gcsPrefix?: string | null;
|
|
3180
4038
|
}
|
|
4039
|
+
/**
|
|
4040
|
+
* Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
4041
|
+
*/
|
|
4042
|
+
export interface Schema$GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesMetadata {
|
|
4043
|
+
/**
|
|
4044
|
+
* Operation create time.
|
|
4045
|
+
*/
|
|
4046
|
+
createTime?: string | null;
|
|
4047
|
+
/**
|
|
4048
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
4049
|
+
*/
|
|
4050
|
+
updateTime?: string | null;
|
|
4051
|
+
}
|
|
4052
|
+
/**
|
|
4053
|
+
* Response message for CompletionService.ImportSuggestionDenyListEntries method.
|
|
4054
|
+
*/
|
|
4055
|
+
export interface Schema$GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesResponse {
|
|
4056
|
+
/**
|
|
4057
|
+
* A sample of errors encountered while processing the request.
|
|
4058
|
+
*/
|
|
4059
|
+
errorSamples?: Schema$GoogleRpcStatus[];
|
|
4060
|
+
/**
|
|
4061
|
+
* Count of deny list entries that failed to be imported.
|
|
4062
|
+
*/
|
|
4063
|
+
failedEntriesCount?: string | null;
|
|
4064
|
+
/**
|
|
4065
|
+
* Count of deny list entries successfully imported.
|
|
4066
|
+
*/
|
|
4067
|
+
importedEntriesCount?: string | null;
|
|
4068
|
+
}
|
|
3181
4069
|
/**
|
|
3182
4070
|
* Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
3183
4071
|
*/
|
|
@@ -3225,56 +4113,164 @@ export namespace discoveryengine_v1alpha {
|
|
|
3225
4113
|
*/
|
|
3226
4114
|
export interface Schema$GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata {
|
|
3227
4115
|
/**
|
|
3228
|
-
* Operation create time.
|
|
4116
|
+
* Operation create time.
|
|
4117
|
+
*/
|
|
4118
|
+
createTime?: string | null;
|
|
4119
|
+
/**
|
|
4120
|
+
* Count of entries that encountered errors while processing.
|
|
4121
|
+
*/
|
|
4122
|
+
failureCount?: string | null;
|
|
4123
|
+
/**
|
|
4124
|
+
* Count of entries that were deleted successfully.
|
|
4125
|
+
*/
|
|
4126
|
+
successCount?: string | null;
|
|
4127
|
+
/**
|
|
4128
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
4129
|
+
*/
|
|
4130
|
+
updateTime?: string | null;
|
|
4131
|
+
}
|
|
4132
|
+
/**
|
|
4133
|
+
* Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.
|
|
4134
|
+
*/
|
|
4135
|
+
export interface Schema$GoogleCloudDiscoveryengineV1PurgeDocumentsResponse {
|
|
4136
|
+
/**
|
|
4137
|
+
* The total count of documents purged as a result of the operation.
|
|
4138
|
+
*/
|
|
4139
|
+
purgeCount?: string | null;
|
|
4140
|
+
/**
|
|
4141
|
+
* A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random.
|
|
4142
|
+
*/
|
|
4143
|
+
purgeSample?: string[] | null;
|
|
4144
|
+
}
|
|
4145
|
+
/**
|
|
4146
|
+
* Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
4147
|
+
*/
|
|
4148
|
+
export interface Schema$GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata {
|
|
4149
|
+
/**
|
|
4150
|
+
* Operation create time.
|
|
4151
|
+
*/
|
|
4152
|
+
createTime?: string | null;
|
|
4153
|
+
/**
|
|
4154
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
4155
|
+
*/
|
|
4156
|
+
updateTime?: string | null;
|
|
4157
|
+
}
|
|
4158
|
+
/**
|
|
4159
|
+
* Response message for CompletionService.PurgeSuggestionDenyListEntries method.
|
|
4160
|
+
*/
|
|
4161
|
+
export interface Schema$GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesResponse {
|
|
4162
|
+
/**
|
|
4163
|
+
* A sample of errors encountered while processing the request.
|
|
4164
|
+
*/
|
|
4165
|
+
errorSamples?: Schema$GoogleRpcStatus[];
|
|
4166
|
+
/**
|
|
4167
|
+
* Number of suggestion deny list entries purged.
|
|
4168
|
+
*/
|
|
4169
|
+
purgeCount?: string | null;
|
|
4170
|
+
}
|
|
4171
|
+
/**
|
|
4172
|
+
* Defines the structure and layout of a type of document data.
|
|
4173
|
+
*/
|
|
4174
|
+
export interface Schema$GoogleCloudDiscoveryengineV1Schema {
|
|
4175
|
+
/**
|
|
4176
|
+
* The JSON representation of the schema.
|
|
4177
|
+
*/
|
|
4178
|
+
jsonSchema?: string | null;
|
|
4179
|
+
/**
|
|
4180
|
+
* Immutable. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
4181
|
+
*/
|
|
4182
|
+
name?: string | null;
|
|
4183
|
+
/**
|
|
4184
|
+
* The structured representation of the schema.
|
|
4185
|
+
*/
|
|
4186
|
+
structSchema?: {[key: string]: any} | null;
|
|
4187
|
+
}
|
|
4188
|
+
/**
|
|
4189
|
+
* Verification information for target sites in advanced site search.
|
|
4190
|
+
*/
|
|
4191
|
+
export interface Schema$GoogleCloudDiscoveryengineV1SiteVerificationInfo {
|
|
4192
|
+
/**
|
|
4193
|
+
* Site verification state indicating the ownership and validity.
|
|
4194
|
+
*/
|
|
4195
|
+
siteVerificationState?: string | null;
|
|
4196
|
+
/**
|
|
4197
|
+
* Latest site verification time.
|
|
4198
|
+
*/
|
|
4199
|
+
verifyTime?: string | null;
|
|
4200
|
+
}
|
|
4201
|
+
/**
|
|
4202
|
+
* A target site for the SiteSearchEngine.
|
|
4203
|
+
*/
|
|
4204
|
+
export interface Schema$GoogleCloudDiscoveryengineV1TargetSite {
|
|
4205
|
+
/**
|
|
4206
|
+
* Input only. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern is always normalized to generate the URI pattern to be used by the search engine.
|
|
4207
|
+
*/
|
|
4208
|
+
exactMatch?: boolean | null;
|
|
4209
|
+
/**
|
|
4210
|
+
* Output only. Failure reason.
|
|
4211
|
+
*/
|
|
4212
|
+
failureReason?: Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReason;
|
|
4213
|
+
/**
|
|
4214
|
+
* Output only. This is system-generated based on the provided_uri_pattern.
|
|
4215
|
+
*/
|
|
4216
|
+
generatedUriPattern?: string | null;
|
|
4217
|
+
/**
|
|
4218
|
+
* Output only. Indexing status.
|
|
4219
|
+
*/
|
|
4220
|
+
indexingStatus?: string | null;
|
|
4221
|
+
/**
|
|
4222
|
+
* Output only. The fully qualified resource name of the target site. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}` The `target_site_id` is system-generated.
|
|
3229
4223
|
*/
|
|
3230
|
-
|
|
4224
|
+
name?: string | null;
|
|
3231
4225
|
/**
|
|
3232
|
-
*
|
|
4226
|
+
* Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated.
|
|
3233
4227
|
*/
|
|
3234
|
-
|
|
4228
|
+
providedUriPattern?: string | null;
|
|
3235
4229
|
/**
|
|
3236
|
-
*
|
|
4230
|
+
* Output only. Site ownership and validity verification status.
|
|
3237
4231
|
*/
|
|
3238
|
-
|
|
4232
|
+
siteVerificationInfo?: Schema$GoogleCloudDiscoveryengineV1SiteVerificationInfo;
|
|
3239
4233
|
/**
|
|
3240
|
-
*
|
|
4234
|
+
* The type of the target site, e.g., whether the site is to be included or excluded.
|
|
4235
|
+
*/
|
|
4236
|
+
type?: string | null;
|
|
4237
|
+
/**
|
|
4238
|
+
* Output only. The target site's last updated time.
|
|
3241
4239
|
*/
|
|
3242
4240
|
updateTime?: string | null;
|
|
3243
4241
|
}
|
|
3244
4242
|
/**
|
|
3245
|
-
*
|
|
4243
|
+
* Site search indexing failure reasons.
|
|
3246
4244
|
*/
|
|
3247
|
-
export interface Schema$
|
|
4245
|
+
export interface Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReason {
|
|
3248
4246
|
/**
|
|
3249
|
-
*
|
|
4247
|
+
* Failed due to insufficient quota.
|
|
3250
4248
|
*/
|
|
3251
|
-
|
|
4249
|
+
quotaFailure?: Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure;
|
|
4250
|
+
}
|
|
4251
|
+
export interface Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure {
|
|
3252
4252
|
/**
|
|
3253
|
-
*
|
|
4253
|
+
* This number is an estimation on how much total quota this project needs to successfully complete indexing.
|
|
3254
4254
|
*/
|
|
3255
|
-
|
|
4255
|
+
totalRequiredQuota?: string | null;
|
|
3256
4256
|
}
|
|
3257
4257
|
/**
|
|
3258
|
-
*
|
|
4258
|
+
* Metadata for UpdateSchema LRO.
|
|
3259
4259
|
*/
|
|
3260
|
-
export interface Schema$
|
|
3261
|
-
/**
|
|
3262
|
-
* The JSON representation of the schema.
|
|
3263
|
-
*/
|
|
3264
|
-
jsonSchema?: string | null;
|
|
4260
|
+
export interface Schema$GoogleCloudDiscoveryengineV1UpdateSchemaMetadata {
|
|
3265
4261
|
/**
|
|
3266
|
-
*
|
|
4262
|
+
* Operation create time.
|
|
3267
4263
|
*/
|
|
3268
|
-
|
|
4264
|
+
createTime?: string | null;
|
|
3269
4265
|
/**
|
|
3270
|
-
*
|
|
4266
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3271
4267
|
*/
|
|
3272
|
-
|
|
4268
|
+
updateTime?: string | null;
|
|
3273
4269
|
}
|
|
3274
4270
|
/**
|
|
3275
|
-
* Metadata
|
|
4271
|
+
* Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3276
4272
|
*/
|
|
3277
|
-
export interface Schema$
|
|
4273
|
+
export interface Schema$GoogleCloudDiscoveryengineV1UpdateTargetSiteMetadata {
|
|
3278
4274
|
/**
|
|
3279
4275
|
* Operation create time.
|
|
3280
4276
|
*/
|
|
@@ -3932,7 +4928,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
3932
4928
|
export interface Params$Resource$Projects$Locations$Estimatedatasize
|
|
3933
4929
|
extends StandardParameters {
|
|
3934
4930
|
/**
|
|
3935
|
-
* Required. Full resource name of the
|
|
4931
|
+
* Required. Full resource name of the location, such as `projects/{project\}/locations/{location\}`.
|
|
3936
4932
|
*/
|
|
3937
4933
|
location?: string;
|
|
3938
4934
|
|
|
@@ -4210,6 +5206,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
4210
5206
|
schemas: Resource$Projects$Locations$Collections$Datastores$Schemas;
|
|
4211
5207
|
servingConfigs: Resource$Projects$Locations$Collections$Datastores$Servingconfigs;
|
|
4212
5208
|
siteSearchEngine: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine;
|
|
5209
|
+
suggestionDenyListEntries: Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries;
|
|
4213
5210
|
userEvents: Resource$Projects$Locations$Collections$Datastores$Userevents;
|
|
4214
5211
|
constructor(context: APIRequestContext) {
|
|
4215
5212
|
this.context = context;
|
|
@@ -4241,6 +5238,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
4241
5238
|
new Resource$Projects$Locations$Collections$Datastores$Sitesearchengine(
|
|
4242
5239
|
this.context
|
|
4243
5240
|
);
|
|
5241
|
+
this.suggestionDenyListEntries =
|
|
5242
|
+
new Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries(
|
|
5243
|
+
this.context
|
|
5244
|
+
);
|
|
4244
5245
|
this.userEvents =
|
|
4245
5246
|
new Resource$Projects$Locations$Collections$Datastores$Userevents(
|
|
4246
5247
|
this.context
|
|
@@ -5219,7 +6220,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
5219
6220
|
*/
|
|
5220
6221
|
query?: string;
|
|
5221
6222
|
/**
|
|
5222
|
-
*
|
|
6223
|
+
* 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.
|
|
5223
6224
|
*/
|
|
5224
6225
|
queryModel?: string;
|
|
5225
6226
|
/**
|
|
@@ -5290,7 +6291,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
5290
6291
|
*/
|
|
5291
6292
|
pageToken?: string;
|
|
5292
6293
|
/**
|
|
5293
|
-
* Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}`. If the caller does not have permission to list
|
|
6294
|
+
* Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}`. If the caller does not have permission to list DataStores under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned.
|
|
5294
6295
|
*/
|
|
5295
6296
|
parent?: string;
|
|
5296
6297
|
}
|
|
@@ -5325,11 +6326,11 @@ export namespace discoveryengine_v1alpha {
|
|
|
5325
6326
|
export interface Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig
|
|
5326
6327
|
extends StandardParameters {
|
|
5327
6328
|
/**
|
|
5328
|
-
*
|
|
6329
|
+
* The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`.
|
|
5329
6330
|
*/
|
|
5330
6331
|
name?: string;
|
|
5331
6332
|
/**
|
|
5332
|
-
* Indicates which fields in the provided DocumentProcessingConfig to update. The following are the only supported fields: * DocumentProcessingConfig.
|
|
6333
|
+
* Indicates which fields in the provided DocumentProcessingConfig to update. The following are the only supported fields: * DocumentProcessingConfig.ocr_config If not set, all supported fields are updated.
|
|
5333
6334
|
*/
|
|
5334
6335
|
updateMask?: string;
|
|
5335
6336
|
|
|
@@ -6989,7 +7990,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
6989
7990
|
*/
|
|
6990
7991
|
name?: string;
|
|
6991
7992
|
/**
|
|
6992
|
-
* Indicates which fields in the provided Conversation to update. The following are NOT supported: *
|
|
7993
|
+
* Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated.
|
|
6993
7994
|
*/
|
|
6994
7995
|
updateMask?: string;
|
|
6995
7996
|
|
|
@@ -8441,7 +9442,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
8441
9442
|
export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend
|
|
8442
9443
|
extends StandardParameters {
|
|
8443
9444
|
/**
|
|
8444
|
-
* Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your Recommend requests.
|
|
9445
|
+
* Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests.
|
|
8445
9446
|
*/
|
|
8446
9447
|
servingConfig?: string;
|
|
8447
9448
|
|
|
@@ -10027,34 +11028,261 @@ export namespace discoveryengine_v1alpha {
|
|
|
10027
11028
|
params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List,
|
|
10028
11029
|
callback: BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>
|
|
10029
11030
|
): void;
|
|
10030
|
-
list(
|
|
10031
|
-
callback: BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>
|
|
11031
|
+
list(
|
|
11032
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>
|
|
11033
|
+
): void;
|
|
11034
|
+
list(
|
|
11035
|
+
paramsOrCallback?:
|
|
11036
|
+
| Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List
|
|
11037
|
+
| BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>
|
|
11038
|
+
| BodyResponseCallback<Readable>,
|
|
11039
|
+
optionsOrCallback?:
|
|
11040
|
+
| MethodOptions
|
|
11041
|
+
| StreamMethodOptions
|
|
11042
|
+
| BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>
|
|
11043
|
+
| BodyResponseCallback<Readable>,
|
|
11044
|
+
callback?:
|
|
11045
|
+
| BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>
|
|
11046
|
+
| BodyResponseCallback<Readable>
|
|
11047
|
+
):
|
|
11048
|
+
| void
|
|
11049
|
+
| GaxiosPromise<Schema$GoogleLongrunningListOperationsResponse>
|
|
11050
|
+
| GaxiosPromise<Readable> {
|
|
11051
|
+
let params = (paramsOrCallback ||
|
|
11052
|
+
{}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List;
|
|
11053
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
11054
|
+
|
|
11055
|
+
if (typeof paramsOrCallback === 'function') {
|
|
11056
|
+
callback = paramsOrCallback;
|
|
11057
|
+
params =
|
|
11058
|
+
{} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List;
|
|
11059
|
+
options = {};
|
|
11060
|
+
}
|
|
11061
|
+
|
|
11062
|
+
if (typeof optionsOrCallback === 'function') {
|
|
11063
|
+
callback = optionsOrCallback;
|
|
11064
|
+
options = {};
|
|
11065
|
+
}
|
|
11066
|
+
|
|
11067
|
+
const rootUrl =
|
|
11068
|
+
options.rootUrl || 'https://discoveryengine.googleapis.com/';
|
|
11069
|
+
const parameters = {
|
|
11070
|
+
options: Object.assign(
|
|
11071
|
+
{
|
|
11072
|
+
url: (rootUrl + '/v1alpha/{+name}/operations').replace(
|
|
11073
|
+
/([^:]\/)\/+/g,
|
|
11074
|
+
'$1'
|
|
11075
|
+
),
|
|
11076
|
+
method: 'GET',
|
|
11077
|
+
},
|
|
11078
|
+
options
|
|
11079
|
+
),
|
|
11080
|
+
params,
|
|
11081
|
+
requiredParams: ['name'],
|
|
11082
|
+
pathParams: ['name'],
|
|
11083
|
+
context: this.context,
|
|
11084
|
+
};
|
|
11085
|
+
if (callback) {
|
|
11086
|
+
createAPIRequest<Schema$GoogleLongrunningListOperationsResponse>(
|
|
11087
|
+
parameters,
|
|
11088
|
+
callback as BodyResponseCallback<unknown>
|
|
11089
|
+
);
|
|
11090
|
+
} else {
|
|
11091
|
+
return createAPIRequest<Schema$GoogleLongrunningListOperationsResponse>(
|
|
11092
|
+
parameters
|
|
11093
|
+
);
|
|
11094
|
+
}
|
|
11095
|
+
}
|
|
11096
|
+
}
|
|
11097
|
+
|
|
11098
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get
|
|
11099
|
+
extends StandardParameters {
|
|
11100
|
+
/**
|
|
11101
|
+
* The name of the operation resource.
|
|
11102
|
+
*/
|
|
11103
|
+
name?: string;
|
|
11104
|
+
}
|
|
11105
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List
|
|
11106
|
+
extends StandardParameters {
|
|
11107
|
+
/**
|
|
11108
|
+
* The standard list filter.
|
|
11109
|
+
*/
|
|
11110
|
+
filter?: string;
|
|
11111
|
+
/**
|
|
11112
|
+
* The name of the operation's parent resource.
|
|
11113
|
+
*/
|
|
11114
|
+
name?: string;
|
|
11115
|
+
/**
|
|
11116
|
+
* The standard list page size.
|
|
11117
|
+
*/
|
|
11118
|
+
pageSize?: number;
|
|
11119
|
+
/**
|
|
11120
|
+
* The standard list page token.
|
|
11121
|
+
*/
|
|
11122
|
+
pageToken?: string;
|
|
11123
|
+
}
|
|
11124
|
+
|
|
11125
|
+
export class Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries {
|
|
11126
|
+
context: APIRequestContext;
|
|
11127
|
+
constructor(context: APIRequestContext) {
|
|
11128
|
+
this.context = context;
|
|
11129
|
+
}
|
|
11130
|
+
|
|
11131
|
+
/**
|
|
11132
|
+
* Imports all SuggestionDenyListEntry for a DataStore.
|
|
11133
|
+
*
|
|
11134
|
+
* @param params - Parameters for request
|
|
11135
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
11136
|
+
* @param callback - Optional callback that handles the response.
|
|
11137
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
11138
|
+
*/
|
|
11139
|
+
import(
|
|
11140
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import,
|
|
11141
|
+
options: StreamMethodOptions
|
|
11142
|
+
): GaxiosPromise<Readable>;
|
|
11143
|
+
import(
|
|
11144
|
+
params?: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import,
|
|
11145
|
+
options?: MethodOptions
|
|
11146
|
+
): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
11147
|
+
import(
|
|
11148
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import,
|
|
11149
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
11150
|
+
callback: BodyResponseCallback<Readable>
|
|
11151
|
+
): void;
|
|
11152
|
+
import(
|
|
11153
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import,
|
|
11154
|
+
options:
|
|
11155
|
+
| MethodOptions
|
|
11156
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>,
|
|
11157
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
11158
|
+
): void;
|
|
11159
|
+
import(
|
|
11160
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import,
|
|
11161
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
11162
|
+
): void;
|
|
11163
|
+
import(
|
|
11164
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
11165
|
+
): void;
|
|
11166
|
+
import(
|
|
11167
|
+
paramsOrCallback?:
|
|
11168
|
+
| Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import
|
|
11169
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
11170
|
+
| BodyResponseCallback<Readable>,
|
|
11171
|
+
optionsOrCallback?:
|
|
11172
|
+
| MethodOptions
|
|
11173
|
+
| StreamMethodOptions
|
|
11174
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
11175
|
+
| BodyResponseCallback<Readable>,
|
|
11176
|
+
callback?:
|
|
11177
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
11178
|
+
| BodyResponseCallback<Readable>
|
|
11179
|
+
):
|
|
11180
|
+
| void
|
|
11181
|
+
| GaxiosPromise<Schema$GoogleLongrunningOperation>
|
|
11182
|
+
| GaxiosPromise<Readable> {
|
|
11183
|
+
let params = (paramsOrCallback ||
|
|
11184
|
+
{}) as Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import;
|
|
11185
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
11186
|
+
|
|
11187
|
+
if (typeof paramsOrCallback === 'function') {
|
|
11188
|
+
callback = paramsOrCallback;
|
|
11189
|
+
params =
|
|
11190
|
+
{} as Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import;
|
|
11191
|
+
options = {};
|
|
11192
|
+
}
|
|
11193
|
+
|
|
11194
|
+
if (typeof optionsOrCallback === 'function') {
|
|
11195
|
+
callback = optionsOrCallback;
|
|
11196
|
+
options = {};
|
|
11197
|
+
}
|
|
11198
|
+
|
|
11199
|
+
const rootUrl =
|
|
11200
|
+
options.rootUrl || 'https://discoveryengine.googleapis.com/';
|
|
11201
|
+
const parameters = {
|
|
11202
|
+
options: Object.assign(
|
|
11203
|
+
{
|
|
11204
|
+
url: (
|
|
11205
|
+
rootUrl + '/v1alpha/{+parent}/suggestionDenyListEntries:import'
|
|
11206
|
+
).replace(/([^:]\/)\/+/g, '$1'),
|
|
11207
|
+
method: 'POST',
|
|
11208
|
+
},
|
|
11209
|
+
options
|
|
11210
|
+
),
|
|
11211
|
+
params,
|
|
11212
|
+
requiredParams: ['parent'],
|
|
11213
|
+
pathParams: ['parent'],
|
|
11214
|
+
context: this.context,
|
|
11215
|
+
};
|
|
11216
|
+
if (callback) {
|
|
11217
|
+
createAPIRequest<Schema$GoogleLongrunningOperation>(
|
|
11218
|
+
parameters,
|
|
11219
|
+
callback as BodyResponseCallback<unknown>
|
|
11220
|
+
);
|
|
11221
|
+
} else {
|
|
11222
|
+
return createAPIRequest<Schema$GoogleLongrunningOperation>(parameters);
|
|
11223
|
+
}
|
|
11224
|
+
}
|
|
11225
|
+
|
|
11226
|
+
/**
|
|
11227
|
+
* Permanently deletes all SuggestionDenyListEntry for a DataStore.
|
|
11228
|
+
*
|
|
11229
|
+
* @param params - Parameters for request
|
|
11230
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
11231
|
+
* @param callback - Optional callback that handles the response.
|
|
11232
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
11233
|
+
*/
|
|
11234
|
+
purge(
|
|
11235
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge,
|
|
11236
|
+
options: StreamMethodOptions
|
|
11237
|
+
): GaxiosPromise<Readable>;
|
|
11238
|
+
purge(
|
|
11239
|
+
params?: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge,
|
|
11240
|
+
options?: MethodOptions
|
|
11241
|
+
): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
11242
|
+
purge(
|
|
11243
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge,
|
|
11244
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
11245
|
+
callback: BodyResponseCallback<Readable>
|
|
11246
|
+
): void;
|
|
11247
|
+
purge(
|
|
11248
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge,
|
|
11249
|
+
options:
|
|
11250
|
+
| MethodOptions
|
|
11251
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>,
|
|
11252
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
11253
|
+
): void;
|
|
11254
|
+
purge(
|
|
11255
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge,
|
|
11256
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
11257
|
+
): void;
|
|
11258
|
+
purge(
|
|
11259
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
10032
11260
|
): void;
|
|
10033
|
-
|
|
11261
|
+
purge(
|
|
10034
11262
|
paramsOrCallback?:
|
|
10035
|
-
| Params$Resource$Projects$Locations$Collections$Datastores$
|
|
10036
|
-
| BodyResponseCallback<Schema$
|
|
11263
|
+
| Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge
|
|
11264
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
10037
11265
|
| BodyResponseCallback<Readable>,
|
|
10038
11266
|
optionsOrCallback?:
|
|
10039
11267
|
| MethodOptions
|
|
10040
11268
|
| StreamMethodOptions
|
|
10041
|
-
| BodyResponseCallback<Schema$
|
|
11269
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
10042
11270
|
| BodyResponseCallback<Readable>,
|
|
10043
11271
|
callback?:
|
|
10044
|
-
| BodyResponseCallback<Schema$
|
|
11272
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
10045
11273
|
| BodyResponseCallback<Readable>
|
|
10046
11274
|
):
|
|
10047
11275
|
| void
|
|
10048
|
-
| GaxiosPromise<Schema$
|
|
11276
|
+
| GaxiosPromise<Schema$GoogleLongrunningOperation>
|
|
10049
11277
|
| GaxiosPromise<Readable> {
|
|
10050
11278
|
let params = (paramsOrCallback ||
|
|
10051
|
-
{}) as Params$Resource$Projects$Locations$Collections$Datastores$
|
|
11279
|
+
{}) as Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge;
|
|
10052
11280
|
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
10053
11281
|
|
|
10054
11282
|
if (typeof paramsOrCallback === 'function') {
|
|
10055
11283
|
callback = paramsOrCallback;
|
|
10056
11284
|
params =
|
|
10057
|
-
{} as Params$Resource$Projects$Locations$Collections$Datastores$
|
|
11285
|
+
{} as Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge;
|
|
10058
11286
|
options = {};
|
|
10059
11287
|
}
|
|
10060
11288
|
|
|
@@ -10068,57 +11296,52 @@ export namespace discoveryengine_v1alpha {
|
|
|
10068
11296
|
const parameters = {
|
|
10069
11297
|
options: Object.assign(
|
|
10070
11298
|
{
|
|
10071
|
-
url: (
|
|
10072
|
-
/
|
|
10073
|
-
|
|
10074
|
-
|
|
10075
|
-
method: 'GET',
|
|
11299
|
+
url: (
|
|
11300
|
+
rootUrl + '/v1alpha/{+parent}/suggestionDenyListEntries:purge'
|
|
11301
|
+
).replace(/([^:]\/)\/+/g, '$1'),
|
|
11302
|
+
method: 'POST',
|
|
10076
11303
|
},
|
|
10077
11304
|
options
|
|
10078
11305
|
),
|
|
10079
11306
|
params,
|
|
10080
|
-
requiredParams: ['
|
|
10081
|
-
pathParams: ['
|
|
11307
|
+
requiredParams: ['parent'],
|
|
11308
|
+
pathParams: ['parent'],
|
|
10082
11309
|
context: this.context,
|
|
10083
11310
|
};
|
|
10084
11311
|
if (callback) {
|
|
10085
|
-
createAPIRequest<Schema$
|
|
11312
|
+
createAPIRequest<Schema$GoogleLongrunningOperation>(
|
|
10086
11313
|
parameters,
|
|
10087
11314
|
callback as BodyResponseCallback<unknown>
|
|
10088
11315
|
);
|
|
10089
11316
|
} else {
|
|
10090
|
-
return createAPIRequest<Schema$
|
|
10091
|
-
parameters
|
|
10092
|
-
);
|
|
11317
|
+
return createAPIRequest<Schema$GoogleLongrunningOperation>(parameters);
|
|
10093
11318
|
}
|
|
10094
11319
|
}
|
|
10095
11320
|
}
|
|
10096
11321
|
|
|
10097
|
-
export interface Params$Resource$Projects$Locations$Collections$Datastores$
|
|
10098
|
-
extends StandardParameters {
|
|
10099
|
-
/**
|
|
10100
|
-
* The name of the operation resource.
|
|
10101
|
-
*/
|
|
10102
|
-
name?: string;
|
|
10103
|
-
}
|
|
10104
|
-
export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List
|
|
11322
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import
|
|
10105
11323
|
extends StandardParameters {
|
|
10106
11324
|
/**
|
|
10107
|
-
* The
|
|
11325
|
+
* Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x.
|
|
10108
11326
|
*/
|
|
10109
|
-
|
|
11327
|
+
parent?: string;
|
|
11328
|
+
|
|
10110
11329
|
/**
|
|
10111
|
-
*
|
|
11330
|
+
* Request body metadata
|
|
10112
11331
|
*/
|
|
10113
|
-
|
|
11332
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequest;
|
|
11333
|
+
}
|
|
11334
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge
|
|
11335
|
+
extends StandardParameters {
|
|
10114
11336
|
/**
|
|
10115
|
-
* The
|
|
11337
|
+
* Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x.
|
|
10116
11338
|
*/
|
|
10117
|
-
|
|
11339
|
+
parent?: string;
|
|
11340
|
+
|
|
10118
11341
|
/**
|
|
10119
|
-
*
|
|
11342
|
+
* Request body metadata
|
|
10120
11343
|
*/
|
|
10121
|
-
|
|
11344
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesRequest;
|
|
10122
11345
|
}
|
|
10123
11346
|
|
|
10124
11347
|
export class Resource$Projects$Locations$Collections$Datastores$Userevents {
|
|
@@ -11065,7 +12288,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
11065
12288
|
}
|
|
11066
12289
|
|
|
11067
12290
|
/**
|
|
11068
|
-
* Pauses the training of an existing engine. Only applicable if
|
|
12291
|
+
* Pauses the training of an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.
|
|
11069
12292
|
*
|
|
11070
12293
|
* @param params - Parameters for request
|
|
11071
12294
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -11163,7 +12386,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
11163
12386
|
}
|
|
11164
12387
|
|
|
11165
12388
|
/**
|
|
11166
|
-
* Resumes the training of an existing engine. Only applicable if
|
|
12389
|
+
* Resumes the training of an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.
|
|
11167
12390
|
*
|
|
11168
12391
|
* @param params - Parameters for request
|
|
11169
12392
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -11261,7 +12484,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
11261
12484
|
}
|
|
11262
12485
|
|
|
11263
12486
|
/**
|
|
11264
|
-
* Tunes an existing engine. Only applicable if
|
|
12487
|
+
* Tunes an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.
|
|
11265
12488
|
*
|
|
11266
12489
|
* @param params - Parameters for request
|
|
11267
12490
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -12107,7 +13330,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
12107
13330
|
*/
|
|
12108
13331
|
name?: string;
|
|
12109
13332
|
/**
|
|
12110
|
-
* Indicates which fields in the provided Conversation to update. The following are NOT supported: *
|
|
13333
|
+
* Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated.
|
|
12111
13334
|
*/
|
|
12112
13335
|
updateMask?: string;
|
|
12113
13336
|
|
|
@@ -12548,7 +13771,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
12548
13771
|
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend
|
|
12549
13772
|
extends StandardParameters {
|
|
12550
13773
|
/**
|
|
12551
|
-
* Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your Recommend requests.
|
|
13774
|
+
* Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests.
|
|
12552
13775
|
*/
|
|
12553
13776
|
servingConfig?: string;
|
|
12554
13777
|
|
|
@@ -12804,6 +14027,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
12804
14027
|
schemas: Resource$Projects$Locations$Datastores$Schemas;
|
|
12805
14028
|
servingConfigs: Resource$Projects$Locations$Datastores$Servingconfigs;
|
|
12806
14029
|
siteSearchEngine: Resource$Projects$Locations$Datastores$Sitesearchengine;
|
|
14030
|
+
suggestionDenyListEntries: Resource$Projects$Locations$Datastores$Suggestiondenylistentries;
|
|
12807
14031
|
userEvents: Resource$Projects$Locations$Datastores$Userevents;
|
|
12808
14032
|
constructor(context: APIRequestContext) {
|
|
12809
14033
|
this.context = context;
|
|
@@ -12827,6 +14051,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
12827
14051
|
new Resource$Projects$Locations$Datastores$Sitesearchengine(
|
|
12828
14052
|
this.context
|
|
12829
14053
|
);
|
|
14054
|
+
this.suggestionDenyListEntries =
|
|
14055
|
+
new Resource$Projects$Locations$Datastores$Suggestiondenylistentries(
|
|
14056
|
+
this.context
|
|
14057
|
+
);
|
|
12830
14058
|
this.userEvents = new Resource$Projects$Locations$Datastores$Userevents(
|
|
12831
14059
|
this.context
|
|
12832
14060
|
);
|
|
@@ -13703,7 +14931,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
13703
14931
|
*/
|
|
13704
14932
|
query?: string;
|
|
13705
14933
|
/**
|
|
13706
|
-
*
|
|
14934
|
+
* 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.
|
|
13707
14935
|
*/
|
|
13708
14936
|
queryModel?: string;
|
|
13709
14937
|
/**
|
|
@@ -13774,7 +15002,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
13774
15002
|
*/
|
|
13775
15003
|
pageToken?: string;
|
|
13776
15004
|
/**
|
|
13777
|
-
* Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}`. If the caller does not have permission to list
|
|
15005
|
+
* Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}`. If the caller does not have permission to list DataStores under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned.
|
|
13778
15006
|
*/
|
|
13779
15007
|
parent?: string;
|
|
13780
15008
|
}
|
|
@@ -13797,11 +15025,11 @@ export namespace discoveryengine_v1alpha {
|
|
|
13797
15025
|
export interface Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig
|
|
13798
15026
|
extends StandardParameters {
|
|
13799
15027
|
/**
|
|
13800
|
-
*
|
|
15028
|
+
* The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`.
|
|
13801
15029
|
*/
|
|
13802
15030
|
name?: string;
|
|
13803
15031
|
/**
|
|
13804
|
-
* Indicates which fields in the provided DocumentProcessingConfig to update. The following are the only supported fields: * DocumentProcessingConfig.
|
|
15032
|
+
* Indicates which fields in the provided DocumentProcessingConfig to update. The following are the only supported fields: * DocumentProcessingConfig.ocr_config If not set, all supported fields are updated.
|
|
13805
15033
|
*/
|
|
13806
15034
|
updateMask?: string;
|
|
13807
15035
|
|
|
@@ -15461,7 +16689,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
15461
16689
|
*/
|
|
15462
16690
|
name?: string;
|
|
15463
16691
|
/**
|
|
15464
|
-
* Indicates which fields in the provided Conversation to update. The following are NOT supported: *
|
|
16692
|
+
* Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated.
|
|
15465
16693
|
*/
|
|
15466
16694
|
updateMask?: string;
|
|
15467
16695
|
|
|
@@ -16683,7 +17911,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
16683
17911
|
export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend
|
|
16684
17912
|
extends StandardParameters {
|
|
16685
17913
|
/**
|
|
16686
|
-
* Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your Recommend requests.
|
|
17914
|
+
* Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests.
|
|
16687
17915
|
*/
|
|
16688
17916
|
servingConfig?: string;
|
|
16689
17917
|
|
|
@@ -17683,6 +18911,228 @@ export namespace discoveryengine_v1alpha {
|
|
|
17683
18911
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSite;
|
|
17684
18912
|
}
|
|
17685
18913
|
|
|
18914
|
+
export class Resource$Projects$Locations$Datastores$Suggestiondenylistentries {
|
|
18915
|
+
context: APIRequestContext;
|
|
18916
|
+
constructor(context: APIRequestContext) {
|
|
18917
|
+
this.context = context;
|
|
18918
|
+
}
|
|
18919
|
+
|
|
18920
|
+
/**
|
|
18921
|
+
* Imports all SuggestionDenyListEntry for a DataStore.
|
|
18922
|
+
*
|
|
18923
|
+
* @param params - Parameters for request
|
|
18924
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
18925
|
+
* @param callback - Optional callback that handles the response.
|
|
18926
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
18927
|
+
*/
|
|
18928
|
+
import(
|
|
18929
|
+
params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import,
|
|
18930
|
+
options: StreamMethodOptions
|
|
18931
|
+
): GaxiosPromise<Readable>;
|
|
18932
|
+
import(
|
|
18933
|
+
params?: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import,
|
|
18934
|
+
options?: MethodOptions
|
|
18935
|
+
): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
18936
|
+
import(
|
|
18937
|
+
params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import,
|
|
18938
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
18939
|
+
callback: BodyResponseCallback<Readable>
|
|
18940
|
+
): void;
|
|
18941
|
+
import(
|
|
18942
|
+
params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import,
|
|
18943
|
+
options:
|
|
18944
|
+
| MethodOptions
|
|
18945
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>,
|
|
18946
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
18947
|
+
): void;
|
|
18948
|
+
import(
|
|
18949
|
+
params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import,
|
|
18950
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
18951
|
+
): void;
|
|
18952
|
+
import(
|
|
18953
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
18954
|
+
): void;
|
|
18955
|
+
import(
|
|
18956
|
+
paramsOrCallback?:
|
|
18957
|
+
| Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import
|
|
18958
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
18959
|
+
| BodyResponseCallback<Readable>,
|
|
18960
|
+
optionsOrCallback?:
|
|
18961
|
+
| MethodOptions
|
|
18962
|
+
| StreamMethodOptions
|
|
18963
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
18964
|
+
| BodyResponseCallback<Readable>,
|
|
18965
|
+
callback?:
|
|
18966
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
18967
|
+
| BodyResponseCallback<Readable>
|
|
18968
|
+
):
|
|
18969
|
+
| void
|
|
18970
|
+
| GaxiosPromise<Schema$GoogleLongrunningOperation>
|
|
18971
|
+
| GaxiosPromise<Readable> {
|
|
18972
|
+
let params = (paramsOrCallback ||
|
|
18973
|
+
{}) as Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import;
|
|
18974
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
18975
|
+
|
|
18976
|
+
if (typeof paramsOrCallback === 'function') {
|
|
18977
|
+
callback = paramsOrCallback;
|
|
18978
|
+
params =
|
|
18979
|
+
{} as Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import;
|
|
18980
|
+
options = {};
|
|
18981
|
+
}
|
|
18982
|
+
|
|
18983
|
+
if (typeof optionsOrCallback === 'function') {
|
|
18984
|
+
callback = optionsOrCallback;
|
|
18985
|
+
options = {};
|
|
18986
|
+
}
|
|
18987
|
+
|
|
18988
|
+
const rootUrl =
|
|
18989
|
+
options.rootUrl || 'https://discoveryengine.googleapis.com/';
|
|
18990
|
+
const parameters = {
|
|
18991
|
+
options: Object.assign(
|
|
18992
|
+
{
|
|
18993
|
+
url: (
|
|
18994
|
+
rootUrl + '/v1alpha/{+parent}/suggestionDenyListEntries:import'
|
|
18995
|
+
).replace(/([^:]\/)\/+/g, '$1'),
|
|
18996
|
+
method: 'POST',
|
|
18997
|
+
},
|
|
18998
|
+
options
|
|
18999
|
+
),
|
|
19000
|
+
params,
|
|
19001
|
+
requiredParams: ['parent'],
|
|
19002
|
+
pathParams: ['parent'],
|
|
19003
|
+
context: this.context,
|
|
19004
|
+
};
|
|
19005
|
+
if (callback) {
|
|
19006
|
+
createAPIRequest<Schema$GoogleLongrunningOperation>(
|
|
19007
|
+
parameters,
|
|
19008
|
+
callback as BodyResponseCallback<unknown>
|
|
19009
|
+
);
|
|
19010
|
+
} else {
|
|
19011
|
+
return createAPIRequest<Schema$GoogleLongrunningOperation>(parameters);
|
|
19012
|
+
}
|
|
19013
|
+
}
|
|
19014
|
+
|
|
19015
|
+
/**
|
|
19016
|
+
* Permanently deletes all SuggestionDenyListEntry for a DataStore.
|
|
19017
|
+
*
|
|
19018
|
+
* @param params - Parameters for request
|
|
19019
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
19020
|
+
* @param callback - Optional callback that handles the response.
|
|
19021
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
19022
|
+
*/
|
|
19023
|
+
purge(
|
|
19024
|
+
params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge,
|
|
19025
|
+
options: StreamMethodOptions
|
|
19026
|
+
): GaxiosPromise<Readable>;
|
|
19027
|
+
purge(
|
|
19028
|
+
params?: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge,
|
|
19029
|
+
options?: MethodOptions
|
|
19030
|
+
): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
19031
|
+
purge(
|
|
19032
|
+
params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge,
|
|
19033
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
19034
|
+
callback: BodyResponseCallback<Readable>
|
|
19035
|
+
): void;
|
|
19036
|
+
purge(
|
|
19037
|
+
params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge,
|
|
19038
|
+
options:
|
|
19039
|
+
| MethodOptions
|
|
19040
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>,
|
|
19041
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
19042
|
+
): void;
|
|
19043
|
+
purge(
|
|
19044
|
+
params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge,
|
|
19045
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
19046
|
+
): void;
|
|
19047
|
+
purge(
|
|
19048
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
19049
|
+
): void;
|
|
19050
|
+
purge(
|
|
19051
|
+
paramsOrCallback?:
|
|
19052
|
+
| Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge
|
|
19053
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
19054
|
+
| BodyResponseCallback<Readable>,
|
|
19055
|
+
optionsOrCallback?:
|
|
19056
|
+
| MethodOptions
|
|
19057
|
+
| StreamMethodOptions
|
|
19058
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
19059
|
+
| BodyResponseCallback<Readable>,
|
|
19060
|
+
callback?:
|
|
19061
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
19062
|
+
| BodyResponseCallback<Readable>
|
|
19063
|
+
):
|
|
19064
|
+
| void
|
|
19065
|
+
| GaxiosPromise<Schema$GoogleLongrunningOperation>
|
|
19066
|
+
| GaxiosPromise<Readable> {
|
|
19067
|
+
let params = (paramsOrCallback ||
|
|
19068
|
+
{}) as Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge;
|
|
19069
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
19070
|
+
|
|
19071
|
+
if (typeof paramsOrCallback === 'function') {
|
|
19072
|
+
callback = paramsOrCallback;
|
|
19073
|
+
params =
|
|
19074
|
+
{} as Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge;
|
|
19075
|
+
options = {};
|
|
19076
|
+
}
|
|
19077
|
+
|
|
19078
|
+
if (typeof optionsOrCallback === 'function') {
|
|
19079
|
+
callback = optionsOrCallback;
|
|
19080
|
+
options = {};
|
|
19081
|
+
}
|
|
19082
|
+
|
|
19083
|
+
const rootUrl =
|
|
19084
|
+
options.rootUrl || 'https://discoveryengine.googleapis.com/';
|
|
19085
|
+
const parameters = {
|
|
19086
|
+
options: Object.assign(
|
|
19087
|
+
{
|
|
19088
|
+
url: (
|
|
19089
|
+
rootUrl + '/v1alpha/{+parent}/suggestionDenyListEntries:purge'
|
|
19090
|
+
).replace(/([^:]\/)\/+/g, '$1'),
|
|
19091
|
+
method: 'POST',
|
|
19092
|
+
},
|
|
19093
|
+
options
|
|
19094
|
+
),
|
|
19095
|
+
params,
|
|
19096
|
+
requiredParams: ['parent'],
|
|
19097
|
+
pathParams: ['parent'],
|
|
19098
|
+
context: this.context,
|
|
19099
|
+
};
|
|
19100
|
+
if (callback) {
|
|
19101
|
+
createAPIRequest<Schema$GoogleLongrunningOperation>(
|
|
19102
|
+
parameters,
|
|
19103
|
+
callback as BodyResponseCallback<unknown>
|
|
19104
|
+
);
|
|
19105
|
+
} else {
|
|
19106
|
+
return createAPIRequest<Schema$GoogleLongrunningOperation>(parameters);
|
|
19107
|
+
}
|
|
19108
|
+
}
|
|
19109
|
+
}
|
|
19110
|
+
|
|
19111
|
+
export interface Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import
|
|
19112
|
+
extends StandardParameters {
|
|
19113
|
+
/**
|
|
19114
|
+
* Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x.
|
|
19115
|
+
*/
|
|
19116
|
+
parent?: string;
|
|
19117
|
+
|
|
19118
|
+
/**
|
|
19119
|
+
* Request body metadata
|
|
19120
|
+
*/
|
|
19121
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequest;
|
|
19122
|
+
}
|
|
19123
|
+
export interface Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge
|
|
19124
|
+
extends StandardParameters {
|
|
19125
|
+
/**
|
|
19126
|
+
* Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x.
|
|
19127
|
+
*/
|
|
19128
|
+
parent?: string;
|
|
19129
|
+
|
|
19130
|
+
/**
|
|
19131
|
+
* Request body metadata
|
|
19132
|
+
*/
|
|
19133
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesRequest;
|
|
19134
|
+
}
|
|
19135
|
+
|
|
17686
19136
|
export class Resource$Projects$Locations$Datastores$Userevents {
|
|
17687
19137
|
context: APIRequestContext;
|
|
17688
19138
|
constructor(context: APIRequestContext) {
|