Manages a collection of models for human agent assistant.
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
ConversationModelsClient(ConversationModelsClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
ConversationModelsClient const &
|
ConversationModelsClient(ConversationModelsClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
ConversationModelsClient &&
|
ConversationModelsClient(std::shared_ptr< ConversationModelsConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< ConversationModelsConnection >
|
opts |
Options
|
Operators
operator=(ConversationModelsClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
ConversationModelsClient const &
|
Returns | |
---|---|
Type | Description |
ConversationModelsClient & |
operator=(ConversationModelsClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
ConversationModelsClient &&
|
Returns | |
---|---|
Type | Description |
ConversationModelsClient & |
Functions
CreateConversationModel(std::string const &, google::cloud::dialogflow::v2::ConversationModel const &, Options)
Creates a model.
This method is a long-running operation. The returned Operation
type has the following method-specific fields:
metadata
: CreateConversationModelOperationMetadataresponse
: ConversationModel
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
The project to create conversation model for. Format: |
conversation_model |
google::cloud::dialogflow::v2::ConversationModel const &
Required. The conversation model 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::ConversationModel > > |
A |
CreateConversationModel(ExperimentalTag, NoAwaitTag, std::string const &, google::cloud::dialogflow::v2::ConversationModel const &, Options)
Creates a model.
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 |
|
ExperimentalTag
|
|
NoAwaitTag
|
parent |
std::string const &
|
conversation_model |
google::cloud::dialogflow::v2::ConversationModel const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateConversationModel(google::cloud::dialogflow::v2::CreateConversationModelRequest const &, Options)
Creates a model.
This method is a long-running operation. The returned Operation
type has the following method-specific fields:
metadata
: CreateConversationModelOperationMetadataresponse
: ConversationModel
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dialogflow::v2::CreateConversationModelRequest 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 |
future< StatusOr< google::cloud::dialogflow::v2::ConversationModel > > |
A |
CreateConversationModel(ExperimentalTag, NoAwaitTag, google::cloud::dialogflow::v2::CreateConversationModelRequest const &, Options)
Creates a model.
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 |
|
ExperimentalTag
|
|
NoAwaitTag
|
request |
google::cloud::dialogflow::v2::CreateConversationModelRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateConversationModel(ExperimentalTag, google::longrunning::Operation const &, Options)
Creates a model.
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 |
|
ExperimentalTag
|
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::dialogflow::v2::ConversationModel > > |
GetConversationModel(std::string const &, Options)
Gets conversation model.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The conversation model to retrieve. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::dialogflow::v2::ConversationModel > |
the result of the RPC. The response message type (google.cloud.dialogflow.v2.ConversationModel) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetConversationModel(google::cloud::dialogflow::v2::GetConversationModelRequest const &, Options)
Gets conversation model.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dialogflow::v2::GetConversationModelRequest 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::ConversationModel > |
the result of the RPC. The response message type (google.cloud.dialogflow.v2.ConversationModel) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListConversationModels(std::string const &, Options)
Lists conversation models.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The project to list all conversation models for. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::dialogflow::v2::ConversationModel > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListConversationModels(google::cloud::dialogflow::v2::ListConversationModelsRequest, Options)
Lists conversation models.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dialogflow::v2::ListConversationModelsRequest
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::ConversationModel > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
DeleteConversationModel(std::string const &, Options)
Deletes a model.
This method is a long-running operation. The returned Operation
type has the following method-specific fields:
metadata
: DeleteConversationModelOperationMetadataresponse
: An Empty message
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The conversation model to delete. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::dialogflow::v2::DeleteConversationModelOperationMetadata > > |
A |
DeleteConversationModel(ExperimentalTag, NoAwaitTag, std::string const &, Options)
Deletes a model.
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 |
|
ExperimentalTag
|
|
NoAwaitTag
|
name |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteConversationModel(google::cloud::dialogflow::v2::DeleteConversationModelRequest const &, Options)
Deletes a model.
This method is a long-running operation. The returned Operation
type has the following method-specific fields:
metadata
: DeleteConversationModelOperationMetadataresponse
: An Empty message
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dialogflow::v2::DeleteConversationModelRequest 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 |
future< StatusOr< google::cloud::dialogflow::v2::DeleteConversationModelOperationMetadata > > |
A |
DeleteConversationModel(ExperimentalTag, NoAwaitTag, google::cloud::dialogflow::v2::DeleteConversationModelRequest const &, Options)
Deletes a model.
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 |
|
ExperimentalTag
|
|
NoAwaitTag
|
request |
google::cloud::dialogflow::v2::DeleteConversationModelRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteConversationModel(ExperimentalTag, google::longrunning::Operation const &, Options)
Deletes a model.
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 |
|
ExperimentalTag
|
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::dialogflow::v2::DeleteConversationModelOperationMetadata > > |
DeployConversationModel(google::cloud::dialogflow::v2::DeployConversationModelRequest const &, Options)
Deploys a model.
If a model is already deployed, deploying it has no effect. A model can only serve prediction requests after it gets deployed. For article suggestion, custom model will not be used unless it is deployed.
This method is a long-running operation. The returned Operation
type has the following method-specific fields:
metadata
: DeployConversationModelOperationMetadataresponse
: An Empty message
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dialogflow::v2::DeployConversationModelRequest 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 |
future< StatusOr< google::cloud::dialogflow::v2::DeployConversationModelOperationMetadata > > |
A |
DeployConversationModel(ExperimentalTag, NoAwaitTag, google::cloud::dialogflow::v2::DeployConversationModelRequest const &, Options)
Deploys a model.
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 |
|
ExperimentalTag
|
|
NoAwaitTag
|
request |
google::cloud::dialogflow::v2::DeployConversationModelRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeployConversationModel(ExperimentalTag, google::longrunning::Operation const &, Options)
Deploys a model.
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 |
|
ExperimentalTag
|
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::dialogflow::v2::DeployConversationModelOperationMetadata > > |
UndeployConversationModel(google::cloud::dialogflow::v2::UndeployConversationModelRequest const &, Options)
Undeploys a model.
If the model is not deployed this method has no effect. If the model is currently being used:
- For article suggestion, article suggestion will fallback to the default model if model is undeployed.
This method is a long-running operation. The returned Operation
type has the following method-specific fields:
metadata
: UndeployConversationModelOperationMetadataresponse
: An Empty message
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dialogflow::v2::UndeployConversationModelRequest 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 |
future< StatusOr< google::cloud::dialogflow::v2::UndeployConversationModelOperationMetadata > > |
A |
UndeployConversationModel(ExperimentalTag, NoAwaitTag, google::cloud::dialogflow::v2::UndeployConversationModelRequest const &, Options)
Undeploys a model.
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 |
|
ExperimentalTag
|
|
NoAwaitTag
|
request |
google::cloud::dialogflow::v2::UndeployConversationModelRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UndeployConversationModel(ExperimentalTag, google::longrunning::Operation const &, Options)
Undeploys a model.
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 |
|
ExperimentalTag
|
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::dialogflow::v2::UndeployConversationModelOperationMetadata > > |
GetConversationModelEvaluation(std::string const &, Options)
Gets an evaluation of conversation model.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The conversation model evaluation resource name. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::dialogflow::v2::ConversationModelEvaluation > |
the result of the RPC. The response message type (google.cloud.dialogflow.v2.ConversationModelEvaluation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetConversationModelEvaluation(google::cloud::dialogflow::v2::GetConversationModelEvaluationRequest const &, Options)
Gets an evaluation of conversation model.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dialogflow::v2::GetConversationModelEvaluationRequest 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::ConversationModelEvaluation > |
the result of the RPC. The response message type (google.cloud.dialogflow.v2.ConversationModelEvaluation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListConversationModelEvaluations(std::string const &, Options)
Lists evaluations of a conversation model.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The conversation model resource name. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::dialogflow::v2::ConversationModelEvaluation > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListConversationModelEvaluations(google::cloud::dialogflow::v2::ListConversationModelEvaluationsRequest, Options)
Lists evaluations of a conversation model.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dialogflow::v2::ListConversationModelEvaluationsRequest
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::ConversationModelEvaluation > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
CreateConversationModelEvaluation(std::string const &, google::cloud::dialogflow::v2::ConversationModelEvaluation const &, Options)
Creates evaluation of a conversation model.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The conversation model resource name. Format: |
conversation_model_evaluation |
google::cloud::dialogflow::v2::ConversationModelEvaluation const &
Required. The conversation model evaluation to be created. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::dialogflow::v2::ConversationModelEvaluation > > |
A |
CreateConversationModelEvaluation(ExperimentalTag, NoAwaitTag, std::string const &, google::cloud::dialogflow::v2::ConversationModelEvaluation const &, Options)
Creates evaluation of a conversation model.
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 |
|
ExperimentalTag
|
|
NoAwaitTag
|
parent |
std::string const &
|
conversation_model_evaluation |
google::cloud::dialogflow::v2::ConversationModelEvaluation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateConversationModelEvaluation(google::cloud::dialogflow::v2::CreateConversationModelEvaluationRequest const &, Options)
Creates evaluation of a conversation model.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dialogflow::v2::CreateConversationModelEvaluationRequest 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 |
future< StatusOr< google::cloud::dialogflow::v2::ConversationModelEvaluation > > |
A |
CreateConversationModelEvaluation(ExperimentalTag, NoAwaitTag, google::cloud::dialogflow::v2::CreateConversationModelEvaluationRequest const &, Options)
Creates evaluation of a conversation model.
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 |
|
ExperimentalTag
|
|
NoAwaitTag
|
request |
google::cloud::dialogflow::v2::CreateConversationModelEvaluationRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateConversationModelEvaluation(ExperimentalTag, google::longrunning::Operation const &, Options)
Creates evaluation of a conversation model.
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 |
|
ExperimentalTag
|
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::dialogflow::v2::ConversationModelEvaluation > > |