Discovery Engine V1 API - Class Google::Cloud::DiscoveryEngine::V1::ConversationalSearchService::Rest::ServiceStub (v0.4.0)

Reference documentation and code samples for the Discovery Engine V1 API class Google::Cloud::DiscoveryEngine::V1::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

#converse_conversation

def converse_conversation(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::DiscoveryEngine::V1::ConverseConversationResponse

Baseline implementation for the converse_conversation REST call

Parameters

request_pb (::Google::Cloud::DiscoveryEngine::V1::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.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::DiscoveryEngine::V1::ConverseConversationResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::DiscoveryEngine::V1::ConverseConversationResponse) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#create_conversation

def create_conversation(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::DiscoveryEngine::V1::Conversation

Baseline implementation for the create_conversation REST call

Parameters

request_pb (::Google::Cloud::DiscoveryEngine::V1::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.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::DiscoveryEngine::V1::Conversation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::DiscoveryEngine::V1::Conversation) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#delete_conversation

def delete_conversation(request_pb, options = nil) { |result, operation| ... } -> ::Google::Protobuf::Empty

Baseline implementation for the delete_conversation REST call

Parameters

request_pb (::Google::Cloud::DiscoveryEngine::V1::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.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Protobuf::Empty)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Protobuf::Empty) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#get_conversation

def get_conversation(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::DiscoveryEngine::V1::Conversation

Baseline implementation for the get_conversation REST call

Parameters

request_pb (::Google::Cloud::DiscoveryEngine::V1::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.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::DiscoveryEngine::V1::Conversation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::DiscoveryEngine::V1::Conversation) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#initialize

def initialize(endpoint:, endpoint_template:, universe_domain:, credentials:) -> ServiceStub

Returns

(ServiceStub) — a new instance of ServiceStub

#list_conversations

def list_conversations(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::DiscoveryEngine::V1::ListConversationsResponse

Baseline implementation for the list_conversations REST call

Parameters

request_pb (::Google::Cloud::DiscoveryEngine::V1::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.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::DiscoveryEngine::V1::ListConversationsResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::DiscoveryEngine::V1::ListConversationsResponse) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns

(String)

#update_conversation

def update_conversation(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::DiscoveryEngine::V1::Conversation

Baseline implementation for the update_conversation REST call

Parameters

request_pb (::Google::Cloud::DiscoveryEngine::V1::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.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::DiscoveryEngine::V1::Conversation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::DiscoveryEngine::V1::Conversation) — A result object deserialized from the server's reply

Raises

(::ArgumentError)