POST /:analyze-text

Request text analysis over a collection of documents.

Request

  • Base URL
    {Endpoint}/language
  • Auth
    • API key in header Ocp-Apim-Subscription-Key
    • or OAuth 2
      Authorization codehttps://login.microsoftonline.com/common/oauth2/authorize
      Token URLhttps://login.microsoftonline.com/common/oauth2/token
      Scopeshttps://cognitiveservices.azure.com/.default

Query parameters

api-versionstring required

The API version to use for this operation.

showStatsboolean

(Optional) if set to true, response will contain request and document level statistics.

Request body

kind'SentimentAnalysis' | 'EntityRecognition' | 'PiiEntityRecognition' | 'KeyPhraseExtraction' | 'LanguageDetection' | 'EntityLinking' required

The kind of the analyze-text tasks supported.

Response

The request has succeeded.

kind'SentimentAnalysisResults' | 'EntityRecognitionResults' | 'PiiEntityRecognitionResults' | 'KeyPhraseExtractionResults' | 'LanguageDetectionResults' | 'EntityLinkingResults' required

The kind of the response object returned by the analyze-text task.

Changes

No recorded changes to this operation across all 6 revisions of this API.