class ProjectsLocationsAgentsFlows extends Resource (View source)

The "flows" collection of methods.

Typical usage is:

 $dialogflowService = new Google\Service\Dialogflow(...);
 $flows = $dialogflowService->projects_locations_agents_flows;

Methods

create(string $parent, GoogleCloudDialogflowCxV3Flow $postBody, array $optParams = [])

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

delete(string $name, array $optParams = [])

Deletes a specified flow. (flows.delete)

export(string $name, GoogleCloudDialogflowCxV3ExportFlowRequest $postBody, array $optParams = [])

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 Note that resources (e.g. intents, entities, webhooks) that the flow references will also be exported. (flows.export)

get(string $name, array $optParams = [])

Retrieves the specified flow. (flows.get)

getValidationResult(string $name, array $optParams = [])

Gets the latest flow validation result. Flow validation is performed when ValidateFlow is called. (flows.getValidationResult)

import(string $parent, GoogleCloudDialogflowCxV3ImportFlowRequest $postBody, array $optParams = [])

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 Note: You should always train a flow prior to sending it queries. See the training documentation.

listProjectsLocationsAgentsFlows(string $parent, array $optParams = [])

Returns the list of all flows in the specified agent.

patch(string $name, GoogleCloudDialogflowCxV3Flow $postBody, array $optParams = [])

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

train(string $name, GoogleCloudDialogflowCxV3TrainFlowRequest $postBody, array $optParams = [])

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.

validate(string $name, GoogleCloudDialogflowCxV3ValidateFlowRequest $postBody, array $optParams = [])

Validates the specified flow and creates or updates validation results.

Details

GoogleCloudDialogflowCxV3Flow create(string $parent, GoogleCloudDialogflowCxV3Flow $postBody, array $optParams = [])

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

(flows.create)

Parameters

string $parent

Required. The agent to create a flow for. Format: projects//locations//agents/.

GoogleCloudDialogflowCxV3Flow $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudDialogflowCxV3Flow

Exceptions

Exception

GoogleProtobufEmpty delete(string $name, array $optParams = [])

Deletes a specified flow. (flows.delete)

Parameters

string $name

Required. The name of the flow to delete. Format: projects//locations//agents//flows/.

array $optParams

Optional parameters.

Return Value

GoogleProtobufEmpty

Exceptions

Exception

GoogleLongrunningOperation export(string $name, GoogleCloudDialogflowCxV3ExportFlowRequest $postBody, array $optParams = [])

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 Note that resources (e.g. intents, entities, webhooks) that the flow references will also be exported. (flows.export)

Parameters

string $name

Required. The name of the flow to export. Format: projects//locations//agents//flows/.

GoogleCloudDialogflowCxV3ExportFlowRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

GoogleCloudDialogflowCxV3Flow get(string $name, array $optParams = [])

Retrieves the specified flow. (flows.get)

Parameters

string $name

Required. The name of the flow to get. Format: projects//locations//agents//flows/.

array $optParams

Optional parameters.

Return Value

GoogleCloudDialogflowCxV3Flow

Exceptions

Exception

GoogleCloudDialogflowCxV3FlowValidationResult getValidationResult(string $name, array $optParams = [])

Gets the latest flow validation result. Flow validation is performed when ValidateFlow is called. (flows.getValidationResult)

Parameters

string $name

Required. The flow name. Format: projects//locations//agents//flows//validationResult.

array $optParams

Optional parameters.

Return Value

GoogleCloudDialogflowCxV3FlowValidationResult

Exceptions

Exception

GoogleLongrunningOperation import(string $parent, GoogleCloudDialogflowCxV3ImportFlowRequest $postBody, array $optParams = [])

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 Note: You should always train a flow prior to sending it queries. See the training documentation.

(flows.import)

Parameters

string $parent

Required. The agent to import the flow into. Format: projects//locations//agents/.

GoogleCloudDialogflowCxV3ImportFlowRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

GoogleCloudDialogflowCxV3ListFlowsResponse listProjectsLocationsAgentsFlows(string $parent, array $optParams = [])

Returns the list of all flows in the specified agent.

(flows.listProjectsLocationsAgentsFlows)

Parameters

string $parent

Required. The agent containing the flows. Format: projects//locations//agents/.

array $optParams

Optional parameters.

Return Value

GoogleCloudDialogflowCxV3ListFlowsResponse

Exceptions

Exception

GoogleCloudDialogflowCxV3Flow patch(string $name, GoogleCloudDialogflowCxV3Flow $postBody, array $optParams = [])

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

(flows.patch)

Parameters

string $name

The unique identifier of the flow. Format: projects//locations//agents//flows/.

GoogleCloudDialogflowCxV3Flow $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudDialogflowCxV3Flow

Exceptions

Exception

GoogleLongrunningOperation train(string $name, GoogleCloudDialogflowCxV3TrainFlowRequest $postBody, array $optParams = [])

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.

(flows.train)

Parameters

string $name

Required. The flow to train. Format: projects//locations//agents//flows/.

GoogleCloudDialogflowCxV3TrainFlowRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

GoogleCloudDialogflowCxV3FlowValidationResult validate(string $name, GoogleCloudDialogflowCxV3ValidateFlowRequest $postBody, array $optParams = [])

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. (flows.validate)

Parameters

string $name

Required. The flow to validate. Format: projects//locations//agents//flows/.

GoogleCloudDialogflowCxV3ValidateFlowRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudDialogflowCxV3FlowValidationResult

Exceptions

Exception