Text Operations - Analyze Text

Riferimento

Servizio:: Azure AI Services

Versione API:: 2024-09-01

Analizzare il testo
API sincrona per l'analisi del contenuto di testo potenzialmente dannoso. Attualmente supporta quattro categorie: Odio, SelfHarm, Sessuale e Violenza.

POST {endpoint}/contentsafety/text:analyze?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. È supportato un massimo di 10.000 caratteri Unicode (punti di codice Unicode) nel testo di una richiesta.
blocklistNames		string[]	Nomi di elenchi di elementi bloccati.
categories		TextCategory[]	Le categorie verranno analizzate. Se non sono assegnati, verrà restituito un set predefinito di risultati dell'analisi per le categorie.
haltOnBlocklistHit		boolean	Se impostato su true, non verranno eseguite ulteriori analisi del contenuto dannoso nei casi in cui vengono raggiunti gli elenchi di blocchi. Se impostato su false, verranno eseguite tutte le analisi del contenuto dannoso, indipendentemente dal fatto che vengano raggiunti o meno elenchi di blocchi.
outputType		AnalyzeTextOutputType	Questo si riferisce al tipo di output dell'analisi del testo. Se non viene assegnato alcun valore, il valore predefinito sarà "FourSeverityLevels".

Risposte

Nome	Tipo	Descrizione
200 OK	AnalyzeTextResult	La richiesta ha avuto esito positivo.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Risposta di errore imprevista. Intestazioni x-ms-error-code: string

Nome

Tipo

Descrizione

200 OK

AnalyzeTextResult

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

Analyze Text

Esempio di richiesta

HTTP

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

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

Risposta di esempio

Codice di stato:: 200

{
  "blocklistsMatch": [],
  "categoriesAnalysis": [
    {
      "category": "Hate",
      "severity": 0
    },
    {
      "category": "SelfHarm",
      "severity": 0
    },
    {
      "category": "Sexual",
      "severity": 0
    },
    {
      "category": "Violence",
      "severity": 0
    }
  ]
}

Definizioni

Nome	Descrizione
AnalyzeTextOptions	Richiesta di analisi del testo.
AnalyzeTextOutputType	Questo si riferisce al tipo di output dell'analisi del testo. Se non viene assegnato alcun valore, il valore predefinito sarà "FourSeverityLevels".
AnalyzeTextResult	Risposta di analisi del testo.
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.
TextBlocklistMatch	Risultato della corrispondenza dell'elenco di blocchi.
TextCategoriesAnalysis	Risultato dell'analisi del testo.
TextCategory	Categoria di danni supportata nell'analisi del contenuto del testo.

AnalyzeTextOptions

Richiesta di analisi del testo.

Nome	Tipo	Valore predefinito	Descrizione
blocklistNames	string[]		Nomi di elenchi di elementi bloccati.
categories	TextCategory[]		Le categorie verranno analizzate. Se non sono assegnati, verrà restituito un set predefinito di risultati dell'analisi per le categorie.
haltOnBlocklistHit	boolean		Se impostato su true, non verranno eseguite ulteriori analisi del contenuto dannoso nei casi in cui vengono raggiunti gli elenchi di blocchi. Se impostato su false, verranno eseguite tutte le analisi del contenuto dannoso, indipendentemente dal fatto che vengano raggiunti o meno elenchi di blocchi.
outputType	AnalyzeTextOutputType	FourSeverityLevels	Questo si riferisce al tipo di output dell'analisi del testo. Se non viene assegnato alcun valore, il valore predefinito sarà "FourSeverityLevels".
text	string		Testo da analizzare. È supportato un massimo di 10.000 caratteri Unicode (punti di codice Unicode) nel testo di una richiesta.

AnalyzeTextOutputType

Questo si riferisce al tipo di output dell'analisi del testo. Se non viene assegnato alcun valore, il valore predefinito sarà "FourSeverityLevels".

Nome	Tipo	Descrizione
EightSeverityLevels	string	Gravità di output in otto livelli, il valore potrebbe essere 0,1,2,3,4,5,6,7.
FourSeverityLevels	string	Gravità dell'output in quattro livelli, il valore potrebbe essere 0,2,4,6.

AnalyzeTextResult

Risposta di analisi del testo.

Nome	Tipo	Descrizione
blocklistsMatch	TextBlocklistMatch[]	Dettagli delle corrispondenze dell'elenco di blocchi.
categoriesAnalysis	TextCategoriesAnalysis[]	Risultato dell'analisi per le categorie.

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.

TextBlocklistMatch

Risultato della corrispondenza dell'elenco di blocchi.

Nome	Tipo	Descrizione
blocklistItemId	string	ID dell'elemento corrispondente.
blocklistItemText	string	Contenuto dell'elemento corrispondente.
blocklistName	string	Nome dell'elenco di elementi bloccati corrispondenti.

TextCategoriesAnalysis

Risultato dell'analisi del testo.

Nome	Tipo	Descrizione
category	TextCategory	Categoria di analisi del testo.
severity	integer	Il valore aumenta con la gravità del contenuto di input. Il valore di questo campo è determinato dal tipo di output specificato nella richiesta. Il tipo di output può essere "FourSeverityLevels" o "EightSeverity Levels" e il valore di output può essere 0, 2, 4, 6 o 0, 1, 2, 3, 4, 5, 6 o 7.

TextCategory

Categoria di danni supportata nell'analisi del contenuto del testo.

Nome	Tipo	Descrizione
Hate	string	Categoria di danni per Text - Hate.
SelfHarm	string	Categoria di danni per Text - SelfHarm.
Sexual	string	Categoria di danni per Text - Sessuale.
Violence	string	Categoria di danni per Text - Violenza.

Condividi tramite

Text Operations - Analyze Text

Parametri dell'URI

Corpo della richiesta

Risposte

Sicurezza

Ocp-Apim-Subscription-Key

OAuth2Auth

Ambiti

Esempio

Analyze Text

Esempio di richiesta

Risposta di esempio

Definizioni

AnalyzeTextOptions

AnalyzeTextOutputType

AnalyzeTextResult

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

TextBlocklistMatch

TextCategoriesAnalysis

TextCategory

Risorse aggiuntive