Conversations

google .cloud .dialogflow .v2. Conversations

Represents a Conversations

Constructor

new Conversations(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new Conversations service.

Parameters:

Name	Type	Attributes	Default	Description
`rpcImpl`	$protobuf.RPCImpl			RPC implementation
`requestDelimited`	boolean	<optional>	false	Whether requests are length-delimited
`responseDelimited`	boolean	<optional>	false	Whether responses are length-delimited

Extends

$protobuf.rpc.Service

Methods

completeConversation(request, callback) → {undefined}

Calls CompleteConversation.

Parameters:

Name	Type	Description
`request`	google.cloud.dialogflow.v2.ICompleteConversationRequest	CompleteConversationRequest message or plain object
`callback`	google.cloud.dialogflow.v2.Conversations.CompleteConversationCallback	Node-style callback called with the error, if any, and Conversation

Returns:

Type	Description
undefined

completeConversation(request) → {Promise.<google.cloud.dialogflow.v2.Conversation>}

Calls CompleteConversation.

Parameters:

Name	Type	Description
`request`	google.cloud.dialogflow.v2.ICompleteConversationRequest	CompleteConversationRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.dialogflow.v2.Conversation>	Promise

createConversation(request, callback) → {undefined}

Calls CreateConversation.

Parameters:

Name	Type	Description
`request`	google.cloud.dialogflow.v2.ICreateConversationRequest	CreateConversationRequest message or plain object
`callback`	google.cloud.dialogflow.v2.Conversations.CreateConversationCallback	Node-style callback called with the error, if any, and Conversation

Returns:

Type	Description
undefined

createConversation(request) → {Promise.<google.cloud.dialogflow.v2.Conversation>}

Calls CreateConversation.

Parameters:

Name	Type	Description
`request`	google.cloud.dialogflow.v2.ICreateConversationRequest	CreateConversationRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.dialogflow.v2.Conversation>	Promise

generateStatelessSuggestion(request, callback) → {undefined}

Calls GenerateStatelessSuggestion.

Parameters:

Name	Type	Description
`request`	google.cloud.dialogflow.v2.IGenerateStatelessSuggestionRequest	GenerateStatelessSuggestionRequest message or plain object
`callback`	google.cloud.dialogflow.v2.Conversations.GenerateStatelessSuggestionCallback	Node-style callback called with the error, if any, and GenerateStatelessSuggestionResponse

Returns:

Type	Description
undefined

generateStatelessSuggestion(request) → {Promise.<google.cloud.dialogflow.v2.GenerateStatelessSuggestionResponse>}

Calls GenerateStatelessSuggestion.

Parameters:

Name	Type	Description
`request`	google.cloud.dialogflow.v2.IGenerateStatelessSuggestionRequest	GenerateStatelessSuggestionRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.dialogflow.v2.GenerateStatelessSuggestionResponse>	Promise

generateStatelessSummary(request, callback) → {undefined}

Calls GenerateStatelessSummary.

Parameters:

Name	Type	Description
`request`	google.cloud.dialogflow.v2.IGenerateStatelessSummaryRequest	GenerateStatelessSummaryRequest message or plain object
`callback`	google.cloud.dialogflow.v2.Conversations.GenerateStatelessSummaryCallback	Node-style callback called with the error, if any, and GenerateStatelessSummaryResponse

Returns:

Type	Description
undefined

generateStatelessSummary(request) → {Promise.<google.cloud.dialogflow.v2.GenerateStatelessSummaryResponse>}

Calls GenerateStatelessSummary.

Parameters:

Name	Type	Description
`request`	google.cloud.dialogflow.v2.IGenerateStatelessSummaryRequest	GenerateStatelessSummaryRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.dialogflow.v2.GenerateStatelessSummaryResponse>	Promise

getConversation(request, callback) → {undefined}

Calls GetConversation.

Parameters:

Name	Type	Description
`request`	google.cloud.dialogflow.v2.IGetConversationRequest	GetConversationRequest message or plain object
`callback`	google.cloud.dialogflow.v2.Conversations.GetConversationCallback	Node-style callback called with the error, if any, and Conversation

Returns:

Type	Description
undefined

getConversation(request) → {Promise.<google.cloud.dialogflow.v2.Conversation>}

Calls GetConversation.

Parameters:

Name	Type	Description
`request`	google.cloud.dialogflow.v2.IGetConversationRequest	GetConversationRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.dialogflow.v2.Conversation>	Promise

listConversations(request, callback) → {undefined}

Calls ListConversations.

Parameters:

Name	Type	Description
`request`	google.cloud.dialogflow.v2.IListConversationsRequest	ListConversationsRequest message or plain object
`callback`	google.cloud.dialogflow.v2.Conversations.ListConversationsCallback	Node-style callback called with the error, if any, and ListConversationsResponse

Returns:

Type	Description
undefined

listConversations(request) → {Promise.<google.cloud.dialogflow.v2.ListConversationsResponse>}

Calls ListConversations.

Parameters:

Name	Type	Description
`request`	google.cloud.dialogflow.v2.IListConversationsRequest	ListConversationsRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.dialogflow.v2.ListConversationsResponse>	Promise

listMessages(request, callback) → {undefined}

Calls ListMessages.

Parameters:

Name	Type	Description
`request`	google.cloud.dialogflow.v2.IListMessagesRequest	ListMessagesRequest message or plain object
`callback`	google.cloud.dialogflow.v2.Conversations.ListMessagesCallback	Node-style callback called with the error, if any, and ListMessagesResponse

Returns:

Type	Description
undefined

listMessages(request) → {Promise.<google.cloud.dialogflow.v2.ListMessagesResponse>}

Calls ListMessages.

Parameters:

Name	Type	Description
`request`	google.cloud.dialogflow.v2.IListMessagesRequest	ListMessagesRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.dialogflow.v2.ListMessagesResponse>	Promise

searchKnowledge(request, callback) → {undefined}

Calls SearchKnowledge.

Parameters:

Name	Type	Description
`request`	google.cloud.dialogflow.v2.ISearchKnowledgeRequest	SearchKnowledgeRequest message or plain object
`callback`	google.cloud.dialogflow.v2.Conversations.SearchKnowledgeCallback	Node-style callback called with the error, if any, and SearchKnowledgeResponse

Returns:

Type	Description
undefined

searchKnowledge(request) → {Promise.<google.cloud.dialogflow.v2.SearchKnowledgeResponse>}

Calls SearchKnowledge.

Parameters:

Name	Type	Description
`request`	google.cloud.dialogflow.v2.ISearchKnowledgeRequest	SearchKnowledgeRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.dialogflow.v2.SearchKnowledgeResponse>	Promise

suggestConversationSummary(request, callback) → {undefined}

Calls SuggestConversationSummary.

Parameters:

Name	Type	Description
`request`	google.cloud.dialogflow.v2.ISuggestConversationSummaryRequest	SuggestConversationSummaryRequest message or plain object
`callback`	google.cloud.dialogflow.v2.Conversations.SuggestConversationSummaryCallback	Node-style callback called with the error, if any, and SuggestConversationSummaryResponse

Returns:

Type	Description
undefined

suggestConversationSummary(request) → {Promise.<google.cloud.dialogflow.v2.SuggestConversationSummaryResponse>}

Calls SuggestConversationSummary.

Parameters:

Name	Type	Description
`request`	google.cloud.dialogflow.v2.ISuggestConversationSummaryRequest	SuggestConversationSummaryRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.dialogflow.v2.SuggestConversationSummaryResponse>	Promise

(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {Conversations}

Creates new Conversations service using the specified rpc implementation.

Parameters:

Name	Type	Attributes	Default	Description
`rpcImpl`	$protobuf.RPCImpl			RPC implementation
`requestDelimited`	boolean	<optional>	false	Whether requests are length-delimited
`responseDelimited`	boolean	<optional>	false	Whether responses are length-delimited

Returns:

Type	Description
Conversations	RPC service. Useful where requests and/or responses are streamed.

Type Definitions

CompleteConversationCallback(error, responseopt)

Callback as used by completeConversation.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.dialogflow.v2.Conversation	<optional>	Conversation

CreateConversationCallback(error, responseopt)

Callback as used by createConversation.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.dialogflow.v2.Conversation	<optional>	Conversation

GenerateStatelessSuggestionCallback(error, responseopt)

Callback as used by generateStatelessSuggestion.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.dialogflow.v2.GenerateStatelessSuggestionResponse	<optional>	GenerateStatelessSuggestionResponse

GenerateStatelessSummaryCallback(error, responseopt)

Callback as used by generateStatelessSummary.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.dialogflow.v2.GenerateStatelessSummaryResponse	<optional>	GenerateStatelessSummaryResponse

GetConversationCallback(error, responseopt)

Callback as used by getConversation.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.dialogflow.v2.Conversation	<optional>	Conversation

ListConversationsCallback(error, responseopt)

Callback as used by listConversations.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.dialogflow.v2.ListConversationsResponse	<optional>	ListConversationsResponse

ListMessagesCallback(error, responseopt)

Callback as used by listMessages.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.dialogflow.v2.ListMessagesResponse	<optional>	ListMessagesResponse

SearchKnowledgeCallback(error, responseopt)

Callback as used by searchKnowledge.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.dialogflow.v2.SearchKnowledgeResponse	<optional>	SearchKnowledgeResponse

SuggestConversationSummaryCallback(error, responseopt)

Callback as used by suggestConversationSummary.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.dialogflow.v2.SuggestConversationSummaryResponse	<optional>	SuggestConversationSummaryResponse