{
  "swagger": "2.0",
  "info": {
    "title": "Microsoft Cognitive Language Service - Document Analysis",
    "version": "2024-11-15-preview",
    "description": "The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms.\nThe API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering.\nFurther documentation can be found in <a href=\\\"https://learn.microsoft.com/azure/cognitive-services/language-service/overview\\\">https://learn.microsoft.com/azure/cognitive-services/language-service/overview</a>.0",
    "x-typespec-generated": [
      {
        "emitter": "@azure-tools/typespec-autorest"
      }
    ]
  },
  "schemes": [
    "https"
  ],
  "x-ms-parameterized-host": {
    "hostTemplate": "{Endpoint}/language",
    "useSchemePrefix": false,
    "parameters": [
      {
        "name": "Endpoint",
        "in": "path",
        "description": "Supported Cognitive Services endpoint (e.g., https://<resource-name>.api.cognitiveservices.azure.com).",
        "required": true,
        "type": "string"
      }
    ]
  },
  "produces": [
    "application/json"
  ],
  "consumes": [
    "application/json"
  ],
  "security": [
    {
      "ApiKeyAuth": []
    },
    {
      "OAuth2Auth": [
        "https://cognitiveservices.azure.com/.default"
      ]
    }
  ],
  "securityDefinitions": {
    "ApiKeyAuth": {
      "type": "apiKey",
      "name": "Ocp-Apim-Subscription-Key",
      "in": "header"
    },
    "OAuth2Auth": {
      "type": "oauth2",
      "flow": "accessCode",
      "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
      "scopes": {
        "https://cognitiveservices.azure.com/.default": ""
      },
      "tokenUrl": "https://login.microsoftonline.com/common/oauth2/token"
    }
  },
  "tags": [],
  "paths": {
    "/analyze-documents/jobs": {
      "post": {
        "operationId": "AnalyzeDocumentsSubmitJob",
        "description": "Submit a collection of text documents for analysis. Specify one or more unique tasks to be executed as a long-running operation.",
        "parameters": [
          {
            "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
          },
          {
            "name": "body",
            "in": "body",
            "description": "The input for the analyze documents operation.",
            "required": true,
            "schema": {
              "$ref": "#/definitions/AnalyzeDocumentJobsInput"
            }
          }
        ],
        "responses": {
          "202": {
            "description": "The request has been accepted for processing, but processing has not yet completed.",
            "headers": {
              "Operation-Location": {
                "type": "string",
                "format": "uri",
                "description": "The location for monitoring the operation state."
              }
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/ErrorResponse"
            },
            "headers": {
              "x-ms-error-code": {
                "type": "string",
                "description": "String error code indicating what went wrong."
              }
            }
          }
        },
        "x-ms-examples": {
          "SuccessfulAnalyzeDocumentsJobsTaskSubmitRequest": {
            "$ref": "./examples/SuccessfulAnalyzeDocumentsJobsTaskSubmitRequest.json"
          }
        },
        "x-ms-long-running-operation": true
      }
    },
    "/analyze-documents/jobs/{jobId}": {
      "get": {
        "operationId": "AnalyzeDocumentsJobStatus",
        "summary": "Get analysis status and results",
        "description": "Get the status of a document analysis job. A job can consist of one or more tasks. After all tasks succeed, the job transitions to the succeeded state and results are available for each task.",
        "parameters": [
          {
            "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
          },
          {
            "name": "jobId",
            "in": "path",
            "description": "job ID",
            "required": true,
            "type": "string",
            "format": "uuid"
          },
          {
            "name": "showStats",
            "in": "query",
            "description": "(Optional) if set to true, response will contain request and document level statistics.",
            "required": false,
            "type": "boolean"
          },
          {
            "name": "top",
            "in": "query",
            "description": "The maximum number of resources to return from the collection.",
            "required": false,
            "type": "integer",
            "format": "int32"
          },
          {
            "name": "skip",
            "in": "query",
            "description": "An offset into the collection of the first resource to be returned.",
            "required": false,
            "type": "integer",
            "format": "int32"
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "schema": {
              "$ref": "#/definitions/AnalyzeDocumentsJobState"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/ErrorResponse"
            },
            "headers": {
              "x-ms-error-code": {
                "type": "string",
                "description": "String error code indicating what went wrong."
              }
            }
          }
        },
        "x-ms-examples": {
          "SuccessfulAnalyzeDocumentsJobStatusTaskStatusRequest": {
            "$ref": "./examples/SuccessfulAnalyzeDocumentsJobStatusTaskStatusRequest.json"
          }
        }
      }
    },
    "/analyze-documents/jobs/{jobId}:cancel": {
      "post": {
        "operationId": "AnalyzeDocumentsCancelJob",
        "summary": "Cancel a long-running Text Analysis job.",
        "description": "Cancel a long-running Text Analysis job.",
        "parameters": [
          {
            "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
          },
          {
            "name": "jobId",
            "in": "path",
            "description": "The job ID to cancel.",
            "required": true,
            "type": "string",
            "format": "uuid"
          }
        ],
        "responses": {
          "202": {
            "description": "The request has been accepted for processing, but processing has not yet completed.",
            "headers": {
              "Operation-Location": {
                "type": "string",
                "format": "uri",
                "description": "The location for monitoring the operation state."
              }
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/ErrorResponse"
            },
            "headers": {
              "x-ms-error-code": {
                "type": "string",
                "description": "String error code indicating what went wrong."
              }
            }
          }
        },
        "x-ms-examples": {
          "SuccessfulAnalyzeDocumentsJobsCancelRequest": {
            "$ref": "./examples/SuccessfulAnalyzeDocumentsJobsCancelRequest.json"
          }
        },
        "x-ms-long-running-operation": true
      }
    }
  },
  "definitions": {
    "AbstractiveSummarizationLROResult": {
      "type": "object",
      "description": "An object representing the results for an Abstractive Summarization task.",
      "properties": {
        "results": {
          "$ref": "#/definitions/AnalyzeDocumentsResult",
          "description": "Results of the task."
        }
      },
      "required": [
        "results"
      ],
      "allOf": [
        {
          "$ref": "#/definitions/AnalyzeDocumentsLROResult"
        }
      ],
      "x-ms-discriminator-value": "AbstractiveSummarizationLROResults"
    },
    "AbstractiveSummarizationLROTask": {
      "type": "object",
      "description": "An object representing the task definition for an Abstractive Summarization task.",
      "properties": {
        "parameters": {
          "$ref": "#/definitions/AbstractiveSummarizationTaskParameters",
          "description": "Parameters for the Abstractive Summarization task."
        }
      },
      "required": [
        "parameters"
      ],
      "allOf": [
        {
          "$ref": "#/definitions/AnalyzeDocumentsLROTask"
        }
      ],
      "x-ms-discriminator-value": "AbstractiveSummarization"
    },
    "AbstractiveSummarizationTaskParameters": {
      "type": "object",
      "description": "Supported parameters for the pre-built Abstractive Summarization task.",
      "properties": {
        "loggingOptOut": {
          "type": "boolean",
          "description": "logging opt out",
          "default": false
        },
        "modelVersion": {
          "type": "string",
          "description": "model version",
          "default": "latest"
        },
        "sentenceCount": {
          "type": "integer",
          "format": "int32",
          "description": "Controls the approximate number of sentences in the output summaries."
        },
        "stringIndexType": {
          "type": "string",
          "description": "String index type",
          "default": "TextElements_v8",
          "enum": [
            "TextElements_v8",
            "UnicodeCodePoint",
            "Utf16CodeUnit"
          ],
          "x-ms-enum": {
            "name": "StringIndexType",
            "modelAsString": true,
            "values": [
              {
                "name": "TextElements_v8",
                "value": "TextElements_v8",
                "description": "Returned offset and length values will correspond to textElements (Graphemes and Grapheme clusters) conforming to the Unicode 8.0.0 standard. Use this option if your application is written in .NET Framework or .NET Core and you will be using StringInfo."
              },
              {
                "name": "UnicodeCodePoint",
                "value": "UnicodeCodePoint",
                "description": "Returned offset and length values will correspond to Unicode code points. Use this option if your application is written in a language that supports Unicode, for example Python."
              },
              {
                "name": "Utf16CodeUnit",
                "value": "Utf16CodeUnit",
                "description": "Returned offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that supports Unicode, for example Java, JavaScript."
              }
            ]
          }
        },
        "summaryLength": {
          "$ref": "#/definitions/SummaryLengthBucket",
          "description": "(NOTE: Recommended to use summaryLength over sentenceCount) Controls the approximate length of the output summaries."
        },
        "instruction": {
          "type": "string",
          "description": "(Optional) If provided, the instruction will be used to generate the summary."
        }
      }
    },
    "AnalyzeDocumentJobsInput": {
      "type": "object",
      "description": "The input object for the analyze documents LRO.",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "Name for the task."
        },
        "analysisInput": {
          "$ref": "#/definitions/MultiLanguageAnalysisInput",
          "description": "Contains the input to be analyzed."
        },
        "tasks": {
          "type": "array",
          "description": "List of tasks to be performed as part of the LRO.",
          "items": {
            "$ref": "#/definitions/AnalyzeDocumentsLROTask"
          }
        },
        "defaultLanguage": {
          "type": "string",
          "description": "Default language to use for records."
        }
      },
      "required": [
        "analysisInput",
        "tasks"
      ]
    },
    "AnalyzeDocumentsDocumentError": {
      "type": "object",
      "description": "Contains the error object with errors encountered for the processed document.",
      "properties": {
        "id": {
          "type": "string",
          "description": "Document Id."
        },
        "error": {
          "$ref": "#/definitions/Error",
          "description": "Document Error."
        }
      },
      "required": [
        "id",
        "error"
      ]
    },
    "AnalyzeDocumentsJobState": {
      "type": "object",
      "description": "The object containing the analyze job LRO job state.",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "display name"
        },
        "createdDateTime": {
          "type": "string",
          "format": "date-time",
          "description": "Date and time job created"
        },
        "expirationDateTime": {
          "type": "string",
          "format": "date-time",
          "description": "Date and time job expires"
        },
        "jobId": {
          "$ref": "#/definitions/Azure.Core.uuid",
          "description": "job ID",
          "readOnly": true
        },
        "lastUpdatedDateTime": {
          "type": "string",
          "format": "date-time",
          "description": "last updated date and time"
        },
        "status": {
          "$ref": "#/definitions/State",
          "description": "status"
        },
        "errors": {
          "type": "array",
          "description": "errors",
          "items": {
            "$ref": "#/definitions/Error"
          }
        },
        "nextLink": {
          "type": "string",
          "description": "next link"
        },
        "tasks": {
          "$ref": "#/definitions/Tasks",
          "description": "List of tasks."
        },
        "statistics": {
          "$ref": "#/definitions/RequestStatistics",
          "description": "if showStats=true was specified in the request this field will contain information about the request payload."
        }
      },
      "required": [
        "createdDateTime",
        "jobId",
        "lastUpdatedDateTime",
        "status",
        "tasks"
      ]
    },
    "AnalyzeDocumentsLROResult": {
      "type": "object",
      "description": "Contains the AnalyzeDocuments long running operation result object.",
      "properties": {
        "lastUpdateDateTime": {
          "type": "string",
          "format": "date-time",
          "description": "The last updated time in UTC for the task."
        },
        "status": {
          "$ref": "#/definitions/State",
          "description": "The status of the task at the mentioned last update time."
        },
        "taskName": {
          "type": "string",
          "description": "task name"
        },
        "kind": {
          "$ref": "#/definitions/AnalyzeDocumentsLROResultsKind",
          "description": "Kind of the task."
        }
      },
      "discriminator": "kind",
      "required": [
        "lastUpdateDateTime",
        "status",
        "kind"
      ]
    },
    "AnalyzeDocumentsLROResultsKind": {
      "type": "string",
      "description": "The kind of the response object returned by the analyze-documents long running task.",
      "enum": [
        "PiiEntityRecognitionLROResults",
        "ExtractiveSummarizationLROResults",
        "AbstractiveSummarizationLROResults"
      ],
      "x-ms-enum": {
        "name": "AnalyzeDocumentsLROResultsKind",
        "modelAsString": true,
        "values": [
          {
            "name": "PiiEntityRecognitionLROResults",
            "value": "PiiEntityRecognitionLROResults",
            "description": "PII entity recognition LRO results"
          },
          {
            "name": "ExtractiveSummarizationLROResults",
            "value": "ExtractiveSummarizationLROResults",
            "description": "Extractive summarization LRO results"
          },
          {
            "name": "AbstractiveSummarizationLROResults",
            "value": "AbstractiveSummarizationLROResults",
            "description": "Abstractive summarization LRO results"
          }
        ]
      }
    },
    "AnalyzeDocumentsLROTask": {
      "type": "object",
      "description": "The long running task to be performed by the service on the input documents.",
      "properties": {
        "taskName": {
          "type": "string",
          "description": "task name"
        },
        "kind": {
          "$ref": "#/definitions/AnalyzeDocumentsLROTaskKind",
          "description": "The kind of task to perform."
        }
      },
      "discriminator": "kind",
      "required": [
        "kind"
      ]
    },
    "AnalyzeDocumentsLROTaskKind": {
      "type": "string",
      "description": "The kind of the long running analyze documents tasks supported.",
      "enum": [
        "PiiEntityRecognition",
        "ExtractiveSummarization",
        "AbstractiveSummarization"
      ],
      "x-ms-enum": {
        "name": "AnalyzeDocumentsLROTaskKind",
        "modelAsString": true,
        "values": [
          {
            "name": "PiiEntityRecognition",
            "value": "PiiEntityRecognition",
            "description": "PII entity recognition task"
          },
          {
            "name": "ExtractiveSummarization",
            "value": "ExtractiveSummarization",
            "description": "Extractive summarization task"
          },
          {
            "name": "AbstractiveSummarization",
            "value": "AbstractiveSummarization",
            "description": "Abstractive summarization task"
          }
        ]
      }
    },
    "AnalyzeDocumentsResult": {
      "type": "object",
      "description": "Contains the result object for the processed document.",
      "properties": {
        "errors": {
          "type": "array",
          "description": "Errors by document id.",
          "items": {
            "$ref": "#/definitions/AnalyzeDocumentsDocumentError"
          }
        },
        "statistics": {
          "$ref": "#/definitions/RequestStatistics",
          "description": "if showStats=true was specified in the request this field will contain information about the request payload."
        },
        "modelVersion": {
          "type": "string",
          "description": "This field indicates which model is used for analysis."
        },
        "documents": {
          "type": "array",
          "description": "Response by document",
          "items": {
            "$ref": "#/definitions/DocumentAnalysisDocumentResult"
          }
        }
      },
      "required": [
        "errors",
        "modelVersion",
        "documents"
      ]
    },
    "Azure.Core.uuid": {
      "type": "string",
      "format": "uuid",
      "description": "Universally Unique Identifier"
    },
    "AzureBlobDocumentLocation": {
      "type": "object",
      "description": "Document location for azure blobs.",
      "properties": {
        "location": {
          "type": "string",
          "description": "The location of the document."
        },
        "managedIdentityClientId": {
          "type": "string",
          "description": "The user managed identity client Id to use to authenticate with the storage account"
        }
      },
      "required": [
        "location"
      ],
      "allOf": [
        {
          "$ref": "#/definitions/DocumentLocation"
        }
      ],
      "x-ms-discriminator-value": "AzureBlob"
    },
    "BaseRedactionPolicy": {
      "type": "object",
      "description": "The abstract base class for RedactionPolicy.",
      "properties": {
        "policyKind": {
          "$ref": "#/definitions/RedactionPolicyKind",
          "description": "The entity RedactionPolicy object kind."
        }
      },
      "discriminator": "policyKind",
      "required": [
        "policyKind"
      ]
    },
    "CharacterMaskPolicy": {
      "type": "object",
      "description": "Represents the policy of redacting with a redaction character",
      "properties": {
        "redactionCharacter": {
          "type": "string",
          "description": "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.",
          "default": "*",
          "enum": [
            "!",
            "#",
            "$",
            "%",
            "&",
            "*",
            "+",
            "-",
            "=",
            "?",
            "@",
            "^",
            "_",
            "~"
          ],
          "x-ms-enum": {
            "name": "redactionCharacter",
            "modelAsString": true,
            "values": [
              {
                "name": "exclamationPoint",
                "value": "!",
                "description": "Exclamation point character"
              },
              {
                "name": "numberSign",
                "value": "#",
                "description": "Number sign character"
              },
              {
                "name": "dollar",
                "value": "$",
                "description": "Dollar sign character"
              },
              {
                "name": "perCent",
                "value": "%",
                "description": "Percent sign character"
              },
              {
                "name": "ampersand",
                "value": "&",
                "description": "Ampersand character"
              },
              {
                "name": "asterisk",
                "value": "*",
                "description": "Asterisk character"
              },
              {
                "name": "plus",
                "value": "+",
                "description": "Plus sign character"
              },
              {
                "name": "minus",
                "value": "-",
                "description": "Minus sign character"
              },
              {
                "name": "equals",
                "value": "=",
                "description": "Equals sign character"
              },
              {
                "name": "questionMark",
                "value": "?",
                "description": "Question mark character"
              },
              {
                "name": "atSign",
                "value": "@",
                "description": "At sign character"
              },
              {
                "name": "caret",
                "value": "^",
                "description": "Caret character"
              },
              {
                "name": "underscore",
                "value": "_",
                "description": "Underscore character"
              },
              {
                "name": "tilde",
                "value": "~",
                "description": "Tilde character"
              }
            ]
          }
        }
      },
      "allOf": [
        {
          "$ref": "#/definitions/BaseRedactionPolicy"
        }
      ],
      "x-ms-discriminator-value": "characterMask"
    },
    "DocumentAnalysisDocumentResult": {
      "type": "object",
      "description": "Contains the result object for the processed document.",
      "properties": {
        "id": {
          "type": "string",
          "description": "Unique, non-empty document identifier."
        },
        "warnings": {
          "type": "array",
          "description": "Warnings encountered while processing document.",
          "items": {
            "$ref": "#/definitions/DocumentWarning"
          }
        },
        "statistics": {
          "$ref": "#/definitions/DocumentStatistics",
          "description": "if showStats=true was specified in the request this field will contain information about the document payload."
        },
        "source": {
          "$ref": "#/definitions/DocumentLocation",
          "description": "Location of the input document."
        },
        "target": {
          "type": "array",
          "description": "Array of document results generated after the analysis.",
          "items": {
            "$ref": "#/definitions/DocumentLocation"
          }
        }
      },
      "required": [
        "id",
        "warnings",
        "source",
        "target"
      ]
    },
    "DocumentLocation": {
      "type": "object",
      "description": "Contains the location of the document.",
      "properties": {
        "kind": {
          "$ref": "#/definitions/DocumentLocationKind",
          "description": "The kind of the document location."
        }
      },
      "discriminator": "kind",
      "required": [
        "kind"
      ]
    },
    "DocumentLocationKind": {
      "type": "string",
      "description": "Enumeration of supported document locations.",
      "enum": [
        "AzureBlob"
      ],
      "x-ms-enum": {
        "name": "DocumentLocationKind",
        "modelAsString": true,
        "values": [
          {
            "name": "AzureBlob",
            "value": "AzureBlob",
            "description": "The document is a URL."
          }
        ]
      }
    },
    "DocumentStatistics": {
      "type": "object",
      "description": "if showStats=true was specified in the request this field will contain information about the document payload.",
      "properties": {
        "charactersCount": {
          "type": "integer",
          "format": "int32",
          "description": "Number of documents elements recognized in the document."
        },
        "transactionsCount": {
          "type": "integer",
          "format": "int32",
          "description": "Number of transactions for the document."
        }
      },
      "required": [
        "charactersCount",
        "transactionsCount"
      ]
    },
    "DocumentWarning": {
      "type": "object",
      "description": "Contains the warnings object with warnings encountered for the processed document.",
      "properties": {
        "code": {
          "$ref": "#/definitions/WarningCodeValue",
          "description": "Warning code."
        },
        "message": {
          "type": "string",
          "description": "Warning message."
        },
        "targetRef": {
          "type": "string",
          "description": "A JSON pointer reference indicating the target object."
        }
      },
      "required": [
        "code",
        "message"
      ]
    },
    "EntityMaskPolicy": {
      "type": "object",
      "description": "Represents the policy of redacting PII with the entity type.",
      "allOf": [
        {
          "$ref": "#/definitions/BaseRedactionPolicy"
        }
      ],
      "x-ms-discriminator-value": "entityMask"
    },
    "Error": {
      "type": "object",
      "description": "The error response object returned when the service encounters some errors during processing the request.",
      "properties": {
        "code": {
          "$ref": "#/definitions/ErrorCode",
          "description": "One of a server-defined set of error codes."
        },
        "message": {
          "type": "string",
          "description": "A human-readable representation of the error."
        },
        "target": {
          "type": "string",
          "description": "The target of the error."
        },
        "details": {
          "type": "array",
          "description": "An array of details about specific errors that led to this reported error.",
          "items": {
            "$ref": "#/definitions/Error"
          }
        },
        "innererror": {
          "$ref": "#/definitions/InnerErrorModel",
          "description": "An object containing more specific information than the current object about the error."
        }
      },
      "required": [
        "code",
        "message"
      ]
    },
    "ErrorCode": {
      "type": "string",
      "description": "Human-readable error code.",
      "enum": [
        "InvalidRequest",
        "InvalidArgument",
        "Unauthorized",
        "Forbidden",
        "NotFound",
        "ProjectNotFound",
        "OperationNotFound",
        "AzureCognitiveSearchNotFound",
        "AzureCognitiveSearchIndexNotFound",
        "TooManyRequests",
        "AzureCognitiveSearchThrottling",
        "AzureCognitiveSearchIndexLimitReached",
        "InternalServerError",
        "ServiceUnavailable",
        "Timeout",
        "QuotaExceeded",
        "Conflict",
        "Warning"
      ],
      "x-ms-enum": {
        "name": "ErrorCode",
        "modelAsString": true,
        "values": [
          {
            "name": "InvalidRequest",
            "value": "InvalidRequest",
            "description": "Invalid request error"
          },
          {
            "name": "InvalidArgument",
            "value": "InvalidArgument",
            "description": "Invalid argument error"
          },
          {
            "name": "Unauthorized",
            "value": "Unauthorized",
            "description": "Unauthorized access error"
          },
          {
            "name": "Forbidden",
            "value": "Forbidden",
            "description": "Forbidden access error"
          },
          {
            "name": "NotFound",
            "value": "NotFound",
            "description": "Not found error"
          },
          {
            "name": "ProjectNotFound",
            "value": "ProjectNotFound",
            "description": "Project not found error"
          },
          {
            "name": "OperationNotFound",
            "value": "OperationNotFound",
            "description": "Operation not found error"
          },
          {
            "name": "AzureCognitiveSearchNotFound",
            "value": "AzureCognitiveSearchNotFound",
            "description": "Azure Cognitive Search not found error"
          },
          {
            "name": "AzureCognitiveSearchIndexNotFound",
            "value": "AzureCognitiveSearchIndexNotFound",
            "description": "Azure Cognitive Search index not found error"
          },
          {
            "name": "TooManyRequests",
            "value": "TooManyRequests",
            "description": "Too many requests error"
          },
          {
            "name": "AzureCognitiveSearchThrottling",
            "value": "AzureCognitiveSearchThrottling",
            "description": "Azure Cognitive Search throttling error"
          },
          {
            "name": "AzureCognitiveSearchIndexLimitReached",
            "value": "AzureCognitiveSearchIndexLimitReached",
            "description": "Azure Cognitive Search index limit reached error"
          },
          {
            "name": "InternalServerError",
            "value": "InternalServerError",
            "description": "Internal server error"
          },
          {
            "name": "ServiceUnavailable",
            "value": "ServiceUnavailable",
            "description": "Service unavailable error"
          },
          {
            "name": "Timeout",
            "value": "Timeout",
            "description": "Timeout error"
          },
          {
            "name": "QuotaExceeded",
            "value": "QuotaExceeded",
            "description": "Quota exceeded error"
          },
          {
            "name": "Conflict",
            "value": "Conflict",
            "description": "Conflict error"
          },
          {
            "name": "Warning",
            "value": "Warning",
            "description": "Warning error"
          }
        ]
      }
    },
    "ErrorResponse": {
      "type": "object",
      "description": "Error response.",
      "properties": {
        "error": {
          "$ref": "#/definitions/Error",
          "description": "The error object."
        }
      },
      "required": [
        "error"
      ]
    },
    "ExtractiveSummarizationLROResult": {
      "type": "object",
      "description": "An object representing the results for an Extractive Summarization task.",
      "properties": {
        "results": {
          "$ref": "#/definitions/AnalyzeDocumentsResult",
          "description": "Results of the document task."
        }
      },
      "required": [
        "results"
      ],
      "allOf": [
        {
          "$ref": "#/definitions/AnalyzeDocumentsLROResult"
        }
      ],
      "x-ms-discriminator-value": "ExtractiveSummarizationLROResults"
    },
    "ExtractiveSummarizationLROTask": {
      "type": "object",
      "description": "An object representing the task definition for an Extractive Summarization task.",
      "properties": {
        "parameters": {
          "$ref": "#/definitions/ExtractiveSummarizationTaskParameters",
          "description": "Parameters for the Extractive Summarization task."
        }
      },
      "allOf": [
        {
          "$ref": "#/definitions/AnalyzeDocumentsLROTask"
        }
      ],
      "x-ms-discriminator-value": "ExtractiveSummarization"
    },
    "ExtractiveSummarizationTaskParameters": {
      "type": "object",
      "description": "Supported parameters for an Extractive Summarization task.",
      "properties": {
        "loggingOptOut": {
          "type": "boolean",
          "description": "logging opt out",
          "default": false
        },
        "modelVersion": {
          "type": "string",
          "description": "model version",
          "default": "latest"
        },
        "sentenceCount": {
          "type": "integer",
          "format": "int64",
          "description": "Specifies the number of sentences in the extracted summary.",
          "default": 3
        },
        "sortBy": {
          "type": "string",
          "description": "Specifies how to sort the extracted summaries.",
          "default": "Offset",
          "enum": [
            "Offset",
            "Rank"
          ],
          "x-ms-enum": {
            "name": "ExtractiveSummarizationSortingCriteria",
            "modelAsString": true,
            "values": [
              {
                "name": "Offset",
                "value": "Offset",
                "description": "Indicates that results should be sorted in order of appearance in the text."
              },
              {
                "name": "Rank",
                "value": "Rank",
                "description": "Indicates that results should be sorted in order of importance (i.e. rank score) according to the model."
              }
            ]
          }
        },
        "stringIndexType": {
          "type": "string",
          "description": "Specifies the method used to interpret string offsets.",
          "default": "TextElements_v8",
          "enum": [
            "TextElements_v8",
            "UnicodeCodePoint",
            "Utf16CodeUnit"
          ],
          "x-ms-enum": {
            "name": "StringIndexType",
            "modelAsString": true,
            "values": [
              {
                "name": "TextElements_v8",
                "value": "TextElements_v8",
                "description": "Returned offset and length values will correspond to textElements (Graphemes and Grapheme clusters) conforming to the Unicode 8.0.0 standard. Use this option if your application is written in .NET Framework or .NET Core and you will be using StringInfo."
              },
              {
                "name": "UnicodeCodePoint",
                "value": "UnicodeCodePoint",
                "description": "Returned offset and length values will correspond to Unicode code points. Use this option if your application is written in a language that supports Unicode, for example Python."
              },
              {
                "name": "Utf16CodeUnit",
                "value": "Utf16CodeUnit",
                "description": "Returned offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that supports Unicode, for example Java, JavaScript."
              }
            ]
          }
        },
        "query": {
          "type": "string",
          "description": "(Optional) If provided, the query will be used to extract most relevant sentences from the document."
        }
      }
    },
    "InnerErrorCode": {
      "type": "string",
      "description": "Human-readable error code.",
      "enum": [
        "InvalidRequest",
        "InvalidParameterValue",
        "KnowledgeBaseNotFound",
        "AzureCognitiveSearchNotFound",
        "AzureCognitiveSearchThrottling",
        "ExtractionFailure",
        "InvalidRequestBodyFormat",
        "EmptyRequest",
        "MissingInputDocuments",
        "InvalidDocument",
        "ModelVersionIncorrect",
        "InvalidDocumentBatch",
        "UnsupportedLanguageCode",
        "InvalidCountryHint"
      ],
      "x-ms-enum": {
        "name": "InnerErrorCode",
        "modelAsString": true,
        "values": [
          {
            "name": "InvalidRequest",
            "value": "InvalidRequest",
            "description": "Invalid request error"
          },
          {
            "name": "InvalidParameterValue",
            "value": "InvalidParameterValue",
            "description": "Invalid parameter value error"
          },
          {
            "name": "KnowledgeBaseNotFound",
            "value": "KnowledgeBaseNotFound",
            "description": "Knowledge base not found error"
          },
          {
            "name": "AzureCognitiveSearchNotFound",
            "value": "AzureCognitiveSearchNotFound",
            "description": "Azure Cognitive Search not found error"
          },
          {
            "name": "AzureCognitiveSearchThrottling",
            "value": "AzureCognitiveSearchThrottling",
            "description": "Azure Cognitive Search throttling error"
          },
          {
            "name": "ExtractionFailure",
            "value": "ExtractionFailure",
            "description": "Extraction failure error"
          },
          {
            "name": "InvalidRequestBodyFormat",
            "value": "InvalidRequestBodyFormat",
            "description": "Invalid request body format error"
          },
          {
            "name": "EmptyRequest",
            "value": "EmptyRequest",
            "description": "Empty request error"
          },
          {
            "name": "MissingInputDocuments",
            "value": "MissingInputDocuments",
            "description": "Missing input documents error"
          },
          {
            "name": "InvalidDocument",
            "value": "InvalidDocument",
            "description": "Invalid document error"
          },
          {
            "name": "ModelVersionIncorrect",
            "value": "ModelVersionIncorrect",
            "description": "Model version incorrect error"
          },
          {
            "name": "InvalidDocumentBatch",
            "value": "InvalidDocumentBatch",
            "description": "Invalid document batch error"
          },
          {
            "name": "UnsupportedLanguageCode",
            "value": "UnsupportedLanguageCode",
            "description": "Unsupported language code error"
          },
          {
            "name": "InvalidCountryHint",
            "value": "InvalidCountryHint",
            "description": "Invalid country hint error"
          }
        ]
      }
    },
    "InnerErrorModel": {
      "type": "object",
      "description": "An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.",
      "properties": {
        "code": {
          "$ref": "#/definitions/InnerErrorCode",
          "description": "One of a server-defined set of error codes."
        },
        "message": {
          "type": "string",
          "description": "Error message."
        },
        "details": {
          "type": "object",
          "description": "Error details.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "target": {
          "type": "string",
          "description": "Error target."
        },
        "innererror": {
          "$ref": "#/definitions/InnerErrorModel",
          "description": "An object containing more specific information than the current object about the error."
        }
      },
      "required": [
        "code",
        "message"
      ]
    },
    "MultiLanguageAnalysisInput": {
      "type": "object",
      "description": "Collection of input documents to be analyzed by the service.",
      "properties": {
        "documents": {
          "type": "array",
          "description": "The input documents to be analyzed.",
          "items": {
            "$ref": "#/definitions/MultiLanguageInput"
          }
        }
      }
    },
    "MultiLanguageInput": {
      "type": "object",
      "description": "Contains an input document to be analyzed by the service.",
      "properties": {
        "id": {
          "type": "string",
          "description": "A unique, non-empty document identifier."
        },
        "source": {
          "$ref": "#/definitions/DocumentLocation",
          "description": "The location of the input document to process."
        },
        "target": {
          "$ref": "#/definitions/DocumentLocation",
          "description": "The location where the processed document will be stored."
        },
        "language": {
          "type": "string",
          "description": "(Optional) This is the 2 letter ISO 639-1 representation of a language. For example, use \\\"en\\\" for English; \\\"es\\\" for Spanish etc. If not set, use \\\"en\\\" for English as default."
        }
      },
      "required": [
        "id",
        "source",
        "target"
      ]
    },
    "NoMaskPolicy": {
      "type": "object",
      "description": "Represents the policy of not redacting found PII.",
      "allOf": [
        {
          "$ref": "#/definitions/BaseRedactionPolicy"
        }
      ],
      "x-ms-discriminator-value": "noMask"
    },
    "PiiCategoriesExclude": {
      "type": "string",
      "description": "(Optional) describes the PII categories to return",
      "enum": [
        "ABARoutingNumber",
        "ARNationalIdentityNumber",
        "AUBankAccountNumber",
        "AUDriversLicenseNumber",
        "AUMedicalAccountNumber",
        "AUPassportNumber",
        "AUTaxFileNumber",
        "AUBusinessNumber",
        "AUCompanyNumber",
        "ATIdentityCard",
        "ATTaxIdentificationNumber",
        "ATValueAddedTaxNumber",
        "AzureDocumentDBAuthKey",
        "AzureIAASDatabaseConnectionAndSQLString",
        "AzureIoTConnectionString",
        "AzurePublishSettingPassword",
        "AzureRedisCacheString",
        "AzureSAS",
        "AzureServiceBusString",
        "AzureStorageAccountKey",
        "AzureStorageAccountGeneric",
        "BENationalNumber",
        "BENationalNumberV2",
        "BEValueAddedTaxNumber",
        "BRCPFNumber",
        "BRLegalEntityNumber",
        "BRNationalIDRG",
        "BGUniformCivilNumber",
        "CABankAccountNumber",
        "CADriversLicenseNumber",
        "CAHealthServiceNumber",
        "CAPassportNumber",
        "CAPersonalHealthIdentification",
        "CASocialInsuranceNumber",
        "CLIdentityCardNumber",
        "CNResidentIdentityCardNumber",
        "CreditCardNumber",
        "HRIdentityCardNumber",
        "HRNationalIDNumber",
        "HRPersonalIdentificationNumber",
        "HRPersonalIdentificationOIBNumberV2",
        "CYIdentityCard",
        "CYTaxIdentificationNumber",
        "CZPersonalIdentityNumber",
        "CZPersonalIdentityV2",
        "DKPersonalIdentificationNumber",
        "DKPersonalIdentificationV2",
        "DrugEnforcementAgencyNumber",
        "EEPersonalIdentificationCode",
        "EUDebitCardNumber",
        "EUDriversLicenseNumber",
        "EUGPSCoordinates",
        "EUNationalIdentificationNumber",
        "EUPassportNumber",
        "EUSocialSecurityNumber",
        "EUTaxIdentificationNumber",
        "FIEuropeanHealthNumber",
        "FINationalID",
        "FINationalIDV2",
        "FIPassportNumber",
        "FRDriversLicenseNumber",
        "FRHealthInsuranceNumber",
        "FRNationalID",
        "FRPassportNumber",
        "FRSocialSecurityNumber",
        "FRTaxIdentificationNumber",
        "FRValueAddedTaxNumber",
        "DEDriversLicenseNumber",
        "DEPassportNumber",
        "DEIdentityCardNumber",
        "DETaxIdentificationNumber",
        "DEValueAddedNumber",
        "GRNationalIDCard",
        "GRNationalIDV2",
        "GRTaxIdentificationNumber",
        "HKIdentityCardNumber",
        "HUValueAddedNumber",
        "HUPersonalIdentificationNumber",
        "HUTaxIdentificationNumber",
        "INPermanentAccount",
        "INUniqueIdentificationNumber",
        "IDIdentityCardNumber",
        "InternationalBankingAccountNumber",
        "IEPersonalPublicServiceNumber",
        "IEPersonalPublicServiceNumberV2",
        "ILBankAccountNumber",
        "ILNationalID",
        "ITDriversLicenseNumber",
        "ITFiscalCode",
        "ITValueAddedTaxNumber",
        "JPBankAccountNumber",
        "JPDriversLicenseNumber",
        "JPPassportNumber",
        "JPResidentRegistrationNumber",
        "JPSocialInsuranceNumber",
        "JPMyNumberCorporate",
        "JPMyNumberPersonal",
        "JPResidenceCardNumber",
        "LVPersonalCode",
        "LTPersonalCode",
        "LUNationalIdentificationNumberNatural",
        "LUNationalIdentificationNumberNonNatural",
        "MYIdentityCardNumber",
        "MTIdentityCardNumber",
        "MTTaxIDNumber",
        "NLCitizensServiceNumber",
        "NLCitizensServiceNumberV2",
        "NLTaxIdentificationNumber",
        "NLValueAddedTaxNumber",
        "NZBankAccountNumber",
        "NZDriversLicenseNumber",
        "NZInlandRevenueNumber",
        "NZMinistryOfHealthNumber",
        "NZSocialWelfareNumber",
        "NOIdentityNumber",
        "PHUnifiedMultiPurposeIDNumber",
        "PLIdentityCard",
        "PLNationalID",
        "PLNationalIDV2",
        "PLPassportNumber",
        "PLTaxIdentificationNumber",
        "PLREGONNumber",
        "PTCitizenCardNumber",
        "PTCitizenCardNumberV2",
        "PTTaxIdentificationNumber",
        "ROPersonalNumericalCode",
        "RUPassportNumberDomestic",
        "RUPassportNumberInternational",
        "SANationalID",
        "SGNationalRegistrationIdentityCardNumber",
        "SKPersonalNumber",
        "SITaxIdentificationNumber",
        "SIUniqueMasterCitizenNumber",
        "ZAIdentificationNumber",
        "KRResidentRegistrationNumber",
        "ESDNI",
        "ESSocialSecurityNumber",
        "ESTaxIdentificationNumber",
        "SQLServerConnectionString",
        "SENationalID",
        "SENationalIDV2",
        "SEPassportNumber",
        "SETaxIdentificationNumber",
        "SWIFTCode",
        "CHSocialSecurityNumber",
        "TWNationalID",
        "TWPassportNumber",
        "TWResidentCertificate",
        "THPopulationIdentificationCode",
        "TRNationalIdentificationNumber",
        "UKDriversLicenseNumber",
        "UKElectoralRollNumber",
        "UKNationalHealthNumber",
        "UKNationalInsuranceNumber",
        "UKUniqueTaxpayerNumber",
        "USUKPassportNumber",
        "USBankAccountNumber",
        "USDriversLicenseNumber",
        "USIndividualTaxpayerIdentification",
        "USSocialSecurityNumber",
        "UAPassportNumberDomestic",
        "UAPassportNumberInternational",
        "Organization",
        "Email",
        "URL",
        "Age",
        "PhoneNumber",
        "IPAddress",
        "Date",
        "Person",
        "Address"
      ],
      "x-ms-enum": {
        "name": "PiiCategoriesExclude",
        "modelAsString": true,
        "values": [
          {
            "name": "ABARoutingNumber",
            "value": "ABARoutingNumber",
            "description": "ABA Routing number"
          },
          {
            "name": "ARNationalIdentityNumber",
            "value": "ARNationalIdentityNumber",
            "description": "AR National Identity Number"
          },
          {
            "name": "AUBankAccountNumber",
            "value": "AUBankAccountNumber",
            "description": "AT Identity Card"
          },
          {
            "name": "AUDriversLicenseNumber",
            "value": "AUDriversLicenseNumber",
            "description": "AU Driver's License Number"
          },
          {
            "name": "AUMedicalAccountNumber",
            "value": "AUMedicalAccountNumber",
            "description": "AU Medical Account Number"
          },
          {
            "name": "AUPassportNumber",
            "value": "AUPassportNumber",
            "description": "AU Passport Number"
          },
          {
            "name": "AUTaxFileNumber",
            "value": "AUTaxFileNumber",
            "description": "AU Tax File Number"
          },
          {
            "name": "AUBusinessNumber",
            "value": "AUBusinessNumber",
            "description": "AU Business Number"
          },
          {
            "name": "AUCompanyNumber",
            "value": "AUCompanyNumber",
            "description": "AU Company Number"
          },
          {
            "name": "ATIdentityCard",
            "value": "ATIdentityCard",
            "description": "AT Identity Card"
          },
          {
            "name": "ATTaxIdentificationNumber",
            "value": "ATTaxIdentificationNumber",
            "description": "AT Tax Identification Number"
          },
          {
            "name": "ATValueAddedTaxNumber",
            "value": "ATValueAddedTaxNumber",
            "description": "AT Value Added Tax Number"
          },
          {
            "name": "AzureDocumentDBAuthKey",
            "value": "AzureDocumentDBAuthKey",
            "description": "Azure Document DB Auth Key"
          },
          {
            "name": "AzureIAASDatabaseConnectionAndSQLString",
            "value": "AzureIAASDatabaseConnectionAndSQLString",
            "description": "Azure IAAS Database Connection And SQL String"
          },
          {
            "name": "AzureIoTConnectionString",
            "value": "AzureIoTConnectionString",
            "description": "Azure IoT Connection String"
          },
          {
            "name": "AzurePublishSettingPassword",
            "value": "AzurePublishSettingPassword",
            "description": "Azure Publish Setting Password"
          },
          {
            "name": "AzureRedisCacheString",
            "value": "AzureRedisCacheString",
            "description": "Azure Redis Cache String"
          },
          {
            "name": "AzureSAS",
            "value": "AzureSAS",
            "description": "Azure SAS"
          },
          {
            "name": "AzureServiceBusString",
            "value": "AzureServiceBusString",
            "description": "Azure Service Bus String"
          },
          {
            "name": "AzureStorageAccountKey",
            "value": "AzureStorageAccountKey",
            "description": "Azure Storage Account Key"
          },
          {
            "name": "AzureStorageAccountGeneric",
            "value": "AzureStorageAccountGeneric",
            "description": "Azure Storage Account Generic"
          },
          {
            "name": "BENationalNumber",
            "value": "BENationalNumber",
            "description": "BE National Number"
          },
          {
            "name": "BENationalNumberV2",
            "value": "BENationalNumberV2",
            "description": "BE National Number V2"
          },
          {
            "name": "BEValueAddedTaxNumber",
            "value": "BEValueAddedTaxNumber",
            "description": "BE Value Added Tax Number"
          },
          {
            "name": "BRCPFNumber",
            "value": "BRCPFNumber",
            "description": "BR CPF Number"
          },
          {
            "name": "BRLegalEntityNumber",
            "value": "BRLegalEntityNumber",
            "description": "BR Legal Entity Number"
          },
          {
            "name": "BRNationalIDRG",
            "value": "BRNationalIDRG",
            "description": "BR National ID RG"
          },
          {
            "name": "BGUniformCivilNumber",
            "value": "BGUniformCivilNumber",
            "description": "BG Uniform Civil Number"
          },
          {
            "name": "CABankAccountNumber",
            "value": "CABankAccountNumber",
            "description": "CA Bank Account Number"
          },
          {
            "name": "CADriversLicenseNumber",
            "value": "CADriversLicenseNumber",
            "description": "CA Driver's License Number"
          },
          {
            "name": "CAHealthServiceNumber",
            "value": "CAHealthServiceNumber",
            "description": "CA Health Service Number"
          },
          {
            "name": "CAPassportNumber",
            "value": "CAPassportNumber",
            "description": "CA Passport Number"
          },
          {
            "name": "CAPersonalHealthIdentification",
            "value": "CAPersonalHealthIdentification",
            "description": "CA Personal Health Identification"
          },
          {
            "name": "CASocialInsuranceNumber",
            "value": "CASocialInsuranceNumber",
            "description": "CA Social Insurance Number"
          },
          {
            "name": "CLIdentityCardNumber",
            "value": "CLIdentityCardNumber",
            "description": "CL Identity Card Number"
          },
          {
            "name": "CNResidentIdentityCardNumber",
            "value": "CNResidentIdentityCardNumber",
            "description": "CN Resident Identity Card Number"
          },
          {
            "name": "CreditCardNumber",
            "value": "CreditCardNumber",
            "description": "Credit Card Number"
          },
          {
            "name": "HRIdentityCardNumber",
            "value": "HRIdentityCardNumber",
            "description": "HR Identity Card Number"
          },
          {
            "name": "HRNationalIDNumber",
            "value": "HRNationalIDNumber",
            "description": "HR National ID Number"
          },
          {
            "name": "HRPersonalIdentificationNumber",
            "value": "HRPersonalIdentificationNumber",
            "description": "HR Personal Identification Number"
          },
          {
            "name": "HRPersonalIdentificationOIBNumberV2",
            "value": "HRPersonalIdentificationOIBNumberV2",
            "description": "HR Personal Identification OIB Number V2"
          },
          {
            "name": "CYIdentityCard",
            "value": "CYIdentityCard",
            "description": "CY Identity Card"
          },
          {
            "name": "CYTaxIdentificationNumber",
            "value": "CYTaxIdentificationNumber",
            "description": "CY Tax Identification Number"
          },
          {
            "name": "CZPersonalIdentityNumber",
            "value": "CZPersonalIdentityNumber",
            "description": "CZ Personal Identity Number"
          },
          {
            "name": "CZPersonalIdentityV2",
            "value": "CZPersonalIdentityV2",
            "description": "CZ Personal Identity V2"
          },
          {
            "name": "DKPersonalIdentificationNumber",
            "value": "DKPersonalIdentificationNumber",
            "description": "DK Personal Identification Number"
          },
          {
            "name": "DKPersonalIdentificationV2",
            "value": "DKPersonalIdentificationV2",
            "description": "DK Personal Identification V2"
          },
          {
            "name": "DrugEnforcementAgencyNumber",
            "value": "DrugEnforcementAgencyNumber",
            "description": "Drug Enforcement Agency Number"
          },
          {
            "name": "EEPersonalIdentificationCode",
            "value": "EEPersonalIdentificationCode",
            "description": "EE Personal Identification Code"
          },
          {
            "name": "EUDebitCardNumber",
            "value": "EUDebitCardNumber",
            "description": "EU Debit Card Number"
          },
          {
            "name": "EUDriversLicenseNumber",
            "value": "EUDriversLicenseNumber",
            "description": "EU Driver's License Number"
          },
          {
            "name": "EUGPSCoordinates",
            "value": "EUGPSCoordinates",
            "description": "EU GPS Coordinates"
          },
          {
            "name": "EUNationalIdentificationNumber",
            "value": "EUNationalIdentificationNumber",
            "description": "EU National Identification Number"
          },
          {
            "name": "EUPassportNumber",
            "value": "EUPassportNumber",
            "description": "EU Passport Number"
          },
          {
            "name": "EUSocialSecurityNumber",
            "value": "EUSocialSecurityNumber",
            "description": "EU Social Security Number"
          },
          {
            "name": "EUTaxIdentificationNumber",
            "value": "EUTaxIdentificationNumber",
            "description": "EU Tax Identification Number"
          },
          {
            "name": "FIEuropeanHealthNumber",
            "value": "FIEuropeanHealthNumber",
            "description": "FI European Health Number"
          },
          {
            "name": "FINationalID",
            "value": "FINationalID",
            "description": "FI National ID"
          },
          {
            "name": "FINationalIDV2",
            "value": "FINationalIDV2",
            "description": "FI National ID V2"
          },
          {
            "name": "FIPassportNumber",
            "value": "FIPassportNumber",
            "description": "FI Passport Number"
          },
          {
            "name": "FRDriversLicenseNumber",
            "value": "FRDriversLicenseNumber",
            "description": "FR Driver's License Number"
          },
          {
            "name": "FRHealthInsuranceNumber",
            "value": "FRHealthInsuranceNumber",
            "description": "FR Health Insurance Number"
          },
          {
            "name": "FRNationalID",
            "value": "FRNationalID",
            "description": "FR National ID"
          },
          {
            "name": "FRPassportNumber",
            "value": "FRPassportNumber",
            "description": "FR Passport Number"
          },
          {
            "name": "FRSocialSecurityNumber",
            "value": "FRSocialSecurityNumber",
            "description": "FR Social Security Number"
          },
          {
            "name": "FRTaxIdentificationNumber",
            "value": "FRTaxIdentificationNumber",
            "description": "FR Tax Identification Number"
          },
          {
            "name": "FRValueAddedTaxNumber",
            "value": "FRValueAddedTaxNumber",
            "description": "FR Value Added Tax Number"
          },
          {
            "name": "DEDriversLicenseNumber",
            "value": "DEDriversLicenseNumber",
            "description": "DE Driver's License Number"
          },
          {
            "name": "DEPassportNumber",
            "value": "DEPassportNumber",
            "description": "DE Passport Number"
          },
          {
            "name": "DEIdentityCardNumber",
            "value": "DEIdentityCardNumber",
            "description": "DE Identity Card Number"
          },
          {
            "name": "DETaxIdentificationNumber",
            "value": "DETaxIdentificationNumber",
            "description": "DE Tax Identification Number"
          },
          {
            "name": "DEValueAddedNumber",
            "value": "DEValueAddedNumber",
            "description": "DE Value Added Number"
          },
          {
            "name": "GRNationalIDCard",
            "value": "GRNationalIDCard",
            "description": "GR National ID Card"
          },
          {
            "name": "GRNationalIDV2",
            "value": "GRNationalIDV2",
            "description": "GR National ID V2"
          },
          {
            "name": "GRTaxIdentificationNumber",
            "value": "GRTaxIdentificationNumber",
            "description": "GR Tax Identification Number"
          },
          {
            "name": "HKIdentityCardNumber",
            "value": "HKIdentityCardNumber",
            "description": "HK Identity Card Number"
          },
          {
            "name": "HUValueAddedNumber",
            "value": "HUValueAddedNumber",
            "description": "HU Value Added Number"
          },
          {
            "name": "HUPersonalIdentificationNumber",
            "value": "HUPersonalIdentificationNumber",
            "description": "HU Personal Identification Number"
          },
          {
            "name": "HUTaxIdentificationNumber",
            "value": "HUTaxIdentificationNumber",
            "description": "HU Tax Identification Number"
          },
          {
            "name": "INPermanentAccount",
            "value": "INPermanentAccount",
            "description": "IN Permanent Account"
          },
          {
            "name": "INUniqueIdentificationNumber",
            "value": "INUniqueIdentificationNumber",
            "description": "IN Unique Identification Number"
          },
          {
            "name": "IDIdentityCardNumber",
            "value": "IDIdentityCardNumber",
            "description": "ID Identity Card Number"
          },
          {
            "name": "InternationalBankingAccountNumber",
            "value": "InternationalBankingAccountNumber",
            "description": "International Banking Account Number"
          },
          {
            "name": "IEPersonalPublicServiceNumber",
            "value": "IEPersonalPublicServiceNumber",
            "description": "IE Personal Public Service Number"
          },
          {
            "name": "IEPersonalPublicServiceNumberV2",
            "value": "IEPersonalPublicServiceNumberV2",
            "description": "IE Personal Public Service Number V2"
          },
          {
            "name": "ILBankAccountNumber",
            "value": "ILBankAccountNumber",
            "description": "IL Bank Account Number"
          },
          {
            "name": "ILNationalID",
            "value": "ILNationalID",
            "description": "IL National ID"
          },
          {
            "name": "ITDriversLicenseNumber",
            "value": "ITDriversLicenseNumber",
            "description": "IT Driver's License Number"
          },
          {
            "name": "ITFiscalCode",
            "value": "ITFiscalCode",
            "description": "IT Fiscal Code"
          },
          {
            "name": "ITValueAddedTaxNumber",
            "value": "ITValueAddedTaxNumber",
            "description": "IT Value Added Tax Number"
          },
          {
            "name": "JPBankAccountNumber",
            "value": "JPBankAccountNumber",
            "description": "JP Bank Account Number"
          },
          {
            "name": "JPDriversLicenseNumber",
            "value": "JPDriversLicenseNumber",
            "description": "JP Driver's License Number"
          },
          {
            "name": "JPPassportNumber",
            "value": "JPPassportNumber",
            "description": "JP Passport Number"
          },
          {
            "name": "JPResidentRegistrationNumber",
            "value": "JPResidentRegistrationNumber",
            "description": "JP Resident Registration Number"
          },
          {
            "name": "JPSocialInsuranceNumber",
            "value": "JPSocialInsuranceNumber",
            "description": "JP Social Insurance Number"
          },
          {
            "name": "JPMyNumberCorporate",
            "value": "JPMyNumberCorporate",
            "description": "JP My Number Corporate"
          },
          {
            "name": "JPMyNumberPersonal",
            "value": "JPMyNumberPersonal",
            "description": "JP My Number Personal"
          },
          {
            "name": "JPResidenceCardNumber",
            "value": "JPResidenceCardNumber",
            "description": "JP Residence Card Number"
          },
          {
            "name": "LVPersonalCode",
            "value": "LVPersonalCode",
            "description": "LV Personal Code"
          },
          {
            "name": "LTPersonalCode",
            "value": "LTPersonalCode",
            "description": "LT Personal Code"
          },
          {
            "name": "LUNationalIdentificationNumberNatural",
            "value": "LUNationalIdentificationNumberNatural",
            "description": "LU National Identification Number Natural"
          },
          {
            "name": "LUNationalIdentificationNumberNonNatural",
            "value": "LUNationalIdentificationNumberNonNatural",
            "description": "LU National Identification Number Non Natural"
          },
          {
            "name": "MYIdentityCardNumber",
            "value": "MYIdentityCardNumber",
            "description": "MY Identity Card Number"
          },
          {
            "name": "MTIdentityCardNumber",
            "value": "MTIdentityCardNumber",
            "description": "MT Identity Card Number"
          },
          {
            "name": "MTTaxIDNumber",
            "value": "MTTaxIDNumber",
            "description": "MT Tax ID Number"
          },
          {
            "name": "NLCitizensServiceNumber",
            "value": "NLCitizensServiceNumber",
            "description": "NL Citizens Service Number"
          },
          {
            "name": "NLCitizensServiceNumberV2",
            "value": "NLCitizensServiceNumberV2",
            "description": "NL Citizens Service Number V2"
          },
          {
            "name": "NLTaxIdentificationNumber",
            "value": "NLTaxIdentificationNumber",
            "description": "NL Tax Identification Number"
          },
          {
            "name": "NLValueAddedTaxNumber",
            "value": "NLValueAddedTaxNumber",
            "description": "NL Value Added Tax Number"
          },
          {
            "name": "NZBankAccountNumber",
            "value": "NZBankAccountNumber",
            "description": "NZ Bank Account Number"
          },
          {
            "name": "NZDriversLicenseNumber",
            "value": "NZDriversLicenseNumber",
            "description": "NZ Driver's License Number"
          },
          {
            "name": "NZInlandRevenueNumber",
            "value": "NZInlandRevenueNumber",
            "description": "NZ Inland Revenue Number"
          },
          {
            "name": "NZMinistryOfHealthNumber",
            "value": "NZMinistryOfHealthNumber",
            "description": "NZ Ministry Of Health Number"
          },
          {
            "name": "NZSocialWelfareNumber",
            "value": "NZSocialWelfareNumber",
            "description": "NZ Social Welfare Number"
          },
          {
            "name": "NOIdentityNumber",
            "value": "NOIdentityNumber",
            "description": "NO Identity Number"
          },
          {
            "name": "PHUnifiedMultiPurposeIDNumber",
            "value": "PHUnifiedMultiPurposeIDNumber",
            "description": "PH Unified Multi Purpose ID Number"
          },
          {
            "name": "PLIdentityCard",
            "value": "PLIdentityCard",
            "description": "PL Identity Card"
          },
          {
            "name": "PLNationalID",
            "value": "PLNationalID",
            "description": "PL National ID"
          },
          {
            "name": "PLNationalIDV2",
            "value": "PLNationalIDV2",
            "description": "PL National ID V2"
          },
          {
            "name": "PLPassportNumber",
            "value": "PLPassportNumber",
            "description": "PL Passport Number"
          },
          {
            "name": "PLTaxIdentificationNumber",
            "value": "PLTaxIdentificationNumber",
            "description": "PL Tax Identification Number"
          },
          {
            "name": "PLREGONNumber",
            "value": "PLREGONNumber",
            "description": "PL REGON Number"
          },
          {
            "name": "PTCitizenCardNumber",
            "value": "PTCitizenCardNumber",
            "description": "PT Citizen Card Number"
          },
          {
            "name": "PTCitizenCardNumberV2",
            "value": "PTCitizenCardNumberV2",
            "description": "PT Citizen Card Number V2"
          },
          {
            "name": "PTTaxIdentificationNumber",
            "value": "PTTaxIdentificationNumber",
            "description": "PT Tax Identification Number"
          },
          {
            "name": "ROPersonalNumericalCode",
            "value": "ROPersonalNumericalCode",
            "description": "RO Personal Numerical Code"
          },
          {
            "name": "RUPassportNumberDomestic",
            "value": "RUPassportNumberDomestic",
            "description": "RU Passport Number Domestic"
          },
          {
            "name": "RUPassportNumberInternational",
            "value": "RUPassportNumberInternational",
            "description": "RU Passport Number International"
          },
          {
            "name": "SANationalID",
            "value": "SANationalID",
            "description": "SA National ID"
          },
          {
            "name": "SGNationalRegistrationIdentityCardNumber",
            "value": "SGNationalRegistrationIdentityCardNumber",
            "description": "SG National Registration Identity Card Number"
          },
          {
            "name": "SKPersonalNumber",
            "value": "SKPersonalNumber",
            "description": "SK Personal Number"
          },
          {
            "name": "SITaxIdentificationNumber",
            "value": "SITaxIdentificationNumber",
            "description": "SI Tax Identification Number"
          },
          {
            "name": "SIUniqueMasterCitizenNumber",
            "value": "SIUniqueMasterCitizenNumber",
            "description": "SI Unique Master Citizen Number"
          },
          {
            "name": "ZAIdentificationNumber",
            "value": "ZAIdentificationNumber",
            "description": "ZA Identification Number"
          },
          {
            "name": "KRResidentRegistrationNumber",
            "value": "KRResidentRegistrationNumber",
            "description": "KR Resident Registration Number"
          },
          {
            "name": "ESDNI",
            "value": "ESDNI",
            "description": "ES DNI"
          },
          {
            "name": "ESSocialSecurityNumber",
            "value": "ESSocialSecurityNumber",
            "description": "ES Social Security Number"
          },
          {
            "name": "ESTaxIdentificationNumber",
            "value": "ESTaxIdentificationNumber",
            "description": "ES Tax Identification Number"
          },
          {
            "name": "SQLServerConnectionString",
            "value": "SQLServerConnectionString",
            "description": "SQL Server Connection String"
          },
          {
            "name": "SENationalID",
            "value": "SENationalID",
            "description": "SE National ID"
          },
          {
            "name": "SENationalIDV2",
            "value": "SENationalIDV2",
            "description": "SE National ID V2"
          },
          {
            "name": "SEPassportNumber",
            "value": "SEPassportNumber",
            "description": "SE Passport Number"
          },
          {
            "name": "SETaxIdentificationNumber",
            "value": "SETaxIdentificationNumber",
            "description": "SE Tax Identification Number"
          },
          {
            "name": "SWIFTCode",
            "value": "SWIFTCode",
            "description": "SWIFT Code"
          },
          {
            "name": "CHSocialSecurityNumber",
            "value": "CHSocialSecurityNumber",
            "description": "CH Social Security Number"
          },
          {
            "name": "TWNationalID",
            "value": "TWNationalID",
            "description": "TW National ID"
          },
          {
            "name": "TWPassportNumber",
            "value": "TWPassportNumber",
            "description": "TW Passport Number"
          },
          {
            "name": "TWResidentCertificate",
            "value": "TWResidentCertificate",
            "description": "TW Resident Certificate"
          },
          {
            "name": "THPopulationIdentificationCode",
            "value": "THPopulationIdentificationCode",
            "description": "TH Population Identification Code"
          },
          {
            "name": "TRNationalIdentificationNumber",
            "value": "TRNationalIdentificationNumber",
            "description": "TR National Identification Number"
          },
          {
            "name": "UKDriversLicenseNumber",
            "value": "UKDriversLicenseNumber",
            "description": "UK Driver's License Number"
          },
          {
            "name": "UKElectoralRollNumber",
            "value": "UKElectoralRollNumber",
            "description": "UK Electoral Roll Number"
          },
          {
            "name": "UKNationalHealthNumber",
            "value": "UKNationalHealthNumber",
            "description": "UK National Health Number"
          },
          {
            "name": "UKNationalInsuranceNumber",
            "value": "UKNationalInsuranceNumber",
            "description": "UK National Insurance Number"
          },
          {
            "name": "UKUniqueTaxpayerNumber",
            "value": "UKUniqueTaxpayerNumber",
            "description": "UK Unique Taxpayer Number"
          },
          {
            "name": "USUKPassportNumber",
            "value": "USUKPassportNumber",
            "description": "US UK Passport Number"
          },
          {
            "name": "USBankAccountNumber",
            "value": "USBankAccountNumber",
            "description": "US Bank Account Number"
          },
          {
            "name": "USDriversLicenseNumber",
            "value": "USDriversLicenseNumber",
            "description": "US Driver's License Number"
          },
          {
            "name": "USIndividualTaxpayerIdentification",
            "value": "USIndividualTaxpayerIdentification",
            "description": "US Individual Taxpayer Identification"
          },
          {
            "name": "USSocialSecurityNumber",
            "value": "USSocialSecurityNumber",
            "description": "US Social Security Number"
          },
          {
            "name": "UAPassportNumberDomestic",
            "value": "UAPassportNumberDomestic",
            "description": "UA Passport Number Domestic"
          },
          {
            "name": "UAPassportNumberInternational",
            "value": "UAPassportNumberInternational",
            "description": "UA Passport Number International"
          },
          {
            "name": "Organization",
            "value": "Organization",
            "description": "Organization"
          },
          {
            "name": "Email",
            "value": "Email",
            "description": "Email"
          },
          {
            "name": "URL",
            "value": "URL",
            "description": "URL"
          },
          {
            "name": "Age",
            "value": "Age",
            "description": "Age"
          },
          {
            "name": "PhoneNumber",
            "value": "PhoneNumber",
            "description": "Phone Number"
          },
          {
            "name": "IPAddress",
            "value": "IPAddress",
            "description": "IP Address"
          },
          {
            "name": "Date",
            "value": "Date",
            "description": "Date"
          },
          {
            "name": "Person",
            "value": "Person",
            "description": "Person"
          },
          {
            "name": "Address",
            "value": "Address",
            "description": "Address"
          }
        ]
      }
    },
    "PiiCategory": {
      "type": "string",
      "description": "(Optional) describes the PII categories to return",
      "enum": [
        "ABARoutingNumber",
        "ARNationalIdentityNumber",
        "AUBankAccountNumber",
        "AUDriversLicenseNumber",
        "AUMedicalAccountNumber",
        "AUPassportNumber",
        "AUTaxFileNumber",
        "AUBusinessNumber",
        "AUCompanyNumber",
        "ATIdentityCard",
        "ATTaxIdentificationNumber",
        "ATValueAddedTaxNumber",
        "AzureDocumentDBAuthKey",
        "AzureIAASDatabaseConnectionAndSQLString",
        "AzureIoTConnectionString",
        "AzurePublishSettingPassword",
        "AzureRedisCacheString",
        "AzureSAS",
        "AzureServiceBusString",
        "AzureStorageAccountKey",
        "AzureStorageAccountGeneric",
        "BENationalNumber",
        "BENationalNumberV2",
        "BEValueAddedTaxNumber",
        "BRCPFNumber",
        "BRLegalEntityNumber",
        "BRNationalIDRG",
        "BGUniformCivilNumber",
        "CABankAccountNumber",
        "CADriversLicenseNumber",
        "CAHealthServiceNumber",
        "CAPassportNumber",
        "CAPersonalHealthIdentification",
        "CASocialInsuranceNumber",
        "CLIdentityCardNumber",
        "CNResidentIdentityCardNumber",
        "CreditCardNumber",
        "HRIdentityCardNumber",
        "HRNationalIDNumber",
        "HRPersonalIdentificationNumber",
        "HRPersonalIdentificationOIBNumberV2",
        "CYIdentityCard",
        "CYTaxIdentificationNumber",
        "CZPersonalIdentityNumber",
        "CZPersonalIdentityV2",
        "DKPersonalIdentificationNumber",
        "DKPersonalIdentificationV2",
        "DrugEnforcementAgencyNumber",
        "EEPersonalIdentificationCode",
        "EUDebitCardNumber",
        "EUDriversLicenseNumber",
        "EUGPSCoordinates",
        "EUNationalIdentificationNumber",
        "EUPassportNumber",
        "EUSocialSecurityNumber",
        "EUTaxIdentificationNumber",
        "FIEuropeanHealthNumber",
        "FINationalID",
        "FINationalIDV2",
        "FIPassportNumber",
        "FRDriversLicenseNumber",
        "FRHealthInsuranceNumber",
        "FRNationalID",
        "FRPassportNumber",
        "FRSocialSecurityNumber",
        "FRTaxIdentificationNumber",
        "FRValueAddedTaxNumber",
        "DEDriversLicenseNumber",
        "DEPassportNumber",
        "DEIdentityCardNumber",
        "DETaxIdentificationNumber",
        "DEValueAddedNumber",
        "GRNationalIDCard",
        "GRNationalIDV2",
        "GRTaxIdentificationNumber",
        "HKIdentityCardNumber",
        "HUValueAddedNumber",
        "HUPersonalIdentificationNumber",
        "HUTaxIdentificationNumber",
        "INPermanentAccount",
        "INUniqueIdentificationNumber",
        "IDIdentityCardNumber",
        "InternationalBankingAccountNumber",
        "IEPersonalPublicServiceNumber",
        "IEPersonalPublicServiceNumberV2",
        "ILBankAccountNumber",
        "ILNationalID",
        "ITDriversLicenseNumber",
        "ITFiscalCode",
        "ITValueAddedTaxNumber",
        "JPBankAccountNumber",
        "JPDriversLicenseNumber",
        "JPPassportNumber",
        "JPResidentRegistrationNumber",
        "JPSocialInsuranceNumber",
        "JPMyNumberCorporate",
        "JPMyNumberPersonal",
        "JPResidenceCardNumber",
        "LVPersonalCode",
        "LTPersonalCode",
        "LUNationalIdentificationNumberNatural",
        "LUNationalIdentificationNumberNonNatural",
        "MYIdentityCardNumber",
        "MTIdentityCardNumber",
        "MTTaxIDNumber",
        "NLCitizensServiceNumber",
        "NLCitizensServiceNumberV2",
        "NLTaxIdentificationNumber",
        "NLValueAddedTaxNumber",
        "NZBankAccountNumber",
        "NZDriversLicenseNumber",
        "NZInlandRevenueNumber",
        "NZMinistryOfHealthNumber",
        "NZSocialWelfareNumber",
        "NOIdentityNumber",
        "PHUnifiedMultiPurposeIDNumber",
        "PLIdentityCard",
        "PLNationalID",
        "PLNationalIDV2",
        "PLPassportNumber",
        "PLTaxIdentificationNumber",
        "PLREGONNumber",
        "PTCitizenCardNumber",
        "PTCitizenCardNumberV2",
        "PTTaxIdentificationNumber",
        "ROPersonalNumericalCode",
        "RUPassportNumberDomestic",
        "RUPassportNumberInternational",
        "SANationalID",
        "SGNationalRegistrationIdentityCardNumber",
        "SKPersonalNumber",
        "SITaxIdentificationNumber",
        "SIUniqueMasterCitizenNumber",
        "ZAIdentificationNumber",
        "KRResidentRegistrationNumber",
        "ESDNI",
        "ESSocialSecurityNumber",
        "ESTaxIdentificationNumber",
        "SQLServerConnectionString",
        "SENationalID",
        "SENationalIDV2",
        "SEPassportNumber",
        "SETaxIdentificationNumber",
        "SWIFTCode",
        "CHSocialSecurityNumber",
        "TWNationalID",
        "TWPassportNumber",
        "TWResidentCertificate",
        "THPopulationIdentificationCode",
        "TRNationalIdentificationNumber",
        "UKDriversLicenseNumber",
        "UKElectoralRollNumber",
        "UKNationalHealthNumber",
        "UKNationalInsuranceNumber",
        "UKUniqueTaxpayerNumber",
        "USUKPassportNumber",
        "USBankAccountNumber",
        "USDriversLicenseNumber",
        "USIndividualTaxpayerIdentification",
        "USSocialSecurityNumber",
        "UAPassportNumberDomestic",
        "UAPassportNumberInternational",
        "Organization",
        "Email",
        "URL",
        "Age",
        "PhoneNumber",
        "IPAddress",
        "Date",
        "Person",
        "Address",
        "All",
        "Default"
      ],
      "x-ms-enum": {
        "name": "PiiCategory",
        "modelAsString": true,
        "values": [
          {
            "name": "ABARoutingNumber",
            "value": "ABARoutingNumber",
            "description": "ABA Routing number"
          },
          {
            "name": "ARNationalIdentityNumber",
            "value": "ARNationalIdentityNumber",
            "description": "AR National Identity Number"
          },
          {
            "name": "AUBankAccountNumber",
            "value": "AUBankAccountNumber",
            "description": "AT Identity Card"
          },
          {
            "name": "AUDriversLicenseNumber",
            "value": "AUDriversLicenseNumber",
            "description": "AU Driver's License Number"
          },
          {
            "name": "AUMedicalAccountNumber",
            "value": "AUMedicalAccountNumber",
            "description": "AU Medical Account Number"
          },
          {
            "name": "AUPassportNumber",
            "value": "AUPassportNumber",
            "description": "AU Passport Number"
          },
          {
            "name": "AUTaxFileNumber",
            "value": "AUTaxFileNumber",
            "description": "AU Tax File Number"
          },
          {
            "name": "AUBusinessNumber",
            "value": "AUBusinessNumber",
            "description": "AU Business Number"
          },
          {
            "name": "AUCompanyNumber",
            "value": "AUCompanyNumber",
            "description": "AU Company Number"
          },
          {
            "name": "ATIdentityCard",
            "value": "ATIdentityCard",
            "description": "AT Identity Card"
          },
          {
            "name": "ATTaxIdentificationNumber",
            "value": "ATTaxIdentificationNumber",
            "description": "AT Tax Identification Number"
          },
          {
            "name": "ATValueAddedTaxNumber",
            "value": "ATValueAddedTaxNumber",
            "description": "AT Value Added Tax Number"
          },
          {
            "name": "AzureDocumentDBAuthKey",
            "value": "AzureDocumentDBAuthKey",
            "description": "Azure Document DB Auth Key"
          },
          {
            "name": "AzureIAASDatabaseConnectionAndSQLString",
            "value": "AzureIAASDatabaseConnectionAndSQLString",
            "description": "Azure IAAS Database Connection And SQL String"
          },
          {
            "name": "AzureIoTConnectionString",
            "value": "AzureIoTConnectionString",
            "description": "Azure IoT Connection String"
          },
          {
            "name": "AzurePublishSettingPassword",
            "value": "AzurePublishSettingPassword",
            "description": "Azure Publish Setting Password"
          },
          {
            "name": "AzureRedisCacheString",
            "value": "AzureRedisCacheString",
            "description": "Azure Redis Cache String"
          },
          {
            "name": "AzureSAS",
            "value": "AzureSAS",
            "description": "Azure SAS"
          },
          {
            "name": "AzureServiceBusString",
            "value": "AzureServiceBusString",
            "description": "Azure Service Bus String"
          },
          {
            "name": "AzureStorageAccountKey",
            "value": "AzureStorageAccountKey",
            "description": "Azure Storage Account Key"
          },
          {
            "name": "AzureStorageAccountGeneric",
            "value": "AzureStorageAccountGeneric",
            "description": "Azure Storage Account Generic"
          },
          {
            "name": "BENationalNumber",
            "value": "BENationalNumber",
            "description": "BE National Number"
          },
          {
            "name": "BENationalNumberV2",
            "value": "BENationalNumberV2",
            "description": "BE National Number V2"
          },
          {
            "name": "BEValueAddedTaxNumber",
            "value": "BEValueAddedTaxNumber",
            "description": "BE Value Added Tax Number"
          },
          {
            "name": "BRCPFNumber",
            "value": "BRCPFNumber",
            "description": "BR CPF Number"
          },
          {
            "name": "BRLegalEntityNumber",
            "value": "BRLegalEntityNumber",
            "description": "BR Legal Entity Number"
          },
          {
            "name": "BRNationalIDRG",
            "value": "BRNationalIDRG",
            "description": "BR National ID RG"
          },
          {
            "name": "BGUniformCivilNumber",
            "value": "BGUniformCivilNumber",
            "description": "BG Uniform Civil Number"
          },
          {
            "name": "CABankAccountNumber",
            "value": "CABankAccountNumber",
            "description": "CA Bank Account Number"
          },
          {
            "name": "CADriversLicenseNumber",
            "value": "CADriversLicenseNumber",
            "description": "CA Driver's License Number"
          },
          {
            "name": "CAHealthServiceNumber",
            "value": "CAHealthServiceNumber",
            "description": "CA Health Service Number"
          },
          {
            "name": "CAPassportNumber",
            "value": "CAPassportNumber",
            "description": "CA Passport Number"
          },
          {
            "name": "CAPersonalHealthIdentification",
            "value": "CAPersonalHealthIdentification",
            "description": "CA Personal Health Identification"
          },
          {
            "name": "CASocialInsuranceNumber",
            "value": "CASocialInsuranceNumber",
            "description": "CA Social Insurance Number"
          },
          {
            "name": "CLIdentityCardNumber",
            "value": "CLIdentityCardNumber",
            "description": "CL Identity Card Number"
          },
          {
            "name": "CNResidentIdentityCardNumber",
            "value": "CNResidentIdentityCardNumber",
            "description": "CN Resident Identity Card Number"
          },
          {
            "name": "CreditCardNumber",
            "value": "CreditCardNumber",
            "description": "Credit Card Number"
          },
          {
            "name": "HRIdentityCardNumber",
            "value": "HRIdentityCardNumber",
            "description": "HR Identity Card Number"
          },
          {
            "name": "HRNationalIDNumber",
            "value": "HRNationalIDNumber",
            "description": "HR National ID Number"
          },
          {
            "name": "HRPersonalIdentificationNumber",
            "value": "HRPersonalIdentificationNumber",
            "description": "HR Personal Identification Number"
          },
          {
            "name": "HRPersonalIdentificationOIBNumberV2",
            "value": "HRPersonalIdentificationOIBNumberV2",
            "description": "HR Personal Identification OIB Number V2"
          },
          {
            "name": "CYIdentityCard",
            "value": "CYIdentityCard",
            "description": "CY Identity Card"
          },
          {
            "name": "CYTaxIdentificationNumber",
            "value": "CYTaxIdentificationNumber",
            "description": "CY Tax Identification Number"
          },
          {
            "name": "CZPersonalIdentityNumber",
            "value": "CZPersonalIdentityNumber",
            "description": "CZ Personal Identity Number"
          },
          {
            "name": "CZPersonalIdentityV2",
            "value": "CZPersonalIdentityV2",
            "description": "CZ Personal Identity V2"
          },
          {
            "name": "DKPersonalIdentificationNumber",
            "value": "DKPersonalIdentificationNumber",
            "description": "DK Personal Identification Number"
          },
          {
            "name": "DKPersonalIdentificationV2",
            "value": "DKPersonalIdentificationV2",
            "description": "DK Personal Identification V2"
          },
          {
            "name": "DrugEnforcementAgencyNumber",
            "value": "DrugEnforcementAgencyNumber",
            "description": "Drug Enforcement Agency Number"
          },
          {
            "name": "EEPersonalIdentificationCode",
            "value": "EEPersonalIdentificationCode",
            "description": "EE Personal Identification Code"
          },
          {
            "name": "EUDebitCardNumber",
            "value": "EUDebitCardNumber",
            "description": "EU Debit Card Number"
          },
          {
            "name": "EUDriversLicenseNumber",
            "value": "EUDriversLicenseNumber",
            "description": "EU Driver's License Number"
          },
          {
            "name": "EUGPSCoordinates",
            "value": "EUGPSCoordinates",
            "description": "EU GPS Coordinates"
          },
          {
            "name": "EUNationalIdentificationNumber",
            "value": "EUNationalIdentificationNumber",
            "description": "EU National Identification Number"
          },
          {
            "name": "EUPassportNumber",
            "value": "EUPassportNumber",
            "description": "EU Passport Number"
          },
          {
            "name": "EUSocialSecurityNumber",
            "value": "EUSocialSecurityNumber",
            "description": "EU Social Security Number"
          },
          {
            "name": "EUTaxIdentificationNumber",
            "value": "EUTaxIdentificationNumber",
            "description": "EU Tax Identification Number"
          },
          {
            "name": "FIEuropeanHealthNumber",
            "value": "FIEuropeanHealthNumber",
            "description": "FI European Health Number"
          },
          {
            "name": "FINationalID",
            "value": "FINationalID",
            "description": "FI National ID"
          },
          {
            "name": "FINationalIDV2",
            "value": "FINationalIDV2",
            "description": "FI National ID V2"
          },
          {
            "name": "FIPassportNumber",
            "value": "FIPassportNumber",
            "description": "FI Passport Number"
          },
          {
            "name": "FRDriversLicenseNumber",
            "value": "FRDriversLicenseNumber",
            "description": "FR Driver's License Number"
          },
          {
            "name": "FRHealthInsuranceNumber",
            "value": "FRHealthInsuranceNumber",
            "description": "FR Health Insurance Number"
          },
          {
            "name": "FRNationalID",
            "value": "FRNationalID",
            "description": "FR National ID"
          },
          {
            "name": "FRPassportNumber",
            "value": "FRPassportNumber",
            "description": "FR Passport Number"
          },
          {
            "name": "FRSocialSecurityNumber",
            "value": "FRSocialSecurityNumber",
            "description": "FR Social Security Number"
          },
          {
            "name": "FRTaxIdentificationNumber",
            "value": "FRTaxIdentificationNumber",
            "description": "FR Tax Identification Number"
          },
          {
            "name": "FRValueAddedTaxNumber",
            "value": "FRValueAddedTaxNumber",
            "description": "FR Value Added Tax Number"
          },
          {
            "name": "DEDriversLicenseNumber",
            "value": "DEDriversLicenseNumber",
            "description": "DE Driver's License Number"
          },
          {
            "name": "DEPassportNumber",
            "value": "DEPassportNumber",
            "description": "DE Passport Number"
          },
          {
            "name": "DEIdentityCardNumber",
            "value": "DEIdentityCardNumber",
            "description": "DE Identity Card Number"
          },
          {
            "name": "DETaxIdentificationNumber",
            "value": "DETaxIdentificationNumber",
            "description": "DE Tax Identification Number"
          },
          {
            "name": "DEValueAddedNumber",
            "value": "DEValueAddedNumber",
            "description": "DE Value Added Number"
          },
          {
            "name": "GRNationalIDCard",
            "value": "GRNationalIDCard",
            "description": "GR National ID Card"
          },
          {
            "name": "GRNationalIDV2",
            "value": "GRNationalIDV2",
            "description": "GR National ID V2"
          },
          {
            "name": "GRTaxIdentificationNumber",
            "value": "GRTaxIdentificationNumber",
            "description": "GR Tax Identification Number"
          },
          {
            "name": "HKIdentityCardNumber",
            "value": "HKIdentityCardNumber",
            "description": "HK Identity Card Number"
          },
          {
            "name": "HUValueAddedNumber",
            "value": "HUValueAddedNumber",
            "description": "HU Value Added Number"
          },
          {
            "name": "HUPersonalIdentificationNumber",
            "value": "HUPersonalIdentificationNumber",
            "description": "HU Personal Identification Number"
          },
          {
            "name": "HUTaxIdentificationNumber",
            "value": "HUTaxIdentificationNumber",
            "description": "HU Tax Identification Number"
          },
          {
            "name": "INPermanentAccount",
            "value": "INPermanentAccount",
            "description": "IN Permanent Account"
          },
          {
            "name": "INUniqueIdentificationNumber",
            "value": "INUniqueIdentificationNumber",
            "description": "IN Unique Identification Number"
          },
          {
            "name": "IDIdentityCardNumber",
            "value": "IDIdentityCardNumber",
            "description": "ID Identity Card Number"
          },
          {
            "name": "InternationalBankingAccountNumber",
            "value": "InternationalBankingAccountNumber",
            "description": "International Banking Account Number"
          },
          {
            "name": "IEPersonalPublicServiceNumber",
            "value": "IEPersonalPublicServiceNumber",
            "description": "IE Personal Public Service Number"
          },
          {
            "name": "IEPersonalPublicServiceNumberV2",
            "value": "IEPersonalPublicServiceNumberV2",
            "description": "IE Personal Public Service Number V2"
          },
          {
            "name": "ILBankAccountNumber",
            "value": "ILBankAccountNumber",
            "description": "IL Bank Account Number"
          },
          {
            "name": "ILNationalID",
            "value": "ILNationalID",
            "description": "IL National ID"
          },
          {
            "name": "ITDriversLicenseNumber",
            "value": "ITDriversLicenseNumber",
            "description": "IT Driver's License Number"
          },
          {
            "name": "ITFiscalCode",
            "value": "ITFiscalCode",
            "description": "IT Fiscal Code"
          },
          {
            "name": "ITValueAddedTaxNumber",
            "value": "ITValueAddedTaxNumber",
            "description": "IT Value Added Tax Number"
          },
          {
            "name": "JPBankAccountNumber",
            "value": "JPBankAccountNumber",
            "description": "JP Bank Account Number"
          },
          {
            "name": "JPDriversLicenseNumber",
            "value": "JPDriversLicenseNumber",
            "description": "JP Driver's License Number"
          },
          {
            "name": "JPPassportNumber",
            "value": "JPPassportNumber",
            "description": "JP Passport Number"
          },
          {
            "name": "JPResidentRegistrationNumber",
            "value": "JPResidentRegistrationNumber",
            "description": "JP Resident Registration Number"
          },
          {
            "name": "JPSocialInsuranceNumber",
            "value": "JPSocialInsuranceNumber",
            "description": "JP Social Insurance Number"
          },
          {
            "name": "JPMyNumberCorporate",
            "value": "JPMyNumberCorporate",
            "description": "JP My Number Corporate"
          },
          {
            "name": "JPMyNumberPersonal",
            "value": "JPMyNumberPersonal",
            "description": "JP My Number Personal"
          },
          {
            "name": "JPResidenceCardNumber",
            "value": "JPResidenceCardNumber",
            "description": "JP Residence Card Number"
          },
          {
            "name": "LVPersonalCode",
            "value": "LVPersonalCode",
            "description": "LV Personal Code"
          },
          {
            "name": "LTPersonalCode",
            "value": "LTPersonalCode",
            "description": "LT Personal Code"
          },
          {
            "name": "LUNationalIdentificationNumberNatural",
            "value": "LUNationalIdentificationNumberNatural",
            "description": "LU National Identification Number Natural"
          },
          {
            "name": "LUNationalIdentificationNumberNonNatural",
            "value": "LUNationalIdentificationNumberNonNatural",
            "description": "LU National Identification Number Non Natural"
          },
          {
            "name": "MYIdentityCardNumber",
            "value": "MYIdentityCardNumber",
            "description": "MY Identity Card Number"
          },
          {
            "name": "MTIdentityCardNumber",
            "value": "MTIdentityCardNumber",
            "description": "MT Identity Card Number"
          },
          {
            "name": "MTTaxIDNumber",
            "value": "MTTaxIDNumber",
            "description": "MT Tax ID Number"
          },
          {
            "name": "NLCitizensServiceNumber",
            "value": "NLCitizensServiceNumber",
            "description": "NL Citizens Service Number"
          },
          {
            "name": "NLCitizensServiceNumberV2",
            "value": "NLCitizensServiceNumberV2",
            "description": "NL Citizens Service Number V2"
          },
          {
            "name": "NLTaxIdentificationNumber",
            "value": "NLTaxIdentificationNumber",
            "description": "NL Tax Identification Number"
          },
          {
            "name": "NLValueAddedTaxNumber",
            "value": "NLValueAddedTaxNumber",
            "description": "NL Value Added Tax Number"
          },
          {
            "name": "NZBankAccountNumber",
            "value": "NZBankAccountNumber",
            "description": "NZ Bank Account Number"
          },
          {
            "name": "NZDriversLicenseNumber",
            "value": "NZDriversLicenseNumber",
            "description": "NZ Driver's License Number"
          },
          {
            "name": "NZInlandRevenueNumber",
            "value": "NZInlandRevenueNumber",
            "description": "NZ Inland Revenue Number"
          },
          {
            "name": "NZMinistryOfHealthNumber",
            "value": "NZMinistryOfHealthNumber",
            "description": "NZ Ministry Of Health Number"
          },
          {
            "name": "NZSocialWelfareNumber",
            "value": "NZSocialWelfareNumber",
            "description": "NZ Social Welfare Number"
          },
          {
            "name": "NOIdentityNumber",
            "value": "NOIdentityNumber",
            "description": "NO Identity Number"
          },
          {
            "name": "PHUnifiedMultiPurposeIDNumber",
            "value": "PHUnifiedMultiPurposeIDNumber",
            "description": "PH Unified Multi Purpose ID Number"
          },
          {
            "name": "PLIdentityCard",
            "value": "PLIdentityCard",
            "description": "PL Identity Card"
          },
          {
            "name": "PLNationalID",
            "value": "PLNationalID",
            "description": "PL National ID"
          },
          {
            "name": "PLNationalIDV2",
            "value": "PLNationalIDV2",
            "description": "PL National ID V2"
          },
          {
            "name": "PLPassportNumber",
            "value": "PLPassportNumber",
            "description": "PL Passport Number"
          },
          {
            "name": "PLTaxIdentificationNumber",
            "value": "PLTaxIdentificationNumber",
            "description": "PL Tax Identification Number"
          },
          {
            "name": "PLREGONNumber",
            "value": "PLREGONNumber",
            "description": "PL REGON Number"
          },
          {
            "name": "PTCitizenCardNumber",
            "value": "PTCitizenCardNumber",
            "description": "PT Citizen Card Number"
          },
          {
            "name": "PTCitizenCardNumberV2",
            "value": "PTCitizenCardNumberV2",
            "description": "PT Citizen Card Number V2"
          },
          {
            "name": "PTTaxIdentificationNumber",
            "value": "PTTaxIdentificationNumber",
            "description": "PT Tax Identification Number"
          },
          {
            "name": "ROPersonalNumericalCode",
            "value": "ROPersonalNumericalCode",
            "description": "RO Personal Numerical Code"
          },
          {
            "name": "RUPassportNumberDomestic",
            "value": "RUPassportNumberDomestic",
            "description": "RU Passport Number Domestic"
          },
          {
            "name": "RUPassportNumberInternational",
            "value": "RUPassportNumberInternational",
            "description": "RU Passport Number International"
          },
          {
            "name": "SANationalID",
            "value": "SANationalID",
            "description": "SA National ID"
          },
          {
            "name": "SGNationalRegistrationIdentityCardNumber",
            "value": "SGNationalRegistrationIdentityCardNumber",
            "description": "SG National Registration Identity Card Number"
          },
          {
            "name": "SKPersonalNumber",
            "value": "SKPersonalNumber",
            "description": "SK Personal Number"
          },
          {
            "name": "SITaxIdentificationNumber",
            "value": "SITaxIdentificationNumber",
            "description": "SI Tax Identification Number"
          },
          {
            "name": "SIUniqueMasterCitizenNumber",
            "value": "SIUniqueMasterCitizenNumber",
            "description": "SI Unique Master Citizen Number"
          },
          {
            "name": "ZAIdentificationNumber",
            "value": "ZAIdentificationNumber",
            "description": "ZA Identification Number"
          },
          {
            "name": "KRResidentRegistrationNumber",
            "value": "KRResidentRegistrationNumber",
            "description": "KR Resident Registration Number"
          },
          {
            "name": "ESDNI",
            "value": "ESDNI",
            "description": "ES DNI"
          },
          {
            "name": "ESSocialSecurityNumber",
            "value": "ESSocialSecurityNumber",
            "description": "ES Social Security Number"
          },
          {
            "name": "ESTaxIdentificationNumber",
            "value": "ESTaxIdentificationNumber",
            "description": "ES Tax Identification Number"
          },
          {
            "name": "SQLServerConnectionString",
            "value": "SQLServerConnectionString",
            "description": "SQL Server Connection String"
          },
          {
            "name": "SENationalID",
            "value": "SENationalID",
            "description": "SE National ID"
          },
          {
            "name": "SENationalIDV2",
            "value": "SENationalIDV2",
            "description": "SE National ID V2"
          },
          {
            "name": "SEPassportNumber",
            "value": "SEPassportNumber",
            "description": "SE Passport Number"
          },
          {
            "name": "SETaxIdentificationNumber",
            "value": "SETaxIdentificationNumber",
            "description": "SE Tax Identification Number"
          },
          {
            "name": "SWIFTCode",
            "value": "SWIFTCode",
            "description": "SWIFT Code"
          },
          {
            "name": "CHSocialSecurityNumber",
            "value": "CHSocialSecurityNumber",
            "description": "CH Social Security Number"
          },
          {
            "name": "TWNationalID",
            "value": "TWNationalID",
            "description": "TW National ID"
          },
          {
            "name": "TWPassportNumber",
            "value": "TWPassportNumber",
            "description": "TW Passport Number"
          },
          {
            "name": "TWResidentCertificate",
            "value": "TWResidentCertificate",
            "description": "TW Resident Certificate"
          },
          {
            "name": "THPopulationIdentificationCode",
            "value": "THPopulationIdentificationCode",
            "description": "TH Population Identification Code"
          },
          {
            "name": "TRNationalIdentificationNumber",
            "value": "TRNationalIdentificationNumber",
            "description": "TR National Identification Number"
          },
          {
            "name": "UKDriversLicenseNumber",
            "value": "UKDriversLicenseNumber",
            "description": "UK Driver's License Number"
          },
          {
            "name": "UKElectoralRollNumber",
            "value": "UKElectoralRollNumber",
            "description": "UK Electoral Roll Number"
          },
          {
            "name": "UKNationalHealthNumber",
            "value": "UKNationalHealthNumber",
            "description": "UK National Health Number"
          },
          {
            "name": "UKNationalInsuranceNumber",
            "value": "UKNationalInsuranceNumber",
            "description": "UK National Insurance Number"
          },
          {
            "name": "UKUniqueTaxpayerNumber",
            "value": "UKUniqueTaxpayerNumber",
            "description": "UK Unique Taxpayer Number"
          },
          {
            "name": "USUKPassportNumber",
            "value": "USUKPassportNumber",
            "description": "US UK Passport Number"
          },
          {
            "name": "USBankAccountNumber",
            "value": "USBankAccountNumber",
            "description": "US Bank Account Number"
          },
          {
            "name": "USDriversLicenseNumber",
            "value": "USDriversLicenseNumber",
            "description": "US Driver's License Number"
          },
          {
            "name": "USIndividualTaxpayerIdentification",
            "value": "USIndividualTaxpayerIdentification",
            "description": "US Individual Taxpayer Identification"
          },
          {
            "name": "USSocialSecurityNumber",
            "value": "USSocialSecurityNumber",
            "description": "US Social Security Number"
          },
          {
            "name": "UAPassportNumberDomestic",
            "value": "UAPassportNumberDomestic",
            "description": "UA Passport Number Domestic"
          },
          {
            "name": "UAPassportNumberInternational",
            "value": "UAPassportNumberInternational",
            "description": "UA Passport Number International"
          },
          {
            "name": "Organization",
            "value": "Organization",
            "description": "Organization"
          },
          {
            "name": "Email",
            "value": "Email",
            "description": "Email"
          },
          {
            "name": "URL",
            "value": "URL",
            "description": "URL"
          },
          {
            "name": "Age",
            "value": "Age",
            "description": "Age"
          },
          {
            "name": "PhoneNumber",
            "value": "PhoneNumber",
            "description": "Phone Number"
          },
          {
            "name": "IPAddress",
            "value": "IPAddress",
            "description": "IP Address"
          },
          {
            "name": "Date",
            "value": "Date",
            "description": "Date"
          },
          {
            "name": "Person",
            "value": "Person",
            "description": "Person"
          },
          {
            "name": "Address",
            "value": "Address",
            "description": "Address"
          },
          {
            "name": "All",
            "value": "All",
            "description": "All PII categories."
          },
          {
            "name": "Default",
            "value": "Default",
            "description": "Default PII categories for the language."
          }
        ]
      }
    },
    "PiiEntityRecognitionLROResult": {
      "type": "object",
      "description": "Contains the PII LRO results.",
      "properties": {
        "results": {
          "$ref": "#/definitions/AnalyzeDocumentsResult",
          "description": "The list of pii document results"
        }
      },
      "required": [
        "results"
      ],
      "allOf": [
        {
          "$ref": "#/definitions/AnalyzeDocumentsLROResult"
        }
      ],
      "x-ms-discriminator-value": "PiiEntityRecognitionLROResults"
    },
    "PiiLROTask": {
      "type": "object",
      "description": "Contains the analyze text PIIEntityRecognition LRO task.",
      "properties": {
        "parameters": {
          "$ref": "#/definitions/PiiTaskParameters",
          "description": "Pii task parameters."
        }
      },
      "allOf": [
        {
          "$ref": "#/definitions/AnalyzeDocumentsLROTask"
        }
      ],
      "x-ms-discriminator-value": "PiiEntityRecognition"
    },
    "PiiTaskParameters": {
      "type": "object",
      "description": "Supported parameters for a PII Entities Recognition task.",
      "properties": {
        "loggingOptOut": {
          "type": "boolean",
          "description": "logging opt out",
          "default": false
        },
        "modelVersion": {
          "type": "string",
          "description": "model version",
          "default": "latest"
        },
        "domain": {
          "type": "string",
          "description": "Domain for PII task",
          "default": "none",
          "enum": [
            "phi",
            "none"
          ],
          "x-ms-enum": {
            "name": "PiiDomain",
            "modelAsString": true,
            "values": [
              {
                "name": "phi",
                "value": "phi",
                "description": "Indicates that entities in the Personal Health Information domain should be redacted."
              },
              {
                "name": "none",
                "value": "none",
                "description": "Indicates that no domain is specified."
              }
            ]
          }
        },
        "piiCategories": {
          "type": "array",
          "description": "Enumeration of PII categories to be returned in the response.",
          "items": {
            "$ref": "#/definitions/PiiCategory"
          }
        },
        "stringIndexType": {
          "type": "string",
          "description": "StringIndexType to be used for analysis.",
          "default": "TextElements_v8",
          "enum": [
            "TextElements_v8",
            "UnicodeCodePoint",
            "Utf16CodeUnit"
          ],
          "x-ms-enum": {
            "name": "StringIndexType",
            "modelAsString": true,
            "values": [
              {
                "name": "TextElements_v8",
                "value": "TextElements_v8",
                "description": "Returned offset and length values will correspond to textElements (Graphemes and Grapheme clusters) conforming to the Unicode 8.0.0 standard. Use this option if your application is written in .NET Framework or .NET Core and you will be using StringInfo."
              },
              {
                "name": "UnicodeCodePoint",
                "value": "UnicodeCodePoint",
                "description": "Returned offset and length values will correspond to Unicode code points. Use this option if your application is written in a language that supports Unicode, for example Python."
              },
              {
                "name": "Utf16CodeUnit",
                "value": "Utf16CodeUnit",
                "description": "Returned offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that supports Unicode, for example Java, JavaScript."
              }
            ]
          }
        },
        "excludePiiCategories": {
          "type": "array",
          "description": "Enumeration of PII categories to be excluded in the response.",
          "items": {
            "$ref": "#/definitions/PiiCategoriesExclude"
          }
        },
        "redactionPolicy": {
          "$ref": "#/definitions/BaseRedactionPolicy",
          "description": "Redaction policy to be used when redacting from documents"
        },
        "excludeExtractionData": {
          "type": "boolean",
          "description": "Boolean to indicate if entities should be excluded from the response json stored in the customer's storage."
        }
      }
    },
    "RedactionPolicyKind": {
      "type": "string",
      "description": "Kinds of redaction policies supported.",
      "enum": [
        "noMask",
        "characterMask",
        "entityMask"
      ],
      "x-ms-enum": {
        "name": "RedactionPolicyKind",
        "modelAsString": true,
        "values": [
          {
            "name": "noMask",
            "value": "noMask",
            "description": "Do not redact detected entities."
          },
          {
            "name": "characterMask",
            "value": "characterMask",
            "description": "Redact detected entities with redaction character."
          },
          {
            "name": "entityMask",
            "value": "entityMask",
            "description": "Redact detected entities with entity type."
          }
        ]
      }
    },
    "RequestStatistics": {
      "type": "object",
      "description": "if showStats=true was specified in the request this field will contain information about the request payload.",
      "properties": {
        "documentsCount": {
          "type": "integer",
          "format": "int32",
          "description": "Number of documents submitted in the request."
        },
        "validDocumentsCount": {
          "type": "integer",
          "format": "int32",
          "description": "Number of valid documents. This excludes empty, over-size limit or non-supported languages documents."
        },
        "erroneousDocumentsCount": {
          "type": "integer",
          "format": "int32",
          "description": "Number of invalid documents. This includes empty, over-size limit or non-supported languages documents."
        },
        "transactionsCount": {
          "type": "integer",
          "format": "int64",
          "description": "Number of transactions for the request."
        }
      },
      "required": [
        "documentsCount",
        "validDocumentsCount",
        "erroneousDocumentsCount",
        "transactionsCount"
      ]
    },
    "State": {
      "type": "string",
      "description": "The status of the task at the mentioned last update time.",
      "enum": [
        "notStarted",
        "running",
        "succeeded",
        "partiallyCompleted",
        "failed",
        "cancelled",
        "cancelling"
      ],
      "x-ms-enum": {
        "name": "State",
        "modelAsString": true,
        "values": [
          {
            "name": "notStarted",
            "value": "notStarted",
            "description": "Not started status"
          },
          {
            "name": "running",
            "value": "running",
            "description": "Running status"
          },
          {
            "name": "succeeded",
            "value": "succeeded",
            "description": "Succeeded status"
          },
          {
            "name": "partiallyCompleted",
            "value": "partiallyCompleted",
            "description": "Partially completed status"
          },
          {
            "name": "failed",
            "value": "failed",
            "description": "Failed status"
          },
          {
            "name": "cancelled",
            "value": "cancelled",
            "description": "Cancelled status"
          },
          {
            "name": "cancelling",
            "value": "cancelling",
            "description": "Cancelling status"
          }
        ]
      }
    },
    "SummaryLengthBucket": {
      "type": "string",
      "description": "Enum that defines the length of the output summaries.",
      "enum": [
        "short",
        "medium",
        "long"
      ],
      "x-ms-enum": {
        "name": "SummaryLengthBucket",
        "modelAsString": true,
        "values": [
          {
            "name": "short",
            "value": "short",
            "description": "Instructs model to generate shorter length summaries."
          },
          {
            "name": "medium",
            "value": "medium",
            "description": "Instructs model to generate medium length summaries."
          },
          {
            "name": "long",
            "value": "long",
            "description": "Instructs model to generate longer length summaries."
          }
        ]
      }
    },
    "Tasks": {
      "type": "object",
      "description": "Container for the tasks status for the LRO job.",
      "properties": {
        "completed": {
          "type": "integer",
          "format": "int32",
          "description": "Count of completed tasks."
        },
        "failed": {
          "type": "integer",
          "format": "int32",
          "description": "Count of failed tasks."
        },
        "inProgress": {
          "type": "integer",
          "format": "int32",
          "description": "Count of inprogress tasks."
        },
        "total": {
          "type": "integer",
          "format": "int32",
          "description": "Count of total tasks."
        },
        "items": {
          "type": "array",
          "description": "Enumerable of Analyze documents job results.",
          "items": {
            "$ref": "#/definitions/AnalyzeDocumentsLROResult"
          }
        }
      },
      "required": [
        "completed",
        "failed",
        "inProgress",
        "total"
      ]
    },
    "WarningCodeValue": {
      "type": "string",
      "description": "Defines the list of the warning codes.",
      "enum": [
        "LongWordsInDocument",
        "DocumentTruncated"
      ],
      "x-ms-enum": {
        "name": "WarningCodeValue",
        "modelAsString": true,
        "values": [
          {
            "name": "LongWordsInDocument",
            "value": "LongWordsInDocument",
            "description": "Long words in document warning"
          },
          {
            "name": "DocumentTruncated",
            "value": "DocumentTruncated",
            "description": "Document truncated warning"
          }
        ]
      }
    }
  },
  "parameters": {
    "Azure.Core.Foundations.ApiVersionParameter": {
      "name": "api-version",
      "in": "query",
      "description": "The API version to use for this operation.",
      "required": true,
      "type": "string",
      "minLength": 1,
      "x-ms-parameter-location": "method",
      "x-ms-client-name": "apiVersion"
    }
  }
}