Module Values.DetectPHIResponseSource

Inspects the clinical text for protected health information (PHI) entities and returns the entity category, location, and confidence score for each entity. Amazon Comprehend Medical only detects entities in English language texts.

Sourcetype nonrec t = {
  1. entities : EntityList.t option;
    (*

    The collection of PHI entities extracted from the input text and their associated information. For each entity, the response provides the entity text, the entity category, where the entity text begins and ends, and the level of confidence that Amazon Comprehend Medical has in its detection.

    *)
  2. paginationToken : String_.t option;
    (*

    If the result of the previous request to DetectPHI was truncated, include the PaginationToken to fetch the next page of PHI entities.

    *)
  3. modelVersion : String_.t option;
    (*

    The version of the model used to analyze the documents. The version number looks like X.X.X. You can use this information to track the model used for a particular batch of documents.

    *)
}
Sourcetype nonrec error = [
  1. | `InternalServerException of InternalServerException.t
  2. | `InvalidEncodingException of InvalidEncodingException.t
  3. | `InvalidRequestException of InvalidRequestException.t
  4. | `ServiceUnavailableException of ServiceUnavailableException.t
  5. | `TextSizeLimitExceededException of TextSizeLimitExceededException.t
  6. | `TooManyRequestsException of TooManyRequestsException.t
  7. | `Unknown_operation_error of string * string option
]
Sourceval make : ?entities:??? -> ?paginationToken:??? -> ?modelVersion:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `InternalServerException of InternalServerException.t | `InvalidEncodingException of InvalidEncodingException.t | `InvalidRequestException of InvalidRequestException.t | `ServiceUnavailableException of ServiceUnavailableException.t | `TextSizeLimitExceededException of TextSizeLimitExceededException.t | `TooManyRequestsException of TooManyRequestsException.t | `Unknown_operation_error of string * string option ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `InternalServerException of InternalServerException.t | `InvalidEncodingException of InvalidEncodingException.t | `InvalidRequestException of InvalidRequestException.t | `ServiceUnavailableException of ServiceUnavailableException.t | `TextSizeLimitExceededException of TextSizeLimitExceededException.t | `TooManyRequestsException of TooManyRequestsException.t | `Unknown_operation_error of string * string option ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `List of [> `Structure of (string * [> `Enum of string | `Float of Float_.t | `Integer of Integer.t | `List of [> `Structure of (string * [> `Enum of string | `Float of Float_.t | `Integer of Integer.t | `List of [> `Structure of (string * [> `Enum of string | `Float of Float_.t ]) list ] list | `String of String_.t ]) list ] list | `String of String_.t ]) list ] list | `String of String_.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t