Text Operations - Detect Text Protected Material

Služba:

Azure AI Services

Verze rozhraní API:

2024-09-01

Detekce chráněného materiálu pro text
Synchronní rozhraní API pro detekci chráněného materiálu v daném textu

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string	Podporované koncové body služeb Cognitive Services (protokol a název hostitele, například: https://.cognitiveservices.azure.com).
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Vyžadováno	Typ	Description
text	True	string	Text, který se má analyzovat, který může obsahovat chráněný materiál. Znaky se počítají v bodech kódu Unicode.

Odpovědi

Name	Typ	Description
200 OK	DetectTextProtectedMaterialResult	Požadavek byl úspěšný.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Neočekávaná chybová odpověď Hlavičky x-ms-error-code: string

Zabezpečení

Ocp-Apim-Subscription-Key

Typ: apiKey
V: header

OAuth2Auth

Typ: oauth2
Tok: application
URL tokenu: https://login.microsoftonline.com/common/oauth2/v2.0/token

Rozsahy

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

Příklady

Detect Protected Material for Text

Ukázkový požadavek

HTTP

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"
}

Ukázková odpověď

Stavový kód:

200

{
  "protectedMaterialAnalysis": {
    "detected": true
  }
}

Definice

Name	Description
Azure.Core.Foundations.Error	Objekt chyby.
Azure.Core.Foundations.ErrorResponse	Odpověď obsahující podrobnosti o chybě.
Azure.Core.Foundations.InnerError	Objekt obsahující konkrétnější informace o chybě. Podle pokynů k rozhraní API Microsoft One – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
DetectTextProtectedMaterialOptions	Požadavek na zjištění potenciálního chráněného materiálu, který je v daném textu.
DetectTextProtectedMaterialResult	Kombinované výsledky detekce potenciálního chráněného materiálu.
TextProtectedMaterialAnalysisResult	Výsledek individuální detekce potenciálního chráněného materiálu.

Azure.Core.Foundations.Error

Objekt chyby.

Name	Typ	Description
code	string	Jedna ze serverově definovaných kódů chyb.
details	Azure.Core.Foundations.Error[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
innererror	Azure.Core.Foundations.InnerError	Objekt obsahující konkrétnější informace, než je aktuální objekt o chybě.
message	string	Čitelné znázornění chyby člověkem.
target	string	Cíl chyby.

Azure.Core.Foundations.ErrorResponse

Odpověď obsahující podrobnosti o chybě.

Name	Typ	Description
error	Azure.Core.Foundations.Error	Objekt chyby.

Azure.Core.Foundations.InnerError

Objekt obsahující konkrétnější informace o chybě. Podle pokynů k rozhraní API Microsoft One – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Description
code	string	Jedna ze serverově definovaných kódů chyb.
innererror	Azure.Core.Foundations.InnerError	Vnitřní chyba.

DetectTextProtectedMaterialOptions

Požadavek na zjištění potenciálního chráněného materiálu, který je v daném textu.

Name	Typ	Description
text	string	Text, který se má analyzovat, který může obsahovat chráněný materiál. Znaky se počítají v bodech kódu Unicode.

DetectTextProtectedMaterialResult

Kombinované výsledky detekce potenciálního chráněného materiálu.

Name	Typ	Description
protectedMaterialAnalysis	TextProtectedMaterialAnalysisResult	Výsledek analýzy pro daný text

TextProtectedMaterialAnalysisResult

Výsledek individuální detekce potenciálního chráněného materiálu.

Name	Typ	Description
detected	boolean	Zda je zjištěn potenciální chráněný materiál, nebo ne.