Поделиться через

Text Operations - Detect Text Protected Material

  • Ссылка
Служба:
Azure AI Services
Версия API:
2024-09-01

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

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

Параметры URI

Имя В Обязательно Тип Описание
endpoint
 path True

string

Поддерживаемые конечные точки Cognitive Services (протокол и имя узла, например https://.cognitiveservices.azure.com).
api-version
 query True

string

Версия API, используемая для этой операции.

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

Имя Обязательно Тип Описание
text True

string

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

Ответы

Имя Тип Описание
200 OK

DetectTextProtectedMaterialResult

Запрос выполнен успешно.
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

Примеры

Detect Protected Material for Text

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

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

{
  "text": "to everyone, the best things in life are free. the stars belong to everyone, they gleam there for you and me. the flowers in spring, the robins that sing, the sunbeams that shine"
}

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

Код состояния:
200 
{
  "protectedMaterialAnalysis": {
    "detected": true
  }
}

Определения

Имя Описание
Azure.Core.Foundations.Error

Объект ошибки.
Azure.Core.Foundations.ErrorResponse

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

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

Запрос на обнаружение потенциально защищенного материала, присутствующих в данном тексте.
DetectTextProtectedMaterialResult

Объединенные результаты обнаружения потенциально защищенного материала.
TextProtectedMaterialAnalysisResult

Результат отдельного обнаружения потенциально защищенного материала.

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

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

Имя Тип Описание
code

string

Один из определяемых сервером кодов ошибок.
innererror

Azure.Core.Foundations.InnerError

Внутренняя ошибка.

DetectTextProtectedMaterialOptions

Запрос на обнаружение потенциально защищенного материала, присутствующих в данном тексте.

Имя Тип Описание
text

string

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

DetectTextProtectedMaterialResult

Объединенные результаты обнаружения потенциально защищенного материала.

Имя Тип Описание
protectedMaterialAnalysis

TextProtectedMaterialAnalysisResult

Результат анализа для заданного текста.

TextProtectedMaterialAnalysisResult

Результат отдельного обнаружения потенциально защищенного материала.

Имя Тип Описание
detected

boolean

Обнаруживается ли потенциальный защищенный материал.