AgentsOperations interface

Fordert die Einstellung eines laufenden oder in der Warteschlange laufenden Jobs an. Gibt 409 Konflikt zurück, wenn der Job bereits im terminalen Zustand ist.

cancelOptimizationJob: (jobId: string, options?: AgentsCancelOptimizationJobOptionalParams) => Promise<AgentOptimizationJob>

Eigenschaftswert

Erstellt einen Optimierungsauftrag und gibt den Warteschlangenauftrag zurück. Auszeichnung Operation-Id für Idempotent-Retry. Clients suchen die URL mit Operation-Location der Get-Operation ab.

createOptimizationJob: (job: AgentOptimizationJob, options?: AgentsCreateOptimizationJobOptionalParams) => JobPoller<AgentOptimizationJobResult>

Eigenschaftswert

Erstellt eine neue Sitzung für einen Agent-Endpunkt. Der Endpunkt löst die Backing-Agent-Version aus und version_indicator erzwingt den Sitzungsbesitz mit dem bereitgestellten Isolationsschlüssel für sitzungsmutierende Operationen.

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

Eigenschaftswert

Erstellt eine neue Agentenversion aus dem Code. Lädt die Postleitzahl hoch und erstellt eine neue Version für einen bestehenden Agenten. Das SHA-256-Hex-Digest der Zip wird im x-ms-code-zip-sha256 Header für Integrität und Dedup bereitgestellt. Der Anforderungskörper besteht aus Multipart-/Formulardaten mit einem JSON-Metadaten-Teil und einem Binärcode-Teil (Teilereihenfolge ist irrelevant). Die maximale Upload-Größe beträgt 250 MB.

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

Eigenschaftswert

Löscht einen Agent. Bei gehosteten Agenten wird die Anfrage mit HTTP 409 abgelehnt, wenn eine Version aktive Sitzungen hat, es sei denn force , sie ist auf true gesetzt. Wenn Force wahr ist, werden alle zugehörigen Sitzungen zusammen mit dem Agenten und seinen Versionen kaskadenartig gelöscht.

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

Eigenschaftswert

Er hebt aktive Arbeit ab, dann löscht er den Job und seine Kandidatenartefakte.

deleteOptimizationJob: (jobId: string, options?: AgentsDeleteOptimizationJobOptionalParams) => Promise<void>

Eigenschaftswert

Löscht eine Sitzung synchron. Gibt 204 Kein Inhalt zurück, wenn die Sitzung gelöscht wird oder nicht existiert.

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

Eigenschaftswert

Löscht die angegebene Datei oder das Verzeichnis aus der Sitzungs-Sandbox. Wenn recursive falsch ist, ergibt das Löschen eines nicht leeren Verzeichnisses 409 Conflict.

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

Eigenschaftswert

Löscht eine bestimmte Version eines Agenten. Bei gehosteten Agenten wird die Anfrage mit HTTP 409 abgelehnt, wenn die Version aktive Sitzungen hat, es sei denn force , sie ist auf true gesetzt. Wenn Force wahr ist, werden alle mit dieser Version verbundenen Sitzungen kaskadenlöscht.

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

Eigenschaftswert

Deaktiviert den angegebenen Agenten und verhindert, dass er neue Sitzungen annimmt oder Anfragen verarbeitet. Bestehende aktive Sitzungen dürfen elegant entleeren, aber keine neuen Sitzungen können erstellt werden. Diese Operation ist idempotent – das Deaktivieren eines bereits deaktivierten Wirkstoffs bringt Erfolg ohne Nebenwirkungen.

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

Eigenschaftswert

Lädt die Postleitzahl für einen codebasierten gehosteten Agenten herunter. Gibt die zuvor hochgeladene Postnummer zurück (application/zip).

Wenn agent_version angegeben ist, gibt die Postleitzahl dieser Version zurück; ansonsten gibt sie die Postleitzahl der neuesten Version zurück.

Der SHA-256-Digest der zurückgegebenen Bytes stimmt mit dem content_hash auf der aufgelösten Version überein code_configuration.

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

Eigenschaftswert

Lädt die Datei auf dem angegebenen Sandbox-Pfad als Binärstrom herunter. Der Pfad wird relativ zum Sitzungs-Home-Verzeichnis aufgelöst.

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

Eigenschaftswert

Ermöglicht den angegebenen Agenten, sodass er neue Sitzungen akzeptieren und Anfragen verarbeiten kann. Diese Operation ist idempotent – sie ermöglicht es einem bereits aktivierten Agenten, erfolgreich ohne Nebenwirkungen zu erzielen.

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

Eigenschaftswert

Schätzungen von Validationsset-Zeilen, pro-Stufen-Modellaufrufvolumina und Kostenbänder, ohne den Auftrag einzureichen.

estimateOptimizationJob: (inputs: AgentOptimizationEstimateInputs, options?: AgentsEstimateOptimizationJobOptionalParams) => Promise<AgentOptimizationEstimateResult>

Eigenschaftswert

Ruft den Agenten ab.

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

Eigenschaftswert

Generiert das Microsoft Teams-App-Paket (zip) für einen Foundry-Agenten aus der bereitgestellten Veröffentlichungsanfrage, ohne es zu veröffentlichen. Das App-Paket wird als . application/zipzurückgeschickt.

getMicrosoft365Package: (agentName: string, publishScope: Microsoft365PublishScope, options?: GetMicrosoft365PackageOptionalParams) => Promise<GetMicrosoft365PackageResponse>

Eigenschaftswert

Gibt Standard- und zuvor veröffentlichte Werte zurück, die zum Vorausfüllen einer Microsoft 365-Veröffentlichungsanfrage für einen Foundry-Agenten verwendet wurden.

getMicrosoft365PublishDefaults: (agentName: string, options?: GetMicrosoft365PublishDefaultsOptionalParams) => Promise<Microsoft365PublishDefaults>

Eigenschaftswert

Holt einen einzelnen Kandidaten ab. Mutationswerte sind immer enthalten.

getOptimizationCandidate: (jobId: string, candidateId: string, options?: AgentsGetOptimizationCandidateOptionalParams) => Promise<AgentOptimizationCandidate>

Eigenschaftswert

Ruft einen Optimierungsauftrag anhand seines Identifikators ab.

getOptimizationJob: (jobId: string, options?: AgentsGetOptimizationJobOptionalParams) => Promise<AgentOptimizationJob>

Eigenschaftswert

Ruft die Details einer gehosteten Agentensitzung anhand von Agentennamen und Sessionskennung ab.

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

Eigenschaftswert

Streamt Konsolenprotokolle (stdout / stderr) für eine bestimmte gehostete Agentensitzung als Server-Sent Events (SSE) Stream.

Jeder SSE-Rahmen enthält:

• event: Immer "log"
• data: eine Klartext-Logzeile (derzeit JSON-formatiert, aber das Schema ist nicht vertraglich und kann zusätzliche Schlüssel enthalten oder das Format im Laufe der Zeit ändern – Clients sollten sie als undurchsichtige Zeichenkette behandeln)

Beispiel-SSE-Frames:

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"}

Der Strom bleibt offen, bis der Client die Verbindung trennt oder der Server die Verbindung beendet. Clients sollten die Wiederanbindung bei Bedarf übernehmen.

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

Eigenschaftswert

Ruft eine bestimmte Version eines Agenten ab.

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

Eigenschaftswert

Gibt die Liste aller Agenten zurück.

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

Eigenschaftswert

Listet Kandidaten für die gegebene Optimierungsstelle mit Cursor-Paginierung auf, einschließlich der ursprünglichen Basislinie und generierten Kandidaten. Jedes output.mutations Element identifiziert ein geändertes Attribut durch ; typeMutationsfelder value werden weggelassen, es sei denn, der Client übergibt expand=mutations.

listOptimizationCandidates: (jobId: string, options?: AgentsListOptimizationCandidatesOptionalParams) => PagedAsyncIterableIterator<AgentOptimizationCandidate, AgentOptimizationCandidate[], PageSettings>

Eigenschaftswert

Listet Optimierungsaufträge mit Cursor-Paginierung und optionalen Status- oder Agentennamen-Filtern auf.

listOptimizationJobs: (options?: AgentsListOptimizationJobsOptionalParams) => PagedAsyncIterableIterator<AgentOptimizationJob, AgentOptimizationJob[], PageSettings>

Eigenschaftswert

Gibt Dateien und Verzeichnisse auf dem angegebenen Pfad im Sitzungssandbox zurück. Die Antwort enthält nur die unmittelbaren Kinder des Zielverzeichnisses und setzt standardmäßig auf das Sitzungs-Home-Verzeichnis, wenn kein Pfad bereitgestellt wird.

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

Eigenschaftswert

Gibt eine pagedierte Sammlung von Sitzungen zurück, die mit dem angegebenen Agenten-Endpunkt zugeordnet sind.

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

Eigenschaftswert

Gibt die Liste der Versionen eines Agenten zurück.

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

Eigenschaftswert

Ändert einen vorhandenen Agent.

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

Eigenschaftswert

Befördert einen Kandidaten zum Foundry-Agenten, der in der Zielkonfiguration des Hauptjobs gespeichert ist. Eine Beförderung ist nicht möglich, wenn die Stelle target_configuration ausgelassen hat. Die Prompt-Agenten-Beförderung schafft eine neue Agentenversion. Die Promotion für gehostete Agenten erfasst derzeit Metadaten der Promotion, ohne eine neue Version des gehosteten Agenten bereitzustellen.

promoteOptimizationCandidate: (jobId: string, candidateId: string, options?: AgentsPromoteOptimizationCandidateOptionalParams) => Promise<AgentOptimizationCandidate>

Eigenschaftswert

Veröffentlicht einen Foundry-Agenten für Microsoft 365 / Microsoft Teams und gibt den veröffentlichten Titel sowie die Teams-App-IDs zurück.

publishToMicrosoft365: (agentName: string, publishScope: Microsoft365PublishScope, options?: PublishToMicrosoft365OptionalParams) => Promise<Microsoft365PublishResponse>

Eigenschaftswert

Beendet die angegebene gehostete Agentensitzung und gibt 204 No Content zurück, wenn die Anfrage erfolgreich ist.

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

Eigenschaftswert

Führt ein Merge-Patch-Update auf die spezifizierte Agent-Endpunktkonfiguration an.

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

Eigenschaftswert

Lädt binäre Dateiinhalte auf den angegebenen Pfad in der Sitzungssandbox hoch. Der Dienst speichert die Datei relativ zum Sitzungs-Home-Verzeichnis und lehnt Payloads größer als 50 MB ab.

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

Eigenschaftswert

Erstellt den Agent.

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

Parameter

Gibt zurück

Erstellt einen Agent aus einem Manifest.

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

Parameter

Gibt zurück

Erstellen Sie eine neue Agentversion.

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

Parameter

Gibt zurück

Erstellen Sie eine neue Agent-Version aus einem Manifest.

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

Parameter

Gibt zurück

Aktualisiert den Agent, indem eine neue Version hinzugefügt wird, wenn Änderungen an der Agentendefinition vorgenommen werden. Wenn keine Änderungen vorgenommen werden, wird die vorhandene Agent-Version zurückgegeben.

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

Parameter

Gibt zurück

Aktualisiert den Agent aus einem Manifest, indem eine neue Version hinzugefügt wird, wenn Änderungen an der Agentdefinition vorhanden sind. Wenn keine Änderungen vorgenommen werden, wird die vorhandene Agent-Version zurückgegeben.

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

Parameter

Gibt zurück