getStream method

Future<GenaiVertexV1InteractionStreamingEvent> getStream(
  1. String name, {
  2. String? lastEventId,
  3. bool? stream,
  4. String? $fields,
})

Fully typed proto, streaming version of GetInteraction that returns Interaction proto.

Request parameters:

name - Required. The name of the interaction to retrieve. Format: interactions/{interaction} Value must have pattern ^interactions/\[^/\]+$.

lastEventId - If set, resumes the interaction stream from the chunk after the event marked by the event id. Can only be used if stream is true.

stream - If true, streams the interaction events as Server-Sent Events.

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

Completes with a GenaiVertexV1InteractionStreamingEvent.

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<GenaiVertexV1InteractionStreamingEvent> getStream(
  core.String name, {
  core.String? lastEventId,
  core.bool? stream,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    'lastEventId': ?lastEventId == null ? null : [lastEventId],
    'stream': ?stream == null ? null : ['${stream}'],
    'fields': ?$fields == null ? null : [$fields],
  };

  final url_ = 'v1/' + core.Uri.encodeFull('$name') + ':stream';

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