Google Cloud Dialogflow v2 API - Class Participants.ParticipantsClient (4.15.0)

Version 4.15.0

• 4.22.0 (latest)
• 4.21.0
• 4.20.0
• 4.19.0
• 4.18.0
• 4.17.0
• 4.16.0
• 4.15.0
• 4.14.0
• 4.13.0
• 4.12.0
• 4.11.0
• 4.10.0
• 4.9.0
• 4.8.0
• 4.7.0
• 4.6.0
• 4.5.0
• 4.4.0
• 4.3.0
• 4.2.0
• 4.1.0
• 4.0.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0

public class Participants.ParticipantsClient : ClientBase<Participants.ParticipantsClient>

Reference documentation and code samples for the Google Cloud Dialogflow v2 API class Participants.ParticipantsClient.

Client for Participants

Inheritance

object > ClientBase > ClientBaseParticipantsParticipantsClient > Participants.ParticipantsClient

Inherited Members

ClientBase<Participants.ParticipantsClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Dialogflow.V2

Assembly

Google.Cloud.Dialogflow.V2.dll

Constructors

ParticipantsClient()

protected ParticipantsClient()

Protected parameterless constructor to allow creation of test doubles.

ParticipantsClient(CallInvoker)

public ParticipantsClient(CallInvoker callInvoker)

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

Parameter
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

ParticipantsClient(ChannelBase)

public ParticipantsClient(ChannelBase channel)

Creates a new client for Participants

Parameter
Name	Description
channel	ChannelBase The channel to use to make remote calls.

ParticipantsClient(ClientBaseConfiguration)

protected ParticipantsClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

AnalyzeContent(AnalyzeContentRequest, CallOptions)

public virtual AnalyzeContentResponse AnalyzeContent(AnalyzeContentRequest request, CallOptions options)

Adds a text (chat, for example), or audio (phone recording, for example) message from a participant into the conversation.

Note: Always use agent versions for production traffic sent to virtual agents. See Versions and environments.

Parameters
Name	Description
request	AnalyzeContentRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AnalyzeContentResponse	The response received from the server.

AnalyzeContent(AnalyzeContentRequest, Metadata, DateTime?, CancellationToken)

public virtual AnalyzeContentResponse AnalyzeContent(AnalyzeContentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Adds a text (chat, for example), or audio (phone recording, for example) message from a participant into the conversation.

Note: Always use agent versions for production traffic sent to virtual agents. See Versions and environments.

Parameters
Name	Description
request	AnalyzeContentRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AnalyzeContentResponse	The response received from the server.

AnalyzeContentAsync(AnalyzeContentRequest, CallOptions)

public virtual AsyncUnaryCall<AnalyzeContentResponse> AnalyzeContentAsync(AnalyzeContentRequest request, CallOptions options)

Adds a text (chat, for example), or audio (phone recording, for example) message from a participant into the conversation.

Note: Always use agent versions for production traffic sent to virtual agents. See Versions and environments.

Parameters
Name	Description
request	AnalyzeContentRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallAnalyzeContentResponse	The call object.

AnalyzeContentAsync(AnalyzeContentRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<AnalyzeContentResponse> AnalyzeContentAsync(AnalyzeContentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Adds a text (chat, for example), or audio (phone recording, for example) message from a participant into the conversation.

Note: Always use agent versions for production traffic sent to virtual agents. See Versions and environments.

Parameters
Name	Description
request	AnalyzeContentRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallAnalyzeContentResponse	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
Type	Description
LocationsLocationsClient	A new Locations.LocationsClient for the same target as this client.

CreateParticipant(CreateParticipantRequest, CallOptions)

public virtual Participant CreateParticipant(CreateParticipantRequest request, CallOptions options)

Creates a new participant in a conversation.

Parameters
Name	Description
request	CreateParticipantRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Participant	The response received from the server.

CreateParticipant(CreateParticipantRequest, Metadata, DateTime?, CancellationToken)

public virtual Participant CreateParticipant(CreateParticipantRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a new participant in a conversation.

Parameters
Name	Description
request	CreateParticipantRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Participant	The response received from the server.

CreateParticipantAsync(CreateParticipantRequest, CallOptions)

public virtual AsyncUnaryCall<Participant> CreateParticipantAsync(CreateParticipantRequest request, CallOptions options)

Creates a new participant in a conversation.

Parameters
Name	Description
request	CreateParticipantRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallParticipant	The call object.

CreateParticipantAsync(CreateParticipantRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Participant> CreateParticipantAsync(CreateParticipantRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a new participant in a conversation.

Parameters
Name	Description
request	CreateParticipantRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallParticipant	The call object.

GetParticipant(GetParticipantRequest, CallOptions)

public virtual Participant GetParticipant(GetParticipantRequest request, CallOptions options)

Retrieves a conversation participant.

Parameters
Name	Description
request	GetParticipantRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Participant	The response received from the server.

GetParticipant(GetParticipantRequest, Metadata, DateTime?, CancellationToken)

public virtual Participant GetParticipant(GetParticipantRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves a conversation participant.

Parameters
Name	Description
request	GetParticipantRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Participant	The response received from the server.

GetParticipantAsync(GetParticipantRequest, CallOptions)

public virtual AsyncUnaryCall<Participant> GetParticipantAsync(GetParticipantRequest request, CallOptions options)

Retrieves a conversation participant.

Parameters
Name	Description
request	GetParticipantRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallParticipant	The call object.

GetParticipantAsync(GetParticipantRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Participant> GetParticipantAsync(GetParticipantRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves a conversation participant.

Parameters
Name	Description
request	GetParticipantRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallParticipant	The call object.

ListParticipants(ListParticipantsRequest, CallOptions)

public virtual ListParticipantsResponse ListParticipants(ListParticipantsRequest request, CallOptions options)

Returns the list of all participants in the specified conversation.

Parameters
Name	Description
request	ListParticipantsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ListParticipantsResponse	The response received from the server.

ListParticipants(ListParticipantsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListParticipantsResponse ListParticipants(ListParticipantsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns the list of all participants in the specified conversation.

Parameters
Name	Description
request	ListParticipantsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ListParticipantsResponse	The response received from the server.

ListParticipantsAsync(ListParticipantsRequest, CallOptions)

public virtual AsyncUnaryCall<ListParticipantsResponse> ListParticipantsAsync(ListParticipantsRequest request, CallOptions options)

Returns the list of all participants in the specified conversation.

Parameters
Name	Description
request	ListParticipantsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallListParticipantsResponse	The call object.

ListParticipantsAsync(ListParticipantsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListParticipantsResponse> ListParticipantsAsync(ListParticipantsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns the list of all participants in the specified conversation.

Parameters
Name	Description
request	ListParticipantsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallListParticipantsResponse	The call object.

NewInstance(ClientBaseConfiguration)

protected override Participants.ParticipantsClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
ParticipantsParticipantsClient

Overrides

ClientBase<Participants.ParticipantsClient>.NewInstance(ClientBase.ClientBaseConfiguration)

StreamingAnalyzeContent(CallOptions)

public virtual AsyncDuplexStreamingCall<StreamingAnalyzeContentRequest, StreamingAnalyzeContentResponse> StreamingAnalyzeContent(CallOptions options)

Adds a text (chat, for example), or audio (phone recording, for example) message from a participant into the conversation. Note: This method is only available through the gRPC API (not REST).

The top-level message sent to the client by the server is StreamingAnalyzeContentResponse. Multiple response messages can be returned in order. The first one or more messages contain the recognition_result field. Each result represents a more complete transcript of what the user said. The next message contains the reply_text field and potentially the reply_audio field. The message can also contain the automated_agent_reply field.

Note: Always use agent versions for production traffic sent to virtual agents. See Versions and environments.

Parameter
Name	Description
options	CallOptions The options for the call.

Returns
Type	Description
AsyncDuplexStreamingCallStreamingAnalyzeContentRequestStreamingAnalyzeContentResponse	The call object.

StreamingAnalyzeContent(Metadata, DateTime?, CancellationToken)

public virtual AsyncDuplexStreamingCall<StreamingAnalyzeContentRequest, StreamingAnalyzeContentResponse> StreamingAnalyzeContent(Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Adds a text (chat, for example), or audio (phone recording, for example) message from a participant into the conversation. Note: This method is only available through the gRPC API (not REST).

The top-level message sent to the client by the server is StreamingAnalyzeContentResponse. Multiple response messages can be returned in order. The first one or more messages contain the recognition_result field. Each result represents a more complete transcript of what the user said. The next message contains the reply_text field and potentially the reply_audio field. The message can also contain the automated_agent_reply field.

Note: Always use agent versions for production traffic sent to virtual agents. See Versions and environments.

Parameters
Name	Description
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncDuplexStreamingCallStreamingAnalyzeContentRequestStreamingAnalyzeContentResponse	The call object.

SuggestArticles(SuggestArticlesRequest, CallOptions)

public virtual SuggestArticlesResponse SuggestArticles(SuggestArticlesRequest request, CallOptions options)

Gets suggested articles for a participant based on specific historical messages.

Parameters
Name	Description
request	SuggestArticlesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
SuggestArticlesResponse	The response received from the server.

SuggestArticles(SuggestArticlesRequest, Metadata, DateTime?, CancellationToken)

public virtual SuggestArticlesResponse SuggestArticles(SuggestArticlesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets suggested articles for a participant based on specific historical messages.

Parameters
Name	Description
request	SuggestArticlesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
SuggestArticlesResponse	The response received from the server.

SuggestArticlesAsync(SuggestArticlesRequest, CallOptions)

public virtual AsyncUnaryCall<SuggestArticlesResponse> SuggestArticlesAsync(SuggestArticlesRequest request, CallOptions options)

Gets suggested articles for a participant based on specific historical messages.

Parameters
Name	Description
request	SuggestArticlesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallSuggestArticlesResponse	The call object.

SuggestArticlesAsync(SuggestArticlesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<SuggestArticlesResponse> SuggestArticlesAsync(SuggestArticlesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets suggested articles for a participant based on specific historical messages.

Parameters
Name	Description
request	SuggestArticlesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallSuggestArticlesResponse	The call object.

SuggestFaqAnswers(SuggestFaqAnswersRequest, CallOptions)

public virtual SuggestFaqAnswersResponse SuggestFaqAnswers(SuggestFaqAnswersRequest request, CallOptions options)

Gets suggested faq answers for a participant based on specific historical messages.

Parameters
Name	Description
request	SuggestFaqAnswersRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
SuggestFaqAnswersResponse	The response received from the server.

SuggestFaqAnswers(SuggestFaqAnswersRequest, Metadata, DateTime?, CancellationToken)

public virtual SuggestFaqAnswersResponse SuggestFaqAnswers(SuggestFaqAnswersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets suggested faq answers for a participant based on specific historical messages.

Parameters
Name	Description
request	SuggestFaqAnswersRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
SuggestFaqAnswersResponse	The response received from the server.

SuggestFaqAnswersAsync(SuggestFaqAnswersRequest, CallOptions)

public virtual AsyncUnaryCall<SuggestFaqAnswersResponse> SuggestFaqAnswersAsync(SuggestFaqAnswersRequest request, CallOptions options)

Gets suggested faq answers for a participant based on specific historical messages.

Parameters
Name	Description
request	SuggestFaqAnswersRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallSuggestFaqAnswersResponse	The call object.

SuggestFaqAnswersAsync(SuggestFaqAnswersRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<SuggestFaqAnswersResponse> SuggestFaqAnswersAsync(SuggestFaqAnswersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets suggested faq answers for a participant based on specific historical messages.

Parameters
Name	Description
request	SuggestFaqAnswersRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallSuggestFaqAnswersResponse	The call object.

SuggestSmartReplies(SuggestSmartRepliesRequest, CallOptions)

public virtual SuggestSmartRepliesResponse SuggestSmartReplies(SuggestSmartRepliesRequest request, CallOptions options)

Gets smart replies for a participant based on specific historical messages.

Parameters
Name	Description
request	SuggestSmartRepliesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
SuggestSmartRepliesResponse	The response received from the server.

SuggestSmartReplies(SuggestSmartRepliesRequest, Metadata, DateTime?, CancellationToken)

public virtual SuggestSmartRepliesResponse SuggestSmartReplies(SuggestSmartRepliesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets smart replies for a participant based on specific historical messages.

Parameters
Name	Description
request	SuggestSmartRepliesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
SuggestSmartRepliesResponse	The response received from the server.

SuggestSmartRepliesAsync(SuggestSmartRepliesRequest, CallOptions)

public virtual AsyncUnaryCall<SuggestSmartRepliesResponse> SuggestSmartRepliesAsync(SuggestSmartRepliesRequest request, CallOptions options)

Gets smart replies for a participant based on specific historical messages.

Parameters
Name	Description
request	SuggestSmartRepliesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallSuggestSmartRepliesResponse	The call object.

SuggestSmartRepliesAsync(SuggestSmartRepliesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<SuggestSmartRepliesResponse> SuggestSmartRepliesAsync(SuggestSmartRepliesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets smart replies for a participant based on specific historical messages.

Parameters
Name	Description
request	SuggestSmartRepliesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallSuggestSmartRepliesResponse	The call object.

UpdateParticipant(UpdateParticipantRequest, CallOptions)

public virtual Participant UpdateParticipant(UpdateParticipantRequest request, CallOptions options)

Updates the specified participant.

Parameters
Name	Description
request	UpdateParticipantRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Participant	The response received from the server.

UpdateParticipant(UpdateParticipantRequest, Metadata, DateTime?, CancellationToken)

public virtual Participant UpdateParticipant(UpdateParticipantRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates the specified participant.

Parameters
Name	Description
request	UpdateParticipantRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Participant	The response received from the server.

UpdateParticipantAsync(UpdateParticipantRequest, CallOptions)

public virtual AsyncUnaryCall<Participant> UpdateParticipantAsync(UpdateParticipantRequest request, CallOptions options)

Updates the specified participant.

Parameters
Name	Description
request	UpdateParticipantRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallParticipant	The call object.

UpdateParticipantAsync(UpdateParticipantRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Participant> UpdateParticipantAsync(UpdateParticipantRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates the specified participant.

Parameters
Name	Description
request	UpdateParticipantRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallParticipant	The call object.