Text Analysis Runtime - Analyze Text

Service:

Cognitive Services - Language

API Version:

2023-04-01

Запрос анализа текста для коллекции документов.

POST {Endpoint}/language/:analyze-text?api-version=2023-04-01

With optional parameters:

POST {Endpoint}/language/:analyze-text?api-version=2023-04-01&showStats={showStats}

Параметры URI

Имя	В	Обязательно	Тип	Описание
Endpoint	path	True	string	Поддерживаемая конечная точка Cognitive Services (например, https://.api.cognitiveservices.azure.com).
api-version	query	True	string	Версия API, используемая для данной операции.
showStats	query		boolean	(Необязательно) Если задано значение true, ответ будет содержать статистику на уровне запроса и документа.

Заголовок запроса

Имя	Обязательно	Тип	Описание
Ocp-Apim-Subscription-Key	True	string

Текст запроса

Текст запроса может быть таким:

Имя	Описание
AnalyzeTextEntityLinkingInput	Содержит входные данные связывания сущностей анализа текста.
AnalyzeTextEntityRecognitionInput	Запрос задачи распознавания сущностей анализа текста.
AnalyzeTextKeyPhraseExtractionInput	Содержит входные данные задачи анализа текста KeyPhraseExtraction.
AnalyzeTextLanguageDetectionInput	Содержит входные данные задачи анализа документов распознавания языка.
AnalyzeTextPiiEntitiesRecognitionInput	Содержит входные данные задачи анализа текста PIIEntityRecognition.
AnalyzeTextSentimentAnalysisInput	Содержит входные данные задачи Анализа текста SentimentAnalysis.

AnalyzeTextEntityLinkingInput

Содержит входные данные связывания сущностей анализа текста.

Имя	Обязательно	Тип	Описание
kind	True	string: EntityLinking	Тип выполняемой задачи.
analysisInput		MultiLanguageAnalysisInput	Содержит входные данные анализа, обрабатываемые службой.
parameters		EntityLinkingTaskParameters	Параметры задачи.

AnalyzeTextEntityRecognitionInput

Запрос задачи распознавания сущностей анализа текста.

Имя	Обязательно	Тип	Описание
kind	True	string: EntityRecognition	Тип выполняемой задачи.
analysisInput		MultiLanguageAnalysisInput	Входные данные для анализа.
parameters		EntitiesTaskParameters	Параметры задачи.

AnalyzeTextKeyPhraseExtractionInput

Содержит входные данные задачи анализа текста KeyPhraseExtraction.

Имя	Обязательно	Тип	Описание
kind	True	string: KeyPhraseExtraction	Тип выполняемой задачи.
analysisInput		MultiLanguageAnalysisInput	Содержит входные документы.
parameters		KeyPhraseTaskParameters	Параметры задачи извлечения ключевых фраз.

AnalyzeTextLanguageDetectionInput

Содержит входные данные задачи анализа документов распознавания языка.

Имя	Обязательно	Тип	Описание
kind	True	string: LanguageDetection	Тип выполняемой задачи.
analysisInput		LanguageDetectionAnalysisInput	Документы для анализа.
parameters		LanguageDetectionTaskParameters	параметры задачи.

AnalyzeTextPiiEntitiesRecognitionInput

Содержит входные данные задачи анализа текста PIIEntityRecognition.

Имя	Обязательно	Тип	Описание
kind	True	string: PiiEntityRecognition	Тип выполняемой задачи.
analysisInput		MultiLanguageAnalysisInput	Содержит входные документы.
parameters		PiiTaskParameters	Параметры задачи Pii.

AnalyzeTextSentimentAnalysisInput

Содержит входные данные задачи Анализа текста SentimentAnalysis.

Имя	Обязательно	Тип	Описание
kind	True	string: SentimentAnalysis	Тип выполняемой задачи.
analysisInput		MultiLanguageAnalysisInput	Содержит входные документы.
parameters		SentimentAnalysisTaskParameters	Параметры задачи анализа тональности.

Ответы

Имя	Тип	Описание
200 OK	AnalyzeTextTaskResult: EntitiesTaskResult EntityLinkingTaskResult KeyPhraseTaskResult LanguageDetectionTaskResult PiiTaskResult SentimentTaskResult	Запрос выполнен успешно.
Other Status Codes	ErrorResponse	Непредвиденное сообщение об ошибке. Headers x-ms-error-code: string

Безопасность

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Примеры

SuccessfulEntityLinkingRequest

SuccessfulEntityRecognitionRequest

SuccessfulKeyPhraseExtractionRequest

SuccessfulLanguageDetectionRequest

SuccessfulPiiEntityRecognitionRequest

SuccessfulSentimentAnalysisRequest

SuccessfulEntityLinkingRequest

Sample Request

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2023-04-01


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

Sample Response

Status code:

200

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

SuccessfulEntityRecognitionRequest

Sample Request

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2023-04-01


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

Sample Response

Status code:

200

{
  "kind": "EntityRecognitionResults",
  "results": {
    "documents": [
      {
        "entities": [
          {
            "category": "Organization",
            "confidenceScore": 0.84,
            "length": 9,
            "offset": 0,
            "text": "Microsoft"
          },
          {
            "category": "Person",
            "confidenceScore": 0.85,
            "length": 10,
            "offset": 25,
            "text": "Bill Gates"
          },
          {
            "category": "Person",
            "confidenceScore": 0.9,
            "length": 10,
            "offset": 40,
            "text": "Paul Allen"
          }
        ],
        "id": "1",
        "warnings": []
      },
      {
        "entities": [
          {
            "category": "Location",
            "confidenceScore": 0.55,
            "length": 7,
            "offset": 33,
            "subcategory": "GPE",
            "text": "Seattle"
          }
        ],
        "id": "2",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2020-04-01"
  }
}

SuccessfulKeyPhraseExtractionRequest

Sample Request

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2023-04-01


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

Sample Response

Status code:

200

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

SuccessfulLanguageDetectionRequest

Sample Request

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2023-04-01


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

Sample Response

Status code:

200

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

SuccessfulPiiEntityRecognitionRequest

Sample Request

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2023-04-01


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

Sample Response

Status code:

200

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

SuccessfulSentimentAnalysisRequest

Sample Request

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2023-04-01


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

Sample Response

Status code:

200

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

Определения

Имя	Описание
AnalyzeTextEntityLinkingInput	Содержит входные данные связывания сущностей анализа текста.
AnalyzeTextEntityRecognitionInput	Запрос задачи распознавания сущностей анализа текста.
AnalyzeTextKeyPhraseExtractionInput	Содержит входные данные задачи анализа текста KeyPhraseExtraction.
AnalyzeTextLanguageDetectionInput	Содержит входные данные задачи анализа документов распознавания языка.
AnalyzeTextPiiEntitiesRecognitionInput	Содержит входные данные задачи анализа текста PIIEntityRecognition.
AnalyzeTextSentimentAnalysisInput	Содержит входные данные задачи анализа текста SentimentAnalysis.
AnalyzeTextTaskKind	Поддерживаемый тип задач анализа текста.
AnalyzeTextTaskResultsKind	Тип объекта ответа, возвращаемого задачей analyze-text.
DetectedLanguage	Содержит сведения об обнаружении языка для текста.
DocumentError	Содержит сведения об ошибках, возникших во время выполнения задания.
DocumentSentimentValue	Прогнозируемая тональность для документа (отрицательная, нейтральная, положительная или смешанная).
DocumentStatistics	Если в запросе указан параметр showStats=true, это поле будет содержать сведения о полезных данных документа.
DocumentWarning	Содержит объект warnings с предупреждениями, возникшими для обработанного документа.
EntitiesDocumentResult	Содержит результат задачи распознавания сущностей для документа.
EntitiesResult	Содержит результат задачи распознавания сущностей.
EntitiesTaskParameters	Поддерживаемые параметры для задачи распознавания сущностей.
EntitiesTaskResult	Содержит задачу сущности
Entity	Определяет объект обнаруженной сущности, содержащий категорию сущности, обнаруженный текст сущности и т. д.
EntityLinkingResult	Результат связывания сущностей.
EntityLinkingTaskParameters	Поддерживаемые параметры для задачи связывания сущностей.
EntityLinkingTaskResult	Содержит результат задачи анализа текста Связывание сущностей.
Error	Объект ответа об ошибке, возвращаемый при обнаружении службой некоторых ошибок во время обработки запроса.
ErrorCode	Код ошибки, доступный для чтения человеком.
ErrorResponse	Ответ об ошибке.
InnerErrorCode	Код ошибки, доступный для чтения человеком.
InnerErrorModel	Объект , содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по API Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
KeyPhraseResult	Содержит KeyPhraseResult.
KeyPhrasesDocumentResult	Содержит результаты извлечения ключевых фраз для документа.
KeyPhraseTaskParameters	Поддерживаемые параметры для задачи извлечения ключевых фраз.
KeyPhraseTaskResult	Содержит результат задачи анализа текста KeyPhraseExtraction.
LanguageDetectionAnalysisInput	Содержит входные данные анализа документа определения языка.
LanguageDetectionDocumentResult	Содержит определение языка для документа.
LanguageDetectionResult	Содержит результат определения языка для запроса.
LanguageDetectionTaskParameters	Поддерживаемые параметры для задачи распознавания языка.
LanguageDetectionTaskResult	Содержит результат задачи распознавания языка для запроса.
LanguageInput	Содержит входные данные обнаружения языка.
LinkedEntitiesDocumentResult	Результат связывания сущностей.
LinkedEntity	Объект LinkedEntity, содержащий обнаруженную сущность со связанными источниками или ссылками.
Match	Объект Match, содержащий текст обнаруженной сущности со смещением и длиной.
MultiLanguageAnalysisInput	Коллекция входных документов, которые будут проанализированы службой.
MultiLanguageInput	Содержит входной документ для анализа службой.
PiiCategory	(Необязательно) описывает возвращаемые категории личных сведений.
PiiDomain	Домен для задачи личных сведений
PiiEntitiesDocumentResult	Содержит результаты личных сведений.
PiiResult	Содержит PiiResult.
PiiTaskParameters	Поддерживаемые параметры для задачи распознавания сущностей личных сведений.
PiiTaskResult	Содержит задачу LRO анализа текста PIIEntityRecognition.
RequestStatistics	Если в запросе указан параметр showStats=true, это поле будет содержать сведения о полезных данных запроса.
SentenceAssessment	Представляет оценку предложения и связанные с ней оценки или целевые объекты.
SentenceSentiment	Тональность предложения документа.
SentenceSentimentValue	Прогнозируемая тональность для предложения.
SentenceTarget	Представляет целевой объект предложения и связанные с ним оценки или целевые объекты.
SentimentAnalysisTaskParameters	Поддерживаемые параметры для задачи анализа тональности.
SentimentConfidenceScores	Представляет оценки достоверности от 0 до 1 для всех классов тональности: положительные, нейтральные, отрицательные.
SentimentDocumentResult	Объект , представляющий предварительно созданные результаты анализа тональности каждого документа.
SentimentResponse	Результаты анализа тональности для входных документов.
SentimentTaskResult	Содержит результат задачи LRO анализа текста SentimentAnalysis.
StringIndexType	Тип строкового индекса
TargetConfidenceScoreLabel	Представляет оценки достоверности для всех классов тональности: положительные и отрицательные.
TargetRelation	Представляет связь между оценками и (или) целевыми объектами.
TargetRelationType	Тип, связанный с целевым объектом.
TokenSentimentValue	Прогнозируемая тональность для предложения.
WarningCodeValue	Определяет список кодов предупреждений.

AnalyzeTextEntityLinkingInput

Содержит входные данные связывания сущностей анализа текста.

Имя	Тип	Описание
analysisInput	MultiLanguageAnalysisInput	Содержит входные данные анализа, обрабатываемые службой.
kind	string: EntityLinking	Тип выполняемой задачи.
parameters	EntityLinkingTaskParameters	Параметры задачи.

AnalyzeTextEntityRecognitionInput

Запрос задачи распознавания сущностей анализа текста.

Имя	Тип	Описание
analysisInput	MultiLanguageAnalysisInput	Входные данные для анализа.
kind	string: EntityRecognition	Тип выполняемой задачи.
parameters	EntitiesTaskParameters	Параметры задачи.

AnalyzeTextKeyPhraseExtractionInput

Содержит входные данные задачи анализа текста KeyPhraseExtraction.

Имя	Тип	Описание
analysisInput	MultiLanguageAnalysisInput	Содержит входные документы.
kind	string: KeyPhraseExtraction	Тип выполняемой задачи.
parameters	KeyPhraseTaskParameters	Параметры задачи извлечения ключевых фраз.

AnalyzeTextLanguageDetectionInput

Содержит входные данные задачи анализа документов распознавания языка.

Имя	Тип	Описание
analysisInput	LanguageDetectionAnalysisInput	Документы для анализа.
kind	string: LanguageDetection	Тип выполняемой задачи.
parameters	LanguageDetectionTaskParameters	параметры задачи.

AnalyzeTextPiiEntitiesRecognitionInput

Содержит входные данные задачи анализа текста PIIEntityRecognition.

Имя	Тип	Описание
analysisInput	MultiLanguageAnalysisInput	Содержит входные документы.
kind	string: PiiEntityRecognition	Тип выполняемой задачи.
parameters	PiiTaskParameters	Параметры задачи Pii.

AnalyzeTextSentimentAnalysisInput

Содержит входные данные задачи анализа текста SentimentAnalysis.

Имя	Тип	Описание
analysisInput	MultiLanguageAnalysisInput	Содержит входные документы.
kind	string: SentimentAnalysis	Тип выполняемой задачи.
parameters	SentimentAnalysisTaskParameters	Параметры задачи анализа тональности.

AnalyzeTextTaskKind

Поддерживаемый тип задач анализа текста.

Имя	Тип	Описание
EntityLinking	string	Задача связывания сущностей
EntityRecognition	string	Задача распознавания сущностей
KeyPhraseExtraction	string	Задача извлечения ключевых фраз
LanguageDetection	string	Задача распознавания языка
PiiEntityRecognition	string	Задача распознавания сущностей личных сведений
SentimentAnalysis	string	Задача анализа тональности

AnalyzeTextTaskResultsKind

Тип объекта ответа, возвращаемого задачей analyze-text.

Имя	Тип	Описание
EntityLinkingResults	string	Результаты связывания сущностей
EntityRecognitionResults	string	Результаты распознавания сущностей
KeyPhraseExtractionResults	string	Результаты извлечения ключевых фраз
LanguageDetectionResults	string	Результаты обнаружения языка
PiiEntityRecognitionResults	string	Результаты распознавания сущностей личных сведений
SentimentAnalysisResults	string	Результаты анализа тональности

DetectedLanguage

Содержит сведения об обнаружении языка для текста.

Имя	Тип	Описание
confidenceScore	number	Оценка достоверности от 0 до 1. Если оценка приближается к 1, существует стопроцентная уверенность, что язык определен правильно.
iso6391Name	string	Двухбуквенный вариант обнаруженного языка в соответствии со стандартом ISO 639-1 (например, en, fr).
name	string	Длинное имя обнаруженного языка (например, английский, французский).

DocumentError

Содержит сведения об ошибках, возникших во время выполнения задания.

Имя	Тип	Описание
error	Error	Ошибка.
id	string	Идентификатор входного документа.

DocumentSentimentValue

Прогнозируемая тональность для документа (отрицательная, нейтральная, положительная или смешанная).

Имя	Тип	Описание
mixed	string	Смешанный оператор
negative	string	Оператор Negative
neutral	string	Оператор Neutral
positive	string	Положительное утверждение

DocumentStatistics

Если в запросе указан параметр showStats=true, это поле будет содержать сведения о полезных данных документа.

Имя	Тип	Описание
charactersCount	integer	Количество текстовых элементов, распознаваемых в документе.
transactionsCount	integer	Количество транзакций для документа.

DocumentWarning

Содержит объект warnings с предупреждениями, возникшими для обработанного документа.

Имя	Тип	Описание
code	WarningCodeValue	Код предупреждения.
message	string	Предупреждающее сообщение.
targetRef	string	Ссылка на указатель JSON, указывающая целевой объект.

EntitiesDocumentResult

Содержит результат задачи распознавания сущностей для документа.

Имя	Тип	Описание
entities	Entity[]	Распознанные сущности в документе.
id	string	Уникальный, непустой идентификатор документа.
statistics	DocumentStatistics	Если в запросе указан параметр showStats=true, это поле будет содержать сведения о полезных данных документа.
warnings	DocumentWarning[]	Предупреждения, возникшие при обработке документа.

EntitiesResult

Содержит результат задачи распознавания сущностей.

Имя	Тип	Описание
documents	EntitiesDocumentResult[]	Ответ по документам
errors	DocumentError[]	Ошибки по идентификатору документа.
modelVersion	string	Это поле указывает, какая модель используется для оценки.
statistics	RequestStatistics	Если в запросе указан параметр showStats=true, это поле будет содержать сведения о полезных данных запроса.

EntitiesTaskParameters

Поддерживаемые параметры для задачи распознавания сущностей.

Имя	Тип	Значение по умолчанию	Описание
loggingOptOut	boolean	False	отказ от ведения журнала
modelVersion	string	latest	версия модели
stringIndexType	StringIndexType	TextElements_v8	(Необязательный) параметр для предоставления типа строкового индекса, используемого для интерпретации смещения строк. По умолчанию — TextElements (Graphemes).

EntitiesTaskResult

Содержит задачу сущности

Имя	Тип	Описание
kind	string: EntityRecognitionResults	Тип результата задачи.
results	EntitiesResult	Результаты распознавания сущностей.

Entity

Определяет объект обнаруженной сущности, содержащий категорию сущности, обнаруженный текст сущности и т. д.

Имя	Тип	Описание
category	string	Тип сущности.
confidenceScore	number	Оценка достоверности от 0 до 1 извлеченной сущности.
length	integer	Длина текста сущности. Использование различных значений stringIndexType может повлиять на возвращаемую длину.
offset	integer	Начальная позиция для текста сущности. Использование различных значений stringIndexType может повлиять на возвращаемое смещение.
subcategory	string	(Необязательно) Подтип сущности.
text	string	Текст сущности, отображаемый в запросе.

EntityLinkingResult

Результат связывания сущностей.

Имя	Тип	Описание
documents	LinkedEntitiesDocumentResult[]	Ответ по документам
errors	DocumentError[]	Ошибки по идентификатору документа.
modelVersion	string	Это поле указывает, какая модель используется для оценки.
statistics	RequestStatistics	Если в запросе указан параметр showStats=true, это поле будет содержать сведения о полезных данных запроса.

EntityLinkingTaskParameters

Поддерживаемые параметры для задачи связывания сущностей.

Имя	Тип	Значение по умолчанию	Описание
loggingOptOut	boolean	False	отказ от ведения журнала
modelVersion	string	latest	версия модели
stringIndexType	StringIndexType	TextElements_v8	Необязательный параметр для указания типа строкового индекса, используемого для интерпретации смещений строк. По умолчанию — TextElements (Graphemes).

EntityLinkingTaskResult

Содержит результат задачи анализа текста Связывание сущностей.

Имя	Тип	Описание
kind	string: EntityLinkingResults	Тип результата задачи.
results	EntityLinkingResult	Результат связывания сущностей.

Error

Объект ответа об ошибке, возвращаемый при обнаружении службой некоторых ошибок во время обработки запроса.

Имя	Тип	Описание
code	ErrorCode	Один из определяемого сервером набора кодов ошибок.
details	Error[]	Массив сведений о конкретных ошибках, которые привели к этой сообщаемой ошибке.
innererror	InnerErrorModel	Объект, содержащий более конкретные сведения об ошибке, чем текущий объект.
message	string	Удобочитаемое представление ошибки.
target	string	Цель ошибки.

ErrorCode

Код ошибки, доступный для чтения человеком.

Имя	Тип	Описание
AzureCognitiveSearchIndexLimitReached	string	ошибка Когнитивный поиск Azure предела индекса
AzureCognitiveSearchIndexNotFound	string	Когнитивный поиск Azure ошибка "Индекс не найден"
AzureCognitiveSearchNotFound	string	Ошибка Когнитивный поиск Azure не найдена
AzureCognitiveSearchThrottling	string	ошибка регулирования Когнитивный поиск Azure
Conflict	string	конфликт
Forbidden	string	Ошибка запрещенного доступа
InternalServerError	string	Внутренняя ошибка сервера
InvalidArgument	string	Ошибка недопустимого аргумента
InvalidRequest	string	Ошибка недопустимого запроса
NotFound	string	Ошибка "Не найдено"
OperationNotFound	string	Ошибка "Операция не найдена"
ProjectNotFound	string	Ошибка "Проект не найден"
QuotaExceeded	string	Ошибка превышения квоты
ServiceUnavailable	string	Ошибка недоступности службы
Timeout	string	Ошибка времени ожидания
TooManyRequests	string	Ошибка "Слишком много запросов"
Unauthorized	string	Ошибка несанкционированного доступа
Warning	string	Предупреждение об ошибке

ErrorResponse

Ответ об ошибке.

Имя	Тип	Описание
error	Error	Объект error.

InnerErrorCode

Код ошибки, доступный для чтения человеком.

Имя	Тип	Описание
AzureCognitiveSearchNotFound	string	Ошибка Когнитивный поиск Azure не найдена
AzureCognitiveSearchThrottling	string	ошибка регулирования Когнитивный поиск Azure
EmptyRequest	string	Ошибка пустого запроса
ExtractionFailure	string	Ошибка при сбое извлечения
InvalidCountryHint	string	Ошибка недопустимого указания страны
InvalidDocument	string	Ошибка недопустимого документа
InvalidDocumentBatch	string	Ошибка пакета недопустимого документа
InvalidParameterValue	string	Ошибка недопустимого значения параметра
InvalidRequest	string	Ошибка недопустимого запроса
InvalidRequestBodyFormat	string	Ошибка недопустимого формата текста запроса
KnowledgeBaseNotFound	string	Ошибка базы знаний не найдена
MissingInputDocuments	string	Ошибка отсутствия входных документов
ModelVersionIncorrect	string	Ошибка "Неправильная версия модели"
UnsupportedLanguageCode	string	Ошибка неподдерживаемого кода языка

InnerErrorModel

Объект , содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по API Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Имя	Тип	Описание
code	InnerErrorCode	Один из определяемого сервером набора кодов ошибок.
details	object	Сведения об ошибке.
innererror	InnerErrorModel	Объект, содержащий более конкретные сведения об ошибке, чем текущий объект.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

KeyPhraseResult

Содержит KeyPhraseResult.

Имя	Тип	Описание
documents	KeyPhrasesDocumentResult[]	Ответ по документам
errors	DocumentError[]	Ошибки по идентификатору документа.
modelVersion	string	Это поле указывает, какая модель используется для оценки.
statistics	RequestStatistics	Если в запросе указан параметр showStats=true, это поле будет содержать сведения о полезных данных запроса.

KeyPhrasesDocumentResult

Содержит результаты извлечения ключевых фраз для документа.

Имя	Тип	Описание
id	string	Уникальный, непустой идентификатор документа.
keyPhrases	string[]	Список репрезентативных слов или фраз. Количество возвращаемых ключевых фраз пропорционально количеству слов во входном документе.
statistics	DocumentStatistics	Если в запросе указан параметр showStats=true, это поле будет содержать сведения о полезных данных документа.
warnings	DocumentWarning[]	Предупреждения, возникшие при обработке документа.

KeyPhraseTaskParameters

Поддерживаемые параметры для задачи извлечения ключевых фраз.

Имя	Тип	Значение по умолчанию	Описание
loggingOptOut	boolean	False	отказ от ведения журнала
modelVersion	string	latest	версия модели

KeyPhraseTaskResult

Содержит результат задачи анализа текста KeyPhraseExtraction.

Имя	Тип	Описание
kind	string: KeyPhraseExtractionResults	Тип результата задачи.
results	KeyPhraseResult	Список результатов извлечения ключевых фраз

LanguageDetectionAnalysisInput

Содержит входные данные анализа документа определения языка.

Имя	Тип	Описание
documents	LanguageInput[]	Список документов для анализа.

LanguageDetectionDocumentResult

Содержит определение языка для документа.

Имя	Тип	Описание
detectedLanguage	DetectedLanguage	Обнаруженный язык.
id	string	Уникальный, непустой идентификатор документа.
statistics	DocumentStatistics	Если в запросе указан параметр showStats=true, это поле будет содержать сведения о полезных данных документа.
warnings	DocumentWarning[]	Предупреждения, возникшие при обработке документа.

LanguageDetectionResult

Содержит результат определения языка для запроса.

Имя	Тип	Описание
documents	LanguageDetectionDocumentResult[]	Перечисление результатов определения языка для каждого входного документа.
errors	DocumentError[]	Ошибки по идентификатору документа.
modelVersion	string	Это поле указывает, какая модель используется для оценки.
statistics	RequestStatistics	Если в запросе указан параметр showStats=true, это поле будет содержать сведения о полезных данных запроса.

LanguageDetectionTaskParameters

Поддерживаемые параметры для задачи распознавания языка.

Имя	Тип	Значение по умолчанию	Описание
loggingOptOut	boolean	False	отказ от ведения журнала
modelVersion	string	latest	версия модели

LanguageDetectionTaskResult

Содержит результат задачи распознавания языка для запроса.

Имя	Тип	Описание
kind	string: LanguageDetectionResults	Тип результата задачи.
results	LanguageDetectionResult	Содержит результаты определения языка.

LanguageInput

Содержит входные данные обнаружения языка.

Имя	Тип	Описание
countryHint	string	Указание страны, чтобы помочь с определением языка текста.
id	string	Уникальный, непустой идентификатор документа.
text	string	Обрабатываемый входной текст.

LinkedEntitiesDocumentResult

Результат связывания сущностей.

Имя	Тип	Описание
entities	LinkedEntity[]	Распознаны известные сущности в документе.
id	string	Уникальный, непустой идентификатор документа.
statistics	DocumentStatistics	Если в запросе указан параметр showStats=true, это поле будет содержать сведения о полезных данных документа.
warnings	DocumentWarning[]	Предупреждения, возникшие при обработке документа.

LinkedEntity

Объект LinkedEntity, содержащий обнаруженную сущность со связанными источниками или ссылками.

Имя	Тип	Описание
bingId	string	Сущность Bing Поиск уникальный идентификатор API распознанной сущности.
dataSource	string	Источник данных, используемый для извлечения связывания сущностей, например Wiki/Bing и т. д.
id	string	Уникальный идентификатор распознанной сущности из источника данных.
language	string	Язык, используемый в источнике данных.
matches	Match[]	Список экземпляров, которые эта сущность отображается в тексте.
name	string	Формальное имя связывания сущностей.
url	string	URL-адрес страницы сущности из источника данных.

Match

Объект Match, содержащий текст обнаруженной сущности со смещением и длиной.

Имя	Тип	Описание
confidenceScore	number	Если распознается хорошо известный элемент, возвращается десятичное число, обозначающее уровень достоверности от 0 до 1.
length	integer	Длина текста соответствия сущности.
offset	integer	Начальная позиция для текста соответствия сущности.
text	string	Текст сущности, отображаемый в запросе.

MultiLanguageAnalysisInput

Коллекция входных документов, которые будут проанализированы службой.

Имя	Тип	Описание
documents	MultiLanguageInput[]	Входные документы для анализа.

MultiLanguageInput

Содержит входной документ для анализа службой.

Имя	Тип	Описание
id	string	Уникальный непустой идентификатор документа.
language	string	(Необязательно) Это 2-буквное представление языка в формате ISO 639-1. Например, используйте "en" для английского языка; "es" для испанского и т. д. Если значение не задано, используйте "en" для английского языка по умолчанию. (Следующее относится только к версии 2023-04-15-preview и выше) Для автоматического определения языка используйте "auto". Если значение не задано, используйте "en" для английского языка по умолчанию.
text	string	Обрабатываемый входной текст.

PiiCategory

(Необязательно) описывает возвращаемые категории личных сведений.

Имя	Тип	Описание
ABARoutingNumber	string	Номер маршрутизации ABA
ARNationalIdentityNumber	string	Национальный идентификационный номер AR
ATIdentityCard	string	Карточка удостоверения AT
ATTaxIdentificationNumber	string	Идентификационный номер налогоплательщика AT
ATValueAddedTaxNumber	string	Номер налога на добавленную стоимость AT
AUBankAccountNumber	string	Карточка удостоверения AT
AUBusinessNumber	string	Рабочий номер AU
AUCompanyNumber	string	AU Company Number
AUDriversLicenseNumber	string	Номер водительского удостоверения AU
AUMedicalAccountNumber	string	Номер медицинского счета AU
AUPassportNumber	string	AU Passport Number
AUTaxFileNumber	string	Номер налогового файла AU
Address	string	Адрес
Age	string	возраст;
All	string	Все категории персональных данных.
AzureDocumentDBAuthKey	string	Ключ проверки подлинности Azure Document DB
AzureIAASDatabaseConnectionAndSQLString	string	Подключение к базе данных Azure IAAS и строка SQL
AzureIoTConnectionString	string	строка подключения Azure IoT;
AzurePublishSettingPassword	string	пароль для публикации Azure;
AzureRedisCacheString	string	Строка кэша Redis для Azure
AzureSAS	string	Azure SAS;
AzureServiceBusString	string	Строка Служебная шина Azure
AzureStorageAccountGeneric	string	Универсальная учетная запись хранения Azure
AzureStorageAccountKey	string	Ключ учетной записи хранения Azure
BENationalNumber	string	Национальный номер BE
BENationalNumberV2	string	BE National Number V2
BEValueAddedTaxNumber	string	BE: налоговый номер с добавленной стоимостью
BGUniformCivilNumber	string	Единый гражданский номер BG
BRCPFNumber	string	Номер CPF BR
BRLegalEntityNumber	string	Номер юридического лица BR
BRNationalIDRG	string	BR National ID RG
CABankAccountNumber	string	CA Bank Account Number
CADriversLicenseNumber	string	Номер водительского удостоверения CA
CAHealthServiceNumber	string	Номер службы работоспособности ЦС
CAPassportNumber	string	Номер паспорта ЦС
CAPersonalHealthIdentification	string	CA Personal Health Identification
CASocialInsuranceNumber	string	CA Social Insurance Number
CHSocialSecurityNumber	string	Номер социального страхования CH
CLIdentityCardNumber	string	CL Identity Card Number
CNResidentIdentityCardNumber	string	Номер удостоверения резидента CN
CYIdentityCard	string	Карточка удостоверения CY
CYTaxIdentificationNumber	string	Идентификационный номер налогоплательщика CY
CZPersonalIdentityNumber	string	Личный идентификационный номер CZ
CZPersonalIdentityV2	string	Личное удостоверение CZ версии 2
CreditCardNumber	string	Номер кредитной карты
DEDriversLicenseNumber	string	Номер водительского удостоверения DE
DEIdentityCardNumber	string	DE Identity Card Number
DEPassportNumber	string	Номер паспорта DE
DETaxIdentificationNumber	string	Идентификационный номер налогоплательщика DE
DEValueAddedNumber	string	Номер добавленной стоимости de
DKPersonalIdentificationNumber	string	Личный идентификационный номер DK
DKPersonalIdentificationV2	string	Идентификация личности DK версии 2
Date	string	Дата
Default	string	Категории личных сведений по умолчанию для языка.
DrugEnforcementAgencyNumber	string	Номер агентства по борьбе с наркотиками
EEPersonalIdentificationCode	string	Личный идентификационный код EE
ESDNI	string	ES DNI
ESSocialSecurityNumber	string	Номер социального страхования ES
ESTaxIdentificationNumber	string	Идентификационный номер налогоплательщика ES
EUDebitCardNumber	string	Номер дебетовой карты ЕС
EUDriversLicenseNumber	string	Номер водительского удостоверения в ЕС
EUGPSCoordinates	string	GPS-координаты в ЕС.
EUNationalIdentificationNumber	string	Национальный идентификационный номер ЕС
EUPassportNumber	string	Номер паспорта ЕС
EUSocialSecurityNumber	string	Номер социального страхования ЕС
EUTaxIdentificationNumber	string	Идентификационный номер налогоплательщика в ЕС
Email	string	электронная почта;
FIEuropeanHealthNumber	string	FI European Health Number
FINationalID	string	Национальный идентификатор FI
FINationalIDV2	string	Национальный идентификатор FI V2
FIPassportNumber	string	Номер паспорта FI
FRDriversLicenseNumber	string	Номер водительского удостоверения FR
FRHealthInsuranceNumber	string	Номер медицинского страхования FR
FRNationalID	string	Национальный идентификатор FR
FRPassportNumber	string	Номер паспорта FR
FRSocialSecurityNumber	string	Номер социального страхования FR
FRTaxIdentificationNumber	string	Идентификационный номер налогоплательщика FR
FRValueAddedTaxNumber	string	Номер налога на добавленную стоимость FR
GRNationalIDCard	string	Национальный идентификатор GR
GRNationalIDV2	string	Национальный идентификатор GR V2
GRTaxIdentificationNumber	string	Идентификационный номер налогоплательщика GR
HKIdentityCardNumber	string	Номер удостоверения личности HK
HRIdentityCardNumber	string	Номер удостоверения персонала
HRNationalIDNumber	string	Национальный идентификационный номер отдела кадров
HRPersonalIdentificationNumber	string	Личный идентификационный номер отдела кадров
HRPersonalIdentificationOIBNumberV2	string	Личный идентификационный номер OIB отдела кадров V2
HUPersonalIdentificationNumber	string	Личный идентификационный номер HU
HUTaxIdentificationNumber	string	Идентификационный номер налогоплательщика HU
HUValueAddedNumber	string	Число добавленных значений HU
IDIdentityCardNumber	string	Идентификационный номер удостоверения личности
IEPersonalPublicServiceNumber	string	Личный номер государственной службы IE
IEPersonalPublicServiceNumberV2	string	IE Personal Public Service Number V2
ILBankAccountNumber	string	Номер банковского счета IL
ILNationalID	string	Национальный идентификатор IL
INPermanentAccount	string	В постоянной учетной записи
INUniqueIdentificationNumber	string	IN Уникальный идентификационный номер
IPAddress	string	IP-адрес
ITDriversLicenseNumber	string	Номер водительского удостоверения ИТ-специалистов
ITFiscalCode	string	Финансовый код ИТ-специалистов
ITValueAddedTaxNumber	string	Номер налога на добавленную стоимость ИТ
InternationalBankingAccountNumber	string	Номер международного банковского счета
JPBankAccountNumber	string	Номер банковского счета JP
JPDriversLicenseNumber	string	Номер водительского удостоверения JP
JPMyNumberCorporate	string	JP My Number Corporate
JPMyNumberPersonal	string	JP My Number Personal
JPPassportNumber	string	Номер паспорта JP
JPResidenceCardNumber	string	Номер карты резидента JP
JPResidentRegistrationNumber	string	Регистрационный номер резидента JP
JPSocialInsuranceNumber	string	Номер социального страхования JP
KRResidentRegistrationNumber	string	Регистрационный номер резидента KR
LTPersonalCode	string	Личный код LT
LUNationalIdentificationNumberNatural	string	LU National Identification Number Natural
LUNationalIdentificationNumberNonNatural	string	LU National Identification Number Non Natural
LVPersonalCode	string	Личный код LV
MTIdentityCardNumber	string	Номер идентификационной карты MT
MTTaxIDNumber	string	Номер налогоплательщика MT
MYIdentityCardNumber	string	Номер моей идентификационной карты
NLCitizensServiceNumber	string	NL Citizens Service Number
NLCitizensServiceNumberV2	string	NL Citizens Service Number V2
NLTaxIdentificationNumber	string	Идентификационный номер налогоплательщика NL
NLValueAddedTaxNumber	string	Номер налога на добавленную стоимость NL
NOIdentityNumber	string	NO Identity Number
NZBankAccountNumber	string	Номер банковского счета новой зеландии
NZDriversLicenseNumber	string	Номер водительского удостоверения новой зеландии
NZInlandRevenueNumber	string	Номер дохода от внутренних операций в новой зеландии
NZMinistryOfHealthNumber	string	Номер Министерства здравоохранения Новой Зеландии
NZSocialWelfareNumber	string	Номер социального обеспечения новой зеландии
Organization	string	План
PHUnifiedMultiPurposeIDNumber	string	PH Unified Multi Purpose ID Number
PLIdentityCard	string	Карточка удостоверений PL
PLNationalID	string	Национальный идентификатор PL
PLNationalIDV2	string	PL National ID V2
PLPassportNumber	string	Номер паспорта PL
PLREGONNumber	string	PL REGON Number
PLTaxIdentificationNumber	string	Идентификационный номер налогоплательщика PL
PTCitizenCardNumber	string	Номер карточки гражданина PT
PTCitizenCardNumberV2	string	Номер карты гражданина PT V2
PTTaxIdentificationNumber	string	Идентификационный номер налогоплательщика PT
Person	string	Человек
PhoneNumber	string	номер телефона;
ROPersonalNumericalCode	string	Личный числовой код RO
RUPassportNumberDomestic	string	Номер паспорта ЕЗ для внутренних
RUPassportNumberInternational	string	RU Passport Number International
SANationalID	string	Национальный идентификатор SA
SENationalID	string	Национальный идентификатор SE
SENationalIDV2	string	SE National ID V2
SEPassportNumber	string	Номер паспорта SE
SETaxIdentificationNumber	string	Идентификационный номер налогоплательщика SE
SGNationalRegistrationIdentityCardNumber	string	SG National Registration Identity Card Number
SITaxIdentificationNumber	string	Идентификационный номер налогоплательщика SI
SIUniqueMasterCitizenNumber	string	Уникальный номер основного гражданина SI
SKPersonalNumber	string	Личный номер SK
SQLServerConnectionString	string	строка подключения SQL Server;
SWIFTCode	string	Код SWIFT
THPopulationIdentificationCode	string	Код идентификации населения TH
TRNationalIdentificationNumber	string	Национальный идентификационный номер TR
TWNationalID	string	Национальный идентификатор TW
TWPassportNumber	string	Номер паспорта TW
TWResidentCertificate	string	Сертификат резидента TW
UAPassportNumberDomestic	string	UA Номер паспорта для внутренних
UAPassportNumberInternational	string	UA Passport Number International
UKDriversLicenseNumber	string	Номер водительского удостоверения в Великобритании
UKElectoralRollNumber	string	Номер электорального списка в Великобритании
UKNationalHealthNumber	string	Национальный номер здравоохранения Великобритании
UKNationalInsuranceNumber	string	Номер национального страхования Великобритании
UKUniqueTaxpayerNumber	string	Уникальный номер налогоплательщика в Великобритании
URL	string	URL-адрес
USBankAccountNumber	string	Номер банковского счета в США
USDriversLicenseNumber	string	Номер водительского удостоверения в США
USIndividualTaxpayerIdentification	string	Идентификация индивидуального налогоплательщика в США
USSocialSecurityNumber	string	Номер социального страхования США
USUKPassportNumber	string	Номер паспорта в США, Соединенное Королевство
ZAIdentificationNumber	string	Идентификационный номер ZA

PiiDomain

Домен для задачи личных сведений

Имя	Тип	Описание
none	string	Указывает, что домен не указан.
phi	string	Указывает, что сущности в домене личных сведений о работоспособности должны быть отредактированы.

PiiEntitiesDocumentResult

Содержит результаты личных сведений.

Имя	Тип	Описание
entities	Entity[]	Распознанные сущности в документе.
id	string	Уникальный, непустой идентификатор документа.
redactedText	string	Возвращает отредактированный текст.
statistics	DocumentStatistics	Если в запросе указан параметр showStats=true, это поле будет содержать сведения о полезных данных документа.
warnings	DocumentWarning[]	Предупреждения, возникшие при обработке документа.

PiiResult

Содержит PiiResult.

Имя	Тип	Описание
documents	PiiEntitiesDocumentResult[]	Ответ по документам
errors	DocumentError[]	Ошибки по идентификатору документа.
modelVersion	string	Это поле указывает, какая модель используется для оценки.
statistics	RequestStatistics	Если в запросе указан параметр showStats=true, это поле будет содержать сведения о полезных данных запроса.

PiiTaskParameters

Поддерживаемые параметры для задачи распознавания сущностей личных сведений.

Имя	Тип	Значение по умолчанию	Описание
domain	PiiDomain	none	Домен для задачи личных сведений
loggingOptOut	boolean	False	отказ от ведения журнала
modelVersion	string	latest	версия модели
piiCategories	PiiCategory[]		Перечисление категорий персональных данных, возвращаемых в ответе.
stringIndexType	StringIndexType	TextElements_v8	StringIndexType, используемый для анализа.

PiiTaskResult

Содержит задачу LRO анализа текста PIIEntityRecognition.

Имя	Тип	Описание
kind	string: PiiEntityRecognitionResults	Тип результата задачи.
results	PiiResult	Список результатов pii

RequestStatistics

Если в запросе указан параметр showStats=true, это поле будет содержать сведения о полезных данных запроса.

Имя	Тип	Описание
documentsCount	integer	Количество документов, отправленных в запросе.
erroneousDocumentsCount	integer	Количество недопустимых документов. Это относится к пустым документам, документам с превышением размера или не поддерживаемым языкам.
transactionsCount	integer	Количество транзакций для запроса.
validDocumentsCount	integer	Количество допустимых документов. Сюда не включаются пустые документы с превышением размера или не поддерживаемые документы на языках.

SentenceAssessment

Представляет оценку предложения и связанные с ней оценки или целевые объекты.

Имя	Тип	Описание
confidenceScores	TargetConfidenceScoreLabel	Представляет оценки достоверности для всех классов тональности: положительные и отрицательные.
isNegated	boolean	Индикатор, представляющий, является ли оценка отрицаемой.
length	integer	Длина целевого объекта.
offset	integer	Целевое смещение от начала предложения.
sentiment	TokenSentimentValue	Тональность предложения.
text	string	Обнаружен целевой текст.

SentenceSentiment

Тональность предложения документа.

Имя	Тип	Описание
assessments	SentenceAssessment[]	Массив оценок для предложения.
confidenceScores	SentimentConfidenceScores	Оценка достоверности тональности от 0 до 1 для предложения для всех классов.
length	integer	Длина целевого объекта.
offset	integer	Целевое смещение от начала предложения.
sentiment	SentenceSentimentValue	Прогнозируемая тональность для предложения.
targets	SentenceTarget[]	Массив целевых объектов предложений для предложения.
text	string	Текст предложения.

SentenceSentimentValue

Прогнозируемая тональность для предложения.

Имя	Тип	Описание
negative	string	Отрицательная тональность
neutral	string	Нейтральная тональность
positive	string	Положительная тональность

SentenceTarget

Представляет целевой объект предложения и связанные с ним оценки или целевые объекты.

Имя	Тип	Описание
confidenceScores	TargetConfidenceScoreLabel	Представляет оценки достоверности для всех классов тональности: положительные и отрицательные.
length	integer	Длина целевого объекта.
offset	integer	Целевое смещение от начала предложения.
relations	TargetRelation[]	Массив объектов оценки или целевых объектов, связанных с целевым объектом.
sentiment	TokenSentimentValue	Тональность предложения.
text	string	Обнаружен целевой текст.

SentimentAnalysisTaskParameters

Поддерживаемые параметры для задачи анализа тональности.

Имя	Тип	Значение по умолчанию	Описание
loggingOptOut	boolean	False	отказ от ведения журнала
modelVersion	string	latest	версия модели
opinionMining	boolean	False	Следует ли использовать интеллектуальный анализ мнений в запросе.
stringIndexType	StringIndexType	TextElements_v8	Задает метод, используемый для интерпретации смещений строк.

SentimentConfidenceScores

Представляет оценки достоверности от 0 до 1 для всех классов тональности: положительные, нейтральные, отрицательные.

Имя	Тип	Описание
negative	number	Оценка достоверности для отрицательной тональности
neutral	number	Оценка достоверности для нейтральной тональности
positive	number	Оценка достоверности для положительной тональности

SentimentDocumentResult

Объект , представляющий предварительно созданные результаты анализа тональности каждого документа.

Имя	Тип	Описание
confidenceScores	SentimentConfidenceScores	Оценка достоверности тональности от 0 до 1 для предложения для всех классов.
id	string	Уникальный, непустой идентификатор документа.
sentences	SentenceSentiment[]	Тональность предложений документа.
sentiment	DocumentSentimentValue	Прогнозируемая тональность для документа (отрицательная, нейтральная, положительная или смешанная).
statistics	DocumentStatistics	Если в запросе указан параметр showStats=true, это поле будет содержать сведения о полезных данных документа.
warnings	DocumentWarning[]	Предупреждения, возникшие при обработке документа.

SentimentResponse

Результаты анализа тональности для входных документов.

Имя	Тип	Описание
documents	SentimentDocumentResult[]	Результаты анализа тональности для каждого документа во входных данных.
errors	DocumentError[]	Ошибки по идентификатору документа.
modelVersion	string	Это поле указывает, какая модель используется для оценки.
statistics	RequestStatistics	Если в запросе указан параметр showStats=true, это поле будет содержать сведения о полезных данных запроса.

SentimentTaskResult

Содержит результат задачи LRO анализа текста SentimentAnalysis.

Имя	Тип	Описание
kind	string: SentimentAnalysisResults	Тип результата задачи.
results	SentimentResponse	Результаты анализа тональности

StringIndexType

Тип строкового индекса

Имя	Тип	Описание
TextElements_v8	string	Возвращаемые значения смещения и длины будут соответствовать TextElements (кластеры Graphemes и Grapheme), подтверждающие стандарт Юникода 8.0.0. Используйте этот параметр, если приложение написано на платформе .NET Framework или .Net Core и вы будете использовать StringInfo.
UnicodeCodePoint	string	Возвращаемые значения смещения и длины будут соответствовать кодовой точке Юникода. Используйте этот параметр, если приложение написано на языке, поддерживающем Юникод, например Python.
Utf16CodeUnit	string	Возвращаемые значения смещения и длины будут соответствовать единицам кода UTF-16. Используйте этот параметр, если приложение написано на языке, поддерживающем Юникод, например Java, JavaScript.

TargetConfidenceScoreLabel

Представляет оценки достоверности для всех классов тональности: положительные и отрицательные.

Имя	Тип	Описание
negative	number	Оценка достоверности для отрицательной тональности
positive	number	Оценка достоверности для положительной тональности

TargetRelation

Представляет связь между оценками и (или) целевыми объектами.

Имя	Тип	Описание
ref	string	Указатель JSON, указывающий связанный объект.
relationType	TargetRelationType	Тип, связанный с целевым объектом.

TargetRelationType

Тип, связанный с целевым объектом.

Имя	Тип	Описание
assessment	string
target	string

TokenSentimentValue

Прогнозируемая тональность для предложения.

Имя	Тип	Описание
mixed	string	Смешанная тональность
negative	string	Отрицательная тональность
positive	string	Положительная тональность

WarningCodeValue

Определяет список кодов предупреждений.

Имя	Тип	Описание
DocumentTruncated	string	Предупреждение об усечении документа
LongWordsInDocument	string	Предупреждение о длинных словах в документе