Some products and features are in the process of being renamed. Generative playbook and flow features are also being migrated to a single consolidated console. See the details.

Method: projects.locations.agents.flows.train

HTTP request
Path parameters
Request body
Response body
Authorization scopes
Try it!

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.

HTTP request

POST https://{endpoint}/v3/{name=projects/*/locations/*/agents/*/flows/*}:train

Where {endpoint} is one of the supported service endpoints.

The URLs use gRPC Transcoding syntax.

Path parameters

Parameters

Parameters
`name`	`string` Required. The flow to train. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`. Authorization requires the following IAM permission on the specified resource `name`: `dialogflow.flows.train`

name

string

Required. The flow to train. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>.

Authorization requires the following IAM permission on the specified resource name:

dialogflow.flows.train

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires one of the following OAuth scopes:

https://www.googleapis.com/auth/cloud-platform
https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.