> ## Documentation Index
> Fetch the complete documentation index at: https://docs.identifai.net/llms.txt
> Use this file to discover all available pages before exploring further.

# Scarica una mappa XAI

> Scarica l'**Attention Map** o l'**Attention Graph** prodotto dallo scope [XAI – eXplainable AI](/it/classification/classify-image#xai-explainable-ai) per un modello, per un'immagine inviata con `with_xai=true` o per un frame di un video inviato con `with_xai=true` (usa l'`identifier` del frame in `results.images`).

Le mappe prodotte dipendono dal modello: le `explanations` dei risultati per modello elencano il `type` e il `method` di ogni mappa disponibile per il modello, anche quando le spiegazioni AI non sono state richieste. La heatmap della Smart Full Analysis non è una mappa XAI: scaricala con l'[endpoint della heatmap](./get-classification-heatmap).

**Nota:** questo endpoint è disponibile anche con l'alias `/api/classification_image/xai/{identifier}`.



## OpenAPI

````yaml it/api-reference/api-swagger-dev-documentation.json GET /api/classification/xai/{identifier}
openapi: 3.0.0
info:
  title: API di identifAI
  version: 1.0.0
  description: >-
    API per integrare le funzionalità di classificazione di immagini e video di
    identifAI.<br><details><summary>**Come ottenere la tua API
    key**</summary>Per ottenere la tua API key, segui questi semplici
    passaggi:   <ol><li><p>**Crea un profilo utente e accedi alla
    piattaforma**</p>Se non hai ancora un account, visita la nostra piattaforma
    e crea un profilo utente. Dopo aver completato la registrazione e verificato
    la tua e-mail, accedi con le tue credenziali.</li><li><p>**Apri il menu
    utente**</p>Dopo l'accesso, fai clic sul tuo nome o sull'icona utente in
    alto a destra nello schermo.</li><li><p>**Seleziona la voce API key**</p>Nel
    menu a tendina che compare, seleziona la voce "Api-Key". Da lì puoi
    visualizzare o generare la tua API key.</li></ol>Ora sei pronto per usare la
    tua API key con la nostra API!</details><details><summary>**Come usare
    l'API**</summary>Per usare l'API, effettua prima una richiesta **POST** per
    avviare la classificazione. Poi usa l'***identificativo*** restituito dalla
    richiesta **POST** per recuperare i risultati.

    <details>

    <summary>**1. Classificazione delle immagini**</summary>
      * Per classificare un'immagine, effettua una richiesta **POST** a `/api/classification` con i parametri richiesti (per i dettagli sui parametri consulta la sezione *"Classificazione"* qui sotto).
      * Nella risposta riceverai l'***identificativo*** dell'immagine classificata.
      * Usa l'***identificativo*** ricevuto per recuperare i risultati della classificazione con una richiesta **GET** a `/api/classification/{identifier}` (per i dettagli su come strutturare la richiesta consulta la sezione *"Classificazione"* qui sotto).
      * La risposta contiene i risultati della classificazione dell'immagine in formato JSON.<br>Nella risposta trovi un array ***results***, con i risultati della classificazione di ogni modello usato, e un array ***verdicts***, con i risultati di ogni euristica applicata.<br>Se la classificazione non è ancora completa, continua a inviare la richiesta **GET** finché il risultato non è disponibile.</details><details><summary>**2. Classificazione dei video**</summary>
        * Per classificare un video, effettua una richiesta **POST** a `/api/classification_video` con i parametri richiesti (per i dettagli sui parametri consulta la sezione *"Classificazione"* qui sotto).
        * Nella risposta riceverai l'***identificativo*** del video classificato.
        * Usa l'***identificativo*** ricevuto per recuperare i risultati della classificazione con una richiesta **GET** a `/api/classification_video/{identifier}` (per i dettagli su come strutturare la richiesta consulta la sezione *"Classificazione"* qui sotto).
        * La risposta contiene i risultati della classificazione del video in formato JSON. Per la classificazione, il video viene suddiviso in *frame*.<br> Nella risposta trovi un array ***results***, con l'esito della classificazione di ogni modello applicato a ogni frame analizzato, e un array ***verdicts***, con i risultati di ogni euristica usata.<br> Se la classificazione non è completa, continua a inviare la richiesta **GET** finché non vengono restituiti i risultati finali.</details><details><summary>**3. Tutte le classificazioni**</summary>L'endpoint `/api/classifications` restituisce tutte le classificazioni di immagini effettuate da un utente, con i risultati di tutte le richieste di classificazione di immagini passate.</details><details><summary>**4. Gestione degli utenti**</summary>  L'endpoint **POST** `/api/user` permette di creare un utente, mentre l'endpoint **DELETE** `/api/user` serve a eliminare un utente (per la struttura delle richieste consulta la sezione sugli utenti qui sotto).</details></details>
servers:
  - url: https://backend.identifai.net
security: []
tags:
  - name: Classification
    description: Route di classificazione
  - name: Infrastructure
    description: Route dell'infrastruttura
  - name: User
    description: Azioni dell'utente
  - name: Partner
    description: Azioni dei partner
paths:
  /api/classification/xai/{identifier}:
    get:
      tags:
        - Classification
      summary: Scarica una mappa XAI
      description: >-
        Scarica l'**Attention Map** o l'**Attention Graph** prodotto dallo scope
        [XAI – eXplainable
        AI](/it/classification/classify-image#xai-explainable-ai) per un
        modello, per un'immagine inviata con `with_xai=true` o per un frame di
        un video inviato con `with_xai=true` (usa l'`identifier` del frame in
        `results.images`).


        Le mappe prodotte dipendono dal modello: le `explanations` dei risultati
        per modello elencano il `type` e il `method` di ogni mappa disponibile
        per il modello, anche quando le spiegazioni AI non sono state richieste.
        La heatmap della Smart Full Analysis non è una mappa XAI: scaricala con
        l'[endpoint della heatmap](./get-classification-heatmap).


        **Nota:** questo endpoint è disponibile anche con l'alias
        `/api/classification_image/xai/{identifier}`.
      parameters:
        - name: identifier
          in: path
          required: true
          schema:
            type: string
          description: L'identificativo dell'immagine o del frame del video.
        - name: model
          in: query
          required: true
          schema:
            type: string
          description: >-
            Il nome del modello che ha prodotto la mappa, come riportato nel
            campo `model` dei risultati per modello (ad es. `Revelio`).
        - name: method
          in: query
          required: true
          schema:
            type: string
            enum:
              - legrad
              - transformer_attribution
              - attention_rollout
          description: Il metodo XAI usato per calcolare la mappa.
        - name: type
          in: query
          required: false
          schema:
            type: string
            enum:
              - attention_map
              - attention_graph
            default: attention_map
          description: >-
            La mappa da scaricare: `attention_map` (sovrapposta al contenuto
            originale) o `attention_graph` (andamento e picchi dell'attenzione
            del modello).
      responses:
        '200':
          description: La mappa XAI, come immagine.
          content:
            image/png:
              schema:
                type: string
                format: binary
        '400':
          description: '`model` o `method` mancante, oppure `type` non valido.'
          content:
            application/json:
              examples:
                missing_parameters:
                  summary: Parametri mancanti
                  value:
                    error: 'Missing required parameters: model, method'
                invalid_type:
                  summary: Tipo non valido
                  value:
                    error: >-
                      Invalid type parameter. Allowed values: attention_map,
                      attention_graph
        '401':
          description: API key non valida o mancante.
          content:
            application/json:
              example:
                error: Unauthorized
        '403':
          description: >-
            L'immagine o il frame non esiste oppure non sei autorizzato ad
            accedervi.
          content:
            application/json:
              example:
                error: Unauthorized
        '404':
          description: >-
            Per l'immagine o il frame non è disponibile alcuna mappa del
            modello, del metodo e del tipo richiesti.
          content:
            application/json:
              example:
                error: Not found
        '429':
          description: Troppe richieste.
          content:
            application/json:
              example:
                error: Too Many Attempts.
      security:
        - ApiKeyAuth: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      name: X-Api-Key
      in: header
      description: La tua API key.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.