Text Operations - Detect Text Protected Material

Szolgáltatás:

Azure AI Services

API verzió:

2024-09-01

Védett anyag észlelése szöveghez
Szinkron API a védett anyagok észleléséhez az adott szövegben.

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

URI paraméterek

Név	Ban	Szükséges	Típus	Leírás
endpoint	path	True	string (uri)	Támogatott Cognitive Services-végpontok (protokoll és állomásnév, például: https://< resource-name.cognitiveservices.azure.com>).
api-version	query	True	string minLength: 1	A művelethez használni kívánt API-verzió.

Kérő Testület

Név	Szükséges	Típus	Leírás
text	True	string	Az elemezni kívánt szöveg, amely védett anyagot tartalmazhat. A karakterek Unicode-kódpontokban lesznek megszámolva.

Válaszok

Név	Típus	Leírás
200 OK	DetectTextProtectedMaterialResult	A kérés sikeres volt.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Váratlan hibaválasz. Fejlécek x-ms-error-code: string

Biztonság

Ocp-Apim-Subscription-Key

Típus: apiKey
Ban: header

OAuth2Auth

Típus: oauth2
Flow: application
Token URL: https://login.microsoftonline.com/common/oauth2/v2.0/token

Hatókörök

Név	Leírás
https://cognitiveservices.azure.com/.default

Példák

Detect Protected Material for Text

Mintakérés

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

Mintaválasz

Állapotkód:

200

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

Meghatározások

Név	Leírás
Azure.Core.Foundations.Error	A hibaobjektum.
Azure.Core.Foundations.ErrorResponse	Hibaadatokat tartalmazó válasz.
Azure.Core.Foundations.InnerError	Egy objektum, amely részletesebb információkat tartalmaz a hibáról. Az Azure REST API irányelvei szerint – https://aka.ms/AzureRestApiGuidelines#handling-errors.
DetectTextProtectedMaterialOptions	Az adott szövegben található potenciális védett anyag észlelésének kérése.
DetectTextProtectedMaterialResult	A potenciálisan védett anyag együttes észlelési eredményei.
TextProtectedMaterialAnalysisResult	A potenciálisan védett anyag egyedi észlelési eredménye.

Azure.Core.Foundations.Error

Tárgy

A hibaobjektum.

Név	Típus	Leírás
code	string	A kiszolgáló által definiált hibakódok egyike.
details	Azure.Core.Foundations.Error[]	A jelentett hibához vezető konkrét hibák részleteinek tömbje.
innererror	Azure.Core.Foundations.InnerError	Egy objektum, amely az aktuális objektumnál pontosabb információt tartalmaz a hibáról.
message	string	A hiba ember által olvasható ábrázolása.
target	string	A hiba célja.

Azure.Core.Foundations.ErrorResponse

Tárgy

Hibaadatokat tartalmazó válasz.

Név	Típus	Leírás
error	Azure.Core.Foundations.Error	A hibaobjektum.

Azure.Core.Foundations.InnerError

Tárgy

Egy objektum, amely részletesebb információkat tartalmaz a hibáról. Az Azure REST API irányelvei szerint – https://aka.ms/AzureRestApiGuidelines#handling-errors.

Név	Típus	Leírás
code	string	A kiszolgáló által definiált hibakódok egyike.
innererror	Azure.Core.Foundations.InnerError	Belső hiba.

DetectTextProtectedMaterialOptions

Tárgy

Az adott szövegben található potenciális védett anyag észlelésének kérése.

Név	Típus	Leírás
text	string	Az elemezni kívánt szöveg, amely védett anyagot tartalmazhat. A karakterek Unicode-kódpontokban lesznek megszámolva.

DetectTextProtectedMaterialResult

Tárgy

A potenciálisan védett anyag együttes észlelési eredményei.

Név	Típus	Leírás
protectedMaterialAnalysis	TextProtectedMaterialAnalysisResult	Az adott szöveg elemzési eredménye.

TextProtectedMaterialAnalysisResult

Tárgy

A potenciálisan védett anyag egyedi észlelési eredménye.

Név	Típus	Leírás
detected	boolean	A potenciális védett anyag észlelése vagy sem.