@google-cloud/discoveryengine 1.10.0 → 1.12.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 +20 -0
- package/README.md +33 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/evaluation.proto +232 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/evaluation_service.proto +252 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/import_config.proto +83 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/sample_query.proto +86 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/sample_query_service.proto +264 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/sample_query_set.proto +64 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/sample_query_set_service.proto +258 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/answer.proto +14 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/chunk.proto +119 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/common.proto +0 -5
- package/build/protos/google/cloud/discoveryengine/v1beta/completion.proto +31 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/completion_service.proto +38 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/conversational_search_service.proto +29 -2
- package/build/protos/google/cloud/discoveryengine/v1beta/custom_tuning_model.proto +7 -1
- package/build/protos/google/cloud/discoveryengine/v1beta/data_store.proto +23 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/data_store_service.proto +10 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/document.proto +1 -1
- package/build/protos/google/cloud/discoveryengine/v1beta/document_processing_config.proto +37 -2
- package/build/protos/google/cloud/discoveryengine/v1beta/evaluation.proto +231 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/evaluation_service.proto +252 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/import_config.proto +191 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/purge_config.proto +111 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/sample_query.proto +86 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/sample_query_service.proto +264 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/sample_query_set.proto +64 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/sample_query_set_service.proto +256 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/search_service.proto +370 -8
- package/build/protos/google/cloud/discoveryengine/v1beta/serving_config.proto +11 -5
- package/build/protos/google/cloud/discoveryengine/v1beta/user_event_service.proto +24 -0
- package/build/protos/protos.d.ts +32735 -21073
- package/build/protos/protos.js +80768 -53241
- package/build/protos/protos.json +5309 -2481
- package/build/src/v1alpha/acl_config_service_client.d.ts +108 -0
- package/build/src/v1alpha/acl_config_service_client.js +157 -0
- package/build/src/v1alpha/chunk_service_client.d.ts +108 -0
- package/build/src/v1alpha/chunk_service_client.js +157 -0
- package/build/src/v1alpha/completion_service_client.d.ts +108 -0
- package/build/src/v1alpha/completion_service_client.js +157 -0
- package/build/src/v1alpha/control_service_client.d.ts +108 -0
- package/build/src/v1alpha/control_service_client.js +157 -0
- package/build/src/v1alpha/conversational_search_service_client.d.ts +108 -0
- package/build/src/v1alpha/conversational_search_service_client.js +157 -0
- package/build/src/v1alpha/data_store_service_client.d.ts +108 -0
- package/build/src/v1alpha/data_store_service_client.js +157 -0
- package/build/src/v1alpha/document_service_client.d.ts +108 -0
- package/build/src/v1alpha/document_service_client.js +157 -0
- package/build/src/v1alpha/engine_service_client.d.ts +108 -0
- package/build/src/v1alpha/engine_service_client.js +157 -0
- package/build/src/v1alpha/estimate_billing_service_client.d.ts +108 -0
- package/build/src/v1alpha/estimate_billing_service_client.js +157 -0
- package/build/src/v1alpha/evaluation_service_client.d.ts +2349 -0
- package/build/src/v1alpha/evaluation_service_client.js +3288 -0
- package/build/src/v1alpha/evaluation_service_client_config.json +58 -0
- package/build/src/v1alpha/grounded_generation_service_client.d.ts +108 -0
- package/build/src/v1alpha/grounded_generation_service_client.js +157 -0
- package/build/src/v1alpha/index.d.ts +3 -0
- package/build/src/v1alpha/index.js +7 -1
- package/build/src/v1alpha/project_service_client.d.ts +108 -0
- package/build/src/v1alpha/project_service_client.js +157 -0
- package/build/src/v1alpha/rank_service_client.d.ts +108 -0
- package/build/src/v1alpha/rank_service_client.js +157 -0
- package/build/src/v1alpha/recommendation_service_client.d.ts +108 -0
- package/build/src/v1alpha/recommendation_service_client.js +157 -0
- package/build/src/v1alpha/sample_query_service_client.d.ts +2317 -0
- package/build/src/v1alpha/sample_query_service_client.js +3186 -0
- package/build/src/v1alpha/sample_query_service_client_config.json +68 -0
- package/build/src/v1alpha/sample_query_set_service_client.d.ts +2176 -0
- package/build/src/v1alpha/sample_query_set_service_client.js +2931 -0
- package/build/src/v1alpha/sample_query_set_service_client_config.json +63 -0
- package/build/src/v1alpha/schema_service_client.d.ts +108 -0
- package/build/src/v1alpha/schema_service_client.js +157 -0
- package/build/src/v1alpha/search_service_client.d.ts +108 -0
- package/build/src/v1alpha/search_service_client.js +157 -0
- package/build/src/v1alpha/search_tuning_service_client.d.ts +108 -0
- package/build/src/v1alpha/search_tuning_service_client.js +157 -0
- package/build/src/v1alpha/serving_config_service_client.d.ts +108 -0
- package/build/src/v1alpha/serving_config_service_client.js +157 -0
- package/build/src/v1alpha/site_search_engine_service_client.d.ts +108 -0
- package/build/src/v1alpha/site_search_engine_service_client.js +157 -0
- package/build/src/v1alpha/user_event_service_client.d.ts +108 -0
- package/build/src/v1alpha/user_event_service_client.js +157 -0
- package/build/src/v1beta/completion_service_client.d.ts +328 -0
- package/build/src/v1beta/completion_service_client.js +423 -0
- package/build/src/v1beta/completion_service_client_config.json +10 -0
- package/build/src/v1beta/control_service_client.d.ts +237 -0
- package/build/src/v1beta/control_service_client.js +333 -0
- package/build/src/v1beta/conversational_search_service_client.d.ts +255 -0
- package/build/src/v1beta/conversational_search_service_client.js +333 -0
- package/build/src/v1beta/data_store_service_client.d.ts +246 -0
- package/build/src/v1beta/data_store_service_client.js +339 -0
- package/build/src/v1beta/document_service_client.d.ts +239 -0
- package/build/src/v1beta/document_service_client.js +339 -0
- package/build/src/v1beta/engine_service_client.d.ts +237 -0
- package/build/src/v1beta/engine_service_client.js +339 -0
- package/build/src/v1beta/evaluation_service_client.d.ts +2325 -0
- package/build/src/v1beta/evaluation_service_client.js +3252 -0
- package/build/src/v1beta/evaluation_service_client_config.json +58 -0
- package/build/src/v1beta/grounded_generation_service_client.d.ts +237 -0
- package/build/src/v1beta/grounded_generation_service_client.js +333 -0
- package/build/src/v1beta/index.d.ts +3 -0
- package/build/src/v1beta/index.js +7 -1
- package/build/src/v1beta/project_service_client.d.ts +237 -0
- package/build/src/v1beta/project_service_client.js +339 -0
- package/build/src/v1beta/rank_service_client.d.ts +237 -0
- package/build/src/v1beta/rank_service_client.js +333 -0
- package/build/src/v1beta/recommendation_service_client.d.ts +237 -0
- package/build/src/v1beta/recommendation_service_client.js +333 -0
- package/build/src/v1beta/sample_query_service_client.d.ts +2293 -0
- package/build/src/v1beta/sample_query_service_client.js +3150 -0
- package/build/src/v1beta/sample_query_service_client_config.json +68 -0
- package/build/src/v1beta/sample_query_set_service_client.d.ts +2150 -0
- package/build/src/v1beta/sample_query_set_service_client.js +2895 -0
- package/build/src/v1beta/sample_query_set_service_client_config.json +63 -0
- package/build/src/v1beta/schema_service_client.d.ts +237 -0
- package/build/src/v1beta/schema_service_client.js +339 -0
- package/build/src/v1beta/search_service_client.d.ts +414 -12
- package/build/src/v1beta/search_service_client.js +451 -8
- package/build/src/v1beta/search_tuning_service_client.d.ts +237 -0
- package/build/src/v1beta/search_tuning_service_client.js +339 -0
- package/build/src/v1beta/serving_config_service_client.d.ts +237 -0
- package/build/src/v1beta/serving_config_service_client.js +333 -0
- package/build/src/v1beta/site_search_engine_service_client.d.ts +237 -0
- package/build/src/v1beta/site_search_engine_service_client.js +339 -0
- package/build/src/v1beta/user_event_service_client.d.ts +312 -0
- package/build/src/v1beta/user_event_service_client.js +381 -0
- package/build/src/v1beta/user_event_service_client_config.json +5 -0
- package/package.json +1 -1
@@ -214,6 +214,17 @@ export declare class SearchServiceClient {
|
|
214
214
|
* Highly recommended for analytics.
|
215
215
|
* {@link protos.google.cloud.discoveryengine.v1beta.UserInfo.user_agent|UserInfo.user_agent}
|
216
216
|
* is used to deduce `device_type` for analytics.
|
217
|
+
* @param {string} request.languageCode
|
218
|
+
* The BCP-47 language code, such as "en-US" or "sr-Latn". For more
|
219
|
+
* information, see [Standard
|
220
|
+
* fields](https://cloud.google.com/apis/design/standard_fields). This field
|
221
|
+
* helps to better interpret the query. If a value isn't specified, the query
|
222
|
+
* language code is automatically detected, which may not be accurate.
|
223
|
+
* @param {string} request.regionCode
|
224
|
+
* The Unicode country/region code (CLDR) of a location, such as "US" and
|
225
|
+
* "419". For more information, see [Standard
|
226
|
+
* fields](https://cloud.google.com/apis/design/standard_fields). If set,
|
227
|
+
* then results will be boosted based on the region_code provided.
|
217
228
|
* @param {number[]} request.facetSpecs
|
218
229
|
* Facet specifications for faceted search. If empty, no facets are returned.
|
219
230
|
*
|
@@ -278,20 +289,26 @@ export declare class SearchServiceClient {
|
|
278
289
|
* documents. This overrides
|
279
290
|
* {@link protos.google.cloud.discoveryengine.v1beta.ServingConfig.ranking_expression|ServingConfig.ranking_expression}.
|
280
291
|
* The ranking expression is a single function or multiple functions that are
|
281
|
-
*
|
292
|
+
* joined by "+".
|
293
|
+
*
|
282
294
|
* * ranking_expression = function, { " + ", function };
|
295
|
+
*
|
283
296
|
* Supported functions:
|
297
|
+
*
|
284
298
|
* * double * relevance_score
|
285
299
|
* * double * dotProduct(embedding_field_path)
|
300
|
+
*
|
286
301
|
* Function variables:
|
287
|
-
*
|
302
|
+
*
|
303
|
+
* * `relevance_score`: pre-defined keywords, used for measure relevance
|
288
304
|
* between query and document.
|
289
|
-
* `embedding_field_path`: the document embedding field
|
305
|
+
* * `embedding_field_path`: the document embedding field
|
290
306
|
* used with query embedding vector.
|
291
|
-
* `dotProduct`: embedding function between embedding_field_path and query
|
307
|
+
* * `dotProduct`: embedding function between embedding_field_path and query
|
292
308
|
* embedding vector.
|
293
309
|
*
|
294
310
|
* Example ranking expression:
|
311
|
+
*
|
295
312
|
* If document has an embedding field doc_embedding, the ranking expression
|
296
313
|
* could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
|
297
314
|
* @param {boolean} request.safeSearch
|
@@ -315,6 +332,44 @@ export declare class SearchServiceClient {
|
|
315
332
|
* See [Google Cloud
|
316
333
|
* Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
|
317
334
|
* for more details.
|
335
|
+
* @param {google.cloud.discoveryengine.v1beta.SearchRequest.NaturalLanguageQueryUnderstandingSpec} request.naturalLanguageQueryUnderstandingSpec
|
336
|
+
* If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional
|
337
|
+
* natural language query understanding will be done.
|
338
|
+
* @param {google.cloud.discoveryengine.v1beta.SearchRequest.SearchAsYouTypeSpec} request.searchAsYouTypeSpec
|
339
|
+
* Search as you type configuration. Only supported for the
|
340
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.IndustryVertical.MEDIA|IndustryVertical.MEDIA}
|
341
|
+
* vertical.
|
342
|
+
* @param {string} request.session
|
343
|
+
* The session resource name. Optional.
|
344
|
+
*
|
345
|
+
* Session allows users to do multi-turn /search API calls or coordination
|
346
|
+
* between /search API calls and /answer API calls.
|
347
|
+
*
|
348
|
+
* Example #1 (multi-turn /search API calls):
|
349
|
+
* 1. Call /search API with the auto-session mode (see below).
|
350
|
+
* 2. Call /search API with the session ID generated in the first call.
|
351
|
+
* Here, the previous search query gets considered in query
|
352
|
+
* standing. I.e., if the first query is "How did Alphabet do in 2022?"
|
353
|
+
* and the current query is "How about 2023?", the current query will
|
354
|
+
* be interpreted as "How did Alphabet do in 2023?".
|
355
|
+
*
|
356
|
+
* Example #2 (coordination between /search API calls and /answer API calls):
|
357
|
+
* 1. Call /search API with the auto-session mode (see below).
|
358
|
+
* 2. Call /answer API with the session ID generated in the first call.
|
359
|
+
* Here, the answer generation happens in the context of the search
|
360
|
+
* results from the first search call.
|
361
|
+
*
|
362
|
+
* Auto-session mode: when `projects/.../sessions/-` is used, a new session
|
363
|
+
* gets automatically created. Otherwise, users can use the create-session API
|
364
|
+
* to create a session manually.
|
365
|
+
*
|
366
|
+
* Multi-turn Search feature is currently at private GA stage. Please use
|
367
|
+
* v1alpha or v1beta version instead before we launch this feature to public
|
368
|
+
* GA. Or ask for allowlisting through Google Support team.
|
369
|
+
* @param {google.cloud.discoveryengine.v1beta.SearchRequest.SessionSpec} request.sessionSpec
|
370
|
+
* Session specification.
|
371
|
+
*
|
372
|
+
* Can be used only when `session` is set.
|
318
373
|
* @param {object} [options]
|
319
374
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
320
375
|
* @returns {Promise} - The promise which resolves to an array.
|
@@ -432,6 +487,17 @@ export declare class SearchServiceClient {
|
|
432
487
|
* Highly recommended for analytics.
|
433
488
|
* {@link protos.google.cloud.discoveryengine.v1beta.UserInfo.user_agent|UserInfo.user_agent}
|
434
489
|
* is used to deduce `device_type` for analytics.
|
490
|
+
* @param {string} request.languageCode
|
491
|
+
* The BCP-47 language code, such as "en-US" or "sr-Latn". For more
|
492
|
+
* information, see [Standard
|
493
|
+
* fields](https://cloud.google.com/apis/design/standard_fields). This field
|
494
|
+
* helps to better interpret the query. If a value isn't specified, the query
|
495
|
+
* language code is automatically detected, which may not be accurate.
|
496
|
+
* @param {string} request.regionCode
|
497
|
+
* The Unicode country/region code (CLDR) of a location, such as "US" and
|
498
|
+
* "419". For more information, see [Standard
|
499
|
+
* fields](https://cloud.google.com/apis/design/standard_fields). If set,
|
500
|
+
* then results will be boosted based on the region_code provided.
|
435
501
|
* @param {number[]} request.facetSpecs
|
436
502
|
* Facet specifications for faceted search. If empty, no facets are returned.
|
437
503
|
*
|
@@ -496,20 +562,26 @@ export declare class SearchServiceClient {
|
|
496
562
|
* documents. This overrides
|
497
563
|
* {@link protos.google.cloud.discoveryengine.v1beta.ServingConfig.ranking_expression|ServingConfig.ranking_expression}.
|
498
564
|
* The ranking expression is a single function or multiple functions that are
|
499
|
-
*
|
565
|
+
* joined by "+".
|
566
|
+
*
|
500
567
|
* * ranking_expression = function, { " + ", function };
|
568
|
+
*
|
501
569
|
* Supported functions:
|
570
|
+
*
|
502
571
|
* * double * relevance_score
|
503
572
|
* * double * dotProduct(embedding_field_path)
|
573
|
+
*
|
504
574
|
* Function variables:
|
505
|
-
*
|
575
|
+
*
|
576
|
+
* * `relevance_score`: pre-defined keywords, used for measure relevance
|
506
577
|
* between query and document.
|
507
|
-
* `embedding_field_path`: the document embedding field
|
578
|
+
* * `embedding_field_path`: the document embedding field
|
508
579
|
* used with query embedding vector.
|
509
|
-
* `dotProduct`: embedding function between embedding_field_path and query
|
580
|
+
* * `dotProduct`: embedding function between embedding_field_path and query
|
510
581
|
* embedding vector.
|
511
582
|
*
|
512
583
|
* Example ranking expression:
|
584
|
+
*
|
513
585
|
* If document has an embedding field doc_embedding, the ranking expression
|
514
586
|
* could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
|
515
587
|
* @param {boolean} request.safeSearch
|
@@ -533,6 +605,44 @@ export declare class SearchServiceClient {
|
|
533
605
|
* See [Google Cloud
|
534
606
|
* Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
|
535
607
|
* for more details.
|
608
|
+
* @param {google.cloud.discoveryengine.v1beta.SearchRequest.NaturalLanguageQueryUnderstandingSpec} request.naturalLanguageQueryUnderstandingSpec
|
609
|
+
* If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional
|
610
|
+
* natural language query understanding will be done.
|
611
|
+
* @param {google.cloud.discoveryengine.v1beta.SearchRequest.SearchAsYouTypeSpec} request.searchAsYouTypeSpec
|
612
|
+
* Search as you type configuration. Only supported for the
|
613
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.IndustryVertical.MEDIA|IndustryVertical.MEDIA}
|
614
|
+
* vertical.
|
615
|
+
* @param {string} request.session
|
616
|
+
* The session resource name. Optional.
|
617
|
+
*
|
618
|
+
* Session allows users to do multi-turn /search API calls or coordination
|
619
|
+
* between /search API calls and /answer API calls.
|
620
|
+
*
|
621
|
+
* Example #1 (multi-turn /search API calls):
|
622
|
+
* 1. Call /search API with the auto-session mode (see below).
|
623
|
+
* 2. Call /search API with the session ID generated in the first call.
|
624
|
+
* Here, the previous search query gets considered in query
|
625
|
+
* standing. I.e., if the first query is "How did Alphabet do in 2022?"
|
626
|
+
* and the current query is "How about 2023?", the current query will
|
627
|
+
* be interpreted as "How did Alphabet do in 2023?".
|
628
|
+
*
|
629
|
+
* Example #2 (coordination between /search API calls and /answer API calls):
|
630
|
+
* 1. Call /search API with the auto-session mode (see below).
|
631
|
+
* 2. Call /answer API with the session ID generated in the first call.
|
632
|
+
* Here, the answer generation happens in the context of the search
|
633
|
+
* results from the first search call.
|
634
|
+
*
|
635
|
+
* Auto-session mode: when `projects/.../sessions/-` is used, a new session
|
636
|
+
* gets automatically created. Otherwise, users can use the create-session API
|
637
|
+
* to create a session manually.
|
638
|
+
*
|
639
|
+
* Multi-turn Search feature is currently at private GA stage. Please use
|
640
|
+
* v1alpha or v1beta version instead before we launch this feature to public
|
641
|
+
* GA. Or ask for allowlisting through Google Support team.
|
642
|
+
* @param {google.cloud.discoveryengine.v1beta.SearchRequest.SessionSpec} request.sessionSpec
|
643
|
+
* Session specification.
|
644
|
+
*
|
645
|
+
* Can be used only when `session` is set.
|
536
646
|
* @param {object} [options]
|
537
647
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
538
648
|
* @returns {Stream}
|
@@ -645,6 +755,17 @@ export declare class SearchServiceClient {
|
|
645
755
|
* Highly recommended for analytics.
|
646
756
|
* {@link protos.google.cloud.discoveryengine.v1beta.UserInfo.user_agent|UserInfo.user_agent}
|
647
757
|
* is used to deduce `device_type` for analytics.
|
758
|
+
* @param {string} request.languageCode
|
759
|
+
* The BCP-47 language code, such as "en-US" or "sr-Latn". For more
|
760
|
+
* information, see [Standard
|
761
|
+
* fields](https://cloud.google.com/apis/design/standard_fields). This field
|
762
|
+
* helps to better interpret the query. If a value isn't specified, the query
|
763
|
+
* language code is automatically detected, which may not be accurate.
|
764
|
+
* @param {string} request.regionCode
|
765
|
+
* The Unicode country/region code (CLDR) of a location, such as "US" and
|
766
|
+
* "419". For more information, see [Standard
|
767
|
+
* fields](https://cloud.google.com/apis/design/standard_fields). If set,
|
768
|
+
* then results will be boosted based on the region_code provided.
|
648
769
|
* @param {number[]} request.facetSpecs
|
649
770
|
* Facet specifications for faceted search. If empty, no facets are returned.
|
650
771
|
*
|
@@ -709,20 +830,26 @@ export declare class SearchServiceClient {
|
|
709
830
|
* documents. This overrides
|
710
831
|
* {@link protos.google.cloud.discoveryengine.v1beta.ServingConfig.ranking_expression|ServingConfig.ranking_expression}.
|
711
832
|
* The ranking expression is a single function or multiple functions that are
|
712
|
-
*
|
833
|
+
* joined by "+".
|
834
|
+
*
|
713
835
|
* * ranking_expression = function, { " + ", function };
|
836
|
+
*
|
714
837
|
* Supported functions:
|
838
|
+
*
|
715
839
|
* * double * relevance_score
|
716
840
|
* * double * dotProduct(embedding_field_path)
|
841
|
+
*
|
717
842
|
* Function variables:
|
718
|
-
*
|
843
|
+
*
|
844
|
+
* * `relevance_score`: pre-defined keywords, used for measure relevance
|
719
845
|
* between query and document.
|
720
|
-
* `embedding_field_path`: the document embedding field
|
846
|
+
* * `embedding_field_path`: the document embedding field
|
721
847
|
* used with query embedding vector.
|
722
|
-
* `dotProduct`: embedding function between embedding_field_path and query
|
848
|
+
* * `dotProduct`: embedding function between embedding_field_path and query
|
723
849
|
* embedding vector.
|
724
850
|
*
|
725
851
|
* Example ranking expression:
|
852
|
+
*
|
726
853
|
* If document has an embedding field doc_embedding, the ranking expression
|
727
854
|
* could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
|
728
855
|
* @param {boolean} request.safeSearch
|
@@ -746,6 +873,44 @@ export declare class SearchServiceClient {
|
|
746
873
|
* See [Google Cloud
|
747
874
|
* Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
|
748
875
|
* for more details.
|
876
|
+
* @param {google.cloud.discoveryengine.v1beta.SearchRequest.NaturalLanguageQueryUnderstandingSpec} request.naturalLanguageQueryUnderstandingSpec
|
877
|
+
* If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional
|
878
|
+
* natural language query understanding will be done.
|
879
|
+
* @param {google.cloud.discoveryengine.v1beta.SearchRequest.SearchAsYouTypeSpec} request.searchAsYouTypeSpec
|
880
|
+
* Search as you type configuration. Only supported for the
|
881
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.IndustryVertical.MEDIA|IndustryVertical.MEDIA}
|
882
|
+
* vertical.
|
883
|
+
* @param {string} request.session
|
884
|
+
* The session resource name. Optional.
|
885
|
+
*
|
886
|
+
* Session allows users to do multi-turn /search API calls or coordination
|
887
|
+
* between /search API calls and /answer API calls.
|
888
|
+
*
|
889
|
+
* Example #1 (multi-turn /search API calls):
|
890
|
+
* 1. Call /search API with the auto-session mode (see below).
|
891
|
+
* 2. Call /search API with the session ID generated in the first call.
|
892
|
+
* Here, the previous search query gets considered in query
|
893
|
+
* standing. I.e., if the first query is "How did Alphabet do in 2022?"
|
894
|
+
* and the current query is "How about 2023?", the current query will
|
895
|
+
* be interpreted as "How did Alphabet do in 2023?".
|
896
|
+
*
|
897
|
+
* Example #2 (coordination between /search API calls and /answer API calls):
|
898
|
+
* 1. Call /search API with the auto-session mode (see below).
|
899
|
+
* 2. Call /answer API with the session ID generated in the first call.
|
900
|
+
* Here, the answer generation happens in the context of the search
|
901
|
+
* results from the first search call.
|
902
|
+
*
|
903
|
+
* Auto-session mode: when `projects/.../sessions/-` is used, a new session
|
904
|
+
* gets automatically created. Otherwise, users can use the create-session API
|
905
|
+
* to create a session manually.
|
906
|
+
*
|
907
|
+
* Multi-turn Search feature is currently at private GA stage. Please use
|
908
|
+
* v1alpha or v1beta version instead before we launch this feature to public
|
909
|
+
* GA. Or ask for allowlisting through Google Support team.
|
910
|
+
* @param {google.cloud.discoveryengine.v1beta.SearchRequest.SessionSpec} request.sessionSpec
|
911
|
+
* Session specification.
|
912
|
+
*
|
913
|
+
* Can be used only when `session` is set.
|
749
914
|
* @param {object} [options]
|
750
915
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
751
916
|
* @returns {Object}
|
@@ -852,6 +1017,39 @@ export declare class SearchServiceClient {
|
|
852
1017
|
* @returns {string} A string representing the engine.
|
853
1018
|
*/
|
854
1019
|
matchEngineFromEngineName(engineName: string): string | number;
|
1020
|
+
/**
|
1021
|
+
* Return a fully-qualified evaluation resource name string.
|
1022
|
+
*
|
1023
|
+
* @param {string} project
|
1024
|
+
* @param {string} location
|
1025
|
+
* @param {string} evaluation
|
1026
|
+
* @returns {string} Resource name string.
|
1027
|
+
*/
|
1028
|
+
evaluationPath(project: string, location: string, evaluation: string): string;
|
1029
|
+
/**
|
1030
|
+
* Parse the project from Evaluation resource.
|
1031
|
+
*
|
1032
|
+
* @param {string} evaluationName
|
1033
|
+
* A fully-qualified path representing Evaluation resource.
|
1034
|
+
* @returns {string} A string representing the project.
|
1035
|
+
*/
|
1036
|
+
matchProjectFromEvaluationName(evaluationName: string): string | number;
|
1037
|
+
/**
|
1038
|
+
* Parse the location from Evaluation resource.
|
1039
|
+
*
|
1040
|
+
* @param {string} evaluationName
|
1041
|
+
* A fully-qualified path representing Evaluation resource.
|
1042
|
+
* @returns {string} A string representing the location.
|
1043
|
+
*/
|
1044
|
+
matchLocationFromEvaluationName(evaluationName: string): string | number;
|
1045
|
+
/**
|
1046
|
+
* Parse the evaluation from Evaluation resource.
|
1047
|
+
*
|
1048
|
+
* @param {string} evaluationName
|
1049
|
+
* A fully-qualified path representing Evaluation resource.
|
1050
|
+
* @returns {string} A string representing the evaluation.
|
1051
|
+
*/
|
1052
|
+
matchEvaluationFromEvaluationName(evaluationName: string): string | number;
|
855
1053
|
/**
|
856
1054
|
* Return a fully-qualified project resource name string.
|
857
1055
|
*
|
@@ -1020,6 +1218,75 @@ export declare class SearchServiceClient {
|
|
1020
1218
|
* @returns {string} A string representing the document.
|
1021
1219
|
*/
|
1022
1220
|
matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
|
1221
|
+
/**
|
1222
|
+
* Return a fully-qualified projectLocationCollectionDataStoreBranchDocumentChunk resource name string.
|
1223
|
+
*
|
1224
|
+
* @param {string} project
|
1225
|
+
* @param {string} location
|
1226
|
+
* @param {string} collection
|
1227
|
+
* @param {string} data_store
|
1228
|
+
* @param {string} branch
|
1229
|
+
* @param {string} document
|
1230
|
+
* @param {string} chunk
|
1231
|
+
* @returns {string} Resource name string.
|
1232
|
+
*/
|
1233
|
+
projectLocationCollectionDataStoreBranchDocumentChunkPath(project: string, location: string, collection: string, dataStore: string, branch: string, document: string, chunk: string): string;
|
1234
|
+
/**
|
1235
|
+
* Parse the project from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
|
1236
|
+
*
|
1237
|
+
* @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
|
1238
|
+
* A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
|
1239
|
+
* @returns {string} A string representing the project.
|
1240
|
+
*/
|
1241
|
+
matchProjectFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;
|
1242
|
+
/**
|
1243
|
+
* Parse the location from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
|
1244
|
+
*
|
1245
|
+
* @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
|
1246
|
+
* A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
|
1247
|
+
* @returns {string} A string representing the location.
|
1248
|
+
*/
|
1249
|
+
matchLocationFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;
|
1250
|
+
/**
|
1251
|
+
* Parse the collection from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
|
1252
|
+
*
|
1253
|
+
* @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
|
1254
|
+
* A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
|
1255
|
+
* @returns {string} A string representing the collection.
|
1256
|
+
*/
|
1257
|
+
matchCollectionFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;
|
1258
|
+
/**
|
1259
|
+
* Parse the data_store from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
|
1260
|
+
*
|
1261
|
+
* @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
|
1262
|
+
* A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
|
1263
|
+
* @returns {string} A string representing the data_store.
|
1264
|
+
*/
|
1265
|
+
matchDataStoreFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;
|
1266
|
+
/**
|
1267
|
+
* Parse the branch from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
|
1268
|
+
*
|
1269
|
+
* @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
|
1270
|
+
* A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
|
1271
|
+
* @returns {string} A string representing the branch.
|
1272
|
+
*/
|
1273
|
+
matchBranchFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;
|
1274
|
+
/**
|
1275
|
+
* Parse the document from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
|
1276
|
+
*
|
1277
|
+
* @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
|
1278
|
+
* A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
|
1279
|
+
* @returns {string} A string representing the document.
|
1280
|
+
*/
|
1281
|
+
matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;
|
1282
|
+
/**
|
1283
|
+
* Parse the chunk from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
|
1284
|
+
*
|
1285
|
+
* @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
|
1286
|
+
* A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
|
1287
|
+
* @returns {string} A string representing the chunk.
|
1288
|
+
*/
|
1289
|
+
matchChunkFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;
|
1023
1290
|
/**
|
1024
1291
|
* Return a fully-qualified projectLocationCollectionDataStoreControl resource name string.
|
1025
1292
|
*
|
@@ -1911,6 +2178,66 @@ export declare class SearchServiceClient {
|
|
1911
2178
|
* @returns {string} A string representing the document.
|
1912
2179
|
*/
|
1913
2180
|
matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
|
2181
|
+
/**
|
2182
|
+
* Return a fully-qualified projectLocationDataStoreBranchDocumentChunk resource name string.
|
2183
|
+
*
|
2184
|
+
* @param {string} project
|
2185
|
+
* @param {string} location
|
2186
|
+
* @param {string} data_store
|
2187
|
+
* @param {string} branch
|
2188
|
+
* @param {string} document
|
2189
|
+
* @param {string} chunk
|
2190
|
+
* @returns {string} Resource name string.
|
2191
|
+
*/
|
2192
|
+
projectLocationDataStoreBranchDocumentChunkPath(project: string, location: string, dataStore: string, branch: string, document: string, chunk: string): string;
|
2193
|
+
/**
|
2194
|
+
* Parse the project from ProjectLocationDataStoreBranchDocumentChunk resource.
|
2195
|
+
*
|
2196
|
+
* @param {string} projectLocationDataStoreBranchDocumentChunkName
|
2197
|
+
* A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
|
2198
|
+
* @returns {string} A string representing the project.
|
2199
|
+
*/
|
2200
|
+
matchProjectFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName: string): string | number;
|
2201
|
+
/**
|
2202
|
+
* Parse the location from ProjectLocationDataStoreBranchDocumentChunk resource.
|
2203
|
+
*
|
2204
|
+
* @param {string} projectLocationDataStoreBranchDocumentChunkName
|
2205
|
+
* A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
|
2206
|
+
* @returns {string} A string representing the location.
|
2207
|
+
*/
|
2208
|
+
matchLocationFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName: string): string | number;
|
2209
|
+
/**
|
2210
|
+
* Parse the data_store from ProjectLocationDataStoreBranchDocumentChunk resource.
|
2211
|
+
*
|
2212
|
+
* @param {string} projectLocationDataStoreBranchDocumentChunkName
|
2213
|
+
* A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
|
2214
|
+
* @returns {string} A string representing the data_store.
|
2215
|
+
*/
|
2216
|
+
matchDataStoreFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName: string): string | number;
|
2217
|
+
/**
|
2218
|
+
* Parse the branch from ProjectLocationDataStoreBranchDocumentChunk resource.
|
2219
|
+
*
|
2220
|
+
* @param {string} projectLocationDataStoreBranchDocumentChunkName
|
2221
|
+
* A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
|
2222
|
+
* @returns {string} A string representing the branch.
|
2223
|
+
*/
|
2224
|
+
matchBranchFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName: string): string | number;
|
2225
|
+
/**
|
2226
|
+
* Parse the document from ProjectLocationDataStoreBranchDocumentChunk resource.
|
2227
|
+
*
|
2228
|
+
* @param {string} projectLocationDataStoreBranchDocumentChunkName
|
2229
|
+
* A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
|
2230
|
+
* @returns {string} A string representing the document.
|
2231
|
+
*/
|
2232
|
+
matchDocumentFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName: string): string | number;
|
2233
|
+
/**
|
2234
|
+
* Parse the chunk from ProjectLocationDataStoreBranchDocumentChunk resource.
|
2235
|
+
*
|
2236
|
+
* @param {string} projectLocationDataStoreBranchDocumentChunkName
|
2237
|
+
* A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
|
2238
|
+
* @returns {string} A string representing the chunk.
|
2239
|
+
*/
|
2240
|
+
matchChunkFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName: string): string | number;
|
1914
2241
|
/**
|
1915
2242
|
* Return a fully-qualified projectLocationDataStoreControl resource name string.
|
1916
2243
|
*
|
@@ -2322,6 +2649,81 @@ export declare class SearchServiceClient {
|
|
2322
2649
|
* @returns {string} A string representing the target_site.
|
2323
2650
|
*/
|
2324
2651
|
matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
|
2652
|
+
/**
|
2653
|
+
* Return a fully-qualified sampleQuery resource name string.
|
2654
|
+
*
|
2655
|
+
* @param {string} project
|
2656
|
+
* @param {string} location
|
2657
|
+
* @param {string} sample_query_set
|
2658
|
+
* @param {string} sample_query
|
2659
|
+
* @returns {string} Resource name string.
|
2660
|
+
*/
|
2661
|
+
sampleQueryPath(project: string, location: string, sampleQuerySet: string, sampleQuery: string): string;
|
2662
|
+
/**
|
2663
|
+
* Parse the project from SampleQuery resource.
|
2664
|
+
*
|
2665
|
+
* @param {string} sampleQueryName
|
2666
|
+
* A fully-qualified path representing SampleQuery resource.
|
2667
|
+
* @returns {string} A string representing the project.
|
2668
|
+
*/
|
2669
|
+
matchProjectFromSampleQueryName(sampleQueryName: string): string | number;
|
2670
|
+
/**
|
2671
|
+
* Parse the location from SampleQuery resource.
|
2672
|
+
*
|
2673
|
+
* @param {string} sampleQueryName
|
2674
|
+
* A fully-qualified path representing SampleQuery resource.
|
2675
|
+
* @returns {string} A string representing the location.
|
2676
|
+
*/
|
2677
|
+
matchLocationFromSampleQueryName(sampleQueryName: string): string | number;
|
2678
|
+
/**
|
2679
|
+
* Parse the sample_query_set from SampleQuery resource.
|
2680
|
+
*
|
2681
|
+
* @param {string} sampleQueryName
|
2682
|
+
* A fully-qualified path representing SampleQuery resource.
|
2683
|
+
* @returns {string} A string representing the sample_query_set.
|
2684
|
+
*/
|
2685
|
+
matchSampleQuerySetFromSampleQueryName(sampleQueryName: string): string | number;
|
2686
|
+
/**
|
2687
|
+
* Parse the sample_query from SampleQuery resource.
|
2688
|
+
*
|
2689
|
+
* @param {string} sampleQueryName
|
2690
|
+
* A fully-qualified path representing SampleQuery resource.
|
2691
|
+
* @returns {string} A string representing the sample_query.
|
2692
|
+
*/
|
2693
|
+
matchSampleQueryFromSampleQueryName(sampleQueryName: string): string | number;
|
2694
|
+
/**
|
2695
|
+
* Return a fully-qualified sampleQuerySet resource name string.
|
2696
|
+
*
|
2697
|
+
* @param {string} project
|
2698
|
+
* @param {string} location
|
2699
|
+
* @param {string} sample_query_set
|
2700
|
+
* @returns {string} Resource name string.
|
2701
|
+
*/
|
2702
|
+
sampleQuerySetPath(project: string, location: string, sampleQuerySet: string): string;
|
2703
|
+
/**
|
2704
|
+
* Parse the project from SampleQuerySet resource.
|
2705
|
+
*
|
2706
|
+
* @param {string} sampleQuerySetName
|
2707
|
+
* A fully-qualified path representing SampleQuerySet resource.
|
2708
|
+
* @returns {string} A string representing the project.
|
2709
|
+
*/
|
2710
|
+
matchProjectFromSampleQuerySetName(sampleQuerySetName: string): string | number;
|
2711
|
+
/**
|
2712
|
+
* Parse the location from SampleQuerySet resource.
|
2713
|
+
*
|
2714
|
+
* @param {string} sampleQuerySetName
|
2715
|
+
* A fully-qualified path representing SampleQuerySet resource.
|
2716
|
+
* @returns {string} A string representing the location.
|
2717
|
+
*/
|
2718
|
+
matchLocationFromSampleQuerySetName(sampleQuerySetName: string): string | number;
|
2719
|
+
/**
|
2720
|
+
* Parse the sample_query_set from SampleQuerySet resource.
|
2721
|
+
*
|
2722
|
+
* @param {string} sampleQuerySetName
|
2723
|
+
* A fully-qualified path representing SampleQuerySet resource.
|
2724
|
+
* @returns {string} A string representing the sample_query_set.
|
2725
|
+
*/
|
2726
|
+
matchSampleQuerySetFromSampleQuerySetName(sampleQuerySetName: string): string | number;
|
2325
2727
|
/**
|
2326
2728
|
* Terminate the gRPC channel and close the client.
|
2327
2729
|
*
|