Avvia un'esecuzione dell'agente dall'API

POST /workflows/{workflowId}/run avvia un'esecuzione dell'agente tramite l'API pubblica di August. La chiamata è asincrona: restituisce immediatamente un run_id e puoi eseguire il polling di GET /workflows/{workflowId}/runs/{runId} per ottenere lo stato e 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 qualsiasi workflow collegato 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 (consulta 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} con 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, tranne l'ID del workflow, sono facoltativi. I campi omessi utilizzano la configurazione salvata dell'agente.

Campo	Funzione
`projectId`	Progetto in cui eseguire l'agente. Il valore predefinito è `"personal"`.
`file_ids`, `folder_ids`	File e cartelle collegati all'esecuzione.
`tabular_review_ids`	Revisioni tabellari collegate all'esecuzione.
`playbook_ids`	Playbook collegati all'esecuzione.
`skill_ids`	Competenze collegate all'esecuzione.
`email_ids`	Email collegate all'esecuzione.
`workflow_ids`	Workflow collegati all'esecuzione.
`workflow_ids_override`	Sostituisce i workflow collegati 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ò sospendersi in attesa di un input umano. Booleano facoltativo, il cui valore predefinito è `true`.
`notify_email`	Invia via email i risultati dei documenti August dell'esecuzione a questo indirizzo dalla casella di posta August, quando l'email della piattaforma è abilitata per l'account.

Usa 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.

Invia i risultati via email

Imposta notify_email per inviare via email i risultati dei documenti August dell'esecuzione dalla casella di posta August a un destinatario a tua scelta. La consegna delle email funziona quando l'email della piattaforma è abilitata per l'account; in caso contrario, l'esecuzione viene comunque avviata e completata, ma non viene inviata alcuna email.

Esecuzioni che si sospendono in attesa di un input umano

Per impostazione predefinita, un'esecuzione API si comporta come un'esecuzione pianificata: se raggiunge un passaggio Domanda o se manca un input senza il quale non può procedere, si sospende 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 August, come descritto in Riprendere un'esecuzione dell'agente in attesa di un 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 emesse schede di approvazione e gli strumenti ask-the-user e wait-for-human-input non sono disponibili. L'agente procede con i documenti allegati, gli input forniti o predefiniti e la definizione dell'agente.

I valori ambigui o mancanti vengono gestiti come ipotesi e segnalati come avvisi, quindi normalmente l'esecuzione termina con Completata con avvisi invece di bloccarsi. Solo se l'esecuzione raggiunge comunque un punto in cui dovrebbe sospendersi, non va a buon fine con un errore del tipo 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.

Risultati dell'esecuzione

Un'esecuzione termina con uno dei tre risultati seguenti:

Riuscita. Il contratto di 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 è proceduto sulla base di un'ipotesi. Le superfici dell'esecuzione mostrano lo stato "Completata con avvisi" e la spiegazione dell'avviso compare nei dettagli dell'esecuzione. Esamina le ipotesi o gli input mancanti prima di fare affidamento sull'output.
Non riuscita. Riservata ai veri errori della piattaforma o di controllo dell'esecuzione, inclusa un'esecuzione non interattiva che necessitava di un input umano che non ha potuto ottenere.

Cosa leggere dopo

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

È stato utile?