annotate method

Future<BatchAnnotateFilesResponse> annotate(
  1. BatchAnnotateFilesRequest request, {
  2. String? $fields,
})

Service that performs image detection and annotation for a batch of files.

Now only "application/pdf", "image/tiff" and "image/gif" are supported. This service will extract at most 5 (customers can specify which 5 in AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each file provided and perform detection and annotation for each image extracted.

request - The metadata request object.

Request parameters:

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

Completes with a BatchAnnotateFilesResponse.

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<BatchAnnotateFilesResponse> annotate(
  BatchAnnotateFilesRequest request, {
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  const url_ = 'v1/files:annotate';

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