@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/build/v1beta.d.ts
CHANGED
|
@@ -193,7 +193,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
193
193
|
functionName?: string | null;
|
|
194
194
|
}
|
|
195
195
|
/**
|
|
196
|
-
* Metadata related to the progress of the SiteSearchEngineService.
|
|
196
|
+
* Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
197
197
|
*/
|
|
198
198
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata {
|
|
199
199
|
/**
|
|
@@ -351,6 +351,11 @@ export declare namespace discoveryengine_v1beta {
|
|
|
351
351
|
*/
|
|
352
352
|
updateTime?: string | null;
|
|
353
353
|
}
|
|
354
|
+
/**
|
|
355
|
+
* The digital parsing configurations for documents.
|
|
356
|
+
*/
|
|
357
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaDigitalParsingConfig {
|
|
358
|
+
}
|
|
354
359
|
/**
|
|
355
360
|
* Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
356
361
|
*/
|
|
@@ -374,13 +379,40 @@ export declare namespace discoveryengine_v1beta {
|
|
|
374
379
|
*/
|
|
375
380
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig {
|
|
376
381
|
/**
|
|
377
|
-
*
|
|
382
|
+
* 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.
|
|
383
|
+
*/
|
|
384
|
+
defaultParsingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig;
|
|
385
|
+
/**
|
|
386
|
+
* The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`.
|
|
378
387
|
*/
|
|
379
388
|
name?: string | null;
|
|
380
389
|
/**
|
|
381
|
-
* The OCR config. Currently it only applies to PDFs.
|
|
390
|
+
* [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.
|
|
382
391
|
*/
|
|
383
392
|
ocrConfig?: Schema$GoogleCloudDiscoveryengineV1alphaOcrConfig;
|
|
393
|
+
/**
|
|
394
|
+
* 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.
|
|
395
|
+
*/
|
|
396
|
+
parsingConfigOverrides?: {
|
|
397
|
+
[key: string]: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig;
|
|
398
|
+
} | null;
|
|
399
|
+
}
|
|
400
|
+
/**
|
|
401
|
+
* Related configurations applied to a specific type of document parser.
|
|
402
|
+
*/
|
|
403
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig {
|
|
404
|
+
/**
|
|
405
|
+
* Configurations applied to digital parser.
|
|
406
|
+
*/
|
|
407
|
+
digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDigitalParsingConfig;
|
|
408
|
+
/**
|
|
409
|
+
* Configurations applied to layout parser.
|
|
410
|
+
*/
|
|
411
|
+
layoutParsingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaLayoutParsingConfig;
|
|
412
|
+
/**
|
|
413
|
+
* Configurations applied to OCR parser. Currently it only applies to PDFs.
|
|
414
|
+
*/
|
|
415
|
+
ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaOcrParsingConfig;
|
|
384
416
|
}
|
|
385
417
|
/**
|
|
386
418
|
* Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
@@ -421,7 +453,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
421
453
|
*/
|
|
422
454
|
createTime?: string | null;
|
|
423
455
|
/**
|
|
424
|
-
* 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
|
|
456
|
+
* 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.
|
|
425
457
|
*/
|
|
426
458
|
dataStoreIds?: string[] | null;
|
|
427
459
|
/**
|
|
@@ -470,7 +502,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
470
502
|
*/
|
|
471
503
|
agentCreationConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig;
|
|
472
504
|
/**
|
|
473
|
-
* 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
|
|
505
|
+
* 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.
|
|
474
506
|
*/
|
|
475
507
|
dialogflowAgentToLink?: string | null;
|
|
476
508
|
}
|
|
@@ -486,6 +518,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
486
518
|
* 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.
|
|
487
519
|
*/
|
|
488
520
|
defaultLanguageCode?: string | null;
|
|
521
|
+
/**
|
|
522
|
+
* 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.
|
|
523
|
+
*/
|
|
524
|
+
location?: string | null;
|
|
489
525
|
/**
|
|
490
526
|
* 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.
|
|
491
527
|
*/
|
|
@@ -505,7 +541,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
505
541
|
*/
|
|
506
542
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaEngineCommonConfig {
|
|
507
543
|
/**
|
|
508
|
-
* The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.
|
|
544
|
+
* Immutable. The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.
|
|
509
545
|
*/
|
|
510
546
|
companyName?: string | null;
|
|
511
547
|
}
|
|
@@ -514,7 +550,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
514
550
|
*/
|
|
515
551
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig {
|
|
516
552
|
/**
|
|
517
|
-
* The optimization objective e.g
|
|
553
|
+
* 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`
|
|
518
554
|
*/
|
|
519
555
|
optimizationObjective?: string | null;
|
|
520
556
|
/**
|
|
@@ -526,7 +562,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
526
562
|
*/
|
|
527
563
|
trainingState?: string | null;
|
|
528
564
|
/**
|
|
529
|
-
* Required. The type of engine e.g
|
|
565
|
+
* 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`.
|
|
530
566
|
*/
|
|
531
567
|
type?: string | null;
|
|
532
568
|
}
|
|
@@ -688,6 +724,36 @@ export declare namespace discoveryengine_v1beta {
|
|
|
688
724
|
*/
|
|
689
725
|
gcsPrefix?: string | null;
|
|
690
726
|
}
|
|
727
|
+
/**
|
|
728
|
+
* Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
729
|
+
*/
|
|
730
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata {
|
|
731
|
+
/**
|
|
732
|
+
* Operation create time.
|
|
733
|
+
*/
|
|
734
|
+
createTime?: string | null;
|
|
735
|
+
/**
|
|
736
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
737
|
+
*/
|
|
738
|
+
updateTime?: string | null;
|
|
739
|
+
}
|
|
740
|
+
/**
|
|
741
|
+
* Response message for CompletionService.ImportSuggestionDenyListEntries method.
|
|
742
|
+
*/
|
|
743
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse {
|
|
744
|
+
/**
|
|
745
|
+
* A sample of errors encountered while processing the request.
|
|
746
|
+
*/
|
|
747
|
+
errorSamples?: Schema$GoogleRpcStatus[];
|
|
748
|
+
/**
|
|
749
|
+
* Count of deny list entries that failed to be imported.
|
|
750
|
+
*/
|
|
751
|
+
failedEntriesCount?: string | null;
|
|
752
|
+
/**
|
|
753
|
+
* Count of deny list entries successfully imported.
|
|
754
|
+
*/
|
|
755
|
+
importedEntriesCount?: string | null;
|
|
756
|
+
}
|
|
691
757
|
/**
|
|
692
758
|
* Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
693
759
|
*/
|
|
@@ -730,12 +796,17 @@ export declare namespace discoveryengine_v1beta {
|
|
|
730
796
|
*/
|
|
731
797
|
unjoinedEventsCount?: string | null;
|
|
732
798
|
}
|
|
799
|
+
/**
|
|
800
|
+
* The layout parsing configurations for documents.
|
|
801
|
+
*/
|
|
802
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaLayoutParsingConfig {
|
|
803
|
+
}
|
|
733
804
|
/**
|
|
734
805
|
* The OCR options for parsing documents.
|
|
735
806
|
*/
|
|
736
807
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaOcrConfig {
|
|
737
808
|
/**
|
|
738
|
-
* Required. If OCR is enabled or not. OCR must be enabled for other OcrConfig options to apply.
|
|
809
|
+
* 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.
|
|
739
810
|
*/
|
|
740
811
|
enabled?: boolean | null;
|
|
741
812
|
/**
|
|
@@ -747,6 +818,19 @@ export declare namespace discoveryengine_v1beta {
|
|
|
747
818
|
*/
|
|
748
819
|
useNativeText?: boolean | null;
|
|
749
820
|
}
|
|
821
|
+
/**
|
|
822
|
+
* The OCR parsing configurations for documents.
|
|
823
|
+
*/
|
|
824
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaOcrParsingConfig {
|
|
825
|
+
/**
|
|
826
|
+
* Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.
|
|
827
|
+
*/
|
|
828
|
+
enhancedDocumentElements?: string[] | null;
|
|
829
|
+
/**
|
|
830
|
+
* If true, will use native text instead of OCR text on pages containing native text.
|
|
831
|
+
*/
|
|
832
|
+
useNativeText?: boolean | null;
|
|
833
|
+
}
|
|
750
834
|
/**
|
|
751
835
|
* Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
752
836
|
*/
|
|
@@ -781,6 +865,32 @@ export declare namespace discoveryengine_v1beta {
|
|
|
781
865
|
*/
|
|
782
866
|
purgeSample?: string[] | null;
|
|
783
867
|
}
|
|
868
|
+
/**
|
|
869
|
+
* Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
870
|
+
*/
|
|
871
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesMetadata {
|
|
872
|
+
/**
|
|
873
|
+
* Operation create time.
|
|
874
|
+
*/
|
|
875
|
+
createTime?: string | null;
|
|
876
|
+
/**
|
|
877
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
878
|
+
*/
|
|
879
|
+
updateTime?: string | null;
|
|
880
|
+
}
|
|
881
|
+
/**
|
|
882
|
+
* Response message for CompletionService.PurgeSuggestionDenyListEntries method.
|
|
883
|
+
*/
|
|
884
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesResponse {
|
|
885
|
+
/**
|
|
886
|
+
* A sample of errors encountered while processing the request.
|
|
887
|
+
*/
|
|
888
|
+
errorSamples?: Schema$GoogleRpcStatus[];
|
|
889
|
+
/**
|
|
890
|
+
* Number of suggestion deny list entries purged.
|
|
891
|
+
*/
|
|
892
|
+
purgeCount?: string | null;
|
|
893
|
+
}
|
|
784
894
|
/**
|
|
785
895
|
* Metadata related to the progress of the PurgeUserEvents operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
786
896
|
*/
|
|
@@ -871,7 +981,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
871
981
|
uri?: string | null;
|
|
872
982
|
}
|
|
873
983
|
/**
|
|
874
|
-
* Details about why crawling failed for a particular CorpusType, e.g
|
|
984
|
+
* Details about why crawling failed for a particular CorpusType, e.g., DESKTOP and MOBILE crawling may fail for different reasons.
|
|
875
985
|
*/
|
|
876
986
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason {
|
|
877
987
|
/**
|
|
@@ -952,7 +1062,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
952
1062
|
*/
|
|
953
1063
|
siteVerificationInfo?: Schema$GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo;
|
|
954
1064
|
/**
|
|
955
|
-
* The type of the target site, e.g
|
|
1065
|
+
* The type of the target site, e.g., whether the site is to be included or excluded.
|
|
956
1066
|
*/
|
|
957
1067
|
type?: string | null;
|
|
958
1068
|
/**
|
|
@@ -970,6 +1080,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
970
1080
|
quotaFailure?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure;
|
|
971
1081
|
}
|
|
972
1082
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure {
|
|
1083
|
+
/**
|
|
1084
|
+
* This number is an estimation on how much total quota this project needs to successfully complete indexing.
|
|
1085
|
+
*/
|
|
1086
|
+
totalRequiredQuota?: string | null;
|
|
973
1087
|
}
|
|
974
1088
|
/**
|
|
975
1089
|
* Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
@@ -1041,6 +1155,64 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1041
1155
|
*/
|
|
1042
1156
|
updateTime?: string | null;
|
|
1043
1157
|
}
|
|
1158
|
+
/**
|
|
1159
|
+
* Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
1160
|
+
*/
|
|
1161
|
+
export interface Schema$GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata {
|
|
1162
|
+
/**
|
|
1163
|
+
* Operation create time.
|
|
1164
|
+
*/
|
|
1165
|
+
createTime?: string | null;
|
|
1166
|
+
/**
|
|
1167
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
1168
|
+
*/
|
|
1169
|
+
updateTime?: string | null;
|
|
1170
|
+
}
|
|
1171
|
+
/**
|
|
1172
|
+
* Response message for SiteSearchEngineService.BatchCreateTargetSites method.
|
|
1173
|
+
*/
|
|
1174
|
+
export interface Schema$GoogleCloudDiscoveryengineV1BatchCreateTargetSitesResponse {
|
|
1175
|
+
/**
|
|
1176
|
+
* TargetSites created.
|
|
1177
|
+
*/
|
|
1178
|
+
targetSites?: Schema$GoogleCloudDiscoveryengineV1TargetSite[];
|
|
1179
|
+
}
|
|
1180
|
+
/**
|
|
1181
|
+
* Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
1182
|
+
*/
|
|
1183
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata {
|
|
1184
|
+
/**
|
|
1185
|
+
* Operation create time.
|
|
1186
|
+
*/
|
|
1187
|
+
createTime?: string | null;
|
|
1188
|
+
/**
|
|
1189
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
1190
|
+
*/
|
|
1191
|
+
updateTime?: string | null;
|
|
1192
|
+
}
|
|
1193
|
+
/**
|
|
1194
|
+
* Request message for SiteSearchEngineService.BatchCreateTargetSites method.
|
|
1195
|
+
*/
|
|
1196
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesRequest {
|
|
1197
|
+
/**
|
|
1198
|
+
* Required. The request message specifying the resources to create. A maximum of 20 TargetSites can be created in a batch.
|
|
1199
|
+
*/
|
|
1200
|
+
requests?: Schema$GoogleCloudDiscoveryengineV1betaCreateTargetSiteRequest[];
|
|
1201
|
+
}
|
|
1202
|
+
/**
|
|
1203
|
+
* Response message for SiteSearchEngineService.BatchCreateTargetSites method.
|
|
1204
|
+
*/
|
|
1205
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesResponse {
|
|
1206
|
+
/**
|
|
1207
|
+
* TargetSites created.
|
|
1208
|
+
*/
|
|
1209
|
+
targetSites?: Schema$GoogleCloudDiscoveryengineV1betaTargetSite[];
|
|
1210
|
+
}
|
|
1211
|
+
/**
|
|
1212
|
+
* Request message for SiteSearchEngineService.BatchVerifyTargetSites method.
|
|
1213
|
+
*/
|
|
1214
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaBatchVerifyTargetSitesRequest {
|
|
1215
|
+
}
|
|
1044
1216
|
/**
|
|
1045
1217
|
* BigQuery source import data from.
|
|
1046
1218
|
*/
|
|
@@ -1224,6 +1396,32 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1224
1396
|
*/
|
|
1225
1397
|
searchResults?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSearchResult[];
|
|
1226
1398
|
}
|
|
1399
|
+
/**
|
|
1400
|
+
* Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
1401
|
+
*/
|
|
1402
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata {
|
|
1403
|
+
/**
|
|
1404
|
+
* Operation create time.
|
|
1405
|
+
*/
|
|
1406
|
+
createTime?: string | null;
|
|
1407
|
+
/**
|
|
1408
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
1409
|
+
*/
|
|
1410
|
+
updateTime?: string | null;
|
|
1411
|
+
}
|
|
1412
|
+
/**
|
|
1413
|
+
* Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
1414
|
+
*/
|
|
1415
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaCreateEngineMetadata {
|
|
1416
|
+
/**
|
|
1417
|
+
* Operation create time.
|
|
1418
|
+
*/
|
|
1419
|
+
createTime?: string | null;
|
|
1420
|
+
/**
|
|
1421
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
1422
|
+
*/
|
|
1423
|
+
updateTime?: string | null;
|
|
1424
|
+
}
|
|
1227
1425
|
/**
|
|
1228
1426
|
* Metadata for Create Schema LRO.
|
|
1229
1427
|
*/
|
|
@@ -1237,6 +1435,32 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1237
1435
|
*/
|
|
1238
1436
|
updateTime?: string | null;
|
|
1239
1437
|
}
|
|
1438
|
+
/**
|
|
1439
|
+
* Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
1440
|
+
*/
|
|
1441
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaCreateTargetSiteMetadata {
|
|
1442
|
+
/**
|
|
1443
|
+
* Operation create time.
|
|
1444
|
+
*/
|
|
1445
|
+
createTime?: string | null;
|
|
1446
|
+
/**
|
|
1447
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
1448
|
+
*/
|
|
1449
|
+
updateTime?: string | null;
|
|
1450
|
+
}
|
|
1451
|
+
/**
|
|
1452
|
+
* Request message for SiteSearchEngineService.CreateTargetSite method.
|
|
1453
|
+
*/
|
|
1454
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaCreateTargetSiteRequest {
|
|
1455
|
+
/**
|
|
1456
|
+
* Required. Parent resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`.
|
|
1457
|
+
*/
|
|
1458
|
+
parent?: string | null;
|
|
1459
|
+
/**
|
|
1460
|
+
* Required. The TargetSite to create.
|
|
1461
|
+
*/
|
|
1462
|
+
targetSite?: Schema$GoogleCloudDiscoveryengineV1betaTargetSite;
|
|
1463
|
+
}
|
|
1240
1464
|
/**
|
|
1241
1465
|
* A custom attribute that is not explicitly modeled in a resource, e.g. UserEvent.
|
|
1242
1466
|
*/
|
|
@@ -1250,6 +1474,65 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1250
1474
|
*/
|
|
1251
1475
|
text?: string[] | null;
|
|
1252
1476
|
}
|
|
1477
|
+
/**
|
|
1478
|
+
* DataStore captures global settings and configs at the DataStore level.
|
|
1479
|
+
*/
|
|
1480
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaDataStore {
|
|
1481
|
+
/**
|
|
1482
|
+
* Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
|
|
1483
|
+
*/
|
|
1484
|
+
contentConfig?: string | null;
|
|
1485
|
+
/**
|
|
1486
|
+
* Output only. Timestamp the DataStore was created at.
|
|
1487
|
+
*/
|
|
1488
|
+
createTime?: string | null;
|
|
1489
|
+
/**
|
|
1490
|
+
* Output only. The id of the default Schema asscociated to this data store.
|
|
1491
|
+
*/
|
|
1492
|
+
defaultSchemaId?: string | null;
|
|
1493
|
+
/**
|
|
1494
|
+
* 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.
|
|
1495
|
+
*/
|
|
1496
|
+
displayName?: string | null;
|
|
1497
|
+
/**
|
|
1498
|
+
* Immutable. The industry vertical that the data store registers.
|
|
1499
|
+
*/
|
|
1500
|
+
industryVertical?: string | null;
|
|
1501
|
+
/**
|
|
1502
|
+
* 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.
|
|
1503
|
+
*/
|
|
1504
|
+
name?: string | null;
|
|
1505
|
+
/**
|
|
1506
|
+
* 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.
|
|
1507
|
+
*/
|
|
1508
|
+
solutionTypes?: string[] | null;
|
|
1509
|
+
}
|
|
1510
|
+
/**
|
|
1511
|
+
* Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
1512
|
+
*/
|
|
1513
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata {
|
|
1514
|
+
/**
|
|
1515
|
+
* Operation create time.
|
|
1516
|
+
*/
|
|
1517
|
+
createTime?: string | null;
|
|
1518
|
+
/**
|
|
1519
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
1520
|
+
*/
|
|
1521
|
+
updateTime?: string | null;
|
|
1522
|
+
}
|
|
1523
|
+
/**
|
|
1524
|
+
* Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
1525
|
+
*/
|
|
1526
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaDeleteEngineMetadata {
|
|
1527
|
+
/**
|
|
1528
|
+
* Operation create time.
|
|
1529
|
+
*/
|
|
1530
|
+
createTime?: string | null;
|
|
1531
|
+
/**
|
|
1532
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
1533
|
+
*/
|
|
1534
|
+
updateTime?: string | null;
|
|
1535
|
+
}
|
|
1253
1536
|
/**
|
|
1254
1537
|
* Metadata for DeleteSchema LRO.
|
|
1255
1538
|
*/
|
|
@@ -1263,6 +1546,42 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1263
1546
|
*/
|
|
1264
1547
|
updateTime?: string | null;
|
|
1265
1548
|
}
|
|
1549
|
+
/**
|
|
1550
|
+
* Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
1551
|
+
*/
|
|
1552
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaDeleteTargetSiteMetadata {
|
|
1553
|
+
/**
|
|
1554
|
+
* Operation create time.
|
|
1555
|
+
*/
|
|
1556
|
+
createTime?: string | null;
|
|
1557
|
+
/**
|
|
1558
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
1559
|
+
*/
|
|
1560
|
+
updateTime?: string | null;
|
|
1561
|
+
}
|
|
1562
|
+
/**
|
|
1563
|
+
* Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
1564
|
+
*/
|
|
1565
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata {
|
|
1566
|
+
/**
|
|
1567
|
+
* Operation create time.
|
|
1568
|
+
*/
|
|
1569
|
+
createTime?: string | null;
|
|
1570
|
+
/**
|
|
1571
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
1572
|
+
*/
|
|
1573
|
+
updateTime?: string | null;
|
|
1574
|
+
}
|
|
1575
|
+
/**
|
|
1576
|
+
* Request message for SiteSearchEngineService.DisableAdvancedSiteSearch method.
|
|
1577
|
+
*/
|
|
1578
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchRequest {
|
|
1579
|
+
}
|
|
1580
|
+
/**
|
|
1581
|
+
* Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.
|
|
1582
|
+
*/
|
|
1583
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse {
|
|
1584
|
+
}
|
|
1266
1585
|
/**
|
|
1267
1586
|
* Document captures all raw metadata information of items to be recommended or searched.
|
|
1268
1587
|
*/
|
|
@@ -1317,7 +1636,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1317
1636
|
*/
|
|
1318
1637
|
rawBytes?: string | null;
|
|
1319
1638
|
/**
|
|
1320
|
-
* 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.
|
|
1639
|
+
* 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.
|
|
1321
1640
|
*/
|
|
1322
1641
|
uri?: string | null;
|
|
1323
1642
|
}
|
|
@@ -1356,13 +1675,176 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1356
1675
|
values?: number[] | null;
|
|
1357
1676
|
}
|
|
1358
1677
|
/**
|
|
1359
|
-
*
|
|
1678
|
+
* Defines embedding config, used for bring your own embeddings feature.
|
|
1360
1679
|
*/
|
|
1361
|
-
export interface Schema$
|
|
1680
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaEmbeddingConfig {
|
|
1362
1681
|
/**
|
|
1363
|
-
*
|
|
1682
|
+
* Full field path in the schema mapped as embedding field.
|
|
1364
1683
|
*/
|
|
1365
|
-
|
|
1684
|
+
fieldPath?: string | null;
|
|
1685
|
+
}
|
|
1686
|
+
/**
|
|
1687
|
+
* Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
1688
|
+
*/
|
|
1689
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata {
|
|
1690
|
+
/**
|
|
1691
|
+
* Operation create time.
|
|
1692
|
+
*/
|
|
1693
|
+
createTime?: string | null;
|
|
1694
|
+
/**
|
|
1695
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
1696
|
+
*/
|
|
1697
|
+
updateTime?: string | null;
|
|
1698
|
+
}
|
|
1699
|
+
/**
|
|
1700
|
+
* Request message for SiteSearchEngineService.EnableAdvancedSiteSearch method.
|
|
1701
|
+
*/
|
|
1702
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchRequest {
|
|
1703
|
+
}
|
|
1704
|
+
/**
|
|
1705
|
+
* Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.
|
|
1706
|
+
*/
|
|
1707
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchResponse {
|
|
1708
|
+
}
|
|
1709
|
+
/**
|
|
1710
|
+
* Metadata that describes the training and serving parameters of an Engine.
|
|
1711
|
+
*/
|
|
1712
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaEngine {
|
|
1713
|
+
/**
|
|
1714
|
+
* Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
|
|
1715
|
+
*/
|
|
1716
|
+
chatEngineConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig;
|
|
1717
|
+
/**
|
|
1718
|
+
* Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
|
|
1719
|
+
*/
|
|
1720
|
+
chatEngineMetadata?: Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata;
|
|
1721
|
+
/**
|
|
1722
|
+
* Common config spec that specifies the metadata of the engine.
|
|
1723
|
+
*/
|
|
1724
|
+
commonConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineCommonConfig;
|
|
1725
|
+
/**
|
|
1726
|
+
* Output only. Timestamp the Recommendation Engine was created at.
|
|
1727
|
+
*/
|
|
1728
|
+
createTime?: string | null;
|
|
1729
|
+
/**
|
|
1730
|
+
* 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.
|
|
1731
|
+
*/
|
|
1732
|
+
dataStoreIds?: string[] | null;
|
|
1733
|
+
/**
|
|
1734
|
+
* Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
|
|
1735
|
+
*/
|
|
1736
|
+
displayName?: string | null;
|
|
1737
|
+
/**
|
|
1738
|
+
* 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.
|
|
1739
|
+
*/
|
|
1740
|
+
industryVertical?: string | null;
|
|
1741
|
+
/**
|
|
1742
|
+
* 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.
|
|
1743
|
+
*/
|
|
1744
|
+
name?: string | null;
|
|
1745
|
+
/**
|
|
1746
|
+
* Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
|
|
1747
|
+
*/
|
|
1748
|
+
searchEngineConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig;
|
|
1749
|
+
/**
|
|
1750
|
+
* Required. The solutions of the engine.
|
|
1751
|
+
*/
|
|
1752
|
+
solutionType?: string | null;
|
|
1753
|
+
/**
|
|
1754
|
+
* Output only. Timestamp the Recommendation Engine was last updated.
|
|
1755
|
+
*/
|
|
1756
|
+
updateTime?: string | null;
|
|
1757
|
+
}
|
|
1758
|
+
/**
|
|
1759
|
+
* Configurations for a Chat Engine.
|
|
1760
|
+
*/
|
|
1761
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig {
|
|
1762
|
+
/**
|
|
1763
|
+
* 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.
|
|
1764
|
+
*/
|
|
1765
|
+
agentCreationConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig;
|
|
1766
|
+
/**
|
|
1767
|
+
* 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.
|
|
1768
|
+
*/
|
|
1769
|
+
dialogflowAgentToLink?: string | null;
|
|
1770
|
+
}
|
|
1771
|
+
/**
|
|
1772
|
+
* 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.
|
|
1773
|
+
*/
|
|
1774
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig {
|
|
1775
|
+
/**
|
|
1776
|
+
* Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.
|
|
1777
|
+
*/
|
|
1778
|
+
business?: string | null;
|
|
1779
|
+
/**
|
|
1780
|
+
* 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.
|
|
1781
|
+
*/
|
|
1782
|
+
defaultLanguageCode?: string | null;
|
|
1783
|
+
/**
|
|
1784
|
+
* 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.
|
|
1785
|
+
*/
|
|
1786
|
+
location?: string | null;
|
|
1787
|
+
/**
|
|
1788
|
+
* 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.
|
|
1789
|
+
*/
|
|
1790
|
+
timeZone?: string | null;
|
|
1791
|
+
}
|
|
1792
|
+
/**
|
|
1793
|
+
* Additional information of a Chat Engine. Fields in this message are output only.
|
|
1794
|
+
*/
|
|
1795
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata {
|
|
1796
|
+
/**
|
|
1797
|
+
* The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.
|
|
1798
|
+
*/
|
|
1799
|
+
dialogflowAgent?: string | null;
|
|
1800
|
+
}
|
|
1801
|
+
/**
|
|
1802
|
+
* Common configurations for an Engine.
|
|
1803
|
+
*/
|
|
1804
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaEngineCommonConfig {
|
|
1805
|
+
/**
|
|
1806
|
+
* Immutable. The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.
|
|
1807
|
+
*/
|
|
1808
|
+
companyName?: string | null;
|
|
1809
|
+
}
|
|
1810
|
+
/**
|
|
1811
|
+
* Configurations for a Search Engine.
|
|
1812
|
+
*/
|
|
1813
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig {
|
|
1814
|
+
/**
|
|
1815
|
+
* The add-on that this search engine enables.
|
|
1816
|
+
*/
|
|
1817
|
+
searchAddOns?: string[] | null;
|
|
1818
|
+
/**
|
|
1819
|
+
* 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.
|
|
1820
|
+
*/
|
|
1821
|
+
searchTier?: string | null;
|
|
1822
|
+
}
|
|
1823
|
+
/**
|
|
1824
|
+
* Response message for SiteSearchEngineService.FetchDomainVerificationStatus method.
|
|
1825
|
+
*/
|
|
1826
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaFetchDomainVerificationStatusResponse {
|
|
1827
|
+
/**
|
|
1828
|
+
* A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
|
|
1829
|
+
*/
|
|
1830
|
+
nextPageToken?: string | null;
|
|
1831
|
+
/**
|
|
1832
|
+
* List of TargetSites containing the site verification status.
|
|
1833
|
+
*/
|
|
1834
|
+
targetSites?: Schema$GoogleCloudDiscoveryengineV1betaTargetSite[];
|
|
1835
|
+
/**
|
|
1836
|
+
* The total number of items matching the request. This will always be populated in the response.
|
|
1837
|
+
*/
|
|
1838
|
+
totalSize?: number | null;
|
|
1839
|
+
}
|
|
1840
|
+
/**
|
|
1841
|
+
* Cloud Storage location for input content.
|
|
1842
|
+
*/
|
|
1843
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaGcsSource {
|
|
1844
|
+
/**
|
|
1845
|
+
* The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`: One custom data JSON per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by Gen App Builder. * `csv`: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by Gen App Builder. Supported values for user even imports: * `user_event` (default): One JSON UserEvent per line.
|
|
1846
|
+
*/
|
|
1847
|
+
dataSchema?: string | null;
|
|
1366
1848
|
/**
|
|
1367
1849
|
* Required. Cloud Storage URIs to input files. URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/x.json`. A request can contain at most 100 files (or 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`).
|
|
1368
1850
|
*/
|
|
@@ -1453,6 +1935,58 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1453
1935
|
*/
|
|
1454
1936
|
gcsPrefix?: string | null;
|
|
1455
1937
|
}
|
|
1938
|
+
/**
|
|
1939
|
+
* Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
1940
|
+
*/
|
|
1941
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata {
|
|
1942
|
+
/**
|
|
1943
|
+
* Operation create time.
|
|
1944
|
+
*/
|
|
1945
|
+
createTime?: string | null;
|
|
1946
|
+
/**
|
|
1947
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
1948
|
+
*/
|
|
1949
|
+
updateTime?: string | null;
|
|
1950
|
+
}
|
|
1951
|
+
/**
|
|
1952
|
+
* Request message for CompletionService.ImportSuggestionDenyListEntries method.
|
|
1953
|
+
*/
|
|
1954
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesRequest {
|
|
1955
|
+
/**
|
|
1956
|
+
* 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.
|
|
1957
|
+
*/
|
|
1958
|
+
gcsSource?: Schema$GoogleCloudDiscoveryengineV1betaGcsSource;
|
|
1959
|
+
/**
|
|
1960
|
+
* The Inline source for the input content for suggestion deny list entries.
|
|
1961
|
+
*/
|
|
1962
|
+
inlineSource?: Schema$GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesRequestInlineSource;
|
|
1963
|
+
}
|
|
1964
|
+
/**
|
|
1965
|
+
* The inline source for SuggestionDenyListEntry.
|
|
1966
|
+
*/
|
|
1967
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesRequestInlineSource {
|
|
1968
|
+
/**
|
|
1969
|
+
* Required. A list of all denylist entries to import. Max of 1000 items.
|
|
1970
|
+
*/
|
|
1971
|
+
entries?: Schema$GoogleCloudDiscoveryengineV1betaSuggestionDenyListEntry[];
|
|
1972
|
+
}
|
|
1973
|
+
/**
|
|
1974
|
+
* Response message for CompletionService.ImportSuggestionDenyListEntries method.
|
|
1975
|
+
*/
|
|
1976
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesResponse {
|
|
1977
|
+
/**
|
|
1978
|
+
* A sample of errors encountered while processing the request.
|
|
1979
|
+
*/
|
|
1980
|
+
errorSamples?: Schema$GoogleRpcStatus[];
|
|
1981
|
+
/**
|
|
1982
|
+
* Count of deny list entries that failed to be imported.
|
|
1983
|
+
*/
|
|
1984
|
+
failedEntriesCount?: string | null;
|
|
1985
|
+
/**
|
|
1986
|
+
* Count of deny list entries successfully imported.
|
|
1987
|
+
*/
|
|
1988
|
+
importedEntriesCount?: string | null;
|
|
1989
|
+
}
|
|
1456
1990
|
/**
|
|
1457
1991
|
* Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
1458
1992
|
*/
|
|
@@ -1559,6 +2093,19 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1559
2093
|
*/
|
|
1560
2094
|
nextPageToken?: string | null;
|
|
1561
2095
|
}
|
|
2096
|
+
/**
|
|
2097
|
+
* Response message for DataStoreService.ListDataStores method.
|
|
2098
|
+
*/
|
|
2099
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaListDataStoresResponse {
|
|
2100
|
+
/**
|
|
2101
|
+
* All the customer's DataStores.
|
|
2102
|
+
*/
|
|
2103
|
+
dataStores?: Schema$GoogleCloudDiscoveryengineV1betaDataStore[];
|
|
2104
|
+
/**
|
|
2105
|
+
* A token that can be sent as ListDataStoresRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
|
|
2106
|
+
*/
|
|
2107
|
+
nextPageToken?: string | null;
|
|
2108
|
+
}
|
|
1562
2109
|
/**
|
|
1563
2110
|
* Response message for DocumentService.ListDocuments method.
|
|
1564
2111
|
*/
|
|
@@ -1572,6 +2119,19 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1572
2119
|
*/
|
|
1573
2120
|
nextPageToken?: string | null;
|
|
1574
2121
|
}
|
|
2122
|
+
/**
|
|
2123
|
+
* Response message for EngineService.ListEngines method.
|
|
2124
|
+
*/
|
|
2125
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaListEnginesResponse {
|
|
2126
|
+
/**
|
|
2127
|
+
* All the customer's Engines.
|
|
2128
|
+
*/
|
|
2129
|
+
engines?: Schema$GoogleCloudDiscoveryengineV1betaEngine[];
|
|
2130
|
+
/**
|
|
2131
|
+
* Not supported.
|
|
2132
|
+
*/
|
|
2133
|
+
nextPageToken?: string | null;
|
|
2134
|
+
}
|
|
1575
2135
|
/**
|
|
1576
2136
|
* Response message for SchemaService.ListSchemas method.
|
|
1577
2137
|
*/
|
|
@@ -1585,6 +2145,36 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1585
2145
|
*/
|
|
1586
2146
|
schemas?: Schema$GoogleCloudDiscoveryengineV1betaSchema[];
|
|
1587
2147
|
}
|
|
2148
|
+
/**
|
|
2149
|
+
* Response for ListServingConfigs method.
|
|
2150
|
+
*/
|
|
2151
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse {
|
|
2152
|
+
/**
|
|
2153
|
+
* Pagination token, if not returned indicates the last page.
|
|
2154
|
+
*/
|
|
2155
|
+
nextPageToken?: string | null;
|
|
2156
|
+
/**
|
|
2157
|
+
* All the ServingConfigs for a given dataStore.
|
|
2158
|
+
*/
|
|
2159
|
+
servingConfigs?: Schema$GoogleCloudDiscoveryengineV1betaServingConfig[];
|
|
2160
|
+
}
|
|
2161
|
+
/**
|
|
2162
|
+
* Response message for SiteSearchEngineService.ListTargetSites method.
|
|
2163
|
+
*/
|
|
2164
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaListTargetSitesResponse {
|
|
2165
|
+
/**
|
|
2166
|
+
* A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
|
|
2167
|
+
*/
|
|
2168
|
+
nextPageToken?: string | null;
|
|
2169
|
+
/**
|
|
2170
|
+
* List of TargetSites.
|
|
2171
|
+
*/
|
|
2172
|
+
targetSites?: Schema$GoogleCloudDiscoveryengineV1betaTargetSite[];
|
|
2173
|
+
/**
|
|
2174
|
+
* The total number of items matching the request. This will always be populated in the response.
|
|
2175
|
+
*/
|
|
2176
|
+
totalSize?: number | null;
|
|
2177
|
+
}
|
|
1588
2178
|
/**
|
|
1589
2179
|
* Media-specific user event information.
|
|
1590
2180
|
*/
|
|
@@ -1687,6 +2277,37 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1687
2277
|
*/
|
|
1688
2278
|
purgeSample?: string[] | null;
|
|
1689
2279
|
}
|
|
2280
|
+
/**
|
|
2281
|
+
* Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
2282
|
+
*/
|
|
2283
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata {
|
|
2284
|
+
/**
|
|
2285
|
+
* Operation create time.
|
|
2286
|
+
*/
|
|
2287
|
+
createTime?: string | null;
|
|
2288
|
+
/**
|
|
2289
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
2290
|
+
*/
|
|
2291
|
+
updateTime?: string | null;
|
|
2292
|
+
}
|
|
2293
|
+
/**
|
|
2294
|
+
* Request message for CompletionService.PurgeSuggestionDenyListEntries method.
|
|
2295
|
+
*/
|
|
2296
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesRequest {
|
|
2297
|
+
}
|
|
2298
|
+
/**
|
|
2299
|
+
* Response message for CompletionService.PurgeSuggestionDenyListEntries method.
|
|
2300
|
+
*/
|
|
2301
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse {
|
|
2302
|
+
/**
|
|
2303
|
+
* A sample of errors encountered while processing the request.
|
|
2304
|
+
*/
|
|
2305
|
+
errorSamples?: Schema$GoogleRpcStatus[];
|
|
2306
|
+
/**
|
|
2307
|
+
* Number of suggestion deny list entries purged.
|
|
2308
|
+
*/
|
|
2309
|
+
purgeCount?: string | null;
|
|
2310
|
+
}
|
|
1690
2311
|
/**
|
|
1691
2312
|
* Request message for Recommend method.
|
|
1692
2313
|
*/
|
|
@@ -1760,6 +2381,15 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1760
2381
|
[key: string]: any;
|
|
1761
2382
|
} | null;
|
|
1762
2383
|
}
|
|
2384
|
+
/**
|
|
2385
|
+
* Request message for SiteSearchEngineService.RecrawlUris method.
|
|
2386
|
+
*/
|
|
2387
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaRecrawlUrisRequest {
|
|
2388
|
+
/**
|
|
2389
|
+
* Required. List of URIs to crawl. At most 10K URIs are supported, otherwise an INVALID_ARGUMENT error is thrown. Each URI should match at least one TargetSite in `site_search_engine`.
|
|
2390
|
+
*/
|
|
2391
|
+
uris?: string[] | null;
|
|
2392
|
+
}
|
|
1763
2393
|
/**
|
|
1764
2394
|
* Defines a reply message to user.
|
|
1765
2395
|
*/
|
|
@@ -1855,7 +2485,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1855
2485
|
*/
|
|
1856
2486
|
contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec;
|
|
1857
2487
|
/**
|
|
1858
|
-
* Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.
|
|
2488
|
+
* 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.
|
|
1859
2489
|
*/
|
|
1860
2490
|
embeddingSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec;
|
|
1861
2491
|
/**
|
|
@@ -1971,7 +2601,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1971
2601
|
*/
|
|
1972
2602
|
export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec {
|
|
1973
2603
|
/**
|
|
1974
|
-
* 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
|
|
2604
|
+
* 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.
|
|
1975
2605
|
*/
|
|
1976
2606
|
maxExtractiveAnswerCount?: number | null;
|
|
1977
2607
|
/**
|
|
@@ -2051,7 +2681,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2051
2681
|
*/
|
|
2052
2682
|
export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec {
|
|
2053
2683
|
/**
|
|
2054
|
-
* The string
|
|
2684
|
+
* 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)
|
|
2055
2685
|
*/
|
|
2056
2686
|
version?: string | null;
|
|
2057
2687
|
}
|
|
@@ -2383,7 +3013,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2383
3013
|
*/
|
|
2384
3014
|
title?: string | null;
|
|
2385
3015
|
/**
|
|
2386
|
-
*
|
|
3016
|
+
* Cloud Storage or HTTP uri for the document.
|
|
2387
3017
|
*/
|
|
2388
3018
|
uri?: string | null;
|
|
2389
3019
|
}
|
|
@@ -2418,32 +3048,235 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2418
3048
|
summary?: string | null;
|
|
2419
3049
|
}
|
|
2420
3050
|
/**
|
|
2421
|
-
*
|
|
3051
|
+
* 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.
|
|
2422
3052
|
*/
|
|
2423
|
-
export interface Schema$
|
|
3053
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaServingConfig {
|
|
2424
3054
|
/**
|
|
2425
|
-
*
|
|
3055
|
+
* 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.
|
|
2426
3056
|
*/
|
|
2427
|
-
|
|
3057
|
+
boostControlIds?: string[] | null;
|
|
2428
3058
|
/**
|
|
2429
|
-
*
|
|
3059
|
+
* Output only. ServingConfig created timestamp.
|
|
2430
3060
|
*/
|
|
2431
|
-
|
|
2432
|
-
}
|
|
2433
|
-
/**
|
|
2434
|
-
* A transaction represents the entire purchase transaction.
|
|
2435
|
-
*/
|
|
2436
|
-
export interface Schema$GoogleCloudDiscoveryengineV1betaTransactionInfo {
|
|
3061
|
+
createTime?: string | null;
|
|
2437
3062
|
/**
|
|
2438
|
-
*
|
|
3063
|
+
* 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.
|
|
2439
3064
|
*/
|
|
2440
|
-
|
|
3065
|
+
displayName?: string | null;
|
|
2441
3066
|
/**
|
|
2442
|
-
*
|
|
3067
|
+
* 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.
|
|
2443
3068
|
*/
|
|
2444
|
-
|
|
3069
|
+
dissociateControlIds?: string[] | null;
|
|
2445
3070
|
/**
|
|
2446
|
-
*
|
|
3071
|
+
* 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.
|
|
3072
|
+
*/
|
|
3073
|
+
diversityLevel?: string | null;
|
|
3074
|
+
/**
|
|
3075
|
+
* 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.
|
|
3076
|
+
*/
|
|
3077
|
+
embeddingConfig?: Schema$GoogleCloudDiscoveryengineV1betaEmbeddingConfig;
|
|
3078
|
+
/**
|
|
3079
|
+
* 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.
|
|
3080
|
+
*/
|
|
3081
|
+
filterControlIds?: string[] | null;
|
|
3082
|
+
/**
|
|
3083
|
+
* The GenericConfig of the serving configuration.
|
|
3084
|
+
*/
|
|
3085
|
+
genericConfig?: Schema$GoogleCloudDiscoveryengineV1betaServingConfigGenericConfig;
|
|
3086
|
+
/**
|
|
3087
|
+
* 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.
|
|
3088
|
+
*/
|
|
3089
|
+
ignoreControlIds?: string[] | null;
|
|
3090
|
+
/**
|
|
3091
|
+
* The MediaConfig of the serving configuration.
|
|
3092
|
+
*/
|
|
3093
|
+
mediaConfig?: Schema$GoogleCloudDiscoveryengineV1betaServingConfigMediaConfig;
|
|
3094
|
+
/**
|
|
3095
|
+
* 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.
|
|
3096
|
+
*/
|
|
3097
|
+
modelId?: string | null;
|
|
3098
|
+
/**
|
|
3099
|
+
* Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}`
|
|
3100
|
+
*/
|
|
3101
|
+
name?: string | null;
|
|
3102
|
+
/**
|
|
3103
|
+
* 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.
|
|
3104
|
+
*/
|
|
3105
|
+
onewaySynonymsControlIds?: string[] | null;
|
|
3106
|
+
rankingExpression?: string | null;
|
|
3107
|
+
/**
|
|
3108
|
+
* 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.
|
|
3109
|
+
*/
|
|
3110
|
+
redirectControlIds?: string[] | null;
|
|
3111
|
+
/**
|
|
3112
|
+
* 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.
|
|
3113
|
+
*/
|
|
3114
|
+
replacementControlIds?: string[] | null;
|
|
3115
|
+
/**
|
|
3116
|
+
* Required. Immutable. Specifies the solution type that a serving config can be associated with.
|
|
3117
|
+
*/
|
|
3118
|
+
solutionType?: string | null;
|
|
3119
|
+
/**
|
|
3120
|
+
* 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.
|
|
3121
|
+
*/
|
|
3122
|
+
synonymsControlIds?: string[] | null;
|
|
3123
|
+
/**
|
|
3124
|
+
* Output only. ServingConfig updated timestamp.
|
|
3125
|
+
*/
|
|
3126
|
+
updateTime?: string | null;
|
|
3127
|
+
}
|
|
3128
|
+
/**
|
|
3129
|
+
* Specifies the configurations needed for Generic Discovery.Currently we support: * `content_search_spec`: configuration for generic content search.
|
|
3130
|
+
*/
|
|
3131
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaServingConfigGenericConfig {
|
|
3132
|
+
/**
|
|
3133
|
+
* Specifies the expected behavior of content search. Only valid for content-search enabled data store.
|
|
3134
|
+
*/
|
|
3135
|
+
contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec;
|
|
3136
|
+
}
|
|
3137
|
+
/**
|
|
3138
|
+
* 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.
|
|
3139
|
+
*/
|
|
3140
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaServingConfigMediaConfig {
|
|
3141
|
+
/**
|
|
3142
|
+
* Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days.
|
|
3143
|
+
*/
|
|
3144
|
+
contentFreshnessCutoffDays?: number | null;
|
|
3145
|
+
/**
|
|
3146
|
+
* Specifies the content watched minutes threshold for demotion.
|
|
3147
|
+
*/
|
|
3148
|
+
contentWatchedMinutesThreshold?: number | null;
|
|
3149
|
+
/**
|
|
3150
|
+
* Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive.
|
|
3151
|
+
*/
|
|
3152
|
+
contentWatchedPercentageThreshold?: number | null;
|
|
3153
|
+
/**
|
|
3154
|
+
* Specifies the content watched minutes threshold for demotion.
|
|
3155
|
+
*/
|
|
3156
|
+
contentWatchedSecondsThreshold?: number | null;
|
|
3157
|
+
/**
|
|
3158
|
+
* 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.
|
|
3159
|
+
*/
|
|
3160
|
+
demotionEventType?: string | null;
|
|
3161
|
+
}
|
|
3162
|
+
/**
|
|
3163
|
+
* SiteSearchEngine captures DataStore level site search persisting configurations. It is a singleton value per data store.
|
|
3164
|
+
*/
|
|
3165
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaSiteSearchEngine {
|
|
3166
|
+
/**
|
|
3167
|
+
* The fully qualified resource name of the site search engine. Format: `projects/x/locations/x/dataStores/x/siteSearchEngine`
|
|
3168
|
+
*/
|
|
3169
|
+
name?: string | null;
|
|
3170
|
+
}
|
|
3171
|
+
/**
|
|
3172
|
+
* Verification information for target sites in advanced site search.
|
|
3173
|
+
*/
|
|
3174
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaSiteVerificationInfo {
|
|
3175
|
+
/**
|
|
3176
|
+
* Site verification state indicating the ownership and validity.
|
|
3177
|
+
*/
|
|
3178
|
+
siteVerificationState?: string | null;
|
|
3179
|
+
/**
|
|
3180
|
+
* Latest site verification time.
|
|
3181
|
+
*/
|
|
3182
|
+
verifyTime?: string | null;
|
|
3183
|
+
}
|
|
3184
|
+
/**
|
|
3185
|
+
* Suggestion deny list entry identifying the phrase to block from suggestions and the applied operation for the phrase.
|
|
3186
|
+
*/
|
|
3187
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaSuggestionDenyListEntry {
|
|
3188
|
+
/**
|
|
3189
|
+
* Required. Phrase to block from suggestions served. Can be maximum 125 characters.
|
|
3190
|
+
*/
|
|
3191
|
+
blockPhrase?: string | null;
|
|
3192
|
+
/**
|
|
3193
|
+
* Required. The match operator to apply for this phrase. Whether to block the exact phrase, or block any suggestions containing this phrase.
|
|
3194
|
+
*/
|
|
3195
|
+
matchOperator?: string | null;
|
|
3196
|
+
}
|
|
3197
|
+
/**
|
|
3198
|
+
* A target site for the SiteSearchEngine.
|
|
3199
|
+
*/
|
|
3200
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaTargetSite {
|
|
3201
|
+
/**
|
|
3202
|
+
* 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.
|
|
3203
|
+
*/
|
|
3204
|
+
exactMatch?: boolean | null;
|
|
3205
|
+
/**
|
|
3206
|
+
* Output only. Failure reason.
|
|
3207
|
+
*/
|
|
3208
|
+
failureReason?: Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReason;
|
|
3209
|
+
/**
|
|
3210
|
+
* Output only. This is system-generated based on the provided_uri_pattern.
|
|
3211
|
+
*/
|
|
3212
|
+
generatedUriPattern?: string | null;
|
|
3213
|
+
/**
|
|
3214
|
+
* Output only. Indexing status.
|
|
3215
|
+
*/
|
|
3216
|
+
indexingStatus?: string | null;
|
|
3217
|
+
/**
|
|
3218
|
+
* 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.
|
|
3219
|
+
*/
|
|
3220
|
+
name?: string | null;
|
|
3221
|
+
/**
|
|
3222
|
+
* Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated.
|
|
3223
|
+
*/
|
|
3224
|
+
providedUriPattern?: string | null;
|
|
3225
|
+
/**
|
|
3226
|
+
* Output only. Site ownership and validity verification status.
|
|
3227
|
+
*/
|
|
3228
|
+
siteVerificationInfo?: Schema$GoogleCloudDiscoveryengineV1betaSiteVerificationInfo;
|
|
3229
|
+
/**
|
|
3230
|
+
* The type of the target site, e.g., whether the site is to be included or excluded.
|
|
3231
|
+
*/
|
|
3232
|
+
type?: string | null;
|
|
3233
|
+
/**
|
|
3234
|
+
* Output only. The target site's last updated time.
|
|
3235
|
+
*/
|
|
3236
|
+
updateTime?: string | null;
|
|
3237
|
+
}
|
|
3238
|
+
/**
|
|
3239
|
+
* Site search indexing failure reasons.
|
|
3240
|
+
*/
|
|
3241
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReason {
|
|
3242
|
+
/**
|
|
3243
|
+
* Failed due to insufficient quota.
|
|
3244
|
+
*/
|
|
3245
|
+
quotaFailure?: Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure;
|
|
3246
|
+
}
|
|
3247
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure {
|
|
3248
|
+
/**
|
|
3249
|
+
* This number is an estimation on how much total quota this project needs to successfully complete indexing.
|
|
3250
|
+
*/
|
|
3251
|
+
totalRequiredQuota?: string | null;
|
|
3252
|
+
}
|
|
3253
|
+
/**
|
|
3254
|
+
* Defines text input.
|
|
3255
|
+
*/
|
|
3256
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaTextInput {
|
|
3257
|
+
/**
|
|
3258
|
+
* Conversation context of the input.
|
|
3259
|
+
*/
|
|
3260
|
+
context?: Schema$GoogleCloudDiscoveryengineV1betaConversationContext;
|
|
3261
|
+
/**
|
|
3262
|
+
* Text input.
|
|
3263
|
+
*/
|
|
3264
|
+
input?: string | null;
|
|
3265
|
+
}
|
|
3266
|
+
/**
|
|
3267
|
+
* A transaction represents the entire purchase transaction.
|
|
3268
|
+
*/
|
|
3269
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaTransactionInfo {
|
|
3270
|
+
/**
|
|
3271
|
+
* All the costs associated with the products. These can be manufacturing costs, shipping expenses not borne by the end user, or any other costs, such that: * Profit = value - tax - cost
|
|
3272
|
+
*/
|
|
3273
|
+
cost?: number | null;
|
|
3274
|
+
/**
|
|
3275
|
+
* Required. Currency code. Use three-character ISO-4217 code.
|
|
3276
|
+
*/
|
|
3277
|
+
currency?: string | null;
|
|
3278
|
+
/**
|
|
3279
|
+
* The total discount(s) value applied to this transaction. This figure should be excluded from TransactionInfo.value For example, if a user paid TransactionInfo.value amount, then nominal (pre-discount) value of the transaction is the sum of TransactionInfo.value and TransactionInfo.discount_value This means that profit is calculated the same way, regardless of the discount value, and that TransactionInfo.discount_value can be larger than TransactionInfo.value: * Profit = value - tax - cost
|
|
2447
3280
|
*/
|
|
2448
3281
|
discountValue?: number | null;
|
|
2449
3282
|
/**
|
|
@@ -2472,6 +3305,19 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2472
3305
|
*/
|
|
2473
3306
|
updateTime?: string | null;
|
|
2474
3307
|
}
|
|
3308
|
+
/**
|
|
3309
|
+
* Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3310
|
+
*/
|
|
3311
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaUpdateTargetSiteMetadata {
|
|
3312
|
+
/**
|
|
3313
|
+
* Operation create time.
|
|
3314
|
+
*/
|
|
3315
|
+
createTime?: string | null;
|
|
3316
|
+
/**
|
|
3317
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3318
|
+
*/
|
|
3319
|
+
updateTime?: string | null;
|
|
3320
|
+
}
|
|
2475
3321
|
/**
|
|
2476
3322
|
* UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with customers' website.
|
|
2477
3323
|
*/
|
|
@@ -2485,110 +3331,371 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2485
3331
|
/**
|
|
2486
3332
|
* Token to attribute an API response to user action(s) to trigger the event. Highly recommended for user events that are the result of RecommendationService.Recommend. This field enables accurate attribution of recommendation model performance. The value must be one of: * RecommendResponse.attribution_token for events that are the result of RecommendationService.Recommend. * SearchResponse.attribution_token for events that are the result of SearchService.Search. This token enables us to accurately attribute page view or conversion completion back to the event and the particular predict response containing this clicked/purchased product. If user clicks on product K in the recommendation results, pass RecommendResponse.attribution_token as a URL parameter to product K's page. When recording events on product K's page, log the RecommendResponse.attribution_token to this field.
|
|
2487
3333
|
*/
|
|
2488
|
-
attributionToken?: string | null;
|
|
3334
|
+
attributionToken?: string | null;
|
|
3335
|
+
/**
|
|
3336
|
+
* CompletionService.CompleteQuery details related to the event. This field should be set for `search` event when autocomplete function is enabled and the user clicks a suggestion for search.
|
|
3337
|
+
*/
|
|
3338
|
+
completionInfo?: Schema$GoogleCloudDiscoveryengineV1betaCompletionInfo;
|
|
3339
|
+
/**
|
|
3340
|
+
* Should set to true if the request is made directly from the end user, in which case the UserEvent.user_info.user_agent can be populated from the HTTP request. This flag should be set only if the API request is made directly from the end user such as a mobile app (and not if a gateway or a server is processing and pushing the user events). This should not be set when using the JavaScript tag in UserEventService.CollectUserEvent.
|
|
3341
|
+
*/
|
|
3342
|
+
directUserRequest?: boolean | null;
|
|
3343
|
+
/**
|
|
3344
|
+
* List of Documents associated with this user event. This field is optional except for the following event types: * `view-item` * `add-to-cart` * `purchase` * `media-play` * `media-complete` In a `search` event, this field represents the documents returned to the end user on the current page (the end user may have not finished browsing the whole page yet). When a new page is returned to the end user, after pagination/filtering/ordering even for the same query, a new `search` event with different UserEvent.documents is desired.
|
|
3345
|
+
*/
|
|
3346
|
+
documents?: Schema$GoogleCloudDiscoveryengineV1betaDocumentInfo[];
|
|
3347
|
+
/**
|
|
3348
|
+
* Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened.
|
|
3349
|
+
*/
|
|
3350
|
+
eventTime?: string | null;
|
|
3351
|
+
/**
|
|
3352
|
+
* Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home \> Men \> Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc.
|
|
3353
|
+
*/
|
|
3354
|
+
eventType?: string | null;
|
|
3355
|
+
/**
|
|
3356
|
+
* 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.
|
|
3357
|
+
*/
|
|
3358
|
+
filter?: string | null;
|
|
3359
|
+
/**
|
|
3360
|
+
* Media-specific info.
|
|
3361
|
+
*/
|
|
3362
|
+
mediaInfo?: Schema$GoogleCloudDiscoveryengineV1betaMediaInfo;
|
|
3363
|
+
/**
|
|
3364
|
+
* Page metadata such as categories and other critical information for certain event types such as `view-category-page`.
|
|
3365
|
+
*/
|
|
3366
|
+
pageInfo?: Schema$GoogleCloudDiscoveryengineV1betaPageInfo;
|
|
3367
|
+
/**
|
|
3368
|
+
* Panel metadata associated with this user event.
|
|
3369
|
+
*/
|
|
3370
|
+
panel?: Schema$GoogleCloudDiscoveryengineV1betaPanelInfo;
|
|
3371
|
+
/**
|
|
3372
|
+
* The promotion IDs if this is an event associated with promotions. Currently, this field is restricted to at most one ID.
|
|
3373
|
+
*/
|
|
3374
|
+
promotionIds?: string[] | null;
|
|
3375
|
+
/**
|
|
3376
|
+
* SearchService.Search details related to the event. This field should be set for `search` event.
|
|
3377
|
+
*/
|
|
3378
|
+
searchInfo?: Schema$GoogleCloudDiscoveryengineV1betaSearchInfo;
|
|
3379
|
+
/**
|
|
3380
|
+
* A unique identifier for tracking a visitor session with a length limit of 128 bytes. A session is an aggregation of an end user behavior in a time span. A general guideline to populate the session_id: 1. If user has no activity for 30 min, a new session_id should be assigned. 2. The session_id should be unique across users, suggest use uuid or add UserEvent.user_pseudo_id as prefix.
|
|
3381
|
+
*/
|
|
3382
|
+
sessionId?: string | null;
|
|
3383
|
+
/**
|
|
3384
|
+
* A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups on the customer end.
|
|
3385
|
+
*/
|
|
3386
|
+
tagIds?: string[] | null;
|
|
3387
|
+
/**
|
|
3388
|
+
* The transaction metadata (if any) associated with this user event.
|
|
3389
|
+
*/
|
|
3390
|
+
transactionInfo?: Schema$GoogleCloudDiscoveryengineV1betaTransactionInfo;
|
|
3391
|
+
/**
|
|
3392
|
+
* Information about the end user.
|
|
3393
|
+
*/
|
|
3394
|
+
userInfo?: Schema$GoogleCloudDiscoveryengineV1betaUserInfo;
|
|
3395
|
+
/**
|
|
3396
|
+
* Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. Do not set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. The field should not contain PII or user-data. We recommend to use Google Analytics [Client ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field.
|
|
3397
|
+
*/
|
|
3398
|
+
userPseudoId?: string | null;
|
|
3399
|
+
}
|
|
3400
|
+
/**
|
|
3401
|
+
* Information of an end user.
|
|
3402
|
+
*/
|
|
3403
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaUserInfo {
|
|
3404
|
+
/**
|
|
3405
|
+
* User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set.
|
|
3406
|
+
*/
|
|
3407
|
+
userAgent?: string | null;
|
|
3408
|
+
/**
|
|
3409
|
+
* Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
|
3410
|
+
*/
|
|
3411
|
+
userId?: string | null;
|
|
3412
|
+
}
|
|
3413
|
+
/**
|
|
3414
|
+
* Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3415
|
+
*/
|
|
3416
|
+
export interface Schema$GoogleCloudDiscoveryengineV1CreateDataStoreMetadata {
|
|
3417
|
+
/**
|
|
3418
|
+
* Operation create time.
|
|
3419
|
+
*/
|
|
3420
|
+
createTime?: string | null;
|
|
3421
|
+
/**
|
|
3422
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3423
|
+
*/
|
|
3424
|
+
updateTime?: string | null;
|
|
3425
|
+
}
|
|
3426
|
+
/**
|
|
3427
|
+
* Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3428
|
+
*/
|
|
3429
|
+
export interface Schema$GoogleCloudDiscoveryengineV1CreateEngineMetadata {
|
|
3430
|
+
/**
|
|
3431
|
+
* Operation create time.
|
|
3432
|
+
*/
|
|
3433
|
+
createTime?: string | null;
|
|
3434
|
+
/**
|
|
3435
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3436
|
+
*/
|
|
3437
|
+
updateTime?: string | null;
|
|
3438
|
+
}
|
|
3439
|
+
/**
|
|
3440
|
+
* Metadata for Create Schema LRO.
|
|
3441
|
+
*/
|
|
3442
|
+
export interface Schema$GoogleCloudDiscoveryengineV1CreateSchemaMetadata {
|
|
3443
|
+
/**
|
|
3444
|
+
* Operation create time.
|
|
3445
|
+
*/
|
|
3446
|
+
createTime?: string | null;
|
|
3447
|
+
/**
|
|
3448
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3449
|
+
*/
|
|
3450
|
+
updateTime?: string | null;
|
|
3451
|
+
}
|
|
3452
|
+
/**
|
|
3453
|
+
* Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3454
|
+
*/
|
|
3455
|
+
export interface Schema$GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata {
|
|
3456
|
+
/**
|
|
3457
|
+
* Operation create time.
|
|
3458
|
+
*/
|
|
3459
|
+
createTime?: string | null;
|
|
3460
|
+
/**
|
|
3461
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3462
|
+
*/
|
|
3463
|
+
updateTime?: string | null;
|
|
3464
|
+
}
|
|
3465
|
+
/**
|
|
3466
|
+
* DataStore captures global settings and configs at the DataStore level.
|
|
3467
|
+
*/
|
|
3468
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DataStore {
|
|
3469
|
+
/**
|
|
3470
|
+
* Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
|
|
3471
|
+
*/
|
|
3472
|
+
contentConfig?: string | null;
|
|
3473
|
+
/**
|
|
3474
|
+
* Output only. Timestamp the DataStore was created at.
|
|
3475
|
+
*/
|
|
3476
|
+
createTime?: string | null;
|
|
3477
|
+
/**
|
|
3478
|
+
* Output only. The id of the default Schema asscociated to this data store.
|
|
3479
|
+
*/
|
|
3480
|
+
defaultSchemaId?: string | null;
|
|
3481
|
+
/**
|
|
3482
|
+
* 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.
|
|
3483
|
+
*/
|
|
3484
|
+
displayName?: string | null;
|
|
3485
|
+
/**
|
|
3486
|
+
* Immutable. The industry vertical that the data store registers.
|
|
3487
|
+
*/
|
|
3488
|
+
industryVertical?: string | null;
|
|
3489
|
+
/**
|
|
3490
|
+
* 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.
|
|
3491
|
+
*/
|
|
3492
|
+
name?: string | null;
|
|
3493
|
+
/**
|
|
3494
|
+
* 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.
|
|
3495
|
+
*/
|
|
3496
|
+
solutionTypes?: string[] | null;
|
|
3497
|
+
}
|
|
3498
|
+
/**
|
|
3499
|
+
* Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3500
|
+
*/
|
|
3501
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata {
|
|
3502
|
+
/**
|
|
3503
|
+
* Operation create time.
|
|
3504
|
+
*/
|
|
3505
|
+
createTime?: string | null;
|
|
3506
|
+
/**
|
|
3507
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3508
|
+
*/
|
|
3509
|
+
updateTime?: string | null;
|
|
3510
|
+
}
|
|
3511
|
+
/**
|
|
3512
|
+
* Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3513
|
+
*/
|
|
3514
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DeleteEngineMetadata {
|
|
3515
|
+
/**
|
|
3516
|
+
* Operation create time.
|
|
3517
|
+
*/
|
|
3518
|
+
createTime?: string | null;
|
|
3519
|
+
/**
|
|
3520
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3521
|
+
*/
|
|
3522
|
+
updateTime?: string | null;
|
|
3523
|
+
}
|
|
3524
|
+
/**
|
|
3525
|
+
* Metadata for DeleteSchema LRO.
|
|
3526
|
+
*/
|
|
3527
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DeleteSchemaMetadata {
|
|
3528
|
+
/**
|
|
3529
|
+
* Operation create time.
|
|
3530
|
+
*/
|
|
3531
|
+
createTime?: string | null;
|
|
3532
|
+
/**
|
|
3533
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3534
|
+
*/
|
|
3535
|
+
updateTime?: string | null;
|
|
3536
|
+
}
|
|
3537
|
+
/**
|
|
3538
|
+
* Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3539
|
+
*/
|
|
3540
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata {
|
|
3541
|
+
/**
|
|
3542
|
+
* Operation create time.
|
|
3543
|
+
*/
|
|
3544
|
+
createTime?: string | null;
|
|
3545
|
+
/**
|
|
3546
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3547
|
+
*/
|
|
3548
|
+
updateTime?: string | null;
|
|
3549
|
+
}
|
|
3550
|
+
/**
|
|
3551
|
+
* Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3552
|
+
*/
|
|
3553
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata {
|
|
3554
|
+
/**
|
|
3555
|
+
* Operation create time.
|
|
3556
|
+
*/
|
|
3557
|
+
createTime?: string | null;
|
|
3558
|
+
/**
|
|
3559
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3560
|
+
*/
|
|
3561
|
+
updateTime?: string | null;
|
|
3562
|
+
}
|
|
3563
|
+
/**
|
|
3564
|
+
* Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.
|
|
3565
|
+
*/
|
|
3566
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse {
|
|
3567
|
+
}
|
|
3568
|
+
/**
|
|
3569
|
+
* Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3570
|
+
*/
|
|
3571
|
+
export interface Schema$GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata {
|
|
3572
|
+
/**
|
|
3573
|
+
* Operation create time.
|
|
3574
|
+
*/
|
|
3575
|
+
createTime?: string | null;
|
|
3576
|
+
/**
|
|
3577
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3578
|
+
*/
|
|
3579
|
+
updateTime?: string | null;
|
|
3580
|
+
}
|
|
3581
|
+
/**
|
|
3582
|
+
* Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.
|
|
3583
|
+
*/
|
|
3584
|
+
export interface Schema$GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchResponse {
|
|
3585
|
+
}
|
|
3586
|
+
/**
|
|
3587
|
+
* Metadata that describes the training and serving parameters of an Engine.
|
|
3588
|
+
*/
|
|
3589
|
+
export interface Schema$GoogleCloudDiscoveryengineV1Engine {
|
|
3590
|
+
/**
|
|
3591
|
+
* Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
|
|
3592
|
+
*/
|
|
3593
|
+
chatEngineConfig?: Schema$GoogleCloudDiscoveryengineV1EngineChatEngineConfig;
|
|
2489
3594
|
/**
|
|
2490
|
-
*
|
|
3595
|
+
* Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
|
|
2491
3596
|
*/
|
|
2492
|
-
|
|
3597
|
+
chatEngineMetadata?: Schema$GoogleCloudDiscoveryengineV1EngineChatEngineMetadata;
|
|
2493
3598
|
/**
|
|
2494
|
-
*
|
|
3599
|
+
* Common config spec that specifies the metadata of the engine.
|
|
2495
3600
|
*/
|
|
2496
|
-
|
|
3601
|
+
commonConfig?: Schema$GoogleCloudDiscoveryengineV1EngineCommonConfig;
|
|
2497
3602
|
/**
|
|
2498
|
-
*
|
|
3603
|
+
* Output only. Timestamp the Recommendation Engine was created at.
|
|
2499
3604
|
*/
|
|
2500
|
-
|
|
3605
|
+
createTime?: string | null;
|
|
2501
3606
|
/**
|
|
2502
|
-
*
|
|
3607
|
+
* 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.
|
|
2503
3608
|
*/
|
|
2504
|
-
|
|
3609
|
+
dataStoreIds?: string[] | null;
|
|
2505
3610
|
/**
|
|
2506
|
-
* Required.
|
|
3611
|
+
* Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
|
|
2507
3612
|
*/
|
|
2508
|
-
|
|
3613
|
+
displayName?: string | null;
|
|
2509
3614
|
/**
|
|
2510
|
-
* The
|
|
3615
|
+
* 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.
|
|
2511
3616
|
*/
|
|
2512
|
-
|
|
3617
|
+
industryVertical?: string | null;
|
|
2513
3618
|
/**
|
|
2514
|
-
*
|
|
3619
|
+
* 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.
|
|
2515
3620
|
*/
|
|
2516
|
-
|
|
3621
|
+
name?: string | null;
|
|
2517
3622
|
/**
|
|
2518
|
-
*
|
|
3623
|
+
* Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
|
|
2519
3624
|
*/
|
|
2520
|
-
|
|
3625
|
+
searchEngineConfig?: Schema$GoogleCloudDiscoveryengineV1EngineSearchEngineConfig;
|
|
2521
3626
|
/**
|
|
2522
|
-
*
|
|
3627
|
+
* Required. The solutions of the engine.
|
|
2523
3628
|
*/
|
|
2524
|
-
|
|
3629
|
+
solutionType?: string | null;
|
|
2525
3630
|
/**
|
|
2526
|
-
*
|
|
3631
|
+
* Output only. Timestamp the Recommendation Engine was last updated.
|
|
2527
3632
|
*/
|
|
2528
|
-
|
|
3633
|
+
updateTime?: string | null;
|
|
3634
|
+
}
|
|
3635
|
+
/**
|
|
3636
|
+
* Configurations for a Chat Engine.
|
|
3637
|
+
*/
|
|
3638
|
+
export interface Schema$GoogleCloudDiscoveryengineV1EngineChatEngineConfig {
|
|
2529
3639
|
/**
|
|
2530
|
-
*
|
|
3640
|
+
* 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.
|
|
2531
3641
|
*/
|
|
2532
|
-
|
|
3642
|
+
agentCreationConfig?: Schema$GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig;
|
|
2533
3643
|
/**
|
|
2534
|
-
*
|
|
3644
|
+
* 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.
|
|
2535
3645
|
*/
|
|
2536
|
-
|
|
3646
|
+
dialogflowAgentToLink?: string | null;
|
|
3647
|
+
}
|
|
3648
|
+
/**
|
|
3649
|
+
* 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.
|
|
3650
|
+
*/
|
|
3651
|
+
export interface Schema$GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig {
|
|
2537
3652
|
/**
|
|
2538
|
-
*
|
|
3653
|
+
* Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.
|
|
2539
3654
|
*/
|
|
2540
|
-
|
|
3655
|
+
business?: string | null;
|
|
2541
3656
|
/**
|
|
2542
|
-
* The
|
|
3657
|
+
* 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.
|
|
2543
3658
|
*/
|
|
2544
|
-
|
|
3659
|
+
defaultLanguageCode?: string | null;
|
|
2545
3660
|
/**
|
|
2546
|
-
*
|
|
3661
|
+
* 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.
|
|
2547
3662
|
*/
|
|
2548
|
-
|
|
3663
|
+
location?: string | null;
|
|
2549
3664
|
/**
|
|
2550
|
-
* Required.
|
|
3665
|
+
* 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.
|
|
2551
3666
|
*/
|
|
2552
|
-
|
|
3667
|
+
timeZone?: string | null;
|
|
2553
3668
|
}
|
|
2554
3669
|
/**
|
|
2555
|
-
*
|
|
3670
|
+
* Additional information of a Chat Engine. Fields in this message are output only.
|
|
2556
3671
|
*/
|
|
2557
|
-
export interface Schema$
|
|
2558
|
-
/**
|
|
2559
|
-
* User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set.
|
|
2560
|
-
*/
|
|
2561
|
-
userAgent?: string | null;
|
|
3672
|
+
export interface Schema$GoogleCloudDiscoveryengineV1EngineChatEngineMetadata {
|
|
2562
3673
|
/**
|
|
2563
|
-
*
|
|
3674
|
+
* The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.
|
|
2564
3675
|
*/
|
|
2565
|
-
|
|
3676
|
+
dialogflowAgent?: string | null;
|
|
2566
3677
|
}
|
|
2567
3678
|
/**
|
|
2568
|
-
*
|
|
3679
|
+
* Common configurations for an Engine.
|
|
2569
3680
|
*/
|
|
2570
|
-
export interface Schema$
|
|
2571
|
-
/**
|
|
2572
|
-
* Operation create time.
|
|
2573
|
-
*/
|
|
2574
|
-
createTime?: string | null;
|
|
3681
|
+
export interface Schema$GoogleCloudDiscoveryengineV1EngineCommonConfig {
|
|
2575
3682
|
/**
|
|
2576
|
-
*
|
|
3683
|
+
* Immutable. The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.
|
|
2577
3684
|
*/
|
|
2578
|
-
|
|
3685
|
+
companyName?: string | null;
|
|
2579
3686
|
}
|
|
2580
3687
|
/**
|
|
2581
|
-
*
|
|
3688
|
+
* Configurations for a Search Engine.
|
|
2582
3689
|
*/
|
|
2583
|
-
export interface Schema$
|
|
3690
|
+
export interface Schema$GoogleCloudDiscoveryengineV1EngineSearchEngineConfig {
|
|
2584
3691
|
/**
|
|
2585
|
-
*
|
|
3692
|
+
* The add-on that this search engine enables.
|
|
2586
3693
|
*/
|
|
2587
|
-
|
|
3694
|
+
searchAddOns?: string[] | null;
|
|
2588
3695
|
/**
|
|
2589
|
-
*
|
|
3696
|
+
* 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.
|
|
2590
3697
|
*/
|
|
2591
|
-
|
|
3698
|
+
searchTier?: string | null;
|
|
2592
3699
|
}
|
|
2593
3700
|
/**
|
|
2594
3701
|
* Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
@@ -2633,6 +3740,36 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2633
3740
|
*/
|
|
2634
3741
|
gcsPrefix?: string | null;
|
|
2635
3742
|
}
|
|
3743
|
+
/**
|
|
3744
|
+
* Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
3745
|
+
*/
|
|
3746
|
+
export interface Schema$GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesMetadata {
|
|
3747
|
+
/**
|
|
3748
|
+
* Operation create time.
|
|
3749
|
+
*/
|
|
3750
|
+
createTime?: string | null;
|
|
3751
|
+
/**
|
|
3752
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3753
|
+
*/
|
|
3754
|
+
updateTime?: string | null;
|
|
3755
|
+
}
|
|
3756
|
+
/**
|
|
3757
|
+
* Response message for CompletionService.ImportSuggestionDenyListEntries method.
|
|
3758
|
+
*/
|
|
3759
|
+
export interface Schema$GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesResponse {
|
|
3760
|
+
/**
|
|
3761
|
+
* A sample of errors encountered while processing the request.
|
|
3762
|
+
*/
|
|
3763
|
+
errorSamples?: Schema$GoogleRpcStatus[];
|
|
3764
|
+
/**
|
|
3765
|
+
* Count of deny list entries that failed to be imported.
|
|
3766
|
+
*/
|
|
3767
|
+
failedEntriesCount?: string | null;
|
|
3768
|
+
/**
|
|
3769
|
+
* Count of deny list entries successfully imported.
|
|
3770
|
+
*/
|
|
3771
|
+
importedEntriesCount?: string | null;
|
|
3772
|
+
}
|
|
2636
3773
|
/**
|
|
2637
3774
|
* Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
2638
3775
|
*/
|
|
@@ -2709,6 +3846,32 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2709
3846
|
*/
|
|
2710
3847
|
purgeSample?: string[] | null;
|
|
2711
3848
|
}
|
|
3849
|
+
/**
|
|
3850
|
+
* Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
3851
|
+
*/
|
|
3852
|
+
export interface Schema$GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata {
|
|
3853
|
+
/**
|
|
3854
|
+
* Operation create time.
|
|
3855
|
+
*/
|
|
3856
|
+
createTime?: string | null;
|
|
3857
|
+
/**
|
|
3858
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3859
|
+
*/
|
|
3860
|
+
updateTime?: string | null;
|
|
3861
|
+
}
|
|
3862
|
+
/**
|
|
3863
|
+
* Response message for CompletionService.PurgeSuggestionDenyListEntries method.
|
|
3864
|
+
*/
|
|
3865
|
+
export interface Schema$GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesResponse {
|
|
3866
|
+
/**
|
|
3867
|
+
* A sample of errors encountered while processing the request.
|
|
3868
|
+
*/
|
|
3869
|
+
errorSamples?: Schema$GoogleRpcStatus[];
|
|
3870
|
+
/**
|
|
3871
|
+
* Number of suggestion deny list entries purged.
|
|
3872
|
+
*/
|
|
3873
|
+
purgeCount?: string | null;
|
|
3874
|
+
}
|
|
2712
3875
|
/**
|
|
2713
3876
|
* Defines the structure and layout of a type of document data.
|
|
2714
3877
|
*/
|
|
@@ -2728,6 +3891,75 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2728
3891
|
[key: string]: any;
|
|
2729
3892
|
} | null;
|
|
2730
3893
|
}
|
|
3894
|
+
/**
|
|
3895
|
+
* Verification information for target sites in advanced site search.
|
|
3896
|
+
*/
|
|
3897
|
+
export interface Schema$GoogleCloudDiscoveryengineV1SiteVerificationInfo {
|
|
3898
|
+
/**
|
|
3899
|
+
* Site verification state indicating the ownership and validity.
|
|
3900
|
+
*/
|
|
3901
|
+
siteVerificationState?: string | null;
|
|
3902
|
+
/**
|
|
3903
|
+
* Latest site verification time.
|
|
3904
|
+
*/
|
|
3905
|
+
verifyTime?: string | null;
|
|
3906
|
+
}
|
|
3907
|
+
/**
|
|
3908
|
+
* A target site for the SiteSearchEngine.
|
|
3909
|
+
*/
|
|
3910
|
+
export interface Schema$GoogleCloudDiscoveryengineV1TargetSite {
|
|
3911
|
+
/**
|
|
3912
|
+
* 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.
|
|
3913
|
+
*/
|
|
3914
|
+
exactMatch?: boolean | null;
|
|
3915
|
+
/**
|
|
3916
|
+
* Output only. Failure reason.
|
|
3917
|
+
*/
|
|
3918
|
+
failureReason?: Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReason;
|
|
3919
|
+
/**
|
|
3920
|
+
* Output only. This is system-generated based on the provided_uri_pattern.
|
|
3921
|
+
*/
|
|
3922
|
+
generatedUriPattern?: string | null;
|
|
3923
|
+
/**
|
|
3924
|
+
* Output only. Indexing status.
|
|
3925
|
+
*/
|
|
3926
|
+
indexingStatus?: string | null;
|
|
3927
|
+
/**
|
|
3928
|
+
* 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.
|
|
3929
|
+
*/
|
|
3930
|
+
name?: string | null;
|
|
3931
|
+
/**
|
|
3932
|
+
* Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated.
|
|
3933
|
+
*/
|
|
3934
|
+
providedUriPattern?: string | null;
|
|
3935
|
+
/**
|
|
3936
|
+
* Output only. Site ownership and validity verification status.
|
|
3937
|
+
*/
|
|
3938
|
+
siteVerificationInfo?: Schema$GoogleCloudDiscoveryengineV1SiteVerificationInfo;
|
|
3939
|
+
/**
|
|
3940
|
+
* The type of the target site, e.g., whether the site is to be included or excluded.
|
|
3941
|
+
*/
|
|
3942
|
+
type?: string | null;
|
|
3943
|
+
/**
|
|
3944
|
+
* Output only. The target site's last updated time.
|
|
3945
|
+
*/
|
|
3946
|
+
updateTime?: string | null;
|
|
3947
|
+
}
|
|
3948
|
+
/**
|
|
3949
|
+
* Site search indexing failure reasons.
|
|
3950
|
+
*/
|
|
3951
|
+
export interface Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReason {
|
|
3952
|
+
/**
|
|
3953
|
+
* Failed due to insufficient quota.
|
|
3954
|
+
*/
|
|
3955
|
+
quotaFailure?: Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure;
|
|
3956
|
+
}
|
|
3957
|
+
export interface Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure {
|
|
3958
|
+
/**
|
|
3959
|
+
* This number is an estimation on how much total quota this project needs to successfully complete indexing.
|
|
3960
|
+
*/
|
|
3961
|
+
totalRequiredQuota?: string | null;
|
|
3962
|
+
}
|
|
2731
3963
|
/**
|
|
2732
3964
|
* Metadata for UpdateSchema LRO.
|
|
2733
3965
|
*/
|
|
@@ -2741,6 +3973,19 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2741
3973
|
*/
|
|
2742
3974
|
updateTime?: string | null;
|
|
2743
3975
|
}
|
|
3976
|
+
/**
|
|
3977
|
+
* Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3978
|
+
*/
|
|
3979
|
+
export interface Schema$GoogleCloudDiscoveryengineV1UpdateTargetSiteMetadata {
|
|
3980
|
+
/**
|
|
3981
|
+
* Operation create time.
|
|
3982
|
+
*/
|
|
3983
|
+
createTime?: string | null;
|
|
3984
|
+
/**
|
|
3985
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3986
|
+
*/
|
|
3987
|
+
updateTime?: string | null;
|
|
3988
|
+
}
|
|
2744
3989
|
/**
|
|
2745
3990
|
* The response message for Operations.ListOperations.
|
|
2746
3991
|
*/
|
|
@@ -2915,22 +4160,107 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2915
4160
|
schemas: Resource$Projects$Locations$Collections$Datastores$Schemas;
|
|
2916
4161
|
servingConfigs: Resource$Projects$Locations$Collections$Datastores$Servingconfigs;
|
|
2917
4162
|
siteSearchEngine: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine;
|
|
4163
|
+
suggestionDenyListEntries: Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries;
|
|
2918
4164
|
userEvents: Resource$Projects$Locations$Collections$Datastores$Userevents;
|
|
2919
4165
|
constructor(context: APIRequestContext);
|
|
2920
4166
|
/**
|
|
2921
|
-
* Completes the specified user input with keyword suggestions.
|
|
4167
|
+
* Completes the specified user input with keyword suggestions.
|
|
4168
|
+
*
|
|
4169
|
+
* @param params - Parameters for request
|
|
4170
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
4171
|
+
* @param callback - Optional callback that handles the response.
|
|
4172
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
4173
|
+
*/
|
|
4174
|
+
completeQuery(params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
4175
|
+
completeQuery(params?: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaCompleteQueryResponse>;
|
|
4176
|
+
completeQuery(params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
4177
|
+
completeQuery(params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaCompleteQueryResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaCompleteQueryResponse>): void;
|
|
4178
|
+
completeQuery(params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaCompleteQueryResponse>): void;
|
|
4179
|
+
completeQuery(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaCompleteQueryResponse>): void;
|
|
4180
|
+
/**
|
|
4181
|
+
* Creates a DataStore. DataStore is for storing Documents. To serve these documents for Search, or Recommendation use case, an Engine needs to be created separately.
|
|
4182
|
+
*
|
|
4183
|
+
* @param params - Parameters for request
|
|
4184
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
4185
|
+
* @param callback - Optional callback that handles the response.
|
|
4186
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
4187
|
+
*/
|
|
4188
|
+
create(params: Params$Resource$Projects$Locations$Collections$Datastores$Create, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
4189
|
+
create(params?: Params$Resource$Projects$Locations$Collections$Datastores$Create, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
4190
|
+
create(params: Params$Resource$Projects$Locations$Collections$Datastores$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
4191
|
+
create(params: Params$Resource$Projects$Locations$Collections$Datastores$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
4192
|
+
create(params: Params$Resource$Projects$Locations$Collections$Datastores$Create, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
4193
|
+
create(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
4194
|
+
/**
|
|
4195
|
+
* Deletes a DataStore.
|
|
4196
|
+
*
|
|
4197
|
+
* @param params - Parameters for request
|
|
4198
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
4199
|
+
* @param callback - Optional callback that handles the response.
|
|
4200
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
4201
|
+
*/
|
|
4202
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Datastores$Delete, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
4203
|
+
delete(params?: Params$Resource$Projects$Locations$Collections$Datastores$Delete, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
4204
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Datastores$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
4205
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Datastores$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
4206
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Datastores$Delete, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
4207
|
+
delete(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
4208
|
+
/**
|
|
4209
|
+
* Gets a DataStore.
|
|
4210
|
+
*
|
|
4211
|
+
* @param params - Parameters for request
|
|
4212
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
4213
|
+
* @param callback - Optional callback that handles the response.
|
|
4214
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
4215
|
+
*/
|
|
4216
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
4217
|
+
get(params?: Params$Resource$Projects$Locations$Collections$Datastores$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaDataStore>;
|
|
4218
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
4219
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaDataStore>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaDataStore>): void;
|
|
4220
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaDataStore>): void;
|
|
4221
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaDataStore>): void;
|
|
4222
|
+
/**
|
|
4223
|
+
* Gets the SiteSearchEngine.
|
|
4224
|
+
*
|
|
4225
|
+
* @param params - Parameters for request
|
|
4226
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
4227
|
+
* @param callback - Optional callback that handles the response.
|
|
4228
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
4229
|
+
*/
|
|
4230
|
+
getSiteSearchEngine(params: Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
4231
|
+
getSiteSearchEngine(params?: Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaSiteSearchEngine>;
|
|
4232
|
+
getSiteSearchEngine(params: Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
4233
|
+
getSiteSearchEngine(params: Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSiteSearchEngine>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSiteSearchEngine>): void;
|
|
4234
|
+
getSiteSearchEngine(params: Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSiteSearchEngine>): void;
|
|
4235
|
+
getSiteSearchEngine(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSiteSearchEngine>): void;
|
|
4236
|
+
/**
|
|
4237
|
+
* Lists all the DataStores associated with the project.
|
|
4238
|
+
*
|
|
4239
|
+
* @param params - Parameters for request
|
|
4240
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
4241
|
+
* @param callback - Optional callback that handles the response.
|
|
4242
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
4243
|
+
*/
|
|
4244
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
4245
|
+
list(params?: Params$Resource$Projects$Locations$Collections$Datastores$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaListDataStoresResponse>;
|
|
4246
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
4247
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListDataStoresResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListDataStoresResponse>): void;
|
|
4248
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListDataStoresResponse>): void;
|
|
4249
|
+
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListDataStoresResponse>): void;
|
|
4250
|
+
/**
|
|
4251
|
+
* Updates a DataStore
|
|
2922
4252
|
*
|
|
2923
4253
|
* @param params - Parameters for request
|
|
2924
4254
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
2925
4255
|
* @param callback - Optional callback that handles the response.
|
|
2926
4256
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
2927
4257
|
*/
|
|
2928
|
-
|
|
2929
|
-
|
|
2930
|
-
|
|
2931
|
-
|
|
2932
|
-
|
|
2933
|
-
|
|
4258
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
4259
|
+
patch(params?: Params$Resource$Projects$Locations$Collections$Datastores$Patch, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaDataStore>;
|
|
4260
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
4261
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaDataStore>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaDataStore>): void;
|
|
4262
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaDataStore>): void;
|
|
4263
|
+
patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaDataStore>): void;
|
|
2934
4264
|
}
|
|
2935
4265
|
export interface Params$Resource$Projects$Locations$Collections$Datastores$Completequery extends StandardParameters {
|
|
2936
4266
|
/**
|
|
@@ -2946,7 +4276,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2946
4276
|
*/
|
|
2947
4277
|
query?: string;
|
|
2948
4278
|
/**
|
|
2949
|
-
*
|
|
4279
|
+
* 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.
|
|
2950
4280
|
*/
|
|
2951
4281
|
queryModel?: string;
|
|
2952
4282
|
/**
|
|
@@ -2954,6 +4284,74 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2954
4284
|
*/
|
|
2955
4285
|
userPseudoId?: string;
|
|
2956
4286
|
}
|
|
4287
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Create extends StandardParameters {
|
|
4288
|
+
/**
|
|
4289
|
+
* A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored.
|
|
4290
|
+
*/
|
|
4291
|
+
createAdvancedSiteSearch?: boolean;
|
|
4292
|
+
/**
|
|
4293
|
+
* Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
|
4294
|
+
*/
|
|
4295
|
+
dataStoreId?: string;
|
|
4296
|
+
/**
|
|
4297
|
+
* Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}`.
|
|
4298
|
+
*/
|
|
4299
|
+
parent?: string;
|
|
4300
|
+
/**
|
|
4301
|
+
* Request body metadata
|
|
4302
|
+
*/
|
|
4303
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaDataStore;
|
|
4304
|
+
}
|
|
4305
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Delete extends StandardParameters {
|
|
4306
|
+
/**
|
|
4307
|
+
* Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to delete the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the DataStore to delete does not exist, a NOT_FOUND error is returned.
|
|
4308
|
+
*/
|
|
4309
|
+
name?: string;
|
|
4310
|
+
}
|
|
4311
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Get extends StandardParameters {
|
|
4312
|
+
/**
|
|
4313
|
+
* Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned.
|
|
4314
|
+
*/
|
|
4315
|
+
name?: string;
|
|
4316
|
+
}
|
|
4317
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine extends StandardParameters {
|
|
4318
|
+
/**
|
|
4319
|
+
* Required. Resource name of SiteSearchEngine, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. If the caller does not have permission to access the [SiteSearchEngine], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.
|
|
4320
|
+
*/
|
|
4321
|
+
name?: string;
|
|
4322
|
+
}
|
|
4323
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$List extends StandardParameters {
|
|
4324
|
+
/**
|
|
4325
|
+
* Filter by solution type. For example: filter = 'solution_type:SOLUTION_TYPE_SEARCH'
|
|
4326
|
+
*/
|
|
4327
|
+
filter?: string;
|
|
4328
|
+
/**
|
|
4329
|
+
* Maximum number of DataStores to return. If unspecified, defaults to 10. The maximum allowed value is 50. Values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT is returned.
|
|
4330
|
+
*/
|
|
4331
|
+
pageSize?: number;
|
|
4332
|
+
/**
|
|
4333
|
+
* A page token ListDataStoresResponse.next_page_token, received from a previous DataStoreService.ListDataStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DataStoreService.ListDataStores must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.
|
|
4334
|
+
*/
|
|
4335
|
+
pageToken?: string;
|
|
4336
|
+
/**
|
|
4337
|
+
* 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.
|
|
4338
|
+
*/
|
|
4339
|
+
parent?: string;
|
|
4340
|
+
}
|
|
4341
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Patch extends StandardParameters {
|
|
4342
|
+
/**
|
|
4343
|
+
* 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.
|
|
4344
|
+
*/
|
|
4345
|
+
name?: string;
|
|
4346
|
+
/**
|
|
4347
|
+
* Indicates which fields in the provided DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.
|
|
4348
|
+
*/
|
|
4349
|
+
updateMask?: string;
|
|
4350
|
+
/**
|
|
4351
|
+
* Request body metadata
|
|
4352
|
+
*/
|
|
4353
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaDataStore;
|
|
4354
|
+
}
|
|
2957
4355
|
export class Resource$Projects$Locations$Collections$Datastores$Branches {
|
|
2958
4356
|
context: APIRequestContext;
|
|
2959
4357
|
documents: Resource$Projects$Locations$Collections$Datastores$Branches$Documents;
|
|
@@ -3340,7 +4738,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
3340
4738
|
*/
|
|
3341
4739
|
name?: string;
|
|
3342
4740
|
/**
|
|
3343
|
-
* Indicates which fields in the provided Conversation to update. The following are NOT supported: *
|
|
4741
|
+
* 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.
|
|
3344
4742
|
*/
|
|
3345
4743
|
updateMask?: string;
|
|
3346
4744
|
/**
|
|
@@ -3653,6 +5051,48 @@ export declare namespace discoveryengine_v1beta {
|
|
|
3653
5051
|
export class Resource$Projects$Locations$Collections$Datastores$Servingconfigs {
|
|
3654
5052
|
context: APIRequestContext;
|
|
3655
5053
|
constructor(context: APIRequestContext);
|
|
5054
|
+
/**
|
|
5055
|
+
* Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
|
|
5056
|
+
*
|
|
5057
|
+
* @param params - Parameters for request
|
|
5058
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5059
|
+
* @param callback - Optional callback that handles the response.
|
|
5060
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5061
|
+
*/
|
|
5062
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
5063
|
+
get(params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>;
|
|
5064
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
5065
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
5066
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
5067
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
5068
|
+
/**
|
|
5069
|
+
* Lists all ServingConfigs linked to this dataStore.
|
|
5070
|
+
*
|
|
5071
|
+
* @param params - Parameters for request
|
|
5072
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5073
|
+
* @param callback - Optional callback that handles the response.
|
|
5074
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5075
|
+
*/
|
|
5076
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
5077
|
+
list(params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>;
|
|
5078
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
5079
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>): void;
|
|
5080
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>): void;
|
|
5081
|
+
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>): void;
|
|
5082
|
+
/**
|
|
5083
|
+
* Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
|
|
5084
|
+
*
|
|
5085
|
+
* @param params - Parameters for request
|
|
5086
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5087
|
+
* @param callback - Optional callback that handles the response.
|
|
5088
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5089
|
+
*/
|
|
5090
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
5091
|
+
patch(params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>;
|
|
5092
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
5093
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
5094
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
5095
|
+
patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
3656
5096
|
/**
|
|
3657
5097
|
* Makes a recommendation, which requires a contextual user event.
|
|
3658
5098
|
*
|
|
@@ -3682,9 +5122,43 @@ export declare namespace discoveryengine_v1beta {
|
|
|
3682
5122
|
search(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSearchResponse>): void;
|
|
3683
5123
|
search(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSearchResponse>): void;
|
|
3684
5124
|
}
|
|
5125
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get extends StandardParameters {
|
|
5126
|
+
/**
|
|
5127
|
+
* Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/servingConfigs/{serving_config_id\}`
|
|
5128
|
+
*/
|
|
5129
|
+
name?: string;
|
|
5130
|
+
}
|
|
5131
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List extends StandardParameters {
|
|
5132
|
+
/**
|
|
5133
|
+
* 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.
|
|
5134
|
+
*/
|
|
5135
|
+
pageSize?: number;
|
|
5136
|
+
/**
|
|
5137
|
+
* Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.
|
|
5138
|
+
*/
|
|
5139
|
+
pageToken?: string;
|
|
5140
|
+
/**
|
|
5141
|
+
* Required. The dataStore resource name. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`
|
|
5142
|
+
*/
|
|
5143
|
+
parent?: string;
|
|
5144
|
+
}
|
|
5145
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch extends StandardParameters {
|
|
5146
|
+
/**
|
|
5147
|
+
* Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}`
|
|
5148
|
+
*/
|
|
5149
|
+
name?: string;
|
|
5150
|
+
/**
|
|
5151
|
+
* Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated.
|
|
5152
|
+
*/
|
|
5153
|
+
updateMask?: string;
|
|
5154
|
+
/**
|
|
5155
|
+
* Request body metadata
|
|
5156
|
+
*/
|
|
5157
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaServingConfig;
|
|
5158
|
+
}
|
|
3685
5159
|
export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend extends StandardParameters {
|
|
3686
5160
|
/**
|
|
3687
|
-
* 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.
|
|
5161
|
+
* 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.
|
|
3688
5162
|
*/
|
|
3689
5163
|
servingConfig?: string;
|
|
3690
5164
|
/**
|
|
@@ -3707,67 +5181,331 @@ export declare namespace discoveryengine_v1beta {
|
|
|
3707
5181
|
operations: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations;
|
|
3708
5182
|
targetSites: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites;
|
|
3709
5183
|
constructor(context: APIRequestContext);
|
|
5184
|
+
/**
|
|
5185
|
+
* Verify target sites' ownership and validity. This API sends all the target sites under site search engine for verification.
|
|
5186
|
+
*
|
|
5187
|
+
* @param params - Parameters for request
|
|
5188
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5189
|
+
* @param callback - Optional callback that handles the response.
|
|
5190
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5191
|
+
*/
|
|
5192
|
+
batchVerifyTargetSites(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
5193
|
+
batchVerifyTargetSites(params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
5194
|
+
batchVerifyTargetSites(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
5195
|
+
batchVerifyTargetSites(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5196
|
+
batchVerifyTargetSites(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5197
|
+
batchVerifyTargetSites(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5198
|
+
/**
|
|
5199
|
+
* Downgrade from advanced site search to basic site search.
|
|
5200
|
+
*
|
|
5201
|
+
* @param params - Parameters for request
|
|
5202
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5203
|
+
* @param callback - Optional callback that handles the response.
|
|
5204
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5205
|
+
*/
|
|
5206
|
+
disableAdvancedSiteSearch(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
5207
|
+
disableAdvancedSiteSearch(params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
5208
|
+
disableAdvancedSiteSearch(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
5209
|
+
disableAdvancedSiteSearch(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5210
|
+
disableAdvancedSiteSearch(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5211
|
+
disableAdvancedSiteSearch(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5212
|
+
/**
|
|
5213
|
+
* Upgrade from basic site search to advanced site search.
|
|
5214
|
+
*
|
|
5215
|
+
* @param params - Parameters for request
|
|
5216
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5217
|
+
* @param callback - Optional callback that handles the response.
|
|
5218
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5219
|
+
*/
|
|
5220
|
+
enableAdvancedSiteSearch(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
5221
|
+
enableAdvancedSiteSearch(params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
5222
|
+
enableAdvancedSiteSearch(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
5223
|
+
enableAdvancedSiteSearch(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5224
|
+
enableAdvancedSiteSearch(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5225
|
+
enableAdvancedSiteSearch(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5226
|
+
/**
|
|
5227
|
+
* Returns list of target sites with its domain verification status. This method can only be called under data store with BASIC_SITE_SEARCH state at the moment.
|
|
5228
|
+
*
|
|
5229
|
+
* @param params - Parameters for request
|
|
5230
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5231
|
+
* @param callback - Optional callback that handles the response.
|
|
5232
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5233
|
+
*/
|
|
5234
|
+
fetchDomainVerificationStatus(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
5235
|
+
fetchDomainVerificationStatus(params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaFetchDomainVerificationStatusResponse>;
|
|
5236
|
+
fetchDomainVerificationStatus(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
5237
|
+
fetchDomainVerificationStatus(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaFetchDomainVerificationStatusResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaFetchDomainVerificationStatusResponse>): void;
|
|
5238
|
+
fetchDomainVerificationStatus(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaFetchDomainVerificationStatusResponse>): void;
|
|
5239
|
+
fetchDomainVerificationStatus(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaFetchDomainVerificationStatusResponse>): void;
|
|
5240
|
+
/**
|
|
5241
|
+
* Request on-demand recrawl for a list of URIs.
|
|
5242
|
+
*
|
|
5243
|
+
* @param params - Parameters for request
|
|
5244
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5245
|
+
* @param callback - Optional callback that handles the response.
|
|
5246
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5247
|
+
*/
|
|
5248
|
+
recrawlUris(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
5249
|
+
recrawlUris(params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
5250
|
+
recrawlUris(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
5251
|
+
recrawlUris(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5252
|
+
recrawlUris(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5253
|
+
recrawlUris(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5254
|
+
}
|
|
5255
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites extends StandardParameters {
|
|
5256
|
+
/**
|
|
5257
|
+
* Required. The parent resource shared by all TargetSites being verified. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`.
|
|
5258
|
+
*/
|
|
5259
|
+
parent?: string;
|
|
5260
|
+
/**
|
|
5261
|
+
* Request body metadata
|
|
5262
|
+
*/
|
|
5263
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaBatchVerifyTargetSitesRequest;
|
|
5264
|
+
}
|
|
5265
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch extends StandardParameters {
|
|
5266
|
+
/**
|
|
5267
|
+
* Required. Full resource name of the SiteSearchEngine, such as `projects/{project\}/locations/{location\}/dataStores/{data_store_id\}/siteSearchEngine`.
|
|
5268
|
+
*/
|
|
5269
|
+
siteSearchEngine?: string;
|
|
5270
|
+
/**
|
|
5271
|
+
* Request body metadata
|
|
5272
|
+
*/
|
|
5273
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchRequest;
|
|
5274
|
+
}
|
|
5275
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch extends StandardParameters {
|
|
5276
|
+
/**
|
|
5277
|
+
* Required. Full resource name of the SiteSearchEngine, such as `projects/{project\}/locations/{location\}/dataStores/{data_store_id\}/siteSearchEngine`.
|
|
5278
|
+
*/
|
|
5279
|
+
siteSearchEngine?: string;
|
|
5280
|
+
/**
|
|
5281
|
+
* Request body metadata
|
|
5282
|
+
*/
|
|
5283
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchRequest;
|
|
5284
|
+
}
|
|
5285
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus extends StandardParameters {
|
|
5286
|
+
/**
|
|
5287
|
+
* Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned.
|
|
5288
|
+
*/
|
|
5289
|
+
pageSize?: number;
|
|
5290
|
+
/**
|
|
5291
|
+
* A page token, received from a previous `FetchDomainVerificationStatus` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchDomainVerificationStatus` must match the call that provided the page token.
|
|
5292
|
+
*/
|
|
5293
|
+
pageToken?: string;
|
|
5294
|
+
/**
|
|
5295
|
+
* Required. The site search engine resource under which we fetch all the domain verification status. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`.
|
|
5296
|
+
*/
|
|
5297
|
+
siteSearchEngine?: string;
|
|
5298
|
+
}
|
|
5299
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris extends StandardParameters {
|
|
5300
|
+
/**
|
|
5301
|
+
* Required. Full resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`.
|
|
5302
|
+
*/
|
|
5303
|
+
siteSearchEngine?: string;
|
|
5304
|
+
/**
|
|
5305
|
+
* Request body metadata
|
|
5306
|
+
*/
|
|
5307
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaRecrawlUrisRequest;
|
|
3710
5308
|
}
|
|
3711
5309
|
export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations {
|
|
3712
5310
|
context: APIRequestContext;
|
|
3713
5311
|
constructor(context: APIRequestContext);
|
|
3714
5312
|
/**
|
|
3715
|
-
* Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
|
|
5313
|
+
* Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
|
|
5314
|
+
*
|
|
5315
|
+
* @param params - Parameters for request
|
|
5316
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5317
|
+
* @param callback - Optional callback that handles the response.
|
|
5318
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5319
|
+
*/
|
|
5320
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
5321
|
+
get(params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
5322
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
5323
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5324
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5325
|
+
get(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5326
|
+
/**
|
|
5327
|
+
* Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
|
|
5328
|
+
*
|
|
5329
|
+
* @param params - Parameters for request
|
|
5330
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5331
|
+
* @param callback - Optional callback that handles the response.
|
|
5332
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5333
|
+
*/
|
|
5334
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
5335
|
+
list(params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningListOperationsResponse>;
|
|
5336
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
5337
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>, callback: BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>): void;
|
|
5338
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List, callback: BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>): void;
|
|
5339
|
+
list(callback: BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>): void;
|
|
5340
|
+
}
|
|
5341
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get extends StandardParameters {
|
|
5342
|
+
/**
|
|
5343
|
+
* The name of the operation resource.
|
|
5344
|
+
*/
|
|
5345
|
+
name?: string;
|
|
5346
|
+
}
|
|
5347
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List extends StandardParameters {
|
|
5348
|
+
/**
|
|
5349
|
+
* The standard list filter.
|
|
5350
|
+
*/
|
|
5351
|
+
filter?: string;
|
|
5352
|
+
/**
|
|
5353
|
+
* The name of the operation's parent resource.
|
|
5354
|
+
*/
|
|
5355
|
+
name?: string;
|
|
5356
|
+
/**
|
|
5357
|
+
* The standard list page size.
|
|
5358
|
+
*/
|
|
5359
|
+
pageSize?: number;
|
|
5360
|
+
/**
|
|
5361
|
+
* The standard list page token.
|
|
5362
|
+
*/
|
|
5363
|
+
pageToken?: string;
|
|
5364
|
+
}
|
|
5365
|
+
export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites {
|
|
5366
|
+
context: APIRequestContext;
|
|
5367
|
+
operations: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations;
|
|
5368
|
+
constructor(context: APIRequestContext);
|
|
5369
|
+
/**
|
|
5370
|
+
* Creates TargetSite in a batch.
|
|
5371
|
+
*
|
|
5372
|
+
* @param params - Parameters for request
|
|
5373
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5374
|
+
* @param callback - Optional callback that handles the response.
|
|
5375
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5376
|
+
*/
|
|
5377
|
+
batchCreate(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
5378
|
+
batchCreate(params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
5379
|
+
batchCreate(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
5380
|
+
batchCreate(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5381
|
+
batchCreate(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5382
|
+
batchCreate(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5383
|
+
/**
|
|
5384
|
+
* Creates a TargetSite.
|
|
5385
|
+
*
|
|
5386
|
+
* @param params - Parameters for request
|
|
5387
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5388
|
+
* @param callback - Optional callback that handles the response.
|
|
5389
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5390
|
+
*/
|
|
5391
|
+
create(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
5392
|
+
create(params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
5393
|
+
create(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
5394
|
+
create(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5395
|
+
create(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5396
|
+
create(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5397
|
+
/**
|
|
5398
|
+
* Deletes a TargetSite.
|
|
5399
|
+
*
|
|
5400
|
+
* @param params - Parameters for request
|
|
5401
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5402
|
+
* @param callback - Optional callback that handles the response.
|
|
5403
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5404
|
+
*/
|
|
5405
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
5406
|
+
delete(params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
5407
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
5408
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5409
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5410
|
+
delete(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5411
|
+
/**
|
|
5412
|
+
* Gets a TargetSite.
|
|
5413
|
+
*
|
|
5414
|
+
* @param params - Parameters for request
|
|
5415
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5416
|
+
* @param callback - Optional callback that handles the response.
|
|
5417
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5418
|
+
*/
|
|
5419
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
5420
|
+
get(params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaTargetSite>;
|
|
5421
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
5422
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaTargetSite>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaTargetSite>): void;
|
|
5423
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaTargetSite>): void;
|
|
5424
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaTargetSite>): void;
|
|
5425
|
+
/**
|
|
5426
|
+
* Gets a list of TargetSites.
|
|
3716
5427
|
*
|
|
3717
5428
|
* @param params - Parameters for request
|
|
3718
5429
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3719
5430
|
* @param callback - Optional callback that handles the response.
|
|
3720
5431
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3721
5432
|
*/
|
|
3722
|
-
|
|
3723
|
-
|
|
3724
|
-
|
|
3725
|
-
|
|
3726
|
-
|
|
3727
|
-
|
|
5433
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
5434
|
+
list(params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaListTargetSitesResponse>;
|
|
5435
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
5436
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListTargetSitesResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListTargetSitesResponse>): void;
|
|
5437
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListTargetSitesResponse>): void;
|
|
5438
|
+
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListTargetSitesResponse>): void;
|
|
3728
5439
|
/**
|
|
3729
|
-
*
|
|
5440
|
+
* Updates a TargetSite.
|
|
3730
5441
|
*
|
|
3731
5442
|
* @param params - Parameters for request
|
|
3732
5443
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3733
5444
|
* @param callback - Optional callback that handles the response.
|
|
3734
5445
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3735
5446
|
*/
|
|
3736
|
-
|
|
3737
|
-
|
|
3738
|
-
|
|
3739
|
-
|
|
3740
|
-
|
|
3741
|
-
|
|
5447
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
5448
|
+
patch(params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
5449
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
5450
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5451
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5452
|
+
patch(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
3742
5453
|
}
|
|
3743
|
-
export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$
|
|
5454
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate extends StandardParameters {
|
|
3744
5455
|
/**
|
|
3745
|
-
* The
|
|
5456
|
+
* Required. The parent resource shared by all TargetSites being created. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. The parent field in the CreateBookRequest messages must either be empty or match this field.
|
|
3746
5457
|
*/
|
|
3747
|
-
|
|
5458
|
+
parent?: string;
|
|
5459
|
+
/**
|
|
5460
|
+
* Request body metadata
|
|
5461
|
+
*/
|
|
5462
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesRequest;
|
|
3748
5463
|
}
|
|
3749
|
-
export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$
|
|
5464
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create extends StandardParameters {
|
|
3750
5465
|
/**
|
|
3751
|
-
*
|
|
5466
|
+
* Required. Parent resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`.
|
|
3752
5467
|
*/
|
|
3753
|
-
|
|
5468
|
+
parent?: string;
|
|
3754
5469
|
/**
|
|
3755
|
-
*
|
|
5470
|
+
* Request body metadata
|
|
5471
|
+
*/
|
|
5472
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaTargetSite;
|
|
5473
|
+
}
|
|
5474
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete extends StandardParameters {
|
|
5475
|
+
/**
|
|
5476
|
+
* Required. Full resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned.
|
|
3756
5477
|
*/
|
|
3757
5478
|
name?: string;
|
|
5479
|
+
}
|
|
5480
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get extends StandardParameters {
|
|
3758
5481
|
/**
|
|
3759
|
-
*
|
|
5482
|
+
* Required. Full resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned.
|
|
5483
|
+
*/
|
|
5484
|
+
name?: string;
|
|
5485
|
+
}
|
|
5486
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List extends StandardParameters {
|
|
5487
|
+
/**
|
|
5488
|
+
* Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned.
|
|
3760
5489
|
*/
|
|
3761
5490
|
pageSize?: number;
|
|
3762
5491
|
/**
|
|
3763
|
-
*
|
|
5492
|
+
* A page token, received from a previous `ListTargetSites` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTargetSites` must match the call that provided the page token.
|
|
3764
5493
|
*/
|
|
3765
5494
|
pageToken?: string;
|
|
5495
|
+
/**
|
|
5496
|
+
* Required. The parent site search engine resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. If the caller does not have permission to list TargetSites under this site search engine, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.
|
|
5497
|
+
*/
|
|
5498
|
+
parent?: string;
|
|
3766
5499
|
}
|
|
3767
|
-
export
|
|
3768
|
-
|
|
3769
|
-
|
|
3770
|
-
|
|
5500
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch extends StandardParameters {
|
|
5501
|
+
/**
|
|
5502
|
+
* 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.
|
|
5503
|
+
*/
|
|
5504
|
+
name?: string;
|
|
5505
|
+
/**
|
|
5506
|
+
* Request body metadata
|
|
5507
|
+
*/
|
|
5508
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaTargetSite;
|
|
3771
5509
|
}
|
|
3772
5510
|
export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations {
|
|
3773
5511
|
context: APIRequestContext;
|
|
@@ -3825,6 +5563,58 @@ export declare namespace discoveryengine_v1beta {
|
|
|
3825
5563
|
*/
|
|
3826
5564
|
pageToken?: string;
|
|
3827
5565
|
}
|
|
5566
|
+
export class Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries {
|
|
5567
|
+
context: APIRequestContext;
|
|
5568
|
+
constructor(context: APIRequestContext);
|
|
5569
|
+
/**
|
|
5570
|
+
* Imports all SuggestionDenyListEntry for a DataStore.
|
|
5571
|
+
*
|
|
5572
|
+
* @param params - Parameters for request
|
|
5573
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5574
|
+
* @param callback - Optional callback that handles the response.
|
|
5575
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5576
|
+
*/
|
|
5577
|
+
import(params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
5578
|
+
import(params?: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
5579
|
+
import(params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
5580
|
+
import(params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5581
|
+
import(params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5582
|
+
import(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5583
|
+
/**
|
|
5584
|
+
* Permanently deletes all SuggestionDenyListEntry for a DataStore.
|
|
5585
|
+
*
|
|
5586
|
+
* @param params - Parameters for request
|
|
5587
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5588
|
+
* @param callback - Optional callback that handles the response.
|
|
5589
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5590
|
+
*/
|
|
5591
|
+
purge(params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
5592
|
+
purge(params?: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
5593
|
+
purge(params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
5594
|
+
purge(params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5595
|
+
purge(params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5596
|
+
purge(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5597
|
+
}
|
|
5598
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import extends StandardParameters {
|
|
5599
|
+
/**
|
|
5600
|
+
* Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x.
|
|
5601
|
+
*/
|
|
5602
|
+
parent?: string;
|
|
5603
|
+
/**
|
|
5604
|
+
* Request body metadata
|
|
5605
|
+
*/
|
|
5606
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesRequest;
|
|
5607
|
+
}
|
|
5608
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge extends StandardParameters {
|
|
5609
|
+
/**
|
|
5610
|
+
* Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x.
|
|
5611
|
+
*/
|
|
5612
|
+
parent?: string;
|
|
5613
|
+
/**
|
|
5614
|
+
* Request body metadata
|
|
5615
|
+
*/
|
|
5616
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesRequest;
|
|
5617
|
+
}
|
|
3828
5618
|
export class Resource$Projects$Locations$Collections$Datastores$Userevents {
|
|
3829
5619
|
context: APIRequestContext;
|
|
3830
5620
|
constructor(context: APIRequestContext);
|
|
@@ -3915,6 +5705,134 @@ export declare namespace discoveryengine_v1beta {
|
|
|
3915
5705
|
operations: Resource$Projects$Locations$Collections$Engines$Operations;
|
|
3916
5706
|
servingConfigs: Resource$Projects$Locations$Collections$Engines$Servingconfigs;
|
|
3917
5707
|
constructor(context: APIRequestContext);
|
|
5708
|
+
/**
|
|
5709
|
+
* Creates a Engine.
|
|
5710
|
+
*
|
|
5711
|
+
* @param params - Parameters for request
|
|
5712
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5713
|
+
* @param callback - Optional callback that handles the response.
|
|
5714
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5715
|
+
*/
|
|
5716
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Create, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
5717
|
+
create(params?: Params$Resource$Projects$Locations$Collections$Engines$Create, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
5718
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
5719
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5720
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Create, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5721
|
+
create(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5722
|
+
/**
|
|
5723
|
+
* Deletes a Engine.
|
|
5724
|
+
*
|
|
5725
|
+
* @param params - Parameters for request
|
|
5726
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5727
|
+
* @param callback - Optional callback that handles the response.
|
|
5728
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5729
|
+
*/
|
|
5730
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Engines$Delete, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
5731
|
+
delete(params?: Params$Resource$Projects$Locations$Collections$Engines$Delete, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
5732
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Engines$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
5733
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Engines$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5734
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Engines$Delete, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5735
|
+
delete(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5736
|
+
/**
|
|
5737
|
+
* Gets a Engine.
|
|
5738
|
+
*
|
|
5739
|
+
* @param params - Parameters for request
|
|
5740
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5741
|
+
* @param callback - Optional callback that handles the response.
|
|
5742
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5743
|
+
*/
|
|
5744
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
5745
|
+
get(params?: Params$Resource$Projects$Locations$Collections$Engines$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaEngine>;
|
|
5746
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
5747
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaEngine>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaEngine>): void;
|
|
5748
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaEngine>): void;
|
|
5749
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaEngine>): void;
|
|
5750
|
+
/**
|
|
5751
|
+
* Lists all the Engines associated with the project.
|
|
5752
|
+
*
|
|
5753
|
+
* @param params - Parameters for request
|
|
5754
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5755
|
+
* @param callback - Optional callback that handles the response.
|
|
5756
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5757
|
+
*/
|
|
5758
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
5759
|
+
list(params?: Params$Resource$Projects$Locations$Collections$Engines$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaListEnginesResponse>;
|
|
5760
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
5761
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListEnginesResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListEnginesResponse>): void;
|
|
5762
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListEnginesResponse>): void;
|
|
5763
|
+
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListEnginesResponse>): void;
|
|
5764
|
+
/**
|
|
5765
|
+
* Updates an Engine
|
|
5766
|
+
*
|
|
5767
|
+
* @param params - Parameters for request
|
|
5768
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5769
|
+
* @param callback - Optional callback that handles the response.
|
|
5770
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5771
|
+
*/
|
|
5772
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
5773
|
+
patch(params?: Params$Resource$Projects$Locations$Collections$Engines$Patch, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaEngine>;
|
|
5774
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
5775
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaEngine>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaEngine>): void;
|
|
5776
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaEngine>): void;
|
|
5777
|
+
patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaEngine>): void;
|
|
5778
|
+
}
|
|
5779
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Create extends StandardParameters {
|
|
5780
|
+
/**
|
|
5781
|
+
* Required. The ID to use for the Engine, which will become the final component of the Engine's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
|
5782
|
+
*/
|
|
5783
|
+
engineId?: string;
|
|
5784
|
+
/**
|
|
5785
|
+
* Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}`.
|
|
5786
|
+
*/
|
|
5787
|
+
parent?: string;
|
|
5788
|
+
/**
|
|
5789
|
+
* Request body metadata
|
|
5790
|
+
*/
|
|
5791
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaEngine;
|
|
5792
|
+
}
|
|
5793
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Delete extends StandardParameters {
|
|
5794
|
+
/**
|
|
5795
|
+
* Required. Full resource name of Engine, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. If the caller does not have permission to delete the Engine, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Engine to delete does not exist, a NOT_FOUND error is returned.
|
|
5796
|
+
*/
|
|
5797
|
+
name?: string;
|
|
5798
|
+
}
|
|
5799
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Get extends StandardParameters {
|
|
5800
|
+
/**
|
|
5801
|
+
* Required. Full resource name of Engine, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`.
|
|
5802
|
+
*/
|
|
5803
|
+
name?: string;
|
|
5804
|
+
}
|
|
5805
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$List extends StandardParameters {
|
|
5806
|
+
/**
|
|
5807
|
+
* Optional. Filter by solution type. For example: solution_type=SOLUTION_TYPE_SEARCH
|
|
5808
|
+
*/
|
|
5809
|
+
filter?: string;
|
|
5810
|
+
/**
|
|
5811
|
+
* Optional. Not supported.
|
|
5812
|
+
*/
|
|
5813
|
+
pageSize?: number;
|
|
5814
|
+
/**
|
|
5815
|
+
* Optional. Not supported.
|
|
5816
|
+
*/
|
|
5817
|
+
pageToken?: string;
|
|
5818
|
+
/**
|
|
5819
|
+
* Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}`.
|
|
5820
|
+
*/
|
|
5821
|
+
parent?: string;
|
|
5822
|
+
}
|
|
5823
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Patch extends StandardParameters {
|
|
5824
|
+
/**
|
|
5825
|
+
* 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.
|
|
5826
|
+
*/
|
|
5827
|
+
name?: string;
|
|
5828
|
+
/**
|
|
5829
|
+
* Indicates which fields in the provided Engine to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.
|
|
5830
|
+
*/
|
|
5831
|
+
updateMask?: string;
|
|
5832
|
+
/**
|
|
5833
|
+
* Request body metadata
|
|
5834
|
+
*/
|
|
5835
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaEngine;
|
|
3918
5836
|
}
|
|
3919
5837
|
export class Resource$Projects$Locations$Collections$Engines$Conversations {
|
|
3920
5838
|
context: APIRequestContext;
|
|
@@ -4064,7 +5982,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
4064
5982
|
*/
|
|
4065
5983
|
name?: string;
|
|
4066
5984
|
/**
|
|
4067
|
-
* Indicates which fields in the provided Conversation to update. The following are NOT supported: *
|
|
5985
|
+
* 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.
|
|
4068
5986
|
*/
|
|
4069
5987
|
updateMask?: string;
|
|
4070
5988
|
/**
|
|
@@ -4131,6 +6049,48 @@ export declare namespace discoveryengine_v1beta {
|
|
|
4131
6049
|
export class Resource$Projects$Locations$Collections$Engines$Servingconfigs {
|
|
4132
6050
|
context: APIRequestContext;
|
|
4133
6051
|
constructor(context: APIRequestContext);
|
|
6052
|
+
/**
|
|
6053
|
+
* Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
|
|
6054
|
+
*
|
|
6055
|
+
* @param params - Parameters for request
|
|
6056
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6057
|
+
* @param callback - Optional callback that handles the response.
|
|
6058
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6059
|
+
*/
|
|
6060
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
6061
|
+
get(params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>;
|
|
6062
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
6063
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
6064
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
6065
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
6066
|
+
/**
|
|
6067
|
+
* Lists all ServingConfigs linked to this dataStore.
|
|
6068
|
+
*
|
|
6069
|
+
* @param params - Parameters for request
|
|
6070
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6071
|
+
* @param callback - Optional callback that handles the response.
|
|
6072
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6073
|
+
*/
|
|
6074
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
6075
|
+
list(params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>;
|
|
6076
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
6077
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>): void;
|
|
6078
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>): void;
|
|
6079
|
+
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>): void;
|
|
6080
|
+
/**
|
|
6081
|
+
* Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
|
|
6082
|
+
*
|
|
6083
|
+
* @param params - Parameters for request
|
|
6084
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6085
|
+
* @param callback - Optional callback that handles the response.
|
|
6086
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6087
|
+
*/
|
|
6088
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
6089
|
+
patch(params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>;
|
|
6090
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
6091
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
6092
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
6093
|
+
patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
4134
6094
|
/**
|
|
4135
6095
|
* Makes a recommendation, which requires a contextual user event.
|
|
4136
6096
|
*
|
|
@@ -4160,9 +6120,43 @@ export declare namespace discoveryengine_v1beta {
|
|
|
4160
6120
|
search(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSearchResponse>): void;
|
|
4161
6121
|
search(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSearchResponse>): void;
|
|
4162
6122
|
}
|
|
6123
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get extends StandardParameters {
|
|
6124
|
+
/**
|
|
6125
|
+
* Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/servingConfigs/{serving_config_id\}`
|
|
6126
|
+
*/
|
|
6127
|
+
name?: string;
|
|
6128
|
+
}
|
|
6129
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List extends StandardParameters {
|
|
6130
|
+
/**
|
|
6131
|
+
* 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.
|
|
6132
|
+
*/
|
|
6133
|
+
pageSize?: number;
|
|
6134
|
+
/**
|
|
6135
|
+
* Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.
|
|
6136
|
+
*/
|
|
6137
|
+
pageToken?: string;
|
|
6138
|
+
/**
|
|
6139
|
+
* Required. The dataStore resource name. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`
|
|
6140
|
+
*/
|
|
6141
|
+
parent?: string;
|
|
6142
|
+
}
|
|
6143
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch extends StandardParameters {
|
|
6144
|
+
/**
|
|
6145
|
+
* Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}`
|
|
6146
|
+
*/
|
|
6147
|
+
name?: string;
|
|
6148
|
+
/**
|
|
6149
|
+
* Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated.
|
|
6150
|
+
*/
|
|
6151
|
+
updateMask?: string;
|
|
6152
|
+
/**
|
|
6153
|
+
* Request body metadata
|
|
6154
|
+
*/
|
|
6155
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaServingConfig;
|
|
6156
|
+
}
|
|
4163
6157
|
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend extends StandardParameters {
|
|
4164
6158
|
/**
|
|
4165
|
-
* 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.
|
|
6159
|
+
* 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.
|
|
4166
6160
|
*/
|
|
4167
6161
|
servingConfig?: string;
|
|
4168
6162
|
/**
|
|
@@ -4244,6 +6238,8 @@ export declare namespace discoveryengine_v1beta {
|
|
|
4244
6238
|
operations: Resource$Projects$Locations$Datastores$Operations;
|
|
4245
6239
|
schemas: Resource$Projects$Locations$Datastores$Schemas;
|
|
4246
6240
|
servingConfigs: Resource$Projects$Locations$Datastores$Servingconfigs;
|
|
6241
|
+
siteSearchEngine: Resource$Projects$Locations$Datastores$Sitesearchengine;
|
|
6242
|
+
suggestionDenyListEntries: Resource$Projects$Locations$Datastores$Suggestiondenylistentries;
|
|
4247
6243
|
userEvents: Resource$Projects$Locations$Datastores$Userevents;
|
|
4248
6244
|
constructor(context: APIRequestContext);
|
|
4249
6245
|
/**
|
|
@@ -4260,6 +6256,90 @@ export declare namespace discoveryengine_v1beta {
|
|
|
4260
6256
|
completeQuery(params: Params$Resource$Projects$Locations$Datastores$Completequery, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaCompleteQueryResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaCompleteQueryResponse>): void;
|
|
4261
6257
|
completeQuery(params: Params$Resource$Projects$Locations$Datastores$Completequery, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaCompleteQueryResponse>): void;
|
|
4262
6258
|
completeQuery(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaCompleteQueryResponse>): void;
|
|
6259
|
+
/**
|
|
6260
|
+
* Creates a DataStore. DataStore is for storing Documents. To serve these documents for Search, or Recommendation use case, an Engine needs to be created separately.
|
|
6261
|
+
*
|
|
6262
|
+
* @param params - Parameters for request
|
|
6263
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6264
|
+
* @param callback - Optional callback that handles the response.
|
|
6265
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6266
|
+
*/
|
|
6267
|
+
create(params: Params$Resource$Projects$Locations$Datastores$Create, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
6268
|
+
create(params?: Params$Resource$Projects$Locations$Datastores$Create, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
6269
|
+
create(params: Params$Resource$Projects$Locations$Datastores$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
6270
|
+
create(params: Params$Resource$Projects$Locations$Datastores$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
6271
|
+
create(params: Params$Resource$Projects$Locations$Datastores$Create, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
6272
|
+
create(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
6273
|
+
/**
|
|
6274
|
+
* Deletes a DataStore.
|
|
6275
|
+
*
|
|
6276
|
+
* @param params - Parameters for request
|
|
6277
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6278
|
+
* @param callback - Optional callback that handles the response.
|
|
6279
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6280
|
+
*/
|
|
6281
|
+
delete(params: Params$Resource$Projects$Locations$Datastores$Delete, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
6282
|
+
delete(params?: Params$Resource$Projects$Locations$Datastores$Delete, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
6283
|
+
delete(params: Params$Resource$Projects$Locations$Datastores$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
6284
|
+
delete(params: Params$Resource$Projects$Locations$Datastores$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
6285
|
+
delete(params: Params$Resource$Projects$Locations$Datastores$Delete, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
6286
|
+
delete(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
6287
|
+
/**
|
|
6288
|
+
* Gets a DataStore.
|
|
6289
|
+
*
|
|
6290
|
+
* @param params - Parameters for request
|
|
6291
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6292
|
+
* @param callback - Optional callback that handles the response.
|
|
6293
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6294
|
+
*/
|
|
6295
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
6296
|
+
get(params?: Params$Resource$Projects$Locations$Datastores$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaDataStore>;
|
|
6297
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
6298
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaDataStore>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaDataStore>): void;
|
|
6299
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaDataStore>): void;
|
|
6300
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaDataStore>): void;
|
|
6301
|
+
/**
|
|
6302
|
+
* Gets the SiteSearchEngine.
|
|
6303
|
+
*
|
|
6304
|
+
* @param params - Parameters for request
|
|
6305
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6306
|
+
* @param callback - Optional callback that handles the response.
|
|
6307
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6308
|
+
*/
|
|
6309
|
+
getSiteSearchEngine(params: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
6310
|
+
getSiteSearchEngine(params?: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaSiteSearchEngine>;
|
|
6311
|
+
getSiteSearchEngine(params: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
6312
|
+
getSiteSearchEngine(params: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSiteSearchEngine>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSiteSearchEngine>): void;
|
|
6313
|
+
getSiteSearchEngine(params: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSiteSearchEngine>): void;
|
|
6314
|
+
getSiteSearchEngine(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSiteSearchEngine>): void;
|
|
6315
|
+
/**
|
|
6316
|
+
* Lists all the DataStores associated with the project.
|
|
6317
|
+
*
|
|
6318
|
+
* @param params - Parameters for request
|
|
6319
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6320
|
+
* @param callback - Optional callback that handles the response.
|
|
6321
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6322
|
+
*/
|
|
6323
|
+
list(params: Params$Resource$Projects$Locations$Datastores$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
6324
|
+
list(params?: Params$Resource$Projects$Locations$Datastores$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaListDataStoresResponse>;
|
|
6325
|
+
list(params: Params$Resource$Projects$Locations$Datastores$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
6326
|
+
list(params: Params$Resource$Projects$Locations$Datastores$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListDataStoresResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListDataStoresResponse>): void;
|
|
6327
|
+
list(params: Params$Resource$Projects$Locations$Datastores$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListDataStoresResponse>): void;
|
|
6328
|
+
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListDataStoresResponse>): void;
|
|
6329
|
+
/**
|
|
6330
|
+
* Updates a DataStore
|
|
6331
|
+
*
|
|
6332
|
+
* @param params - Parameters for request
|
|
6333
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6334
|
+
* @param callback - Optional callback that handles the response.
|
|
6335
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6336
|
+
*/
|
|
6337
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
6338
|
+
patch(params?: Params$Resource$Projects$Locations$Datastores$Patch, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaDataStore>;
|
|
6339
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
6340
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaDataStore>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaDataStore>): void;
|
|
6341
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaDataStore>): void;
|
|
6342
|
+
patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaDataStore>): void;
|
|
4263
6343
|
}
|
|
4264
6344
|
export interface Params$Resource$Projects$Locations$Datastores$Completequery extends StandardParameters {
|
|
4265
6345
|
/**
|
|
@@ -4275,7 +6355,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
4275
6355
|
*/
|
|
4276
6356
|
query?: string;
|
|
4277
6357
|
/**
|
|
4278
|
-
*
|
|
6358
|
+
* 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.
|
|
4279
6359
|
*/
|
|
4280
6360
|
queryModel?: string;
|
|
4281
6361
|
/**
|
|
@@ -4283,6 +6363,74 @@ export declare namespace discoveryengine_v1beta {
|
|
|
4283
6363
|
*/
|
|
4284
6364
|
userPseudoId?: string;
|
|
4285
6365
|
}
|
|
6366
|
+
export interface Params$Resource$Projects$Locations$Datastores$Create extends StandardParameters {
|
|
6367
|
+
/**
|
|
6368
|
+
* A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored.
|
|
6369
|
+
*/
|
|
6370
|
+
createAdvancedSiteSearch?: boolean;
|
|
6371
|
+
/**
|
|
6372
|
+
* Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
|
6373
|
+
*/
|
|
6374
|
+
dataStoreId?: string;
|
|
6375
|
+
/**
|
|
6376
|
+
* Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}`.
|
|
6377
|
+
*/
|
|
6378
|
+
parent?: string;
|
|
6379
|
+
/**
|
|
6380
|
+
* Request body metadata
|
|
6381
|
+
*/
|
|
6382
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaDataStore;
|
|
6383
|
+
}
|
|
6384
|
+
export interface Params$Resource$Projects$Locations$Datastores$Delete extends StandardParameters {
|
|
6385
|
+
/**
|
|
6386
|
+
* Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to delete the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the DataStore to delete does not exist, a NOT_FOUND error is returned.
|
|
6387
|
+
*/
|
|
6388
|
+
name?: string;
|
|
6389
|
+
}
|
|
6390
|
+
export interface Params$Resource$Projects$Locations$Datastores$Get extends StandardParameters {
|
|
6391
|
+
/**
|
|
6392
|
+
* Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned.
|
|
6393
|
+
*/
|
|
6394
|
+
name?: string;
|
|
6395
|
+
}
|
|
6396
|
+
export interface Params$Resource$Projects$Locations$Datastores$Getsitesearchengine extends StandardParameters {
|
|
6397
|
+
/**
|
|
6398
|
+
* Required. Resource name of SiteSearchEngine, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. If the caller does not have permission to access the [SiteSearchEngine], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.
|
|
6399
|
+
*/
|
|
6400
|
+
name?: string;
|
|
6401
|
+
}
|
|
6402
|
+
export interface Params$Resource$Projects$Locations$Datastores$List extends StandardParameters {
|
|
6403
|
+
/**
|
|
6404
|
+
* Filter by solution type. For example: filter = 'solution_type:SOLUTION_TYPE_SEARCH'
|
|
6405
|
+
*/
|
|
6406
|
+
filter?: string;
|
|
6407
|
+
/**
|
|
6408
|
+
* Maximum number of DataStores to return. If unspecified, defaults to 10. The maximum allowed value is 50. Values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT is returned.
|
|
6409
|
+
*/
|
|
6410
|
+
pageSize?: number;
|
|
6411
|
+
/**
|
|
6412
|
+
* A page token ListDataStoresResponse.next_page_token, received from a previous DataStoreService.ListDataStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DataStoreService.ListDataStores must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.
|
|
6413
|
+
*/
|
|
6414
|
+
pageToken?: string;
|
|
6415
|
+
/**
|
|
6416
|
+
* 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.
|
|
6417
|
+
*/
|
|
6418
|
+
parent?: string;
|
|
6419
|
+
}
|
|
6420
|
+
export interface Params$Resource$Projects$Locations$Datastores$Patch extends StandardParameters {
|
|
6421
|
+
/**
|
|
6422
|
+
* 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.
|
|
6423
|
+
*/
|
|
6424
|
+
name?: string;
|
|
6425
|
+
/**
|
|
6426
|
+
* Indicates which fields in the provided DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.
|
|
6427
|
+
*/
|
|
6428
|
+
updateMask?: string;
|
|
6429
|
+
/**
|
|
6430
|
+
* Request body metadata
|
|
6431
|
+
*/
|
|
6432
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaDataStore;
|
|
6433
|
+
}
|
|
4286
6434
|
export class Resource$Projects$Locations$Datastores$Branches {
|
|
4287
6435
|
context: APIRequestContext;
|
|
4288
6436
|
documents: Resource$Projects$Locations$Datastores$Branches$Documents;
|
|
@@ -4669,7 +6817,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
4669
6817
|
*/
|
|
4670
6818
|
name?: string;
|
|
4671
6819
|
/**
|
|
4672
|
-
* Indicates which fields in the provided Conversation to update. The following are NOT supported: *
|
|
6820
|
+
* 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.
|
|
4673
6821
|
*/
|
|
4674
6822
|
updateMask?: string;
|
|
4675
6823
|
/**
|
|
@@ -4925,6 +7073,48 @@ export declare namespace discoveryengine_v1beta {
|
|
|
4925
7073
|
export class Resource$Projects$Locations$Datastores$Servingconfigs {
|
|
4926
7074
|
context: APIRequestContext;
|
|
4927
7075
|
constructor(context: APIRequestContext);
|
|
7076
|
+
/**
|
|
7077
|
+
* Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
|
|
7078
|
+
*
|
|
7079
|
+
* @param params - Parameters for request
|
|
7080
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
7081
|
+
* @param callback - Optional callback that handles the response.
|
|
7082
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
7083
|
+
*/
|
|
7084
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
7085
|
+
get(params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>;
|
|
7086
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
7087
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
7088
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
7089
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
7090
|
+
/**
|
|
7091
|
+
* Lists all ServingConfigs linked to this dataStore.
|
|
7092
|
+
*
|
|
7093
|
+
* @param params - Parameters for request
|
|
7094
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
7095
|
+
* @param callback - Optional callback that handles the response.
|
|
7096
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
7097
|
+
*/
|
|
7098
|
+
list(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
7099
|
+
list(params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>;
|
|
7100
|
+
list(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
7101
|
+
list(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>): void;
|
|
7102
|
+
list(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>): void;
|
|
7103
|
+
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>): void;
|
|
7104
|
+
/**
|
|
7105
|
+
* Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
|
|
7106
|
+
*
|
|
7107
|
+
* @param params - Parameters for request
|
|
7108
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
7109
|
+
* @param callback - Optional callback that handles the response.
|
|
7110
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
7111
|
+
*/
|
|
7112
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
7113
|
+
patch(params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>;
|
|
7114
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
7115
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
7116
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
7117
|
+
patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
4928
7118
|
/**
|
|
4929
7119
|
* Makes a recommendation, which requires a contextual user event.
|
|
4930
7120
|
*
|
|
@@ -4954,9 +7144,43 @@ export declare namespace discoveryengine_v1beta {
|
|
|
4954
7144
|
search(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSearchResponse>): void;
|
|
4955
7145
|
search(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSearchResponse>): void;
|
|
4956
7146
|
}
|
|
7147
|
+
export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get extends StandardParameters {
|
|
7148
|
+
/**
|
|
7149
|
+
* Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/servingConfigs/{serving_config_id\}`
|
|
7150
|
+
*/
|
|
7151
|
+
name?: string;
|
|
7152
|
+
}
|
|
7153
|
+
export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$List extends StandardParameters {
|
|
7154
|
+
/**
|
|
7155
|
+
* 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.
|
|
7156
|
+
*/
|
|
7157
|
+
pageSize?: number;
|
|
7158
|
+
/**
|
|
7159
|
+
* Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.
|
|
7160
|
+
*/
|
|
7161
|
+
pageToken?: string;
|
|
7162
|
+
/**
|
|
7163
|
+
* Required. The dataStore resource name. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`
|
|
7164
|
+
*/
|
|
7165
|
+
parent?: string;
|
|
7166
|
+
}
|
|
7167
|
+
export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch extends StandardParameters {
|
|
7168
|
+
/**
|
|
7169
|
+
* Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}`
|
|
7170
|
+
*/
|
|
7171
|
+
name?: string;
|
|
7172
|
+
/**
|
|
7173
|
+
* Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated.
|
|
7174
|
+
*/
|
|
7175
|
+
updateMask?: string;
|
|
7176
|
+
/**
|
|
7177
|
+
* Request body metadata
|
|
7178
|
+
*/
|
|
7179
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaServingConfig;
|
|
7180
|
+
}
|
|
4957
7181
|
export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend extends StandardParameters {
|
|
4958
7182
|
/**
|
|
4959
|
-
* 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.
|
|
7183
|
+
* 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.
|
|
4960
7184
|
*/
|
|
4961
7185
|
servingConfig?: string;
|
|
4962
7186
|
/**
|
|
@@ -4974,6 +7198,279 @@ export declare namespace discoveryengine_v1beta {
|
|
|
4974
7198
|
*/
|
|
4975
7199
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequest;
|
|
4976
7200
|
}
|
|
7201
|
+
export class Resource$Projects$Locations$Datastores$Sitesearchengine {
|
|
7202
|
+
context: APIRequestContext;
|
|
7203
|
+
targetSites: Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites;
|
|
7204
|
+
constructor(context: APIRequestContext);
|
|
7205
|
+
/**
|
|
7206
|
+
* Downgrade from advanced site search to basic site search.
|
|
7207
|
+
*
|
|
7208
|
+
* @param params - Parameters for request
|
|
7209
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
7210
|
+
* @param callback - Optional callback that handles the response.
|
|
7211
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
7212
|
+
*/
|
|
7213
|
+
disableAdvancedSiteSearch(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
7214
|
+
disableAdvancedSiteSearch(params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
7215
|
+
disableAdvancedSiteSearch(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
7216
|
+
disableAdvancedSiteSearch(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
7217
|
+
disableAdvancedSiteSearch(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
7218
|
+
disableAdvancedSiteSearch(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
7219
|
+
/**
|
|
7220
|
+
* Upgrade from basic site search to advanced site search.
|
|
7221
|
+
*
|
|
7222
|
+
* @param params - Parameters for request
|
|
7223
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
7224
|
+
* @param callback - Optional callback that handles the response.
|
|
7225
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
7226
|
+
*/
|
|
7227
|
+
enableAdvancedSiteSearch(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
7228
|
+
enableAdvancedSiteSearch(params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
7229
|
+
enableAdvancedSiteSearch(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
7230
|
+
enableAdvancedSiteSearch(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
7231
|
+
enableAdvancedSiteSearch(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
7232
|
+
enableAdvancedSiteSearch(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
7233
|
+
/**
|
|
7234
|
+
* Request on-demand recrawl for a list of URIs.
|
|
7235
|
+
*
|
|
7236
|
+
* @param params - Parameters for request
|
|
7237
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
7238
|
+
* @param callback - Optional callback that handles the response.
|
|
7239
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
7240
|
+
*/
|
|
7241
|
+
recrawlUris(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
7242
|
+
recrawlUris(params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
7243
|
+
recrawlUris(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
7244
|
+
recrawlUris(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
7245
|
+
recrawlUris(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
7246
|
+
recrawlUris(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
7247
|
+
}
|
|
7248
|
+
export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch extends StandardParameters {
|
|
7249
|
+
/**
|
|
7250
|
+
* Required. Full resource name of the SiteSearchEngine, such as `projects/{project\}/locations/{location\}/dataStores/{data_store_id\}/siteSearchEngine`.
|
|
7251
|
+
*/
|
|
7252
|
+
siteSearchEngine?: string;
|
|
7253
|
+
/**
|
|
7254
|
+
* Request body metadata
|
|
7255
|
+
*/
|
|
7256
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchRequest;
|
|
7257
|
+
}
|
|
7258
|
+
export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch extends StandardParameters {
|
|
7259
|
+
/**
|
|
7260
|
+
* Required. Full resource name of the SiteSearchEngine, such as `projects/{project\}/locations/{location\}/dataStores/{data_store_id\}/siteSearchEngine`.
|
|
7261
|
+
*/
|
|
7262
|
+
siteSearchEngine?: string;
|
|
7263
|
+
/**
|
|
7264
|
+
* Request body metadata
|
|
7265
|
+
*/
|
|
7266
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchRequest;
|
|
7267
|
+
}
|
|
7268
|
+
export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris extends StandardParameters {
|
|
7269
|
+
/**
|
|
7270
|
+
* Required. Full resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`.
|
|
7271
|
+
*/
|
|
7272
|
+
siteSearchEngine?: string;
|
|
7273
|
+
/**
|
|
7274
|
+
* Request body metadata
|
|
7275
|
+
*/
|
|
7276
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaRecrawlUrisRequest;
|
|
7277
|
+
}
|
|
7278
|
+
export class Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites {
|
|
7279
|
+
context: APIRequestContext;
|
|
7280
|
+
constructor(context: APIRequestContext);
|
|
7281
|
+
/**
|
|
7282
|
+
* Creates TargetSite in a batch.
|
|
7283
|
+
*
|
|
7284
|
+
* @param params - Parameters for request
|
|
7285
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
7286
|
+
* @param callback - Optional callback that handles the response.
|
|
7287
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
7288
|
+
*/
|
|
7289
|
+
batchCreate(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
7290
|
+
batchCreate(params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
7291
|
+
batchCreate(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
7292
|
+
batchCreate(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
7293
|
+
batchCreate(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
7294
|
+
batchCreate(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
7295
|
+
/**
|
|
7296
|
+
* Creates a TargetSite.
|
|
7297
|
+
*
|
|
7298
|
+
* @param params - Parameters for request
|
|
7299
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
7300
|
+
* @param callback - Optional callback that handles the response.
|
|
7301
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
7302
|
+
*/
|
|
7303
|
+
create(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
7304
|
+
create(params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
7305
|
+
create(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
7306
|
+
create(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
7307
|
+
create(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
7308
|
+
create(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
7309
|
+
/**
|
|
7310
|
+
* Deletes a TargetSite.
|
|
7311
|
+
*
|
|
7312
|
+
* @param params - Parameters for request
|
|
7313
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
7314
|
+
* @param callback - Optional callback that handles the response.
|
|
7315
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
7316
|
+
*/
|
|
7317
|
+
delete(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
7318
|
+
delete(params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
7319
|
+
delete(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
7320
|
+
delete(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
7321
|
+
delete(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
7322
|
+
delete(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
7323
|
+
/**
|
|
7324
|
+
* Gets a TargetSite.
|
|
7325
|
+
*
|
|
7326
|
+
* @param params - Parameters for request
|
|
7327
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
7328
|
+
* @param callback - Optional callback that handles the response.
|
|
7329
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
7330
|
+
*/
|
|
7331
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
7332
|
+
get(params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaTargetSite>;
|
|
7333
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
7334
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaTargetSite>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaTargetSite>): void;
|
|
7335
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaTargetSite>): void;
|
|
7336
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaTargetSite>): void;
|
|
7337
|
+
/**
|
|
7338
|
+
* Gets a list of TargetSites.
|
|
7339
|
+
*
|
|
7340
|
+
* @param params - Parameters for request
|
|
7341
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
7342
|
+
* @param callback - Optional callback that handles the response.
|
|
7343
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
7344
|
+
*/
|
|
7345
|
+
list(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
7346
|
+
list(params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaListTargetSitesResponse>;
|
|
7347
|
+
list(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
7348
|
+
list(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListTargetSitesResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListTargetSitesResponse>): void;
|
|
7349
|
+
list(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListTargetSitesResponse>): void;
|
|
7350
|
+
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListTargetSitesResponse>): void;
|
|
7351
|
+
/**
|
|
7352
|
+
* Updates a TargetSite.
|
|
7353
|
+
*
|
|
7354
|
+
* @param params - Parameters for request
|
|
7355
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
7356
|
+
* @param callback - Optional callback that handles the response.
|
|
7357
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
7358
|
+
*/
|
|
7359
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
7360
|
+
patch(params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
7361
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
7362
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
7363
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
7364
|
+
patch(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
7365
|
+
}
|
|
7366
|
+
export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate extends StandardParameters {
|
|
7367
|
+
/**
|
|
7368
|
+
* Required. The parent resource shared by all TargetSites being created. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. The parent field in the CreateBookRequest messages must either be empty or match this field.
|
|
7369
|
+
*/
|
|
7370
|
+
parent?: string;
|
|
7371
|
+
/**
|
|
7372
|
+
* Request body metadata
|
|
7373
|
+
*/
|
|
7374
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesRequest;
|
|
7375
|
+
}
|
|
7376
|
+
export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create extends StandardParameters {
|
|
7377
|
+
/**
|
|
7378
|
+
* Required. Parent resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`.
|
|
7379
|
+
*/
|
|
7380
|
+
parent?: string;
|
|
7381
|
+
/**
|
|
7382
|
+
* Request body metadata
|
|
7383
|
+
*/
|
|
7384
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaTargetSite;
|
|
7385
|
+
}
|
|
7386
|
+
export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete extends StandardParameters {
|
|
7387
|
+
/**
|
|
7388
|
+
* Required. Full resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned.
|
|
7389
|
+
*/
|
|
7390
|
+
name?: string;
|
|
7391
|
+
}
|
|
7392
|
+
export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get extends StandardParameters {
|
|
7393
|
+
/**
|
|
7394
|
+
* Required. Full resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned.
|
|
7395
|
+
*/
|
|
7396
|
+
name?: string;
|
|
7397
|
+
}
|
|
7398
|
+
export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List extends StandardParameters {
|
|
7399
|
+
/**
|
|
7400
|
+
* Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned.
|
|
7401
|
+
*/
|
|
7402
|
+
pageSize?: number;
|
|
7403
|
+
/**
|
|
7404
|
+
* A page token, received from a previous `ListTargetSites` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTargetSites` must match the call that provided the page token.
|
|
7405
|
+
*/
|
|
7406
|
+
pageToken?: string;
|
|
7407
|
+
/**
|
|
7408
|
+
* Required. The parent site search engine resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. If the caller does not have permission to list TargetSites under this site search engine, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.
|
|
7409
|
+
*/
|
|
7410
|
+
parent?: string;
|
|
7411
|
+
}
|
|
7412
|
+
export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch extends StandardParameters {
|
|
7413
|
+
/**
|
|
7414
|
+
* 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.
|
|
7415
|
+
*/
|
|
7416
|
+
name?: string;
|
|
7417
|
+
/**
|
|
7418
|
+
* Request body metadata
|
|
7419
|
+
*/
|
|
7420
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaTargetSite;
|
|
7421
|
+
}
|
|
7422
|
+
export class Resource$Projects$Locations$Datastores$Suggestiondenylistentries {
|
|
7423
|
+
context: APIRequestContext;
|
|
7424
|
+
constructor(context: APIRequestContext);
|
|
7425
|
+
/**
|
|
7426
|
+
* Imports all SuggestionDenyListEntry for a DataStore.
|
|
7427
|
+
*
|
|
7428
|
+
* @param params - Parameters for request
|
|
7429
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
7430
|
+
* @param callback - Optional callback that handles the response.
|
|
7431
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
7432
|
+
*/
|
|
7433
|
+
import(params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
7434
|
+
import(params?: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
7435
|
+
import(params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
7436
|
+
import(params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
7437
|
+
import(params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
7438
|
+
import(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
7439
|
+
/**
|
|
7440
|
+
* Permanently deletes all SuggestionDenyListEntry for a DataStore.
|
|
7441
|
+
*
|
|
7442
|
+
* @param params - Parameters for request
|
|
7443
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
7444
|
+
* @param callback - Optional callback that handles the response.
|
|
7445
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
7446
|
+
*/
|
|
7447
|
+
purge(params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
7448
|
+
purge(params?: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
7449
|
+
purge(params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
7450
|
+
purge(params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
7451
|
+
purge(params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
7452
|
+
purge(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
7453
|
+
}
|
|
7454
|
+
export interface Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import extends StandardParameters {
|
|
7455
|
+
/**
|
|
7456
|
+
* Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x.
|
|
7457
|
+
*/
|
|
7458
|
+
parent?: string;
|
|
7459
|
+
/**
|
|
7460
|
+
* Request body metadata
|
|
7461
|
+
*/
|
|
7462
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesRequest;
|
|
7463
|
+
}
|
|
7464
|
+
export interface Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge extends StandardParameters {
|
|
7465
|
+
/**
|
|
7466
|
+
* Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x.
|
|
7467
|
+
*/
|
|
7468
|
+
parent?: string;
|
|
7469
|
+
/**
|
|
7470
|
+
* Request body metadata
|
|
7471
|
+
*/
|
|
7472
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesRequest;
|
|
7473
|
+
}
|
|
4977
7474
|
export class Resource$Projects$Locations$Datastores$Userevents {
|
|
4978
7475
|
context: APIRequestContext;
|
|
4979
7476
|
constructor(context: APIRequestContext);
|