Avviare 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/{run_id} per verificarne 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, nonché a tutti i workflow associati 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) e un messaggio Agent run started o Agent run already existed.
Esegui il polling di GET /workflows/{workflowId}/runs/{run_id} con il run_id restituito finché l'esecuzione non termina.

Campi del corpo della richiesta

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

Campo	Cosa fa
`projectId`	Progetto in cui eseguire l'operazione. Il valore predefinito è `"personal"`.
`file_ids`, `folder_ids`	File e cartelle associati all'esecuzione.
`tabular_review_ids`	Revisioni tabellari associate all'esecuzione.
`playbook_ids`	Playbook associati all'esecuzione.
`skill_ids`	Competenze associate all'esecuzione.
`email_ids`	Email associate all'esecuzione.
`workflow_ids`	Workflow associati all'esecuzione.
`workflow_ids_override`	Sostituisce i workflow associati predefiniti dell'agente.
`run_context`	Contesto dell'esecuzione.
`inputs`	Mappa dei nomi degli input ai valori stringa.
`input_bindings`	Associazioni degli input del workflow.
`allow_human_input`	Indica se l'esecuzione può mettersi in pausa in attesa di input umano. Booleano facoltativo; il valore predefinito è `true`.

Usare i valori predefiniti salvati o sostituirli

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

Eseguire senza input umano

Imposta allow_human_input su false per rendere l'esecuzione non interattiva. 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 usando i documenti allegati, gli input forniti o predefiniti e la definizione dell'agente. I valori ambigui o mancanti vengono gestiti come ipotesi e segnalati, invece di bloccare l'esecuzione.

Se l'esecuzione non può realmente procedere senza input umano, termina con un errore del tipo Run requires human input that cannot be provided: ... invece di rimanere in pausa.

Le esecuzioni avviate dal portale di August usano sempre questo comportamento non interattivo e terminano con un esito di completamento, avviso o errore, invece di rimanere in pausa. Il percorso interattivo disattivato da allow_human_input: false è descritto in Riprendere un'esecuzione dell'agente in attesa di input umano.

Esiti dell'esecuzione

Un'esecuzione termina con uno dei tre esiti seguenti:

Completata. Il contratto di output è stato soddisfatto correttamente.
Completata con avvisi. L'esecuzione ha prodotto 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 un'ipotesi. Le interfacce 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. Riservato agli 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 esecuzioni nell'interfaccia utente del prodotto
Trigger degli agenti per l'automazione basata su eventi e pianificazioni
Riprendi un'esecuzione dell'agente in attesa di input umano per il percorso interattivo

È stato utile?