serverStreamingDetectIntent method

Future<GoogleCloudDialogflowCxV3DetectIntentResponse> serverStreamingDetectIntent(GoogleCloudDialogflowCxV3DetectIntentRequest request, String session, { String? $fields, })

Processes a natural language query and returns structured, actionable data as a result through server-side streaming.

Server-side streaming allows Dialogflow to send partial responses earlier in a single request.

request - The metadata request object.

Request parameters:

session - Required. The name of the session this query is sent to. Format: projects//locations//agents//sessions/ or projects//locations//agents//environments//sessions/. If Environment ID is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate Session ID. It can be a random number or some type of session identifiers (preferably hashed). The length of the Session ID must not exceed 36 characters. For more information, see the sessions guide. Note: Always use agent versions for production traffic. See Versions and environments. Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/agents/\[^/\]+/environments/\[^/\]+/sessions/\[^/\]+$.

$fields - Selector specifying which fields to include in a partial response.

Completes with a GoogleCloudDialogflowCxV3DetectIntentResponse.

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<GoogleCloudDialogflowCxV3DetectIntentResponse>
    serverStreamingDetectIntent(
  GoogleCloudDialogflowCxV3DetectIntentRequest request,
  core.String session, {
  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('$session') +
      ':serverStreamingDetectIntent';

  final response_ = await _requester.request(
    url_,
    'POST',
    body: body_,
    queryParams: queryParams_,
  );
  return GoogleCloudDialogflowCxV3DetectIntentResponse.fromJson(
      response_ as core.Map<core.String, core.dynamic>);
}