Reference documentation and code samples for the Discovery Engine V1BETA API class Google::Cloud::DiscoveryEngine::V1beta::ConversationalSearchService::Rest::ServiceStub.
REST service stub for the ConversationalSearchService service. Service stub contains baseline method implementations including transcoding, making the REST call, and deserialing the response.
Inherits
- Object
Methods
#answer_query
def answer_query(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryResponse
Baseline implementation for the answer_query REST call
- request_pb (::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#converse_conversation
def converse_conversation(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::DiscoveryEngine::V1beta::ConverseConversationResponse
Baseline implementation for the converse_conversation REST call
- request_pb (::Google::Cloud::DiscoveryEngine::V1beta::ConverseConversationRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::DiscoveryEngine::V1beta::ConverseConversationResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::DiscoveryEngine::V1beta::ConverseConversationResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#create_conversation
def create_conversation(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::DiscoveryEngine::V1beta::Conversation
Baseline implementation for the create_conversation REST call
- request_pb (::Google::Cloud::DiscoveryEngine::V1beta::CreateConversationRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::DiscoveryEngine::V1beta::Conversation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::DiscoveryEngine::V1beta::Conversation) — A result object deserialized from the server's reply
- (::ArgumentError)
#create_session
def create_session(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::DiscoveryEngine::V1beta::Session
Baseline implementation for the create_session REST call
- request_pb (::Google::Cloud::DiscoveryEngine::V1beta::CreateSessionRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::DiscoveryEngine::V1beta::Session)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::DiscoveryEngine::V1beta::Session) — A result object deserialized from the server's reply
- (::ArgumentError)
#delete_conversation
def delete_conversation(request_pb, options = nil) { |result, operation| ... } -> ::Google::Protobuf::Empty
Baseline implementation for the delete_conversation REST call
- request_pb (::Google::Cloud::DiscoveryEngine::V1beta::DeleteConversationRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Protobuf::Empty)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Protobuf::Empty) — A result object deserialized from the server's reply
- (::ArgumentError)
#delete_session
def delete_session(request_pb, options = nil) { |result, operation| ... } -> ::Google::Protobuf::Empty
Baseline implementation for the delete_session REST call
- request_pb (::Google::Cloud::DiscoveryEngine::V1beta::DeleteSessionRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Protobuf::Empty)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Protobuf::Empty) — A result object deserialized from the server's reply
- (::ArgumentError)
#endpoint
def endpoint() -> String
The effective endpoint
- (String)
#get_answer
def get_answer(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::DiscoveryEngine::V1beta::Answer
Baseline implementation for the get_answer REST call
- request_pb (::Google::Cloud::DiscoveryEngine::V1beta::GetAnswerRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::DiscoveryEngine::V1beta::Answer)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::DiscoveryEngine::V1beta::Answer) — A result object deserialized from the server's reply
- (::ArgumentError)
#get_conversation
def get_conversation(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::DiscoveryEngine::V1beta::Conversation
Baseline implementation for the get_conversation REST call
- request_pb (::Google::Cloud::DiscoveryEngine::V1beta::GetConversationRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::DiscoveryEngine::V1beta::Conversation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::DiscoveryEngine::V1beta::Conversation) — A result object deserialized from the server's reply
- (::ArgumentError)
#get_session
def get_session(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::DiscoveryEngine::V1beta::Session
Baseline implementation for the get_session REST call
- request_pb (::Google::Cloud::DiscoveryEngine::V1beta::GetSessionRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::DiscoveryEngine::V1beta::Session)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::DiscoveryEngine::V1beta::Session) — A result object deserialized from the server's reply
- (::ArgumentError)
#initialize
def initialize(endpoint:, endpoint_template:, universe_domain:, credentials:) -> ServiceStub
- (ServiceStub) — a new instance of ServiceStub
#list_conversations
def list_conversations(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::DiscoveryEngine::V1beta::ListConversationsResponse
Baseline implementation for the list_conversations REST call
- request_pb (::Google::Cloud::DiscoveryEngine::V1beta::ListConversationsRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::DiscoveryEngine::V1beta::ListConversationsResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::DiscoveryEngine::V1beta::ListConversationsResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#list_sessions
def list_sessions(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::DiscoveryEngine::V1beta::ListSessionsResponse
Baseline implementation for the list_sessions REST call
- request_pb (::Google::Cloud::DiscoveryEngine::V1beta::ListSessionsRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::DiscoveryEngine::V1beta::ListSessionsResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::DiscoveryEngine::V1beta::ListSessionsResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#universe_domain
def universe_domain() -> String
The effective universe domain
- (String)
#update_conversation
def update_conversation(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::DiscoveryEngine::V1beta::Conversation
Baseline implementation for the update_conversation REST call
- request_pb (::Google::Cloud::DiscoveryEngine::V1beta::UpdateConversationRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::DiscoveryEngine::V1beta::Conversation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::DiscoveryEngine::V1beta::Conversation) — A result object deserialized from the server's reply
- (::ArgumentError)
#update_session
def update_session(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::DiscoveryEngine::V1beta::Session
Baseline implementation for the update_session REST call
- request_pb (::Google::Cloud::DiscoveryEngine::V1beta::UpdateSessionRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::DiscoveryEngine::V1beta::Session)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::DiscoveryEngine::V1beta::Session) — A result object deserialized from the server's reply
- (::ArgumentError)