@googleapis/discoveryengine 5.0.0 → 6.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +11 -0
- package/build/v1alpha.d.ts +1233 -127
- package/build/v1alpha.js +144 -0
- package/build/v1alpha.js.map +1 -1
- package/build/v1beta.d.ts +2284 -149
- package/build/v1beta.js +1558 -218
- package/build/v1beta.js.map +1 -1
- package/package.json +1 -1
- package/v1alpha.ts +1662 -212
- package/v1beta.ts +8829 -3274
package/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,11 +1675,165 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1356
1675
|
values?: number[] | null;
|
|
1357
1676
|
}
|
|
1358
1677
|
/**
|
|
1359
|
-
*
|
|
1678
|
+
* Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
1360
1679
|
*/
|
|
1361
|
-
export interface Schema$
|
|
1680
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata {
|
|
1362
1681
|
/**
|
|
1363
|
-
*
|
|
1682
|
+
* Operation create time.
|
|
1683
|
+
*/
|
|
1684
|
+
createTime?: string | null;
|
|
1685
|
+
/**
|
|
1686
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
1687
|
+
*/
|
|
1688
|
+
updateTime?: string | null;
|
|
1689
|
+
}
|
|
1690
|
+
/**
|
|
1691
|
+
* Request message for SiteSearchEngineService.EnableAdvancedSiteSearch method.
|
|
1692
|
+
*/
|
|
1693
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchRequest {
|
|
1694
|
+
}
|
|
1695
|
+
/**
|
|
1696
|
+
* Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.
|
|
1697
|
+
*/
|
|
1698
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchResponse {
|
|
1699
|
+
}
|
|
1700
|
+
/**
|
|
1701
|
+
* Metadata that describes the training and serving parameters of an Engine.
|
|
1702
|
+
*/
|
|
1703
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaEngine {
|
|
1704
|
+
/**
|
|
1705
|
+
* Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
|
|
1706
|
+
*/
|
|
1707
|
+
chatEngineConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig;
|
|
1708
|
+
/**
|
|
1709
|
+
* Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
|
|
1710
|
+
*/
|
|
1711
|
+
chatEngineMetadata?: Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata;
|
|
1712
|
+
/**
|
|
1713
|
+
* Common config spec that specifies the metadata of the engine.
|
|
1714
|
+
*/
|
|
1715
|
+
commonConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineCommonConfig;
|
|
1716
|
+
/**
|
|
1717
|
+
* Output only. Timestamp the Recommendation Engine was created at.
|
|
1718
|
+
*/
|
|
1719
|
+
createTime?: string | null;
|
|
1720
|
+
/**
|
|
1721
|
+
* 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.
|
|
1722
|
+
*/
|
|
1723
|
+
dataStoreIds?: string[] | null;
|
|
1724
|
+
/**
|
|
1725
|
+
* Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
|
|
1726
|
+
*/
|
|
1727
|
+
displayName?: string | null;
|
|
1728
|
+
/**
|
|
1729
|
+
* 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.
|
|
1730
|
+
*/
|
|
1731
|
+
industryVertical?: string | null;
|
|
1732
|
+
/**
|
|
1733
|
+
* 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.
|
|
1734
|
+
*/
|
|
1735
|
+
name?: string | null;
|
|
1736
|
+
/**
|
|
1737
|
+
* Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
|
|
1738
|
+
*/
|
|
1739
|
+
searchEngineConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig;
|
|
1740
|
+
/**
|
|
1741
|
+
* Required. The solutions of the engine.
|
|
1742
|
+
*/
|
|
1743
|
+
solutionType?: string | null;
|
|
1744
|
+
/**
|
|
1745
|
+
* Output only. Timestamp the Recommendation Engine was last updated.
|
|
1746
|
+
*/
|
|
1747
|
+
updateTime?: string | null;
|
|
1748
|
+
}
|
|
1749
|
+
/**
|
|
1750
|
+
* Configurations for a Chat Engine.
|
|
1751
|
+
*/
|
|
1752
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig {
|
|
1753
|
+
/**
|
|
1754
|
+
* 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.
|
|
1755
|
+
*/
|
|
1756
|
+
agentCreationConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig;
|
|
1757
|
+
/**
|
|
1758
|
+
* 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.
|
|
1759
|
+
*/
|
|
1760
|
+
dialogflowAgentToLink?: string | null;
|
|
1761
|
+
}
|
|
1762
|
+
/**
|
|
1763
|
+
* 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.
|
|
1764
|
+
*/
|
|
1765
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig {
|
|
1766
|
+
/**
|
|
1767
|
+
* Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.
|
|
1768
|
+
*/
|
|
1769
|
+
business?: string | null;
|
|
1770
|
+
/**
|
|
1771
|
+
* 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.
|
|
1772
|
+
*/
|
|
1773
|
+
defaultLanguageCode?: string | null;
|
|
1774
|
+
/**
|
|
1775
|
+
* 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.
|
|
1776
|
+
*/
|
|
1777
|
+
location?: string | null;
|
|
1778
|
+
/**
|
|
1779
|
+
* 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.
|
|
1780
|
+
*/
|
|
1781
|
+
timeZone?: string | null;
|
|
1782
|
+
}
|
|
1783
|
+
/**
|
|
1784
|
+
* Additional information of a Chat Engine. Fields in this message are output only.
|
|
1785
|
+
*/
|
|
1786
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata {
|
|
1787
|
+
/**
|
|
1788
|
+
* The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.
|
|
1789
|
+
*/
|
|
1790
|
+
dialogflowAgent?: string | null;
|
|
1791
|
+
}
|
|
1792
|
+
/**
|
|
1793
|
+
* Common configurations for an Engine.
|
|
1794
|
+
*/
|
|
1795
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaEngineCommonConfig {
|
|
1796
|
+
/**
|
|
1797
|
+
* Immutable. The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.
|
|
1798
|
+
*/
|
|
1799
|
+
companyName?: string | null;
|
|
1800
|
+
}
|
|
1801
|
+
/**
|
|
1802
|
+
* Configurations for a Search Engine.
|
|
1803
|
+
*/
|
|
1804
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig {
|
|
1805
|
+
/**
|
|
1806
|
+
* The add-on that this search engine enables.
|
|
1807
|
+
*/
|
|
1808
|
+
searchAddOns?: string[] | null;
|
|
1809
|
+
/**
|
|
1810
|
+
* 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.
|
|
1811
|
+
*/
|
|
1812
|
+
searchTier?: string | null;
|
|
1813
|
+
}
|
|
1814
|
+
/**
|
|
1815
|
+
* Response message for SiteSearchEngineService.FetchDomainVerificationStatus method.
|
|
1816
|
+
*/
|
|
1817
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaFetchDomainVerificationStatusResponse {
|
|
1818
|
+
/**
|
|
1819
|
+
* A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
|
|
1820
|
+
*/
|
|
1821
|
+
nextPageToken?: string | null;
|
|
1822
|
+
/**
|
|
1823
|
+
* List of TargetSites containing the site verification status.
|
|
1824
|
+
*/
|
|
1825
|
+
targetSites?: Schema$GoogleCloudDiscoveryengineV1betaTargetSite[];
|
|
1826
|
+
/**
|
|
1827
|
+
* The total number of items matching the request. This will always be populated in the response.
|
|
1828
|
+
*/
|
|
1829
|
+
totalSize?: number | null;
|
|
1830
|
+
}
|
|
1831
|
+
/**
|
|
1832
|
+
* Cloud Storage location for input content.
|
|
1833
|
+
*/
|
|
1834
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaGcsSource {
|
|
1835
|
+
/**
|
|
1836
|
+
* 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.
|
|
1364
1837
|
*/
|
|
1365
1838
|
dataSchema?: string | null;
|
|
1366
1839
|
/**
|
|
@@ -1453,6 +1926,58 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1453
1926
|
*/
|
|
1454
1927
|
gcsPrefix?: string | null;
|
|
1455
1928
|
}
|
|
1929
|
+
/**
|
|
1930
|
+
* Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
1931
|
+
*/
|
|
1932
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata {
|
|
1933
|
+
/**
|
|
1934
|
+
* Operation create time.
|
|
1935
|
+
*/
|
|
1936
|
+
createTime?: string | null;
|
|
1937
|
+
/**
|
|
1938
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
1939
|
+
*/
|
|
1940
|
+
updateTime?: string | null;
|
|
1941
|
+
}
|
|
1942
|
+
/**
|
|
1943
|
+
* Request message for CompletionService.ImportSuggestionDenyListEntries method.
|
|
1944
|
+
*/
|
|
1945
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesRequest {
|
|
1946
|
+
/**
|
|
1947
|
+
* 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.
|
|
1948
|
+
*/
|
|
1949
|
+
gcsSource?: Schema$GoogleCloudDiscoveryengineV1betaGcsSource;
|
|
1950
|
+
/**
|
|
1951
|
+
* The Inline source for the input content for suggestion deny list entries.
|
|
1952
|
+
*/
|
|
1953
|
+
inlineSource?: Schema$GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesRequestInlineSource;
|
|
1954
|
+
}
|
|
1955
|
+
/**
|
|
1956
|
+
* The inline source for SuggestionDenyListEntry.
|
|
1957
|
+
*/
|
|
1958
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesRequestInlineSource {
|
|
1959
|
+
/**
|
|
1960
|
+
* Required. A list of all denylist entries to import. Max of 1000 items.
|
|
1961
|
+
*/
|
|
1962
|
+
entries?: Schema$GoogleCloudDiscoveryengineV1betaSuggestionDenyListEntry[];
|
|
1963
|
+
}
|
|
1964
|
+
/**
|
|
1965
|
+
* Response message for CompletionService.ImportSuggestionDenyListEntries method.
|
|
1966
|
+
*/
|
|
1967
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesResponse {
|
|
1968
|
+
/**
|
|
1969
|
+
* A sample of errors encountered while processing the request.
|
|
1970
|
+
*/
|
|
1971
|
+
errorSamples?: Schema$GoogleRpcStatus[];
|
|
1972
|
+
/**
|
|
1973
|
+
* Count of deny list entries that failed to be imported.
|
|
1974
|
+
*/
|
|
1975
|
+
failedEntriesCount?: string | null;
|
|
1976
|
+
/**
|
|
1977
|
+
* Count of deny list entries successfully imported.
|
|
1978
|
+
*/
|
|
1979
|
+
importedEntriesCount?: string | null;
|
|
1980
|
+
}
|
|
1456
1981
|
/**
|
|
1457
1982
|
* Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
1458
1983
|
*/
|
|
@@ -1559,6 +2084,19 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1559
2084
|
*/
|
|
1560
2085
|
nextPageToken?: string | null;
|
|
1561
2086
|
}
|
|
2087
|
+
/**
|
|
2088
|
+
* Response message for DataStoreService.ListDataStores method.
|
|
2089
|
+
*/
|
|
2090
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaListDataStoresResponse {
|
|
2091
|
+
/**
|
|
2092
|
+
* All the customer's DataStores.
|
|
2093
|
+
*/
|
|
2094
|
+
dataStores?: Schema$GoogleCloudDiscoveryengineV1betaDataStore[];
|
|
2095
|
+
/**
|
|
2096
|
+
* 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.
|
|
2097
|
+
*/
|
|
2098
|
+
nextPageToken?: string | null;
|
|
2099
|
+
}
|
|
1562
2100
|
/**
|
|
1563
2101
|
* Response message for DocumentService.ListDocuments method.
|
|
1564
2102
|
*/
|
|
@@ -1572,6 +2110,19 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1572
2110
|
*/
|
|
1573
2111
|
nextPageToken?: string | null;
|
|
1574
2112
|
}
|
|
2113
|
+
/**
|
|
2114
|
+
* Response message for EngineService.ListEngines method.
|
|
2115
|
+
*/
|
|
2116
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaListEnginesResponse {
|
|
2117
|
+
/**
|
|
2118
|
+
* All the customer's Engines.
|
|
2119
|
+
*/
|
|
2120
|
+
engines?: Schema$GoogleCloudDiscoveryengineV1betaEngine[];
|
|
2121
|
+
/**
|
|
2122
|
+
* Not supported.
|
|
2123
|
+
*/
|
|
2124
|
+
nextPageToken?: string | null;
|
|
2125
|
+
}
|
|
1575
2126
|
/**
|
|
1576
2127
|
* Response message for SchemaService.ListSchemas method.
|
|
1577
2128
|
*/
|
|
@@ -1585,6 +2136,23 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1585
2136
|
*/
|
|
1586
2137
|
schemas?: Schema$GoogleCloudDiscoveryengineV1betaSchema[];
|
|
1587
2138
|
}
|
|
2139
|
+
/**
|
|
2140
|
+
* Response message for SiteSearchEngineService.ListTargetSites method.
|
|
2141
|
+
*/
|
|
2142
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaListTargetSitesResponse {
|
|
2143
|
+
/**
|
|
2144
|
+
* A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
|
|
2145
|
+
*/
|
|
2146
|
+
nextPageToken?: string | null;
|
|
2147
|
+
/**
|
|
2148
|
+
* List of TargetSites.
|
|
2149
|
+
*/
|
|
2150
|
+
targetSites?: Schema$GoogleCloudDiscoveryengineV1betaTargetSite[];
|
|
2151
|
+
/**
|
|
2152
|
+
* The total number of items matching the request. This will always be populated in the response.
|
|
2153
|
+
*/
|
|
2154
|
+
totalSize?: number | null;
|
|
2155
|
+
}
|
|
1588
2156
|
/**
|
|
1589
2157
|
* Media-specific user event information.
|
|
1590
2158
|
*/
|
|
@@ -1687,6 +2255,37 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1687
2255
|
*/
|
|
1688
2256
|
purgeSample?: string[] | null;
|
|
1689
2257
|
}
|
|
2258
|
+
/**
|
|
2259
|
+
* Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
2260
|
+
*/
|
|
2261
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata {
|
|
2262
|
+
/**
|
|
2263
|
+
* Operation create time.
|
|
2264
|
+
*/
|
|
2265
|
+
createTime?: string | null;
|
|
2266
|
+
/**
|
|
2267
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
2268
|
+
*/
|
|
2269
|
+
updateTime?: string | null;
|
|
2270
|
+
}
|
|
2271
|
+
/**
|
|
2272
|
+
* Request message for CompletionService.PurgeSuggestionDenyListEntries method.
|
|
2273
|
+
*/
|
|
2274
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesRequest {
|
|
2275
|
+
}
|
|
2276
|
+
/**
|
|
2277
|
+
* Response message for CompletionService.PurgeSuggestionDenyListEntries method.
|
|
2278
|
+
*/
|
|
2279
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse {
|
|
2280
|
+
/**
|
|
2281
|
+
* A sample of errors encountered while processing the request.
|
|
2282
|
+
*/
|
|
2283
|
+
errorSamples?: Schema$GoogleRpcStatus[];
|
|
2284
|
+
/**
|
|
2285
|
+
* Number of suggestion deny list entries purged.
|
|
2286
|
+
*/
|
|
2287
|
+
purgeCount?: string | null;
|
|
2288
|
+
}
|
|
1690
2289
|
/**
|
|
1691
2290
|
* Request message for Recommend method.
|
|
1692
2291
|
*/
|
|
@@ -1760,6 +2359,15 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1760
2359
|
[key: string]: any;
|
|
1761
2360
|
} | null;
|
|
1762
2361
|
}
|
|
2362
|
+
/**
|
|
2363
|
+
* Request message for SiteSearchEngineService.RecrawlUris method.
|
|
2364
|
+
*/
|
|
2365
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaRecrawlUrisRequest {
|
|
2366
|
+
/**
|
|
2367
|
+
* 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`.
|
|
2368
|
+
*/
|
|
2369
|
+
uris?: string[] | null;
|
|
2370
|
+
}
|
|
1763
2371
|
/**
|
|
1764
2372
|
* Defines a reply message to user.
|
|
1765
2373
|
*/
|
|
@@ -1855,7 +2463,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1855
2463
|
*/
|
|
1856
2464
|
contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec;
|
|
1857
2465
|
/**
|
|
1858
|
-
* Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.
|
|
2466
|
+
* 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
2467
|
*/
|
|
1860
2468
|
embeddingSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec;
|
|
1861
2469
|
/**
|
|
@@ -1971,7 +2579,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1971
2579
|
*/
|
|
1972
2580
|
export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec {
|
|
1973
2581
|
/**
|
|
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
|
|
2582
|
+
* 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
2583
|
*/
|
|
1976
2584
|
maxExtractiveAnswerCount?: number | null;
|
|
1977
2585
|
/**
|
|
@@ -2051,7 +2659,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2051
2659
|
*/
|
|
2052
2660
|
export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec {
|
|
2053
2661
|
/**
|
|
2054
|
-
* The string
|
|
2662
|
+
* The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned version of the text-bison@001 model. * `preview`: string. (Public preview) Uses a fine-tuned version of the text-bison@002 model. This model works only for summaries in English.
|
|
2055
2663
|
*/
|
|
2056
2664
|
version?: string | null;
|
|
2057
2665
|
}
|
|
@@ -2383,7 +2991,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2383
2991
|
*/
|
|
2384
2992
|
title?: string | null;
|
|
2385
2993
|
/**
|
|
2386
|
-
*
|
|
2994
|
+
* Cloud Storage or HTTP uri for the document.
|
|
2387
2995
|
*/
|
|
2388
2996
|
uri?: string | null;
|
|
2389
2997
|
}
|
|
@@ -2418,42 +3026,133 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2418
3026
|
summary?: string | null;
|
|
2419
3027
|
}
|
|
2420
3028
|
/**
|
|
2421
|
-
*
|
|
3029
|
+
* SiteSearchEngine captures DataStore level site search persisting configurations. It is a singleton value per data store.
|
|
2422
3030
|
*/
|
|
2423
|
-
export interface Schema$
|
|
2424
|
-
/**
|
|
2425
|
-
* Conversation context of the input.
|
|
2426
|
-
*/
|
|
2427
|
-
context?: Schema$GoogleCloudDiscoveryengineV1betaConversationContext;
|
|
3031
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaSiteSearchEngine {
|
|
2428
3032
|
/**
|
|
2429
|
-
*
|
|
3033
|
+
* The fully qualified resource name of the site search engine. Format: `projects/x/locations/x/dataStores/x/siteSearchEngine`
|
|
2430
3034
|
*/
|
|
2431
|
-
|
|
3035
|
+
name?: string | null;
|
|
2432
3036
|
}
|
|
2433
3037
|
/**
|
|
2434
|
-
*
|
|
3038
|
+
* Verification information for target sites in advanced site search.
|
|
2435
3039
|
*/
|
|
2436
|
-
export interface Schema$
|
|
3040
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaSiteVerificationInfo {
|
|
2437
3041
|
/**
|
|
2438
|
-
*
|
|
3042
|
+
* Site verification state indicating the ownership and validity.
|
|
2439
3043
|
*/
|
|
2440
|
-
|
|
3044
|
+
siteVerificationState?: string | null;
|
|
2441
3045
|
/**
|
|
2442
|
-
*
|
|
3046
|
+
* Latest site verification time.
|
|
2443
3047
|
*/
|
|
2444
|
-
|
|
3048
|
+
verifyTime?: string | null;
|
|
3049
|
+
}
|
|
3050
|
+
/**
|
|
3051
|
+
* Suggestion deny list entry identifying the phrase to block from suggestions and the applied operation for the phrase.
|
|
3052
|
+
*/
|
|
3053
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaSuggestionDenyListEntry {
|
|
2445
3054
|
/**
|
|
2446
|
-
*
|
|
3055
|
+
* Required. Phrase to block from suggestions served. Can be maximum 125 characters.
|
|
2447
3056
|
*/
|
|
2448
|
-
|
|
3057
|
+
blockPhrase?: string | null;
|
|
2449
3058
|
/**
|
|
2450
|
-
*
|
|
3059
|
+
* Required. The match operator to apply for this phrase. Whether to block the exact phrase, or block any suggestions containing this phrase.
|
|
2451
3060
|
*/
|
|
2452
|
-
|
|
3061
|
+
matchOperator?: string | null;
|
|
3062
|
+
}
|
|
3063
|
+
/**
|
|
3064
|
+
* A target site for the SiteSearchEngine.
|
|
3065
|
+
*/
|
|
3066
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaTargetSite {
|
|
2453
3067
|
/**
|
|
2454
|
-
*
|
|
3068
|
+
* 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.
|
|
2455
3069
|
*/
|
|
2456
|
-
|
|
3070
|
+
exactMatch?: boolean | null;
|
|
3071
|
+
/**
|
|
3072
|
+
* Output only. Failure reason.
|
|
3073
|
+
*/
|
|
3074
|
+
failureReason?: Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReason;
|
|
3075
|
+
/**
|
|
3076
|
+
* Output only. This is system-generated based on the provided_uri_pattern.
|
|
3077
|
+
*/
|
|
3078
|
+
generatedUriPattern?: string | null;
|
|
3079
|
+
/**
|
|
3080
|
+
* Output only. Indexing status.
|
|
3081
|
+
*/
|
|
3082
|
+
indexingStatus?: string | null;
|
|
3083
|
+
/**
|
|
3084
|
+
* 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.
|
|
3085
|
+
*/
|
|
3086
|
+
name?: string | null;
|
|
3087
|
+
/**
|
|
3088
|
+
* Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated.
|
|
3089
|
+
*/
|
|
3090
|
+
providedUriPattern?: string | null;
|
|
3091
|
+
/**
|
|
3092
|
+
* Output only. Site ownership and validity verification status.
|
|
3093
|
+
*/
|
|
3094
|
+
siteVerificationInfo?: Schema$GoogleCloudDiscoveryengineV1betaSiteVerificationInfo;
|
|
3095
|
+
/**
|
|
3096
|
+
* The type of the target site, e.g., whether the site is to be included or excluded.
|
|
3097
|
+
*/
|
|
3098
|
+
type?: string | null;
|
|
3099
|
+
/**
|
|
3100
|
+
* Output only. The target site's last updated time.
|
|
3101
|
+
*/
|
|
3102
|
+
updateTime?: string | null;
|
|
3103
|
+
}
|
|
3104
|
+
/**
|
|
3105
|
+
* Site search indexing failure reasons.
|
|
3106
|
+
*/
|
|
3107
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReason {
|
|
3108
|
+
/**
|
|
3109
|
+
* Failed due to insufficient quota.
|
|
3110
|
+
*/
|
|
3111
|
+
quotaFailure?: Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure;
|
|
3112
|
+
}
|
|
3113
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure {
|
|
3114
|
+
/**
|
|
3115
|
+
* This number is an estimation on how much total quota this project needs to successfully complete indexing.
|
|
3116
|
+
*/
|
|
3117
|
+
totalRequiredQuota?: string | null;
|
|
3118
|
+
}
|
|
3119
|
+
/**
|
|
3120
|
+
* Defines text input.
|
|
3121
|
+
*/
|
|
3122
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaTextInput {
|
|
3123
|
+
/**
|
|
3124
|
+
* Conversation context of the input.
|
|
3125
|
+
*/
|
|
3126
|
+
context?: Schema$GoogleCloudDiscoveryengineV1betaConversationContext;
|
|
3127
|
+
/**
|
|
3128
|
+
* Text input.
|
|
3129
|
+
*/
|
|
3130
|
+
input?: string | null;
|
|
3131
|
+
}
|
|
3132
|
+
/**
|
|
3133
|
+
* A transaction represents the entire purchase transaction.
|
|
3134
|
+
*/
|
|
3135
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaTransactionInfo {
|
|
3136
|
+
/**
|
|
3137
|
+
* 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
|
|
3138
|
+
*/
|
|
3139
|
+
cost?: number | null;
|
|
3140
|
+
/**
|
|
3141
|
+
* Required. Currency code. Use three-character ISO-4217 code.
|
|
3142
|
+
*/
|
|
3143
|
+
currency?: string | null;
|
|
3144
|
+
/**
|
|
3145
|
+
* 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
|
|
3146
|
+
*/
|
|
3147
|
+
discountValue?: number | null;
|
|
3148
|
+
/**
|
|
3149
|
+
* All the taxes associated with the transaction.
|
|
3150
|
+
*/
|
|
3151
|
+
tax?: number | null;
|
|
3152
|
+
/**
|
|
3153
|
+
* The transaction ID with a length limit of 128 characters.
|
|
3154
|
+
*/
|
|
3155
|
+
transactionId?: string | null;
|
|
2457
3156
|
/**
|
|
2458
3157
|
* Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include.
|
|
2459
3158
|
*/
|
|
@@ -2472,6 +3171,19 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2472
3171
|
*/
|
|
2473
3172
|
updateTime?: string | null;
|
|
2474
3173
|
}
|
|
3174
|
+
/**
|
|
3175
|
+
* Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3176
|
+
*/
|
|
3177
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaUpdateTargetSiteMetadata {
|
|
3178
|
+
/**
|
|
3179
|
+
* Operation create time.
|
|
3180
|
+
*/
|
|
3181
|
+
createTime?: string | null;
|
|
3182
|
+
/**
|
|
3183
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3184
|
+
*/
|
|
3185
|
+
updateTime?: string | null;
|
|
3186
|
+
}
|
|
2475
3187
|
/**
|
|
2476
3188
|
* UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with customers' website.
|
|
2477
3189
|
*/
|
|
@@ -2507,7 +3219,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2507
3219
|
*/
|
|
2508
3220
|
eventType?: string | null;
|
|
2509
3221
|
/**
|
|
2510
|
-
* 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
|
|
3222
|
+
* 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.
|
|
2511
3223
|
*/
|
|
2512
3224
|
filter?: string | null;
|
|
2513
3225
|
/**
|
|
@@ -2564,6 +3276,32 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2564
3276
|
*/
|
|
2565
3277
|
userId?: string | null;
|
|
2566
3278
|
}
|
|
3279
|
+
/**
|
|
3280
|
+
* Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3281
|
+
*/
|
|
3282
|
+
export interface Schema$GoogleCloudDiscoveryengineV1CreateDataStoreMetadata {
|
|
3283
|
+
/**
|
|
3284
|
+
* Operation create time.
|
|
3285
|
+
*/
|
|
3286
|
+
createTime?: string | null;
|
|
3287
|
+
/**
|
|
3288
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3289
|
+
*/
|
|
3290
|
+
updateTime?: string | null;
|
|
3291
|
+
}
|
|
3292
|
+
/**
|
|
3293
|
+
* Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3294
|
+
*/
|
|
3295
|
+
export interface Schema$GoogleCloudDiscoveryengineV1CreateEngineMetadata {
|
|
3296
|
+
/**
|
|
3297
|
+
* Operation create time.
|
|
3298
|
+
*/
|
|
3299
|
+
createTime?: string | null;
|
|
3300
|
+
/**
|
|
3301
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3302
|
+
*/
|
|
3303
|
+
updateTime?: string | null;
|
|
3304
|
+
}
|
|
2567
3305
|
/**
|
|
2568
3306
|
* Metadata for Create Schema LRO.
|
|
2569
3307
|
*/
|
|
@@ -2577,6 +3315,78 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2577
3315
|
*/
|
|
2578
3316
|
updateTime?: string | null;
|
|
2579
3317
|
}
|
|
3318
|
+
/**
|
|
3319
|
+
* Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3320
|
+
*/
|
|
3321
|
+
export interface Schema$GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata {
|
|
3322
|
+
/**
|
|
3323
|
+
* Operation create time.
|
|
3324
|
+
*/
|
|
3325
|
+
createTime?: string | null;
|
|
3326
|
+
/**
|
|
3327
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3328
|
+
*/
|
|
3329
|
+
updateTime?: string | null;
|
|
3330
|
+
}
|
|
3331
|
+
/**
|
|
3332
|
+
* DataStore captures global settings and configs at the DataStore level.
|
|
3333
|
+
*/
|
|
3334
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DataStore {
|
|
3335
|
+
/**
|
|
3336
|
+
* Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
|
|
3337
|
+
*/
|
|
3338
|
+
contentConfig?: string | null;
|
|
3339
|
+
/**
|
|
3340
|
+
* Output only. Timestamp the DataStore was created at.
|
|
3341
|
+
*/
|
|
3342
|
+
createTime?: string | null;
|
|
3343
|
+
/**
|
|
3344
|
+
* Output only. The id of the default Schema asscociated to this data store.
|
|
3345
|
+
*/
|
|
3346
|
+
defaultSchemaId?: string | null;
|
|
3347
|
+
/**
|
|
3348
|
+
* 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.
|
|
3349
|
+
*/
|
|
3350
|
+
displayName?: string | null;
|
|
3351
|
+
/**
|
|
3352
|
+
* Immutable. The industry vertical that the data store registers.
|
|
3353
|
+
*/
|
|
3354
|
+
industryVertical?: string | null;
|
|
3355
|
+
/**
|
|
3356
|
+
* 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.
|
|
3357
|
+
*/
|
|
3358
|
+
name?: string | null;
|
|
3359
|
+
/**
|
|
3360
|
+
* 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.
|
|
3361
|
+
*/
|
|
3362
|
+
solutionTypes?: string[] | null;
|
|
3363
|
+
}
|
|
3364
|
+
/**
|
|
3365
|
+
* Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3366
|
+
*/
|
|
3367
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata {
|
|
3368
|
+
/**
|
|
3369
|
+
* Operation create time.
|
|
3370
|
+
*/
|
|
3371
|
+
createTime?: string | null;
|
|
3372
|
+
/**
|
|
3373
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3374
|
+
*/
|
|
3375
|
+
updateTime?: string | null;
|
|
3376
|
+
}
|
|
3377
|
+
/**
|
|
3378
|
+
* Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3379
|
+
*/
|
|
3380
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DeleteEngineMetadata {
|
|
3381
|
+
/**
|
|
3382
|
+
* Operation create time.
|
|
3383
|
+
*/
|
|
3384
|
+
createTime?: string | null;
|
|
3385
|
+
/**
|
|
3386
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3387
|
+
*/
|
|
3388
|
+
updateTime?: string | null;
|
|
3389
|
+
}
|
|
2580
3390
|
/**
|
|
2581
3391
|
* Metadata for DeleteSchema LRO.
|
|
2582
3392
|
*/
|
|
@@ -2590,6 +3400,169 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2590
3400
|
*/
|
|
2591
3401
|
updateTime?: string | null;
|
|
2592
3402
|
}
|
|
3403
|
+
/**
|
|
3404
|
+
* Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3405
|
+
*/
|
|
3406
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata {
|
|
3407
|
+
/**
|
|
3408
|
+
* Operation create time.
|
|
3409
|
+
*/
|
|
3410
|
+
createTime?: string | null;
|
|
3411
|
+
/**
|
|
3412
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3413
|
+
*/
|
|
3414
|
+
updateTime?: string | null;
|
|
3415
|
+
}
|
|
3416
|
+
/**
|
|
3417
|
+
* Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3418
|
+
*/
|
|
3419
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata {
|
|
3420
|
+
/**
|
|
3421
|
+
* Operation create time.
|
|
3422
|
+
*/
|
|
3423
|
+
createTime?: string | null;
|
|
3424
|
+
/**
|
|
3425
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3426
|
+
*/
|
|
3427
|
+
updateTime?: string | null;
|
|
3428
|
+
}
|
|
3429
|
+
/**
|
|
3430
|
+
* Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.
|
|
3431
|
+
*/
|
|
3432
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse {
|
|
3433
|
+
}
|
|
3434
|
+
/**
|
|
3435
|
+
* Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3436
|
+
*/
|
|
3437
|
+
export interface Schema$GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata {
|
|
3438
|
+
/**
|
|
3439
|
+
* Operation create time.
|
|
3440
|
+
*/
|
|
3441
|
+
createTime?: string | null;
|
|
3442
|
+
/**
|
|
3443
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3444
|
+
*/
|
|
3445
|
+
updateTime?: string | null;
|
|
3446
|
+
}
|
|
3447
|
+
/**
|
|
3448
|
+
* Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.
|
|
3449
|
+
*/
|
|
3450
|
+
export interface Schema$GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchResponse {
|
|
3451
|
+
}
|
|
3452
|
+
/**
|
|
3453
|
+
* Metadata that describes the training and serving parameters of an Engine.
|
|
3454
|
+
*/
|
|
3455
|
+
export interface Schema$GoogleCloudDiscoveryengineV1Engine {
|
|
3456
|
+
/**
|
|
3457
|
+
* Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
|
|
3458
|
+
*/
|
|
3459
|
+
chatEngineConfig?: Schema$GoogleCloudDiscoveryengineV1EngineChatEngineConfig;
|
|
3460
|
+
/**
|
|
3461
|
+
* Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
|
|
3462
|
+
*/
|
|
3463
|
+
chatEngineMetadata?: Schema$GoogleCloudDiscoveryengineV1EngineChatEngineMetadata;
|
|
3464
|
+
/**
|
|
3465
|
+
* Common config spec that specifies the metadata of the engine.
|
|
3466
|
+
*/
|
|
3467
|
+
commonConfig?: Schema$GoogleCloudDiscoveryengineV1EngineCommonConfig;
|
|
3468
|
+
/**
|
|
3469
|
+
* Output only. Timestamp the Recommendation Engine was created at.
|
|
3470
|
+
*/
|
|
3471
|
+
createTime?: string | null;
|
|
3472
|
+
/**
|
|
3473
|
+
* 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.
|
|
3474
|
+
*/
|
|
3475
|
+
dataStoreIds?: string[] | null;
|
|
3476
|
+
/**
|
|
3477
|
+
* Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
|
|
3478
|
+
*/
|
|
3479
|
+
displayName?: string | null;
|
|
3480
|
+
/**
|
|
3481
|
+
* 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.
|
|
3482
|
+
*/
|
|
3483
|
+
industryVertical?: string | null;
|
|
3484
|
+
/**
|
|
3485
|
+
* 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.
|
|
3486
|
+
*/
|
|
3487
|
+
name?: string | null;
|
|
3488
|
+
/**
|
|
3489
|
+
* Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
|
|
3490
|
+
*/
|
|
3491
|
+
searchEngineConfig?: Schema$GoogleCloudDiscoveryengineV1EngineSearchEngineConfig;
|
|
3492
|
+
/**
|
|
3493
|
+
* Required. The solutions of the engine.
|
|
3494
|
+
*/
|
|
3495
|
+
solutionType?: string | null;
|
|
3496
|
+
/**
|
|
3497
|
+
* Output only. Timestamp the Recommendation Engine was last updated.
|
|
3498
|
+
*/
|
|
3499
|
+
updateTime?: string | null;
|
|
3500
|
+
}
|
|
3501
|
+
/**
|
|
3502
|
+
* Configurations for a Chat Engine.
|
|
3503
|
+
*/
|
|
3504
|
+
export interface Schema$GoogleCloudDiscoveryengineV1EngineChatEngineConfig {
|
|
3505
|
+
/**
|
|
3506
|
+
* 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.
|
|
3507
|
+
*/
|
|
3508
|
+
agentCreationConfig?: Schema$GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig;
|
|
3509
|
+
/**
|
|
3510
|
+
* 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.
|
|
3511
|
+
*/
|
|
3512
|
+
dialogflowAgentToLink?: string | null;
|
|
3513
|
+
}
|
|
3514
|
+
/**
|
|
3515
|
+
* 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.
|
|
3516
|
+
*/
|
|
3517
|
+
export interface Schema$GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig {
|
|
3518
|
+
/**
|
|
3519
|
+
* Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.
|
|
3520
|
+
*/
|
|
3521
|
+
business?: string | null;
|
|
3522
|
+
/**
|
|
3523
|
+
* 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.
|
|
3524
|
+
*/
|
|
3525
|
+
defaultLanguageCode?: string | null;
|
|
3526
|
+
/**
|
|
3527
|
+
* 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.
|
|
3528
|
+
*/
|
|
3529
|
+
location?: string | null;
|
|
3530
|
+
/**
|
|
3531
|
+
* 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.
|
|
3532
|
+
*/
|
|
3533
|
+
timeZone?: string | null;
|
|
3534
|
+
}
|
|
3535
|
+
/**
|
|
3536
|
+
* Additional information of a Chat Engine. Fields in this message are output only.
|
|
3537
|
+
*/
|
|
3538
|
+
export interface Schema$GoogleCloudDiscoveryengineV1EngineChatEngineMetadata {
|
|
3539
|
+
/**
|
|
3540
|
+
* The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.
|
|
3541
|
+
*/
|
|
3542
|
+
dialogflowAgent?: string | null;
|
|
3543
|
+
}
|
|
3544
|
+
/**
|
|
3545
|
+
* Common configurations for an Engine.
|
|
3546
|
+
*/
|
|
3547
|
+
export interface Schema$GoogleCloudDiscoveryengineV1EngineCommonConfig {
|
|
3548
|
+
/**
|
|
3549
|
+
* Immutable. The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.
|
|
3550
|
+
*/
|
|
3551
|
+
companyName?: string | null;
|
|
3552
|
+
}
|
|
3553
|
+
/**
|
|
3554
|
+
* Configurations for a Search Engine.
|
|
3555
|
+
*/
|
|
3556
|
+
export interface Schema$GoogleCloudDiscoveryengineV1EngineSearchEngineConfig {
|
|
3557
|
+
/**
|
|
3558
|
+
* The add-on that this search engine enables.
|
|
3559
|
+
*/
|
|
3560
|
+
searchAddOns?: string[] | null;
|
|
3561
|
+
/**
|
|
3562
|
+
* 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.
|
|
3563
|
+
*/
|
|
3564
|
+
searchTier?: string | null;
|
|
3565
|
+
}
|
|
2593
3566
|
/**
|
|
2594
3567
|
* Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
2595
3568
|
*/
|
|
@@ -2633,6 +3606,36 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2633
3606
|
*/
|
|
2634
3607
|
gcsPrefix?: string | null;
|
|
2635
3608
|
}
|
|
3609
|
+
/**
|
|
3610
|
+
* Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
3611
|
+
*/
|
|
3612
|
+
export interface Schema$GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesMetadata {
|
|
3613
|
+
/**
|
|
3614
|
+
* Operation create time.
|
|
3615
|
+
*/
|
|
3616
|
+
createTime?: string | null;
|
|
3617
|
+
/**
|
|
3618
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3619
|
+
*/
|
|
3620
|
+
updateTime?: string | null;
|
|
3621
|
+
}
|
|
3622
|
+
/**
|
|
3623
|
+
* Response message for CompletionService.ImportSuggestionDenyListEntries method.
|
|
3624
|
+
*/
|
|
3625
|
+
export interface Schema$GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesResponse {
|
|
3626
|
+
/**
|
|
3627
|
+
* A sample of errors encountered while processing the request.
|
|
3628
|
+
*/
|
|
3629
|
+
errorSamples?: Schema$GoogleRpcStatus[];
|
|
3630
|
+
/**
|
|
3631
|
+
* Count of deny list entries that failed to be imported.
|
|
3632
|
+
*/
|
|
3633
|
+
failedEntriesCount?: string | null;
|
|
3634
|
+
/**
|
|
3635
|
+
* Count of deny list entries successfully imported.
|
|
3636
|
+
*/
|
|
3637
|
+
importedEntriesCount?: string | null;
|
|
3638
|
+
}
|
|
2636
3639
|
/**
|
|
2637
3640
|
* Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
2638
3641
|
*/
|
|
@@ -2709,6 +3712,32 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2709
3712
|
*/
|
|
2710
3713
|
purgeSample?: string[] | null;
|
|
2711
3714
|
}
|
|
3715
|
+
/**
|
|
3716
|
+
* Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
3717
|
+
*/
|
|
3718
|
+
export interface Schema$GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata {
|
|
3719
|
+
/**
|
|
3720
|
+
* Operation create time.
|
|
3721
|
+
*/
|
|
3722
|
+
createTime?: string | null;
|
|
3723
|
+
/**
|
|
3724
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3725
|
+
*/
|
|
3726
|
+
updateTime?: string | null;
|
|
3727
|
+
}
|
|
3728
|
+
/**
|
|
3729
|
+
* Response message for CompletionService.PurgeSuggestionDenyListEntries method.
|
|
3730
|
+
*/
|
|
3731
|
+
export interface Schema$GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesResponse {
|
|
3732
|
+
/**
|
|
3733
|
+
* A sample of errors encountered while processing the request.
|
|
3734
|
+
*/
|
|
3735
|
+
errorSamples?: Schema$GoogleRpcStatus[];
|
|
3736
|
+
/**
|
|
3737
|
+
* Number of suggestion deny list entries purged.
|
|
3738
|
+
*/
|
|
3739
|
+
purgeCount?: string | null;
|
|
3740
|
+
}
|
|
2712
3741
|
/**
|
|
2713
3742
|
* Defines the structure and layout of a type of document data.
|
|
2714
3743
|
*/
|
|
@@ -2728,6 +3757,75 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2728
3757
|
[key: string]: any;
|
|
2729
3758
|
} | null;
|
|
2730
3759
|
}
|
|
3760
|
+
/**
|
|
3761
|
+
* Verification information for target sites in advanced site search.
|
|
3762
|
+
*/
|
|
3763
|
+
export interface Schema$GoogleCloudDiscoveryengineV1SiteVerificationInfo {
|
|
3764
|
+
/**
|
|
3765
|
+
* Site verification state indicating the ownership and validity.
|
|
3766
|
+
*/
|
|
3767
|
+
siteVerificationState?: string | null;
|
|
3768
|
+
/**
|
|
3769
|
+
* Latest site verification time.
|
|
3770
|
+
*/
|
|
3771
|
+
verifyTime?: string | null;
|
|
3772
|
+
}
|
|
3773
|
+
/**
|
|
3774
|
+
* A target site for the SiteSearchEngine.
|
|
3775
|
+
*/
|
|
3776
|
+
export interface Schema$GoogleCloudDiscoveryengineV1TargetSite {
|
|
3777
|
+
/**
|
|
3778
|
+
* 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.
|
|
3779
|
+
*/
|
|
3780
|
+
exactMatch?: boolean | null;
|
|
3781
|
+
/**
|
|
3782
|
+
* Output only. Failure reason.
|
|
3783
|
+
*/
|
|
3784
|
+
failureReason?: Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReason;
|
|
3785
|
+
/**
|
|
3786
|
+
* Output only. This is system-generated based on the provided_uri_pattern.
|
|
3787
|
+
*/
|
|
3788
|
+
generatedUriPattern?: string | null;
|
|
3789
|
+
/**
|
|
3790
|
+
* Output only. Indexing status.
|
|
3791
|
+
*/
|
|
3792
|
+
indexingStatus?: string | null;
|
|
3793
|
+
/**
|
|
3794
|
+
* 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.
|
|
3795
|
+
*/
|
|
3796
|
+
name?: string | null;
|
|
3797
|
+
/**
|
|
3798
|
+
* Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated.
|
|
3799
|
+
*/
|
|
3800
|
+
providedUriPattern?: string | null;
|
|
3801
|
+
/**
|
|
3802
|
+
* Output only. Site ownership and validity verification status.
|
|
3803
|
+
*/
|
|
3804
|
+
siteVerificationInfo?: Schema$GoogleCloudDiscoveryengineV1SiteVerificationInfo;
|
|
3805
|
+
/**
|
|
3806
|
+
* The type of the target site, e.g., whether the site is to be included or excluded.
|
|
3807
|
+
*/
|
|
3808
|
+
type?: string | null;
|
|
3809
|
+
/**
|
|
3810
|
+
* Output only. The target site's last updated time.
|
|
3811
|
+
*/
|
|
3812
|
+
updateTime?: string | null;
|
|
3813
|
+
}
|
|
3814
|
+
/**
|
|
3815
|
+
* Site search indexing failure reasons.
|
|
3816
|
+
*/
|
|
3817
|
+
export interface Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReason {
|
|
3818
|
+
/**
|
|
3819
|
+
* Failed due to insufficient quota.
|
|
3820
|
+
*/
|
|
3821
|
+
quotaFailure?: Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure;
|
|
3822
|
+
}
|
|
3823
|
+
export interface Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure {
|
|
3824
|
+
/**
|
|
3825
|
+
* This number is an estimation on how much total quota this project needs to successfully complete indexing.
|
|
3826
|
+
*/
|
|
3827
|
+
totalRequiredQuota?: string | null;
|
|
3828
|
+
}
|
|
2731
3829
|
/**
|
|
2732
3830
|
* Metadata for UpdateSchema LRO.
|
|
2733
3831
|
*/
|
|
@@ -2741,6 +3839,19 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2741
3839
|
*/
|
|
2742
3840
|
updateTime?: string | null;
|
|
2743
3841
|
}
|
|
3842
|
+
/**
|
|
3843
|
+
* Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3844
|
+
*/
|
|
3845
|
+
export interface Schema$GoogleCloudDiscoveryengineV1UpdateTargetSiteMetadata {
|
|
3846
|
+
/**
|
|
3847
|
+
* Operation create time.
|
|
3848
|
+
*/
|
|
3849
|
+
createTime?: string | null;
|
|
3850
|
+
/**
|
|
3851
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3852
|
+
*/
|
|
3853
|
+
updateTime?: string | null;
|
|
3854
|
+
}
|
|
2744
3855
|
/**
|
|
2745
3856
|
* The response message for Operations.ListOperations.
|
|
2746
3857
|
*/
|
|
@@ -2915,22 +4026,107 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2915
4026
|
schemas: Resource$Projects$Locations$Collections$Datastores$Schemas;
|
|
2916
4027
|
servingConfigs: Resource$Projects$Locations$Collections$Datastores$Servingconfigs;
|
|
2917
4028
|
siteSearchEngine: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine;
|
|
4029
|
+
suggestionDenyListEntries: Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries;
|
|
2918
4030
|
userEvents: Resource$Projects$Locations$Collections$Datastores$Userevents;
|
|
2919
4031
|
constructor(context: APIRequestContext);
|
|
2920
4032
|
/**
|
|
2921
|
-
* Completes the specified user input with keyword suggestions.
|
|
4033
|
+
* Completes the specified user input with keyword suggestions.
|
|
4034
|
+
*
|
|
4035
|
+
* @param params - Parameters for request
|
|
4036
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
4037
|
+
* @param callback - Optional callback that handles the response.
|
|
4038
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
4039
|
+
*/
|
|
4040
|
+
completeQuery(params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
4041
|
+
completeQuery(params?: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaCompleteQueryResponse>;
|
|
4042
|
+
completeQuery(params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
4043
|
+
completeQuery(params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaCompleteQueryResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaCompleteQueryResponse>): void;
|
|
4044
|
+
completeQuery(params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaCompleteQueryResponse>): void;
|
|
4045
|
+
completeQuery(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaCompleteQueryResponse>): void;
|
|
4046
|
+
/**
|
|
4047
|
+
* 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.
|
|
4048
|
+
*
|
|
4049
|
+
* @param params - Parameters for request
|
|
4050
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
4051
|
+
* @param callback - Optional callback that handles the response.
|
|
4052
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
4053
|
+
*/
|
|
4054
|
+
create(params: Params$Resource$Projects$Locations$Collections$Datastores$Create, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
4055
|
+
create(params?: Params$Resource$Projects$Locations$Collections$Datastores$Create, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
4056
|
+
create(params: Params$Resource$Projects$Locations$Collections$Datastores$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
4057
|
+
create(params: Params$Resource$Projects$Locations$Collections$Datastores$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
4058
|
+
create(params: Params$Resource$Projects$Locations$Collections$Datastores$Create, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
4059
|
+
create(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
4060
|
+
/**
|
|
4061
|
+
* Deletes a DataStore.
|
|
4062
|
+
*
|
|
4063
|
+
* @param params - Parameters for request
|
|
4064
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
4065
|
+
* @param callback - Optional callback that handles the response.
|
|
4066
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
4067
|
+
*/
|
|
4068
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Datastores$Delete, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
4069
|
+
delete(params?: Params$Resource$Projects$Locations$Collections$Datastores$Delete, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
4070
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Datastores$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
4071
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Datastores$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
4072
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Datastores$Delete, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
4073
|
+
delete(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
4074
|
+
/**
|
|
4075
|
+
* Gets a DataStore.
|
|
4076
|
+
*
|
|
4077
|
+
* @param params - Parameters for request
|
|
4078
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
4079
|
+
* @param callback - Optional callback that handles the response.
|
|
4080
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
4081
|
+
*/
|
|
4082
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
4083
|
+
get(params?: Params$Resource$Projects$Locations$Collections$Datastores$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaDataStore>;
|
|
4084
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
4085
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaDataStore>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaDataStore>): void;
|
|
4086
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaDataStore>): void;
|
|
4087
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaDataStore>): void;
|
|
4088
|
+
/**
|
|
4089
|
+
* Gets the SiteSearchEngine.
|
|
4090
|
+
*
|
|
4091
|
+
* @param params - Parameters for request
|
|
4092
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
4093
|
+
* @param callback - Optional callback that handles the response.
|
|
4094
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
4095
|
+
*/
|
|
4096
|
+
getSiteSearchEngine(params: Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
4097
|
+
getSiteSearchEngine(params?: Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaSiteSearchEngine>;
|
|
4098
|
+
getSiteSearchEngine(params: Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
4099
|
+
getSiteSearchEngine(params: Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSiteSearchEngine>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSiteSearchEngine>): void;
|
|
4100
|
+
getSiteSearchEngine(params: Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSiteSearchEngine>): void;
|
|
4101
|
+
getSiteSearchEngine(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSiteSearchEngine>): void;
|
|
4102
|
+
/**
|
|
4103
|
+
* Lists all the DataStores associated with the project.
|
|
2922
4104
|
*
|
|
2923
4105
|
* @param params - Parameters for request
|
|
2924
4106
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
2925
4107
|
* @param callback - Optional callback that handles the response.
|
|
2926
4108
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
2927
4109
|
*/
|
|
2928
|
-
|
|
2929
|
-
|
|
2930
|
-
|
|
2931
|
-
|
|
2932
|
-
|
|
2933
|
-
|
|
4110
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
4111
|
+
list(params?: Params$Resource$Projects$Locations$Collections$Datastores$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaListDataStoresResponse>;
|
|
4112
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
4113
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListDataStoresResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListDataStoresResponse>): void;
|
|
4114
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListDataStoresResponse>): void;
|
|
4115
|
+
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListDataStoresResponse>): void;
|
|
4116
|
+
/**
|
|
4117
|
+
* Updates a DataStore
|
|
4118
|
+
*
|
|
4119
|
+
* @param params - Parameters for request
|
|
4120
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
4121
|
+
* @param callback - Optional callback that handles the response.
|
|
4122
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
4123
|
+
*/
|
|
4124
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
4125
|
+
patch(params?: Params$Resource$Projects$Locations$Collections$Datastores$Patch, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaDataStore>;
|
|
4126
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
4127
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaDataStore>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaDataStore>): void;
|
|
4128
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaDataStore>): void;
|
|
4129
|
+
patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaDataStore>): void;
|
|
2934
4130
|
}
|
|
2935
4131
|
export interface Params$Resource$Projects$Locations$Collections$Datastores$Completequery extends StandardParameters {
|
|
2936
4132
|
/**
|
|
@@ -2946,7 +4142,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2946
4142
|
*/
|
|
2947
4143
|
query?: string;
|
|
2948
4144
|
/**
|
|
2949
|
-
*
|
|
4145
|
+
* 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
4146
|
*/
|
|
2951
4147
|
queryModel?: string;
|
|
2952
4148
|
/**
|
|
@@ -2954,6 +4150,74 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2954
4150
|
*/
|
|
2955
4151
|
userPseudoId?: string;
|
|
2956
4152
|
}
|
|
4153
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Create extends StandardParameters {
|
|
4154
|
+
/**
|
|
4155
|
+
* 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.
|
|
4156
|
+
*/
|
|
4157
|
+
createAdvancedSiteSearch?: boolean;
|
|
4158
|
+
/**
|
|
4159
|
+
* 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.
|
|
4160
|
+
*/
|
|
4161
|
+
dataStoreId?: string;
|
|
4162
|
+
/**
|
|
4163
|
+
* Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}`.
|
|
4164
|
+
*/
|
|
4165
|
+
parent?: string;
|
|
4166
|
+
/**
|
|
4167
|
+
* Request body metadata
|
|
4168
|
+
*/
|
|
4169
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaDataStore;
|
|
4170
|
+
}
|
|
4171
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Delete extends StandardParameters {
|
|
4172
|
+
/**
|
|
4173
|
+
* 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.
|
|
4174
|
+
*/
|
|
4175
|
+
name?: string;
|
|
4176
|
+
}
|
|
4177
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Get extends StandardParameters {
|
|
4178
|
+
/**
|
|
4179
|
+
* 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.
|
|
4180
|
+
*/
|
|
4181
|
+
name?: string;
|
|
4182
|
+
}
|
|
4183
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine extends StandardParameters {
|
|
4184
|
+
/**
|
|
4185
|
+
* 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.
|
|
4186
|
+
*/
|
|
4187
|
+
name?: string;
|
|
4188
|
+
}
|
|
4189
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$List extends StandardParameters {
|
|
4190
|
+
/**
|
|
4191
|
+
* Filter by solution type. For example: filter = 'solution_type:SOLUTION_TYPE_SEARCH'
|
|
4192
|
+
*/
|
|
4193
|
+
filter?: string;
|
|
4194
|
+
/**
|
|
4195
|
+
* 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.
|
|
4196
|
+
*/
|
|
4197
|
+
pageSize?: number;
|
|
4198
|
+
/**
|
|
4199
|
+
* 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.
|
|
4200
|
+
*/
|
|
4201
|
+
pageToken?: string;
|
|
4202
|
+
/**
|
|
4203
|
+
* 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.
|
|
4204
|
+
*/
|
|
4205
|
+
parent?: string;
|
|
4206
|
+
}
|
|
4207
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Patch extends StandardParameters {
|
|
4208
|
+
/**
|
|
4209
|
+
* 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.
|
|
4210
|
+
*/
|
|
4211
|
+
name?: string;
|
|
4212
|
+
/**
|
|
4213
|
+
* Indicates which fields in the provided DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.
|
|
4214
|
+
*/
|
|
4215
|
+
updateMask?: string;
|
|
4216
|
+
/**
|
|
4217
|
+
* Request body metadata
|
|
4218
|
+
*/
|
|
4219
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaDataStore;
|
|
4220
|
+
}
|
|
2957
4221
|
export class Resource$Projects$Locations$Collections$Datastores$Branches {
|
|
2958
4222
|
context: APIRequestContext;
|
|
2959
4223
|
documents: Resource$Projects$Locations$Collections$Datastores$Branches$Documents;
|
|
@@ -3340,7 +4604,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
3340
4604
|
*/
|
|
3341
4605
|
name?: string;
|
|
3342
4606
|
/**
|
|
3343
|
-
* Indicates which fields in the provided Conversation to update. The following are NOT supported: *
|
|
4607
|
+
* 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
4608
|
*/
|
|
3345
4609
|
updateMask?: string;
|
|
3346
4610
|
/**
|
|
@@ -3564,37 +4828,275 @@ export declare namespace discoveryengine_v1beta {
|
|
|
3564
4828
|
/**
|
|
3565
4829
|
* Required. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`.
|
|
3566
4830
|
*/
|
|
3567
|
-
name?: string;
|
|
4831
|
+
name?: string;
|
|
4832
|
+
}
|
|
4833
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List extends StandardParameters {
|
|
4834
|
+
/**
|
|
4835
|
+
* The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
|
|
4836
|
+
*/
|
|
4837
|
+
pageSize?: number;
|
|
4838
|
+
/**
|
|
4839
|
+
* A page token, received from a previous SchemaService.ListSchemas call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SchemaService.ListSchemas must match the call that provided the page token.
|
|
4840
|
+
*/
|
|
4841
|
+
pageToken?: string;
|
|
4842
|
+
/**
|
|
4843
|
+
* Required. The parent data store resource name, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`.
|
|
4844
|
+
*/
|
|
4845
|
+
parent?: string;
|
|
4846
|
+
}
|
|
4847
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch extends StandardParameters {
|
|
4848
|
+
/**
|
|
4849
|
+
* If set to true, and the Schema is not found, a new Schema will be created. In this situation, `update_mask` is ignored.
|
|
4850
|
+
*/
|
|
4851
|
+
allowMissing?: boolean;
|
|
4852
|
+
/**
|
|
4853
|
+
* Immutable. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
4854
|
+
*/
|
|
4855
|
+
name?: string;
|
|
4856
|
+
/**
|
|
4857
|
+
* Request body metadata
|
|
4858
|
+
*/
|
|
4859
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSchema;
|
|
4860
|
+
}
|
|
4861
|
+
export class Resource$Projects$Locations$Collections$Datastores$Schemas$Operations {
|
|
4862
|
+
context: APIRequestContext;
|
|
4863
|
+
constructor(context: APIRequestContext);
|
|
4864
|
+
/**
|
|
4865
|
+
* 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.
|
|
4866
|
+
*
|
|
4867
|
+
* @param params - Parameters for request
|
|
4868
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
4869
|
+
* @param callback - Optional callback that handles the response.
|
|
4870
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
4871
|
+
*/
|
|
4872
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
4873
|
+
get(params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
4874
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
4875
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
4876
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
4877
|
+
get(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
4878
|
+
/**
|
|
4879
|
+
* Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
|
|
4880
|
+
*
|
|
4881
|
+
* @param params - Parameters for request
|
|
4882
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
4883
|
+
* @param callback - Optional callback that handles the response.
|
|
4884
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
4885
|
+
*/
|
|
4886
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
4887
|
+
list(params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningListOperationsResponse>;
|
|
4888
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
4889
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>, callback: BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>): void;
|
|
4890
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List, callback: BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>): void;
|
|
4891
|
+
list(callback: BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>): void;
|
|
4892
|
+
}
|
|
4893
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get extends StandardParameters {
|
|
4894
|
+
/**
|
|
4895
|
+
* The name of the operation resource.
|
|
4896
|
+
*/
|
|
4897
|
+
name?: string;
|
|
4898
|
+
}
|
|
4899
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List extends StandardParameters {
|
|
4900
|
+
/**
|
|
4901
|
+
* The standard list filter.
|
|
4902
|
+
*/
|
|
4903
|
+
filter?: string;
|
|
4904
|
+
/**
|
|
4905
|
+
* The name of the operation's parent resource.
|
|
4906
|
+
*/
|
|
4907
|
+
name?: string;
|
|
4908
|
+
/**
|
|
4909
|
+
* The standard list page size.
|
|
4910
|
+
*/
|
|
4911
|
+
pageSize?: number;
|
|
4912
|
+
/**
|
|
4913
|
+
* The standard list page token.
|
|
4914
|
+
*/
|
|
4915
|
+
pageToken?: string;
|
|
4916
|
+
}
|
|
4917
|
+
export class Resource$Projects$Locations$Collections$Datastores$Servingconfigs {
|
|
4918
|
+
context: APIRequestContext;
|
|
4919
|
+
constructor(context: APIRequestContext);
|
|
4920
|
+
/**
|
|
4921
|
+
* Makes a recommendation, which requires a contextual user event.
|
|
4922
|
+
*
|
|
4923
|
+
* @param params - Parameters for request
|
|
4924
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
4925
|
+
* @param callback - Optional callback that handles the response.
|
|
4926
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
4927
|
+
*/
|
|
4928
|
+
recommend(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
4929
|
+
recommend(params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaRecommendResponse>;
|
|
4930
|
+
recommend(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
4931
|
+
recommend(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaRecommendResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaRecommendResponse>): void;
|
|
4932
|
+
recommend(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaRecommendResponse>): void;
|
|
4933
|
+
recommend(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaRecommendResponse>): void;
|
|
4934
|
+
/**
|
|
4935
|
+
* Performs a search.
|
|
4936
|
+
*
|
|
4937
|
+
* @param params - Parameters for request
|
|
4938
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
4939
|
+
* @param callback - Optional callback that handles the response.
|
|
4940
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
4941
|
+
*/
|
|
4942
|
+
search(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
4943
|
+
search(params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaSearchResponse>;
|
|
4944
|
+
search(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
4945
|
+
search(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSearchResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSearchResponse>): void;
|
|
4946
|
+
search(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSearchResponse>): void;
|
|
4947
|
+
search(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSearchResponse>): void;
|
|
4948
|
+
}
|
|
4949
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend extends StandardParameters {
|
|
4950
|
+
/**
|
|
4951
|
+
* 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.
|
|
4952
|
+
*/
|
|
4953
|
+
servingConfig?: string;
|
|
4954
|
+
/**
|
|
4955
|
+
* Request body metadata
|
|
4956
|
+
*/
|
|
4957
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaRecommendRequest;
|
|
4958
|
+
}
|
|
4959
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search extends StandardParameters {
|
|
4960
|
+
/**
|
|
4961
|
+
* Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.
|
|
4962
|
+
*/
|
|
4963
|
+
servingConfig?: string;
|
|
4964
|
+
/**
|
|
4965
|
+
* Request body metadata
|
|
4966
|
+
*/
|
|
4967
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequest;
|
|
4968
|
+
}
|
|
4969
|
+
export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine {
|
|
4970
|
+
context: APIRequestContext;
|
|
4971
|
+
operations: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations;
|
|
4972
|
+
targetSites: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites;
|
|
4973
|
+
constructor(context: APIRequestContext);
|
|
4974
|
+
/**
|
|
4975
|
+
* Verify target sites' ownership and validity. This API sends all the target sites under site search engine for verification.
|
|
4976
|
+
*
|
|
4977
|
+
* @param params - Parameters for request
|
|
4978
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
4979
|
+
* @param callback - Optional callback that handles the response.
|
|
4980
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
4981
|
+
*/
|
|
4982
|
+
batchVerifyTargetSites(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
4983
|
+
batchVerifyTargetSites(params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
4984
|
+
batchVerifyTargetSites(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
4985
|
+
batchVerifyTargetSites(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
4986
|
+
batchVerifyTargetSites(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
4987
|
+
batchVerifyTargetSites(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
4988
|
+
/**
|
|
4989
|
+
* Downgrade from advanced site search to basic site search.
|
|
4990
|
+
*
|
|
4991
|
+
* @param params - Parameters for request
|
|
4992
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
4993
|
+
* @param callback - Optional callback that handles the response.
|
|
4994
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
4995
|
+
*/
|
|
4996
|
+
disableAdvancedSiteSearch(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
4997
|
+
disableAdvancedSiteSearch(params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
4998
|
+
disableAdvancedSiteSearch(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
4999
|
+
disableAdvancedSiteSearch(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5000
|
+
disableAdvancedSiteSearch(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5001
|
+
disableAdvancedSiteSearch(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5002
|
+
/**
|
|
5003
|
+
* Upgrade from basic site search to advanced site search.
|
|
5004
|
+
*
|
|
5005
|
+
* @param params - Parameters for request
|
|
5006
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5007
|
+
* @param callback - Optional callback that handles the response.
|
|
5008
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5009
|
+
*/
|
|
5010
|
+
enableAdvancedSiteSearch(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
5011
|
+
enableAdvancedSiteSearch(params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
5012
|
+
enableAdvancedSiteSearch(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
5013
|
+
enableAdvancedSiteSearch(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5014
|
+
enableAdvancedSiteSearch(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5015
|
+
enableAdvancedSiteSearch(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5016
|
+
/**
|
|
5017
|
+
* 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.
|
|
5018
|
+
*
|
|
5019
|
+
* @param params - Parameters for request
|
|
5020
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5021
|
+
* @param callback - Optional callback that handles the response.
|
|
5022
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5023
|
+
*/
|
|
5024
|
+
fetchDomainVerificationStatus(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
5025
|
+
fetchDomainVerificationStatus(params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaFetchDomainVerificationStatusResponse>;
|
|
5026
|
+
fetchDomainVerificationStatus(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
5027
|
+
fetchDomainVerificationStatus(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaFetchDomainVerificationStatusResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaFetchDomainVerificationStatusResponse>): void;
|
|
5028
|
+
fetchDomainVerificationStatus(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaFetchDomainVerificationStatusResponse>): void;
|
|
5029
|
+
fetchDomainVerificationStatus(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaFetchDomainVerificationStatusResponse>): void;
|
|
5030
|
+
/**
|
|
5031
|
+
* Request on-demand recrawl for a list of URIs.
|
|
5032
|
+
*
|
|
5033
|
+
* @param params - Parameters for request
|
|
5034
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5035
|
+
* @param callback - Optional callback that handles the response.
|
|
5036
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5037
|
+
*/
|
|
5038
|
+
recrawlUris(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
5039
|
+
recrawlUris(params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
5040
|
+
recrawlUris(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
5041
|
+
recrawlUris(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5042
|
+
recrawlUris(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5043
|
+
recrawlUris(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5044
|
+
}
|
|
5045
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites extends StandardParameters {
|
|
5046
|
+
/**
|
|
5047
|
+
* Required. The parent resource shared by all TargetSites being verified. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`.
|
|
5048
|
+
*/
|
|
5049
|
+
parent?: string;
|
|
5050
|
+
/**
|
|
5051
|
+
* Request body metadata
|
|
5052
|
+
*/
|
|
5053
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaBatchVerifyTargetSitesRequest;
|
|
5054
|
+
}
|
|
5055
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch extends StandardParameters {
|
|
5056
|
+
/**
|
|
5057
|
+
* Required. Full resource name of the SiteSearchEngine, such as `projects/{project\}/locations/{location\}/dataStores/{data_store_id\}/siteSearchEngine`.
|
|
5058
|
+
*/
|
|
5059
|
+
siteSearchEngine?: string;
|
|
5060
|
+
/**
|
|
5061
|
+
* Request body metadata
|
|
5062
|
+
*/
|
|
5063
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchRequest;
|
|
5064
|
+
}
|
|
5065
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch extends StandardParameters {
|
|
5066
|
+
/**
|
|
5067
|
+
* Required. Full resource name of the SiteSearchEngine, such as `projects/{project\}/locations/{location\}/dataStores/{data_store_id\}/siteSearchEngine`.
|
|
5068
|
+
*/
|
|
5069
|
+
siteSearchEngine?: string;
|
|
5070
|
+
/**
|
|
5071
|
+
* Request body metadata
|
|
5072
|
+
*/
|
|
5073
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchRequest;
|
|
3568
5074
|
}
|
|
3569
|
-
export interface Params$Resource$Projects$Locations$Collections$Datastores$
|
|
5075
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus extends StandardParameters {
|
|
3570
5076
|
/**
|
|
3571
|
-
*
|
|
5077
|
+
* 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.
|
|
3572
5078
|
*/
|
|
3573
5079
|
pageSize?: number;
|
|
3574
5080
|
/**
|
|
3575
|
-
* A page token, received from a previous
|
|
5081
|
+
* 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.
|
|
3576
5082
|
*/
|
|
3577
5083
|
pageToken?: string;
|
|
3578
5084
|
/**
|
|
3579
|
-
* Required. The
|
|
5085
|
+
* 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`.
|
|
3580
5086
|
*/
|
|
3581
|
-
|
|
5087
|
+
siteSearchEngine?: string;
|
|
3582
5088
|
}
|
|
3583
|
-
export interface Params$Resource$Projects$Locations$Collections$Datastores$
|
|
5089
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris extends StandardParameters {
|
|
3584
5090
|
/**
|
|
3585
|
-
*
|
|
3586
|
-
*/
|
|
3587
|
-
allowMissing?: boolean;
|
|
3588
|
-
/**
|
|
3589
|
-
* Immutable. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
5091
|
+
* Required. Full resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`.
|
|
3590
5092
|
*/
|
|
3591
|
-
|
|
5093
|
+
siteSearchEngine?: string;
|
|
3592
5094
|
/**
|
|
3593
5095
|
* Request body metadata
|
|
3594
5096
|
*/
|
|
3595
|
-
requestBody?: Schema$
|
|
5097
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaRecrawlUrisRequest;
|
|
3596
5098
|
}
|
|
3597
|
-
export class Resource$Projects$Locations$Collections$Datastores$
|
|
5099
|
+
export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations {
|
|
3598
5100
|
context: APIRequestContext;
|
|
3599
5101
|
constructor(context: APIRequestContext);
|
|
3600
5102
|
/**
|
|
@@ -3605,11 +5107,11 @@ export declare namespace discoveryengine_v1beta {
|
|
|
3605
5107
|
* @param callback - Optional callback that handles the response.
|
|
3606
5108
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3607
5109
|
*/
|
|
3608
|
-
get(params: Params$Resource$Projects$Locations$Collections$Datastores$
|
|
3609
|
-
get(params?: Params$Resource$Projects$Locations$Collections$Datastores$
|
|
3610
|
-
get(params: Params$Resource$Projects$Locations$Collections$Datastores$
|
|
3611
|
-
get(params: Params$Resource$Projects$Locations$Collections$Datastores$
|
|
3612
|
-
get(params: Params$Resource$Projects$Locations$Collections$Datastores$
|
|
5110
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
5111
|
+
get(params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
5112
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
5113
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5114
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
3613
5115
|
get(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
3614
5116
|
/**
|
|
3615
5117
|
* Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
|
|
@@ -3619,20 +5121,20 @@ export declare namespace discoveryengine_v1beta {
|
|
|
3619
5121
|
* @param callback - Optional callback that handles the response.
|
|
3620
5122
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3621
5123
|
*/
|
|
3622
|
-
list(params: Params$Resource$Projects$Locations$Collections$Datastores$
|
|
3623
|
-
list(params?: Params$Resource$Projects$Locations$Collections$Datastores$
|
|
3624
|
-
list(params: Params$Resource$Projects$Locations$Collections$Datastores$
|
|
3625
|
-
list(params: Params$Resource$Projects$Locations$Collections$Datastores$
|
|
3626
|
-
list(params: Params$Resource$Projects$Locations$Collections$Datastores$
|
|
5124
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
5125
|
+
list(params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningListOperationsResponse>;
|
|
5126
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
5127
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>, callback: BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>): void;
|
|
5128
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List, callback: BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>): void;
|
|
3627
5129
|
list(callback: BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>): void;
|
|
3628
5130
|
}
|
|
3629
|
-
export interface Params$Resource$Projects$Locations$Collections$Datastores$
|
|
5131
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get extends StandardParameters {
|
|
3630
5132
|
/**
|
|
3631
5133
|
* The name of the operation resource.
|
|
3632
5134
|
*/
|
|
3633
5135
|
name?: string;
|
|
3634
5136
|
}
|
|
3635
|
-
export interface Params$Resource$Projects$Locations$Collections$Datastores$
|
|
5137
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List extends StandardParameters {
|
|
3636
5138
|
/**
|
|
3637
5139
|
* The standard list filter.
|
|
3638
5140
|
*/
|
|
@@ -3650,124 +5152,150 @@ export declare namespace discoveryengine_v1beta {
|
|
|
3650
5152
|
*/
|
|
3651
5153
|
pageToken?: string;
|
|
3652
5154
|
}
|
|
3653
|
-
export class Resource$Projects$Locations$Collections$Datastores$
|
|
5155
|
+
export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites {
|
|
3654
5156
|
context: APIRequestContext;
|
|
5157
|
+
operations: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations;
|
|
3655
5158
|
constructor(context: APIRequestContext);
|
|
3656
5159
|
/**
|
|
3657
|
-
*
|
|
5160
|
+
* Creates TargetSite in a batch.
|
|
3658
5161
|
*
|
|
3659
5162
|
* @param params - Parameters for request
|
|
3660
5163
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3661
5164
|
* @param callback - Optional callback that handles the response.
|
|
3662
5165
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3663
5166
|
*/
|
|
3664
|
-
|
|
3665
|
-
|
|
3666
|
-
|
|
3667
|
-
|
|
3668
|
-
|
|
3669
|
-
|
|
5167
|
+
batchCreate(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
5168
|
+
batchCreate(params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
5169
|
+
batchCreate(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
5170
|
+
batchCreate(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5171
|
+
batchCreate(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5172
|
+
batchCreate(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
3670
5173
|
/**
|
|
3671
|
-
*
|
|
5174
|
+
* Creates a TargetSite.
|
|
3672
5175
|
*
|
|
3673
5176
|
* @param params - Parameters for request
|
|
3674
5177
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3675
5178
|
* @param callback - Optional callback that handles the response.
|
|
3676
5179
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3677
5180
|
*/
|
|
3678
|
-
|
|
3679
|
-
|
|
3680
|
-
|
|
3681
|
-
|
|
3682
|
-
|
|
3683
|
-
|
|
3684
|
-
}
|
|
3685
|
-
export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend extends StandardParameters {
|
|
3686
|
-
/**
|
|
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.
|
|
3688
|
-
*/
|
|
3689
|
-
servingConfig?: string;
|
|
3690
|
-
/**
|
|
3691
|
-
* Request body metadata
|
|
3692
|
-
*/
|
|
3693
|
-
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaRecommendRequest;
|
|
3694
|
-
}
|
|
3695
|
-
export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search extends StandardParameters {
|
|
5181
|
+
create(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
5182
|
+
create(params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
5183
|
+
create(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
5184
|
+
create(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5185
|
+
create(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5186
|
+
create(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
3696
5187
|
/**
|
|
3697
|
-
*
|
|
5188
|
+
* Deletes a TargetSite.
|
|
5189
|
+
*
|
|
5190
|
+
* @param params - Parameters for request
|
|
5191
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5192
|
+
* @param callback - Optional callback that handles the response.
|
|
5193
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3698
5194
|
*/
|
|
3699
|
-
|
|
5195
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
5196
|
+
delete(params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
5197
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
5198
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5199
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5200
|
+
delete(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
3700
5201
|
/**
|
|
3701
|
-
*
|
|
5202
|
+
* Gets a TargetSite.
|
|
5203
|
+
*
|
|
5204
|
+
* @param params - Parameters for request
|
|
5205
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5206
|
+
* @param callback - Optional callback that handles the response.
|
|
5207
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3702
5208
|
*/
|
|
3703
|
-
|
|
3704
|
-
|
|
3705
|
-
|
|
3706
|
-
|
|
3707
|
-
|
|
3708
|
-
|
|
3709
|
-
constructor(context: APIRequestContext);
|
|
3710
|
-
}
|
|
3711
|
-
export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations {
|
|
3712
|
-
context: APIRequestContext;
|
|
3713
|
-
constructor(context: APIRequestContext);
|
|
5209
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
5210
|
+
get(params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaTargetSite>;
|
|
5211
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
5212
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaTargetSite>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaTargetSite>): void;
|
|
5213
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaTargetSite>): void;
|
|
5214
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaTargetSite>): void;
|
|
3714
5215
|
/**
|
|
3715
|
-
* Gets
|
|
5216
|
+
* Gets a list of TargetSites.
|
|
3716
5217
|
*
|
|
3717
5218
|
* @param params - Parameters for request
|
|
3718
5219
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3719
5220
|
* @param callback - Optional callback that handles the response.
|
|
3720
5221
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3721
5222
|
*/
|
|
3722
|
-
|
|
3723
|
-
|
|
3724
|
-
|
|
3725
|
-
|
|
3726
|
-
|
|
3727
|
-
|
|
5223
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
5224
|
+
list(params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaListTargetSitesResponse>;
|
|
5225
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
5226
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListTargetSitesResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListTargetSitesResponse>): void;
|
|
5227
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListTargetSitesResponse>): void;
|
|
5228
|
+
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListTargetSitesResponse>): void;
|
|
3728
5229
|
/**
|
|
3729
|
-
*
|
|
5230
|
+
* Updates a TargetSite.
|
|
3730
5231
|
*
|
|
3731
5232
|
* @param params - Parameters for request
|
|
3732
5233
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3733
5234
|
* @param callback - Optional callback that handles the response.
|
|
3734
5235
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3735
5236
|
*/
|
|
3736
|
-
|
|
3737
|
-
|
|
3738
|
-
|
|
3739
|
-
|
|
3740
|
-
|
|
3741
|
-
|
|
5237
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
5238
|
+
patch(params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
5239
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
5240
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5241
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5242
|
+
patch(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
3742
5243
|
}
|
|
3743
|
-
export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$
|
|
5244
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate extends StandardParameters {
|
|
3744
5245
|
/**
|
|
3745
|
-
* The
|
|
5246
|
+
* 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
5247
|
*/
|
|
3747
|
-
|
|
5248
|
+
parent?: string;
|
|
5249
|
+
/**
|
|
5250
|
+
* Request body metadata
|
|
5251
|
+
*/
|
|
5252
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesRequest;
|
|
3748
5253
|
}
|
|
3749
|
-
export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$
|
|
5254
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create extends StandardParameters {
|
|
3750
5255
|
/**
|
|
3751
|
-
*
|
|
5256
|
+
* Required. Parent resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`.
|
|
3752
5257
|
*/
|
|
3753
|
-
|
|
5258
|
+
parent?: string;
|
|
3754
5259
|
/**
|
|
3755
|
-
*
|
|
5260
|
+
* Request body metadata
|
|
5261
|
+
*/
|
|
5262
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaTargetSite;
|
|
5263
|
+
}
|
|
5264
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete extends StandardParameters {
|
|
5265
|
+
/**
|
|
5266
|
+
* 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
5267
|
*/
|
|
3757
5268
|
name?: string;
|
|
5269
|
+
}
|
|
5270
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get extends StandardParameters {
|
|
3758
5271
|
/**
|
|
3759
|
-
*
|
|
5272
|
+
* 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.
|
|
5273
|
+
*/
|
|
5274
|
+
name?: string;
|
|
5275
|
+
}
|
|
5276
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List extends StandardParameters {
|
|
5277
|
+
/**
|
|
5278
|
+
* 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
5279
|
*/
|
|
3761
5280
|
pageSize?: number;
|
|
3762
5281
|
/**
|
|
3763
|
-
*
|
|
5282
|
+
* 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
5283
|
*/
|
|
3765
5284
|
pageToken?: string;
|
|
5285
|
+
/**
|
|
5286
|
+
* 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.
|
|
5287
|
+
*/
|
|
5288
|
+
parent?: string;
|
|
3766
5289
|
}
|
|
3767
|
-
export
|
|
3768
|
-
|
|
3769
|
-
|
|
3770
|
-
|
|
5290
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch extends StandardParameters {
|
|
5291
|
+
/**
|
|
5292
|
+
* 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.
|
|
5293
|
+
*/
|
|
5294
|
+
name?: string;
|
|
5295
|
+
/**
|
|
5296
|
+
* Request body metadata
|
|
5297
|
+
*/
|
|
5298
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaTargetSite;
|
|
3771
5299
|
}
|
|
3772
5300
|
export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations {
|
|
3773
5301
|
context: APIRequestContext;
|
|
@@ -3825,6 +5353,58 @@ export declare namespace discoveryengine_v1beta {
|
|
|
3825
5353
|
*/
|
|
3826
5354
|
pageToken?: string;
|
|
3827
5355
|
}
|
|
5356
|
+
export class Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries {
|
|
5357
|
+
context: APIRequestContext;
|
|
5358
|
+
constructor(context: APIRequestContext);
|
|
5359
|
+
/**
|
|
5360
|
+
* Imports all SuggestionDenyListEntry for a DataStore.
|
|
5361
|
+
*
|
|
5362
|
+
* @param params - Parameters for request
|
|
5363
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5364
|
+
* @param callback - Optional callback that handles the response.
|
|
5365
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5366
|
+
*/
|
|
5367
|
+
import(params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
5368
|
+
import(params?: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
5369
|
+
import(params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
5370
|
+
import(params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5371
|
+
import(params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5372
|
+
import(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5373
|
+
/**
|
|
5374
|
+
* Permanently deletes all SuggestionDenyListEntry for a DataStore.
|
|
5375
|
+
*
|
|
5376
|
+
* @param params - Parameters for request
|
|
5377
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5378
|
+
* @param callback - Optional callback that handles the response.
|
|
5379
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5380
|
+
*/
|
|
5381
|
+
purge(params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
5382
|
+
purge(params?: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
5383
|
+
purge(params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
5384
|
+
purge(params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5385
|
+
purge(params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5386
|
+
purge(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5387
|
+
}
|
|
5388
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import extends StandardParameters {
|
|
5389
|
+
/**
|
|
5390
|
+
* Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x.
|
|
5391
|
+
*/
|
|
5392
|
+
parent?: string;
|
|
5393
|
+
/**
|
|
5394
|
+
* Request body metadata
|
|
5395
|
+
*/
|
|
5396
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesRequest;
|
|
5397
|
+
}
|
|
5398
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge extends StandardParameters {
|
|
5399
|
+
/**
|
|
5400
|
+
* Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x.
|
|
5401
|
+
*/
|
|
5402
|
+
parent?: string;
|
|
5403
|
+
/**
|
|
5404
|
+
* Request body metadata
|
|
5405
|
+
*/
|
|
5406
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesRequest;
|
|
5407
|
+
}
|
|
3828
5408
|
export class Resource$Projects$Locations$Collections$Datastores$Userevents {
|
|
3829
5409
|
context: APIRequestContext;
|
|
3830
5410
|
constructor(context: APIRequestContext);
|
|
@@ -3915,6 +5495,134 @@ export declare namespace discoveryengine_v1beta {
|
|
|
3915
5495
|
operations: Resource$Projects$Locations$Collections$Engines$Operations;
|
|
3916
5496
|
servingConfigs: Resource$Projects$Locations$Collections$Engines$Servingconfigs;
|
|
3917
5497
|
constructor(context: APIRequestContext);
|
|
5498
|
+
/**
|
|
5499
|
+
* Creates a Engine.
|
|
5500
|
+
*
|
|
5501
|
+
* @param params - Parameters for request
|
|
5502
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5503
|
+
* @param callback - Optional callback that handles the response.
|
|
5504
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5505
|
+
*/
|
|
5506
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Create, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
5507
|
+
create(params?: Params$Resource$Projects$Locations$Collections$Engines$Create, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
5508
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
5509
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5510
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Create, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5511
|
+
create(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5512
|
+
/**
|
|
5513
|
+
* Deletes a Engine.
|
|
5514
|
+
*
|
|
5515
|
+
* @param params - Parameters for request
|
|
5516
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5517
|
+
* @param callback - Optional callback that handles the response.
|
|
5518
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5519
|
+
*/
|
|
5520
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Engines$Delete, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
5521
|
+
delete(params?: Params$Resource$Projects$Locations$Collections$Engines$Delete, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
5522
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Engines$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
5523
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Engines$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5524
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Engines$Delete, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5525
|
+
delete(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5526
|
+
/**
|
|
5527
|
+
* Gets a Engine.
|
|
5528
|
+
*
|
|
5529
|
+
* @param params - Parameters for request
|
|
5530
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5531
|
+
* @param callback - Optional callback that handles the response.
|
|
5532
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5533
|
+
*/
|
|
5534
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
5535
|
+
get(params?: Params$Resource$Projects$Locations$Collections$Engines$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaEngine>;
|
|
5536
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
5537
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaEngine>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaEngine>): void;
|
|
5538
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaEngine>): void;
|
|
5539
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaEngine>): void;
|
|
5540
|
+
/**
|
|
5541
|
+
* Lists all the Engines associated with the project.
|
|
5542
|
+
*
|
|
5543
|
+
* @param params - Parameters for request
|
|
5544
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5545
|
+
* @param callback - Optional callback that handles the response.
|
|
5546
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5547
|
+
*/
|
|
5548
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
5549
|
+
list(params?: Params$Resource$Projects$Locations$Collections$Engines$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaListEnginesResponse>;
|
|
5550
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
5551
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListEnginesResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListEnginesResponse>): void;
|
|
5552
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListEnginesResponse>): void;
|
|
5553
|
+
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListEnginesResponse>): void;
|
|
5554
|
+
/**
|
|
5555
|
+
* Updates an Engine
|
|
5556
|
+
*
|
|
5557
|
+
* @param params - Parameters for request
|
|
5558
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5559
|
+
* @param callback - Optional callback that handles the response.
|
|
5560
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5561
|
+
*/
|
|
5562
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
5563
|
+
patch(params?: Params$Resource$Projects$Locations$Collections$Engines$Patch, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaEngine>;
|
|
5564
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
5565
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaEngine>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaEngine>): void;
|
|
5566
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaEngine>): void;
|
|
5567
|
+
patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaEngine>): void;
|
|
5568
|
+
}
|
|
5569
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Create extends StandardParameters {
|
|
5570
|
+
/**
|
|
5571
|
+
* 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.
|
|
5572
|
+
*/
|
|
5573
|
+
engineId?: string;
|
|
5574
|
+
/**
|
|
5575
|
+
* Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}`.
|
|
5576
|
+
*/
|
|
5577
|
+
parent?: string;
|
|
5578
|
+
/**
|
|
5579
|
+
* Request body metadata
|
|
5580
|
+
*/
|
|
5581
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaEngine;
|
|
5582
|
+
}
|
|
5583
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Delete extends StandardParameters {
|
|
5584
|
+
/**
|
|
5585
|
+
* 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.
|
|
5586
|
+
*/
|
|
5587
|
+
name?: string;
|
|
5588
|
+
}
|
|
5589
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Get extends StandardParameters {
|
|
5590
|
+
/**
|
|
5591
|
+
* Required. Full resource name of Engine, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`.
|
|
5592
|
+
*/
|
|
5593
|
+
name?: string;
|
|
5594
|
+
}
|
|
5595
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$List extends StandardParameters {
|
|
5596
|
+
/**
|
|
5597
|
+
* Optional. Filter by solution type. For example: solution_type=SOLUTION_TYPE_SEARCH
|
|
5598
|
+
*/
|
|
5599
|
+
filter?: string;
|
|
5600
|
+
/**
|
|
5601
|
+
* Optional. Not supported.
|
|
5602
|
+
*/
|
|
5603
|
+
pageSize?: number;
|
|
5604
|
+
/**
|
|
5605
|
+
* Optional. Not supported.
|
|
5606
|
+
*/
|
|
5607
|
+
pageToken?: string;
|
|
5608
|
+
/**
|
|
5609
|
+
* Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}`.
|
|
5610
|
+
*/
|
|
5611
|
+
parent?: string;
|
|
5612
|
+
}
|
|
5613
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Patch extends StandardParameters {
|
|
5614
|
+
/**
|
|
5615
|
+
* 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.
|
|
5616
|
+
*/
|
|
5617
|
+
name?: string;
|
|
5618
|
+
/**
|
|
5619
|
+
* Indicates which fields in the provided Engine to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.
|
|
5620
|
+
*/
|
|
5621
|
+
updateMask?: string;
|
|
5622
|
+
/**
|
|
5623
|
+
* Request body metadata
|
|
5624
|
+
*/
|
|
5625
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaEngine;
|
|
3918
5626
|
}
|
|
3919
5627
|
export class Resource$Projects$Locations$Collections$Engines$Conversations {
|
|
3920
5628
|
context: APIRequestContext;
|
|
@@ -4064,7 +5772,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
4064
5772
|
*/
|
|
4065
5773
|
name?: string;
|
|
4066
5774
|
/**
|
|
4067
|
-
* Indicates which fields in the provided Conversation to update. The following are NOT supported: *
|
|
5775
|
+
* 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
5776
|
*/
|
|
4069
5777
|
updateMask?: string;
|
|
4070
5778
|
/**
|
|
@@ -4162,7 +5870,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
4162
5870
|
}
|
|
4163
5871
|
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend extends StandardParameters {
|
|
4164
5872
|
/**
|
|
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.
|
|
5873
|
+
* 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
5874
|
*/
|
|
4167
5875
|
servingConfig?: string;
|
|
4168
5876
|
/**
|
|
@@ -4244,6 +5952,8 @@ export declare namespace discoveryengine_v1beta {
|
|
|
4244
5952
|
operations: Resource$Projects$Locations$Datastores$Operations;
|
|
4245
5953
|
schemas: Resource$Projects$Locations$Datastores$Schemas;
|
|
4246
5954
|
servingConfigs: Resource$Projects$Locations$Datastores$Servingconfigs;
|
|
5955
|
+
siteSearchEngine: Resource$Projects$Locations$Datastores$Sitesearchengine;
|
|
5956
|
+
suggestionDenyListEntries: Resource$Projects$Locations$Datastores$Suggestiondenylistentries;
|
|
4247
5957
|
userEvents: Resource$Projects$Locations$Datastores$Userevents;
|
|
4248
5958
|
constructor(context: APIRequestContext);
|
|
4249
5959
|
/**
|
|
@@ -4260,6 +5970,90 @@ export declare namespace discoveryengine_v1beta {
|
|
|
4260
5970
|
completeQuery(params: Params$Resource$Projects$Locations$Datastores$Completequery, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaCompleteQueryResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaCompleteQueryResponse>): void;
|
|
4261
5971
|
completeQuery(params: Params$Resource$Projects$Locations$Datastores$Completequery, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaCompleteQueryResponse>): void;
|
|
4262
5972
|
completeQuery(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaCompleteQueryResponse>): void;
|
|
5973
|
+
/**
|
|
5974
|
+
* 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.
|
|
5975
|
+
*
|
|
5976
|
+
* @param params - Parameters for request
|
|
5977
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5978
|
+
* @param callback - Optional callback that handles the response.
|
|
5979
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5980
|
+
*/
|
|
5981
|
+
create(params: Params$Resource$Projects$Locations$Datastores$Create, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
5982
|
+
create(params?: Params$Resource$Projects$Locations$Datastores$Create, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
5983
|
+
create(params: Params$Resource$Projects$Locations$Datastores$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
5984
|
+
create(params: Params$Resource$Projects$Locations$Datastores$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5985
|
+
create(params: Params$Resource$Projects$Locations$Datastores$Create, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5986
|
+
create(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5987
|
+
/**
|
|
5988
|
+
* Deletes a DataStore.
|
|
5989
|
+
*
|
|
5990
|
+
* @param params - Parameters for request
|
|
5991
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5992
|
+
* @param callback - Optional callback that handles the response.
|
|
5993
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5994
|
+
*/
|
|
5995
|
+
delete(params: Params$Resource$Projects$Locations$Datastores$Delete, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
5996
|
+
delete(params?: Params$Resource$Projects$Locations$Datastores$Delete, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
5997
|
+
delete(params: Params$Resource$Projects$Locations$Datastores$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
5998
|
+
delete(params: Params$Resource$Projects$Locations$Datastores$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
5999
|
+
delete(params: Params$Resource$Projects$Locations$Datastores$Delete, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
6000
|
+
delete(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
6001
|
+
/**
|
|
6002
|
+
* Gets a DataStore.
|
|
6003
|
+
*
|
|
6004
|
+
* @param params - Parameters for request
|
|
6005
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6006
|
+
* @param callback - Optional callback that handles the response.
|
|
6007
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6008
|
+
*/
|
|
6009
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
6010
|
+
get(params?: Params$Resource$Projects$Locations$Datastores$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaDataStore>;
|
|
6011
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
6012
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaDataStore>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaDataStore>): void;
|
|
6013
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaDataStore>): void;
|
|
6014
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaDataStore>): void;
|
|
6015
|
+
/**
|
|
6016
|
+
* Gets the SiteSearchEngine.
|
|
6017
|
+
*
|
|
6018
|
+
* @param params - Parameters for request
|
|
6019
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6020
|
+
* @param callback - Optional callback that handles the response.
|
|
6021
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6022
|
+
*/
|
|
6023
|
+
getSiteSearchEngine(params: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
6024
|
+
getSiteSearchEngine(params?: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaSiteSearchEngine>;
|
|
6025
|
+
getSiteSearchEngine(params: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
6026
|
+
getSiteSearchEngine(params: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSiteSearchEngine>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSiteSearchEngine>): void;
|
|
6027
|
+
getSiteSearchEngine(params: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSiteSearchEngine>): void;
|
|
6028
|
+
getSiteSearchEngine(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSiteSearchEngine>): void;
|
|
6029
|
+
/**
|
|
6030
|
+
* Lists all the DataStores associated with the project.
|
|
6031
|
+
*
|
|
6032
|
+
* @param params - Parameters for request
|
|
6033
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6034
|
+
* @param callback - Optional callback that handles the response.
|
|
6035
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6036
|
+
*/
|
|
6037
|
+
list(params: Params$Resource$Projects$Locations$Datastores$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
6038
|
+
list(params?: Params$Resource$Projects$Locations$Datastores$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaListDataStoresResponse>;
|
|
6039
|
+
list(params: Params$Resource$Projects$Locations$Datastores$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
6040
|
+
list(params: Params$Resource$Projects$Locations$Datastores$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListDataStoresResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListDataStoresResponse>): void;
|
|
6041
|
+
list(params: Params$Resource$Projects$Locations$Datastores$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListDataStoresResponse>): void;
|
|
6042
|
+
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListDataStoresResponse>): void;
|
|
6043
|
+
/**
|
|
6044
|
+
* Updates a DataStore
|
|
6045
|
+
*
|
|
6046
|
+
* @param params - Parameters for request
|
|
6047
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6048
|
+
* @param callback - Optional callback that handles the response.
|
|
6049
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6050
|
+
*/
|
|
6051
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
6052
|
+
patch(params?: Params$Resource$Projects$Locations$Datastores$Patch, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaDataStore>;
|
|
6053
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
6054
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaDataStore>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaDataStore>): void;
|
|
6055
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaDataStore>): void;
|
|
6056
|
+
patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaDataStore>): void;
|
|
4263
6057
|
}
|
|
4264
6058
|
export interface Params$Resource$Projects$Locations$Datastores$Completequery extends StandardParameters {
|
|
4265
6059
|
/**
|
|
@@ -4275,7 +6069,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
4275
6069
|
*/
|
|
4276
6070
|
query?: string;
|
|
4277
6071
|
/**
|
|
4278
|
-
*
|
|
6072
|
+
* 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
6073
|
*/
|
|
4280
6074
|
queryModel?: string;
|
|
4281
6075
|
/**
|
|
@@ -4283,6 +6077,74 @@ export declare namespace discoveryengine_v1beta {
|
|
|
4283
6077
|
*/
|
|
4284
6078
|
userPseudoId?: string;
|
|
4285
6079
|
}
|
|
6080
|
+
export interface Params$Resource$Projects$Locations$Datastores$Create extends StandardParameters {
|
|
6081
|
+
/**
|
|
6082
|
+
* 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.
|
|
6083
|
+
*/
|
|
6084
|
+
createAdvancedSiteSearch?: boolean;
|
|
6085
|
+
/**
|
|
6086
|
+
* 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.
|
|
6087
|
+
*/
|
|
6088
|
+
dataStoreId?: string;
|
|
6089
|
+
/**
|
|
6090
|
+
* Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}`.
|
|
6091
|
+
*/
|
|
6092
|
+
parent?: string;
|
|
6093
|
+
/**
|
|
6094
|
+
* Request body metadata
|
|
6095
|
+
*/
|
|
6096
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaDataStore;
|
|
6097
|
+
}
|
|
6098
|
+
export interface Params$Resource$Projects$Locations$Datastores$Delete extends StandardParameters {
|
|
6099
|
+
/**
|
|
6100
|
+
* 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.
|
|
6101
|
+
*/
|
|
6102
|
+
name?: string;
|
|
6103
|
+
}
|
|
6104
|
+
export interface Params$Resource$Projects$Locations$Datastores$Get extends StandardParameters {
|
|
6105
|
+
/**
|
|
6106
|
+
* 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.
|
|
6107
|
+
*/
|
|
6108
|
+
name?: string;
|
|
6109
|
+
}
|
|
6110
|
+
export interface Params$Resource$Projects$Locations$Datastores$Getsitesearchengine extends StandardParameters {
|
|
6111
|
+
/**
|
|
6112
|
+
* 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.
|
|
6113
|
+
*/
|
|
6114
|
+
name?: string;
|
|
6115
|
+
}
|
|
6116
|
+
export interface Params$Resource$Projects$Locations$Datastores$List extends StandardParameters {
|
|
6117
|
+
/**
|
|
6118
|
+
* Filter by solution type. For example: filter = 'solution_type:SOLUTION_TYPE_SEARCH'
|
|
6119
|
+
*/
|
|
6120
|
+
filter?: string;
|
|
6121
|
+
/**
|
|
6122
|
+
* 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.
|
|
6123
|
+
*/
|
|
6124
|
+
pageSize?: number;
|
|
6125
|
+
/**
|
|
6126
|
+
* 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.
|
|
6127
|
+
*/
|
|
6128
|
+
pageToken?: string;
|
|
6129
|
+
/**
|
|
6130
|
+
* 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.
|
|
6131
|
+
*/
|
|
6132
|
+
parent?: string;
|
|
6133
|
+
}
|
|
6134
|
+
export interface Params$Resource$Projects$Locations$Datastores$Patch extends StandardParameters {
|
|
6135
|
+
/**
|
|
6136
|
+
* 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.
|
|
6137
|
+
*/
|
|
6138
|
+
name?: string;
|
|
6139
|
+
/**
|
|
6140
|
+
* Indicates which fields in the provided DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.
|
|
6141
|
+
*/
|
|
6142
|
+
updateMask?: string;
|
|
6143
|
+
/**
|
|
6144
|
+
* Request body metadata
|
|
6145
|
+
*/
|
|
6146
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaDataStore;
|
|
6147
|
+
}
|
|
4286
6148
|
export class Resource$Projects$Locations$Datastores$Branches {
|
|
4287
6149
|
context: APIRequestContext;
|
|
4288
6150
|
documents: Resource$Projects$Locations$Datastores$Branches$Documents;
|
|
@@ -4669,7 +6531,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
4669
6531
|
*/
|
|
4670
6532
|
name?: string;
|
|
4671
6533
|
/**
|
|
4672
|
-
* Indicates which fields in the provided Conversation to update. The following are NOT supported: *
|
|
6534
|
+
* 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
6535
|
*/
|
|
4674
6536
|
updateMask?: string;
|
|
4675
6537
|
/**
|
|
@@ -4956,7 +6818,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
4956
6818
|
}
|
|
4957
6819
|
export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend extends StandardParameters {
|
|
4958
6820
|
/**
|
|
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.
|
|
6821
|
+
* 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
6822
|
*/
|
|
4961
6823
|
servingConfig?: string;
|
|
4962
6824
|
/**
|
|
@@ -4974,6 +6836,279 @@ export declare namespace discoveryengine_v1beta {
|
|
|
4974
6836
|
*/
|
|
4975
6837
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequest;
|
|
4976
6838
|
}
|
|
6839
|
+
export class Resource$Projects$Locations$Datastores$Sitesearchengine {
|
|
6840
|
+
context: APIRequestContext;
|
|
6841
|
+
targetSites: Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites;
|
|
6842
|
+
constructor(context: APIRequestContext);
|
|
6843
|
+
/**
|
|
6844
|
+
* Downgrade from advanced site search to basic site search.
|
|
6845
|
+
*
|
|
6846
|
+
* @param params - Parameters for request
|
|
6847
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6848
|
+
* @param callback - Optional callback that handles the response.
|
|
6849
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6850
|
+
*/
|
|
6851
|
+
disableAdvancedSiteSearch(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
6852
|
+
disableAdvancedSiteSearch(params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
6853
|
+
disableAdvancedSiteSearch(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
6854
|
+
disableAdvancedSiteSearch(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
6855
|
+
disableAdvancedSiteSearch(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
6856
|
+
disableAdvancedSiteSearch(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
6857
|
+
/**
|
|
6858
|
+
* Upgrade from basic site search to advanced site search.
|
|
6859
|
+
*
|
|
6860
|
+
* @param params - Parameters for request
|
|
6861
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6862
|
+
* @param callback - Optional callback that handles the response.
|
|
6863
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6864
|
+
*/
|
|
6865
|
+
enableAdvancedSiteSearch(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
6866
|
+
enableAdvancedSiteSearch(params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
6867
|
+
enableAdvancedSiteSearch(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
6868
|
+
enableAdvancedSiteSearch(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
6869
|
+
enableAdvancedSiteSearch(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
6870
|
+
enableAdvancedSiteSearch(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
6871
|
+
/**
|
|
6872
|
+
* Request on-demand recrawl for a list of URIs.
|
|
6873
|
+
*
|
|
6874
|
+
* @param params - Parameters for request
|
|
6875
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6876
|
+
* @param callback - Optional callback that handles the response.
|
|
6877
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6878
|
+
*/
|
|
6879
|
+
recrawlUris(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
6880
|
+
recrawlUris(params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
6881
|
+
recrawlUris(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
6882
|
+
recrawlUris(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
6883
|
+
recrawlUris(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
6884
|
+
recrawlUris(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
6885
|
+
}
|
|
6886
|
+
export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch extends StandardParameters {
|
|
6887
|
+
/**
|
|
6888
|
+
* Required. Full resource name of the SiteSearchEngine, such as `projects/{project\}/locations/{location\}/dataStores/{data_store_id\}/siteSearchEngine`.
|
|
6889
|
+
*/
|
|
6890
|
+
siteSearchEngine?: string;
|
|
6891
|
+
/**
|
|
6892
|
+
* Request body metadata
|
|
6893
|
+
*/
|
|
6894
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchRequest;
|
|
6895
|
+
}
|
|
6896
|
+
export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch extends StandardParameters {
|
|
6897
|
+
/**
|
|
6898
|
+
* Required. Full resource name of the SiteSearchEngine, such as `projects/{project\}/locations/{location\}/dataStores/{data_store_id\}/siteSearchEngine`.
|
|
6899
|
+
*/
|
|
6900
|
+
siteSearchEngine?: string;
|
|
6901
|
+
/**
|
|
6902
|
+
* Request body metadata
|
|
6903
|
+
*/
|
|
6904
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchRequest;
|
|
6905
|
+
}
|
|
6906
|
+
export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris extends StandardParameters {
|
|
6907
|
+
/**
|
|
6908
|
+
* Required. Full resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`.
|
|
6909
|
+
*/
|
|
6910
|
+
siteSearchEngine?: string;
|
|
6911
|
+
/**
|
|
6912
|
+
* Request body metadata
|
|
6913
|
+
*/
|
|
6914
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaRecrawlUrisRequest;
|
|
6915
|
+
}
|
|
6916
|
+
export class Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites {
|
|
6917
|
+
context: APIRequestContext;
|
|
6918
|
+
constructor(context: APIRequestContext);
|
|
6919
|
+
/**
|
|
6920
|
+
* Creates TargetSite in a batch.
|
|
6921
|
+
*
|
|
6922
|
+
* @param params - Parameters for request
|
|
6923
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6924
|
+
* @param callback - Optional callback that handles the response.
|
|
6925
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6926
|
+
*/
|
|
6927
|
+
batchCreate(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
6928
|
+
batchCreate(params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
6929
|
+
batchCreate(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
6930
|
+
batchCreate(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
6931
|
+
batchCreate(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
6932
|
+
batchCreate(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
6933
|
+
/**
|
|
6934
|
+
* Creates a TargetSite.
|
|
6935
|
+
*
|
|
6936
|
+
* @param params - Parameters for request
|
|
6937
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6938
|
+
* @param callback - Optional callback that handles the response.
|
|
6939
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6940
|
+
*/
|
|
6941
|
+
create(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
6942
|
+
create(params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
6943
|
+
create(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
6944
|
+
create(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
6945
|
+
create(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
6946
|
+
create(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
6947
|
+
/**
|
|
6948
|
+
* Deletes a TargetSite.
|
|
6949
|
+
*
|
|
6950
|
+
* @param params - Parameters for request
|
|
6951
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6952
|
+
* @param callback - Optional callback that handles the response.
|
|
6953
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6954
|
+
*/
|
|
6955
|
+
delete(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
6956
|
+
delete(params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
6957
|
+
delete(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
6958
|
+
delete(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
6959
|
+
delete(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
6960
|
+
delete(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
6961
|
+
/**
|
|
6962
|
+
* Gets a TargetSite.
|
|
6963
|
+
*
|
|
6964
|
+
* @param params - Parameters for request
|
|
6965
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6966
|
+
* @param callback - Optional callback that handles the response.
|
|
6967
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6968
|
+
*/
|
|
6969
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
6970
|
+
get(params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaTargetSite>;
|
|
6971
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
6972
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaTargetSite>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaTargetSite>): void;
|
|
6973
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaTargetSite>): void;
|
|
6974
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaTargetSite>): void;
|
|
6975
|
+
/**
|
|
6976
|
+
* Gets a list of TargetSites.
|
|
6977
|
+
*
|
|
6978
|
+
* @param params - Parameters for request
|
|
6979
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6980
|
+
* @param callback - Optional callback that handles the response.
|
|
6981
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6982
|
+
*/
|
|
6983
|
+
list(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
6984
|
+
list(params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaListTargetSitesResponse>;
|
|
6985
|
+
list(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
6986
|
+
list(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListTargetSitesResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListTargetSitesResponse>): void;
|
|
6987
|
+
list(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListTargetSitesResponse>): void;
|
|
6988
|
+
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListTargetSitesResponse>): void;
|
|
6989
|
+
/**
|
|
6990
|
+
* Updates a TargetSite.
|
|
6991
|
+
*
|
|
6992
|
+
* @param params - Parameters for request
|
|
6993
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6994
|
+
* @param callback - Optional callback that handles the response.
|
|
6995
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6996
|
+
*/
|
|
6997
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
6998
|
+
patch(params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
6999
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
7000
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
7001
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
7002
|
+
patch(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
7003
|
+
}
|
|
7004
|
+
export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate extends StandardParameters {
|
|
7005
|
+
/**
|
|
7006
|
+
* 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.
|
|
7007
|
+
*/
|
|
7008
|
+
parent?: string;
|
|
7009
|
+
/**
|
|
7010
|
+
* Request body metadata
|
|
7011
|
+
*/
|
|
7012
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesRequest;
|
|
7013
|
+
}
|
|
7014
|
+
export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create extends StandardParameters {
|
|
7015
|
+
/**
|
|
7016
|
+
* Required. Parent resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`.
|
|
7017
|
+
*/
|
|
7018
|
+
parent?: string;
|
|
7019
|
+
/**
|
|
7020
|
+
* Request body metadata
|
|
7021
|
+
*/
|
|
7022
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaTargetSite;
|
|
7023
|
+
}
|
|
7024
|
+
export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete extends StandardParameters {
|
|
7025
|
+
/**
|
|
7026
|
+
* 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.
|
|
7027
|
+
*/
|
|
7028
|
+
name?: string;
|
|
7029
|
+
}
|
|
7030
|
+
export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get extends StandardParameters {
|
|
7031
|
+
/**
|
|
7032
|
+
* 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.
|
|
7033
|
+
*/
|
|
7034
|
+
name?: string;
|
|
7035
|
+
}
|
|
7036
|
+
export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List extends StandardParameters {
|
|
7037
|
+
/**
|
|
7038
|
+
* 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.
|
|
7039
|
+
*/
|
|
7040
|
+
pageSize?: number;
|
|
7041
|
+
/**
|
|
7042
|
+
* 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.
|
|
7043
|
+
*/
|
|
7044
|
+
pageToken?: string;
|
|
7045
|
+
/**
|
|
7046
|
+
* 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.
|
|
7047
|
+
*/
|
|
7048
|
+
parent?: string;
|
|
7049
|
+
}
|
|
7050
|
+
export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch extends StandardParameters {
|
|
7051
|
+
/**
|
|
7052
|
+
* 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.
|
|
7053
|
+
*/
|
|
7054
|
+
name?: string;
|
|
7055
|
+
/**
|
|
7056
|
+
* Request body metadata
|
|
7057
|
+
*/
|
|
7058
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaTargetSite;
|
|
7059
|
+
}
|
|
7060
|
+
export class Resource$Projects$Locations$Datastores$Suggestiondenylistentries {
|
|
7061
|
+
context: APIRequestContext;
|
|
7062
|
+
constructor(context: APIRequestContext);
|
|
7063
|
+
/**
|
|
7064
|
+
* Imports all SuggestionDenyListEntry for a DataStore.
|
|
7065
|
+
*
|
|
7066
|
+
* @param params - Parameters for request
|
|
7067
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
7068
|
+
* @param callback - Optional callback that handles the response.
|
|
7069
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
7070
|
+
*/
|
|
7071
|
+
import(params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
7072
|
+
import(params?: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
7073
|
+
import(params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
7074
|
+
import(params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
7075
|
+
import(params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
7076
|
+
import(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
7077
|
+
/**
|
|
7078
|
+
* Permanently deletes all SuggestionDenyListEntry for a DataStore.
|
|
7079
|
+
*
|
|
7080
|
+
* @param params - Parameters for request
|
|
7081
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
7082
|
+
* @param callback - Optional callback that handles the response.
|
|
7083
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
7084
|
+
*/
|
|
7085
|
+
purge(params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
7086
|
+
purge(params?: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
7087
|
+
purge(params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
7088
|
+
purge(params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
7089
|
+
purge(params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
7090
|
+
purge(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
7091
|
+
}
|
|
7092
|
+
export interface Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import extends StandardParameters {
|
|
7093
|
+
/**
|
|
7094
|
+
* Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x.
|
|
7095
|
+
*/
|
|
7096
|
+
parent?: string;
|
|
7097
|
+
/**
|
|
7098
|
+
* Request body metadata
|
|
7099
|
+
*/
|
|
7100
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesRequest;
|
|
7101
|
+
}
|
|
7102
|
+
export interface Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge extends StandardParameters {
|
|
7103
|
+
/**
|
|
7104
|
+
* Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x.
|
|
7105
|
+
*/
|
|
7106
|
+
parent?: string;
|
|
7107
|
+
/**
|
|
7108
|
+
* Request body metadata
|
|
7109
|
+
*/
|
|
7110
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesRequest;
|
|
7111
|
+
}
|
|
4977
7112
|
export class Resource$Projects$Locations$Datastores$Userevents {
|
|
4978
7113
|
context: APIRequestContext;
|
|
4979
7114
|
constructor(context: APIRequestContext);
|