# frozen_string_literal: true # Copyright 2023 Google LLC # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # https://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. # Auto-generated by gapic-generator-ruby. DO NOT EDIT! require "google/cloud/errors" require "google/cloud/discoveryengine/v1beta/conversational_search_service_pb" require "google/cloud/location" module Google module Cloud module DiscoveryEngine module V1beta module ConversationalSearchService ## # Client for the ConversationalSearchService service. # # Service for conversational search. # class Client include Paths # @private attr_reader :conversational_search_service_stub ## # Configure the ConversationalSearchService Client class. # # See {::Google::Cloud::DiscoveryEngine::V1beta::ConversationalSearchService::Client::Configuration} # for a description of the configuration fields. # # @example # # # Modify the configuration for all ConversationalSearchService clients # ::Google::Cloud::DiscoveryEngine::V1beta::ConversationalSearchService::Client.configure do |config| # config.timeout = 10.0 # end # # @yield [config] Configure the Client client. # @yieldparam config [Client::Configuration] # # @return [Client::Configuration] # def self.configure @configure ||= begin namespace = ["Google", "Cloud", "DiscoveryEngine", "V1beta"] parent_config = while namespace.any? parent_name = namespace.join "::" parent_const = const_get parent_name break parent_const.configure if parent_const.respond_to? :configure namespace.pop end default_config = Client::Configuration.new parent_config default_config.timeout = 30.0 default_config.retry_policy = { initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14] } default_config end yield @configure if block_given? @configure end ## # Configure the ConversationalSearchService Client instance. # # The configuration is set to the derived mode, meaning that values can be changed, # but structural changes (adding new fields, etc.) are not allowed. Structural changes # should be made on {Client.configure}. # # See {::Google::Cloud::DiscoveryEngine::V1beta::ConversationalSearchService::Client::Configuration} # for a description of the configuration fields. # # @yield [config] Configure the Client client. # @yieldparam config [Client::Configuration] # # @return [Client::Configuration] # def configure yield @config if block_given? @config end ## # Create a new ConversationalSearchService client object. # # @example # # # Create a client using the default configuration # client = ::Google::Cloud::DiscoveryEngine::V1beta::ConversationalSearchService::Client.new # # # Create a client using a custom configuration # client = ::Google::Cloud::DiscoveryEngine::V1beta::ConversationalSearchService::Client.new do |config| # config.timeout = 10.0 # end # # @yield [config] Configure the ConversationalSearchService client. # @yieldparam config [Client::Configuration] # def initialize # These require statements are intentionally placed here to initialize # the gRPC module only when it's required. # See https://github.com/googleapis/toolkit/issues/446 require "gapic/grpc" require "google/cloud/discoveryengine/v1beta/conversational_search_service_services_pb" # Create the configuration object @config = Configuration.new Client.configure # Yield the configuration if needed yield @config if block_given? # Create credentials credentials = @config.credentials # Use self-signed JWT if the endpoint is unchanged from default, # but only if the default endpoint does not have a region prefix. enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT && !@config.endpoint.split(".").first.include?("-") credentials ||= Credentials.default scope: @config.scope, enable_self_signed_jwt: enable_self_signed_jwt if credentials.is_a?(::String) || credentials.is_a?(::Hash) credentials = Credentials.new credentials, scope: @config.scope end @quota_project_id = @config.quota_project @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id @location_client = Google::Cloud::Location::Locations::Client.new do |config| config.credentials = credentials config.quota_project = @quota_project_id config.endpoint = @config.endpoint end @conversational_search_service_stub = ::Gapic::ServiceStub.new( ::Google::Cloud::DiscoveryEngine::V1beta::ConversationalSearchService::Stub, credentials: credentials, endpoint: @config.endpoint, channel_args: @config.channel_args, interceptors: @config.interceptors, channel_pool_config: @config.channel_pool ) end ## # Get the associated client for mix-in of the Locations. # # @return [Google::Cloud::Location::Locations::Client] # attr_reader :location_client # Service calls ## # Converses a conversation. # # @overload converse_conversation(request, options = nil) # Pass arguments to `converse_conversation` via a request object, either of type # {::Google::Cloud::DiscoveryEngine::V1beta::ConverseConversationRequest} or an equivalent Hash. # # @param request [::Google::Cloud::DiscoveryEngine::V1beta::ConverseConversationRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. # # @overload converse_conversation(name: nil, query: nil, serving_config: nil, conversation: nil, safe_search: nil, user_labels: nil, summary_spec: nil) # Pass arguments to `converse_conversation` 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). # # @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}`. # Use # `projects/{project_number}/locations/{location_id}/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}` # 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 # ignored as we automatically assign new name for the conversation in auto # session. # @param safe_search [::Boolean] # Whether to turn on safe search. # @param user_labels [::Hash{::String => ::String}] # The user labels applied to a resource must meet the following requirements: # # * Each resource can have multiple labels, up to a maximum of 64. # * Each label must be a key-value pair. # * Keys have a minimum length of 1 character and a maximum length of 63 # characters and cannot be empty. Values can be empty and have a maximum # length of 63 characters. # * Keys and values can contain only lowercase letters, numeric characters, # underscores, and dashes. All characters must use UTF-8 encoding, and # international characters are allowed. # * The key portion of a label must be unique. However, you can use the same # key with multiple resources. # * Keys must start with a lowercase letter or international character. # # See [Google Cloud # Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) # for more details. # @param summary_spec [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec, ::Hash] # A specification for configuring the summary returned in the response. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Cloud::DiscoveryEngine::V1beta::ConverseConversationResponse] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Cloud::DiscoveryEngine::V1beta::ConverseConversationResponse] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/discovery_engine/v1beta" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::DiscoveryEngine::V1beta::ConversationalSearchService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::DiscoveryEngine::V1beta::ConverseConversationRequest.new # # # Call the converse_conversation method. # result = client.converse_conversation request # # # The returned object is of type Google::Cloud::DiscoveryEngine::V1beta::ConverseConversationResponse. # p result # def converse_conversation request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1beta::ConverseConversationRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.converse_conversation.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::DiscoveryEngine::V1beta::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.name header_params["name"] = request.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.converse_conversation.timeout, metadata: metadata, retry_policy: @config.rpcs.converse_conversation.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @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) end ## # Creates a Conversation. # # If the {::Google::Cloud::DiscoveryEngine::V1beta::Conversation Conversation} to # create already exists, an ALREADY_EXISTS error is returned. # # @overload create_conversation(request, options = nil) # Pass arguments to `create_conversation` via a request object, either of type # {::Google::Cloud::DiscoveryEngine::V1beta::CreateConversationRequest} or an equivalent Hash. # # @param request [::Google::Cloud::DiscoveryEngine::V1beta::CreateConversationRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. # # @overload create_conversation(parent: nil, conversation: nil) # Pass arguments to `create_conversation` 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). # # @param parent [::String] # Required. Full resource name of parent data store. Format: # `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` # @param conversation [::Google::Cloud::DiscoveryEngine::V1beta::Conversation, ::Hash] # Required. The conversation to create. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Cloud::DiscoveryEngine::V1beta::Conversation] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Cloud::DiscoveryEngine::V1beta::Conversation] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/discovery_engine/v1beta" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::DiscoveryEngine::V1beta::ConversationalSearchService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::DiscoveryEngine::V1beta::CreateConversationRequest.new # # # Call the create_conversation method. # result = client.create_conversation request # # # The returned object is of type Google::Cloud::DiscoveryEngine::V1beta::Conversation. # p result # def create_conversation request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1beta::CreateConversationRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.create_conversation.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::DiscoveryEngine::V1beta::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.parent header_params["parent"] = request.parent end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.create_conversation.timeout, metadata: metadata, retry_policy: @config.rpcs.create_conversation.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @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) end ## # Deletes a Conversation. # # If the {::Google::Cloud::DiscoveryEngine::V1beta::Conversation Conversation} to # delete does not exist, a NOT_FOUND error is returned. # # @overload delete_conversation(request, options = nil) # Pass arguments to `delete_conversation` via a request object, either of type # {::Google::Cloud::DiscoveryEngine::V1beta::DeleteConversationRequest} or an equivalent Hash. # # @param request [::Google::Cloud::DiscoveryEngine::V1beta::DeleteConversationRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. # # @overload delete_conversation(name: nil) # Pass arguments to `delete_conversation` 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). # # @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}` # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Protobuf::Empty] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Protobuf::Empty] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/discovery_engine/v1beta" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::DiscoveryEngine::V1beta::ConversationalSearchService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::DiscoveryEngine::V1beta::DeleteConversationRequest.new # # # Call the delete_conversation method. # result = client.delete_conversation request # # # The returned object is of type Google::Protobuf::Empty. # p result # def delete_conversation request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1beta::DeleteConversationRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.delete_conversation.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::DiscoveryEngine::V1beta::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.name header_params["name"] = request.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.delete_conversation.timeout, metadata: metadata, retry_policy: @config.rpcs.delete_conversation.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @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) end ## # Updates a Conversation. # # {::Google::Cloud::DiscoveryEngine::V1beta::Conversation Conversation} action # type cannot be changed. If the # {::Google::Cloud::DiscoveryEngine::V1beta::Conversation Conversation} to update # does not exist, a NOT_FOUND error is returned. # # @overload update_conversation(request, options = nil) # Pass arguments to `update_conversation` via a request object, either of type # {::Google::Cloud::DiscoveryEngine::V1beta::UpdateConversationRequest} or an equivalent Hash. # # @param request [::Google::Cloud::DiscoveryEngine::V1beta::UpdateConversationRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. # # @overload update_conversation(conversation: nil, update_mask: nil) # Pass arguments to `update_conversation` 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). # # @param conversation [::Google::Cloud::DiscoveryEngine::V1beta::Conversation, ::Hash] # Required. The Conversation to update. # @param update_mask [::Google::Protobuf::FieldMask, ::Hash] # Indicates which fields in the provided # {::Google::Cloud::DiscoveryEngine::V1beta::Conversation Conversation} to update. # The following are NOT supported: # # * [conversation.name][] # # If not set or empty, all supported fields are updated. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Cloud::DiscoveryEngine::V1beta::Conversation] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Cloud::DiscoveryEngine::V1beta::Conversation] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/discovery_engine/v1beta" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::DiscoveryEngine::V1beta::ConversationalSearchService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::DiscoveryEngine::V1beta::UpdateConversationRequest.new # # # Call the update_conversation method. # result = client.update_conversation request # # # The returned object is of type Google::Cloud::DiscoveryEngine::V1beta::Conversation. # p result # def update_conversation request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1beta::UpdateConversationRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.update_conversation.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::DiscoveryEngine::V1beta::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.conversation&.name header_params["conversation.name"] = request.conversation.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.update_conversation.timeout, metadata: metadata, retry_policy: @config.rpcs.update_conversation.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @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) end ## # Gets a Conversation. # # @overload get_conversation(request, options = nil) # Pass arguments to `get_conversation` via a request object, either of type # {::Google::Cloud::DiscoveryEngine::V1beta::GetConversationRequest} or an equivalent Hash. # # @param request [::Google::Cloud::DiscoveryEngine::V1beta::GetConversationRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. # # @overload get_conversation(name: nil) # Pass arguments to `get_conversation` 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). # # @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}` # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Cloud::DiscoveryEngine::V1beta::Conversation] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Cloud::DiscoveryEngine::V1beta::Conversation] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/discovery_engine/v1beta" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::DiscoveryEngine::V1beta::ConversationalSearchService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::DiscoveryEngine::V1beta::GetConversationRequest.new # # # Call the get_conversation method. # result = client.get_conversation request # # # The returned object is of type Google::Cloud::DiscoveryEngine::V1beta::Conversation. # p result # def get_conversation request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1beta::GetConversationRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.get_conversation.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::DiscoveryEngine::V1beta::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.name header_params["name"] = request.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.get_conversation.timeout, metadata: metadata, retry_policy: @config.rpcs.get_conversation.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @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) end ## # Lists all Conversations by their parent # [DataStore][google.cloud.discoveryengine.v1beta.DataStore]. # # @overload list_conversations(request, options = nil) # Pass arguments to `list_conversations` via a request object, either of type # {::Google::Cloud::DiscoveryEngine::V1beta::ListConversationsRequest} or an equivalent Hash. # # @param request [::Google::Cloud::DiscoveryEngine::V1beta::ListConversationsRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. # # @overload list_conversations(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) # Pass arguments to `list_conversations` 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). # # @param parent [::String] # Required. The data store resource name. Format: # `projects/{project_number}/locations/{location_id}/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. # @param page_token [::String] # A page token, received from a previous `ListConversations` call. # Provide this to retrieve the subsequent page. # @param filter [::String] # A filter to apply on the list results. The supported features are: # user_pseudo_id, state. # # Example: # "user_pseudo_id = some_id" # @param order_by [::String] # A comma-separated list of fields to order by, sorted in ascending order. # Use "desc" after a field name for descending. # Supported fields: # * `update_time` # * `create_time` # * `conversation_name` # # Example: # "update_time desc" # "create_time" # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1beta::Conversation>] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Gapic::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1beta::Conversation>] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/discovery_engine/v1beta" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::DiscoveryEngine::V1beta::ConversationalSearchService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::DiscoveryEngine::V1beta::ListConversationsRequest.new # # # Call the list_conversations method. # result = client.list_conversations request # # # The returned object is of type Gapic::PagedEnumerable. You can iterate # # over elements, and API calls will be issued to fetch pages as needed. # result.each do |item| # # Each element is of type ::Google::Cloud::DiscoveryEngine::V1beta::Conversation. # p item # end # def list_conversations request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1beta::ListConversationsRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.list_conversations.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::DiscoveryEngine::V1beta::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.parent header_params["parent"] = request.parent end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.list_conversations.timeout, metadata: metadata, retry_policy: @config.rpcs.list_conversations.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @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 end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end ## # Configuration class for the ConversationalSearchService API. # # This class represents the configuration for ConversationalSearchService, # providing control over timeouts, retry behavior, logging, transport # parameters, and other low-level controls. Certain parameters can also be # applied individually to specific RPCs. See # {::Google::Cloud::DiscoveryEngine::V1beta::ConversationalSearchService::Client::Configuration::Rpcs} # for a list of RPCs that can be configured independently. # # Configuration can be applied globally to all clients, or to a single client # on construction. # # @example # # # Modify the global config, setting the timeout for # # converse_conversation to 20 seconds, # # and all remaining timeouts to 10 seconds. # ::Google::Cloud::DiscoveryEngine::V1beta::ConversationalSearchService::Client.configure do |config| # config.timeout = 10.0 # config.rpcs.converse_conversation.timeout = 20.0 # end # # # Apply the above configuration only to a new client. # client = ::Google::Cloud::DiscoveryEngine::V1beta::ConversationalSearchService::Client.new do |config| # config.timeout = 10.0 # config.rpcs.converse_conversation.timeout = 20.0 # end # # @!attribute [rw] endpoint # The hostname or hostname:port of the service endpoint. # Defaults to `"discoveryengine.googleapis.com"`. # @return [::String] # @!attribute [rw] credentials # Credentials to send with calls. You may provide any of the following types: # * (`String`) The path to a service account key file in JSON format # * (`Hash`) A service account key as a Hash # * (`Google::Auth::Credentials`) A googleauth credentials object # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials)) # * (`Signet::OAuth2::Client`) A signet oauth2 client object # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client)) # * (`GRPC::Core::Channel`) a gRPC channel with included credentials # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object # * (`nil`) indicating no credentials # @return [::Object] # @!attribute [rw] scope # The OAuth scopes # @return [::Array<::String>] # @!attribute [rw] lib_name # The library name as recorded in instrumentation and logging # @return [::String] # @!attribute [rw] lib_version # The library version as recorded in instrumentation and logging # @return [::String] # @!attribute [rw] channel_args # Extra parameters passed to the gRPC channel. Note: this is ignored if a # `GRPC::Core::Channel` object is provided as the credential. # @return [::Hash] # @!attribute [rw] interceptors # An array of interceptors that are run before calls are executed. # @return [::Array<::GRPC::ClientInterceptor>] # @!attribute [rw] timeout # The call timeout in seconds. # @return [::Numeric] # @!attribute [rw] metadata # Additional gRPC headers to be sent with the call. # @return [::Hash{::Symbol=>::String}] # @!attribute [rw] retry_policy # The retry policy. The value is a hash with the following keys: # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds. # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds. # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier. # * `:retry_codes` (*type:* `Array`) - The error codes that should # trigger a retry. # @return [::Hash] # @!attribute [rw] quota_project # A separate project against which to charge quota. # @return [::String] # class Configuration extend ::Gapic::Config DEFAULT_ENDPOINT = "discoveryengine.googleapis.com" config_attr :endpoint, DEFAULT_ENDPOINT, ::String config_attr :credentials, nil do |value| allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil] allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC allowed.any? { |klass| klass === value } end config_attr :scope, nil, ::String, ::Array, nil config_attr :lib_name, nil, ::String, nil config_attr :lib_version, nil, ::String, nil config_attr(:channel_args, { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil) config_attr :interceptors, nil, ::Array, nil config_attr :timeout, nil, ::Numeric, nil config_attr :metadata, nil, ::Hash, nil config_attr :retry_policy, nil, ::Hash, ::Proc, nil config_attr :quota_project, nil, ::String, nil # @private def initialize parent_config = nil @parent_config = parent_config unless parent_config.nil? yield self if block_given? end ## # Configurations for individual RPCs # @return [Rpcs] # def rpcs @rpcs ||= begin parent_rpcs = nil parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs) Rpcs.new parent_rpcs end end ## # Configuration for the channel pool # @return [::Gapic::ServiceStub::ChannelPool::Configuration] # def channel_pool @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new end ## # Configuration RPC class for the ConversationalSearchService API. # # Includes fields providing the configuration for each RPC in this service. # Each configuration object is of type `Gapic::Config::Method` and includes # the following configuration fields: # # * `timeout` (*type:* `Numeric`) - The call timeout in seconds # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields # include the following keys: # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds. # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds. # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier. # * `:retry_codes` (*type:* `Array`) - The error codes that should # trigger a retry. # class Rpcs ## # RPC-specific configuration for `converse_conversation` # @return [::Gapic::Config::Method] # attr_reader :converse_conversation ## # RPC-specific configuration for `create_conversation` # @return [::Gapic::Config::Method] # attr_reader :create_conversation ## # RPC-specific configuration for `delete_conversation` # @return [::Gapic::Config::Method] # attr_reader :delete_conversation ## # RPC-specific configuration for `update_conversation` # @return [::Gapic::Config::Method] # attr_reader :update_conversation ## # RPC-specific configuration for `get_conversation` # @return [::Gapic::Config::Method] # attr_reader :get_conversation ## # RPC-specific configuration for `list_conversations` # @return [::Gapic::Config::Method] # attr_reader :list_conversations # @private def initialize parent_rpcs = nil converse_conversation_config = parent_rpcs.converse_conversation if parent_rpcs.respond_to? :converse_conversation @converse_conversation = ::Gapic::Config::Method.new converse_conversation_config create_conversation_config = parent_rpcs.create_conversation if parent_rpcs.respond_to? :create_conversation @create_conversation = ::Gapic::Config::Method.new create_conversation_config delete_conversation_config = parent_rpcs.delete_conversation if parent_rpcs.respond_to? :delete_conversation @delete_conversation = ::Gapic::Config::Method.new delete_conversation_config update_conversation_config = parent_rpcs.update_conversation if parent_rpcs.respond_to? :update_conversation @update_conversation = ::Gapic::Config::Method.new update_conversation_config get_conversation_config = parent_rpcs.get_conversation if parent_rpcs.respond_to? :get_conversation @get_conversation = ::Gapic::Config::Method.new get_conversation_config list_conversations_config = parent_rpcs.list_conversations if parent_rpcs.respond_to? :list_conversations @list_conversations = ::Gapic::Config::Method.new list_conversations_config yield self if block_given? end end end end end end end end end