Google Cloud Dialogflow v2beta1 API - Class Conversations.ConversationsClient (1.0.0-beta14)

public class Conversations.ConversationsClient : ClientBase<Conversations.ConversationsClient>

Reference documentation and code samples for the Google Cloud Dialogflow v2beta1 API class Conversations.ConversationsClient.

Client for Conversations

Inheritance

object > ClientBase > ClientBaseConversationsConversationsClient > Conversations.ConversationsClient

Namespace

Google.Cloud.Dialogflow.V2Beta1

Assembly

Google.Cloud.Dialogflow.V2Beta1.dll

Constructors

ConversationsClient()

protected ConversationsClient()

Protected parameterless constructor to allow creation of test doubles.

ConversationsClient(CallInvoker)

public ConversationsClient(CallInvoker callInvoker)

Creates a new client for Conversations that uses a custom CallInvoker.

Parameter
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

ConversationsClient(ChannelBase)

public ConversationsClient(ChannelBase channel)

Creates a new client for Conversations

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

ConversationsClient(ClientBaseConfiguration)

protected ConversationsClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBaseClientBaseConfiguration

The client configuration.

Methods

BatchCreateMessages(BatchCreateMessagesRequest, CallOptions)

public virtual BatchCreateMessagesResponse BatchCreateMessages(BatchCreateMessagesRequest request, CallOptions options)

Batch ingests messages to conversation. Customers can use this RPC to ingest historical messages to conversation.

Parameters
NameDescription
requestBatchCreateMessagesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
BatchCreateMessagesResponse

The response received from the server.

BatchCreateMessages(BatchCreateMessagesRequest, Metadata, DateTime?, CancellationToken)

public virtual BatchCreateMessagesResponse BatchCreateMessages(BatchCreateMessagesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Batch ingests messages to conversation. Customers can use this RPC to ingest historical messages to conversation.

Parameters
NameDescription
requestBatchCreateMessagesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineSystem.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
BatchCreateMessagesResponse

The response received from the server.

BatchCreateMessagesAsync(BatchCreateMessagesRequest, CallOptions)

public virtual AsyncUnaryCall<BatchCreateMessagesResponse> BatchCreateMessagesAsync(BatchCreateMessagesRequest request, CallOptions options)

Batch ingests messages to conversation. Customers can use this RPC to ingest historical messages to conversation.

Parameters
NameDescription
requestBatchCreateMessagesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallBatchCreateMessagesResponse

The call object.

BatchCreateMessagesAsync(BatchCreateMessagesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<BatchCreateMessagesResponse> BatchCreateMessagesAsync(BatchCreateMessagesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Batch ingests messages to conversation. Customers can use this RPC to ingest historical messages to conversation.

Parameters
NameDescription
requestBatchCreateMessagesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineSystem.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallBatchCreateMessagesResponse

The call object.

CompleteConversation(CompleteConversationRequest, CallOptions)

public virtual Conversation CompleteConversation(CompleteConversationRequest request, CallOptions options)

Completes the specified conversation. Finished conversations are purged from the database after 30 days.

Parameters
NameDescription
requestCompleteConversationRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Conversation

The response received from the server.

CompleteConversation(CompleteConversationRequest, Metadata, DateTime?, CancellationToken)

public virtual Conversation CompleteConversation(CompleteConversationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Completes the specified conversation. Finished conversations are purged from the database after 30 days.

Parameters
NameDescription
requestCompleteConversationRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineSystem.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Conversation

The response received from the server.

CompleteConversationAsync(CompleteConversationRequest, CallOptions)

public virtual AsyncUnaryCall<Conversation> CompleteConversationAsync(CompleteConversationRequest request, CallOptions options)

Completes the specified conversation. Finished conversations are purged from the database after 30 days.

Parameters
NameDescription
requestCompleteConversationRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallConversation

The call object.

CompleteConversationAsync(CompleteConversationRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Conversation> CompleteConversationAsync(CompleteConversationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Completes the specified conversation. Finished conversations are purged from the database after 30 days.

Parameters
NameDescription
requestCompleteConversationRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineSystem.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallConversation

The call object.

CreateConversation(CreateConversationRequest, CallOptions)

public virtual Conversation CreateConversation(CreateConversationRequest request, CallOptions options)

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.v2beta1.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.v2beta1.Intent] with [Intent.live_agent_handoff][google.cloud.dialogflow.v2beta1.Intent.live_agent_handoff] is triggered, conversation will transfer to Assist Stage.

Parameters
NameDescription
requestCreateConversationRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Conversation

The response received from the server.

CreateConversation(CreateConversationRequest, Metadata, DateTime?, CancellationToken)

public virtual Conversation CreateConversation(CreateConversationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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.v2beta1.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.v2beta1.Intent] with [Intent.live_agent_handoff][google.cloud.dialogflow.v2beta1.Intent.live_agent_handoff] is triggered, conversation will transfer to Assist Stage.

Parameters
NameDescription
requestCreateConversationRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineSystem.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Conversation

The response received from the server.

CreateConversationAsync(CreateConversationRequest, CallOptions)

public virtual AsyncUnaryCall<Conversation> CreateConversationAsync(CreateConversationRequest request, CallOptions options)

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.v2beta1.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.v2beta1.Intent] with [Intent.live_agent_handoff][google.cloud.dialogflow.v2beta1.Intent.live_agent_handoff] is triggered, conversation will transfer to Assist Stage.

Parameters
NameDescription
requestCreateConversationRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallConversation

The call object.

CreateConversationAsync(CreateConversationRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Conversation> CreateConversationAsync(CreateConversationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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.v2beta1.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.v2beta1.Intent] with [Intent.live_agent_handoff][google.cloud.dialogflow.v2beta1.Intent.live_agent_handoff] is triggered, conversation will transfer to Assist Stage.

Parameters
NameDescription
requestCreateConversationRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineSystem.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallConversation

The call object.

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

Creates a new instance of Locations.LocationsClient using the same call invoker as this client.

Returns
TypeDescription
LocationsLocationsClient

A new Locations.LocationsClient for the same target as this client.

GenerateStatelessSummary(GenerateStatelessSummaryRequest, CallOptions)

public virtual GenerateStatelessSummaryResponse GenerateStatelessSummary(GenerateStatelessSummaryRequest request, CallOptions options)

Generates and returns a summary for a conversation that does not have a resource created for it.

Parameters
NameDescription
requestGenerateStatelessSummaryRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
GenerateStatelessSummaryResponse

The response received from the server.

GenerateStatelessSummary(GenerateStatelessSummaryRequest, Metadata, DateTime?, CancellationToken)

public virtual GenerateStatelessSummaryResponse GenerateStatelessSummary(GenerateStatelessSummaryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Generates and returns a summary for a conversation that does not have a resource created for it.

Parameters
NameDescription
requestGenerateStatelessSummaryRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineSystem.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
GenerateStatelessSummaryResponse

The response received from the server.

GenerateStatelessSummaryAsync(GenerateStatelessSummaryRequest, CallOptions)

public virtual AsyncUnaryCall<GenerateStatelessSummaryResponse> GenerateStatelessSummaryAsync(GenerateStatelessSummaryRequest request, CallOptions options)

Generates and returns a summary for a conversation that does not have a resource created for it.

Parameters
NameDescription
requestGenerateStatelessSummaryRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallGenerateStatelessSummaryResponse

The call object.

GenerateStatelessSummaryAsync(GenerateStatelessSummaryRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<GenerateStatelessSummaryResponse> GenerateStatelessSummaryAsync(GenerateStatelessSummaryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Generates and returns a summary for a conversation that does not have a resource created for it.

Parameters
NameDescription
requestGenerateStatelessSummaryRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineSystem.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallGenerateStatelessSummaryResponse

The call object.

GetConversation(GetConversationRequest, CallOptions)

public virtual Conversation GetConversation(GetConversationRequest request, CallOptions options)

Retrieves the specific conversation.

Parameters
NameDescription
requestGetConversationRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Conversation

The response received from the server.

GetConversation(GetConversationRequest, Metadata, DateTime?, CancellationToken)

public virtual Conversation GetConversation(GetConversationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves the specific conversation.

Parameters
NameDescription
requestGetConversationRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineSystem.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Conversation

The response received from the server.

GetConversationAsync(GetConversationRequest, CallOptions)

public virtual AsyncUnaryCall<Conversation> GetConversationAsync(GetConversationRequest request, CallOptions options)

Retrieves the specific conversation.

Parameters
NameDescription
requestGetConversationRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallConversation

The call object.

GetConversationAsync(GetConversationRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Conversation> GetConversationAsync(GetConversationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves the specific conversation.

Parameters
NameDescription
requestGetConversationRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineSystem.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallConversation

The call object.

ListConversations(ListConversationsRequest, CallOptions)

public virtual ListConversationsResponse ListConversations(ListConversationsRequest request, CallOptions options)

Returns the list of all conversations in the specified project.

Parameters
NameDescription
requestListConversationsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListConversationsResponse

The response received from the server.

ListConversations(ListConversationsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListConversationsResponse ListConversations(ListConversationsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns the list of all conversations in the specified project.

Parameters
NameDescription
requestListConversationsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineSystem.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListConversationsResponse

The response received from the server.

ListConversationsAsync(ListConversationsRequest, CallOptions)

public virtual AsyncUnaryCall<ListConversationsResponse> ListConversationsAsync(ListConversationsRequest request, CallOptions options)

Returns the list of all conversations in the specified project.

Parameters
NameDescription
requestListConversationsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallListConversationsResponse

The call object.

ListConversationsAsync(ListConversationsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListConversationsResponse> ListConversationsAsync(ListConversationsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns the list of all conversations in the specified project.

Parameters
NameDescription
requestListConversationsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineSystem.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallListConversationsResponse

The call object.

ListMessages(ListMessagesRequest, CallOptions)

public virtual ListMessagesResponse ListMessages(ListMessagesRequest request, CallOptions options)

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
NameDescription
requestListMessagesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListMessagesResponse

The response received from the server.

ListMessages(ListMessagesRequest, Metadata, DateTime?, CancellationToken)

public virtual ListMessagesResponse ListMessages(ListMessagesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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
NameDescription
requestListMessagesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineSystem.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListMessagesResponse

The response received from the server.

ListMessagesAsync(ListMessagesRequest, CallOptions)

public virtual AsyncUnaryCall<ListMessagesResponse> ListMessagesAsync(ListMessagesRequest request, CallOptions options)

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
NameDescription
requestListMessagesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallListMessagesResponse

The call object.

ListMessagesAsync(ListMessagesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListMessagesResponse> ListMessagesAsync(ListMessagesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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
NameDescription
requestListMessagesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineSystem.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallListMessagesResponse

The call object.

NewInstance(ClientBaseConfiguration)

protected override Conversations.ConversationsClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
NameDescription
configurationClientBaseClientBaseConfiguration
Returns
TypeDescription
ConversationsConversationsClient
Overrides

SearchKnowledge(SearchKnowledgeRequest, CallOptions)

public virtual SearchKnowledgeResponse SearchKnowledge(SearchKnowledgeRequest request, CallOptions options)

Get answers for the given query based on knowledge documents.

Parameters
NameDescription
requestSearchKnowledgeRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
SearchKnowledgeResponse

The response received from the server.

SearchKnowledge(SearchKnowledgeRequest, Metadata, DateTime?, CancellationToken)

public virtual SearchKnowledgeResponse SearchKnowledge(SearchKnowledgeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Get answers for the given query based on knowledge documents.

Parameters
NameDescription
requestSearchKnowledgeRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineSystem.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
SearchKnowledgeResponse

The response received from the server.

SearchKnowledgeAsync(SearchKnowledgeRequest, CallOptions)

public virtual AsyncUnaryCall<SearchKnowledgeResponse> SearchKnowledgeAsync(SearchKnowledgeRequest request, CallOptions options)

Get answers for the given query based on knowledge documents.

Parameters
NameDescription
requestSearchKnowledgeRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallSearchKnowledgeResponse

The call object.

SearchKnowledgeAsync(SearchKnowledgeRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<SearchKnowledgeResponse> SearchKnowledgeAsync(SearchKnowledgeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Get answers for the given query based on knowledge documents.

Parameters
NameDescription
requestSearchKnowledgeRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineSystem.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallSearchKnowledgeResponse

The call object.

SuggestConversationSummary(SuggestConversationSummaryRequest, CallOptions)

public virtual SuggestConversationSummaryResponse SuggestConversationSummary(SuggestConversationSummaryRequest request, CallOptions options)

Suggest summary for a conversation based on specific historical messages. The range of the messages to be used for summary can be specified in the request.

Parameters
NameDescription
requestSuggestConversationSummaryRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
SuggestConversationSummaryResponse

The response received from the server.

SuggestConversationSummary(SuggestConversationSummaryRequest, Metadata, DateTime?, CancellationToken)

public virtual SuggestConversationSummaryResponse SuggestConversationSummary(SuggestConversationSummaryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Suggest summary for a conversation based on specific historical messages. The range of the messages to be used for summary can be specified in the request.

Parameters
NameDescription
requestSuggestConversationSummaryRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineSystem.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
SuggestConversationSummaryResponse

The response received from the server.

SuggestConversationSummaryAsync(SuggestConversationSummaryRequest, CallOptions)

public virtual AsyncUnaryCall<SuggestConversationSummaryResponse> SuggestConversationSummaryAsync(SuggestConversationSummaryRequest request, CallOptions options)

Suggest summary for a conversation based on specific historical messages. The range of the messages to be used for summary can be specified in the request.

Parameters
NameDescription
requestSuggestConversationSummaryRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallSuggestConversationSummaryResponse

The call object.

SuggestConversationSummaryAsync(SuggestConversationSummaryRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<SuggestConversationSummaryResponse> SuggestConversationSummaryAsync(SuggestConversationSummaryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Suggest summary for a conversation based on specific historical messages. The range of the messages to be used for summary can be specified in the request.

Parameters
NameDescription
requestSuggestConversationSummaryRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineSystem.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallSuggestConversationSummaryResponse

The call object.