Dialogflow v3 API - Class Intents.IntentsClient (2.18.0)

Version 2.18.0

• 2.21.0 (latest)
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

public class Intents.IntentsClient : ClientBase<Intents.IntentsClient>

Reference documentation and code samples for the Dialogflow v3 API class Intents.IntentsClient.

Client for Intents

Inheritance

object > ClientBase > ClientBaseIntentsIntentsClient > Intents.IntentsClient

Inherited Members

ClientBase<Intents.IntentsClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Dialogflow.Cx.V3

Assembly

Google.Cloud.Dialogflow.Cx.V3.dll

Constructors

IntentsClient()

protected IntentsClient()

Protected parameterless constructor to allow creation of test doubles.

IntentsClient(CallInvoker)

public IntentsClient(CallInvoker callInvoker)

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

Parameter
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

IntentsClient(ChannelBase)

public IntentsClient(ChannelBase channel)

Creates a new client for Intents

Parameter
Name	Description
channel	ChannelBase The channel to use to make remote calls.

IntentsClient(ClientBaseConfiguration)

protected IntentsClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

CreateIntent(CreateIntentRequest, CallOptions)

public virtual Intent CreateIntent(CreateIntentRequest request, CallOptions options)

Creates an intent in the specified agent.

Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters
Name	Description
request	CreateIntentRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Intent	The response received from the server.

CreateIntent(CreateIntentRequest, Metadata, DateTime?, CancellationToken)

public virtual Intent CreateIntent(CreateIntentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates an intent in the specified agent.

Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters
Name	Description
request	CreateIntentRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Intent	The response received from the server.

CreateIntentAsync(CreateIntentRequest, CallOptions)

public virtual AsyncUnaryCall<Intent> CreateIntentAsync(CreateIntentRequest request, CallOptions options)

Creates an intent in the specified agent.

Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters
Name	Description
request	CreateIntentRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallIntent	The call object.

CreateIntentAsync(CreateIntentRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Intent> CreateIntentAsync(CreateIntentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates an intent in the specified agent.

Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters
Name	Description
request	CreateIntentRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallIntent	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
Type	Description
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
Type	Description
OperationsOperationsClient	A new Operations client for the same target as this client.

DeleteIntent(DeleteIntentRequest, CallOptions)

public virtual Empty DeleteIntent(DeleteIntentRequest request, CallOptions options)

Deletes the specified intent.

Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters
Name	Description
request	DeleteIntentRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Empty	The response received from the server.

DeleteIntent(DeleteIntentRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty DeleteIntent(DeleteIntentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes the specified intent.

Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters
Name	Description
request	DeleteIntentRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Empty	The response received from the server.

DeleteIntentAsync(DeleteIntentRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteIntentAsync(DeleteIntentRequest request, CallOptions options)

Deletes the specified intent.

Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters
Name	Description
request	DeleteIntentRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

DeleteIntentAsync(DeleteIntentRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteIntentAsync(DeleteIntentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes the specified intent.

Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters
Name	Description
request	DeleteIntentRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

ExportIntents(ExportIntentsRequest, CallOptions)

public virtual Operation ExportIntents(ExportIntentsRequest request, CallOptions options)

Exports the selected intents.

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

• metadata: [ExportIntentsMetadata][google.cloud.dialogflow.cx.v3.ExportIntentsMetadata]
• response: [ExportIntentsResponse][google.cloud.dialogflow.cx.v3.ExportIntentsResponse]

Parameters
Name	Description
request	ExportIntentsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

ExportIntents(ExportIntentsRequest, Metadata, DateTime?, CancellationToken)

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

Exports the selected intents.

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

• metadata: [ExportIntentsMetadata][google.cloud.dialogflow.cx.v3.ExportIntentsMetadata]
• response: [ExportIntentsResponse][google.cloud.dialogflow.cx.v3.ExportIntentsResponse]

Parameters
Name	Description
request	ExportIntentsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

ExportIntentsAsync(ExportIntentsRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ExportIntentsAsync(ExportIntentsRequest request, CallOptions options)

Exports the selected intents.

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

• metadata: [ExportIntentsMetadata][google.cloud.dialogflow.cx.v3.ExportIntentsMetadata]
• response: [ExportIntentsResponse][google.cloud.dialogflow.cx.v3.ExportIntentsResponse]

Parameters
Name	Description
request	ExportIntentsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

ExportIntentsAsync(ExportIntentsRequest, Metadata, DateTime?, CancellationToken)

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

Exports the selected intents.

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

• metadata: [ExportIntentsMetadata][google.cloud.dialogflow.cx.v3.ExportIntentsMetadata]
• response: [ExportIntentsResponse][google.cloud.dialogflow.cx.v3.ExportIntentsResponse]

Parameters
Name	Description
request	ExportIntentsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

GetIntent(GetIntentRequest, CallOptions)

public virtual Intent GetIntent(GetIntentRequest request, CallOptions options)

Retrieves the specified intent.

Parameters
Name	Description
request	GetIntentRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Intent	The response received from the server.

GetIntent(GetIntentRequest, Metadata, DateTime?, CancellationToken)

public virtual Intent GetIntent(GetIntentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves the specified intent.

Parameters
Name	Description
request	GetIntentRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Intent	The response received from the server.

GetIntentAsync(GetIntentRequest, CallOptions)

public virtual AsyncUnaryCall<Intent> GetIntentAsync(GetIntentRequest request, CallOptions options)

Retrieves the specified intent.

Parameters
Name	Description
request	GetIntentRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallIntent	The call object.

GetIntentAsync(GetIntentRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Intent> GetIntentAsync(GetIntentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves the specified intent.

Parameters
Name	Description
request	GetIntentRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallIntent	The call object.

ImportIntents(ImportIntentsRequest, CallOptions)

public virtual Operation ImportIntents(ImportIntentsRequest request, CallOptions options)

Imports the specified intents into the agent.

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

• metadata: [ImportIntentsMetadata][google.cloud.dialogflow.cx.v3.ImportIntentsMetadata]
• response: [ImportIntentsResponse][google.cloud.dialogflow.cx.v3.ImportIntentsResponse]

Parameters
Name	Description
request	ImportIntentsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

ImportIntents(ImportIntentsRequest, Metadata, DateTime?, CancellationToken)

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

Imports the specified intents into the agent.

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

• metadata: [ImportIntentsMetadata][google.cloud.dialogflow.cx.v3.ImportIntentsMetadata]
• response: [ImportIntentsResponse][google.cloud.dialogflow.cx.v3.ImportIntentsResponse]

Parameters
Name	Description
request	ImportIntentsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

ImportIntentsAsync(ImportIntentsRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ImportIntentsAsync(ImportIntentsRequest request, CallOptions options)

Imports the specified intents into the agent.

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

• metadata: [ImportIntentsMetadata][google.cloud.dialogflow.cx.v3.ImportIntentsMetadata]
• response: [ImportIntentsResponse][google.cloud.dialogflow.cx.v3.ImportIntentsResponse]

Parameters
Name	Description
request	ImportIntentsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

ImportIntentsAsync(ImportIntentsRequest, Metadata, DateTime?, CancellationToken)

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

Imports the specified intents into the agent.

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

• metadata: [ImportIntentsMetadata][google.cloud.dialogflow.cx.v3.ImportIntentsMetadata]
• response: [ImportIntentsResponse][google.cloud.dialogflow.cx.v3.ImportIntentsResponse]

Parameters
Name	Description
request	ImportIntentsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

ListIntents(ListIntentsRequest, CallOptions)

public virtual ListIntentsResponse ListIntents(ListIntentsRequest request, CallOptions options)

Returns the list of all intents in the specified agent.

Parameters
Name	Description
request	ListIntentsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ListIntentsResponse	The response received from the server.

ListIntents(ListIntentsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListIntentsResponse ListIntents(ListIntentsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns the list of all intents in the specified agent.

Parameters
Name	Description
request	ListIntentsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ListIntentsResponse	The response received from the server.

ListIntentsAsync(ListIntentsRequest, CallOptions)

public virtual AsyncUnaryCall<ListIntentsResponse> ListIntentsAsync(ListIntentsRequest request, CallOptions options)

Returns the list of all intents in the specified agent.

Parameters
Name	Description
request	ListIntentsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallListIntentsResponse	The call object.

ListIntentsAsync(ListIntentsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListIntentsResponse> ListIntentsAsync(ListIntentsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns the list of all intents in the specified agent.

Parameters
Name	Description
request	ListIntentsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallListIntentsResponse	The call object.

NewInstance(ClientBaseConfiguration)

protected override Intents.IntentsClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
IntentsIntentsClient

Overrides

ClientBase<Intents.IntentsClient>.NewInstance(ClientBase.ClientBaseConfiguration)

UpdateIntent(UpdateIntentRequest, CallOptions)

public virtual Intent UpdateIntent(UpdateIntentRequest request, CallOptions options)

Updates the specified intent.

Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters
Name	Description
request	UpdateIntentRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Intent	The response received from the server.

UpdateIntent(UpdateIntentRequest, Metadata, DateTime?, CancellationToken)

public virtual Intent UpdateIntent(UpdateIntentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates the specified intent.

Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters
Name	Description
request	UpdateIntentRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Intent	The response received from the server.

UpdateIntentAsync(UpdateIntentRequest, CallOptions)

public virtual AsyncUnaryCall<Intent> UpdateIntentAsync(UpdateIntentRequest request, CallOptions options)

Updates the specified intent.

Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters
Name	Description
request	UpdateIntentRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallIntent	The call object.

UpdateIntentAsync(UpdateIntentRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Intent> UpdateIntentAsync(UpdateIntentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates the specified intent.

Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters
Name	Description
request	UpdateIntentRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallIntent	The call object.