Condividi tramite

Text Operations - Detect Text Protected Material

  • Riferimento
Servizio:
Azure AI Services
Versione API:
2024-09-01

Rilevare il materiale protetto per il testo
API sincrona per il rilevamento di materiale protetto nel testo specificato.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
endpoint
 path True

string

Endpoint di Servizi cognitivi supportati (protocollo e nome host, ad esempio: https://.cognitiveservices.azure.com).
api-version
 query True

string

Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome Necessario Tipo Descrizione
text True

string

Testo da analizzare, che può contenere materiale protetto. I caratteri verranno conteggiati nei punti di codice Unicode.

Risposte

Nome Tipo Descrizione
200 OK

DetectTextProtectedMaterialResult

La richiesta ha avuto esito positivo.
Other Status Codes

Azure.Core.Foundations.ErrorResponse

Risposta di errore imprevista.

Intestazioni

x-ms-error-code: string

Sicurezza

Ocp-Apim-Subscription-Key

Tipo: apiKey
In: header

OAuth2Auth

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

Ambiti

Nome Descrizione
https://cognitiveservices.azure.com/.default

Esempio

Detect Protected Material for Text

Esempio di richiesta

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

Risposta di esempio

Codice di stato:
200 
{
  "protectedMaterialAnalysis": {
    "detected": true
  }
}

Definizioni

Nome Descrizione
Azure.Core.Foundations.Error

Oggetto error.
Azure.Core.Foundations.ErrorResponse

Risposta contenente i dettagli dell'errore.
Azure.Core.Foundations.InnerError

Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'API Microsoft One , https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
DetectTextProtectedMaterialOptions

La richiesta di rilevare il potenziale materiale protetto presente nel testo specificato.
DetectTextProtectedMaterialResult

Risultati di rilevamento combinati di potenziali materiali protetti.
TextProtectedMaterialAnalysisResult

Risultato del rilevamento individuale di materiale protetto potenziale.

Azure.Core.Foundations.Error

Oggetto error.

Nome Tipo Descrizione
code

string

Uno di un set definito dal server di codici di errore.
details

Azure.Core.Foundations.Error[]

Matrice di dettagli sugli errori specifici che hanno causato l'errore segnalato.
innererror

Azure.Core.Foundations.InnerError

Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message

string

Rappresentazione leggibile dell'errore.
target

string

Destinazione dell'errore.

Azure.Core.Foundations.ErrorResponse

Risposta contenente i dettagli dell'errore.

Nome Tipo Descrizione
error

Azure.Core.Foundations.Error

Oggetto error.

Azure.Core.Foundations.InnerError

Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'API Microsoft One , https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nome Tipo Descrizione
code

string

Uno di un set definito dal server di codici di errore.
innererror

Azure.Core.Foundations.InnerError

Errore interno.

DetectTextProtectedMaterialOptions

La richiesta di rilevare il potenziale materiale protetto presente nel testo specificato.

Nome Tipo Descrizione
text

string

Testo da analizzare, che può contenere materiale protetto. I caratteri verranno conteggiati nei punti di codice Unicode.

DetectTextProtectedMaterialResult

Risultati di rilevamento combinati di potenziali materiali protetti.

Nome Tipo Descrizione
protectedMaterialAnalysis

TextProtectedMaterialAnalysisResult

Risultato dell'analisi per il testo specificato.

TextProtectedMaterialAnalysisResult

Risultato del rilevamento individuale di materiale protetto potenziale.

Nome Tipo Descrizione
detected

boolean

Indica se il materiale protetto potenziale viene rilevato o meno.