google-cloud-discovery_engine-v1beta 0.15.0 → 0.17.0

data/lib/google/cloud/discovery_engine/v1beta/control_service/rest/service_stub.rb

@@ -30,7 +30,8 @@ module Google
             # including transcoding, making the REST call, and deserialing the response.
             #
             class ServiceStub
-              def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
+              # @private
+              def initialize endpoint:, endpoint_template:, universe_domain:, credentials:, logger:
                 # These require statements are intentionally placed here to initialize
                 # the REST modules only when it's required.
                 require "gapic/rest"
@@ -40,7 +41,9 @@ module Google
                                                              universe_domain: universe_domain,
                                                              credentials: credentials,
                                                              numeric_enums: true,
-                                                             raise_faraday_errors: false
+                                                             service_name: self.class,
+                                                             raise_faraday_errors: false,
+                                                             logger: logger
               end
 
               ##
@@ -61,6 +64,15 @@ module Google
                 @client_stub.endpoint
               end
 
+              ##
+              # The logger used for request/response debug logging.
+              #
+              # @return [Logger]
+              #
+              def logger stub: false
+                stub ? @client_stub.stub_logger : @client_stub.logger
+              end
+
               ##
               # Baseline implementation for the create_control REST call
               #
@@ -87,16 +99,18 @@ module Google
 
                 response = @client_stub.make_http_request(
                   verb,
-                  uri:     uri,
-                  body:    body || "",
-                  params:  query_string_params,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "create_control",
                   options: options
                 )
                 operation = ::Gapic::Rest::TransportOperation.new response
                 result = ::Google::Cloud::DiscoveryEngine::V1beta::Control.decode_json response.body, ignore_unknown_fields: true
-
-                yield result, operation if block_given?
-                result
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
               end
 
               ##
@@ -125,16 +139,18 @@ module Google
 
                 response = @client_stub.make_http_request(
                   verb,
-                  uri:     uri,
-                  body:    body || "",
-                  params:  query_string_params,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "delete_control",
                   options: options
                 )
                 operation = ::Gapic::Rest::TransportOperation.new response
                 result = ::Google::Protobuf::Empty.decode_json response.body, ignore_unknown_fields: true
-
-                yield result, operation if block_given?
-                result
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
               end
 
               ##
@@ -163,16 +179,18 @@ module Google
 
                 response = @client_stub.make_http_request(
                   verb,
-                  uri:     uri,
-                  body:    body || "",
-                  params:  query_string_params,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "update_control",
                   options: options
                 )
                 operation = ::Gapic::Rest::TransportOperation.new response
                 result = ::Google::Cloud::DiscoveryEngine::V1beta::Control.decode_json response.body, ignore_unknown_fields: true
-
-                yield result, operation if block_given?
-                result
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
               end
 
               ##
@@ -201,16 +219,18 @@ module Google
 
                 response = @client_stub.make_http_request(
                   verb,
-                  uri:     uri,
-                  body:    body || "",
-                  params:  query_string_params,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "get_control",
                   options: options
                 )
                 operation = ::Gapic::Rest::TransportOperation.new response
                 result = ::Google::Cloud::DiscoveryEngine::V1beta::Control.decode_json response.body, ignore_unknown_fields: true
-
-                yield result, operation if block_given?
-                result
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
               end
 
               ##
@@ -239,16 +259,18 @@ module Google
 
                 response = @client_stub.make_http_request(
                   verb,
-                  uri:     uri,
-                  body:    body || "",
-                  params:  query_string_params,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "list_controls",
                   options: options
                 )
                 operation = ::Gapic::Rest::TransportOperation.new response
                 result = ::Google::Cloud::DiscoveryEngine::V1beta::ListControlsResponse.decode_json response.body, ignore_unknown_fields: true
-
-                yield result, operation if block_given?
-                result
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
               end
 
               ##

data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/client.rb

@@ -163,14 +163,26 @@ module Google
                 universe_domain: @config.universe_domain,
                 channel_args: @config.channel_args,
                 interceptors: @config.interceptors,
-                channel_pool_config: @config.channel_pool
+                channel_pool_config: @config.channel_pool,
+                logger: @config.logger
               )
 
+              @conversational_search_service_stub.stub_logger&.info do |entry|
+                entry.set_system_name
+                entry.set_service
+                entry.message = "Created client for #{entry.service}"
+                entry.set_credentials_fields credentials
+                entry.set "customEndpoint", @config.endpoint if @config.endpoint
+                entry.set "defaultTimeout", @config.timeout if @config.timeout
+                entry.set "quotaProject", @quota_project_id if @quota_project_id
+              end
+
               @location_client = Google::Cloud::Location::Locations::Client.new do |config|
                 config.credentials = credentials
                 config.quota_project = @quota_project_id
                 config.endpoint = @conversational_search_service_stub.endpoint
                 config.universe_domain = @conversational_search_service_stub.universe_domain
+                config.logger = @conversational_search_service_stub.logger if config.respond_to? :logger=
               end
             end
 
@@ -181,6 +193,15 @@ module Google
             #
             attr_reader :location_client
 
+            ##
+            # The logger used for request/response debug logging.
+            #
+            # @return [Logger]
+            #
+            def logger
+              @conversational_search_service_stub.logger
+            end
+
             # Service calls
 
             ##
@@ -203,16 +224,16 @@ module Google
             #
             #   @param name [::String]
             #     Required. The resource name of the Conversation to get. Format:
-            #     `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`.
+            #     `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`.
             #     Use
-            #     `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-`
+            #     `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/-`
             #     to activate auto session mode, which automatically creates a new
             #     conversation inside a ConverseConversation session.
             #   @param query [::Google::Cloud::DiscoveryEngine::V1beta::TextInput, ::Hash]
             #     Required. Current user input.
             #   @param serving_config [::String]
             #     The resource name of the Serving Config to use. Format:
-            #     `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}`
+            #     `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}`
             #     If this is not set, the default serving config will be used.
             #   @param conversation [::Google::Cloud::DiscoveryEngine::V1beta::Conversation, ::Hash]
             #     The conversation to be used by auto session only. The name field will be
@@ -321,7 +342,6 @@ module Google
 
               @conversational_search_service_stub.call_rpc :converse_conversation, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -350,7 +370,7 @@ module Google
             #
             #   @param parent [::String]
             #     Required. Full resource name of parent data store. Format:
-            #     `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
+            #     `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
             #   @param conversation [::Google::Cloud::DiscoveryEngine::V1beta::Conversation, ::Hash]
             #     Required. The conversation to create.
             #
@@ -413,7 +433,6 @@ module Google
 
               @conversational_search_service_stub.call_rpc :create_conversation, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -442,7 +461,7 @@ module Google
             #
             #   @param name [::String]
             #     Required. The resource name of the Conversation to delete. Format:
-            #     `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
+            #     `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Protobuf::Empty]
@@ -503,7 +522,6 @@ module Google
 
               @conversational_search_service_stub.call_rpc :delete_conversation, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -602,7 +620,6 @@ module Google
 
               @conversational_search_service_stub.call_rpc :update_conversation, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -628,7 +645,7 @@ module Google
             #
             #   @param name [::String]
             #     Required. The resource name of the Conversation to get. Format:
-            #     `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
+            #     `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Cloud::DiscoveryEngine::V1beta::Conversation]
@@ -689,7 +706,6 @@ module Google
 
               @conversational_search_service_stub.call_rpc :get_conversation, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -716,7 +732,7 @@ module Google
             #
             #   @param parent [::String]
             #     Required. The data store resource name. Format:
-            #     `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
+            #     `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
             #   @param page_size [::Integer]
             #     Maximum number of results to return. If unspecified, defaults
             #     to 50. Max allowed value is 1000.
@@ -805,7 +821,7 @@ module Google
               @conversational_search_service_stub.call_rpc :list_conversations, request, options: options do |response, operation|
                 response = ::Gapic::PagedEnumerable.new @conversational_search_service_stub, :list_conversations, request, response, operation, options
                 yield response, operation if block_given?
-                return response
+                throw :response, response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -824,7 +840,7 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload answer_query(serving_config: nil, query: nil, session: nil, safety_spec: nil, related_questions_spec: nil, answer_generation_spec: nil, search_spec: nil, query_understanding_spec: nil, asynchronous_mode: nil, user_pseudo_id: nil, user_labels: nil)
+            # @overload answer_query(serving_config: nil, query: nil, session: nil, safety_spec: nil, related_questions_spec: nil, grounding_spec: nil, answer_generation_spec: nil, search_spec: nil, query_understanding_spec: nil, asynchronous_mode: nil, user_pseudo_id: nil, user_labels: nil)
             #   Pass arguments to `answer_query` via keyword arguments. Note that at
             #   least one keyword argument is required. To specify no parameters, or to keep all
             #   the default parameter values, pass an empty Hash as a request object (see above).
@@ -849,6 +865,8 @@ module Google
             #     Model specification.
             #   @param related_questions_spec [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::RelatedQuestionsSpec, ::Hash]
             #     Related questions specification.
+            #   @param grounding_spec [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::GroundingSpec, ::Hash]
+            #     Optional. Grounding specification.
             #   @param answer_generation_spec [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::AnswerGenerationSpec, ::Hash]
             #     Answer generation specification.
             #   @param search_spec [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::SearchSpec, ::Hash]
@@ -856,6 +874,9 @@ module Google
             #   @param query_understanding_spec [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::QueryUnderstandingSpec, ::Hash]
             #     Query understanding specification.
             #   @param asynchronous_mode [::Boolean]
+            #     Deprecated: This field is deprecated. Streaming Answer API will be
+            #     supported.
+            #
             #     Asynchronous mode control.
             #
             #     If enabled, the response will be returned with answer/session resource
@@ -953,7 +974,6 @@ module Google
 
               @conversational_search_service_stub.call_rpc :answer_query, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -979,7 +999,7 @@ module Google
             #
             #   @param name [::String]
             #     Required. The resource name of the Answer to get. Format:
-            #     `projects/{project_number}/locations/{location_id}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`
+            #     `projects/{project}/locations/{location}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Cloud::DiscoveryEngine::V1beta::Answer]
@@ -1040,7 +1060,6 @@ module Google
 
               @conversational_search_service_stub.call_rpc :get_answer, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -1069,7 +1088,7 @@ module Google
             #
             #   @param parent [::String]
             #     Required. Full resource name of parent data store. Format:
-            #     `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
+            #     `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
             #   @param session [::Google::Cloud::DiscoveryEngine::V1beta::Session, ::Hash]
             #     Required. The session to create.
             #
@@ -1132,7 +1151,6 @@ module Google
 
               @conversational_search_service_stub.call_rpc :create_session, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -1161,7 +1179,7 @@ module Google
             #
             #   @param name [::String]
             #     Required. The resource name of the Session to delete. Format:
-            #     `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`
+            #     `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Protobuf::Empty]
@@ -1222,7 +1240,6 @@ module Google
 
               @conversational_search_service_stub.call_rpc :delete_session, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -1320,7 +1337,6 @@ module Google
 
               @conversational_search_service_stub.call_rpc :update_session, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -1346,7 +1362,7 @@ module Google
             #
             #   @param name [::String]
             #     Required. The resource name of the Session to get. Format:
-            #     `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`
+            #     `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Cloud::DiscoveryEngine::V1beta::Session]
@@ -1407,7 +1423,6 @@ module Google
 
               @conversational_search_service_stub.call_rpc :get_session, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -1434,7 +1449,7 @@ module Google
             #
             #   @param parent [::String]
             #     Required. The data store resource name. Format:
-            #     `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
+            #     `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
             #   @param page_size [::Integer]
             #     Maximum number of results to return. If unspecified, defaults
             #     to 50. Max allowed value is 1000.
@@ -1523,7 +1538,7 @@ module Google
               @conversational_search_service_stub.call_rpc :list_sessions, request, options: options do |response, operation|
                 response = ::Gapic::PagedEnumerable.new @conversational_search_service_stub, :list_sessions, request, response, operation, options
                 yield response, operation if block_given?
-                return response
+                throw :response, response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -1612,6 +1627,11 @@ module Google
             #   default endpoint URL. The default value of nil uses the environment
             #   universe (usually the default "googleapis.com" universe).
             #   @return [::String,nil]
+            # @!attribute [rw] logger
+            #   A custom logger to use for request/response debug logging, or the value
+            #   `:default` (the default) to construct a default logger, or `nil` to
+            #   explicitly disable logging.
+            #   @return [::Logger,:default,nil]
             #
             class Configuration
               extend ::Gapic::Config
@@ -1636,6 +1656,7 @@ module Google
               config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
               config_attr :quota_project, nil, ::String, nil
               config_attr :universe_domain, nil, ::String, nil
+              config_attr :logger, :default, ::Logger, nil, :default
 
               # @private
               def initialize parent_config = nil