@googleapis/discoveryengine 5.0.0 → 6.1.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 +18 -0
- package/build/v1alpha.d.ts +1665 -163
- package/build/v1alpha.js +432 -0
- package/build/v1alpha.js.map +1 -1
- package/build/v1beta.d.ts +2630 -133
- package/build/v1beta.js +1894 -266
- package/build/v1beta.js.map +1 -1
- package/package.json +1 -1
- package/v1alpha.ts +2786 -190
- package/v1beta.ts +9943 -3276
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
|
/**
|
|
@@ -573,6 +573,15 @@ export namespace discoveryengine_v1alpha {
|
|
|
573
573
|
*/
|
|
574
574
|
text?: string[] | null;
|
|
575
575
|
}
|
|
576
|
+
/**
|
|
577
|
+
* Defines custom fine tuning spec.
|
|
578
|
+
*/
|
|
579
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec {
|
|
580
|
+
/**
|
|
581
|
+
* Whether or not to enable and include custom fine tuned search adaptor model.
|
|
582
|
+
*/
|
|
583
|
+
enableSearchAdaptor?: boolean | null;
|
|
584
|
+
}
|
|
576
585
|
/**
|
|
577
586
|
* DataStore captures global settings and configs at the DataStore level.
|
|
578
587
|
*/
|
|
@@ -658,6 +667,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
658
667
|
*/
|
|
659
668
|
updateTime?: string | null;
|
|
660
669
|
}
|
|
670
|
+
/**
|
|
671
|
+
* The digital parsing configurations for documents.
|
|
672
|
+
*/
|
|
673
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaDigitalParsingConfig {}
|
|
661
674
|
/**
|
|
662
675
|
* Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
663
676
|
*/
|
|
@@ -729,7 +742,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
729
742
|
*/
|
|
730
743
|
rawBytes?: string | null;
|
|
731
744
|
/**
|
|
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.
|
|
745
|
+
* 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
746
|
*/
|
|
734
747
|
uri?: string | null;
|
|
735
748
|
}
|
|
@@ -763,13 +776,42 @@ export namespace discoveryengine_v1alpha {
|
|
|
763
776
|
*/
|
|
764
777
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig {
|
|
765
778
|
/**
|
|
766
|
-
*
|
|
779
|
+
* 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.
|
|
780
|
+
*/
|
|
781
|
+
defaultParsingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig;
|
|
782
|
+
/**
|
|
783
|
+
* The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`.
|
|
767
784
|
*/
|
|
768
785
|
name?: string | null;
|
|
769
786
|
/**
|
|
770
|
-
* The OCR config. Currently it only applies to PDFs.
|
|
787
|
+
* [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
788
|
*/
|
|
772
789
|
ocrConfig?: Schema$GoogleCloudDiscoveryengineV1alphaOcrConfig;
|
|
790
|
+
/**
|
|
791
|
+
* 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.
|
|
792
|
+
*/
|
|
793
|
+
parsingConfigOverrides?: {
|
|
794
|
+
[
|
|
795
|
+
key: string
|
|
796
|
+
]: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig;
|
|
797
|
+
} | null;
|
|
798
|
+
}
|
|
799
|
+
/**
|
|
800
|
+
* Related configurations applied to a specific type of document parser.
|
|
801
|
+
*/
|
|
802
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig {
|
|
803
|
+
/**
|
|
804
|
+
* Configurations applied to digital parser.
|
|
805
|
+
*/
|
|
806
|
+
digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDigitalParsingConfig;
|
|
807
|
+
/**
|
|
808
|
+
* Configurations applied to layout parser.
|
|
809
|
+
*/
|
|
810
|
+
layoutParsingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaLayoutParsingConfig;
|
|
811
|
+
/**
|
|
812
|
+
* Configurations applied to OCR parser. Currently it only applies to PDFs.
|
|
813
|
+
*/
|
|
814
|
+
ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaOcrParsingConfig;
|
|
773
815
|
}
|
|
774
816
|
/**
|
|
775
817
|
* Double list.
|
|
@@ -780,6 +822,15 @@ export namespace discoveryengine_v1alpha {
|
|
|
780
822
|
*/
|
|
781
823
|
values?: number[] | null;
|
|
782
824
|
}
|
|
825
|
+
/**
|
|
826
|
+
* Defines embedding config, used for bring your own embeddings feature.
|
|
827
|
+
*/
|
|
828
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaEmbeddingConfig {
|
|
829
|
+
/**
|
|
830
|
+
* Full field path in the schema mapped as embedding field.
|
|
831
|
+
*/
|
|
832
|
+
fieldPath?: string | null;
|
|
833
|
+
}
|
|
783
834
|
/**
|
|
784
835
|
* Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
785
836
|
*/
|
|
@@ -822,7 +873,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
822
873
|
*/
|
|
823
874
|
createTime?: string | null;
|
|
824
875
|
/**
|
|
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
|
|
876
|
+
* 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
877
|
*/
|
|
827
878
|
dataStoreIds?: string[] | null;
|
|
828
879
|
/**
|
|
@@ -871,7 +922,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
871
922
|
*/
|
|
872
923
|
agentCreationConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig;
|
|
873
924
|
/**
|
|
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
|
|
925
|
+
* 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
926
|
*/
|
|
876
927
|
dialogflowAgentToLink?: string | null;
|
|
877
928
|
}
|
|
@@ -887,6 +938,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
887
938
|
* 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
939
|
*/
|
|
889
940
|
defaultLanguageCode?: string | null;
|
|
941
|
+
/**
|
|
942
|
+
* 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.
|
|
943
|
+
*/
|
|
944
|
+
location?: string | null;
|
|
890
945
|
/**
|
|
891
946
|
* 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
947
|
*/
|
|
@@ -906,7 +961,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
906
961
|
*/
|
|
907
962
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaEngineCommonConfig {
|
|
908
963
|
/**
|
|
909
|
-
* The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.
|
|
964
|
+
* Immutable. The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.
|
|
910
965
|
*/
|
|
911
966
|
companyName?: string | null;
|
|
912
967
|
}
|
|
@@ -915,7 +970,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
915
970
|
*/
|
|
916
971
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig {
|
|
917
972
|
/**
|
|
918
|
-
* The optimization objective e.g
|
|
973
|
+
* 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
974
|
*/
|
|
920
975
|
optimizationObjective?: string | null;
|
|
921
976
|
/**
|
|
@@ -927,7 +982,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
927
982
|
*/
|
|
928
983
|
trainingState?: string | null;
|
|
929
984
|
/**
|
|
930
|
-
* Required. The type of engine e.g
|
|
985
|
+
* 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
986
|
*/
|
|
932
987
|
type?: string | null;
|
|
933
988
|
}
|
|
@@ -1005,7 +1060,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
1005
1060
|
websiteDataSource?: Schema$GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSource;
|
|
1006
1061
|
}
|
|
1007
1062
|
/**
|
|
1008
|
-
* Data source contains files either in
|
|
1063
|
+
* Data source contains files either in Cloud Storage or BigQuery.
|
|
1009
1064
|
*/
|
|
1010
1065
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestFileDataSource {
|
|
1011
1066
|
/**
|
|
@@ -1127,6 +1182,23 @@ export namespace discoveryengine_v1alpha {
|
|
|
1127
1182
|
*/
|
|
1128
1183
|
inputUris?: string[] | null;
|
|
1129
1184
|
}
|
|
1185
|
+
/**
|
|
1186
|
+
* Defines guided search spec.
|
|
1187
|
+
*/
|
|
1188
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec {
|
|
1189
|
+
/**
|
|
1190
|
+
* Whether or not to enable and include refinement attributes in gudied search result.
|
|
1191
|
+
*/
|
|
1192
|
+
enableRefinementAttributes?: boolean | null;
|
|
1193
|
+
/**
|
|
1194
|
+
* Whether or not to enable and include related questions in search response.
|
|
1195
|
+
*/
|
|
1196
|
+
enableRelatedQuestions?: boolean | null;
|
|
1197
|
+
/**
|
|
1198
|
+
* Max number of related questions to be returned. The valid range is [1, 5]. If enable_related_questions is true, the default value is 3.
|
|
1199
|
+
*/
|
|
1200
|
+
maxRelatedQuestions?: number | null;
|
|
1201
|
+
}
|
|
1130
1202
|
/**
|
|
1131
1203
|
* Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
1132
1204
|
*/
|
|
@@ -1212,6 +1284,58 @@ export namespace discoveryengine_v1alpha {
|
|
|
1212
1284
|
*/
|
|
1213
1285
|
gcsPrefix?: string | null;
|
|
1214
1286
|
}
|
|
1287
|
+
/**
|
|
1288
|
+
* Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
1289
|
+
*/
|
|
1290
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata {
|
|
1291
|
+
/**
|
|
1292
|
+
* Operation create time.
|
|
1293
|
+
*/
|
|
1294
|
+
createTime?: string | null;
|
|
1295
|
+
/**
|
|
1296
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
1297
|
+
*/
|
|
1298
|
+
updateTime?: string | null;
|
|
1299
|
+
}
|
|
1300
|
+
/**
|
|
1301
|
+
* Request message for CompletionService.ImportSuggestionDenyListEntries method.
|
|
1302
|
+
*/
|
|
1303
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequest {
|
|
1304
|
+
/**
|
|
1305
|
+
* 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.
|
|
1306
|
+
*/
|
|
1307
|
+
gcsSource?: Schema$GoogleCloudDiscoveryengineV1alphaGcsSource;
|
|
1308
|
+
/**
|
|
1309
|
+
* The Inline source for the input content for suggestion deny list entries.
|
|
1310
|
+
*/
|
|
1311
|
+
inlineSource?: Schema$GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequestInlineSource;
|
|
1312
|
+
}
|
|
1313
|
+
/**
|
|
1314
|
+
* The inline source for SuggestionDenyListEntry.
|
|
1315
|
+
*/
|
|
1316
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequestInlineSource {
|
|
1317
|
+
/**
|
|
1318
|
+
* Required. A list of all denylist entries to import. Max of 1000 items.
|
|
1319
|
+
*/
|
|
1320
|
+
entries?: Schema$GoogleCloudDiscoveryengineV1alphaSuggestionDenyListEntry[];
|
|
1321
|
+
}
|
|
1322
|
+
/**
|
|
1323
|
+
* Response message for CompletionService.ImportSuggestionDenyListEntries method.
|
|
1324
|
+
*/
|
|
1325
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse {
|
|
1326
|
+
/**
|
|
1327
|
+
* A sample of errors encountered while processing the request.
|
|
1328
|
+
*/
|
|
1329
|
+
errorSamples?: Schema$GoogleRpcStatus[];
|
|
1330
|
+
/**
|
|
1331
|
+
* Count of deny list entries that failed to be imported.
|
|
1332
|
+
*/
|
|
1333
|
+
failedEntriesCount?: string | null;
|
|
1334
|
+
/**
|
|
1335
|
+
* Count of deny list entries successfully imported.
|
|
1336
|
+
*/
|
|
1337
|
+
importedEntriesCount?: string | null;
|
|
1338
|
+
}
|
|
1215
1339
|
/**
|
|
1216
1340
|
* Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
1217
1341
|
*/
|
|
@@ -1305,6 +1429,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
1305
1429
|
*/
|
|
1306
1430
|
minimum?: number | null;
|
|
1307
1431
|
}
|
|
1432
|
+
/**
|
|
1433
|
+
* The layout parsing configurations for documents.
|
|
1434
|
+
*/
|
|
1435
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaLayoutParsingConfig {}
|
|
1308
1436
|
/**
|
|
1309
1437
|
* Response for ListConversations method.
|
|
1310
1438
|
*/
|
|
@@ -1370,6 +1498,19 @@ export namespace discoveryengine_v1alpha {
|
|
|
1370
1498
|
*/
|
|
1371
1499
|
schemas?: Schema$GoogleCloudDiscoveryengineV1alphaSchema[];
|
|
1372
1500
|
}
|
|
1501
|
+
/**
|
|
1502
|
+
* Response for ListServingConfigs method.
|
|
1503
|
+
*/
|
|
1504
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse {
|
|
1505
|
+
/**
|
|
1506
|
+
* Pagination token, if not returned indicates the last page.
|
|
1507
|
+
*/
|
|
1508
|
+
nextPageToken?: string | null;
|
|
1509
|
+
/**
|
|
1510
|
+
* All the ServingConfigs for a given dataStore.
|
|
1511
|
+
*/
|
|
1512
|
+
servingConfigs?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfig[];
|
|
1513
|
+
}
|
|
1373
1514
|
/**
|
|
1374
1515
|
* Response message for SiteSearchEngineService.ListTargetSites method.
|
|
1375
1516
|
*/
|
|
@@ -1423,7 +1564,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
1423
1564
|
*/
|
|
1424
1565
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaOcrConfig {
|
|
1425
1566
|
/**
|
|
1426
|
-
* Required. If OCR is enabled or not. OCR must be enabled for other OcrConfig options to apply.
|
|
1567
|
+
* 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
1568
|
*/
|
|
1428
1569
|
enabled?: boolean | null;
|
|
1429
1570
|
/**
|
|
@@ -1435,6 +1576,19 @@ export namespace discoveryengine_v1alpha {
|
|
|
1435
1576
|
*/
|
|
1436
1577
|
useNativeText?: boolean | null;
|
|
1437
1578
|
}
|
|
1579
|
+
/**
|
|
1580
|
+
* The OCR parsing configurations for documents.
|
|
1581
|
+
*/
|
|
1582
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaOcrParsingConfig {
|
|
1583
|
+
/**
|
|
1584
|
+
* Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.
|
|
1585
|
+
*/
|
|
1586
|
+
enhancedDocumentElements?: string[] | null;
|
|
1587
|
+
/**
|
|
1588
|
+
* If true, will use native text instead of OCR text on pages containing native text.
|
|
1589
|
+
*/
|
|
1590
|
+
useNativeText?: boolean | null;
|
|
1591
|
+
}
|
|
1438
1592
|
/**
|
|
1439
1593
|
* Detailed page information.
|
|
1440
1594
|
*/
|
|
@@ -1528,6 +1682,36 @@ export namespace discoveryengine_v1alpha {
|
|
|
1528
1682
|
*/
|
|
1529
1683
|
purgeSample?: string[] | null;
|
|
1530
1684
|
}
|
|
1685
|
+
/**
|
|
1686
|
+
* Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
1687
|
+
*/
|
|
1688
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesMetadata {
|
|
1689
|
+
/**
|
|
1690
|
+
* Operation create time.
|
|
1691
|
+
*/
|
|
1692
|
+
createTime?: string | null;
|
|
1693
|
+
/**
|
|
1694
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
1695
|
+
*/
|
|
1696
|
+
updateTime?: string | null;
|
|
1697
|
+
}
|
|
1698
|
+
/**
|
|
1699
|
+
* Request message for CompletionService.PurgeSuggestionDenyListEntries method.
|
|
1700
|
+
*/
|
|
1701
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesRequest {}
|
|
1702
|
+
/**
|
|
1703
|
+
* Response message for CompletionService.PurgeSuggestionDenyListEntries method.
|
|
1704
|
+
*/
|
|
1705
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesResponse {
|
|
1706
|
+
/**
|
|
1707
|
+
* A sample of errors encountered while processing the request.
|
|
1708
|
+
*/
|
|
1709
|
+
errorSamples?: Schema$GoogleRpcStatus[];
|
|
1710
|
+
/**
|
|
1711
|
+
* Number of suggestion deny list entries purged.
|
|
1712
|
+
*/
|
|
1713
|
+
purgeCount?: string | null;
|
|
1714
|
+
}
|
|
1531
1715
|
/**
|
|
1532
1716
|
* Metadata related to the progress of the PurgeUserEvents operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
1533
1717
|
*/
|
|
@@ -1707,7 +1891,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
1707
1891
|
uri?: string | null;
|
|
1708
1892
|
}
|
|
1709
1893
|
/**
|
|
1710
|
-
* Details about why crawling failed for a particular CorpusType, e.g
|
|
1894
|
+
* Details about why crawling failed for a particular CorpusType, e.g., DESKTOP and MOBILE crawling may fail for different reasons.
|
|
1711
1895
|
*/
|
|
1712
1896
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason {
|
|
1713
1897
|
/**
|
|
@@ -1820,7 +2004,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
1820
2004
|
*/
|
|
1821
2005
|
contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec;
|
|
1822
2006
|
/**
|
|
1823
|
-
* Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.
|
|
2007
|
+
* 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
2008
|
*/
|
|
1825
2009
|
embeddingSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec;
|
|
1826
2010
|
/**
|
|
@@ -1936,7 +2120,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
1936
2120
|
*/
|
|
1937
2121
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec {
|
|
1938
2122
|
/**
|
|
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
|
|
2123
|
+
* 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
2124
|
*/
|
|
1941
2125
|
maxExtractiveAnswerCount?: number | null;
|
|
1942
2126
|
/**
|
|
@@ -2016,7 +2200,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
2016
2200
|
*/
|
|
2017
2201
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec {
|
|
2018
2202
|
/**
|
|
2019
|
-
* The string
|
|
2203
|
+
* 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. LINT.IfChange * `preview`: string. (Public preview) Uses a fine-tuned version of the text-bison@002 model. This model works only for summaries in English. LINT.ThenChange(//depot/google3/cloud/console/web/ai/unified_cloud_search/pages/configurations/widget_tab.ts)
|
|
2020
2204
|
*/
|
|
2021
2205
|
version?: string | null;
|
|
2022
2206
|
}
|
|
@@ -2348,7 +2532,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
2348
2532
|
*/
|
|
2349
2533
|
title?: string | null;
|
|
2350
2534
|
/**
|
|
2351
|
-
*
|
|
2535
|
+
* Cloud Storage or HTTP uri for the document.
|
|
2352
2536
|
*/
|
|
2353
2537
|
uri?: string | null;
|
|
2354
2538
|
}
|
|
@@ -2382,6 +2566,126 @@ export namespace discoveryengine_v1alpha {
|
|
|
2382
2566
|
*/
|
|
2383
2567
|
summary?: string | null;
|
|
2384
2568
|
}
|
|
2569
|
+
/**
|
|
2570
|
+
* Configures metadata that is used to generate serving time results (e.g. search results or recommendation predictions). The ServingConfig is passed in the search and predict request and generates results.
|
|
2571
|
+
*/
|
|
2572
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaServingConfig {
|
|
2573
|
+
/**
|
|
2574
|
+
* Boost controls to use in serving path. All triggered boost controls will be applied. Boost controls must be in the same data store as the serving config. Maximum of 20 boost controls.
|
|
2575
|
+
*/
|
|
2576
|
+
boostControlIds?: string[] | null;
|
|
2577
|
+
/**
|
|
2578
|
+
* Output only. ServingConfig created timestamp.
|
|
2579
|
+
*/
|
|
2580
|
+
createTime?: string | null;
|
|
2581
|
+
/**
|
|
2582
|
+
* Custom fine tuning configs.
|
|
2583
|
+
*/
|
|
2584
|
+
customFineTuningSpec?: Schema$GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec;
|
|
2585
|
+
/**
|
|
2586
|
+
* Required. The human readable serving config display name. Used in Discovery UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
|
2587
|
+
*/
|
|
2588
|
+
displayName?: string | null;
|
|
2589
|
+
/**
|
|
2590
|
+
* Condition do not associate specifications. If multiple do not associate conditions match, all matching do not associate controls in the list will execute. Order does not matter. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
|
|
2591
|
+
*/
|
|
2592
|
+
dissociateControlIds?: string[] | null;
|
|
2593
|
+
/**
|
|
2594
|
+
* How much diversity to use in recommendation model results e.g. `medium-diversity` or `high-diversity`. Currently supported values: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` If not specified, we choose default based on recommendation model type. Default value: `no-diversity`. Can only be set if SolutionType is SOLUTION_TYPE_RECOMMENDATION.
|
|
2595
|
+
*/
|
|
2596
|
+
diversityLevel?: string | null;
|
|
2597
|
+
/**
|
|
2598
|
+
* Bring your own embedding config. The config is used for search semantic retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embeddings that are provided by this EmbeddingConfig. If SearchRequest.EmbeddingSpec.EmbeddingVector.vector is provided, it overrides this ServingConfig.embedding_config.
|
|
2599
|
+
*/
|
|
2600
|
+
embeddingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEmbeddingConfig;
|
|
2601
|
+
/**
|
|
2602
|
+
* Filter controls to use in serving path. All triggered filter controls will be applied. Filter controls must be in the same data store as the serving config. Maximum of 20 filter controls.
|
|
2603
|
+
*/
|
|
2604
|
+
filterControlIds?: string[] | null;
|
|
2605
|
+
/**
|
|
2606
|
+
* The GenericConfig of the serving configuration.
|
|
2607
|
+
*/
|
|
2608
|
+
genericConfig?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfigGenericConfig;
|
|
2609
|
+
/**
|
|
2610
|
+
* Guided search configs.
|
|
2611
|
+
*/
|
|
2612
|
+
guidedSearchSpec?: Schema$GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec;
|
|
2613
|
+
/**
|
|
2614
|
+
* Condition ignore specifications. If multiple ignore conditions match, all matching ignore controls in the list will execute. Order does not matter. Maximum number of specifications is 100.
|
|
2615
|
+
*/
|
|
2616
|
+
ignoreControlIds?: string[] | null;
|
|
2617
|
+
/**
|
|
2618
|
+
* The MediaConfig of the serving configuration.
|
|
2619
|
+
*/
|
|
2620
|
+
mediaConfig?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig;
|
|
2621
|
+
/**
|
|
2622
|
+
* The id of the model to use at serving time. Currently only RecommendationModels are supported. Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when SolutionType is SOLUTION_TYPE_RECOMMENDATION.
|
|
2623
|
+
*/
|
|
2624
|
+
modelId?: string | null;
|
|
2625
|
+
/**
|
|
2626
|
+
* Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}`
|
|
2627
|
+
*/
|
|
2628
|
+
name?: string | null;
|
|
2629
|
+
/**
|
|
2630
|
+
* Condition oneway synonyms specifications. If multiple oneway synonyms conditions match, all matching oneway synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
|
|
2631
|
+
*/
|
|
2632
|
+
onewaySynonymsControlIds?: string[] | null;
|
|
2633
|
+
rankingExpression?: string | null;
|
|
2634
|
+
/**
|
|
2635
|
+
* IDs of the redirect controls. Only the first triggered redirect action is applied, even if multiple apply. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
|
|
2636
|
+
*/
|
|
2637
|
+
redirectControlIds?: string[] | null;
|
|
2638
|
+
/**
|
|
2639
|
+
* Condition replacement specifications. Applied according to the order in the list. A previously replaced term can not be re-replaced. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
|
|
2640
|
+
*/
|
|
2641
|
+
replacementControlIds?: string[] | null;
|
|
2642
|
+
/**
|
|
2643
|
+
* Required. Immutable. Specifies the solution type that a serving config can be associated with.
|
|
2644
|
+
*/
|
|
2645
|
+
solutionType?: string | null;
|
|
2646
|
+
/**
|
|
2647
|
+
* Condition synonyms specifications. If multiple synonyms conditions match, all matching synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
|
|
2648
|
+
*/
|
|
2649
|
+
synonymsControlIds?: string[] | null;
|
|
2650
|
+
/**
|
|
2651
|
+
* Output only. ServingConfig updated timestamp.
|
|
2652
|
+
*/
|
|
2653
|
+
updateTime?: string | null;
|
|
2654
|
+
}
|
|
2655
|
+
/**
|
|
2656
|
+
* Specifies the configurations needed for Generic Discovery.Currently we support: * `content_search_spec`: configuration for generic content search.
|
|
2657
|
+
*/
|
|
2658
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaServingConfigGenericConfig {
|
|
2659
|
+
/**
|
|
2660
|
+
* Specifies the expected behavior of content search. Only valid for content-search enabled data store.
|
|
2661
|
+
*/
|
|
2662
|
+
contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec;
|
|
2663
|
+
}
|
|
2664
|
+
/**
|
|
2665
|
+
* Specifies the configurations needed for Media Discovery. Currently we support: * `demote_content_watched`: Threshold for watched content demotion. Customers can specify if using watched content demotion or use viewed detail page. Using the content watched demotion, customers need to specify the watched minutes or percentage exceeds the threshold, the content will be demoted in the recommendation result. * `promote_fresh_content`: cutoff days for fresh content promotion. Customers can specify if using content freshness promotion. If the content was published within the cutoff days, the content will be promoted in the recommendation result. Can only be set if SolutionType is SOLUTION_TYPE_RECOMMENDATION.
|
|
2666
|
+
*/
|
|
2667
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig {
|
|
2668
|
+
/**
|
|
2669
|
+
* Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days.
|
|
2670
|
+
*/
|
|
2671
|
+
contentFreshnessCutoffDays?: number | null;
|
|
2672
|
+
/**
|
|
2673
|
+
* Specifies the content watched minutes threshold for demotion.
|
|
2674
|
+
*/
|
|
2675
|
+
contentWatchedMinutesThreshold?: number | null;
|
|
2676
|
+
/**
|
|
2677
|
+
* Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive.
|
|
2678
|
+
*/
|
|
2679
|
+
contentWatchedPercentageThreshold?: number | null;
|
|
2680
|
+
/**
|
|
2681
|
+
* Specifies the content watched minutes threshold for demotion.
|
|
2682
|
+
*/
|
|
2683
|
+
contentWatchedSecondsThreshold?: number | null;
|
|
2684
|
+
/**
|
|
2685
|
+
* Specifies the event type used for demoting recommendation result. Currently supported values: * `view-item`: Item viewed. * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. If unset, watch history demotion will not be applied. Content freshness demotion will still be applied.
|
|
2686
|
+
*/
|
|
2687
|
+
demotionEventType?: string | null;
|
|
2688
|
+
}
|
|
2385
2689
|
/**
|
|
2386
2690
|
* SiteSearchEngine captures DataStore level site search persisting configurations. It is a singleton value per data store.
|
|
2387
2691
|
*/
|
|
@@ -2404,6 +2708,19 @@ export namespace discoveryengine_v1alpha {
|
|
|
2404
2708
|
*/
|
|
2405
2709
|
verifyTime?: string | null;
|
|
2406
2710
|
}
|
|
2711
|
+
/**
|
|
2712
|
+
* Suggestion deny list entry identifying the phrase to block from suggestions and the applied operation for the phrase.
|
|
2713
|
+
*/
|
|
2714
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaSuggestionDenyListEntry {
|
|
2715
|
+
/**
|
|
2716
|
+
* Required. Phrase to block from suggestions served. Can be maximum 125 characters.
|
|
2717
|
+
*/
|
|
2718
|
+
blockPhrase?: string | null;
|
|
2719
|
+
/**
|
|
2720
|
+
* Required. The match operator to apply for this phrase. Whether to block the exact phrase, or block any suggestions containing this phrase.
|
|
2721
|
+
*/
|
|
2722
|
+
matchOperator?: string | null;
|
|
2723
|
+
}
|
|
2407
2724
|
/**
|
|
2408
2725
|
* A target site for the SiteSearchEngine.
|
|
2409
2726
|
*/
|
|
@@ -2437,7 +2754,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
2437
2754
|
*/
|
|
2438
2755
|
siteVerificationInfo?: Schema$GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo;
|
|
2439
2756
|
/**
|
|
2440
|
-
* The type of the target site, e.g
|
|
2757
|
+
* The type of the target site, e.g., whether the site is to be included or excluded.
|
|
2441
2758
|
*/
|
|
2442
2759
|
type?: string | null;
|
|
2443
2760
|
/**
|
|
@@ -2454,7 +2771,12 @@ export namespace discoveryengine_v1alpha {
|
|
|
2454
2771
|
*/
|
|
2455
2772
|
quotaFailure?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure;
|
|
2456
2773
|
}
|
|
2457
|
-
export interface Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure {
|
|
2774
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure {
|
|
2775
|
+
/**
|
|
2776
|
+
* This number is an estimation on how much total quota this project needs to successfully complete indexing.
|
|
2777
|
+
*/
|
|
2778
|
+
totalRequiredQuota?: string | null;
|
|
2779
|
+
}
|
|
2458
2780
|
/**
|
|
2459
2781
|
* Defines text input.
|
|
2460
2782
|
*/
|
|
@@ -2490,7 +2812,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
2490
2812
|
*/
|
|
2491
2813
|
errorConfig?: Schema$GoogleCloudDiscoveryengineV1alphaImportErrorConfig;
|
|
2492
2814
|
/**
|
|
2493
|
-
*
|
|
2815
|
+
* Cloud Storage training input.
|
|
2494
2816
|
*/
|
|
2495
2817
|
gcsTrainingInput?: Schema$GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequestGcsTrainingInput;
|
|
2496
2818
|
/**
|
|
@@ -2499,23 +2821,23 @@ export namespace discoveryengine_v1alpha {
|
|
|
2499
2821
|
modelType?: string | null;
|
|
2500
2822
|
}
|
|
2501
2823
|
/**
|
|
2502
|
-
*
|
|
2824
|
+
* Cloud Storage training data input.
|
|
2503
2825
|
*/
|
|
2504
2826
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequestGcsTrainingInput {
|
|
2505
2827
|
/**
|
|
2506
|
-
* The
|
|
2828
|
+
* 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
2829
|
*/
|
|
2508
2830
|
corpusDataPath?: string | null;
|
|
2509
2831
|
/**
|
|
2510
|
-
* The gcs query data which could be associated in train data. The data path format is gs:///. A newline delimited jsonl/ndjson file.
|
|
2832
|
+
* 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
2833
|
*/
|
|
2512
2834
|
queryDataPath?: string | null;
|
|
2513
2835
|
/**
|
|
2514
|
-
*
|
|
2836
|
+
* 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
2837
|
*/
|
|
2516
2838
|
testDataPath?: string | null;
|
|
2517
2839
|
/**
|
|
2518
|
-
*
|
|
2840
|
+
* 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
2841
|
*/
|
|
2520
2842
|
trainDataPath?: string | null;
|
|
2521
2843
|
}
|
|
@@ -2643,7 +2965,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
2643
2965
|
*/
|
|
2644
2966
|
eventType?: string | null;
|
|
2645
2967
|
/**
|
|
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
|
|
2968
|
+
* 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
2969
|
*/
|
|
2648
2970
|
filter?: string | null;
|
|
2649
2971
|
/**
|
|
@@ -2811,6 +3133,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
2811
3133
|
key: string
|
|
2812
3134
|
]: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigUIComponentField;
|
|
2813
3135
|
} | null;
|
|
3136
|
+
/**
|
|
3137
|
+
* Output only. The industry vertical that the WidgetConfig registers. The WidgetConfig industry vertical is based on the associated Engine.
|
|
3138
|
+
*/
|
|
3139
|
+
industryVertical?: string | null;
|
|
2814
3140
|
/**
|
|
2815
3141
|
* Output only. Whether LLM is enabled in the corresponding data store.
|
|
2816
3142
|
*/
|
|
@@ -2935,9 +3261,9 @@ export namespace discoveryengine_v1alpha {
|
|
|
2935
3261
|
uToken?: string | null;
|
|
2936
3262
|
}
|
|
2937
3263
|
/**
|
|
2938
|
-
* Metadata
|
|
3264
|
+
* Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
2939
3265
|
*/
|
|
2940
|
-
export interface Schema$
|
|
3266
|
+
export interface Schema$GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata {
|
|
2941
3267
|
/**
|
|
2942
3268
|
* Operation create time.
|
|
2943
3269
|
*/
|
|
@@ -2948,9 +3274,18 @@ export namespace discoveryengine_v1alpha {
|
|
|
2948
3274
|
updateTime?: string | null;
|
|
2949
3275
|
}
|
|
2950
3276
|
/**
|
|
2951
|
-
*
|
|
3277
|
+
* Response message for SiteSearchEngineService.BatchCreateTargetSites method.
|
|
2952
3278
|
*/
|
|
2953
|
-
export interface Schema$
|
|
3279
|
+
export interface Schema$GoogleCloudDiscoveryengineV1BatchCreateTargetSitesResponse {
|
|
3280
|
+
/**
|
|
3281
|
+
* TargetSites created.
|
|
3282
|
+
*/
|
|
3283
|
+
targetSites?: Schema$GoogleCloudDiscoveryengineV1TargetSite[];
|
|
3284
|
+
}
|
|
3285
|
+
/**
|
|
3286
|
+
* Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3287
|
+
*/
|
|
3288
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata {
|
|
2954
3289
|
/**
|
|
2955
3290
|
* Operation create time.
|
|
2956
3291
|
*/
|
|
@@ -2961,145 +3296,155 @@ export namespace discoveryengine_v1alpha {
|
|
|
2961
3296
|
updateTime?: string | null;
|
|
2962
3297
|
}
|
|
2963
3298
|
/**
|
|
2964
|
-
*
|
|
3299
|
+
* Response message for SiteSearchEngineService.BatchCreateTargetSites method.
|
|
2965
3300
|
*/
|
|
2966
|
-
export interface Schema$
|
|
2967
|
-
/**
|
|
2968
|
-
* Operation create time.
|
|
2969
|
-
*/
|
|
2970
|
-
createTime?: string | null;
|
|
3301
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesResponse {
|
|
2971
3302
|
/**
|
|
2972
|
-
*
|
|
3303
|
+
* TargetSites created.
|
|
2973
3304
|
*/
|
|
2974
|
-
|
|
3305
|
+
targetSites?: Schema$GoogleCloudDiscoveryengineV1betaTargetSite[];
|
|
3306
|
+
}
|
|
3307
|
+
/**
|
|
3308
|
+
* Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3309
|
+
*/
|
|
3310
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata {
|
|
2975
3311
|
/**
|
|
2976
|
-
*
|
|
3312
|
+
* Operation create time.
|
|
2977
3313
|
*/
|
|
2978
|
-
|
|
3314
|
+
createTime?: string | null;
|
|
2979
3315
|
/**
|
|
2980
3316
|
* Operation last update time. If the operation is done, this is also the finish time.
|
|
2981
3317
|
*/
|
|
2982
3318
|
updateTime?: string | null;
|
|
2983
3319
|
}
|
|
2984
3320
|
/**
|
|
2985
|
-
*
|
|
3321
|
+
* Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
2986
3322
|
*/
|
|
2987
|
-
export interface Schema$
|
|
3323
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaCreateEngineMetadata {
|
|
2988
3324
|
/**
|
|
2989
|
-
*
|
|
3325
|
+
* Operation create time.
|
|
2990
3326
|
*/
|
|
2991
|
-
|
|
3327
|
+
createTime?: string | null;
|
|
2992
3328
|
/**
|
|
2993
|
-
*
|
|
3329
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
2994
3330
|
*/
|
|
2995
|
-
|
|
3331
|
+
updateTime?: string | null;
|
|
2996
3332
|
}
|
|
2997
3333
|
/**
|
|
2998
|
-
*
|
|
3334
|
+
* Metadata for Create Schema LRO.
|
|
2999
3335
|
*/
|
|
3000
|
-
export interface Schema$
|
|
3336
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata {
|
|
3001
3337
|
/**
|
|
3002
|
-
*
|
|
3338
|
+
* Operation create time.
|
|
3003
3339
|
*/
|
|
3004
|
-
|
|
3340
|
+
createTime?: string | null;
|
|
3341
|
+
/**
|
|
3342
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3343
|
+
*/
|
|
3344
|
+
updateTime?: string | null;
|
|
3005
3345
|
}
|
|
3006
3346
|
/**
|
|
3007
|
-
* Metadata related to the progress of the
|
|
3347
|
+
* Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3008
3348
|
*/
|
|
3009
|
-
export interface Schema$
|
|
3349
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaCreateTargetSiteMetadata {
|
|
3010
3350
|
/**
|
|
3011
3351
|
* Operation create time.
|
|
3012
3352
|
*/
|
|
3013
3353
|
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
3354
|
/**
|
|
3023
3355
|
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3024
3356
|
*/
|
|
3025
3357
|
updateTime?: string | null;
|
|
3026
3358
|
}
|
|
3027
3359
|
/**
|
|
3028
|
-
*
|
|
3360
|
+
* DataStore captures global settings and configs at the DataStore level.
|
|
3029
3361
|
*/
|
|
3030
|
-
export interface Schema$
|
|
3362
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaDataStore {
|
|
3031
3363
|
/**
|
|
3032
|
-
*
|
|
3364
|
+
* Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
|
|
3033
3365
|
*/
|
|
3034
|
-
|
|
3366
|
+
contentConfig?: string | null;
|
|
3035
3367
|
/**
|
|
3036
|
-
*
|
|
3368
|
+
* Output only. Timestamp the DataStore was created at.
|
|
3037
3369
|
*/
|
|
3038
|
-
|
|
3370
|
+
createTime?: string | null;
|
|
3039
3371
|
/**
|
|
3040
|
-
*
|
|
3372
|
+
* Output only. The id of the default Schema asscociated to this data store.
|
|
3041
3373
|
*/
|
|
3042
|
-
|
|
3374
|
+
defaultSchemaId?: string | null;
|
|
3043
3375
|
/**
|
|
3044
|
-
*
|
|
3376
|
+
* 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.
|
|
3045
3377
|
*/
|
|
3046
|
-
|
|
3378
|
+
displayName?: string | null;
|
|
3379
|
+
/**
|
|
3380
|
+
* Immutable. The industry vertical that the data store registers.
|
|
3381
|
+
*/
|
|
3382
|
+
industryVertical?: string | null;
|
|
3383
|
+
/**
|
|
3384
|
+
* 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.
|
|
3385
|
+
*/
|
|
3386
|
+
name?: string | null;
|
|
3387
|
+
/**
|
|
3388
|
+
* 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.
|
|
3389
|
+
*/
|
|
3390
|
+
solutionTypes?: string[] | null;
|
|
3047
3391
|
}
|
|
3048
3392
|
/**
|
|
3049
|
-
* Metadata related to the progress of the
|
|
3393
|
+
* Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3050
3394
|
*/
|
|
3051
|
-
export interface Schema$
|
|
3395
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata {
|
|
3052
3396
|
/**
|
|
3053
3397
|
* Operation create time.
|
|
3054
3398
|
*/
|
|
3055
3399
|
createTime?: string | null;
|
|
3056
3400
|
/**
|
|
3057
|
-
*
|
|
3401
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3058
3402
|
*/
|
|
3059
|
-
|
|
3403
|
+
updateTime?: string | null;
|
|
3404
|
+
}
|
|
3405
|
+
/**
|
|
3406
|
+
* Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3407
|
+
*/
|
|
3408
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaDeleteEngineMetadata {
|
|
3060
3409
|
/**
|
|
3061
|
-
*
|
|
3410
|
+
* Operation create time.
|
|
3062
3411
|
*/
|
|
3063
|
-
|
|
3412
|
+
createTime?: string | null;
|
|
3064
3413
|
/**
|
|
3065
3414
|
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3066
3415
|
*/
|
|
3067
3416
|
updateTime?: string | null;
|
|
3068
3417
|
}
|
|
3069
3418
|
/**
|
|
3070
|
-
*
|
|
3419
|
+
* Metadata for DeleteSchema LRO.
|
|
3071
3420
|
*/
|
|
3072
|
-
export interface Schema$
|
|
3421
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata {
|
|
3073
3422
|
/**
|
|
3074
|
-
*
|
|
3423
|
+
* Operation create time.
|
|
3075
3424
|
*/
|
|
3076
|
-
|
|
3425
|
+
createTime?: string | null;
|
|
3077
3426
|
/**
|
|
3078
|
-
*
|
|
3427
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3079
3428
|
*/
|
|
3080
|
-
|
|
3429
|
+
updateTime?: string | null;
|
|
3081
3430
|
}
|
|
3082
3431
|
/**
|
|
3083
|
-
*
|
|
3432
|
+
* Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3084
3433
|
*/
|
|
3085
|
-
export interface Schema$
|
|
3086
|
-
/**
|
|
3087
|
-
* The JSON representation of the schema.
|
|
3088
|
-
*/
|
|
3089
|
-
jsonSchema?: string | null;
|
|
3434
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaDeleteTargetSiteMetadata {
|
|
3090
3435
|
/**
|
|
3091
|
-
*
|
|
3436
|
+
* Operation create time.
|
|
3092
3437
|
*/
|
|
3093
|
-
|
|
3438
|
+
createTime?: string | null;
|
|
3094
3439
|
/**
|
|
3095
|
-
*
|
|
3440
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3096
3441
|
*/
|
|
3097
|
-
|
|
3442
|
+
updateTime?: string | null;
|
|
3098
3443
|
}
|
|
3099
3444
|
/**
|
|
3100
|
-
* Metadata
|
|
3445
|
+
* Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3101
3446
|
*/
|
|
3102
|
-
export interface Schema$
|
|
3447
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata {
|
|
3103
3448
|
/**
|
|
3104
3449
|
* Operation create time.
|
|
3105
3450
|
*/
|
|
@@ -3110,9 +3455,13 @@ export namespace discoveryengine_v1alpha {
|
|
|
3110
3455
|
updateTime?: string | null;
|
|
3111
3456
|
}
|
|
3112
3457
|
/**
|
|
3113
|
-
*
|
|
3458
|
+
* Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.
|
|
3114
3459
|
*/
|
|
3115
|
-
export interface Schema$
|
|
3460
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse {}
|
|
3461
|
+
/**
|
|
3462
|
+
* Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3463
|
+
*/
|
|
3464
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata {
|
|
3116
3465
|
/**
|
|
3117
3466
|
* Operation create time.
|
|
3118
3467
|
*/
|
|
@@ -3123,22 +3472,127 @@ export namespace discoveryengine_v1alpha {
|
|
|
3123
3472
|
updateTime?: string | null;
|
|
3124
3473
|
}
|
|
3125
3474
|
/**
|
|
3126
|
-
*
|
|
3475
|
+
* Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.
|
|
3127
3476
|
*/
|
|
3128
|
-
export interface Schema$
|
|
3477
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchResponse {}
|
|
3478
|
+
/**
|
|
3479
|
+
* Metadata that describes the training and serving parameters of an Engine.
|
|
3480
|
+
*/
|
|
3481
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaEngine {
|
|
3129
3482
|
/**
|
|
3130
|
-
*
|
|
3483
|
+
* Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
|
|
3484
|
+
*/
|
|
3485
|
+
chatEngineConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig;
|
|
3486
|
+
/**
|
|
3487
|
+
* Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
|
|
3488
|
+
*/
|
|
3489
|
+
chatEngineMetadata?: Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata;
|
|
3490
|
+
/**
|
|
3491
|
+
* Common config spec that specifies the metadata of the engine.
|
|
3492
|
+
*/
|
|
3493
|
+
commonConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineCommonConfig;
|
|
3494
|
+
/**
|
|
3495
|
+
* Output only. Timestamp the Recommendation Engine was created at.
|
|
3131
3496
|
*/
|
|
3132
3497
|
createTime?: string | null;
|
|
3133
3498
|
/**
|
|
3134
|
-
*
|
|
3499
|
+
* 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.
|
|
3500
|
+
*/
|
|
3501
|
+
dataStoreIds?: string[] | null;
|
|
3502
|
+
/**
|
|
3503
|
+
* Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
|
|
3504
|
+
*/
|
|
3505
|
+
displayName?: string | null;
|
|
3506
|
+
/**
|
|
3507
|
+
* 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.
|
|
3508
|
+
*/
|
|
3509
|
+
industryVertical?: string | null;
|
|
3510
|
+
/**
|
|
3511
|
+
* 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.
|
|
3512
|
+
*/
|
|
3513
|
+
name?: string | null;
|
|
3514
|
+
/**
|
|
3515
|
+
* Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
|
|
3516
|
+
*/
|
|
3517
|
+
searchEngineConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig;
|
|
3518
|
+
/**
|
|
3519
|
+
* Required. The solutions of the engine.
|
|
3520
|
+
*/
|
|
3521
|
+
solutionType?: string | null;
|
|
3522
|
+
/**
|
|
3523
|
+
* Output only. Timestamp the Recommendation Engine was last updated.
|
|
3135
3524
|
*/
|
|
3136
3525
|
updateTime?: string | null;
|
|
3137
3526
|
}
|
|
3527
|
+
/**
|
|
3528
|
+
* Configurations for a Chat Engine.
|
|
3529
|
+
*/
|
|
3530
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig {
|
|
3531
|
+
/**
|
|
3532
|
+
* 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.
|
|
3533
|
+
*/
|
|
3534
|
+
agentCreationConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig;
|
|
3535
|
+
/**
|
|
3536
|
+
* 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.
|
|
3537
|
+
*/
|
|
3538
|
+
dialogflowAgentToLink?: string | null;
|
|
3539
|
+
}
|
|
3540
|
+
/**
|
|
3541
|
+
* 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.
|
|
3542
|
+
*/
|
|
3543
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig {
|
|
3544
|
+
/**
|
|
3545
|
+
* Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.
|
|
3546
|
+
*/
|
|
3547
|
+
business?: string | null;
|
|
3548
|
+
/**
|
|
3549
|
+
* 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.
|
|
3550
|
+
*/
|
|
3551
|
+
defaultLanguageCode?: string | null;
|
|
3552
|
+
/**
|
|
3553
|
+
* 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.
|
|
3554
|
+
*/
|
|
3555
|
+
location?: string | null;
|
|
3556
|
+
/**
|
|
3557
|
+
* 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.
|
|
3558
|
+
*/
|
|
3559
|
+
timeZone?: string | null;
|
|
3560
|
+
}
|
|
3561
|
+
/**
|
|
3562
|
+
* Additional information of a Chat Engine. Fields in this message are output only.
|
|
3563
|
+
*/
|
|
3564
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata {
|
|
3565
|
+
/**
|
|
3566
|
+
* The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.
|
|
3567
|
+
*/
|
|
3568
|
+
dialogflowAgent?: string | null;
|
|
3569
|
+
}
|
|
3570
|
+
/**
|
|
3571
|
+
* Common configurations for an Engine.
|
|
3572
|
+
*/
|
|
3573
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaEngineCommonConfig {
|
|
3574
|
+
/**
|
|
3575
|
+
* Immutable. The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.
|
|
3576
|
+
*/
|
|
3577
|
+
companyName?: string | null;
|
|
3578
|
+
}
|
|
3579
|
+
/**
|
|
3580
|
+
* Configurations for a Search Engine.
|
|
3581
|
+
*/
|
|
3582
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig {
|
|
3583
|
+
/**
|
|
3584
|
+
* The add-on that this search engine enables.
|
|
3585
|
+
*/
|
|
3586
|
+
searchAddOns?: string[] | null;
|
|
3587
|
+
/**
|
|
3588
|
+
* 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.
|
|
3589
|
+
*/
|
|
3590
|
+
searchTier?: string | null;
|
|
3591
|
+
}
|
|
3138
3592
|
/**
|
|
3139
3593
|
* Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
3140
3594
|
*/
|
|
3141
|
-
export interface Schema$
|
|
3595
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata {
|
|
3142
3596
|
/**
|
|
3143
3597
|
* Operation create time.
|
|
3144
3598
|
*/
|
|
@@ -3159,11 +3613,11 @@ export namespace discoveryengine_v1alpha {
|
|
|
3159
3613
|
/**
|
|
3160
3614
|
* 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.
|
|
3161
3615
|
*/
|
|
3162
|
-
export interface Schema$
|
|
3616
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaImportDocumentsResponse {
|
|
3163
3617
|
/**
|
|
3164
3618
|
* Echoes the destination for the complete errors in the request if set.
|
|
3165
3619
|
*/
|
|
3166
|
-
errorConfig?: Schema$
|
|
3620
|
+
errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig;
|
|
3167
3621
|
/**
|
|
3168
3622
|
* A sample of errors encountered while processing the request.
|
|
3169
3623
|
*/
|
|
@@ -3172,16 +3626,46 @@ export namespace discoveryengine_v1alpha {
|
|
|
3172
3626
|
/**
|
|
3173
3627
|
* Configuration of destination for Import related errors.
|
|
3174
3628
|
*/
|
|
3175
|
-
export interface Schema$
|
|
3629
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig {
|
|
3176
3630
|
/**
|
|
3177
3631
|
* 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
3632
|
*/
|
|
3179
3633
|
gcsPrefix?: string | null;
|
|
3180
3634
|
}
|
|
3635
|
+
/**
|
|
3636
|
+
* Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
3637
|
+
*/
|
|
3638
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata {
|
|
3639
|
+
/**
|
|
3640
|
+
* Operation create time.
|
|
3641
|
+
*/
|
|
3642
|
+
createTime?: string | null;
|
|
3643
|
+
/**
|
|
3644
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3645
|
+
*/
|
|
3646
|
+
updateTime?: string | null;
|
|
3647
|
+
}
|
|
3648
|
+
/**
|
|
3649
|
+
* Response message for CompletionService.ImportSuggestionDenyListEntries method.
|
|
3650
|
+
*/
|
|
3651
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesResponse {
|
|
3652
|
+
/**
|
|
3653
|
+
* A sample of errors encountered while processing the request.
|
|
3654
|
+
*/
|
|
3655
|
+
errorSamples?: Schema$GoogleRpcStatus[];
|
|
3656
|
+
/**
|
|
3657
|
+
* Count of deny list entries that failed to be imported.
|
|
3658
|
+
*/
|
|
3659
|
+
failedEntriesCount?: string | null;
|
|
3660
|
+
/**
|
|
3661
|
+
* Count of deny list entries successfully imported.
|
|
3662
|
+
*/
|
|
3663
|
+
importedEntriesCount?: string | null;
|
|
3664
|
+
}
|
|
3181
3665
|
/**
|
|
3182
3666
|
* Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
3183
3667
|
*/
|
|
3184
|
-
export interface Schema$
|
|
3668
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata {
|
|
3185
3669
|
/**
|
|
3186
3670
|
* Operation create time.
|
|
3187
3671
|
*/
|
|
@@ -3202,11 +3686,11 @@ export namespace discoveryengine_v1alpha {
|
|
|
3202
3686
|
/**
|
|
3203
3687
|
* 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.
|
|
3204
3688
|
*/
|
|
3205
|
-
export interface Schema$
|
|
3689
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaImportUserEventsResponse {
|
|
3206
3690
|
/**
|
|
3207
3691
|
* Echoes the destination for the complete errors if this field was set in the request.
|
|
3208
3692
|
*/
|
|
3209
|
-
errorConfig?: Schema$
|
|
3693
|
+
errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig;
|
|
3210
3694
|
/**
|
|
3211
3695
|
* A sample of errors encountered while processing the request.
|
|
3212
3696
|
*/
|
|
@@ -3223,58 +3707,738 @@ export namespace discoveryengine_v1alpha {
|
|
|
3223
3707
|
/**
|
|
3224
3708
|
* Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3225
3709
|
*/
|
|
3226
|
-
export interface Schema$
|
|
3710
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata {
|
|
3711
|
+
/**
|
|
3712
|
+
* Operation create time.
|
|
3713
|
+
*/
|
|
3714
|
+
createTime?: string | null;
|
|
3715
|
+
/**
|
|
3716
|
+
* Count of entries that encountered errors while processing.
|
|
3717
|
+
*/
|
|
3718
|
+
failureCount?: string | null;
|
|
3719
|
+
/**
|
|
3720
|
+
* Count of entries that were deleted successfully.
|
|
3721
|
+
*/
|
|
3722
|
+
successCount?: string | null;
|
|
3723
|
+
/**
|
|
3724
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3725
|
+
*/
|
|
3726
|
+
updateTime?: string | null;
|
|
3727
|
+
}
|
|
3728
|
+
/**
|
|
3729
|
+
* 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.
|
|
3730
|
+
*/
|
|
3731
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse {
|
|
3732
|
+
/**
|
|
3733
|
+
* The total count of documents purged as a result of the operation.
|
|
3734
|
+
*/
|
|
3735
|
+
purgeCount?: string | null;
|
|
3736
|
+
/**
|
|
3737
|
+
* 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.
|
|
3738
|
+
*/
|
|
3739
|
+
purgeSample?: string[] | null;
|
|
3740
|
+
}
|
|
3741
|
+
/**
|
|
3742
|
+
* Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
3743
|
+
*/
|
|
3744
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata {
|
|
3745
|
+
/**
|
|
3746
|
+
* Operation create time.
|
|
3747
|
+
*/
|
|
3748
|
+
createTime?: string | null;
|
|
3749
|
+
/**
|
|
3750
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3751
|
+
*/
|
|
3752
|
+
updateTime?: string | null;
|
|
3753
|
+
}
|
|
3754
|
+
/**
|
|
3755
|
+
* Response message for CompletionService.PurgeSuggestionDenyListEntries method.
|
|
3756
|
+
*/
|
|
3757
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse {
|
|
3758
|
+
/**
|
|
3759
|
+
* A sample of errors encountered while processing the request.
|
|
3760
|
+
*/
|
|
3761
|
+
errorSamples?: Schema$GoogleRpcStatus[];
|
|
3762
|
+
/**
|
|
3763
|
+
* Number of suggestion deny list entries purged.
|
|
3764
|
+
*/
|
|
3765
|
+
purgeCount?: string | null;
|
|
3766
|
+
}
|
|
3767
|
+
/**
|
|
3768
|
+
* Defines the structure and layout of a type of document data.
|
|
3769
|
+
*/
|
|
3770
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaSchema {
|
|
3771
|
+
/**
|
|
3772
|
+
* The JSON representation of the schema.
|
|
3773
|
+
*/
|
|
3774
|
+
jsonSchema?: string | null;
|
|
3775
|
+
/**
|
|
3776
|
+
* 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.
|
|
3777
|
+
*/
|
|
3778
|
+
name?: string | null;
|
|
3779
|
+
/**
|
|
3780
|
+
* The structured representation of the schema.
|
|
3781
|
+
*/
|
|
3782
|
+
structSchema?: {[key: string]: any} | null;
|
|
3783
|
+
}
|
|
3784
|
+
/**
|
|
3785
|
+
* Verification information for target sites in advanced site search.
|
|
3786
|
+
*/
|
|
3787
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaSiteVerificationInfo {
|
|
3788
|
+
/**
|
|
3789
|
+
* Site verification state indicating the ownership and validity.
|
|
3790
|
+
*/
|
|
3791
|
+
siteVerificationState?: string | null;
|
|
3792
|
+
/**
|
|
3793
|
+
* Latest site verification time.
|
|
3794
|
+
*/
|
|
3795
|
+
verifyTime?: string | null;
|
|
3796
|
+
}
|
|
3797
|
+
/**
|
|
3798
|
+
* A target site for the SiteSearchEngine.
|
|
3799
|
+
*/
|
|
3800
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaTargetSite {
|
|
3801
|
+
/**
|
|
3802
|
+
* 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.
|
|
3803
|
+
*/
|
|
3804
|
+
exactMatch?: boolean | null;
|
|
3805
|
+
/**
|
|
3806
|
+
* Output only. Failure reason.
|
|
3807
|
+
*/
|
|
3808
|
+
failureReason?: Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReason;
|
|
3809
|
+
/**
|
|
3810
|
+
* Output only. This is system-generated based on the provided_uri_pattern.
|
|
3811
|
+
*/
|
|
3812
|
+
generatedUriPattern?: string | null;
|
|
3813
|
+
/**
|
|
3814
|
+
* Output only. Indexing status.
|
|
3815
|
+
*/
|
|
3816
|
+
indexingStatus?: string | null;
|
|
3817
|
+
/**
|
|
3818
|
+
* 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.
|
|
3819
|
+
*/
|
|
3820
|
+
name?: string | null;
|
|
3821
|
+
/**
|
|
3822
|
+
* Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated.
|
|
3823
|
+
*/
|
|
3824
|
+
providedUriPattern?: string | null;
|
|
3825
|
+
/**
|
|
3826
|
+
* Output only. Site ownership and validity verification status.
|
|
3827
|
+
*/
|
|
3828
|
+
siteVerificationInfo?: Schema$GoogleCloudDiscoveryengineV1betaSiteVerificationInfo;
|
|
3829
|
+
/**
|
|
3830
|
+
* The type of the target site, e.g., whether the site is to be included or excluded.
|
|
3831
|
+
*/
|
|
3832
|
+
type?: string | null;
|
|
3833
|
+
/**
|
|
3834
|
+
* Output only. The target site's last updated time.
|
|
3835
|
+
*/
|
|
3836
|
+
updateTime?: string | null;
|
|
3837
|
+
}
|
|
3838
|
+
/**
|
|
3839
|
+
* Site search indexing failure reasons.
|
|
3840
|
+
*/
|
|
3841
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReason {
|
|
3842
|
+
/**
|
|
3843
|
+
* Failed due to insufficient quota.
|
|
3844
|
+
*/
|
|
3845
|
+
quotaFailure?: Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure;
|
|
3846
|
+
}
|
|
3847
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure {
|
|
3848
|
+
/**
|
|
3849
|
+
* This number is an estimation on how much total quota this project needs to successfully complete indexing.
|
|
3850
|
+
*/
|
|
3851
|
+
totalRequiredQuota?: string | null;
|
|
3852
|
+
}
|
|
3853
|
+
/**
|
|
3854
|
+
* Metadata for UpdateSchema LRO.
|
|
3855
|
+
*/
|
|
3856
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaUpdateSchemaMetadata {
|
|
3857
|
+
/**
|
|
3858
|
+
* Operation create time.
|
|
3859
|
+
*/
|
|
3860
|
+
createTime?: string | null;
|
|
3861
|
+
/**
|
|
3862
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3863
|
+
*/
|
|
3864
|
+
updateTime?: string | null;
|
|
3865
|
+
}
|
|
3866
|
+
/**
|
|
3867
|
+
* Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3868
|
+
*/
|
|
3869
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaUpdateTargetSiteMetadata {
|
|
3870
|
+
/**
|
|
3871
|
+
* Operation create time.
|
|
3872
|
+
*/
|
|
3873
|
+
createTime?: string | null;
|
|
3874
|
+
/**
|
|
3875
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3876
|
+
*/
|
|
3877
|
+
updateTime?: string | null;
|
|
3878
|
+
}
|
|
3879
|
+
/**
|
|
3880
|
+
* Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3881
|
+
*/
|
|
3882
|
+
export interface Schema$GoogleCloudDiscoveryengineV1CreateDataStoreMetadata {
|
|
3883
|
+
/**
|
|
3884
|
+
* Operation create time.
|
|
3885
|
+
*/
|
|
3886
|
+
createTime?: string | null;
|
|
3887
|
+
/**
|
|
3888
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3889
|
+
*/
|
|
3890
|
+
updateTime?: string | null;
|
|
3891
|
+
}
|
|
3892
|
+
/**
|
|
3893
|
+
* Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3894
|
+
*/
|
|
3895
|
+
export interface Schema$GoogleCloudDiscoveryengineV1CreateEngineMetadata {
|
|
3896
|
+
/**
|
|
3897
|
+
* Operation create time.
|
|
3898
|
+
*/
|
|
3899
|
+
createTime?: string | null;
|
|
3900
|
+
/**
|
|
3901
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3902
|
+
*/
|
|
3903
|
+
updateTime?: string | null;
|
|
3904
|
+
}
|
|
3905
|
+
/**
|
|
3906
|
+
* Metadata for Create Schema LRO.
|
|
3907
|
+
*/
|
|
3908
|
+
export interface Schema$GoogleCloudDiscoveryengineV1CreateSchemaMetadata {
|
|
3909
|
+
/**
|
|
3910
|
+
* Operation create time.
|
|
3911
|
+
*/
|
|
3912
|
+
createTime?: string | null;
|
|
3913
|
+
/**
|
|
3914
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3915
|
+
*/
|
|
3916
|
+
updateTime?: string | null;
|
|
3917
|
+
}
|
|
3918
|
+
/**
|
|
3919
|
+
* Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3920
|
+
*/
|
|
3921
|
+
export interface Schema$GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata {
|
|
3922
|
+
/**
|
|
3923
|
+
* Operation create time.
|
|
3924
|
+
*/
|
|
3925
|
+
createTime?: string | null;
|
|
3926
|
+
/**
|
|
3927
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3928
|
+
*/
|
|
3929
|
+
updateTime?: string | null;
|
|
3930
|
+
}
|
|
3931
|
+
/**
|
|
3932
|
+
* DataStore captures global settings and configs at the DataStore level.
|
|
3933
|
+
*/
|
|
3934
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DataStore {
|
|
3935
|
+
/**
|
|
3936
|
+
* Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
|
|
3937
|
+
*/
|
|
3938
|
+
contentConfig?: string | null;
|
|
3939
|
+
/**
|
|
3940
|
+
* Output only. Timestamp the DataStore was created at.
|
|
3941
|
+
*/
|
|
3942
|
+
createTime?: string | null;
|
|
3943
|
+
/**
|
|
3944
|
+
* Output only. The id of the default Schema asscociated to this data store.
|
|
3945
|
+
*/
|
|
3946
|
+
defaultSchemaId?: string | null;
|
|
3947
|
+
/**
|
|
3948
|
+
* 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.
|
|
3949
|
+
*/
|
|
3950
|
+
displayName?: string | null;
|
|
3951
|
+
/**
|
|
3952
|
+
* Immutable. The industry vertical that the data store registers.
|
|
3953
|
+
*/
|
|
3954
|
+
industryVertical?: string | null;
|
|
3955
|
+
/**
|
|
3956
|
+
* 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.
|
|
3957
|
+
*/
|
|
3958
|
+
name?: string | null;
|
|
3959
|
+
/**
|
|
3960
|
+
* 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.
|
|
3961
|
+
*/
|
|
3962
|
+
solutionTypes?: string[] | null;
|
|
3963
|
+
}
|
|
3964
|
+
/**
|
|
3965
|
+
* Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3966
|
+
*/
|
|
3967
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata {
|
|
3968
|
+
/**
|
|
3969
|
+
* Operation create time.
|
|
3970
|
+
*/
|
|
3971
|
+
createTime?: string | null;
|
|
3972
|
+
/**
|
|
3973
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3974
|
+
*/
|
|
3975
|
+
updateTime?: string | null;
|
|
3976
|
+
}
|
|
3977
|
+
/**
|
|
3978
|
+
* Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3979
|
+
*/
|
|
3980
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DeleteEngineMetadata {
|
|
3981
|
+
/**
|
|
3982
|
+
* Operation create time.
|
|
3983
|
+
*/
|
|
3984
|
+
createTime?: string | null;
|
|
3985
|
+
/**
|
|
3986
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3987
|
+
*/
|
|
3988
|
+
updateTime?: string | null;
|
|
3989
|
+
}
|
|
3990
|
+
/**
|
|
3991
|
+
* Metadata for DeleteSchema LRO.
|
|
3992
|
+
*/
|
|
3993
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DeleteSchemaMetadata {
|
|
3994
|
+
/**
|
|
3995
|
+
* Operation create time.
|
|
3996
|
+
*/
|
|
3997
|
+
createTime?: string | null;
|
|
3998
|
+
/**
|
|
3999
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
4000
|
+
*/
|
|
4001
|
+
updateTime?: string | null;
|
|
4002
|
+
}
|
|
4003
|
+
/**
|
|
4004
|
+
* Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
4005
|
+
*/
|
|
4006
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata {
|
|
4007
|
+
/**
|
|
4008
|
+
* Operation create time.
|
|
4009
|
+
*/
|
|
4010
|
+
createTime?: string | null;
|
|
4011
|
+
/**
|
|
4012
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
4013
|
+
*/
|
|
4014
|
+
updateTime?: string | null;
|
|
4015
|
+
}
|
|
4016
|
+
/**
|
|
4017
|
+
* Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
4018
|
+
*/
|
|
4019
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata {
|
|
4020
|
+
/**
|
|
4021
|
+
* Operation create time.
|
|
4022
|
+
*/
|
|
4023
|
+
createTime?: string | null;
|
|
4024
|
+
/**
|
|
4025
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
4026
|
+
*/
|
|
4027
|
+
updateTime?: string | null;
|
|
4028
|
+
}
|
|
4029
|
+
/**
|
|
4030
|
+
* Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.
|
|
4031
|
+
*/
|
|
4032
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse {}
|
|
4033
|
+
/**
|
|
4034
|
+
* Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
4035
|
+
*/
|
|
4036
|
+
export interface Schema$GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata {
|
|
4037
|
+
/**
|
|
4038
|
+
* Operation create time.
|
|
4039
|
+
*/
|
|
4040
|
+
createTime?: string | null;
|
|
4041
|
+
/**
|
|
4042
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
4043
|
+
*/
|
|
4044
|
+
updateTime?: string | null;
|
|
4045
|
+
}
|
|
4046
|
+
/**
|
|
4047
|
+
* Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.
|
|
4048
|
+
*/
|
|
4049
|
+
export interface Schema$GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchResponse {}
|
|
4050
|
+
/**
|
|
4051
|
+
* Metadata that describes the training and serving parameters of an Engine.
|
|
4052
|
+
*/
|
|
4053
|
+
export interface Schema$GoogleCloudDiscoveryengineV1Engine {
|
|
4054
|
+
/**
|
|
4055
|
+
* Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
|
|
4056
|
+
*/
|
|
4057
|
+
chatEngineConfig?: Schema$GoogleCloudDiscoveryengineV1EngineChatEngineConfig;
|
|
4058
|
+
/**
|
|
4059
|
+
* Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
|
|
4060
|
+
*/
|
|
4061
|
+
chatEngineMetadata?: Schema$GoogleCloudDiscoveryengineV1EngineChatEngineMetadata;
|
|
4062
|
+
/**
|
|
4063
|
+
* Common config spec that specifies the metadata of the engine.
|
|
4064
|
+
*/
|
|
4065
|
+
commonConfig?: Schema$GoogleCloudDiscoveryengineV1EngineCommonConfig;
|
|
4066
|
+
/**
|
|
4067
|
+
* Output only. Timestamp the Recommendation Engine was created at.
|
|
4068
|
+
*/
|
|
4069
|
+
createTime?: string | null;
|
|
4070
|
+
/**
|
|
4071
|
+
* 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.
|
|
4072
|
+
*/
|
|
4073
|
+
dataStoreIds?: string[] | null;
|
|
4074
|
+
/**
|
|
4075
|
+
* Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
|
|
4076
|
+
*/
|
|
4077
|
+
displayName?: string | null;
|
|
4078
|
+
/**
|
|
4079
|
+
* 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.
|
|
4080
|
+
*/
|
|
4081
|
+
industryVertical?: string | null;
|
|
4082
|
+
/**
|
|
4083
|
+
* 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.
|
|
4084
|
+
*/
|
|
4085
|
+
name?: string | null;
|
|
4086
|
+
/**
|
|
4087
|
+
* Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
|
|
4088
|
+
*/
|
|
4089
|
+
searchEngineConfig?: Schema$GoogleCloudDiscoveryengineV1EngineSearchEngineConfig;
|
|
4090
|
+
/**
|
|
4091
|
+
* Required. The solutions of the engine.
|
|
4092
|
+
*/
|
|
4093
|
+
solutionType?: string | null;
|
|
4094
|
+
/**
|
|
4095
|
+
* Output only. Timestamp the Recommendation Engine was last updated.
|
|
4096
|
+
*/
|
|
4097
|
+
updateTime?: string | null;
|
|
4098
|
+
}
|
|
4099
|
+
/**
|
|
4100
|
+
* Configurations for a Chat Engine.
|
|
4101
|
+
*/
|
|
4102
|
+
export interface Schema$GoogleCloudDiscoveryengineV1EngineChatEngineConfig {
|
|
4103
|
+
/**
|
|
4104
|
+
* 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.
|
|
4105
|
+
*/
|
|
4106
|
+
agentCreationConfig?: Schema$GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig;
|
|
4107
|
+
/**
|
|
4108
|
+
* 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.
|
|
4109
|
+
*/
|
|
4110
|
+
dialogflowAgentToLink?: string | null;
|
|
4111
|
+
}
|
|
4112
|
+
/**
|
|
4113
|
+
* 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.
|
|
4114
|
+
*/
|
|
4115
|
+
export interface Schema$GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig {
|
|
4116
|
+
/**
|
|
4117
|
+
* Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.
|
|
4118
|
+
*/
|
|
4119
|
+
business?: string | null;
|
|
4120
|
+
/**
|
|
4121
|
+
* 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.
|
|
4122
|
+
*/
|
|
4123
|
+
defaultLanguageCode?: string | null;
|
|
4124
|
+
/**
|
|
4125
|
+
* 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.
|
|
4126
|
+
*/
|
|
4127
|
+
location?: string | null;
|
|
4128
|
+
/**
|
|
4129
|
+
* 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.
|
|
4130
|
+
*/
|
|
4131
|
+
timeZone?: string | null;
|
|
4132
|
+
}
|
|
4133
|
+
/**
|
|
4134
|
+
* Additional information of a Chat Engine. Fields in this message are output only.
|
|
4135
|
+
*/
|
|
4136
|
+
export interface Schema$GoogleCloudDiscoveryengineV1EngineChatEngineMetadata {
|
|
4137
|
+
/**
|
|
4138
|
+
* The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.
|
|
4139
|
+
*/
|
|
4140
|
+
dialogflowAgent?: string | null;
|
|
4141
|
+
}
|
|
4142
|
+
/**
|
|
4143
|
+
* Common configurations for an Engine.
|
|
4144
|
+
*/
|
|
4145
|
+
export interface Schema$GoogleCloudDiscoveryengineV1EngineCommonConfig {
|
|
4146
|
+
/**
|
|
4147
|
+
* Immutable. The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.
|
|
4148
|
+
*/
|
|
4149
|
+
companyName?: string | null;
|
|
4150
|
+
}
|
|
4151
|
+
/**
|
|
4152
|
+
* Configurations for a Search Engine.
|
|
4153
|
+
*/
|
|
4154
|
+
export interface Schema$GoogleCloudDiscoveryengineV1EngineSearchEngineConfig {
|
|
4155
|
+
/**
|
|
4156
|
+
* The add-on that this search engine enables.
|
|
4157
|
+
*/
|
|
4158
|
+
searchAddOns?: string[] | null;
|
|
4159
|
+
/**
|
|
4160
|
+
* 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.
|
|
4161
|
+
*/
|
|
4162
|
+
searchTier?: string | null;
|
|
4163
|
+
}
|
|
4164
|
+
/**
|
|
4165
|
+
* Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
4166
|
+
*/
|
|
4167
|
+
export interface Schema$GoogleCloudDiscoveryengineV1ImportDocumentsMetadata {
|
|
4168
|
+
/**
|
|
4169
|
+
* Operation create time.
|
|
4170
|
+
*/
|
|
4171
|
+
createTime?: string | null;
|
|
4172
|
+
/**
|
|
4173
|
+
* Count of entries that encountered errors while processing.
|
|
4174
|
+
*/
|
|
4175
|
+
failureCount?: string | null;
|
|
4176
|
+
/**
|
|
4177
|
+
* Count of entries that were processed successfully.
|
|
4178
|
+
*/
|
|
4179
|
+
successCount?: string | null;
|
|
4180
|
+
/**
|
|
4181
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
4182
|
+
*/
|
|
4183
|
+
updateTime?: string | null;
|
|
4184
|
+
}
|
|
4185
|
+
/**
|
|
4186
|
+
* 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.
|
|
4187
|
+
*/
|
|
4188
|
+
export interface Schema$GoogleCloudDiscoveryengineV1ImportDocumentsResponse {
|
|
4189
|
+
/**
|
|
4190
|
+
* Echoes the destination for the complete errors in the request if set.
|
|
4191
|
+
*/
|
|
4192
|
+
errorConfig?: Schema$GoogleCloudDiscoveryengineV1ImportErrorConfig;
|
|
4193
|
+
/**
|
|
4194
|
+
* A sample of errors encountered while processing the request.
|
|
4195
|
+
*/
|
|
4196
|
+
errorSamples?: Schema$GoogleRpcStatus[];
|
|
4197
|
+
}
|
|
4198
|
+
/**
|
|
4199
|
+
* Configuration of destination for Import related errors.
|
|
4200
|
+
*/
|
|
4201
|
+
export interface Schema$GoogleCloudDiscoveryengineV1ImportErrorConfig {
|
|
4202
|
+
/**
|
|
4203
|
+
* 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.
|
|
4204
|
+
*/
|
|
4205
|
+
gcsPrefix?: string | null;
|
|
4206
|
+
}
|
|
4207
|
+
/**
|
|
4208
|
+
* Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
4209
|
+
*/
|
|
4210
|
+
export interface Schema$GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesMetadata {
|
|
4211
|
+
/**
|
|
4212
|
+
* Operation create time.
|
|
4213
|
+
*/
|
|
4214
|
+
createTime?: string | null;
|
|
4215
|
+
/**
|
|
4216
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
4217
|
+
*/
|
|
4218
|
+
updateTime?: string | null;
|
|
4219
|
+
}
|
|
4220
|
+
/**
|
|
4221
|
+
* Response message for CompletionService.ImportSuggestionDenyListEntries method.
|
|
4222
|
+
*/
|
|
4223
|
+
export interface Schema$GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesResponse {
|
|
4224
|
+
/**
|
|
4225
|
+
* A sample of errors encountered while processing the request.
|
|
4226
|
+
*/
|
|
4227
|
+
errorSamples?: Schema$GoogleRpcStatus[];
|
|
4228
|
+
/**
|
|
4229
|
+
* Count of deny list entries that failed to be imported.
|
|
4230
|
+
*/
|
|
4231
|
+
failedEntriesCount?: string | null;
|
|
4232
|
+
/**
|
|
4233
|
+
* Count of deny list entries successfully imported.
|
|
4234
|
+
*/
|
|
4235
|
+
importedEntriesCount?: string | null;
|
|
4236
|
+
}
|
|
4237
|
+
/**
|
|
4238
|
+
* Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
4239
|
+
*/
|
|
4240
|
+
export interface Schema$GoogleCloudDiscoveryengineV1ImportUserEventsMetadata {
|
|
4241
|
+
/**
|
|
4242
|
+
* Operation create time.
|
|
4243
|
+
*/
|
|
4244
|
+
createTime?: string | null;
|
|
4245
|
+
/**
|
|
4246
|
+
* Count of entries that encountered errors while processing.
|
|
4247
|
+
*/
|
|
4248
|
+
failureCount?: string | null;
|
|
4249
|
+
/**
|
|
4250
|
+
* Count of entries that were processed successfully.
|
|
4251
|
+
*/
|
|
4252
|
+
successCount?: string | null;
|
|
4253
|
+
/**
|
|
4254
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
4255
|
+
*/
|
|
4256
|
+
updateTime?: string | null;
|
|
4257
|
+
}
|
|
4258
|
+
/**
|
|
4259
|
+
* 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.
|
|
4260
|
+
*/
|
|
4261
|
+
export interface Schema$GoogleCloudDiscoveryengineV1ImportUserEventsResponse {
|
|
4262
|
+
/**
|
|
4263
|
+
* Echoes the destination for the complete errors if this field was set in the request.
|
|
4264
|
+
*/
|
|
4265
|
+
errorConfig?: Schema$GoogleCloudDiscoveryengineV1ImportErrorConfig;
|
|
4266
|
+
/**
|
|
4267
|
+
* A sample of errors encountered while processing the request.
|
|
4268
|
+
*/
|
|
4269
|
+
errorSamples?: Schema$GoogleRpcStatus[];
|
|
4270
|
+
/**
|
|
4271
|
+
* Count of user events imported with complete existing Documents.
|
|
4272
|
+
*/
|
|
4273
|
+
joinedEventsCount?: string | null;
|
|
4274
|
+
/**
|
|
4275
|
+
* Count of user events imported, but with Document information not found in the existing Branch.
|
|
4276
|
+
*/
|
|
4277
|
+
unjoinedEventsCount?: string | null;
|
|
4278
|
+
}
|
|
4279
|
+
/**
|
|
4280
|
+
* Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
4281
|
+
*/
|
|
4282
|
+
export interface Schema$GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata {
|
|
4283
|
+
/**
|
|
4284
|
+
* Operation create time.
|
|
4285
|
+
*/
|
|
4286
|
+
createTime?: string | null;
|
|
4287
|
+
/**
|
|
4288
|
+
* Count of entries that encountered errors while processing.
|
|
4289
|
+
*/
|
|
4290
|
+
failureCount?: string | null;
|
|
4291
|
+
/**
|
|
4292
|
+
* Count of entries that were deleted successfully.
|
|
4293
|
+
*/
|
|
4294
|
+
successCount?: string | null;
|
|
4295
|
+
/**
|
|
4296
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
4297
|
+
*/
|
|
4298
|
+
updateTime?: string | null;
|
|
4299
|
+
}
|
|
4300
|
+
/**
|
|
4301
|
+
* 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.
|
|
4302
|
+
*/
|
|
4303
|
+
export interface Schema$GoogleCloudDiscoveryengineV1PurgeDocumentsResponse {
|
|
4304
|
+
/**
|
|
4305
|
+
* The total count of documents purged as a result of the operation.
|
|
4306
|
+
*/
|
|
4307
|
+
purgeCount?: string | null;
|
|
4308
|
+
/**
|
|
4309
|
+
* 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.
|
|
4310
|
+
*/
|
|
4311
|
+
purgeSample?: string[] | null;
|
|
4312
|
+
}
|
|
4313
|
+
/**
|
|
4314
|
+
* Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
4315
|
+
*/
|
|
4316
|
+
export interface Schema$GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata {
|
|
4317
|
+
/**
|
|
4318
|
+
* Operation create time.
|
|
4319
|
+
*/
|
|
4320
|
+
createTime?: string | null;
|
|
4321
|
+
/**
|
|
4322
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
4323
|
+
*/
|
|
4324
|
+
updateTime?: string | null;
|
|
4325
|
+
}
|
|
4326
|
+
/**
|
|
4327
|
+
* Response message for CompletionService.PurgeSuggestionDenyListEntries method.
|
|
4328
|
+
*/
|
|
4329
|
+
export interface Schema$GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesResponse {
|
|
4330
|
+
/**
|
|
4331
|
+
* A sample of errors encountered while processing the request.
|
|
4332
|
+
*/
|
|
4333
|
+
errorSamples?: Schema$GoogleRpcStatus[];
|
|
4334
|
+
/**
|
|
4335
|
+
* Number of suggestion deny list entries purged.
|
|
4336
|
+
*/
|
|
4337
|
+
purgeCount?: string | null;
|
|
4338
|
+
}
|
|
4339
|
+
/**
|
|
4340
|
+
* Defines the structure and layout of a type of document data.
|
|
4341
|
+
*/
|
|
4342
|
+
export interface Schema$GoogleCloudDiscoveryengineV1Schema {
|
|
4343
|
+
/**
|
|
4344
|
+
* The JSON representation of the schema.
|
|
4345
|
+
*/
|
|
4346
|
+
jsonSchema?: string | null;
|
|
4347
|
+
/**
|
|
4348
|
+
* 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.
|
|
4349
|
+
*/
|
|
4350
|
+
name?: string | null;
|
|
4351
|
+
/**
|
|
4352
|
+
* The structured representation of the schema.
|
|
4353
|
+
*/
|
|
4354
|
+
structSchema?: {[key: string]: any} | null;
|
|
4355
|
+
}
|
|
4356
|
+
/**
|
|
4357
|
+
* Verification information for target sites in advanced site search.
|
|
4358
|
+
*/
|
|
4359
|
+
export interface Schema$GoogleCloudDiscoveryengineV1SiteVerificationInfo {
|
|
4360
|
+
/**
|
|
4361
|
+
* Site verification state indicating the ownership and validity.
|
|
4362
|
+
*/
|
|
4363
|
+
siteVerificationState?: string | null;
|
|
4364
|
+
/**
|
|
4365
|
+
* Latest site verification time.
|
|
4366
|
+
*/
|
|
4367
|
+
verifyTime?: string | null;
|
|
4368
|
+
}
|
|
4369
|
+
/**
|
|
4370
|
+
* A target site for the SiteSearchEngine.
|
|
4371
|
+
*/
|
|
4372
|
+
export interface Schema$GoogleCloudDiscoveryengineV1TargetSite {
|
|
4373
|
+
/**
|
|
4374
|
+
* 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.
|
|
4375
|
+
*/
|
|
4376
|
+
exactMatch?: boolean | null;
|
|
4377
|
+
/**
|
|
4378
|
+
* Output only. Failure reason.
|
|
4379
|
+
*/
|
|
4380
|
+
failureReason?: Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReason;
|
|
4381
|
+
/**
|
|
4382
|
+
* Output only. This is system-generated based on the provided_uri_pattern.
|
|
4383
|
+
*/
|
|
4384
|
+
generatedUriPattern?: string | null;
|
|
4385
|
+
/**
|
|
4386
|
+
* Output only. Indexing status.
|
|
4387
|
+
*/
|
|
4388
|
+
indexingStatus?: string | null;
|
|
3227
4389
|
/**
|
|
3228
|
-
*
|
|
4390
|
+
* 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
4391
|
*/
|
|
3230
|
-
|
|
4392
|
+
name?: string | null;
|
|
3231
4393
|
/**
|
|
3232
|
-
*
|
|
4394
|
+
* Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated.
|
|
3233
4395
|
*/
|
|
3234
|
-
|
|
4396
|
+
providedUriPattern?: string | null;
|
|
3235
4397
|
/**
|
|
3236
|
-
*
|
|
4398
|
+
* Output only. Site ownership and validity verification status.
|
|
3237
4399
|
*/
|
|
3238
|
-
|
|
4400
|
+
siteVerificationInfo?: Schema$GoogleCloudDiscoveryengineV1SiteVerificationInfo;
|
|
3239
4401
|
/**
|
|
3240
|
-
*
|
|
4402
|
+
* The type of the target site, e.g., whether the site is to be included or excluded.
|
|
4403
|
+
*/
|
|
4404
|
+
type?: string | null;
|
|
4405
|
+
/**
|
|
4406
|
+
* Output only. The target site's last updated time.
|
|
3241
4407
|
*/
|
|
3242
4408
|
updateTime?: string | null;
|
|
3243
4409
|
}
|
|
3244
4410
|
/**
|
|
3245
|
-
*
|
|
4411
|
+
* Site search indexing failure reasons.
|
|
3246
4412
|
*/
|
|
3247
|
-
export interface Schema$
|
|
4413
|
+
export interface Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReason {
|
|
3248
4414
|
/**
|
|
3249
|
-
*
|
|
4415
|
+
* Failed due to insufficient quota.
|
|
3250
4416
|
*/
|
|
3251
|
-
|
|
4417
|
+
quotaFailure?: Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure;
|
|
4418
|
+
}
|
|
4419
|
+
export interface Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure {
|
|
3252
4420
|
/**
|
|
3253
|
-
*
|
|
4421
|
+
* This number is an estimation on how much total quota this project needs to successfully complete indexing.
|
|
3254
4422
|
*/
|
|
3255
|
-
|
|
4423
|
+
totalRequiredQuota?: string | null;
|
|
3256
4424
|
}
|
|
3257
4425
|
/**
|
|
3258
|
-
*
|
|
4426
|
+
* Metadata for UpdateSchema LRO.
|
|
3259
4427
|
*/
|
|
3260
|
-
export interface Schema$
|
|
3261
|
-
/**
|
|
3262
|
-
* The JSON representation of the schema.
|
|
3263
|
-
*/
|
|
3264
|
-
jsonSchema?: string | null;
|
|
4428
|
+
export interface Schema$GoogleCloudDiscoveryengineV1UpdateSchemaMetadata {
|
|
3265
4429
|
/**
|
|
3266
|
-
*
|
|
4430
|
+
* Operation create time.
|
|
3267
4431
|
*/
|
|
3268
|
-
|
|
4432
|
+
createTime?: string | null;
|
|
3269
4433
|
/**
|
|
3270
|
-
*
|
|
4434
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3271
4435
|
*/
|
|
3272
|
-
|
|
4436
|
+
updateTime?: string | null;
|
|
3273
4437
|
}
|
|
3274
4438
|
/**
|
|
3275
|
-
* Metadata
|
|
4439
|
+
* Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3276
4440
|
*/
|
|
3277
|
-
export interface Schema$
|
|
4441
|
+
export interface Schema$GoogleCloudDiscoveryengineV1UpdateTargetSiteMetadata {
|
|
3278
4442
|
/**
|
|
3279
4443
|
* Operation create time.
|
|
3280
4444
|
*/
|
|
@@ -3932,7 +5096,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
3932
5096
|
export interface Params$Resource$Projects$Locations$Estimatedatasize
|
|
3933
5097
|
extends StandardParameters {
|
|
3934
5098
|
/**
|
|
3935
|
-
* Required. Full resource name of the
|
|
5099
|
+
* Required. Full resource name of the location, such as `projects/{project\}/locations/{location\}`.
|
|
3936
5100
|
*/
|
|
3937
5101
|
location?: string;
|
|
3938
5102
|
|
|
@@ -4210,6 +5374,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
4210
5374
|
schemas: Resource$Projects$Locations$Collections$Datastores$Schemas;
|
|
4211
5375
|
servingConfigs: Resource$Projects$Locations$Collections$Datastores$Servingconfigs;
|
|
4212
5376
|
siteSearchEngine: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine;
|
|
5377
|
+
suggestionDenyListEntries: Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries;
|
|
4213
5378
|
userEvents: Resource$Projects$Locations$Collections$Datastores$Userevents;
|
|
4214
5379
|
constructor(context: APIRequestContext) {
|
|
4215
5380
|
this.context = context;
|
|
@@ -4241,6 +5406,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
4241
5406
|
new Resource$Projects$Locations$Collections$Datastores$Sitesearchengine(
|
|
4242
5407
|
this.context
|
|
4243
5408
|
);
|
|
5409
|
+
this.suggestionDenyListEntries =
|
|
5410
|
+
new Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries(
|
|
5411
|
+
this.context
|
|
5412
|
+
);
|
|
4244
5413
|
this.userEvents =
|
|
4245
5414
|
new Resource$Projects$Locations$Collections$Datastores$Userevents(
|
|
4246
5415
|
this.context
|
|
@@ -5219,7 +6388,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
5219
6388
|
*/
|
|
5220
6389
|
query?: string;
|
|
5221
6390
|
/**
|
|
5222
|
-
*
|
|
6391
|
+
* 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
6392
|
*/
|
|
5224
6393
|
queryModel?: string;
|
|
5225
6394
|
/**
|
|
@@ -5290,7 +6459,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
5290
6459
|
*/
|
|
5291
6460
|
pageToken?: string;
|
|
5292
6461
|
/**
|
|
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
|
|
6462
|
+
* 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
6463
|
*/
|
|
5295
6464
|
parent?: string;
|
|
5296
6465
|
}
|
|
@@ -5325,11 +6494,11 @@ export namespace discoveryengine_v1alpha {
|
|
|
5325
6494
|
export interface Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig
|
|
5326
6495
|
extends StandardParameters {
|
|
5327
6496
|
/**
|
|
5328
|
-
*
|
|
6497
|
+
* The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`.
|
|
5329
6498
|
*/
|
|
5330
6499
|
name?: string;
|
|
5331
6500
|
/**
|
|
5332
|
-
* Indicates which fields in the provided DocumentProcessingConfig to update. The following are the only supported fields: * DocumentProcessingConfig.
|
|
6501
|
+
* 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
6502
|
*/
|
|
5334
6503
|
updateMask?: string;
|
|
5335
6504
|
|
|
@@ -6989,7 +8158,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
6989
8158
|
*/
|
|
6990
8159
|
name?: string;
|
|
6991
8160
|
/**
|
|
6992
|
-
* Indicates which fields in the provided Conversation to update. The following are NOT supported: *
|
|
8161
|
+
* 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
8162
|
*/
|
|
6994
8163
|
updateMask?: string;
|
|
6995
8164
|
|
|
@@ -8241,6 +9410,294 @@ export namespace discoveryengine_v1alpha {
|
|
|
8241
9410
|
this.context = context;
|
|
8242
9411
|
}
|
|
8243
9412
|
|
|
9413
|
+
/**
|
|
9414
|
+
* Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
|
|
9415
|
+
*
|
|
9416
|
+
* @param params - Parameters for request
|
|
9417
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
9418
|
+
* @param callback - Optional callback that handles the response.
|
|
9419
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
9420
|
+
*/
|
|
9421
|
+
get(
|
|
9422
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get,
|
|
9423
|
+
options: StreamMethodOptions
|
|
9424
|
+
): GaxiosPromise<Readable>;
|
|
9425
|
+
get(
|
|
9426
|
+
params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get,
|
|
9427
|
+
options?: MethodOptions
|
|
9428
|
+
): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>;
|
|
9429
|
+
get(
|
|
9430
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get,
|
|
9431
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
9432
|
+
callback: BodyResponseCallback<Readable>
|
|
9433
|
+
): void;
|
|
9434
|
+
get(
|
|
9435
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get,
|
|
9436
|
+
options:
|
|
9437
|
+
| MethodOptions
|
|
9438
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>,
|
|
9439
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
|
|
9440
|
+
): void;
|
|
9441
|
+
get(
|
|
9442
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get,
|
|
9443
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
|
|
9444
|
+
): void;
|
|
9445
|
+
get(
|
|
9446
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
|
|
9447
|
+
): void;
|
|
9448
|
+
get(
|
|
9449
|
+
paramsOrCallback?:
|
|
9450
|
+
| Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get
|
|
9451
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
|
|
9452
|
+
| BodyResponseCallback<Readable>,
|
|
9453
|
+
optionsOrCallback?:
|
|
9454
|
+
| MethodOptions
|
|
9455
|
+
| StreamMethodOptions
|
|
9456
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
|
|
9457
|
+
| BodyResponseCallback<Readable>,
|
|
9458
|
+
callback?:
|
|
9459
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
|
|
9460
|
+
| BodyResponseCallback<Readable>
|
|
9461
|
+
):
|
|
9462
|
+
| void
|
|
9463
|
+
| GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
|
|
9464
|
+
| GaxiosPromise<Readable> {
|
|
9465
|
+
let params = (paramsOrCallback ||
|
|
9466
|
+
{}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get;
|
|
9467
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
9468
|
+
|
|
9469
|
+
if (typeof paramsOrCallback === 'function') {
|
|
9470
|
+
callback = paramsOrCallback;
|
|
9471
|
+
params =
|
|
9472
|
+
{} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get;
|
|
9473
|
+
options = {};
|
|
9474
|
+
}
|
|
9475
|
+
|
|
9476
|
+
if (typeof optionsOrCallback === 'function') {
|
|
9477
|
+
callback = optionsOrCallback;
|
|
9478
|
+
options = {};
|
|
9479
|
+
}
|
|
9480
|
+
|
|
9481
|
+
const rootUrl =
|
|
9482
|
+
options.rootUrl || 'https://discoveryengine.googleapis.com/';
|
|
9483
|
+
const parameters = {
|
|
9484
|
+
options: Object.assign(
|
|
9485
|
+
{
|
|
9486
|
+
url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'),
|
|
9487
|
+
method: 'GET',
|
|
9488
|
+
},
|
|
9489
|
+
options
|
|
9490
|
+
),
|
|
9491
|
+
params,
|
|
9492
|
+
requiredParams: ['name'],
|
|
9493
|
+
pathParams: ['name'],
|
|
9494
|
+
context: this.context,
|
|
9495
|
+
};
|
|
9496
|
+
if (callback) {
|
|
9497
|
+
createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>(
|
|
9498
|
+
parameters,
|
|
9499
|
+
callback as BodyResponseCallback<unknown>
|
|
9500
|
+
);
|
|
9501
|
+
} else {
|
|
9502
|
+
return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>(
|
|
9503
|
+
parameters
|
|
9504
|
+
);
|
|
9505
|
+
}
|
|
9506
|
+
}
|
|
9507
|
+
|
|
9508
|
+
/**
|
|
9509
|
+
* Lists all ServingConfigs linked to this dataStore.
|
|
9510
|
+
*
|
|
9511
|
+
* @param params - Parameters for request
|
|
9512
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
9513
|
+
* @param callback - Optional callback that handles the response.
|
|
9514
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
9515
|
+
*/
|
|
9516
|
+
list(
|
|
9517
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List,
|
|
9518
|
+
options: StreamMethodOptions
|
|
9519
|
+
): GaxiosPromise<Readable>;
|
|
9520
|
+
list(
|
|
9521
|
+
params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List,
|
|
9522
|
+
options?: MethodOptions
|
|
9523
|
+
): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>;
|
|
9524
|
+
list(
|
|
9525
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List,
|
|
9526
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
9527
|
+
callback: BodyResponseCallback<Readable>
|
|
9528
|
+
): void;
|
|
9529
|
+
list(
|
|
9530
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List,
|
|
9531
|
+
options:
|
|
9532
|
+
| MethodOptions
|
|
9533
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>,
|
|
9534
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>
|
|
9535
|
+
): void;
|
|
9536
|
+
list(
|
|
9537
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List,
|
|
9538
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>
|
|
9539
|
+
): void;
|
|
9540
|
+
list(
|
|
9541
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>
|
|
9542
|
+
): void;
|
|
9543
|
+
list(
|
|
9544
|
+
paramsOrCallback?:
|
|
9545
|
+
| Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List
|
|
9546
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>
|
|
9547
|
+
| BodyResponseCallback<Readable>,
|
|
9548
|
+
optionsOrCallback?:
|
|
9549
|
+
| MethodOptions
|
|
9550
|
+
| StreamMethodOptions
|
|
9551
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>
|
|
9552
|
+
| BodyResponseCallback<Readable>,
|
|
9553
|
+
callback?:
|
|
9554
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>
|
|
9555
|
+
| BodyResponseCallback<Readable>
|
|
9556
|
+
):
|
|
9557
|
+
| void
|
|
9558
|
+
| GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>
|
|
9559
|
+
| GaxiosPromise<Readable> {
|
|
9560
|
+
let params = (paramsOrCallback ||
|
|
9561
|
+
{}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List;
|
|
9562
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
9563
|
+
|
|
9564
|
+
if (typeof paramsOrCallback === 'function') {
|
|
9565
|
+
callback = paramsOrCallback;
|
|
9566
|
+
params =
|
|
9567
|
+
{} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List;
|
|
9568
|
+
options = {};
|
|
9569
|
+
}
|
|
9570
|
+
|
|
9571
|
+
if (typeof optionsOrCallback === 'function') {
|
|
9572
|
+
callback = optionsOrCallback;
|
|
9573
|
+
options = {};
|
|
9574
|
+
}
|
|
9575
|
+
|
|
9576
|
+
const rootUrl =
|
|
9577
|
+
options.rootUrl || 'https://discoveryengine.googleapis.com/';
|
|
9578
|
+
const parameters = {
|
|
9579
|
+
options: Object.assign(
|
|
9580
|
+
{
|
|
9581
|
+
url: (rootUrl + '/v1alpha/{+parent}/servingConfigs').replace(
|
|
9582
|
+
/([^:]\/)\/+/g,
|
|
9583
|
+
'$1'
|
|
9584
|
+
),
|
|
9585
|
+
method: 'GET',
|
|
9586
|
+
},
|
|
9587
|
+
options
|
|
9588
|
+
),
|
|
9589
|
+
params,
|
|
9590
|
+
requiredParams: ['parent'],
|
|
9591
|
+
pathParams: ['parent'],
|
|
9592
|
+
context: this.context,
|
|
9593
|
+
};
|
|
9594
|
+
if (callback) {
|
|
9595
|
+
createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>(
|
|
9596
|
+
parameters,
|
|
9597
|
+
callback as BodyResponseCallback<unknown>
|
|
9598
|
+
);
|
|
9599
|
+
} else {
|
|
9600
|
+
return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>(
|
|
9601
|
+
parameters
|
|
9602
|
+
);
|
|
9603
|
+
}
|
|
9604
|
+
}
|
|
9605
|
+
|
|
9606
|
+
/**
|
|
9607
|
+
* Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
|
|
9608
|
+
*
|
|
9609
|
+
* @param params - Parameters for request
|
|
9610
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
9611
|
+
* @param callback - Optional callback that handles the response.
|
|
9612
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
9613
|
+
*/
|
|
9614
|
+
patch(
|
|
9615
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch,
|
|
9616
|
+
options: StreamMethodOptions
|
|
9617
|
+
): GaxiosPromise<Readable>;
|
|
9618
|
+
patch(
|
|
9619
|
+
params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch,
|
|
9620
|
+
options?: MethodOptions
|
|
9621
|
+
): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>;
|
|
9622
|
+
patch(
|
|
9623
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch,
|
|
9624
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
9625
|
+
callback: BodyResponseCallback<Readable>
|
|
9626
|
+
): void;
|
|
9627
|
+
patch(
|
|
9628
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch,
|
|
9629
|
+
options:
|
|
9630
|
+
| MethodOptions
|
|
9631
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>,
|
|
9632
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
|
|
9633
|
+
): void;
|
|
9634
|
+
patch(
|
|
9635
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch,
|
|
9636
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
|
|
9637
|
+
): void;
|
|
9638
|
+
patch(
|
|
9639
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
|
|
9640
|
+
): void;
|
|
9641
|
+
patch(
|
|
9642
|
+
paramsOrCallback?:
|
|
9643
|
+
| Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch
|
|
9644
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
|
|
9645
|
+
| BodyResponseCallback<Readable>,
|
|
9646
|
+
optionsOrCallback?:
|
|
9647
|
+
| MethodOptions
|
|
9648
|
+
| StreamMethodOptions
|
|
9649
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
|
|
9650
|
+
| BodyResponseCallback<Readable>,
|
|
9651
|
+
callback?:
|
|
9652
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
|
|
9653
|
+
| BodyResponseCallback<Readable>
|
|
9654
|
+
):
|
|
9655
|
+
| void
|
|
9656
|
+
| GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
|
|
9657
|
+
| GaxiosPromise<Readable> {
|
|
9658
|
+
let params = (paramsOrCallback ||
|
|
9659
|
+
{}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch;
|
|
9660
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
9661
|
+
|
|
9662
|
+
if (typeof paramsOrCallback === 'function') {
|
|
9663
|
+
callback = paramsOrCallback;
|
|
9664
|
+
params =
|
|
9665
|
+
{} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch;
|
|
9666
|
+
options = {};
|
|
9667
|
+
}
|
|
9668
|
+
|
|
9669
|
+
if (typeof optionsOrCallback === 'function') {
|
|
9670
|
+
callback = optionsOrCallback;
|
|
9671
|
+
options = {};
|
|
9672
|
+
}
|
|
9673
|
+
|
|
9674
|
+
const rootUrl =
|
|
9675
|
+
options.rootUrl || 'https://discoveryengine.googleapis.com/';
|
|
9676
|
+
const parameters = {
|
|
9677
|
+
options: Object.assign(
|
|
9678
|
+
{
|
|
9679
|
+
url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'),
|
|
9680
|
+
method: 'PATCH',
|
|
9681
|
+
},
|
|
9682
|
+
options
|
|
9683
|
+
),
|
|
9684
|
+
params,
|
|
9685
|
+
requiredParams: ['name'],
|
|
9686
|
+
pathParams: ['name'],
|
|
9687
|
+
context: this.context,
|
|
9688
|
+
};
|
|
9689
|
+
if (callback) {
|
|
9690
|
+
createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>(
|
|
9691
|
+
parameters,
|
|
9692
|
+
callback as BodyResponseCallback<unknown>
|
|
9693
|
+
);
|
|
9694
|
+
} else {
|
|
9695
|
+
return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>(
|
|
9696
|
+
parameters
|
|
9697
|
+
);
|
|
9698
|
+
}
|
|
9699
|
+
}
|
|
9700
|
+
|
|
8244
9701
|
/**
|
|
8245
9702
|
* Makes a recommendation, which requires a contextual user event.
|
|
8246
9703
|
*
|
|
@@ -8438,10 +9895,48 @@ export namespace discoveryengine_v1alpha {
|
|
|
8438
9895
|
}
|
|
8439
9896
|
}
|
|
8440
9897
|
|
|
9898
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get
|
|
9899
|
+
extends StandardParameters {
|
|
9900
|
+
/**
|
|
9901
|
+
* Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/servingConfigs/{serving_config_id\}`
|
|
9902
|
+
*/
|
|
9903
|
+
name?: string;
|
|
9904
|
+
}
|
|
9905
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List
|
|
9906
|
+
extends StandardParameters {
|
|
9907
|
+
/**
|
|
9908
|
+
* Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned.
|
|
9909
|
+
*/
|
|
9910
|
+
pageSize?: number;
|
|
9911
|
+
/**
|
|
9912
|
+
* Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.
|
|
9913
|
+
*/
|
|
9914
|
+
pageToken?: string;
|
|
9915
|
+
/**
|
|
9916
|
+
* Required. The dataStore resource name. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`
|
|
9917
|
+
*/
|
|
9918
|
+
parent?: string;
|
|
9919
|
+
}
|
|
9920
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch
|
|
9921
|
+
extends StandardParameters {
|
|
9922
|
+
/**
|
|
9923
|
+
* Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}`
|
|
9924
|
+
*/
|
|
9925
|
+
name?: string;
|
|
9926
|
+
/**
|
|
9927
|
+
* Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated.
|
|
9928
|
+
*/
|
|
9929
|
+
updateMask?: string;
|
|
9930
|
+
|
|
9931
|
+
/**
|
|
9932
|
+
* Request body metadata
|
|
9933
|
+
*/
|
|
9934
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfig;
|
|
9935
|
+
}
|
|
8441
9936
|
export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend
|
|
8442
9937
|
extends StandardParameters {
|
|
8443
9938
|
/**
|
|
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.
|
|
9939
|
+
* 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
9940
|
*/
|
|
8446
9941
|
servingConfig?: string;
|
|
8447
9942
|
|
|
@@ -10032,29 +11527,256 @@ export namespace discoveryengine_v1alpha {
|
|
|
10032
11527
|
): void;
|
|
10033
11528
|
list(
|
|
10034
11529
|
paramsOrCallback?:
|
|
10035
|
-
| Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List
|
|
10036
|
-
| BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>
|
|
11530
|
+
| Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List
|
|
11531
|
+
| BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>
|
|
11532
|
+
| BodyResponseCallback<Readable>,
|
|
11533
|
+
optionsOrCallback?:
|
|
11534
|
+
| MethodOptions
|
|
11535
|
+
| StreamMethodOptions
|
|
11536
|
+
| BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>
|
|
11537
|
+
| BodyResponseCallback<Readable>,
|
|
11538
|
+
callback?:
|
|
11539
|
+
| BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>
|
|
11540
|
+
| BodyResponseCallback<Readable>
|
|
11541
|
+
):
|
|
11542
|
+
| void
|
|
11543
|
+
| GaxiosPromise<Schema$GoogleLongrunningListOperationsResponse>
|
|
11544
|
+
| GaxiosPromise<Readable> {
|
|
11545
|
+
let params = (paramsOrCallback ||
|
|
11546
|
+
{}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List;
|
|
11547
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
11548
|
+
|
|
11549
|
+
if (typeof paramsOrCallback === 'function') {
|
|
11550
|
+
callback = paramsOrCallback;
|
|
11551
|
+
params =
|
|
11552
|
+
{} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List;
|
|
11553
|
+
options = {};
|
|
11554
|
+
}
|
|
11555
|
+
|
|
11556
|
+
if (typeof optionsOrCallback === 'function') {
|
|
11557
|
+
callback = optionsOrCallback;
|
|
11558
|
+
options = {};
|
|
11559
|
+
}
|
|
11560
|
+
|
|
11561
|
+
const rootUrl =
|
|
11562
|
+
options.rootUrl || 'https://discoveryengine.googleapis.com/';
|
|
11563
|
+
const parameters = {
|
|
11564
|
+
options: Object.assign(
|
|
11565
|
+
{
|
|
11566
|
+
url: (rootUrl + '/v1alpha/{+name}/operations').replace(
|
|
11567
|
+
/([^:]\/)\/+/g,
|
|
11568
|
+
'$1'
|
|
11569
|
+
),
|
|
11570
|
+
method: 'GET',
|
|
11571
|
+
},
|
|
11572
|
+
options
|
|
11573
|
+
),
|
|
11574
|
+
params,
|
|
11575
|
+
requiredParams: ['name'],
|
|
11576
|
+
pathParams: ['name'],
|
|
11577
|
+
context: this.context,
|
|
11578
|
+
};
|
|
11579
|
+
if (callback) {
|
|
11580
|
+
createAPIRequest<Schema$GoogleLongrunningListOperationsResponse>(
|
|
11581
|
+
parameters,
|
|
11582
|
+
callback as BodyResponseCallback<unknown>
|
|
11583
|
+
);
|
|
11584
|
+
} else {
|
|
11585
|
+
return createAPIRequest<Schema$GoogleLongrunningListOperationsResponse>(
|
|
11586
|
+
parameters
|
|
11587
|
+
);
|
|
11588
|
+
}
|
|
11589
|
+
}
|
|
11590
|
+
}
|
|
11591
|
+
|
|
11592
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get
|
|
11593
|
+
extends StandardParameters {
|
|
11594
|
+
/**
|
|
11595
|
+
* The name of the operation resource.
|
|
11596
|
+
*/
|
|
11597
|
+
name?: string;
|
|
11598
|
+
}
|
|
11599
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List
|
|
11600
|
+
extends StandardParameters {
|
|
11601
|
+
/**
|
|
11602
|
+
* The standard list filter.
|
|
11603
|
+
*/
|
|
11604
|
+
filter?: string;
|
|
11605
|
+
/**
|
|
11606
|
+
* The name of the operation's parent resource.
|
|
11607
|
+
*/
|
|
11608
|
+
name?: string;
|
|
11609
|
+
/**
|
|
11610
|
+
* The standard list page size.
|
|
11611
|
+
*/
|
|
11612
|
+
pageSize?: number;
|
|
11613
|
+
/**
|
|
11614
|
+
* The standard list page token.
|
|
11615
|
+
*/
|
|
11616
|
+
pageToken?: string;
|
|
11617
|
+
}
|
|
11618
|
+
|
|
11619
|
+
export class Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries {
|
|
11620
|
+
context: APIRequestContext;
|
|
11621
|
+
constructor(context: APIRequestContext) {
|
|
11622
|
+
this.context = context;
|
|
11623
|
+
}
|
|
11624
|
+
|
|
11625
|
+
/**
|
|
11626
|
+
* Imports all SuggestionDenyListEntry for a DataStore.
|
|
11627
|
+
*
|
|
11628
|
+
* @param params - Parameters for request
|
|
11629
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
11630
|
+
* @param callback - Optional callback that handles the response.
|
|
11631
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
11632
|
+
*/
|
|
11633
|
+
import(
|
|
11634
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import,
|
|
11635
|
+
options: StreamMethodOptions
|
|
11636
|
+
): GaxiosPromise<Readable>;
|
|
11637
|
+
import(
|
|
11638
|
+
params?: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import,
|
|
11639
|
+
options?: MethodOptions
|
|
11640
|
+
): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
11641
|
+
import(
|
|
11642
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import,
|
|
11643
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
11644
|
+
callback: BodyResponseCallback<Readable>
|
|
11645
|
+
): void;
|
|
11646
|
+
import(
|
|
11647
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import,
|
|
11648
|
+
options:
|
|
11649
|
+
| MethodOptions
|
|
11650
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>,
|
|
11651
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
11652
|
+
): void;
|
|
11653
|
+
import(
|
|
11654
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import,
|
|
11655
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
11656
|
+
): void;
|
|
11657
|
+
import(
|
|
11658
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
11659
|
+
): void;
|
|
11660
|
+
import(
|
|
11661
|
+
paramsOrCallback?:
|
|
11662
|
+
| Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import
|
|
11663
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
11664
|
+
| BodyResponseCallback<Readable>,
|
|
11665
|
+
optionsOrCallback?:
|
|
11666
|
+
| MethodOptions
|
|
11667
|
+
| StreamMethodOptions
|
|
11668
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
11669
|
+
| BodyResponseCallback<Readable>,
|
|
11670
|
+
callback?:
|
|
11671
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
11672
|
+
| BodyResponseCallback<Readable>
|
|
11673
|
+
):
|
|
11674
|
+
| void
|
|
11675
|
+
| GaxiosPromise<Schema$GoogleLongrunningOperation>
|
|
11676
|
+
| GaxiosPromise<Readable> {
|
|
11677
|
+
let params = (paramsOrCallback ||
|
|
11678
|
+
{}) as Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import;
|
|
11679
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
11680
|
+
|
|
11681
|
+
if (typeof paramsOrCallback === 'function') {
|
|
11682
|
+
callback = paramsOrCallback;
|
|
11683
|
+
params =
|
|
11684
|
+
{} as Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import;
|
|
11685
|
+
options = {};
|
|
11686
|
+
}
|
|
11687
|
+
|
|
11688
|
+
if (typeof optionsOrCallback === 'function') {
|
|
11689
|
+
callback = optionsOrCallback;
|
|
11690
|
+
options = {};
|
|
11691
|
+
}
|
|
11692
|
+
|
|
11693
|
+
const rootUrl =
|
|
11694
|
+
options.rootUrl || 'https://discoveryengine.googleapis.com/';
|
|
11695
|
+
const parameters = {
|
|
11696
|
+
options: Object.assign(
|
|
11697
|
+
{
|
|
11698
|
+
url: (
|
|
11699
|
+
rootUrl + '/v1alpha/{+parent}/suggestionDenyListEntries:import'
|
|
11700
|
+
).replace(/([^:]\/)\/+/g, '$1'),
|
|
11701
|
+
method: 'POST',
|
|
11702
|
+
},
|
|
11703
|
+
options
|
|
11704
|
+
),
|
|
11705
|
+
params,
|
|
11706
|
+
requiredParams: ['parent'],
|
|
11707
|
+
pathParams: ['parent'],
|
|
11708
|
+
context: this.context,
|
|
11709
|
+
};
|
|
11710
|
+
if (callback) {
|
|
11711
|
+
createAPIRequest<Schema$GoogleLongrunningOperation>(
|
|
11712
|
+
parameters,
|
|
11713
|
+
callback as BodyResponseCallback<unknown>
|
|
11714
|
+
);
|
|
11715
|
+
} else {
|
|
11716
|
+
return createAPIRequest<Schema$GoogleLongrunningOperation>(parameters);
|
|
11717
|
+
}
|
|
11718
|
+
}
|
|
11719
|
+
|
|
11720
|
+
/**
|
|
11721
|
+
* Permanently deletes all SuggestionDenyListEntry for a DataStore.
|
|
11722
|
+
*
|
|
11723
|
+
* @param params - Parameters for request
|
|
11724
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
11725
|
+
* @param callback - Optional callback that handles the response.
|
|
11726
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
11727
|
+
*/
|
|
11728
|
+
purge(
|
|
11729
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge,
|
|
11730
|
+
options: StreamMethodOptions
|
|
11731
|
+
): GaxiosPromise<Readable>;
|
|
11732
|
+
purge(
|
|
11733
|
+
params?: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge,
|
|
11734
|
+
options?: MethodOptions
|
|
11735
|
+
): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
11736
|
+
purge(
|
|
11737
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge,
|
|
11738
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
11739
|
+
callback: BodyResponseCallback<Readable>
|
|
11740
|
+
): void;
|
|
11741
|
+
purge(
|
|
11742
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge,
|
|
11743
|
+
options:
|
|
11744
|
+
| MethodOptions
|
|
11745
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>,
|
|
11746
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
11747
|
+
): void;
|
|
11748
|
+
purge(
|
|
11749
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge,
|
|
11750
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
11751
|
+
): void;
|
|
11752
|
+
purge(
|
|
11753
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
11754
|
+
): void;
|
|
11755
|
+
purge(
|
|
11756
|
+
paramsOrCallback?:
|
|
11757
|
+
| Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge
|
|
11758
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
10037
11759
|
| BodyResponseCallback<Readable>,
|
|
10038
11760
|
optionsOrCallback?:
|
|
10039
11761
|
| MethodOptions
|
|
10040
11762
|
| StreamMethodOptions
|
|
10041
|
-
| BodyResponseCallback<Schema$
|
|
11763
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
10042
11764
|
| BodyResponseCallback<Readable>,
|
|
10043
11765
|
callback?:
|
|
10044
|
-
| BodyResponseCallback<Schema$
|
|
11766
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
10045
11767
|
| BodyResponseCallback<Readable>
|
|
10046
11768
|
):
|
|
10047
11769
|
| void
|
|
10048
|
-
| GaxiosPromise<Schema$
|
|
11770
|
+
| GaxiosPromise<Schema$GoogleLongrunningOperation>
|
|
10049
11771
|
| GaxiosPromise<Readable> {
|
|
10050
11772
|
let params = (paramsOrCallback ||
|
|
10051
|
-
{}) as Params$Resource$Projects$Locations$Collections$Datastores$
|
|
11773
|
+
{}) as Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge;
|
|
10052
11774
|
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
10053
11775
|
|
|
10054
11776
|
if (typeof paramsOrCallback === 'function') {
|
|
10055
11777
|
callback = paramsOrCallback;
|
|
10056
11778
|
params =
|
|
10057
|
-
{} as Params$Resource$Projects$Locations$Collections$Datastores$
|
|
11779
|
+
{} as Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge;
|
|
10058
11780
|
options = {};
|
|
10059
11781
|
}
|
|
10060
11782
|
|
|
@@ -10068,57 +11790,52 @@ export namespace discoveryengine_v1alpha {
|
|
|
10068
11790
|
const parameters = {
|
|
10069
11791
|
options: Object.assign(
|
|
10070
11792
|
{
|
|
10071
|
-
url: (
|
|
10072
|
-
/
|
|
10073
|
-
|
|
10074
|
-
|
|
10075
|
-
method: 'GET',
|
|
11793
|
+
url: (
|
|
11794
|
+
rootUrl + '/v1alpha/{+parent}/suggestionDenyListEntries:purge'
|
|
11795
|
+
).replace(/([^:]\/)\/+/g, '$1'),
|
|
11796
|
+
method: 'POST',
|
|
10076
11797
|
},
|
|
10077
11798
|
options
|
|
10078
11799
|
),
|
|
10079
11800
|
params,
|
|
10080
|
-
requiredParams: ['
|
|
10081
|
-
pathParams: ['
|
|
11801
|
+
requiredParams: ['parent'],
|
|
11802
|
+
pathParams: ['parent'],
|
|
10082
11803
|
context: this.context,
|
|
10083
11804
|
};
|
|
10084
11805
|
if (callback) {
|
|
10085
|
-
createAPIRequest<Schema$
|
|
11806
|
+
createAPIRequest<Schema$GoogleLongrunningOperation>(
|
|
10086
11807
|
parameters,
|
|
10087
11808
|
callback as BodyResponseCallback<unknown>
|
|
10088
11809
|
);
|
|
10089
11810
|
} else {
|
|
10090
|
-
return createAPIRequest<Schema$
|
|
10091
|
-
parameters
|
|
10092
|
-
);
|
|
11811
|
+
return createAPIRequest<Schema$GoogleLongrunningOperation>(parameters);
|
|
10093
11812
|
}
|
|
10094
11813
|
}
|
|
10095
11814
|
}
|
|
10096
11815
|
|
|
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
|
|
11816
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import
|
|
10105
11817
|
extends StandardParameters {
|
|
10106
11818
|
/**
|
|
10107
|
-
* The
|
|
11819
|
+
* Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x.
|
|
10108
11820
|
*/
|
|
10109
|
-
|
|
11821
|
+
parent?: string;
|
|
11822
|
+
|
|
10110
11823
|
/**
|
|
10111
|
-
*
|
|
11824
|
+
* Request body metadata
|
|
10112
11825
|
*/
|
|
10113
|
-
|
|
11826
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequest;
|
|
11827
|
+
}
|
|
11828
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge
|
|
11829
|
+
extends StandardParameters {
|
|
10114
11830
|
/**
|
|
10115
|
-
* The
|
|
11831
|
+
* Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x.
|
|
10116
11832
|
*/
|
|
10117
|
-
|
|
11833
|
+
parent?: string;
|
|
11834
|
+
|
|
10118
11835
|
/**
|
|
10119
|
-
*
|
|
11836
|
+
* Request body metadata
|
|
10120
11837
|
*/
|
|
10121
|
-
|
|
11838
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesRequest;
|
|
10122
11839
|
}
|
|
10123
11840
|
|
|
10124
11841
|
export class Resource$Projects$Locations$Collections$Datastores$Userevents {
|
|
@@ -11065,7 +12782,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
11065
12782
|
}
|
|
11066
12783
|
|
|
11067
12784
|
/**
|
|
11068
|
-
* Pauses the training of an existing engine. Only applicable if
|
|
12785
|
+
* Pauses the training of an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.
|
|
11069
12786
|
*
|
|
11070
12787
|
* @param params - Parameters for request
|
|
11071
12788
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -11163,7 +12880,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
11163
12880
|
}
|
|
11164
12881
|
|
|
11165
12882
|
/**
|
|
11166
|
-
* Resumes the training of an existing engine. Only applicable if
|
|
12883
|
+
* Resumes the training of an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.
|
|
11167
12884
|
*
|
|
11168
12885
|
* @param params - Parameters for request
|
|
11169
12886
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -11261,7 +12978,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
11261
12978
|
}
|
|
11262
12979
|
|
|
11263
12980
|
/**
|
|
11264
|
-
* Tunes an existing engine. Only applicable if
|
|
12981
|
+
* Tunes an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.
|
|
11265
12982
|
*
|
|
11266
12983
|
* @param params - Parameters for request
|
|
11267
12984
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -12107,7 +13824,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
12107
13824
|
*/
|
|
12108
13825
|
name?: string;
|
|
12109
13826
|
/**
|
|
12110
|
-
* Indicates which fields in the provided Conversation to update. The following are NOT supported: *
|
|
13827
|
+
* 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
13828
|
*/
|
|
12112
13829
|
updateMask?: string;
|
|
12113
13830
|
|
|
@@ -12348,6 +14065,294 @@ export namespace discoveryengine_v1alpha {
|
|
|
12348
14065
|
this.context = context;
|
|
12349
14066
|
}
|
|
12350
14067
|
|
|
14068
|
+
/**
|
|
14069
|
+
* Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
|
|
14070
|
+
*
|
|
14071
|
+
* @param params - Parameters for request
|
|
14072
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
14073
|
+
* @param callback - Optional callback that handles the response.
|
|
14074
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
14075
|
+
*/
|
|
14076
|
+
get(
|
|
14077
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get,
|
|
14078
|
+
options: StreamMethodOptions
|
|
14079
|
+
): GaxiosPromise<Readable>;
|
|
14080
|
+
get(
|
|
14081
|
+
params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get,
|
|
14082
|
+
options?: MethodOptions
|
|
14083
|
+
): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>;
|
|
14084
|
+
get(
|
|
14085
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get,
|
|
14086
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
14087
|
+
callback: BodyResponseCallback<Readable>
|
|
14088
|
+
): void;
|
|
14089
|
+
get(
|
|
14090
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get,
|
|
14091
|
+
options:
|
|
14092
|
+
| MethodOptions
|
|
14093
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>,
|
|
14094
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
|
|
14095
|
+
): void;
|
|
14096
|
+
get(
|
|
14097
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get,
|
|
14098
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
|
|
14099
|
+
): void;
|
|
14100
|
+
get(
|
|
14101
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
|
|
14102
|
+
): void;
|
|
14103
|
+
get(
|
|
14104
|
+
paramsOrCallback?:
|
|
14105
|
+
| Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get
|
|
14106
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
|
|
14107
|
+
| BodyResponseCallback<Readable>,
|
|
14108
|
+
optionsOrCallback?:
|
|
14109
|
+
| MethodOptions
|
|
14110
|
+
| StreamMethodOptions
|
|
14111
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
|
|
14112
|
+
| BodyResponseCallback<Readable>,
|
|
14113
|
+
callback?:
|
|
14114
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
|
|
14115
|
+
| BodyResponseCallback<Readable>
|
|
14116
|
+
):
|
|
14117
|
+
| void
|
|
14118
|
+
| GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
|
|
14119
|
+
| GaxiosPromise<Readable> {
|
|
14120
|
+
let params = (paramsOrCallback ||
|
|
14121
|
+
{}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get;
|
|
14122
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
14123
|
+
|
|
14124
|
+
if (typeof paramsOrCallback === 'function') {
|
|
14125
|
+
callback = paramsOrCallback;
|
|
14126
|
+
params =
|
|
14127
|
+
{} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get;
|
|
14128
|
+
options = {};
|
|
14129
|
+
}
|
|
14130
|
+
|
|
14131
|
+
if (typeof optionsOrCallback === 'function') {
|
|
14132
|
+
callback = optionsOrCallback;
|
|
14133
|
+
options = {};
|
|
14134
|
+
}
|
|
14135
|
+
|
|
14136
|
+
const rootUrl =
|
|
14137
|
+
options.rootUrl || 'https://discoveryengine.googleapis.com/';
|
|
14138
|
+
const parameters = {
|
|
14139
|
+
options: Object.assign(
|
|
14140
|
+
{
|
|
14141
|
+
url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'),
|
|
14142
|
+
method: 'GET',
|
|
14143
|
+
},
|
|
14144
|
+
options
|
|
14145
|
+
),
|
|
14146
|
+
params,
|
|
14147
|
+
requiredParams: ['name'],
|
|
14148
|
+
pathParams: ['name'],
|
|
14149
|
+
context: this.context,
|
|
14150
|
+
};
|
|
14151
|
+
if (callback) {
|
|
14152
|
+
createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>(
|
|
14153
|
+
parameters,
|
|
14154
|
+
callback as BodyResponseCallback<unknown>
|
|
14155
|
+
);
|
|
14156
|
+
} else {
|
|
14157
|
+
return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>(
|
|
14158
|
+
parameters
|
|
14159
|
+
);
|
|
14160
|
+
}
|
|
14161
|
+
}
|
|
14162
|
+
|
|
14163
|
+
/**
|
|
14164
|
+
* Lists all ServingConfigs linked to this dataStore.
|
|
14165
|
+
*
|
|
14166
|
+
* @param params - Parameters for request
|
|
14167
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
14168
|
+
* @param callback - Optional callback that handles the response.
|
|
14169
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
14170
|
+
*/
|
|
14171
|
+
list(
|
|
14172
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List,
|
|
14173
|
+
options: StreamMethodOptions
|
|
14174
|
+
): GaxiosPromise<Readable>;
|
|
14175
|
+
list(
|
|
14176
|
+
params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List,
|
|
14177
|
+
options?: MethodOptions
|
|
14178
|
+
): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>;
|
|
14179
|
+
list(
|
|
14180
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List,
|
|
14181
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
14182
|
+
callback: BodyResponseCallback<Readable>
|
|
14183
|
+
): void;
|
|
14184
|
+
list(
|
|
14185
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List,
|
|
14186
|
+
options:
|
|
14187
|
+
| MethodOptions
|
|
14188
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>,
|
|
14189
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>
|
|
14190
|
+
): void;
|
|
14191
|
+
list(
|
|
14192
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List,
|
|
14193
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>
|
|
14194
|
+
): void;
|
|
14195
|
+
list(
|
|
14196
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>
|
|
14197
|
+
): void;
|
|
14198
|
+
list(
|
|
14199
|
+
paramsOrCallback?:
|
|
14200
|
+
| Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List
|
|
14201
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>
|
|
14202
|
+
| BodyResponseCallback<Readable>,
|
|
14203
|
+
optionsOrCallback?:
|
|
14204
|
+
| MethodOptions
|
|
14205
|
+
| StreamMethodOptions
|
|
14206
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>
|
|
14207
|
+
| BodyResponseCallback<Readable>,
|
|
14208
|
+
callback?:
|
|
14209
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>
|
|
14210
|
+
| BodyResponseCallback<Readable>
|
|
14211
|
+
):
|
|
14212
|
+
| void
|
|
14213
|
+
| GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>
|
|
14214
|
+
| GaxiosPromise<Readable> {
|
|
14215
|
+
let params = (paramsOrCallback ||
|
|
14216
|
+
{}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List;
|
|
14217
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
14218
|
+
|
|
14219
|
+
if (typeof paramsOrCallback === 'function') {
|
|
14220
|
+
callback = paramsOrCallback;
|
|
14221
|
+
params =
|
|
14222
|
+
{} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List;
|
|
14223
|
+
options = {};
|
|
14224
|
+
}
|
|
14225
|
+
|
|
14226
|
+
if (typeof optionsOrCallback === 'function') {
|
|
14227
|
+
callback = optionsOrCallback;
|
|
14228
|
+
options = {};
|
|
14229
|
+
}
|
|
14230
|
+
|
|
14231
|
+
const rootUrl =
|
|
14232
|
+
options.rootUrl || 'https://discoveryengine.googleapis.com/';
|
|
14233
|
+
const parameters = {
|
|
14234
|
+
options: Object.assign(
|
|
14235
|
+
{
|
|
14236
|
+
url: (rootUrl + '/v1alpha/{+parent}/servingConfigs').replace(
|
|
14237
|
+
/([^:]\/)\/+/g,
|
|
14238
|
+
'$1'
|
|
14239
|
+
),
|
|
14240
|
+
method: 'GET',
|
|
14241
|
+
},
|
|
14242
|
+
options
|
|
14243
|
+
),
|
|
14244
|
+
params,
|
|
14245
|
+
requiredParams: ['parent'],
|
|
14246
|
+
pathParams: ['parent'],
|
|
14247
|
+
context: this.context,
|
|
14248
|
+
};
|
|
14249
|
+
if (callback) {
|
|
14250
|
+
createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>(
|
|
14251
|
+
parameters,
|
|
14252
|
+
callback as BodyResponseCallback<unknown>
|
|
14253
|
+
);
|
|
14254
|
+
} else {
|
|
14255
|
+
return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>(
|
|
14256
|
+
parameters
|
|
14257
|
+
);
|
|
14258
|
+
}
|
|
14259
|
+
}
|
|
14260
|
+
|
|
14261
|
+
/**
|
|
14262
|
+
* Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
|
|
14263
|
+
*
|
|
14264
|
+
* @param params - Parameters for request
|
|
14265
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
14266
|
+
* @param callback - Optional callback that handles the response.
|
|
14267
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
14268
|
+
*/
|
|
14269
|
+
patch(
|
|
14270
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch,
|
|
14271
|
+
options: StreamMethodOptions
|
|
14272
|
+
): GaxiosPromise<Readable>;
|
|
14273
|
+
patch(
|
|
14274
|
+
params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch,
|
|
14275
|
+
options?: MethodOptions
|
|
14276
|
+
): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>;
|
|
14277
|
+
patch(
|
|
14278
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch,
|
|
14279
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
14280
|
+
callback: BodyResponseCallback<Readable>
|
|
14281
|
+
): void;
|
|
14282
|
+
patch(
|
|
14283
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch,
|
|
14284
|
+
options:
|
|
14285
|
+
| MethodOptions
|
|
14286
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>,
|
|
14287
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
|
|
14288
|
+
): void;
|
|
14289
|
+
patch(
|
|
14290
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch,
|
|
14291
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
|
|
14292
|
+
): void;
|
|
14293
|
+
patch(
|
|
14294
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
|
|
14295
|
+
): void;
|
|
14296
|
+
patch(
|
|
14297
|
+
paramsOrCallback?:
|
|
14298
|
+
| Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch
|
|
14299
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
|
|
14300
|
+
| BodyResponseCallback<Readable>,
|
|
14301
|
+
optionsOrCallback?:
|
|
14302
|
+
| MethodOptions
|
|
14303
|
+
| StreamMethodOptions
|
|
14304
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
|
|
14305
|
+
| BodyResponseCallback<Readable>,
|
|
14306
|
+
callback?:
|
|
14307
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
|
|
14308
|
+
| BodyResponseCallback<Readable>
|
|
14309
|
+
):
|
|
14310
|
+
| void
|
|
14311
|
+
| GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
|
|
14312
|
+
| GaxiosPromise<Readable> {
|
|
14313
|
+
let params = (paramsOrCallback ||
|
|
14314
|
+
{}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch;
|
|
14315
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
14316
|
+
|
|
14317
|
+
if (typeof paramsOrCallback === 'function') {
|
|
14318
|
+
callback = paramsOrCallback;
|
|
14319
|
+
params =
|
|
14320
|
+
{} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch;
|
|
14321
|
+
options = {};
|
|
14322
|
+
}
|
|
14323
|
+
|
|
14324
|
+
if (typeof optionsOrCallback === 'function') {
|
|
14325
|
+
callback = optionsOrCallback;
|
|
14326
|
+
options = {};
|
|
14327
|
+
}
|
|
14328
|
+
|
|
14329
|
+
const rootUrl =
|
|
14330
|
+
options.rootUrl || 'https://discoveryengine.googleapis.com/';
|
|
14331
|
+
const parameters = {
|
|
14332
|
+
options: Object.assign(
|
|
14333
|
+
{
|
|
14334
|
+
url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'),
|
|
14335
|
+
method: 'PATCH',
|
|
14336
|
+
},
|
|
14337
|
+
options
|
|
14338
|
+
),
|
|
14339
|
+
params,
|
|
14340
|
+
requiredParams: ['name'],
|
|
14341
|
+
pathParams: ['name'],
|
|
14342
|
+
context: this.context,
|
|
14343
|
+
};
|
|
14344
|
+
if (callback) {
|
|
14345
|
+
createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>(
|
|
14346
|
+
parameters,
|
|
14347
|
+
callback as BodyResponseCallback<unknown>
|
|
14348
|
+
);
|
|
14349
|
+
} else {
|
|
14350
|
+
return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>(
|
|
14351
|
+
parameters
|
|
14352
|
+
);
|
|
14353
|
+
}
|
|
14354
|
+
}
|
|
14355
|
+
|
|
12351
14356
|
/**
|
|
12352
14357
|
* Makes a recommendation, which requires a contextual user event.
|
|
12353
14358
|
*
|
|
@@ -12545,10 +14550,48 @@ export namespace discoveryengine_v1alpha {
|
|
|
12545
14550
|
}
|
|
12546
14551
|
}
|
|
12547
14552
|
|
|
14553
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get
|
|
14554
|
+
extends StandardParameters {
|
|
14555
|
+
/**
|
|
14556
|
+
* Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/servingConfigs/{serving_config_id\}`
|
|
14557
|
+
*/
|
|
14558
|
+
name?: string;
|
|
14559
|
+
}
|
|
14560
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List
|
|
14561
|
+
extends StandardParameters {
|
|
14562
|
+
/**
|
|
14563
|
+
* Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned.
|
|
14564
|
+
*/
|
|
14565
|
+
pageSize?: number;
|
|
14566
|
+
/**
|
|
14567
|
+
* Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.
|
|
14568
|
+
*/
|
|
14569
|
+
pageToken?: string;
|
|
14570
|
+
/**
|
|
14571
|
+
* Required. The dataStore resource name. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`
|
|
14572
|
+
*/
|
|
14573
|
+
parent?: string;
|
|
14574
|
+
}
|
|
14575
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch
|
|
14576
|
+
extends StandardParameters {
|
|
14577
|
+
/**
|
|
14578
|
+
* Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}`
|
|
14579
|
+
*/
|
|
14580
|
+
name?: string;
|
|
14581
|
+
/**
|
|
14582
|
+
* Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated.
|
|
14583
|
+
*/
|
|
14584
|
+
updateMask?: string;
|
|
14585
|
+
|
|
14586
|
+
/**
|
|
14587
|
+
* Request body metadata
|
|
14588
|
+
*/
|
|
14589
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfig;
|
|
14590
|
+
}
|
|
12548
14591
|
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend
|
|
12549
14592
|
extends StandardParameters {
|
|
12550
14593
|
/**
|
|
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.
|
|
14594
|
+
* 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
14595
|
*/
|
|
12553
14596
|
servingConfig?: string;
|
|
12554
14597
|
|
|
@@ -12804,6 +14847,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
12804
14847
|
schemas: Resource$Projects$Locations$Datastores$Schemas;
|
|
12805
14848
|
servingConfigs: Resource$Projects$Locations$Datastores$Servingconfigs;
|
|
12806
14849
|
siteSearchEngine: Resource$Projects$Locations$Datastores$Sitesearchengine;
|
|
14850
|
+
suggestionDenyListEntries: Resource$Projects$Locations$Datastores$Suggestiondenylistentries;
|
|
12807
14851
|
userEvents: Resource$Projects$Locations$Datastores$Userevents;
|
|
12808
14852
|
constructor(context: APIRequestContext) {
|
|
12809
14853
|
this.context = context;
|
|
@@ -12827,6 +14871,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
12827
14871
|
new Resource$Projects$Locations$Datastores$Sitesearchengine(
|
|
12828
14872
|
this.context
|
|
12829
14873
|
);
|
|
14874
|
+
this.suggestionDenyListEntries =
|
|
14875
|
+
new Resource$Projects$Locations$Datastores$Suggestiondenylistentries(
|
|
14876
|
+
this.context
|
|
14877
|
+
);
|
|
12830
14878
|
this.userEvents = new Resource$Projects$Locations$Datastores$Userevents(
|
|
12831
14879
|
this.context
|
|
12832
14880
|
);
|
|
@@ -13703,7 +15751,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
13703
15751
|
*/
|
|
13704
15752
|
query?: string;
|
|
13705
15753
|
/**
|
|
13706
|
-
*
|
|
15754
|
+
* 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
15755
|
*/
|
|
13708
15756
|
queryModel?: string;
|
|
13709
15757
|
/**
|
|
@@ -13774,7 +15822,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
13774
15822
|
*/
|
|
13775
15823
|
pageToken?: string;
|
|
13776
15824
|
/**
|
|
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
|
|
15825
|
+
* 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
15826
|
*/
|
|
13779
15827
|
parent?: string;
|
|
13780
15828
|
}
|
|
@@ -13797,11 +15845,11 @@ export namespace discoveryengine_v1alpha {
|
|
|
13797
15845
|
export interface Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig
|
|
13798
15846
|
extends StandardParameters {
|
|
13799
15847
|
/**
|
|
13800
|
-
*
|
|
15848
|
+
* The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`.
|
|
13801
15849
|
*/
|
|
13802
15850
|
name?: string;
|
|
13803
15851
|
/**
|
|
13804
|
-
* Indicates which fields in the provided DocumentProcessingConfig to update. The following are the only supported fields: * DocumentProcessingConfig.
|
|
15852
|
+
* 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
15853
|
*/
|
|
13806
15854
|
updateMask?: string;
|
|
13807
15855
|
|
|
@@ -15461,7 +17509,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
15461
17509
|
*/
|
|
15462
17510
|
name?: string;
|
|
15463
17511
|
/**
|
|
15464
|
-
* Indicates which fields in the provided Conversation to update. The following are NOT supported: *
|
|
17512
|
+
* 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
17513
|
*/
|
|
15466
17514
|
updateMask?: string;
|
|
15467
17515
|
|
|
@@ -16477,10 +18525,298 @@ export namespace discoveryengine_v1alpha {
|
|
|
16477
18525
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSchema;
|
|
16478
18526
|
}
|
|
16479
18527
|
|
|
16480
|
-
export class Resource$Projects$Locations$Datastores$Servingconfigs {
|
|
16481
|
-
context: APIRequestContext;
|
|
16482
|
-
constructor(context: APIRequestContext) {
|
|
16483
|
-
this.context = context;
|
|
18528
|
+
export class Resource$Projects$Locations$Datastores$Servingconfigs {
|
|
18529
|
+
context: APIRequestContext;
|
|
18530
|
+
constructor(context: APIRequestContext) {
|
|
18531
|
+
this.context = context;
|
|
18532
|
+
}
|
|
18533
|
+
|
|
18534
|
+
/**
|
|
18535
|
+
* Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
|
|
18536
|
+
*
|
|
18537
|
+
* @param params - Parameters for request
|
|
18538
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
18539
|
+
* @param callback - Optional callback that handles the response.
|
|
18540
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
18541
|
+
*/
|
|
18542
|
+
get(
|
|
18543
|
+
params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get,
|
|
18544
|
+
options: StreamMethodOptions
|
|
18545
|
+
): GaxiosPromise<Readable>;
|
|
18546
|
+
get(
|
|
18547
|
+
params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get,
|
|
18548
|
+
options?: MethodOptions
|
|
18549
|
+
): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>;
|
|
18550
|
+
get(
|
|
18551
|
+
params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get,
|
|
18552
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
18553
|
+
callback: BodyResponseCallback<Readable>
|
|
18554
|
+
): void;
|
|
18555
|
+
get(
|
|
18556
|
+
params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get,
|
|
18557
|
+
options:
|
|
18558
|
+
| MethodOptions
|
|
18559
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>,
|
|
18560
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
|
|
18561
|
+
): void;
|
|
18562
|
+
get(
|
|
18563
|
+
params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get,
|
|
18564
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
|
|
18565
|
+
): void;
|
|
18566
|
+
get(
|
|
18567
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
|
|
18568
|
+
): void;
|
|
18569
|
+
get(
|
|
18570
|
+
paramsOrCallback?:
|
|
18571
|
+
| Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get
|
|
18572
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
|
|
18573
|
+
| BodyResponseCallback<Readable>,
|
|
18574
|
+
optionsOrCallback?:
|
|
18575
|
+
| MethodOptions
|
|
18576
|
+
| StreamMethodOptions
|
|
18577
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
|
|
18578
|
+
| BodyResponseCallback<Readable>,
|
|
18579
|
+
callback?:
|
|
18580
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
|
|
18581
|
+
| BodyResponseCallback<Readable>
|
|
18582
|
+
):
|
|
18583
|
+
| void
|
|
18584
|
+
| GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
|
|
18585
|
+
| GaxiosPromise<Readable> {
|
|
18586
|
+
let params = (paramsOrCallback ||
|
|
18587
|
+
{}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get;
|
|
18588
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
18589
|
+
|
|
18590
|
+
if (typeof paramsOrCallback === 'function') {
|
|
18591
|
+
callback = paramsOrCallback;
|
|
18592
|
+
params =
|
|
18593
|
+
{} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get;
|
|
18594
|
+
options = {};
|
|
18595
|
+
}
|
|
18596
|
+
|
|
18597
|
+
if (typeof optionsOrCallback === 'function') {
|
|
18598
|
+
callback = optionsOrCallback;
|
|
18599
|
+
options = {};
|
|
18600
|
+
}
|
|
18601
|
+
|
|
18602
|
+
const rootUrl =
|
|
18603
|
+
options.rootUrl || 'https://discoveryengine.googleapis.com/';
|
|
18604
|
+
const parameters = {
|
|
18605
|
+
options: Object.assign(
|
|
18606
|
+
{
|
|
18607
|
+
url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'),
|
|
18608
|
+
method: 'GET',
|
|
18609
|
+
},
|
|
18610
|
+
options
|
|
18611
|
+
),
|
|
18612
|
+
params,
|
|
18613
|
+
requiredParams: ['name'],
|
|
18614
|
+
pathParams: ['name'],
|
|
18615
|
+
context: this.context,
|
|
18616
|
+
};
|
|
18617
|
+
if (callback) {
|
|
18618
|
+
createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>(
|
|
18619
|
+
parameters,
|
|
18620
|
+
callback as BodyResponseCallback<unknown>
|
|
18621
|
+
);
|
|
18622
|
+
} else {
|
|
18623
|
+
return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>(
|
|
18624
|
+
parameters
|
|
18625
|
+
);
|
|
18626
|
+
}
|
|
18627
|
+
}
|
|
18628
|
+
|
|
18629
|
+
/**
|
|
18630
|
+
* Lists all ServingConfigs linked to this dataStore.
|
|
18631
|
+
*
|
|
18632
|
+
* @param params - Parameters for request
|
|
18633
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
18634
|
+
* @param callback - Optional callback that handles the response.
|
|
18635
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
18636
|
+
*/
|
|
18637
|
+
list(
|
|
18638
|
+
params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List,
|
|
18639
|
+
options: StreamMethodOptions
|
|
18640
|
+
): GaxiosPromise<Readable>;
|
|
18641
|
+
list(
|
|
18642
|
+
params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List,
|
|
18643
|
+
options?: MethodOptions
|
|
18644
|
+
): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>;
|
|
18645
|
+
list(
|
|
18646
|
+
params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List,
|
|
18647
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
18648
|
+
callback: BodyResponseCallback<Readable>
|
|
18649
|
+
): void;
|
|
18650
|
+
list(
|
|
18651
|
+
params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List,
|
|
18652
|
+
options:
|
|
18653
|
+
| MethodOptions
|
|
18654
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>,
|
|
18655
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>
|
|
18656
|
+
): void;
|
|
18657
|
+
list(
|
|
18658
|
+
params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List,
|
|
18659
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>
|
|
18660
|
+
): void;
|
|
18661
|
+
list(
|
|
18662
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>
|
|
18663
|
+
): void;
|
|
18664
|
+
list(
|
|
18665
|
+
paramsOrCallback?:
|
|
18666
|
+
| Params$Resource$Projects$Locations$Datastores$Servingconfigs$List
|
|
18667
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>
|
|
18668
|
+
| BodyResponseCallback<Readable>,
|
|
18669
|
+
optionsOrCallback?:
|
|
18670
|
+
| MethodOptions
|
|
18671
|
+
| StreamMethodOptions
|
|
18672
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>
|
|
18673
|
+
| BodyResponseCallback<Readable>,
|
|
18674
|
+
callback?:
|
|
18675
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>
|
|
18676
|
+
| BodyResponseCallback<Readable>
|
|
18677
|
+
):
|
|
18678
|
+
| void
|
|
18679
|
+
| GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>
|
|
18680
|
+
| GaxiosPromise<Readable> {
|
|
18681
|
+
let params = (paramsOrCallback ||
|
|
18682
|
+
{}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$List;
|
|
18683
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
18684
|
+
|
|
18685
|
+
if (typeof paramsOrCallback === 'function') {
|
|
18686
|
+
callback = paramsOrCallback;
|
|
18687
|
+
params =
|
|
18688
|
+
{} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$List;
|
|
18689
|
+
options = {};
|
|
18690
|
+
}
|
|
18691
|
+
|
|
18692
|
+
if (typeof optionsOrCallback === 'function') {
|
|
18693
|
+
callback = optionsOrCallback;
|
|
18694
|
+
options = {};
|
|
18695
|
+
}
|
|
18696
|
+
|
|
18697
|
+
const rootUrl =
|
|
18698
|
+
options.rootUrl || 'https://discoveryengine.googleapis.com/';
|
|
18699
|
+
const parameters = {
|
|
18700
|
+
options: Object.assign(
|
|
18701
|
+
{
|
|
18702
|
+
url: (rootUrl + '/v1alpha/{+parent}/servingConfigs').replace(
|
|
18703
|
+
/([^:]\/)\/+/g,
|
|
18704
|
+
'$1'
|
|
18705
|
+
),
|
|
18706
|
+
method: 'GET',
|
|
18707
|
+
},
|
|
18708
|
+
options
|
|
18709
|
+
),
|
|
18710
|
+
params,
|
|
18711
|
+
requiredParams: ['parent'],
|
|
18712
|
+
pathParams: ['parent'],
|
|
18713
|
+
context: this.context,
|
|
18714
|
+
};
|
|
18715
|
+
if (callback) {
|
|
18716
|
+
createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>(
|
|
18717
|
+
parameters,
|
|
18718
|
+
callback as BodyResponseCallback<unknown>
|
|
18719
|
+
);
|
|
18720
|
+
} else {
|
|
18721
|
+
return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>(
|
|
18722
|
+
parameters
|
|
18723
|
+
);
|
|
18724
|
+
}
|
|
18725
|
+
}
|
|
18726
|
+
|
|
18727
|
+
/**
|
|
18728
|
+
* Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
|
|
18729
|
+
*
|
|
18730
|
+
* @param params - Parameters for request
|
|
18731
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
18732
|
+
* @param callback - Optional callback that handles the response.
|
|
18733
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
18734
|
+
*/
|
|
18735
|
+
patch(
|
|
18736
|
+
params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch,
|
|
18737
|
+
options: StreamMethodOptions
|
|
18738
|
+
): GaxiosPromise<Readable>;
|
|
18739
|
+
patch(
|
|
18740
|
+
params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch,
|
|
18741
|
+
options?: MethodOptions
|
|
18742
|
+
): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>;
|
|
18743
|
+
patch(
|
|
18744
|
+
params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch,
|
|
18745
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
18746
|
+
callback: BodyResponseCallback<Readable>
|
|
18747
|
+
): void;
|
|
18748
|
+
patch(
|
|
18749
|
+
params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch,
|
|
18750
|
+
options:
|
|
18751
|
+
| MethodOptions
|
|
18752
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>,
|
|
18753
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
|
|
18754
|
+
): void;
|
|
18755
|
+
patch(
|
|
18756
|
+
params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch,
|
|
18757
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
|
|
18758
|
+
): void;
|
|
18759
|
+
patch(
|
|
18760
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
|
|
18761
|
+
): void;
|
|
18762
|
+
patch(
|
|
18763
|
+
paramsOrCallback?:
|
|
18764
|
+
| Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch
|
|
18765
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
|
|
18766
|
+
| BodyResponseCallback<Readable>,
|
|
18767
|
+
optionsOrCallback?:
|
|
18768
|
+
| MethodOptions
|
|
18769
|
+
| StreamMethodOptions
|
|
18770
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
|
|
18771
|
+
| BodyResponseCallback<Readable>,
|
|
18772
|
+
callback?:
|
|
18773
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
|
|
18774
|
+
| BodyResponseCallback<Readable>
|
|
18775
|
+
):
|
|
18776
|
+
| void
|
|
18777
|
+
| GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
|
|
18778
|
+
| GaxiosPromise<Readable> {
|
|
18779
|
+
let params = (paramsOrCallback ||
|
|
18780
|
+
{}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch;
|
|
18781
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
18782
|
+
|
|
18783
|
+
if (typeof paramsOrCallback === 'function') {
|
|
18784
|
+
callback = paramsOrCallback;
|
|
18785
|
+
params =
|
|
18786
|
+
{} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch;
|
|
18787
|
+
options = {};
|
|
18788
|
+
}
|
|
18789
|
+
|
|
18790
|
+
if (typeof optionsOrCallback === 'function') {
|
|
18791
|
+
callback = optionsOrCallback;
|
|
18792
|
+
options = {};
|
|
18793
|
+
}
|
|
18794
|
+
|
|
18795
|
+
const rootUrl =
|
|
18796
|
+
options.rootUrl || 'https://discoveryengine.googleapis.com/';
|
|
18797
|
+
const parameters = {
|
|
18798
|
+
options: Object.assign(
|
|
18799
|
+
{
|
|
18800
|
+
url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'),
|
|
18801
|
+
method: 'PATCH',
|
|
18802
|
+
},
|
|
18803
|
+
options
|
|
18804
|
+
),
|
|
18805
|
+
params,
|
|
18806
|
+
requiredParams: ['name'],
|
|
18807
|
+
pathParams: ['name'],
|
|
18808
|
+
context: this.context,
|
|
18809
|
+
};
|
|
18810
|
+
if (callback) {
|
|
18811
|
+
createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>(
|
|
18812
|
+
parameters,
|
|
18813
|
+
callback as BodyResponseCallback<unknown>
|
|
18814
|
+
);
|
|
18815
|
+
} else {
|
|
18816
|
+
return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>(
|
|
18817
|
+
parameters
|
|
18818
|
+
);
|
|
18819
|
+
}
|
|
16484
18820
|
}
|
|
16485
18821
|
|
|
16486
18822
|
/**
|
|
@@ -16680,10 +19016,48 @@ export namespace discoveryengine_v1alpha {
|
|
|
16680
19016
|
}
|
|
16681
19017
|
}
|
|
16682
19018
|
|
|
19019
|
+
export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get
|
|
19020
|
+
extends StandardParameters {
|
|
19021
|
+
/**
|
|
19022
|
+
* Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/servingConfigs/{serving_config_id\}`
|
|
19023
|
+
*/
|
|
19024
|
+
name?: string;
|
|
19025
|
+
}
|
|
19026
|
+
export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$List
|
|
19027
|
+
extends StandardParameters {
|
|
19028
|
+
/**
|
|
19029
|
+
* Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned.
|
|
19030
|
+
*/
|
|
19031
|
+
pageSize?: number;
|
|
19032
|
+
/**
|
|
19033
|
+
* Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.
|
|
19034
|
+
*/
|
|
19035
|
+
pageToken?: string;
|
|
19036
|
+
/**
|
|
19037
|
+
* Required. The dataStore resource name. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`
|
|
19038
|
+
*/
|
|
19039
|
+
parent?: string;
|
|
19040
|
+
}
|
|
19041
|
+
export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch
|
|
19042
|
+
extends StandardParameters {
|
|
19043
|
+
/**
|
|
19044
|
+
* Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}`
|
|
19045
|
+
*/
|
|
19046
|
+
name?: string;
|
|
19047
|
+
/**
|
|
19048
|
+
* Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated.
|
|
19049
|
+
*/
|
|
19050
|
+
updateMask?: string;
|
|
19051
|
+
|
|
19052
|
+
/**
|
|
19053
|
+
* Request body metadata
|
|
19054
|
+
*/
|
|
19055
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfig;
|
|
19056
|
+
}
|
|
16683
19057
|
export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend
|
|
16684
19058
|
extends StandardParameters {
|
|
16685
19059
|
/**
|
|
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.
|
|
19060
|
+
* 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
19061
|
*/
|
|
16688
19062
|
servingConfig?: string;
|
|
16689
19063
|
|
|
@@ -17683,6 +20057,228 @@ export namespace discoveryengine_v1alpha {
|
|
|
17683
20057
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSite;
|
|
17684
20058
|
}
|
|
17685
20059
|
|
|
20060
|
+
export class Resource$Projects$Locations$Datastores$Suggestiondenylistentries {
|
|
20061
|
+
context: APIRequestContext;
|
|
20062
|
+
constructor(context: APIRequestContext) {
|
|
20063
|
+
this.context = context;
|
|
20064
|
+
}
|
|
20065
|
+
|
|
20066
|
+
/**
|
|
20067
|
+
* Imports all SuggestionDenyListEntry for a DataStore.
|
|
20068
|
+
*
|
|
20069
|
+
* @param params - Parameters for request
|
|
20070
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
20071
|
+
* @param callback - Optional callback that handles the response.
|
|
20072
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
20073
|
+
*/
|
|
20074
|
+
import(
|
|
20075
|
+
params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import,
|
|
20076
|
+
options: StreamMethodOptions
|
|
20077
|
+
): GaxiosPromise<Readable>;
|
|
20078
|
+
import(
|
|
20079
|
+
params?: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import,
|
|
20080
|
+
options?: MethodOptions
|
|
20081
|
+
): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
20082
|
+
import(
|
|
20083
|
+
params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import,
|
|
20084
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
20085
|
+
callback: BodyResponseCallback<Readable>
|
|
20086
|
+
): void;
|
|
20087
|
+
import(
|
|
20088
|
+
params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import,
|
|
20089
|
+
options:
|
|
20090
|
+
| MethodOptions
|
|
20091
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>,
|
|
20092
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
20093
|
+
): void;
|
|
20094
|
+
import(
|
|
20095
|
+
params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import,
|
|
20096
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
20097
|
+
): void;
|
|
20098
|
+
import(
|
|
20099
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
20100
|
+
): void;
|
|
20101
|
+
import(
|
|
20102
|
+
paramsOrCallback?:
|
|
20103
|
+
| Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import
|
|
20104
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
20105
|
+
| BodyResponseCallback<Readable>,
|
|
20106
|
+
optionsOrCallback?:
|
|
20107
|
+
| MethodOptions
|
|
20108
|
+
| StreamMethodOptions
|
|
20109
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
20110
|
+
| BodyResponseCallback<Readable>,
|
|
20111
|
+
callback?:
|
|
20112
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
20113
|
+
| BodyResponseCallback<Readable>
|
|
20114
|
+
):
|
|
20115
|
+
| void
|
|
20116
|
+
| GaxiosPromise<Schema$GoogleLongrunningOperation>
|
|
20117
|
+
| GaxiosPromise<Readable> {
|
|
20118
|
+
let params = (paramsOrCallback ||
|
|
20119
|
+
{}) as Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import;
|
|
20120
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
20121
|
+
|
|
20122
|
+
if (typeof paramsOrCallback === 'function') {
|
|
20123
|
+
callback = paramsOrCallback;
|
|
20124
|
+
params =
|
|
20125
|
+
{} as Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import;
|
|
20126
|
+
options = {};
|
|
20127
|
+
}
|
|
20128
|
+
|
|
20129
|
+
if (typeof optionsOrCallback === 'function') {
|
|
20130
|
+
callback = optionsOrCallback;
|
|
20131
|
+
options = {};
|
|
20132
|
+
}
|
|
20133
|
+
|
|
20134
|
+
const rootUrl =
|
|
20135
|
+
options.rootUrl || 'https://discoveryengine.googleapis.com/';
|
|
20136
|
+
const parameters = {
|
|
20137
|
+
options: Object.assign(
|
|
20138
|
+
{
|
|
20139
|
+
url: (
|
|
20140
|
+
rootUrl + '/v1alpha/{+parent}/suggestionDenyListEntries:import'
|
|
20141
|
+
).replace(/([^:]\/)\/+/g, '$1'),
|
|
20142
|
+
method: 'POST',
|
|
20143
|
+
},
|
|
20144
|
+
options
|
|
20145
|
+
),
|
|
20146
|
+
params,
|
|
20147
|
+
requiredParams: ['parent'],
|
|
20148
|
+
pathParams: ['parent'],
|
|
20149
|
+
context: this.context,
|
|
20150
|
+
};
|
|
20151
|
+
if (callback) {
|
|
20152
|
+
createAPIRequest<Schema$GoogleLongrunningOperation>(
|
|
20153
|
+
parameters,
|
|
20154
|
+
callback as BodyResponseCallback<unknown>
|
|
20155
|
+
);
|
|
20156
|
+
} else {
|
|
20157
|
+
return createAPIRequest<Schema$GoogleLongrunningOperation>(parameters);
|
|
20158
|
+
}
|
|
20159
|
+
}
|
|
20160
|
+
|
|
20161
|
+
/**
|
|
20162
|
+
* Permanently deletes all SuggestionDenyListEntry for a DataStore.
|
|
20163
|
+
*
|
|
20164
|
+
* @param params - Parameters for request
|
|
20165
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
20166
|
+
* @param callback - Optional callback that handles the response.
|
|
20167
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
20168
|
+
*/
|
|
20169
|
+
purge(
|
|
20170
|
+
params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge,
|
|
20171
|
+
options: StreamMethodOptions
|
|
20172
|
+
): GaxiosPromise<Readable>;
|
|
20173
|
+
purge(
|
|
20174
|
+
params?: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge,
|
|
20175
|
+
options?: MethodOptions
|
|
20176
|
+
): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
20177
|
+
purge(
|
|
20178
|
+
params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge,
|
|
20179
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
20180
|
+
callback: BodyResponseCallback<Readable>
|
|
20181
|
+
): void;
|
|
20182
|
+
purge(
|
|
20183
|
+
params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge,
|
|
20184
|
+
options:
|
|
20185
|
+
| MethodOptions
|
|
20186
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>,
|
|
20187
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
20188
|
+
): void;
|
|
20189
|
+
purge(
|
|
20190
|
+
params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge,
|
|
20191
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
20192
|
+
): void;
|
|
20193
|
+
purge(
|
|
20194
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
20195
|
+
): void;
|
|
20196
|
+
purge(
|
|
20197
|
+
paramsOrCallback?:
|
|
20198
|
+
| Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge
|
|
20199
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
20200
|
+
| BodyResponseCallback<Readable>,
|
|
20201
|
+
optionsOrCallback?:
|
|
20202
|
+
| MethodOptions
|
|
20203
|
+
| StreamMethodOptions
|
|
20204
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
20205
|
+
| BodyResponseCallback<Readable>,
|
|
20206
|
+
callback?:
|
|
20207
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
20208
|
+
| BodyResponseCallback<Readable>
|
|
20209
|
+
):
|
|
20210
|
+
| void
|
|
20211
|
+
| GaxiosPromise<Schema$GoogleLongrunningOperation>
|
|
20212
|
+
| GaxiosPromise<Readable> {
|
|
20213
|
+
let params = (paramsOrCallback ||
|
|
20214
|
+
{}) as Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge;
|
|
20215
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
20216
|
+
|
|
20217
|
+
if (typeof paramsOrCallback === 'function') {
|
|
20218
|
+
callback = paramsOrCallback;
|
|
20219
|
+
params =
|
|
20220
|
+
{} as Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge;
|
|
20221
|
+
options = {};
|
|
20222
|
+
}
|
|
20223
|
+
|
|
20224
|
+
if (typeof optionsOrCallback === 'function') {
|
|
20225
|
+
callback = optionsOrCallback;
|
|
20226
|
+
options = {};
|
|
20227
|
+
}
|
|
20228
|
+
|
|
20229
|
+
const rootUrl =
|
|
20230
|
+
options.rootUrl || 'https://discoveryengine.googleapis.com/';
|
|
20231
|
+
const parameters = {
|
|
20232
|
+
options: Object.assign(
|
|
20233
|
+
{
|
|
20234
|
+
url: (
|
|
20235
|
+
rootUrl + '/v1alpha/{+parent}/suggestionDenyListEntries:purge'
|
|
20236
|
+
).replace(/([^:]\/)\/+/g, '$1'),
|
|
20237
|
+
method: 'POST',
|
|
20238
|
+
},
|
|
20239
|
+
options
|
|
20240
|
+
),
|
|
20241
|
+
params,
|
|
20242
|
+
requiredParams: ['parent'],
|
|
20243
|
+
pathParams: ['parent'],
|
|
20244
|
+
context: this.context,
|
|
20245
|
+
};
|
|
20246
|
+
if (callback) {
|
|
20247
|
+
createAPIRequest<Schema$GoogleLongrunningOperation>(
|
|
20248
|
+
parameters,
|
|
20249
|
+
callback as BodyResponseCallback<unknown>
|
|
20250
|
+
);
|
|
20251
|
+
} else {
|
|
20252
|
+
return createAPIRequest<Schema$GoogleLongrunningOperation>(parameters);
|
|
20253
|
+
}
|
|
20254
|
+
}
|
|
20255
|
+
}
|
|
20256
|
+
|
|
20257
|
+
export interface Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import
|
|
20258
|
+
extends StandardParameters {
|
|
20259
|
+
/**
|
|
20260
|
+
* Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x.
|
|
20261
|
+
*/
|
|
20262
|
+
parent?: string;
|
|
20263
|
+
|
|
20264
|
+
/**
|
|
20265
|
+
* Request body metadata
|
|
20266
|
+
*/
|
|
20267
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequest;
|
|
20268
|
+
}
|
|
20269
|
+
export interface Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge
|
|
20270
|
+
extends StandardParameters {
|
|
20271
|
+
/**
|
|
20272
|
+
* Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x.
|
|
20273
|
+
*/
|
|
20274
|
+
parent?: string;
|
|
20275
|
+
|
|
20276
|
+
/**
|
|
20277
|
+
* Request body metadata
|
|
20278
|
+
*/
|
|
20279
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesRequest;
|
|
20280
|
+
}
|
|
20281
|
+
|
|
17686
20282
|
export class Resource$Projects$Locations$Datastores$Userevents {
|
|
17687
20283
|
context: APIRequestContext;
|
|
17688
20284
|
constructor(context: APIRequestContext) {
|