Class Sessions.SessionsClient (1.5.0)

public class SessionsClient : ClientBase<Sessions.SessionsClient>

Client for Sessions

Inheritance

Object > ClientBase > ClientBase<Sessions.SessionsClient> > Sessions.SessionsClient

Inherited Members

ClientBase<Sessions.SessionsClient>.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

SessionsClient()

protected SessionsClient()

Protected parameterless constructor to allow creation of test doubles.

SessionsClient(CallInvoker)

public SessionsClient(CallInvoker callInvoker)

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

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

SessionsClient(ChannelBase)

public SessionsClient(ChannelBase channel)

Creates a new client for Sessions

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

SessionsClient(ClientBase.ClientBaseConfiguration)

protected SessionsClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
`configuration`	`ClientBase.ClientBaseConfiguration` The client configuration.

Methods

DetectIntent(DetectIntentRequest, CallOptions)

public virtual DetectIntentResponse DetectIntent(DetectIntentRequest request, CallOptions options)

Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause session entity types to be updated, which in turn might affect results of future queries.

Note: Always use agent versions for production traffic. See Versions and environments.

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

Returns
Type	Description
`DetectIntentResponse`	The response received from the server.

DetectIntent(DetectIntentRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual DetectIntentResponse DetectIntent(DetectIntentRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Note: Always use agent versions for production traffic. See Versions and environments.

Parameters
Name	Description
`request`	`DetectIntentRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<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
`DetectIntentResponse`	The response received from the server.

DetectIntentAsync(DetectIntentRequest, CallOptions)

public virtual AsyncUnaryCall<DetectIntentResponse> DetectIntentAsync(DetectIntentRequest request, CallOptions options)

Note: Always use agent versions for production traffic. See Versions and environments.

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

Returns
Type	Description
`AsyncUnaryCall<DetectIntentResponse>`	The call object.

DetectIntentAsync(DetectIntentRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<DetectIntentResponse> DetectIntentAsync(DetectIntentRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Note: Always use agent versions for production traffic. See Versions and environments.

Parameters
Name	Description
`request`	`DetectIntentRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<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
`AsyncUnaryCall<DetectIntentResponse>`	The call object.

FulfillIntent(FulfillIntentRequest, CallOptions)

public virtual FulfillIntentResponse FulfillIntent(FulfillIntentRequest request, CallOptions options)

Fulfills a matched intent returned by [MatchIntent][google.cloud.dialogflow.cx.v3.Sessions.MatchIntent]. Must be called after [MatchIntent][google.cloud.dialogflow.cx.v3.Sessions.MatchIntent], with input from [MatchIntentResponse][google.cloud.dialogflow.cx.v3.MatchIntentResponse]. Otherwise, the behavior is undefined.

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

Returns
Type	Description
`FulfillIntentResponse`	The response received from the server.

FulfillIntent(FulfillIntentRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual FulfillIntentResponse FulfillIntent(FulfillIntentRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Parameters
Name	Description
`request`	`FulfillIntentRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<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
`FulfillIntentResponse`	The response received from the server.

FulfillIntentAsync(FulfillIntentRequest, CallOptions)

public virtual AsyncUnaryCall<FulfillIntentResponse> FulfillIntentAsync(FulfillIntentRequest request, CallOptions options)

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

Returns
Type	Description
`AsyncUnaryCall<FulfillIntentResponse>`	The call object.

FulfillIntentAsync(FulfillIntentRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<FulfillIntentResponse> FulfillIntentAsync(FulfillIntentRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Parameters
Name	Description
`request`	`FulfillIntentRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<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
`AsyncUnaryCall<FulfillIntentResponse>`	The call object.

MatchIntent(MatchIntentRequest, CallOptions)

public virtual MatchIntentResponse MatchIntent(MatchIntentRequest request, CallOptions options)

Returns preliminary intent match results, doesn't change the session status.

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

Returns
Type	Description
`MatchIntentResponse`	The response received from the server.

MatchIntent(MatchIntentRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual MatchIntentResponse MatchIntent(MatchIntentRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Returns preliminary intent match results, doesn't change the session status.

Parameters
Name	Description
`request`	`MatchIntentRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<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
`MatchIntentResponse`	The response received from the server.

MatchIntentAsync(MatchIntentRequest, CallOptions)

public virtual AsyncUnaryCall<MatchIntentResponse> MatchIntentAsync(MatchIntentRequest request, CallOptions options)

Returns preliminary intent match results, doesn't change the session status.

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

Returns
Type	Description
`AsyncUnaryCall<MatchIntentResponse>`	The call object.

MatchIntentAsync(MatchIntentRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<MatchIntentResponse> MatchIntentAsync(MatchIntentRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Returns preliminary intent match results, doesn't change the session status.

Parameters
Name	Description
`request`	`MatchIntentRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<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
`AsyncUnaryCall<MatchIntentResponse>`	The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

protected override Sessions.SessionsClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
`configuration`	`ClientBase.ClientBaseConfiguration`

Returns
Type	Description
`Sessions.SessionsClient`

Overrides

Grpc.Core.ClientBase<Google.Cloud.Dialogflow.Cx.V3.Sessions.SessionsClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

StreamingDetectIntent(CallOptions)

public virtual AsyncDuplexStreamingCall<StreamingDetectIntentRequest, StreamingDetectIntentResponse> StreamingDetectIntent(CallOptions options)

Processes a natural language query in audio format in a streaming fashion and returns structured, actionable data as a result. This method is only available via the gRPC API (not REST).

Note: Always use agent versions for production traffic. See Versions and environments.

Parameter
Name	Description
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncDuplexStreamingCall<StreamingDetectIntentRequest, StreamingDetectIntentResponse>`	The call object.

StreamingDetectIntent(Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncDuplexStreamingCall<StreamingDetectIntentRequest, StreamingDetectIntentResponse> StreamingDetectIntent(Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Processes a natural language query in audio format in a streaming fashion and returns structured, actionable data as a result. This method is only available via the gRPC API (not REST).

Note: Always use agent versions for production traffic. See Versions and environments.

Parameters
Name	Description
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<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
`AsyncDuplexStreamingCall<StreamingDetectIntentRequest, StreamingDetectIntentResponse>`	The call object.