Analyze Text
Detect entities in the provided text strings using Private AI’s entity detection engine and return the results of the analysis and validation of each entity.
Body
API 4.1 Spec Definition
UTF-8 encoded message(s) to process. E.g. ["My name is Adam"] or ["I live at", "263 Spadina Av"]. Request processing time increases linearly with input text length, therefore maximum length is dependent on provisioned hardware and any timeouts set by the user. Private AI has tested up to 500K characters on the CPU and GPU containers.
When set to True, the list of inputs provided in text will be processed together as a single input by the Private AI PII detection model. This shares context between the different inputs and is useful when processing a sequence of short inputs, such as an SMS chat log. This option should only be enabled when the inputs are related, otherwise PII detection performance could be degraded.
This optional field serves as a hint to the analyzer to interpret locale-dependent entity types like dates. When set to en-CA, the date 12-10-2024 will be interpreted as October 12, 2024. However, if the hint is set to en-US, the date will be interpreted as December 10, 2024. If no locale is provided the language of the input text will be used.
Response
Successful Response