@google-cloud/discoveryengine 1.12.0 → 1.14.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +14 -0
- package/README.md +10 -0
- package/build/protos/google/cloud/discoveryengine/v1/answer.proto +49 -5
- package/build/protos/google/cloud/discoveryengine/v1/control.proto +6 -4
- package/build/protos/google/cloud/discoveryengine/v1/conversational_search_service.proto +9 -9
- package/build/protos/google/cloud/discoveryengine/v1/custom_tuning_model.proto +96 -0
- package/build/protos/google/cloud/discoveryengine/v1/data_store_service.proto +10 -0
- package/build/protos/google/cloud/discoveryengine/v1/document.proto +20 -0
- package/build/protos/google/cloud/discoveryengine/v1/document_processing_config.proto +2 -0
- package/build/protos/google/cloud/discoveryengine/v1/document_service.proto +110 -0
- package/build/protos/google/cloud/discoveryengine/v1/grounded_generation_service.proto +2 -1
- package/build/protos/google/cloud/discoveryengine/v1/import_config.proto +13 -7
- package/build/protos/google/cloud/discoveryengine/v1/purge_config.proto +117 -0
- package/build/protos/google/cloud/discoveryengine/v1/recommendation_service.proto +2 -1
- package/build/protos/google/cloud/discoveryengine/v1/search_service.proto +40 -16
- package/build/protos/google/cloud/discoveryengine/v1/search_tuning_service.proto +196 -0
- package/build/protos/google/cloud/discoveryengine/v1/user_event.proto +4 -0
- package/build/protos/google/cloud/discoveryengine/v1/user_event_service.proto +21 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/acl_config_service.proto +1 -1
- package/build/protos/google/cloud/discoveryengine/v1alpha/answer.proto +61 -2
- package/build/protos/google/cloud/discoveryengine/v1alpha/chunk.proto +1 -1
- package/build/protos/google/cloud/discoveryengine/v1alpha/completion.proto +31 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/completion_service.proto +38 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/control.proto +1 -1
- package/build/protos/google/cloud/discoveryengine/v1alpha/conversational_search_service.proto +28 -9
- package/build/protos/google/cloud/discoveryengine/v1alpha/custom_tuning_model.proto +10 -1
- package/build/protos/google/cloud/discoveryengine/v1alpha/data_store.proto +71 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/data_store_service.proto +11 -1
- package/build/protos/google/cloud/discoveryengine/v1alpha/document.proto +24 -1
- package/build/protos/google/cloud/discoveryengine/v1alpha/document_processing_config.proto +6 -2
- package/build/protos/google/cloud/discoveryengine/v1alpha/document_service.proto +108 -1
- package/build/protos/google/cloud/discoveryengine/v1alpha/grounded_generation_service.proto +2 -1
- package/build/protos/google/cloud/discoveryengine/v1alpha/import_config.proto +119 -5
- package/build/protos/google/cloud/discoveryengine/v1alpha/purge_config.proto +58 -1
- package/build/protos/google/cloud/discoveryengine/v1alpha/schema.proto +5 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/search_service.proto +428 -12
- package/build/protos/google/cloud/discoveryengine/v1alpha/serving_config.proto +14 -5
- package/build/protos/google/cloud/discoveryengine/v1alpha/site_search_engine_service.proto +126 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/user_event.proto +4 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/user_event_service.proto +3 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/answer.proto +47 -2
- package/build/protos/google/cloud/discoveryengine/v1beta/control.proto +1 -1
- package/build/protos/google/cloud/discoveryengine/v1beta/conversational_search_service.proto +3 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/custom_tuning_model.proto +3 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/document.proto +20 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/document_processing_config.proto +2 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/document_service.proto +114 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/grounded_generation_service.proto +2 -1
- package/build/protos/google/cloud/discoveryengine/v1beta/import_config.proto +13 -7
- package/build/protos/google/cloud/discoveryengine/v1beta/purge_config.proto +44 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/search_service.proto +101 -6
- package/build/protos/google/cloud/discoveryengine/v1beta/user_event.proto +4 -0
- package/build/protos/protos.d.ts +24137 -16126
- package/build/protos/protos.js +78286 -58223
- package/build/protos/protos.json +1954 -105
- package/build/src/index.d.ts +4 -1
- package/build/src/index.js +4 -1
- package/build/src/v1/completion_service_client.d.ts +93 -0
- package/build/src/v1/completion_service_client.js +134 -0
- package/build/src/v1/control_service_client.d.ts +93 -0
- package/build/src/v1/control_service_client.js +128 -0
- package/build/src/v1/conversational_search_service_client.d.ts +93 -0
- package/build/src/v1/conversational_search_service_client.js +128 -0
- package/build/src/v1/data_store_service_client.d.ts +102 -0
- package/build/src/v1/data_store_service_client.js +134 -0
- package/build/src/v1/document_service_client.d.ts +131 -0
- package/build/src/v1/document_service_client.js +156 -0
- package/build/src/v1/document_service_client_config.json +5 -0
- package/build/src/v1/engine_service_client.d.ts +93 -0
- package/build/src/v1/engine_service_client.js +134 -0
- package/build/src/v1/grounded_generation_service_client.d.ts +93 -0
- package/build/src/v1/grounded_generation_service_client.js +128 -0
- package/build/src/v1/index.d.ts +1 -0
- package/build/src/v1/index.js +3 -1
- package/build/src/v1/project_service_client.d.ts +93 -0
- package/build/src/v1/project_service_client.js +134 -0
- package/build/src/v1/rank_service_client.d.ts +93 -0
- package/build/src/v1/rank_service_client.js +128 -0
- package/build/src/v1/recommendation_service_client.d.ts +95 -1
- package/build/src/v1/recommendation_service_client.js +128 -0
- package/build/src/v1/schema_service_client.d.ts +93 -0
- package/build/src/v1/schema_service_client.js +134 -0
- package/build/src/v1/search_service_client.d.ts +111 -9
- package/build/src/v1/search_service_client.js +140 -6
- package/build/src/v1/search_tuning_service_client.d.ts +1776 -0
- package/build/src/v1/search_tuning_service_client.js +2589 -0
- package/build/src/v1/search_tuning_service_client_config.json +34 -0
- package/build/src/v1/site_search_engine_service_client.d.ts +93 -0
- package/build/src/v1/site_search_engine_service_client.js +134 -0
- package/build/src/v1/user_event_service_client.d.ts +168 -0
- package/build/src/v1/user_event_service_client.js +176 -0
- package/build/src/v1/user_event_service_client_config.json +5 -0
- package/build/src/v1alpha/acl_config_service_client.d.ts +1 -1
- package/build/src/v1alpha/completion_service_client.d.ts +91 -0
- package/build/src/v1alpha/completion_service_client.js +90 -0
- package/build/src/v1alpha/completion_service_client_config.json +10 -0
- package/build/src/v1alpha/conversational_search_service_client.d.ts +18 -0
- package/build/src/v1alpha/data_store_service_client.d.ts +12 -3
- package/build/src/v1alpha/data_store_service_client.js +8 -2
- package/build/src/v1alpha/document_service_client.d.ts +33 -0
- package/build/src/v1alpha/document_service_client.js +28 -0
- package/build/src/v1alpha/document_service_client_config.json +5 -0
- package/build/src/v1alpha/engine_service_client.js +6 -0
- package/build/src/v1alpha/estimate_billing_service_client.js +6 -0
- package/build/src/v1alpha/evaluation_service_client.js +6 -0
- package/build/src/v1alpha/project_service_client.js +6 -0
- package/build/src/v1alpha/sample_query_service_client.js +6 -0
- package/build/src/v1alpha/schema_service_client.js +6 -0
- package/build/src/v1alpha/search_service_client.d.ts +219 -21
- package/build/src/v1alpha/search_service_client.js +146 -14
- package/build/src/v1alpha/search_tuning_service_client.js +6 -0
- package/build/src/v1alpha/site_search_engine_service_client.d.ts +101 -0
- package/build/src/v1alpha/site_search_engine_service_client.js +70 -0
- package/build/src/v1alpha/site_search_engine_service_client_config.json +8 -0
- package/build/src/v1alpha/user_event_service_client.js +6 -0
- package/build/src/v1beta/document_service_client.d.ts +38 -0
- package/build/src/v1beta/document_service_client.js +22 -0
- package/build/src/v1beta/document_service_client_config.json +5 -0
- package/build/src/v1beta/search_service_client.d.ts +36 -9
- package/build/src/v1beta/search_service_client.js +24 -6
- package/package.json +2 -2
@@ -417,15 +417,29 @@ class SearchServiceClient {
|
|
417
417
|
* object. Leave it unset if ordered by relevance. `order_by` expression is
|
418
418
|
* case-sensitive.
|
419
419
|
*
|
420
|
-
* For more information on ordering
|
421
|
-
* [
|
422
|
-
*
|
420
|
+
* For more information on ordering the website search results, see
|
421
|
+
* [Order web search
|
422
|
+
* results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results).
|
423
|
+
* For more information on ordering the healthcare search results, see
|
424
|
+
* [Order healthcare search
|
425
|
+
* results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results).
|
423
426
|
* If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
|
424
427
|
* @param {google.cloud.discoveryengine.v1alpha.UserInfo} request.userInfo
|
425
428
|
* Information about the end user.
|
426
429
|
* Highly recommended for analytics.
|
427
430
|
* {@link protos.google.cloud.discoveryengine.v1alpha.UserInfo.user_agent|UserInfo.user_agent}
|
428
431
|
* is used to deduce `device_type` for analytics.
|
432
|
+
* @param {string} request.languageCode
|
433
|
+
* The BCP-47 language code, such as "en-US" or "sr-Latn". For more
|
434
|
+
* information, see [Standard
|
435
|
+
* fields](https://cloud.google.com/apis/design/standard_fields). This field
|
436
|
+
* helps to better interpret the query. If a value isn't specified, the query
|
437
|
+
* language code is automatically detected, which may not be accurate.
|
438
|
+
* @param {string} request.regionCode
|
439
|
+
* The Unicode country/region code (CLDR) of a location, such as "US" and
|
440
|
+
* "419". For more information, see [Standard
|
441
|
+
* fields](https://cloud.google.com/apis/design/standard_fields). If set,
|
442
|
+
* then results will be boosted based on the region_code provided.
|
429
443
|
* @param {number[]} request.facetSpecs
|
430
444
|
* Facet specifications for faceted search. If empty, no facets are returned.
|
431
445
|
*
|
@@ -490,20 +504,26 @@ class SearchServiceClient {
|
|
490
504
|
* documents. This overrides
|
491
505
|
* {@link protos.google.cloud.discoveryengine.v1alpha.ServingConfig.ranking_expression|ServingConfig.ranking_expression}.
|
492
506
|
* The ranking expression is a single function or multiple functions that are
|
493
|
-
*
|
507
|
+
* joined by "+".
|
508
|
+
*
|
494
509
|
* * ranking_expression = function, { " + ", function };
|
510
|
+
*
|
495
511
|
* Supported functions:
|
512
|
+
*
|
496
513
|
* * double * relevance_score
|
497
514
|
* * double * dotProduct(embedding_field_path)
|
515
|
+
*
|
498
516
|
* Function variables:
|
499
|
-
*
|
517
|
+
*
|
518
|
+
* * `relevance_score`: pre-defined keywords, used for measure relevance
|
500
519
|
* between query and document.
|
501
|
-
* `embedding_field_path`: the document embedding field
|
520
|
+
* * `embedding_field_path`: the document embedding field
|
502
521
|
* used with query embedding vector.
|
503
|
-
* `dotProduct`: embedding function between embedding_field_path and query
|
522
|
+
* * `dotProduct`: embedding function between embedding_field_path and query
|
504
523
|
* embedding vector.
|
505
524
|
*
|
506
525
|
* Example ranking expression:
|
526
|
+
*
|
507
527
|
* If document has an embedding field doc_embedding, the ranking expression
|
508
528
|
* could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
|
509
529
|
* @param {boolean} request.safeSearch
|
@@ -527,8 +547,54 @@ class SearchServiceClient {
|
|
527
547
|
* See [Google Cloud
|
528
548
|
* Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
|
529
549
|
* for more details.
|
550
|
+
* @param {google.cloud.discoveryengine.v1alpha.SearchRequest.NaturalLanguageQueryUnderstandingSpec} request.naturalLanguageQueryUnderstandingSpec
|
551
|
+
* If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional
|
552
|
+
* natural language query understanding will be done.
|
553
|
+
* @param {google.cloud.discoveryengine.v1alpha.SearchRequest.SearchAsYouTypeSpec} request.searchAsYouTypeSpec
|
554
|
+
* Search as you type configuration. Only supported for the
|
555
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.IndustryVertical.MEDIA|IndustryVertical.MEDIA}
|
556
|
+
* vertical.
|
530
557
|
* @param {google.cloud.discoveryengine.v1alpha.CustomFineTuningSpec} request.customFineTuningSpec
|
531
558
|
* Custom fine tuning configs.
|
559
|
+
* If set, it has higher priority than the configs set in
|
560
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.ServingConfig.custom_fine_tuning_spec|ServingConfig.custom_fine_tuning_spec}.
|
561
|
+
* @param {string} request.session
|
562
|
+
* The session resource name. Optional.
|
563
|
+
*
|
564
|
+
* Session allows users to do multi-turn /search API calls or coordination
|
565
|
+
* between /search API calls and /answer API calls.
|
566
|
+
*
|
567
|
+
* Example #1 (multi-turn /search API calls):
|
568
|
+
* 1. Call /search API with the auto-session mode (see below).
|
569
|
+
* 2. Call /search API with the session ID generated in the first call.
|
570
|
+
* Here, the previous search query gets considered in query
|
571
|
+
* standing. I.e., if the first query is "How did Alphabet do in 2022?"
|
572
|
+
* and the current query is "How about 2023?", the current query will
|
573
|
+
* be interpreted as "How did Alphabet do in 2023?".
|
574
|
+
*
|
575
|
+
* Example #2 (coordination between /search API calls and /answer API calls):
|
576
|
+
* 1. Call /search API with the auto-session mode (see below).
|
577
|
+
* 2. Call /answer API with the session ID generated in the first call.
|
578
|
+
* Here, the answer generation happens in the context of the search
|
579
|
+
* results from the first search call.
|
580
|
+
*
|
581
|
+
* Auto-session mode: when `projects/.../sessions/-` is used, a new session
|
582
|
+
* gets automatically created. Otherwise, users can use the create-session API
|
583
|
+
* to create a session manually.
|
584
|
+
*
|
585
|
+
* Multi-turn Search feature is currently at private GA stage. Please use
|
586
|
+
* v1alpha or v1beta version instead before we launch this feature to public
|
587
|
+
* GA. Or ask for allowlisting through Google Support team.
|
588
|
+
* @param {google.cloud.discoveryengine.v1alpha.SearchRequest.SessionSpec} request.sessionSpec
|
589
|
+
* Session specification.
|
590
|
+
*
|
591
|
+
* Can be used only when `session` is set.
|
592
|
+
* @param {google.cloud.discoveryengine.v1alpha.SearchRequest.RelevanceThreshold} request.relevanceThreshold
|
593
|
+
* The relevance threshold of the search results.
|
594
|
+
*
|
595
|
+
* Default to Google defined threshold, leveraging a balance of
|
596
|
+
* precision and recall to deliver both highly accurate results and
|
597
|
+
* comprehensive coverage of relevant information.
|
532
598
|
* @param {object} [options]
|
533
599
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
534
600
|
* @returns {Stream}
|
@@ -647,15 +713,29 @@ class SearchServiceClient {
|
|
647
713
|
* object. Leave it unset if ordered by relevance. `order_by` expression is
|
648
714
|
* case-sensitive.
|
649
715
|
*
|
650
|
-
* For more information on ordering
|
651
|
-
* [
|
652
|
-
*
|
716
|
+
* For more information on ordering the website search results, see
|
717
|
+
* [Order web search
|
718
|
+
* results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results).
|
719
|
+
* For more information on ordering the healthcare search results, see
|
720
|
+
* [Order healthcare search
|
721
|
+
* results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results).
|
653
722
|
* If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
|
654
723
|
* @param {google.cloud.discoveryengine.v1alpha.UserInfo} request.userInfo
|
655
724
|
* Information about the end user.
|
656
725
|
* Highly recommended for analytics.
|
657
726
|
* {@link protos.google.cloud.discoveryengine.v1alpha.UserInfo.user_agent|UserInfo.user_agent}
|
658
727
|
* is used to deduce `device_type` for analytics.
|
728
|
+
* @param {string} request.languageCode
|
729
|
+
* The BCP-47 language code, such as "en-US" or "sr-Latn". For more
|
730
|
+
* information, see [Standard
|
731
|
+
* fields](https://cloud.google.com/apis/design/standard_fields). This field
|
732
|
+
* helps to better interpret the query. If a value isn't specified, the query
|
733
|
+
* language code is automatically detected, which may not be accurate.
|
734
|
+
* @param {string} request.regionCode
|
735
|
+
* The Unicode country/region code (CLDR) of a location, such as "US" and
|
736
|
+
* "419". For more information, see [Standard
|
737
|
+
* fields](https://cloud.google.com/apis/design/standard_fields). If set,
|
738
|
+
* then results will be boosted based on the region_code provided.
|
659
739
|
* @param {number[]} request.facetSpecs
|
660
740
|
* Facet specifications for faceted search. If empty, no facets are returned.
|
661
741
|
*
|
@@ -720,20 +800,26 @@ class SearchServiceClient {
|
|
720
800
|
* documents. This overrides
|
721
801
|
* {@link protos.google.cloud.discoveryengine.v1alpha.ServingConfig.ranking_expression|ServingConfig.ranking_expression}.
|
722
802
|
* The ranking expression is a single function or multiple functions that are
|
723
|
-
*
|
803
|
+
* joined by "+".
|
804
|
+
*
|
724
805
|
* * ranking_expression = function, { " + ", function };
|
806
|
+
*
|
725
807
|
* Supported functions:
|
808
|
+
*
|
726
809
|
* * double * relevance_score
|
727
810
|
* * double * dotProduct(embedding_field_path)
|
811
|
+
*
|
728
812
|
* Function variables:
|
729
|
-
*
|
813
|
+
*
|
814
|
+
* * `relevance_score`: pre-defined keywords, used for measure relevance
|
730
815
|
* between query and document.
|
731
|
-
* `embedding_field_path`: the document embedding field
|
816
|
+
* * `embedding_field_path`: the document embedding field
|
732
817
|
* used with query embedding vector.
|
733
|
-
* `dotProduct`: embedding function between embedding_field_path and query
|
818
|
+
* * `dotProduct`: embedding function between embedding_field_path and query
|
734
819
|
* embedding vector.
|
735
820
|
*
|
736
821
|
* Example ranking expression:
|
822
|
+
*
|
737
823
|
* If document has an embedding field doc_embedding, the ranking expression
|
738
824
|
* could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
|
739
825
|
* @param {boolean} request.safeSearch
|
@@ -757,8 +843,54 @@ class SearchServiceClient {
|
|
757
843
|
* See [Google Cloud
|
758
844
|
* Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
|
759
845
|
* for more details.
|
846
|
+
* @param {google.cloud.discoveryengine.v1alpha.SearchRequest.NaturalLanguageQueryUnderstandingSpec} request.naturalLanguageQueryUnderstandingSpec
|
847
|
+
* If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional
|
848
|
+
* natural language query understanding will be done.
|
849
|
+
* @param {google.cloud.discoveryengine.v1alpha.SearchRequest.SearchAsYouTypeSpec} request.searchAsYouTypeSpec
|
850
|
+
* Search as you type configuration. Only supported for the
|
851
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.IndustryVertical.MEDIA|IndustryVertical.MEDIA}
|
852
|
+
* vertical.
|
760
853
|
* @param {google.cloud.discoveryengine.v1alpha.CustomFineTuningSpec} request.customFineTuningSpec
|
761
854
|
* Custom fine tuning configs.
|
855
|
+
* If set, it has higher priority than the configs set in
|
856
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.ServingConfig.custom_fine_tuning_spec|ServingConfig.custom_fine_tuning_spec}.
|
857
|
+
* @param {string} request.session
|
858
|
+
* The session resource name. Optional.
|
859
|
+
*
|
860
|
+
* Session allows users to do multi-turn /search API calls or coordination
|
861
|
+
* between /search API calls and /answer API calls.
|
862
|
+
*
|
863
|
+
* Example #1 (multi-turn /search API calls):
|
864
|
+
* 1. Call /search API with the auto-session mode (see below).
|
865
|
+
* 2. Call /search API with the session ID generated in the first call.
|
866
|
+
* Here, the previous search query gets considered in query
|
867
|
+
* standing. I.e., if the first query is "How did Alphabet do in 2022?"
|
868
|
+
* and the current query is "How about 2023?", the current query will
|
869
|
+
* be interpreted as "How did Alphabet do in 2023?".
|
870
|
+
*
|
871
|
+
* Example #2 (coordination between /search API calls and /answer API calls):
|
872
|
+
* 1. Call /search API with the auto-session mode (see below).
|
873
|
+
* 2. Call /answer API with the session ID generated in the first call.
|
874
|
+
* Here, the answer generation happens in the context of the search
|
875
|
+
* results from the first search call.
|
876
|
+
*
|
877
|
+
* Auto-session mode: when `projects/.../sessions/-` is used, a new session
|
878
|
+
* gets automatically created. Otherwise, users can use the create-session API
|
879
|
+
* to create a session manually.
|
880
|
+
*
|
881
|
+
* Multi-turn Search feature is currently at private GA stage. Please use
|
882
|
+
* v1alpha or v1beta version instead before we launch this feature to public
|
883
|
+
* GA. Or ask for allowlisting through Google Support team.
|
884
|
+
* @param {google.cloud.discoveryengine.v1alpha.SearchRequest.SessionSpec} request.sessionSpec
|
885
|
+
* Session specification.
|
886
|
+
*
|
887
|
+
* Can be used only when `session` is set.
|
888
|
+
* @param {google.cloud.discoveryengine.v1alpha.SearchRequest.RelevanceThreshold} request.relevanceThreshold
|
889
|
+
* The relevance threshold of the search results.
|
890
|
+
*
|
891
|
+
* Default to Google defined threshold, leveraging a balance of
|
892
|
+
* precision and recall to deliver both highly accurate results and
|
893
|
+
* comprehensive coverage of relevant information.
|
762
894
|
* @param {object} [options]
|
763
895
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
764
896
|
* @returns {Object}
|
@@ -249,6 +249,9 @@ class SearchTuningServiceClient {
|
|
249
249
|
{
|
250
250
|
get: '/v1alpha/{name=projects/*/locations/*/evaluations/*/operations/*}',
|
251
251
|
},
|
252
|
+
{
|
253
|
+
get: '/v1alpha/{name=projects/*/locations/*/identity_mapping_stores/*/operations/*}',
|
254
|
+
},
|
252
255
|
{ get: '/v1alpha/{name=projects/*/locations/*/operations/*}' },
|
253
256
|
{
|
254
257
|
get: '/v1alpha/{name=projects/*/locations/*/sampleQuerySets/*/operations/*}',
|
@@ -293,6 +296,9 @@ class SearchTuningServiceClient {
|
|
293
296
|
{
|
294
297
|
get: '/v1alpha/{name=projects/*/locations/*/dataStores/*}/operations',
|
295
298
|
},
|
299
|
+
{
|
300
|
+
get: '/v1alpha/{name=projects/*/locations/*/identity_mapping_stores/*}/operations',
|
301
|
+
},
|
296
302
|
{ get: '/v1alpha/{name=projects/*/locations/*}/operations' },
|
297
303
|
{ get: '/v1alpha/{name=projects/*}/operations' },
|
298
304
|
],
|
@@ -180,6 +180,33 @@ export declare class SiteSearchEngineServiceClient {
|
|
180
180
|
]>;
|
181
181
|
getTargetSite(request: protos.google.cloud.discoveryengine.v1alpha.IGetTargetSiteRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.ITargetSite, protos.google.cloud.discoveryengine.v1alpha.IGetTargetSiteRequest | null | undefined, {} | null | undefined>): void;
|
182
182
|
getTargetSite(request: protos.google.cloud.discoveryengine.v1alpha.IGetTargetSiteRequest, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.ITargetSite, protos.google.cloud.discoveryengine.v1alpha.IGetTargetSiteRequest | null | undefined, {} | null | undefined>): void;
|
183
|
+
/**
|
184
|
+
* Gets the URI Pattern to Document data mapping for an Advanced Site Search
|
185
|
+
* DataStore.
|
186
|
+
*
|
187
|
+
* @param {Object} request
|
188
|
+
* The request object that will be sent.
|
189
|
+
* @param {string} request.siteSearchEngine
|
190
|
+
* Required. Full resource name of the
|
191
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.SiteSearchEngine|SiteSearchEngine},
|
192
|
+
* such as
|
193
|
+
* `projects/* /locations/* /collections/* /dataStores/* /siteSearchEngine`.
|
194
|
+
* @param {object} [options]
|
195
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
196
|
+
* @returns {Promise} - The promise which resolves to an array.
|
197
|
+
* The first element of the array is an object representing {@link protos.google.cloud.discoveryengine.v1alpha.GetUriPatternDocumentDataResponse|GetUriPatternDocumentDataResponse}.
|
198
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
199
|
+
* for more details and examples.
|
200
|
+
* @example <caption>include:samples/generated/v1alpha/site_search_engine_service.get_uri_pattern_document_data.js</caption>
|
201
|
+
* region_tag:discoveryengine_v1alpha_generated_SiteSearchEngineService_GetUriPatternDocumentData_async
|
202
|
+
*/
|
203
|
+
getUriPatternDocumentData(request?: protos.google.cloud.discoveryengine.v1alpha.IGetUriPatternDocumentDataRequest, options?: CallOptions): Promise<[
|
204
|
+
protos.google.cloud.discoveryengine.v1alpha.IGetUriPatternDocumentDataResponse,
|
205
|
+
(protos.google.cloud.discoveryengine.v1alpha.IGetUriPatternDocumentDataRequest | undefined),
|
206
|
+
{} | undefined
|
207
|
+
]>;
|
208
|
+
getUriPatternDocumentData(request: protos.google.cloud.discoveryengine.v1alpha.IGetUriPatternDocumentDataRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IGetUriPatternDocumentDataResponse, protos.google.cloud.discoveryengine.v1alpha.IGetUriPatternDocumentDataRequest | null | undefined, {} | null | undefined>): void;
|
209
|
+
getUriPatternDocumentData(request: protos.google.cloud.discoveryengine.v1alpha.IGetUriPatternDocumentDataRequest, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IGetUriPatternDocumentDataResponse, protos.google.cloud.discoveryengine.v1alpha.IGetUriPatternDocumentDataRequest | null | undefined, {} | null | undefined>): void;
|
183
210
|
/**
|
184
211
|
* Creates a {@link protos.google.cloud.discoveryengine.v1alpha.TargetSite|TargetSite}.
|
185
212
|
*
|
@@ -521,6 +548,80 @@ export declare class SiteSearchEngineServiceClient {
|
|
521
548
|
* region_tag:discoveryengine_v1alpha_generated_SiteSearchEngineService_BatchVerifyTargetSites_async
|
522
549
|
*/
|
523
550
|
checkBatchVerifyTargetSitesProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1alpha.BatchVerifyTargetSitesResponse, protos.google.cloud.discoveryengine.v1alpha.BatchVerifyTargetSitesMetadata>>;
|
551
|
+
/**
|
552
|
+
* Sets the URI Pattern to Document data mapping for an Advanced Site Search
|
553
|
+
* DataStore.
|
554
|
+
*
|
555
|
+
* @param {Object} request
|
556
|
+
* The request object that will be sent.
|
557
|
+
* @param {string} request.siteSearchEngine
|
558
|
+
* Required. Full resource name of the
|
559
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.SiteSearchEngine|SiteSearchEngine},
|
560
|
+
* such as
|
561
|
+
* `projects/* /locations/* /collections/* /dataStores/* /siteSearchEngine`.
|
562
|
+
* @param {number[]} request.documentDataMap
|
563
|
+
* Document data keyed by URI pattern. Each entry must be consistent with
|
564
|
+
* the {@link protos.google.cloud.discoveryengine.v1alpha.Schema|Schema}. For example:
|
565
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.Schema|Schema} = {
|
566
|
+
* "type": "object",
|
567
|
+
* "properties": {
|
568
|
+
* "Categories": {
|
569
|
+
* "type": "array",
|
570
|
+
* "items": {
|
571
|
+
* "retrievable": true,
|
572
|
+
* "type": "string"
|
573
|
+
* }
|
574
|
+
* }
|
575
|
+
* }
|
576
|
+
*
|
577
|
+
* document_data_map = {
|
578
|
+
* "www.url1.com/*": {
|
579
|
+
* "Categories": ["category1", "category2"]
|
580
|
+
* },
|
581
|
+
* "www.url2.com/*": {
|
582
|
+
* "Categories": ["category3"]
|
583
|
+
* }
|
584
|
+
* }
|
585
|
+
* @param {boolean} request.emptyDocumentDataMap
|
586
|
+
* If true, clears the document data map. If true,
|
587
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.SetUriPatternDocumentDataRequest.document_data_map|SetUriPatternDocumentDataRequest.document_data_map}
|
588
|
+
* must be empty.
|
589
|
+
* @param {google.protobuf.Struct} request.schema
|
590
|
+
* Optional. If not provided, the current
|
591
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.Schema|Schema} is used. If provided,
|
592
|
+
* validates and updates the
|
593
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.Schema|Schema}. If validation fails,
|
594
|
+
* an error is returned.
|
595
|
+
* @param {object} [options]
|
596
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
597
|
+
* @returns {Promise} - The promise which resolves to an array.
|
598
|
+
* The first element of the array is an object representing
|
599
|
+
* a long running operation. Its `promise()` method returns a promise
|
600
|
+
* you can `await` for.
|
601
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
|
602
|
+
* for more details and examples.
|
603
|
+
* @example <caption>include:samples/generated/v1alpha/site_search_engine_service.set_uri_pattern_document_data.js</caption>
|
604
|
+
* region_tag:discoveryengine_v1alpha_generated_SiteSearchEngineService_SetUriPatternDocumentData_async
|
605
|
+
*/
|
606
|
+
setUriPatternDocumentData(request?: protos.google.cloud.discoveryengine.v1alpha.ISetUriPatternDocumentDataRequest, options?: CallOptions): Promise<[
|
607
|
+
LROperation<protos.google.cloud.discoveryengine.v1alpha.ISetUriPatternDocumentDataResponse, protos.google.cloud.discoveryengine.v1alpha.ISetUriPatternDocumentDataMetadata>,
|
608
|
+
protos.google.longrunning.IOperation | undefined,
|
609
|
+
{} | undefined
|
610
|
+
]>;
|
611
|
+
setUriPatternDocumentData(request: protos.google.cloud.discoveryengine.v1alpha.ISetUriPatternDocumentDataRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1alpha.ISetUriPatternDocumentDataResponse, protos.google.cloud.discoveryengine.v1alpha.ISetUriPatternDocumentDataMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
|
612
|
+
setUriPatternDocumentData(request: protos.google.cloud.discoveryengine.v1alpha.ISetUriPatternDocumentDataRequest, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1alpha.ISetUriPatternDocumentDataResponse, protos.google.cloud.discoveryengine.v1alpha.ISetUriPatternDocumentDataMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
|
613
|
+
/**
|
614
|
+
* Check the status of the long running operation returned by `setUriPatternDocumentData()`.
|
615
|
+
* @param {String} name
|
616
|
+
* The operation name that will be passed.
|
617
|
+
* @returns {Promise} - The promise which resolves to an object.
|
618
|
+
* The decoded operation object has result and metadata field to get information from.
|
619
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
|
620
|
+
* for more details and examples.
|
621
|
+
* @example <caption>include:samples/generated/v1alpha/site_search_engine_service.set_uri_pattern_document_data.js</caption>
|
622
|
+
* region_tag:discoveryengine_v1alpha_generated_SiteSearchEngineService_SetUriPatternDocumentData_async
|
623
|
+
*/
|
624
|
+
checkSetUriPatternDocumentDataProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1alpha.SetUriPatternDocumentDataResponse, protos.google.cloud.discoveryengine.v1alpha.SetUriPatternDocumentDataMetadata>>;
|
524
625
|
/**
|
525
626
|
* Gets a list of
|
526
627
|
* {@link protos.google.cloud.discoveryengine.v1alpha.TargetSite|TargetSite}s.
|
@@ -257,6 +257,9 @@ class SiteSearchEngineServiceClient {
|
|
257
257
|
{
|
258
258
|
get: '/v1alpha/{name=projects/*/locations/*/evaluations/*/operations/*}',
|
259
259
|
},
|
260
|
+
{
|
261
|
+
get: '/v1alpha/{name=projects/*/locations/*/identity_mapping_stores/*/operations/*}',
|
262
|
+
},
|
260
263
|
{ get: '/v1alpha/{name=projects/*/locations/*/operations/*}' },
|
261
264
|
{
|
262
265
|
get: '/v1alpha/{name=projects/*/locations/*/sampleQuerySets/*/operations/*}',
|
@@ -301,6 +304,9 @@ class SiteSearchEngineServiceClient {
|
|
301
304
|
{
|
302
305
|
get: '/v1alpha/{name=projects/*/locations/*/dataStores/*}/operations',
|
303
306
|
},
|
307
|
+
{
|
308
|
+
get: '/v1alpha/{name=projects/*/locations/*/identity_mapping_stores/*}/operations',
|
309
|
+
},
|
304
310
|
{ get: '/v1alpha/{name=projects/*/locations/*}/operations' },
|
305
311
|
{ get: '/v1alpha/{name=projects/*}/operations' },
|
306
312
|
],
|
@@ -326,6 +332,8 @@ class SiteSearchEngineServiceClient {
|
|
326
332
|
const recrawlUrisMetadata = protoFilesRoot.lookup('.google.cloud.discoveryengine.v1alpha.RecrawlUrisMetadata');
|
327
333
|
const batchVerifyTargetSitesResponse = protoFilesRoot.lookup('.google.cloud.discoveryengine.v1alpha.BatchVerifyTargetSitesResponse');
|
328
334
|
const batchVerifyTargetSitesMetadata = protoFilesRoot.lookup('.google.cloud.discoveryengine.v1alpha.BatchVerifyTargetSitesMetadata');
|
335
|
+
const setUriPatternDocumentDataResponse = protoFilesRoot.lookup('.google.cloud.discoveryengine.v1alpha.SetUriPatternDocumentDataResponse');
|
336
|
+
const setUriPatternDocumentDataMetadata = protoFilesRoot.lookup('.google.cloud.discoveryengine.v1alpha.SetUriPatternDocumentDataMetadata');
|
329
337
|
this.descriptors.longrunning = {
|
330
338
|
createTargetSite: new this._gaxModule.LongrunningDescriptor(this.operationsClient, createTargetSiteResponse.decode.bind(createTargetSiteResponse), createTargetSiteMetadata.decode.bind(createTargetSiteMetadata)),
|
331
339
|
batchCreateTargetSites: new this._gaxModule.LongrunningDescriptor(this.operationsClient, batchCreateTargetSitesResponse.decode.bind(batchCreateTargetSitesResponse), batchCreateTargetSitesMetadata.decode.bind(batchCreateTargetSitesMetadata)),
|
@@ -335,6 +343,7 @@ class SiteSearchEngineServiceClient {
|
|
335
343
|
disableAdvancedSiteSearch: new this._gaxModule.LongrunningDescriptor(this.operationsClient, disableAdvancedSiteSearchResponse.decode.bind(disableAdvancedSiteSearchResponse), disableAdvancedSiteSearchMetadata.decode.bind(disableAdvancedSiteSearchMetadata)),
|
336
344
|
recrawlUris: new this._gaxModule.LongrunningDescriptor(this.operationsClient, recrawlUrisResponse.decode.bind(recrawlUrisResponse), recrawlUrisMetadata.decode.bind(recrawlUrisMetadata)),
|
337
345
|
batchVerifyTargetSites: new this._gaxModule.LongrunningDescriptor(this.operationsClient, batchVerifyTargetSitesResponse.decode.bind(batchVerifyTargetSitesResponse), batchVerifyTargetSitesMetadata.decode.bind(batchVerifyTargetSitesMetadata)),
|
346
|
+
setUriPatternDocumentData: new this._gaxModule.LongrunningDescriptor(this.operationsClient, setUriPatternDocumentDataResponse.decode.bind(setUriPatternDocumentDataResponse), setUriPatternDocumentDataMetadata.decode.bind(setUriPatternDocumentDataMetadata)),
|
338
347
|
};
|
339
348
|
// Put together the default options sent with requests.
|
340
349
|
this._defaults = this._gaxGrpc.constructSettings('google.cloud.discoveryengine.v1alpha.SiteSearchEngineService', gapicConfig, opts.clientConfig || {}, { 'x-goog-api-client': clientHeader.join(' ') });
|
@@ -383,6 +392,8 @@ class SiteSearchEngineServiceClient {
|
|
383
392
|
'recrawlUris',
|
384
393
|
'batchVerifyTargetSites',
|
385
394
|
'fetchDomainVerificationStatus',
|
395
|
+
'setUriPatternDocumentData',
|
396
|
+
'getUriPatternDocumentData',
|
386
397
|
];
|
387
398
|
for (const methodName of siteSearchEngineServiceStubMethods) {
|
388
399
|
const callPromise = this.siteSearchEngineServiceStub.then(stub => (...args) => {
|
@@ -504,6 +515,27 @@ class SiteSearchEngineServiceClient {
|
|
504
515
|
this.initialize();
|
505
516
|
return this.innerApiCalls.getTargetSite(request, options, callback);
|
506
517
|
}
|
518
|
+
getUriPatternDocumentData(request, optionsOrCallback, callback) {
|
519
|
+
var _a;
|
520
|
+
request = request || {};
|
521
|
+
let options;
|
522
|
+
if (typeof optionsOrCallback === 'function' && callback === undefined) {
|
523
|
+
callback = optionsOrCallback;
|
524
|
+
options = {};
|
525
|
+
}
|
526
|
+
else {
|
527
|
+
options = optionsOrCallback;
|
528
|
+
}
|
529
|
+
options = options || {};
|
530
|
+
options.otherArgs = options.otherArgs || {};
|
531
|
+
options.otherArgs.headers = options.otherArgs.headers || {};
|
532
|
+
options.otherArgs.headers['x-goog-request-params'] =
|
533
|
+
this._gaxModule.routingHeader.fromParams({
|
534
|
+
site_search_engine: (_a = request.siteSearchEngine) !== null && _a !== void 0 ? _a : '',
|
535
|
+
});
|
536
|
+
this.initialize();
|
537
|
+
return this.innerApiCalls.getUriPatternDocumentData(request, options, callback);
|
538
|
+
}
|
507
539
|
createTargetSite(request, optionsOrCallback, callback) {
|
508
540
|
var _a;
|
509
541
|
request = request || {};
|
@@ -808,6 +840,44 @@ class SiteSearchEngineServiceClient {
|
|
808
840
|
const decodeOperation = new this._gaxModule.Operation(operation, this.descriptors.longrunning.batchVerifyTargetSites, this._gaxModule.createDefaultBackoffSettings());
|
809
841
|
return decodeOperation;
|
810
842
|
}
|
843
|
+
setUriPatternDocumentData(request, optionsOrCallback, callback) {
|
844
|
+
var _a;
|
845
|
+
request = request || {};
|
846
|
+
let options;
|
847
|
+
if (typeof optionsOrCallback === 'function' && callback === undefined) {
|
848
|
+
callback = optionsOrCallback;
|
849
|
+
options = {};
|
850
|
+
}
|
851
|
+
else {
|
852
|
+
options = optionsOrCallback;
|
853
|
+
}
|
854
|
+
options = options || {};
|
855
|
+
options.otherArgs = options.otherArgs || {};
|
856
|
+
options.otherArgs.headers = options.otherArgs.headers || {};
|
857
|
+
options.otherArgs.headers['x-goog-request-params'] =
|
858
|
+
this._gaxModule.routingHeader.fromParams({
|
859
|
+
site_search_engine: (_a = request.siteSearchEngine) !== null && _a !== void 0 ? _a : '',
|
860
|
+
});
|
861
|
+
this.initialize();
|
862
|
+
return this.innerApiCalls.setUriPatternDocumentData(request, options, callback);
|
863
|
+
}
|
864
|
+
/**
|
865
|
+
* Check the status of the long running operation returned by `setUriPatternDocumentData()`.
|
866
|
+
* @param {String} name
|
867
|
+
* The operation name that will be passed.
|
868
|
+
* @returns {Promise} - The promise which resolves to an object.
|
869
|
+
* The decoded operation object has result and metadata field to get information from.
|
870
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
|
871
|
+
* for more details and examples.
|
872
|
+
* @example <caption>include:samples/generated/v1alpha/site_search_engine_service.set_uri_pattern_document_data.js</caption>
|
873
|
+
* region_tag:discoveryengine_v1alpha_generated_SiteSearchEngineService_SetUriPatternDocumentData_async
|
874
|
+
*/
|
875
|
+
async checkSetUriPatternDocumentDataProgress(name) {
|
876
|
+
const request = new this._gaxModule.operationsProtos.google.longrunning.GetOperationRequest({ name });
|
877
|
+
const [operation] = await this.operationsClient.getOperation(request);
|
878
|
+
const decodeOperation = new this._gaxModule.Operation(operation, this.descriptors.longrunning.setUriPatternDocumentData, this._gaxModule.createDefaultBackoffSettings());
|
879
|
+
return decodeOperation;
|
880
|
+
}
|
811
881
|
listTargetSites(request, optionsOrCallback, callback) {
|
812
882
|
var _a;
|
813
883
|
request = request || {};
|
@@ -67,6 +67,14 @@
|
|
67
67
|
"FetchDomainVerificationStatus": {
|
68
68
|
"retry_codes_name": "non_idempotent",
|
69
69
|
"retry_params_name": "default"
|
70
|
+
},
|
71
|
+
"SetUriPatternDocumentData": {
|
72
|
+
"retry_codes_name": "non_idempotent",
|
73
|
+
"retry_params_name": "default"
|
74
|
+
},
|
75
|
+
"GetUriPatternDocumentData": {
|
76
|
+
"retry_codes_name": "non_idempotent",
|
77
|
+
"retry_params_name": "default"
|
70
78
|
}
|
71
79
|
}
|
72
80
|
}
|
@@ -249,6 +249,9 @@ class UserEventServiceClient {
|
|
249
249
|
{
|
250
250
|
get: '/v1alpha/{name=projects/*/locations/*/evaluations/*/operations/*}',
|
251
251
|
},
|
252
|
+
{
|
253
|
+
get: '/v1alpha/{name=projects/*/locations/*/identity_mapping_stores/*/operations/*}',
|
254
|
+
},
|
252
255
|
{ get: '/v1alpha/{name=projects/*/locations/*/operations/*}' },
|
253
256
|
{
|
254
257
|
get: '/v1alpha/{name=projects/*/locations/*/sampleQuerySets/*/operations/*}',
|
@@ -293,6 +296,9 @@ class UserEventServiceClient {
|
|
293
296
|
{
|
294
297
|
get: '/v1alpha/{name=projects/*/locations/*/dataStores/*}/operations',
|
295
298
|
},
|
299
|
+
{
|
300
|
+
get: '/v1alpha/{name=projects/*/locations/*/identity_mapping_stores/*}/operations',
|
301
|
+
},
|
296
302
|
{ get: '/v1alpha/{name=projects/*/locations/*}/operations' },
|
297
303
|
{ get: '/v1alpha/{name=projects/*}/operations' },
|
298
304
|
],
|
@@ -266,6 +266,35 @@ export declare class DocumentServiceClient {
|
|
266
266
|
]>;
|
267
267
|
deleteDocument(request: protos.google.cloud.discoveryengine.v1beta.IDeleteDocumentRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.discoveryengine.v1beta.IDeleteDocumentRequest | null | undefined, {} | null | undefined>): void;
|
268
268
|
deleteDocument(request: protos.google.cloud.discoveryengine.v1beta.IDeleteDocumentRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.discoveryengine.v1beta.IDeleteDocumentRequest | null | undefined, {} | null | undefined>): void;
|
269
|
+
/**
|
270
|
+
* Gets index freshness metadata for
|
271
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}s. Supported for
|
272
|
+
* website search only.
|
273
|
+
*
|
274
|
+
* @param {Object} request
|
275
|
+
* The request object that will be sent.
|
276
|
+
* @param {string} request.parent
|
277
|
+
* Required. The parent branch resource name, such as
|
278
|
+
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
|
279
|
+
* @param {google.cloud.discoveryengine.v1beta.BatchGetDocumentsMetadataRequest.Matcher} request.matcher
|
280
|
+
* Required. Matcher for the
|
281
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}s.
|
282
|
+
* @param {object} [options]
|
283
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
284
|
+
* @returns {Promise} - The promise which resolves to an array.
|
285
|
+
* The first element of the array is an object representing {@link protos.google.cloud.discoveryengine.v1beta.BatchGetDocumentsMetadataResponse|BatchGetDocumentsMetadataResponse}.
|
286
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
287
|
+
* for more details and examples.
|
288
|
+
* @example <caption>include:samples/generated/v1beta/document_service.batch_get_documents_metadata.js</caption>
|
289
|
+
* region_tag:discoveryengine_v1beta_generated_DocumentService_BatchGetDocumentsMetadata_async
|
290
|
+
*/
|
291
|
+
batchGetDocumentsMetadata(request?: protos.google.cloud.discoveryengine.v1beta.IBatchGetDocumentsMetadataRequest, options?: CallOptions): Promise<[
|
292
|
+
protos.google.cloud.discoveryengine.v1beta.IBatchGetDocumentsMetadataResponse,
|
293
|
+
(protos.google.cloud.discoveryengine.v1beta.IBatchGetDocumentsMetadataRequest | undefined),
|
294
|
+
{} | undefined
|
295
|
+
]>;
|
296
|
+
batchGetDocumentsMetadata(request: protos.google.cloud.discoveryengine.v1beta.IBatchGetDocumentsMetadataRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1beta.IBatchGetDocumentsMetadataResponse, protos.google.cloud.discoveryengine.v1beta.IBatchGetDocumentsMetadataRequest | null | undefined, {} | null | undefined>): void;
|
297
|
+
batchGetDocumentsMetadata(request: protos.google.cloud.discoveryengine.v1beta.IBatchGetDocumentsMetadataRequest, callback: Callback<protos.google.cloud.discoveryengine.v1beta.IBatchGetDocumentsMetadataResponse, protos.google.cloud.discoveryengine.v1beta.IBatchGetDocumentsMetadataRequest | null | undefined, {} | null | undefined>): void;
|
269
298
|
/**
|
270
299
|
* Bulk import of multiple
|
271
300
|
* {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}s. Request
|
@@ -420,6 +449,13 @@ export declare class DocumentServiceClient {
|
|
420
449
|
*
|
421
450
|
* @param {Object} request
|
422
451
|
* The request object that will be sent.
|
452
|
+
* @param {google.cloud.discoveryengine.v1beta.GcsSource} request.gcsSource
|
453
|
+
* Cloud Storage location for the input content.
|
454
|
+
* Supported `data_schema`:
|
455
|
+
* * `document_id`: One valid
|
456
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.Document.id|Document.id} per line.
|
457
|
+
* @param {google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest.InlineSource} request.inlineSource
|
458
|
+
* Inline source for the input content for purge.
|
423
459
|
* @param {string} request.parent
|
424
460
|
* Required. The parent resource name, such as
|
425
461
|
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
|
@@ -427,6 +463,8 @@ export declare class DocumentServiceClient {
|
|
427
463
|
* Required. Filter matching documents to purge. Only currently supported
|
428
464
|
* value is
|
429
465
|
* `*` (all items).
|
466
|
+
* @param {google.cloud.discoveryengine.v1beta.PurgeErrorConfig} request.errorConfig
|
467
|
+
* The desired location of errors incurred during the purge.
|
430
468
|
* @param {boolean} request.force
|
431
469
|
* Actually performs the purge. If `force` is set to false, return the
|
432
470
|
* expected purge count without deleting any documents.
|
@@ -361,6 +361,7 @@ class DocumentServiceClient {
|
|
361
361
|
'deleteDocument',
|
362
362
|
'importDocuments',
|
363
363
|
'purgeDocuments',
|
364
|
+
'batchGetDocumentsMetadata',
|
364
365
|
];
|
365
366
|
for (const methodName of documentServiceStubMethods) {
|
366
367
|
const callPromise = this.documentServiceStub.then(stub => (...args) => {
|
@@ -524,6 +525,27 @@ class DocumentServiceClient {
|
|
524
525
|
this.initialize();
|
525
526
|
return this.innerApiCalls.deleteDocument(request, options, callback);
|
526
527
|
}
|
528
|
+
batchGetDocumentsMetadata(request, optionsOrCallback, callback) {
|
529
|
+
var _a;
|
530
|
+
request = request || {};
|
531
|
+
let options;
|
532
|
+
if (typeof optionsOrCallback === 'function' && callback === undefined) {
|
533
|
+
callback = optionsOrCallback;
|
534
|
+
options = {};
|
535
|
+
}
|
536
|
+
else {
|
537
|
+
options = optionsOrCallback;
|
538
|
+
}
|
539
|
+
options = options || {};
|
540
|
+
options.otherArgs = options.otherArgs || {};
|
541
|
+
options.otherArgs.headers = options.otherArgs.headers || {};
|
542
|
+
options.otherArgs.headers['x-goog-request-params'] =
|
543
|
+
this._gaxModule.routingHeader.fromParams({
|
544
|
+
parent: (_a = request.parent) !== null && _a !== void 0 ? _a : '',
|
545
|
+
});
|
546
|
+
this.initialize();
|
547
|
+
return this.innerApiCalls.batchGetDocumentsMetadata(request, options, callback);
|
548
|
+
}
|
527
549
|
importDocuments(request, optionsOrCallback, callback) {
|
528
550
|
var _a;
|
529
551
|
request = request || {};
|
@@ -75,6 +75,11 @@
|
|
75
75
|
"timeout_millis": 30000,
|
76
76
|
"retry_codes_name": "unavailable",
|
77
77
|
"retry_params_name": "ce5b960a6ed052e690863808e4f0deff3dc7d49f"
|
78
|
+
},
|
79
|
+
"BatchGetDocumentsMetadata": {
|
80
|
+
"timeout_millis": 30000,
|
81
|
+
"retry_codes_name": "unavailable",
|
82
|
+
"retry_params_name": "ce5b960a6ed052e690863808e4f0deff3dc7d49f"
|
78
83
|
}
|
79
84
|
}
|
80
85
|
}
|