@googleapis/discoveryengine 4.0.0 → 5.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.
@@ -202,6 +202,42 @@ export declare namespace discoveryengine_v1alpha {
202
202
  */
203
203
  token?: string | null;
204
204
  }
205
+ /**
206
+ * Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.
207
+ */
208
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata {
209
+ /**
210
+ * Operation create time.
211
+ */
212
+ createTime?: string | null;
213
+ /**
214
+ * Operation last update time. If the operation is done, this is also the finish time.
215
+ */
216
+ updateTime?: string | null;
217
+ }
218
+ /**
219
+ * Request message for SiteSearchEngineService.s method.
220
+ */
221
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesRequest {
222
+ /**
223
+ * Required. The request message specifying the resources to create. A maximum of 20 TargetSites can be created in a batch.
224
+ */
225
+ requests?: Schema$GoogleCloudDiscoveryengineV1alphaCreateTargetSiteRequest[];
226
+ }
227
+ /**
228
+ * Response message for SiteSearchEngineService.BatchCreateTargetSites method.
229
+ */
230
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse {
231
+ /**
232
+ * TargetSites created.
233
+ */
234
+ targetSites?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSite[];
235
+ }
236
+ /**
237
+ * Request message for SiteSearchEngineService.BatchVerifyTargetSites method.
238
+ */
239
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaBatchVerifyTargetSitesRequest {
240
+ }
205
241
  /**
206
242
  * BigQuery source import data from.
207
243
  */
@@ -308,7 +344,7 @@ export declare namespace discoveryengine_v1alpha {
308
344
  */
309
345
  messages?: Schema$GoogleCloudDiscoveryengineV1alphaConversationMessage[];
310
346
  /**
311
- * Immutable. Fully qualified name `project/x/locations/global/collections/{collection\}/dataStore/x/conversations/x`
347
+ * Immutable. Fully qualified name `project/x/locations/global/collections/{collection\}/dataStore/x/conversations/x` or `project/x/locations/global/collections/{collection\}/engines/x/conversations/x`.
312
348
  */
313
349
  name?: string | null;
314
350
  /**
@@ -362,6 +398,10 @@ export declare namespace discoveryengine_v1alpha {
362
398
  * The conversation to be used by auto session only. The name field will be ignored as we automatically assign new name for the conversation in auto session.
363
399
  */
364
400
  conversation?: Schema$GoogleCloudDiscoveryengineV1alphaConversation;
401
+ /**
402
+ * The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the summary response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --\> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
403
+ */
404
+ filter?: string | null;
365
405
  /**
366
406
  * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`. Use `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session.
367
407
  */
@@ -449,6 +489,32 @@ export declare namespace discoveryengine_v1alpha {
449
489
  */
450
490
  updateTime?: string | null;
451
491
  }
492
+ /**
493
+ * Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.
494
+ */
495
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaCreateTargetSiteMetadata {
496
+ /**
497
+ * Operation create time.
498
+ */
499
+ createTime?: string | null;
500
+ /**
501
+ * Operation last update time. If the operation is done, this is also the finish time.
502
+ */
503
+ updateTime?: string | null;
504
+ }
505
+ /**
506
+ * Request message for SiteSearchEngineService.CreateTargetSite method.
507
+ */
508
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaCreateTargetSiteRequest {
509
+ /**
510
+ * Required. Parent resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`.
511
+ */
512
+ parent?: string | null;
513
+ /**
514
+ * Required. The TargetSite to create.
515
+ */
516
+ targetSite?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSite;
517
+ }
452
518
  /**
453
519
  * A custom attribute that is not explicitly modeled in a resource, e.g. UserEvent.
454
520
  */
@@ -534,6 +600,42 @@ export declare namespace discoveryengine_v1alpha {
534
600
  */
535
601
  updateTime?: string | null;
536
602
  }
603
+ /**
604
+ * Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.
605
+ */
606
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaDeleteTargetSiteMetadata {
607
+ /**
608
+ * Operation create time.
609
+ */
610
+ createTime?: string | null;
611
+ /**
612
+ * Operation last update time. If the operation is done, this is also the finish time.
613
+ */
614
+ updateTime?: string | null;
615
+ }
616
+ /**
617
+ * Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
618
+ */
619
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata {
620
+ /**
621
+ * Operation create time.
622
+ */
623
+ createTime?: string | null;
624
+ /**
625
+ * Operation last update time. If the operation is done, this is also the finish time.
626
+ */
627
+ updateTime?: string | null;
628
+ }
629
+ /**
630
+ * Request message for SiteSearchEngineService.DisableAdvancedSiteSearch method.
631
+ */
632
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchRequest {
633
+ }
634
+ /**
635
+ * Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.
636
+ */
637
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchResponse {
638
+ }
537
639
  /**
538
640
  * Document captures all raw metadata information of items to be recommended or searched.
539
641
  */
@@ -617,6 +719,19 @@ export declare namespace discoveryengine_v1alpha {
617
719
  */
618
720
  uri?: string | null;
619
721
  }
722
+ /**
723
+ * A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.
724
+ */
725
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig {
726
+ /**
727
+ * Output only. The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`.
728
+ */
729
+ name?: string | null;
730
+ /**
731
+ * The OCR config. Currently it only applies to PDFs.
732
+ */
733
+ ocrConfig?: Schema$GoogleCloudDiscoveryengineV1alphaOcrConfig;
734
+ }
620
735
  /**
621
736
  * Double list.
622
737
  */
@@ -626,6 +741,29 @@ export declare namespace discoveryengine_v1alpha {
626
741
  */
627
742
  values?: number[] | null;
628
743
  }
744
+ /**
745
+ * Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
746
+ */
747
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchMetadata {
748
+ /**
749
+ * Operation create time.
750
+ */
751
+ createTime?: string | null;
752
+ /**
753
+ * Operation last update time. If the operation is done, this is also the finish time.
754
+ */
755
+ updateTime?: string | null;
756
+ }
757
+ /**
758
+ * Request message for SiteSearchEngineService.EnableAdvancedSiteSearch method.
759
+ */
760
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchRequest {
761
+ }
762
+ /**
763
+ * Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.
764
+ */
765
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchResponse {
766
+ }
629
767
  /**
630
768
  * Metadata that describes the training and serving parameters of an Engine.
631
769
  */
@@ -808,6 +946,97 @@ export declare namespace discoveryengine_v1alpha {
808
946
  */
809
947
  export interface Schema$GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig {
810
948
  }
949
+ /**
950
+ * Metadata related to the progress of the EstimateDataSize operation. This is returned by the google.longrunning.Operation.metadata field.
951
+ */
952
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata {
953
+ /**
954
+ * Operation create time.
955
+ */
956
+ createTime?: string | null;
957
+ }
958
+ /**
959
+ * Request message for EstimateBillingService.EstimateDataSize method
960
+ */
961
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequest {
962
+ /**
963
+ * Structured or unstructured data.
964
+ */
965
+ fileDataSource?: Schema$GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestFileDataSource;
966
+ /**
967
+ * Website data.
968
+ */
969
+ websiteDataSource?: Schema$GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSource;
970
+ }
971
+ /**
972
+ * Data source contains files either in GCS or BigQuery.
973
+ */
974
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestFileDataSource {
975
+ /**
976
+ * BigQuery input source.
977
+ */
978
+ bigquerySource?: Schema$GoogleCloudDiscoveryengineV1alphaBigQuerySource;
979
+ /**
980
+ * Cloud Storage location for the input content.
981
+ */
982
+ gcsSource?: Schema$GoogleCloudDiscoveryengineV1alphaGcsSource;
983
+ }
984
+ /**
985
+ * Data source is a set of website patterns that we crawl to get the total number of websites.
986
+ */
987
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSource {
988
+ /**
989
+ * Required. The URI patterns to estimate the data sizes. At most 10 patterns are allowed, otherwise an INVALID_ARGUMENT error is thrown.
990
+ */
991
+ estimatorUriPatterns?: Schema$GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSourceEstimatorUriPattern[];
992
+ }
993
+ /**
994
+ * URI patterns that we use to crawl.
995
+ */
996
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSourceEstimatorUriPattern {
997
+ /**
998
+ * Whether we infer the generated URI or use the exact provided one.
999
+ */
1000
+ exactMatch?: boolean | null;
1001
+ /**
1002
+ * Whether the pattern is exclusive or not. If set to true, the pattern is considered exclusive. If unset or set to false, the pattern is considered inclusive by default.
1003
+ */
1004
+ exclusive?: boolean | null;
1005
+ /**
1006
+ * User provided URI pattern. For example, `foo.com/bar/x`.
1007
+ */
1008
+ providedUriPattern?: string | null;
1009
+ }
1010
+ /**
1011
+ * Response of the EstimateDataSize request. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.
1012
+ */
1013
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse {
1014
+ /**
1015
+ * Data size in terms of bytes.
1016
+ */
1017
+ dataSizeBytes?: string | null;
1018
+ /**
1019
+ * Total number of documents.
1020
+ */
1021
+ documentCount?: string | null;
1022
+ }
1023
+ /**
1024
+ * Response message for SiteSearchEngineService.FetchDomainVerificationStatus method.
1025
+ */
1026
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse {
1027
+ /**
1028
+ * A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
1029
+ */
1030
+ nextPageToken?: string | null;
1031
+ /**
1032
+ * List of TargetSites containing the site verification status.
1033
+ */
1034
+ targetSites?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSite[];
1035
+ /**
1036
+ * The total number of items matching the request. This will always be populated in the response.
1037
+ */
1038
+ totalSize?: number | null;
1039
+ }
811
1040
  /**
812
1041
  * Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.
813
1042
  */
@@ -1105,6 +1334,23 @@ export declare namespace discoveryengine_v1alpha {
1105
1334
  */
1106
1335
  schemas?: Schema$GoogleCloudDiscoveryengineV1alphaSchema[];
1107
1336
  }
1337
+ /**
1338
+ * Response message for SiteSearchEngineService.ListTargetSites method.
1339
+ */
1340
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaListTargetSitesResponse {
1341
+ /**
1342
+ * A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
1343
+ */
1344
+ nextPageToken?: string | null;
1345
+ /**
1346
+ * List of TargetSites.
1347
+ */
1348
+ targetSites?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSite[];
1349
+ /**
1350
+ * The total number of items matching the request. This will always be populated in the response.
1351
+ */
1352
+ totalSize?: number | null;
1353
+ }
1108
1354
  /**
1109
1355
  * Request message for WidgetService.LookupWidgetConfig method.
1110
1356
  */
@@ -1136,6 +1382,23 @@ export declare namespace discoveryengine_v1alpha {
1136
1382
  */
1137
1383
  mediaProgressPercentage?: number | null;
1138
1384
  }
1385
+ /**
1386
+ * The OCR options for parsing documents.
1387
+ */
1388
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaOcrConfig {
1389
+ /**
1390
+ * Required. If OCR is enabled or not. OCR must be enabled for other OcrConfig options to apply.
1391
+ */
1392
+ enabled?: boolean | null;
1393
+ /**
1394
+ * Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.
1395
+ */
1396
+ enhancedDocumentElements?: string[] | null;
1397
+ /**
1398
+ * If true, will use native text instead of OCR text on pages containing native text.
1399
+ */
1400
+ useNativeText?: boolean | null;
1401
+ }
1139
1402
  /**
1140
1403
  * Detailed page information.
1141
1404
  */
@@ -1704,11 +1967,37 @@ export declare namespace discoveryengine_v1alpha {
1704
1967
  * Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.
1705
1968
  */
1706
1969
  languageCode?: string | null;
1970
+ /**
1971
+ * If specified, the spec will be used to modify the prompt provided to the LLM.
1972
+ */
1973
+ modelPromptSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec;
1974
+ /**
1975
+ * If specified, the spec will be used to modify the model specification provided to the LLM.
1976
+ */
1977
+ modelSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec;
1707
1978
  /**
1708
1979
  * The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most five results can be used to generate a summary.
1709
1980
  */
1710
1981
  summaryResultCount?: number | null;
1711
1982
  }
1983
+ /**
1984
+ * Specification of the prompt to use with the model.
1985
+ */
1986
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec {
1987
+ /**
1988
+ * Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.
1989
+ */
1990
+ preamble?: string | null;
1991
+ }
1992
+ /**
1993
+ * Specification of the model.
1994
+ */
1995
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec {
1996
+ /**
1997
+ * The string format of the model version. e.g. stable, preview, etc.
1998
+ */
1999
+ version?: string | null;
2000
+ }
1712
2001
  /**
1713
2002
  * The specification that uses customized query embedding vector to do semantic document retrieval.
1714
2003
  */
@@ -1987,6 +2276,59 @@ export declare namespace discoveryengine_v1alpha {
1987
2276
  * The summary content.
1988
2277
  */
1989
2278
  summaryText?: string | null;
2279
+ summaryWithMetadata?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummaryWithMetadata;
2280
+ }
2281
+ /**
2282
+ * Citation info for a segment.
2283
+ */
2284
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitation {
2285
+ /**
2286
+ * End of the attributed segment, exclusive.
2287
+ */
2288
+ endIndex?: string | null;
2289
+ /**
2290
+ * Citation sources for the attributed segment.
2291
+ */
2292
+ sources?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationSource[];
2293
+ /**
2294
+ * Index indicates the start of the segment, measured in bytes/unicode.
2295
+ */
2296
+ startIndex?: string | null;
2297
+ }
2298
+ /**
2299
+ * Citation metadata.
2300
+ */
2301
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationMetadata {
2302
+ /**
2303
+ * Citations for segments.
2304
+ */
2305
+ citations?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitation[];
2306
+ }
2307
+ /**
2308
+ * Citation source.
2309
+ */
2310
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationSource {
2311
+ /**
2312
+ * Document reference index from SummaryWithMetadata.references. It is 0-indexed and the value will be zero if the reference_index is not set explicitly.
2313
+ */
2314
+ referenceIndex?: string | null;
2315
+ }
2316
+ /**
2317
+ * Document reference.
2318
+ */
2319
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReference {
2320
+ /**
2321
+ * Required. Document.name of the document. Full resource name of the referenced document, in the format `projects/x/locations/x/collections/x/dataStores/x/branches/x/documents/x`.
2322
+ */
2323
+ document?: string | null;
2324
+ /**
2325
+ * Title of the document.
2326
+ */
2327
+ title?: string | null;
2328
+ /**
2329
+ * GCS or HTTP uri for the document.
2330
+ */
2331
+ uri?: string | null;
1990
2332
  }
1991
2333
  /**
1992
2334
  * Safety Attribute categories and their associated confidence scores.
@@ -2001,6 +2343,32 @@ export declare namespace discoveryengine_v1alpha {
2001
2343
  */
2002
2344
  scores?: number[] | null;
2003
2345
  }
2346
+ /**
2347
+ * Summary with metadata information.
2348
+ */
2349
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummaryWithMetadata {
2350
+ /**
2351
+ * Citation metadata for given summary.
2352
+ */
2353
+ citationMetadata?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationMetadata;
2354
+ /**
2355
+ * Document References.
2356
+ */
2357
+ references?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReference[];
2358
+ /**
2359
+ * Summary text with no citation information.
2360
+ */
2361
+ summary?: string | null;
2362
+ }
2363
+ /**
2364
+ * SiteSearchEngine captures DataStore level site search persisting configurations. It is a singleton value per data store.
2365
+ */
2366
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaSiteSearchEngine {
2367
+ /**
2368
+ * The fully qualified resource name of the site search engine. Format: `projects/x/locations/x/dataStores/x/siteSearchEngine`
2369
+ */
2370
+ name?: string | null;
2371
+ }
2004
2372
  /**
2005
2373
  * Verification information for target sites in advanced site search.
2006
2374
  */
@@ -2080,29 +2448,97 @@ export declare namespace discoveryengine_v1alpha {
2080
2448
  input?: string | null;
2081
2449
  }
2082
2450
  /**
2083
- * A transaction represents the entire purchase transaction.
2451
+ * Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field.
2084
2452
  */
2085
- export interface Schema$GoogleCloudDiscoveryengineV1alphaTransactionInfo {
2453
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata {
2086
2454
  /**
2087
- * 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
2455
+ * Operation create time.
2088
2456
  */
2089
- cost?: number | null;
2457
+ createTime?: string | null;
2090
2458
  /**
2091
- * Required. Currency code. Use three-character ISO-4217 code.
2459
+ * Operation last update time. If the operation is done, this is also the finish time.
2092
2460
  */
2093
- currency?: string | null;
2461
+ updateTime?: string | null;
2462
+ }
2463
+ /**
2464
+ * Request message for SearchTuningService.TrainCustomModel method.
2465
+ */
2466
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequest {
2094
2467
  /**
2095
- * 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
2468
+ * The desired location of errors incurred during the data ingestion and training.
2096
2469
  */
2097
- discountValue?: number | null;
2470
+ errorConfig?: Schema$GoogleCloudDiscoveryengineV1alphaImportErrorConfig;
2098
2471
  /**
2099
- * All the taxes associated with the transaction.
2472
+ * Gcs training input.
2100
2473
  */
2101
- tax?: number | null;
2474
+ gcsTrainingInput?: Schema$GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequestGcsTrainingInput;
2102
2475
  /**
2103
- * The transaction ID with a length limit of 128 characters.
2476
+ * Model to be trained. Supported values are: * **search-tuning**: Fine tuning the search system based on data provided.
2104
2477
  */
2105
- transactionId?: string | null;
2478
+ modelType?: string | null;
2479
+ }
2480
+ /**
2481
+ * Gcs training data input.
2482
+ */
2483
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequestGcsTrainingInput {
2484
+ /**
2485
+ * The gcs corpus data which could be associated in train data. The data path format is gs:///. A newline delimited jsonl/ndjson file. * For search-tuning model, each line should have the _id, title and text. Example: {"_id": "doc1", title: "relevant doc", "text": "relevant text"\}
2486
+ */
2487
+ corpusDataPath?: string | null;
2488
+ /**
2489
+ * The gcs query data which could be associated in train data. The data path format is gs:///. A newline delimited jsonl/ndjson file. * For search-tuning model, each line should have the _id and text. Example: {"_id": "query1", "text": "example query"\}
2490
+ */
2491
+ queryDataPath?: string | null;
2492
+ /**
2493
+ * Gcs test data. Same format as train_data_path. If not provided, a random 80/20 train/test split will be performed on train_data_path.
2494
+ */
2495
+ testDataPath?: string | null;
2496
+ /**
2497
+ * Gcs training data path whose format should be gs:///. The file should be in tsv format. Each line should have the doc_id and query_id and score (number). * For search-tuning model, it should have the query-id corpus-id score as tsv file header. The score should be a number in [0, inf+). The larger the number is, the more relevant the pair is. Example: query-id\tcorpus-id\tscore query1\tdoc1\t1
2498
+ */
2499
+ trainDataPath?: string | null;
2500
+ }
2501
+ /**
2502
+ * Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field.
2503
+ */
2504
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse {
2505
+ /**
2506
+ * Echoes the destination for the complete errors in the request if set.
2507
+ */
2508
+ errorConfig?: Schema$GoogleCloudDiscoveryengineV1alphaImportErrorConfig;
2509
+ /**
2510
+ * A sample of errors encountered while processing the data.
2511
+ */
2512
+ errorSamples?: Schema$GoogleRpcStatus[];
2513
+ /**
2514
+ * The trained model status. Possible values are: * **bad-data**: The training data quality is bad. * **no-improvement**: Tuning didn't improve performance. Won't deploy. * **in-progress**: Model training is in progress. * **ready**: The model is ready for serving.
2515
+ */
2516
+ modelStatus?: string | null;
2517
+ }
2518
+ /**
2519
+ * A transaction represents the entire purchase transaction.
2520
+ */
2521
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaTransactionInfo {
2522
+ /**
2523
+ * 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
2524
+ */
2525
+ cost?: number | null;
2526
+ /**
2527
+ * Required. Currency code. Use three-character ISO-4217 code.
2528
+ */
2529
+ currency?: string | null;
2530
+ /**
2531
+ * 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
2532
+ */
2533
+ discountValue?: number | null;
2534
+ /**
2535
+ * All the taxes associated with the transaction.
2536
+ */
2537
+ tax?: number | null;
2538
+ /**
2539
+ * The transaction ID with a length limit of 128 characters.
2540
+ */
2541
+ transactionId?: string | null;
2106
2542
  /**
2107
2543
  * 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.
2108
2544
  */
@@ -2140,6 +2576,19 @@ export declare namespace discoveryengine_v1alpha {
2140
2576
  */
2141
2577
  updateTime?: string | null;
2142
2578
  }
2579
+ /**
2580
+ * Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.
2581
+ */
2582
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata {
2583
+ /**
2584
+ * Operation create time.
2585
+ */
2586
+ createTime?: string | null;
2587
+ /**
2588
+ * Operation last update time. If the operation is done, this is also the finish time.
2589
+ */
2590
+ updateTime?: string | null;
2591
+ }
2143
2592
  /**
2144
2593
  * UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with customers' website.
2145
2594
  */
@@ -3013,6 +3462,30 @@ export declare namespace discoveryengine_v1alpha {
3013
3462
  dataStores: Resource$Projects$Locations$Datastores;
3014
3463
  operations: Resource$Projects$Locations$Operations;
3015
3464
  constructor(context: APIRequestContext);
3465
+ /**
3466
+ * Estimates the data size to be used by a customer.
3467
+ *
3468
+ * @param params - Parameters for request
3469
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
3470
+ * @param callback - Optional callback that handles the response.
3471
+ * @returns A promise if used with async/await, or void if used with a callback.
3472
+ */
3473
+ estimateDataSize(params: Params$Resource$Projects$Locations$Estimatedatasize, options: StreamMethodOptions): GaxiosPromise<Readable>;
3474
+ estimateDataSize(params?: Params$Resource$Projects$Locations$Estimatedatasize, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
3475
+ estimateDataSize(params: Params$Resource$Projects$Locations$Estimatedatasize, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
3476
+ estimateDataSize(params: Params$Resource$Projects$Locations$Estimatedatasize, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
3477
+ estimateDataSize(params: Params$Resource$Projects$Locations$Estimatedatasize, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
3478
+ estimateDataSize(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
3479
+ }
3480
+ export interface Params$Resource$Projects$Locations$Estimatedatasize extends StandardParameters {
3481
+ /**
3482
+ * Required. Full resource name of the Location, such as `projects/{project\}/locations/{location\}`.
3483
+ */
3484
+ location?: string;
3485
+ /**
3486
+ * Request body metadata
3487
+ */
3488
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequest;
3016
3489
  }
3017
3490
  export class Resource$Projects$Locations$Collections {
3018
3491
  context: APIRequestContext;
@@ -3150,6 +3623,34 @@ export declare namespace discoveryengine_v1alpha {
3150
3623
  get(params: Params$Resource$Projects$Locations$Collections$Datastores$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>): void;
3151
3624
  get(params: Params$Resource$Projects$Locations$Collections$Datastores$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>): void;
3152
3625
  get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>): void;
3626
+ /**
3627
+ * Gets a DocumentProcessingConfig.
3628
+ *
3629
+ * @param params - Parameters for request
3630
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
3631
+ * @param callback - Optional callback that handles the response.
3632
+ * @returns A promise if used with async/await, or void if used with a callback.
3633
+ */
3634
+ getDocumentProcessingConfig(params: Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig, options: StreamMethodOptions): GaxiosPromise<Readable>;
3635
+ getDocumentProcessingConfig(params?: Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig>;
3636
+ getDocumentProcessingConfig(params: Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
3637
+ getDocumentProcessingConfig(params: Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig>): void;
3638
+ getDocumentProcessingConfig(params: Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig>): void;
3639
+ getDocumentProcessingConfig(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig>): void;
3640
+ /**
3641
+ * Gets the SiteSearchEngine.
3642
+ *
3643
+ * @param params - Parameters for request
3644
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
3645
+ * @param callback - Optional callback that handles the response.
3646
+ * @returns A promise if used with async/await, or void if used with a callback.
3647
+ */
3648
+ getSiteSearchEngine(params: Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine, options: StreamMethodOptions): GaxiosPromise<Readable>;
3649
+ getSiteSearchEngine(params?: Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaSiteSearchEngine>;
3650
+ getSiteSearchEngine(params: Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
3651
+ getSiteSearchEngine(params: Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSiteSearchEngine>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSiteSearchEngine>): void;
3652
+ getSiteSearchEngine(params: Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSiteSearchEngine>): void;
3653
+ getSiteSearchEngine(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSiteSearchEngine>): void;
3153
3654
  /**
3154
3655
  * Lists all the DataStores associated with the project.
3155
3656
  *
@@ -3178,6 +3679,34 @@ export declare namespace discoveryengine_v1alpha {
3178
3679
  patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>): void;
3179
3680
  patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>): void;
3180
3681
  patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>): void;
3682
+ /**
3683
+ * Trains a custom model.
3684
+ *
3685
+ * @param params - Parameters for request
3686
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
3687
+ * @param callback - Optional callback that handles the response.
3688
+ * @returns A promise if used with async/await, or void if used with a callback.
3689
+ */
3690
+ trainCustomModel(params: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, options: StreamMethodOptions): GaxiosPromise<Readable>;
3691
+ trainCustomModel(params?: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
3692
+ trainCustomModel(params: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
3693
+ trainCustomModel(params: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
3694
+ trainCustomModel(params: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
3695
+ trainCustomModel(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
3696
+ /**
3697
+ * Updates the DocumentProcessingConfig. DocumentProcessingConfig is a singleon resource of DataStore. It's empty when DataStore is created. The first call to this method will set up DocumentProcessingConfig.
3698
+ *
3699
+ * @param params - Parameters for request
3700
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
3701
+ * @param callback - Optional callback that handles the response.
3702
+ * @returns A promise if used with async/await, or void if used with a callback.
3703
+ */
3704
+ updateDocumentProcessingConfig(params: Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig, options: StreamMethodOptions): GaxiosPromise<Readable>;
3705
+ updateDocumentProcessingConfig(params?: Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig>;
3706
+ updateDocumentProcessingConfig(params: Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
3707
+ updateDocumentProcessingConfig(params: Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig>): void;
3708
+ updateDocumentProcessingConfig(params: Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig>): void;
3709
+ updateDocumentProcessingConfig(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig>): void;
3181
3710
  }
3182
3711
  export interface Params$Resource$Projects$Locations$Collections$Datastores$Completequery extends StandardParameters {
3183
3712
  /**
@@ -3231,6 +3760,18 @@ export declare namespace discoveryengine_v1alpha {
3231
3760
  */
3232
3761
  name?: string;
3233
3762
  }
3763
+ export interface Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig extends StandardParameters {
3764
+ /**
3765
+ * Required. Full DocumentProcessingConfig resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/documentProcessingConfig`
3766
+ */
3767
+ name?: string;
3768
+ }
3769
+ export interface Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine extends StandardParameters {
3770
+ /**
3771
+ * 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.
3772
+ */
3773
+ name?: string;
3774
+ }
3234
3775
  export interface Params$Resource$Projects$Locations$Collections$Datastores$List extends StandardParameters {
3235
3776
  /**
3236
3777
  * Filter by solution type. For example: filter = 'solution_type:SOLUTION_TYPE_SEARCH'
@@ -3263,6 +3804,30 @@ export declare namespace discoveryengine_v1alpha {
3263
3804
  */
3264
3805
  requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDataStore;
3265
3806
  }
3807
+ export interface Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel extends StandardParameters {
3808
+ /**
3809
+ * Required. The resource name of the Data Store, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to train the models.
3810
+ */
3811
+ dataStore?: string;
3812
+ /**
3813
+ * Request body metadata
3814
+ */
3815
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequest;
3816
+ }
3817
+ export interface Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig extends StandardParameters {
3818
+ /**
3819
+ * Output only. The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`.
3820
+ */
3821
+ name?: string;
3822
+ /**
3823
+ * Indicates which fields in the provided DocumentProcessingConfig to update. The following are the only supported fields: * DocumentProcessingConfig.orc_config If not set, all supported fields are updated.
3824
+ */
3825
+ updateMask?: string;
3826
+ /**
3827
+ * Request body metadata
3828
+ */
3829
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig;
3830
+ }
3266
3831
  export class Resource$Projects$Locations$Collections$Datastores$Branches {
3267
3832
  context: APIRequestContext;
3268
3833
  documents: Resource$Projects$Locations$Collections$Datastores$Branches$Documents;
@@ -3645,7 +4210,7 @@ export declare namespace discoveryengine_v1alpha {
3645
4210
  }
3646
4211
  export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch extends StandardParameters {
3647
4212
  /**
3648
- * Immutable. Fully qualified name `project/x/locations/global/collections/{collection\}/dataStore/x/conversations/x`
4213
+ * Immutable. Fully qualified name `project/x/locations/global/collections/{collection\}/dataStore/x/conversations/x` or `project/x/locations/global/collections/{collection\}/engines/x/conversations/x`.
3649
4214
  */
3650
4215
  name?: string;
3651
4216
  /**
@@ -4016,6 +4581,62 @@ export declare namespace discoveryengine_v1alpha {
4016
4581
  operations: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations;
4017
4582
  targetSites: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites;
4018
4583
  constructor(context: APIRequestContext);
4584
+ /**
4585
+ * Verify target sites' ownership and validity. This API sends all the target sites under site search engine for verification.
4586
+ *
4587
+ * @param params - Parameters for request
4588
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
4589
+ * @param callback - Optional callback that handles the response.
4590
+ * @returns A promise if used with async/await, or void if used with a callback.
4591
+ */
4592
+ batchVerifyTargetSites(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, options: StreamMethodOptions): GaxiosPromise<Readable>;
4593
+ batchVerifyTargetSites(params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
4594
+ batchVerifyTargetSites(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
4595
+ batchVerifyTargetSites(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
4596
+ batchVerifyTargetSites(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
4597
+ batchVerifyTargetSites(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
4598
+ /**
4599
+ * Downgrade from advanced site search to basic site search.
4600
+ *
4601
+ * @param params - Parameters for request
4602
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
4603
+ * @param callback - Optional callback that handles the response.
4604
+ * @returns A promise if used with async/await, or void if used with a callback.
4605
+ */
4606
+ disableAdvancedSiteSearch(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch, options: StreamMethodOptions): GaxiosPromise<Readable>;
4607
+ disableAdvancedSiteSearch(params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
4608
+ disableAdvancedSiteSearch(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
4609
+ disableAdvancedSiteSearch(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
4610
+ disableAdvancedSiteSearch(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
4611
+ disableAdvancedSiteSearch(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
4612
+ /**
4613
+ * Upgrade from basic site search to advanced site search.
4614
+ *
4615
+ * @param params - Parameters for request
4616
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
4617
+ * @param callback - Optional callback that handles the response.
4618
+ * @returns A promise if used with async/await, or void if used with a callback.
4619
+ */
4620
+ enableAdvancedSiteSearch(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch, options: StreamMethodOptions): GaxiosPromise<Readable>;
4621
+ enableAdvancedSiteSearch(params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
4622
+ enableAdvancedSiteSearch(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
4623
+ enableAdvancedSiteSearch(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
4624
+ enableAdvancedSiteSearch(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
4625
+ enableAdvancedSiteSearch(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
4626
+ /**
4627
+ * 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.
4628
+ *
4629
+ * @param params - Parameters for request
4630
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
4631
+ * @param callback - Optional callback that handles the response.
4632
+ * @returns A promise if used with async/await, or void if used with a callback.
4633
+ */
4634
+ fetchDomainVerificationStatus(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus, options: StreamMethodOptions): GaxiosPromise<Readable>;
4635
+ fetchDomainVerificationStatus(params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse>;
4636
+ fetchDomainVerificationStatus(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
4637
+ fetchDomainVerificationStatus(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse>): void;
4638
+ fetchDomainVerificationStatus(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse>): void;
4639
+ fetchDomainVerificationStatus(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse>): void;
4019
4640
  /**
4020
4641
  * Request on-demand recrawl for a list of URIs.
4021
4642
  *
@@ -4031,6 +4652,50 @@ export declare namespace discoveryengine_v1alpha {
4031
4652
  recrawlUris(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
4032
4653
  recrawlUris(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
4033
4654
  }
4655
+ export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites extends StandardParameters {
4656
+ /**
4657
+ * Required. The parent resource shared by all TargetSites being verified. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`.
4658
+ */
4659
+ parent?: string;
4660
+ /**
4661
+ * Request body metadata
4662
+ */
4663
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaBatchVerifyTargetSitesRequest;
4664
+ }
4665
+ export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch extends StandardParameters {
4666
+ /**
4667
+ * Required. Full resource name of the SiteSearchEngine, such as `projects/{project\}/locations/{location\}/dataStores/{data_store_id\}/siteSearchEngine`.
4668
+ */
4669
+ siteSearchEngine?: string;
4670
+ /**
4671
+ * Request body metadata
4672
+ */
4673
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchRequest;
4674
+ }
4675
+ export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch extends StandardParameters {
4676
+ /**
4677
+ * Required. Full resource name of the SiteSearchEngine, such as `projects/{project\}/locations/{location\}/dataStores/{data_store_id\}/siteSearchEngine`.
4678
+ */
4679
+ siteSearchEngine?: string;
4680
+ /**
4681
+ * Request body metadata
4682
+ */
4683
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchRequest;
4684
+ }
4685
+ export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus extends StandardParameters {
4686
+ /**
4687
+ * 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.
4688
+ */
4689
+ pageSize?: number;
4690
+ /**
4691
+ * 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.
4692
+ */
4693
+ pageToken?: string;
4694
+ /**
4695
+ * 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`.
4696
+ */
4697
+ siteSearchEngine?: string;
4698
+ }
4034
4699
  export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris extends StandardParameters {
4035
4700
  /**
4036
4701
  * Required. Full resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`.
@@ -4101,117 +4766,257 @@ export declare namespace discoveryengine_v1alpha {
4101
4766
  context: APIRequestContext;
4102
4767
  operations: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations;
4103
4768
  constructor(context: APIRequestContext);
4104
- }
4105
- export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations {
4106
- context: APIRequestContext;
4107
- constructor(context: APIRequestContext);
4108
4769
  /**
4109
- * 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.
4770
+ * Creates TargetSite in a batch.
4110
4771
  *
4111
4772
  * @param params - Parameters for request
4112
4773
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
4113
4774
  * @param callback - Optional callback that handles the response.
4114
4775
  * @returns A promise if used with async/await, or void if used with a callback.
4115
4776
  */
4116
- get(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
4117
- get(params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
4118
- get(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
4119
- get(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
4120
- get(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
4121
- get(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
4777
+ batchCreate(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, options: StreamMethodOptions): GaxiosPromise<Readable>;
4778
+ batchCreate(params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
4779
+ batchCreate(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
4780
+ batchCreate(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
4781
+ batchCreate(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
4782
+ batchCreate(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
4122
4783
  /**
4123
- * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
4784
+ * Creates a TargetSite.
4124
4785
  *
4125
4786
  * @param params - Parameters for request
4126
4787
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
4127
4788
  * @param callback - Optional callback that handles the response.
4128
4789
  * @returns A promise if used with async/await, or void if used with a callback.
4129
4790
  */
4130
- list(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
4131
- list(params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningListOperationsResponse>;
4132
- list(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
4133
- list(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>, callback: BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>): void;
4134
- list(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List, callback: BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>): void;
4135
- list(callback: BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>): void;
4136
- }
4137
- export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get extends StandardParameters {
4138
- /**
4139
- * The name of the operation resource.
4140
- */
4141
- name?: string;
4142
- }
4143
- export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List extends StandardParameters {
4144
- /**
4145
- * The standard list filter.
4146
- */
4147
- filter?: string;
4148
- /**
4149
- * The name of the operation's parent resource.
4150
- */
4151
- name?: string;
4152
- /**
4153
- * The standard list page size.
4154
- */
4155
- pageSize?: number;
4156
- /**
4157
- * The standard list page token.
4158
- */
4159
- pageToken?: string;
4160
- }
4161
- export class Resource$Projects$Locations$Collections$Datastores$Userevents {
4162
- context: APIRequestContext;
4163
- constructor(context: APIRequestContext);
4791
+ create(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, options: StreamMethodOptions): GaxiosPromise<Readable>;
4792
+ create(params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
4793
+ create(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
4794
+ create(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
4795
+ create(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
4796
+ create(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
4164
4797
  /**
4165
- * Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.
4798
+ * Deletes a TargetSite.
4166
4799
  *
4167
4800
  * @param params - Parameters for request
4168
4801
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
4169
4802
  * @param callback - Optional callback that handles the response.
4170
4803
  * @returns A promise if used with async/await, or void if used with a callback.
4171
4804
  */
4172
- collect(params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, options: StreamMethodOptions): GaxiosPromise<Readable>;
4173
- collect(params?: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, options?: MethodOptions): GaxiosPromise<Schema$GoogleApiHttpBody>;
4174
- collect(params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
4175
- collect(params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, options: MethodOptions | BodyResponseCallback<Schema$GoogleApiHttpBody>, callback: BodyResponseCallback<Schema$GoogleApiHttpBody>): void;
4176
- collect(params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, callback: BodyResponseCallback<Schema$GoogleApiHttpBody>): void;
4177
- collect(callback: BodyResponseCallback<Schema$GoogleApiHttpBody>): void;
4805
+ delete(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, options: StreamMethodOptions): GaxiosPromise<Readable>;
4806
+ delete(params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
4807
+ delete(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
4808
+ delete(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
4809
+ delete(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
4810
+ delete(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
4178
4811
  /**
4179
- * Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.
4812
+ * Gets a TargetSite.
4180
4813
  *
4181
4814
  * @param params - Parameters for request
4182
4815
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
4183
4816
  * @param callback - Optional callback that handles the response.
4184
4817
  * @returns A promise if used with async/await, or void if used with a callback.
4185
4818
  */
4186
- import(params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, options: StreamMethodOptions): GaxiosPromise<Readable>;
4187
- import(params?: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
4188
- import(params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
4189
- import(params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
4190
- import(params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
4191
- import(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
4819
+ get(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
4820
+ get(params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaTargetSite>;
4821
+ get(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
4822
+ get(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaTargetSite>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaTargetSite>): void;
4823
+ get(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaTargetSite>): void;
4824
+ get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaTargetSite>): void;
4192
4825
  /**
4193
- * Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete. To test a filter, use the list command first.
4826
+ * Gets a list of TargetSites.
4194
4827
  *
4195
4828
  * @param params - Parameters for request
4196
4829
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
4197
4830
  * @param callback - Optional callback that handles the response.
4198
4831
  * @returns A promise if used with async/await, or void if used with a callback.
4199
4832
  */
4200
- purge(params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge, options: StreamMethodOptions): GaxiosPromise<Readable>;
4201
- purge(params?: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
4202
- purge(params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
4203
- purge(params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
4204
- purge(params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
4205
- purge(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
4833
+ list(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
4834
+ list(params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaListTargetSitesResponse>;
4835
+ list(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
4836
+ list(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListTargetSitesResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListTargetSitesResponse>): void;
4837
+ list(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListTargetSitesResponse>): void;
4838
+ list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListTargetSitesResponse>): void;
4206
4839
  /**
4207
- * Writes a single user event.
4840
+ * Updates a TargetSite.
4208
4841
  *
4209
4842
  * @param params - Parameters for request
4210
4843
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
4211
4844
  * @param callback - Optional callback that handles the response.
4212
4845
  * @returns A promise if used with async/await, or void if used with a callback.
4213
4846
  */
4214
- write(params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, options: StreamMethodOptions): GaxiosPromise<Readable>;
4847
+ patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
4848
+ patch(params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
4849
+ patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
4850
+ patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
4851
+ patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
4852
+ patch(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
4853
+ }
4854
+ export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate extends StandardParameters {
4855
+ /**
4856
+ * 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.
4857
+ */
4858
+ parent?: string;
4859
+ /**
4860
+ * Request body metadata
4861
+ */
4862
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesRequest;
4863
+ }
4864
+ export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create extends StandardParameters {
4865
+ /**
4866
+ * Required. Parent resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`.
4867
+ */
4868
+ parent?: string;
4869
+ /**
4870
+ * Request body metadata
4871
+ */
4872
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSite;
4873
+ }
4874
+ export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete extends StandardParameters {
4875
+ /**
4876
+ * 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.
4877
+ */
4878
+ name?: string;
4879
+ }
4880
+ export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get extends StandardParameters {
4881
+ /**
4882
+ * 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.
4883
+ */
4884
+ name?: string;
4885
+ }
4886
+ export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List extends StandardParameters {
4887
+ /**
4888
+ * 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.
4889
+ */
4890
+ pageSize?: number;
4891
+ /**
4892
+ * 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.
4893
+ */
4894
+ pageToken?: string;
4895
+ /**
4896
+ * 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.
4897
+ */
4898
+ parent?: string;
4899
+ }
4900
+ export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch extends StandardParameters {
4901
+ /**
4902
+ * 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.
4903
+ */
4904
+ name?: string;
4905
+ /**
4906
+ * Request body metadata
4907
+ */
4908
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSite;
4909
+ }
4910
+ export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations {
4911
+ context: APIRequestContext;
4912
+ constructor(context: APIRequestContext);
4913
+ /**
4914
+ * 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.
4915
+ *
4916
+ * @param params - Parameters for request
4917
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
4918
+ * @param callback - Optional callback that handles the response.
4919
+ * @returns A promise if used with async/await, or void if used with a callback.
4920
+ */
4921
+ get(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
4922
+ get(params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
4923
+ get(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
4924
+ get(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
4925
+ get(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
4926
+ get(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
4927
+ /**
4928
+ * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
4929
+ *
4930
+ * @param params - Parameters for request
4931
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
4932
+ * @param callback - Optional callback that handles the response.
4933
+ * @returns A promise if used with async/await, or void if used with a callback.
4934
+ */
4935
+ list(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
4936
+ list(params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningListOperationsResponse>;
4937
+ list(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
4938
+ list(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>, callback: BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>): void;
4939
+ list(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List, callback: BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>): void;
4940
+ list(callback: BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>): void;
4941
+ }
4942
+ export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get extends StandardParameters {
4943
+ /**
4944
+ * The name of the operation resource.
4945
+ */
4946
+ name?: string;
4947
+ }
4948
+ export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List extends StandardParameters {
4949
+ /**
4950
+ * The standard list filter.
4951
+ */
4952
+ filter?: string;
4953
+ /**
4954
+ * The name of the operation's parent resource.
4955
+ */
4956
+ name?: string;
4957
+ /**
4958
+ * The standard list page size.
4959
+ */
4960
+ pageSize?: number;
4961
+ /**
4962
+ * The standard list page token.
4963
+ */
4964
+ pageToken?: string;
4965
+ }
4966
+ export class Resource$Projects$Locations$Collections$Datastores$Userevents {
4967
+ context: APIRequestContext;
4968
+ constructor(context: APIRequestContext);
4969
+ /**
4970
+ * Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.
4971
+ *
4972
+ * @param params - Parameters for request
4973
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
4974
+ * @param callback - Optional callback that handles the response.
4975
+ * @returns A promise if used with async/await, or void if used with a callback.
4976
+ */
4977
+ collect(params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, options: StreamMethodOptions): GaxiosPromise<Readable>;
4978
+ collect(params?: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, options?: MethodOptions): GaxiosPromise<Schema$GoogleApiHttpBody>;
4979
+ collect(params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
4980
+ collect(params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, options: MethodOptions | BodyResponseCallback<Schema$GoogleApiHttpBody>, callback: BodyResponseCallback<Schema$GoogleApiHttpBody>): void;
4981
+ collect(params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, callback: BodyResponseCallback<Schema$GoogleApiHttpBody>): void;
4982
+ collect(callback: BodyResponseCallback<Schema$GoogleApiHttpBody>): void;
4983
+ /**
4984
+ * Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.
4985
+ *
4986
+ * @param params - Parameters for request
4987
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
4988
+ * @param callback - Optional callback that handles the response.
4989
+ * @returns A promise if used with async/await, or void if used with a callback.
4990
+ */
4991
+ import(params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, options: StreamMethodOptions): GaxiosPromise<Readable>;
4992
+ import(params?: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
4993
+ import(params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
4994
+ import(params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
4995
+ import(params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
4996
+ import(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
4997
+ /**
4998
+ * Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete. To test a filter, use the list command first.
4999
+ *
5000
+ * @param params - Parameters for request
5001
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
5002
+ * @param callback - Optional callback that handles the response.
5003
+ * @returns A promise if used with async/await, or void if used with a callback.
5004
+ */
5005
+ purge(params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge, options: StreamMethodOptions): GaxiosPromise<Readable>;
5006
+ purge(params?: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
5007
+ purge(params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
5008
+ purge(params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
5009
+ purge(params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
5010
+ purge(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
5011
+ /**
5012
+ * Writes a single user event.
5013
+ *
5014
+ * @param params - Parameters for request
5015
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
5016
+ * @param callback - Optional callback that handles the response.
5017
+ * @returns A promise if used with async/await, or void if used with a callback.
5018
+ */
5019
+ write(params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, options: StreamMethodOptions): GaxiosPromise<Readable>;
4215
5020
  write(params?: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaUserEvent>;
4216
5021
  write(params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
4217
5022
  write(params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaUserEvent>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaUserEvent>): void;
@@ -4268,6 +5073,7 @@ export declare namespace discoveryengine_v1alpha {
4268
5073
  }
4269
5074
  export class Resource$Projects$Locations$Collections$Engines {
4270
5075
  context: APIRequestContext;
5076
+ conversations: Resource$Projects$Locations$Collections$Engines$Conversations;
4271
5077
  operations: Resource$Projects$Locations$Collections$Engines$Operations;
4272
5078
  servingConfigs: Resource$Projects$Locations$Collections$Engines$Servingconfigs;
4273
5079
  constructor(context: APIRequestContext);
@@ -4472,6 +5278,162 @@ export declare namespace discoveryengine_v1alpha {
4472
5278
  */
4473
5279
  requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaTuneEngineRequest;
4474
5280
  }
5281
+ export class Resource$Projects$Locations$Collections$Engines$Conversations {
5282
+ context: APIRequestContext;
5283
+ constructor(context: APIRequestContext);
5284
+ /**
5285
+ * Converses a conversation.
5286
+ *
5287
+ * @param params - Parameters for request
5288
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
5289
+ * @param callback - Optional callback that handles the response.
5290
+ * @returns A promise if used with async/await, or void if used with a callback.
5291
+ */
5292
+ converse(params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse, options: StreamMethodOptions): GaxiosPromise<Readable>;
5293
+ converse(params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaConverseConversationResponse>;
5294
+ converse(params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
5295
+ converse(params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaConverseConversationResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaConverseConversationResponse>): void;
5296
+ converse(params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaConverseConversationResponse>): void;
5297
+ converse(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaConverseConversationResponse>): void;
5298
+ /**
5299
+ * Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned.
5300
+ *
5301
+ * @param params - Parameters for request
5302
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
5303
+ * @param callback - Optional callback that handles the response.
5304
+ * @returns A promise if used with async/await, or void if used with a callback.
5305
+ */
5306
+ create(params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, options: StreamMethodOptions): GaxiosPromise<Readable>;
5307
+ create(params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaConversation>;
5308
+ create(params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
5309
+ create(params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaConversation>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaConversation>): void;
5310
+ create(params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaConversation>): void;
5311
+ create(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaConversation>): void;
5312
+ /**
5313
+ * Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned.
5314
+ *
5315
+ * @param params - Parameters for request
5316
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
5317
+ * @param callback - Optional callback that handles the response.
5318
+ * @returns A promise if used with async/await, or void if used with a callback.
5319
+ */
5320
+ delete(params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, options: StreamMethodOptions): GaxiosPromise<Readable>;
5321
+ delete(params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, options?: MethodOptions): GaxiosPromise<Schema$GoogleProtobufEmpty>;
5322
+ delete(params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
5323
+ delete(params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleProtobufEmpty>, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
5324
+ delete(params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
5325
+ delete(callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
5326
+ /**
5327
+ * Gets a Conversation.
5328
+ *
5329
+ * @param params - Parameters for request
5330
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
5331
+ * @param callback - Optional callback that handles the response.
5332
+ * @returns A promise if used with async/await, or void if used with a callback.
5333
+ */
5334
+ get(params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
5335
+ get(params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaConversation>;
5336
+ get(params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
5337
+ get(params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaConversation>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaConversation>): void;
5338
+ get(params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaConversation>): void;
5339
+ get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaConversation>): void;
5340
+ /**
5341
+ * Lists all Conversations by their parent DataStore.
5342
+ *
5343
+ * @param params - Parameters for request
5344
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
5345
+ * @param callback - Optional callback that handles the response.
5346
+ * @returns A promise if used with async/await, or void if used with a callback.
5347
+ */
5348
+ list(params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
5349
+ list(params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaListConversationsResponse>;
5350
+ list(params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
5351
+ list(params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListConversationsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListConversationsResponse>): void;
5352
+ list(params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListConversationsResponse>): void;
5353
+ list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListConversationsResponse>): void;
5354
+ /**
5355
+ * Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned.
5356
+ *
5357
+ * @param params - Parameters for request
5358
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
5359
+ * @param callback - Optional callback that handles the response.
5360
+ * @returns A promise if used with async/await, or void if used with a callback.
5361
+ */
5362
+ patch(params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
5363
+ patch(params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaConversation>;
5364
+ patch(params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
5365
+ patch(params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaConversation>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaConversation>): void;
5366
+ patch(params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaConversation>): void;
5367
+ patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaConversation>): void;
5368
+ }
5369
+ export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse extends StandardParameters {
5370
+ /**
5371
+ * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`. Use `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session.
5372
+ */
5373
+ name?: string;
5374
+ /**
5375
+ * Request body metadata
5376
+ */
5377
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaConverseConversationRequest;
5378
+ }
5379
+ export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create extends StandardParameters {
5380
+ /**
5381
+ * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}`
5382
+ */
5383
+ parent?: string;
5384
+ /**
5385
+ * Request body metadata
5386
+ */
5387
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaConversation;
5388
+ }
5389
+ export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete extends StandardParameters {
5390
+ /**
5391
+ * Required. The resource name of the Conversation to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`
5392
+ */
5393
+ name?: string;
5394
+ }
5395
+ export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get extends StandardParameters {
5396
+ /**
5397
+ * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`
5398
+ */
5399
+ name?: string;
5400
+ }
5401
+ export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$List extends StandardParameters {
5402
+ /**
5403
+ * A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id"
5404
+ */
5405
+ filter?: string;
5406
+ /**
5407
+ * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `conversation_name` Example: "update_time desc" "create_time"
5408
+ */
5409
+ orderBy?: string;
5410
+ /**
5411
+ * Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
5412
+ */
5413
+ pageSize?: number;
5414
+ /**
5415
+ * A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page.
5416
+ */
5417
+ pageToken?: string;
5418
+ /**
5419
+ * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}`
5420
+ */
5421
+ parent?: string;
5422
+ }
5423
+ export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch extends StandardParameters {
5424
+ /**
5425
+ * Immutable. Fully qualified name `project/x/locations/global/collections/{collection\}/dataStore/x/conversations/x` or `project/x/locations/global/collections/{collection\}/engines/x/conversations/x`.
5426
+ */
5427
+ name?: string;
5428
+ /**
5429
+ * 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.
5430
+ */
5431
+ updateMask?: string;
5432
+ /**
5433
+ * Request body metadata
5434
+ */
5435
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaConversation;
5436
+ }
4475
5437
  export class Resource$Projects$Locations$Collections$Engines$Operations {
4476
5438
  context: APIRequestContext;
4477
5439
  constructor(context: APIRequestContext);
@@ -4703,6 +5665,34 @@ export declare namespace discoveryengine_v1alpha {
4703
5665
  get(params: Params$Resource$Projects$Locations$Datastores$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>): void;
4704
5666
  get(params: Params$Resource$Projects$Locations$Datastores$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>): void;
4705
5667
  get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>): void;
5668
+ /**
5669
+ * Gets a DocumentProcessingConfig.
5670
+ *
5671
+ * @param params - Parameters for request
5672
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
5673
+ * @param callback - Optional callback that handles the response.
5674
+ * @returns A promise if used with async/await, or void if used with a callback.
5675
+ */
5676
+ getDocumentProcessingConfig(params: Params$Resource$Projects$Locations$Datastores$Getdocumentprocessingconfig, options: StreamMethodOptions): GaxiosPromise<Readable>;
5677
+ getDocumentProcessingConfig(params?: Params$Resource$Projects$Locations$Datastores$Getdocumentprocessingconfig, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig>;
5678
+ getDocumentProcessingConfig(params: Params$Resource$Projects$Locations$Datastores$Getdocumentprocessingconfig, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
5679
+ getDocumentProcessingConfig(params: Params$Resource$Projects$Locations$Datastores$Getdocumentprocessingconfig, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig>): void;
5680
+ getDocumentProcessingConfig(params: Params$Resource$Projects$Locations$Datastores$Getdocumentprocessingconfig, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig>): void;
5681
+ getDocumentProcessingConfig(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig>): void;
5682
+ /**
5683
+ * Gets the SiteSearchEngine.
5684
+ *
5685
+ * @param params - Parameters for request
5686
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
5687
+ * @param callback - Optional callback that handles the response.
5688
+ * @returns A promise if used with async/await, or void if used with a callback.
5689
+ */
5690
+ getSiteSearchEngine(params: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, options: StreamMethodOptions): GaxiosPromise<Readable>;
5691
+ getSiteSearchEngine(params?: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaSiteSearchEngine>;
5692
+ getSiteSearchEngine(params: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
5693
+ getSiteSearchEngine(params: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSiteSearchEngine>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSiteSearchEngine>): void;
5694
+ getSiteSearchEngine(params: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSiteSearchEngine>): void;
5695
+ getSiteSearchEngine(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSiteSearchEngine>): void;
4706
5696
  /**
4707
5697
  * Lists all the DataStores associated with the project.
4708
5698
  *
@@ -4731,6 +5721,20 @@ export declare namespace discoveryengine_v1alpha {
4731
5721
  patch(params: Params$Resource$Projects$Locations$Datastores$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>): void;
4732
5722
  patch(params: Params$Resource$Projects$Locations$Datastores$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>): void;
4733
5723
  patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>): void;
5724
+ /**
5725
+ * Updates the DocumentProcessingConfig. DocumentProcessingConfig is a singleon resource of DataStore. It's empty when DataStore is created. The first call to this method will set up DocumentProcessingConfig.
5726
+ *
5727
+ * @param params - Parameters for request
5728
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
5729
+ * @param callback - Optional callback that handles the response.
5730
+ * @returns A promise if used with async/await, or void if used with a callback.
5731
+ */
5732
+ updateDocumentProcessingConfig(params: Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig, options: StreamMethodOptions): GaxiosPromise<Readable>;
5733
+ updateDocumentProcessingConfig(params?: Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig>;
5734
+ updateDocumentProcessingConfig(params: Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
5735
+ updateDocumentProcessingConfig(params: Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig>): void;
5736
+ updateDocumentProcessingConfig(params: Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig>): void;
5737
+ updateDocumentProcessingConfig(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig>): void;
4734
5738
  }
4735
5739
  export interface Params$Resource$Projects$Locations$Datastores$Completequery extends StandardParameters {
4736
5740
  /**
@@ -4784,6 +5788,18 @@ export declare namespace discoveryengine_v1alpha {
4784
5788
  */
4785
5789
  name?: string;
4786
5790
  }
5791
+ export interface Params$Resource$Projects$Locations$Datastores$Getdocumentprocessingconfig extends StandardParameters {
5792
+ /**
5793
+ * Required. Full DocumentProcessingConfig resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/documentProcessingConfig`
5794
+ */
5795
+ name?: string;
5796
+ }
5797
+ export interface Params$Resource$Projects$Locations$Datastores$Getsitesearchengine extends StandardParameters {
5798
+ /**
5799
+ * 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.
5800
+ */
5801
+ name?: string;
5802
+ }
4787
5803
  export interface Params$Resource$Projects$Locations$Datastores$List extends StandardParameters {
4788
5804
  /**
4789
5805
  * Filter by solution type. For example: filter = 'solution_type:SOLUTION_TYPE_SEARCH'
@@ -4816,6 +5832,20 @@ export declare namespace discoveryengine_v1alpha {
4816
5832
  */
4817
5833
  requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDataStore;
4818
5834
  }
5835
+ export interface Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig extends StandardParameters {
5836
+ /**
5837
+ * Output only. The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`.
5838
+ */
5839
+ name?: string;
5840
+ /**
5841
+ * Indicates which fields in the provided DocumentProcessingConfig to update. The following are the only supported fields: * DocumentProcessingConfig.orc_config If not set, all supported fields are updated.
5842
+ */
5843
+ updateMask?: string;
5844
+ /**
5845
+ * Request body metadata
5846
+ */
5847
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig;
5848
+ }
4819
5849
  export class Resource$Projects$Locations$Datastores$Branches {
4820
5850
  context: APIRequestContext;
4821
5851
  documents: Resource$Projects$Locations$Datastores$Branches$Documents;
@@ -5198,7 +6228,7 @@ export declare namespace discoveryengine_v1alpha {
5198
6228
  }
5199
6229
  export interface Params$Resource$Projects$Locations$Datastores$Conversations$Patch extends StandardParameters {
5200
6230
  /**
5201
- * Immutable. Fully qualified name `project/x/locations/global/collections/{collection\}/dataStore/x/conversations/x`
6231
+ * Immutable. Fully qualified name `project/x/locations/global/collections/{collection\}/dataStore/x/conversations/x` or `project/x/locations/global/collections/{collection\}/engines/x/conversations/x`.
5202
6232
  */
5203
6233
  name?: string;
5204
6234
  /**
@@ -5509,7 +6539,36 @@ export declare namespace discoveryengine_v1alpha {
5509
6539
  }
5510
6540
  export class Resource$Projects$Locations$Datastores$Sitesearchengine {
5511
6541
  context: APIRequestContext;
6542
+ targetSites: Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites;
5512
6543
  constructor(context: APIRequestContext);
6544
+ /**
6545
+ * Downgrade from advanced site search to basic site search.
6546
+ *
6547
+ * @param params - Parameters for request
6548
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
6549
+ * @param callback - Optional callback that handles the response.
6550
+ * @returns A promise if used with async/await, or void if used with a callback.
6551
+ */
6552
+ disableAdvancedSiteSearch(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, options: StreamMethodOptions): GaxiosPromise<Readable>;
6553
+ disableAdvancedSiteSearch(params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
6554
+ disableAdvancedSiteSearch(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
6555
+ disableAdvancedSiteSearch(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
6556
+ disableAdvancedSiteSearch(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
6557
+ disableAdvancedSiteSearch(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
6558
+ /**
6559
+ * Upgrade from basic site search to advanced site search.
6560
+ *
6561
+ * @param params - Parameters for request
6562
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
6563
+ * @param callback - Optional callback that handles the response.
6564
+ * @returns A promise if used with async/await, or void if used with a callback.
6565
+ */
6566
+ enableAdvancedSiteSearch(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, options: StreamMethodOptions): GaxiosPromise<Readable>;
6567
+ enableAdvancedSiteSearch(params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
6568
+ enableAdvancedSiteSearch(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
6569
+ enableAdvancedSiteSearch(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
6570
+ enableAdvancedSiteSearch(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
6571
+ enableAdvancedSiteSearch(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
5513
6572
  /**
5514
6573
  * Request on-demand recrawl for a list of URIs.
5515
6574
  *
@@ -5525,6 +6584,26 @@ export declare namespace discoveryengine_v1alpha {
5525
6584
  recrawlUris(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
5526
6585
  recrawlUris(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
5527
6586
  }
6587
+ export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch extends StandardParameters {
6588
+ /**
6589
+ * Required. Full resource name of the SiteSearchEngine, such as `projects/{project\}/locations/{location\}/dataStores/{data_store_id\}/siteSearchEngine`.
6590
+ */
6591
+ siteSearchEngine?: string;
6592
+ /**
6593
+ * Request body metadata
6594
+ */
6595
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchRequest;
6596
+ }
6597
+ export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch extends StandardParameters {
6598
+ /**
6599
+ * Required. Full resource name of the SiteSearchEngine, such as `projects/{project\}/locations/{location\}/dataStores/{data_store_id\}/siteSearchEngine`.
6600
+ */
6601
+ siteSearchEngine?: string;
6602
+ /**
6603
+ * Request body metadata
6604
+ */
6605
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchRequest;
6606
+ }
5528
6607
  export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris extends StandardParameters {
5529
6608
  /**
5530
6609
  * Required. Full resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`.
@@ -5535,6 +6614,150 @@ export declare namespace discoveryengine_v1alpha {
5535
6614
  */
5536
6615
  requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest;
5537
6616
  }
6617
+ export class Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites {
6618
+ context: APIRequestContext;
6619
+ constructor(context: APIRequestContext);
6620
+ /**
6621
+ * Creates TargetSite in a batch.
6622
+ *
6623
+ * @param params - Parameters for request
6624
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
6625
+ * @param callback - Optional callback that handles the response.
6626
+ * @returns A promise if used with async/await, or void if used with a callback.
6627
+ */
6628
+ batchCreate(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, options: StreamMethodOptions): GaxiosPromise<Readable>;
6629
+ batchCreate(params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
6630
+ batchCreate(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
6631
+ batchCreate(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
6632
+ batchCreate(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
6633
+ batchCreate(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
6634
+ /**
6635
+ * Creates a TargetSite.
6636
+ *
6637
+ * @param params - Parameters for request
6638
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
6639
+ * @param callback - Optional callback that handles the response.
6640
+ * @returns A promise if used with async/await, or void if used with a callback.
6641
+ */
6642
+ create(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, options: StreamMethodOptions): GaxiosPromise<Readable>;
6643
+ create(params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
6644
+ create(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
6645
+ create(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
6646
+ create(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
6647
+ create(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
6648
+ /**
6649
+ * Deletes a TargetSite.
6650
+ *
6651
+ * @param params - Parameters for request
6652
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
6653
+ * @param callback - Optional callback that handles the response.
6654
+ * @returns A promise if used with async/await, or void if used with a callback.
6655
+ */
6656
+ delete(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, options: StreamMethodOptions): GaxiosPromise<Readable>;
6657
+ delete(params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
6658
+ delete(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
6659
+ delete(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
6660
+ delete(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
6661
+ delete(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
6662
+ /**
6663
+ * Gets a TargetSite.
6664
+ *
6665
+ * @param params - Parameters for request
6666
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
6667
+ * @param callback - Optional callback that handles the response.
6668
+ * @returns A promise if used with async/await, or void if used with a callback.
6669
+ */
6670
+ get(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
6671
+ get(params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaTargetSite>;
6672
+ get(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
6673
+ get(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaTargetSite>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaTargetSite>): void;
6674
+ get(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaTargetSite>): void;
6675
+ get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaTargetSite>): void;
6676
+ /**
6677
+ * Gets a list of TargetSites.
6678
+ *
6679
+ * @param params - Parameters for request
6680
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
6681
+ * @param callback - Optional callback that handles the response.
6682
+ * @returns A promise if used with async/await, or void if used with a callback.
6683
+ */
6684
+ list(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
6685
+ list(params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaListTargetSitesResponse>;
6686
+ list(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
6687
+ list(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListTargetSitesResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListTargetSitesResponse>): void;
6688
+ list(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListTargetSitesResponse>): void;
6689
+ list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListTargetSitesResponse>): void;
6690
+ /**
6691
+ * Updates a TargetSite.
6692
+ *
6693
+ * @param params - Parameters for request
6694
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
6695
+ * @param callback - Optional callback that handles the response.
6696
+ * @returns A promise if used with async/await, or void if used with a callback.
6697
+ */
6698
+ patch(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
6699
+ patch(params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
6700
+ patch(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
6701
+ patch(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
6702
+ patch(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
6703
+ patch(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
6704
+ }
6705
+ export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate extends StandardParameters {
6706
+ /**
6707
+ * 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.
6708
+ */
6709
+ parent?: string;
6710
+ /**
6711
+ * Request body metadata
6712
+ */
6713
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesRequest;
6714
+ }
6715
+ export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create extends StandardParameters {
6716
+ /**
6717
+ * Required. Parent resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`.
6718
+ */
6719
+ parent?: string;
6720
+ /**
6721
+ * Request body metadata
6722
+ */
6723
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSite;
6724
+ }
6725
+ export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete extends StandardParameters {
6726
+ /**
6727
+ * 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.
6728
+ */
6729
+ name?: string;
6730
+ }
6731
+ export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get extends StandardParameters {
6732
+ /**
6733
+ * 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.
6734
+ */
6735
+ name?: string;
6736
+ }
6737
+ export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List extends StandardParameters {
6738
+ /**
6739
+ * 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.
6740
+ */
6741
+ pageSize?: number;
6742
+ /**
6743
+ * 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.
6744
+ */
6745
+ pageToken?: string;
6746
+ /**
6747
+ * 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.
6748
+ */
6749
+ parent?: string;
6750
+ }
6751
+ export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch extends StandardParameters {
6752
+ /**
6753
+ * 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.
6754
+ */
6755
+ name?: string;
6756
+ /**
6757
+ * Request body metadata
6758
+ */
6759
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSite;
6760
+ }
5538
6761
  export class Resource$Projects$Locations$Datastores$Userevents {
5539
6762
  context: APIRequestContext;
5540
6763
  constructor(context: APIRequestContext);