@googleapis/discoveryengine 8.0.0 → 8.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -215,6 +215,599 @@ export declare namespace discoveryengine_v1alpha {
215
215
  */
216
216
  token?: string | null;
217
217
  }
218
+ /**
219
+ * Defines an answer.
220
+ */
221
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswer {
222
+ /**
223
+ * Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
224
+ */
225
+ answerSkippedReasons?: string[] | null;
226
+ /**
227
+ * The textual answer.
228
+ */
229
+ answerText?: string | null;
230
+ /**
231
+ * Citations.
232
+ */
233
+ citations?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerCitation[];
234
+ /**
235
+ * Output only. Answer completed timestamp.
236
+ */
237
+ completeTime?: string | null;
238
+ /**
239
+ * Output only. Answer creation timestamp.
240
+ */
241
+ createTime?: string | null;
242
+ /**
243
+ * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x/answers/x`
244
+ */
245
+ name?: string | null;
246
+ /**
247
+ * Query understanding information.
248
+ */
249
+ queryUnderstandingInfo?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo;
250
+ /**
251
+ * References.
252
+ */
253
+ references?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerReference[];
254
+ /**
255
+ * Suggested related questions.
256
+ */
257
+ relatedQuestions?: string[] | null;
258
+ /**
259
+ * The state of the answer generation.
260
+ */
261
+ state?: string | null;
262
+ /**
263
+ * Answer generation steps.
264
+ */
265
+ steps?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerStep[];
266
+ }
267
+ /**
268
+ * Citation info for a segment.
269
+ */
270
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerCitation {
271
+ /**
272
+ * End of the attributed segment, exclusive.
273
+ */
274
+ endIndex?: string | null;
275
+ /**
276
+ * Citation sources for the attributed segment.
277
+ */
278
+ sources?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerCitationSource[];
279
+ /**
280
+ * Index indicates the start of the segment, measured in bytes (UTF-8 unicode).
281
+ */
282
+ startIndex?: string | null;
283
+ }
284
+ /**
285
+ * Citation source.
286
+ */
287
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerCitationSource {
288
+ /**
289
+ * ID of the citation source.
290
+ */
291
+ referenceId?: string | null;
292
+ }
293
+ /**
294
+ * Request message for ConversationalSearchService.AnswerQuery method.
295
+ */
296
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest {
297
+ /**
298
+ * Answer generation specification.
299
+ */
300
+ answerGenerationSpec?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpec;
301
+ /**
302
+ * Asynchronous mode control. If enabled, the response will be returned with answer/session resource name without final answer. The API users need to do the polling to get the latest status of answer/session by calling ConversationalSearchService.GetAnswer or ConversationalSearchService.GetSession method.
303
+ */
304
+ asynchronousMode?: boolean | null;
305
+ /**
306
+ * Required. Current user query.
307
+ */
308
+ query?: Schema$GoogleCloudDiscoveryengineV1alphaQuery;
309
+ /**
310
+ * Query understanding specification.
311
+ */
312
+ queryUnderstandingSpec?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpec;
313
+ /**
314
+ * Related questions specification.
315
+ */
316
+ relatedQuestionsSpec?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestRelatedQuestionsSpec;
317
+ /**
318
+ * Model specification.
319
+ */
320
+ safetySpec?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSafetySpec;
321
+ /**
322
+ * Search specification.
323
+ */
324
+ searchSpec?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpec;
325
+ /**
326
+ * The session resource name. Not required. When session field is not set, the API is in sessionless mode. We support auto session mode: users can use the wildcard symbol “-” as session id. A new id will be automatically generated and assigned.
327
+ */
328
+ session?: string | null;
329
+ /**
330
+ * A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
331
+ */
332
+ userPseudoId?: string | null;
333
+ }
334
+ /**
335
+ * Answer generation specification.
336
+ */
337
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpec {
338
+ /**
339
+ * Language code for Answer. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.
340
+ */
341
+ answerLanguageCode?: string | null;
342
+ /**
343
+ * Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No answer is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating answers for adversarial queries and return fallback messages instead.
344
+ */
345
+ ignoreAdversarialQuery?: boolean | null;
346
+ /**
347
+ * Specifies whether to filter out queries that are not answer-seeking. The default value is `false`. Google employs search-query classification to detect answer-seeking queries. No answer is returned if the search query is classified as a non-answer seeking query. If this field is set to `true`, we skip generating answers for non-answer seeking queries and return fallback messages instead.
348
+ */
349
+ ignoreNonAnswerSeekingQuery?: boolean | null;
350
+ /**
351
+ * Specifies whether to include citation metadata in the answer. The default value is `false`.
352
+ */
353
+ includeCitations?: boolean | null;
354
+ /**
355
+ * Answer generation model specification.
356
+ */
357
+ modelSpec?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecModelSpec;
358
+ /**
359
+ * Answer generation prompt specification.
360
+ */
361
+ promptSpec?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecPromptSpec;
362
+ }
363
+ /**
364
+ * Answer Generation Model specification.
365
+ */
366
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecModelSpec {
367
+ /**
368
+ * Model version. If not set, it will use the default stable model. Allowed values are: stable, preview.
369
+ */
370
+ modelVersion?: string | null;
371
+ }
372
+ /**
373
+ * Answer generation prompt specification.
374
+ */
375
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecPromptSpec {
376
+ /**
377
+ * Customized preamble.
378
+ */
379
+ preamble?: string | null;
380
+ }
381
+ /**
382
+ * Query understanding specification.
383
+ */
384
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpec {
385
+ /**
386
+ * Query classification specification.
387
+ */
388
+ queryClassificationSpec?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec;
389
+ /**
390
+ * Query rephraser specification.
391
+ */
392
+ queryRephraserSpec?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec;
393
+ }
394
+ /**
395
+ * Query classification specification.
396
+ */
397
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec {
398
+ /**
399
+ * Enabled query classification types.
400
+ */
401
+ types?: string[] | null;
402
+ }
403
+ /**
404
+ * Query rephraser specification.
405
+ */
406
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec {
407
+ /**
408
+ * Disable query rephraser.
409
+ */
410
+ disable?: boolean | null;
411
+ /**
412
+ * Max rephrase steps. The max number is 5 steps. If not set or set to < 1, it will be set to 1 by default.
413
+ */
414
+ maxRephraseSteps?: number | null;
415
+ }
416
+ /**
417
+ * Related questions specification.
418
+ */
419
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestRelatedQuestionsSpec {
420
+ /**
421
+ * Enable related questions feature if true.
422
+ */
423
+ enable?: boolean | null;
424
+ }
425
+ /**
426
+ * Safety specification.
427
+ */
428
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSafetySpec {
429
+ /**
430
+ * Enable the safety filtering on the answer response. It is false by default.
431
+ */
432
+ enable?: boolean | null;
433
+ }
434
+ /**
435
+ * Search specification.
436
+ */
437
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpec {
438
+ /**
439
+ * Search parameters.
440
+ */
441
+ searchParams?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchParams;
442
+ /**
443
+ * Search result list.
444
+ */
445
+ searchResultList?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultList;
446
+ }
447
+ /**
448
+ * Search parameters.
449
+ */
450
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchParams {
451
+ /**
452
+ * Boost specification to boost certain documents in search results which may affect the answer query response. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
453
+ */
454
+ boostSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec;
455
+ /**
456
+ * Custom fine tuning configs.
457
+ */
458
+ customFineTuningSpec?: Schema$GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec;
459
+ /**
460
+ * 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 Answer 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 customers 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)
461
+ */
462
+ filter?: string | null;
463
+ /**
464
+ * Number of search results to return. The default value is 10.
465
+ */
466
+ maxReturnResults?: number | null;
467
+ /**
468
+ * The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
469
+ */
470
+ orderBy?: string | null;
471
+ /**
472
+ * Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents)
473
+ */
474
+ searchResultMode?: string | null;
475
+ }
476
+ /**
477
+ * Search result list.
478
+ */
479
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultList {
480
+ /**
481
+ * Search results.
482
+ */
483
+ searchResults?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResult[];
484
+ }
485
+ /**
486
+ * Search result.
487
+ */
488
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResult {
489
+ /**
490
+ * Chunk information.
491
+ */
492
+ chunkInfo?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo;
493
+ /**
494
+ * Unstructured document information.
495
+ */
496
+ unstructuredDocumentInfo?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo;
497
+ }
498
+ /**
499
+ * Chunk information.
500
+ */
501
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo {
502
+ /**
503
+ * Chunk resource name.
504
+ */
505
+ chunk?: string | null;
506
+ /**
507
+ * Chunk textual content.
508
+ */
509
+ content?: string | null;
510
+ }
511
+ /**
512
+ * Unstructured document information.
513
+ */
514
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo {
515
+ /**
516
+ * Document resource name.
517
+ */
518
+ document?: string | null;
519
+ /**
520
+ * List of document contexts.
521
+ */
522
+ documentContexts?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext[];
523
+ /**
524
+ * List of extractive answers.
525
+ */
526
+ extractiveAnswers?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer[];
527
+ /**
528
+ * List of extractive segments.
529
+ */
530
+ extractiveSegments?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment[];
531
+ /**
532
+ * Title.
533
+ */
534
+ title?: string | null;
535
+ /**
536
+ * URI for the document.
537
+ */
538
+ uri?: string | null;
539
+ }
540
+ /**
541
+ * Document context.
542
+ */
543
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext {
544
+ /**
545
+ * Document content.
546
+ */
547
+ content?: string | null;
548
+ /**
549
+ * Page identifier.
550
+ */
551
+ pageIdentifier?: string | null;
552
+ }
553
+ /**
554
+ * Extractive answer. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#get-answers)
555
+ */
556
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer {
557
+ /**
558
+ * Extractive answer content.
559
+ */
560
+ content?: string | null;
561
+ /**
562
+ * Page identifier.
563
+ */
564
+ pageIdentifier?: string | null;
565
+ }
566
+ /**
567
+ * Extractive segment. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#extractive-segments)
568
+ */
569
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment {
570
+ /**
571
+ * Extractive segment content.
572
+ */
573
+ content?: string | null;
574
+ /**
575
+ * Page identifier.
576
+ */
577
+ pageIdentifier?: string | null;
578
+ }
579
+ /**
580
+ * Response message for ConversationalSearchService.AnswerQuery method.
581
+ */
582
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse {
583
+ /**
584
+ * Answer resource object. If AnswerQueryRequest.StepSpec.max_step_count is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API.
585
+ */
586
+ answer?: Schema$GoogleCloudDiscoveryengineV1alphaAnswer;
587
+ /**
588
+ * A global unique ID used for logging.
589
+ */
590
+ answerQueryToken?: string | null;
591
+ /**
592
+ * Session resource object. It will be only available when session field is set and valid in the AnswerQueryRequest request.
593
+ */
594
+ session?: Schema$GoogleCloudDiscoveryengineV1alphaSession;
595
+ }
596
+ /**
597
+ * Query understanding information.
598
+ */
599
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo {
600
+ /**
601
+ * Query classification information.
602
+ */
603
+ queryClassificationInfo?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo[];
604
+ }
605
+ /**
606
+ * Query classification information.
607
+ */
608
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo {
609
+ /**
610
+ * Classification output.
611
+ */
612
+ positive?: boolean | null;
613
+ /**
614
+ * Query classification type.
615
+ */
616
+ type?: string | null;
617
+ }
618
+ /**
619
+ * Reference.
620
+ */
621
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerReference {
622
+ /**
623
+ * Chunk information.
624
+ */
625
+ chunkInfo?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo;
626
+ /**
627
+ * Unstructured document information.
628
+ */
629
+ unstructuredDocumentInfo?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo;
630
+ }
631
+ /**
632
+ * Chunk information.
633
+ */
634
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo {
635
+ /**
636
+ * Chunk resource name.
637
+ */
638
+ chunk?: string | null;
639
+ /**
640
+ * Chunk textual content.
641
+ */
642
+ content?: string | null;
643
+ /**
644
+ * Document metadata.
645
+ */
646
+ documentMetadata?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata;
647
+ /**
648
+ * Relevance score.
649
+ */
650
+ relevanceScore?: number | null;
651
+ }
652
+ /**
653
+ * Document metadata.
654
+ */
655
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata {
656
+ /**
657
+ * Document resource name.
658
+ */
659
+ document?: string | null;
660
+ /**
661
+ * Page identifier.
662
+ */
663
+ pageIdentifier?: string | null;
664
+ /**
665
+ * Title.
666
+ */
667
+ title?: string | null;
668
+ /**
669
+ * URI for the document.
670
+ */
671
+ uri?: string | null;
672
+ }
673
+ /**
674
+ * Unstructured document information.
675
+ */
676
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo {
677
+ /**
678
+ * List of cited chunk contents derived from document content.
679
+ */
680
+ chunkContents?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent[];
681
+ /**
682
+ * Document resource name.
683
+ */
684
+ document?: string | null;
685
+ /**
686
+ * Title.
687
+ */
688
+ title?: string | null;
689
+ /**
690
+ * URI for the document.
691
+ */
692
+ uri?: string | null;
693
+ }
694
+ /**
695
+ * Chunk content.
696
+ */
697
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent {
698
+ /**
699
+ * Chunk textual content.
700
+ */
701
+ content?: string | null;
702
+ /**
703
+ * Page identifier.
704
+ */
705
+ pageIdentifier?: string | null;
706
+ }
707
+ /**
708
+ * Step information.
709
+ */
710
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerStep {
711
+ /**
712
+ * Actions.
713
+ */
714
+ actions?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerStepAction[];
715
+ /**
716
+ * The description of the step.
717
+ */
718
+ description?: string | null;
719
+ /**
720
+ * The state of the step.
721
+ */
722
+ state?: string | null;
723
+ /**
724
+ * The thought of the step.
725
+ */
726
+ thought?: string | null;
727
+ }
728
+ /**
729
+ * Action.
730
+ */
731
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerStepAction {
732
+ /**
733
+ * Observation.
734
+ */
735
+ observation?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation;
736
+ /**
737
+ * Search action.
738
+ */
739
+ searchAction?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction;
740
+ }
741
+ /**
742
+ * Observation.
743
+ */
744
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation {
745
+ /**
746
+ * Search results observed by the search action, it can be snippets info or chunk info, depending on the citation type set by the user.
747
+ */
748
+ searchResults?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult[];
749
+ }
750
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult {
751
+ /**
752
+ * If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.
753
+ */
754
+ chunkInfo?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo[];
755
+ /**
756
+ * Document resource name.
757
+ */
758
+ document?: string | null;
759
+ /**
760
+ * If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.
761
+ */
762
+ snippetInfo?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo[];
763
+ /**
764
+ * Title.
765
+ */
766
+ title?: string | null;
767
+ /**
768
+ * URI for the document.
769
+ */
770
+ uri?: string | null;
771
+ }
772
+ /**
773
+ * Chunk information.
774
+ */
775
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo {
776
+ /**
777
+ * Chunk resource name.
778
+ */
779
+ chunk?: string | null;
780
+ /**
781
+ * Chunk textual content.
782
+ */
783
+ content?: string | null;
784
+ /**
785
+ * Relevance score.
786
+ */
787
+ relevanceScore?: number | null;
788
+ }
789
+ /**
790
+ * Snippet information.
791
+ */
792
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo {
793
+ /**
794
+ * Snippet content.
795
+ */
796
+ snippet?: string | null;
797
+ /**
798
+ * Status of the snippet defined by the search team.
799
+ */
800
+ snippetStatus?: string | null;
801
+ }
802
+ /**
803
+ * Search action.
804
+ */
805
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction {
806
+ /**
807
+ * The query to search.
808
+ */
809
+ query?: string | null;
810
+ }
218
811
  /**
219
812
  * Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.
220
813
  */
@@ -256,7 +849,7 @@ export declare namespace discoveryengine_v1alpha {
256
849
  */
257
850
  export interface Schema$GoogleCloudDiscoveryengineV1alphaBigQuerySource {
258
851
  /**
259
- * The schema to use when parsing the data from the source. Supported values for user event imports: * `user_event` (default): One UserEvent per row. Supported values for document imports: * `document` (default): One Document format per row. Each document must have a valid Document.id and one of Document.json_data or Document.struct_data. * `custom`: One custom data per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by Gen App Builder.
852
+ * The schema to use when parsing the data from the source. Supported values for user event imports: * `user_event` (default): One UserEvent per row. Supported values for document imports: * `document` (default): One Document format per row. Each document must have a valid Document.id and one of Document.json_data or Document.struct_data. * `custom`: One custom data per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical.
260
853
  */
261
854
  dataSchema?: string | null;
262
855
  /**
@@ -280,10 +873,156 @@ export declare namespace discoveryengine_v1alpha {
280
873
  */
281
874
  tableId?: string | null;
282
875
  }
876
+ /**
877
+ * The Bigtable Options object that contains information to support the import.
878
+ */
879
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaBigtableOptions {
880
+ /**
881
+ * The mapping from family names to an object that contains column families level information for the given column family. If a family is not present in this map it will be ignored.
882
+ */
883
+ families?: {
884
+ [key: string]: Schema$GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumnFamily;
885
+ } | null;
886
+ /**
887
+ * The field name used for saving row key value in the document. The name has to match the pattern `a-zA-Z0-9*`.
888
+ */
889
+ keyFieldName?: string | null;
890
+ }
891
+ /**
892
+ * The column of the Bigtable.
893
+ */
894
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumn {
895
+ /**
896
+ * The encoding mode of the values when the type is not `STRING`. Acceptable encoding values are: * `TEXT`: indicates values are alphanumeric text strings. * `BINARY`: indicates values are encoded using `HBase Bytes.toBytes` family of functions. This can be overridden for a specific column by listing that column in `columns` and specifying an encoding for it.
897
+ */
898
+ encoding?: string | null;
899
+ /**
900
+ * The field name to use for this column in the document. The name has to match the pattern `a-zA-Z0-9*`. If not set, it is parsed from the qualifier bytes with best effort. However, due to different naming patterns, field name collisions could happen, where parsing behavior is undefined.
901
+ */
902
+ fieldName?: string | null;
903
+ /**
904
+ * Required. Qualifier of the column. If it cannot be decoded with utf-8, use a base-64 encoded string instead.
905
+ */
906
+ qualifier?: string | null;
907
+ /**
908
+ * The type of values in this column family. The values are expected to be encoded using `HBase Bytes.toBytes` function when the encoding value is set to `BINARY`.
909
+ */
910
+ type?: string | null;
911
+ }
912
+ /**
913
+ * The column family of the Bigtable.
914
+ */
915
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumnFamily {
916
+ /**
917
+ * The list of objects that contains column level information for each column. If a column is not present in this list it will be ignored.
918
+ */
919
+ columns?: Schema$GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumn[];
920
+ /**
921
+ * The encoding mode of the values when the type is not STRING. Acceptable encoding values are: * `TEXT`: indicates values are alphanumeric text strings. * `BINARY`: indicates values are encoded using `HBase Bytes.toBytes` family of functions. This can be overridden for a specific column by listing that column in `columns` and specifying an encoding for it.
922
+ */
923
+ encoding?: string | null;
924
+ /**
925
+ * The field name to use for this column family in the document. The name has to match the pattern `a-zA-Z0-9*`. If not set, it is parsed from the family name with best effort. However, due to different naming patterns, field name collisions could happen, where parsing behavior is undefined.
926
+ */
927
+ fieldName?: string | null;
928
+ /**
929
+ * The type of values in this column family. The values are expected to be encoded using `HBase Bytes.toBytes` function when the encoding value is set to `BINARY`.
930
+ */
931
+ type?: string | null;
932
+ }
933
+ /**
934
+ * The Cloud Bigtable source for importing data.
935
+ */
936
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaBigtableSource {
937
+ /**
938
+ * Required. Bigtable options that contains information needed when parsing data into typed structures. For example, column type annotations.
939
+ */
940
+ bigtableOptions?: Schema$GoogleCloudDiscoveryengineV1alphaBigtableOptions;
941
+ /**
942
+ * Required. The instance ID of the Cloud Bigtable that needs to be imported.
943
+ */
944
+ instanceId?: string | null;
945
+ /**
946
+ * The project ID that the Bigtable source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.
947
+ */
948
+ projectId?: string | null;
949
+ /**
950
+ * Required. The table ID of the Cloud Bigtable that needs to be imported.
951
+ */
952
+ tableId?: string | null;
953
+ }
954
+ /**
955
+ * Request message for GroundedGenerationService.CheckGrounding method.
956
+ */
957
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaCheckGroundingRequest {
958
+ /**
959
+ * Answer candidate to check.
960
+ */
961
+ answerCandidate?: string | null;
962
+ /**
963
+ * List of facts for the grounding check. We support up to 200 facts.
964
+ */
965
+ facts?: Schema$GoogleCloudDiscoveryengineV1alphaGroundingFact[];
966
+ /**
967
+ * Configuration of the grounding check.
968
+ */
969
+ groundingSpec?: Schema$GoogleCloudDiscoveryengineV1alphaCheckGroundingSpec;
970
+ }
971
+ /**
972
+ * Response message for the GroundedGenerationService.CheckGrounding method.
973
+ */
974
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaCheckGroundingResponse {
975
+ /**
976
+ * List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request.
977
+ */
978
+ citedChunks?: Schema$GoogleCloudDiscoveryengineV1alphaFactChunk[];
979
+ /**
980
+ * Claim texts and citation info across all claims in the answer candidate.
981
+ */
982
+ claims?: Schema$GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseClaim[];
983
+ /**
984
+ * The support score for the input answer candidate. Higher the score, higher is the fraction of claims that are supported by the provided facts. This is always set when a response is returned.
985
+ */
986
+ supportScore?: number | null;
987
+ }
988
+ /**
989
+ * Text and citation info for a claim in the answer candidate.
990
+ */
991
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseClaim {
992
+ /**
993
+ * A list of indices (into 'cited_chunks') specifying the citations associated with the claim. For instance [1,3,4] means that cited_chunks[1], cited_chunks[3], cited_chunks[4] are the facts cited supporting for the claim. A citation to a fact indicates that the claim is supported by the fact.
994
+ */
995
+ citationIndices?: number[] | null;
996
+ /**
997
+ * Text for the claim in the answer candidate. Always provided regardless of whether citations or anti-citations are found.
998
+ */
999
+ claimText?: string | null;
1000
+ /**
1001
+ * Position indicating the end of the claim in the answer candidate, exclusive.
1002
+ */
1003
+ endPos?: number | null;
1004
+ /**
1005
+ * Position indicating the start of the claim in the answer candidate, measured in bytes.
1006
+ */
1007
+ startPos?: number | null;
1008
+ }
1009
+ /**
1010
+ * Specification for the grounding check.
1011
+ */
1012
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaCheckGroundingSpec {
1013
+ /**
1014
+ * The threshold (in [0,1]) used for determining whether a fact must be cited for a claim in the answer candidate. Choosing a higher threshold will lead to fewer but very strong citations, while choosing a lower threshold may lead to more but somewhat weaker citations. If unset, the threshold will default to 0.6.
1015
+ */
1016
+ citationThreshold?: number | null;
1017
+ }
283
1018
  /**
284
1019
  * Chunk captures all raw metadata information of items to be recommended or searched in the chunk mode.
285
1020
  */
286
1021
  export interface Schema$GoogleCloudDiscoveryengineV1alphaChunk {
1022
+ /**
1023
+ * Output only. Metadata of the current chunk.
1024
+ */
1025
+ chunkMetadata?: Schema$GoogleCloudDiscoveryengineV1alphaChunkChunkMetadata;
287
1026
  /**
288
1027
  * Content is a string from a document (parsed content).
289
1028
  */
@@ -299,18 +1038,41 @@ export declare namespace discoveryengine_v1alpha {
299
1038
  */
300
1039
  documentMetadata?: Schema$GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata;
301
1040
  /**
302
- * Unique chunk id of the current chunk.
1041
+ * Unique chunk ID of the current chunk.
303
1042
  */
304
1043
  id?: string | null;
305
1044
  /**
306
1045
  * The full resource name of the chunk. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document_id\}/chunks/{chunk_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
307
1046
  */
308
1047
  name?: string | null;
1048
+ /**
1049
+ * Page span of the chunk.
1050
+ */
1051
+ pageSpan?: Schema$GoogleCloudDiscoveryengineV1alphaChunkPageSpan;
1052
+ }
1053
+ /**
1054
+ * Metadata of the current chunk. This field is only populated on SearchService.Search API.
1055
+ */
1056
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaChunkChunkMetadata {
1057
+ /**
1058
+ * The next chunks of the current chunk. The number is controlled by SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks. This field is only populated on SearchService.Search API.
1059
+ */
1060
+ nextChunks?: Schema$GoogleCloudDiscoveryengineV1alphaChunk[];
1061
+ /**
1062
+ * The previous chunks of the current chunk. The number is controlled by SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks. This field is only populated on SearchService.Search API.
1063
+ */
1064
+ previousChunks?: Schema$GoogleCloudDiscoveryengineV1alphaChunk[];
309
1065
  }
310
1066
  /**
311
1067
  * Document metadata contains the information of the document of the current chunk.
312
1068
  */
313
1069
  export interface Schema$GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata {
1070
+ /**
1071
+ * Data representation. The structured JSON data for the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown.
1072
+ */
1073
+ structData?: {
1074
+ [key: string]: any;
1075
+ } | null;
314
1076
  /**
315
1077
  * Title of the document.
316
1078
  */
@@ -320,6 +1082,48 @@ export declare namespace discoveryengine_v1alpha {
320
1082
  */
321
1083
  uri?: string | null;
322
1084
  }
1085
+ /**
1086
+ * Page span of the chunk.
1087
+ */
1088
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaChunkPageSpan {
1089
+ /**
1090
+ * The end page of the chunk.
1091
+ */
1092
+ pageEnd?: number | null;
1093
+ /**
1094
+ * The start page of the chunk.
1095
+ */
1096
+ pageStart?: number | null;
1097
+ }
1098
+ /**
1099
+ * Cloud SQL source import data from.
1100
+ */
1101
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaCloudSqlSource {
1102
+ /**
1103
+ * Required. The Cloud SQL database to copy the data from with a length limit of 256 characters.
1104
+ */
1105
+ databaseId?: string | null;
1106
+ /**
1107
+ * Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Cloud SQL export to a specific Cloud Storage directory. Ensure that the Cloud SQL service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory.
1108
+ */
1109
+ gcsStagingDir?: string | null;
1110
+ /**
1111
+ * Required. The Cloud SQL instance to copy the data from with a length limit of 256 characters.
1112
+ */
1113
+ instanceId?: string | null;
1114
+ /**
1115
+ * Option for serverless export. Enabling this option will incur additional cost. More info can be found [here](https://cloud.google.com/sql/pricing#serverless).
1116
+ */
1117
+ offload?: boolean | null;
1118
+ /**
1119
+ * The project ID that the Cloud SQL source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.
1120
+ */
1121
+ projectId?: string | null;
1122
+ /**
1123
+ * Required. The Cloud SQL table to copy the data from with a length limit of 256 characters.
1124
+ */
1125
+ tableId?: string | null;
1126
+ }
323
1127
  /**
324
1128
  * Request message for CompletionService.CompleteQuery method.
325
1129
  */
@@ -397,7 +1201,7 @@ export declare namespace discoveryengine_v1alpha {
397
1201
  */
398
1202
  messages?: Schema$GoogleCloudDiscoveryengineV1alphaConversationMessage[];
399
1203
  /**
400
- * 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`.
1204
+ * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/dataStore/x/conversations/x` or `projects/{project\}/locations/global/collections/{collection\}/engines/x/conversations/x`.
401
1205
  */
402
1206
  name?: string | null;
403
1207
  /**
@@ -904,7 +1708,7 @@ export declare namespace discoveryengine_v1alpha {
904
1708
  */
905
1709
  export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig {
906
1710
  /**
907
- * Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.
1711
+ * [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.
908
1712
  */
909
1713
  enhancedDocumentElements?: string[] | null;
910
1714
  /**
@@ -1023,7 +1827,7 @@ export declare namespace discoveryengine_v1alpha {
1023
1827
  */
1024
1828
  agentCreationConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig;
1025
1829
  /**
1026
- * The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Please use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.
1830
+ * The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.
1027
1831
  */
1028
1832
  dialogflowAgentToLink?: string | null;
1029
1833
  }
@@ -1130,7 +1934,7 @@ export declare namespace discoveryengine_v1alpha {
1130
1934
  */
1131
1935
  searchAddOns?: string[] | null;
1132
1936
  /**
1133
- * The search feature tier of this engine. Different tiers might have different pricing. To learn more, please check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.
1937
+ * The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.
1134
1938
  */
1135
1939
  searchTier?: string | null;
1136
1940
  }
@@ -1213,6 +2017,25 @@ export declare namespace discoveryengine_v1alpha {
1213
2017
  */
1214
2018
  documentCount?: string | null;
1215
2019
  }
2020
+ /**
2021
+ * Fact Chunk.
2022
+ */
2023
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaFactChunk {
2024
+ /**
2025
+ * Text content of the fact chunk. Can be at most 10K characters long.
2026
+ */
2027
+ chunkText?: string | null;
2028
+ /**
2029
+ * Source from which this fact chunk was retrieved. If it was retrieved from the GroundingFacts provided in the request then this field will contain the index of the specific fact from which this chunk was retrieved.
2030
+ */
2031
+ source?: string | null;
2032
+ /**
2033
+ * More fine-grained information for the source reference.
2034
+ */
2035
+ sourceMetadata?: {
2036
+ [key: string]: string;
2037
+ } | null;
2038
+ }
1216
2039
  /**
1217
2040
  * Response message for SiteSearchEngineService.FetchDomainVerificationStatus method.
1218
2041
  */
@@ -1230,10 +2053,27 @@ export declare namespace discoveryengine_v1alpha {
1230
2053
  */
1231
2054
  totalSize?: number | null;
1232
2055
  }
2056
+ /**
2057
+ * Cloud FhirStore source import data from.
2058
+ */
2059
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaFhirStoreSource {
2060
+ /**
2061
+ * Required. The full resource name of the FHIR store to import data from, in the format of `projects/{project\}/locations/{location\}/datasets/{dataset\}/fhirStores/{fhir_store\}`.
2062
+ */
2063
+ fhirStore?: string | null;
2064
+ /**
2065
+ * Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the FhirStore export to a specific Cloud Storage directory.
2066
+ */
2067
+ gcsStagingDir?: string | null;
2068
+ }
1233
2069
  /**
1234
2070
  * Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.
1235
2071
  */
1236
2072
  export interface Schema$GoogleCloudDiscoveryengineV1alphaFieldConfig {
2073
+ /**
2074
+ * If this field is set, only the corresponding source will be indexed for this field. Otherwise, the values from different sources are merged. Assuming a page with `` in meta tag, and `` in page map: if this enum is set to METATAGS, we will only index ``; if this enum is not set, we will merge them and index ``.
2075
+ */
2076
+ advancedSiteSearchDataSources?: string[] | null;
1237
2077
  /**
1238
2078
  * If completable_option is COMPLETABLE_ENABLED, field values are directly used and returned as suggestions for Autocomplete in CompletionService.CompleteQuery. If completable_option is unset, the server behavior defaults to COMPLETABLE_DISABLED for fields that support setting completable options, which are just `string` fields. For those fields that do not support setting completable options, the server will skip completable option setting, and setting completable_option for those fields will throw `INVALID_ARGUMENT` error.
1239
2079
  */
@@ -1271,12 +2111,33 @@ export declare namespace discoveryengine_v1alpha {
1271
2111
  */
1272
2112
  searchableOption?: string | null;
1273
2113
  }
2114
+ /**
2115
+ * Firestore source import data from.
2116
+ */
2117
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaFirestoreSource {
2118
+ /**
2119
+ * Required. The Firestore collection to copy the data from with a length limit of 1,500 characters.
2120
+ */
2121
+ collectionId?: string | null;
2122
+ /**
2123
+ * Required. The Firestore database to copy the data from with a length limit of 256 characters.
2124
+ */
2125
+ databaseId?: string | null;
2126
+ /**
2127
+ * Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Firestore export to a specific Cloud Storage directory. Ensure that the Firestore service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory.
2128
+ */
2129
+ gcsStagingDir?: string | null;
2130
+ /**
2131
+ * The project ID that the Cloud SQL source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.
2132
+ */
2133
+ projectId?: string | null;
2134
+ }
1274
2135
  /**
1275
2136
  * Cloud Storage location for input content.
1276
2137
  */
1277
2138
  export interface Schema$GoogleCloudDiscoveryengineV1alphaGcsSource {
1278
2139
  /**
1279
- * The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`: One custom data JSON per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by Gen App Builder. * `csv`: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by Gen App Builder. Supported values for user even imports: * `user_event` (default): One JSON UserEvent per line.
2140
+ * The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`: One custom data JSON per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. * `csv`: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by the GENERIC Data Store vertical. Supported values for user even imports: * `user_event` (default): One JSON UserEvent per line.
1280
2141
  */
1281
2142
  dataSchema?: string | null;
1282
2143
  /**
@@ -1284,6 +2145,21 @@ export declare namespace discoveryengine_v1alpha {
1284
2145
  */
1285
2146
  inputUris?: string[] | null;
1286
2147
  }
2148
+ /**
2149
+ * Grounding Fact.
2150
+ */
2151
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaGroundingFact {
2152
+ /**
2153
+ * Attributes associated with the fact. Common attributes include `source` (indicating where the fact was sourced from), `author` (indicating the author of the fact), and so on.
2154
+ */
2155
+ attributes?: {
2156
+ [key: string]: string;
2157
+ } | null;
2158
+ /**
2159
+ * Text content of the fact. Can be at most 10K characters long.
2160
+ */
2161
+ factText?: string | null;
2162
+ }
1287
2163
  /**
1288
2164
  * Defines guided search spec.
1289
2165
  */
@@ -1339,6 +2215,10 @@ export declare namespace discoveryengine_v1alpha {
1339
2215
  * Count of entries that were processed successfully.
1340
2216
  */
1341
2217
  successCount?: string | null;
2218
+ /**
2219
+ * Total count of entries that were processed.
2220
+ */
2221
+ totalCount?: string | null;
1342
2222
  /**
1343
2223
  * Operation last update time. If the operation is done, this is also the finish time.
1344
2224
  */
@@ -1349,23 +2229,39 @@ export declare namespace discoveryengine_v1alpha {
1349
2229
  */
1350
2230
  export interface Schema$GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest {
1351
2231
  /**
1352
- * Whether to automatically generate IDs for the documents if absent. If set to `true`, Document.ids are automatically generated based on the hash of the payload, where IDs may not be consistent during multiple imports. In which case ReconciliationMode.FULL is highly recommended to avoid duplicate contents. If unset or set to `false`, Document.ids have to be specified using id_field, otherwise, documents without IDs fail to be imported. Only set this field when using GcsSource or BigQuerySource, and when GcsSource.data_schema or BigQuerySource.data_schema is `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
2232
+ * Whether to automatically generate IDs for the documents if absent. If set to `true`, Document.ids are automatically generated based on the hash of the payload, where IDs may not be consistent during multiple imports. In which case ReconciliationMode.FULL is highly recommended to avoid duplicate contents. If unset or set to `false`, Document.ids have to be specified using id_field, otherwise, documents without IDs fail to be imported. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. * FirestoreSource. * BigtableSource.
1353
2233
  */
1354
2234
  autoGenerateIds?: boolean | null;
1355
2235
  /**
1356
2236
  * BigQuery input source.
1357
2237
  */
1358
2238
  bigquerySource?: Schema$GoogleCloudDiscoveryengineV1alphaBigQuerySource;
2239
+ /**
2240
+ * Cloud Bigtable input source.
2241
+ */
2242
+ bigtableSource?: Schema$GoogleCloudDiscoveryengineV1alphaBigtableSource;
2243
+ /**
2244
+ * Cloud SQL input source.
2245
+ */
2246
+ cloudSqlSource?: Schema$GoogleCloudDiscoveryengineV1alphaCloudSqlSource;
1359
2247
  /**
1360
2248
  * The desired location of errors incurred during the Import.
1361
2249
  */
1362
2250
  errorConfig?: Schema$GoogleCloudDiscoveryengineV1alphaImportErrorConfig;
2251
+ /**
2252
+ * FhirStore input source.
2253
+ */
2254
+ fhirStoreSource?: Schema$GoogleCloudDiscoveryengineV1alphaFhirStoreSource;
2255
+ /**
2256
+ * Firestore input source.
2257
+ */
2258
+ firestoreSource?: Schema$GoogleCloudDiscoveryengineV1alphaFirestoreSource;
1363
2259
  /**
1364
2260
  * Cloud Storage location for the input content.
1365
2261
  */
1366
2262
  gcsSource?: Schema$GoogleCloudDiscoveryengineV1alphaGcsSource;
1367
2263
  /**
1368
- * The field in the Cloud Storage and BigQuery sources that indicates the unique IDs of the documents. For GcsSource it is the key of the JSON field. For instance, `my_id` for JSON `{"my_id": "some_uuid"\}`. For BigQuerySource it is the column name of the BigQuery table where the unique ids are stored. The values of the JSON field or the BigQuery column are used as the Document.ids. The JSON field or the BigQuery column must be of string type, and the values must be set as valid strings conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters. Otherwise, documents without valid IDs fail to be imported. Only set this field when using GcsSource or BigQuerySource, and when GcsSource.data_schema or BigQuerySource.data_schema is `custom`. And only set this field when auto_generate_ids is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown. If it is unset, a default value `_id` is used when importing from the allowed data sources.
2264
+ * The field indicates the ID field or column to be used as unique IDs of the documents. For GcsSource it is the key of the JSON field. For instance, `my_id` for JSON `{"my_id": "some_uuid"\}`. For others, it may be the column name of the table where the unique ids are stored. The values of the JSON field or the table column are used as the Document.ids. The JSON field or the table column must be of string type, and the values must be set as valid strings conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters. Otherwise, documents without valid IDs fail to be imported. Only set this field when auto_generate_ids is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown. If it is unset, a default value `_id` is used when importing from the allowed data sources. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. * FirestoreSource. * BigtableSource.
1369
2265
  */
1370
2266
  idField?: string | null;
1371
2267
  /**
@@ -1375,7 +2271,15 @@ export declare namespace discoveryengine_v1alpha {
1375
2271
  /**
1376
2272
  * The mode of reconciliation between existing documents and the documents to be imported. Defaults to ReconciliationMode.INCREMENTAL.
1377
2273
  */
1378
- reconciliationMode?: string | null;
2274
+ reconciliationMode?: string | null;
2275
+ /**
2276
+ * Spanner input source.
2277
+ */
2278
+ spannerSource?: Schema$GoogleCloudDiscoveryengineV1alphaSpannerSource;
2279
+ /**
2280
+ * Indicates which fields in the provided imported documents to update. If not set, the default is to update all fields.
2281
+ */
2282
+ updateMask?: string | null;
1379
2283
  }
1380
2284
  /**
1381
2285
  * The inline source for the input config for ImportDocuments method.
@@ -1644,6 +2548,19 @@ export declare namespace discoveryengine_v1alpha {
1644
2548
  */
1645
2549
  servingConfigs?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfig[];
1646
2550
  }
2551
+ /**
2552
+ * Response for ListSessions method.
2553
+ */
2554
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaListSessionsResponse {
2555
+ /**
2556
+ * Pagination token, if not returned indicates the last page.
2557
+ */
2558
+ nextPageToken?: string | null;
2559
+ /**
2560
+ * All the Sessions for a given data store.
2561
+ */
2562
+ sessions?: Schema$GoogleCloudDiscoveryengineV1alphaSession[];
2563
+ }
1647
2564
  /**
1648
2565
  * Response message for SiteSearchEngineService.ListTargetSites method.
1649
2566
  */
@@ -1697,7 +2614,7 @@ export declare namespace discoveryengine_v1alpha {
1697
2614
  */
1698
2615
  export interface Schema$GoogleCloudDiscoveryengineV1alphaPageInfo {
1699
2616
  /**
1700
- * The most specific category associated with a category page. To represent full path of category, use '\>' sign to separate different hierarchies. If '\>' is part of the category name, please replace it with other character(s). Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: `"pageCategory" : "Sales \> 2017 Black Friday Deals"`. Required for `view-category-page` events. Other event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error is returned.
2617
+ * The most specific category associated with a category page. To represent full path of category, use '\>' sign to separate different hierarchies. If '\>' is part of the category name, replace it with other character(s). Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: `"pageCategory" : "Sales \> 2017 Black Friday Deals"`. Required for `view-category-page` events. Other event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error is returned.
1701
2618
  */
1702
2619
  pageCategory?: string | null;
1703
2620
  /**
@@ -1765,6 +2682,72 @@ export declare namespace discoveryengine_v1alpha {
1765
2682
  */
1766
2683
  jsonData?: string | null;
1767
2684
  }
2685
+ /**
2686
+ * Metadata and configurations for a Google Cloud project in the service.
2687
+ */
2688
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaProject {
2689
+ /**
2690
+ * Output only. The timestamp when this project is created.
2691
+ */
2692
+ createTime?: string | null;
2693
+ /**
2694
+ * Output only. Full resource name of the project, for example `projects/{project_number\}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.
2695
+ */
2696
+ name?: string | null;
2697
+ /**
2698
+ * Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use.
2699
+ */
2700
+ provisionCompletionTime?: string | null;
2701
+ /**
2702
+ * Output only. A map of terms of services. The key is the `id` of ServiceTerms.
2703
+ */
2704
+ serviceTermsMap?: {
2705
+ [key: string]: Schema$GoogleCloudDiscoveryengineV1alphaProjectServiceTerms;
2706
+ } | null;
2707
+ }
2708
+ /**
2709
+ * Metadata about the terms of service.
2710
+ */
2711
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaProjectServiceTerms {
2712
+ /**
2713
+ * The last time when the project agreed to the terms of service.
2714
+ */
2715
+ acceptTime?: string | null;
2716
+ /**
2717
+ * The last time when the project declined or revoked the agreement to terms of service.
2718
+ */
2719
+ declineTime?: string | null;
2720
+ /**
2721
+ * The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`.
2722
+ */
2723
+ id?: string | null;
2724
+ /**
2725
+ * Whether the project has accepted/rejected the service terms or it is still pending.
2726
+ */
2727
+ state?: string | null;
2728
+ /**
2729
+ * The version string of the terms of service. For acceptable values, see the comments for id above.
2730
+ */
2731
+ version?: string | null;
2732
+ }
2733
+ /**
2734
+ * Metadata associated with a project provision operation.
2735
+ */
2736
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaProvisionProjectMetadata {
2737
+ }
2738
+ /**
2739
+ * Request for ProjectService.ProvisionProject method.
2740
+ */
2741
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaProvisionProjectRequest {
2742
+ /**
2743
+ * Required. Set to `true` to specify that caller has read and would like to give consent to the [Terms for data use](https://cloud.google.com/retail/data-use-terms).
2744
+ */
2745
+ acceptDataUseTerms?: boolean | null;
2746
+ /**
2747
+ * Required. The version of the [Terms for data use](https://cloud.google.com/retail/data-use-terms) that caller has read and would like to give consent to. Acceptable version is `2022-11-23`, and this may change over time.
2748
+ */
2749
+ dataUseTermsVersion?: string | null;
2750
+ }
1768
2751
  /**
1769
2752
  * Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.
1770
2753
  */
@@ -1907,6 +2890,74 @@ export declare namespace discoveryengine_v1alpha {
1907
2890
  */
1908
2891
  purgeCount?: string | null;
1909
2892
  }
2893
+ /**
2894
+ * Defines a user inputed query.
2895
+ */
2896
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaQuery {
2897
+ /**
2898
+ * Unique Id for the query.
2899
+ */
2900
+ queryId?: string | null;
2901
+ /**
2902
+ * Plain text.
2903
+ */
2904
+ text?: string | null;
2905
+ }
2906
+ /**
2907
+ * Record message for RankService.Rank method.
2908
+ */
2909
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaRankingRecord {
2910
+ /**
2911
+ * The content of the record. Empty by default. At least one of title or content should be set otherwise an INVALID_ARGUMENT error is thrown.
2912
+ */
2913
+ content?: string | null;
2914
+ /**
2915
+ * The unique ID to represent the record.
2916
+ */
2917
+ id?: string | null;
2918
+ /**
2919
+ * The score of this record based on the given query and selected model.
2920
+ */
2921
+ score?: number | null;
2922
+ /**
2923
+ * The title of the record. Empty by default. At least one of title or content should be set otherwise an INVALID_ARGUMENT error is thrown.
2924
+ */
2925
+ title?: string | null;
2926
+ }
2927
+ /**
2928
+ * Request message for RankService.Rank method.
2929
+ */
2930
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaRankRequest {
2931
+ /**
2932
+ * If true, the response will contain only record ID and score. By default, it is false, the response will contain record details.
2933
+ */
2934
+ ignoreRecordDetailsInResponse?: boolean | null;
2935
+ /**
2936
+ * The identifier of the model to use. It is one of: * `semantic-ranker-512@latest`: Semantic ranking model with maxiumn input token size 512. It is set to `semantic-ranker-512@latest` by default if unspecified.
2937
+ */
2938
+ model?: string | null;
2939
+ /**
2940
+ * The query to use.
2941
+ */
2942
+ query?: string | null;
2943
+ /**
2944
+ * Required. A list of records to rank. At most 200 records to rank.
2945
+ */
2946
+ records?: Schema$GoogleCloudDiscoveryengineV1alphaRankingRecord[];
2947
+ /**
2948
+ * The number of results to return. If this is unset or no bigger than zero, returns all results.
2949
+ */
2950
+ topN?: number | null;
2951
+ }
2952
+ /**
2953
+ * Response message for RankService.Rank method.
2954
+ */
2955
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaRankResponse {
2956
+ /**
2957
+ * A list of records sorted by descending score.
2958
+ */
2959
+ records?: Schema$GoogleCloudDiscoveryengineV1alphaRankingRecord[];
2960
+ }
1910
2961
  /**
1911
2962
  * Request message for Recommend method.
1912
2963
  */
@@ -2099,6 +3150,23 @@ export declare namespace discoveryengine_v1alpha {
2099
3150
  */
2100
3151
  uri?: string | null;
2101
3152
  }
3153
+ /**
3154
+ * Request for ReportConsentChange method.
3155
+ */
3156
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaReportConsentChangeRequest {
3157
+ /**
3158
+ * Required. Whether customer decides to accept or decline service term. At this moment, only accept action is supported.
3159
+ */
3160
+ consentChangeAction?: string | null;
3161
+ /**
3162
+ * Required. The unique identifier of the terms of service to update. Available term ids: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this service term id, the acceptable service_term_version to provide is `2022-11-23`.
3163
+ */
3164
+ serviceTermId?: string | null;
3165
+ /**
3166
+ * Required. The version string of the terms of service to update.
3167
+ */
3168
+ serviceTermVersion?: string | null;
3169
+ }
2102
3170
  /**
2103
3171
  * Request for resuming training of an engine.
2104
3172
  */
@@ -2197,7 +3265,7 @@ export declare namespace discoveryengine_v1alpha {
2197
3265
  */
2198
3266
  orderBy?: string | null;
2199
3267
  /**
2200
- * Maximum number of Documents to return. If unspecified, defaults to a reasonable value. The maximum allowed value is 100. Values above 100 are coerced to 100. If this field is negative, an `INVALID_ARGUMENT` is returned.
3268
+ * Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.
2201
3269
  */
2202
3270
  pageSize?: number | null;
2203
3271
  /**
@@ -2266,15 +3334,57 @@ export declare namespace discoveryengine_v1alpha {
2266
3334
  * Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied.
2267
3335
  */
2268
3336
  boost?: number | null;
3337
+ /**
3338
+ * Complex specification for custom ranking based on customer defined attribute value.
3339
+ */
3340
+ boostControlSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec;
2269
3341
  /**
2270
3342
  * An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": `(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))`
2271
3343
  */
2272
3344
  condition?: string | null;
2273
3345
  }
3346
+ /**
3347
+ * Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above.
3348
+ */
3349
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec {
3350
+ /**
3351
+ * The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).
3352
+ */
3353
+ attributeType?: string | null;
3354
+ /**
3355
+ * The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.
3356
+ */
3357
+ controlPoints?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint[];
3358
+ /**
3359
+ * The name of the field whose value will be used to determine the boost amount.
3360
+ */
3361
+ fieldName?: string | null;
3362
+ /**
3363
+ * The interpolation type to be applied to connect the control points listed below.
3364
+ */
3365
+ interpolationType?: string | null;
3366
+ }
3367
+ /**
3368
+ * The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).
3369
+ */
3370
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint {
3371
+ /**
3372
+ * Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.
3373
+ */
3374
+ attributeValue?: string | null;
3375
+ /**
3376
+ * The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.
3377
+ */
3378
+ boostAmount?: number | null;
3379
+ }
2274
3380
  /**
2275
3381
  * A specification for configuring the behavior of content search.
2276
3382
  */
2277
3383
  export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec {
3384
+ /**
3385
+ * Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS
3386
+ */
3387
+ chunkSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec;
2278
3388
  /**
2279
3389
  * If there is no extractive_content_spec provided, there will be no extractive answer in the search response.
2280
3390
  */
@@ -2292,6 +3402,19 @@ export declare namespace discoveryengine_v1alpha {
2292
3402
  */
2293
3403
  summarySpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec;
2294
3404
  }
3405
+ /**
3406
+ * Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS
3407
+ */
3408
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec {
3409
+ /**
3410
+ * The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned.
3411
+ */
3412
+ numNextChunks?: number | null;
3413
+ /**
3414
+ * The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned.
3415
+ */
3416
+ numPreviousChunks?: number | null;
3417
+ }
2295
3418
  /**
2296
3419
  * A specification for configuring the extractive content in a search response.
2297
3420
  */
@@ -2313,7 +3436,7 @@ export declare namespace discoveryengine_v1alpha {
2313
3436
  */
2314
3437
  numPreviousSegments?: number | null;
2315
3438
  /**
2316
- * Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, please contact your Customer Engineer. The default value is `false`.
3439
+ * Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`.
2317
3440
  */
2318
3441
  returnExtractiveSegmentScore?: boolean | null;
2319
3442
  }
@@ -2363,11 +3486,11 @@ export declare namespace discoveryengine_v1alpha {
2363
3486
  */
2364
3487
  modelSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec;
2365
3488
  /**
2366
- * 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 10 results can be used to generate a summary.
3489
+ * 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 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.
2367
3490
  */
2368
3491
  summaryResultCount?: number | null;
2369
3492
  /**
2370
- * If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Please note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.
3493
+ * If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.
2371
3494
  */
2372
3495
  useSemanticChunks?: boolean | null;
2373
3496
  }
@@ -2724,6 +3847,10 @@ export declare namespace discoveryengine_v1alpha {
2724
3847
  * Document reference.
2725
3848
  */
2726
3849
  export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReference {
3850
+ /**
3851
+ * List of cited chunk contents derived from document content.
3852
+ */
3853
+ chunkContents?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReferenceChunkContent[];
2727
3854
  /**
2728
3855
  * 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`.
2729
3856
  */
@@ -2737,6 +3864,19 @@ export declare namespace discoveryengine_v1alpha {
2737
3864
  */
2738
3865
  uri?: string | null;
2739
3866
  }
3867
+ /**
3868
+ * Chunk content.
3869
+ */
3870
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReferenceChunkContent {
3871
+ /**
3872
+ * Chunk textual content.
3873
+ */
3874
+ content?: string | null;
3875
+ /**
3876
+ * Page identifier.
3877
+ */
3878
+ pageIdentifier?: string | null;
3879
+ }
2740
3880
  /**
2741
3881
  * Safety Attribute categories and their associated confidence scores.
2742
3882
  */
@@ -2886,6 +4026,48 @@ export declare namespace discoveryengine_v1alpha {
2886
4026
  */
2887
4027
  demotionEventType?: string | null;
2888
4028
  }
4029
+ /**
4030
+ * External session proto definition.
4031
+ */
4032
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaSession {
4033
+ /**
4034
+ * Output only. The time the session finished.
4035
+ */
4036
+ endTime?: string | null;
4037
+ /**
4038
+ * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x`
4039
+ */
4040
+ name?: string | null;
4041
+ /**
4042
+ * Output only. The time the session started.
4043
+ */
4044
+ startTime?: string | null;
4045
+ /**
4046
+ * The state of the session.
4047
+ */
4048
+ state?: string | null;
4049
+ /**
4050
+ * Turns.
4051
+ */
4052
+ turns?: Schema$GoogleCloudDiscoveryengineV1alphaSessionTurn[];
4053
+ /**
4054
+ * A unique identifier for tracking users.
4055
+ */
4056
+ userPseudoId?: string | null;
4057
+ }
4058
+ /**
4059
+ * Represents a turn, including a query from the user and a answer from service.
4060
+ */
4061
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaSessionTurn {
4062
+ /**
4063
+ * The resource name of the answer to the user query.
4064
+ */
4065
+ answer?: string | null;
4066
+ /**
4067
+ * The user query.
4068
+ */
4069
+ query?: Schema$GoogleCloudDiscoveryengineV1alphaQuery;
4070
+ }
2889
4071
  /**
2890
4072
  * SiteSearchEngine captures DataStore level site search persisting configurations. It is a singleton value per data store.
2891
4073
  */
@@ -2908,6 +4090,31 @@ export declare namespace discoveryengine_v1alpha {
2908
4090
  */
2909
4091
  verifyTime?: string | null;
2910
4092
  }
4093
+ /**
4094
+ * The Spanner source for importing data
4095
+ */
4096
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaSpannerSource {
4097
+ /**
4098
+ * Required. The database ID of the source Spanner table.
4099
+ */
4100
+ databaseId?: string | null;
4101
+ /**
4102
+ * Whether to apply data boost on Spanner export. Enabling this option will incur additional cost. More info can be found [here](https://cloud.google.com/spanner/docs/databoost/databoost-overview#billing_and_quotas).
4103
+ */
4104
+ enableDataBoost?: boolean | null;
4105
+ /**
4106
+ * Required. The instance ID of the source Spanner table.
4107
+ */
4108
+ instanceId?: string | null;
4109
+ /**
4110
+ * The project ID that the Spanner source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.
4111
+ */
4112
+ projectId?: string | null;
4113
+ /**
4114
+ * Required. The table name of the Spanner database that needs to be imported.
4115
+ */
4116
+ tableId?: string | null;
4117
+ }
2911
4118
  /**
2912
4119
  * Suggestion deny list entry identifying the phrase to block from suggestions and the applied operation for the phrase.
2913
4120
  */
@@ -3057,7 +4264,13 @@ export declare namespace discoveryengine_v1alpha {
3057
4264
  */
3058
4265
  errorSamples?: Schema$GoogleRpcStatus[];
3059
4266
  /**
3060
- * 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.
4267
+ * The metrics of the trained model.
4268
+ */
4269
+ metrics?: {
4270
+ [key: string]: number;
4271
+ } | null;
4272
+ /**
4273
+ * 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 job creation is in progress. * **training**: Model is actively training. * **evaluating**: The model is evaluating trained metrics. * **indexing**: The model trained metrics are indexing. * **ready**: The model is ready for serving.
3061
4274
  */
3062
4275
  modelStatus?: string | null;
3063
4276
  }
@@ -3326,6 +4539,10 @@ export declare namespace discoveryengine_v1alpha {
3326
4539
  * Whether to enable safe search.
3327
4540
  */
3328
4541
  enableSafeSearch?: boolean | null;
4542
+ /**
4543
+ * Whether to enable search-as-you-type behavior for the search widget
4544
+ */
4545
+ enableSearchAsYouType?: boolean | null;
3329
4546
  /**
3330
4547
  * Turn on or off summary for each snippets result.
3331
4548
  */
@@ -3394,7 +4611,7 @@ export declare namespace discoveryengine_v1alpha {
3394
4611
  */
3395
4612
  id?: string | null;
3396
4613
  /**
3397
- * The name of the collection. It should be collection resource name. Format: `projects/{project_number\}/locations/{location\}/collections/{collection_id\}`. For widget service usage, such look up widget config, returned name should be skipped.
4614
+ * The name of the collection. It should be collection resource name. Format: `projects/{project_number\}/locations/{location\}/collections/{collection_id\}`. For APIs under WidgetService, such as LookUpWidgetConfig, the project number and location part is erased in this field.
3398
4615
  */
3399
4616
  name?: string | null;
3400
4617
  }
@@ -3411,7 +4628,7 @@ export declare namespace discoveryengine_v1alpha {
3411
4628
  */
3412
4629
  id?: string | null;
3413
4630
  /**
3414
- * The name of the data store. It should be data store resource name Format: `projects/{project_number\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. For widget service usage, such look up widget config, returned name should be skipped.
4631
+ * The name of the data store. It should be data store resource name Format: `projects/{project_number\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. For APIs under WidgetService, such as LookUpWidgetConfig, the project number and location part is erased in this field.
3415
4632
  */
3416
4633
  name?: string | null;
3417
4634
  }
@@ -3434,7 +4651,7 @@ export declare namespace discoveryengine_v1alpha {
3434
4651
  */
3435
4652
  id?: string | null;
3436
4653
  /**
3437
- * The name of the data store. It should be data store resource name Format: `projects/{project_number\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. For widget service usage, such look up widget config, returned name should be skipped.
4654
+ * The name of the data store. It should be data store resource name Format: `projects/{project_number\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. For APIs under WidgetService, such as LookUpWidgetConfig, the project number and location part is erased in this field.
3438
4655
  */
3439
4656
  name?: string | null;
3440
4657
  }
@@ -3785,7 +5002,7 @@ export declare namespace discoveryengine_v1alpha {
3785
5002
  */
3786
5003
  export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig {
3787
5004
  /**
3788
- * Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.
5005
+ * [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.
3789
5006
  */
3790
5007
  enhancedDocumentElements?: string[] | null;
3791
5008
  /**
@@ -3869,7 +5086,7 @@ export declare namespace discoveryengine_v1alpha {
3869
5086
  */
3870
5087
  agentCreationConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig;
3871
5088
  /**
3872
- * The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Please use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.
5089
+ * The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.
3873
5090
  */
3874
5091
  dialogflowAgentToLink?: string | null;
3875
5092
  }
@@ -3921,7 +5138,7 @@ export declare namespace discoveryengine_v1alpha {
3921
5138
  */
3922
5139
  searchAddOns?: string[] | null;
3923
5140
  /**
3924
- * The search feature tier of this engine. Different tiers might have different pricing. To learn more, please check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.
5141
+ * The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.
3925
5142
  */
3926
5143
  searchTier?: string | null;
3927
5144
  }
@@ -3941,6 +5158,10 @@ export declare namespace discoveryengine_v1alpha {
3941
5158
  * Count of entries that were processed successfully.
3942
5159
  */
3943
5160
  successCount?: string | null;
5161
+ /**
5162
+ * Total count of entries that were processed.
5163
+ */
5164
+ totalCount?: string | null;
3944
5165
  /**
3945
5166
  * Operation last update time. If the operation is done, this is also the finish time.
3946
5167
  */
@@ -4221,10 +5442,30 @@ export declare namespace discoveryengine_v1alpha {
4221
5442
  */
4222
5443
  errorSamples?: Schema$GoogleRpcStatus[];
4223
5444
  /**
4224
- * 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.
5445
+ * The metrics of the trained model.
5446
+ */
5447
+ metrics?: {
5448
+ [key: string]: number;
5449
+ } | null;
5450
+ /**
5451
+ * 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 job creation is in progress. * **training**: Model is actively training. * **evaluating**: The model is evaluating trained metrics. * **indexing**: The model trained metrics are indexing. * **ready**: The model is ready for serving.
4225
5452
  */
4226
5453
  modelStatus?: string | null;
4227
5454
  }
5455
+ /**
5456
+ * Metadata associated with a tune operation.
5457
+ */
5458
+ export interface Schema$GoogleCloudDiscoveryengineV1betaTuneEngineMetadata {
5459
+ /**
5460
+ * Required. The resource name of the engine that this tune applies to. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`
5461
+ */
5462
+ engine?: string | null;
5463
+ }
5464
+ /**
5465
+ * Response associated with a tune operation.
5466
+ */
5467
+ export interface Schema$GoogleCloudDiscoveryengineV1betaTuneEngineResponse {
5468
+ }
4228
5469
  /**
4229
5470
  * Metadata for UpdateSchema LRO.
4230
5471
  */
@@ -4456,7 +5697,7 @@ export declare namespace discoveryengine_v1alpha {
4456
5697
  */
4457
5698
  export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig {
4458
5699
  /**
4459
- * Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.
5700
+ * [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.
4460
5701
  */
4461
5702
  enhancedDocumentElements?: string[] | null;
4462
5703
  /**
@@ -4540,7 +5781,7 @@ export declare namespace discoveryengine_v1alpha {
4540
5781
  */
4541
5782
  agentCreationConfig?: Schema$GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig;
4542
5783
  /**
4543
- * The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Please use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.
5784
+ * The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.
4544
5785
  */
4545
5786
  dialogflowAgentToLink?: string | null;
4546
5787
  }
@@ -4592,7 +5833,7 @@ export declare namespace discoveryengine_v1alpha {
4592
5833
  */
4593
5834
  searchAddOns?: string[] | null;
4594
5835
  /**
4595
- * The search feature tier of this engine. Different tiers might have different pricing. To learn more, please check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.
5836
+ * The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.
4596
5837
  */
4597
5838
  searchTier?: string | null;
4598
5839
  }
@@ -4612,6 +5853,10 @@ export declare namespace discoveryengine_v1alpha {
4612
5853
  * Count of entries that were processed successfully.
4613
5854
  */
4614
5855
  successCount?: string | null;
5856
+ /**
5857
+ * Total count of entries that were processed.
5858
+ */
5859
+ totalCount?: string | null;
4615
5860
  /**
4616
5861
  * Operation last update time. If the operation is done, this is also the finish time.
4617
5862
  */
@@ -5049,43 +6294,116 @@ export declare namespace discoveryengine_v1alpha {
5049
6294
  /**
5050
6295
  * Required. The location resource where widget complete query will be performed. Format: `locations/{location\}`
5051
6296
  */
5052
- location?: string;
6297
+ location?: string;
6298
+ /**
6299
+ * Request body metadata
6300
+ */
6301
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryRequest;
6302
+ }
6303
+ export interface Params$Resource$Locations$Widgetconverseconversation extends StandardParameters {
6304
+ /**
6305
+ * Required. The location resource where widget converse conversation will be performed. Format: `locations/{location\}`
6306
+ */
6307
+ location?: string;
6308
+ /**
6309
+ * Request body metadata
6310
+ */
6311
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationRequest;
6312
+ }
6313
+ export interface Params$Resource$Locations$Widgetsearch extends StandardParameters {
6314
+ /**
6315
+ * Required. The location resource where widget search will be performed. Format: `locations/{location\}`
6316
+ */
6317
+ location?: string;
6318
+ /**
6319
+ * Request body metadata
6320
+ */
6321
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetSearchRequest;
6322
+ }
6323
+ export class Resource$Projects {
6324
+ context: APIRequestContext;
6325
+ locations: Resource$Projects$Locations;
6326
+ operations: Resource$Projects$Operations;
6327
+ constructor(context: APIRequestContext);
6328
+ /**
6329
+ * Gets a Project. Returns NOT_FOUND when the project is not yet created.
6330
+ *
6331
+ * @param params - Parameters for request
6332
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
6333
+ * @param callback - Optional callback that handles the response.
6334
+ * @returns A promise if used with async/await, or void if used with a callback.
6335
+ */
6336
+ get(params: Params$Resource$Projects$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
6337
+ get(params?: Params$Resource$Projects$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaProject>;
6338
+ get(params: Params$Resource$Projects$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
6339
+ get(params: Params$Resource$Projects$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaProject>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaProject>): void;
6340
+ get(params: Params$Resource$Projects$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaProject>): void;
6341
+ get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaProject>): void;
6342
+ /**
6343
+ * Provisions the project resource. During the process, related systems will get prepared and initialized. Caller must read the [Terms for data use](https://cloud.google.com/retail/data-use-terms), and optionally specify in request to provide consent to that service terms.
6344
+ *
6345
+ * @param params - Parameters for request
6346
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
6347
+ * @param callback - Optional callback that handles the response.
6348
+ * @returns A promise if used with async/await, or void if used with a callback.
6349
+ */
6350
+ provision(params: Params$Resource$Projects$Provision, options: StreamMethodOptions): GaxiosPromise<Readable>;
6351
+ provision(params?: Params$Resource$Projects$Provision, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
6352
+ provision(params: Params$Resource$Projects$Provision, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
6353
+ provision(params: Params$Resource$Projects$Provision, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
6354
+ provision(params: Params$Resource$Projects$Provision, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
6355
+ provision(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
6356
+ /**
6357
+ * Updates service terms for this project. This method can be used to retroactively accept the latest terms. Terms available for update: * [Terms for data use](https://cloud.google.com/retail/data-use-terms)
6358
+ *
6359
+ * @param params - Parameters for request
6360
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
6361
+ * @param callback - Optional callback that handles the response.
6362
+ * @returns A promise if used with async/await, or void if used with a callback.
6363
+ */
6364
+ reportConsentChange(params: Params$Resource$Projects$Reportconsentchange, options: StreamMethodOptions): GaxiosPromise<Readable>;
6365
+ reportConsentChange(params?: Params$Resource$Projects$Reportconsentchange, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaProject>;
6366
+ reportConsentChange(params: Params$Resource$Projects$Reportconsentchange, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
6367
+ reportConsentChange(params: Params$Resource$Projects$Reportconsentchange, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaProject>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaProject>): void;
6368
+ reportConsentChange(params: Params$Resource$Projects$Reportconsentchange, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaProject>): void;
6369
+ reportConsentChange(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaProject>): void;
6370
+ }
6371
+ export interface Params$Resource$Projects$Get extends StandardParameters {
5053
6372
  /**
5054
- * Request body metadata
6373
+ * Required. Full resource name of a Project, such as `projects/{project_id_or_number\}`.
5055
6374
  */
5056
- requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryRequest;
6375
+ name?: string;
5057
6376
  }
5058
- export interface Params$Resource$Locations$Widgetconverseconversation extends StandardParameters {
6377
+ export interface Params$Resource$Projects$Provision extends StandardParameters {
5059
6378
  /**
5060
- * Required. The location resource where widget converse conversation will be performed. Format: `locations/{location\}`
6379
+ * Required. Full resource name of a Project, such as `projects/{project_id_or_number\}`.
5061
6380
  */
5062
- location?: string;
6381
+ name?: string;
5063
6382
  /**
5064
6383
  * Request body metadata
5065
6384
  */
5066
- requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationRequest;
6385
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaProvisionProjectRequest;
5067
6386
  }
5068
- export interface Params$Resource$Locations$Widgetsearch extends StandardParameters {
6387
+ export interface Params$Resource$Projects$Reportconsentchange extends StandardParameters {
5069
6388
  /**
5070
- * Required. The location resource where widget search will be performed. Format: `locations/{location\}`
6389
+ * Required. Full resource name of a Project, such as `projects/{project_id_or_number\}`.
5071
6390
  */
5072
- location?: string;
6391
+ project?: string;
5073
6392
  /**
5074
6393
  * Request body metadata
5075
6394
  */
5076
- requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetSearchRequest;
5077
- }
5078
- export class Resource$Projects {
5079
- context: APIRequestContext;
5080
- locations: Resource$Projects$Locations;
5081
- operations: Resource$Projects$Operations;
5082
- constructor(context: APIRequestContext);
6395
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaReportConsentChangeRequest;
5083
6396
  }
5084
6397
  export class Resource$Projects$Locations {
5085
6398
  context: APIRequestContext;
5086
6399
  collections: Resource$Projects$Locations$Collections;
5087
6400
  dataStores: Resource$Projects$Locations$Datastores;
6401
+ evaluations: Resource$Projects$Locations$Evaluations;
6402
+ groundingConfigs: Resource$Projects$Locations$Groundingconfigs;
5088
6403
  operations: Resource$Projects$Locations$Operations;
6404
+ rankingConfigs: Resource$Projects$Locations$Rankingconfigs;
6405
+ sampleQuerySets: Resource$Projects$Locations$Samplequerysets;
6406
+ userEvents: Resource$Projects$Locations$Userevents;
5089
6407
  constructor(context: APIRequestContext);
5090
6408
  /**
5091
6409
  * Estimates the data size to be used by a customer.
@@ -5233,6 +6551,7 @@ export declare namespace discoveryengine_v1alpha {
5233
6551
  operations: Resource$Projects$Locations$Collections$Datastores$Operations;
5234
6552
  schemas: Resource$Projects$Locations$Collections$Datastores$Schemas;
5235
6553
  servingConfigs: Resource$Projects$Locations$Collections$Datastores$Servingconfigs;
6554
+ sessions: Resource$Projects$Locations$Collections$Datastores$Sessions;
5236
6555
  siteSearchEngine: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine;
5237
6556
  suggestionDenyListEntries: Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries;
5238
6557
  userEvents: Resource$Projects$Locations$Collections$Datastores$Userevents;
@@ -5965,7 +7284,7 @@ export declare namespace discoveryengine_v1alpha {
5965
7284
  }
5966
7285
  export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch extends StandardParameters {
5967
7286
  /**
5968
- * 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`.
7287
+ * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/dataStore/x/conversations/x` or `projects/{project\}/locations/global/collections/{collection\}/engines/x/conversations/x`.
5969
7288
  */
5970
7289
  name?: string;
5971
7290
  /**
@@ -6282,6 +7601,20 @@ export declare namespace discoveryengine_v1alpha {
6282
7601
  export class Resource$Projects$Locations$Collections$Datastores$Servingconfigs {
6283
7602
  context: APIRequestContext;
6284
7603
  constructor(context: APIRequestContext);
7604
+ /**
7605
+ * Answer query method.
7606
+ *
7607
+ * @param params - Parameters for request
7608
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
7609
+ * @param callback - Optional callback that handles the response.
7610
+ * @returns A promise if used with async/await, or void if used with a callback.
7611
+ */
7612
+ answer(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, options: StreamMethodOptions): GaxiosPromise<Readable>;
7613
+ answer(params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>;
7614
+ answer(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
7615
+ answer(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>): void;
7616
+ answer(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>): void;
7617
+ answer(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>): void;
6285
7618
  /**
6286
7619
  * Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
6287
7620
  *
@@ -6353,6 +7686,16 @@ export declare namespace discoveryengine_v1alpha {
6353
7686
  search(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>): void;
6354
7687
  search(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>): void;
6355
7688
  }
7689
+ export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer extends StandardParameters {
7690
+ /**
7691
+ * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/x/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.
7692
+ */
7693
+ servingConfig?: string;
7694
+ /**
7695
+ * Request body metadata
7696
+ */
7697
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest;
7698
+ }
6356
7699
  export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get extends StandardParameters {
6357
7700
  /**
6358
7701
  * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
@@ -6407,6 +7750,163 @@ export declare namespace discoveryengine_v1alpha {
6407
7750
  */
6408
7751
  requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequest;
6409
7752
  }
7753
+ export class Resource$Projects$Locations$Collections$Datastores$Sessions {
7754
+ context: APIRequestContext;
7755
+ answers: Resource$Projects$Locations$Collections$Datastores$Sessions$Answers;
7756
+ constructor(context: APIRequestContext);
7757
+ /**
7758
+ * Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.
7759
+ *
7760
+ * @param params - Parameters for request
7761
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
7762
+ * @param callback - Optional callback that handles the response.
7763
+ * @returns A promise if used with async/await, or void if used with a callback.
7764
+ */
7765
+ create(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create, options: StreamMethodOptions): GaxiosPromise<Readable>;
7766
+ create(params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaSession>;
7767
+ create(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
7768
+ create(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>): void;
7769
+ create(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>): void;
7770
+ create(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>): void;
7771
+ /**
7772
+ * Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned.
7773
+ *
7774
+ * @param params - Parameters for request
7775
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
7776
+ * @param callback - Optional callback that handles the response.
7777
+ * @returns A promise if used with async/await, or void if used with a callback.
7778
+ */
7779
+ delete(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete, options: StreamMethodOptions): GaxiosPromise<Readable>;
7780
+ delete(params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete, options?: MethodOptions): GaxiosPromise<Schema$GoogleProtobufEmpty>;
7781
+ delete(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
7782
+ delete(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleProtobufEmpty>, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
7783
+ delete(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
7784
+ delete(callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
7785
+ /**
7786
+ * Gets a Session.
7787
+ *
7788
+ * @param params - Parameters for request
7789
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
7790
+ * @param callback - Optional callback that handles the response.
7791
+ * @returns A promise if used with async/await, or void if used with a callback.
7792
+ */
7793
+ get(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
7794
+ get(params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaSession>;
7795
+ get(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
7796
+ get(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>): void;
7797
+ get(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>): void;
7798
+ get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>): void;
7799
+ /**
7800
+ * Lists all Sessions by their parent DataStore.
7801
+ *
7802
+ * @param params - Parameters for request
7803
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
7804
+ * @param callback - Optional callback that handles the response.
7805
+ * @returns A promise if used with async/await, or void if used with a callback.
7806
+ */
7807
+ list(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
7808
+ list(params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaListSessionsResponse>;
7809
+ list(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
7810
+ list(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListSessionsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListSessionsResponse>): void;
7811
+ list(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListSessionsResponse>): void;
7812
+ list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListSessionsResponse>): void;
7813
+ /**
7814
+ * Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned.
7815
+ *
7816
+ * @param params - Parameters for request
7817
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
7818
+ * @param callback - Optional callback that handles the response.
7819
+ * @returns A promise if used with async/await, or void if used with a callback.
7820
+ */
7821
+ patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
7822
+ patch(params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaSession>;
7823
+ patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
7824
+ patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>): void;
7825
+ patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>): void;
7826
+ patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>): void;
7827
+ }
7828
+ export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create extends StandardParameters {
7829
+ /**
7830
+ * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}`
7831
+ */
7832
+ parent?: string;
7833
+ /**
7834
+ * Request body metadata
7835
+ */
7836
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSession;
7837
+ }
7838
+ export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete extends StandardParameters {
7839
+ /**
7840
+ * Required. The resource name of the Session to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}`
7841
+ */
7842
+ name?: string;
7843
+ }
7844
+ export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get extends StandardParameters {
7845
+ /**
7846
+ * Required. The resource name of the Session to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}`
7847
+ */
7848
+ name?: string;
7849
+ }
7850
+ export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List extends StandardParameters {
7851
+ /**
7852
+ * A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id"
7853
+ */
7854
+ filter?: string;
7855
+ /**
7856
+ * 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` * `session_name` Example: "update_time desc" "create_time"
7857
+ */
7858
+ orderBy?: string;
7859
+ /**
7860
+ * Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
7861
+ */
7862
+ pageSize?: number;
7863
+ /**
7864
+ * A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page.
7865
+ */
7866
+ pageToken?: string;
7867
+ /**
7868
+ * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}`
7869
+ */
7870
+ parent?: string;
7871
+ }
7872
+ export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch extends StandardParameters {
7873
+ /**
7874
+ * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x`
7875
+ */
7876
+ name?: string;
7877
+ /**
7878
+ * Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated.
7879
+ */
7880
+ updateMask?: string;
7881
+ /**
7882
+ * Request body metadata
7883
+ */
7884
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSession;
7885
+ }
7886
+ export class Resource$Projects$Locations$Collections$Datastores$Sessions$Answers {
7887
+ context: APIRequestContext;
7888
+ constructor(context: APIRequestContext);
7889
+ /**
7890
+ * Gets a Answer.
7891
+ *
7892
+ * @param params - Parameters for request
7893
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
7894
+ * @param callback - Optional callback that handles the response.
7895
+ * @returns A promise if used with async/await, or void if used with a callback.
7896
+ */
7897
+ get(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
7898
+ get(params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaAnswer>;
7899
+ get(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
7900
+ get(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswer>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswer>): void;
7901
+ get(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswer>): void;
7902
+ get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswer>): void;
7903
+ }
7904
+ export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get extends StandardParameters {
7905
+ /**
7906
+ * Required. The resource name of the Answer to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}`
7907
+ */
7908
+ name?: string;
7909
+ }
6410
7910
  export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine {
6411
7911
  context: APIRequestContext;
6412
7912
  operations: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations;
@@ -6946,7 +8446,7 @@ export declare namespace discoveryengine_v1alpha {
6946
8446
  }
6947
8447
  export interface Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write extends StandardParameters {
6948
8448
  /**
6949
- * Required. The parent DataStore resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`.
8449
+ * Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project\}/locations/{location\}`.
6950
8450
  */
6951
8451
  parent?: string;
6952
8452
  /**
@@ -6959,6 +8459,7 @@ export declare namespace discoveryengine_v1alpha {
6959
8459
  conversations: Resource$Projects$Locations$Collections$Engines$Conversations;
6960
8460
  operations: Resource$Projects$Locations$Collections$Engines$Operations;
6961
8461
  servingConfigs: Resource$Projects$Locations$Collections$Engines$Servingconfigs;
8462
+ sessions: Resource$Projects$Locations$Collections$Engines$Sessions;
6962
8463
  constructor(context: APIRequestContext);
6963
8464
  /**
6964
8465
  * Creates a Engine.
@@ -7305,7 +8806,7 @@ export declare namespace discoveryengine_v1alpha {
7305
8806
  }
7306
8807
  export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch extends StandardParameters {
7307
8808
  /**
7308
- * 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`.
8809
+ * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/dataStore/x/conversations/x` or `projects/{project\}/locations/global/collections/{collection\}/engines/x/conversations/x`.
7309
8810
  */
7310
8811
  name?: string;
7311
8812
  /**
@@ -7376,6 +8877,20 @@ export declare namespace discoveryengine_v1alpha {
7376
8877
  export class Resource$Projects$Locations$Collections$Engines$Servingconfigs {
7377
8878
  context: APIRequestContext;
7378
8879
  constructor(context: APIRequestContext);
8880
+ /**
8881
+ * Answer query method.
8882
+ *
8883
+ * @param params - Parameters for request
8884
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
8885
+ * @param callback - Optional callback that handles the response.
8886
+ * @returns A promise if used with async/await, or void if used with a callback.
8887
+ */
8888
+ answer(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, options: StreamMethodOptions): GaxiosPromise<Readable>;
8889
+ answer(params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>;
8890
+ answer(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
8891
+ answer(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>): void;
8892
+ answer(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>): void;
8893
+ answer(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>): void;
7379
8894
  /**
7380
8895
  * Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
7381
8896
  *
@@ -7440,66 +8955,233 @@ export declare namespace discoveryengine_v1alpha {
7440
8955
  * @param callback - Optional callback that handles the response.
7441
8956
  * @returns A promise if used with async/await, or void if used with a callback.
7442
8957
  */
7443
- search(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, options: StreamMethodOptions): GaxiosPromise<Readable>;
7444
- search(params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>;
7445
- search(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
7446
- search(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>): void;
7447
- search(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>): void;
7448
- search(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>): void;
8958
+ search(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, options: StreamMethodOptions): GaxiosPromise<Readable>;
8959
+ search(params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>;
8960
+ search(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
8961
+ search(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>): void;
8962
+ search(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>): void;
8963
+ search(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>): void;
8964
+ }
8965
+ export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer extends StandardParameters {
8966
+ /**
8967
+ * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/x/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.
8968
+ */
8969
+ servingConfig?: string;
8970
+ /**
8971
+ * Request body metadata
8972
+ */
8973
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest;
8974
+ }
8975
+ export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get extends StandardParameters {
8976
+ /**
8977
+ * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
8978
+ */
8979
+ name?: string;
8980
+ }
8981
+ export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List extends StandardParameters {
8982
+ /**
8983
+ * Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned.
8984
+ */
8985
+ pageSize?: number;
8986
+ /**
8987
+ * Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.
8988
+ */
8989
+ pageToken?: string;
8990
+ /**
8991
+ * Required. Full resource name of the parent resource. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
8992
+ */
8993
+ parent?: string;
8994
+ }
8995
+ export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch extends StandardParameters {
8996
+ /**
8997
+ * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}`
8998
+ */
8999
+ name?: string;
9000
+ /**
9001
+ * Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated.
9002
+ */
9003
+ updateMask?: string;
9004
+ /**
9005
+ * Request body metadata
9006
+ */
9007
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfig;
9008
+ }
9009
+ export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend extends StandardParameters {
9010
+ /**
9011
+ * Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests.
9012
+ */
9013
+ servingConfig?: string;
9014
+ /**
9015
+ * Request body metadata
9016
+ */
9017
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRecommendRequest;
9018
+ }
9019
+ export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search extends StandardParameters {
9020
+ /**
9021
+ * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.
9022
+ */
9023
+ servingConfig?: string;
9024
+ /**
9025
+ * Request body metadata
9026
+ */
9027
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequest;
9028
+ }
9029
+ export class Resource$Projects$Locations$Collections$Engines$Sessions {
9030
+ context: APIRequestContext;
9031
+ answers: Resource$Projects$Locations$Collections$Engines$Sessions$Answers;
9032
+ constructor(context: APIRequestContext);
9033
+ /**
9034
+ * Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.
9035
+ *
9036
+ * @param params - Parameters for request
9037
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
9038
+ * @param callback - Optional callback that handles the response.
9039
+ * @returns A promise if used with async/await, or void if used with a callback.
9040
+ */
9041
+ create(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, options: StreamMethodOptions): GaxiosPromise<Readable>;
9042
+ create(params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaSession>;
9043
+ create(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
9044
+ create(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>): void;
9045
+ create(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>): void;
9046
+ create(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>): void;
9047
+ /**
9048
+ * Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned.
9049
+ *
9050
+ * @param params - Parameters for request
9051
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
9052
+ * @param callback - Optional callback that handles the response.
9053
+ * @returns A promise if used with async/await, or void if used with a callback.
9054
+ */
9055
+ delete(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, options: StreamMethodOptions): GaxiosPromise<Readable>;
9056
+ delete(params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, options?: MethodOptions): GaxiosPromise<Schema$GoogleProtobufEmpty>;
9057
+ delete(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
9058
+ delete(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleProtobufEmpty>, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
9059
+ delete(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
9060
+ delete(callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
9061
+ /**
9062
+ * Gets a Session.
9063
+ *
9064
+ * @param params - Parameters for request
9065
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
9066
+ * @param callback - Optional callback that handles the response.
9067
+ * @returns A promise if used with async/await, or void if used with a callback.
9068
+ */
9069
+ get(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
9070
+ get(params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaSession>;
9071
+ get(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
9072
+ get(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>): void;
9073
+ get(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>): void;
9074
+ get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>): void;
9075
+ /**
9076
+ * Lists all Sessions by their parent DataStore.
9077
+ *
9078
+ * @param params - Parameters for request
9079
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
9080
+ * @param callback - Optional callback that handles the response.
9081
+ * @returns A promise if used with async/await, or void if used with a callback.
9082
+ */
9083
+ list(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
9084
+ list(params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaListSessionsResponse>;
9085
+ list(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
9086
+ list(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListSessionsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListSessionsResponse>): void;
9087
+ list(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListSessionsResponse>): void;
9088
+ list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListSessionsResponse>): void;
9089
+ /**
9090
+ * Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned.
9091
+ *
9092
+ * @param params - Parameters for request
9093
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
9094
+ * @param callback - Optional callback that handles the response.
9095
+ * @returns A promise if used with async/await, or void if used with a callback.
9096
+ */
9097
+ patch(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
9098
+ patch(params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaSession>;
9099
+ patch(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
9100
+ patch(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>): void;
9101
+ patch(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>): void;
9102
+ patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>): void;
9103
+ }
9104
+ export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create extends StandardParameters {
9105
+ /**
9106
+ * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}`
9107
+ */
9108
+ parent?: string;
9109
+ /**
9110
+ * Request body metadata
9111
+ */
9112
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSession;
7449
9113
  }
7450
- export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get extends StandardParameters {
9114
+ export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete extends StandardParameters {
7451
9115
  /**
7452
- * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
9116
+ * Required. The resource name of the Session to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}`
7453
9117
  */
7454
9118
  name?: string;
7455
9119
  }
7456
- export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List extends StandardParameters {
9120
+ export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get extends StandardParameters {
7457
9121
  /**
7458
- * Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned.
9122
+ * Required. The resource name of the Session to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}`
9123
+ */
9124
+ name?: string;
9125
+ }
9126
+ export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$List extends StandardParameters {
9127
+ /**
9128
+ * A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id"
9129
+ */
9130
+ filter?: string;
9131
+ /**
9132
+ * 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` * `session_name` Example: "update_time desc" "create_time"
9133
+ */
9134
+ orderBy?: string;
9135
+ /**
9136
+ * Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
7459
9137
  */
7460
9138
  pageSize?: number;
7461
9139
  /**
7462
- * Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.
9140
+ * A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page.
7463
9141
  */
7464
9142
  pageToken?: string;
7465
9143
  /**
7466
- * Required. Full resource name of the parent resource. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
9144
+ * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}`
7467
9145
  */
7468
9146
  parent?: string;
7469
9147
  }
7470
- export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch extends StandardParameters {
9148
+ export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch extends StandardParameters {
7471
9149
  /**
7472
- * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}`
9150
+ * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x`
7473
9151
  */
7474
9152
  name?: string;
7475
9153
  /**
7476
- * Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated.
9154
+ * Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated.
7477
9155
  */
7478
9156
  updateMask?: string;
7479
9157
  /**
7480
9158
  * Request body metadata
7481
9159
  */
7482
- requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfig;
9160
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSession;
7483
9161
  }
7484
- export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend extends StandardParameters {
7485
- /**
7486
- * Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests.
7487
- */
7488
- servingConfig?: string;
9162
+ export class Resource$Projects$Locations$Collections$Engines$Sessions$Answers {
9163
+ context: APIRequestContext;
9164
+ constructor(context: APIRequestContext);
7489
9165
  /**
7490
- * Request body metadata
9166
+ * Gets a Answer.
9167
+ *
9168
+ * @param params - Parameters for request
9169
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
9170
+ * @param callback - Optional callback that handles the response.
9171
+ * @returns A promise if used with async/await, or void if used with a callback.
7491
9172
  */
7492
- requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRecommendRequest;
9173
+ get(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
9174
+ get(params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaAnswer>;
9175
+ get(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
9176
+ get(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswer>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswer>): void;
9177
+ get(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswer>): void;
9178
+ get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswer>): void;
7493
9179
  }
7494
- export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search extends StandardParameters {
7495
- /**
7496
- * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.
7497
- */
7498
- servingConfig?: string;
9180
+ export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get extends StandardParameters {
7499
9181
  /**
7500
- * Request body metadata
9182
+ * Required. The resource name of the Answer to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}`
7501
9183
  */
7502
- requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequest;
9184
+ name?: string;
7503
9185
  }
7504
9186
  export class Resource$Projects$Locations$Collections$Operations {
7505
9187
  context: APIRequestContext;
@@ -7565,6 +9247,7 @@ export declare namespace discoveryengine_v1alpha {
7565
9247
  operations: Resource$Projects$Locations$Datastores$Operations;
7566
9248
  schemas: Resource$Projects$Locations$Datastores$Schemas;
7567
9249
  servingConfigs: Resource$Projects$Locations$Datastores$Servingconfigs;
9250
+ sessions: Resource$Projects$Locations$Datastores$Sessions;
7568
9251
  siteSearchEngine: Resource$Projects$Locations$Datastores$Sitesearchengine;
7569
9252
  suggestionDenyListEntries: Resource$Projects$Locations$Datastores$Suggestiondenylistentries;
7570
9253
  userEvents: Resource$Projects$Locations$Datastores$Userevents;
@@ -8273,7 +9956,7 @@ export declare namespace discoveryengine_v1alpha {
8273
9956
  }
8274
9957
  export interface Params$Resource$Projects$Locations$Datastores$Conversations$Patch extends StandardParameters {
8275
9958
  /**
8276
- * 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`.
9959
+ * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/dataStore/x/conversations/x` or `projects/{project\}/locations/global/collections/{collection\}/engines/x/conversations/x`.
8277
9960
  */
8278
9961
  name?: string;
8279
9962
  /**
@@ -8533,6 +10216,20 @@ export declare namespace discoveryengine_v1alpha {
8533
10216
  export class Resource$Projects$Locations$Datastores$Servingconfigs {
8534
10217
  context: APIRequestContext;
8535
10218
  constructor(context: APIRequestContext);
10219
+ /**
10220
+ * Answer query method.
10221
+ *
10222
+ * @param params - Parameters for request
10223
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
10224
+ * @param callback - Optional callback that handles the response.
10225
+ * @returns A promise if used with async/await, or void if used with a callback.
10226
+ */
10227
+ answer(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, options: StreamMethodOptions): GaxiosPromise<Readable>;
10228
+ answer(params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>;
10229
+ answer(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
10230
+ answer(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>): void;
10231
+ answer(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>): void;
10232
+ answer(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>): void;
8536
10233
  /**
8537
10234
  * Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
8538
10235
  *
@@ -8604,6 +10301,16 @@ export declare namespace discoveryengine_v1alpha {
8604
10301
  search(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>): void;
8605
10302
  search(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>): void;
8606
10303
  }
10304
+ export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer extends StandardParameters {
10305
+ /**
10306
+ * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/x/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.
10307
+ */
10308
+ servingConfig?: string;
10309
+ /**
10310
+ * Request body metadata
10311
+ */
10312
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest;
10313
+ }
8607
10314
  export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get extends StandardParameters {
8608
10315
  /**
8609
10316
  * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
@@ -8658,6 +10365,163 @@ export declare namespace discoveryengine_v1alpha {
8658
10365
  */
8659
10366
  requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequest;
8660
10367
  }
10368
+ export class Resource$Projects$Locations$Datastores$Sessions {
10369
+ context: APIRequestContext;
10370
+ answers: Resource$Projects$Locations$Datastores$Sessions$Answers;
10371
+ constructor(context: APIRequestContext);
10372
+ /**
10373
+ * Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.
10374
+ *
10375
+ * @param params - Parameters for request
10376
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
10377
+ * @param callback - Optional callback that handles the response.
10378
+ * @returns A promise if used with async/await, or void if used with a callback.
10379
+ */
10380
+ create(params: Params$Resource$Projects$Locations$Datastores$Sessions$Create, options: StreamMethodOptions): GaxiosPromise<Readable>;
10381
+ create(params?: Params$Resource$Projects$Locations$Datastores$Sessions$Create, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaSession>;
10382
+ create(params: Params$Resource$Projects$Locations$Datastores$Sessions$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
10383
+ create(params: Params$Resource$Projects$Locations$Datastores$Sessions$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>): void;
10384
+ create(params: Params$Resource$Projects$Locations$Datastores$Sessions$Create, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>): void;
10385
+ create(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>): void;
10386
+ /**
10387
+ * Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned.
10388
+ *
10389
+ * @param params - Parameters for request
10390
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
10391
+ * @param callback - Optional callback that handles the response.
10392
+ * @returns A promise if used with async/await, or void if used with a callback.
10393
+ */
10394
+ delete(params: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, options: StreamMethodOptions): GaxiosPromise<Readable>;
10395
+ delete(params?: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, options?: MethodOptions): GaxiosPromise<Schema$GoogleProtobufEmpty>;
10396
+ delete(params: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
10397
+ delete(params: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleProtobufEmpty>, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
10398
+ delete(params: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
10399
+ delete(callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
10400
+ /**
10401
+ * Gets a Session.
10402
+ *
10403
+ * @param params - Parameters for request
10404
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
10405
+ * @param callback - Optional callback that handles the response.
10406
+ * @returns A promise if used with async/await, or void if used with a callback.
10407
+ */
10408
+ get(params: Params$Resource$Projects$Locations$Datastores$Sessions$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
10409
+ get(params?: Params$Resource$Projects$Locations$Datastores$Sessions$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaSession>;
10410
+ get(params: Params$Resource$Projects$Locations$Datastores$Sessions$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
10411
+ get(params: Params$Resource$Projects$Locations$Datastores$Sessions$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>): void;
10412
+ get(params: Params$Resource$Projects$Locations$Datastores$Sessions$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>): void;
10413
+ get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>): void;
10414
+ /**
10415
+ * Lists all Sessions by their parent DataStore.
10416
+ *
10417
+ * @param params - Parameters for request
10418
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
10419
+ * @param callback - Optional callback that handles the response.
10420
+ * @returns A promise if used with async/await, or void if used with a callback.
10421
+ */
10422
+ list(params: Params$Resource$Projects$Locations$Datastores$Sessions$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
10423
+ list(params?: Params$Resource$Projects$Locations$Datastores$Sessions$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaListSessionsResponse>;
10424
+ list(params: Params$Resource$Projects$Locations$Datastores$Sessions$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
10425
+ list(params: Params$Resource$Projects$Locations$Datastores$Sessions$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListSessionsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListSessionsResponse>): void;
10426
+ list(params: Params$Resource$Projects$Locations$Datastores$Sessions$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListSessionsResponse>): void;
10427
+ list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListSessionsResponse>): void;
10428
+ /**
10429
+ * Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned.
10430
+ *
10431
+ * @param params - Parameters for request
10432
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
10433
+ * @param callback - Optional callback that handles the response.
10434
+ * @returns A promise if used with async/await, or void if used with a callback.
10435
+ */
10436
+ patch(params: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
10437
+ patch(params?: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaSession>;
10438
+ patch(params: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
10439
+ patch(params: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>): void;
10440
+ patch(params: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>): void;
10441
+ patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>): void;
10442
+ }
10443
+ export interface Params$Resource$Projects$Locations$Datastores$Sessions$Create extends StandardParameters {
10444
+ /**
10445
+ * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}`
10446
+ */
10447
+ parent?: string;
10448
+ /**
10449
+ * Request body metadata
10450
+ */
10451
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSession;
10452
+ }
10453
+ export interface Params$Resource$Projects$Locations$Datastores$Sessions$Delete extends StandardParameters {
10454
+ /**
10455
+ * Required. The resource name of the Session to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}`
10456
+ */
10457
+ name?: string;
10458
+ }
10459
+ export interface Params$Resource$Projects$Locations$Datastores$Sessions$Get extends StandardParameters {
10460
+ /**
10461
+ * Required. The resource name of the Session to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}`
10462
+ */
10463
+ name?: string;
10464
+ }
10465
+ export interface Params$Resource$Projects$Locations$Datastores$Sessions$List extends StandardParameters {
10466
+ /**
10467
+ * A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id"
10468
+ */
10469
+ filter?: string;
10470
+ /**
10471
+ * 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` * `session_name` Example: "update_time desc" "create_time"
10472
+ */
10473
+ orderBy?: string;
10474
+ /**
10475
+ * Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
10476
+ */
10477
+ pageSize?: number;
10478
+ /**
10479
+ * A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page.
10480
+ */
10481
+ pageToken?: string;
10482
+ /**
10483
+ * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}`
10484
+ */
10485
+ parent?: string;
10486
+ }
10487
+ export interface Params$Resource$Projects$Locations$Datastores$Sessions$Patch extends StandardParameters {
10488
+ /**
10489
+ * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x`
10490
+ */
10491
+ name?: string;
10492
+ /**
10493
+ * Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated.
10494
+ */
10495
+ updateMask?: string;
10496
+ /**
10497
+ * Request body metadata
10498
+ */
10499
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSession;
10500
+ }
10501
+ export class Resource$Projects$Locations$Datastores$Sessions$Answers {
10502
+ context: APIRequestContext;
10503
+ constructor(context: APIRequestContext);
10504
+ /**
10505
+ * Gets a Answer.
10506
+ *
10507
+ * @param params - Parameters for request
10508
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
10509
+ * @param callback - Optional callback that handles the response.
10510
+ * @returns A promise if used with async/await, or void if used with a callback.
10511
+ */
10512
+ get(params: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
10513
+ get(params?: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaAnswer>;
10514
+ get(params: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
10515
+ get(params: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswer>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswer>): void;
10516
+ get(params: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswer>): void;
10517
+ get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswer>): void;
10518
+ }
10519
+ export interface Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get extends StandardParameters {
10520
+ /**
10521
+ * Required. The resource name of the Answer to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}`
10522
+ */
10523
+ name?: string;
10524
+ }
8661
10525
  export class Resource$Projects$Locations$Datastores$Sitesearchengine {
8662
10526
  context: APIRequestContext;
8663
10527
  targetSites: Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites;
@@ -9031,7 +10895,7 @@ export declare namespace discoveryengine_v1alpha {
9031
10895
  }
9032
10896
  export interface Params$Resource$Projects$Locations$Datastores$Userevents$Write extends StandardParameters {
9033
10897
  /**
9034
- * Required. The parent DataStore resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`.
10898
+ * Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project\}/locations/{location\}`.
9035
10899
  */
9036
10900
  parent?: string;
9037
10901
  /**
@@ -9039,6 +10903,63 @@ export declare namespace discoveryengine_v1alpha {
9039
10903
  */
9040
10904
  requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaUserEvent;
9041
10905
  }
10906
+ export class Resource$Projects$Locations$Evaluations {
10907
+ context: APIRequestContext;
10908
+ operations: Resource$Projects$Locations$Evaluations$Operations;
10909
+ constructor(context: APIRequestContext);
10910
+ }
10911
+ export class Resource$Projects$Locations$Evaluations$Operations {
10912
+ context: APIRequestContext;
10913
+ constructor(context: APIRequestContext);
10914
+ /**
10915
+ * 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.
10916
+ *
10917
+ * @param params - Parameters for request
10918
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
10919
+ * @param callback - Optional callback that handles the response.
10920
+ * @returns A promise if used with async/await, or void if used with a callback.
10921
+ */
10922
+ get(params: Params$Resource$Projects$Locations$Evaluations$Operations$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
10923
+ get(params?: Params$Resource$Projects$Locations$Evaluations$Operations$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
10924
+ get(params: Params$Resource$Projects$Locations$Evaluations$Operations$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
10925
+ get(params: Params$Resource$Projects$Locations$Evaluations$Operations$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
10926
+ get(params: Params$Resource$Projects$Locations$Evaluations$Operations$Get, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
10927
+ get(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
10928
+ }
10929
+ export interface Params$Resource$Projects$Locations$Evaluations$Operations$Get extends StandardParameters {
10930
+ /**
10931
+ * The name of the operation resource.
10932
+ */
10933
+ name?: string;
10934
+ }
10935
+ export class Resource$Projects$Locations$Groundingconfigs {
10936
+ context: APIRequestContext;
10937
+ constructor(context: APIRequestContext);
10938
+ /**
10939
+ * Performs a grounding check.
10940
+ *
10941
+ * @param params - Parameters for request
10942
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
10943
+ * @param callback - Optional callback that handles the response.
10944
+ * @returns A promise if used with async/await, or void if used with a callback.
10945
+ */
10946
+ check(params: Params$Resource$Projects$Locations$Groundingconfigs$Check, options: StreamMethodOptions): GaxiosPromise<Readable>;
10947
+ check(params?: Params$Resource$Projects$Locations$Groundingconfigs$Check, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaCheckGroundingResponse>;
10948
+ check(params: Params$Resource$Projects$Locations$Groundingconfigs$Check, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
10949
+ check(params: Params$Resource$Projects$Locations$Groundingconfigs$Check, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCheckGroundingResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCheckGroundingResponse>): void;
10950
+ check(params: Params$Resource$Projects$Locations$Groundingconfigs$Check, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCheckGroundingResponse>): void;
10951
+ check(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCheckGroundingResponse>): void;
10952
+ }
10953
+ export interface Params$Resource$Projects$Locations$Groundingconfigs$Check extends StandardParameters {
10954
+ /**
10955
+ * Required. The resource name of the grounding config, such as `projects/x/locations/global/groundingConfigs/default_grounding_config`.
10956
+ */
10957
+ groundingConfig?: string;
10958
+ /**
10959
+ * Request body metadata
10960
+ */
10961
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaCheckGroundingRequest;
10962
+ }
9042
10963
  export class Resource$Projects$Locations$Operations {
9043
10964
  context: APIRequestContext;
9044
10965
  constructor(context: APIRequestContext);
@@ -9095,6 +11016,91 @@ export declare namespace discoveryengine_v1alpha {
9095
11016
  */
9096
11017
  pageToken?: string;
9097
11018
  }
11019
+ export class Resource$Projects$Locations$Rankingconfigs {
11020
+ context: APIRequestContext;
11021
+ constructor(context: APIRequestContext);
11022
+ /**
11023
+ * Ranks a list of text records based on the given input query.
11024
+ *
11025
+ * @param params - Parameters for request
11026
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
11027
+ * @param callback - Optional callback that handles the response.
11028
+ * @returns A promise if used with async/await, or void if used with a callback.
11029
+ */
11030
+ rank(params: Params$Resource$Projects$Locations$Rankingconfigs$Rank, options: StreamMethodOptions): GaxiosPromise<Readable>;
11031
+ rank(params?: Params$Resource$Projects$Locations$Rankingconfigs$Rank, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaRankResponse>;
11032
+ rank(params: Params$Resource$Projects$Locations$Rankingconfigs$Rank, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
11033
+ rank(params: Params$Resource$Projects$Locations$Rankingconfigs$Rank, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaRankResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaRankResponse>): void;
11034
+ rank(params: Params$Resource$Projects$Locations$Rankingconfigs$Rank, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaRankResponse>): void;
11035
+ rank(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaRankResponse>): void;
11036
+ }
11037
+ export interface Params$Resource$Projects$Locations$Rankingconfigs$Rank extends StandardParameters {
11038
+ /**
11039
+ * Required. The resource name of the rank service config, such as `projects/{project_num\}/locations/{location_id\}/rankingConfigs/default_ranking_config`.
11040
+ */
11041
+ rankingConfig?: string;
11042
+ /**
11043
+ * Request body metadata
11044
+ */
11045
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRankRequest;
11046
+ }
11047
+ export class Resource$Projects$Locations$Samplequerysets {
11048
+ context: APIRequestContext;
11049
+ operations: Resource$Projects$Locations$Samplequerysets$Operations;
11050
+ constructor(context: APIRequestContext);
11051
+ }
11052
+ export class Resource$Projects$Locations$Samplequerysets$Operations {
11053
+ context: APIRequestContext;
11054
+ constructor(context: APIRequestContext);
11055
+ /**
11056
+ * 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.
11057
+ *
11058
+ * @param params - Parameters for request
11059
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
11060
+ * @param callback - Optional callback that handles the response.
11061
+ * @returns A promise if used with async/await, or void if used with a callback.
11062
+ */
11063
+ get(params: Params$Resource$Projects$Locations$Samplequerysets$Operations$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
11064
+ get(params?: Params$Resource$Projects$Locations$Samplequerysets$Operations$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
11065
+ get(params: Params$Resource$Projects$Locations$Samplequerysets$Operations$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
11066
+ get(params: Params$Resource$Projects$Locations$Samplequerysets$Operations$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
11067
+ get(params: Params$Resource$Projects$Locations$Samplequerysets$Operations$Get, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
11068
+ get(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
11069
+ }
11070
+ export interface Params$Resource$Projects$Locations$Samplequerysets$Operations$Get extends StandardParameters {
11071
+ /**
11072
+ * The name of the operation resource.
11073
+ */
11074
+ name?: string;
11075
+ }
11076
+ export class Resource$Projects$Locations$Userevents {
11077
+ context: APIRequestContext;
11078
+ constructor(context: APIRequestContext);
11079
+ /**
11080
+ * Writes a single user event.
11081
+ *
11082
+ * @param params - Parameters for request
11083
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
11084
+ * @param callback - Optional callback that handles the response.
11085
+ * @returns A promise if used with async/await, or void if used with a callback.
11086
+ */
11087
+ write(params: Params$Resource$Projects$Locations$Userevents$Write, options: StreamMethodOptions): GaxiosPromise<Readable>;
11088
+ write(params?: Params$Resource$Projects$Locations$Userevents$Write, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaUserEvent>;
11089
+ write(params: Params$Resource$Projects$Locations$Userevents$Write, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
11090
+ write(params: Params$Resource$Projects$Locations$Userevents$Write, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaUserEvent>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaUserEvent>): void;
11091
+ write(params: Params$Resource$Projects$Locations$Userevents$Write, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaUserEvent>): void;
11092
+ write(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaUserEvent>): void;
11093
+ }
11094
+ export interface Params$Resource$Projects$Locations$Userevents$Write extends StandardParameters {
11095
+ /**
11096
+ * Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project\}/locations/{location\}`.
11097
+ */
11098
+ parent?: string;
11099
+ /**
11100
+ * Request body metadata
11101
+ */
11102
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaUserEvent;
11103
+ }
9098
11104
  export class Resource$Projects$Operations {
9099
11105
  context: APIRequestContext;
9100
11106
  constructor(context: APIRequestContext);