train method
- GoogleCloudDialogflowCxV3TrainFlowRequest request,
- String name, {
- String? $fields,
Trains the specified flow.
Note that only the flow in 'draft' environment is trained. This method is
a [long-running
operation](https://cloud.google.com/dialogflow/cx/docs/how/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.
request
- The metadata request object.
Request parameters:
name
- Required. The flow to train. Format:
projects//locations//agents//flows/
.
Value must have pattern
^projects/\[^/\]+/locations/\[^/\]+/agents/\[^/\]+/flows/\[^/\]+$
.
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a GoogleLongrunningOperation.
Completes with a commons.ApiRequestError if the API endpoint returned an error.
If the used http.Client
completes with an error when making a REST call,
this method will complete with the same error.
Implementation
async.Future<GoogleLongrunningOperation> train(
GoogleCloudDialogflowCxV3TrainFlowRequest request,
core.String name, {
core.String? $fields,
}) async {
final body_ = convert.json.encode(request);
final queryParams_ = <core.String, core.List<core.String>>{
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v3/' + core.Uri.encodeFull('$name') + ':train';
final response_ = await _requester.request(
url_,
'POST',
body: body_,
queryParams: queryParams_,
);
return GoogleLongrunningOperation.fromJson(
response_ as core.Map<core.String, core.dynamic>);
}