public sealed class ParticipantsClientImpl : ParticipantsClient
Reference documentation and code samples for the Google Cloud Dialogflow v2 API class ParticipantsClientImpl.
Participants client wrapper implementation, for convenient use.
Inherited Members
Namespace
Google.Cloud.Dialogflow.V2Assembly
Google.Cloud.Dialogflow.V2.dll
Remarks
Service for managing [Participants][google.cloud.dialogflow.v2.Participant].
Constructors
ParticipantsClientImpl(ParticipantsClient, ParticipantsSettings, ILogger)
public ParticipantsClientImpl(Participants.ParticipantsClient grpcClient, ParticipantsSettings settings, ILogger logger)
Constructs a client wrapper for the Participants service, with the specified gRPC client and settings.
Parameters | |
---|---|
Name | Description |
grpcClient |
ParticipantsParticipantsClient The underlying gRPC client. |
settings |
ParticipantsSettings The base ParticipantsSettings used within this client. |
logger |
ILogger Optional ILogger to use within this client. |
Properties
GrpcClient
public override Participants.ParticipantsClient GrpcClient { get; }
The underlying gRPC Participants client
Property Value | |
---|---|
Type | Description |
ParticipantsParticipantsClient |
LocationsClient
public override LocationsClient LocationsClient { get; }
The LocationsClient associated with this client.
Property Value | |
---|---|
Type | Description |
LocationsClient |
Methods
AnalyzeContent(AnalyzeContentRequest, CallSettings)
public override AnalyzeContentResponse AnalyzeContent(AnalyzeContentRequest request, CallSettings callSettings = null)
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 object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
AnalyzeContentResponse |
The RPC response. |
AnalyzeContentAsync(AnalyzeContentRequest, CallSettings)
public override Task<AnalyzeContentResponse> AnalyzeContentAsync(AnalyzeContentRequest request, CallSettings callSettings = null)
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 object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskAnalyzeContentResponse |
A Task containing the RPC response. |
CreateParticipant(CreateParticipantRequest, CallSettings)
public override Participant CreateParticipant(CreateParticipantRequest request, CallSettings callSettings = null)
Creates a new participant in a conversation.
Parameters | |
---|---|
Name | Description |
request |
CreateParticipantRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Participant |
The RPC response. |
CreateParticipantAsync(CreateParticipantRequest, CallSettings)
public override Task<Participant> CreateParticipantAsync(CreateParticipantRequest request, CallSettings callSettings = null)
Creates a new participant in a conversation.
Parameters | |
---|---|
Name | Description |
request |
CreateParticipantRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskParticipant |
A Task containing the RPC response. |
GetParticipant(GetParticipantRequest, CallSettings)
public override Participant GetParticipant(GetParticipantRequest request, CallSettings callSettings = null)
Retrieves a conversation participant.
Parameters | |
---|---|
Name | Description |
request |
GetParticipantRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Participant |
The RPC response. |
GetParticipantAsync(GetParticipantRequest, CallSettings)
public override Task<Participant> GetParticipantAsync(GetParticipantRequest request, CallSettings callSettings = null)
Retrieves a conversation participant.
Parameters | |
---|---|
Name | Description |
request |
GetParticipantRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskParticipant |
A Task containing the RPC response. |
ListParticipants(ListParticipantsRequest, CallSettings)
public override PagedEnumerable<ListParticipantsResponse, Participant> ListParticipants(ListParticipantsRequest request, CallSettings callSettings = null)
Returns the list of all participants in the specified conversation.
Parameters | |
---|---|
Name | Description |
request |
ListParticipantsRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerableListParticipantsResponseParticipant |
A pageable sequence of Participant resources. |
ListParticipantsAsync(ListParticipantsRequest, CallSettings)
public override PagedAsyncEnumerable<ListParticipantsResponse, Participant> ListParticipantsAsync(ListParticipantsRequest request, CallSettings callSettings = null)
Returns the list of all participants in the specified conversation.
Parameters | |
---|---|
Name | Description |
request |
ListParticipantsRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerableListParticipantsResponseParticipant |
A pageable asynchronous sequence of Participant resources. |
StreamingAnalyzeContent(CallSettings, BidirectionalStreamingSettings)
public override ParticipantsClient.StreamingAnalyzeContentStream StreamingAnalyzeContent(CallSettings callSettings = null, BidirectionalStreamingSettings streamingSettings = null)
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 |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
streamingSettings |
BidirectionalStreamingSettings If not null, applies streaming overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
ParticipantsClientStreamingAnalyzeContentStream |
The client-server stream. |
SuggestArticles(SuggestArticlesRequest, CallSettings)
public override SuggestArticlesResponse SuggestArticles(SuggestArticlesRequest request, CallSettings callSettings = null)
Gets suggested articles for a participant based on specific historical messages.
Parameters | |
---|---|
Name | Description |
request |
SuggestArticlesRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
SuggestArticlesResponse |
The RPC response. |
SuggestArticlesAsync(SuggestArticlesRequest, CallSettings)
public override Task<SuggestArticlesResponse> SuggestArticlesAsync(SuggestArticlesRequest request, CallSettings callSettings = null)
Gets suggested articles for a participant based on specific historical messages.
Parameters | |
---|---|
Name | Description |
request |
SuggestArticlesRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskSuggestArticlesResponse |
A Task containing the RPC response. |
SuggestFaqAnswers(SuggestFaqAnswersRequest, CallSettings)
public override SuggestFaqAnswersResponse SuggestFaqAnswers(SuggestFaqAnswersRequest request, CallSettings callSettings = null)
Gets suggested faq answers for a participant based on specific historical messages.
Parameters | |
---|---|
Name | Description |
request |
SuggestFaqAnswersRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
SuggestFaqAnswersResponse |
The RPC response. |
SuggestFaqAnswersAsync(SuggestFaqAnswersRequest, CallSettings)
public override Task<SuggestFaqAnswersResponse> SuggestFaqAnswersAsync(SuggestFaqAnswersRequest request, CallSettings callSettings = null)
Gets suggested faq answers for a participant based on specific historical messages.
Parameters | |
---|---|
Name | Description |
request |
SuggestFaqAnswersRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskSuggestFaqAnswersResponse |
A Task containing the RPC response. |
SuggestKnowledgeAssist(SuggestKnowledgeAssistRequest, CallSettings)
public override SuggestKnowledgeAssistResponse SuggestKnowledgeAssist(SuggestKnowledgeAssistRequest request, CallSettings callSettings = null)
Gets knowledge assist suggestions based on historical messages.
Parameters | |
---|---|
Name | Description |
request |
SuggestKnowledgeAssistRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
SuggestKnowledgeAssistResponse |
The RPC response. |
SuggestKnowledgeAssistAsync(SuggestKnowledgeAssistRequest, CallSettings)
public override Task<SuggestKnowledgeAssistResponse> SuggestKnowledgeAssistAsync(SuggestKnowledgeAssistRequest request, CallSettings callSettings = null)
Gets knowledge assist suggestions based on historical messages.
Parameters | |
---|---|
Name | Description |
request |
SuggestKnowledgeAssistRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskSuggestKnowledgeAssistResponse |
A Task containing the RPC response. |
SuggestSmartReplies(SuggestSmartRepliesRequest, CallSettings)
public override SuggestSmartRepliesResponse SuggestSmartReplies(SuggestSmartRepliesRequest request, CallSettings callSettings = null)
Gets smart replies for a participant based on specific historical messages.
Parameters | |
---|---|
Name | Description |
request |
SuggestSmartRepliesRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
SuggestSmartRepliesResponse |
The RPC response. |
SuggestSmartRepliesAsync(SuggestSmartRepliesRequest, CallSettings)
public override Task<SuggestSmartRepliesResponse> SuggestSmartRepliesAsync(SuggestSmartRepliesRequest request, CallSettings callSettings = null)
Gets smart replies for a participant based on specific historical messages.
Parameters | |
---|---|
Name | Description |
request |
SuggestSmartRepliesRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskSuggestSmartRepliesResponse |
A Task containing the RPC response. |
UpdateParticipant(UpdateParticipantRequest, CallSettings)
public override Participant UpdateParticipant(UpdateParticipantRequest request, CallSettings callSettings = null)
Updates the specified participant.
Parameters | |
---|---|
Name | Description |
request |
UpdateParticipantRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Participant |
The RPC response. |
UpdateParticipantAsync(UpdateParticipantRequest, CallSettings)
public override Task<Participant> UpdateParticipantAsync(UpdateParticipantRequest request, CallSettings callSettings = null)
Updates the specified participant.
Parameters | |
---|---|
Name | Description |
request |
UpdateParticipantRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskParticipant |
A Task containing the RPC response. |