Dialogflow V2 API - Class Google::Cloud::Dialogflow::V2::Conversations::Rest::ServiceStub (v1.4.0)

Version latest

• 1.4.0 (latest)
• 1.3.0
• 1.2.0
• 1.1.1
• 1.0.0
• 0.34.0
• 0.33.0
• 0.32.2
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.2
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.1
• 0.16.0
• 0.15.2
• 0.14.0
• 0.13.0
• 0.12.0

Reference documentation and code samples for the Dialogflow V2 API class Google::Cloud::Dialogflow::V2::Conversations::Rest::ServiceStub.

REST service stub for the Conversations service. Service stub contains baseline method implementations including transcoding, making the REST call, and deserialing the response.

Inherits

• Object

Methods

#complete_conversation

def complete_conversation(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Dialogflow::V2::Conversation

Baseline implementation for the complete_conversation REST call

Parameters

• request_pb (::Google::Cloud::Dialogflow::V2::CompleteConversationRequest) — 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::Dialogflow::V2::Conversation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Dialogflow::V2::Conversation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#create_conversation

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

Baseline implementation for the create_conversation REST call

Parameters

• request_pb (::Google::Cloud::Dialogflow::V2::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::Dialogflow::V2::Conversation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Dialogflow::V2::Conversation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#endpoint

def endpoint() -> String

The effective endpoint

Returns

• (String)

#generate_stateless_suggestion

def generate_stateless_suggestion(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Dialogflow::V2::GenerateStatelessSuggestionResponse

Baseline implementation for the generate_stateless_suggestion REST call

Parameters

• request_pb (::Google::Cloud::Dialogflow::V2::GenerateStatelessSuggestionRequest) — 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::Dialogflow::V2::GenerateStatelessSuggestionResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Dialogflow::V2::GenerateStatelessSuggestionResponse) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#generate_stateless_summary

def generate_stateless_summary(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Dialogflow::V2::GenerateStatelessSummaryResponse

Baseline implementation for the generate_stateless_summary REST call

Parameters

• request_pb (::Google::Cloud::Dialogflow::V2::GenerateStatelessSummaryRequest) — 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::Dialogflow::V2::GenerateStatelessSummaryResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Dialogflow::V2::GenerateStatelessSummaryResponse) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#get_conversation

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

Baseline implementation for the get_conversation REST call

Parameters

• request_pb (::Google::Cloud::Dialogflow::V2::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::Dialogflow::V2::Conversation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Dialogflow::V2::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::Dialogflow::V2::ListConversationsResponse

Baseline implementation for the list_conversations REST call

Parameters

• request_pb (::Google::Cloud::Dialogflow::V2::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::Dialogflow::V2::ListConversationsResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Dialogflow::V2::ListConversationsResponse) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#list_messages

def list_messages(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Dialogflow::V2::ListMessagesResponse

Baseline implementation for the list_messages REST call

Parameters

• request_pb (::Google::Cloud::Dialogflow::V2::ListMessagesRequest) — 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::Dialogflow::V2::ListMessagesResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Dialogflow::V2::ListMessagesResponse) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#search_knowledge

def search_knowledge(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Dialogflow::V2::SearchKnowledgeResponse

Baseline implementation for the search_knowledge REST call

Parameters

• request_pb (::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest) — 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::Dialogflow::V2::SearchKnowledgeResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Dialogflow::V2::SearchKnowledgeResponse) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#suggest_conversation_summary

def suggest_conversation_summary(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Dialogflow::V2::SuggestConversationSummaryResponse

Baseline implementation for the suggest_conversation_summary REST call

Parameters

• request_pb (::Google::Cloud::Dialogflow::V2::SuggestConversationSummaryRequest) — 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::Dialogflow::V2::SuggestConversationSummaryResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Dialogflow::V2::SuggestConversationSummaryResponse) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns

• (String)