Text Analytics

This endpoint performs comprehensive text analysis on provided content and answers specific questions about the text. Each response is supported by reasoning and the exact phrase extracted from the content.

Headers

api-subscription-keystringRequired

Request

This endpoint expects an object.
textstringRequired

The text content to be analyzed. This should be a non-empty string containing the full text for analysis.

questionsstringRequired

List of questions to be answered based on the call content. Each question should be a valid JSON object with the following structure: {id: string, text: string, description: string (optional), type: string, properties: object}.The type field must be one of: boolean, enum, short answer, long answer, or number. For enum type questions, include an ‘options’ list in the properties.

Response

Successful Response

request_idstringOptional
answerslist of objectsOptional

List of answers derived from the text analysis. Each answer corresponds to a question from the original request. This field will be null if no valid answers could be generated.

Errors