google-cloud-discovery_engine-v1beta 0.14.2 → 0.16.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/google/cloud/discovery_engine/v1beta/completion_service/client.rb +155 -0
- data/lib/google/cloud/discovery_engine/v1beta/completion_service/paths.rb +62 -0
- data/lib/google/cloud/discovery_engine/v1beta/completion_service/rest/client.rb +148 -0
- data/lib/google/cloud/discovery_engine/v1beta/completion_service/rest/service_stub.rb +76 -0
- data/lib/google/cloud/discovery_engine/v1beta/control_service/client.rb +6 -6
- data/lib/google/cloud/discovery_engine/v1beta/control_service/rest/client.rb +6 -6
- data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/client.rb +18 -13
- data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/rest/client.rb +18 -13
- data/lib/google/cloud/discovery_engine/v1beta/document_service/client.rb +109 -1
- data/lib/google/cloud/discovery_engine/v1beta/document_service/paths.rb +25 -0
- data/lib/google/cloud/discovery_engine/v1beta/document_service/rest/client.rb +102 -1
- data/lib/google/cloud/discovery_engine/v1beta/document_service/rest/service_stub.rb +66 -0
- data/lib/google/cloud/discovery_engine/v1beta/engine_service/client.rb +3 -3
- data/lib/google/cloud/discovery_engine/v1beta/engine_service/rest/client.rb +3 -3
- data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/client.rb +218 -4
- data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/paths.rb +85 -0
- data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/rest/client.rb +125 -4
- data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/rest/service_stub.rb +60 -0
- data/lib/google/cloud/discovery_engine/v1beta/rank_service/client.rb +1 -1
- data/lib/google/cloud/discovery_engine/v1beta/rank_service/rest/client.rb +1 -1
- data/lib/google/cloud/discovery_engine/v1beta/search_service/client.rb +410 -4
- data/lib/google/cloud/discovery_engine/v1beta/search_service/rest/client.rb +402 -4
- data/lib/google/cloud/discovery_engine/v1beta/search_service/rest/service_stub.rb +76 -0
- data/lib/google/cloud/discovery_engine/v1beta/serving_config_service/client.rb +2 -2
- data/lib/google/cloud/discovery_engine/v1beta/serving_config_service/rest/client.rb +2 -2
- data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/client.rb +324 -1
- data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/paths.rb +49 -0
- data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/rest/client.rb +303 -1
- data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/rest/service_stub.rb +193 -0
- data/lib/google/cloud/discovery_engine/v1beta/user_event_service/client.rb +1 -1
- data/lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/client.rb +1 -1
- data/lib/google/cloud/discovery_engine/v1beta/version.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/answer_pb.rb +2 -1
- data/lib/google/cloud/discoveryengine/v1beta/common_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/completion_service_pb.rb +18 -1
- data/lib/google/cloud/discoveryengine/v1beta/completion_service_services_pb.rb +2 -0
- data/lib/google/cloud/discoveryengine/v1beta/control_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/conversational_search_service_pb.rb +4 -1
- data/lib/google/cloud/discoveryengine/v1beta/custom_tuning_model_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/data_store_pb.rb +7 -1
- data/lib/google/cloud/discoveryengine/v1beta/document_pb.rb +4 -1
- data/lib/google/cloud/discoveryengine/v1beta/document_service_pb.rb +11 -1
- data/lib/google/cloud/discoveryengine/v1beta/document_service_services_pb.rb +4 -0
- data/lib/google/cloud/discoveryengine/v1beta/engine_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/grounded_generation_service_pb.rb +24 -1
- data/lib/google/cloud/discoveryengine/v1beta/grounded_generation_service_services_pb.rb +4 -0
- data/lib/google/cloud/discoveryengine/v1beta/grounding_pb.rb +2 -1
- data/lib/google/cloud/discoveryengine/v1beta/import_config_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/purge_config_pb.rb +5 -1
- data/lib/google/cloud/discoveryengine/v1beta/search_service_pb.rb +6 -1
- data/lib/google/cloud/discoveryengine/v1beta/search_service_services_pb.rb +14 -0
- data/lib/google/cloud/discoveryengine/v1beta/serving_config_pb.rb +2 -2
- data/lib/google/cloud/discoveryengine/v1beta/site_search_engine_pb.rb +2 -1
- data/lib/google/cloud/discoveryengine/v1beta/site_search_engine_service_pb.rb +10 -1
- data/lib/google/cloud/discoveryengine/v1beta/site_search_engine_service_services_pb.rb +7 -0
- data/lib/google/cloud/discoveryengine/v1beta/user_event_pb.rb +1 -1
- data/proto_docs/google/api/client.rb +20 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/answer.rb +68 -8
- data/proto_docs/google/cloud/discoveryengine/v1beta/completion_service.rb +268 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/control.rb +10 -1
- data/proto_docs/google/cloud/discoveryengine/v1beta/control_service.rb +6 -6
- data/proto_docs/google/cloud/discoveryengine/v1beta/conversational_search_service.rb +98 -15
- data/proto_docs/google/cloud/discoveryengine/v1beta/custom_tuning_model.rb +11 -3
- data/proto_docs/google/cloud/discoveryengine/v1beta/data_store.rb +131 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/document.rb +22 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/document_processing_config.rb +9 -5
- data/proto_docs/google/cloud/discoveryengine/v1beta/document_service.rb +123 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/engine.rb +5 -1
- data/proto_docs/google/cloud/discoveryengine/v1beta/engine_service.rb +4 -4
- data/proto_docs/google/cloud/discoveryengine/v1beta/grounded_generation_service.rb +398 -2
- data/proto_docs/google/cloud/discoveryengine/v1beta/grounding.rb +10 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/import_config.rb +13 -7
- data/proto_docs/google/cloud/discoveryengine/v1beta/project.rb +1 -1
- data/proto_docs/google/cloud/discoveryengine/v1beta/purge_config.rb +39 -1
- data/proto_docs/google/cloud/discoveryengine/v1beta/rank_service.rb +1 -1
- data/proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb +175 -6
- data/proto_docs/google/cloud/discoveryengine/v1beta/serving_config.rb +16 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/serving_config_service.rb +2 -2
- data/proto_docs/google/cloud/discoveryengine/v1beta/site_search_engine.rb +17 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/site_search_engine_service.rb +147 -1
- data/proto_docs/google/cloud/discoveryengine/v1beta/user_event.rb +13 -1
- metadata +3 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 03ccf808ee4fe5e65560966192cbc367522c8aaedfd4a21bfadb17a34afe5395
|
4
|
+
data.tar.gz: c048a44de610ddce2da04abd17d2e97a53b2b303d820cc3cb9a9906eee562d33
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 5479fd924bf38180abed0eef647521985fcb9bbc9af2c8870d5d5ea131ede9d5c3b7dd326c480ad0a1b491a352ea0d769ea5b46ade241cba7d320252fad341c1
|
7
|
+
data.tar.gz: 6a945dbda3267553c018174928bd1b346474933d8239e064265d07e46061642f376061fd806ac7aef047ca2d5cffe39f27b64dbf25e2125a52ec2fe90263d791
|
@@ -326,6 +326,154 @@ module Google
|
|
326
326
|
raise ::Google::Cloud::Error.from_error(e)
|
327
327
|
end
|
328
328
|
|
329
|
+
##
|
330
|
+
# Completes the user input with advanced keyword suggestions.
|
331
|
+
#
|
332
|
+
# @overload advanced_complete_query(request, options = nil)
|
333
|
+
# Pass arguments to `advanced_complete_query` via a request object, either of type
|
334
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::AdvancedCompleteQueryRequest} or an equivalent Hash.
|
335
|
+
#
|
336
|
+
# @param request [::Google::Cloud::DiscoveryEngine::V1beta::AdvancedCompleteQueryRequest, ::Hash]
|
337
|
+
# A request object representing the call parameters. Required. To specify no
|
338
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
339
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
340
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
341
|
+
#
|
342
|
+
# @overload advanced_complete_query(completion_config: nil, query: nil, query_model: nil, user_pseudo_id: nil, user_info: nil, include_tail_suggestions: nil, boost_spec: nil, suggestion_types: nil)
|
343
|
+
# Pass arguments to `advanced_complete_query` via keyword arguments. Note that at
|
344
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
345
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
346
|
+
#
|
347
|
+
# @param completion_config [::String]
|
348
|
+
# Required. The completion_config of the parent dataStore or engine resource
|
349
|
+
# name for which the completion is performed, such as
|
350
|
+
# `projects/*/locations/global/collections/default_collection/dataStores/*/completionConfig`
|
351
|
+
# `projects/*/locations/global/collections/default_collection/engines/*/completionConfig`.
|
352
|
+
# @param query [::String]
|
353
|
+
# Required. The typeahead input used to fetch suggestions. Maximum length is
|
354
|
+
# 128 characters.
|
355
|
+
#
|
356
|
+
# The query can not be empty for most of the suggestion types. If it is
|
357
|
+
# empty, an `INVALID_ARGUMENT` error is returned. The exception is when the
|
358
|
+
# suggestion_types contains only the type `RECENT_SEARCH`, the query can
|
359
|
+
# be an empty string. The is called "zero prefix" feature, which returns
|
360
|
+
# user's recently searched queries given the empty query.
|
361
|
+
# @param query_model [::String]
|
362
|
+
# Specifies the autocomplete data model. This overrides any model specified
|
363
|
+
# in the Configuration > Autocomplete section of the Cloud console. Currently
|
364
|
+
# supported values:
|
365
|
+
#
|
366
|
+
# * `document` - Using suggestions generated from user-imported documents.
|
367
|
+
# * `search-history` - Using suggestions generated from the past history of
|
368
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SearchService::Client#search SearchService.Search}
|
369
|
+
# API calls. Do not use it when there is no traffic for Search API.
|
370
|
+
# * `user-event` - Using suggestions generated from user-imported search
|
371
|
+
# events.
|
372
|
+
# * `document-completable` - Using suggestions taken directly from
|
373
|
+
# user-imported document fields marked as completable.
|
374
|
+
#
|
375
|
+
# Default values:
|
376
|
+
#
|
377
|
+
# * `document` is the default model for regular dataStores.
|
378
|
+
# * `search-history` is the default model for site search dataStores.
|
379
|
+
# @param user_pseudo_id [::String]
|
380
|
+
# A unique identifier for tracking visitors. For example, this could be
|
381
|
+
# implemented with an HTTP cookie, which should be able to uniquely identify
|
382
|
+
# a visitor on a single device. This unique identifier should not change if
|
383
|
+
# the visitor logs in or out of the website.
|
384
|
+
#
|
385
|
+
# This field should NOT have a fixed value such as `unknown_visitor`.
|
386
|
+
#
|
387
|
+
# This should be the same identifier as
|
388
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::UserEvent#user_pseudo_id UserEvent.user_pseudo_id}
|
389
|
+
# and
|
390
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#user_pseudo_id SearchRequest.user_pseudo_id}.
|
391
|
+
#
|
392
|
+
# The field must be a UTF-8 encoded string with a length limit of 128
|
393
|
+
# @param user_info [::Google::Cloud::DiscoveryEngine::V1beta::UserInfo, ::Hash]
|
394
|
+
# Optional. Information about the end user.
|
395
|
+
#
|
396
|
+
# This should be the same identifier information as
|
397
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::UserEvent#user_info UserEvent.user_info}
|
398
|
+
# and
|
399
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#user_info SearchRequest.user_info}.
|
400
|
+
# @param include_tail_suggestions [::Boolean]
|
401
|
+
# Indicates if tail suggestions should be returned if there are no
|
402
|
+
# suggestions that match the full query. Even if set to true, if there are
|
403
|
+
# suggestions that match the full query, those are returned and no
|
404
|
+
# tail suggestions are returned.
|
405
|
+
# @param boost_spec [::Google::Cloud::DiscoveryEngine::V1beta::AdvancedCompleteQueryRequest::BoostSpec, ::Hash]
|
406
|
+
# Optional. Specification to boost suggestions matching the condition.
|
407
|
+
# @param suggestion_types [::Array<::Google::Cloud::DiscoveryEngine::V1beta::AdvancedCompleteQueryRequest::SuggestionType>]
|
408
|
+
# Optional. Suggestion types to return. If empty or unspecified, query
|
409
|
+
# suggestions are returned. Only one suggestion type is supported at the
|
410
|
+
# moment.
|
411
|
+
#
|
412
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
413
|
+
# @yieldparam response [::Google::Cloud::DiscoveryEngine::V1beta::AdvancedCompleteQueryResponse]
|
414
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
415
|
+
#
|
416
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::AdvancedCompleteQueryResponse]
|
417
|
+
#
|
418
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
419
|
+
#
|
420
|
+
# @example Basic example
|
421
|
+
# require "google/cloud/discovery_engine/v1beta"
|
422
|
+
#
|
423
|
+
# # Create a client object. The client can be reused for multiple calls.
|
424
|
+
# client = Google::Cloud::DiscoveryEngine::V1beta::CompletionService::Client.new
|
425
|
+
#
|
426
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
427
|
+
# request = Google::Cloud::DiscoveryEngine::V1beta::AdvancedCompleteQueryRequest.new
|
428
|
+
#
|
429
|
+
# # Call the advanced_complete_query method.
|
430
|
+
# result = client.advanced_complete_query request
|
431
|
+
#
|
432
|
+
# # The returned object is of type Google::Cloud::DiscoveryEngine::V1beta::AdvancedCompleteQueryResponse.
|
433
|
+
# p result
|
434
|
+
#
|
435
|
+
def advanced_complete_query request, options = nil
|
436
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
437
|
+
|
438
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1beta::AdvancedCompleteQueryRequest
|
439
|
+
|
440
|
+
# Converts hash and nil to an options object
|
441
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
442
|
+
|
443
|
+
# Customize the options with defaults
|
444
|
+
metadata = @config.rpcs.advanced_complete_query.metadata.to_h
|
445
|
+
|
446
|
+
# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
|
447
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
448
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
449
|
+
gapic_version: ::Google::Cloud::DiscoveryEngine::V1beta::VERSION
|
450
|
+
metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
|
451
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
452
|
+
|
453
|
+
header_params = {}
|
454
|
+
if request.completion_config
|
455
|
+
header_params["completion_config"] = request.completion_config
|
456
|
+
end
|
457
|
+
|
458
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
459
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
460
|
+
|
461
|
+
options.apply_defaults timeout: @config.rpcs.advanced_complete_query.timeout,
|
462
|
+
metadata: metadata,
|
463
|
+
retry_policy: @config.rpcs.advanced_complete_query.retry_policy
|
464
|
+
|
465
|
+
options.apply_defaults timeout: @config.timeout,
|
466
|
+
metadata: @config.metadata,
|
467
|
+
retry_policy: @config.retry_policy
|
468
|
+
|
469
|
+
@completion_service_stub.call_rpc :advanced_complete_query, request, options: options do |response, operation|
|
470
|
+
yield response, operation if block_given?
|
471
|
+
return response
|
472
|
+
end
|
473
|
+
rescue ::GRPC::BadStatus => e
|
474
|
+
raise ::Google::Cloud::Error.from_error(e)
|
475
|
+
end
|
476
|
+
|
329
477
|
##
|
330
478
|
# Imports all
|
331
479
|
# {::Google::Cloud::DiscoveryEngine::V1beta::SuggestionDenyListEntry SuggestionDenyListEntry}
|
@@ -895,6 +1043,11 @@ module Google
|
|
895
1043
|
#
|
896
1044
|
attr_reader :complete_query
|
897
1045
|
##
|
1046
|
+
# RPC-specific configuration for `advanced_complete_query`
|
1047
|
+
# @return [::Gapic::Config::Method]
|
1048
|
+
#
|
1049
|
+
attr_reader :advanced_complete_query
|
1050
|
+
##
|
898
1051
|
# RPC-specific configuration for `import_suggestion_deny_list_entries`
|
899
1052
|
# @return [::Gapic::Config::Method]
|
900
1053
|
#
|
@@ -919,6 +1072,8 @@ module Google
|
|
919
1072
|
def initialize parent_rpcs = nil
|
920
1073
|
complete_query_config = parent_rpcs.complete_query if parent_rpcs.respond_to? :complete_query
|
921
1074
|
@complete_query = ::Gapic::Config::Method.new complete_query_config
|
1075
|
+
advanced_complete_query_config = parent_rpcs.advanced_complete_query if parent_rpcs.respond_to? :advanced_complete_query
|
1076
|
+
@advanced_complete_query = ::Gapic::Config::Method.new advanced_complete_query_config
|
922
1077
|
import_suggestion_deny_list_entries_config = parent_rpcs.import_suggestion_deny_list_entries if parent_rpcs.respond_to? :import_suggestion_deny_list_entries
|
923
1078
|
@import_suggestion_deny_list_entries = ::Gapic::Config::Method.new import_suggestion_deny_list_entries_config
|
924
1079
|
purge_suggestion_deny_list_entries_config = parent_rpcs.purge_suggestion_deny_list_entries if parent_rpcs.respond_to? :purge_suggestion_deny_list_entries
|
@@ -24,6 +24,68 @@ module Google
|
|
24
24
|
module CompletionService
|
25
25
|
# Path helper methods for the CompletionService API.
|
26
26
|
module Paths
|
27
|
+
##
|
28
|
+
# Create a fully-qualified CompletionConfig resource string.
|
29
|
+
#
|
30
|
+
# @overload completion_config_path(project:, location:, data_store:)
|
31
|
+
# The resource will be in the following format:
|
32
|
+
#
|
33
|
+
# `projects/{project}/locations/{location}/dataStores/{data_store}/completionConfig`
|
34
|
+
#
|
35
|
+
# @param project [String]
|
36
|
+
# @param location [String]
|
37
|
+
# @param data_store [String]
|
38
|
+
#
|
39
|
+
# @overload completion_config_path(project:, location:, collection:, data_store:)
|
40
|
+
# The resource will be in the following format:
|
41
|
+
#
|
42
|
+
# `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/completionConfig`
|
43
|
+
#
|
44
|
+
# @param project [String]
|
45
|
+
# @param location [String]
|
46
|
+
# @param collection [String]
|
47
|
+
# @param data_store [String]
|
48
|
+
#
|
49
|
+
# @overload completion_config_path(project:, location:, collection:, engine:)
|
50
|
+
# The resource will be in the following format:
|
51
|
+
#
|
52
|
+
# `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/completionConfig`
|
53
|
+
#
|
54
|
+
# @param project [String]
|
55
|
+
# @param location [String]
|
56
|
+
# @param collection [String]
|
57
|
+
# @param engine [String]
|
58
|
+
#
|
59
|
+
# @return [::String]
|
60
|
+
def completion_config_path **args
|
61
|
+
resources = {
|
62
|
+
"data_store:location:project" => (proc do |project:, location:, data_store:|
|
63
|
+
raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
|
64
|
+
raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
|
65
|
+
|
66
|
+
"projects/#{project}/locations/#{location}/dataStores/#{data_store}/completionConfig"
|
67
|
+
end),
|
68
|
+
"collection:data_store:location:project" => (proc do |project:, location:, collection:, data_store:|
|
69
|
+
raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
|
70
|
+
raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
|
71
|
+
raise ::ArgumentError, "collection cannot contain /" if collection.to_s.include? "/"
|
72
|
+
|
73
|
+
"projects/#{project}/locations/#{location}/collections/#{collection}/dataStores/#{data_store}/completionConfig"
|
74
|
+
end),
|
75
|
+
"collection:engine:location:project" => (proc do |project:, location:, collection:, engine:|
|
76
|
+
raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
|
77
|
+
raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
|
78
|
+
raise ::ArgumentError, "collection cannot contain /" if collection.to_s.include? "/"
|
79
|
+
|
80
|
+
"projects/#{project}/locations/#{location}/collections/#{collection}/engines/#{engine}/completionConfig"
|
81
|
+
end)
|
82
|
+
}
|
83
|
+
|
84
|
+
resource = resources[args.keys.sort.join(":")]
|
85
|
+
raise ::ArgumentError, "no resource found for values #{args.keys}" if resource.nil?
|
86
|
+
resource.call(**args)
|
87
|
+
end
|
88
|
+
|
27
89
|
##
|
28
90
|
# Create a fully-qualified DataStore resource string.
|
29
91
|
#
|
@@ -312,6 +312,147 @@ module Google
|
|
312
312
|
raise ::Google::Cloud::Error.from_error(e)
|
313
313
|
end
|
314
314
|
|
315
|
+
##
|
316
|
+
# Completes the user input with advanced keyword suggestions.
|
317
|
+
#
|
318
|
+
# @overload advanced_complete_query(request, options = nil)
|
319
|
+
# Pass arguments to `advanced_complete_query` via a request object, either of type
|
320
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::AdvancedCompleteQueryRequest} or an equivalent Hash.
|
321
|
+
#
|
322
|
+
# @param request [::Google::Cloud::DiscoveryEngine::V1beta::AdvancedCompleteQueryRequest, ::Hash]
|
323
|
+
# A request object representing the call parameters. Required. To specify no
|
324
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
325
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
326
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
327
|
+
#
|
328
|
+
# @overload advanced_complete_query(completion_config: nil, query: nil, query_model: nil, user_pseudo_id: nil, user_info: nil, include_tail_suggestions: nil, boost_spec: nil, suggestion_types: nil)
|
329
|
+
# Pass arguments to `advanced_complete_query` via keyword arguments. Note that at
|
330
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
331
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
332
|
+
#
|
333
|
+
# @param completion_config [::String]
|
334
|
+
# Required. The completion_config of the parent dataStore or engine resource
|
335
|
+
# name for which the completion is performed, such as
|
336
|
+
# `projects/*/locations/global/collections/default_collection/dataStores/*/completionConfig`
|
337
|
+
# `projects/*/locations/global/collections/default_collection/engines/*/completionConfig`.
|
338
|
+
# @param query [::String]
|
339
|
+
# Required. The typeahead input used to fetch suggestions. Maximum length is
|
340
|
+
# 128 characters.
|
341
|
+
#
|
342
|
+
# The query can not be empty for most of the suggestion types. If it is
|
343
|
+
# empty, an `INVALID_ARGUMENT` error is returned. The exception is when the
|
344
|
+
# suggestion_types contains only the type `RECENT_SEARCH`, the query can
|
345
|
+
# be an empty string. The is called "zero prefix" feature, which returns
|
346
|
+
# user's recently searched queries given the empty query.
|
347
|
+
# @param query_model [::String]
|
348
|
+
# Specifies the autocomplete data model. This overrides any model specified
|
349
|
+
# in the Configuration > Autocomplete section of the Cloud console. Currently
|
350
|
+
# supported values:
|
351
|
+
#
|
352
|
+
# * `document` - Using suggestions generated from user-imported documents.
|
353
|
+
# * `search-history` - Using suggestions generated from the past history of
|
354
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SearchService::Rest::Client#search SearchService.Search}
|
355
|
+
# API calls. Do not use it when there is no traffic for Search API.
|
356
|
+
# * `user-event` - Using suggestions generated from user-imported search
|
357
|
+
# events.
|
358
|
+
# * `document-completable` - Using suggestions taken directly from
|
359
|
+
# user-imported document fields marked as completable.
|
360
|
+
#
|
361
|
+
# Default values:
|
362
|
+
#
|
363
|
+
# * `document` is the default model for regular dataStores.
|
364
|
+
# * `search-history` is the default model for site search dataStores.
|
365
|
+
# @param user_pseudo_id [::String]
|
366
|
+
# A unique identifier for tracking visitors. For example, this could be
|
367
|
+
# implemented with an HTTP cookie, which should be able to uniquely identify
|
368
|
+
# a visitor on a single device. This unique identifier should not change if
|
369
|
+
# the visitor logs in or out of the website.
|
370
|
+
#
|
371
|
+
# This field should NOT have a fixed value such as `unknown_visitor`.
|
372
|
+
#
|
373
|
+
# This should be the same identifier as
|
374
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::UserEvent#user_pseudo_id UserEvent.user_pseudo_id}
|
375
|
+
# and
|
376
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#user_pseudo_id SearchRequest.user_pseudo_id}.
|
377
|
+
#
|
378
|
+
# The field must be a UTF-8 encoded string with a length limit of 128
|
379
|
+
# @param user_info [::Google::Cloud::DiscoveryEngine::V1beta::UserInfo, ::Hash]
|
380
|
+
# Optional. Information about the end user.
|
381
|
+
#
|
382
|
+
# This should be the same identifier information as
|
383
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::UserEvent#user_info UserEvent.user_info}
|
384
|
+
# and
|
385
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#user_info SearchRequest.user_info}.
|
386
|
+
# @param include_tail_suggestions [::Boolean]
|
387
|
+
# Indicates if tail suggestions should be returned if there are no
|
388
|
+
# suggestions that match the full query. Even if set to true, if there are
|
389
|
+
# suggestions that match the full query, those are returned and no
|
390
|
+
# tail suggestions are returned.
|
391
|
+
# @param boost_spec [::Google::Cloud::DiscoveryEngine::V1beta::AdvancedCompleteQueryRequest::BoostSpec, ::Hash]
|
392
|
+
# Optional. Specification to boost suggestions matching the condition.
|
393
|
+
# @param suggestion_types [::Array<::Google::Cloud::DiscoveryEngine::V1beta::AdvancedCompleteQueryRequest::SuggestionType>]
|
394
|
+
# Optional. Suggestion types to return. If empty or unspecified, query
|
395
|
+
# suggestions are returned. Only one suggestion type is supported at the
|
396
|
+
# moment.
|
397
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
398
|
+
# @yieldparam result [::Google::Cloud::DiscoveryEngine::V1beta::AdvancedCompleteQueryResponse]
|
399
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
400
|
+
#
|
401
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::AdvancedCompleteQueryResponse]
|
402
|
+
#
|
403
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
404
|
+
#
|
405
|
+
# @example Basic example
|
406
|
+
# require "google/cloud/discovery_engine/v1beta"
|
407
|
+
#
|
408
|
+
# # Create a client object. The client can be reused for multiple calls.
|
409
|
+
# client = Google::Cloud::DiscoveryEngine::V1beta::CompletionService::Rest::Client.new
|
410
|
+
#
|
411
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
412
|
+
# request = Google::Cloud::DiscoveryEngine::V1beta::AdvancedCompleteQueryRequest.new
|
413
|
+
#
|
414
|
+
# # Call the advanced_complete_query method.
|
415
|
+
# result = client.advanced_complete_query request
|
416
|
+
#
|
417
|
+
# # The returned object is of type Google::Cloud::DiscoveryEngine::V1beta::AdvancedCompleteQueryResponse.
|
418
|
+
# p result
|
419
|
+
#
|
420
|
+
def advanced_complete_query request, options = nil
|
421
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
422
|
+
|
423
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1beta::AdvancedCompleteQueryRequest
|
424
|
+
|
425
|
+
# Converts hash and nil to an options object
|
426
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
427
|
+
|
428
|
+
# Customize the options with defaults
|
429
|
+
call_metadata = @config.rpcs.advanced_complete_query.metadata.to_h
|
430
|
+
|
431
|
+
# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
|
432
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
433
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
434
|
+
gapic_version: ::Google::Cloud::DiscoveryEngine::V1beta::VERSION,
|
435
|
+
transports_version_send: [:rest]
|
436
|
+
|
437
|
+
call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
|
438
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
439
|
+
|
440
|
+
options.apply_defaults timeout: @config.rpcs.advanced_complete_query.timeout,
|
441
|
+
metadata: call_metadata,
|
442
|
+
retry_policy: @config.rpcs.advanced_complete_query.retry_policy
|
443
|
+
|
444
|
+
options.apply_defaults timeout: @config.timeout,
|
445
|
+
metadata: @config.metadata,
|
446
|
+
retry_policy: @config.retry_policy
|
447
|
+
|
448
|
+
@completion_service_stub.advanced_complete_query request, options do |result, operation|
|
449
|
+
yield result, operation if block_given?
|
450
|
+
return result
|
451
|
+
end
|
452
|
+
rescue ::Gapic::Rest::Error => e
|
453
|
+
raise ::Google::Cloud::Error.from_error(e)
|
454
|
+
end
|
455
|
+
|
315
456
|
##
|
316
457
|
# Imports all
|
317
458
|
# {::Google::Cloud::DiscoveryEngine::V1beta::SuggestionDenyListEntry SuggestionDenyListEntry}
|
@@ -833,6 +974,11 @@ module Google
|
|
833
974
|
#
|
834
975
|
attr_reader :complete_query
|
835
976
|
##
|
977
|
+
# RPC-specific configuration for `advanced_complete_query`
|
978
|
+
# @return [::Gapic::Config::Method]
|
979
|
+
#
|
980
|
+
attr_reader :advanced_complete_query
|
981
|
+
##
|
836
982
|
# RPC-specific configuration for `import_suggestion_deny_list_entries`
|
837
983
|
# @return [::Gapic::Config::Method]
|
838
984
|
#
|
@@ -857,6 +1003,8 @@ module Google
|
|
857
1003
|
def initialize parent_rpcs = nil
|
858
1004
|
complete_query_config = parent_rpcs.complete_query if parent_rpcs.respond_to? :complete_query
|
859
1005
|
@complete_query = ::Gapic::Config::Method.new complete_query_config
|
1006
|
+
advanced_complete_query_config = parent_rpcs.advanced_complete_query if parent_rpcs.respond_to? :advanced_complete_query
|
1007
|
+
@advanced_complete_query = ::Gapic::Config::Method.new advanced_complete_query_config
|
860
1008
|
import_suggestion_deny_list_entries_config = parent_rpcs.import_suggestion_deny_list_entries if parent_rpcs.respond_to? :import_suggestion_deny_list_entries
|
861
1009
|
@import_suggestion_deny_list_entries = ::Gapic::Config::Method.new import_suggestion_deny_list_entries_config
|
862
1010
|
purge_suggestion_deny_list_entries_config = parent_rpcs.purge_suggestion_deny_list_entries if parent_rpcs.respond_to? :purge_suggestion_deny_list_entries
|
@@ -99,6 +99,44 @@ module Google
|
|
99
99
|
result
|
100
100
|
end
|
101
101
|
|
102
|
+
##
|
103
|
+
# Baseline implementation for the advanced_complete_query REST call
|
104
|
+
#
|
105
|
+
# @param request_pb [::Google::Cloud::DiscoveryEngine::V1beta::AdvancedCompleteQueryRequest]
|
106
|
+
# A request object representing the call parameters. Required.
|
107
|
+
# @param options [::Gapic::CallOptions]
|
108
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
109
|
+
#
|
110
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
111
|
+
# @yieldparam result [::Google::Cloud::DiscoveryEngine::V1beta::AdvancedCompleteQueryResponse]
|
112
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
113
|
+
#
|
114
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::AdvancedCompleteQueryResponse]
|
115
|
+
# A result object deserialized from the server's reply
|
116
|
+
def advanced_complete_query request_pb, options = nil
|
117
|
+
raise ::ArgumentError, "request must be provided" if request_pb.nil?
|
118
|
+
|
119
|
+
verb, uri, query_string_params, body = ServiceStub.transcode_advanced_complete_query_request request_pb
|
120
|
+
query_string_params = if query_string_params.any?
|
121
|
+
query_string_params.to_h { |p| p.split "=", 2 }
|
122
|
+
else
|
123
|
+
{}
|
124
|
+
end
|
125
|
+
|
126
|
+
response = @client_stub.make_http_request(
|
127
|
+
verb,
|
128
|
+
uri: uri,
|
129
|
+
body: body || "",
|
130
|
+
params: query_string_params,
|
131
|
+
options: options
|
132
|
+
)
|
133
|
+
operation = ::Gapic::Rest::TransportOperation.new response
|
134
|
+
result = ::Google::Cloud::DiscoveryEngine::V1beta::AdvancedCompleteQueryResponse.decode_json response.body, ignore_unknown_fields: true
|
135
|
+
|
136
|
+
yield result, operation if block_given?
|
137
|
+
result
|
138
|
+
end
|
139
|
+
|
102
140
|
##
|
103
141
|
# Baseline implementation for the import_suggestion_deny_list_entries REST call
|
104
142
|
#
|
@@ -279,6 +317,44 @@ module Google
|
|
279
317
|
transcoder.transcode request_pb
|
280
318
|
end
|
281
319
|
|
320
|
+
##
|
321
|
+
# @private
|
322
|
+
#
|
323
|
+
# GRPC transcoding helper method for the advanced_complete_query REST call
|
324
|
+
#
|
325
|
+
# @param request_pb [::Google::Cloud::DiscoveryEngine::V1beta::AdvancedCompleteQueryRequest]
|
326
|
+
# A request object representing the call parameters. Required.
|
327
|
+
# @return [Array(String, [String, nil], Hash{String => String})]
|
328
|
+
# Uri, Body, Query string parameters
|
329
|
+
def self.transcode_advanced_complete_query_request request_pb
|
330
|
+
transcoder = Gapic::Rest::GrpcTranscoder.new
|
331
|
+
.with_bindings(
|
332
|
+
uri_method: :post,
|
333
|
+
uri_template: "/v1beta/{completion_config}:completeQuery",
|
334
|
+
body: "*",
|
335
|
+
matches: [
|
336
|
+
["completion_config", %r{^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/completionConfig/?$}, false]
|
337
|
+
]
|
338
|
+
)
|
339
|
+
.with_bindings(
|
340
|
+
uri_method: :post,
|
341
|
+
uri_template: "/v1beta/{completion_config}:completeQuery",
|
342
|
+
body: "*",
|
343
|
+
matches: [
|
344
|
+
["completion_config", %r{^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/completionConfig/?$}, false]
|
345
|
+
]
|
346
|
+
)
|
347
|
+
.with_bindings(
|
348
|
+
uri_method: :post,
|
349
|
+
uri_template: "/v1beta/{completion_config}:completeQuery",
|
350
|
+
body: "*",
|
351
|
+
matches: [
|
352
|
+
["completion_config", %r{^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/completionConfig/?$}, false]
|
353
|
+
]
|
354
|
+
)
|
355
|
+
transcoder.transcode request_pb
|
356
|
+
end
|
357
|
+
|
282
358
|
##
|
283
359
|
# @private
|
284
360
|
#
|
@@ -211,9 +211,9 @@ module Google
|
|
211
211
|
#
|
212
212
|
# @param parent [::String]
|
213
213
|
# Required. Full resource name of parent data store. Format:
|
214
|
-
# `projects/{
|
214
|
+
# `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`
|
215
215
|
# or
|
216
|
-
# `projects/{
|
216
|
+
# `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
|
217
217
|
# @param control [::Google::Cloud::DiscoveryEngine::V1beta::Control, ::Hash]
|
218
218
|
# Required. The Control to create.
|
219
219
|
# @param control_id [::String]
|
@@ -311,7 +311,7 @@ module Google
|
|
311
311
|
#
|
312
312
|
# @param name [::String]
|
313
313
|
# Required. The resource name of the Control to delete. Format:
|
314
|
-
# `projects/{
|
314
|
+
# `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`
|
315
315
|
#
|
316
316
|
# @yield [response, operation] Access the result along with the RPC operation
|
317
317
|
# @yieldparam response [::Google::Protobuf::Empty]
|
@@ -497,7 +497,7 @@ module Google
|
|
497
497
|
#
|
498
498
|
# @param name [::String]
|
499
499
|
# Required. The resource name of the Control to get. Format:
|
500
|
-
# `projects/{
|
500
|
+
# `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`
|
501
501
|
#
|
502
502
|
# @yield [response, operation] Access the result along with the RPC operation
|
503
503
|
# @yieldparam response [::Google::Cloud::DiscoveryEngine::V1beta::Control]
|
@@ -585,9 +585,9 @@ module Google
|
|
585
585
|
#
|
586
586
|
# @param parent [::String]
|
587
587
|
# Required. The data store resource name. Format:
|
588
|
-
# `projects/{
|
588
|
+
# `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`
|
589
589
|
# or
|
590
|
-
# `projects/{
|
590
|
+
# `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
|
591
591
|
# @param page_size [::Integer]
|
592
592
|
# Optional. Maximum number of results to return. If unspecified, defaults
|
593
593
|
# to 50. Max allowed value is 1000.
|
@@ -204,9 +204,9 @@ module Google
|
|
204
204
|
#
|
205
205
|
# @param parent [::String]
|
206
206
|
# Required. Full resource name of parent data store. Format:
|
207
|
-
# `projects/{
|
207
|
+
# `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`
|
208
208
|
# or
|
209
|
-
# `projects/{
|
209
|
+
# `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
|
210
210
|
# @param control [::Google::Cloud::DiscoveryEngine::V1beta::Control, ::Hash]
|
211
211
|
# Required. The Control to create.
|
212
212
|
# @param control_id [::String]
|
@@ -297,7 +297,7 @@ module Google
|
|
297
297
|
#
|
298
298
|
# @param name [::String]
|
299
299
|
# Required. The resource name of the Control to delete. Format:
|
300
|
-
# `projects/{
|
300
|
+
# `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`
|
301
301
|
# @yield [result, operation] Access the result along with the TransportOperation object
|
302
302
|
# @yieldparam result [::Google::Protobuf::Empty]
|
303
303
|
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
@@ -469,7 +469,7 @@ module Google
|
|
469
469
|
#
|
470
470
|
# @param name [::String]
|
471
471
|
# Required. The resource name of the Control to get. Format:
|
472
|
-
# `projects/{
|
472
|
+
# `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`
|
473
473
|
# @yield [result, operation] Access the result along with the TransportOperation object
|
474
474
|
# @yieldparam result [::Google::Cloud::DiscoveryEngine::V1beta::Control]
|
475
475
|
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
@@ -550,9 +550,9 @@ module Google
|
|
550
550
|
#
|
551
551
|
# @param parent [::String]
|
552
552
|
# Required. The data store resource name. Format:
|
553
|
-
# `projects/{
|
553
|
+
# `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`
|
554
554
|
# or
|
555
|
-
# `projects/{
|
555
|
+
# `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
|
556
556
|
# @param page_size [::Integer]
|
557
557
|
# Optional. Maximum number of results to return. If unspecified, defaults
|
558
558
|
# to 50. Max allowed value is 1000.
|