Class ConversationDatasetsClient (2.28.0)

Conversation datasets.

Conversation datasets contain raw conversation files and their customizable metadata that can be used for model training.

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

ConversationDatasetsClient(ConversationDatasetsClient const &)

Copy and move support

Parameter
Name Description
ConversationDatasetsClient const &

ConversationDatasetsClient(ConversationDatasetsClient &&)

Copy and move support

Parameter
Name Description
ConversationDatasetsClient &&

ConversationDatasetsClient(std::shared_ptr< ConversationDatasetsConnection >, Options)

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

Operators

operator=(ConversationDatasetsClient const &)

Copy and move support

Parameter
Name Description
ConversationDatasetsClient const &
Returns
Type Description
ConversationDatasetsClient &

operator=(ConversationDatasetsClient &&)

Copy and move support

Parameter
Name Description
ConversationDatasetsClient &&
Returns
Type Description
ConversationDatasetsClient &

Functions

CreateConversationDataset(std::string const &, google::cloud::dialogflow::v2::ConversationDataset const &, Options)

Creates a new conversation dataset.

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

Parameters
Name Description
parent std::string const &

Required. The project to create conversation dataset for. Format: projects/<ProjectID>/locations/<LocationID>
conversation_dataset google::cloud::dialogflow::v2::ConversationDataset const &

Required. The conversation dataset to create.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::dialogflow::v2::ConversationDataset > >

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.v2.ConversationDataset proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateConversationDataset(NoAwaitTag, std::string const &, google::cloud::dialogflow::v2::ConversationDataset const &, Options)

Creates a new conversation dataset.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
parent std::string const &
conversation_dataset google::cloud::dialogflow::v2::ConversationDataset const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateConversationDataset(google::cloud::dialogflow::v2::CreateConversationDatasetRequest const &, Options)

Creates a new conversation dataset.

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

Parameters
Name Description
request google::cloud::dialogflow::v2::CreateConversationDatasetRequest 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.CreateConversationDatasetRequest. 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::v2::ConversationDataset > >

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.v2.ConversationDataset proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateConversationDataset(NoAwaitTag, google::cloud::dialogflow::v2::CreateConversationDatasetRequest const &, Options)

Creates a new conversation dataset.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::dialogflow::v2::CreateConversationDatasetRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateConversationDataset(google::longrunning::Operation const &, Options)

Creates a new conversation dataset.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::dialogflow::v2::ConversationDataset > >

GetConversationDataset(std::string const &, Options)

Retrieves the specified conversation dataset.

Parameters
Name Description
name std::string const &

Required. The conversation dataset to retrieve. Format: projects/<ProjectID>/locations/<LocationID>/conversationDatasets/<Conversation Dataset ID>
opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::dialogflow::v2::ConversationDataset >

the result of the RPC. The response message type (google.cloud.dialogflow.v2.ConversationDataset) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetConversationDataset(google::cloud::dialogflow::v2::GetConversationDatasetRequest const &, Options)

Retrieves the specified conversation dataset.

Parameters
Name Description
request google::cloud::dialogflow::v2::GetConversationDatasetRequest 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.GetConversationDatasetRequest. 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::ConversationDataset >

the result of the RPC. The response message type (google.cloud.dialogflow.v2.ConversationDataset) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListConversationDatasets(std::string const &, Options)

Returns the list of all conversation datasets in the specified project and location.

Parameters
Name Description
parent std::string const &

Required. The project and location name to list all conversation datasets for. Format: projects/<ProjectID>/locations/<LocationID>
opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::dialogflow::v2::ConversationDataset >

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.ConversationDataset, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListConversationDatasets(google::cloud::dialogflow::v2::ListConversationDatasetsRequest, Options)

Returns the list of all conversation datasets in the specified project and location.

Parameters
Name Description
request google::cloud::dialogflow::v2::ListConversationDatasetsRequest

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.ListConversationDatasetsRequest. 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::ConversationDataset >

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.ConversationDataset, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

DeleteConversationDataset(std::string const &, Options)

Deletes the specified conversation dataset.

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

Parameters
Name Description
name std::string const &

Required. The conversation dataset to delete. Format: projects/<ProjectID>/locations/<LocationID>/conversationDatasets/<Conversation Dataset ID>
opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::dialogflow::v2::DeleteConversationDatasetOperationMetadata > >

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.v2.DeleteConversationDatasetOperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteConversationDataset(NoAwaitTag, std::string const &, Options)

Deletes the specified conversation dataset.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
name std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteConversationDataset(google::cloud::dialogflow::v2::DeleteConversationDatasetRequest const &, Options)

Deletes the specified conversation dataset.

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

Parameters
Name Description
request google::cloud::dialogflow::v2::DeleteConversationDatasetRequest 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.DeleteConversationDatasetRequest. 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::v2::DeleteConversationDatasetOperationMetadata > >

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.v2.DeleteConversationDatasetOperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteConversationDataset(NoAwaitTag, google::cloud::dialogflow::v2::DeleteConversationDatasetRequest const &, Options)

Deletes the specified conversation dataset.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::dialogflow::v2::DeleteConversationDatasetRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteConversationDataset(google::longrunning::Operation const &, Options)

Deletes the specified conversation dataset.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::dialogflow::v2::DeleteConversationDatasetOperationMetadata > >

ImportConversationData(google::cloud::dialogflow::v2::ImportConversationDataRequest const &, Options)

Import data into the specified conversation dataset.

Note that it is not allowed to import data to a conversation dataset that already has data in it.

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

Parameters
Name Description
request google::cloud::dialogflow::v2::ImportConversationDataRequest 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.ImportConversationDataRequest. 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::v2::ImportConversationDataOperationResponse > >

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.v2.ImportConversationDataOperationResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ImportConversationData(NoAwaitTag, google::cloud::dialogflow::v2::ImportConversationDataRequest const &, Options)

Import data into the specified conversation dataset.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::dialogflow::v2::ImportConversationDataRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

ImportConversationData(google::longrunning::Operation const &, Options)

Import data into the specified conversation dataset.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::dialogflow::v2::ImportConversationDataOperationResponse > >