Google Cloud Dialogflow v2 API - Class ConversationModelsClientImpl (4.23.0) 

public sealed class ConversationModelsClientImpl : ConversationModelsClient

Reference documentation and code samples for the Google Cloud Dialogflow v2 API class ConversationModelsClientImpl.

ConversationModels client wrapper implementation, for convenient use.

Inheritance

object > ConversationModelsClient > ConversationModelsClientImpl

Namespace

Google.Cloud.Dialogflow.V2

Assembly

Google.Cloud.Dialogflow.V2.dll

Remarks

Manages a collection of models for human agent assistant.

Constructors

ConversationModelsClientImpl(ConversationModelsClient, ConversationModelsSettings, ILogger)

public ConversationModelsClientImpl(ConversationModels.ConversationModelsClient grpcClient, ConversationModelsSettings settings, ILogger logger)

Constructs a client wrapper for the ConversationModels service, with the specified gRPC client and settings.

Parameters
Name Description
grpcClient ConversationModelsConversationModelsClient

The underlying gRPC client.
settings ConversationModelsSettings

The base ConversationModelsSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

CreateConversationModelEvaluationOperationsClient

public override OperationsClient CreateConversationModelEvaluationOperationsClient { get; }

The long-running operations client for CreateConversationModelEvaluation.

Property Value
Type Description
OperationsClient
Overrides

CreateConversationModelOperationsClient

public override OperationsClient CreateConversationModelOperationsClient { get; }

The long-running operations client for CreateConversationModel.

Property Value
Type Description
OperationsClient
Overrides

DeleteConversationModelOperationsClient

public override OperationsClient DeleteConversationModelOperationsClient { get; }

The long-running operations client for DeleteConversationModel.

Property Value
Type Description
OperationsClient
Overrides

DeployConversationModelOperationsClient

public override OperationsClient DeployConversationModelOperationsClient { get; }

The long-running operations client for DeployConversationModel.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override ConversationModels.ConversationModelsClient GrpcClient { get; }

The underlying gRPC ConversationModels client

Property Value
Type Description
ConversationModelsConversationModelsClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient
Overrides

UndeployConversationModelOperationsClient

public override OperationsClient UndeployConversationModelOperationsClient { get; }

The long-running operations client for UndeployConversationModel.

Property Value
Type Description
OperationsClient
Overrides

Methods

CreateConversationModel(CreateConversationModelRequest, CallSettings)

public override Operation<ConversationModel, CreateConversationModelOperationMetadata> CreateConversationModel(CreateConversationModelRequest request, CallSettings callSettings = null)

Creates a model.

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

  • metadata: [CreateConversationModelOperationMetadata][google.cloud.dialogflow.v2.CreateConversationModelOperationMetadata]
  • response: [ConversationModel][google.cloud.dialogflow.v2.ConversationModel]
Parameters
Name Description
request CreateConversationModelRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationConversationModelCreateConversationModelOperationMetadata

The RPC response.
Overrides

CreateConversationModelAsync(CreateConversationModelRequest, CallSettings)

public override Task<Operation<ConversationModel, CreateConversationModelOperationMetadata>> CreateConversationModelAsync(CreateConversationModelRequest request, CallSettings callSettings = null)

Creates a model.

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

  • metadata: [CreateConversationModelOperationMetadata][google.cloud.dialogflow.v2.CreateConversationModelOperationMetadata]
  • response: [ConversationModel][google.cloud.dialogflow.v2.ConversationModel]
Parameters
Name Description
request CreateConversationModelRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationConversationModelCreateConversationModelOperationMetadata

A Task containing the RPC response.
Overrides

CreateConversationModelEvaluation(CreateConversationModelEvaluationRequest, CallSettings)

public override Operation<ConversationModelEvaluation, CreateConversationModelEvaluationOperationMetadata> CreateConversationModelEvaluation(CreateConversationModelEvaluationRequest request, CallSettings callSettings = null)

Creates evaluation of a conversation model.

Parameters
Name Description
request CreateConversationModelEvaluationRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationConversationModelEvaluationCreateConversationModelEvaluationOperationMetadata

The RPC response.
Overrides

CreateConversationModelEvaluationAsync(CreateConversationModelEvaluationRequest, CallSettings)

public override Task<Operation<ConversationModelEvaluation, CreateConversationModelEvaluationOperationMetadata>> CreateConversationModelEvaluationAsync(CreateConversationModelEvaluationRequest request, CallSettings callSettings = null)

Creates evaluation of a conversation model.

Parameters
Name Description
request CreateConversationModelEvaluationRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationConversationModelEvaluationCreateConversationModelEvaluationOperationMetadata

A Task containing the RPC response.
Overrides

DeleteConversationModel(DeleteConversationModelRequest, CallSettings)

public override Operation<Empty, DeleteConversationModelOperationMetadata> DeleteConversationModel(DeleteConversationModelRequest request, CallSettings callSettings = null)

Deletes a model.

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

  • metadata: [DeleteConversationModelOperationMetadata][google.cloud.dialogflow.v2.DeleteConversationModelOperationMetadata]
  • response: An Empty message
Parameters
Name Description
request DeleteConversationModelRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyDeleteConversationModelOperationMetadata

The RPC response.
Overrides

DeleteConversationModelAsync(DeleteConversationModelRequest, CallSettings)

public override Task<Operation<Empty, DeleteConversationModelOperationMetadata>> DeleteConversationModelAsync(DeleteConversationModelRequest request, CallSettings callSettings = null)

Deletes a model.

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

  • metadata: [DeleteConversationModelOperationMetadata][google.cloud.dialogflow.v2.DeleteConversationModelOperationMetadata]
  • response: An Empty message
Parameters
Name Description
request DeleteConversationModelRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyDeleteConversationModelOperationMetadata

A Task containing the RPC response.
Overrides

DeployConversationModel(DeployConversationModelRequest, CallSettings)

public override Operation<Empty, DeployConversationModelOperationMetadata> DeployConversationModel(DeployConversationModelRequest request, CallSettings callSettings = null)

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: [DeployConversationModelOperationMetadata][google.cloud.dialogflow.v2.DeployConversationModelOperationMetadata]
  • response: An Empty message
Parameters
Name Description
request DeployConversationModelRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyDeployConversationModelOperationMetadata

The RPC response.
Overrides

DeployConversationModelAsync(DeployConversationModelRequest, CallSettings)

public override Task<Operation<Empty, DeployConversationModelOperationMetadata>> DeployConversationModelAsync(DeployConversationModelRequest request, CallSettings callSettings = null)

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: [DeployConversationModelOperationMetadata][google.cloud.dialogflow.v2.DeployConversationModelOperationMetadata]
  • response: An Empty message
Parameters
Name Description
request DeployConversationModelRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyDeployConversationModelOperationMetadata

A Task containing the RPC response.
Overrides

GetConversationModel(GetConversationModelRequest, CallSettings)

public override ConversationModel GetConversationModel(GetConversationModelRequest request, CallSettings callSettings = null)

Gets conversation model.

Parameters
Name Description
request GetConversationModelRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
ConversationModel

The RPC response.
Overrides

GetConversationModelAsync(GetConversationModelRequest, CallSettings)

public override Task<ConversationModel> GetConversationModelAsync(GetConversationModelRequest request, CallSettings callSettings = null)

Gets conversation model.

Parameters
Name Description
request GetConversationModelRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskConversationModel

A Task containing the RPC response.
Overrides

GetConversationModelEvaluation(GetConversationModelEvaluationRequest, CallSettings)

public override ConversationModelEvaluation GetConversationModelEvaluation(GetConversationModelEvaluationRequest request, CallSettings callSettings = null)

Gets an evaluation of conversation model.

Parameters
Name Description
request GetConversationModelEvaluationRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
ConversationModelEvaluation

The RPC response.
Overrides

GetConversationModelEvaluationAsync(GetConversationModelEvaluationRequest, CallSettings)

public override Task<ConversationModelEvaluation> GetConversationModelEvaluationAsync(GetConversationModelEvaluationRequest request, CallSettings callSettings = null)

Gets an evaluation of conversation model.

Parameters
Name Description
request GetConversationModelEvaluationRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskConversationModelEvaluation

A Task containing the RPC response.
Overrides

ListConversationModelEvaluations(ListConversationModelEvaluationsRequest, CallSettings)

public override PagedEnumerable<ListConversationModelEvaluationsResponse, ConversationModelEvaluation> ListConversationModelEvaluations(ListConversationModelEvaluationsRequest request, CallSettings callSettings = null)

Lists evaluations of a conversation model.

Parameters
Name Description
request ListConversationModelEvaluationsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListConversationModelEvaluationsResponseConversationModelEvaluation

A pageable sequence of ConversationModelEvaluation resources.
Overrides

ListConversationModelEvaluationsAsync(ListConversationModelEvaluationsRequest, CallSettings)

public override PagedAsyncEnumerable<ListConversationModelEvaluationsResponse, ConversationModelEvaluation> ListConversationModelEvaluationsAsync(ListConversationModelEvaluationsRequest request, CallSettings callSettings = null)

Lists evaluations of a conversation model.

Parameters
Name Description
request ListConversationModelEvaluationsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListConversationModelEvaluationsResponseConversationModelEvaluation

A pageable asynchronous sequence of ConversationModelEvaluation resources.
Overrides

ListConversationModels(ListConversationModelsRequest, CallSettings)

public override PagedEnumerable<ListConversationModelsResponse, ConversationModel> ListConversationModels(ListConversationModelsRequest request, CallSettings callSettings = null)

Lists conversation models.

Parameters
Name Description
request ListConversationModelsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListConversationModelsResponseConversationModel

A pageable sequence of ConversationModel resources.
Overrides

ListConversationModelsAsync(ListConversationModelsRequest, CallSettings)

public override PagedAsyncEnumerable<ListConversationModelsResponse, ConversationModel> ListConversationModelsAsync(ListConversationModelsRequest request, CallSettings callSettings = null)

Lists conversation models.

Parameters
Name Description
request ListConversationModelsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListConversationModelsResponseConversationModel

A pageable asynchronous sequence of ConversationModel resources.
Overrides

UndeployConversationModel(UndeployConversationModelRequest, CallSettings)

public override Operation<Empty, UndeployConversationModelOperationMetadata> UndeployConversationModel(UndeployConversationModelRequest request, CallSettings callSettings = null)

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: [UndeployConversationModelOperationMetadata][google.cloud.dialogflow.v2.UndeployConversationModelOperationMetadata]
  • response: An Empty message
Parameters
Name Description
request UndeployConversationModelRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyUndeployConversationModelOperationMetadata

The RPC response.
Overrides

UndeployConversationModelAsync(UndeployConversationModelRequest, CallSettings)

public override Task<Operation<Empty, UndeployConversationModelOperationMetadata>> UndeployConversationModelAsync(UndeployConversationModelRequest request, CallSettings callSettings = null)

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: [UndeployConversationModelOperationMetadata][google.cloud.dialogflow.v2.UndeployConversationModelOperationMetadata]
  • response: An Empty message
Parameters
Name Description
request UndeployConversationModelRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyUndeployConversationModelOperationMetadata

A Task containing the RPC response.
Overrides