Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified Manuale utente.pdf
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
90 changes: 60 additions & 30 deletions SorgentiTex/Manuale utente/main.tex
Original file line number Diff line number Diff line change
Expand Up @@ -40,21 +40,14 @@ \subsubsection{Riferimenti normativi}
\item \textit{Regolamento del progetto didattico}: \\
\url{https://www.math.unipd.it/~tullio/IS-1/2023/Dispense/PD2.pdf}\\
(Ultimo accesso: 2024-03-14);
\item \textit{Standard ISO/IEC 9126}:\\
\url{https://it.wikipedia.org/wiki/ISO/IEC_9126}\\
(Ultimo accesso: 2024-03-14).
\end{itemize}
\subsubsection{Riferimenti informativi}
\begin{itemize}
\item \textit{(Analisi dei requisiti v3.0.0(0))};
\item \textit{Capitolato C1}: \textit{Knowledge Management AI}: \\ \url{https://www.math.unipd.it/~tullio/IS-1/2023/Progetto/C1.pdf}\\
(Ultimo accesso: 2024-02-08);

(Ultimo accesso: 2024-02-08).
\end{itemize}

\newpage


\section{Istruzioni per l'utente}
Questa sezione comprende le istruzioni per l'uso del prodotto delle funzionalità disponibili all'utente (attore).
\subsection{Configurazione utente}
Expand Down Expand Up @@ -110,6 +103,7 @@ \subsubsection{Cambiamento del modello LLM selezionato}
\item Premere il bottone con su scritto 'Confirm configuration'.
\end{itemize}

\newpage
\subsection{Gestione dei documenti}
In questa sezione si illustrano le possibili azioni operabili sui documenti.
\subsubsection{Visualizzazione lista dei documenti}
Expand Down Expand Up @@ -166,7 +160,7 @@ \subsubsubsection{Visualizzazione delle colonne}
\item Selezionare l'opzione 'Hide' dal menù che comparirà automaticamente.
\end{itemize}

\subsubsubsection{Scorrimento orizzontale}
\subsubsubsection{Paginazione}
\begin{figure}[H]
\centering
\frame{
Expand Down Expand Up @@ -324,7 +318,7 @@ \subsubsection{Caricamento e rimozione dall'area di staging}
\caption{Documents - cancel staging}
\label{img:docsStageAreadel}
\end{figure}
\item Se si cambia idea e non è più necessario fare l'upload del documento (o dei documenti) inseriti nell'area di staging, selezionare il bottone 'Cancel upload' che si trova sotto all'area di staging;
\item Se non è più necessario fare l'upload del documento (o dei documenti) inseriti nell'area di staging, selezionare il bottone 'Cancel upload' che si trova sotto all'area di staging;
\begin{figure}[H]
\centering
\frame{
Expand All @@ -333,9 +327,22 @@ \subsubsection{Caricamento e rimozione dall'area di staging}
\label{img:docsStageAreacancel}
\end{figure}
\item Se nell'area di staging è già presente un documento (o più documenti) con lo stesso nome e formato di quello (o quelli) selezionato/i, viene visualizzato un pop up di errore in basso a destra, dato che non è possibile inserire due documenti uguali nell'area di staging.\\ Se i due documenti dovessero avere stesso nome e formato ma dovessero essere diversi, si prega di rinominare il secondo documento in questione e caricarlo nuovamente nell'area di staging;

\begin{figure}[H]
\centering
\frame{
\includegraphics[width=10cm]{img/Screen/duplicateddoc.png}}
\caption{Documents - documenti duplicati}
\label{img:duplicatedDocuments}
\end{figure}
\item Se si prova ad inserire nell'area di staging un documento con un formato non leggibile dall'applicazione viene visualizzato un pop up di errore in basso a destra.
\end{itemize}
\begin{figure}[H]
\centering
\frame{
\includegraphics[width=10cm]{img/Screen/invalidformat.png}}
\caption{Documents - Formato non valido}
\label{img:invalidFormat}
\end{figure}
\end{itemize}


\subsubsection{Upload nel sistema di archiviazione e nel vector database dall'area di staging}
Expand All @@ -354,7 +361,7 @@ \subsubsection{Upload nel sistema di archiviazione e nel vector database dall'ar
\begin{figure}[H]
\centering
\frame{
\includegraphics[width=8cm]{img/Screen/substitutedocuments.png}}
\includegraphics[width=10cm]{img/Screen/substitutedocuments.png}}
\caption{Documents - sostituisci documenti caricati}
\label{img:docsStageSubstitute}
\end{figure}
Expand All @@ -368,12 +375,18 @@ \subsubsection{Occultamento dal sistema}
\item Aprire la lista dei documenti nel sistema di archiviazione: vedi \vedi{sec:visDocsList};
\item Trovare il documento che si desidera occultare e fare clic sul bottone raffigurante i tre puntini in verticale nella riga corrispondente;
\item Selezionare l'opzione 'Conceal' dall'elenco che compare automaticamente;
\begin{figure}[H]
\centering
\frame{
\includegraphics[width=16cm]{img/Screen/concealsingle.png}}
\caption{Documents - singolo occultamento}
\label{img:concealSingle}
\end{figure}
\item In seguito a tale azione, apparirà un pop up di conferma: selezionare l'opzione 'Conceal' per confermare o l'opzione 'Abort' per annullare l'azione.

\begin{figure}[H]
\centering
\frame{
\includegraphics[width=8cm]{img/Screen/concealdocuments.png}}
\includegraphics[width=10cm]{img/Screen/concealdocuments.png}}
\caption{Documents - conferma occultamento}
\label{img:confirmConceal}
\end{figure}
Expand All @@ -387,44 +400,62 @@ \subsubsection{Occultamento dal sistema}
\frame{
\includegraphics[width=16cm]{img/Screen/concealselected.png}}
\caption{Documents - occulta selezionati}
\label{img:confirmConcealSel}
\label{img:concealSel}
\end{figure}

\item Selezionare l'opzione 'Conceal' facendo clic sul bottone che compare automaticamente in alto a destra rispetto alla lista dei documenti;
\item Come per il singolo documento prima, apparirà un pop up di conferma: selezionare l'opzione 'Conceal' per confermare o l'opzione 'Abort' per annullare l'azione.
\end{itemize}


\subsubsection{Riabilitazione dal sistema}
Per riabilitare un documento occultato nel sistema di archiviazione il procedimento è simile a quello dell' occultamento (vedi \vedi{sec:concealDocs}):
\begin{itemize}
\item Aprire la lista dei documenti nel sistema di archiviazione: vedi \vedi{sec:visDocsList};
\item Trovare il documento che si desidera riabilitare e fare clic sul bottone raffigurante i tre puntini in verticale nella riga corrispondente;
\item Selezionare l'opzione 'Enable' dall'elenco che compare automaticamente;
\begin{figure}[H]
\centering
\frame{
\includegraphics[width=16cm]{img/Screen/enablesingle.png}}
\caption{Documents - singola riabilitazione}
\label{img:enableSel}
\end{figure}
\item In seguito a tale azione, apparirà un pop up di conferma: selezionare l'opzione 'Enable' per confermare o l'opzione 'Abort' per annullare l'azione, simile al pop up di conferma occultamento.
\begin{figure}[H]
\centering
\frame{
\includegraphics[width=10cm]{img/Screen/confirmenable.png}}
\caption{Documents - conferma riabilitazione}
\label{img:confirmEnable}
\end{figure}
\end{itemize}

Per riabilitare più documenti presenti nel sistema di archiviazione è necessario:
\begin{itemize}
\item Aprire la lista dei documenti nel sistema di archiviazione: vedi \vedi{sec:visDocsList};
\item Trovare i documenti che si desidera riabilitare e fare clic sul bottone raffigurante un quadrato a sinistra di ogni documento da riabilitare, per operare la selezione dei documenti, similmente al processo di selezione dei documenti per occultarli. Attenzione: i documenti selezionati devono essere esclusivamente di stato 'Concealed', altrimenti non sarà possibile proseguire;
\begin{figure}[H]
\centering
\frame{
\includegraphics[width=16cm]{img/Screen/enableselected.png}}
\caption{Documents - riabilita selezionati}
\label{img:enableSel}
\end{figure}
\item Selezionare l'opzione 'Enable' facendo clic sul bottone che compare automaticamente in alto a destra rispetto alla lista dei documenti;
\item In seguito a tale azione, apparirà un pop up di conferma: selezionare l'opzione 'Enable' per confermare o l'opzione 'Abort' per annullare l'azione, simile al pop up di conferma occultamento documenti selezionati.
\end{itemize}

\subsubsection{Incorporazione (Embed) da lista dei documenti}
Per incorporare nel sistema un documento il procedimento è simile a quello dell' occultamento (vedi \vedi{sec:concealDocs}):
\subsubsection{Operazione Embed da lista dei documenti}
Per calcolare gli embeddings di un documento nel sistema il procedimento è simile a quello dell' occultamento (vedi \vedi{sec:concealDocs}):
\begin{itemize}
\item Aprire la lista di tutti i documenti: vedi \vedi{sec:visDocsList};
\item Trovare il documento che si desidera incorporare e fare clic sul bottone raffigurante i tre puntini in verticale nella riga corrispondente;
\item Trovare il documento di cui si desidera calcolare gli embeddings e fare clic sul bottone raffigurante i tre puntini in verticale nella riga corrispondente;
\item Selezionare l'opzione 'Embed' dall'elenco che compare automaticamente;
\item In seguito a tale azione, apparirà un pop up di conferma: selezionare l'opzione 'Embed' per confermare o l'opzione 'Abort' per annullare l'azione.
\end{itemize}
Per incorporare più documenti presenti nel sistema di archiviazione è necessario:
Per calcolare gli embeddings più documenti presenti nel sistema di archiviazione è necessario:
\begin{itemize}
\item Aprire la lista di tutti i documenti: vedi \vedi{sec:visDocsList};
\item Trovare i documenti che si desidera incorporare e fare clic sul bottone raffigurante un quadrato a sinistra di ogni documento, per operare la selezione dei documenti. Attenzione: i documenti selezionati devono essere esclusivamente di stato 'Not Embedded', altrimenti non sarà possibile proseguire;
\item Selezionare l'opzione 'Embed' facendo clic sul bottone che compare automaticamente in alto a destra rispetto alla lista dei documenti;
\item Trovare i documenti di cui si desidera calcolare gli embeddings e fare clic sul bottone raffigurante un quadrato a sinistra di ogni documento, per operare la selezione dei documenti. Attenzione: i documenti selezionati devono essere esclusivamente di stato 'Not Embedded', altrimenti non sarà possibile proseguire;
\item Selezionare l'opzione 'Embed' facendo clic sul bottone che compare automaticamente in alto a destra rispetto alla lista dei documenti;
\item In seguito a tale azione, apparirà un pop up di conferma: selezionare l'opzione 'Embed' per confermare o l'opzione 'Abort' per annullare l'azione.
\end{itemize}

Expand Down Expand Up @@ -463,8 +494,7 @@ \subsubsection{Ricerca nel sistema}
\end{itemize}
È inoltre possibile combinare tutte le funzioni di ricerca tra loro, quindi per esempio si può effettuare la ricerca di un documento inserendone titolo, stato e formato ricercati. \\ Per annullare le selezioni dei filtri di ricerca è sufficiente cliccare sul pulsante 'Reset' (affiancato dal simbolo 'X') che compare automaticamente dopo la selezione di un filtro di ricerca, situato a destra del pulsante di ricerca per formato.



\newpage
\subsection{Gestione delle chat}
In questa sezione si illustrano le possibili azioni operabili sulle chat dell'applicazione.
\subsubsection{Visualizzazione}
Expand Down Expand Up @@ -501,7 +531,7 @@ \subsubsection{Visualizzazione}
Se si comincia una conversazione con il chatbot o se si seleziona l'opzione 'Chatbot' dal menù in alto a sinistra della dashboard, la lista delle chat dell'applicazione è resa disponibile nella parte sinistra della pagina. Nella lista vengono visualizzati i timestamp dell'ultimo messaggio presente per ogni chat (nella rispettiva riga in alto a destra), la preview dell'ultimo messaggio presente della chat (appena sotto al titolo) e la preview dell'ultimo mittente di una chat.


\subsubsection{Creazione, eliminazione, Ridenominazione}
\subsubsection{Creazione, eliminazione, ridenominazione}
\subsubsubsection{Creazione chat }
Per creare una nuova chat è necessario:
\begin{itemize}
Expand Down Expand Up @@ -537,7 +567,7 @@ \subsubsubsection{Eliminazione chat }
\begin{figure}[H]
\centering
\frame{
\includegraphics[width=8cm]{img/Screen/deletechat.png}}
\includegraphics[width=10cm]{img/Screen/deletechat.png}}
\caption{Chatbot - conferma eliminazione chat}
\end{figure}
\end{itemize}
Expand Down Expand Up @@ -678,7 +708,7 @@ \subsubsection{Modalità vocale}
\item Se si desidera inviare il messaggio fare clic sul bottone a destra della casella per l'inserimento testuale, raffigurante un aeroplanino.
\end{itemize}


\newpage
\subsection{Altre funzionalità}
\subsubsection{Cambio del tema di sfondo}
L'interfaccia dell'applicazione è disponibile in tema chiaro o scuro.\\
Expand Down
2 changes: 2 additions & 0 deletions SorgentiTex/Manuale utente/registroversioni.tex
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ \section*{Registro delle versioni}

\endlastfoot

\hline
v2.27.9(2) & $2024-04-12$ & \quantities{Campese M.} & Ciriolo I. & Aggiunta immagini toast notifiche.\\
\hline
v2.27.8(2) & $2024-04-10$ & \quantities{Campese M.} & Michelon R. & Aggiornamento immagini.\\
\hline
Expand Down