AgentsOperations interface

Begär avbokning av ett körande eller köat jobb. Returnerar 409 Konflikt om jobbet redan är i ett terminalt tillstånd.

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

Egenskapsvärde

Skapar ett optimeringsjobb och returnerar det köade jobbet. Utmärkelser Operation-Id för idempotent återprövning. Klienterna pollar URL:en genom Operation-Location att använda get-operationen.

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

Egenskapsvärde

Skapar en ny session för en agent-endpoint. Endpointen löser backingagentens version från version_indicator och upprätthåller sessionsägande med hjälp av den medföljande isoleringsnyckeln för sessionsmuterande operationer.

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

Egenskapsvärde

Skapar en ny agentversion från kod. Laddar upp postnumret och skapar en ny version för en befintlig agent. SHA-256 hex-digesten av zip-filen finns i x-ms-code-zip-sha256 headern för integritet och dedup. Begäranarkroppen är multipart/formulärdata med en JSON-metadatadel och en binär koddel (delordern är irrelevant). Maximal uppladdningsstorlek är 250 MB.

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

Egenskapsvärde

Tar bort en agent. För hostade agenter, om någon version har aktiva sessioner, avvisas begäran med HTTP 409 om force inte är satt till true. När force är sant raderas alla associerade sessioner kaskadraderade tillsammans med agenten och dess versioner.

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

Egenskapsvärde

Avbokar aktivt arbete, sedan raderar det jobbet och dess kandidatartefakter.

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

Egenskapsvärde

Tar bort en session synkront. Returnerar 204 Inget innehåll när sessionen tas bort eller inte existerar.

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

Egenskapsvärde

Tar bort den angivna filen eller katalogen från sessionsandlådan. När recursive är falsk, returnerar radering av en icke-tom katalog 409 Conflict.

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

Egenskapsvärde

Tar bort en specifik version av en agent. För hostade agenter, om versionen har aktiva sessioner, avvisas begäran med HTTP 409 om force inte är satt till true. När force är sant raderas alla sessioner kopplade till denna version kaskadraderade.

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

Egenskapsvärde

Inaktiverar den specificerade agenten, vilket förhindrar att den accepterar nya sessioner eller behandlar förfrågningar. Befintliga aktiva sessioner får tömma sig smidigt men inga nya sessioner kan skapas. Denna operation är idempotent — att inaktivera ett redan funktionsnedsatt medel ger framgång utan biverkningar.

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

Egenskapsvärde

Laddar ner postnumret för en kodbaserad hostad agent. Returnerar den tidigare uppladdade zip-filen (application/zip).

Om agent_version tillhandahålls returnerar den versionens postnummer; annars returnerar den senaste versionens postnummer.

SHA-256-digesten av de returnerade bytena matchar på content_hash den upplösta versionens code_configuration.

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

Egenskapsvärde

Laddar ner filen på den angivna sandlådesökvägen som en binär ström. Sökvägen löses i förhållande till sessionens hemkatalog.

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

Egenskapsvärde

Möjliggör den angivna agenten, vilket gör att den kan acceptera nya sessioner och behandla förfrågningar. Denna operation är idempotent — vilket möjliggör att ett redan aktiverat medel ger framgång utan biverkningar.

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

Egenskapsvärde

Uppskattar valideringsrader, per-stegs modellanropsvolymer och kostnadsband utan att skicka in jobbet.

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

Egenskapsvärde

Hämtar agenten.

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

Egenskapsvärde

Genererar Microsoft Teams-apppaketet (zip) för en Foundry-agent från den medföljande publiceringsförfrågan, utan att publicera den. Returnerar apppaketet som application/zip.

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

Egenskapsvärde

Returnerar standard- och tidigare publicerade värden som används för att förfylla i en Microsoft 365-publiceringsförfrågan för en Foundry-agent.

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

Egenskapsvärde

Hämtar en enda kandidat. Mutationsvärden inkluderas alltid.

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

Egenskapsvärde

Hämtar ett optimeringsjobb via dess identifierare.

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

Egenskapsvärde

Hämtar detaljer om en hostad agentsession via agentnamn och sessionsidentifierare.

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

Egenskapsvärde

Strömmar använder konsolloggar (stdout / stderr) för en specifik hostad agentsession som en Server-Sent Events (SSE)-ström.

Varje SSE-ram innehåller:

• event: alltid "log"
• data: en klartext-loglinje (för närvarande JSON-formaterad, men schemat är inte kontraktsmässigt och kan innehålla ytterligare nycklar eller ändra format över tid — klienter bör behandla det som en ogenomskinlig sträng)

Exempel på SSE-ramar:

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

Strömmen förblir öppen tills klienten kopplar bort eller servern avslutar anslutningen. Klienter bör hantera återanslutning vid behov.

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

Egenskapsvärde

Hämtar en specifik version av en agent.

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

Egenskapsvärde

Returnerar listan över alla agenter.

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

Egenskapsvärde

Listar kandidater för det givna optimeringsjobbet med markörpaginering, inklusive den ursprungliga baslinjen och genererade kandidater. Varje output.mutations objekt identifierar ett ändrat attribut med type; mutationsfält value utelämnas om inte klienten passerar expand=mutations.

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

Egenskapsvärde

Listar optimeringsjobb med markörpaginering och valfria status- eller agentnamnfilter.

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

Egenskapsvärde

Returnerar filer och kataloger på den angivna sökvägen i sessionsandlådan. Svaret inkluderar endast de omedelbara barnen till målkatalogen och går tillbaka till sessionens hemkatalog när ingen sökväg tillhandahålls.

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

Egenskapsvärde

Returnerar en sidad samling sessioner kopplade till den angivna agentens slutpunkt.

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

Egenskapsvärde

Returnerar listan över versioner av en agent.

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

Egenskapsvärde

Ändrar en befintlig agent.

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

Egenskapsvärde

Befordrar en kandidat till Foundry-agenten som lagras i moderjobbets målkonfiguration. Befordran är inte tillgänglig när jobbet utelämnade target_configuration. Prompt-agent-befordran skapar en ny agentversion. Host-agent-promotion registrerar för närvarande promotionsmetadata utan att distribuera en ny version med hostagent.

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

Egenskapsvärde

Publicerar en Foundry-agent till Microsoft 365 / Microsoft Teams och returnerar den publicerade titeln och Teams-app-ID:n.

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

Egenskapsvärde

Avslutar den specificerade hostade agentsessionen och returnerar 204 Inget innehåll när förfrågan lyckas.

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

Egenskapsvärde

Applicerar en merge-patch-uppdatering på den angivna agent-endpoint-konfigurationen.

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

Egenskapsvärde

Laddar upp binärt filinnehåll till den angivna sökvägen i sessionsandlådan. Tjänsten lagrar filen relativt sessionens hemkatalog och avvisar nyttolaster större än 50 MB.

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

Egenskapsvärde

Skapar agenten.

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

Parametrar

Returer

Skapar en agent från ett manifest.

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

Parametrar

Returer

Skapa en ny agentversion.

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

Parametrar

Returer

Skapa en ny agentversion från ett manifest.

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

Parametrar

Returer

Uppdaterar agenten genom att lägga till en ny version om det finns några ändringar i agentdefinitionen. Om inga ändringar görs returneras den befintliga agentversionen.

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

Parametrar

Returer

Uppdaterar agenten från ett manifest genom att lägga till en ny version om det finns några ändringar i agentdefinitionen. Om inga ändringar görs returneras den befintliga agentversionen.

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

Parametrar

Returer