analyzeEntities method

Future<AnalyzeEntitiesResponse> analyzeEntities(
  1. AnalyzeEntitiesRequest request, {
  2. String? $fields,
})

Finds named entities (currently proper names and common nouns) in the text along with entity types, probability, mentions for each entity, and other properties.

request - The metadata request object.

Request parameters:

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

Completes with a AnalyzeEntitiesResponse.

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<AnalyzeEntitiesResponse> analyzeEntities(
  AnalyzeEntitiesRequest 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_ = 'v2/documents:analyzeEntities';

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