AgentsOperations interface

Interfaccia che rappresenta le operazioni di un agente.

Proprietà

createSession	Crea una nuova sessione per un endpoint agente. L'endpoint risolve la versione dell'agente di supporto e `version_indicator` fa rispettare la proprietà della sessione utilizzando la chiave di isolamento fornita per le operazioni di mutazione della sessione.
createVersionFromCode	Crea una nuova versione dell'agente dal codice. Carica il codice ZIP e crea una nuova versione per un agente esistente. Il digest esagonale SHA-256 dello zip è fornito nell'intestazione `x-ms-code-zip-sha256` per integrità e deduplicazione. Il corpo della richiesta è composto da multipart/modul-data con una parte di metadati JSON e una parte di codice binario (l'ordine delle parti è irrilevante). La dimensione massima di upload è di 250 MB.
delete	Elimina un agente. Per gli agenti ospiti, se una qualsiasi versione ha sessioni attive, la richiesta viene rifiutata con HTTP 409 a meno che `force` non venga impostata su true. Quando la forza è vera, tutte le sessioni associate vengono cancellate a cascata insieme all'agente e alle sue versioni.
deleteSession	Cancella una sessione in modo sincrono. Restituisce 204 Nessun contenuto quando la sessione viene eliminata o non esiste.
deleteSessionFile	Elimina il file o la directory specificati dal sandbox della sessione. Quando `recursive` è falso, eliminando una directory non vuota restituisce 409 Conflitto.
deleteVersion	Elimina una versione specifica di un agente. Per gli agenti ospiti, se la versione ha sessioni attive, la richiesta viene rifiutata con HTTP 409 a meno che `force` non venga impostata su true. Quando la forza è vera, tutte le sessioni associate a questa versione vengono cancellate a cascata.
disable	Disabilita l'agente specificato, impedendogli di accettare nuove sessioni o di elaborare richieste. Le sessioni attive esistenti possono scaricare con grazia, ma non si possono creare nuove sessioni. Questa operazione è idempotente — disabilitare un agente già disabile restituisce successo senza effetti collaterali.
downloadAgentCode	Scarica il codice CAP per un agente ospitato basato su codice. Restituisce il zip precedentemente caricato (`application/zip`). Se `agent_version` viene fornito, restituisce il codice zip di quella versione; altrimenti restituisce il codice zip dell'ultima versione. Il digest SHA-256 dei byte restituiti corrisponde a `content_hash` quello della versione `code_configuration`risolta .
downloadSessionFile	Scarica il file nel percorso sandbox specificato come flusso binario. Il percorso viene risolto rispetto alla directory principale della sessione.
enable	Abilita l'agente specificato, consentendogli di accettare nuove sessioni e processare richieste. Questa operazione è idempotente — permette a un agente già abilitato di restituire il successo senza effetti collaterali.
get	Recupera l'agente.
getSession	Recupera i dettagli di una sessione di agente ospitata per nome dell'agente e identificatore di sessione.
getSessionLogStream	Trasmette i log della console (stdout / stderr) per una sessione di agente ospitato specifica come flusso Server-Sent Eventi (SSE). Ogni frame SSE contiene: `event`: sempre `"log"` `data`: una logline in testo semplice (attualmente formattata in JSON, ma lo schema non è contrattuale e può includere chiavi aggiuntive o cambiare formato nel tempo — i clienti dovrebbero considerarla come una stringa opaca) Esempi di frame SSE: `event: log data: {"timestamp":"2026-03-10T09:33:17.121Z","stream":"stdout","message":"Starting FoundryCBAgent server on port 8088"} event: log data: {"timestamp":"2026-03-10T09:33:17.130Z","stream":"stderr","message":"INFO: Application startup complete."} event: log data: {"timestamp":"2026-03-10T09:34:52.714Z","stream":"status","message":"Successfully connected to container"} event: log data: {"timestamp":"2026-03-10T09:35:52.714Z","stream":"status","message":"No logs since last 60 seconds"}` Il flusso rimane aperto finché il client non si disconnette o il server non interrompe la connessione. I clienti dovrebbero gestire la riconnessione quando necessario.
getVersion	Recupera una versione specifica di un agente.
list	Restituisce l'elenco di tutti gli agenti.
listSessionFiles	Restituisce file e directory sul percorso specificato nel sandbox della sessione. La risposta include solo i figli immediati della directory di destinazione e si avvia di default alla directory home della sessione quando non viene fornito alcun percorso.
listSessions	Restituisce una raccolta paginata di sessioni associate all'endpoint agente specificato.
listVersions	Restituisce l'elenco delle versioni di un agente.
patchAgentObject	Modifica un agente esistente.
stopSession	Termina la sessione dell'agente ospitato specificata e restituisce 204 Nessun contenuto quando la richiesta ha successo.
updateAgent	Applica un aggiornamento di merge-patch alla configurazione dell'endpoint agente specificata.
uploadSessionFile	Carica il contenuto binario del file sul percorso specificato nel sandbox della sessione. Il servizio memorizza il file rispetto alla cartella home della sessione e rifiuta payload superiori a 50 MB.

Metodi

create(string, AgentDefinitionUnion, AgentsCreateOptionalParams)	Crea l'agente.
create(string, string, Record<string, unknown>, AgentsCreateAgentFromManifestOptionalParams)	Crea un agente da un manifesto.
createVersion(string, AgentDefinitionUnion, AgentsCreateVersionOptionalParams)	Creare una nuova versione dell'agente.
createVersion(string, string, Record<string, unknown>, AgentsCreateAgentVersionFromManifestOptionalParams)	Creare una nuova versione dell'agente da un manifesto.
update(string, AgentDefinitionUnion, AgentsUpdateOptionalParams)	Aggiorna l'agente aggiungendo una nuova versione se sono presenti modifiche alla definizione dell'agente. Se non viene apportata alcuna modifica, restituisce la versione dell'agente esistente.
update(string, string, Record<string, unknown>, AgentsUpdateAgentFromManifestOptionalParams)	Aggiorna l'agente da un manifesto aggiungendo una nuova versione se sono presenti modifiche alla definizione dell'agente. Se non viene apportata alcuna modifica, restituisce la versione dell'agente esistente.

createSession

Crea una nuova sessione per un endpoint agente. L'endpoint risolve la versione dell'agente di supporto e version_indicator fa rispettare la proprietà della sessione utilizzando la chiave di isolamento fornita per le operazioni di mutazione della sessione.

createSession: (agentName: string, versionIndicator: VersionIndicatorUnion, options?: AgentsCreateSessionOptionalParams) => Promise<AgentSessionResource>

Valore della proprietà

(agentName: string, versionIndicator: VersionIndicatorUnion, options?: AgentsCreateSessionOptionalParams) => Promise<AgentSessionResource>

createVersionFromCode

Crea una nuova versione dell'agente dal codice. Carica il codice ZIP e crea una nuova versione per un agente esistente. Il digest esagonale SHA-256 dello zip è fornito nell'intestazione x-ms-code-zip-sha256 per integrità e deduplicazione. Il corpo della richiesta è composto da multipart/modul-data con una parte di metadati JSON e una parte di codice binario (l'ordine delle parti è irrilevante). La dimensione massima di upload è di 250 MB.

createVersionFromCode: (agentName: string, codeZipSha256: string, content: CreateAgentVersionFromCodeContent, options?: AgentsCreateVersionFromCodeOptionalParams) => Promise<AgentVersion>

Valore della proprietà

(agentName: string, codeZipSha256: string, content: CreateAgentVersionFromCodeContent, options?: AgentsCreateVersionFromCodeOptionalParams) => Promise<AgentVersion>

delete

Elimina un agente. Per gli agenti ospiti, se una qualsiasi versione ha sessioni attive, la richiesta viene rifiutata con HTTP 409 a meno che force non venga impostata su true. Quando la forza è vera, tutte le sessioni associate vengono cancellate a cascata insieme all'agente e alle sue versioni.

delete: (agentName: string, options?: AgentsDeleteOptionalParams) => Promise<DeleteAgentResponse>

Valore della proprietà

(agentName: string, options?: AgentsDeleteOptionalParams) => Promise<DeleteAgentResponse>

deleteSession

Cancella una sessione in modo sincrono. Restituisce 204 Nessun contenuto quando la sessione viene eliminata o non esiste.

deleteSession: (agentName: string, sessionId: string, options?: AgentsDeleteSessionOptionalParams) => Promise<void>

Valore della proprietà

(agentName: string, sessionId: string, options?: AgentsDeleteSessionOptionalParams) => Promise<void>

deleteSessionFile

Elimina il file o la directory specificati dal sandbox della sessione. Quando recursive è falso, eliminando una directory non vuota restituisce 409 Conflitto.

deleteSessionFile: (agentName: string, sessionId: string, path: string, options?: AgentsDeleteSessionFileOptionalParams) => Promise<void>

Valore della proprietà

(agentName: string, sessionId: string, path: string, options?: AgentsDeleteSessionFileOptionalParams) => Promise<void>

deleteVersion

Elimina una versione specifica di un agente. Per gli agenti ospiti, se la versione ha sessioni attive, la richiesta viene rifiutata con HTTP 409 a meno che force non venga impostata su true. Quando la forza è vera, tutte le sessioni associate a questa versione vengono cancellate a cascata.

deleteVersion: (agentName: string, agentVersion: string, options?: AgentsDeleteVersionOptionalParams) => Promise<DeleteAgentVersionResponse>

Valore della proprietà

(agentName: string, agentVersion: string, options?: AgentsDeleteVersionOptionalParams) => Promise<DeleteAgentVersionResponse>

disable

Disabilita l'agente specificato, impedendogli di accettare nuove sessioni o di elaborare richieste. Le sessioni attive esistenti possono scaricare con grazia, ma non si possono creare nuove sessioni. Questa operazione è idempotente — disabilitare un agente già disabile restituisce successo senza effetti collaterali.

disable: (agentName: string, options?: AgentsDisableOptionalParams) => Promise<void>

Valore della proprietà

(agentName: string, options?: AgentsDisableOptionalParams) => Promise<void>

downloadAgentCode

Scarica il codice CAP per un agente ospitato basato su codice. Restituisce il zip precedentemente caricato (application/zip).

Se agent_version viene fornito, restituisce il codice zip di quella versione; altrimenti restituisce il codice zip dell'ultima versione.

Il digest SHA-256 dei byte restituiti corrisponde a content_hash quello della versione code_configurationrisolta .

downloadAgentCode: (agentName: string, options?: AgentsDownloadAgentCodeOptionalParams) => Promise<AgentsDownloadAgentCodeResponse>

Valore della proprietà

(agentName: string, options?: AgentsDownloadAgentCodeOptionalParams) => Promise<AgentsDownloadAgentCodeResponse>

downloadSessionFile

Scarica il file nel percorso sandbox specificato come flusso binario. Il percorso viene risolto rispetto alla directory principale della sessione.

downloadSessionFile: (agentName: string, sessionId: string, path: string, options?: AgentsDownloadSessionFileOptionalParams) => Promise<AgentsDownloadSessionFileResponse>

Valore della proprietà

(agentName: string, sessionId: string, path: string, options?: AgentsDownloadSessionFileOptionalParams) => Promise<AgentsDownloadSessionFileResponse>

enable

Abilita l'agente specificato, consentendogli di accettare nuove sessioni e processare richieste. Questa operazione è idempotente — permette a un agente già abilitato di restituire il successo senza effetti collaterali.

enable: (agentName: string, options?: AgentsEnableOptionalParams) => Promise<void>

Valore della proprietà

(agentName: string, options?: AgentsEnableOptionalParams) => Promise<void>

get

Recupera l'agente.

get: (agentName: string, options?: AgentsGetOptionalParams) => Promise<Agent>

Valore della proprietà

(agentName: string, options?: AgentsGetOptionalParams) => Promise<Agent>

getSession

Recupera i dettagli di una sessione di agente ospitata per nome dell'agente e identificatore di sessione.

getSession: (agentName: string, sessionId: string, options?: AgentsGetSessionOptionalParams) => Promise<AgentSessionResource>

Valore della proprietà

(agentName: string, sessionId: string, options?: AgentsGetSessionOptionalParams) => Promise<AgentSessionResource>

getSessionLogStream

Trasmette i log della console (stdout / stderr) per una sessione di agente ospitato specifica come flusso Server-Sent Eventi (SSE).

Ogni frame SSE contiene:

event: sempre "log"
data: una logline in testo semplice (attualmente formattata in JSON, ma lo schema non è contrattuale e può includere chiavi aggiuntive o cambiare formato nel tempo — i clienti dovrebbero considerarla come una stringa opaca)

Esempi di frame SSE:

event: log
data: {"timestamp":"2026-03-10T09:33:17.121Z","stream":"stdout","message":"Starting FoundryCBAgent server on port 8088"}

event: log
data: {"timestamp":"2026-03-10T09:33:17.130Z","stream":"stderr","message":"INFO: Application startup complete."}

event: log
data: {"timestamp":"2026-03-10T09:34:52.714Z","stream":"status","message":"Successfully connected to container"}

event: log
data: {"timestamp":"2026-03-10T09:35:52.714Z","stream":"status","message":"No logs since last 60 seconds"}

Il flusso rimane aperto finché il client non si disconnette o il server non interrompe la connessione. I clienti dovrebbero gestire la riconnessione quando necessario.

getSessionLogStream: (agentName: string, agentVersion: string, sessionId: string, options?: AgentsGetSessionLogStreamOptionalParams) => Promise<AgentsDownloadSessionFileResponse>

Valore della proprietà

(agentName: string, agentVersion: string, sessionId: string, options?: AgentsGetSessionLogStreamOptionalParams) => Promise<AgentsDownloadSessionFileResponse>

getVersion

Recupera una versione specifica di un agente.

getVersion: (agentName: string, agentVersion: string, options?: AgentsGetVersionOptionalParams) => Promise<AgentVersion>

Valore della proprietà

(agentName: string, agentVersion: string, options?: AgentsGetVersionOptionalParams) => Promise<AgentVersion>

list

Restituisce l'elenco di tutti gli agenti.

list: (options?: AgentsListOptionalParams) => PagedAsyncIterableIterator<Agent, Agent[], PageSettings>

Valore della proprietà

(options?: AgentsListOptionalParams) => PagedAsyncIterableIterator<Agent, Agent[], PageSettings>

listSessionFiles

Restituisce file e directory sul percorso specificato nel sandbox della sessione. La risposta include solo i figli immediati della directory di destinazione e si avvia di default alla directory home della sessione quando non viene fornito alcun percorso.

listSessionFiles: (agentName: string, sessionId: string, options?: AgentsListSessionFilesOptionalParams) => PagedAsyncIterableIterator<SessionDirectoryEntry, SessionDirectoryEntry[], PageSettings>

Valore della proprietà

(agentName: string, sessionId: string, options?: AgentsListSessionFilesOptionalParams) => PagedAsyncIterableIterator<SessionDirectoryEntry, SessionDirectoryEntry[], PageSettings>

listSessions

Restituisce una raccolta paginata di sessioni associate all'endpoint agente specificato.

listSessions: (agentName: string, options?: AgentsListSessionsOptionalParams) => PagedAsyncIterableIterator<AgentSessionResource, AgentSessionResource[], PageSettings>

Valore della proprietà

(agentName: string, options?: AgentsListSessionsOptionalParams) => PagedAsyncIterableIterator<AgentSessionResource, AgentSessionResource[], PageSettings>

listVersions

Restituisce l'elenco delle versioni di un agente.

listVersions: (agentName: string, options?: AgentsListVersionsOptionalParams) => PagedAsyncIterableIterator<AgentVersion, AgentVersion[], PageSettings>

Valore della proprietà

(agentName: string, options?: AgentsListVersionsOptionalParams) => PagedAsyncIterableIterator<AgentVersion, AgentVersion[], PageSettings>

patchAgentObject

Modifica un agente esistente.

patchAgentObject: (agentName: string, options?: AgentsUpdateAgentObjectOptionalParams) => Promise<Agent>

Valore della proprietà

(agentName: string, options?: AgentsUpdateAgentObjectOptionalParams) => Promise<Agent>

stopSession

Termina la sessione dell'agente ospitato specificata e restituisce 204 Nessun contenuto quando la richiesta ha successo.

stopSession: (agentName: string, sessionId: string, options?: AgentsStopSessionOptionalParams) => Promise<void>

Valore della proprietà

(agentName: string, sessionId: string, options?: AgentsStopSessionOptionalParams) => Promise<void>

updateAgent

Applica un aggiornamento di merge-patch alla configurazione dell'endpoint agente specificata.

updateAgent: (agentName: string, options?: AgentsUpdateAgentObjectOptionalParams) => Promise<Agent>

Valore della proprietà

(agentName: string, options?: AgentsUpdateAgentObjectOptionalParams) => Promise<Agent>

uploadSessionFile

Carica il contenuto binario del file sul percorso specificato nel sandbox della sessione. Il servizio memorizza il file rispetto alla cartella home della sessione e rifiuta payload superiori a 50 MB.

uploadSessionFile: (agentName: string, sessionId: string, path: string, content: Uint8Array, options?: AgentsUploadSessionFileOptionalParams) => Promise<SessionFileWriteResponse>

Valore della proprietà

(agentName: string, sessionId: string, path: string, content: Uint8Array, options?: AgentsUploadSessionFileOptionalParams) => Promise<SessionFileWriteResponse>

create(string, AgentDefinitionUnion, AgentsCreateOptionalParams)

Crea l'agente.

function create(name: string, definition: AgentDefinitionUnion, options?: AgentsCreateOptionalParams): Promise<Agent>

Parametri

name: string

definition: AgentDefinitionUnion

options: AgentsCreateOptionalParams

Valori restituiti

Promise<Agent>

create(string, string, Record<string, unknown>, AgentsCreateAgentFromManifestOptionalParams)

Crea un agente da un manifesto.

function create(name: string, manifestId: string, parameterValues: Record<string, unknown>, options?: AgentsCreateAgentFromManifestOptionalParams): Promise<Agent>

Parametri

name: string

manifestId: string

parameterValues: Record<string, unknown>

options: AgentsCreateAgentFromManifestOptionalParams

Valori restituiti

Promise<Agent>

createVersion(string, AgentDefinitionUnion, AgentsCreateVersionOptionalParams)

Creare una nuova versione dell'agente.

function createVersion(agentName: string, definition: AgentDefinitionUnion, options?: AgentsCreateVersionOptionalParams): Promise<AgentVersion>

Parametri

agentName: string

definition: AgentDefinitionUnion

options: AgentsCreateVersionOptionalParams

Valori restituiti

Promise<AgentVersion>

createVersion(string, string, Record<string, unknown>, AgentsCreateAgentVersionFromManifestOptionalParams)

Creare una nuova versione dell'agente da un manifesto.

function createVersion(agentName: string, manifestId: string, parameterValues: Record<string, unknown>, options?: AgentsCreateAgentVersionFromManifestOptionalParams): Promise<AgentVersion>

Parametri

agentName: string

manifestId: string

parameterValues: Record<string, unknown>

options: AgentsCreateAgentVersionFromManifestOptionalParams

Valori restituiti

Promise<AgentVersion>

update(string, AgentDefinitionUnion, AgentsUpdateOptionalParams)

Aggiorna l'agente aggiungendo una nuova versione se sono presenti modifiche alla definizione dell'agente. Se non viene apportata alcuna modifica, restituisce la versione dell'agente esistente.

function update(agentName: string, definition: AgentDefinitionUnion, options?: AgentsUpdateOptionalParams): Promise<Agent>

Parametri

agentName: string

definition: AgentDefinitionUnion

options: AgentsUpdateOptionalParams

Valori restituiti

Promise<Agent>

update(string, string, Record<string, unknown>, AgentsUpdateAgentFromManifestOptionalParams)

Aggiorna l'agente da un manifesto aggiungendo una nuova versione se sono presenti modifiche alla definizione dell'agente. Se non viene apportata alcuna modifica, restituisce la versione dell'agente esistente.

function update(agentName: string, manifestId: string, parameterValues: Record<string, unknown>, options?: AgentsUpdateAgentFromManifestOptionalParams): Promise<Agent>

Parametri

agentName: string

manifestId: string

parameterValues: Record<string, unknown>

options: AgentsUpdateAgentFromManifestOptionalParams

Valori restituiti

Promise<Agent>

AgentsOperations interface

Proprietà

Metodi

Dettagli proprietà

createSession

Valore della proprietà

createVersionFromCode

Valore della proprietà

delete

Valore della proprietà

deleteSession

Valore della proprietà

deleteSessionFile

Valore della proprietà

deleteVersion

Valore della proprietà

disable

Valore della proprietà

downloadAgentCode

Valore della proprietà

downloadSessionFile

Valore della proprietà

enable

Valore della proprietà

get

Valore della proprietà

getSession

Valore della proprietà

getSessionLogStream

Valore della proprietà

getVersion

Valore della proprietà

list

Valore della proprietà

listSessionFiles

Valore della proprietà

listSessions

Valore della proprietà

listVersions

Valore della proprietà

patchAgentObject

Valore della proprietà

stopSession

Valore della proprietà

updateAgent

Valore della proprietà

uploadSessionFile

Valore della proprietà

Dettagli metodo

create(string, AgentDefinitionUnion, AgentsCreateOptionalParams)

Parametri

Valori restituiti

create(string, string, Record<string, unknown>, AgentsCreateAgentFromManifestOptionalParams)

Parametri

Valori restituiti

createVersion(string, AgentDefinitionUnion, AgentsCreateVersionOptionalParams)

Parametri

Valori restituiti

createVersion(string, string, Record<string, unknown>, AgentsCreateAgentVersionFromManifestOptionalParams)

Parametri

Valori restituiti

update(string, AgentDefinitionUnion, AgentsUpdateOptionalParams)

Parametri

Valori restituiti

update(string, string, Record<string, unknown>, AgentsUpdateAgentFromManifestOptionalParams)

Parametri

Valori restituiti