API AgentPanoramica
Una panoramica dell'interfaccia utente di API Agent e dei suoi componenti principali.
Dettagli connessione
Dopo aver effettuato l'accesso, è possibile visualizzare i dettagli della connessione nella barra in alto a sinistra. È possibile fare clic sul testo a sinistra di AI per accedere a informazioni più specifiche, che comprendono la gestione di API Connect URL e l'organizzazione del fornitore.
Nuova chat
- Fare clic sul menu IBM API Agent e selezionare New chat per avviare una nuova sessione.
- Selezionare un'organizzazione di provider. Dovete essere già membri di questa organizzazione e il sito API Agent deve essere abilitato per voi. Ciò consente di utilizzare il sito API Agent.
Fare clic su Continua. Viene visualizzato un messaggio di benvenuto.
Nel campo Digita qualcosa, inserire il testo per iniziare a interagire con API Agent.
Pianifica
- I piani che non modificano il sistema (operazioni di sola lettura) vengono eseguiti automaticamente e non richiedono l'approvazione dell'utente.
- I piani che modificano lo stato del sistema (come la creazione, l'aggiornamento o l'eliminazione di risorse) richiedono l'approvazione esplicita dell'utente prima dell'esecuzione.
L'esempio seguente mostra il piano per il messaggio utente di create test cases for the petstore api and run the test cases.
Visualizzazione e modifica del piano
Una volta visualizzato il piano, è possibile visualizzare e modificare i suggerimenti per ogni strumento. Se i suggerimenti predefiniti forniti da API Agent sono soddisfacenti, è possibile approvarli e continuare.
Per apportare modifiche, selezionare Modifica piano per aprire la finestra Modifica piano, dove è possibile modificare i valori.
Approvazione
È necessaria l'approvazione dell'utente per eseguire qualsiasi strumento che apporti modifiche allo stato del sistema. Questi strumenti non possono essere eseguiti senza il consenso esplicito dell'utente.
Comprendere le risposte
Ogni risposta è un risultato visualizzato per l'esecuzione di un singolo strumento. Include un riepilogo, espandere l'opzione freccia per visualizzare una risposta dettagliata del sistema.
Dopo aver fatto clic su Approva, lo strumento viene eseguito e visualizza una risposta. Di seguito è riportato un esempio di esecuzione riuscita.
Errori
Se il prompt richiede un'azione che il sito API Agent non può eseguire perché il sistema non dispone degli strumenti appropriati per la richiesta. Il sito API Agent afferma che la richiesta non può essere completata con gli strumenti attuali. Vengono quindi elencati gli strumenti disponibili e le loro brevi descrizioni. Tutti gli altri errori sono errori di esecuzione degli strumenti. In questi casi, il sito API Agent fornisce un riepilogo dell'errore riscontrato durante l'esecuzione dello strumento.
Interruzione in corso
È possibile ignorare il piano generato e avviare un'altra richiesta. Se si sceglie questa opzione, la richiesta e l'azione precedente vengono ignorate.
Comandi
È possibile eseguire alcuni degli strumenti disponibili direttamente utilizzando /commands. Se si inizia a digitare una barra in avanti (/), è possibile visualizzare l'elenco dei comandi disponibili.
Per passare i parametri, è necessario fornire i valori nel formato key:value . Lo spazio è consentito prima del valore, il che rende più facile specificare il file da caricare. Di seguito è riportato un esempio di utilizzo di /comando.
Caricare e scaricare file
Alcuni comandi richiedono il caricamento di file. Il file deve trovarsi nell'area di lavoro di Visual Studio Code per essere caricato.
Immettendo @ nel campo Tipo qualcosa, viene visualizzato un elenco di file disponibili. Man mano che si inseriscono i caratteri, l'elenco viene filtrato di conseguenza. È possibile selezionare un file in qualsiasi momento di questo processo.
Dove è elencato @file name , è possibile caricare un file dall'area di lavoro locale.
Ogni volta che si parla di api_name, lo si può usare con id, name:version, o con il nome di un draft API. L'uso del solo nome è accettabile, purché esista una sola bozza di API con quel nome specifico. Tuttavia, non è consentito utilizzare il titolo di un'API. Le stesse linee guida si applicano quando si parla di product_name .
Alcuni comandi consentono di scaricare i file dalla risposta, il che è indicato da un'icona di download.
