Dialogflow v3 API - Class Flows.FlowsBase (2.18.0)

Version latest

• 2.18.0 (latest)
• 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

[BindServiceMethod(typeof(Flows), "BindService")]
public abstract class Flows.FlowsBase

Reference documentation and code samples for the Dialogflow v3 API class Flows.FlowsBase.

Base class for server-side implementations of Flows

Inheritance

object > Flows.FlowsBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Dialogflow.Cx.V3

Assembly

Google.Cloud.Dialogflow.Cx.V3.dll

Methods

CreateFlow(CreateFlowRequest, ServerCallContext)

public virtual Task<Flow> CreateFlow(CreateFlowRequest request, ServerCallContext context)

Creates a flow in the specified agent.

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

Parameters
Name	Description
request	CreateFlowRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskFlow	The response to send back to the client (wrapped by a task).

DeleteFlow(DeleteFlowRequest, ServerCallContext)

public virtual Task<Empty> DeleteFlow(DeleteFlowRequest request, ServerCallContext context)

Deletes a specified flow.

Parameters
Name	Description
request	DeleteFlowRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEmpty	The response to send back to the client (wrapped by a task).

ExportFlow(ExportFlowRequest, ServerCallContext)

public virtual Task<Operation> ExportFlow(ExportFlowRequest request, ServerCallContext context)

Exports the specified flow to a binary file.

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

• metadata: An empty Struct message
• response: [ExportFlowResponse][google.cloud.dialogflow.cx.v3.ExportFlowResponse]

Note that resources (e.g. intents, entities, webhooks) that the flow references will also be exported.

Parameters
Name	Description
request	ExportFlowRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

GetFlow(GetFlowRequest, ServerCallContext)

public virtual Task<Flow> GetFlow(GetFlowRequest request, ServerCallContext context)

Retrieves the specified flow.

Parameters
Name	Description
request	GetFlowRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskFlow	The response to send back to the client (wrapped by a task).

GetFlowValidationResult(GetFlowValidationResultRequest, ServerCallContext)

public virtual Task<FlowValidationResult> GetFlowValidationResult(GetFlowValidationResultRequest request, ServerCallContext context)

Gets the latest flow validation result. Flow validation is performed when ValidateFlow is called.

Parameters
Name	Description
request	GetFlowValidationResultRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskFlowValidationResult	The response to send back to the client (wrapped by a task).

ImportFlow(ImportFlowRequest, ServerCallContext)

public virtual Task<Operation> ImportFlow(ImportFlowRequest request, ServerCallContext context)

Imports the specified flow to the specified agent from a binary file.

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

• metadata: An empty Struct message
• response: [ImportFlowResponse][google.cloud.dialogflow.cx.v3.ImportFlowResponse]

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

Parameters
Name	Description
request	ImportFlowRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

ListFlows(ListFlowsRequest, ServerCallContext)

public virtual Task<ListFlowsResponse> ListFlows(ListFlowsRequest request, ServerCallContext context)

Returns the list of all flows in the specified agent.

Parameters
Name	Description
request	ListFlowsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListFlowsResponse	The response to send back to the client (wrapped by a task).

TrainFlow(TrainFlowRequest, ServerCallContext)

public virtual Task<Operation> TrainFlow(TrainFlowRequest request, ServerCallContext context)

Trains the specified flow. Note that only the flow in 'draft' environment is trained.

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

• metadata: An empty Struct message
• response: An Empty message

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

Parameters
Name	Description
request	TrainFlowRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

UpdateFlow(UpdateFlowRequest, ServerCallContext)

public virtual Task<Flow> UpdateFlow(UpdateFlowRequest request, ServerCallContext context)

Updates the specified flow.

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

Parameters
Name	Description
request	UpdateFlowRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskFlow	The response to send back to the client (wrapped by a task).

ValidateFlow(ValidateFlowRequest, ServerCallContext)

public virtual Task<FlowValidationResult> ValidateFlow(ValidateFlowRequest request, ServerCallContext context)

Validates the specified flow and creates or updates validation results. Please call this API after the training is completed to get the complete validation results.

Parameters
Name	Description
request	ValidateFlowRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskFlowValidationResult	The response to send back to the client (wrapped by a task).