Text Operations - Analyze Text

Служба:: Azure AI Services

Версия API:: 2024-09-01

Анализ текста
Синхронный API для анализа потенциально вредного текстового содержимого. В настоящее время она поддерживает четыре категории: "Ненависть", "Самохарм", "Сексуальное" и "Насилие".

POST {endpoint}/contentsafety/text:analyze?api-version=2024-09-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string (uri)	Поддерживаемые конечные точки Cognitive Services (протокол и имя узла, например: https://< имя-ресурса.cognitiveservices.azure.com>).
api-version	query	True	string minLength: 1	Версия API, используемая для этой операции.

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

Имя	Обязательно	Тип	Описание
text	True	string maxLength: 10000	Текст, который необходимо проанализировать. Мы поддерживаем не более 10 тысяч символов Юникода (кодовые точки Юникода) в тексте одного запроса.
blocklistNames		string[]	Имена блок-списков.
categories		TextCategory[]	Категории будут проанализированы. Если они не назначены, возвращается набор результатов анализа по умолчанию для категорий.
haltOnBlocklistHit		boolean	Если задано значение true, дальнейший анализ вредного содержимого не будет выполняться в случаях, когда блок-списки попадают. Если задано значение false, все анализы вредного содержимого будут выполняться независимо от того, будут ли выполнены блок-списки.
outputType		AnalyzeTextOutputType	Это относится к типу выходных данных анализа текста. Если значение не назначено, значение по умолчанию будет иметь значение FourSeverityLevels.

Ответы

Имя	Тип	Описание
200 OK	AnalyzeTextResult	Запрос выполнен успешно.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Непредвиденное сообщение об ошибке. Заголовки x-ms-error-code: string

Имя

Тип

Описание

200 OK

AnalyzeTextResult

Запрос выполнен успешно.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Непредвиденное сообщение об ошибке.

Заголовки

x-ms-error-code: string

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

Ocp-Apim-Subscription-Key

Тип: apiKey
В: header

OAuth2Auth

Тип: oauth2
Flow: application
URL-адрес токена: https://login.microsoftonline.com/common/oauth2/v2.0/token

Области

Имя	Описание
https://cognitiveservices.azure.com/.default

Примеры

Analyze Text

Образец запроса

HTTP

POST {endpoint}/contentsafety/text:analyze?api-version=2024-09-01

{
  "text": "This is text example"
}

Пример ответа

Код состояния:: 200

{
  "blocklistsMatch": [],
  "categoriesAnalysis": [
    {
      "category": "Hate",
      "severity": 0
    },
    {
      "category": "SelfHarm",
      "severity": 0
    },
    {
      "category": "Sexual",
      "severity": 0
    },
    {
      "category": "Violence",
      "severity": 0
    }
  ]
}

Определения

Имя	Описание
AnalyzeTextOptions	Запрос на анализ текста.
AnalyzeTextOutputType	Это относится к типу выходных данных анализа текста. Если значение не назначено, значение по умолчанию будет иметь значение FourSeverityLevels.
AnalyzeTextResult	Ответ на анализ текста.
Azure.Core.Foundations.Error	Объект ошибки.
Azure.Core.Foundations.ErrorResponse	Ответ, содержащий сведения об ошибке.
Azure.Core.Foundations.InnerError	Объект, содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по Azure REST API — https://aka.ms/AzureRestApiGuidelines#handling-errors.
TextBlocklistMatch	Результат сопоставления блок-списка.
TextCategoriesAnalysis	Результат анализа текста.
TextCategory	Категория вреда, поддерживаемая в анализе содержимого текста.

AnalyzeTextOptions

Объект

Запрос на анализ текста.

Имя	Тип	Default value	Описание
blocklistNames	string[]		Имена блок-списков.
categories	TextCategory[]		Категории будут проанализированы. Если они не назначены, возвращается набор результатов анализа по умолчанию для категорий.
haltOnBlocklistHit	boolean		Если задано значение true, дальнейший анализ вредного содержимого не будет выполняться в случаях, когда блок-списки попадают. Если задано значение false, все анализы вредного содержимого будут выполняться независимо от того, будут ли выполнены блок-списки.
outputType	AnalyzeTextOutputType	FourSeverityLevels	Это относится к типу выходных данных анализа текста. Если значение не назначено, значение по умолчанию будет иметь значение FourSeverityLevels.
text	string maxLength: 10000		Текст, который необходимо проанализировать. Мы поддерживаем не более 10 тысяч символов Юникода (кодовые точки Юникода) в тексте одного запроса.

AnalyzeTextOutputType

Перечисление

Это относится к типу выходных данных анализа текста. Если значение не назначено, значение по умолчанию будет иметь значение FourSeverityLevels.

Значение	Описание
FourSeverityLevels	Уровень серьезности выходных данных в четырех уровнях может иметь значение 0,2 4,6.
EightSeverityLevels	Уровень серьезности выходных данных в восьми уровнях может иметь значение 0,1,2,3 4,5 6,7.

AnalyzeTextResult

Объект

Ответ на анализ текста.

Имя	Тип	Описание
blocklistsMatch	TextBlocklistMatch[]	Сведения о совпадении с блок-списком.
categoriesAnalysis	TextCategoriesAnalysis[]	Результат анализа для категорий.

Azure.Core.Foundations.Error

Объект

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

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

Azure.Core.Foundations.ErrorResponse

Объект

Ответ, содержащий сведения об ошибке.

Имя	Тип	Описание
error	Azure.Core.Foundations.Error	Объект ошибки.

Azure.Core.Foundations.InnerError

Объект

Объект, содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по Azure REST API — https://aka.ms/AzureRestApiGuidelines#handling-errors.

Имя	Тип	Описание
code	string	Один из определяемых сервером кодов ошибок.
innererror	Azure.Core.Foundations.InnerError	Внутренняя ошибка.

TextBlocklistMatch

Объект

Результат сопоставления блок-списка.

Имя	Тип	Описание
blocklistItemId	string maxLength: 64	Идентификатор соответствующего элемента.
blocklistItemText	string maxLength: 128	Содержимое соответствующего элемента.
blocklistName	string maxLength: 64	Имя соответствующего блок-списка.

TextCategoriesAnalysis

Объект

Результат анализа текста.

Имя	Тип	Описание
category	TextCategory	Категория анализа текста.
severity	integer (int32)	Значение увеличивается с серьезностью входного содержимого. Значение этого поля определяется типом выходных данных, указанным в запросе. Тип выходных данных может быть "FourSeverityLevels" или "ВосемьSeverity Levels", а выходное значение может быть равно 0, 2, 4, 6 или 0, 1, 2, 3, 4, 5, 6 или 7.

TextCategory

Перечисление

Категория вреда, поддерживаемая в анализе содержимого текста.

Значение	Описание
Hate	Категория вреда для текста - ненависть.
SelfHarm	Категория вреда для текста — SelfHarm.
Sexual	Категория вреда для текста - сексуальный.
Violence	Категория вреда для текста - насилие.