Google Cloud Dialogflow v2 API - Class ConversationModels.ConversationModelsClient (4.16.0)

public class ConversationModels.ConversationModelsClient : ClientBase<ConversationModels.ConversationModelsClient>

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

Client for ConversationModels

Inheritance

object > ClientBase > ClientBaseConversationModelsConversationModelsClient > ConversationModels.ConversationModelsClient

Namespace

Google.Cloud.Dialogflow.V2

Assembly

Google.Cloud.Dialogflow.V2.dll

Constructors

ConversationModelsClient()

protected ConversationModelsClient()

Protected parameterless constructor to allow creation of test doubles.

ConversationModelsClient(CallInvoker)

public ConversationModelsClient(CallInvoker callInvoker)

Creates a new client for ConversationModels that uses a custom CallInvoker.

Parameter
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

ConversationModelsClient(ChannelBase)

public ConversationModelsClient(ChannelBase channel)

Creates a new client for ConversationModels

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

ConversationModelsClient(ClientBaseConfiguration)

protected ConversationModelsClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBaseClientBaseConfiguration

The client configuration.

Methods

CreateConversationModel(CreateConversationModelRequest, CallOptions)

public virtual Operation CreateConversationModel(CreateConversationModelRequest request, CallOptions options)

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
NameDescription
requestCreateConversationModelRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateConversationModel(CreateConversationModelRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateConversationModel(CreateConversationModelRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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
NameDescription
requestCreateConversationModelRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateConversationModelAsync(CreateConversationModelRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateConversationModelAsync(CreateConversationModelRequest request, CallOptions options)

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
NameDescription
requestCreateConversationModelRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

CreateConversationModelAsync(CreateConversationModelRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateConversationModelAsync(CreateConversationModelRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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
NameDescription
requestCreateConversationModelRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

CreateConversationModelEvaluation(CreateConversationModelEvaluationRequest, CallOptions)

public virtual Operation CreateConversationModelEvaluation(CreateConversationModelEvaluationRequest request, CallOptions options)

Creates evaluation of a conversation model.

Parameters
NameDescription
requestCreateConversationModelEvaluationRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateConversationModelEvaluation(CreateConversationModelEvaluationRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateConversationModelEvaluation(CreateConversationModelEvaluationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates evaluation of a conversation model.

Parameters
NameDescription
requestCreateConversationModelEvaluationRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateConversationModelEvaluationAsync(CreateConversationModelEvaluationRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateConversationModelEvaluationAsync(CreateConversationModelEvaluationRequest request, CallOptions options)

Creates evaluation of a conversation model.

Parameters
NameDescription
requestCreateConversationModelEvaluationRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

CreateConversationModelEvaluationAsync(CreateConversationModelEvaluationRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateConversationModelEvaluationAsync(CreateConversationModelEvaluationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates evaluation of a conversation model.

Parameters
NameDescription
requestCreateConversationModelEvaluationRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

Creates a new instance of Locations.LocationsClient using the same call invoker as this client.

Returns
TypeDescription
LocationsLocationsClient

A new Locations.LocationsClient for the same target as this client.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
TypeDescription
OperationsOperationsClient

A new Operations client for the same target as this client.

DeleteConversationModel(DeleteConversationModelRequest, CallOptions)

public virtual Operation DeleteConversationModel(DeleteConversationModelRequest request, CallOptions options)

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
NameDescription
requestDeleteConversationModelRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteConversationModel(DeleteConversationModelRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DeleteConversationModel(DeleteConversationModelRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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
NameDescription
requestDeleteConversationModelRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteConversationModelAsync(DeleteConversationModelRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteConversationModelAsync(DeleteConversationModelRequest request, CallOptions options)

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
NameDescription
requestDeleteConversationModelRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

DeleteConversationModelAsync(DeleteConversationModelRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteConversationModelAsync(DeleteConversationModelRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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
NameDescription
requestDeleteConversationModelRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

DeployConversationModel(DeployConversationModelRequest, CallOptions)

public virtual Operation DeployConversationModel(DeployConversationModelRequest request, CallOptions 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: [DeployConversationModelOperationMetadata][google.cloud.dialogflow.v2.DeployConversationModelOperationMetadata]
  • response: An Empty message
Parameters
NameDescription
requestDeployConversationModelRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

DeployConversationModel(DeployConversationModelRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DeployConversationModel(DeployConversationModelRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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
NameDescription
requestDeployConversationModelRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

DeployConversationModelAsync(DeployConversationModelRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeployConversationModelAsync(DeployConversationModelRequest request, CallOptions 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: [DeployConversationModelOperationMetadata][google.cloud.dialogflow.v2.DeployConversationModelOperationMetadata]
  • response: An Empty message
Parameters
NameDescription
requestDeployConversationModelRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

DeployConversationModelAsync(DeployConversationModelRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeployConversationModelAsync(DeployConversationModelRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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
NameDescription
requestDeployConversationModelRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

GetConversationModel(GetConversationModelRequest, CallOptions)

public virtual ConversationModel GetConversationModel(GetConversationModelRequest request, CallOptions options)

Gets conversation model.

Parameters
NameDescription
requestGetConversationModelRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ConversationModel

The response received from the server.

GetConversationModel(GetConversationModelRequest, Metadata, DateTime?, CancellationToken)

public virtual ConversationModel GetConversationModel(GetConversationModelRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets conversation model.

Parameters
NameDescription
requestGetConversationModelRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ConversationModel

The response received from the server.

GetConversationModelAsync(GetConversationModelRequest, CallOptions)

public virtual AsyncUnaryCall<ConversationModel> GetConversationModelAsync(GetConversationModelRequest request, CallOptions options)

Gets conversation model.

Parameters
NameDescription
requestGetConversationModelRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallConversationModel

The call object.

GetConversationModelAsync(GetConversationModelRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ConversationModel> GetConversationModelAsync(GetConversationModelRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets conversation model.

Parameters
NameDescription
requestGetConversationModelRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallConversationModel

The call object.

GetConversationModelEvaluation(GetConversationModelEvaluationRequest, CallOptions)

public virtual ConversationModelEvaluation GetConversationModelEvaluation(GetConversationModelEvaluationRequest request, CallOptions options)

Gets an evaluation of conversation model.

Parameters
NameDescription
requestGetConversationModelEvaluationRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ConversationModelEvaluation

The response received from the server.

GetConversationModelEvaluation(GetConversationModelEvaluationRequest, Metadata, DateTime?, CancellationToken)

public virtual ConversationModelEvaluation GetConversationModelEvaluation(GetConversationModelEvaluationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets an evaluation of conversation model.

Parameters
NameDescription
requestGetConversationModelEvaluationRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ConversationModelEvaluation

The response received from the server.

GetConversationModelEvaluationAsync(GetConversationModelEvaluationRequest, CallOptions)

public virtual AsyncUnaryCall<ConversationModelEvaluation> GetConversationModelEvaluationAsync(GetConversationModelEvaluationRequest request, CallOptions options)

Gets an evaluation of conversation model.

Parameters
NameDescription
requestGetConversationModelEvaluationRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallConversationModelEvaluation

The call object.

GetConversationModelEvaluationAsync(GetConversationModelEvaluationRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ConversationModelEvaluation> GetConversationModelEvaluationAsync(GetConversationModelEvaluationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets an evaluation of conversation model.

Parameters
NameDescription
requestGetConversationModelEvaluationRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallConversationModelEvaluation

The call object.

ListConversationModelEvaluations(ListConversationModelEvaluationsRequest, CallOptions)

public virtual ListConversationModelEvaluationsResponse ListConversationModelEvaluations(ListConversationModelEvaluationsRequest request, CallOptions options)

Lists evaluations of a conversation model.

Parameters
NameDescription
requestListConversationModelEvaluationsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListConversationModelEvaluationsResponse

The response received from the server.

ListConversationModelEvaluations(ListConversationModelEvaluationsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListConversationModelEvaluationsResponse ListConversationModelEvaluations(ListConversationModelEvaluationsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists evaluations of a conversation model.

Parameters
NameDescription
requestListConversationModelEvaluationsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListConversationModelEvaluationsResponse

The response received from the server.

ListConversationModelEvaluationsAsync(ListConversationModelEvaluationsRequest, CallOptions)

public virtual AsyncUnaryCall<ListConversationModelEvaluationsResponse> ListConversationModelEvaluationsAsync(ListConversationModelEvaluationsRequest request, CallOptions options)

Lists evaluations of a conversation model.

Parameters
NameDescription
requestListConversationModelEvaluationsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallListConversationModelEvaluationsResponse

The call object.

ListConversationModelEvaluationsAsync(ListConversationModelEvaluationsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListConversationModelEvaluationsResponse> ListConversationModelEvaluationsAsync(ListConversationModelEvaluationsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists evaluations of a conversation model.

Parameters
NameDescription
requestListConversationModelEvaluationsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallListConversationModelEvaluationsResponse

The call object.

ListConversationModels(ListConversationModelsRequest, CallOptions)

public virtual ListConversationModelsResponse ListConversationModels(ListConversationModelsRequest request, CallOptions options)

Lists conversation models.

Parameters
NameDescription
requestListConversationModelsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListConversationModelsResponse

The response received from the server.

ListConversationModels(ListConversationModelsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListConversationModelsResponse ListConversationModels(ListConversationModelsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists conversation models.

Parameters
NameDescription
requestListConversationModelsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListConversationModelsResponse

The response received from the server.

ListConversationModelsAsync(ListConversationModelsRequest, CallOptions)

public virtual AsyncUnaryCall<ListConversationModelsResponse> ListConversationModelsAsync(ListConversationModelsRequest request, CallOptions options)

Lists conversation models.

Parameters
NameDescription
requestListConversationModelsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallListConversationModelsResponse

The call object.

ListConversationModelsAsync(ListConversationModelsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListConversationModelsResponse> ListConversationModelsAsync(ListConversationModelsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists conversation models.

Parameters
NameDescription
requestListConversationModelsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallListConversationModelsResponse

The call object.

NewInstance(ClientBaseConfiguration)

protected override ConversationModels.ConversationModelsClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
NameDescription
configurationClientBaseClientBaseConfiguration
Returns
TypeDescription
ConversationModelsConversationModelsClient
Overrides

UndeployConversationModel(UndeployConversationModelRequest, CallOptions)

public virtual Operation UndeployConversationModel(UndeployConversationModelRequest request, CallOptions 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: [UndeployConversationModelOperationMetadata][google.cloud.dialogflow.v2.UndeployConversationModelOperationMetadata]
  • response: An Empty message
Parameters
NameDescription
requestUndeployConversationModelRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

UndeployConversationModel(UndeployConversationModelRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation UndeployConversationModel(UndeployConversationModelRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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
NameDescription
requestUndeployConversationModelRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

UndeployConversationModelAsync(UndeployConversationModelRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UndeployConversationModelAsync(UndeployConversationModelRequest request, CallOptions 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: [UndeployConversationModelOperationMetadata][google.cloud.dialogflow.v2.UndeployConversationModelOperationMetadata]
  • response: An Empty message
Parameters
NameDescription
requestUndeployConversationModelRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

UndeployConversationModelAsync(UndeployConversationModelRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> UndeployConversationModelAsync(UndeployConversationModelRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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
NameDescription
requestUndeployConversationModelRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.