public sealed class ConversationsClientImpl : ConversationsClientConversations client wrapper implementation, for convenient use.
Namespace
Google.Cloud.Dialogflow.V2Assembly
Google.Cloud.Dialogflow.V2.dll
Remarks
Service for managing [Conversations][google.cloud.dialogflow.v2.Conversation].
Constructors
ConversationsClientImpl(Conversations.ConversationsClient, ConversationsSettings)
public ConversationsClientImpl(Conversations.ConversationsClient grpcClient, ConversationsSettings settings)Constructs a client wrapper for the Conversations service, with the specified gRPC client and settings.
| Parameters | |
|---|---|
| Name | Description |
grpcClient | Conversations.ConversationsClientThe underlying gRPC client. |
settings | ConversationsSettingsThe base ConversationsSettings used within this client. |
Properties
GrpcClient
public override Conversations.ConversationsClient GrpcClient { get; }The underlying gRPC Conversations client
| Property Value | |
|---|---|
| Type | Description |
Conversations.ConversationsClient | |
Methods
CompleteConversation(CompleteConversationRequest, CallSettings)
public override Conversation CompleteConversation(CompleteConversationRequest request, CallSettings callSettings = null)Completes the specified conversation. Finished conversations are purged from the database after 30 days.
| Parameters | |
|---|---|
| Name | Description |
request | CompleteConversationRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Conversation | The RPC response. |
CompleteConversationAsync(CompleteConversationRequest, CallSettings)
public override Task<Conversation> CompleteConversationAsync(CompleteConversationRequest request, CallSettings callSettings = null)Completes the specified conversation. Finished conversations are purged from the database after 30 days.
| Parameters | |
|---|---|
| Name | Description |
request | CompleteConversationRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Conversation> | A Task containing the RPC response. |
CreateConversation(CreateConversationRequest, CallSettings)
public override Conversation CreateConversation(CreateConversationRequest request, CallSettings callSettings = null)Creates a new conversation. Conversations are auto-completed after 24 hours.
Conversation Lifecycle: There are two stages during a conversation: Automated Agent Stage and Assist Stage.
For Automated Agent Stage, there will be a dialogflow agent responding to user queries.
For Assist Stage, there's no dialogflow agent responding to user queries. But we will provide suggestions which are generated from conversation.
If [Conversation.conversation_profile][google.cloud.dialogflow.v2.Conversation.conversation_profile] is configured for a dialogflow
agent, conversation will start from Automated Agent Stage, otherwise, it
will start from Assist Stage. And during Automated Agent Stage, once an
[Intent][google.cloud.dialogflow.v2.Intent] with [Intent.live_agent_handoff][google.cloud.dialogflow.v2.Intent.live_agent_handoff] is triggered, conversation
will transfer to Assist Stage.
| Parameters | |
|---|---|
| Name | Description |
request | CreateConversationRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Conversation | The RPC response. |
CreateConversationAsync(CreateConversationRequest, CallSettings)
public override Task<Conversation> CreateConversationAsync(CreateConversationRequest request, CallSettings callSettings = null)Creates a new conversation. Conversations are auto-completed after 24 hours.
Conversation Lifecycle: There are two stages during a conversation: Automated Agent Stage and Assist Stage.
For Automated Agent Stage, there will be a dialogflow agent responding to user queries.
For Assist Stage, there's no dialogflow agent responding to user queries. But we will provide suggestions which are generated from conversation.
If [Conversation.conversation_profile][google.cloud.dialogflow.v2.Conversation.conversation_profile] is configured for a dialogflow
agent, conversation will start from Automated Agent Stage, otherwise, it
will start from Assist Stage. And during Automated Agent Stage, once an
[Intent][google.cloud.dialogflow.v2.Intent] with [Intent.live_agent_handoff][google.cloud.dialogflow.v2.Intent.live_agent_handoff] is triggered, conversation
will transfer to Assist Stage.
| Parameters | |
|---|---|
| Name | Description |
request | CreateConversationRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Conversation> | A Task containing the RPC response. |
GetConversation(GetConversationRequest, CallSettings)
public override Conversation GetConversation(GetConversationRequest request, CallSettings callSettings = null)Retrieves the specific conversation.
| Parameters | |
|---|---|
| Name | Description |
request | GetConversationRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Conversation | The RPC response. |
GetConversationAsync(GetConversationRequest, CallSettings)
public override Task<Conversation> GetConversationAsync(GetConversationRequest request, CallSettings callSettings = null)Retrieves the specific conversation.
| Parameters | |
|---|---|
| Name | Description |
request | GetConversationRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Conversation> | A Task containing the RPC response. |
ListConversations(ListConversationsRequest, CallSettings)
public override PagedEnumerable<ListConversationsResponse, Conversation> ListConversations(ListConversationsRequest request, CallSettings callSettings = null)Returns the list of all conversations in the specified project.
| Parameters | |
|---|---|
| Name | Description |
request | ListConversationsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerable<ListConversationsResponse, Conversation> | A pageable sequence of Conversation resources. |
ListConversationsAsync(ListConversationsRequest, CallSettings)
public override PagedAsyncEnumerable<ListConversationsResponse, Conversation> ListConversationsAsync(ListConversationsRequest request, CallSettings callSettings = null)Returns the list of all conversations in the specified project.
| Parameters | |
|---|---|
| Name | Description |
request | ListConversationsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerable<ListConversationsResponse, Conversation> | A pageable asynchronous sequence of Conversation resources. |
ListMessages(ListMessagesRequest, CallSettings)
public override PagedEnumerable<ListMessagesResponse, Message> ListMessages(ListMessagesRequest request, CallSettings callSettings = null)Lists messages that belong to a given conversation.
messages are ordered by create_time in descending order. To fetch
updates without duplication, send request with filter
create_time_epoch_microseconds }
[first item's create_time of previous request] and empty page_token.
| Parameters | |
|---|---|
| Name | Description |
request | ListMessagesRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerable<ListMessagesResponse, Message> | A pageable sequence of Message resources. |
ListMessagesAsync(ListMessagesRequest, CallSettings)
public override PagedAsyncEnumerable<ListMessagesResponse, Message> ListMessagesAsync(ListMessagesRequest request, CallSettings callSettings = null)Lists messages that belong to a given conversation.
messages are ordered by create_time in descending order. To fetch
updates without duplication, send request with filter
create_time_epoch_microseconds }
[first item's create_time of previous request] and empty page_token.
| Parameters | |
|---|---|
| Name | Description |
request | ListMessagesRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerable<ListMessagesResponse, Message> | A pageable asynchronous sequence of Message resources. |