Analyze Text Submit Job - Analyze Text Submit Job

Service:: Azure AI Services

API Version:: 2024-11-01

Submit a collection of text documents for analysis. Specify one or more unique tasks to be executed as a long-running operation.

POST {Endpoint}/language/analyze-text/jobs?api-version=2024-11-01

URI Parameters

Name	In	Required	Type	Description
Endpoint	path	True	string	Supported Cognitive Services endpoint (e.g., https://<resource-name>.api.cognitiveservices.azure.com).
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Body

Name	Required	Type	Description
analysisInput	True	MultiLanguageAnalysisInput	Contains the input to be analyzed.
tasks	True	AnalyzeTextLROTask[]: AbstractiveSummarizationLROTask[] CustomEntitiesLROTask[] CustomMultiLabelClassificationLROTask[] CustomSingleLabelClassificationLROTask[] EntitiesLROTask[] EntityLinkingLROTask[] ExtractiveSummarizationLROTask[] HealthcareLROTask[] KeyPhraseLROTask[] PiiLROTask[] SentimentAnalysisLROTask[]	List of tasks to be performed as part of the LRO.
displayName		string	Name for the task.

Responses

Name	Type	Description
202 Accepted		The request has been accepted for processing, but processing has not yet completed. Headers Operation-Location: string
Other Status Codes	ErrorResponse	An unexpected error response. Headers x-ms-error-code: string

Name

Type

Description

202 Accepted

The request has been accepted for processing, but processing has not yet completed.

Headers

Operation-Location: string

Other Status Codes

ErrorResponse

An unexpected error response.

Headers

x-ms-error-code: string

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

OAuth2Auth

Type: oauth2
Flow: accessCode
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize
Token URL: https://login.microsoftonline.com/common/oauth2/token

Scopes

Name	Description
https://cognitiveservices.azure.com/.default

Examples

SuccessfulAbstractiveSummarizationSummaryLengthTaskSubmit

SuccessfulAbstractiveSummarizationTaskSubmit

SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest

SuccessfulHealthcareDocumentTypePostRequest

SuccessfulHealthcarePostRequest

SuccessfulAbstractiveSummarizationSummaryLengthTaskSubmit

Sample request

HTTP

POST {Endpoint}/language/analyze-text/jobs?api-version=2024-11-01

{
  "displayName": "Document Abstractive Summarization Task Example",
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "language": "en",
        "text": "At Microsoft, we have been on a quest to advance AI beyond existing techniques, by taking a more holistic, human-centric approach to learning and understanding. As Chief Technology Officer of Azure AI Cognitive Services, I have been working with a team of amazing scientists and engineers to turn this quest into a reality. In my role, I enjoy a unique perspective in viewing the relationship among three attributes of human cognition: monolingual text (X), audio or visual sensory signals, (Y) and multilingual (Z). At the intersection of all three, there is magic—what we call XYZ-code as illustrated in Figure 1—a joint representation to create more powerful AI that can speak, hear, see, and understand humans better. We believe XYZ-code will enable us to fulfill our long-term vision: cross-domain transfer learning, spanning modalities and languages. The goal is to have pre-trained models that can jointly learn representations to support a broad range of downstream AI tasks, much in the way humans do today. Over the past five years, we have achieved human performance on benchmarks in conversational speech recognition, machine translation, conversational question answering, machine reading comprehension, and image captioning. These five breakthroughs provided us with strong signals toward our more ambitious aspiration to produce a leap in AI capabilities, achieving multi-sensory and multilingual learning that is closer in line with how humans learn and understand. I believe the joint XYZ-code is a foundational component of this aspiration, if grounded with external knowledge sources in the downstream AI tasks."
      }
    ]
  },
  "tasks": [
    {
      "kind": "AbstractiveSummarization",
      "taskName": "Document Abstractive Summarization Task 1",
      "parameters": {
        "summaryLength": "medium"
      }
    }
  ]
}

Sample response

Status code:: 202

Operation-Location: {endpoint}/language/analyze-text/jobs/{jobId}?api-version=2024-11-01

SuccessfulAbstractiveSummarizationTaskSubmit

Sample request

HTTP

POST {Endpoint}/language/analyze-text/jobs?api-version=2024-11-01

{
  "displayName": "Document Abstractive Summarization Task Example",
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "language": "en",
        "text": "At Microsoft, we have been on a quest to advance AI beyond existing techniques, by taking a more holistic, human-centric approach to learning and understanding. As Chief Technology Officer of Azure AI Cognitive Services, I have been working with a team of amazing scientists and engineers to turn this quest into a reality. In my role, I enjoy a unique perspective in viewing the relationship among three attributes of human cognition: monolingual text (X), audio or visual sensory signals, (Y) and multilingual (Z). At the intersection of all three, there is magic—what we call XYZ-code as illustrated in Figure 1—a joint representation to create more powerful AI that can speak, hear, see, and understand humans better. We believe XYZ-code will enable us to fulfill our long-term vision: cross-domain transfer learning, spanning modalities and languages. The goal is to have pre-trained models that can jointly learn representations to support a broad range of downstream AI tasks, much in the way humans do today. Over the past five years, we have achieved human performance on benchmarks in conversational speech recognition, machine translation, conversational question answering, machine reading comprehension, and image captioning. These five breakthroughs provided us with strong signals toward our more ambitious aspiration to produce a leap in AI capabilities, achieving multi-sensory and multilingual learning that is closer in line with how humans learn and understand. I believe the joint XYZ-code is a foundational component of this aspiration, if grounded with external knowledge sources in the downstream AI tasks."
      }
    ]
  },
  "tasks": [
    {
      "kind": "AbstractiveSummarization",
      "taskName": "Document Abstractive Summarization Task 1",
      "parameters": {
        "sentenceCount": 1
      }
    }
  ]
}

Sample response

Status code:: 202

Operation-Location: {endpoint}/language/analyze-text/jobs/{jobId}?api-version=2024-11-01

SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest

Sample request

HTTP

POST {Endpoint}/language/analyze-text/jobs?api-version=2024-11-01

{
  "displayName": "Extracting Location & US Region",
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "language": "en",
        "text": "I had a wonderful trip to Seattle last week."
      },
      {
        "id": "2",
        "language": "en",
        "text": "I'm flying to NYC tomorrow. See you there."
      }
    ]
  },
  "tasks": [
    {
      "kind": "EntityRecognition",
      "taskName": "Recognize Entities",
      "parameters": {
        "modelVersion": "latest"
      }
    },
    {
      "kind": "CustomEntityRecognition",
      "taskName": "Recognize US Regions",
      "parameters": {
        "projectName": "MyProject",
        "deploymentName": "MyDeployment"
      }
    }
  ]
}

Sample response

Status code:: 202

Operation-Location: {endpoint}/language/analyze-text/jobs/{jobId}?api-version=2024-11-01

SuccessfulHealthcareDocumentTypePostRequest

Sample request

HTTP

POST {Endpoint}/language/analyze-text/jobs?api-version=2024-11-01

{
  "analysisInput": {
    "documents": [
      {
        "text": "Prescribed 100mg ibuprofen, taken twice daily.",
        "id": "1",
        "language": "en"
      }
    ]
  },
  "tasks": [
    {
      "kind": "Healthcare",
      "parameters": {
        "modelVersion": "latest",
        "fhirVersion": "4.0.1",
        "documentType": "DischargeSummary"
      }
    }
  ]
}

Sample response

Status code:: 202

Operation-Location: {Endpoint}/language/analyze-text/jobs/{jobId}?api-version=2023-11-01

SuccessfulHealthcarePostRequest

Sample request

HTTP

POST {Endpoint}/language/analyze-text/jobs?api-version=2024-11-01

{
  "analysisInput": {
    "documents": [
      {
        "text": "Prescribed 100mg ibuprofen, taken twice daily.",
        "id": "1",
        "language": "en"
      }
    ]
  },
  "tasks": [
    {
      "kind": "Healthcare",
      "parameters": {
        "modelVersion": "latest"
      }
    }
  ]
}

Sample response

Status code:: 202

Operation-Location: {Endpoint}/language/analyze-text/jobs/{jobId}?api-version=2023-11-01

Definitions

Name	Description
AbstractiveSummarizationLROTask	An object representing the task definition for an Abstractive Summarization task.
AbstractiveSummarizationTaskParameters	Supported parameters for the pre-built Abstractive Summarization task.
AllowOverlapEntityPolicyType	Represents the allow overlap policy. Will apply no post processing logic for the entities. Whatever the model predicts is what will be returned to the user. This allows the user to get a full view of every single model's possible values and apply their own custom logic on entity selection
AnalyzeTextJobsInput	The input object for the analyze text LRO.
AnalyzeTextLROTaskKind	The kind of the long running analyze text tasks supported.
CustomEntitiesLROTask	Contains the custom text LRO task.
CustomEntitiesTaskParameters	Supported parameters for a Custom Entities task.
CustomMultiLabelClassificationLROTask	Use custom models to classify text into multi label taxonomy
CustomMultiLabelClassificationTaskParameters	Supported parameters for a Custom Multi Classification task.
CustomSingleLabelClassificationLROTask	Use custom models to classify text into single label taxonomy
CustomSingleLabelClassificationTaskParameters	Supported parameters for a Custom Single Classification task.
EntitiesLROTask	An object representing the task definition for an Entities Recognition task.
EntitiesTaskParameters	Supported parameters for an Entity Recognition task.
EntityCategory	Contains all the entity categories detected by entity recognition.
EntityInferenceOptions	The class that houses the inference options allowed for named entity recognition.
EntityLinkingLROTask	Contains the analyze text Entity linking LRO task.
EntityLinkingTaskParameters	Supported parameters for an Entity Linking task.
Error	The error response object returned when the service encounters some errors during processing the request.
ErrorCode	Human-readable error code.
ErrorResponse	Error response.
ExtractiveSummarizationLROTask	An object representing the task definition for an Extractive Summarization task.
ExtractiveSummarizationSortingCriteria	Specifies how to sort the extracted summaries.
ExtractiveSummarizationTaskParameters	Supported parameters for an Extractive Summarization task.
fhirVersion	The FHIR Spec version.
healthcareDocumentType	Document type.
HealthcareLROTask	The long running task to be performed by the service on the Healthcare input documents.
HealthcareTaskParameters	Supported parameters for a Healthcare task.
InnerErrorCode	Human-readable error code.
InnerErrorModel	An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
KeyPhraseLROTask	An object representing the task definition for a Key Phrase Extraction task.
KeyPhraseTaskParameters	Supported parameters for a Key Phrase Extraction task.
MatchLongestEntityPolicyType	Represents the Match longest overlap policy. No overlapping entities as far as it is possible. 1. If there are overlapping entities, the longest one will be returned. 2. If the set of characters predicted for 2 or more entities are exactly the same, select the entity that has the higher confidence score.3. If the entity scores are identical, return all entities that are still present after applying the previous rules. 3. If there is partial overlap (as in Hello Text Analytics) follow the above steps starting from 1.
MultiLanguageAnalysisInput	Collection of input documents to be analyzed by the service.
MultiLanguageInput	Contains an input document to be analyzed by the service.
PiiCategory	(Optional) describes the PII categories to return
PiiDomain	Domain for PII task
PiiLROTask	Contains the analyze text PIIEntityRecognition LRO task.
PiiTaskParameters	Supported parameters for a PII Entities Recognition task.
SentimentAnalysisLROTask	An object representing the task definition for a Sentiment Analysis task.
SentimentAnalysisTaskParameters	Supported parameters for a Sentiment Analysis task.
StringIndexType	String index type
SummaryLengthBucket	Enum that defines the length of the output summaries.

AbstractiveSummarizationLROTask

Object

An object representing the task definition for an Abstractive Summarization task.

Name	Type	Description
kind	string: AbstractiveSummarization	The kind of task to perform.
parameters	AbstractiveSummarizationTaskParameters	Parameters for the Abstractive Summarization task.
taskName	string	task name

AbstractiveSummarizationTaskParameters

Object

Supported parameters for the pre-built Abstractive Summarization task.

Name	Type	Default value	Description
loggingOptOut	boolean	False	logging opt out
modelVersion	string	latest	model version
sentenceCount	integer (int32)		Controls the approximate number of sentences in the output summaries.
stringIndexType	StringIndexType	TextElements_v8	String index type
summaryLength	SummaryLengthBucket		(NOTE: Recommended to use summaryLength over sentenceCount) Controls the approximate length of the output summaries.

AllowOverlapEntityPolicyType

Object

Represents the allow overlap policy. Will apply no post processing logic for the entities. Whatever the model predicts is what will be returned to the user. This allows the user to get a full view of every single model's possible values and apply their own custom logic on entity selection

Name	Type	Default value	Description
policyKind	string: allowOverlap	matchLongest	The entity OverlapPolicy object kind.

AnalyzeTextJobsInput

Object

The input object for the analyze text LRO.

Name	Type	Description
analysisInput	MultiLanguageAnalysisInput	Contains the input to be analyzed.
displayName	string	Name for the task.
tasks	AnalyzeTextLROTask[]: AbstractiveSummarizationLROTask[] CustomEntitiesLROTask[] CustomMultiLabelClassificationLROTask[] CustomSingleLabelClassificationLROTask[] EntitiesLROTask[] EntityLinkingLROTask[] ExtractiveSummarizationLROTask[] HealthcareLROTask[] KeyPhraseLROTask[] PiiLROTask[] SentimentAnalysisLROTask[]	List of tasks to be performed as part of the LRO.

AnalyzeTextLROTaskKind

Enumeration

The kind of the long running analyze text tasks supported.

Value	Description
SentimentAnalysis	Sentiment analysis task
EntityRecognition	Entity recognition task
PiiEntityRecognition	PII entity recognition task
KeyPhraseExtraction	Key phrase extraction task
EntityLinking	Entity linking task
Healthcare	Healthcare task
CustomEntityRecognition	Custom entity recognition task
CustomSingleLabelClassification	Custom single label classification task
CustomMultiLabelClassification	Custom multi label classification task
ExtractiveSummarization	Extractive summarization task
AbstractiveSummarization	Abstractive summarization task

CustomEntitiesLROTask

Object

Contains the custom text LRO task.

Name	Type	Description
kind	string: CustomEntityRecognition	The kind of task to perform.
parameters	CustomEntitiesTaskParameters	task parameters.
taskName	string	task name

CustomEntitiesTaskParameters

Object

Supported parameters for a Custom Entities task.

Name	Type	Default value	Description
deploymentName	string		This field indicates the deployment name for the model.
loggingOptOut	boolean	False	logging opt out
projectName	string		This field indicates the project name for the model.
stringIndexType	StringIndexType	TextElements_v8	Optional parameter to provide the string index type used to interpret string offsets. Defaults to TextElements (Graphemes).

CustomMultiLabelClassificationLROTask

Object

Use custom models to classify text into multi label taxonomy

Name	Type	Description
kind	string: CustomMultiLabelClassification	The kind of task to perform.
parameters	CustomMultiLabelClassificationTaskParameters	Task parameters.
taskName	string	task name

CustomMultiLabelClassificationTaskParameters

Object

Supported parameters for a Custom Multi Classification task.

Name	Type	Default value	Description
deploymentName	string		This field indicates the deployment name for the model.
loggingOptOut	boolean	False	logging opt out
projectName	string		This field indicates the project name for the model.

CustomSingleLabelClassificationLROTask

Object

Use custom models to classify text into single label taxonomy

Name	Type	Description
kind	string: CustomSingleLabelClassification	The kind of task to perform.
parameters	CustomSingleLabelClassificationTaskParameters	Task parameters
taskName	string	task name

CustomSingleLabelClassificationTaskParameters

Object

Supported parameters for a Custom Single Classification task.

Name	Type	Default value	Description
deploymentName	string		This field indicates the deployment name for the model.
loggingOptOut	boolean	False	logging opt out
projectName	string		This field indicates the project name for the model.

EntitiesLROTask

Object

An object representing the task definition for an Entities Recognition task.

Name	Type	Description
kind	string: EntityRecognition	The kind of task to perform.
parameters	EntitiesTaskParameters	Task parameters.
taskName	string	task name

EntitiesTaskParameters

Object

Supported parameters for an Entity Recognition task.

Name	Type	Default value	Description
exclusionList	EntityCategory[]		(Optional) request parameter that filters out any entities that are included the excludeList. When a user specifies an excludeList, they cannot get a prediction returned with an entity in that list. We will apply inclusionList before exclusionList
inclusionList	EntityCategory[]		(Optional) request parameter that limits the output to the requested entity types included in this list. We will apply inclusionList before exclusionList
inferenceOptions	EntityInferenceOptions		(Optional) request parameter that allows the user to provide settings for running the inference.
loggingOptOut	boolean	False	logging opt out
modelVersion	string	latest	model version
overlapPolicy	BaseEntityOverlapPolicy: AllowOverlapEntityPolicyType MatchLongestEntityPolicyType		(Optional) describes the type of overlap policy to apply to the ner output.
stringIndexType	StringIndexType	TextElements_v8	(Optional) parameter to provide the string index type used to interpret string offsets. Defaults to TextElements (Graphemes).

EntityCategory

Enumeration

Contains all the entity categories detected by entity recognition.

Value	Description
Address	Specific street-level mentions of locations: house/building numbers, streets, avenues, highways, intersections referenced by name.
Numeric	Numeric values, including digits and number words.
Age	Age-related values.
Currency	Currency-related values.
Number	Numbers without a unit
NumberRange	Range of Numbers
Percentage	Percentage-related values.
Ordinal	Ordinal numbers.
Temperature	Temperature-related values.
Dimension	Dimension of measurements
Length	Length of an object.
Weight	Weight of an object.
Height	Height of an object.
Speed	Speed of an object.
Area	Area of an object.
Volume	Volume of an object.
Information	Unit of measure for digital information.
Temporal	Items relating to time.
Date	Calendar dates.
Time	Times of day.
DateTime	Calendar dates with time.
DateRange	Range of dates.
TimeRange	Range of times.
DateTimeRange	Range of date and time.
Duration	Duration of time.
SetTemporal	Set of time-related values.
Event	Social, sports, business, political, educational, natural, historical, criminal, violent, legal, military events with a timed period.
SportsEvent	Sports event-related values.
CulturalEvent	Cultural event-related values.
NaturalEvent	Natural event-related values.
Location	Particular point or place in physical space.
GPE	Cities, countries/regions, states.
City	City-related values.
State	State-related values.
CountryRegion	Country or region-related values.
Continent	Continent-related values.
Structural	Manmade structures.
Airport	Airports.
Geological	Geographic and natural features such as rivers, oceans, and deserts.
Organization	Corporations, agencies, and other groups of people defined by some established organizational structure. These labels can include companies, political parties/movements, musical bands, sport clubs, government bodies, and public organizations. Nationalities or religions are not ORGANIZATION.
OrganizationMedical	Medical companies and groups.
OrganizationStockExchange	Stock exchange groups.
OrganizationSports	Sports-related organizations.
Person	First, last, and middle names, names of fictional characters, and aliases. Titles, such as 'Mr.' or 'President', are not considered part of the named entity.
PersonType	Human roles classified by a group membership.
Email	Email addresses.
URL	URLs to websites.
IP	network IP addresses.
PhoneNumber	Phone numbers (US and EU phone numbers only).
Product	Single or group of commercial, consumable objects, electronics, vehicles, food groups.
ComputingProduct	Computing products.
Skill	A capability, skill, or expertise.

EntityInferenceOptions

Object

The class that houses the inference options allowed for named entity recognition.

Name	Type	Default value	Description
excludeNormalizedValues	boolean	False	Option to include/exclude the detected entity values to be normalized and included in the metadata. The numeric and temporal entity types support value normalization.

EntityLinkingLROTask

Object

Contains the analyze text Entity linking LRO task.

Name	Type	Description
kind	string: EntityLinking	The kind of task to perform.
parameters	EntityLinkingTaskParameters	Task parameters.
taskName	string	task name

EntityLinkingTaskParameters

Object

Supported parameters for an Entity Linking task.

Name	Type	Default value	Description
loggingOptOut	boolean	False	logging opt out
modelVersion	string	latest	model version
stringIndexType	StringIndexType	TextElements_v8	Optional parameter to provide the string index type used to interpret string offsets. Defaults to TextElements (Graphemes).

Error

Object

The error response object returned when the service encounters some errors during processing the request.

Name	Type	Description
code	ErrorCode	One of a server-defined set of error codes.
details	Error[]	An array of details about specific errors that led to this reported error.
innererror	InnerErrorModel	An object containing more specific information than the current object about the error.
message	string	A human-readable representation of the error.
target	string	The target of the error.

ErrorCode

Enumeration

Human-readable error code.

Value	Description
InvalidRequest	Invalid request error
InvalidArgument	Invalid argument error
Unauthorized	Unauthorized access error
Forbidden	Forbidden access error
NotFound	Not found error
ProjectNotFound	Project not found error
OperationNotFound	Operation not found error
AzureCognitiveSearchNotFound	Azure Cognitive Search not found error
AzureCognitiveSearchIndexNotFound	Azure Cognitive Search index not found error
TooManyRequests	Too many requests error
AzureCognitiveSearchThrottling	Azure Cognitive Search throttling error
AzureCognitiveSearchIndexLimitReached	Azure Cognitive Search index limit reached error
InternalServerError	Internal server error
ServiceUnavailable	Service unavailable error
Timeout	Timeout error
QuotaExceeded	Quota exceeded error
Conflict	Conflict error
Warning	Warning error

ErrorResponse

Object

Error response.

Name	Type	Description
error	Error	The error object.

ExtractiveSummarizationLROTask

Object

An object representing the task definition for an Extractive Summarization task.

Name	Type	Description
kind	string: ExtractiveSummarization	The kind of task to perform.
parameters	ExtractiveSummarizationTaskParameters	Parameters for the Extractive Summarization task.
taskName	string	task name

ExtractiveSummarizationSortingCriteria

Enumeration

Specifies how to sort the extracted summaries.

Value	Description
Offset	Indicates that results should be sorted in order of appearance in the text.
Rank	Indicates that results should be sorted in order of importance (i.e. rank score) according to the model.

ExtractiveSummarizationTaskParameters

Object

Supported parameters for an Extractive Summarization task.

Name	Type	Default value	Description
loggingOptOut	boolean	False	logging opt out
modelVersion	string	latest	model version
sentenceCount	integer (int64)	3	Specifies the number of sentences in the extracted summary.
sortBy	ExtractiveSummarizationSortingCriteria	Offset	Specifies how to sort the extracted summaries.
stringIndexType	StringIndexType	TextElements_v8	Specifies the method used to interpret string offsets.

fhirVersion

Enumeration

The FHIR Spec version.

Value	Description
4.0.1	Version 4.0.1

healthcareDocumentType

Enumeration

Document type.

Value	Description
None	None document type
ClinicalTrial	Clinical trial document type
DischargeSummary	Discharge summary document type
ProgressNote	Progress note document type
HistoryAndPhysical	History and physical document type
Consult	Consult document type
Imaging	Imaging document type
Pathology	Pathology document type
ProcedureNote	Procedure note document type

HealthcareLROTask

Object

The long running task to be performed by the service on the Healthcare input documents.

Name	Type	Description
kind	string: Healthcare	The kind of task to perform.
parameters	HealthcareTaskParameters	Parameters for the Healthcare task.
taskName	string	task name

HealthcareTaskParameters

Object

Supported parameters for a Healthcare task.

Name	Type	Default value	Description
documentType	healthcareDocumentType		Document type that can be provided as input for Fhir Documents. Expect to have fhirVersion provided when used. Behavior of using None enum is the same as not using the documentType parameter.
fhirVersion	fhirVersion		The FHIR Spec version that the result will use to format the fhirBundle. For additional information see https://www.hl7.org/fhir/overview.html.
loggingOptOut	boolean	False	logging opt out
modelVersion	string	latest	model version
stringIndexType	StringIndexType	TextElements_v8	Specifies the method used to interpret string offsets.

InnerErrorCode

Enumeration

Human-readable error code.

Value	Description
InvalidRequest	Invalid request error
InvalidParameterValue	Invalid parameter value error
KnowledgeBaseNotFound	Knowledge base not found error
AzureCognitiveSearchNotFound	Azure Cognitive Search not found error
AzureCognitiveSearchThrottling	Azure Cognitive Search throttling error
ExtractionFailure	Extraction failure error
InvalidRequestBodyFormat	Invalid request body format error
EmptyRequest	Empty request error
MissingInputDocuments	Missing input documents error
InvalidDocument	Invalid document error
ModelVersionIncorrect	Model version incorrect error
InvalidDocumentBatch	Invalid document batch error
UnsupportedLanguageCode	Unsupported language code error
InvalidCountryHint	Invalid country hint error

InnerErrorModel

Object

An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Type	Description
code	InnerErrorCode	One of a server-defined set of error codes.
details	object	Error details.
innererror	InnerErrorModel	An object containing more specific information than the current object about the error.
message	string	Error message.
target	string	Error target.

KeyPhraseLROTask

Object

An object representing the task definition for a Key Phrase Extraction task.

Name	Type	Description
kind	string: KeyPhraseExtraction	The kind of task to perform.
parameters	KeyPhraseTaskParameters	Key phrase extraction task parameters.
taskName	string	task name

KeyPhraseTaskParameters

Object

Supported parameters for a Key Phrase Extraction task.

Name	Type	Default value	Description
loggingOptOut	boolean	False	logging opt out
modelVersion	string	latest	model version

MatchLongestEntityPolicyType

Object

Represents the Match longest overlap policy. No overlapping entities as far as it is possible. 1. If there are overlapping entities, the longest one will be returned. 2. If the set of characters predicted for 2 or more entities are exactly the same, select the entity that has the higher confidence score.3. If the entity scores are identical, return all entities that are still present after applying the previous rules. 3. If there is partial overlap (as in Hello Text Analytics) follow the above steps starting from 1.

Name	Type	Default value	Description
policyKind	string: matchLongest	matchLongest	The entity OverlapPolicy object kind.

MultiLanguageAnalysisInput

Object

Collection of input documents to be analyzed by the service.

Name	Type	Description
documents	MultiLanguageInput[]	The input documents to be analyzed.

MultiLanguageInput

Object

Contains an input document to be analyzed by the service.

Name	Type	Description
id	string	A unique, non-empty document identifier.
language	string	(Optional) This is the 2 letter ISO 639-1 representation of a language. For example, use "en" for English; "es" for Spanish etc. If not set, use "en" for English as default. (Following only applies to 2023-04-15-preview and above) For Auto Language Detection, use "auto". If not set, use "en" for English as default.
text	string	The input text to process.

PiiCategory

Enumeration

(Optional) describes the PII categories to return

Value	Description
ABARoutingNumber	ABA Routing number
ARNationalIdentityNumber	AR National Identity Number
AUBankAccountNumber	AT Bank Account Number
AUDriversLicenseNumber	AU Driver's License Number
AUMedicalAccountNumber	AU Medical Account Number
AUPassportNumber	AU Passport Number
AUTaxFileNumber	AU Tax File Number
AUBusinessNumber	AU Business Number
AUCompanyNumber	AU Company Number
ATIdentityCard	AT Identity Card
ATTaxIdentificationNumber	AT Tax Identification Number
ATValueAddedTaxNumber	AT Value Added Tax Number
AzureDocumentDBAuthKey	Azure Document DB Auth Key
AzureIAASDatabaseConnectionAndSQLString	Azure IAAS Database Connection And SQL String
AzureIoTConnectionString	Azure IoT Connection String
AzurePublishSettingPassword	Azure Publish Setting Password
AzureRedisCacheString	Azure Redis Cache String
AzureSAS	Azure SAS
AzureServiceBusString	Azure Service Bus String
AzureStorageAccountKey	Azure Storage Account Key
AzureStorageAccountGeneric	Azure Storage Account Generic
BENationalNumber	BE National Number
BENationalNumberV2	BE National Number V2
BEValueAddedTaxNumber	BE Value Added Tax Number
BRCPFNumber	BR CPF Number
BRLegalEntityNumber	BR Legal Entity Number
BRNationalIDRG	BR National ID RG
BGUniformCivilNumber	BG Uniform Civil Number
CABankAccountNumber	CA Bank Account Number
CADriversLicenseNumber	CA Driver's License Number
CAHealthServiceNumber	CA Health Service Number
CAPassportNumber	CA Passport Number
CAPersonalHealthIdentification	CA Personal Health Identification
CASocialInsuranceNumber	CA Social Insurance Number
CLIdentityCardNumber	CL Identity Card Number
CNResidentIdentityCardNumber	CN Resident Identity Card Number
CreditCardNumber	Credit Card Number
HRIdentityCardNumber	HR Identity Card Number
HRNationalIDNumber	HR National ID Number
HRPersonalIdentificationNumber	HR Personal Identification Number
HRPersonalIdentificationOIBNumberV2	HR Personal Identification OIB Number V2
CYIdentityCard	CY Identity Card
CYTaxIdentificationNumber	CY Tax Identification Number
CZPersonalIdentityNumber	CZ Personal Identity Number
CZPersonalIdentityV2	CZ Personal Identity V2
DKPersonalIdentificationNumber	DK Personal Identification Number
DKPersonalIdentificationV2	DK Personal Identification V2
DrugEnforcementAgencyNumber	Drug Enforcement Agency Number
EEPersonalIdentificationCode	EE Personal Identification Code
EUDebitCardNumber	EU Debit Card Number
EUDriversLicenseNumber	EU Driver's License Number
EUGPSCoordinates	EU GPS Coordinates
EUNationalIdentificationNumber	EU National Identification Number
EUPassportNumber	EU Passport Number
EUSocialSecurityNumber	EU Social Security Number
EUTaxIdentificationNumber	EU Tax Identification Number
FIEuropeanHealthNumber	FI European Health Number
FINationalID	FI National ID
FINationalIDV2	FI National ID V2
FIPassportNumber	FI Passport Number
FRDriversLicenseNumber	FR Driver's License Number
FRHealthInsuranceNumber	FR Health Insurance Number
FRNationalID	FR National ID
FRPassportNumber	FR Passport Number
FRSocialSecurityNumber	FR Social Security Number
FRTaxIdentificationNumber	FR Tax Identification Number
FRValueAddedTaxNumber	FR Value Added Tax Number
DEDriversLicenseNumber	DE Driver's License Number
DEPassportNumber	DE Passport Number
DEIdentityCardNumber	DE Identity Card Number
DETaxIdentificationNumber	DE Tax Identification Number
DEValueAddedNumber	DE Value Added Number
GRNationalIDCard	GR National ID Card
GRNationalIDV2	GR National ID V2
GRTaxIdentificationNumber	GR Tax Identification Number
HKIdentityCardNumber	HK Identity Card Number
HUValueAddedNumber	HU Value Added Number
HUPersonalIdentificationNumber	HU Personal Identification Number
HUTaxIdentificationNumber	HU Tax Identification Number
INPermanentAccount	IN Permanent Account
INUniqueIdentificationNumber	IN Unique Identification Number
IDIdentityCardNumber	ID Identity Card Number
InternationalBankingAccountNumber	International Banking Account Number
IEPersonalPublicServiceNumber	IE Personal Public Service Number
IEPersonalPublicServiceNumberV2	IE Personal Public Service Number V2
ILBankAccountNumber	IL Bank Account Number
ILNationalID	IL National ID
ITDriversLicenseNumber	IT Driver's License Number
ITFiscalCode	IT Fiscal Code
ITValueAddedTaxNumber	IT Value Added Tax Number
JPBankAccountNumber	JP Bank Account Number
JPDriversLicenseNumber	JP Driver's License Number
JPPassportNumber	JP Passport Number
JPResidentRegistrationNumber	JP Resident Registration Number
JPSocialInsuranceNumber	JP Social Insurance Number
JPMyNumberCorporate	JP My Number Corporate
JPMyNumberPersonal	JP My Number Personal
JPResidenceCardNumber	JP Residence Card Number
LVPersonalCode	LV Personal Code
LTPersonalCode	LT Personal Code
LUNationalIdentificationNumberNatural	LU National Identification Number Natural
LUNationalIdentificationNumberNonNatural	LU National Identification Number Non Natural
MYIdentityCardNumber	MY Identity Card Number
MTIdentityCardNumber	MT Identity Card Number
MTTaxIDNumber	MT Tax ID Number
NLCitizensServiceNumber	NL Citizens Service Number
NLCitizensServiceNumberV2	NL Citizens Service Number V2
NLTaxIdentificationNumber	NL Tax Identification Number
NLValueAddedTaxNumber	NL Value Added Tax Number
NZBankAccountNumber	NZ Bank Account Number
NZDriversLicenseNumber	NZ Driver's License Number
NZInlandRevenueNumber	NZ Inland Revenue Number
NZMinistryOfHealthNumber	NZ Ministry Of Health Number
NZSocialWelfareNumber	NZ Social Welfare Number
NOIdentityNumber	NO Identity Number
PHUnifiedMultiPurposeIDNumber	PH Unified Multi Purpose ID Number
PLIdentityCard	PL Identity Card
PLNationalID	PL National ID
PLNationalIDV2	PL National ID V2
PLPassportNumber	PL Passport Number
PLTaxIdentificationNumber	PL Tax Identification Number
PLREGONNumber	PL REGON Number
PTCitizenCardNumber	PT Citizen Card Number
PTCitizenCardNumberV2	PT Citizen Card Number V2
PTTaxIdentificationNumber	PT Tax Identification Number
ROPersonalNumericalCode	RO Personal Numerical Code
RUPassportNumberDomestic	RU Passport Number Domestic
RUPassportNumberInternational	RU Passport Number International
SANationalID	SA National ID
SGNationalRegistrationIdentityCardNumber	SG National Registration Identity Card Number
SKPersonalNumber	SK Personal Number
SITaxIdentificationNumber	SI Tax Identification Number
SIUniqueMasterCitizenNumber	SI Unique Master Citizen Number
ZAIdentificationNumber	ZA Identification Number
KRResidentRegistrationNumber	KR Resident Registration Number
ESDNI	ES DNI
ESSocialSecurityNumber	ES Social Security Number
ESTaxIdentificationNumber	ES Tax Identification Number
SQLServerConnectionString	SQL Server Connection String
SENationalID	SE National ID
SENationalIDV2	SE National ID V2
SEPassportNumber	SE Passport Number
SETaxIdentificationNumber	SE Tax Identification Number
SWIFTCode	SWIFT Code
CHSocialSecurityNumber	CH Social Security Number
TWNationalID	TW National ID
TWPassportNumber	TW Passport Number
TWResidentCertificate	TW Resident Certificate
THPopulationIdentificationCode	TH Population Identification Code
TRNationalIdentificationNumber	TR National Identification Number
UKDriversLicenseNumber	UK Driver's License Number
UKElectoralRollNumber	UK Electoral Roll Number
UKNationalHealthNumber	UK National Health Number
UKNationalInsuranceNumber	UK National Insurance Number
UKUniqueTaxpayerNumber	UK Unique Taxpayer Number
USUKPassportNumber	US UK Passport Number
USBankAccountNumber	US Bank Account Number
USDriversLicenseNumber	US Driver's License Number
USIndividualTaxpayerIdentification	US Individual Taxpayer Identification
USSocialSecurityNumber	US Social Security Number
UAPassportNumberDomestic	UA Passport Number Domestic
UAPassportNumberInternational	UA Passport Number International
Organization	Organization
Email	Email
URL	URL
Age	Age
PhoneNumber	Phone Number
IPAddress	IP Address
Date	Date
Person	Person
Address	Address
All	All PII categories.
Default	Default PII categories for the language.

PiiDomain

Enumeration

Domain for PII task

Value	Description
phi	Indicates that entities in the Personal Health Information domain should be redacted.
none	Indicates that no domain is specified.

PiiLROTask

Object

Contains the analyze text PIIEntityRecognition LRO task.

Name	Type	Description
kind	string: PiiEntityRecognition	The kind of task to perform.
parameters	PiiTaskParameters	Pii task parameters.
taskName	string	task name

PiiTaskParameters

Object

Supported parameters for a PII Entities Recognition task.

Name	Type	Default value	Description
domain	PiiDomain	none	Domain for PII task
loggingOptOut	boolean	True	logging opt out
modelVersion	string	latest	model version
piiCategories	PiiCategory[]		Enumeration of PII categories to be returned in the response.
stringIndexType	StringIndexType	TextElements_v8	StringIndexType to be used for analysis.

SentimentAnalysisLROTask

Object

An object representing the task definition for a Sentiment Analysis task.

Name	Type	Description
kind	string: SentimentAnalysis	The kind of task to perform.
parameters	SentimentAnalysisTaskParameters	Parameters for the Sentiment Analysis task.
taskName	string	task name

SentimentAnalysisTaskParameters

Object

Supported parameters for a Sentiment Analysis task.

Name	Type	Default value	Description
loggingOptOut	boolean	False	logging opt out
modelVersion	string	latest	model version
opinionMining	boolean	False	Whether to use opinion mining in the request or not.
stringIndexType	StringIndexType	TextElements_v8	Specifies the method used to interpret string offsets.

StringIndexType

Enumeration

String index type

Value	Description
TextElements_v8	Returned offset and length values will correspond to TextElements (Graphemes and Grapheme clusters) confirming to the Unicode 8.0.0 standard. Use this option if your application is written in .Net Framework or .Net Core and you will be using StringInfo.
UnicodeCodePoint	Returned offset and length values will correspond to Unicode code points. Use this option if your application is written in a language that support Unicode, for example Python.
Utf16CodeUnit	Returned offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript.

SummaryLengthBucket

Enumeration

Enum that defines the length of the output summaries.

Value	Description
short	Instructs model to generate shorter length summaries.
medium	Instructs model to generate medium length summaries.
long	Instructs model to generate longer length summaries.

Share via

Analyze Text Submit Job - Analyze Text Submit Job

URI Parameters

Request Body

Responses

Security

Ocp-Apim-Subscription-Key

OAuth2Auth

Scopes

Examples

SuccessfulAbstractiveSummarizationSummaryLengthTaskSubmit

Sample request

Sample response

SuccessfulAbstractiveSummarizationTaskSubmit

Sample request

Sample response

SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest

Sample request

Sample response

SuccessfulHealthcareDocumentTypePostRequest

Sample request

Sample response

SuccessfulHealthcarePostRequest

Sample request

Sample response

Definitions

AbstractiveSummarizationLROTask

AbstractiveSummarizationTaskParameters

AllowOverlapEntityPolicyType

AnalyzeTextJobsInput

AnalyzeTextLROTaskKind

CustomEntitiesLROTask

CustomEntitiesTaskParameters

CustomMultiLabelClassificationLROTask

CustomMultiLabelClassificationTaskParameters

CustomSingleLabelClassificationLROTask

CustomSingleLabelClassificationTaskParameters

EntitiesLROTask

EntitiesTaskParameters

EntityCategory

EntityInferenceOptions

EntityLinkingLROTask

EntityLinkingTaskParameters

Error

ErrorCode

ErrorResponse

ExtractiveSummarizationLROTask

ExtractiveSummarizationSortingCriteria

ExtractiveSummarizationTaskParameters

fhirVersion

healthcareDocumentType

HealthcareLROTask

HealthcareTaskParameters

InnerErrorCode

InnerErrorModel

KeyPhraseLROTask

KeyPhraseTaskParameters

MatchLongestEntityPolicyType

MultiLanguageAnalysisInput

MultiLanguageInput

PiiCategory

PiiDomain

PiiLROTask

PiiTaskParameters

SentimentAnalysisLROTask

SentimentAnalysisTaskParameters

StringIndexType

SummaryLengthBucket