Image Operations - Analyze Image
Analizzare l'immagine
API sincrona per l'analisi del contenuto di immagini potenzialmente dannose. Attualmente supporta quattro categorie: Odio, SelfHarm, Sessuale e Violenza.
POST {endpoint}/contentsafety/image: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 |
---|---|---|---|
image | True |
Immagine da analizzare. |
|
categories |
Le categorie verranno analizzate. Se non sono assegnati, verrà restituito un set predefinito di risultati dell'analisi per le categorie. |
||
outputType |
Questo si riferisce al tipo di output dell'analisi delle immagini. Se non viene assegnato alcun valore, il valore predefinito sarà "FourSeverityLevels". |
Risposte
Nome | Tipo | Descrizione |
---|---|---|
200 OK |
La richiesta ha avuto esito positivo. |
|
Other Status Codes |
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 Image
Esempio di richiesta
POST {endpoint}/contentsafety/image:analyze?api-version=2024-09-01
{
"image": {
"content": "Y29udGVudDE="
}
}
Risposta di esempio
{
"categoriesAnalysis": [
{
"category": "Hate",
"severity": 0
},
{
"category": "SelfHarm",
"severity": 0
},
{
"category": "Sexual",
"severity": 0
},
{
"category": "Violence",
"severity": 2
}
]
}
Definizioni
Nome | Descrizione |
---|---|
Analyze |
Richiesta di analisi delle immagini. |
Analyze |
Questo si riferisce al tipo di output dell'analisi delle immagini. Se non viene assegnato alcun valore, il valore predefinito sarà "FourSeverityLevels". |
Analyze |
Risposta di analisi delle immagini. |
Azure. |
Oggetto error. |
Azure. |
Risposta contenente i dettagli dell'errore. |
Azure. |
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. |
Image |
Risultato dell'analisi delle immagini. |
Image |
Categoria di danni supportata nell'analisi del contenuto delle immagini. |
Image |
L'immagine può essere in byte codificati in base64 o in un URL del BLOB. È possibile scegliere solo una di queste opzioni. Se vengono forniti entrambi, la richiesta verrà rifiutata. La dimensione massima dell'immagine è 2048 x 2048 pixel e non deve superare i 4 MB, mentre la dimensione minima dell'immagine è 50 x 50 pixel. |
AnalyzeImageOptions
Richiesta di analisi delle immagini.
Nome | Tipo | Valore predefinito | Descrizione |
---|---|---|---|
categories |
Le categorie verranno analizzate. Se non sono assegnati, verrà restituito un set predefinito di risultati dell'analisi per le categorie. |
||
image |
Immagine da analizzare. |
||
outputType | FourSeverityLevels |
Questo si riferisce al tipo di output dell'analisi delle immagini. Se non viene assegnato alcun valore, il valore predefinito sarà "FourSeverityLevels". |
AnalyzeImageOutputType
Questo si riferisce al tipo di output dell'analisi delle immagini. Se non viene assegnato alcun valore, il valore predefinito sarà "FourSeverityLevels".
Nome | Tipo | Descrizione |
---|---|---|
FourSeverityLevels |
string |
Gravità dell'output in quattro livelli, il valore potrebbe essere 0,2,4,6. |
AnalyzeImageResult
Risposta di analisi delle immagini.
Nome | Tipo | Descrizione |
---|---|---|
categoriesAnalysis |
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 |
Matrice di dettagli sugli errori specifici che hanno causato l'errore segnalato. |
|
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 |
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 |
Errore interno. |
ImageCategoriesAnalysis
Risultato dell'analisi delle immagini.
Nome | Tipo | Descrizione |
---|---|---|
category |
Categoria di analisi delle immagini. |
|
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" e il valore di output può essere 0, 2, 4, 6. |
ImageCategory
Categoria di danni supportata nell'analisi del contenuto delle immagini.
Nome | Tipo | Descrizione |
---|---|---|
Hate |
string |
Categoria di danni per Image - Hate. |
SelfHarm |
string |
Categoria di danni per Image - SelfHarm. |
Sexual |
string |
Categoria di danni per Image - Sessuale. |
Violence |
string |
Categoria di danni per Image - Violenza. |
ImageData
L'immagine può essere in byte codificati in base64 o in un URL del BLOB. È possibile scegliere solo una di queste opzioni. Se vengono forniti entrambi, la richiesta verrà rifiutata. La dimensione massima dell'immagine è 2048 x 2048 pixel e non deve superare i 4 MB, mentre la dimensione minima dell'immagine è 50 x 50 pixel.
Nome | Tipo | Descrizione |
---|---|---|
blobUrl |
string |
URL del BLOB dell'immagine. |
content |
string |
Codifica Base64 dell'immagine. |