Text Operations - Detect Text Protected Material

Service:

Cognitive Services

API Version:

2024-02-15-preview

Beveiligd materiaal analyseren
Een synchrone API voor de analyse van beveiligd materiaal.

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

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 moet worden geanalyseerd. We ondersteunen maximaal 1.000 Unicode-tekens (Unicode-codepunten) in de tekst van één aanvraag.

Antwoorden

Name	Type	Description
200 OK	AnalyzeTextProtectedMaterialResult	De aanvraag is geslaagd.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Een onverwacht foutbericht. Headers x-ms-error-code: string

Beveiliging

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

Voorbeelden

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

Definities

Name	Description
AnalyzeTextProtectedMaterialOptions	De aanvraag voor een analyse van beveiligd materiaal.
AnalyzeTextProtectedMaterialResult	Het antwoord van de analyse van beveiligd materiaal.
Azure.Core.Foundations.Error	Het foutobject.
Azure.Core.Foundations.ErrorResponse	Een antwoord met foutdetails.
Azure.Core.Foundations.InnerError	Een object met specifiekere 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.
ProtectedMaterialAnalysisResult	Het antwoord van de met tekst beveiligde materiaalanalyse.

AnalyzeTextProtectedMaterialOptions

De aanvraag voor een analyse van beveiligd materiaal.

Name	Type	Description
text	string	De tekst moet worden geanalyseerd. We ondersteunen maximaal 1.000 Unicode-tekens (Unicode-codepunten) in de tekst van één aanvraag.

AnalyzeTextProtectedMaterialResult

Het antwoord van de analyse van beveiligd materiaal.

Name	Type	Description
protectedMaterialAnalysis	ProtectedMaterialAnalysisResult	Analyseresultaat voor beveiligd 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 tot deze gerapporteerde fout hebben geleid.
innererror	Azure.Core.Foundations.InnerError	Een object met specifiekere informatie dan het huidige object over de fout.
message	string	Een door mensen 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 specifiekere 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.

ProtectedMaterialAnalysisResult

Het antwoord van de met tekst beveiligde materiaalanalyse.

Name	Type	Description
detected	boolean	Analyseresultaat voor beveiligd materiaal..