Text Operations - Detect Text Protected Material

Service:

Azure AI Services

API-versie:

2024-09-01

Beveiligd materiaal voor tekst detecteren
Een synchrone API voor het detecteren van beveiligd materiaal in de opgegeven tekst.

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

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string	Ondersteunde Cognitive Services-eindpunten (protocol en hostnaam, bijvoorbeeld: https://.cognitiveservices.azure.com).
api-version	query	True	string	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name	Vereist	Type	Description
text	True	string	De tekst die moet worden geanalyseerd, die mogelijk beveiligd materiaal bevat. De tekens worden geteld in Unicode-codepunten.

Antwoorden

Name	Type	Description
200 OK	DetectTextProtectedMaterialResult	De aanvraag is voltooid.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Een onverwachte foutreactie. Kopteksten x-ms-error-code: string

Beveiliging

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

OAuth2Auth

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

Bereiken

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

Voorbeelden

Detect Protected Material for Text

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:

200

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

Definities

Name	Description
Azure.Core.Foundations.Error	Het foutobject.
Azure.Core.Foundations.ErrorResponse	Een antwoord met foutdetails.
Azure.Core.Foundations.InnerError	Een object met meer specifieke informatie over de fout. Volgens de richtlijnen voor Microsoft One-API- https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
DetectTextProtectedMaterialOptions	De aanvraag voor het detecteren van potentieel beveiligd materiaal dat aanwezig is in de opgegeven tekst.
DetectTextProtectedMaterialResult	De gecombineerde detectieresultaten van potentieel beschermd materiaal.
TextProtectedMaterialAnalysisResult	Het individuele detectieresultaat van potentieel beschermd materiaal.

Azure.Core.Foundations.Error

Het foutobject.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
details	Azure.Core.Foundations.Error[]	Een matrix met details over specifieke fouten die hebben geleid tot deze gemelde fout.
innererror	Azure.Core.Foundations.InnerError	Een object met meer specifieke informatie dan het huidige object over de fout.
message	string	Een leesbare weergave van de fout.
target	string	Het doel van de fout.

Azure.Core.Foundations.ErrorResponse

Een antwoord met foutdetails.

Name	Type	Description
error	Azure.Core.Foundations.Error	Het foutobject.

Azure.Core.Foundations.InnerError

Een object met meer specifieke informatie over de fout. Volgens de richtlijnen voor Microsoft One-API- https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
innererror	Azure.Core.Foundations.InnerError	Interne fout.

DetectTextProtectedMaterialOptions

De aanvraag voor het detecteren van potentieel beveiligd materiaal dat aanwezig is in de opgegeven tekst.

Name	Type	Description
text	string	De tekst die moet worden geanalyseerd, die mogelijk beveiligd materiaal bevat. De tekens worden geteld in Unicode-codepunten.

DetectTextProtectedMaterialResult

De gecombineerde detectieresultaten van potentieel beschermd materiaal.

Name	Type	Description
protectedMaterialAnalysis	TextProtectedMaterialAnalysisResult	Analyseresultaat voor de opgegeven tekst.

TextProtectedMaterialAnalysisResult

Het individuele detectieresultaat van potentieel beschermd materiaal.

Name	Type	Description
detected	boolean	Of mogelijk beveiligd materiaal wordt gedetecteerd of niet.