detectPiiEntities method

Future<DetectPiiEntitiesResponse> detectPiiEntities({
  1. required LanguageCode languageCode,
  2. required String text,
})

Inspects the input text for entities that contain personally identifiable information (PII) and returns information about them.

May throw InvalidRequestException. May throw TextSizeLimitExceededException. May throw UnsupportedLanguageException. May throw InternalServerException.

Parameter languageCode : The language of the input documents.

Parameter text : A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.

Implementation

Future<DetectPiiEntitiesResponse> detectPiiEntities({
  required LanguageCode languageCode,
  required String text,
}) async {
  ArgumentError.checkNotNull(languageCode, 'languageCode');
  ArgumentError.checkNotNull(text, 'text');
  _s.validateStringLength(
    'text',
    text,
    1,
    1152921504606846976,
    isRequired: true,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'Comprehend_20171127.DetectPiiEntities'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'LanguageCode': languageCode.toValue(),
      'Text': text,
    },
  );

  return DetectPiiEntitiesResponse.fromJson(jsonResponse.body);
}