Creazione di uno strumento di chiamata degli endpoint API negli agenti AI generativa

Negli agenti di intelligenza artificiale generativa, ogni agente deve disporre di uno o più strumenti. È possibile creare lo strumento di un agente durante o dopo la creazione dell'agente. Per entrambe le opzioni, la creazione di uno strumento ha gli stessi passaggi. Questa sezione mostra i passi per creare uno strumento di chiamata dell'endpoint API.

Prima di iniziare, esaminare le Linee guida per lo strumento di chiamata degli endpoint API per gli agenti AI generativa e completare i task necessari. Ad esempio, potresti dover creare un segreto del vault OCI e aggiungere criteri per accedere ai segreti del vault.

Creazione di uno strumento di chiamata endpoint API

  1. Selezionare Crea strumento, quindi Strumento personalizzato.
  2. Inserire il nome e la descrizione di questo strumento.
  3. In Configurazione degli strumenti selezionare Chiamata dell'endpoint API (esecuzione dell'agente).
  4. (Facoltativo) Selezionare un esempio, se applicabile.

    Se si seleziona un esempio, l'esempio viene copiato nella casella Schema API per l'importazione In linea. Passare al punto 6.

  5. Per Importa schema API, selezionare una delle seguenti opzioni per fornire lo schema API per questo strumento. Uno schema API descrive le operazioni e i metodi dell'endpoint API.
    • In linea: per uno schema di piccole dimensioni, è possibile immettere una stringa contenente le operazioni e i metodi dell'endpoint API.
    • Scegli dallo storage degli oggetti: per uno schema o uno schema di grandi dimensioni con aggiornamenti frequenti, selezionare un compartimento e un bucket. Selezionare quindi il file che contiene lo schema API.
  6. Per Tipo di autenticazione, selezionare una delle opzioni riportate di seguito e completare la configurazione dello strumento in base alle esigenze.
    • Nessuno: per richiamare endpoint API pubblici o privati che non richiedono l'autenticazione. Quando questa opzione è selezionata, non viene aggiunta alcuna intestazione di autenticazione a una richiesta di chiamata.
    • Chiave API: una chiave API è un token fornito da un client durante le chiamate API. La chiave API deve essere memorizzata in un segreto vault OCI.
      • Posizione chiave: specificare la posizione della chiave API in una richiesta di chiamata.
        • Selezionare Intestazione per inviare la chiave nell'intestazione della richiesta.
        • Selezionare Parametro query per passare la chiave come parametro di query nella richiesta.
      • Nome chiave: immettere il nome di una chiave di intestazione (ad esempio, Authorization) o il nome chiave di un parametro di query (ad esempio, appid).
      • Seleziona segreto vault: nel compartimento appropriato, selezionare il segreto vault OCI che contiene la chiave API.
    • Base: autenticazione di base HTTP mediante un nome utente e una password. Le credenziali devono essere specificate nel formato <your-username>:<your-password> e memorizzate in un segreto vault OCI.
      • Seleziona segreto vault: nel compartimento appropriato, selezionare il segreto vault OCI con le credenziali nel formato richiesto.
    • Bearer: autenticazione OAuth 2.0 mediante un token bearer. Il token deve essere memorizzato in un segreto vault OCI.
      • Seleziona segreto vault: nel compartimento appropriato, selezionare il segreto vault OCI che contiene il token.
    • IDCS: autenticazione OAuth 2.0 mediante l'ID client e il segreto client ottenuti da un'applicazione riservata Oracle Identity Cloud Service (IDCS). Il segreto client deve essere memorizzato in un segreto vault OCI.
      • Dominio di identità: nel compartimento appropriato, selezionare il dominio di Identity in cui creare questo strumento.
      • ID client: immettere l'ID client dell'applicazione riservata.
      • Segreto client: nel compartimento appropriato, selezionare il segreto vault OCI con il segreto client per l'applicazione riservata.
      • URL ambito: immettere l'URL dell'ambito che definisce un set specifico di risorse e operazioni a cui è possibile accedere.
    • Principal delle risorse OCI: solo per chiamare le API del servizio OCI come storage degli oggetti, computazione e networking (VCN e subnet).
  7. Nel compartimento appropriato, selezionare la VCN e la subnet che si desidera utilizzare.
  8. Selezionare Crea strumento.
Suggerimento

Eseguire una delle azioni riportate di seguito.

  • Se si sta creando un agente, tornare a Creazione di un agente negli agenti AI generativa per creare un altro strumento o un endpoint agente.
  • Se lo strumento è stato aggiunto a un agente esistente, dopo l'attivazione dello strumento, nella pagina dei dettagli dell'agente selezionare Avvia chat per chattare con l'agente utilizzando questo strumento.
  • Se l'agente è stato creato senza un endpoint agente, quando si è pronti a utilizzarlo, creare un endpoint per questo agente.
Nota

Per consentire a un revisore umano di monitorare e modificare una risposta prima di inviarla all'utente, selezionare la funzione facoltativa Abilita utente umano nel loop nell'endpoint dell'agente.