Text Operations - Detect Text Protected Material

Service:

Cognitive Services

API Version:

2024-02-15-preview

Analýza chráněného materiálu
Synchronní rozhraní API pro analýzu chráněného materiálu.

POST {endpoint}/contentsafety/text:detectProtectedMaterial?api-version=2024-02-15-preview

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 je potřeba analyzovat. Podporujeme maximálně 1k znaků Unicode (body kódu Unicode) v textu jednoho požadavku.

Odpovědi

Name	Typ	Description
200 OK	AnalyzeTextProtectedMaterialResult	Žádost byla úspěšná.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Neočekávaná chybová odpověď. Headers x-ms-error-code: string

Zabezpečení

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

OAuth2Auth

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

Scopes

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

Příklady

Detect Protected Material

Sample Request

HTTP

POST {endpoint}/contentsafety/text:detectProtectedMaterial?api-version=2024-02-15-preview

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

Sample Response

Status code:

200

{
  "protectedMaterialAnalysis": {
    "detected": false
  }
}

Definice

Name	Description
AnalyzeTextProtectedMaterialOptions	Žádost o analýzu chráněného materiálu
AnalyzeTextProtectedMaterialResult	Odpověď analýzy chráněného materiálu
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í MICROSOFT One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ProtectedMaterialAnalysisResult	Odpověď na analýzu materiálu chráněného textem

AnalyzeTextProtectedMaterialOptions

Žádost o analýzu chráněného materiálu

Name	Typ	Description
text	string	Text je potřeba analyzovat. Podporujeme maximálně 1k znaků Unicode (body kódu Unicode) v textu jednoho požadavku.

AnalyzeTextProtectedMaterialResult

Odpověď analýzy chráněného materiálu

Name	Typ	Description
protectedMaterialAnalysis	ProtectedMaterialAnalysisResult	Výsledek analýzy chráněného materiálu

Azure.Core.Foundations.Error

Objekt chyby.

Name	Typ	Description
code	string	Jeden ze serverem definovaných chybových kódů.
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 o chybě než aktuální objekt.
message	string	Lidsky čitelná reprezentace chyby.
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í MICROSOFT One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Description
code	string	Jeden ze serverem definovaných chybových kódů.
innererror	Azure.Core.Foundations.InnerError	Vnitřní chyba.

ProtectedMaterialAnalysisResult

Odpověď na analýzu materiálu chráněného textem

Name	Typ	Description
detected	boolean	Výsledek analýzy chráněného materiálu.