Reference documentation and code samples for the Discovery Engine V1 API class Google::Cloud::DiscoveryEngine::V1::ConversationalSearchService::Rest::Client.
REST client for the ConversationalSearchService service.
Service for conversational search.
Inherits
- Object
Methods
.configure
def self.configure() { |config| ... } -> Client::Configuration
Configure the ConversationalSearchService Client class.
See Configuration for a description of the configuration fields.
- (config) — Configure the Client client.
- config (Client::Configuration)
# Modify the configuration for all ConversationalSearchService clients ::Google::Cloud::DiscoveryEngine::V1::ConversationalSearchService::Rest::Client.configure do |config| config.timeout = 10.0 end
#answer_query
def answer_query(request, options = nil) -> ::Google::Cloud::DiscoveryEngine::V1::AnswerQueryResponse
def answer_query(serving_config: nil, query: nil, session: nil, safety_spec: nil, related_questions_spec: nil, answer_generation_spec: nil, search_spec: nil, query_understanding_spec: nil, asynchronous_mode: nil, user_pseudo_id: nil, user_labels: nil) -> ::Google::Cloud::DiscoveryEngine::V1::AnswerQueryResponse
Answer query method.
def answer_query(request, options = nil) -> ::Google::Cloud::DiscoveryEngine::V1::AnswerQueryResponse
answer_query
via a request object, either of type
AnswerQueryRequest or an equivalent Hash.
- request (::Google::Cloud::DiscoveryEngine::V1::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.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def answer_query(serving_config: nil, query: nil, session: nil, safety_spec: nil, related_questions_spec: nil, answer_generation_spec: nil, search_spec: nil, query_understanding_spec: nil, asynchronous_mode: nil, user_pseudo_id: nil, user_labels: nil) -> ::Google::Cloud::DiscoveryEngine::V1::AnswerQueryResponse
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).
-
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
, orprojects/*/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. - query (::Google::Cloud::DiscoveryEngine::V1::Query, ::Hash) — Required. Current user query.
-
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. - safety_spec (::Google::Cloud::DiscoveryEngine::V1::AnswerQueryRequest::SafetySpec, ::Hash) — Model specification.
- related_questions_spec (::Google::Cloud::DiscoveryEngine::V1::AnswerQueryRequest::RelatedQuestionsSpec, ::Hash) — Related questions specification.
- answer_generation_spec (::Google::Cloud::DiscoveryEngine::V1::AnswerQueryRequest::AnswerGenerationSpec, ::Hash) — Answer generation specification.
- search_spec (::Google::Cloud::DiscoveryEngine::V1::AnswerQueryRequest::SearchSpec, ::Hash) — Search specification.
- query_understanding_spec (::Google::Cloud::DiscoveryEngine::V1::AnswerQueryRequest::QueryUnderstandingSpec, ::Hash) — Query understanding specification.
-
asynchronous_mode (::Boolean) — Deprecated: This field is deprecated. Streaming Answer API will be
supported.
Asynchronous mode control.
If enabled, the response will be returned with answer/session resource name without final answer. The API users need to do the polling to get the latest status of answer/session by calling ConversationalSearchService.GetAnswer or ConversationalSearchService.GetSession method.
-
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. -
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 for more details.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::DiscoveryEngine::V1::AnswerQueryResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/cloud/discovery_engine/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::DiscoveryEngine::V1::ConversationalSearchService::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::DiscoveryEngine::V1::AnswerQueryRequest.new # Call the answer_query method. result = client.answer_query request # The returned object is of type Google::Cloud::DiscoveryEngine::V1::AnswerQueryResponse. p result
#configure
def configure() { |config| ... } -> Client::Configuration
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 Configuration for a description of the configuration fields.
- (config) — Configure the Client client.
- config (Client::Configuration)
#converse_conversation
def converse_conversation(request, options = nil) -> ::Google::Cloud::DiscoveryEngine::V1::ConverseConversationResponse
def 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) -> ::Google::Cloud::DiscoveryEngine::V1::ConverseConversationResponse
Converses a conversation.
def converse_conversation(request, options = nil) -> ::Google::Cloud::DiscoveryEngine::V1::ConverseConversationResponse
converse_conversation
via a request object, either of type
Google::Cloud::DiscoveryEngine::V1::ConverseConversationRequest or an equivalent Hash.
- request (::Google::Cloud::DiscoveryEngine::V1::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.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def 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) -> ::Google::Cloud::DiscoveryEngine::V1::ConverseConversationResponse
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).
-
name (::String) — Required. The resource name of the Conversation to get. Format:
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}
. Useprojects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/-
to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. - query (::Google::Cloud::DiscoveryEngine::V1::TextInput, ::Hash) — Required. Current user input.
-
serving_config (::String) — The resource name of the Serving Config to use. Format:
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}
If this is not set, the default serving config will be used. - conversation (::Google::Cloud::DiscoveryEngine::V1::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.
- safe_search (::Boolean) — Whether to turn on safe search.
-
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 for more details.
- summary_spec (::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SummarySpec, ::Hash) — A specification for configuring the summary returned in the response.
-
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
- boost_spec (::Google::Cloud::DiscoveryEngine::V1::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
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::DiscoveryEngine::V1::ConverseConversationResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/cloud/discovery_engine/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::DiscoveryEngine::V1::ConversationalSearchService::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::DiscoveryEngine::V1::ConverseConversationRequest.new # Call the converse_conversation method. result = client.converse_conversation request # The returned object is of type Google::Cloud::DiscoveryEngine::V1::ConverseConversationResponse. p result
#create_conversation
def create_conversation(request, options = nil) -> ::Google::Cloud::DiscoveryEngine::V1::Conversation
def create_conversation(parent: nil, conversation: nil) -> ::Google::Cloud::DiscoveryEngine::V1::Conversation
Creates a Conversation.
If the Conversation to create already exists, an ALREADY_EXISTS error is returned.
def create_conversation(request, options = nil) -> ::Google::Cloud::DiscoveryEngine::V1::Conversation
create_conversation
via a request object, either of type
Google::Cloud::DiscoveryEngine::V1::CreateConversationRequest or an equivalent Hash.
- request (::Google::Cloud::DiscoveryEngine::V1::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.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def create_conversation(parent: nil, conversation: nil) -> ::Google::Cloud::DiscoveryEngine::V1::Conversation
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).
-
parent (::String) — Required. Full resource name of parent data store. Format:
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}
- conversation (::Google::Cloud::DiscoveryEngine::V1::Conversation, ::Hash) — Required. The conversation to create.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::DiscoveryEngine::V1::Conversation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/cloud/discovery_engine/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::DiscoveryEngine::V1::ConversationalSearchService::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::DiscoveryEngine::V1::CreateConversationRequest.new # Call the create_conversation method. result = client.create_conversation request # The returned object is of type Google::Cloud::DiscoveryEngine::V1::Conversation. p result
#create_session
def create_session(request, options = nil) -> ::Google::Cloud::DiscoveryEngine::V1::Session
def create_session(parent: nil, session: nil) -> ::Google::Cloud::DiscoveryEngine::V1::Session
def create_session(request, options = nil) -> ::Google::Cloud::DiscoveryEngine::V1::Session
create_session
via a request object, either of type
Google::Cloud::DiscoveryEngine::V1::CreateSessionRequest or an equivalent Hash.
- request (::Google::Cloud::DiscoveryEngine::V1::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.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def create_session(parent: nil, session: nil) -> ::Google::Cloud::DiscoveryEngine::V1::Session
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).
-
parent (::String) — Required. Full resource name of parent data store. Format:
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}
- session (::Google::Cloud::DiscoveryEngine::V1::Session, ::Hash) — Required. The session to create.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::DiscoveryEngine::V1::Session)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/cloud/discovery_engine/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::DiscoveryEngine::V1::ConversationalSearchService::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::DiscoveryEngine::V1::CreateSessionRequest.new # Call the create_session method. result = client.create_session request # The returned object is of type Google::Cloud::DiscoveryEngine::V1::Session. p result
#delete_conversation
def delete_conversation(request, options = nil) -> ::Google::Protobuf::Empty
def delete_conversation(name: nil) -> ::Google::Protobuf::Empty
Deletes a Conversation.
If the Conversation to delete does not exist, a NOT_FOUND error is returned.
def delete_conversation(request, options = nil) -> ::Google::Protobuf::Empty
delete_conversation
via a request object, either of type
DeleteConversationRequest or an equivalent Hash.
- request (::Google::Cloud::DiscoveryEngine::V1::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.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def delete_conversation(name: nil) -> ::Google::Protobuf::Empty
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).
-
name (::String) — Required. The resource name of the Conversation to delete. Format:
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Protobuf::Empty)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/cloud/discovery_engine/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::DiscoveryEngine::V1::ConversationalSearchService::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::DiscoveryEngine::V1::DeleteConversationRequest.new # Call the delete_conversation method. result = client.delete_conversation request # The returned object is of type Google::Protobuf::Empty. p result
#delete_session
def delete_session(request, options = nil) -> ::Google::Protobuf::Empty
def delete_session(name: nil) -> ::Google::Protobuf::Empty
def delete_session(request, options = nil) -> ::Google::Protobuf::Empty
delete_session
via a request object, either of type
DeleteSessionRequest or an equivalent Hash.
- request (::Google::Cloud::DiscoveryEngine::V1::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.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def delete_session(name: nil) -> ::Google::Protobuf::Empty
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).
-
name (::String) — Required. The resource name of the Session to delete. Format:
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Protobuf::Empty)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/cloud/discovery_engine/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::DiscoveryEngine::V1::ConversationalSearchService::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::DiscoveryEngine::V1::DeleteSessionRequest.new # Call the delete_session method. result = client.delete_session request # The returned object is of type Google::Protobuf::Empty. p result
#get_answer
def get_answer(request, options = nil) -> ::Google::Cloud::DiscoveryEngine::V1::Answer
def get_answer(name: nil) -> ::Google::Cloud::DiscoveryEngine::V1::Answer
Gets a Answer.
def get_answer(request, options = nil) -> ::Google::Cloud::DiscoveryEngine::V1::Answer
get_answer
via a request object, either of type
GetAnswerRequest or an equivalent Hash.
- request (::Google::Cloud::DiscoveryEngine::V1::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.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def get_answer(name: nil) -> ::Google::Cloud::DiscoveryEngine::V1::Answer
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).
-
name (::String) — Required. The resource name of the Answer to get. Format:
projects/{project}/locations/{location}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::DiscoveryEngine::V1::Answer)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/cloud/discovery_engine/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::DiscoveryEngine::V1::ConversationalSearchService::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::DiscoveryEngine::V1::GetAnswerRequest.new # Call the get_answer method. result = client.get_answer request # The returned object is of type Google::Cloud::DiscoveryEngine::V1::Answer. p result
#get_conversation
def get_conversation(request, options = nil) -> ::Google::Cloud::DiscoveryEngine::V1::Conversation
def get_conversation(name: nil) -> ::Google::Cloud::DiscoveryEngine::V1::Conversation
Gets a Conversation.
def get_conversation(request, options = nil) -> ::Google::Cloud::DiscoveryEngine::V1::Conversation
get_conversation
via a request object, either of type
GetConversationRequest or an equivalent Hash.
- request (::Google::Cloud::DiscoveryEngine::V1::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.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def get_conversation(name: nil) -> ::Google::Cloud::DiscoveryEngine::V1::Conversation
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).
-
name (::String) — Required. The resource name of the Conversation to get. Format:
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::DiscoveryEngine::V1::Conversation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/cloud/discovery_engine/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::DiscoveryEngine::V1::ConversationalSearchService::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::DiscoveryEngine::V1::GetConversationRequest.new # Call the get_conversation method. result = client.get_conversation request # The returned object is of type Google::Cloud::DiscoveryEngine::V1::Conversation. p result
#get_session
def get_session(request, options = nil) -> ::Google::Cloud::DiscoveryEngine::V1::Session
def get_session(name: nil) -> ::Google::Cloud::DiscoveryEngine::V1::Session
Gets a Session.
def get_session(request, options = nil) -> ::Google::Cloud::DiscoveryEngine::V1::Session
get_session
via a request object, either of type
GetSessionRequest or an equivalent Hash.
- request (::Google::Cloud::DiscoveryEngine::V1::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.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def get_session(name: nil) -> ::Google::Cloud::DiscoveryEngine::V1::Session
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).
-
name (::String) — Required. The resource name of the Session to get. Format:
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::DiscoveryEngine::V1::Session)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/cloud/discovery_engine/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::DiscoveryEngine::V1::ConversationalSearchService::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::DiscoveryEngine::V1::GetSessionRequest.new # Call the get_session method. result = client.get_session request # The returned object is of type Google::Cloud::DiscoveryEngine::V1::Session. p result
#initialize
def initialize() { |config| ... } -> Client
Create a new ConversationalSearchService REST client object.
- (config) — Configure the ConversationalSearchService client.
- config (Client::Configuration)
- (Client) — a new instance of Client
# Create a client using the default configuration client = ::Google::Cloud::DiscoveryEngine::V1::ConversationalSearchService::Rest::Client.new # Create a client using a custom configuration client = ::Google::Cloud::DiscoveryEngine::V1::ConversationalSearchService::Rest::Client.new do |config| config.timeout = 10.0 end
#list_conversations
def list_conversations(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1::Conversation>
def list_conversations(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1::Conversation>
Lists all Conversations by their parent DataStore.
def list_conversations(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1::Conversation>
list_conversations
via a request object, either of type
ListConversationsRequest or an equivalent Hash.
- request (::Google::Cloud::DiscoveryEngine::V1::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.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def list_conversations(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1::Conversation>
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).
-
parent (::String) — Required. The data store resource name. Format:
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}
- page_size (::Integer) — Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
-
page_token (::String) — A page token, received from a previous
ListConversations
call. Provide this to retrieve the subsequent page. -
filter (::String) — A filter to apply on the list results. The supported features are:
user_pseudo_id, state.
Example: "user_pseudo_id = some_id"
-
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"
- (result, operation) — Access the result along with the TransportOperation object
- result (::Gapic::Rest::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1::Conversation>)
- operation (::Gapic::Rest::TransportOperation)
- (::Gapic::Rest::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1::Conversation>)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/cloud/discovery_engine/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::DiscoveryEngine::V1::ConversationalSearchService::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::DiscoveryEngine::V1::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::V1::Conversation. p item end
#list_sessions
def list_sessions(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1::Session>
def list_sessions(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1::Session>
Lists all Sessions by their parent DataStore.
def list_sessions(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1::Session>
list_sessions
via a request object, either of type
ListSessionsRequest or an equivalent Hash.
- request (::Google::Cloud::DiscoveryEngine::V1::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.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def list_sessions(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1::Session>
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).
-
parent (::String) — Required. The data store resource name. Format:
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}
- page_size (::Integer) — Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
-
page_token (::String) — A page token, received from a previous
ListSessions
call. Provide this to retrieve the subsequent page. -
filter (::String) — A filter to apply on the list results. The supported features are:
user_pseudo_id, state.
Example: "user_pseudo_id = some_id"
-
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"
- (result, operation) — Access the result along with the TransportOperation object
- result (::Gapic::Rest::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1::Session>)
- operation (::Gapic::Rest::TransportOperation)
- (::Gapic::Rest::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1::Session>)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/cloud/discovery_engine/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::DiscoveryEngine::V1::ConversationalSearchService::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::DiscoveryEngine::V1::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::V1::Session. p item end
#location_client
def location_client() -> Google::Cloud::Location::Locations::Rest::Client
Get the associated client for mix-in of the Locations.
- (Google::Cloud::Location::Locations::Rest::Client)
#logger
def logger() -> Logger
The logger used for request/response debug logging.
- (Logger)
#universe_domain
def universe_domain() -> String
The effective universe domain
- (String)
#update_conversation
def update_conversation(request, options = nil) -> ::Google::Cloud::DiscoveryEngine::V1::Conversation
def update_conversation(conversation: nil, update_mask: nil) -> ::Google::Cloud::DiscoveryEngine::V1::Conversation
Updates a Conversation.
Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned.
def update_conversation(request, options = nil) -> ::Google::Cloud::DiscoveryEngine::V1::Conversation
update_conversation
via a request object, either of type
UpdateConversationRequest or an equivalent Hash.
- request (::Google::Cloud::DiscoveryEngine::V1::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.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def update_conversation(conversation: nil, update_mask: nil) -> ::Google::Cloud::DiscoveryEngine::V1::Conversation
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).
- conversation (::Google::Cloud::DiscoveryEngine::V1::Conversation, ::Hash) — Required. The Conversation to update.
-
update_mask (::Google::Protobuf::FieldMask, ::Hash) — Indicates which fields in the provided
Conversation to update. The
following are NOT supported:
If not set or empty, all supported fields are updated.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::DiscoveryEngine::V1::Conversation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/cloud/discovery_engine/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::DiscoveryEngine::V1::ConversationalSearchService::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::DiscoveryEngine::V1::UpdateConversationRequest.new # Call the update_conversation method. result = client.update_conversation request # The returned object is of type Google::Cloud::DiscoveryEngine::V1::Conversation. p result
#update_session
def update_session(request, options = nil) -> ::Google::Cloud::DiscoveryEngine::V1::Session
def update_session(session: nil, update_mask: nil) -> ::Google::Cloud::DiscoveryEngine::V1::Session
Updates a Session.
Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned.
def update_session(request, options = nil) -> ::Google::Cloud::DiscoveryEngine::V1::Session
update_session
via a request object, either of type
UpdateSessionRequest or an equivalent Hash.
- request (::Google::Cloud::DiscoveryEngine::V1::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.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def update_session(session: nil, update_mask: nil) -> ::Google::Cloud::DiscoveryEngine::V1::Session
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).
- session (::Google::Cloud::DiscoveryEngine::V1::Session, ::Hash) — Required. The Session to update.
-
update_mask (::Google::Protobuf::FieldMask, ::Hash) — Indicates which fields in the provided
Session to update. The following
are NOT supported:
If not set or empty, all supported fields are updated.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::DiscoveryEngine::V1::Session)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/cloud/discovery_engine/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::DiscoveryEngine::V1::ConversationalSearchService::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::DiscoveryEngine::V1::UpdateSessionRequest.new # Call the update_session method. result = client.update_session request # The returned object is of type Google::Cloud::DiscoveryEngine::V1::Session. p result