google-cloud-discovery_engine-v1 2.0.0 → 2.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.
Files changed (77) hide show
  1. checksums.yaml +4 -4
  2. data/lib/google/cloud/discovery_engine/v1/conversational_search_service/client.rb +186 -4
  3. data/lib/google/cloud/discovery_engine/v1/conversational_search_service/rest/client.rb +181 -4
  4. data/lib/google/cloud/discovery_engine/v1/conversational_search_service/rest/service_stub.rb +72 -0
  5. data/lib/google/cloud/discovery_engine/v1/document_service/client.rb +8 -2
  6. data/lib/google/cloud/discovery_engine/v1/document_service/rest/client.rb +8 -2
  7. data/lib/google/cloud/discovery_engine/v1/grounded_generation_service/client.rb +1 -3
  8. data/lib/google/cloud/discovery_engine/v1/grounded_generation_service/rest/client.rb +1 -3
  9. data/lib/google/cloud/discovery_engine/v1/rank_service/client.rb +1 -1
  10. data/lib/google/cloud/discovery_engine/v1/rank_service/rest/client.rb +1 -1
  11. data/lib/google/cloud/discovery_engine/v1/recommendation_service/client.rb +3 -3
  12. data/lib/google/cloud/discovery_engine/v1/recommendation_service/rest/client.rb +3 -3
  13. data/lib/google/cloud/discovery_engine/v1/rest.rb +1 -0
  14. data/lib/google/cloud/discovery_engine/v1/search_service/client.rb +44 -12
  15. data/lib/google/cloud/discovery_engine/v1/search_service/rest/client.rb +44 -12
  16. data/lib/google/cloud/discovery_engine/v1/serving_config_service/client.rb +484 -0
  17. data/lib/google/cloud/discovery_engine/v1/serving_config_service/credentials.rb +47 -0
  18. data/lib/google/cloud/discovery_engine/v1/serving_config_service/paths.rb +101 -0
  19. data/lib/google/cloud/discovery_engine/v1/serving_config_service/rest/client.rb +451 -0
  20. data/lib/google/cloud/discovery_engine/v1/serving_config_service/rest/service_stub.rb +159 -0
  21. data/lib/google/cloud/discovery_engine/v1/serving_config_service/rest.rb +53 -0
  22. data/lib/google/cloud/discovery_engine/v1/serving_config_service.rb +56 -0
  23. data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/client.rb +316 -3
  24. data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/paths.rb +49 -0
  25. data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/rest/client.rb +295 -3
  26. data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/rest/service_stub.rb +206 -0
  27. data/lib/google/cloud/discovery_engine/v1/user_event_service/client.rb +21 -9
  28. data/lib/google/cloud/discovery_engine/v1/user_event_service/rest/client.rb +21 -9
  29. data/lib/google/cloud/discovery_engine/v1/user_event_service/rest/service_stub.rb +8 -0
  30. data/lib/google/cloud/discovery_engine/v1/version.rb +1 -1
  31. data/lib/google/cloud/discovery_engine/v1.rb +1 -0
  32. data/lib/google/cloud/discoveryengine/v1/answer_pb.rb +4 -1
  33. data/lib/google/cloud/discoveryengine/v1/common_pb.rb +4 -1
  34. data/lib/google/cloud/discoveryengine/v1/control_pb.rb +7 -1
  35. data/lib/google/cloud/discoveryengine/v1/conversational_search_service_pb.rb +12 -1
  36. data/lib/google/cloud/discoveryengine/v1/conversational_search_service_services_pb.rb +8 -0
  37. data/lib/google/cloud/discoveryengine/v1/data_store_pb.rb +2 -1
  38. data/lib/google/cloud/discoveryengine/v1/document_pb.rb +1 -1
  39. data/lib/google/cloud/discoveryengine/v1/engine_pb.rb +1 -1
  40. data/lib/google/cloud/discoveryengine/v1/grounded_generation_service_pb.rb +6 -1
  41. data/lib/google/cloud/discoveryengine/v1/import_config_pb.rb +1 -1
  42. data/lib/google/cloud/discoveryengine/v1/safety_pb.rb +47 -0
  43. data/lib/google/cloud/discoveryengine/v1/search_service_pb.rb +5 -1
  44. data/lib/google/cloud/discoveryengine/v1/serving_config_pb.rb +52 -0
  45. data/lib/google/cloud/discoveryengine/v1/serving_config_service_pb.rb +51 -0
  46. data/lib/google/cloud/discoveryengine/v1/serving_config_service_services_pb.rb +48 -0
  47. data/lib/google/cloud/discoveryengine/v1/session_pb.rb +3 -1
  48. data/lib/google/cloud/discoveryengine/v1/site_search_engine_pb.rb +2 -1
  49. data/lib/google/cloud/discoveryengine/v1/site_search_engine_service_pb.rb +10 -1
  50. data/lib/google/cloud/discoveryengine/v1/site_search_engine_service_services_pb.rb +7 -0
  51. data/lib/google/cloud/discoveryengine/v1/user_event_pb.rb +1 -1
  52. data/lib/google/cloud/discoveryengine/v1/user_event_service_pb.rb +1 -1
  53. data/proto_docs/google/api/client.rb +6 -0
  54. data/proto_docs/google/cloud/discoveryengine/v1/answer.rb +53 -2
  55. data/proto_docs/google/cloud/discoveryengine/v1/chunk.rb +2 -1
  56. data/proto_docs/google/cloud/discoveryengine/v1/common.rb +40 -0
  57. data/proto_docs/google/cloud/discoveryengine/v1/control.rb +122 -7
  58. data/proto_docs/google/cloud/discoveryengine/v1/conversational_search_service.rb +159 -2
  59. data/proto_docs/google/cloud/discoveryengine/v1/data_store.rb +25 -4
  60. data/proto_docs/google/cloud/discoveryengine/v1/document.rb +7 -2
  61. data/proto_docs/google/cloud/discoveryengine/v1/document_service.rb +1 -1
  62. data/proto_docs/google/cloud/discoveryengine/v1/engine.rb +16 -3
  63. data/proto_docs/google/cloud/discoveryengine/v1/grounded_generation_service.rb +90 -12
  64. data/proto_docs/google/cloud/discoveryengine/v1/import_config.rb +19 -1
  65. data/proto_docs/google/cloud/discoveryengine/v1/purge_config.rb +9 -5
  66. data/proto_docs/google/cloud/discoveryengine/v1/rank_service.rb +3 -1
  67. data/proto_docs/google/cloud/discoveryengine/v1/recommendation_service.rb +3 -3
  68. data/proto_docs/google/cloud/discoveryengine/v1/safety.rb +108 -0
  69. data/proto_docs/google/cloud/discoveryengine/v1/search_service.rb +109 -8
  70. data/proto_docs/google/cloud/discoveryengine/v1/serving_config.rb +261 -0
  71. data/proto_docs/google/cloud/discoveryengine/v1/serving_config_service.rb +44 -0
  72. data/proto_docs/google/cloud/discoveryengine/v1/session.rb +18 -0
  73. data/proto_docs/google/cloud/discoveryengine/v1/site_search_engine.rb +19 -2
  74. data/proto_docs/google/cloud/discoveryengine/v1/site_search_engine_service.rb +146 -4
  75. data/proto_docs/google/cloud/discoveryengine/v1/user_event.rb +34 -0
  76. data/proto_docs/google/cloud/discoveryengine/v1/user_event_service.rb +12 -4
  77. metadata +17 -3
@@ -453,7 +453,7 @@ module Google
453
453
  # Otherwise, an `ALREADY_EXISTS` error is returned.
454
454
  #
455
455
  # This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
456
- # standard with a length limit of 63 characters. Otherwise, an
456
+ # standard with a length limit of 128 characters. Otherwise, an
457
457
  # `INVALID_ARGUMENT` error is returned.
458
458
  # @yield [result, operation] Access the result along with the TransportOperation object
459
459
  # @yieldparam result [::Google::Cloud::DiscoveryEngine::V1::Document]
@@ -713,7 +713,7 @@ module Google
713
713
  # @param options [::Gapic::CallOptions, ::Hash]
714
714
  # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
715
715
  #
716
- # @overload import_documents(inline_source: nil, gcs_source: nil, bigquery_source: nil, fhir_store_source: nil, spanner_source: nil, cloud_sql_source: nil, firestore_source: nil, alloy_db_source: nil, bigtable_source: nil, parent: nil, error_config: nil, reconciliation_mode: nil, update_mask: nil, auto_generate_ids: nil, id_field: nil)
716
+ # @overload import_documents(inline_source: nil, gcs_source: nil, bigquery_source: nil, fhir_store_source: nil, spanner_source: nil, cloud_sql_source: nil, firestore_source: nil, alloy_db_source: nil, bigtable_source: nil, parent: nil, error_config: nil, reconciliation_mode: nil, update_mask: nil, auto_generate_ids: nil, id_field: nil, force_refresh_content: nil)
717
717
  # Pass arguments to `import_documents` via keyword arguments. Note that at
718
718
  # least one keyword argument is required. To specify no parameters, or to keep all
719
719
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -828,6 +828,12 @@ module Google
828
828
  # * {::Google::Cloud::DiscoveryEngine::V1::CloudSqlSource CloudSqlSource}.
829
829
  # * {::Google::Cloud::DiscoveryEngine::V1::FirestoreSource FirestoreSource}.
830
830
  # * {::Google::Cloud::DiscoveryEngine::V1::BigtableSource BigtableSource}.
831
+ # @param force_refresh_content [::Boolean]
832
+ # Optional. Whether to force refresh the unstructured content of the
833
+ # documents.
834
+ #
835
+ # If set to `true`, the content part of the documents will be refreshed
836
+ # regardless of the update status of the referencing content.
831
837
  # @yield [result, operation] Access the result along with the TransportOperation object
832
838
  # @yieldparam result [::Gapic::Operation]
833
839
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -315,8 +315,6 @@ module Google
315
315
  # For single-turn queries, this is a single instance. For multi-turn queries,
316
316
  # this is a repeated field that contains conversation history + latest
317
317
  # request.
318
- #
319
- # Only a single-turn query is supported currently.
320
318
  # @param generation_spec [::Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentRequest::GenerationSpec, ::Hash]
321
319
  # Content generation specification.
322
320
  # @param grounding_spec [::Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentRequest::GroundingSpec, ::Hash]
@@ -426,7 +424,7 @@ module Google
426
424
  # Required. The resource name of the grounding config, such as
427
425
  # `projects/*/locations/global/groundingConfigs/default_grounding_config`.
428
426
  # @param answer_candidate [::String]
429
- # Answer candidate to check. Can have a maximum length of 1024 characters.
427
+ # Answer candidate to check. It can have a maximum length of 4096 tokens.
430
428
  # @param facts [::Array<::Google::Cloud::DiscoveryEngine::V1::GroundingFact, ::Hash>]
431
429
  # List of facts for the grounding check.
432
430
  # We support up to 200 facts.
@@ -230,8 +230,6 @@ module Google
230
230
  # For single-turn queries, this is a single instance. For multi-turn queries,
231
231
  # this is a repeated field that contains conversation history + latest
232
232
  # request.
233
- #
234
- # Only a single-turn query is supported currently.
235
233
  # @param generation_spec [::Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentRequest::GenerationSpec, ::Hash]
236
234
  # Content generation specification.
237
235
  # @param grounding_spec [::Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentRequest::GroundingSpec, ::Hash]
@@ -334,7 +332,7 @@ module Google
334
332
  # Required. The resource name of the grounding config, such as
335
333
  # `projects/*/locations/global/groundingConfigs/default_grounding_config`.
336
334
  # @param answer_candidate [::String]
337
- # Answer candidate to check. Can have a maximum length of 1024 characters.
335
+ # Answer candidate to check. It can have a maximum length of 4096 tokens.
338
336
  # @param facts [::Array<::Google::Cloud::DiscoveryEngine::V1::GroundingFact, ::Hash>]
339
337
  # List of facts for the grounding check.
340
338
  # We support up to 200 facts.
@@ -228,7 +228,7 @@ module Google
228
228
  # @param model [::String]
229
229
  # The identifier of the model to use. It is one of:
230
230
  #
231
- # * `semantic-ranker-512@latest`: Semantic ranking model with maxiumn input
231
+ # * `semantic-ranker-512@latest`: Semantic ranking model with maximum input
232
232
  # token size 512.
233
233
  #
234
234
  # It is set to `semantic-ranker-512@latest` by default if unspecified.
@@ -221,7 +221,7 @@ module Google
221
221
  # @param model [::String]
222
222
  # The identifier of the model to use. It is one of:
223
223
  #
224
- # * `semantic-ranker-512@latest`: Semantic ranking model with maxiumn input
224
+ # * `semantic-ranker-512@latest`: Semantic ranking model with maximum input
225
225
  # token size 512.
226
226
  #
227
227
  # It is set to `semantic-ranker-512@latest` by default if unspecified.
@@ -224,7 +224,7 @@ module Google
224
224
  #
225
225
  # @param serving_config [::String]
226
226
  # Required. Full resource name of a
227
- # [ServingConfig][google.cloud.discoveryengine.v1.ServingConfig]:
227
+ # {::Google::Cloud::DiscoveryEngine::V1::ServingConfig ServingConfig}:
228
228
  # `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or
229
229
  # `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*`
230
230
  #
@@ -273,9 +273,9 @@ module Google
273
273
  # attribute-based expressions are expected instead of the above described
274
274
  # tag-based syntax. Examples:
275
275
  #
276
- # * (launguage: ANY("en", "es")) AND NOT (categories: ANY("Movie"))
276
+ # * (language: ANY("en", "es")) AND NOT (categories: ANY("Movie"))
277
277
  # * (available: true) AND
278
- # (launguage: ANY("en", "es")) OR (categories: ANY("Movie"))
278
+ # (language: ANY("en", "es")) OR (categories: ANY("Movie"))
279
279
  #
280
280
  # If your filter blocks all results, the API returns generic
281
281
  # (unfiltered) popular Documents. If you only want results strictly matching
@@ -217,7 +217,7 @@ module Google
217
217
  #
218
218
  # @param serving_config [::String]
219
219
  # Required. Full resource name of a
220
- # [ServingConfig][google.cloud.discoveryengine.v1.ServingConfig]:
220
+ # {::Google::Cloud::DiscoveryEngine::V1::ServingConfig ServingConfig}:
221
221
  # `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or
222
222
  # `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*`
223
223
  #
@@ -266,9 +266,9 @@ module Google
266
266
  # attribute-based expressions are expected instead of the above described
267
267
  # tag-based syntax. Examples:
268
268
  #
269
- # * (launguage: ANY("en", "es")) AND NOT (categories: ANY("Movie"))
269
+ # * (language: ANY("en", "es")) AND NOT (categories: ANY("Movie"))
270
270
  # * (available: true) AND
271
- # (launguage: ANY("en", "es")) OR (categories: ANY("Movie"))
271
+ # (language: ANY("en", "es")) OR (categories: ANY("Movie"))
272
272
  #
273
273
  # If your filter blocks all results, the API returns generic
274
274
  # (unfiltered) popular Documents. If you only want results strictly matching
@@ -29,6 +29,7 @@ require "google/cloud/discovery_engine/v1/rank_service/rest"
29
29
  require "google/cloud/discovery_engine/v1/recommendation_service/rest"
30
30
  require "google/cloud/discovery_engine/v1/schema_service/rest"
31
31
  require "google/cloud/discovery_engine/v1/search_tuning_service/rest"
32
+ require "google/cloud/discovery_engine/v1/serving_config_service/rest"
32
33
  require "google/cloud/discovery_engine/v1/site_search_engine_service/rest"
33
34
  require "google/cloud/discovery_engine/v1/user_event_service/rest"
34
35
  require "google/cloud/discovery_engine/v1/version"
@@ -217,7 +217,7 @@ module Google
217
217
  # @param options [::Gapic::CallOptions, ::Hash]
218
218
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
219
219
  #
220
- # @overload search(serving_config: nil, branch: nil, query: nil, image_query: nil, page_size: nil, page_token: nil, offset: nil, one_box_page_size: nil, data_store_specs: nil, filter: nil, canonical_filter: nil, order_by: nil, user_info: nil, language_code: nil, facet_specs: nil, boost_spec: nil, params: nil, query_expansion_spec: nil, spell_correction_spec: nil, user_pseudo_id: nil, content_search_spec: nil, safe_search: nil, user_labels: nil, search_as_you_type_spec: nil, session: nil, session_spec: nil)
220
+ # @overload search(serving_config: nil, branch: nil, query: nil, image_query: nil, page_size: nil, page_token: nil, offset: nil, one_box_page_size: nil, data_store_specs: nil, filter: nil, canonical_filter: nil, order_by: nil, user_info: nil, language_code: nil, facet_specs: nil, boost_spec: nil, params: nil, query_expansion_spec: nil, spell_correction_spec: nil, user_pseudo_id: nil, content_search_spec: nil, safe_search: nil, user_labels: nil, search_as_you_type_spec: nil, display_spec: nil, session: nil, session_spec: nil, relevance_threshold: nil, relevance_score_spec: nil)
221
221
  # Pass arguments to `search` via keyword arguments. Note that at
222
222
  # least one keyword argument is required. To specify no parameters, or to keep all
223
223
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -272,10 +272,13 @@ module Google
272
272
  # This applies to each OneBox type individually.
273
273
  # Default number is 10.
274
274
  # @param data_store_specs [::Array<::Google::Cloud::DiscoveryEngine::V1::SearchRequest::DataStoreSpec, ::Hash>]
275
- # Specs defining dataStores to filter on in a search call and configurations
276
- # for those dataStores. This is only considered for engines with multiple
277
- # dataStores use case. For single dataStore within an engine, they should
278
- # use the specs at the top level.
275
+ # Specifications that define the specific
276
+ # {::Google::Cloud::DiscoveryEngine::V1::DataStore DataStore}s to be searched,
277
+ # along with configurations for those data stores. This is only considered
278
+ # for {::Google::Cloud::DiscoveryEngine::V1::Engine Engine}s with multiple data
279
+ # stores. For engines with a single data store, the specs directly under
280
+ # {::Google::Cloud::DiscoveryEngine::V1::SearchRequest SearchRequest} should be
281
+ # used.
279
282
  # @param filter [::String]
280
283
  # The filter syntax consists of an expression language for constructing a
281
284
  # predicate from one or more fields of the documents being filtered. Filter
@@ -320,7 +323,7 @@ module Google
320
323
  # If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
321
324
  # @param user_info [::Google::Cloud::DiscoveryEngine::V1::UserInfo, ::Hash]
322
325
  # Information about the end user.
323
- # Highly recommended for analytics.
326
+ # Highly recommended for analytics and personalization.
324
327
  # {::Google::Cloud::DiscoveryEngine::V1::UserInfo#user_agent UserInfo.user_agent}
325
328
  # is used to deduce `device_type` for analytics.
326
329
  # @param language_code [::String]
@@ -402,6 +405,9 @@ module Google
402
405
  # Search as you type configuration. Only supported for the
403
406
  # {::Google::Cloud::DiscoveryEngine::V1::IndustryVertical::MEDIA IndustryVertical.MEDIA}
404
407
  # vertical.
408
+ # @param display_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::DisplaySpec, ::Hash]
409
+ # Optional. Config for display feature, like match highlighting on search
410
+ # results.
405
411
  # @param session [::String]
406
412
  # The session resource name. Optional.
407
413
  #
@@ -433,6 +439,16 @@ module Google
433
439
  # Session specification.
434
440
  #
435
441
  # Can be used only when `session` is set.
442
+ # @param relevance_threshold [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::RelevanceThreshold]
443
+ # The relevance threshold of the search results.
444
+ #
445
+ # Default to Google defined threshold, leveraging a balance of
446
+ # precision and recall to deliver both highly accurate results and
447
+ # comprehensive coverage of relevant information.
448
+ #
449
+ # This feature is not supported for healthcare search.
450
+ # @param relevance_score_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::RelevanceScoreSpec, ::Hash]
451
+ # Optional. The specification for returning the relevance score.
436
452
  #
437
453
  # @yield [response, operation] Access the result along with the RPC operation
438
454
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1::SearchResponse::SearchResult>]
@@ -529,7 +545,7 @@ module Google
529
545
  # @param options [::Gapic::CallOptions, ::Hash]
530
546
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
531
547
  #
532
- # @overload search_lite(serving_config: nil, branch: nil, query: nil, image_query: nil, page_size: nil, page_token: nil, offset: nil, one_box_page_size: nil, data_store_specs: nil, filter: nil, canonical_filter: nil, order_by: nil, user_info: nil, language_code: nil, facet_specs: nil, boost_spec: nil, params: nil, query_expansion_spec: nil, spell_correction_spec: nil, user_pseudo_id: nil, content_search_spec: nil, safe_search: nil, user_labels: nil, search_as_you_type_spec: nil, session: nil, session_spec: nil)
548
+ # @overload search_lite(serving_config: nil, branch: nil, query: nil, image_query: nil, page_size: nil, page_token: nil, offset: nil, one_box_page_size: nil, data_store_specs: nil, filter: nil, canonical_filter: nil, order_by: nil, user_info: nil, language_code: nil, facet_specs: nil, boost_spec: nil, params: nil, query_expansion_spec: nil, spell_correction_spec: nil, user_pseudo_id: nil, content_search_spec: nil, safe_search: nil, user_labels: nil, search_as_you_type_spec: nil, display_spec: nil, session: nil, session_spec: nil, relevance_threshold: nil, relevance_score_spec: nil)
533
549
  # Pass arguments to `search_lite` via keyword arguments. Note that at
534
550
  # least one keyword argument is required. To specify no parameters, or to keep all
535
551
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -584,10 +600,13 @@ module Google
584
600
  # This applies to each OneBox type individually.
585
601
  # Default number is 10.
586
602
  # @param data_store_specs [::Array<::Google::Cloud::DiscoveryEngine::V1::SearchRequest::DataStoreSpec, ::Hash>]
587
- # Specs defining dataStores to filter on in a search call and configurations
588
- # for those dataStores. This is only considered for engines with multiple
589
- # dataStores use case. For single dataStore within an engine, they should
590
- # use the specs at the top level.
603
+ # Specifications that define the specific
604
+ # {::Google::Cloud::DiscoveryEngine::V1::DataStore DataStore}s to be searched,
605
+ # along with configurations for those data stores. This is only considered
606
+ # for {::Google::Cloud::DiscoveryEngine::V1::Engine Engine}s with multiple data
607
+ # stores. For engines with a single data store, the specs directly under
608
+ # {::Google::Cloud::DiscoveryEngine::V1::SearchRequest SearchRequest} should be
609
+ # used.
591
610
  # @param filter [::String]
592
611
  # The filter syntax consists of an expression language for constructing a
593
612
  # predicate from one or more fields of the documents being filtered. Filter
@@ -632,7 +651,7 @@ module Google
632
651
  # If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
633
652
  # @param user_info [::Google::Cloud::DiscoveryEngine::V1::UserInfo, ::Hash]
634
653
  # Information about the end user.
635
- # Highly recommended for analytics.
654
+ # Highly recommended for analytics and personalization.
636
655
  # {::Google::Cloud::DiscoveryEngine::V1::UserInfo#user_agent UserInfo.user_agent}
637
656
  # is used to deduce `device_type` for analytics.
638
657
  # @param language_code [::String]
@@ -714,6 +733,9 @@ module Google
714
733
  # Search as you type configuration. Only supported for the
715
734
  # {::Google::Cloud::DiscoveryEngine::V1::IndustryVertical::MEDIA IndustryVertical.MEDIA}
716
735
  # vertical.
736
+ # @param display_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::DisplaySpec, ::Hash]
737
+ # Optional. Config for display feature, like match highlighting on search
738
+ # results.
717
739
  # @param session [::String]
718
740
  # The session resource name. Optional.
719
741
  #
@@ -745,6 +767,16 @@ module Google
745
767
  # Session specification.
746
768
  #
747
769
  # Can be used only when `session` is set.
770
+ # @param relevance_threshold [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::RelevanceThreshold]
771
+ # The relevance threshold of the search results.
772
+ #
773
+ # Default to Google defined threshold, leveraging a balance of
774
+ # precision and recall to deliver both highly accurate results and
775
+ # comprehensive coverage of relevant information.
776
+ #
777
+ # This feature is not supported for healthcare search.
778
+ # @param relevance_score_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::RelevanceScoreSpec, ::Hash]
779
+ # Optional. The specification for returning the relevance score.
748
780
  #
749
781
  # @yield [response, operation] Access the result along with the RPC operation
750
782
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1::SearchResponse::SearchResult>]
@@ -210,7 +210,7 @@ module Google
210
210
  # @param options [::Gapic::CallOptions, ::Hash]
211
211
  # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
212
212
  #
213
- # @overload search(serving_config: nil, branch: nil, query: nil, image_query: nil, page_size: nil, page_token: nil, offset: nil, one_box_page_size: nil, data_store_specs: nil, filter: nil, canonical_filter: nil, order_by: nil, user_info: nil, language_code: nil, facet_specs: nil, boost_spec: nil, params: nil, query_expansion_spec: nil, spell_correction_spec: nil, user_pseudo_id: nil, content_search_spec: nil, safe_search: nil, user_labels: nil, search_as_you_type_spec: nil, session: nil, session_spec: nil)
213
+ # @overload search(serving_config: nil, branch: nil, query: nil, image_query: nil, page_size: nil, page_token: nil, offset: nil, one_box_page_size: nil, data_store_specs: nil, filter: nil, canonical_filter: nil, order_by: nil, user_info: nil, language_code: nil, facet_specs: nil, boost_spec: nil, params: nil, query_expansion_spec: nil, spell_correction_spec: nil, user_pseudo_id: nil, content_search_spec: nil, safe_search: nil, user_labels: nil, search_as_you_type_spec: nil, display_spec: nil, session: nil, session_spec: nil, relevance_threshold: nil, relevance_score_spec: nil)
214
214
  # Pass arguments to `search` via keyword arguments. Note that at
215
215
  # least one keyword argument is required. To specify no parameters, or to keep all
216
216
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -265,10 +265,13 @@ module Google
265
265
  # This applies to each OneBox type individually.
266
266
  # Default number is 10.
267
267
  # @param data_store_specs [::Array<::Google::Cloud::DiscoveryEngine::V1::SearchRequest::DataStoreSpec, ::Hash>]
268
- # Specs defining dataStores to filter on in a search call and configurations
269
- # for those dataStores. This is only considered for engines with multiple
270
- # dataStores use case. For single dataStore within an engine, they should
271
- # use the specs at the top level.
268
+ # Specifications that define the specific
269
+ # {::Google::Cloud::DiscoveryEngine::V1::DataStore DataStore}s to be searched,
270
+ # along with configurations for those data stores. This is only considered
271
+ # for {::Google::Cloud::DiscoveryEngine::V1::Engine Engine}s with multiple data
272
+ # stores. For engines with a single data store, the specs directly under
273
+ # {::Google::Cloud::DiscoveryEngine::V1::SearchRequest SearchRequest} should be
274
+ # used.
272
275
  # @param filter [::String]
273
276
  # The filter syntax consists of an expression language for constructing a
274
277
  # predicate from one or more fields of the documents being filtered. Filter
@@ -313,7 +316,7 @@ module Google
313
316
  # If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
314
317
  # @param user_info [::Google::Cloud::DiscoveryEngine::V1::UserInfo, ::Hash]
315
318
  # Information about the end user.
316
- # Highly recommended for analytics.
319
+ # Highly recommended for analytics and personalization.
317
320
  # {::Google::Cloud::DiscoveryEngine::V1::UserInfo#user_agent UserInfo.user_agent}
318
321
  # is used to deduce `device_type` for analytics.
319
322
  # @param language_code [::String]
@@ -395,6 +398,9 @@ module Google
395
398
  # Search as you type configuration. Only supported for the
396
399
  # {::Google::Cloud::DiscoveryEngine::V1::IndustryVertical::MEDIA IndustryVertical.MEDIA}
397
400
  # vertical.
401
+ # @param display_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::DisplaySpec, ::Hash]
402
+ # Optional. Config for display feature, like match highlighting on search
403
+ # results.
398
404
  # @param session [::String]
399
405
  # The session resource name. Optional.
400
406
  #
@@ -426,6 +432,16 @@ module Google
426
432
  # Session specification.
427
433
  #
428
434
  # Can be used only when `session` is set.
435
+ # @param relevance_threshold [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::RelevanceThreshold]
436
+ # The relevance threshold of the search results.
437
+ #
438
+ # Default to Google defined threshold, leveraging a balance of
439
+ # precision and recall to deliver both highly accurate results and
440
+ # comprehensive coverage of relevant information.
441
+ #
442
+ # This feature is not supported for healthcare search.
443
+ # @param relevance_score_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::RelevanceScoreSpec, ::Hash]
444
+ # Optional. The specification for returning the relevance score.
429
445
  # @yield [result, operation] Access the result along with the TransportOperation object
430
446
  # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1::SearchResponse::SearchResult>]
431
447
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -515,7 +531,7 @@ module Google
515
531
  # @param options [::Gapic::CallOptions, ::Hash]
516
532
  # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
517
533
  #
518
- # @overload search_lite(serving_config: nil, branch: nil, query: nil, image_query: nil, page_size: nil, page_token: nil, offset: nil, one_box_page_size: nil, data_store_specs: nil, filter: nil, canonical_filter: nil, order_by: nil, user_info: nil, language_code: nil, facet_specs: nil, boost_spec: nil, params: nil, query_expansion_spec: nil, spell_correction_spec: nil, user_pseudo_id: nil, content_search_spec: nil, safe_search: nil, user_labels: nil, search_as_you_type_spec: nil, session: nil, session_spec: nil)
534
+ # @overload search_lite(serving_config: nil, branch: nil, query: nil, image_query: nil, page_size: nil, page_token: nil, offset: nil, one_box_page_size: nil, data_store_specs: nil, filter: nil, canonical_filter: nil, order_by: nil, user_info: nil, language_code: nil, facet_specs: nil, boost_spec: nil, params: nil, query_expansion_spec: nil, spell_correction_spec: nil, user_pseudo_id: nil, content_search_spec: nil, safe_search: nil, user_labels: nil, search_as_you_type_spec: nil, display_spec: nil, session: nil, session_spec: nil, relevance_threshold: nil, relevance_score_spec: nil)
519
535
  # Pass arguments to `search_lite` via keyword arguments. Note that at
520
536
  # least one keyword argument is required. To specify no parameters, or to keep all
521
537
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -570,10 +586,13 @@ module Google
570
586
  # This applies to each OneBox type individually.
571
587
  # Default number is 10.
572
588
  # @param data_store_specs [::Array<::Google::Cloud::DiscoveryEngine::V1::SearchRequest::DataStoreSpec, ::Hash>]
573
- # Specs defining dataStores to filter on in a search call and configurations
574
- # for those dataStores. This is only considered for engines with multiple
575
- # dataStores use case. For single dataStore within an engine, they should
576
- # use the specs at the top level.
589
+ # Specifications that define the specific
590
+ # {::Google::Cloud::DiscoveryEngine::V1::DataStore DataStore}s to be searched,
591
+ # along with configurations for those data stores. This is only considered
592
+ # for {::Google::Cloud::DiscoveryEngine::V1::Engine Engine}s with multiple data
593
+ # stores. For engines with a single data store, the specs directly under
594
+ # {::Google::Cloud::DiscoveryEngine::V1::SearchRequest SearchRequest} should be
595
+ # used.
577
596
  # @param filter [::String]
578
597
  # The filter syntax consists of an expression language for constructing a
579
598
  # predicate from one or more fields of the documents being filtered. Filter
@@ -618,7 +637,7 @@ module Google
618
637
  # If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
619
638
  # @param user_info [::Google::Cloud::DiscoveryEngine::V1::UserInfo, ::Hash]
620
639
  # Information about the end user.
621
- # Highly recommended for analytics.
640
+ # Highly recommended for analytics and personalization.
622
641
  # {::Google::Cloud::DiscoveryEngine::V1::UserInfo#user_agent UserInfo.user_agent}
623
642
  # is used to deduce `device_type` for analytics.
624
643
  # @param language_code [::String]
@@ -700,6 +719,9 @@ module Google
700
719
  # Search as you type configuration. Only supported for the
701
720
  # {::Google::Cloud::DiscoveryEngine::V1::IndustryVertical::MEDIA IndustryVertical.MEDIA}
702
721
  # vertical.
722
+ # @param display_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::DisplaySpec, ::Hash]
723
+ # Optional. Config for display feature, like match highlighting on search
724
+ # results.
703
725
  # @param session [::String]
704
726
  # The session resource name. Optional.
705
727
  #
@@ -731,6 +753,16 @@ module Google
731
753
  # Session specification.
732
754
  #
733
755
  # Can be used only when `session` is set.
756
+ # @param relevance_threshold [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::RelevanceThreshold]
757
+ # The relevance threshold of the search results.
758
+ #
759
+ # Default to Google defined threshold, leveraging a balance of
760
+ # precision and recall to deliver both highly accurate results and
761
+ # comprehensive coverage of relevant information.
762
+ #
763
+ # This feature is not supported for healthcare search.
764
+ # @param relevance_score_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::RelevanceScoreSpec, ::Hash]
765
+ # Optional. The specification for returning the relevance score.
734
766
  # @yield [result, operation] Access the result along with the TransportOperation object
735
767
  # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1::SearchResponse::SearchResult>]
736
768
  # @yieldparam operation [::Gapic::Rest::TransportOperation]