Text Analysis Runtime - Analyze Text

Service:

Azure AI Services

API Version:

2024-11-15-preview

Request text analysis over a collection of documents.

POST {Endpoint}/language/:analyze-text?api-version=2024-11-15-preview

With optional parameters:

POST {Endpoint}/language/:analyze-text?api-version=2024-11-15-preview&showStats={showStats}

URI Parameters

Name	In	Required	Type	Description
Endpoint	path	True	string	Supported Cognitive Services endpoint (e.g., https://.api.cognitiveservices.azure.com).
api-version	query	True	string minLength: 1	The API version to use for this operation.
showStats	query		boolean	(Optional) if set to true, response will contain request and document level statistics.

Request Body

The request body can be one of the following:

Name	Description
AnalyzeTextEntityLinkingInput	Contains the analyze text Entity linking input.
AnalyzeTextEntityRecognitionInput	The entity recognition analyze text input task request.
AnalyzeTextKeyPhraseExtractionInput	Contains the analyze text KeyPhraseExtraction task input.
AnalyzeTextLanguageDetectionInput	Contains the language detection document analysis task input.
AnalyzeTextPiiEntitiesRecognitionInput	Contains the analyze text PIIEntityRecognition task input.
AnalyzeTextSentimentAnalysisInput	Contains the analyze text SentimentAnalysis task input.

AnalyzeTextEntityLinkingInput

Contains the analyze text Entity linking input.

Name	Required	Type	Description
kind	True	string: EntityLinking	The kind of task to perform.
analysisInput		MultiLanguageAnalysisInput	Contains the analysis input to be handled by the service.
parameters		EntityLinkingTaskParameters	Task parameters.

AnalyzeTextEntityRecognitionInput

The entity recognition analyze text input task request.

Name	Required	Type	Description
kind	True	string: EntityRecognition	The kind of task to perform.
analysisInput		MultiLanguageAnalysisInput	The input to be analyzed.
parameters		EntitiesTaskParameters	Task parameters.

AnalyzeTextKeyPhraseExtractionInput

Contains the analyze text KeyPhraseExtraction task input.

Name	Required	Type	Description
kind	True	string: KeyPhraseExtraction	The kind of task to perform.
analysisInput		MultiLanguageAnalysisInput	Contains the input documents.
parameters		KeyPhraseTaskParameters	Key phrase extraction task parameters.

AnalyzeTextLanguageDetectionInput

Contains the language detection document analysis task input.

Name	Required	Type	Description
kind	True	string: LanguageDetection	The kind of task to perform.
analysisInput		LanguageDetectionAnalysisInput	Documents to be analyzed.
parameters		LanguageDetectionTaskParameters	task parameters.

AnalyzeTextPiiEntitiesRecognitionInput

Contains the analyze text PIIEntityRecognition task input.

Name	Required	Type	Description
kind	True	string: PiiEntityRecognition	The kind of task to perform.
analysisInput		MultiLanguageAnalysisInput	Contains the input documents.
parameters		PiiTaskParameters	Pii task parameters.

AnalyzeTextSentimentAnalysisInput

Contains the analyze text SentimentAnalysis task input.

Name	Required	Type	Description
kind	True	string: SentimentAnalysis	The kind of task to perform.
analysisInput		MultiLanguageAnalysisInput	Contains the input documents.
parameters		SentimentAnalysisTaskParameters	Sentiment Analysis task parameters.

Responses

Name	Type	Description
200 OK	AnalyzeTextTaskResult: EntitiesTaskResult EntityLinkingTaskResult KeyPhraseTaskResult LanguageDetectionTaskResult PiiTaskResult SentimentTaskResult	The request has succeeded.
Other Status Codes	ErrorResponse	An unexpected error response. Headers x-ms-error-code: string

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

OAuth2Auth

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

Scopes

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

Examples

SuccessfulEntityLinkingRequest

SuccessfulEntityRecognitionExclusionRequest

SuccessfulEntityRecognitionInclusionRequest

SuccessfulEntityRecognitionInferenceOptionsRequest

SuccessfulEntityRecognitionOverlapPolicy

SuccessfulEntityRecognitionRequest

SuccessfulKeyPhraseExtractionRequest

SuccessfulLanguageDetectionRequest

SuccessfulPiiEntityRecognitionExclusionRequest

SuccessfulPiiEntityRecognitionMaskedEntitiesRequest

SuccessfulPiiEntityRecognitionRedactionPolicyRequest

SuccessfulPiiEntityRecognitionRequest

SuccessfulSentimentAnalysisRequest

SuccessfulEntityLinkingRequest

Sample request

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2024-11-15-preview

{
  "kind": "EntityLinking",
  "parameters": {
    "modelVersion": "latest"
  },
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "language": "en",
        "text": "Microsoft was founded by Bill Gates and Paul Allen."
      },
      {
        "id": "2",
        "language": "en",
        "text": "Pike place market is my favorite Seattle attraction."
      }
    ]
  }
}

Sample response

Status code:

200

{
  "kind": "EntityLinkingResults",
  "results": {
    "documents": [
      {
        "entities": [
          {
            "dataSource": "Wikipedia",
            "id": "Bill Gates",
            "language": "en",
            "matches": [
              {
                "confidenceScore": 0.52,
                "length": 10,
                "offset": 25,
                "text": "Bill Gates"
              }
            ],
            "name": "Bill Gates",
            "url": "https://en.wikipedia.org/wiki/Bill_Gates"
          },
          {
            "dataSource": "Wikipedia",
            "id": "Paul Allen",
            "language": "en",
            "matches": [
              {
                "confidenceScore": 0.54,
                "length": 10,
                "offset": 40,
                "text": "Paul Allen"
              }
            ],
            "name": "Paul Allen",
            "url": "https://en.wikipedia.org/wiki/Paul_Allen"
          },
          {
            "dataSource": "Wikipedia",
            "id": "Microsoft",
            "language": "en",
            "matches": [
              {
                "confidenceScore": 0.49,
                "length": 9,
                "offset": 0,
                "text": "Microsoft"
              }
            ],
            "name": "Microsoft",
            "url": "https://en.wikipedia.org/wiki/Microsoft"
          }
        ],
        "id": "1",
        "warnings": []
      },
      {
        "entities": [
          {
            "dataSource": "Wikipedia",
            "id": "Pike Place Market",
            "language": "en",
            "matches": [
              {
                "confidenceScore": 0.86,
                "length": 17,
                "offset": 0,
                "text": "Pike place market"
              }
            ],
            "name": "Pike Place Market",
            "url": "https://en.wikipedia.org/wiki/Pike_Place_Market"
          },
          {
            "dataSource": "Wikipedia",
            "id": "Seattle",
            "language": "en",
            "matches": [
              {
                "confidenceScore": 0.27,
                "length": 7,
                "offset": 33,
                "text": "Seattle"
              }
            ],
            "name": "Seattle",
            "url": "https://en.wikipedia.org/wiki/Seattle"
          }
        ],
        "id": "2",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2020-02-01"
  }
}

SuccessfulEntityRecognitionExclusionRequest

Sample request

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2024-11-15-preview

{
  "kind": "EntityRecognition",
  "parameters": {
    "modelVersion": "latest",
    "exclusionList": [
      "Numeric"
    ],
    "overlapPolicy": {
      "policyKind": "allowOverlap"
    }
  },
  "analysisInput": {
    "documents": [
      {
        "id": "2",
        "language": "en",
        "text": "When I was 5 years old I had $90.00 dollars to my name."
      },
      {
        "id": "3",
        "language": "en",
        "text": "When we flew from LAX it seemed like we were moving at 10 meters per second. I was lucky to see Amsterdam, Effile Tower, and the Nile."
      }
    ]
  }
}

Sample response

Status code:

200

{
  "kind": "EntityRecognitionResults",
  "results": {
    "documents": [
      {
        "entities": [],
        "id": "2",
        "warnings": []
      },
      {
        "entities": [
          {
            "text": "LAX",
            "category": "Location",
            "type": "Airport",
            "offset": 18,
            "length": 3,
            "confidenceScore": 0.72,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Structural",
                "confidenceScore": 0.72
              }
            ]
          },
          {
            "text": "Amsterdam",
            "category": "Location",
            "type": "City",
            "offset": 96,
            "length": 9,
            "confidenceScore": 0.8,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.84
              },
              {
                "name": "GPE",
                "confidenceScore": 0.84
              },
              {
                "name": "City",
                "confidenceScore": 0.8
              }
            ]
          },
          {
            "text": "Eiffel Tower",
            "category": "Location",
            "type": "Structural",
            "offset": 107,
            "length": 12,
            "confidenceScore": 0.9,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Structural",
                "confidenceScore": 0.9
              }
            ]
          },
          {
            "text": "Nile",
            "category": "Location",
            "type": "Geological",
            "offset": 129,
            "length": 4,
            "confidenceScore": 0.63,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Geological",
                "confidenceScore": 0.63
              }
            ]
          }
        ],
        "id": "3",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-06-01"
  }
}

SuccessfulEntityRecognitionInclusionRequest

Sample request

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2024-11-15-preview

{
  "kind": "EntityRecognition",
  "parameters": {
    "modelVersion": "latest",
    "inclusionList": [
      "Location"
    ]
  },
  "analysisInput": {
    "documents": [
      {
        "id": "2",
        "language": "en",
        "text": "When I was 5 years old I had $90.00 dollars to my name."
      },
      {
        "id": "3",
        "language": "en",
        "text": "When we flew from LAX it seemed like we were moving at 10 meters per second. I was lucky to see Amsterdam, Effile Tower, and the Nile."
      }
    ]
  }
}

Sample response

Status code:

200

{
  "kind": "EntityRecognitionResults",
  "results": {
    "documents": [
      {
        "entities": [],
        "id": "2",
        "warnings": []
      },
      {
        "entities": [
          {
            "text": "LAX",
            "category": "Location",
            "type": "Structural",
            "offset": 18,
            "length": 3,
            "confidenceScore": 0.72,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Structural",
                "confidenceScore": 0.72
              }
            ]
          },
          {
            "text": "Amsterdam",
            "category": "Location",
            "type": "City",
            "offset": 96,
            "length": 9,
            "confidenceScore": 0.8,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.84
              },
              {
                "name": "GPE",
                "confidenceScore": 0.84
              },
              {
                "name": "City",
                "confidenceScore": 0.8
              }
            ]
          },
          {
            "text": "Eiffel Tower",
            "category": "Location",
            "type": "Structural",
            "offset": 107,
            "length": 12,
            "confidenceScore": 0.9,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Structural",
                "confidenceScore": 0.9
              }
            ]
          },
          {
            "text": "Nile",
            "category": "Location",
            "type": "Geological",
            "offset": 129,
            "length": 4,
            "confidenceScore": 0.63,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Geological",
                "confidenceScore": 0.63
              }
            ]
          }
        ],
        "id": "3",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-06-01"
  }
}

SuccessfulEntityRecognitionInferenceOptionsRequest

Sample request

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2024-11-15-preview

{
  "kind": "EntityRecognition",
  "parameters": {
    "modelVersion": "latest",
    "inferenceOptions": {
      "excludeNormalizedValues": true
    }
  },
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "language": "en",
        "text": "When I was 5 years old I had $90.00 dollars to my name."
      }
    ]
  }
}

Sample response

Status code:

200

{
  "kind": "EntityRecognitionResults",
  "results": {
    "documents": [
      {
        "entities": [
          {
            "text": "5 years old",
            "category": "Numeric",
            "type": "Age",
            "offset": 11,
            "length": 11,
            "confidenceScore": 0.99,
            "tags": [
              {
                "name": "Numeric",
                "confidenceScore": 0.99
              },
              {
                "name": "Age",
                "confidenceScore": 0.99
              }
            ]
          },
          {
            "text": "$90.00",
            "category": "Numeric",
            "type": "Currency",
            "offset": 29,
            "length": 14,
            "confidenceScore": 0.99,
            "tags": [
              {
                "name": "Numeric",
                "confidenceScore": 0.99
              },
              {
                "name": "Currency",
                "confidenceScore": 0.99
              }
            ]
          }
        ],
        "id": "1",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2023-09-01"
  }
}

SuccessfulEntityRecognitionOverlapPolicy

Sample request

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2024-11-15-preview

{
  "kind": "EntityRecognition",
  "parameters": {
    "modelVersion": "latest",
    "overlapPolicy": {
      "policyKind": "matchLongest"
    }
  },
  "analysisInput": {
    "documents": [
      {
        "id": "4",
        "language": "en",
        "text": "25th April Meeting was an intresting one. At least we gont to experience the WorldCup"
      }
    ]
  }
}

Sample response

Status code:

200

{
  "kind": "EntityRecognitionResults",
  "results": {
    "documents": [
      {
        "entities": [
          {
            "text": "25th April Meeting",
            "category": "Event",
            "type": "Event",
            "offset": 0,
            "length": 18,
            "confidenceScore": 0.59,
            "tags": [
              {
                "name": "Event",
                "confidenceScore": 0.59
              }
            ]
          },
          {
            "text": "Worldcup",
            "category": "Event",
            "type": "SportsEvent",
            "offset": 0,
            "length": 8,
            "confidenceScore": 0.51,
            "tags": [
              {
                "name": "Event",
                "confidenceScore": 0.55
              },
              {
                "name": "SportsEvent",
                "confidenceScore": 0.51
              }
            ]
          }
        ],
        "id": "4",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-06-01"
  }
}

SuccessfulEntityRecognitionRequest

Sample request

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2024-11-15-preview

{
  "kind": "EntityRecognition",
  "parameters": {
    "modelVersion": "latest",
    "overlapPolicy": {
      "policyKind": "allowOverlap"
    }
  },
  "analysisInput": {
    "documents": [
      {
        "id": "2",
        "language": "en",
        "text": "When I was 5 years old I had $90.00 dollars to my name."
      },
      {
        "id": "3",
        "language": "en",
        "text": "When we flew from LAX it seemed like we were moving at 10 meters per second. I was lucky to see Amsterdam, Effile Tower, and the Nile."
      },
      {
        "id": "4",
        "language": "en",
        "text": "25th April Meeting was an intresting one. At least we gont to experience the WorldCup"
      },
      {
        "id": "5",
        "language": "en",
        "text": "My IP is 127.12.1.1 and my phone   number is 5555555555"
      }
    ]
  }
}

Sample response

Status code:

200

{
  "kind": "EntityRecognitionResults",
  "results": {
    "documents": [
      {
        "entities": [
          {
            "text": "5 years old",
            "category": "Numeric",
            "type": "Age",
            "offset": 11,
            "length": 11,
            "confidenceScore": 0.99,
            "tags": [
              {
                "name": "Numeric",
                "confidenceScore": 0.99
              },
              {
                "name": "Age",
                "confidenceScore": 0.99
              }
            ],
            "metadata": {
              "metadataKind": "AgeMetadata",
              "unit": "Year",
              "value": 5
            }
          },
          {
            "text": "$90.00",
            "category": "Numeric",
            "type": "Currency",
            "offset": 29,
            "length": 14,
            "confidenceScore": 0.99,
            "tags": [
              {
                "name": "Numeric",
                "confidenceScore": 0.99
              },
              {
                "name": "Currency",
                "confidenceScore": 0.99
              }
            ],
            "metadata": {
              "metadataKind": "CurrencyMetadata",
              "unit": "Dollar",
              "iso4217": "USD",
              "value": 90
            }
          }
        ],
        "id": "2",
        "warnings": []
      },
      {
        "entities": [
          {
            "text": "LAX",
            "category": "Location",
            "type": "Structural",
            "offset": 18,
            "length": 3,
            "confidenceScore": 0.72,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Structural",
                "confidenceScore": 0.72
              }
            ]
          },
          {
            "text": "10 meters per second",
            "category": "Numeric",
            "type": "Speed",
            "offset": 55,
            "length": 20,
            "confidenceScore": 0.8,
            "tags": [
              {
                "name": "Dimension",
                "confidenceScore": 0.84
              },
              {
                "name": "Numeric",
                "confidenceScore": 0.84
              },
              {
                "name": "Speed",
                "confidenceScore": 0.8
              }
            ],
            "metadata": {
              "metadataKind": "SpeedMetadata",
              "unit": "MetersPerSecond",
              "value": 10
            }
          },
          {
            "text": "Amsterdam",
            "category": "Location",
            "type": "City",
            "offset": 96,
            "length": 9,
            "confidenceScore": 0.8,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.84
              },
              {
                "name": "GPE",
                "confidenceScore": 0.84
              },
              {
                "name": "City",
                "confidenceScore": 0.8
              }
            ]
          },
          {
            "text": "Eiffel Tower",
            "category": "Location",
            "type": "Structural",
            "offset": 107,
            "length": 12,
            "confidenceScore": 0.9,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Structural",
                "confidenceScore": 0.9
              }
            ]
          },
          {
            "text": "Nile",
            "category": "Location",
            "type": "Geological",
            "offset": 129,
            "length": 4,
            "confidenceScore": 0.63,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Geological",
                "confidenceScore": 0.63
              }
            ]
          }
        ],
        "id": "3",
        "warnings": []
      },
      {
        "entities": [
          {
            "text": "25th April",
            "category": "Temporal",
            "type": "Date",
            "offset": 0,
            "length": 10,
            "confidenceScore": 0.58,
            "tags": [
              {
                "name": "Temporal",
                "confidenceScore": 0.9
              },
              {
                "name": "Date",
                "confidenceScore": 0.58
              }
            ],
            "metadata": {
              "metadataKind": "DateMetadata",
              "dateValues": [
                {
                  "timex": "XXXX-04-25",
                  "value": "2022-04-25"
                },
                {
                  "timex": "XXXX-04-25",
                  "value": "2023-04-25"
                }
              ]
            }
          },
          {
            "text": "25th April Meeting",
            "category": "Event",
            "type": "Event",
            "offset": 0,
            "length": 18,
            "confidenceScore": 0.55,
            "tags": [
              {
                "name": "Event",
                "confidenceScore": 0.55
              }
            ]
          },
          {
            "text": "25th April Meeting",
            "category": "Event",
            "type": "CulturalEvent",
            "offset": 0,
            "length": 18,
            "confidenceScore": 0.55,
            "tags": [
              {
                "name": "Event",
                "confidenceScore": 0.55
              },
              {
                "name": "CulturalEvent",
                "confidenceScore": 0.55
              }
            ]
          },
          {
            "text": "Worldcup",
            "category": "Event",
            "type": "SportsEvent",
            "offset": 0,
            "length": 8,
            "confidenceScore": 0.51,
            "tags": [
              {
                "name": "Event",
                "confidenceScore": 0.55
              },
              {
                "name": "SportsEvent",
                "confidenceScore": 0.51
              }
            ]
          }
        ],
        "id": "4",
        "warnings": []
      },
      {
        "entities": [
          {
            "text": "127.12.1.1",
            "category": "IP",
            "type": "IP",
            "offset": 9,
            "length": 10,
            "confidenceScore": 0.8,
            "tags": [
              {
                "name": "IP",
                "confidenceScore": 0.8
              }
            ]
          },
          {
            "text": "5555555555",
            "category": "PhoneNumber",
            "type": "PhoneNumber",
            "offset": 45,
            "length": 9,
            "confidenceScore": 0.8,
            "tags": [
              {
                "name": "PhoneNumber",
                "confidenceScore": 0.8
              }
            ]
          }
        ],
        "id": "5",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-06-01"
  }
}

SuccessfulKeyPhraseExtractionRequest

Sample request

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2024-11-15-preview

{
  "kind": "KeyPhraseExtraction",
  "parameters": {
    "modelVersion": "latest"
  },
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "language": "en",
        "text": "Microsoft was founded by Bill Gates and Paul Allen."
      },
      {
        "id": "2",
        "language": "en",
        "text": "Text Analytics is one of the Azure Cognitive Services."
      },
      {
        "id": "3",
        "language": "en",
        "text": "My cat might need to see a veterinarian."
      }
    ]
  }
}

Sample response

Status code:

200

{
  "kind": "KeyPhraseExtractionResults",
  "results": {
    "documents": [
      {
        "id": "1",
        "keyPhrases": [
          "Bill Gates",
          "Paul Allen",
          "Microsoft"
        ],
        "warnings": []
      },
      {
        "id": "2",
        "keyPhrases": [
          "Azure Cognitive Services",
          "Text Analytics"
        ],
        "warnings": []
      },
      {
        "id": "3",
        "keyPhrases": [
          "cat",
          "veterinarian"
        ],
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-06-01"
  }
}

SuccessfulLanguageDetectionRequest

Sample request

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2024-11-15-preview

{
  "kind": "LanguageDetection",
  "parameters": {
    "modelVersion": "latest"
  },
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "text": "Hello world"
      },
      {
        "id": "2",
        "text": "Bonjour tout le monde"
      },
      {
        "id": "3",
        "text": "Hola mundo"
      },
      {
        "id": "4",
        "text": "Tumhara naam kya hai?"
      }
    ]
  }
}

Sample response

Status code:

200

{
  "kind": "LanguageDetectionResults",
  "results": {
    "documents": [
      {
        "detectedLanguage": {
          "confidenceScore": 1,
          "iso6391Name": "en",
          "name": "English",
          "scriptName": "Latin",
          "scriptIso15924Code": "Latn"
        },
        "id": "1",
        "warnings": []
      },
      {
        "detectedLanguage": {
          "confidenceScore": 1,
          "iso6391Name": "fr",
          "name": "French",
          "scriptName": "Latin",
          "scriptIso15924Code": "Latn"
        },
        "id": "2",
        "warnings": []
      },
      {
        "detectedLanguage": {
          "confidenceScore": 1,
          "iso6391Name": "es",
          "name": "Spanish",
          "scriptName": "Latin",
          "scriptIso15924Code": "Latn"
        },
        "id": "3",
        "warnings": []
      },
      {
        "detectedLanguage": {
          "confidenceScore": 1,
          "iso6391Name": "hi",
          "name": "Hindi",
          "scriptName": "Latin",
          "scriptIso15924Code": "Latn"
        },
        "id": "4",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2023-12-01"
  }
}

SuccessfulPiiEntityRecognitionExclusionRequest

Sample request

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2024-11-15-preview

{
  "kind": "PiiEntityRecognition",
  "parameters": {
    "modelVersion": "latest",
    "excludePiiCategories": [
      "USSocialSecurityNumber"
    ]
  },
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "language": "en",
        "text": "My SSN is 859-98-0987"
      },
      {
        "id": "2",
        "language": "en",
        "text": "Your ABA number - 111000025 - is the first 9 digits in the lower left hand corner of your personal check."
      },
      {
        "id": "3",
        "language": "en",
        "text": "Is 998.214.865-68 your Brazilian CPF number?"
      }
    ]
  }
}

Sample response

Status code:

200

{
  "kind": "PiiEntityRecognitionResults",
  "results": {
    "documents": [
      {
        "id": "2",
        "redactedText": "Your ABA number - ********* - is the first 9 digits in the lower left hand corner of your personal check.",
        "entities": [
          {
            "category": "ABARoutingNumber",
            "type": "ABARoutingNumber",
            "confidenceScore": 0.75,
            "length": 9,
            "offset": 18,
            "text": "111000025",
            "tags": [
              {
                "name": "Number",
                "confidenceScore": 0.8
              },
              {
                "name": "Numeric",
                "confidenceScore": 0.8
              }
            ]
          }
        ],
        "warnings": []
      },
      {
        "id": "3",
        "redactedText": "Is ************** your Brazilian CPF number?",
        "entities": [
          {
            "category": "BRCPFNumber",
            "type": "BRCPFNumber",
            "confidenceScore": 0.85,
            "length": 14,
            "offset": 3,
            "text": "998.214.865-68",
            "tags": [
              {
                "name": "Number",
                "confidenceScore": 0.8
              },
              {
                "name": "Numeric",
                "confidenceScore": 0.8
              }
            ]
          }
        ],
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-01-15"
  }
}

SuccessfulPiiEntityRecognitionMaskedEntitiesRequest

Sample request

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2024-11-15-preview

{
  "kind": "PiiEntityRecognition",
  "parameters": {
    "modelVersion": "latest",
    "redactionPolicy": {
      "policyKind": "entityMask"
    }
  },
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "language": "en",
        "text": "My name is John Doe My phone number is 424 878 9192"
      }
    ]
  }
}

Sample response

Status code:

200

{
  "kind": "PiiEntityRecognitionResults",
  "results": {
    "documents": [
      {
        "id": "1",
        "redactedText": "My name is [PERSON_1] My phone number is [PHONENUMBER_1]",
        "entities": [
          {
            "category": "Person",
            "type": "Person",
            "tags": [
              {
                "name": "Person",
                "confidenceScore": 0.65
              }
            ],
            "length": 8,
            "offset": 11,
            "mask": "[Person_1]",
            "maskOffset": 11,
            "maskLength": 9,
            "text": "John Doe",
            "confidenceScore": 0.65
          },
          {
            "category": "PhoneNumber",
            "type": "PhoneNumber",
            "tags": [
              {
                "name": "PhoneNumber",
                "confidenceScore": 0.8
              }
            ],
            "length": 12,
            "offset": 36,
            "mask": "[PHONENUMBER_1]",
            "maskOffset": 41,
            "maskLength": 13,
            "text": "424 878 9192",
            "confidenceScore": 0.8
          }
        ],
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-01-15"
  }
}

SuccessfulPiiEntityRecognitionRedactionPolicyRequest

Sample request

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2024-11-15-preview

{
  "kind": "PiiEntityRecognition",
  "parameters": {
    "modelVersion": "latest",
    "redactionPolicy": {
      "policyKind": "characterMask",
      "redactionCharacter": "-"
    }
  },
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "language": "en",
        "text": "My SSN is 859-98-0987"
      },
      {
        "id": "2",
        "language": "en",
        "text": "Your ABA number - 111000025 - is the first 9 digits in the lower left hand corner of your personal check."
      },
      {
        "id": "3",
        "language": "en",
        "text": "Is 998.214.865-68 your Brazilian CPF number?"
      }
    ]
  }
}

Sample response

Status code:

200

{
  "kind": "PiiEntityRecognitionResults",
  "results": {
    "documents": [
      {
        "id": "1",
        "redactedText": "My SSN is -----------",
        "entities": [
          {
            "category": "USSocialSecurityNumber",
            "type": "USSocialSecurityNumber",
            "confidenceScore": 0.65,
            "length": 11,
            "offset": 28,
            "text": "859-98-0987",
            "tags": [
              {
                "name": "Number",
                "confidenceScore": 0.8
              },
              {
                "name": "Numeric",
                "confidenceScore": 0.8
              }
            ]
          }
        ],
        "warnings": []
      },
      {
        "id": "2",
        "redactedText": "Your ABA number - --------- - is the first 9 digits in the lower left hand corner of your personal check.",
        "entities": [
          {
            "category": "ABARoutingNumber",
            "type": "ABARoutingNumber",
            "confidenceScore": 0.75,
            "length": 9,
            "offset": 18,
            "text": "111000025",
            "tags": [
              {
                "name": "Number",
                "confidenceScore": 0.8
              },
              {
                "name": "Numeric",
                "confidenceScore": 0.8
              }
            ]
          }
        ],
        "warnings": []
      },
      {
        "id": "3",
        "redactedText": "Is -------------- your Brazilian CPF number?",
        "entities": [
          {
            "category": "BRCPFNumber",
            "type": "",
            "confidenceScore": 0.85,
            "length": 14,
            "offset": 3,
            "text": "998.214.865-68",
            "tags": [
              {
                "name": "Number",
                "confidenceScore": 0.8
              },
              {
                "name": "Numeric",
                "confidenceScore": 0.8
              }
            ]
          }
        ],
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-01-15"
  }
}

SuccessfulPiiEntityRecognitionRequest

Sample request

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2024-11-15-preview

{
  "kind": "PiiEntityRecognition",
  "parameters": {
    "modelVersion": "latest"
  },
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "language": "en",
        "text": "My SSN is 859-98-0987"
      },
      {
        "id": "2",
        "language": "en",
        "text": "Your ABA number - 111000025 - is the first 9 digits in the lower left hand corner of your personal check."
      },
      {
        "id": "3",
        "language": "en",
        "text": "Is 998.214.865-68 your Brazilian CPF number?"
      }
    ]
  }
}

Sample response

Status code:

200

{
  "kind": "PiiEntityRecognitionResults",
  "results": {
    "documents": [
      {
        "id": "1",
        "redactedText": "My SSN is ***********",
        "entities": [
          {
            "category": "USSocialSecurityNumber",
            "type": "USSocialSecurityNumber",
            "confidenceScore": 0.65,
            "length": 11,
            "offset": 28,
            "text": "859-98-0987",
            "tags": [
              {
                "name": "Number",
                "confidenceScore": 0.8
              },
              {
                "name": "Numeric",
                "confidenceScore": 0.8
              }
            ]
          }
        ],
        "warnings": []
      },
      {
        "id": "2",
        "redactedText": "Your ABA number - ********* - is the first 9 digits in the lower left hand corner of your personal check.",
        "entities": [
          {
            "category": "ABARoutingNumber",
            "type": "ABARoutingNumber",
            "confidenceScore": 0.75,
            "length": 9,
            "offset": 18,
            "text": "111000025",
            "tags": [
              {
                "name": "Number",
                "confidenceScore": 0.8
              },
              {
                "name": "Numeric",
                "confidenceScore": 0.8
              }
            ]
          }
        ],
        "warnings": []
      },
      {
        "id": "3",
        "redactedText": "Is ************** your Brazilian CPF number?",
        "entities": [
          {
            "category": "BRCPFNumber",
            "type": "BRCPFNumber",
            "confidenceScore": 0.85,
            "length": 14,
            "offset": 3,
            "text": "998.214.865-68",
            "tags": [
              {
                "name": "Number",
                "confidenceScore": 0.8
              },
              {
                "name": "Numeric",
                "confidenceScore": 0.8
              }
            ]
          }
        ],
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-01-15"
  }
}

SuccessfulSentimentAnalysisRequest

Sample request

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2024-11-15-preview

{
  "kind": "SentimentAnalysis",
  "parameters": {
    "modelVersion": "latest"
  },
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "language": "en",
        "text": "Great atmosphere. Close to plenty of restaurants, hotels, and transit! Staff are friendly and helpful."
      }
    ]
  }
}

Sample response

Status code:

200

{
  "kind": "SentimentAnalysisResults",
  "results": {
    "documents": [
      {
        "confidenceScores": {
          "negative": 0,
          "neutral": 0,
          "positive": 1
        },
        "id": "1",
        "sentences": [
          {
            "targets": [
              {
                "confidenceScores": {
                  "negative": 0,
                  "positive": 1
                },
                "length": 10,
                "offset": 6,
                "relations": [
                  {
                    "ref": "#/documents/0/sentences/0/assessments/0",
                    "relationType": "assessment"
                  }
                ],
                "sentiment": "positive",
                "text": "atmosphere"
              }
            ],
            "confidenceScores": {
              "negative": 0,
              "neutral": 0,
              "positive": 1
            },
            "length": 17,
            "offset": 0,
            "assessments": [
              {
                "confidenceScores": {
                  "negative": 0,
                  "positive": 1
                },
                "isNegated": false,
                "length": 5,
                "offset": 0,
                "sentiment": "positive",
                "text": "great"
              }
            ],
            "sentiment": "positive",
            "text": "Great atmosphere."
          },
          {
            "targets": [
              {
                "confidenceScores": {
                  "negative": 0.01,
                  "positive": 0.99
                },
                "length": 11,
                "offset": 37,
                "relations": [
                  {
                    "ref": "#/documents/0/sentences/1/assessments/0",
                    "relationType": "assessment"
                  }
                ],
                "sentiment": "positive",
                "text": "restaurants"
              },
              {
                "confidenceScores": {
                  "negative": 0.01,
                  "positive": 0.99
                },
                "length": 6,
                "offset": 50,
                "relations": [
                  {
                    "ref": "#/documents/0/sentences/1/assessments/0",
                    "relationType": "assessment"
                  }
                ],
                "sentiment": "positive",
                "text": "hotels"
              }
            ],
            "confidenceScores": {
              "negative": 0.01,
              "neutral": 0.86,
              "positive": 0.13
            },
            "length": 52,
            "offset": 18,
            "assessments": [
              {
                "confidenceScores": {
                  "negative": 0.01,
                  "positive": 0.99
                },
                "isNegated": false,
                "length": 15,
                "offset": 18,
                "sentiment": "positive",
                "text": "Close to plenty"
              }
            ],
            "sentiment": "neutral",
            "text": "Close to plenty of restaurants, hotels, and transit!"
          }
        ],
        "sentiment": "positive",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-10-01"
  }
}

Definitions

Name	Description
AgeMetadata	Represents the Age entity Metadata model.
AgeUnit	The Age Unit of measurement
AllowOverlapEntityPolicyType	Represents the allow overlap policy. Will apply no post processing logic for the entities. Whatever the model predicts is what will be returned to the user. This allows the user to get a full view of every single model's possible values and apply their own custom logic on entity selection
AnalyzeTextEntityLinkingInput	Contains the analyze text Entity linking input.
AnalyzeTextEntityRecognitionInput	The entity recognition analyze text input task request.
AnalyzeTextKeyPhraseExtractionInput	Contains the analyze text KeyPhraseExtraction task input.
AnalyzeTextLanguageDetectionInput	Contains the language detection document analysis task input.
AnalyzeTextPiiEntitiesRecognitionInput	Contains the analyze text PIIEntityRecognition task input.
AnalyzeTextSentimentAnalysisInput	Contains the analyze text SentimentAnalysis task input.
AnalyzeTextTaskKind	The kind of the analyze-text tasks supported.
AnalyzeTextTaskResultsKind	The kind of the response object returned by the analyze-text task.
AreaMetadata	Represents the Area entity Metadata model.
AreaUnit	The area unit of measurement.
CharacterMaskPolicyType	Represents the policy of redacting with a redaction character
CurrencyMetadata	Represents the Currency ) entity Metadata model.
DateMetadata	A Metadata for date entity instances.
DateTimeMetadata	A Metadata for datetime entity instances.
DateValue	Represents the date value.
DetectedLanguage	Contains the details of the detected language for the text.
DocumentError	Contains details of errors encountered during a job execution.
DocumentSentimentValue	Predicted sentiment for document (Negative, Neutral, Positive, or Mixed).
DocumentStatistics	if showStats=true was specified in the request this field will contain information about the document payload.
DocumentWarning	Contains the warnings object with warnings encountered for the processed document.
EntitiesDocumentResultWithMetadataDetectedLanguage	Contains the entity recognition task result for the document with metadata and detected language.
EntitiesTaskParameters	Supported parameters for an Entity Recognition task.
EntitiesTaskResult	Contains the entity task
EntitiesWithMetadataAutoResult	Contains the entity recognition task result.
EntityCategory	Contains all the entity categories detected by entity recognition.
EntityInferenceOptions	The class that houses the inference options allowed for named entity recognition.
EntityLinkingResult	Entity linking result.
EntityLinkingResultWithDetectedLanguage	Entity linking document result with auto language detection.
EntityLinkingTaskParameters	Supported parameters for an Entity Linking task.
EntityLinkingTaskResult	Contains the analyze text Entity linking task result.
EntityMaskPolicyType	Represents the policy of redacting PII with the entity type.
EntityTag	Entity tag object which contains the name of the tags abd any associated confidence score. Entity Tags are used to express some similarities/affinity between entities.
EntityWithMetadata	Entity object with tags and metadata.
Error	The error response object returned when the service encounters some errors during processing the request.
ErrorCode	Human-readable error code.
ErrorResponse	Error response.
InformationMetadata	Represents the Information (data) entity Metadata model.
InformationUnit	The information (data) Unit of measurement.
InnerErrorCode	Human-readable error code.
InnerErrorModel	An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
KeyPhraseResult	Contains the KeyPhraseResult.
KeyPhrasesDocumentResultWithDetectedLanguage	A ranked list of sentences representing the extracted summary.
KeyPhraseTaskParameters	Supported parameters for a Key Phrase Extraction task.
KeyPhraseTaskResult	Contains the analyze text KeyPhraseExtraction task result.
LanguageDetectionAnalysisInput	Contains the language detection document analysis input.
LanguageDetectionDocumentResult	Contains the language detection for a document.
LanguageDetectionResult	Contains the language detection result for the request.
LanguageDetectionTaskParameters	Supported parameters for a Language Detection task.
LanguageDetectionTaskResult	Contains the language detection task result for the request.
LanguageInput	Contains the language detection input.
LengthMetadata	Represents the Length entity Metadata model.
LengthUnit	The length unit of measurement.
LinkedEntity	The LinkedEntity object containing the detected entity with the associated sources/links.
Match	The Match object containing the detected entity text with the offset and the length.
MatchLongestEntityPolicyType	Represents the Match longest overlap policy. No overlapping entities as far as it is possible. 1. If there are overlapping entities, the longest one will be returned. 2. If the set of characters predicted for 2 or more entities are exactly the same, select the entity that has the higher confidence score.3. If the entity scores are identical, return all entities that are still present after applying the previous rules. 3. If there is partial overlap (as in Hello Text Analytics) follow the above steps starting from 1.
MetadataKind	The entity Metadata object kind.
MultiLanguageAnalysisInput	Collection of input documents to be analyzed by the service.
MultiLanguageInput	Contains an input document to be analyzed by the service.
NoMaskPolicyType	Represents the policy of not redacting found PII.
NumberKind	The type of the extracted number entity.
NumberMetadata	A metadata for numeric entity instances.
NumericRangeMetadata	represents the Metadata of numeric intervals.
OrdinalMetadata	A metadata for numeric entity instances.
PiiCategoriesExclude	(Optional) describes the PII categories to return
PiiCategory	(Optional) describes the PII categories to return
PiiDomain	Domain for PII task
PiiEntityWithTags	Entity object with tags.
PiiResult	Contains the PiiResult.
PiiResultWithDetectedLanguage	Contains the PII results with detected language.
PiiTaskParameters	Supported parameters for a PII Entities Recognition task.
PiiTaskResult	Contains the analyze text PIIEntityRecognition LRO task.
RangeInclusivity	The range inclusiveness of this property property.
RangeKind	The kind of the number range entity.
redactionCharacter	Optional parameter to use a Custom Character to be used for redaction in PII responses. Default character will be * as before. We allow specific ascii characters for redaction.
RelativeTo	The reference point that the ordinal number denotes.
RequestStatistics	if showStats=true was specified in the request this field will contain information about the request payload.
ScriptCode	Identifies the script of the input document. Maps to the ISO 15924 standard script code.
ScriptKind	Identifies the script of the input document. Maps to the ISO 15924 standard formal name.
SentenceAssessment	Represents a sentence assessment and the assessments or target objects related to it.
SentenceSentiment	A document's sentence sentiment.
SentenceSentimentValue	The predicted Sentiment for the sentence.
SentenceTarget	Represents a sentence target and the assessments or target objects related to it.
SentimentAnalysisTaskParameters	Supported parameters for a Sentiment Analysis task.
SentimentConfidenceScores	Represents the confidence scores between 0 and 1 across all sentiment classes: positive, neutral, negative.
SentimentDocumentResultWithDetectedLanguage	Sentiment analysis per document.
SentimentResponse	Sentiment analysis results for the input documents.
SentimentTaskResult	Contains the analyze text SentimentAnalysis LRO task result.
SpeedMetadata	Represents the Speed entity Metadata model.
SpeedUnit	The speed Unit of measurement
StringIndexType	String index type
TargetConfidenceScoreLabel	Represents the confidence scores across all sentiment classes: positive and negative.
TargetRelation	Represents the relation between assessments and/or targets.
TargetRelationType	The type related to the target.
TemperatureMetadata	Represents the Information entity Metadata model.
TemperatureUnit	The temperature Unit of measurement.
TemporalModifier	An optional modifier of a date/time instance.
TemporalSetMetadata	A Metadata for temporal set entity instances.
TemporalSpanMetadata	represents the Metadata of a date and/or time span.
TemporalSpanValues	Temporal span object.
TimeMetadata	A Metadata for time entity instances.
TokenSentimentValue	The predicted Sentiment for the sentence.
VolumeMetadata	Represents the Volume entity Metadata model.
VolumeUnit	The Volume Unit of measurement
WarningCodeValue	Defines the list of the warning codes.
WeightMetadata	Represents the Weight ) entity Metadata model.
WeightUnit	The weight Unit of measurement.

AgeMetadata

Object

Represents the Age entity Metadata model.

Name	Type	Description
metadataKind	string: AgeMetadata	The entity Metadata object kind.
unit	AgeUnit	Unit of measure for age.
value	number (double)	The numeric value that the extracted text denotes.

AgeUnit

Enumeration

The Age Unit of measurement

Value	Description
Day	Time period of a day
Month	Time period of a month
Unspecified	Unspecified time period
Week	Time period of a week
Year	Time period of a year

AllowOverlapEntityPolicyType

Object

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

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

AnalyzeTextEntityLinkingInput

Object

Contains the analyze text Entity linking input.

Name	Type	Description
analysisInput	MultiLanguageAnalysisInput	Contains the analysis input to be handled by the service.
kind	string: EntityLinking	The kind of task to perform.
parameters	EntityLinkingTaskParameters	Task parameters.

AnalyzeTextEntityRecognitionInput

Object

The entity recognition analyze text input task request.

Name	Type	Description
analysisInput	MultiLanguageAnalysisInput	The input to be analyzed.
kind	string: EntityRecognition	The kind of task to perform.
parameters	EntitiesTaskParameters	Task parameters.

AnalyzeTextKeyPhraseExtractionInput

Object

Contains the analyze text KeyPhraseExtraction task input.

Name	Type	Description
analysisInput	MultiLanguageAnalysisInput	Contains the input documents.
kind	string: KeyPhraseExtraction	The kind of task to perform.
parameters	KeyPhraseTaskParameters	Key phrase extraction task parameters.

AnalyzeTextLanguageDetectionInput

Object

Contains the language detection document analysis task input.

Name	Type	Description
analysisInput	LanguageDetectionAnalysisInput	Documents to be analyzed.
kind	string: LanguageDetection	The kind of task to perform.
parameters	LanguageDetectionTaskParameters	task parameters.

AnalyzeTextPiiEntitiesRecognitionInput

Object

Contains the analyze text PIIEntityRecognition task input.

Name	Type	Description
analysisInput	MultiLanguageAnalysisInput	Contains the input documents.
kind	string: PiiEntityRecognition	The kind of task to perform.
parameters	PiiTaskParameters	Pii task parameters.

AnalyzeTextSentimentAnalysisInput

Object

Contains the analyze text SentimentAnalysis task input.

Name	Type	Description
analysisInput	MultiLanguageAnalysisInput	Contains the input documents.
kind	string: SentimentAnalysis	The kind of task to perform.
parameters	SentimentAnalysisTaskParameters	Sentiment Analysis task parameters.

AnalyzeTextTaskKind

Enumeration

The kind of the analyze-text tasks supported.

Value	Description
EntityLinking	Entity linking task
EntityRecognition	Entity recognition task
KeyPhraseExtraction	Key phrase extraction task
LanguageDetection	Language detection task
PiiEntityRecognition	PII entity recognition task
SentimentAnalysis	Sentiment analysis task

AnalyzeTextTaskResultsKind

Enumeration

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

Value	Description
EntityLinkingResults	Entity linking results
EntityRecognitionResults	Entity recognition results
KeyPhraseExtractionResults	Key phrase extraction results
LanguageDetectionResults	Language detection results
PiiEntityRecognitionResults	PII entity recognition results
SentimentAnalysisResults	Sentiment analysis results

AreaMetadata

Object

Represents the Area entity Metadata model.

Name	Type	Description
metadataKind	string: AreaMetadata	The entity Metadata object kind.
unit	AreaUnit	Unit of measure for area.
value	number (double)	The numeric value that the extracted text denotes.

AreaUnit

Enumeration

The area unit of measurement.

Value	Description
Acre	Area unit in acres
SquareCentimeter	Area unit in square centimeters
SquareDecameter	Area unit in square decameters
SquareDecimeter	Area unit in square decimeters
SquareFoot	Area unit in square feet
SquareHectometer	Area unit in square hectometers
SquareInch	Area unit in square inches
SquareKilometer	Area unit in square kilometers
SquareMeter	Area unit in square meters
SquareMile	Area unit in square miles
SquareMillimeter	Area unit in square millimeters
SquareYard	Area unit in square yards
Unspecified	Unspecified area unit

CharacterMaskPolicyType

Object

Represents the policy of redacting with a redaction character

Name	Type	Default value	Description
policyKind	string: characterMask	characterMask	The entity RedactionPolicy object kind.
redactionCharacter	redactionCharacter	*	Optional parameter to use a Custom Character to be used for redaction in PII responses. Default character will be * as before. We allow specific ascii characters for redaction.

CurrencyMetadata

Object

Represents the Currency ) entity Metadata model.

Name	Type	Description
iso4217	string	The alphabetic code based on another ISO standard, ISO 3166, which lists the codes for country names. The first two letters of the ISO 4217 three-letter code are the same as the code for the country name, and, where possible, the third letter corresponds to the first letter of the currency name.
metadataKind	string: CurrencyMetadata	The entity Metadata object kind.
unit	string	Currency unit.
value	number (double)	The numeric value that the extracted text denotes.

DateMetadata

Object

A Metadata for date entity instances.

Name	Type	Description
dateValues	DateValue[]	List of date values.
metadataKind	string: DateMetadata	The entity Metadata object kind.

DateTimeMetadata

Object

A Metadata for datetime entity instances.

Name	Type	Description
dateValues	DateValue[]	List of date values.
metadataKind	string: DateTimeMetadata	The entity Metadata object kind.

DateValue

Object

Represents the date value.

Name	Type	Description
modifier	TemporalModifier	Modifier for datetime to indicate point of reference like before, after etc.
timex	string	An extended ISO 8601 date/time representation as described in (https://github.com/Microsoft/Recognizers-Text/blob/master/Patterns/English/English-DateTime.yaml)
value	string	The actual time that the extracted text denote.

DetectedLanguage

Object

Contains the details of the detected language for the text.

Name	Type	Description
confidenceScore	number (double)	A confidence score between 0 and 1. Scores close to 1 indicate 100% certainty that the identified language is true.
iso6391Name	string	A two letter representation of the detected language according to the ISO 639-1 standard (e.g. en, fr).
name	string	Long name of a detected language (e.g. English, French).
scriptIso15924Code	ScriptCode	Identifies the script code of the input document according to the ISO 15924 standard.
scriptName	ScriptKind	Identifies the script name of the input document according to the ISO 15924 standard.

DocumentError

Object

Contains details of errors encountered during a job execution.

Name	Type	Description
error	Error	Error encountered.
id	string	The ID of the input document.

DocumentSentimentValue

Enumeration

Predicted sentiment for document (Negative, Neutral, Positive, or Mixed).

Value	Description
mixed	Mixed statement
negative	Negative statement
neutral	Neutral statement
positive	Positive statement

DocumentStatistics

Object

if showStats=true was specified in the request this field will contain information about the document payload.

Name	Type	Description
charactersCount	integer (int32)	Number of text elements recognized in the document.
transactionsCount	integer (int32)	Number of transactions for the document.

DocumentWarning

Object

Contains the warnings object with warnings encountered for the processed document.

Name	Type	Description
code	WarningCodeValue	Warning code.
message	string	Warning message.
targetRef	string	A JSON pointer reference indicating the target object.

EntitiesDocumentResultWithMetadataDetectedLanguage

Object

Contains the entity recognition task result for the document with metadata and detected language.

Name	Type	Description
detectedLanguage	DetectedLanguage	If 'language' is set to 'auto' for the document in the request this field will contain a 2 letter ISO 639-1 representation of the language detected for this document.
entities	EntityWithMetadata[]	Recognized entities in the document.
id	string	Unique, non-empty document identifier.
statistics	DocumentStatistics	if showStats=true was specified in the request this field will contain information about the document payload.
warnings	DocumentWarning[]	Warnings encountered while processing document.

EntitiesTaskParameters

Object

Supported parameters for an Entity Recognition task.

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

EntitiesTaskResult

Object

Contains the entity task

Name	Type	Description
kind	string: EntityRecognitionResults	The kind of task result.
results	EntitiesWithMetadataAutoResult	Results for entity recognition.

EntitiesWithMetadataAutoResult

Object

Contains the entity recognition task result.

Name	Type	Description
documents	EntitiesDocumentResultWithMetadataDetectedLanguage[]	Response by document
errors	DocumentError[]	Errors by document id.
modelVersion	string	This field indicates which model is used for scoring.
statistics	RequestStatistics	if showStats=true was specified in the request this field will contain information about the request payload.

EntityCategory

Enumeration

Contains all the entity categories detected by entity recognition.

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

EntityInferenceOptions

Object

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

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

EntityLinkingResult

Object

Entity linking result.

Name	Type	Description
documents	EntityLinkingResultWithDetectedLanguage[]	Response by document
errors	DocumentError[]	Errors by document id.
modelVersion	string	This field indicates which model is used for scoring.
statistics	RequestStatistics	if showStats=true was specified in the request this field will contain information about the request payload.

EntityLinkingResultWithDetectedLanguage

Object

Entity linking document result with auto language detection.

Name	Type	Description
detectedLanguage	DetectedLanguage	If 'language' is set to 'auto' for the document in the request this field will contain a 2 letter ISO 639-1 representation of the language detected for this document.
entities	LinkedEntity[]	Recognized well known entities in the document.
id	string	Unique, non-empty document identifier.
statistics	DocumentStatistics	if showStats=true was specified in the request this field will contain information about the document payload.
warnings	DocumentWarning[]	Warnings encountered while processing document.

EntityLinkingTaskParameters

Object

Supported parameters for an Entity Linking task.

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

EntityLinkingTaskResult

Object

Contains the analyze text Entity linking task result.

Name	Type	Description
kind	string: EntityLinkingResults	The kind of task result.
results	EntityLinkingResult	Entity linking result.

EntityMaskPolicyType

Object

Represents the policy of redacting PII with the entity type.

Name	Type	Default value	Description
policyKind	string: entityMask	characterMask	The entity RedactionPolicy object kind.

EntityTag

Object

Entity tag object which contains the name of the tags abd any associated confidence score. Entity Tags are used to express some similarities/affinity between entities.

Name	Type	Description
confidenceScore	number (double)	Detection score between 0 and 1 of the extracted entity.
name	string	Name of the tag. Entity Tag names will be unique globally.

EntityWithMetadata

Object

Entity object with tags and metadata.

Name	Type	Description
category	string	Entity type.
confidenceScore	number (double)	Confidence score between 0 and 1 of the extracted entity.
length	integer (int32)	Length for the entity text. Use of different 'stringIndexType' values can affect the length returned.
metadata	BaseMetadata: AgeMetadata AreaMetadata CurrencyMetadata DateMetadata DateTimeMetadata InformationMetadata LengthMetadata NumberMetadata NumericRangeMetadata OrdinalMetadata SpeedMetadata TemperatureMetadata TemporalSetMetadata TemporalSpanMetadata TimeMetadata VolumeMetadata WeightMetadata	The entity metadata object.
offset	integer (int32)	Start position for the entity text. Use of different 'stringIndexType' values can affect the offset returned.
subcategory	string	(Optional) Entity sub type.
tags	EntityTag[]	List of entity tags. Tags are to express some similarities/affinity between entities.
text	string	Entity text as appears in the request.
type	string	An entity type is the lowest (or finest) granularity at which the entity has been detected. The type maps to the specific metadata attributes associated with the entity detected.

Error

Object

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

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

ErrorCode

Enumeration

Human-readable error code.

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

ErrorResponse

Object

Error response.

Name	Type	Description
error	Error	The error object.

InformationMetadata

Object

Represents the Information (data) entity Metadata model.

Name	Type	Description
metadataKind	string: InformationMetadata	The entity Metadata object kind.
unit	InformationUnit	Unit of measure for information.
value	number (double)	The numeric value that the extracted text denotes.

InformationUnit

Enumeration

The information (data) Unit of measurement.

Value	Description
Bit	Data size unit in bits
Byte	Data size unit in bytes
Gigabit	Data size unit in gigabits
Gigabyte	Data size unit in gigabytes
Kilobit	Data size unit in kilobits
Kilobyte	Data size unit in kilobytes
Megabit	Data size unit in megabits
Megabyte	Data size unit in megabytes
Petabit	Data size unit in petabits
Petabyte	Data size unit in petabytes
Terabit	Data size unit in terabits
Terabyte	Data size unit in terabytes
Unspecified	Unspecified data size unit

InnerErrorCode

Enumeration

Human-readable error code.

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

InnerErrorModel

Object

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

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

KeyPhraseResult

Object

Contains the KeyPhraseResult.

Name	Type	Description
documents	KeyPhrasesDocumentResultWithDetectedLanguage[]	Response by document
errors	DocumentError[]	Errors by document id.
modelVersion	string	This field indicates which model is used for scoring.
statistics	RequestStatistics	if showStats=true was specified in the request this field will contain information about the request payload.

KeyPhrasesDocumentResultWithDetectedLanguage

Object

A ranked list of sentences representing the extracted summary.

Name	Type	Description
detectedLanguage	DetectedLanguage	If 'language' is set to 'auto' for the document in the request this field will contain a 2 letter ISO 639-1 representation of the language detected for this document.
id	string	Unique, non-empty document identifier.
keyPhrases	string[]	A list of representative words or phrases. The number of key phrases returned is proportional to the number of words in the input document.
statistics	DocumentStatistics	if showStats=true was specified in the request this field will contain information about the document payload.
warnings	DocumentWarning[]	Warnings encountered while processing document.

KeyPhraseTaskParameters

Object

Supported parameters for a Key Phrase Extraction task.

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

KeyPhraseTaskResult

Object

Contains the analyze text KeyPhraseExtraction task result.

Name	Type	Description
kind	string: KeyPhraseExtractionResults	The kind of task result.
results	KeyPhraseResult	The list of Key phrase extraction results

LanguageDetectionAnalysisInput

Object

Contains the language detection document analysis input.

Name	Type	Description
documents	LanguageInput[]	List of documents to be analyzed.

LanguageDetectionDocumentResult

Object

Contains the language detection for a document.

Name	Type	Description
detectedLanguage	DetectedLanguage	Detected Language.
id	string	Unique, non-empty document identifier.
statistics	DocumentStatistics	if showStats=true was specified in the request this field will contain information about the document payload.
warnings	DocumentWarning[]	Warnings encountered while processing document.

LanguageDetectionResult

Object

Contains the language detection result for the request.

Name	Type	Description
documents	LanguageDetectionDocumentResult[]	Enumeration of language detection results for each input document.
errors	DocumentError[]	Errors by document id.
modelVersion	string	This field indicates which model is used for scoring.
statistics	RequestStatistics	if showStats=true was specified in the request this field will contain information about the request payload.

LanguageDetectionTaskParameters

Object

Supported parameters for a Language Detection task.

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

LanguageDetectionTaskResult

Object

Contains the language detection task result for the request.

Name	Type	Description
kind	string: LanguageDetectionResults	The kind of task result.
results	LanguageDetectionResult	Contains the language detection results.

LanguageInput

Object

Contains the language detection input.

Name	Type	Description
countryHint	string	The country hint to help with language detection of the text.
id	string	A unique, non-empty document identifier.
text	string	The input text to process.

LengthMetadata

Object

Represents the Length entity Metadata model.

Name	Type	Description
metadataKind	string: LengthMetadata	The entity Metadata object kind.
unit	LengthUnit	Unit of measure for length.
value	number (double)	The numeric value that the extracted text denotes.

LengthUnit

Enumeration

The length unit of measurement.

Value	Description
Centimeter	Length unit in centimeters.
Decameter	Length unit in decameters.
Decimeter	Length unit in decimeters.
Foot	Length unit in feet.
Hectometer	Length unit in hectometers.
Inch	Length unit in inches.
Kilometer	Length unit in kilometers.
LightYear	Length unit in light years.
Meter	Length unit in meters.
Micrometer	Length unit in micrometers.
Mile	Length unit in miles.
Millimeter	Length unit in millimeters.
Nanometer	Length unit in nanometers.
Picometer	Length unit in picometers.
Point	Length unit in points.
Unspecified	Unspecified length unit.
Yard	Length unit in yards.

LinkedEntity

Object

The LinkedEntity object containing the detected entity with the associated sources/links.

Name	Type	Description
bingId	string	Bing Entity Search API unique identifier of the recognized entity.
dataSource	string	Data source used to extract entity linking, such as Wiki/Bing etc.
id	string	Unique identifier of the recognized entity from the data source.
language	string	Language used in the data source.
matches	Match[]	List of instances this entity appears in the text.
name	string	Entity Linking formal name.
url	string	URL for the entity's page from the data source.

Match

Object

The Match object containing the detected entity text with the offset and the length.

Name	Type	Description
confidenceScore	number (double)	If a well known item is recognized, a decimal number denoting the confidence level between 0 and 1 will be returned.
length	integer (int32)	Length for the entity match text.
offset	integer (int32)	Start position for the entity match text.
text	string	Entity text as appears in the request.

MatchLongestEntityPolicyType

Object

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

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

MetadataKind

Enumeration

The entity Metadata object kind.

Value	Description
AgeMetadata	Metadata for age-related values.
AreaMetadata	Metadata for area-related values.
CurrencyMetadata	Metadata for currency-related values.
DateMetadata	Metadata for date-related values.
DateTimeMetadata	Metadata for date and time-related values.
InformationMetadata	Metadata for information-related values.
LengthMetadata	Metadata for length-related values.
NumberMetadata	Metadata for numeric values.
NumericRangeMetadata	Metadata for numeric range values.
OrdinalMetadata	Metadata for ordinal numbers.
SpeedMetadata	Metadata for speed-related values.
TemperatureMetadata	Metadata for temperature-related values.
TemporalSetMetadata	Metadata for set of time-related values.
TemporalSpanMetadata	Metadata for temporal span values.
TimeMetadata	Metadata for time-related values.
VolumeMetadata	Metadata for volume-related values.
WeightMetadata	Metadata for weight-related values.

MultiLanguageAnalysisInput

Object

Collection of input documents to be analyzed by the service.

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

MultiLanguageInput

Object

Contains an input document to be analyzed by the service.

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

NoMaskPolicyType

Object

Represents the policy of not redacting found PII.

Name	Type	Default value	Description
policyKind	string: noMask	characterMask	The entity RedactionPolicy object kind.

NumberKind

Enumeration

The type of the extracted number entity.

Value	Description
Decimal	Decimal number
Fraction	Fraction number
Integer	Integer number
Percent	Percent number
Power	Power number
Unspecified	Unspecified number kind

NumberMetadata

Object

A metadata for numeric entity instances.

Name	Type	Description
metadataKind	string: NumberMetadata	The entity Metadata object kind.
numberKind	NumberKind	Kind of the number type.
value	number (double)	A numeric representation of what the extracted text denotes.

NumericRangeMetadata

Object

represents the Metadata of numeric intervals.

Name	Type	Description
maximum	number (double)	The ending value of the interval.
metadataKind	string: NumericRangeMetadata	The entity Metadata object kind.
minimum	number (double)	The beginning value of the interval.
rangeInclusivity	RangeInclusivity	The inclusiveness of this range.
rangeKind	RangeKind	Kind of numeric ranges supported - like Number, Speed, etc.

OrdinalMetadata

Object

A metadata for numeric entity instances.

Name	Type	Description
metadataKind	string: OrdinalMetadata	The entity Metadata object kind.
offset	string	The offset with respect to the reference (e.g., offset = -1 indicates the second to last)
relativeTo	RelativeTo	The reference point that the ordinal number denotes.
value	string	A simple arithmetic expression that the ordinal denotes.

PiiCategoriesExclude

Enumeration

(Optional) describes the PII categories to return

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

PiiCategory

Enumeration

(Optional) describes the PII categories to return

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

PiiDomain

Enumeration

Domain for PII task

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

PiiEntityWithTags

Object

Entity object with tags.

Name	Type	Description
category	string	Entity type.
confidenceScore	number (double)	Confidence score between 0 and 1 of the extracted entity.
length	integer (int32)	Length for the entity text. Use of different 'stringIndexType' values can affect the length returned.
mask	string	Optional field which will be returned only when using the redaction policy kind “MaskWithEntityType”. This field will contain the exact mask text used to mask the PII entity in the original text
maskLength	integer (int32)	The length of the masked text. Will be present when using the redaction policy kind “MaskWithEntityType”.
maskOffset	integer (int32)	Start position of masked text in the redacted text when using the redaction policy kind “MaskWithEntityType”.
offset	integer (int32)	Start position for the entity text. Use of different 'stringIndexType' values can affect the offset returned.
subcategory	string	(Optional) Entity sub type.
tags	EntityTag[]	List of entity tags. Tags are to express some similarities/affinity between entities.
text	string	Entity text as appears in the request.
type	string	An entity type is the lowest (or finest) granularity at which the entity has been detected. The type maps to the specific metadata attributes associated with the entity detected.

PiiResult

Object

Contains the PiiResult.

Name	Type	Description
documents	PiiResultWithDetectedLanguage[]	Response by document
errors	DocumentError[]	Errors by document id.
modelVersion	string	This field indicates which model is used for scoring.
statistics	RequestStatistics	if showStats=true was specified in the request this field will contain information about the request payload.

PiiResultWithDetectedLanguage

Object

Contains the PII results with detected language.

Name	Type	Description
detectedLanguage	DetectedLanguage	If 'language' is set to 'auto' for the document in the request this field will contain a 2 letter ISO 639-1 representation of the language detected for this document.
entities	PiiEntityWithTags[]	Recognized entities in the document.
id	string	Unique, non-empty document identifier.
redactedText	string	Returns redacted text.
statistics	DocumentStatistics	if showStats=true was specified in the request this field will contain information about the document payload.
warnings	DocumentWarning[]	Warnings encountered while processing document.

PiiTaskParameters

Object

Supported parameters for a PII Entities Recognition task.

Name	Type	Default value	Description
domain	PiiDomain	none	Domain for PII task
excludePiiCategories	PiiCategoriesExclude[]		Enumeration of PII categories to be excluded in the response.
loggingOptOut	boolean	False	logging opt out
modelVersion	string	latest	model version
piiCategories	PiiCategory[]		Enumeration of PII categories to be returned in the response.
redactionPolicy	BaseRedactionPolicy: CharacterMaskPolicyType EntityMaskPolicyType NoMaskPolicyType		RedactionPolicy to be used on the input.
stringIndexType	StringIndexType	TextElements_v8	StringIndexType to be used for analysis.

PiiTaskResult

Object

Contains the analyze text PIIEntityRecognition LRO task.

Name	Type	Description
kind	string: PiiEntityRecognitionResults	The kind of task result.
results	PiiResult	The list of pii results

RangeInclusivity

Enumeration

The range inclusiveness of this property property.

Value	Description
LeftInclusive	Left side inclusive
LeftRightInclusive	Both sides inclusive
NoneInclusive	No inclusivity
RightInclusive	Right side inclusive

RangeKind

Enumeration

The kind of the number range entity.

Value	Description
Age	Age range
Area	Area range
Currency	Currency range
Information	Information range
Length	Length range
Number	Number range
Speed	Speed range
Temperature	Temperature range
Volume	Volume range
Weight	Weight range

redactionCharacter

Enumeration

Optional parameter to use a Custom Character to be used for redaction in PII responses. Default character will be * as before. We allow specific ascii characters for redaction.

Value	Description
!	Exclamation point character
#	Number sign character
$	Dollar sign character
%	Percent sign character
&	Ampersand character
*	Asterisk character
+	Plus sign character
-	Minus sign character
=	Equals sign character
?	Question mark character
@	At sign character
^	Caret character
_	Underscore character
~	Tilde character

RelativeTo

Enumeration

The reference point that the ordinal number denotes.

Value	Description
Current	Current state or position
End	End state or position
Start	Start state or position

RequestStatistics

Object

if showStats=true was specified in the request this field will contain information about the request payload.

Name	Type	Description
documentsCount	integer (int32)	Number of documents submitted in the request.
erroneousDocumentsCount	integer (int32)	Number of invalid documents. This includes empty, over-size limit or non-supported languages documents.
transactionsCount	integer (int64)	Number of transactions for the request.
validDocumentsCount	integer (int32)	Number of valid documents. This excludes empty, over-size limit or non-supported languages documents.

ScriptCode

Enumeration

Identifies the script of the input document. Maps to the ISO 15924 standard script code.

Value	Description
Arab	Script code for the Arabic script.
Armn	Script code for the Armenian script.
Beng	Script code for the Bangla script.
Cans	Script code for the UnifiedCanadianAboriginalSyllabics script.
Cyrl	Script code for the Cyrillic script.
Deva	Script code for the Devanagari script.
Ethi	Script code for the Ethiopic script.
Geor	Script code for the Georgian script.
Grek	Script code for the Greek script.
Gujr	Script code for the Gujarati script.
Guru	Script code for the Gurmukhi script.
Hang	Script code for the Hangul script.
Hani	Script code for the HanLiteral script.
Hans	Script code for the HanSimplified script.
Hant	Script code for the HanTraditional script.
Hebr	Script code for the Hebrew script.
Jpan	Script code for the Japanese script.
Khmr	Script code for the Khmer script.
Knda	Script code for the Kannada script.
Laoo	Script code for the Lao script.
Latn	Script code for the Latin script.
Mlym	Script code for the Malayalam script.
Mong	Script code for the Mongolian script.
Mtei	Script code for the Meitei script.
Mymr	Script code for the Myanmar script.
Olck	Script code for the Santali script.
Orya	Script code for the Odia script.
Shrd	Script code for the Sharada script.
Sinh	Script code for the Sinhala script.
Taml	Script code for the Tamil script.
Telu	Script code for the Telugu script.
Thaa	Script code for the Thaana script.
Thai	Script code for the Thai script.
Tibt	Script code for the Tibetan script.

ScriptKind

Enumeration

Identifies the script of the input document. Maps to the ISO 15924 standard formal name.

Value	Description
Arabic	Script name for the Arabic script.
Armenian	Script name for the Armenian script.
Bangla	Script name for the Bangla script.
Cyrillic	Script name for the Cyrillic script.
Devanagari	Script name for the Devanagari script.
Ethiopic	Script name for the Ethiopic script.
Georgian	Script name for the Georgian script.
Greek	Script name for the Greek script.
Gujarati	Script name for the Gujarati script.
Gurmukhi	Script name for the Gurmukhi script.
HanLiteral	Script name for the HanLiteral script.
HanSimplified	Script name for the HanSimplified script.
HanTraditional	Script name for the HanTraditional script.
Hangul	Script name for the Hangul script.
Hebrew	Script name for the Hebrew script.
Japanese	Script name for the Japanese script.
Kannada	Script name for the Kannada script.
Khmer	Script name for the Khmer script.
Lao	Script name for the Lao script.
Latin	Script name for the Latin script.
Malayalam	Script name for the Malayalam script.
Meitei	Script name for the Meitei script.
Mongolian	Script name for the Mongolian script.
Myanmar	Script name for the Myanmar script.
Odia	Script name for the Odia script.
Santali	Script name for the Santali script.
Sharada	Script name for the Sharada script.
Sinhala	Script name for the Sinhala script.
Tamil	Script name for the Tamil script.
Telugu	Script name for the Telugu script.
Thaana	Script name for the Thaana script.
Thai	Script name for the Thai script.
Tibetan	Script name for the Tibetan script.
UnifiedCanadianAboriginalSyllabics	Script name for the UnifiedCanadianAboriginalSyllabics script.

SentenceAssessment

Object

Represents a sentence assessment and the assessments or target objects related to it.

Name	Type	Description
confidenceScores	TargetConfidenceScoreLabel	Represents the confidence scores across all sentiment classes: positive and negative.
isNegated	boolean	The indicator representing if the assessment is negated.
length	integer (int32)	The length of the target.
offset	integer (int32)	The target offset from the start of the sentence.
sentiment	TokenSentimentValue	The sentiment of the sentence.
text	string	The target text detected.

SentenceSentiment

Object

A document's sentence sentiment.

Name	Type	Description
assessments	SentenceAssessment[]	The array of assessments for the sentence.
confidenceScores	SentimentConfidenceScores	The sentiment confidence score between 0 and 1 for the sentence for all classes.
length	integer (int32)	The length of the target.
offset	integer (int32)	The target offset from the start of the sentence.
sentiment	SentenceSentimentValue	The predicted Sentiment for the sentence.
targets	SentenceTarget[]	The array of sentence targets for the sentence.
text	string	The sentence text.

SentenceSentimentValue

Enumeration

The predicted Sentiment for the sentence.

Value	Description
negative	Negative sentiment
neutral	Neutral sentiment
positive	Positive sentiment

SentenceTarget

Object

Represents a sentence target and the assessments or target objects related to it.

Name	Type	Description
confidenceScores	TargetConfidenceScoreLabel	Represents the confidence scores across all sentiment classes: positive and negative.
length	integer (int32)	The length of the target.
offset	integer (int32)	The target offset from the start of the sentence.
relations	TargetRelation[]	The array of either assessment or target objects which is related to the target.
sentiment	TokenSentimentValue	The sentiment of the sentence.
text	string	The target text detected.

SentimentAnalysisTaskParameters

Object

Supported parameters for a Sentiment Analysis task.

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

SentimentConfidenceScores

Object

Represents the confidence scores between 0 and 1 across all sentiment classes: positive, neutral, negative.

Name	Type	Description
negative	number (double)	Confidence score for negative sentiment
neutral	number (double)	Confidence score for neutral sentiment
positive	number (double)	Confidence score for positive sentiment

SentimentDocumentResultWithDetectedLanguage

Object

Sentiment analysis per document.

Name	Type	Description
confidenceScores	SentimentConfidenceScores	The sentiment confidence score between 0 and 1 for the sentence for all classes.
detectedLanguage	DetectedLanguage	If 'language' is set to 'auto' for the document in the request this field will contain a 2 letter ISO 639-1 representation of the language detected for this document.
id	string	Unique, non-empty document identifier.
sentences	SentenceSentiment[]	The document's sentences sentiment.
sentiment	DocumentSentimentValue	Predicted sentiment for document (Negative, Neutral, Positive, or Mixed).
statistics	DocumentStatistics	if showStats=true was specified in the request this field will contain information about the document payload.
warnings	DocumentWarning[]	Warnings encountered while processing document.

SentimentResponse

Object

Sentiment analysis results for the input documents.

Name	Type	Description
documents	SentimentDocumentResultWithDetectedLanguage[]	The sentiment analysis results for each document in the input.
errors	DocumentError[]	Errors by document id.
modelVersion	string	This field indicates which model is used for scoring.
statistics	RequestStatistics	if showStats=true was specified in the request this field will contain information about the request payload.

SentimentTaskResult

Object

Contains the analyze text SentimentAnalysis LRO task result.

Name	Type	Description
kind	string: SentimentAnalysisResults	The kind of task result.
results	SentimentResponse	The sentiment analysis results

SpeedMetadata

Object

Represents the Speed entity Metadata model.

Name	Type	Description
metadataKind	string: SpeedMetadata	The entity Metadata object kind.
unit	SpeedUnit	Unit of measure for speed.
value	number (double)	The numeric value that the extracted text denotes.

SpeedUnit

Enumeration

The speed Unit of measurement

Value	Description
CentimetersPerMillisecond	Speed unit in centimeters per millisecond.
FeetPerMinute	Speed unit in feet per minute.
FeetPerSecond	Speed unit in feet per second.
KilometersPerHour	Speed unit in kilometers per hour.
KilometersPerMillisecond	Speed unit in Kilometers per millisecond.
KilometersPerMinute	Speed unit in kilometers per minute.
KilometersPerSecond	Speed unit in kilometers per second.
Knots	Speed unit in knots.
MetersPerMillisecond	Speed unit in meters per millisecond.
MetersPerSecond	Speed unit in meters per second.
MilesPerHour	Speed unit in miles per hour.
Unspecified	Unspecified speed unit.
YardsPerMinute	Speed unit in yards per minute.
YardsPerSecond	Speed unit in yards per second.

StringIndexType

Enumeration

String index type

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

TargetConfidenceScoreLabel

Object

Represents the confidence scores across all sentiment classes: positive and negative.

Name	Type	Description
negative	number (double)	Confidence score for negative sentiment
positive	number (double)	Confidence score for positive sentiment

TargetRelation

Object

Represents the relation between assessments and/or targets.

Name	Type	Description
ref	string	The JSON pointer indicating the linked object.
relationType	TargetRelationType	The type related to the target.

TargetRelationType

Enumeration

The type related to the target.

Value	Description
assessment	Assessment relation.
target	Target relation.

TemperatureMetadata

Object

Represents the Information entity Metadata model.

Name	Type	Description
metadataKind	string: TemperatureMetadata	The entity Metadata object kind.
unit	TemperatureUnit	Unit of measure for temperature.
value	number (double)	The numeric value that the extracted text denotes.

TemperatureUnit

Enumeration

The temperature Unit of measurement.

Value	Description
Celsius	Temperature unit in Celsius
Fahrenheit	Temperature unit in Fahrenheit
Kelvin	Temperature unit in Kelvin
Rankine	Temperature unit in Rankine
Unspecified	Unspecified temperature unit

TemporalModifier

Enumeration

An optional modifier of a date/time instance.

Value	Description
After	After a specific time
AfterApprox	After an approximate time
AfterMid	After the middle of a time period
AfterStart	After the start of a time period
Approx	Approximately at a specific time
Before	Before a specific time
BeforeApprox	Before an approximate time
BeforeEnd	Before the end of a time period
BeforeStart	Before the start of a time period
End	At the end of a time period
Less	Less than a specific time
Mid	In the middle of a time period
More	More than a specific time
ReferenceUndefined	Reference to an undefined time
Since	Since a specific time
SinceEnd	Since the end of a time period
Start	At the start of a time period
Until	Until a specific time

TemporalSetMetadata

Object

A Metadata for temporal set entity instances.

Name	Type	Description
dateValues	DateValue[]	List of date values.
metadataKind	string: TemporalSetMetadata	The entity Metadata object kind.

TemporalSpanMetadata

Object

represents the Metadata of a date and/or time span.

Name	Type	Description
metadataKind	string: TemporalSpanMetadata	The entity Metadata object kind.
spanValues	TemporalSpanValues[]	List of temporal spans detected.

TemporalSpanValues

Object

Temporal span object.

Name	Type	Description
begin	string	Start value for the span.
duration	string	An optional duration value formatted based on the ISO 8601 (https://en.wikipedia.org/wiki/ISO_8601#Durations)
end	string	End value for the span.
modifier	TemporalModifier	Modifier for datetime to indicate point of reference like before, after etc.
timex	string	An optional triplet containing the beginning, the end, and the duration all stated as ISO 8601 formatted strings.

TimeMetadata

Object

A Metadata for time entity instances.

Name	Type	Description
dateValues	DateValue[]	List of date values.
metadataKind	string: TimeMetadata	The entity Metadata object kind.

TokenSentimentValue

Enumeration

The predicted Sentiment for the sentence.

Value	Description
mixed	Mixed sentiment
negative	Negative sentiment
positive	Positive sentiment

VolumeMetadata

Object

Represents the Volume entity Metadata model.

Name	Type	Description
metadataKind	string: VolumeMetadata	The entity Metadata object kind.
unit	VolumeUnit	Unit of measure for volume.
value	number (double)	The numeric value that the extracted text denotes.

VolumeUnit

Enumeration

The Volume Unit of measurement

Value	Description
Barrel	Volume unit in barrels.
Bushel	Volume unit in bushels.
Centiliter	Volume unit in centiliters.
Cord	Volume unit in cords.
CubicCentimeter	Volume unit in cubic centimeters.
CubicFoot	Volume unit in cubic feet.
CubicInch	Volume unit in cubic inches.
CubicMeter	Volume unit in cubic meters.
CubicMile	Volume unit in cubic miles.
CubicMillimeter	Volume unit in cubic millimeters.
CubicYard	Volume unit in cubic yards.
Cup	Volume unit in cups.
Decaliter	Volume unit in decaliters.
FluidDram	Volume unit in fluid drams.
FluidOunce	Volume unit in fluid ounces.
Gill	Volume unit in gills.
Hectoliter	Volume unit in hectoliters.
Hogshead	Volume unit in hogsheads.
Liter	Volume unit in liters.
Milliliter	Volume unit in milliliters.
Minim	Volume unit in minims.
Peck	Volume unit in pecks.
Pinch	Volume unit in pinches.
Pint	Volume unit in pints.
Quart	Volume unit in quarts.
Tablespoon	Volume unit in tablespoons.
Teaspoon	Volume unit in teaspoons.
Unspecified	Unspecified volume unit.

WarningCodeValue

Enumeration

Defines the list of the warning codes.

Value	Description
DocumentTruncated	Document truncated warning
LongWordsInDocument	Long words in document warning

WeightMetadata

Object

Represents the Weight ) entity Metadata model.

Name	Type	Description
metadataKind	string: WeightMetadata	The entity Metadata object kind.
unit	WeightUnit	Unit of measure for weight.
value	number (double)	The numeric value that the extracted text denotes.

WeightUnit

Enumeration

The weight Unit of measurement.

Value	Description
Dram	Weight unit in drams
Gallon	Volume unit in gallons
Grain	Weight unit in grains
Gram	Weight unit in grams
Kilogram	Weight unit in kilograms
LongTonBritish	Weight unit in long tons (British)
MetricTon	Weight unit in metric tons
Milligram	Weight unit in milligrams
Ounce	Weight unit in ounces
PennyWeight	Weight unit in pennyweights
Pound	Weight unit in pounds
ShortHundredWeightUS	Weight unit in short hundredweights (US)
ShortTonUS	Weight unit in short tons (US)
Stone	Weight unit in stones
Ton	Weight unit in tons
Unspecified	Unspecified weight unit