AgentsOperations interface

Verzoekt annulering van een lopende of in de wachtrij staande taak. Geeft 409 Conflict terug als de taak al in een terminale toestand is.

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

Waarde van eigenschap

Maakt een optimalisatietaak aan en geeft de wachtrij terug. Eerbewijzen Operation-Id voor idempotent herkansing. Clients pollen de URL in Operation-Location door gebruik te maken van de get-operatie.

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

Waarde van eigenschap

Maakt een nieuwe sessie aan voor een agent-endpoint. Het eindpunt lost de backingagentversie op en version_indicator dwingt sessie-eigendom af met behulp van de meegeleverde isolatiesleutel voor sessiemutatiebewerkingen.

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

Waarde van eigenschap

Maakt een nieuwe agentversie aan vanuit code. Uploadt de code postcode en maakt een nieuwe versie aan voor een bestaande agent. De SHA-256 hex-digest van de zip wordt in de x-ms-code-zip-sha256 header geleverd voor integriteit en dedup. De request body bestaat uit multipart/form-data met een JSON-metadata-gedeelte en een binaire code-deel (partvolgorde is niet relevant). De maximale uploadgrootte is 250 MB.

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

Waarde van eigenschap

Hiermee verwijdert u een agent. Voor gehoste agenten, als een versie actieve sessies heeft, wordt het verzoek afgewezen met HTTP 409, tenzij force het op true is gezet. Wanneer force waar is, worden alle bijbehorende sessies samen met de agent en zijn versies gecascade-verwijderd.

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

Waarde van eigenschap

Active-werk annuleert, en verwijdert vervolgens de baan en de artefacten van de kandidaat.

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

Waarde van eigenschap

Verwijdert een sessie synchroon. Retournert 204 Geen inhoud wanneer de sessie is verwijderd of niet bestaat.

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

Waarde van eigenschap

Verwijdert het opgegeven bestand of de map uit de sessiesandbox. Wanneer recursive is false, geeft het verwijderen van een niet-lege map 409 Conflict terug.

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

Waarde van eigenschap

Hiermee verwijdert u een specifieke versie van een agent. Voor gehoste agenten, als de versie actieve sessies heeft, wordt het verzoek afgewezen met HTTP 409, tenzij force het op true is gezet. Wanneer force waar is, worden alle sessies die aan deze versie zijn gekoppeld gecascade-verwijderd.

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

Waarde van eigenschap

Schakelt de opgegeven agent uit, waardoor deze geen nieuwe sessies accepteert of verzoeken verwerkt. Bestaande actieve sessies mogen soepel aflopen, maar er kunnen geen nieuwe sessies worden aangemaakt. Deze operatie is idempotent — het uitschakelen van een al uitgeschakeld middel levert succes op zonder bijwerkingen.

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

Waarde van eigenschap

Download de code-zip voor een code-gebaseerde gehoste agent. Retourneert de eerder geüploade zipcode (application/zip).

Als agent_version is geleverd, wordt de postcode van die versie teruggegeven; anders wordt de postcode van de nieuwste versie teruggegeven.

De SHA-256-digest van de teruggestuurde bytes komt overeen met die content_hash op de opgeloste versie van code_configuration.

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

Waarde van eigenschap

Downloadt het bestand op het opgegeven sandboxpad als een binaire stroom. Het pad wordt opgelost ten opzichte van de sessie-homemap.

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

Waarde van eigenschap

Maakt de opgegeven agent mogelijk, zodat deze nieuwe sessies kan accepteren en verzoeken kan verwerken. Deze operatie is idempotent — waardoor een reeds ingeschakelde agent succes oplevert zonder bijwerkingen.

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

Waarde van eigenschap

Schattingen validatie-setrijen, per-stage modelaanroepvolumes en kostenbanden zonder de opdracht in te dienen.

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

Waarde van eigenschap

Haalt de agent op.

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

Waarde van eigenschap

Genereert het Microsoft Teams app-pakket (zip) voor een Foundry-agent uit het meegeleverde publicatieverzoek, zonder het te publiceren. Retourneert het app-pakket als application/zip.

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

Waarde van eigenschap

Geeft standaard- en eerder gepubliceerde waarden terug die zijn gebruikt om een Microsoft 365 publicatieverzoek voor een Foundry-agent vooraf in te vullen.

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

Waarde van eigenschap

Een enkele kandidaat wordt opgehaald. Mutatiewaarden worden altijd meegenomen.

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

Waarde van eigenschap

Haalt een optimalisatietaak op via de identifier.

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

Waarde van eigenschap

Haalt de details van een gehoste agentsessie op via agentnaam en sessie-identificatie.

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

Waarde van eigenschap

Streams consolelogs (stdout / stderr) voor een specifieke gehoste agentsessie als een Server-Sent Events (SSE) stream.

Elk SSE-frame bevat:

• event: altijd "log"
• data: een platte loglijn (momenteel JSON-opgemaakt, maar het schema is niet contractueel en kan extra sleutels bevatten of het formaat in de loop van de tijd wijzigen — clients moeten het behandelen als een ondoorzichtige string)

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

De stream blijft open totdat de client de verbinding verbreekt of de server de verbinding beëindigt. Klanten moeten de herverbinding indien nodig regelen.

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

Waarde van eigenschap

Haalt een specifieke versie van een agent op.

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

Waarde van eigenschap

Geeft de lijst met alle agenten terug.

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

Waarde van eigenschap

Geeft een lijst van kandidaten voor de gegeven optimalisatietaak met cursor-paginering, inclusief de oorspronkelijke baseline en gegenereerde kandidaten. Elk output.mutations item identificeert een gewijzigd attribuut door ; typemutatievelden value worden weggelaten tenzij de client .expand=mutations

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

Waarde van eigenschap

Lijst optimalisatietaken met cursor-paginering en optionele status- of agentnaamfilters.

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

Waarde van eigenschap

Retourneert bestanden en mappen op het opgegeven pad in de sessiesandbox. De respons bevat alleen de directe kinderen van de doelmap en schakelt standaard terug naar de sessie-homemap wanneer er geen pad wordt opgegeven.

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

Waarde van eigenschap

Geeft een gepagineerde verzameling sessies terug die gekoppeld zijn aan het opgegeven agent-eindpunt.

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

Waarde van eigenschap

Retourneert de lijst met versies van een agent.

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

Waarde van eigenschap

Hiermee wijzigt u een bestaande agent.

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

Waarde van eigenschap

Bevordert een kandidaat tot de Foundry-agent die is opgeslagen in de doelconfiguratie van de hoofdfunctie. Promotie is niet mogelijk als de functie target_configuration heeft weggelaten. Prompt-agent promotie creëert een nieuwe agentversie. Hosted-agent promotie registreert momenteel promotiemetadata zonder een nieuwe versie van gehoste agenten uit te rollen.

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

Waarde van eigenschap

Publiceert een Foundry-agent naar Microsoft 365 / Microsoft Teams en geeft de gepubliceerde titel en Teams-app-id's terug.

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

Waarde van eigenschap

Beëindigt de gespecificeerde sessie van de gehoste agent en geeft 204 Geen Inhoud terug wanneer het verzoek succesvol is.

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

Waarde van eigenschap

Past een merge-patch update toe op de opgegeven agent-endpointconfiguratie.

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

Waarde van eigenschap

Uploadt binaire bestandsinhoud naar het opgegeven pad in de sessiesandbox. De service slaat het bestand op ten opzichte van de sessie-thuismap en weigert payloads groter dan 50 MB.

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

Waarde van eigenschap

Hiermee maakt u de agent.

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

Parameters

Retouren

Maakt een agent van een manifest.

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

Parameters

Retouren

Maak een nieuwe agentversie.

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

Parameters

Retouren

Maak een nieuwe agentversie op basis van een manifest.

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

Parameters

Retouren

Werkt de agent bij door een nieuwe versie toe te voegen als er wijzigingen zijn in de agentdefinitie. Als er geen wijzigingen zijn, wordt de bestaande agentversie geretourneerd.

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

Parameters

Retouren

Hiermee werkt u de agent bij vanuit een manifest door een nieuwe versie toe te voegen als er wijzigingen in de agentdefinitie zijn. Als er geen wijzigingen zijn, wordt de bestaande agentversie geretourneerd.

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

Parameters

Retouren