{
"swagger": "2.0",
"info": {
"title": "Microsoft Cognitive Language Service - Text Analysis",
"version": "2022-05-01",
"description": "The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. Further documentation can be found in https://learn.microsoft.com/azure/cognitive-services/language-service/overview.0",
"x-typespec-generated": [
{
"emitter": "@azure-tools/typespec-autorest"
}
]
},
"schemes": [
"https"
],
"x-ms-parameterized-host": {
"hostTemplate": "{Endpoint}/language",
"useSchemePrefix": false,
"parameters": [
{
"name": "Endpoint",
"in": "path",
"description": "Supported Cognitive Services endpoint (e.g., https://.api.cognitiveservices.azure.com).",
"required": true,
"type": "string",
"format": "uri",
"x-ms-skip-url-encoding": true
}
]
},
"produces": [
"application/json"
],
"consumes": [
"application/json"
],
"security": [
{
"ApiKeyAuth": []
},
{
"OAuth2Auth": [
"https://cognitiveservices.azure.com/.default"
]
}
],
"securityDefinitions": {
"ApiKeyAuth": {
"type": "apiKey",
"name": "Ocp-Apim-Subscription-Key",
"in": "header"
},
"OAuth2Auth": {
"type": "oauth2",
"flow": "accessCode",
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
"scopes": {
"https://cognitiveservices.azure.com/.default": ""
},
"tokenUrl": "https://login.microsoftonline.com/common/oauth2/token"
}
},
"tags": [],
"paths": {
"/:analyze-text": {
"post": {
"operationId": "AnalyzeText",
"description": "Request text analysis over a collection of documents.",
"parameters": [
{
"$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
},
{
"name": "showStats",
"in": "query",
"description": "(Optional) if set to true, response will contain request and document level statistics.",
"required": false,
"type": "boolean"
},
{
"name": "body",
"in": "body",
"description": "The input documents to analyze.",
"required": true,
"schema": {
"$ref": "#/definitions/AnalyzeTextTask"
}
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/AnalyzeTextTaskResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
},
"headers": {
"x-ms-error-code": {
"type": "string",
"description": "String error code indicating what went wrong."
}
}
}
},
"x-ms-examples": {
"SuccessfulEntityLinkingRequest": {
"$ref": "./examples/SuccessfulEntityLinkingRequest.json"
},
"SuccessfulEntityRecognitionRequest": {
"$ref": "./examples/SuccessfulEntityRecognitionRequest.json"
},
"SuccessfulKeyPhraseExtractionRequest": {
"$ref": "./examples/SuccessfulKeyPhraseExtractionRequest.json"
},
"SuccessfulLanguageDetectionRequest": {
"$ref": "./examples/SuccessfulLanguageDetectionRequest.json"
},
"SuccessfulPiiEntityRecognitionRequest": {
"$ref": "./examples/SuccessfulPiiEntityRecognitionRequest.json"
},
"SuccessfulSentimentAnalysisRequest": {
"$ref": "./examples/SuccessfulSentimentAnalysisRequest.json"
}
}
}
},
"/analyze-text/jobs": {
"post": {
"operationId": "AnalyzeTextSubmitJob",
"description": "Submit a collection of text documents for analysis. Specify one or more unique tasks to be executed as a long-running operation.",
"parameters": [
{
"$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/AnalyzeTextJobsInput"
}
}
],
"responses": {
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"headers": {
"Operation-Location": {
"type": "string",
"format": "uri",
"description": "The location for monitoring the operation state."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
},
"headers": {
"x-ms-error-code": {
"type": "string",
"description": "String error code indicating what went wrong."
}
}
}
},
"x-ms-examples": {
"SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest": {
"$ref": "./examples/SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest.json"
}
},
"x-ms-long-running-operation": true
}
},
"/analyze-text/jobs/{jobId}": {
"get": {
"operationId": "AnalyzeTextJobStatus",
"summary": "Get analysis status and results",
"description": "Get the status of an analysis job. A job can consist of one or more tasks. After all tasks succeed, the job transitions to the succeeded state and results are available for each task.",
"parameters": [
{
"$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
},
{
"name": "jobId",
"in": "path",
"description": "job ID",
"required": true,
"type": "string",
"format": "uuid"
},
{
"name": "showStats",
"in": "query",
"description": "(Optional) if set to true, response will contain request and document level statistics.",
"required": false,
"type": "boolean"
},
{
"name": "top",
"in": "query",
"description": "The maximum number of resources to return from the collection.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "skip",
"in": "query",
"description": "An offset into the collection of the first resource to be returned.",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/AnalyzeTextJobState"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
},
"headers": {
"x-ms-error-code": {
"type": "string",
"description": "String error code indicating what went wrong."
}
}
}
},
"x-ms-examples": {
"SuccessfulAnalyzeTextJobsMultipleTaskStatusRequest": {
"$ref": "./examples/SuccessfulAnalyzeTextJobsMultipleTaskStatusRequest.json"
}
}
}
},
"/analyze-text/jobs/{jobId}:cancel": {
"post": {
"operationId": "AnalyzeTextCancelJob",
"summary": "Cancel a long-running Text Analysis job.",
"description": "Cancel a long-running Text Analysis job.",
"parameters": [
{
"$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
},
{
"name": "jobId",
"in": "path",
"description": "The job ID to cancel.",
"required": true,
"type": "string",
"format": "uuid"
}
],
"responses": {
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"headers": {
"Operation-Location": {
"type": "string",
"format": "uri",
"description": "The location for monitoring the operation state."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
},
"headers": {
"x-ms-error-code": {
"type": "string",
"description": "String error code indicating what went wrong."
}
}
}
},
"x-ms-examples": {
"SuccessfulAnalyzeTextJobsCancelRequest": {
"$ref": "./examples/SuccessfulAnalyzeTextJobsCancelRequest.json"
}
},
"x-ms-long-running-operation": true
}
}
},
"definitions": {
"AnalyzeTextEntityLinkingInput": {
"type": "object",
"description": "Contains the analyze text Entity linking input.",
"properties": {
"analysisInput": {
"$ref": "#/definitions/MultiLanguageAnalysisInput",
"description": "Contains the analysis input to be handled by the service."
},
"parameters": {
"$ref": "#/definitions/EntityLinkingTaskParameters",
"description": "Task parameters."
}
},
"allOf": [
{
"$ref": "#/definitions/AnalyzeTextTask"
}
],
"x-ms-discriminator-value": "EntityLinking"
},
"AnalyzeTextEntityRecognitionInput": {
"type": "object",
"description": "The entity recognition analyze text input task request.",
"properties": {
"analysisInput": {
"$ref": "#/definitions/MultiLanguageAnalysisInput",
"description": "The input to be analyzed."
},
"parameters": {
"$ref": "#/definitions/EntitiesTaskParameters",
"description": "Task parameters."
}
},
"allOf": [
{
"$ref": "#/definitions/AnalyzeTextTask"
}
],
"x-ms-discriminator-value": "EntityRecognition"
},
"AnalyzeTextJobState": {
"type": "object",
"description": "The object containing the analyze job LRO job state.",
"properties": {
"displayName": {
"type": "string",
"description": "display name"
},
"createdDateTime": {
"type": "string",
"format": "date-time",
"description": "Date and time job created"
},
"expirationDateTime": {
"type": "string",
"format": "date-time",
"description": "Date and time job expires"
},
"jobId": {
"$ref": "#/definitions/Azure.Core.uuid",
"description": "job ID",
"readOnly": true
},
"lastUpdatedDateTime": {
"type": "string",
"format": "date-time",
"description": "last updated date and time"
},
"status": {
"$ref": "#/definitions/State",
"description": "status"
},
"errors": {
"type": "array",
"description": "errors",
"items": {
"$ref": "#/definitions/Error"
}
},
"nextLink": {
"type": "string",
"description": "next link"
},
"tasks": {
"$ref": "#/definitions/Tasks",
"description": "List of tasks."
},
"statistics": {
"$ref": "#/definitions/RequestStatistics",
"description": "if showStats=true was specified in the request this field will contain information about the request payload."
}
},
"required": [
"createdDateTime",
"jobId",
"lastUpdatedDateTime",
"status",
"tasks"
]
},
"AnalyzeTextJobsInput": {
"type": "object",
"description": "The input object for the analyze text LRO.",
"properties": {
"displayName": {
"type": "string",
"description": "Name for the task."
},
"analysisInput": {
"$ref": "#/definitions/MultiLanguageAnalysisInput",
"description": "Contains the input to be analyzed."
},
"tasks": {
"type": "array",
"description": "List of tasks to be performed as part of the LRO.",
"items": {
"$ref": "#/definitions/AnalyzeTextLROTask"
}
}
},
"required": [
"analysisInput",
"tasks"
]
},
"AnalyzeTextKeyPhraseExtractionInput": {
"type": "object",
"description": "Contains the analyze text KeyPhraseExtraction task input.",
"properties": {
"analysisInput": {
"$ref": "#/definitions/MultiLanguageAnalysisInput",
"description": "Contains the input documents."
},
"parameters": {
"$ref": "#/definitions/KeyPhraseTaskParameters",
"description": "Key phrase extraction task parameters."
}
},
"allOf": [
{
"$ref": "#/definitions/AnalyzeTextTask"
}
],
"x-ms-discriminator-value": "KeyPhraseExtraction"
},
"AnalyzeTextLROResult": {
"type": "object",
"description": "Contains the AnalyzeText long running operation result object.",
"properties": {
"lastUpdateDateTime": {
"type": "string",
"format": "date-time",
"description": "The last updated time in UTC for the task."
},
"status": {
"$ref": "#/definitions/State",
"description": "The status of the task at the mentioned last update time."
},
"taskName": {
"type": "string",
"description": "task name"
},
"kind": {
"$ref": "#/definitions/AnalyzeTextLROResultsKind",
"description": "Kind of the task."
}
},
"discriminator": "kind",
"required": [
"lastUpdateDateTime",
"status",
"kind"
]
},
"AnalyzeTextLROResultsKind": {
"type": "string",
"description": "The kind of the response object returned by the analyze-text long running task.",
"enum": [
"SentimentAnalysisLROResults",
"EntityRecognitionLROResults",
"PiiEntityRecognitionLROResults",
"KeyPhraseExtractionLROResults",
"EntityLinkingLROResults",
"HealthcareLROResults",
"CustomEntityRecognitionLROResults",
"CustomSingleLabelClassificationLROResults",
"CustomMultiLabelClassificationLROResults"
],
"x-ms-enum": {
"name": "AnalyzeTextLROResultsKind",
"modelAsString": true,
"values": [
{
"name": "SentimentAnalysisLROResults",
"value": "SentimentAnalysisLROResults",
"description": "Sentiment analysis LRO results"
},
{
"name": "EntityRecognitionLROResults",
"value": "EntityRecognitionLROResults",
"description": "Entity recognition LRO results"
},
{
"name": "PiiEntityRecognitionLROResults",
"value": "PiiEntityRecognitionLROResults",
"description": "PII entity recognition LRO results"
},
{
"name": "KeyPhraseExtractionLROResults",
"value": "KeyPhraseExtractionLROResults",
"description": "Key phrase extraction LRO results"
},
{
"name": "EntityLinkingLROResults",
"value": "EntityLinkingLROResults",
"description": "Entity linking LRO results"
},
{
"name": "HealthcareLROResults",
"value": "HealthcareLROResults",
"description": "Healthcare LRO results"
},
{
"name": "CustomEntityRecognitionLROResults",
"value": "CustomEntityRecognitionLROResults",
"description": "Custom entity recognition LRO results"
},
{
"name": "CustomSingleLabelClassificationLROResults",
"value": "CustomSingleLabelClassificationLROResults",
"description": "Custom single label classification LRO results"
},
{
"name": "CustomMultiLabelClassificationLROResults",
"value": "CustomMultiLabelClassificationLROResults",
"description": "Custom multi label classification LRO results"
}
]
}
},
"AnalyzeTextLROTask": {
"type": "object",
"description": "The long running task to be performed by the service on the input documents.",
"properties": {
"taskName": {
"type": "string",
"description": "task name"
},
"kind": {
"$ref": "#/definitions/AnalyzeTextLROTaskKind",
"description": "The kind of task to perform."
}
},
"discriminator": "kind",
"required": [
"kind"
]
},
"AnalyzeTextLROTaskKind": {
"type": "string",
"description": "The kind of the long running analyze text tasks supported.",
"enum": [
"SentimentAnalysis",
"EntityRecognition",
"PiiEntityRecognition",
"KeyPhraseExtraction",
"EntityLinking",
"Healthcare",
"CustomEntityRecognition",
"CustomSingleLabelClassification",
"CustomMultiLabelClassification"
],
"x-ms-enum": {
"name": "AnalyzeTextLROTaskKind",
"modelAsString": true,
"values": [
{
"name": "SentimentAnalysis",
"value": "SentimentAnalysis",
"description": "Sentiment analysis task"
},
{
"name": "EntityRecognition",
"value": "EntityRecognition",
"description": "Entity recognition task"
},
{
"name": "PiiEntityRecognition",
"value": "PiiEntityRecognition",
"description": "PII entity recognition task"
},
{
"name": "KeyPhraseExtraction",
"value": "KeyPhraseExtraction",
"description": "Key phrase extraction task"
},
{
"name": "EntityLinking",
"value": "EntityLinking",
"description": "Entity linking task"
},
{
"name": "Healthcare",
"value": "Healthcare",
"description": "Healthcare task"
},
{
"name": "CustomEntityRecognition",
"value": "CustomEntityRecognition",
"description": "Custom entity recognition task"
},
{
"name": "CustomSingleLabelClassification",
"value": "CustomSingleLabelClassification",
"description": "Custom single label classification task"
},
{
"name": "CustomMultiLabelClassification",
"value": "CustomMultiLabelClassification",
"description": "Custom multi label classification task"
}
]
}
},
"AnalyzeTextLanguageDetectionInput": {
"type": "object",
"description": "Contains the language detection document analysis task input.",
"properties": {
"analysisInput": {
"$ref": "#/definitions/LanguageDetectionAnalysisInput",
"description": "Documents to be analyzed."
},
"parameters": {
"$ref": "#/definitions/LanguageDetectionTaskParameters",
"description": "task parameters."
}
},
"allOf": [
{
"$ref": "#/definitions/AnalyzeTextTask"
}
],
"x-ms-discriminator-value": "LanguageDetection"
},
"AnalyzeTextPiiEntitiesRecognitionInput": {
"type": "object",
"description": "Contains the analyze text PIIEntityRecognition task input.",
"properties": {
"analysisInput": {
"$ref": "#/definitions/MultiLanguageAnalysisInput",
"description": "Contains the input documents."
},
"parameters": {
"$ref": "#/definitions/PiiTaskParameters",
"description": "Pii task parameters."
}
},
"allOf": [
{
"$ref": "#/definitions/AnalyzeTextTask"
}
],
"x-ms-discriminator-value": "PiiEntityRecognition"
},
"AnalyzeTextSentimentAnalysisInput": {
"type": "object",
"description": "Contains the analyze text SentimentAnalysis task input.",
"properties": {
"analysisInput": {
"$ref": "#/definitions/MultiLanguageAnalysisInput",
"description": "Contains the input documents."
},
"parameters": {
"$ref": "#/definitions/SentimentAnalysisTaskParameters",
"description": "Sentiment Analysis task parameters."
}
},
"allOf": [
{
"$ref": "#/definitions/AnalyzeTextTask"
}
],
"x-ms-discriminator-value": "SentimentAnalysis"
},
"AnalyzeTextTask": {
"type": "object",
"description": "Collection of documents to analyze and a single task to execute.",
"properties": {
"kind": {
"$ref": "#/definitions/AnalyzeTextTaskKind",
"description": "The kind of task to perform."
}
},
"discriminator": "kind",
"required": [
"kind"
]
},
"AnalyzeTextTaskKind": {
"type": "string",
"description": "The kind of the analyze-text tasks supported.",
"enum": [
"SentimentAnalysis",
"EntityRecognition",
"PiiEntityRecognition",
"KeyPhraseExtraction",
"LanguageDetection",
"EntityLinking"
],
"x-ms-enum": {
"name": "AnalyzeTextTaskKind",
"modelAsString": true,
"values": [
{
"name": "SentimentAnalysis",
"value": "SentimentAnalysis",
"description": "Sentiment analysis task"
},
{
"name": "EntityRecognition",
"value": "EntityRecognition",
"description": "Entity recognition task"
},
{
"name": "PiiEntityRecognition",
"value": "PiiEntityRecognition",
"description": "PII entity recognition task"
},
{
"name": "KeyPhraseExtraction",
"value": "KeyPhraseExtraction",
"description": "Key phrase extraction task"
},
{
"name": "LanguageDetection",
"value": "LanguageDetection",
"description": "Language detection task"
},
{
"name": "EntityLinking",
"value": "EntityLinking",
"description": "Entity linking task"
}
]
}
},
"AnalyzeTextTaskResult": {
"type": "object",
"description": "The result object for the analyze task.",
"properties": {
"kind": {
"$ref": "#/definitions/AnalyzeTextTaskResultsKind",
"description": "The kind of task result."
}
},
"discriminator": "kind",
"required": [
"kind"
]
},
"AnalyzeTextTaskResultsKind": {
"type": "string",
"description": "The kind of the response object returned by the analyze-text task.",
"enum": [
"SentimentAnalysisResults",
"EntityRecognitionResults",
"PiiEntityRecognitionResults",
"KeyPhraseExtractionResults",
"LanguageDetectionResults",
"EntityLinkingResults"
],
"x-ms-enum": {
"name": "AnalyzeTextTaskResultsKind",
"modelAsString": true,
"values": [
{
"name": "SentimentAnalysisResults",
"value": "SentimentAnalysisResults",
"description": "Sentiment analysis results"
},
{
"name": "EntityRecognitionResults",
"value": "EntityRecognitionResults",
"description": "Entity recognition results"
},
{
"name": "PiiEntityRecognitionResults",
"value": "PiiEntityRecognitionResults",
"description": "PII entity recognition results"
},
{
"name": "KeyPhraseExtractionResults",
"value": "KeyPhraseExtractionResults",
"description": "Key phrase extraction results"
},
{
"name": "LanguageDetectionResults",
"value": "LanguageDetectionResults",
"description": "Language detection results"
},
{
"name": "EntityLinkingResults",
"value": "EntityLinkingResults",
"description": "Entity linking results"
}
]
}
},
"Association": {
"type": "string",
"description": "Describes if the entity is the subject of the text or if it describes someone else.",
"enum": [
"subject",
"other"
],
"x-ms-enum": {
"name": "Association",
"modelAsString": false,
"values": [
{
"name": "subject",
"value": "subject",
"description": "Subject association"
},
{
"name": "other",
"value": "other",
"description": "Other association"
}
]
}
},
"Azure.Core.uuid": {
"type": "string",
"format": "uuid",
"description": "Universally Unique Identifier"
},
"Certainty": {
"type": "string",
"description": "Describes the entities certainty and polarity.",
"enum": [
"positive",
"positivePossible",
"neutralPossible",
"negativePossible",
"negative"
],
"x-ms-enum": {
"name": "Certainty",
"modelAsString": false,
"values": [
{
"name": "positive",
"value": "positive",
"description": "Positive certainty"
},
{
"name": "positivePossible",
"value": "positivePossible",
"description": "Possibly positive certainty"
},
{
"name": "neutralPossible",
"value": "neutralPossible",
"description": "Possibly neutral certainty"
},
{
"name": "negativePossible",
"value": "negativePossible",
"description": "Possibly negative certainty"
},
{
"name": "negative",
"value": "negative",
"description": "Negative certainty"
}
]
}
},
"ClassificationDocumentResult": {
"type": "object",
"description": "Contains the classification doc result for the task.",
"properties": {
"id": {
"type": "string",
"description": "Unique, non-empty document identifier."
},
"warnings": {
"type": "array",
"description": "Warnings encountered while processing document.",
"items": {
"$ref": "#/definitions/DocumentWarning"
}
},
"statistics": {
"$ref": "#/definitions/DocumentStatistics",
"description": "if showStats=true was specified in the request this field will contain information about the document payload."
},
"class": {
"type": "array",
"description": "Contains the classification doc results for all docs.",
"items": {
"$ref": "#/definitions/ClassificationResult"
}
}
},
"required": [
"id",
"warnings",
"class"
]
},
"ClassificationResult": {
"type": "object",
"description": "Contains the classification result.",
"properties": {
"category": {
"type": "string",
"description": "Classification type."
},
"confidenceScore": {
"type": "number",
"format": "double",
"description": "Confidence score between 0 and 1 of the recognized class."
}
},
"required": [
"category",
"confidenceScore"
]
},
"Conditionality": {
"type": "string",
"description": "Describes any conditionality on the entity.",
"enum": [
"hypothetical",
"conditional"
],
"x-ms-enum": {
"name": "Conditionality",
"modelAsString": false,
"values": [
{
"name": "hypothetical",
"value": "hypothetical",
"description": "Hypothetical conditionality"
},
{
"name": "conditional",
"value": "conditional",
"description": "Conditional conditionality"
}
]
}
},
"CustomEntitiesLROTask": {
"type": "object",
"description": "Contains the custom text LRO task.",
"properties": {
"parameters": {
"$ref": "#/definitions/CustomEntitiesTaskParameters",
"description": "task parameters."
}
},
"allOf": [
{
"$ref": "#/definitions/AnalyzeTextLROTask"
}
],
"x-ms-discriminator-value": "CustomEntityRecognition"
},
"CustomEntitiesResult": {
"type": "object",
"description": "Contains the list of detected custom entities result for the documents.",
"properties": {
"errors": {
"type": "array",
"description": "Errors by document id.",
"items": {
"$ref": "#/definitions/DocumentError"
}
},
"statistics": {
"$ref": "#/definitions/RequestStatistics",
"description": "if showStats=true was specified in the request this field will contain information about the request payload."
},
"projectName": {
"type": "string",
"description": "This field indicates the project name for the model."
},
"deploymentName": {
"type": "string",
"description": "This field indicates the deployment name for the model."
},
"documents": {
"type": "array",
"description": "Enumeration of the document results.",
"items": {
"$ref": "#/definitions/EntitiesDocumentResult"
}
}
},
"required": [
"errors",
"projectName",
"deploymentName",
"documents"
]
},
"CustomEntitiesTaskParameters": {
"type": "object",
"description": "Supported parameters for a Custom Entities task.",
"properties": {
"loggingOptOut": {
"type": "boolean",
"description": "logging opt out",
"default": false
},
"projectName": {
"type": "string",
"description": "This field indicates the project name for the model."
},
"deploymentName": {
"type": "string",
"description": "This field indicates the deployment name for the model."
},
"stringIndexType": {
"type": "string",
"description": "Optional parameter to provide the string index type used to interpret string offsets. Defaults to TextElements (Graphemes).",
"default": "TextElements_v8",
"enum": [
"TextElements_v8",
"UnicodeCodePoint",
"Utf16CodeUnit"
],
"x-ms-enum": {
"name": "StringIndexType",
"modelAsString": true,
"values": [
{
"name": "TextElements_v8",
"value": "TextElements_v8",
"description": "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."
},
{
"name": "UnicodeCodePoint",
"value": "UnicodeCodePoint",
"description": "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."
},
{
"name": "Utf16CodeUnit",
"value": "Utf16CodeUnit",
"description": "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."
}
]
}
}
},
"required": [
"projectName",
"deploymentName"
]
},
"CustomEntityRecognitionLROResult": {
"type": "object",
"description": "Contains the custom entity recognition job result.",
"properties": {
"results": {
"$ref": "#/definitions/CustomEntitiesResult",
"description": "List of results."
}
},
"required": [
"results"
],
"allOf": [
{
"$ref": "#/definitions/AnalyzeTextLROResult"
}
],
"x-ms-discriminator-value": "CustomEntityRecognitionLROResults"
},
"CustomLabelClassificationResult": {
"type": "object",
"description": "Contains the custom label classification results.",
"properties": {
"errors": {
"type": "array",
"description": "Errors by document id.",
"items": {
"$ref": "#/definitions/DocumentError"
}
},
"statistics": {
"$ref": "#/definitions/RequestStatistics",
"description": "if showStats=true was specified in the request this field will contain information about the request payload."
},
"projectName": {
"type": "string",
"description": "This field indicates the project name for the model."
},
"deploymentName": {
"type": "string",
"description": "This field indicates the deployment name for the model."
},
"documents": {
"type": "array",
"description": "Response by document",
"items": {
"$ref": "#/definitions/ClassificationDocumentResult"
}
}
},
"required": [
"errors",
"projectName",
"deploymentName",
"documents"
]
},
"CustomMultiLabelClassificationLROResult": {
"type": "object",
"description": "Contains the custom multi label classification job result.",
"properties": {
"results": {
"$ref": "#/definitions/CustomLabelClassificationResult",
"description": "List of results."
}
},
"required": [
"results"
],
"allOf": [
{
"$ref": "#/definitions/AnalyzeTextLROResult"
}
],
"x-ms-discriminator-value": "CustomMultiLabelClassificationLROResults"
},
"CustomMultiLabelClassificationLROTask": {
"type": "object",
"description": "Use custom models to classify text into multi label taxonomy",
"properties": {
"parameters": {
"$ref": "#/definitions/CustomMultiLabelClassificationTaskParameters",
"description": "Task parameters."
}
},
"allOf": [
{
"$ref": "#/definitions/AnalyzeTextLROTask"
}
],
"x-ms-discriminator-value": "CustomMultiLabelClassification"
},
"CustomMultiLabelClassificationTaskParameters": {
"type": "object",
"description": "Supported parameters for a Custom Multi Classification task.",
"properties": {
"loggingOptOut": {
"type": "boolean",
"description": "logging opt out",
"default": false
},
"projectName": {
"type": "string",
"description": "This field indicates the project name for the model."
},
"deploymentName": {
"type": "string",
"description": "This field indicates the deployment name for the model."
}
},
"required": [
"projectName",
"deploymentName"
]
},
"CustomSingleLabelClassificationLROResult": {
"type": "object",
"description": "Contains the custom single label classification job result.",
"properties": {
"results": {
"$ref": "#/definitions/CustomLabelClassificationResult",
"description": "List of results."
}
},
"required": [
"results"
],
"allOf": [
{
"$ref": "#/definitions/AnalyzeTextLROResult"
}
],
"x-ms-discriminator-value": "CustomSingleLabelClassificationLROResults"
},
"CustomSingleLabelClassificationLROTask": {
"type": "object",
"description": "Use custom models to classify text into single label taxonomy",
"properties": {
"parameters": {
"$ref": "#/definitions/CustomSingleLabelClassificationTaskParameters",
"description": "Task parameters"
}
},
"allOf": [
{
"$ref": "#/definitions/AnalyzeTextLROTask"
}
],
"x-ms-discriminator-value": "CustomSingleLabelClassification"
},
"CustomSingleLabelClassificationTaskParameters": {
"type": "object",
"description": "Supported parameters for a Custom Single Classification task.",
"properties": {
"loggingOptOut": {
"type": "boolean",
"description": "logging opt out",
"default": false
},
"projectName": {
"type": "string",
"description": "This field indicates the project name for the model."
},
"deploymentName": {
"type": "string",
"description": "This field indicates the deployment name for the model."
}
},
"required": [
"projectName",
"deploymentName"
]
},
"DetectedLanguage": {
"type": "object",
"description": "Contains the details of the detected language for the text.",
"properties": {
"name": {
"type": "string",
"description": "Long name of a detected language (e.g. English, French)."
},
"iso6391Name": {
"type": "string",
"description": "A two letter representation of the detected language according to the ISO 639-1 standard (e.g. en, fr)."
},
"confidenceScore": {
"type": "number",
"format": "double",
"description": "A confidence score between 0 and 1. Scores close to 1 indicate 100% certainty that the identified language is true."
}
},
"required": [
"name",
"iso6391Name",
"confidenceScore"
]
},
"DocumentError": {
"type": "object",
"description": "Contains details of errors encountered during a job execution.",
"properties": {
"id": {
"type": "string",
"description": "The ID of the input document."
},
"error": {
"$ref": "#/definitions/Error",
"description": "Error encountered."
}
},
"required": [
"id",
"error"
]
},
"DocumentSentimentValue": {
"type": "string",
"description": "Predicted sentiment for document (Negative, Neutral, Positive, or Mixed).",
"enum": [
"positive",
"neutral",
"negative",
"mixed"
],
"x-ms-enum": {
"name": "DocumentSentimentValue",
"modelAsString": false,
"values": [
{
"name": "positive",
"value": "positive",
"description": "Positive statement"
},
{
"name": "neutral",
"value": "neutral",
"description": "Neutral statement"
},
{
"name": "negative",
"value": "negative",
"description": "Negative statement"
},
{
"name": "mixed",
"value": "mixed",
"description": "Mixed statement"
}
]
}
},
"DocumentStatistics": {
"type": "object",
"description": "if showStats=true was specified in the request this field will contain information about the document payload.",
"properties": {
"charactersCount": {
"type": "integer",
"format": "int32",
"description": "Number of text elements recognized in the document."
},
"transactionsCount": {
"type": "integer",
"format": "int32",
"description": "Number of transactions for the document."
}
},
"required": [
"charactersCount",
"transactionsCount"
]
},
"DocumentWarning": {
"type": "object",
"description": "Contains the warnings object with warnings encountered for the processed document.",
"properties": {
"code": {
"$ref": "#/definitions/WarningCodeValue",
"description": "Warning code."
},
"message": {
"type": "string",
"description": "Warning message."
},
"targetRef": {
"type": "string",
"description": "A JSON pointer reference indicating the target object."
}
},
"required": [
"code",
"message"
]
},
"EntitiesDocumentResult": {
"type": "object",
"description": "Contains the entity recognition task result for the document.",
"properties": {
"id": {
"type": "string",
"description": "Unique, non-empty document identifier."
},
"warnings": {
"type": "array",
"description": "Warnings encountered while processing document.",
"items": {
"$ref": "#/definitions/DocumentWarning"
}
},
"statistics": {
"$ref": "#/definitions/DocumentStatistics",
"description": "if showStats=true was specified in the request this field will contain information about the document payload."
},
"entities": {
"type": "array",
"description": "Recognized entities in the document.",
"items": {
"$ref": "#/definitions/Entity"
}
}
},
"required": [
"id",
"warnings",
"entities"
]
},
"EntitiesLROTask": {
"type": "object",
"description": "An object representing the task definition for an Entities Recognition task.",
"properties": {
"parameters": {
"$ref": "#/definitions/EntitiesTaskParameters",
"description": "Task parameters."
}
},
"allOf": [
{
"$ref": "#/definitions/AnalyzeTextLROTask"
}
],
"x-ms-discriminator-value": "EntityRecognition"
},
"EntitiesResult": {
"type": "object",
"description": "Contains the entity recognition task result.",
"properties": {
"errors": {
"type": "array",
"description": "Errors by document id.",
"items": {
"$ref": "#/definitions/DocumentError"
}
},
"statistics": {
"$ref": "#/definitions/RequestStatistics",
"description": "if showStats=true was specified in the request this field will contain information about the request payload."
},
"modelVersion": {
"type": "string",
"description": "This field indicates which model is used for scoring."
},
"documents": {
"type": "array",
"description": "Response by document",
"items": {
"$ref": "#/definitions/EntitiesDocumentResult"
}
}
},
"required": [
"errors",
"modelVersion",
"documents"
]
},
"EntitiesTaskParameters": {
"type": "object",
"description": "Supported parameters for an Entity Recognition task.",
"properties": {
"loggingOptOut": {
"type": "boolean",
"description": "logging opt out",
"default": false
},
"modelVersion": {
"type": "string",
"description": "model version",
"default": "latest"
},
"stringIndexType": {
"type": "string",
"description": "(Optional) parameter to provide the string index type used to interpret string offsets. Defaults to TextElements (Graphemes).",
"default": "TextElements_v8",
"enum": [
"TextElements_v8",
"UnicodeCodePoint",
"Utf16CodeUnit"
],
"x-ms-enum": {
"name": "StringIndexType",
"modelAsString": true,
"values": [
{
"name": "TextElements_v8",
"value": "TextElements_v8",
"description": "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."
},
{
"name": "UnicodeCodePoint",
"value": "UnicodeCodePoint",
"description": "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."
},
{
"name": "Utf16CodeUnit",
"value": "Utf16CodeUnit",
"description": "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."
}
]
}
}
}
},
"EntitiesTaskResult": {
"type": "object",
"description": "Contains the entity task",
"properties": {
"results": {
"$ref": "#/definitions/EntitiesResult",
"description": "Results for entity recognition."
}
},
"required": [
"results"
],
"allOf": [
{
"$ref": "#/definitions/AnalyzeTextTaskResult"
}
],
"x-ms-discriminator-value": "EntityRecognitionResults"
},
"Entity": {
"type": "object",
"description": "Defines the detected entity object containing the entity category and entity text detected, etc.",
"properties": {
"text": {
"type": "string",
"description": "Entity text as appears in the request."
},
"category": {
"type": "string",
"description": "Entity type."
},
"subcategory": {
"type": "string",
"description": "(Optional) Entity sub type."
},
"offset": {
"type": "integer",
"format": "int32",
"description": "Start position for the entity text. Use of different 'stringIndexType' values can affect the offset returned."
},
"length": {
"type": "integer",
"format": "int32",
"description": "Length for the entity text. Use of different 'stringIndexType' values can affect the length returned."
},
"confidenceScore": {
"type": "number",
"format": "double",
"description": "Confidence score between 0 and 1 of the extracted entity."
}
},
"required": [
"text",
"category",
"offset",
"length",
"confidenceScore"
]
},
"EntityLinkingLROResult": {
"type": "object",
"description": "Contains the analyze text Entity linking task LRO result.",
"properties": {
"results": {
"$ref": "#/definitions/EntityLinkingResult",
"description": "Entity linking result."
}
},
"required": [
"results"
],
"allOf": [
{
"$ref": "#/definitions/AnalyzeTextLROResult"
}
],
"x-ms-discriminator-value": "EntityLinkingLROResults"
},
"EntityLinkingLROTask": {
"type": "object",
"description": "Contains the analyze text Entity linking LRO task.",
"properties": {
"parameters": {
"$ref": "#/definitions/EntityLinkingTaskParameters",
"description": "Task parameters."
}
},
"allOf": [
{
"$ref": "#/definitions/AnalyzeTextLROTask"
}
],
"x-ms-discriminator-value": "EntityLinking"
},
"EntityLinkingResult": {
"type": "object",
"description": "Entity linking result.",
"properties": {
"errors": {
"type": "array",
"description": "Errors by document id.",
"items": {
"$ref": "#/definitions/DocumentError"
}
},
"statistics": {
"$ref": "#/definitions/RequestStatistics",
"description": "if showStats=true was specified in the request this field will contain information about the request payload."
},
"modelVersion": {
"type": "string",
"description": "This field indicates which model is used for scoring."
},
"documents": {
"type": "array",
"description": "Response by document",
"items": {
"$ref": "#/definitions/LinkedEntitiesDocumentResult"
}
}
},
"required": [
"errors",
"modelVersion",
"documents"
]
},
"EntityLinkingTaskParameters": {
"type": "object",
"description": "Supported parameters for an Entity Linking task.",
"properties": {
"loggingOptOut": {
"type": "boolean",
"description": "logging opt out",
"default": false
},
"modelVersion": {
"type": "string",
"description": "model version",
"default": "latest"
},
"stringIndexType": {
"type": "string",
"description": "Optional parameter to provide the string index type used to interpret string offsets. Defaults to TextElements (Graphemes).",
"default": "TextElements_v8",
"enum": [
"TextElements_v8",
"UnicodeCodePoint",
"Utf16CodeUnit"
],
"x-ms-enum": {
"name": "StringIndexType",
"modelAsString": true,
"values": [
{
"name": "TextElements_v8",
"value": "TextElements_v8",
"description": "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."
},
{
"name": "UnicodeCodePoint",
"value": "UnicodeCodePoint",
"description": "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."
},
{
"name": "Utf16CodeUnit",
"value": "Utf16CodeUnit",
"description": "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."
}
]
}
}
}
},
"EntityLinkingTaskResult": {
"type": "object",
"description": "Contains the analyze text Entity linking task result.",
"properties": {
"results": {
"$ref": "#/definitions/EntityLinkingResult",
"description": "Entity linking result."
}
},
"required": [
"results"
],
"allOf": [
{
"$ref": "#/definitions/AnalyzeTextTaskResult"
}
],
"x-ms-discriminator-value": "EntityLinkingResults"
},
"EntityRecognitionLROResult": {
"type": "object",
"description": "Contains the entity recognition job task result.",
"properties": {
"results": {
"$ref": "#/definitions/EntitiesResult",
"description": "Results for the task."
}
},
"required": [
"results"
],
"allOf": [
{
"$ref": "#/definitions/AnalyzeTextLROResult"
}
],
"x-ms-discriminator-value": "EntityRecognitionLROResults"
},
"Error": {
"type": "object",
"description": "The error response object returned when the service encounters some errors during processing the request.",
"properties": {
"code": {
"$ref": "#/definitions/ErrorCode",
"description": "One of a server-defined set of error codes."
},
"message": {
"type": "string",
"description": "A human-readable representation of the error."
},
"target": {
"type": "string",
"description": "The target of the error."
},
"details": {
"type": "array",
"description": "An array of details about specific errors that led to this reported error.",
"items": {
"$ref": "#/definitions/Error"
}
},
"innererror": {
"$ref": "#/definitions/InnerErrorModel",
"description": "An object containing more specific information than the current object about the error."
}
},
"required": [
"code",
"message"
]
},
"ErrorCode": {
"type": "string",
"description": "Human-readable error code.",
"enum": [
"InvalidRequest",
"InvalidArgument",
"Unauthorized",
"Forbidden",
"NotFound",
"ProjectNotFound",
"OperationNotFound",
"AzureCognitiveSearchNotFound",
"AzureCognitiveSearchIndexNotFound",
"TooManyRequests",
"AzureCognitiveSearchThrottling",
"AzureCognitiveSearchIndexLimitReached",
"InternalServerError",
"ServiceUnavailable",
"Timeout",
"QuotaExceeded",
"Conflict",
"Warning"
],
"x-ms-enum": {
"name": "ErrorCode",
"modelAsString": true,
"values": [
{
"name": "InvalidRequest",
"value": "InvalidRequest",
"description": "Invalid request error"
},
{
"name": "InvalidArgument",
"value": "InvalidArgument",
"description": "Invalid argument error"
},
{
"name": "Unauthorized",
"value": "Unauthorized",
"description": "Unauthorized access error"
},
{
"name": "Forbidden",
"value": "Forbidden",
"description": "Forbidden access error"
},
{
"name": "NotFound",
"value": "NotFound",
"description": "Not found error"
},
{
"name": "ProjectNotFound",
"value": "ProjectNotFound",
"description": "Project not found error"
},
{
"name": "OperationNotFound",
"value": "OperationNotFound",
"description": "Operation not found error"
},
{
"name": "AzureCognitiveSearchNotFound",
"value": "AzureCognitiveSearchNotFound",
"description": "Azure Cognitive Search not found error"
},
{
"name": "AzureCognitiveSearchIndexNotFound",
"value": "AzureCognitiveSearchIndexNotFound",
"description": "Azure Cognitive Search index not found error"
},
{
"name": "TooManyRequests",
"value": "TooManyRequests",
"description": "Too many requests error"
},
{
"name": "AzureCognitiveSearchThrottling",
"value": "AzureCognitiveSearchThrottling",
"description": "Azure Cognitive Search throttling error"
},
{
"name": "AzureCognitiveSearchIndexLimitReached",
"value": "AzureCognitiveSearchIndexLimitReached",
"description": "Azure Cognitive Search index limit reached error"
},
{
"name": "InternalServerError",
"value": "InternalServerError",
"description": "Internal server error"
},
{
"name": "ServiceUnavailable",
"value": "ServiceUnavailable",
"description": "Service unavailable error"
},
{
"name": "Timeout",
"value": "Timeout",
"description": "Timeout error"
},
{
"name": "QuotaExceeded",
"value": "QuotaExceeded",
"description": "Quota exceeded error"
},
{
"name": "Conflict",
"value": "Conflict",
"description": "Conflict error"
},
{
"name": "Warning",
"value": "Warning",
"description": "Warning error"
}
]
}
},
"ErrorResponse": {
"type": "object",
"description": "Error response.",
"properties": {
"error": {
"$ref": "#/definitions/Error",
"description": "The error object."
}
},
"required": [
"error"
]
},
"HealthcareAssertion": {
"type": "object",
"description": "Assertion of the entity.",
"properties": {
"conditionality": {
"$ref": "#/definitions/Conditionality",
"description": "Describes any conditionality on the entity."
},
"certainty": {
"$ref": "#/definitions/Certainty",
"description": "Describes the entities certainty and polarity."
},
"association": {
"$ref": "#/definitions/Association",
"description": "Describes if the entity is the subject of the text or if it describes someone else."
}
}
},
"HealthcareEntitiesDocumentResult": {
"type": "object",
"description": "Result object for the processed Healthcare document.",
"properties": {
"id": {
"type": "string",
"description": "Unique, non-empty document identifier."
},
"warnings": {
"type": "array",
"description": "Warnings encountered while processing document.",
"items": {
"$ref": "#/definitions/DocumentWarning"
}
},
"statistics": {
"$ref": "#/definitions/DocumentStatistics",
"description": "if showStats=true was specified in the request this field will contain information about the document payload."
},
"entities": {
"type": "array",
"description": "Healthcare entities.",
"items": {
"$ref": "#/definitions/HealthcareEntity"
}
},
"relations": {
"type": "array",
"description": "Healthcare entity relations.",
"items": {
"$ref": "#/definitions/HealthcareRelation"
}
}
},
"required": [
"id",
"warnings",
"entities",
"relations"
]
},
"HealthcareEntity": {
"type": "object",
"description": "Healthcare entity extracted from the document",
"properties": {
"text": {
"type": "string",
"description": "Entity text as appears in the request."
},
"category": {
"$ref": "#/definitions/healthcareEntityCategory",
"description": "Healthcare Entity Category."
},
"subcategory": {
"type": "string",
"description": "(Optional) Entity sub type."
},
"offset": {
"type": "integer",
"format": "int32",
"description": "Start position for the entity text. Use of different 'stringIndexType' values can affect the offset returned."
},
"length": {
"type": "integer",
"format": "int32",
"description": "Length for the entity text. Use of different 'stringIndexType' values can affect the length returned."
},
"confidenceScore": {
"type": "number",
"format": "double",
"description": "Confidence score between 0 and 1 of the extracted entity."
},
"assertion": {
"$ref": "#/definitions/HealthcareAssertion",
"description": "Assertion of the entity."
},
"name": {
"type": "string",
"description": "Preferred name for the entity. Example: 'histologically' would have a 'name' of 'histologic'."
},
"links": {
"type": "array",
"description": "Entity references in known data sources.",
"items": {
"$ref": "#/definitions/HealthcareEntityLink"
}
}
},
"required": [
"text",
"category",
"offset",
"length",
"confidenceScore"
]
},
"HealthcareEntityLink": {
"type": "object",
"description": "Reference to an entity in known data sources.",
"properties": {
"dataSource": {
"type": "string",
"description": "Entity Catalog. Examples include: UMLS, CHV, MSH, etc."
},
"id": {
"type": "string",
"description": "Entity id in the given source catalog."
}
},
"required": [
"dataSource",
"id"
]
},
"HealthcareLROResult": {
"type": "object",
"description": "Healthcare Analyze Text long tunning operation result object.",
"properties": {
"results": {
"$ref": "#/definitions/HealthcareResult",
"description": "Results of the task."
}
},
"required": [
"results"
],
"allOf": [
{
"$ref": "#/definitions/AnalyzeTextLROResult"
}
],
"x-ms-discriminator-value": "HealthcareLROResults"
},
"HealthcareLROTask": {
"type": "object",
"description": "The long running task to be performed by the service on the Healthcare input documents.",
"properties": {
"parameters": {
"$ref": "#/definitions/HealthcareTaskParameters",
"description": "Parameters for the Healthcare task."
}
},
"allOf": [
{
"$ref": "#/definitions/AnalyzeTextLROTask"
}
],
"x-ms-discriminator-value": "Healthcare"
},
"HealthcareRelation": {
"type": "object",
"description": "Every relation is an entity graph of a certain relationType, where all entities are connected and have specific roles within the relation context.",
"properties": {
"relationType": {
"$ref": "#/definitions/relationType",
"description": "Type of relation. Examples include: `DosageOfMedication` or 'FrequencyOfMedication', etc."
},
"entities": {
"type": "array",
"description": "The entities in the relation.",
"items": {
"$ref": "#/definitions/HealthcareRelationEntity"
}
}
},
"required": [
"relationType",
"entities"
]
},
"HealthcareRelationEntity": {
"type": "object",
"description": "Entity in the relation.",
"properties": {
"ref": {
"type": "string",
"description": "Reference link object, using a JSON pointer RFC 6901 (URI Fragment Identifier Representation), pointing to the entity ."
},
"role": {
"type": "string",
"description": "Role of entity in the relationship. For example: 'CD20-positive diffuse large B-cell lymphoma' has the following entities with their roles in parenthesis: CD20 (GeneOrProtein), Positive (Expression), diffuse large B-cell lymphoma (Diagnosis)."
}
},
"required": [
"ref",
"role"
]
},
"HealthcareResult": {
"type": "object",
"description": "Result object for the processed Healthcare task.",
"properties": {
"errors": {
"type": "array",
"description": "Errors by document id.",
"items": {
"$ref": "#/definitions/DocumentError"
}
},
"statistics": {
"$ref": "#/definitions/RequestStatistics",
"description": "if showStats=true was specified in the request this field will contain information about the request payload."
},
"modelVersion": {
"type": "string",
"description": "This field indicates which model is used for scoring."
},
"documents": {
"type": "array",
"description": "List of result objects for the processed Healthcare documents.",
"items": {
"$ref": "#/definitions/HealthcareEntitiesDocumentResult"
}
}
},
"required": [
"errors",
"modelVersion",
"documents"
]
},
"HealthcareTaskParameters": {
"type": "object",
"description": "Supported parameters for a Healthcare task.",
"properties": {
"loggingOptOut": {
"type": "boolean",
"description": "logging opt out",
"default": false
},
"modelVersion": {
"type": "string",
"description": "model version",
"default": "latest"
},
"stringIndexType": {
"type": "string",
"description": "Specifies the method used to interpret string offsets.",
"default": "TextElements_v8",
"enum": [
"TextElements_v8",
"UnicodeCodePoint",
"Utf16CodeUnit"
],
"x-ms-enum": {
"name": "StringIndexType",
"modelAsString": true,
"values": [
{
"name": "TextElements_v8",
"value": "TextElements_v8",
"description": "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."
},
{
"name": "UnicodeCodePoint",
"value": "UnicodeCodePoint",
"description": "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."
},
{
"name": "Utf16CodeUnit",
"value": "Utf16CodeUnit",
"description": "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."
}
]
}
}
}
},
"InnerErrorCode": {
"type": "string",
"description": "Human-readable error code.",
"enum": [
"InvalidRequest",
"InvalidParameterValue",
"KnowledgeBaseNotFound",
"AzureCognitiveSearchNotFound",
"AzureCognitiveSearchThrottling",
"ExtractionFailure",
"InvalidRequestBodyFormat",
"EmptyRequest",
"MissingInputDocuments",
"InvalidDocument",
"ModelVersionIncorrect",
"InvalidDocumentBatch",
"UnsupportedLanguageCode",
"InvalidCountryHint"
],
"x-ms-enum": {
"name": "InnerErrorCode",
"modelAsString": true,
"values": [
{
"name": "InvalidRequest",
"value": "InvalidRequest",
"description": "Invalid request error"
},
{
"name": "InvalidParameterValue",
"value": "InvalidParameterValue",
"description": "Invalid parameter value error"
},
{
"name": "KnowledgeBaseNotFound",
"value": "KnowledgeBaseNotFound",
"description": "Knowledge base not found error"
},
{
"name": "AzureCognitiveSearchNotFound",
"value": "AzureCognitiveSearchNotFound",
"description": "Azure Cognitive Search not found error"
},
{
"name": "AzureCognitiveSearchThrottling",
"value": "AzureCognitiveSearchThrottling",
"description": "Azure Cognitive Search throttling error"
},
{
"name": "ExtractionFailure",
"value": "ExtractionFailure",
"description": "Extraction failure error"
},
{
"name": "InvalidRequestBodyFormat",
"value": "InvalidRequestBodyFormat",
"description": "Invalid request body format error"
},
{
"name": "EmptyRequest",
"value": "EmptyRequest",
"description": "Empty request error"
},
{
"name": "MissingInputDocuments",
"value": "MissingInputDocuments",
"description": "Missing input documents error"
},
{
"name": "InvalidDocument",
"value": "InvalidDocument",
"description": "Invalid document error"
},
{
"name": "ModelVersionIncorrect",
"value": "ModelVersionIncorrect",
"description": "Model version incorrect error"
},
{
"name": "InvalidDocumentBatch",
"value": "InvalidDocumentBatch",
"description": "Invalid document batch error"
},
{
"name": "UnsupportedLanguageCode",
"value": "UnsupportedLanguageCode",
"description": "Unsupported language code error"
},
{
"name": "InvalidCountryHint",
"value": "InvalidCountryHint",
"description": "Invalid country hint error"
}
]
}
},
"InnerErrorModel": {
"type": "object",
"description": "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.",
"properties": {
"code": {
"$ref": "#/definitions/InnerErrorCode",
"description": "One of a server-defined set of error codes."
},
"message": {
"type": "string",
"description": "Error message."
},
"details": {
"type": "object",
"description": "Error details.",
"additionalProperties": {
"type": "string"
}
},
"target": {
"type": "string",
"description": "Error target."
},
"innererror": {
"$ref": "#/definitions/InnerErrorModel",
"description": "An object containing more specific information than the current object about the error."
}
},
"required": [
"code",
"message"
]
},
"KeyPhraseExtractionLROResult": {
"type": "object",
"description": "Contains the analyze text KeyPhraseExtraction LRO task.",
"properties": {
"results": {
"$ref": "#/definitions/KeyPhraseResult",
"description": "The list of Key phrase extraction results"
}
},
"required": [
"results"
],
"allOf": [
{
"$ref": "#/definitions/AnalyzeTextLROResult"
}
],
"x-ms-discriminator-value": "KeyPhraseExtractionLROResults"
},
"KeyPhraseLROTask": {
"type": "object",
"description": "An object representing the task definition for a Key Phrase Extraction task.",
"properties": {
"parameters": {
"$ref": "#/definitions/KeyPhraseTaskParameters",
"description": "Key phrase extraction task parameters."
}
},
"allOf": [
{
"$ref": "#/definitions/AnalyzeTextLROTask"
}
],
"x-ms-discriminator-value": "KeyPhraseExtraction"
},
"KeyPhraseResult": {
"type": "object",
"description": "Contains the KeyPhraseResult.",
"properties": {
"errors": {
"type": "array",
"description": "Errors by document id.",
"items": {
"$ref": "#/definitions/DocumentError"
}
},
"statistics": {
"$ref": "#/definitions/RequestStatistics",
"description": "if showStats=true was specified in the request this field will contain information about the request payload."
},
"modelVersion": {
"type": "string",
"description": "This field indicates which model is used for scoring."
},
"documents": {
"type": "array",
"description": "Response by document",
"items": {
"$ref": "#/definitions/KeyPhrasesDocumentResult"
}
}
},
"required": [
"errors",
"modelVersion",
"documents"
]
},
"KeyPhraseTaskParameters": {
"type": "object",
"description": "Supported parameters for a Key Phrase Extraction task.",
"properties": {
"loggingOptOut": {
"type": "boolean",
"description": "logging opt out",
"default": false
},
"modelVersion": {
"type": "string",
"description": "model version",
"default": "latest"
}
}
},
"KeyPhraseTaskResult": {
"type": "object",
"description": "Contains the analyze text KeyPhraseExtraction task result.",
"properties": {
"results": {
"$ref": "#/definitions/KeyPhraseResult",
"description": "The list of Key phrase extraction results"
}
},
"required": [
"results"
],
"allOf": [
{
"$ref": "#/definitions/AnalyzeTextTaskResult"
}
],
"x-ms-discriminator-value": "KeyPhraseExtractionResults"
},
"KeyPhrasesDocumentResult": {
"type": "object",
"description": "Contains the Key phrase extraction results for a document.",
"properties": {
"id": {
"type": "string",
"description": "Unique, non-empty document identifier."
},
"warnings": {
"type": "array",
"description": "Warnings encountered while processing document.",
"items": {
"$ref": "#/definitions/DocumentWarning"
}
},
"statistics": {
"$ref": "#/definitions/DocumentStatistics",
"description": "if showStats=true was specified in the request this field will contain information about the document payload."
},
"keyPhrases": {
"type": "array",
"description": "A list of representative words or phrases. The number of key phrases returned is proportional to the number of words in the input document.",
"items": {
"type": "string"
}
}
},
"required": [
"id",
"warnings",
"keyPhrases"
]
},
"LanguageDetectionAnalysisInput": {
"type": "object",
"description": "Contains the language detection document analysis input.",
"properties": {
"documents": {
"type": "array",
"description": "List of documents to be analyzed.",
"items": {
"$ref": "#/definitions/LanguageInput"
}
}
}
},
"LanguageDetectionDocumentResult": {
"type": "object",
"description": "Contains the language detection for a document.",
"properties": {
"id": {
"type": "string",
"description": "Unique, non-empty document identifier."
},
"warnings": {
"type": "array",
"description": "Warnings encountered while processing document.",
"items": {
"$ref": "#/definitions/DocumentWarning"
}
},
"statistics": {
"$ref": "#/definitions/DocumentStatistics",
"description": "if showStats=true was specified in the request this field will contain information about the document payload."
},
"detectedLanguage": {
"$ref": "#/definitions/DetectedLanguage",
"description": "Detected Language."
}
},
"required": [
"id",
"warnings",
"detectedLanguage"
]
},
"LanguageDetectionResult": {
"type": "object",
"description": "Contains the language detection result for the request.",
"properties": {
"errors": {
"type": "array",
"description": "Errors by document id.",
"items": {
"$ref": "#/definitions/DocumentError"
}
},
"statistics": {
"$ref": "#/definitions/RequestStatistics",
"description": "if showStats=true was specified in the request this field will contain information about the request payload."
},
"modelVersion": {
"type": "string",
"description": "This field indicates which model is used for scoring."
},
"documents": {
"type": "array",
"description": "Enumeration of language detection results for each input document.",
"items": {
"$ref": "#/definitions/LanguageDetectionDocumentResult"
}
}
},
"required": [
"errors",
"modelVersion",
"documents"
]
},
"LanguageDetectionTaskParameters": {
"type": "object",
"description": "Supported parameters for a Language Detection task.",
"properties": {
"loggingOptOut": {
"type": "boolean",
"description": "logging opt out",
"default": false
},
"modelVersion": {
"type": "string",
"description": "model version",
"default": "latest"
}
}
},
"LanguageDetectionTaskResult": {
"type": "object",
"description": "Contains the language detection task result for the request.",
"properties": {
"results": {
"$ref": "#/definitions/LanguageDetectionResult",
"description": "Contains the language detection results."
}
},
"required": [
"results"
],
"allOf": [
{
"$ref": "#/definitions/AnalyzeTextTaskResult"
}
],
"x-ms-discriminator-value": "LanguageDetectionResults"
},
"LanguageInput": {
"type": "object",
"description": "Contains the language detection input.",
"properties": {
"id": {
"type": "string",
"description": "A unique, non-empty document identifier."
},
"text": {
"type": "string",
"description": "The input text to process."
},
"countryHint": {
"type": "string",
"description": "The country hint to help with language detection of the text."
}
},
"required": [
"id",
"text"
]
},
"LinkedEntitiesDocumentResult": {
"type": "object",
"description": "Entity linking document result.",
"properties": {
"id": {
"type": "string",
"description": "Unique, non-empty document identifier."
},
"warnings": {
"type": "array",
"description": "Warnings encountered while processing document.",
"items": {
"$ref": "#/definitions/DocumentWarning"
}
},
"statistics": {
"$ref": "#/definitions/DocumentStatistics",
"description": "if showStats=true was specified in the request this field will contain information about the document payload."
},
"entities": {
"type": "array",
"description": "Recognized well known entities in the document.",
"items": {
"$ref": "#/definitions/LinkedEntity"
}
}
},
"required": [
"id",
"warnings",
"entities"
]
},
"LinkedEntity": {
"type": "object",
"description": "The LinkedEntity object containing the detected entity with the associated sources/links.",
"properties": {
"name": {
"type": "string",
"description": "Entity Linking formal name."
},
"matches": {
"type": "array",
"description": "List of instances this entity appears in the text.",
"items": {
"$ref": "#/definitions/Match"
}
},
"language": {
"type": "string",
"description": "Language used in the data source."
},
"id": {
"type": "string",
"description": "Unique identifier of the recognized entity from the data source."
},
"url": {
"type": "string",
"description": "URL for the entity's page from the data source."
},
"dataSource": {
"type": "string",
"description": "Data source used to extract entity linking, such as Wiki/Bing etc."
},
"bingId": {
"type": "string",
"description": "Bing Entity Search API unique identifier of the recognized entity."
}
},
"required": [
"name",
"matches",
"language",
"url",
"dataSource"
]
},
"Match": {
"type": "object",
"description": "The Match object containing the detected entity text with the offset and the length.",
"properties": {
"confidenceScore": {
"type": "number",
"format": "double",
"description": "If a well known item is recognized, a decimal number denoting the confidence level between 0 and 1 will be returned."
},
"text": {
"type": "string",
"description": "Entity text as appears in the request."
},
"offset": {
"type": "integer",
"format": "int32",
"description": "Start position for the entity match text."
},
"length": {
"type": "integer",
"format": "int32",
"description": "Length for the entity match text."
}
},
"required": [
"confidenceScore",
"text",
"offset",
"length"
]
},
"MultiLanguageAnalysisInput": {
"type": "object",
"description": "Collection of input documents to be analyzed by the service.",
"properties": {
"documents": {
"type": "array",
"description": "The input documents to be analyzed.",
"items": {
"$ref": "#/definitions/MultiLanguageInput"
}
}
}
},
"MultiLanguageInput": {
"type": "object",
"description": "Contains an input document to be analyzed by the service.",
"properties": {
"id": {
"type": "string",
"description": "A unique, non-empty document identifier."
},
"text": {
"type": "string",
"description": "The input text to process."
},
"language": {
"type": "string",
"description": "(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."
}
},
"required": [
"id",
"text"
]
},
"PiiCategory": {
"type": "string",
"description": "(Optional) describes the PII categories to return",
"enum": [
"ABARoutingNumber",
"ARNationalIdentityNumber",
"AUBankAccountNumber",
"AUDriversLicenseNumber",
"AUMedicalAccountNumber",
"AUPassportNumber",
"AUTaxFileNumber",
"AUBusinessNumber",
"AUCompanyNumber",
"ATIdentityCard",
"ATTaxIdentificationNumber",
"ATValueAddedTaxNumber",
"AzureDocumentDBAuthKey",
"AzureIAASDatabaseConnectionAndSQLString",
"AzureIoTConnectionString",
"AzurePublishSettingPassword",
"AzureRedisCacheString",
"AzureSAS",
"AzureServiceBusString",
"AzureStorageAccountKey",
"AzureStorageAccountGeneric",
"BENationalNumber",
"BENationalNumberV2",
"BEValueAddedTaxNumber",
"BRCPFNumber",
"BRLegalEntityNumber",
"BRNationalIDRG",
"BGUniformCivilNumber",
"CABankAccountNumber",
"CADriversLicenseNumber",
"CAHealthServiceNumber",
"CAPassportNumber",
"CAPersonalHealthIdentification",
"CASocialInsuranceNumber",
"CLIdentityCardNumber",
"CNResidentIdentityCardNumber",
"CreditCardNumber",
"HRIdentityCardNumber",
"HRNationalIDNumber",
"HRPersonalIdentificationNumber",
"HRPersonalIdentificationOIBNumberV2",
"CYIdentityCard",
"CYTaxIdentificationNumber",
"CZPersonalIdentityNumber",
"CZPersonalIdentityV2",
"DKPersonalIdentificationNumber",
"DKPersonalIdentificationV2",
"DrugEnforcementAgencyNumber",
"EEPersonalIdentificationCode",
"EUDebitCardNumber",
"EUDriversLicenseNumber",
"EUGPSCoordinates",
"EUNationalIdentificationNumber",
"EUPassportNumber",
"EUSocialSecurityNumber",
"EUTaxIdentificationNumber",
"FIEuropeanHealthNumber",
"FINationalID",
"FINationalIDV2",
"FIPassportNumber",
"FRDriversLicenseNumber",
"FRHealthInsuranceNumber",
"FRNationalID",
"FRPassportNumber",
"FRSocialSecurityNumber",
"FRTaxIdentificationNumber",
"FRValueAddedTaxNumber",
"DEDriversLicenseNumber",
"DEPassportNumber",
"DEIdentityCardNumber",
"DETaxIdentificationNumber",
"DEValueAddedNumber",
"GRNationalIDCard",
"GRNationalIDV2",
"GRTaxIdentificationNumber",
"HKIdentityCardNumber",
"HUValueAddedNumber",
"HUPersonalIdentificationNumber",
"HUTaxIdentificationNumber",
"INPermanentAccount",
"INUniqueIdentificationNumber",
"IDIdentityCardNumber",
"InternationalBankingAccountNumber",
"IEPersonalPublicServiceNumber",
"IEPersonalPublicServiceNumberV2",
"ILBankAccountNumber",
"ILNationalID",
"ITDriversLicenseNumber",
"ITFiscalCode",
"ITValueAddedTaxNumber",
"JPBankAccountNumber",
"JPDriversLicenseNumber",
"JPPassportNumber",
"JPResidentRegistrationNumber",
"JPSocialInsuranceNumber",
"JPMyNumberCorporate",
"JPMyNumberPersonal",
"JPResidenceCardNumber",
"LVPersonalCode",
"LTPersonalCode",
"LUNationalIdentificationNumberNatural",
"LUNationalIdentificationNumberNonNatural",
"MYIdentityCardNumber",
"MTIdentityCardNumber",
"MTTaxIDNumber",
"NLCitizensServiceNumber",
"NLCitizensServiceNumberV2",
"NLTaxIdentificationNumber",
"NLValueAddedTaxNumber",
"NZBankAccountNumber",
"NZDriversLicenseNumber",
"NZInlandRevenueNumber",
"NZMinistryOfHealthNumber",
"NZSocialWelfareNumber",
"NOIdentityNumber",
"PHUnifiedMultiPurposeIDNumber",
"PLIdentityCard",
"PLNationalID",
"PLNationalIDV2",
"PLPassportNumber",
"PLTaxIdentificationNumber",
"PLREGONNumber",
"PTCitizenCardNumber",
"PTCitizenCardNumberV2",
"PTTaxIdentificationNumber",
"ROPersonalNumericalCode",
"RUPassportNumberDomestic",
"RUPassportNumberInternational",
"SANationalID",
"SGNationalRegistrationIdentityCardNumber",
"SKPersonalNumber",
"SITaxIdentificationNumber",
"SIUniqueMasterCitizenNumber",
"ZAIdentificationNumber",
"KRResidentRegistrationNumber",
"ESDNI",
"ESSocialSecurityNumber",
"ESTaxIdentificationNumber",
"SQLServerConnectionString",
"SENationalID",
"SENationalIDV2",
"SEPassportNumber",
"SETaxIdentificationNumber",
"SWIFTCode",
"CHSocialSecurityNumber",
"TWNationalID",
"TWPassportNumber",
"TWResidentCertificate",
"THPopulationIdentificationCode",
"TRNationalIdentificationNumber",
"UKDriversLicenseNumber",
"UKElectoralRollNumber",
"UKNationalHealthNumber",
"UKNationalInsuranceNumber",
"UKUniqueTaxpayerNumber",
"USUKPassportNumber",
"USBankAccountNumber",
"USDriversLicenseNumber",
"USIndividualTaxpayerIdentification",
"USSocialSecurityNumber",
"UAPassportNumberDomestic",
"UAPassportNumberInternational",
"Organization",
"Email",
"URL",
"Age",
"PhoneNumber",
"IPAddress",
"Date",
"Person",
"Address",
"All",
"Default"
],
"x-ms-enum": {
"name": "PiiCategory",
"modelAsString": true,
"values": [
{
"name": "ABARoutingNumber",
"value": "ABARoutingNumber",
"description": "ABA Routing number"
},
{
"name": "ARNationalIdentityNumber",
"value": "ARNationalIdentityNumber",
"description": "AR National Identity Number"
},
{
"name": "AUBankAccountNumber",
"value": "AUBankAccountNumber",
"description": "AT Bank Account Number"
},
{
"name": "AUDriversLicenseNumber",
"value": "AUDriversLicenseNumber",
"description": "AU Driver's License Number"
},
{
"name": "AUMedicalAccountNumber",
"value": "AUMedicalAccountNumber",
"description": "AU Medical Account Number"
},
{
"name": "AUPassportNumber",
"value": "AUPassportNumber",
"description": "AU Passport Number"
},
{
"name": "AUTaxFileNumber",
"value": "AUTaxFileNumber",
"description": "AU Tax File Number"
},
{
"name": "AUBusinessNumber",
"value": "AUBusinessNumber",
"description": "AU Business Number"
},
{
"name": "AUCompanyNumber",
"value": "AUCompanyNumber",
"description": "AU Company Number"
},
{
"name": "ATIdentityCard",
"value": "ATIdentityCard",
"description": "AT Identity Card"
},
{
"name": "ATTaxIdentificationNumber",
"value": "ATTaxIdentificationNumber",
"description": "AT Tax Identification Number"
},
{
"name": "ATValueAddedTaxNumber",
"value": "ATValueAddedTaxNumber",
"description": "AT Value Added Tax Number"
},
{
"name": "AzureDocumentDBAuthKey",
"value": "AzureDocumentDBAuthKey",
"description": "Azure Document DB Auth Key"
},
{
"name": "AzureIAASDatabaseConnectionAndSQLString",
"value": "AzureIAASDatabaseConnectionAndSQLString",
"description": "Azure IAAS Database Connection And SQL String"
},
{
"name": "AzureIoTConnectionString",
"value": "AzureIoTConnectionString",
"description": "Azure IoT Connection String"
},
{
"name": "AzurePublishSettingPassword",
"value": "AzurePublishSettingPassword",
"description": "Azure Publish Setting Password"
},
{
"name": "AzureRedisCacheString",
"value": "AzureRedisCacheString",
"description": "Azure Redis Cache String"
},
{
"name": "AzureSAS",
"value": "AzureSAS",
"description": "Azure SAS"
},
{
"name": "AzureServiceBusString",
"value": "AzureServiceBusString",
"description": "Azure Service Bus String"
},
{
"name": "AzureStorageAccountKey",
"value": "AzureStorageAccountKey",
"description": "Azure Storage Account Key"
},
{
"name": "AzureStorageAccountGeneric",
"value": "AzureStorageAccountGeneric",
"description": "Azure Storage Account Generic"
},
{
"name": "BENationalNumber",
"value": "BENationalNumber",
"description": "BE National Number"
},
{
"name": "BENationalNumberV2",
"value": "BENationalNumberV2",
"description": "BE National Number V2"
},
{
"name": "BEValueAddedTaxNumber",
"value": "BEValueAddedTaxNumber",
"description": "BE Value Added Tax Number"
},
{
"name": "BRCPFNumber",
"value": "BRCPFNumber",
"description": "BR CPF Number"
},
{
"name": "BRLegalEntityNumber",
"value": "BRLegalEntityNumber",
"description": "BR Legal Entity Number"
},
{
"name": "BRNationalIDRG",
"value": "BRNationalIDRG",
"description": "BR National ID RG"
},
{
"name": "BGUniformCivilNumber",
"value": "BGUniformCivilNumber",
"description": "BG Uniform Civil Number"
},
{
"name": "CABankAccountNumber",
"value": "CABankAccountNumber",
"description": "CA Bank Account Number"
},
{
"name": "CADriversLicenseNumber",
"value": "CADriversLicenseNumber",
"description": "CA Driver's License Number"
},
{
"name": "CAHealthServiceNumber",
"value": "CAHealthServiceNumber",
"description": "CA Health Service Number"
},
{
"name": "CAPassportNumber",
"value": "CAPassportNumber",
"description": "CA Passport Number"
},
{
"name": "CAPersonalHealthIdentification",
"value": "CAPersonalHealthIdentification",
"description": "CA Personal Health Identification"
},
{
"name": "CASocialInsuranceNumber",
"value": "CASocialInsuranceNumber",
"description": "CA Social Insurance Number"
},
{
"name": "CLIdentityCardNumber",
"value": "CLIdentityCardNumber",
"description": "CL Identity Card Number"
},
{
"name": "CNResidentIdentityCardNumber",
"value": "CNResidentIdentityCardNumber",
"description": "CN Resident Identity Card Number"
},
{
"name": "CreditCardNumber",
"value": "CreditCardNumber",
"description": "Credit Card Number"
},
{
"name": "HRIdentityCardNumber",
"value": "HRIdentityCardNumber",
"description": "HR Identity Card Number"
},
{
"name": "HRNationalIDNumber",
"value": "HRNationalIDNumber",
"description": "HR National ID Number"
},
{
"name": "HRPersonalIdentificationNumber",
"value": "HRPersonalIdentificationNumber",
"description": "HR Personal Identification Number"
},
{
"name": "HRPersonalIdentificationOIBNumberV2",
"value": "HRPersonalIdentificationOIBNumberV2",
"description": "HR Personal Identification OIB Number V2"
},
{
"name": "CYIdentityCard",
"value": "CYIdentityCard",
"description": "CY Identity Card"
},
{
"name": "CYTaxIdentificationNumber",
"value": "CYTaxIdentificationNumber",
"description": "CY Tax Identification Number"
},
{
"name": "CZPersonalIdentityNumber",
"value": "CZPersonalIdentityNumber",
"description": "CZ Personal Identity Number"
},
{
"name": "CZPersonalIdentityV2",
"value": "CZPersonalIdentityV2",
"description": "CZ Personal Identity V2"
},
{
"name": "DKPersonalIdentificationNumber",
"value": "DKPersonalIdentificationNumber",
"description": "DK Personal Identification Number"
},
{
"name": "DKPersonalIdentificationV2",
"value": "DKPersonalIdentificationV2",
"description": "DK Personal Identification V2"
},
{
"name": "DrugEnforcementAgencyNumber",
"value": "DrugEnforcementAgencyNumber",
"description": "Drug Enforcement Agency Number"
},
{
"name": "EEPersonalIdentificationCode",
"value": "EEPersonalIdentificationCode",
"description": "EE Personal Identification Code"
},
{
"name": "EUDebitCardNumber",
"value": "EUDebitCardNumber",
"description": "EU Debit Card Number"
},
{
"name": "EUDriversLicenseNumber",
"value": "EUDriversLicenseNumber",
"description": "EU Driver's License Number"
},
{
"name": "EUGPSCoordinates",
"value": "EUGPSCoordinates",
"description": "EU GPS Coordinates"
},
{
"name": "EUNationalIdentificationNumber",
"value": "EUNationalIdentificationNumber",
"description": "EU National Identification Number"
},
{
"name": "EUPassportNumber",
"value": "EUPassportNumber",
"description": "EU Passport Number"
},
{
"name": "EUSocialSecurityNumber",
"value": "EUSocialSecurityNumber",
"description": "EU Social Security Number"
},
{
"name": "EUTaxIdentificationNumber",
"value": "EUTaxIdentificationNumber",
"description": "EU Tax Identification Number"
},
{
"name": "FIEuropeanHealthNumber",
"value": "FIEuropeanHealthNumber",
"description": "FI European Health Number"
},
{
"name": "FINationalID",
"value": "FINationalID",
"description": "FI National ID"
},
{
"name": "FINationalIDV2",
"value": "FINationalIDV2",
"description": "FI National ID V2"
},
{
"name": "FIPassportNumber",
"value": "FIPassportNumber",
"description": "FI Passport Number"
},
{
"name": "FRDriversLicenseNumber",
"value": "FRDriversLicenseNumber",
"description": "FR Driver's License Number"
},
{
"name": "FRHealthInsuranceNumber",
"value": "FRHealthInsuranceNumber",
"description": "FR Health Insurance Number"
},
{
"name": "FRNationalID",
"value": "FRNationalID",
"description": "FR National ID"
},
{
"name": "FRPassportNumber",
"value": "FRPassportNumber",
"description": "FR Passport Number"
},
{
"name": "FRSocialSecurityNumber",
"value": "FRSocialSecurityNumber",
"description": "FR Social Security Number"
},
{
"name": "FRTaxIdentificationNumber",
"value": "FRTaxIdentificationNumber",
"description": "FR Tax Identification Number"
},
{
"name": "FRValueAddedTaxNumber",
"value": "FRValueAddedTaxNumber",
"description": "FR Value Added Tax Number"
},
{
"name": "DEDriversLicenseNumber",
"value": "DEDriversLicenseNumber",
"description": "DE Driver's License Number"
},
{
"name": "DEPassportNumber",
"value": "DEPassportNumber",
"description": "DE Passport Number"
},
{
"name": "DEIdentityCardNumber",
"value": "DEIdentityCardNumber",
"description": "DE Identity Card Number"
},
{
"name": "DETaxIdentificationNumber",
"value": "DETaxIdentificationNumber",
"description": "DE Tax Identification Number"
},
{
"name": "DEValueAddedNumber",
"value": "DEValueAddedNumber",
"description": "DE Value Added Number"
},
{
"name": "GRNationalIDCard",
"value": "GRNationalIDCard",
"description": "GR National ID Card"
},
{
"name": "GRNationalIDV2",
"value": "GRNationalIDV2",
"description": "GR National ID V2"
},
{
"name": "GRTaxIdentificationNumber",
"value": "GRTaxIdentificationNumber",
"description": "GR Tax Identification Number"
},
{
"name": "HKIdentityCardNumber",
"value": "HKIdentityCardNumber",
"description": "HK Identity Card Number"
},
{
"name": "HUValueAddedNumber",
"value": "HUValueAddedNumber",
"description": "HU Value Added Number"
},
{
"name": "HUPersonalIdentificationNumber",
"value": "HUPersonalIdentificationNumber",
"description": "HU Personal Identification Number"
},
{
"name": "HUTaxIdentificationNumber",
"value": "HUTaxIdentificationNumber",
"description": "HU Tax Identification Number"
},
{
"name": "INPermanentAccount",
"value": "INPermanentAccount",
"description": "IN Permanent Account"
},
{
"name": "INUniqueIdentificationNumber",
"value": "INUniqueIdentificationNumber",
"description": "IN Unique Identification Number"
},
{
"name": "IDIdentityCardNumber",
"value": "IDIdentityCardNumber",
"description": "ID Identity Card Number"
},
{
"name": "InternationalBankingAccountNumber",
"value": "InternationalBankingAccountNumber",
"description": "International Banking Account Number"
},
{
"name": "IEPersonalPublicServiceNumber",
"value": "IEPersonalPublicServiceNumber",
"description": "IE Personal Public Service Number"
},
{
"name": "IEPersonalPublicServiceNumberV2",
"value": "IEPersonalPublicServiceNumberV2",
"description": "IE Personal Public Service Number V2"
},
{
"name": "ILBankAccountNumber",
"value": "ILBankAccountNumber",
"description": "IL Bank Account Number"
},
{
"name": "ILNationalID",
"value": "ILNationalID",
"description": "IL National ID"
},
{
"name": "ITDriversLicenseNumber",
"value": "ITDriversLicenseNumber",
"description": "IT Driver's License Number"
},
{
"name": "ITFiscalCode",
"value": "ITFiscalCode",
"description": "IT Fiscal Code"
},
{
"name": "ITValueAddedTaxNumber",
"value": "ITValueAddedTaxNumber",
"description": "IT Value Added Tax Number"
},
{
"name": "JPBankAccountNumber",
"value": "JPBankAccountNumber",
"description": "JP Bank Account Number"
},
{
"name": "JPDriversLicenseNumber",
"value": "JPDriversLicenseNumber",
"description": "JP Driver's License Number"
},
{
"name": "JPPassportNumber",
"value": "JPPassportNumber",
"description": "JP Passport Number"
},
{
"name": "JPResidentRegistrationNumber",
"value": "JPResidentRegistrationNumber",
"description": "JP Resident Registration Number"
},
{
"name": "JPSocialInsuranceNumber",
"value": "JPSocialInsuranceNumber",
"description": "JP Social Insurance Number"
},
{
"name": "JPMyNumberCorporate",
"value": "JPMyNumberCorporate",
"description": "JP My Number Corporate"
},
{
"name": "JPMyNumberPersonal",
"value": "JPMyNumberPersonal",
"description": "JP My Number Personal"
},
{
"name": "JPResidenceCardNumber",
"value": "JPResidenceCardNumber",
"description": "JP Residence Card Number"
},
{
"name": "LVPersonalCode",
"value": "LVPersonalCode",
"description": "LV Personal Code"
},
{
"name": "LTPersonalCode",
"value": "LTPersonalCode",
"description": "LT Personal Code"
},
{
"name": "LUNationalIdentificationNumberNatural",
"value": "LUNationalIdentificationNumberNatural",
"description": "LU National Identification Number Natural"
},
{
"name": "LUNationalIdentificationNumberNonNatural",
"value": "LUNationalIdentificationNumberNonNatural",
"description": "LU National Identification Number Non Natural"
},
{
"name": "MYIdentityCardNumber",
"value": "MYIdentityCardNumber",
"description": "MY Identity Card Number"
},
{
"name": "MTIdentityCardNumber",
"value": "MTIdentityCardNumber",
"description": "MT Identity Card Number"
},
{
"name": "MTTaxIDNumber",
"value": "MTTaxIDNumber",
"description": "MT Tax ID Number"
},
{
"name": "NLCitizensServiceNumber",
"value": "NLCitizensServiceNumber",
"description": "NL Citizens Service Number"
},
{
"name": "NLCitizensServiceNumberV2",
"value": "NLCitizensServiceNumberV2",
"description": "NL Citizens Service Number V2"
},
{
"name": "NLTaxIdentificationNumber",
"value": "NLTaxIdentificationNumber",
"description": "NL Tax Identification Number"
},
{
"name": "NLValueAddedTaxNumber",
"value": "NLValueAddedTaxNumber",
"description": "NL Value Added Tax Number"
},
{
"name": "NZBankAccountNumber",
"value": "NZBankAccountNumber",
"description": "NZ Bank Account Number"
},
{
"name": "NZDriversLicenseNumber",
"value": "NZDriversLicenseNumber",
"description": "NZ Driver's License Number"
},
{
"name": "NZInlandRevenueNumber",
"value": "NZInlandRevenueNumber",
"description": "NZ Inland Revenue Number"
},
{
"name": "NZMinistryOfHealthNumber",
"value": "NZMinistryOfHealthNumber",
"description": "NZ Ministry Of Health Number"
},
{
"name": "NZSocialWelfareNumber",
"value": "NZSocialWelfareNumber",
"description": "NZ Social Welfare Number"
},
{
"name": "NOIdentityNumber",
"value": "NOIdentityNumber",
"description": "NO Identity Number"
},
{
"name": "PHUnifiedMultiPurposeIDNumber",
"value": "PHUnifiedMultiPurposeIDNumber",
"description": "PH Unified Multi Purpose ID Number"
},
{
"name": "PLIdentityCard",
"value": "PLIdentityCard",
"description": "PL Identity Card"
},
{
"name": "PLNationalID",
"value": "PLNationalID",
"description": "PL National ID"
},
{
"name": "PLNationalIDV2",
"value": "PLNationalIDV2",
"description": "PL National ID V2"
},
{
"name": "PLPassportNumber",
"value": "PLPassportNumber",
"description": "PL Passport Number"
},
{
"name": "PLTaxIdentificationNumber",
"value": "PLTaxIdentificationNumber",
"description": "PL Tax Identification Number"
},
{
"name": "PLREGONNumber",
"value": "PLREGONNumber",
"description": "PL REGON Number"
},
{
"name": "PTCitizenCardNumber",
"value": "PTCitizenCardNumber",
"description": "PT Citizen Card Number"
},
{
"name": "PTCitizenCardNumberV2",
"value": "PTCitizenCardNumberV2",
"description": "PT Citizen Card Number V2"
},
{
"name": "PTTaxIdentificationNumber",
"value": "PTTaxIdentificationNumber",
"description": "PT Tax Identification Number"
},
{
"name": "ROPersonalNumericalCode",
"value": "ROPersonalNumericalCode",
"description": "RO Personal Numerical Code"
},
{
"name": "RUPassportNumberDomestic",
"value": "RUPassportNumberDomestic",
"description": "RU Passport Number Domestic"
},
{
"name": "RUPassportNumberInternational",
"value": "RUPassportNumberInternational",
"description": "RU Passport Number International"
},
{
"name": "SANationalID",
"value": "SANationalID",
"description": "SA National ID"
},
{
"name": "SGNationalRegistrationIdentityCardNumber",
"value": "SGNationalRegistrationIdentityCardNumber",
"description": "SG National Registration Identity Card Number"
},
{
"name": "SKPersonalNumber",
"value": "SKPersonalNumber",
"description": "SK Personal Number"
},
{
"name": "SITaxIdentificationNumber",
"value": "SITaxIdentificationNumber",
"description": "SI Tax Identification Number"
},
{
"name": "SIUniqueMasterCitizenNumber",
"value": "SIUniqueMasterCitizenNumber",
"description": "SI Unique Master Citizen Number"
},
{
"name": "ZAIdentificationNumber",
"value": "ZAIdentificationNumber",
"description": "ZA Identification Number"
},
{
"name": "KRResidentRegistrationNumber",
"value": "KRResidentRegistrationNumber",
"description": "KR Resident Registration Number"
},
{
"name": "ESDNI",
"value": "ESDNI",
"description": "ES DNI"
},
{
"name": "ESSocialSecurityNumber",
"value": "ESSocialSecurityNumber",
"description": "ES Social Security Number"
},
{
"name": "ESTaxIdentificationNumber",
"value": "ESTaxIdentificationNumber",
"description": "ES Tax Identification Number"
},
{
"name": "SQLServerConnectionString",
"value": "SQLServerConnectionString",
"description": "SQL Server Connection String"
},
{
"name": "SENationalID",
"value": "SENationalID",
"description": "SE National ID"
},
{
"name": "SENationalIDV2",
"value": "SENationalIDV2",
"description": "SE National ID V2"
},
{
"name": "SEPassportNumber",
"value": "SEPassportNumber",
"description": "SE Passport Number"
},
{
"name": "SETaxIdentificationNumber",
"value": "SETaxIdentificationNumber",
"description": "SE Tax Identification Number"
},
{
"name": "SWIFTCode",
"value": "SWIFTCode",
"description": "SWIFT Code"
},
{
"name": "CHSocialSecurityNumber",
"value": "CHSocialSecurityNumber",
"description": "CH Social Security Number"
},
{
"name": "TWNationalID",
"value": "TWNationalID",
"description": "TW National ID"
},
{
"name": "TWPassportNumber",
"value": "TWPassportNumber",
"description": "TW Passport Number"
},
{
"name": "TWResidentCertificate",
"value": "TWResidentCertificate",
"description": "TW Resident Certificate"
},
{
"name": "THPopulationIdentificationCode",
"value": "THPopulationIdentificationCode",
"description": "TH Population Identification Code"
},
{
"name": "TRNationalIdentificationNumber",
"value": "TRNationalIdentificationNumber",
"description": "TR National Identification Number"
},
{
"name": "UKDriversLicenseNumber",
"value": "UKDriversLicenseNumber",
"description": "UK Driver's License Number"
},
{
"name": "UKElectoralRollNumber",
"value": "UKElectoralRollNumber",
"description": "UK Electoral Roll Number"
},
{
"name": "UKNationalHealthNumber",
"value": "UKNationalHealthNumber",
"description": "UK National Health Number"
},
{
"name": "UKNationalInsuranceNumber",
"value": "UKNationalInsuranceNumber",
"description": "UK National Insurance Number"
},
{
"name": "UKUniqueTaxpayerNumber",
"value": "UKUniqueTaxpayerNumber",
"description": "UK Unique Taxpayer Number"
},
{
"name": "USUKPassportNumber",
"value": "USUKPassportNumber",
"description": "US UK Passport Number"
},
{
"name": "USBankAccountNumber",
"value": "USBankAccountNumber",
"description": "US Bank Account Number"
},
{
"name": "USDriversLicenseNumber",
"value": "USDriversLicenseNumber",
"description": "US Driver's License Number"
},
{
"name": "USIndividualTaxpayerIdentification",
"value": "USIndividualTaxpayerIdentification",
"description": "US Individual Taxpayer Identification"
},
{
"name": "USSocialSecurityNumber",
"value": "USSocialSecurityNumber",
"description": "US Social Security Number"
},
{
"name": "UAPassportNumberDomestic",
"value": "UAPassportNumberDomestic",
"description": "UA Passport Number Domestic"
},
{
"name": "UAPassportNumberInternational",
"value": "UAPassportNumberInternational",
"description": "UA Passport Number International"
},
{
"name": "Organization",
"value": "Organization",
"description": "Organization"
},
{
"name": "Email",
"value": "Email",
"description": "Email"
},
{
"name": "URL",
"value": "URL",
"description": "URL"
},
{
"name": "Age",
"value": "Age",
"description": "Age"
},
{
"name": "PhoneNumber",
"value": "PhoneNumber",
"description": "Phone Number"
},
{
"name": "IPAddress",
"value": "IPAddress",
"description": "IP Address"
},
{
"name": "Date",
"value": "Date",
"description": "Date"
},
{
"name": "Person",
"value": "Person",
"description": "Person"
},
{
"name": "Address",
"value": "Address",
"description": "Address"
},
{
"name": "All",
"value": "All",
"description": "All PII categories."
},
{
"name": "Default",
"value": "Default",
"description": "Default PII categories for the language."
}
]
}
},
"PiiEntitiesDocumentResult": {
"type": "object",
"description": "Contains the PII results.",
"properties": {
"id": {
"type": "string",
"description": "Unique, non-empty document identifier."
},
"warnings": {
"type": "array",
"description": "Warnings encountered while processing document.",
"items": {
"$ref": "#/definitions/DocumentWarning"
}
},
"statistics": {
"$ref": "#/definitions/DocumentStatistics",
"description": "if showStats=true was specified in the request this field will contain information about the document payload."
},
"redactedText": {
"type": "string",
"description": "Returns redacted text."
},
"entities": {
"type": "array",
"description": "Recognized entities in the document.",
"items": {
"$ref": "#/definitions/Entity"
}
}
},
"required": [
"id",
"warnings",
"redactedText",
"entities"
]
},
"PiiEntityRecognitionLROResult": {
"type": "object",
"description": "Contains the PII LRO results.",
"properties": {
"results": {
"$ref": "#/definitions/PiiResult",
"description": "The list of pii results"
}
},
"required": [
"results"
],
"allOf": [
{
"$ref": "#/definitions/AnalyzeTextLROResult"
}
],
"x-ms-discriminator-value": "PiiEntityRecognitionLROResults"
},
"PiiLROTask": {
"type": "object",
"description": "Contains the analyze text PIIEntityRecognition LRO task.",
"properties": {
"parameters": {
"$ref": "#/definitions/PiiTaskParameters",
"description": "Pii task parameters."
}
},
"allOf": [
{
"$ref": "#/definitions/AnalyzeTextLROTask"
}
],
"x-ms-discriminator-value": "PiiEntityRecognition"
},
"PiiResult": {
"type": "object",
"description": "Contains the PiiResult.",
"properties": {
"errors": {
"type": "array",
"description": "Errors by document id.",
"items": {
"$ref": "#/definitions/DocumentError"
}
},
"statistics": {
"$ref": "#/definitions/RequestStatistics",
"description": "if showStats=true was specified in the request this field will contain information about the request payload."
},
"modelVersion": {
"type": "string",
"description": "This field indicates which model is used for scoring."
},
"documents": {
"type": "array",
"description": "Response by document",
"items": {
"$ref": "#/definitions/PiiEntitiesDocumentResult"
}
}
},
"required": [
"errors",
"modelVersion",
"documents"
]
},
"PiiTaskParameters": {
"type": "object",
"description": "Supported parameters for a PII Entities Recognition task.",
"properties": {
"loggingOptOut": {
"type": "boolean",
"description": "logging opt out",
"default": true
},
"modelVersion": {
"type": "string",
"description": "model version",
"default": "latest"
},
"domain": {
"type": "string",
"description": "Domain for PII task",
"default": "none",
"enum": [
"phi",
"none"
],
"x-ms-enum": {
"name": "PiiDomain",
"modelAsString": true,
"values": [
{
"name": "phi",
"value": "phi",
"description": "Indicates that entities in the Personal Health Information domain should be redacted."
},
{
"name": "none",
"value": "none",
"description": "Indicates that no domain is specified."
}
]
}
},
"piiCategories": {
"type": "array",
"description": "Enumeration of PII categories to be returned in the response.",
"items": {
"$ref": "#/definitions/PiiCategory"
}
},
"stringIndexType": {
"type": "string",
"description": "StringIndexType to be used for analysis.",
"default": "TextElements_v8",
"enum": [
"TextElements_v8",
"UnicodeCodePoint",
"Utf16CodeUnit"
],
"x-ms-enum": {
"name": "StringIndexType",
"modelAsString": true,
"values": [
{
"name": "TextElements_v8",
"value": "TextElements_v8",
"description": "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."
},
{
"name": "UnicodeCodePoint",
"value": "UnicodeCodePoint",
"description": "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."
},
{
"name": "Utf16CodeUnit",
"value": "Utf16CodeUnit",
"description": "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."
}
]
}
}
}
},
"PiiTaskResult": {
"type": "object",
"description": "Contains the analyze text PIIEntityRecognition LRO task.",
"properties": {
"results": {
"$ref": "#/definitions/PiiResult",
"description": "The list of pii results"
}
},
"required": [
"results"
],
"allOf": [
{
"$ref": "#/definitions/AnalyzeTextTaskResult"
}
],
"x-ms-discriminator-value": "PiiEntityRecognitionResults"
},
"RequestStatistics": {
"type": "object",
"description": "if showStats=true was specified in the request this field will contain information about the request payload.",
"properties": {
"documentsCount": {
"type": "integer",
"format": "int32",
"description": "Number of documents submitted in the request."
},
"validDocumentsCount": {
"type": "integer",
"format": "int32",
"description": "Number of valid documents. This excludes empty, over-size limit or non-supported languages documents."
},
"erroneousDocumentsCount": {
"type": "integer",
"format": "int32",
"description": "Number of invalid documents. This includes empty, over-size limit or non-supported languages documents."
},
"transactionsCount": {
"type": "integer",
"format": "int64",
"description": "Number of transactions for the request."
}
},
"required": [
"documentsCount",
"validDocumentsCount",
"erroneousDocumentsCount",
"transactionsCount"
]
},
"SentenceAssessment": {
"type": "object",
"description": "Represents a sentence assessment and the assessments or target objects related to it.",
"properties": {
"sentiment": {
"$ref": "#/definitions/TokenSentimentValue",
"description": "The sentiment of the sentence."
},
"confidenceScores": {
"$ref": "#/definitions/TargetConfidenceScoreLabel",
"description": "Represents the confidence scores across all sentiment classes: positive and negative."
},
"offset": {
"type": "integer",
"format": "int32",
"description": "The target offset from the start of the sentence."
},
"length": {
"type": "integer",
"format": "int32",
"description": "The length of the target."
},
"text": {
"type": "string",
"description": "The target text detected."
},
"isNegated": {
"type": "boolean",
"description": "The indicator representing if the assessment is negated."
}
},
"required": [
"sentiment",
"confidenceScores",
"offset",
"length",
"text",
"isNegated"
]
},
"SentenceSentiment": {
"type": "object",
"description": "A document's sentence sentiment.",
"properties": {
"text": {
"type": "string",
"description": "The sentence text."
},
"sentiment": {
"$ref": "#/definitions/SentenceSentimentValue",
"description": "The predicted Sentiment for the sentence."
},
"confidenceScores": {
"$ref": "#/definitions/SentimentConfidenceScores",
"description": "The sentiment confidence score between 0 and 1 for the sentence for all classes."
},
"offset": {
"type": "integer",
"format": "int32",
"description": "The target offset from the start of the sentence."
},
"length": {
"type": "integer",
"format": "int32",
"description": "The length of the target."
},
"targets": {
"type": "array",
"description": "The array of sentence targets for the sentence.",
"items": {
"$ref": "#/definitions/SentenceTarget"
}
},
"assessments": {
"type": "array",
"description": "The array of assessments for the sentence.",
"items": {
"$ref": "#/definitions/SentenceAssessment"
}
}
},
"required": [
"text",
"sentiment",
"confidenceScores",
"offset",
"length"
]
},
"SentenceSentimentValue": {
"type": "string",
"description": "The predicted Sentiment for the sentence.",
"enum": [
"positive",
"neutral",
"negative"
],
"x-ms-enum": {
"name": "SentenceSentimentValue",
"modelAsString": false,
"values": [
{
"name": "positive",
"value": "positive",
"description": "Positive sentiment"
},
{
"name": "neutral",
"value": "neutral",
"description": "Neutral sentiment"
},
{
"name": "negative",
"value": "negative",
"description": "Negative sentiment"
}
]
}
},
"SentenceTarget": {
"type": "object",
"description": "Represents a sentence target and the assessments or target objects related to it.",
"properties": {
"sentiment": {
"$ref": "#/definitions/TokenSentimentValue",
"description": "The sentiment of the sentence."
},
"confidenceScores": {
"$ref": "#/definitions/TargetConfidenceScoreLabel",
"description": "Represents the confidence scores across all sentiment classes: positive and negative."
},
"offset": {
"type": "integer",
"format": "int32",
"description": "The target offset from the start of the sentence."
},
"length": {
"type": "integer",
"format": "int32",
"description": "The length of the target."
},
"text": {
"type": "string",
"description": "The target text detected."
},
"relations": {
"type": "array",
"description": "The array of either assessment or target objects which is related to the target.",
"items": {
"$ref": "#/definitions/TargetRelation"
}
}
},
"required": [
"sentiment",
"confidenceScores",
"offset",
"length",
"text",
"relations"
]
},
"SentimentAnalysisLROTask": {
"type": "object",
"description": "An object representing the task definition for a Sentiment Analysis task.",
"properties": {
"parameters": {
"$ref": "#/definitions/SentimentAnalysisTaskParameters",
"description": "Parameters for the Sentiment Analysis task."
}
},
"allOf": [
{
"$ref": "#/definitions/AnalyzeTextLROTask"
}
],
"x-ms-discriminator-value": "SentimentAnalysis"
},
"SentimentAnalysisTaskParameters": {
"type": "object",
"description": "Supported parameters for a Sentiment Analysis task.",
"properties": {
"loggingOptOut": {
"type": "boolean",
"description": "logging opt out",
"default": false
},
"modelVersion": {
"type": "string",
"description": "model version",
"default": "latest"
},
"opinionMining": {
"type": "boolean",
"description": "Whether to use opinion mining in the request or not.",
"default": false
},
"stringIndexType": {
"type": "string",
"description": "Specifies the method used to interpret string offsets.",
"default": "TextElements_v8",
"enum": [
"TextElements_v8",
"UnicodeCodePoint",
"Utf16CodeUnit"
],
"x-ms-enum": {
"name": "StringIndexType",
"modelAsString": true,
"values": [
{
"name": "TextElements_v8",
"value": "TextElements_v8",
"description": "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."
},
{
"name": "UnicodeCodePoint",
"value": "UnicodeCodePoint",
"description": "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."
},
{
"name": "Utf16CodeUnit",
"value": "Utf16CodeUnit",
"description": "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."
}
]
}
}
}
},
"SentimentConfidenceScores": {
"type": "object",
"description": "Represents the confidence scores between 0 and 1 across all sentiment classes: positive, neutral, negative.",
"properties": {
"positive": {
"type": "number",
"format": "double",
"description": "Confidence score for positive sentiment"
},
"neutral": {
"type": "number",
"format": "double",
"description": "Confidence score for neutral sentiment"
},
"negative": {
"type": "number",
"format": "double",
"description": "Confidence score for negative sentiment"
}
},
"required": [
"positive",
"neutral",
"negative"
]
},
"SentimentDocumentResult": {
"type": "object",
"description": "An object representing the pre-built Sentiment Analysis results of each document.",
"properties": {
"id": {
"type": "string",
"description": "Unique, non-empty document identifier."
},
"warnings": {
"type": "array",
"description": "Warnings encountered while processing document.",
"items": {
"$ref": "#/definitions/DocumentWarning"
}
},
"statistics": {
"$ref": "#/definitions/DocumentStatistics",
"description": "if showStats=true was specified in the request this field will contain information about the document payload."
},
"sentiment": {
"$ref": "#/definitions/DocumentSentimentValue",
"description": "Predicted sentiment for document (Negative, Neutral, Positive, or Mixed)."
},
"confidenceScores": {
"$ref": "#/definitions/SentimentConfidenceScores",
"description": "The sentiment confidence score between 0 and 1 for the sentence for all classes."
},
"sentences": {
"type": "array",
"description": "The document's sentences sentiment.",
"items": {
"$ref": "#/definitions/SentenceSentiment"
}
}
},
"required": [
"id",
"warnings",
"sentiment",
"confidenceScores",
"sentences"
]
},
"SentimentLROResult": {
"type": "object",
"description": "Contains the Sentiment Analysis LRO results.",
"properties": {
"results": {
"$ref": "#/definitions/SentimentResponse",
"description": "The sentiment analysis results"
}
},
"required": [
"results"
],
"allOf": [
{
"$ref": "#/definitions/AnalyzeTextLROResult"
}
],
"x-ms-discriminator-value": "SentimentAnalysisLROResults"
},
"SentimentResponse": {
"type": "object",
"description": "Sentiment analysis results for the input documents.",
"properties": {
"errors": {
"type": "array",
"description": "Errors by document id.",
"items": {
"$ref": "#/definitions/DocumentError"
}
},
"statistics": {
"$ref": "#/definitions/RequestStatistics",
"description": "if showStats=true was specified in the request this field will contain information about the request payload."
},
"modelVersion": {
"type": "string",
"description": "This field indicates which model is used for scoring."
},
"documents": {
"type": "array",
"description": "The sentiment analysis results for each document in the input.",
"items": {
"$ref": "#/definitions/SentimentDocumentResult"
}
}
},
"required": [
"errors",
"modelVersion",
"documents"
]
},
"SentimentTaskResult": {
"type": "object",
"description": "Contains the analyze text SentimentAnalysis LRO task result.",
"properties": {
"results": {
"$ref": "#/definitions/SentimentResponse",
"description": "The sentiment analysis results"
}
},
"required": [
"results"
],
"allOf": [
{
"$ref": "#/definitions/AnalyzeTextTaskResult"
}
],
"x-ms-discriminator-value": "SentimentAnalysisResults"
},
"State": {
"type": "string",
"description": "The status of the task at the mentioned last update time.",
"enum": [
"notStarted",
"running",
"succeeded",
"partiallyCompleted",
"failed",
"cancelled",
"cancelling"
],
"x-ms-enum": {
"name": "State",
"modelAsString": true,
"values": [
{
"name": "notStarted",
"value": "notStarted",
"description": "Not started status"
},
{
"name": "running",
"value": "running",
"description": "Running status"
},
{
"name": "succeeded",
"value": "succeeded",
"description": "Succeeded status"
},
{
"name": "partiallyCompleted",
"value": "partiallyCompleted",
"description": "Partially completed status"
},
{
"name": "failed",
"value": "failed",
"description": "Failed status"
},
{
"name": "cancelled",
"value": "cancelled",
"description": "Cancelled status"
},
{
"name": "cancelling",
"value": "cancelling",
"description": "Cancelling status"
}
]
}
},
"TargetConfidenceScoreLabel": {
"type": "object",
"description": "Represents the confidence scores across all sentiment classes: positive and negative.",
"properties": {
"positive": {
"type": "number",
"format": "double",
"description": "Confidence score for positive sentiment"
},
"negative": {
"type": "number",
"format": "double",
"description": "Confidence score for negative sentiment"
}
},
"required": [
"positive",
"negative"
]
},
"TargetRelation": {
"type": "object",
"description": "Represents the relation between assessments and/or targets.",
"properties": {
"ref": {
"type": "string",
"description": "The JSON pointer indicating the linked object."
},
"relationType": {
"$ref": "#/definitions/TargetRelationType",
"description": "The type related to the target."
}
},
"required": [
"ref",
"relationType"
]
},
"TargetRelationType": {
"type": "string",
"description": "The type related to the target.",
"enum": [
"assessment",
"target"
],
"x-ms-enum": {
"name": "TargetRelationType",
"modelAsString": false,
"values": [
{
"name": "assessment",
"value": "assessment",
"description": "Assessment relation."
},
{
"name": "target",
"value": "target",
"description": "Target relation."
}
]
}
},
"Tasks": {
"type": "object",
"description": "Container for the tasks status for the LRO job.",
"properties": {
"completed": {
"type": "integer",
"format": "int32",
"description": "Count of completed tasks."
},
"failed": {
"type": "integer",
"format": "int32",
"description": "Count of failed tasks."
},
"inProgress": {
"type": "integer",
"format": "int32",
"description": "Count of inprogress tasks."
},
"total": {
"type": "integer",
"format": "int32",
"description": "Count of total tasks."
},
"items": {
"type": "array",
"description": "Enumerable of Analyze text job results.",
"items": {
"$ref": "#/definitions/AnalyzeTextLROResult"
}
}
},
"required": [
"completed",
"failed",
"inProgress",
"total"
]
},
"TokenSentimentValue": {
"type": "string",
"description": "The predicted Sentiment for the sentence.",
"enum": [
"positive",
"mixed",
"negative"
],
"x-ms-enum": {
"name": "TokenSentimentValue",
"modelAsString": false,
"values": [
{
"name": "positive",
"value": "positive",
"description": "Positive sentiment"
},
{
"name": "mixed",
"value": "mixed",
"description": "Mixed sentiment"
},
{
"name": "negative",
"value": "negative",
"description": "Negative sentiment"
}
]
}
},
"WarningCodeValue": {
"type": "string",
"description": "Defines the list of the warning codes.",
"enum": [
"LongWordsInDocument",
"DocumentTruncated"
],
"x-ms-enum": {
"name": "WarningCodeValue",
"modelAsString": true,
"values": [
{
"name": "LongWordsInDocument",
"value": "LongWordsInDocument",
"description": "Long words in document warning"
},
{
"name": "DocumentTruncated",
"value": "DocumentTruncated",
"description": "Document truncated warning"
}
]
}
},
"healthcareEntityCategory": {
"type": "string",
"description": "Healthcare Entity Category.",
"enum": [
"BodyStructure",
"Age",
"Gender",
"ExaminationName",
"Date",
"Direction",
"Frequency",
"MeasurementValue",
"MeasurementUnit",
"RelationalOperator",
"Time",
"GeneOrProtein",
"Variant",
"AdministrativeEvent",
"CareEnvironment",
"HealthcareProfession",
"Diagnosis",
"SymptomOrSign",
"ConditionQualifier",
"MedicationClass",
"MedicationName",
"Dosage",
"MedicationForm",
"MedicationRoute",
"FamilyRelation",
"TreatmentName"
],
"x-ms-enum": {
"name": "healthcareEntityCategory",
"modelAsString": true,
"values": [
{
"name": "BodyStructure",
"value": "BodyStructure",
"description": "Body structure"
},
{
"name": "Age",
"value": "Age",
"description": "Age"
},
{
"name": "Gender",
"value": "Gender",
"description": "Gender"
},
{
"name": "ExaminationName",
"value": "ExaminationName",
"description": "Examination name"
},
{
"name": "Date",
"value": "Date",
"description": "Date"
},
{
"name": "Direction",
"value": "Direction",
"description": "Direction"
},
{
"name": "Frequency",
"value": "Frequency",
"description": "Frequency"
},
{
"name": "MeasurementValue",
"value": "MeasurementValue",
"description": "Measurement value"
},
{
"name": "MeasurementUnit",
"value": "MeasurementUnit",
"description": "Measurement unit"
},
{
"name": "RelationalOperator",
"value": "RelationalOperator",
"description": "Relational operator"
},
{
"name": "Time",
"value": "Time",
"description": "Time"
},
{
"name": "GeneOrProtein",
"value": "GeneOrProtein",
"description": "Gene or protein"
},
{
"name": "Variant",
"value": "Variant",
"description": "Variant"
},
{
"name": "AdministrativeEvent",
"value": "AdministrativeEvent",
"description": "Administrative event"
},
{
"name": "CareEnvironment",
"value": "CareEnvironment",
"description": "Care environment"
},
{
"name": "HealthcareProfession",
"value": "HealthcareProfession",
"description": "Healthcare profession"
},
{
"name": "Diagnosis",
"value": "Diagnosis",
"description": "Diagnosis"
},
{
"name": "SymptomOrSign",
"value": "SymptomOrSign",
"description": "Symptom or sign"
},
{
"name": "ConditionQualifier",
"value": "ConditionQualifier",
"description": "Condition qualifier"
},
{
"name": "MedicationClass",
"value": "MedicationClass",
"description": "Medication class"
},
{
"name": "MedicationName",
"value": "MedicationName",
"description": "Medication name"
},
{
"name": "Dosage",
"value": "Dosage",
"description": "Dosage"
},
{
"name": "MedicationForm",
"value": "MedicationForm",
"description": "Medication form"
},
{
"name": "MedicationRoute",
"value": "MedicationRoute",
"description": "Medication route"
},
{
"name": "FamilyRelation",
"value": "FamilyRelation",
"description": "Family relation"
},
{
"name": "TreatmentName",
"value": "TreatmentName",
"description": "Treatment name"
}
]
}
},
"relationType": {
"type": "string",
"description": "Type of relation. Examples include: `DosageOfMedication` or 'FrequencyOfMedication', etc.",
"enum": [
"Abbreviation",
"DirectionOfBodyStructure",
"DirectionOfCondition",
"DirectionOfExamination",
"DirectionOfTreatment",
"DosageOfMedication",
"FormOfMedication",
"FrequencyOfMedication",
"FrequencyOfTreatment",
"QualifierOfCondition",
"RelationOfExamination",
"RouteOfMedication",
"TimeOfCondition",
"TimeOfEvent",
"TimeOfExamination",
"TimeOfMedication",
"TimeOfTreatment",
"UnitOfCondition",
"UnitOfExamination",
"ValueOfCondition",
"ValueOfExamination"
],
"x-ms-enum": {
"name": "relationType",
"modelAsString": true,
"values": [
{
"name": "Abbreviation",
"value": "Abbreviation",
"description": "Abbreviation"
},
{
"name": "DirectionOfBodyStructure",
"value": "DirectionOfBodyStructure",
"description": "Direction of body structure"
},
{
"name": "DirectionOfCondition",
"value": "DirectionOfCondition",
"description": "Direction of condition"
},
{
"name": "DirectionOfExamination",
"value": "DirectionOfExamination",
"description": "Direction of examination"
},
{
"name": "DirectionOfTreatment",
"value": "DirectionOfTreatment",
"description": "Direction of treatment"
},
{
"name": "DosageOfMedication",
"value": "DosageOfMedication",
"description": "Dosage of medication"
},
{
"name": "FormOfMedication",
"value": "FormOfMedication",
"description": "Form of medication"
},
{
"name": "FrequencyOfMedication",
"value": "FrequencyOfMedication",
"description": "Frequency of medication"
},
{
"name": "FrequencyOfTreatment",
"value": "FrequencyOfTreatment",
"description": "Frequency of treatment"
},
{
"name": "QualifierOfCondition",
"value": "QualifierOfCondition",
"description": "Qualifier of condition"
},
{
"name": "RelationOfExamination",
"value": "RelationOfExamination",
"description": "Relation of examination"
},
{
"name": "RouteOfMedication",
"value": "RouteOfMedication",
"description": "Route of medication"
},
{
"name": "TimeOfCondition",
"value": "TimeOfCondition",
"description": "Time of condition"
},
{
"name": "TimeOfEvent",
"value": "TimeOfEvent",
"description": "Time of event"
},
{
"name": "TimeOfExamination",
"value": "TimeOfExamination",
"description": "Time of examination"
},
{
"name": "TimeOfMedication",
"value": "TimeOfMedication",
"description": "Time of medication"
},
{
"name": "TimeOfTreatment",
"value": "TimeOfTreatment",
"description": "Time of treatment"
},
{
"name": "UnitOfCondition",
"value": "UnitOfCondition",
"description": "Unit of condition"
},
{
"name": "UnitOfExamination",
"value": "UnitOfExamination",
"description": "Unit of examination"
},
{
"name": "ValueOfCondition",
"value": "ValueOfCondition",
"description": "Value of condition"
},
{
"name": "ValueOfExamination",
"value": "ValueOfExamination",
"description": "Value of examination"
}
]
}
}
},
"parameters": {
"Azure.Core.Foundations.ApiVersionParameter": {
"name": "api-version",
"in": "query",
"description": "The API version to use for this operation.",
"required": true,
"type": "string",
"minLength": 1,
"x-ms-parameter-location": "method",
"x-ms-client-name": "apiVersion"
}
}
}