Dialogflow API C++ Client 2.13.0
A C++ Client Library for the Dialogflow API
|
Service for managing Intents. More...
#include <google/cloud/dialogflow_es/intents_client.h>
Public Member Functions | |
IntentsClient (std::shared_ptr< IntentsConnection > connection, Options opts={}) | |
~IntentsClient () | |
StreamRange< google::cloud::dialogflow::v2::Intent > | ListIntents (std::string const &parent, Options opts={}) |
Returns the list of all intents in the specified agent. More... | |
StreamRange< google::cloud::dialogflow::v2::Intent > | ListIntents (std::string const &parent, std::string const &language_code, Options opts={}) |
Returns the list of all intents in the specified agent. More... | |
StreamRange< google::cloud::dialogflow::v2::Intent > | ListIntents (google::cloud::dialogflow::v2::ListIntentsRequest request, Options opts={}) |
Returns the list of all intents in the specified agent. More... | |
StatusOr< google::cloud::dialogflow::v2::Intent > | GetIntent (std::string const &name, Options opts={}) |
Retrieves the specified intent. More... | |
StatusOr< google::cloud::dialogflow::v2::Intent > | GetIntent (std::string const &name, std::string const &language_code, Options opts={}) |
Retrieves the specified intent. More... | |
StatusOr< google::cloud::dialogflow::v2::Intent > | GetIntent (google::cloud::dialogflow::v2::GetIntentRequest const &request, Options opts={}) |
Retrieves the specified intent. More... | |
StatusOr< google::cloud::dialogflow::v2::Intent > | CreateIntent (std::string const &parent, google::cloud::dialogflow::v2::Intent const &intent, Options opts={}) |
Creates an intent in the specified agent. More... | |
StatusOr< google::cloud::dialogflow::v2::Intent > | CreateIntent (std::string const &parent, google::cloud::dialogflow::v2::Intent const &intent, std::string const &language_code, Options opts={}) |
Creates an intent in the specified agent. More... | |
StatusOr< google::cloud::dialogflow::v2::Intent > | CreateIntent (google::cloud::dialogflow::v2::CreateIntentRequest const &request, Options opts={}) |
Creates an intent in the specified agent. More... | |
StatusOr< google::cloud::dialogflow::v2::Intent > | UpdateIntent (google::cloud::dialogflow::v2::Intent const &intent, std::string const &language_code, Options opts={}) |
Updates the specified intent. More... | |
StatusOr< google::cloud::dialogflow::v2::Intent > | UpdateIntent (google::cloud::dialogflow::v2::Intent const &intent, std::string const &language_code, google::protobuf::FieldMask const &update_mask, Options opts={}) |
Updates the specified intent. More... | |
StatusOr< google::cloud::dialogflow::v2::Intent > | UpdateIntent (google::cloud::dialogflow::v2::UpdateIntentRequest const &request, Options opts={}) |
Updates the specified intent. More... | |
Status | DeleteIntent (std::string const &name, Options opts={}) |
Deletes the specified intent and its direct or indirect followup intents. More... | |
Status | DeleteIntent (google::cloud::dialogflow::v2::DeleteIntentRequest const &request, Options opts={}) |
Deletes the specified intent and its direct or indirect followup intents. More... | |
future< StatusOr< google::cloud::dialogflow::v2::BatchUpdateIntentsResponse > > | BatchUpdateIntents (std::string const &parent, std::string const &intent_batch_uri, Options opts={}) |
Updates/Creates multiple intents in the specified agent. More... | |
future< StatusOr< google::cloud::dialogflow::v2::BatchUpdateIntentsResponse > > | BatchUpdateIntents (std::string const &parent, google::cloud::dialogflow::v2::IntentBatch const &intent_batch_inline, Options opts={}) |
Updates/Creates multiple intents in the specified agent. More... | |
future< StatusOr< google::cloud::dialogflow::v2::BatchUpdateIntentsResponse > > | BatchUpdateIntents (google::cloud::dialogflow::v2::BatchUpdateIntentsRequest const &request, Options opts={}) |
Updates/Creates multiple intents in the specified agent. More... | |
future< StatusOr< google::protobuf::Struct > > | BatchDeleteIntents (std::string const &parent, std::vector< google::cloud::dialogflow::v2::Intent > const &intents, Options opts={}) |
Deletes intents in the specified agent. More... | |
future< StatusOr< google::protobuf::Struct > > | BatchDeleteIntents (google::cloud::dialogflow::v2::BatchDeleteIntentsRequest const &request, Options opts={}) |
Deletes intents in the specified agent. More... | |
Copy and move support | |
IntentsClient (IntentsClient const &)=default | |
IntentsClient & | operator= (IntentsClient const &)=default |
IntentsClient (IntentsClient &&)=default | |
IntentsClient & | operator= (IntentsClient &&)=default |
Friends | |
Equality | |
bool | operator== (IntentsClient const &a, IntentsClient const &b) |
bool | operator!= (IntentsClient const &a, IntentsClient const &b) |
Service for managing Intents.
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.
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.
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.
|
explicit |
google::cloud::dialogflow_es::IntentsClient::~IntentsClient | ( | ) |
|
default |
|
default |
future< StatusOr< google::protobuf::Struct > > google::cloud::dialogflow_es::IntentsClient::BatchDeleteIntents | ( | google::cloud::dialogflow::v2::BatchDeleteIntentsRequest const & | request, |
Options | opts = {} |
||
) |
Deletes intents in the specified agent.
This method is a long-running operation. The returned Operation
type has the following method-specific fields:
metadata
: An empty Struct messageresponse
: An Empty messageNote: You should always train an agent prior to sending it queries. See the training documentation.
request | 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.BatchDeleteIntentsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules. |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
future< StatusOr< google::protobuf::Struct > > google::cloud::dialogflow_es::IntentsClient::BatchDeleteIntents | ( | std::string const & | parent, |
std::vector< google::cloud::dialogflow::v2::Intent > const & | intents, | ||
Options | opts = {} |
||
) |
Deletes intents in the specified agent.
This method is a long-running operation. The returned Operation
type has the following method-specific fields:
metadata
: An empty Struct messageresponse
: An Empty messageNote: You should always train an agent prior to sending it queries. See the training documentation.
parent | Required. The name of the agent to delete all entities types for. Format: projects/<Project ID>/agent . |
intents | Required. The collection of intents to delete. Only intent name must be filled in. |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
future< StatusOr< google::cloud::dialogflow::v2::BatchUpdateIntentsResponse > > google::cloud::dialogflow_es::IntentsClient::BatchUpdateIntents | ( | google::cloud::dialogflow::v2::BatchUpdateIntentsRequest const & | request, |
Options | opts = {} |
||
) |
Updates/Creates multiple intents in the specified agent.
This method is a long-running operation. The returned Operation
type has the following method-specific fields:
metadata
: An empty Struct messageresponse
: BatchUpdateIntentsResponseNote: You should always train an agent prior to sending it queries. See the training documentation.
request | 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.BatchUpdateIntentsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules. |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
future< StatusOr< google::cloud::dialogflow::v2::BatchUpdateIntentsResponse > > google::cloud::dialogflow_es::IntentsClient::BatchUpdateIntents | ( | std::string const & | parent, |
google::cloud::dialogflow::v2::IntentBatch const & | intent_batch_inline, | ||
Options | opts = {} |
||
) |
Updates/Creates multiple intents in the specified agent.
This method is a long-running operation. The returned Operation
type has the following method-specific fields:
metadata
: An empty Struct messageresponse
: BatchUpdateIntentsResponseNote: You should always train an agent prior to sending it queries. See the training documentation.
parent | Required. The name of the agent to update or create intents in. Format: projects/<Project ID>/agent . |
intent_batch_inline | The collection of intents to update or create. |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
future< StatusOr< google::cloud::dialogflow::v2::BatchUpdateIntentsResponse > > google::cloud::dialogflow_es::IntentsClient::BatchUpdateIntents | ( | std::string const & | parent, |
std::string const & | intent_batch_uri, | ||
Options | opts = {} |
||
) |
Updates/Creates multiple intents in the specified agent.
This method is a long-running operation. The returned Operation
type has the following method-specific fields:
metadata
: An empty Struct messageresponse
: BatchUpdateIntentsResponseNote: You should always train an agent prior to sending it queries. See the training documentation.
parent | Required. The name of the agent to update or create intents in. Format: projects/<Project ID>/agent . |
intent_batch_uri | The URI to a Google Cloud Storage file containing intents to update or create. The file format can either be a serialized proto (of IntentBatch type) or JSON object. Note: The URI must start with "gs://". |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
StatusOr< google::cloud::dialogflow::v2::Intent > google::cloud::dialogflow_es::IntentsClient::CreateIntent | ( | google::cloud::dialogflow::v2::CreateIntentRequest const & | request, |
Options | opts = {} |
||
) |
Creates an intent in the specified agent.
Note: You should always train an agent prior to sending it queries. See the training documentation.
request | 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.CreateIntentRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules. |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
StatusOr< google::cloud::dialogflow::v2::Intent > google::cloud::dialogflow_es::IntentsClient::CreateIntent | ( | std::string const & | parent, |
google::cloud::dialogflow::v2::Intent const & | intent, | ||
Options | opts = {} |
||
) |
Creates an intent in the specified agent.
Note: You should always train an agent prior to sending it queries. See the training documentation.
parent | Required. The agent to create a intent for. Format: projects/<Project ID>/agent . |
intent | Required. The intent to create. |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
StatusOr< google::cloud::dialogflow::v2::Intent > google::cloud::dialogflow_es::IntentsClient::CreateIntent | ( | std::string const & | parent, |
google::cloud::dialogflow::v2::Intent const & | intent, | ||
std::string const & | language_code, | ||
Options | opts = {} |
||
) |
Creates an intent in the specified agent.
Note: You should always train an agent prior to sending it queries. See the training documentation.
parent | Required. The agent to create a intent for. Format: projects/<Project ID>/agent . |
intent | Required. The intent to create. |
language_code | Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data. |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
Status google::cloud::dialogflow_es::IntentsClient::DeleteIntent | ( | google::cloud::dialogflow::v2::DeleteIntentRequest const & | request, |
Options | opts = {} |
||
) |
Deletes the specified intent and its direct or indirect followup intents.
Note: You should always train an agent prior to sending it queries. See the training documentation.
request | 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.DeleteIntentRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules. |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
Status google::cloud::dialogflow_es::IntentsClient::DeleteIntent | ( | std::string const & | name, |
Options | opts = {} |
||
) |
Deletes the specified intent and its direct or indirect followup intents.
Note: You should always train an agent prior to sending it queries. See the training documentation.
name | Required. The name of the intent to delete. If this intent has direct or indirect followup intents, we also delete them. Format: projects/<Project ID>/agent/intents/<Intent ID> . |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
StatusOr< google::cloud::dialogflow::v2::Intent > google::cloud::dialogflow_es::IntentsClient::GetIntent | ( | google::cloud::dialogflow::v2::GetIntentRequest const & | request, |
Options | opts = {} |
||
) |
Retrieves the specified intent.
request | 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.GetIntentRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules. |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
StatusOr< google::cloud::dialogflow::v2::Intent > google::cloud::dialogflow_es::IntentsClient::GetIntent | ( | std::string const & | name, |
Options | opts = {} |
||
) |
Retrieves the specified intent.
name | Required. The name of the intent. Format: projects/<Project ID>/agent/intents/<Intent ID> . |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
StatusOr< google::cloud::dialogflow::v2::Intent > google::cloud::dialogflow_es::IntentsClient::GetIntent | ( | std::string const & | name, |
std::string const & | language_code, | ||
Options | opts = {} |
||
) |
Retrieves the specified intent.
name | Required. The name of the intent. Format: projects/<Project ID>/agent/intents/<Intent ID> . |
language_code | Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data. |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
StreamRange< google::cloud::dialogflow::v2::Intent > google::cloud::dialogflow_es::IntentsClient::ListIntents | ( | google::cloud::dialogflow::v2::ListIntentsRequest | request, |
Options | opts = {} |
||
) |
Returns the list of all intents in the specified agent.
request | 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.ListIntentsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules. |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
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.Intent, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules. StreamRange< google::cloud::dialogflow::v2::Intent > google::cloud::dialogflow_es::IntentsClient::ListIntents | ( | std::string const & | parent, |
Options | opts = {} |
||
) |
Returns the list of all intents in the specified agent.
parent | Required. The agent to list all intents from. Format: projects/<Project ID>/agent or projects/<Project ID>/locations/<Location ID>/agent . Alternatively, you can specify the environment to list intents for. Format: projects/<Project ID>/agent/environments/<Environment ID> or projects/<Project ID>/locations/<Location ID>/agent/environments/<Environment ID> . Note: training phrases of the intents will not be returned for non-draft environment. |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
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.Intent, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules. StreamRange< google::cloud::dialogflow::v2::Intent > google::cloud::dialogflow_es::IntentsClient::ListIntents | ( | std::string const & | parent, |
std::string const & | language_code, | ||
Options | opts = {} |
||
) |
Returns the list of all intents in the specified agent.
parent | Required. The agent to list all intents from. Format: projects/<Project ID>/agent or projects/<Project ID>/locations/<Location ID>/agent . Alternatively, you can specify the environment to list intents for. Format: projects/<Project ID>/agent/environments/<Environment ID> or projects/<Project ID>/locations/<Location ID>/agent/environments/<Environment ID> . Note: training phrases of the intents will not be returned for non-draft environment. |
language_code | Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data. |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
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.Intent, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.
|
default |
|
default |
StatusOr< google::cloud::dialogflow::v2::Intent > google::cloud::dialogflow_es::IntentsClient::UpdateIntent | ( | google::cloud::dialogflow::v2::Intent const & | intent, |
std::string const & | language_code, | ||
google::protobuf::FieldMask const & | update_mask, | ||
Options | opts = {} |
||
) |
Updates the specified intent.
Note: You should always train an agent prior to sending it queries. See the training documentation.
intent | Required. The intent to update. |
language_code | Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data. |
update_mask | Optional. The mask to control which fields get updated. |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
StatusOr< google::cloud::dialogflow::v2::Intent > google::cloud::dialogflow_es::IntentsClient::UpdateIntent | ( | google::cloud::dialogflow::v2::Intent const & | intent, |
std::string const & | language_code, | ||
Options | opts = {} |
||
) |
Updates the specified intent.
Note: You should always train an agent prior to sending it queries. See the training documentation.
intent | Required. The intent to update. |
language_code | Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data. |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
StatusOr< google::cloud::dialogflow::v2::Intent > google::cloud::dialogflow_es::IntentsClient::UpdateIntent | ( | google::cloud::dialogflow::v2::UpdateIntentRequest const & | request, |
Options | opts = {} |
||
) |
Updates the specified intent.
Note: You should always train an agent prior to sending it queries. See the training documentation.
request | 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.UpdateIntentRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules. |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
|
friend |
|
friend |