Class ParticipantsClient (2.28.0)

Version 2.28.0

• 2.34.0-rc (latest)
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.1
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.1
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0

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: projects/<ProjectID>/locations/<LocationID>/conversations/<Conversation ID>.
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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dialogflow.v2.CreateParticipantRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

GetParticipant(std::string const &, Options)

Retrieves a conversation participant.

Parameters
Name	Description
name	std::string const & Required. The name of the participant. Format: projects/<ProjectID>/locations/<LocationID>/conversations/<Conversation ID>/participants/<Participant ID>.
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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dialogflow.v2.GetParticipantRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

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: projects/<ProjectID>/locations/<LocationID>/conversations/<Conversation ID>.
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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.dialogflow.v2.Participant, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dialogflow.v2.ListParticipantsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.dialogflow.v2.Participant, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dialogflow.v2.UpdateParticipantRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

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: projects/<ProjectID>/locations/<LocationID>/conversations/<Conversation ID>/participants/<Participant ID>.
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 StatusOr contains the error details.

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: projects/<ProjectID>/locations/<LocationID>/conversations/<Conversation ID>/participants/<Participant ID>.
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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dialogflow.v2.AnalyzeContentRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

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: projects/<ProjectID>/locations/<LocationID>/conversations/<Conversation ID>/participants/<Participant ID>.
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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dialogflow.v2.SuggestArticlesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

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: projects/<ProjectID>/locations/<LocationID>/conversations/<Conversation ID>/participants/<Participant ID>.
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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dialogflow.v2.SuggestFaqAnswersRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

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: projects/<ProjectID>/locations/<LocationID>/conversations/<Conversation ID>/participants/<Participant ID>.
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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dialogflow.v2.SuggestSmartRepliesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dialogflow.v2.SuggestKnowledgeAssistRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.