Avvia un'esecuzione dell'agente tramite API

POST /workflows/{workflowId}/run avvia un'esecuzione dell'agente tramite l'API pubblica di August. La chiamata è asincrona: restituisce immediatamente un run_id, quindi puoi eseguire il polling di GET /workflows/{workflowId}/runs/{runId} per verificarne lo stato e ottenere l'output.

Prima di iniziare

L'operazione di esecuzione è protetta. August verifica che il chiamante possa accedere al workflow dell'agente, incluso il progetto a cui appartiene, e a tutti i workflow collegati direttamente all'esecuzione o tramite associazioni di input.

Invia la richiesta di esecuzione

L'operazione è POST /workflows/{workflowId}/run, descritta nell'API come "Esegui un agente".

Invia POST /workflows/{workflowId}/run con i campi del corpo della richiesta necessari (vedi la tabella seguente).
Leggi la risposta. Restituisce run_id, workflow_id, chat_id (oppure null), question_id (oppure null) e un messaggio Agent run started o Agent run already existed.
Esegui il polling di GET /workflows/{workflowId}/runs/{runId} utilizzando il run_id restituito finché l'esecuzione non termina.

Per elencare le esecuzioni precedenti di un agente, chiama GET /workflows/{workflowId}/runs.

Campi del corpo della richiesta

Tutti i campi, ad eccezione dell'ID del workflow, sono facoltativi. I campi omessi utilizzano la configurazione salvata dell'agente.

Campo	A cosa serve
`projectId`	Progetto in cui eseguire l'operazione. Il valore predefinito è `"personal"`.
`file_ids`, `folder_ids`	File e cartelle allegati all'esecuzione.
`tabular_review_ids`	Revisioni tabellari allegate all'esecuzione.
`playbook_ids`	Playbook allegati all'esecuzione.
`skill_ids`	Competenze allegate all'esecuzione.
`email_ids`	Email allegate all'esecuzione.
`workflow_ids`	Workflow allegati all'esecuzione.
`workflow_ids_override`	Sostituisce i workflow allegati predefiniti dell'agente.
`run_context`	Contesto dell'esecuzione.
`inputs`	Mappa dei nomi degli input ai relativi valori stringa.
`input_bindings`	Associazioni degli input del workflow.
`allow_human_input`	Indica se l'esecuzione può essere messa in pausa per l'inserimento di dati da parte di una persona. Booleano facoltativo, con valore predefinito `true`.

Utilizza i valori predefiniti salvati oppure sostituiscili

Gli allegati e la mappa inputs sostituiscono i valori predefiniti salvati dell'agente. Se li ometti, l'esecuzione utilizza i valori predefiniti restituiti da GET /workflows/{workflowId}/run-inputs.

Esecuzioni messe in pausa per l'inserimento di dati da parte di una persona

Per impostazione predefinita, un'esecuzione tramite API si comporta come un'esecuzione pianificata: se raggiunge un passaggio Question o manca di un input senza il quale non può funzionare, viene messa in pausa con lo stato waiting. L'API pubblica non dispone di un'operazione per rispondere, quindi l'utente proprietario della chiave API risponde all'esecuzione nell'app web di August, come descritto in Riprendi un'esecuzione dell'agente in attesa di input umano.

Esegui senza input umano

Imposta allow_human_input su false quando non sarà disponibile nessuno per rispondere, ad esempio quando il tuo portale clienti avvia l'esecuzione. L'esecuzione non può porre domande a una persona: non vengono generate schede di approvazione e gli strumenti ask-the-user e wait-for-human-input non sono disponibili. L'agente procede utilizzando i documenti allegati, gli input forniti o predefiniti e la definizione dell'agente.

I valori ambigui o mancanti vengono gestiti come supposizioni e segnalati come avvisi, quindi normalmente l'esecuzione termina con Completata con avvisi anziché bloccarsi. Solo se l'esecuzione raggiunge comunque un punto in cui dovrebbe essere messa in pausa, ha esito negativo con un errore nella forma Run requires human input that cannot be provided: ....

Un agente può anche essere salvato come non interattivo; in tal caso, ogni sua esecuzione si comporta in questo modo, indipendentemente dal valore inviato in allow_human_input.

Esiti dell'esecuzione

Un'esecuzione termina con uno dei tre esiti seguenti:

Riuscita. Il contratto dell'output è stato soddisfatto correttamente.
Completata con avvisi. L'esecuzione ha restituito il proprio output, ma qualcosa non è andato come previsto: ad esempio, non è stato possibile identificare un input, mancava un elemento obbligatorio oppure un passaggio è proseguito sulla base di una supposizione. Le superfici dell'esecuzione mostrano lo stato "Completata con avvisi" e la spiegazione dell'avviso appare nei dettagli dell'esecuzione. Verifica le supposizioni o gli input mancanti prima di fare affidamento sull'output.
Non riuscita. Riservata a errori effettivi della piattaforma o del controllo dell'esecuzione, inclusa un'esecuzione non interattiva che richiedeva un input umano non disponibile.

Cosa leggere dopo

Esegui un agente per avviare le esecuzioni nell'interfaccia del prodotto
Trigger degli agenti per l'automazione pianificata e attivata dai caricamenti
Riprendi un'esecuzione dell'agente in attesa di input umano per il percorso interattivo

È stato utile?