Service for managing Participants.
Equality
Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection>
objects compare equal. Objects that compare equal share the same underlying resources.
Performance
Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.
Thread Safety
Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.
Constructors
ParticipantsClient(ParticipantsClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
ParticipantsClient const &
|
ParticipantsClient(ParticipantsClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
ParticipantsClient &&
|
ParticipantsClient(std::shared_ptr< ParticipantsConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< ParticipantsConnection >
|
opts |
Options
|
Operators
operator=(ParticipantsClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
ParticipantsClient const &
|
Returns | |
---|---|
Type | Description |
ParticipantsClient & |
operator=(ParticipantsClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
ParticipantsClient &&
|
Returns | |
---|---|
Type | Description |
ParticipantsClient & |
Functions
CreateParticipant(std::string const &, google::cloud::dialogflow::v2::Participant const &, Options)
Creates a new participant in a conversation.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. Resource identifier of the conversation adding the participant. Format: |
participant |
google::cloud::dialogflow::v2::Participant const &
Required. The participant to create. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::dialogflow::v2::Participant > |
the result of the RPC. The response message type (google.cloud.dialogflow.v2.Participant) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateParticipant(google::cloud::dialogflow::v2::CreateParticipantRequest const &, Options)
Creates a new participant in a conversation.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dialogflow::v2::CreateParticipantRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::dialogflow::v2::Participant > |
the result of the RPC. The response message type (google.cloud.dialogflow.v2.Participant) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetParticipant(std::string const &, Options)
Retrieves a conversation participant.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the participant. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::dialogflow::v2::Participant > |
the result of the RPC. The response message type (google.cloud.dialogflow.v2.Participant) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetParticipant(google::cloud::dialogflow::v2::GetParticipantRequest const &, Options)
Retrieves a conversation participant.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dialogflow::v2::GetParticipantRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::dialogflow::v2::Participant > |
the result of the RPC. The response message type (google.cloud.dialogflow.v2.Participant) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListParticipants(std::string const &, Options)
Returns the list of all participants in the specified conversation.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The conversation to list all participants from. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::dialogflow::v2::Participant > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListParticipants(google::cloud::dialogflow::v2::ListParticipantsRequest, Options)
Returns the list of all participants in the specified conversation.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dialogflow::v2::ListParticipantsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::dialogflow::v2::Participant > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
UpdateParticipant(google::cloud::dialogflow::v2::Participant const &, google::protobuf::FieldMask const &, Options)
Updates the specified participant.
Parameters | |
---|---|
Name | Description |
participant |
google::cloud::dialogflow::v2::Participant const &
Required. The participant to update. |
update_mask |
google::protobuf::FieldMask const &
Required. The mask to specify which fields to update. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::dialogflow::v2::Participant > |
the result of the RPC. The response message type (google.cloud.dialogflow.v2.Participant) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateParticipant(google::cloud::dialogflow::v2::UpdateParticipantRequest const &, Options)
Updates the specified participant.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dialogflow::v2::UpdateParticipantRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::dialogflow::v2::Participant > |
the result of the RPC. The response message type (google.cloud.dialogflow.v2.Participant) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
AnalyzeContent(std::string const &, google::cloud::dialogflow::v2::TextInput const &, 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 |
participant |
std::string const &
Required. The name of the participant this text comes from. Format: |
text_input |
google::cloud::dialogflow::v2::TextInput const &
The natural language text to be processed. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::dialogflow::v2::AnalyzeContentResponse > |
the result of the RPC. The response message type (google.cloud.dialogflow.v2.AnalyzeContentResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
AnalyzeContent(std::string const &, google::cloud::dialogflow::v2::EventInput const &, 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 |
participant |
std::string const &
Required. The name of the participant this text comes from. Format: |
event_input |
google::cloud::dialogflow::v2::EventInput const &
An input event to send to Dialogflow. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::dialogflow::v2::AnalyzeContentResponse > |
the result of the RPC. The response message type (google.cloud.dialogflow.v2.AnalyzeContentResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
AnalyzeContent(google::cloud::dialogflow::v2::AnalyzeContentRequest const &, 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 |
google::cloud::dialogflow::v2::AnalyzeContentRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::dialogflow::v2::AnalyzeContentResponse > |
the result of the RPC. The response message type (google.cloud.dialogflow.v2.AnalyzeContentResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
AsyncStreamingAnalyzeContent(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 |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
std::unique_ptr<::google::cloud::AsyncStreamingReadWriteRpc< google::cloud::dialogflow::v2::StreamingAnalyzeContentRequest, google::cloud::dialogflow::v2::StreamingAnalyzeContentResponse > > |
An object representing the bidirectional streaming RPC. Applications can send multiple request messages and receive multiple response messages through this API. Bidirectional streaming RPCs can impose restrictions on the sequence of request and response messages. Please consult the service documentation for details. The request message type (google.cloud.dialogflow.v2.StreamingAnalyzeContentRequest) and response messages (google.cloud.dialogflow.v2.StreamingAnalyzeContentResponse) are mapped to C++ classes using the Protobuf mapping rules. |
SuggestArticles(std::string const &, Options)
Gets suggested articles for a participant based on specific historical messages.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The name of the participant to fetch suggestion for. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::dialogflow::v2::SuggestArticlesResponse > |
the result of the RPC. The response message type (google.cloud.dialogflow.v2.SuggestArticlesResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
SuggestArticles(google::cloud::dialogflow::v2::SuggestArticlesRequest const &, Options)
Gets suggested articles for a participant based on specific historical messages.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dialogflow::v2::SuggestArticlesRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::dialogflow::v2::SuggestArticlesResponse > |
the result of the RPC. The response message type (google.cloud.dialogflow.v2.SuggestArticlesResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
SuggestFaqAnswers(std::string const &, Options)
Gets suggested faq answers for a participant based on specific historical messages.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The name of the participant to fetch suggestion for. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::dialogflow::v2::SuggestFaqAnswersResponse > |
the result of the RPC. The response message type (google.cloud.dialogflow.v2.SuggestFaqAnswersResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
SuggestFaqAnswers(google::cloud::dialogflow::v2::SuggestFaqAnswersRequest const &, Options)
Gets suggested faq answers for a participant based on specific historical messages.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dialogflow::v2::SuggestFaqAnswersRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::dialogflow::v2::SuggestFaqAnswersResponse > |
the result of the RPC. The response message type (google.cloud.dialogflow.v2.SuggestFaqAnswersResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
SuggestSmartReplies(std::string const &, Options)
Gets smart replies for a participant based on specific historical messages.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The name of the participant to fetch suggestion for. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::dialogflow::v2::SuggestSmartRepliesResponse > |
the result of the RPC. The response message type (google.cloud.dialogflow.v2.SuggestSmartRepliesResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
SuggestSmartReplies(google::cloud::dialogflow::v2::SuggestSmartRepliesRequest const &, Options)
Gets smart replies for a participant based on specific historical messages.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dialogflow::v2::SuggestSmartRepliesRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::dialogflow::v2::SuggestSmartRepliesResponse > |
the result of the RPC. The response message type (google.cloud.dialogflow.v2.SuggestSmartRepliesResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
SuggestKnowledgeAssist(google::cloud::dialogflow::v2::SuggestKnowledgeAssistRequest const &, Options)
Gets knowledge assist suggestions based on historical messages.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dialogflow::v2::SuggestKnowledgeAssistRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::dialogflow::v2::SuggestKnowledgeAssistResponse > |
the result of the RPC. The response message type (google.cloud.dialogflow.v2.SuggestKnowledgeAssistResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |