Class IntentsClient (2.20.0)

Version 2.20.0

• 2.32.0-rc (latest)
• 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 Intents.

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

IntentsClient(IntentsClient const &)

Copy and move support

Parameter
Name	Description
	IntentsClient const &

IntentsClient(IntentsClient &&)

Copy and move support

Parameter
Name	Description
	IntentsClient &&

IntentsClient(std::shared_ptr< IntentsConnection >, Options)

Parameters
Name	Description
connection	std::shared_ptr< IntentsConnection >
opts	Options

Operators

operator=(IntentsClient const &)

Copy and move support

Parameter
Name	Description
	IntentsClient const &

Returns
Type	Description
IntentsClient &

operator=(IntentsClient &&)

Copy and move support

Parameter
Name	Description
	IntentsClient &&

Returns
Type	Description
IntentsClient &

Functions

ListIntents(std::string const &, Options)

Returns the list of all intents in the specified agent.

Parameters
Name	Description
parent	std::string const & Required. The agent to list all intents for. Format: projects/<ProjectID>/locations/<LocationID>/agents/<Agent ID>.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::dialogflow::cx::v3::Intent >	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.cx.v3.Intent, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListIntents(google::cloud::dialogflow::cx::v3::ListIntentsRequest, Options)

Returns the list of all intents in the specified agent.

Parameters
Name	Description
request	google::cloud::dialogflow::cx::v3::ListIntentsRequest 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.cx.v3.ListIntentsRequest. 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::cx::v3::Intent >	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.cx.v3.Intent, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetIntent(std::string const &, Options)

Retrieves the specified intent.

Parameters
Name	Description
name	std::string const & Required. The name of the intent. Format: projects/<ProjectID>/locations/<LocationID>/agents/<Agent ID>/intents/<Intent ID>.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::dialogflow::cx::v3::Intent >	the result of the RPC. The response message type (google.cloud.dialogflow.cx.v3.Intent) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetIntent(google::cloud::dialogflow::cx::v3::GetIntentRequest const &, Options)

Retrieves the specified intent.

Parameters
Name	Description
request	google::cloud::dialogflow::cx::v3::GetIntentRequest 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.cx.v3.GetIntentRequest. 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::cx::v3::Intent >	the result of the RPC. The response message type (google.cloud.dialogflow.cx.v3.Intent) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateIntent(std::string const &, google::cloud::dialogflow::cx::v3::Intent const &, Options)

Creates an intent in the specified agent.

Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters
Name	Description
parent	std::string const & Required. The agent to create an intent for. Format: projects/<ProjectID>/locations/<LocationID>/agents/<Agent ID>.
intent	google::cloud::dialogflow::cx::v3::Intent const & Required. The intent to create.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::dialogflow::cx::v3::Intent >	the result of the RPC. The response message type (google.cloud.dialogflow.cx.v3.Intent) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateIntent(google::cloud::dialogflow::cx::v3::CreateIntentRequest const &, Options)

Creates an intent in the specified agent.

Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters
Name	Description
request	google::cloud::dialogflow::cx::v3::CreateIntentRequest 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.cx.v3.CreateIntentRequest. 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::cx::v3::Intent >	the result of the RPC. The response message type (google.cloud.dialogflow.cx.v3.Intent) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateIntent(google::cloud::dialogflow::cx::v3::Intent const &, google::protobuf::FieldMask const &, Options)

Updates the specified intent.

Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters
Name	Description
intent	google::cloud::dialogflow::cx::v3::Intent const & Required. The intent to update.
update_mask	google::protobuf::FieldMask const & The mask to control which fields get updated. If the mask is not present, all fields will be updated.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::dialogflow::cx::v3::Intent >	the result of the RPC. The response message type (google.cloud.dialogflow.cx.v3.Intent) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateIntent(google::cloud::dialogflow::cx::v3::UpdateIntentRequest const &, Options)

Updates the specified intent.

Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters
Name	Description
request	google::cloud::dialogflow::cx::v3::UpdateIntentRequest 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.cx.v3.UpdateIntentRequest. 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::cx::v3::Intent >	the result of the RPC. The response message type (google.cloud.dialogflow.cx.v3.Intent) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DeleteIntent(std::string const &, Options)

Deletes the specified intent.

Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters
Name	Description
name	std::string const & Required. The name of the intent to delete. Format: projects/<ProjectID>/locations/<LocationID>/agents/<Agent ID>/intents/<Intent ID>.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
Status	a Status object. If the request failed, the status contains the details of the failure.

DeleteIntent(google::cloud::dialogflow::cx::v3::DeleteIntentRequest const &, Options)

Deletes the specified intent.

Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters
Name	Description
request	google::cloud::dialogflow::cx::v3::DeleteIntentRequest 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.cx.v3.DeleteIntentRequest. 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
Status	a Status object. If the request failed, the status contains the details of the failure.

ImportIntents(google::cloud::dialogflow::cx::v3::ImportIntentsRequest const &, Options)

Imports the specified intents into the agent.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

• metadata: ImportIntentsMetadata
• response: ImportIntentsResponse

Parameters
Name	Description
request	google::cloud::dialogflow::cx::v3::ImportIntentsRequest 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.cx.v3.ImportIntentsRequest. 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
future< StatusOr< google::cloud::dialogflow::cx::v3::ImportIntentsResponse > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.dialogflow.cx.v3.ImportIntentsResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ExportIntents(google::cloud::dialogflow::cx::v3::ExportIntentsRequest const &, Options)

Exports the selected intents.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

• metadata: ExportIntentsMetadata
• response: ExportIntentsResponse

Parameters
Name	Description
request	google::cloud::dialogflow::cx::v3::ExportIntentsRequest 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.cx.v3.ExportIntentsRequest. 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
future< StatusOr< google::cloud::dialogflow::cx::v3::ExportIntentsResponse > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.dialogflow.cx.v3.ExportIntentsResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.