# 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/discovery_engine/v1beta/conversational_search_service/rest/service_stub"
require "google/cloud/location/rest"
module Google
module Cloud
module DiscoveryEngine
module V1beta
module ConversationalSearchService
module Rest
##
# REST client for the ConversationalSearchService service.
#
# Service for conversational search.
#
class Client
# @private
API_VERSION = ""
# @private
DEFAULT_ENDPOINT_TEMPLATE = "discoveryengine.$UNIVERSE_DOMAIN$"
include Paths
# @private
attr_reader :conversational_search_service_stub
##
# Configure the ConversationalSearchService Client class.
#
# See {::Google::Cloud::DiscoveryEngine::V1beta::ConversationalSearchService::Rest::Client::Configuration}
# for a description of the configuration fields.
#
# @example
#
# # Modify the configuration for all ConversationalSearchService clients
# ::Google::Cloud::DiscoveryEngine::V1beta::ConversationalSearchService::Rest::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::Rest::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
##
# The effective universe domain
#
# @return [String]
#
def universe_domain
@conversational_search_service_stub.universe_domain
end
##
# Create a new ConversationalSearchService REST client object.
#
# @example
#
# # Create a client using the default configuration
# client = ::Google::Cloud::DiscoveryEngine::V1beta::ConversationalSearchService::Rest::Client.new
#
# # Create a client using a custom configuration
# client = ::Google::Cloud::DiscoveryEngine::V1beta::ConversationalSearchService::Rest::Client.new do |config|
# config.timeout = 10.0
# end
#
# @yield [config] Configure the ConversationalSearchService client.
# @yieldparam config [Client::Configuration]
#
def initialize
# 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.nil? ||
(@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
@conversational_search_service_stub = ::Google::Cloud::DiscoveryEngine::V1beta::ConversationalSearchService::Rest::ServiceStub.new(
endpoint: @config.endpoint,
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
universe_domain: @config.universe_domain,
credentials: credentials
)
@location_client = Google::Cloud::Location::Locations::Rest::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
end
end
##
# Get the associated client for mix-in of the Locations.
#
# @return [Google::Cloud::Location::Locations::Rest::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, filter: nil, boost_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.
# @param filter [::String]
# The filter syntax consists of an expression language for constructing a
# predicate from one or more fields of the documents being filtered. Filter
# expression is case-sensitive. This will be used to filter search results
# which may affect the summary response.
#
# If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
#
# Filtering in Vertex AI Search is done by mapping the LHS filter key to a
# key property defined in the Vertex AI Search backend -- this mapping is
# defined by the customer in their schema. For example a media customer might
# have a field 'name' in their schema. In this case the filter would look
# like this: filter --> name:'ANY("king kong")'
#
# For more information about filtering including syntax and filter
# operators, see
# [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
# @param boost_spec [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::BoostSpec, ::Hash]
# Boost specification to boost certain documents in search results which may
# affect the converse response. For more information on boosting, see
# [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
# @yield [result, operation] Access the result along with the TransportOperation object
# @yieldparam result [::Google::Cloud::DiscoveryEngine::V1beta::ConverseConversationResponse]
# @yieldparam operation [::Gapic::Rest::TransportOperation]
#
# @return [::Google::Cloud::DiscoveryEngine::V1beta::ConverseConversationResponse]
#
# @raise [::Google::Cloud::Error] if the REST call 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::Rest::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
call_metadata = @config.rpcs.converse_conversation.metadata.to_h
# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
call_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,
transports_version_send: [:rest]
call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
options.apply_defaults timeout: @config.rpcs.converse_conversation.timeout,
metadata: call_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.converse_conversation request, options do |result, operation|
yield result, operation if block_given?
return result
end
rescue ::Gapic::Rest::Error => 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 [result, operation] Access the result along with the TransportOperation object
# @yieldparam result [::Google::Cloud::DiscoveryEngine::V1beta::Conversation]
# @yieldparam operation [::Gapic::Rest::TransportOperation]
#
# @return [::Google::Cloud::DiscoveryEngine::V1beta::Conversation]
#
# @raise [::Google::Cloud::Error] if the REST call 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::Rest::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
call_metadata = @config.rpcs.create_conversation.metadata.to_h
# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
call_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,
transports_version_send: [:rest]
call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
options.apply_defaults timeout: @config.rpcs.create_conversation.timeout,
metadata: call_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.create_conversation request, options do |result, operation|
yield result, operation if block_given?
return result
end
rescue ::Gapic::Rest::Error => 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 [result, operation] Access the result along with the TransportOperation object
# @yieldparam result [::Google::Protobuf::Empty]
# @yieldparam operation [::Gapic::Rest::TransportOperation]
#
# @return [::Google::Protobuf::Empty]
#
# @raise [::Google::Cloud::Error] if the REST call 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::Rest::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
call_metadata = @config.rpcs.delete_conversation.metadata.to_h
# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
call_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,
transports_version_send: [:rest]
call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
options.apply_defaults timeout: @config.rpcs.delete_conversation.timeout,
metadata: call_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.delete_conversation request, options do |result, operation|
yield result, operation if block_given?
return result
end
rescue ::Gapic::Rest::Error => 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:
#
# * {::Google::Cloud::DiscoveryEngine::V1beta::Conversation#name Conversation.name}
#
# If not set or empty, all supported fields are updated.
# @yield [result, operation] Access the result along with the TransportOperation object
# @yieldparam result [::Google::Cloud::DiscoveryEngine::V1beta::Conversation]
# @yieldparam operation [::Gapic::Rest::TransportOperation]
#
# @return [::Google::Cloud::DiscoveryEngine::V1beta::Conversation]
#
# @raise [::Google::Cloud::Error] if the REST call 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::Rest::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
call_metadata = @config.rpcs.update_conversation.metadata.to_h
# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
call_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,
transports_version_send: [:rest]
call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
options.apply_defaults timeout: @config.rpcs.update_conversation.timeout,
metadata: call_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.update_conversation request, options do |result, operation|
yield result, operation if block_given?
return result
end
rescue ::Gapic::Rest::Error => 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 [result, operation] Access the result along with the TransportOperation object
# @yieldparam result [::Google::Cloud::DiscoveryEngine::V1beta::Conversation]
# @yieldparam operation [::Gapic::Rest::TransportOperation]
#
# @return [::Google::Cloud::DiscoveryEngine::V1beta::Conversation]
#
# @raise [::Google::Cloud::Error] if the REST call 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::Rest::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
call_metadata = @config.rpcs.get_conversation.metadata.to_h
# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
call_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,
transports_version_send: [:rest]
call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
options.apply_defaults timeout: @config.rpcs.get_conversation.timeout,
metadata: call_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.get_conversation request, options do |result, operation|
yield result, operation if block_given?
return result
end
rescue ::Gapic::Rest::Error => e
raise ::Google::Cloud::Error.from_error(e)
end
##
# Lists all Conversations by their parent
# {::Google::Cloud::DiscoveryEngine::V1beta::DataStore 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 [result, operation] Access the result along with the TransportOperation object
# @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1beta::Conversation>]
# @yieldparam operation [::Gapic::Rest::TransportOperation]
#
# @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1beta::Conversation>]
#
# @raise [::Google::Cloud::Error] if the REST call 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::Rest::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
call_metadata = @config.rpcs.list_conversations.metadata.to_h
# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
call_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,
transports_version_send: [:rest]
call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
options.apply_defaults timeout: @config.rpcs.list_conversations.timeout,
metadata: call_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.list_conversations request, options do |result, operation|
result = ::Gapic::Rest::PagedEnumerable.new @conversational_search_service_stub, :list_conversations, "conversations", request, result, options
yield result, operation if block_given?
return result
end
rescue ::Gapic::Rest::Error => e
raise ::Google::Cloud::Error.from_error(e)
end
##
# Answer query method.
#
# @overload answer_query(request, options = nil)
# Pass arguments to `answer_query` via a request object, either of type
# {::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest} or an equivalent Hash.
#
# @param request [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest, ::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 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)
# 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).
#
# @param serving_config [::String]
# Required. The resource name of the Search serving config, such as
# `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`,
# or
# `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`.
# This field is used to identify the serving configuration name, set
# of models used to make the search.
# @param query [::Google::Cloud::DiscoveryEngine::V1beta::Query, ::Hash]
# Required. Current user query.
# @param session [::String]
# The session resource name. Not required.
#
# When session field is not set, the API is in sessionless mode.
#
# We support auto session mode: users can use the wildcard symbol `-` as
# session ID. A new ID will be automatically generated and assigned.
# @param safety_spec [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::SafetySpec, ::Hash]
# Model specification.
# @param related_questions_spec [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::RelatedQuestionsSpec, ::Hash]
# Related questions 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]
# Search specification.
# @param query_understanding_spec [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::QueryUnderstandingSpec, ::Hash]
# Query understanding specification.
# @param asynchronous_mode [::Boolean]
# Asynchronous mode control.
#
# If enabled, the response will be returned with answer/session resource
# name without final answer. The API users need to do the polling to get
# the latest status of answer/session by calling
# {::Google::Cloud::DiscoveryEngine::V1beta::ConversationalSearchService::Rest::Client#get_answer ConversationalSearchService.GetAnswer}
# or
# {::Google::Cloud::DiscoveryEngine::V1beta::ConversationalSearchService::Rest::Client#get_session ConversationalSearchService.GetSession}
# method.
# @param user_pseudo_id [::String]
# A unique identifier for tracking visitors. For example, this could be
# implemented with an HTTP cookie, which should be able to uniquely identify
# a visitor on a single device. This unique identifier should not change if
# the visitor logs in or out of the website.
#
# This field should NOT have a fixed value such as `unknown_visitor`.
#
# The field must be a UTF-8 encoded string with a length limit of 128
# characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
# @yield [result, operation] Access the result along with the TransportOperation object
# @yieldparam result [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryResponse]
# @yieldparam operation [::Gapic::Rest::TransportOperation]
#
# @return [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryResponse]
#
# @raise [::Google::Cloud::Error] if the REST call 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::Rest::Client.new
#
# # Create a request. To set request fields, pass in keyword arguments.
# request = Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest.new
#
# # Call the answer_query method.
# result = client.answer_query request
#
# # The returned object is of type Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryResponse.
# p result
#
def answer_query request, options = nil
raise ::ArgumentError, "request must be provided" if request.nil?
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest
# 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
call_metadata = @config.rpcs.answer_query.metadata.to_h
# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
call_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,
transports_version_send: [:rest]
call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
options.apply_defaults timeout: @config.rpcs.answer_query.timeout,
metadata: call_metadata,
retry_policy: @config.rpcs.answer_query.retry_policy
options.apply_defaults timeout: @config.timeout,
metadata: @config.metadata,
retry_policy: @config.retry_policy
@conversational_search_service_stub.answer_query request, options do |result, operation|
yield result, operation if block_given?
return result
end
rescue ::Gapic::Rest::Error => e
raise ::Google::Cloud::Error.from_error(e)
end
##
# Gets a Answer.
#
# @overload get_answer(request, options = nil)
# Pass arguments to `get_answer` via a request object, either of type
# {::Google::Cloud::DiscoveryEngine::V1beta::GetAnswerRequest} or an equivalent Hash.
#
# @param request [::Google::Cloud::DiscoveryEngine::V1beta::GetAnswerRequest, ::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_answer(name: nil)
# Pass arguments to `get_answer` 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 Answer to get. Format:
# `projects/{project_number}/locations/{location_id}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`
# @yield [result, operation] Access the result along with the TransportOperation object
# @yieldparam result [::Google::Cloud::DiscoveryEngine::V1beta::Answer]
# @yieldparam operation [::Gapic::Rest::TransportOperation]
#
# @return [::Google::Cloud::DiscoveryEngine::V1beta::Answer]
#
# @raise [::Google::Cloud::Error] if the REST call 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::Rest::Client.new
#
# # Create a request. To set request fields, pass in keyword arguments.
# request = Google::Cloud::DiscoveryEngine::V1beta::GetAnswerRequest.new
#
# # Call the get_answer method.
# result = client.get_answer request
#
# # The returned object is of type Google::Cloud::DiscoveryEngine::V1beta::Answer.
# p result
#
def get_answer request, options = nil
raise ::ArgumentError, "request must be provided" if request.nil?
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1beta::GetAnswerRequest
# 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
call_metadata = @config.rpcs.get_answer.metadata.to_h
# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
call_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,
transports_version_send: [:rest]
call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
options.apply_defaults timeout: @config.rpcs.get_answer.timeout,
metadata: call_metadata,
retry_policy: @config.rpcs.get_answer.retry_policy
options.apply_defaults timeout: @config.timeout,
metadata: @config.metadata,
retry_policy: @config.retry_policy
@conversational_search_service_stub.get_answer request, options do |result, operation|
yield result, operation if block_given?
return result
end
rescue ::Gapic::Rest::Error => e
raise ::Google::Cloud::Error.from_error(e)
end
##
# Creates a Session.
#
# If the {::Google::Cloud::DiscoveryEngine::V1beta::Session Session} to create
# already exists, an ALREADY_EXISTS error is returned.
#
# @overload create_session(request, options = nil)
# Pass arguments to `create_session` via a request object, either of type
# {::Google::Cloud::DiscoveryEngine::V1beta::CreateSessionRequest} or an equivalent Hash.
#
# @param request [::Google::Cloud::DiscoveryEngine::V1beta::CreateSessionRequest, ::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_session(parent: nil, session: nil)
# Pass arguments to `create_session` 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 session [::Google::Cloud::DiscoveryEngine::V1beta::Session, ::Hash]
# Required. The session to create.
# @yield [result, operation] Access the result along with the TransportOperation object
# @yieldparam result [::Google::Cloud::DiscoveryEngine::V1beta::Session]
# @yieldparam operation [::Gapic::Rest::TransportOperation]
#
# @return [::Google::Cloud::DiscoveryEngine::V1beta::Session]
#
# @raise [::Google::Cloud::Error] if the REST call 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::Rest::Client.new
#
# # Create a request. To set request fields, pass in keyword arguments.
# request = Google::Cloud::DiscoveryEngine::V1beta::CreateSessionRequest.new
#
# # Call the create_session method.
# result = client.create_session request
#
# # The returned object is of type Google::Cloud::DiscoveryEngine::V1beta::Session.
# p result
#
def create_session request, options = nil
raise ::ArgumentError, "request must be provided" if request.nil?
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1beta::CreateSessionRequest
# 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
call_metadata = @config.rpcs.create_session.metadata.to_h
# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
call_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,
transports_version_send: [:rest]
call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
options.apply_defaults timeout: @config.rpcs.create_session.timeout,
metadata: call_metadata,
retry_policy: @config.rpcs.create_session.retry_policy
options.apply_defaults timeout: @config.timeout,
metadata: @config.metadata,
retry_policy: @config.retry_policy
@conversational_search_service_stub.create_session request, options do |result, operation|
yield result, operation if block_given?
return result
end
rescue ::Gapic::Rest::Error => e
raise ::Google::Cloud::Error.from_error(e)
end
##
# Deletes a Session.
#
# If the {::Google::Cloud::DiscoveryEngine::V1beta::Session Session} to delete
# does not exist, a NOT_FOUND error is returned.
#
# @overload delete_session(request, options = nil)
# Pass arguments to `delete_session` via a request object, either of type
# {::Google::Cloud::DiscoveryEngine::V1beta::DeleteSessionRequest} or an equivalent Hash.
#
# @param request [::Google::Cloud::DiscoveryEngine::V1beta::DeleteSessionRequest, ::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_session(name: nil)
# Pass arguments to `delete_session` 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 Session to delete. Format:
# `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`
# @yield [result, operation] Access the result along with the TransportOperation object
# @yieldparam result [::Google::Protobuf::Empty]
# @yieldparam operation [::Gapic::Rest::TransportOperation]
#
# @return [::Google::Protobuf::Empty]
#
# @raise [::Google::Cloud::Error] if the REST call 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::Rest::Client.new
#
# # Create a request. To set request fields, pass in keyword arguments.
# request = Google::Cloud::DiscoveryEngine::V1beta::DeleteSessionRequest.new
#
# # Call the delete_session method.
# result = client.delete_session request
#
# # The returned object is of type Google::Protobuf::Empty.
# p result
#
def delete_session request, options = nil
raise ::ArgumentError, "request must be provided" if request.nil?
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1beta::DeleteSessionRequest
# 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
call_metadata = @config.rpcs.delete_session.metadata.to_h
# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
call_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,
transports_version_send: [:rest]
call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
options.apply_defaults timeout: @config.rpcs.delete_session.timeout,
metadata: call_metadata,
retry_policy: @config.rpcs.delete_session.retry_policy
options.apply_defaults timeout: @config.timeout,
metadata: @config.metadata,
retry_policy: @config.retry_policy
@conversational_search_service_stub.delete_session request, options do |result, operation|
yield result, operation if block_given?
return result
end
rescue ::Gapic::Rest::Error => e
raise ::Google::Cloud::Error.from_error(e)
end
##
# Updates a Session.
#
# {::Google::Cloud::DiscoveryEngine::V1beta::Session Session} action type cannot
# be changed. If the {::Google::Cloud::DiscoveryEngine::V1beta::Session Session}
# to update does not exist, a NOT_FOUND error is returned.
#
# @overload update_session(request, options = nil)
# Pass arguments to `update_session` via a request object, either of type
# {::Google::Cloud::DiscoveryEngine::V1beta::UpdateSessionRequest} or an equivalent Hash.
#
# @param request [::Google::Cloud::DiscoveryEngine::V1beta::UpdateSessionRequest, ::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_session(session: nil, update_mask: nil)
# Pass arguments to `update_session` 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 session [::Google::Cloud::DiscoveryEngine::V1beta::Session, ::Hash]
# Required. The Session to update.
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
# Indicates which fields in the provided
# {::Google::Cloud::DiscoveryEngine::V1beta::Session Session} to update. The
# following are NOT supported:
#
# * {::Google::Cloud::DiscoveryEngine::V1beta::Session#name Session.name}
#
# If not set or empty, all supported fields are updated.
# @yield [result, operation] Access the result along with the TransportOperation object
# @yieldparam result [::Google::Cloud::DiscoveryEngine::V1beta::Session]
# @yieldparam operation [::Gapic::Rest::TransportOperation]
#
# @return [::Google::Cloud::DiscoveryEngine::V1beta::Session]
#
# @raise [::Google::Cloud::Error] if the REST call 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::Rest::Client.new
#
# # Create a request. To set request fields, pass in keyword arguments.
# request = Google::Cloud::DiscoveryEngine::V1beta::UpdateSessionRequest.new
#
# # Call the update_session method.
# result = client.update_session request
#
# # The returned object is of type Google::Cloud::DiscoveryEngine::V1beta::Session.
# p result
#
def update_session request, options = nil
raise ::ArgumentError, "request must be provided" if request.nil?
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1beta::UpdateSessionRequest
# 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
call_metadata = @config.rpcs.update_session.metadata.to_h
# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
call_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,
transports_version_send: [:rest]
call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
options.apply_defaults timeout: @config.rpcs.update_session.timeout,
metadata: call_metadata,
retry_policy: @config.rpcs.update_session.retry_policy
options.apply_defaults timeout: @config.timeout,
metadata: @config.metadata,
retry_policy: @config.retry_policy
@conversational_search_service_stub.update_session request, options do |result, operation|
yield result, operation if block_given?
return result
end
rescue ::Gapic::Rest::Error => e
raise ::Google::Cloud::Error.from_error(e)
end
##
# Gets a Session.
#
# @overload get_session(request, options = nil)
# Pass arguments to `get_session` via a request object, either of type
# {::Google::Cloud::DiscoveryEngine::V1beta::GetSessionRequest} or an equivalent Hash.
#
# @param request [::Google::Cloud::DiscoveryEngine::V1beta::GetSessionRequest, ::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_session(name: nil)
# Pass arguments to `get_session` 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 Session to get. Format:
# `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`
# @yield [result, operation] Access the result along with the TransportOperation object
# @yieldparam result [::Google::Cloud::DiscoveryEngine::V1beta::Session]
# @yieldparam operation [::Gapic::Rest::TransportOperation]
#
# @return [::Google::Cloud::DiscoveryEngine::V1beta::Session]
#
# @raise [::Google::Cloud::Error] if the REST call 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::Rest::Client.new
#
# # Create a request. To set request fields, pass in keyword arguments.
# request = Google::Cloud::DiscoveryEngine::V1beta::GetSessionRequest.new
#
# # Call the get_session method.
# result = client.get_session request
#
# # The returned object is of type Google::Cloud::DiscoveryEngine::V1beta::Session.
# p result
#
def get_session request, options = nil
raise ::ArgumentError, "request must be provided" if request.nil?
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1beta::GetSessionRequest
# 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
call_metadata = @config.rpcs.get_session.metadata.to_h
# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
call_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,
transports_version_send: [:rest]
call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
options.apply_defaults timeout: @config.rpcs.get_session.timeout,
metadata: call_metadata,
retry_policy: @config.rpcs.get_session.retry_policy
options.apply_defaults timeout: @config.timeout,
metadata: @config.metadata,
retry_policy: @config.retry_policy
@conversational_search_service_stub.get_session request, options do |result, operation|
yield result, operation if block_given?
return result
end
rescue ::Gapic::Rest::Error => e
raise ::Google::Cloud::Error.from_error(e)
end
##
# Lists all Sessions by their parent
# {::Google::Cloud::DiscoveryEngine::V1beta::DataStore DataStore}.
#
# @overload list_sessions(request, options = nil)
# Pass arguments to `list_sessions` via a request object, either of type
# {::Google::Cloud::DiscoveryEngine::V1beta::ListSessionsRequest} or an equivalent Hash.
#
# @param request [::Google::Cloud::DiscoveryEngine::V1beta::ListSessionsRequest, ::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_sessions(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil)
# Pass arguments to `list_sessions` 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 `ListSessions` 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`
# * `session_name`
#
# Example:
# "update_time desc"
# "create_time"
# @yield [result, operation] Access the result along with the TransportOperation object
# @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1beta::Session>]
# @yieldparam operation [::Gapic::Rest::TransportOperation]
#
# @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1beta::Session>]
#
# @raise [::Google::Cloud::Error] if the REST call 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::Rest::Client.new
#
# # Create a request. To set request fields, pass in keyword arguments.
# request = Google::Cloud::DiscoveryEngine::V1beta::ListSessionsRequest.new
#
# # Call the list_sessions method.
# result = client.list_sessions 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::Session.
# p item
# end
#
def list_sessions request, options = nil
raise ::ArgumentError, "request must be provided" if request.nil?
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1beta::ListSessionsRequest
# 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
call_metadata = @config.rpcs.list_sessions.metadata.to_h
# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
call_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,
transports_version_send: [:rest]
call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
options.apply_defaults timeout: @config.rpcs.list_sessions.timeout,
metadata: call_metadata,
retry_policy: @config.rpcs.list_sessions.retry_policy
options.apply_defaults timeout: @config.timeout,
metadata: @config.metadata,
retry_policy: @config.retry_policy
@conversational_search_service_stub.list_sessions request, options do |result, operation|
result = ::Gapic::Rest::PagedEnumerable.new @conversational_search_service_stub, :list_sessions, "sessions", request, result, options
yield result, operation if block_given?
return result
end
rescue ::Gapic::Rest::Error => e
raise ::Google::Cloud::Error.from_error(e)
end
##
# Configuration class for the ConversationalSearchService REST API.
#
# This class represents the configuration for ConversationalSearchService REST,
# 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::Rest::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::Rest::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::Rest::Client.new do |config|
# config.timeout = 10.0
# config.rpcs.converse_conversation.timeout = 20.0
# end
#
# @!attribute [rw] endpoint
# A custom service endpoint, as a hostname or hostname:port. The default is
# nil, indicating to use the default endpoint in the current universe domain.
# @return [::String,nil]
# @!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))
# * (`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] timeout
# The call timeout in seconds.
# @return [::Numeric]
# @!attribute [rw] metadata
# Additional 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<String>`) - The error codes that should
# trigger a retry.
# @return [::Hash]
# @!attribute [rw] quota_project
# A separate project against which to charge quota.
# @return [::String]
# @!attribute [rw] universe_domain
# The universe domain within which to make requests. This determines the
# default endpoint URL. The default value of nil uses the environment
# universe (usually the default "googleapis.com" universe).
# @return [::String,nil]
#
class Configuration
extend ::Gapic::Config
# @private
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
DEFAULT_ENDPOINT = "discoveryengine.googleapis.com"
config_attr :endpoint, nil, ::String, nil
config_attr :credentials, nil do |value|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
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 :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
config_attr :universe_domain, 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 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 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<String>`) - 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
##
# RPC-specific configuration for `answer_query`
# @return [::Gapic::Config::Method]
#
attr_reader :answer_query
##
# RPC-specific configuration for `get_answer`
# @return [::Gapic::Config::Method]
#
attr_reader :get_answer
##
# RPC-specific configuration for `create_session`
# @return [::Gapic::Config::Method]
#
attr_reader :create_session
##
# RPC-specific configuration for `delete_session`
# @return [::Gapic::Config::Method]
#
attr_reader :delete_session
##
# RPC-specific configuration for `update_session`
# @return [::Gapic::Config::Method]
#
attr_reader :update_session
##
# RPC-specific configuration for `get_session`
# @return [::Gapic::Config::Method]
#
attr_reader :get_session
##
# RPC-specific configuration for `list_sessions`
# @return [::Gapic::Config::Method]
#
attr_reader :list_sessions
# @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
answer_query_config = parent_rpcs.answer_query if parent_rpcs.respond_to? :answer_query
@answer_query = ::Gapic::Config::Method.new answer_query_config
get_answer_config = parent_rpcs.get_answer if parent_rpcs.respond_to? :get_answer
@get_answer = ::Gapic::Config::Method.new get_answer_config
create_session_config = parent_rpcs.create_session if parent_rpcs.respond_to? :create_session
@create_session = ::Gapic::Config::Method.new create_session_config
delete_session_config = parent_rpcs.delete_session if parent_rpcs.respond_to? :delete_session
@delete_session = ::Gapic::Config::Method.new delete_session_config
update_session_config = parent_rpcs.update_session if parent_rpcs.respond_to? :update_session
@update_session = ::Gapic::Config::Method.new update_session_config
get_session_config = parent_rpcs.get_session if parent_rpcs.respond_to? :get_session
@get_session = ::Gapic::Config::Method.new get_session_config
list_sessions_config = parent_rpcs.list_sessions if parent_rpcs.respond_to? :list_sessions
@list_sessions = ::Gapic::Config::Method.new list_sessions_config
yield self if block_given?
end
end
end
end
end
end
end
end
end
end