@azure/ai-projects package

Huvudklienten för AIProjectClient

Ett fel uppstod vid förvärvet av en Microsoft Entra-åtkomsttoken.

Ett fel som väcks av WebSocket-anslutningen.

Ett fel uppstår när ett WebSocket-meddelande inte stämmer överens med röstagentprotokollet.

Klient för att etablera realtidssessioner med hanterade Foundry-röstagenter.

Basfelet väcks av Voice Agents realtidsklient.

En agent som implementerar A2A-protokollet.

Ett A2A-verktyg förvarat i en verktygslåda.

Konfiguration specifik för A2A-protokollet.

En agent som implementerar A2A-protokollet.

Ett A2A-verktyg förvarat i en verktygslåda.

Valfria parametrar för klienten.

En resurs för AI-sökindex.

Konfiguration specifik för aktivitetsprotokollet.

modellgränssnittsagent

modellgränssnitt AgentBlueprintReference

modellgränssnitt AgentCard

modellgränssnitt AgentCardSkill

Insikter om resultaten av agentutvärderingen

Insikter från agentklusteranalysen.

Agentkälla för datagenereringsjobb — refererar till en agent för att hämta instruktioner och metadata från.

Basdefinitionsgränssnitt för agenter. Innehåller agenttypen och valfri RAI-konfiguration.

modellgränssnitt AgentEndpointAuthorizationScheme

modellgränssnitt AgentEndpointConfig

Agentkälla för utvärderargenereringsjobb — refererar till en agent för att hämta instruktioner och metadata från.

(Förhandsvisning) En hanterad runtime och agentloop som används för att köra en promptagent.

modellgränssnittet AgentIdentity

Ett kvarstående problem upptäckt genom en agents spår.

Ytterligare insiktsdetaljer. Utelämnas om inte detaljer efterfrågas.

Uppskattad kostnad för Agent Insights.

Ett markerat spår som ger bevis för en agentinsikt.

Ett JSON-objekt som används i Agent Insights-payloads.

En lättviktig spårreferens kopplad till en agents insikt som stödjande bevis.

En agent Insights-monitor per agent som äger konfiguration, kör och upptäckta insikter.

Fält accepteras vid skapandet av en Agent Insights-monitor för en agent.

En Agent Insights-monitoröversikt returnerad av listoperationer.

Fält som kan uppdateras på en Agent Insights-monitor.

En rekommenderad lösning för en agentinsikt.

En kundrenderbar ändring i en föreslagen lösning.

Den rekommenderade åtgärden för en agent insikt.

En långvarig serie som analyserar en agents spår och uppdaterar agentens insikter.

Indata som används vid skapandet av en agent insight kör.

Resultatstatistik som produceras när en agent insiktskörning lyckas.

Strukturerad anledning till varför schemalagd produktion är avstängd för en övervakare.

Tokenanvändning för en Agent Insights-körning.

Fält som kan uppdateras vid en agents insight.

Den effektiva översikten för en Agent Insights-övervakare.

En användargiven översikt som träder i kraft omedelbart och sår nästa generation.

Kandidatresultat som produceras av ett agentoptimeringsjobb.

Caller-tillhandahållna baslinjeagentvärden som inte kan lösas från målagenten.

En kandidat genererad av ett optimeringsjobb.

Jämförande utvärderingssammanfattning för en kandidat.

Baskandidatresultat. Jobbtyper definierar härledda utdatamodeller med sina egna fält.

Befordringsmetadata registrerad för en kandidat.

Kandidatsökningsinställningar.

Konfiguration för att optimera en agent för uppmätt kvalitet.

Basmodell för typspecifik optimeringskonfiguration.

Uppskattad ekonomisk kostnad. Finns endast när minst en bidragande modell har prissättningsdata.

Ett lågt/typiskt/takintervall för en uppskattad kvantitet. Förväntade värden kan vara fraktionerade, inklusive uppskattade antal modellanrop.

Indata för att uppskatta ett agentoptimeringsjobb.

Resultatet returnerades vid uppskattning av ett agentoptimeringsjobb.

Återanvändbar kvalitetsmätningskonfiguration.

Bas-diskriminerad modell för en optimeringsutvärderingsuppsättning.

Referens till en namngiven utvärderare, valfritt fäst på en version.

Identifierar Foundry-agenten som äger konfigurationen som optimeras.

Instruktioner mutation.

Agent optimeringsjobbresurs — ett långvarigt jobb som ger kandidatändringar i en Foundry-agentkonfiguration.

Genomsnittlig latens för ett optimeringssteg och modell.

Partiellt eller terminalt resultat som produceras av ett agentoptimeringsjobb.

Aggregerad tokenanvändning för ett optimeringssteg och modell.

Identifierar en modell som används av ett optimerings- eller utvärderingssteg.

Modellmutation.

Baskandidatmutation.

Kandidatresultat som produceras av ett promptoptimeringsjobb.

Sammanfattning av kandidater som producerats av ett agentoptimeringsjobb.

En färdighet i den manuellt tillhandahållna agentoptimeringsytan.

Färdighetsmutationer.

Agentattributen och alternativa värden som finns tillgängliga för en agentoptimeringssökning.

Uppskattade värden grupperade efter optimeringssteg.

Baskälla för en måluppfyllande optimeringsutvärderingsuppsättning.

Refererar till en explicit versionserad registrerad Foundry-dataset för utvärdering av måluppfyllelse.

Utvärderingsset innehåller oberoende ingångar med ett enda varv.

Tillhandahåller envarvsrader direkt i optimeringsbegäran.

En enda punkt i en inline-utvärderingsuppsättning.

Basmålskonfiguration för ett optimeringsjobb.

Verktygsmutationer.

Baskälla för en utvärderingssats för användarsamtalssimulering.

Refererar till en explicit versionsbaserad registrerad Foundry-dataset för utvärdering av användarkonversationssimulering.

Utvärderingsset innehåller scenarier för simulerade samtal.

Tillhandahåller Evals testfall för användarkonversationssimulering direkt i optimeringsförfrågan.

modellgränssnitt AgentReference

En agentsession som ger en långlivad beräkningssandlåda för hostade agentanrop.

Indatakonfiguration för utvärderingstaxonomin när indatatypen är agent.

Representerar en specifik version av en agent. Innehåller metadata, versionshantering, skapandetid och agentdefinition.

Definition av autentiseringsuppgifter för agentidentitet

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Gränssnitt som representerar en agents åtgärder.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Felsvar för API-fel.

Definition av API-nyckelautentiseringsuppgifter

Tillåter assistenten att skapa, radera eller uppdatera filer med enhetliga diffar.

modellgränssnitt ApproximateLocation

Artefaktprofil för modellen

Konfiguration för en kodtolkarcontainer. Du kan också ange ID:t för de filer som koden ska köras på.

Representerar ett mål som specificerar en Azure AI-agent.

Representerar ett mål som specificerar en Azure AI-modell för operationer som kräver modellval.

Azure AI-sökning indexdefinition

Indatadefinitionsinformationen för ett Azure AI-sökverktyg som används för att konfigurera en agent.

En uppsättning indexresurser som används av verktyget azure_ai_search.

Ett Azure AI-sökning-verktyg lagrat i en verktygslåda.

Konfigurationsalternativ för agentens slutpunkt för getOpenAIClient-metoden. Används främst för hostade agenter.

Strukturen för att behålla storage könamn och URI.

Definitionen av Azure-funktionen.

Strukturen för att behålla storage könamn och URI.

Indatadefinitionsinformationen för ett Azure Function Tool, som används för att konfigurera en agent.

Azure Konfiguration av OpenAI-modell. API-versionen väljs av tjänsten för att fråga modellen.

En basklass för autentiseringsuppgifter för anslutning

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Gränssnitt som representerar en BetaAgentInsightMonitors operationer.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Verksamhet för hantering av agenter.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Gränssnitt som representerar en BetaEvaluationTaxonomies-operation.

Valfria parametrar.

Valfria parametrar.

Operationer för BetaEvaluatorsOperations.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Gränssnitt som representerar en BetaInsights-operation.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Gränssnitt som representerar en BetaMemoryStores-operation.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Alternativ för create-metoden som laddar upp lokala filer och registrerar en modellversion.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Gränssnitt som representerar BetaModels-operationer.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Gränssnitt som representerar en betaoperation.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Gränssnitt som representerar BetaRedTeams-operationer.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Gränssnitt som representerar en BetaRoutines-operation.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Gränssnitt som representerar en BetaSchedules-operation.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Gränssnitt som representerar BetaSkills-operationer.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Drift för hantering av röstsamtal mellan agenter.

Drift för hantering av röstagentsamtal och telefoni.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Drift för hantering av röstagenttelefoni.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

En bing anpassad sökkonfiguration.

Information om indatadefinitionen för ett Bing anpassat sökverktyg som används för att konfigurera en agent.

Parametrarna för det bing anpassade sökverktyget.

Sökkonfiguration för Bing grounding

Parametrarna för bing grundsökningsverktyg.

Information om indatadefinitionen för ett bing grundsökningsverktyg som används för att konfigurera en agent.

Information om blobreferens.

modellgränssnitt BotServiceAuthorizationScheme

modellgränssnitt BotServiceRbacAuthorizationScheme

modellgränssnitt BotServiceTenantAuthorizationScheme

Information om indatadefinitionen för ett webbläsarautomatiseringsverktyg, som används för att konfigurera en agent.

Ett webbläsarautomatiseringsverktyg lagrat i en verktygslåda.

Information om indatadefinitionen för ett webbläsarautomatiseringsverktyg, som används för att konfigurera en agent.

Definition av indataparametrar för anslutningen som används av Browser Automation Tool.

Definition av inmatningsparametrar för Browser Automation Tool.

Ett webbläsarautomatiseringsverktyg lagrat i en verktygslåda.

Ett verktyg för att fånga strukturerade resultat

Koordinater för analysdiagrammet.

Ett funktionsverktyg som kan användas för att generera ett svar.

Ett minnesobjekt som innehåller en sammanfattning som extraherats från konversationer.

Insikter från klusteranalysen.

Tokenanvändning för klusteranalys

Kodbaserad utvärderardefinition med hjälp av python-kod

Kodbaserad distributionskonfiguration för en hostad agent.

Ett verktyg som kör Python-kod för att hjälpa till att generera ett svar på en prompt.

Ett kodtolkverktyg lagrat i en verktygslåda.

Ett filter som används för att jämföra en angiven attributnyckel med ett angivet värde med hjälp av en definierad jämförelseåtgärd.

Kombinera flera filter med and eller or.

Ett verktyg som styr en virtuell dator. Läs mer om datorverktyget.

Ett verktyg som styr en virtuell dator. Läs mer om datorverktyget.

Åtgärder för svar från listan och hämta anslutningar

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Gränssnitt som representerar en anslutningsåtgärd.

modellgränssnittet ContainerAutoParam

Containerbaserad distributionskonfiguration för en hostad agent.

modellgränssnitt ContainerNetworkPolicyAllowlistParam

modellgränssnitt ContainerNetworkPolicyDisabledParam

modellgränssnitt ContainerNetworkPolicyDomainSecretParam

Nätverksåtkomstpolicy för containern.

modellgränssnitt ContainerSkill

Åtgärd för utvärderingsregel för kontinuerlig utvärdering.

Definition av CosmosDB Vector Store-index

Multiparts begäranspråk för att uppdatera eller versionsanpassa en kodbaserad agent (POST /agents/{name} och POST /agents/{name}/versions).

JSON-metadata för kodbaserade agentoperationer (skapa, uppdatera, skapa version). Agentnamnet kommer från URL-vägens parameter eller x-ms-agent-name headern, så det ingår inte i denna modell. Innehållshashen (SHA-256 i zip-adressen) bärs i x-ms-code-zip-sha256 headern.

Multipart request body för att skapa en färdighetsversion från filer. Accepterar antingen en enda zip-fil eller flera individuella färdighetsfiler (kataloguppladdning). För zip-uppladdningar extraherar och validerar servern innehållet. Vid kataloguppladdningar valideras filer as-is.

Begäran om att skapa en Microsoft Teams Phone Extension-bindning.

Begäran om att skapa en telefonbindning.

En förfrågan om att skapa ett varaktigt direkt utgående samtalsjobb.

Statistik för tokenanvändning för förfrågan.

Begäran om att skapa en Twilio-bindning.

Cron-baserad utlösare.

Definition av anpassade autentiseringsuppgifter

En grammatik definierad av användaren.

En anpassad händelserutin-trigger.

Obegränsad fri text.

Ett anpassat verktyg som bearbetar indata med ett specificerat format. Läs mer om anpassade verktyg

Inmatningsformatet för det anpassade verktyget. Standard är obegränsad text.

Dagligt upprepningsschema.

Datagenereringsresurs.

Konfiguration för att hantera datagenereringsjobb.

Anroparens indata för ett datagenereringsjobb.

Utdata information för ett datagenereringsjobb.

Resultatet som produceras av ett framgångsrikt datagenereringsjobb.

Baskällmodellen för datagenereringsjobb.

LLM-modelleringsalternativ för datagenereringsjobb.

Tokenanvändningsinformation för ett datagenereringsjobb.

Representerar en referens till en blob för förbrukning

Dataset outputar för ett datagenereringsjobb.

Datasetkälla för utvärderargenereringsjobb — referens till en datamängd.

Referens till en versionerad Foundry Dataset.

DatasetVersionsdefinition

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Gränssnitt som representerar en Datasets-operation.

Valfria parametrar.

Ett borttaget agentobjekt

Ett borttaget agentversionsobjekt

Svar för att ha raderat ett minnesobjekt från en minneslagring.

modellgränssnitt DeleteMemoryStoreResponse

En borttagen färdighet.

En borttagen färdighetsversion.

Definition av modelldistribution

Valfria parametrar.

Valfria parametrar.

Gränssnitt som representerar en distributionsåtgärd.

En enda dimension — en oberoende, mätbar kvalitetsdimension inom en bedömningsmatrisbedömares poängplan.

Identifierare returneras efter att en rutinmässig dispatch har köats.

Konfigurationsklass för inbäddning

modellgränssnittet EmptyModelParam

Definition av endpoint-baserad utvärderare. Kunden äger och är värd för en HTTP-endpoint som implementerar utvärderingskontraktet. Utvärderaren refererar till en Project Connection med namn; anslutningen lagrar slutpunktens URL och inloggningsuppgifter (API-nyckel eller Entra ID). Vid exekveringstillfället löser tjänsten anslutningen för att erhålla slutpunktens URL och autentiseringsdetaljer, och anropar sedan slutpunkten för varje utvärderingsrad.

modellgränssnitt EntraAuthorizationScheme

Entra ID-legitimationsdefinition

modellgränssnitt Felmodell

Resultat av utvärderingen.

Metrisk jämförelse för en behandling mot baslinjen.

Jämförelseresultat för behandling körs mot baslinjen.

Sammanfattande statistik för ett mått i en utvärderingskörning.

Konfigurerar en Azure-standard neural röst som används för att konvertera text till tal för utvärdering via Voice Live-endpointen.

Begäran om utvärderingsjämförelse

Insikter från utvärderingsjämförelsen.

Jobbresurs för generering av utvärderingsdata.

Indata som anroparen tillhandahåller för ett uppdrag för att generera utvärderingsdata.

Dataset-utdatakonfiguration för ett utvärderingsdatagenereringsjobb.

Konfigurerar modellen som spelar den simulerade användaren. Denna modell är separat från den utvärderade target.

Ett exempel från utvärderingsresultatet.

Modell för utvärderingsregel.

Åtgärdsmodell för utvärdering.

Modell för utvärderingsfilter.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Gränssnitt som representerar en EvaluationRules-åtgärd.

Insikter om uppsättningen av utvärderingsresultat

Insikter från utvärderingen kör klusteranalys.

Utvärderingsuppgift för schemat.

Basklass för mål med stöd för diskriminator.

Definition av taxonomi för utvärdering

Indatakonfiguration för utvärderingstaxonomin.

Röstkonfiguration används för att konvertera text till tal för utvärdering via Voice Live-endpointen.

Begär att organet får utvärderarbehörighet

Konfiguration av basutvärderare med diskriminator

Tjänstehanterade proveniensartefakter som produceras av ett utvärderargenereringsjobb. Finns endast på EvaluatorVersionsresurser skapade via genereringspipelinen. Den kombinerade JSONL Foundry Dataset är skrivskyddad och löses till en versionerad datamängd i ett tjänstereserverat namnrymd.

Indata från uppringaren för ett utvärderargenereringsjobb.

Resurs för Utvärderargenerering av jobb — ett långvarigt jobb som genererar bedömningskriterier baserade på bedömningskriterier från källmaterial. Vid framgång blir resultatet den persisterade EvaluatorVersion.

Basmodellen för utvärderargenereringsjobb. Polymorf över type.

Sammanfattning av tokenförbrukning för ett utvärderargenereringsjobb. Fylls när jobbet når ett terminalt tillstånd.

Utvärderare Metriska mått

Definition av utvärderare

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Operationer för utvärderareOperationer.

Valfria parametrar.

Definitionen av extern agent. Representerar en tredjepartsagent som hostas utanför Foundry (till exempel på GCP eller AWS). Registrering är endast metadata: Foundry registrerar agentens definition för att lysa upp observerbarhetsupplevelser (spår, utvärderingar) över kundgenererade OpenTelemetri-data.

Parametrarna för verktyget för infrastrukturdataagenten.

Ett FabricIQ-serverside-verktyg.

Ett FabricIQ-verktyg förvarat i en verktygslåda.

Konfigurationsklass för fältmappning

Azure OpenAI-filutdata för ett datagenereringsjobb.

Filkälla för datagenereringsjobb — Azure OpenAI filinmatning.

FilDatasetVersionsdefinition

Ett verktyg som söker efter relevant innehåll från uppladdade filer. Läs mer om filsökningsverktyget.

Ett filsökverktyg lagrat i en verktygslåda.

modellgränssnitt FixedRatioVersionSelectionRule

FilDatasetVersionsdefinition

En varning kopplad till en modell.

modellgränssnitt FunctionObject

Parametrarna som funktionerna accepterar, som beskrivs som ett JSON-schemaobjekt. Se guiden för exempel och JSON-schemareferensen för dokumentation om formatet. Om du utelämnar parameters definieras en funktion med en tom parameterlista.

Ett verktyg som låter modellen utföra skalkommandon.

modellgränssnitt FunktionShellToolParamEnvironment

modellgränssnitt FunktionShellToolParamEnvironmentContainerReferenceParam

modellgränssnitt FunktionShellToolParamEnvironmentLocalEnvironmentParam

Definierar en funktion i din egen kod som modellen kan välja att anropa. Läs mer om funktionsanrop.

modellgränssnittet FunctionToolParam

Alternativ för att konfigurera GenAI-spårning på en specifik AIProjectClient-instans.

Skicka dessa under nyckeln tracingOptions AIProjectClientOptionalParams för att aktivera GenAI-spårning när klienten instansieras. Varje klientinstans upprätthåller sin egen oberoende spårningskonfiguration.

Indata för att generera en röstagent. Endast kind och name är alltid obligatoriska. Författartjänsten expanderar dessa indata till en fullständig, redigerbar VoiceAgentDefinition, som sedan skapas genom POST /agents. De genererade instructions och ljud-/röstinställningarna lagras som separata fält i den resulterande agentdefinitionen, så att uppringaren kan redigera eller åsidosätta någon av dem via standardversionshantering.

Valfria parametrar.

Valfria parametrar.

(Förhandsvisning) GitHub Copilot hanterade harness för promptagenter.

En möjliggörande överskrivning för ett GitHub Copilot-inbyggt verktyg.

Standardinställningen för aktivering av GitHub Copilot inbyggda verktyg.

(Förhandsgranskning) Konfigurationsöverskrivningar för GitHub Copilot inbyggda verktyg.

En rutinutlösare för GitHub-problem.

Headerbaserad hemlig autentisering för en telemetri-endpoint. Det upplösta hemlighetsvärdet injiceras som en HTTP-header.

Definitionen av den värdbaserade agenten.

Schema för upprepning per timme.

Utvärderingsregelåtgärd för mänsklig utvärdering.

modellgränssnitt HybridSearchOptions

Ett verktyg som genererar bilder med hjälp av GPT-bildmodellerna.

modellgränssnittet ImageGenToolInputImageMask

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Gränssnitt som representerar en indexåtgärder.

modellgränssnitt InlineSkillParam

Inline-färdighetslast

Svarstexten för klusterinsikter.

Ett kluster av analysprover.

Förfrågningskroppen för att generera en insikt.

Konfiguration av modellen som används i insiktsgenereringen.

Begäran om insiktsrapporten.

Resultatet av insikterna.

Ett smakprov från analysen.

Insiktsuppgift för schemat.

Sammanfattning av felklusteranalysen.

Metadata om insikterna.

Konfiguration specifik för anropsprotokollet.

Konfiguration specifik för WebSocket-baserade anropsprotokollet.

En manuell payload som används för att testa en API-rutindispatch för anrop.

Skickar en rutin via råa anrops-API:et. Exakt en av agent_name eller agent_endpoint_id måste tillhandahållas.

En manuell nyttolast som används för att testa en respons-API-rutinutflykt.

Skickar en rutin via svars-API:et. Exakt en av agent_name eller agent_endpoint_id måste tillhandahållas.

Operationstillstånd för en långvarig operation som skapar en jobbresurs.

ANPASSNING: SDK-FÖRBÄTTRING: de emitterade pollers resolverar till jobbets terminalpayload result , som inte bär någon identifierare; jobId håller det skapade jobbet nåbart.

Ett verktyg som gör att modellen kan köra gränssnittskommandon i en lokal miljö.

modellgränssnitt LocalSkillParam

Ett log-sannolikhetsobjekt.

Adapterspecifik metadata för LoRA-modeller. Drivsystem som betjänar motorkonfiguration vid utplacering.

Ett verktyg som är tillgängligt på en MCP-server.

modellgränssnitt MCPListToolsToolAnnotations

modellgränssnitt MCPListToolsToolInputSchema

Ge modellen åtkomst till ytterligare verktyg via MCP-servrar (Remote Model Context Protocol). Lär dig mer om MCP.

Ett filterobjekt för att specificera vilka verktyg som är tillåtna.

modellgränssnitt MCPToolRequireApproval

Ett MCP-verktyg som förvaras i en verktygslåda.

modellgränssnitt ManagedAgentIdentityBlueprintReference

Hanterad Azure AI-sökning indexdefinition

Konfiguration specifik för MCP-protokollet.

Ett enskilt minnesobjekt som lagras i minneslagret och som innehåller innehåll och metadata.

Representerar en enskild minnesåtgärd (skapa, uppdatera eller ta bort) som utförs på ett minnesobjekt.

Ett hämtat minnesobjekt från minnessökningen.

Alternativ för minnessökning.

Ett verktyg för att integrera minnen i agenten.

Ett minneslager som kan lagra och hämta användarminnen.

Standardimplementering av minneslager.

Standardkonfigurationer för minneslager.

Grundläggande definition för minneslagringskonfigurationer.

Svar för att ta bort minnen från ett omfång.

Användningsstatistik för en minneslagringsåtgärd.

Svar på minnessökning.

Resultat av minnesuppdatering.

Anger status för en uppdateringsåtgärd för minneslagret.

Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format och fråga efter objekt via API eller instrumentpanelen. Nycklar är strängar med en maximal längd på 64 tecken. Värden är strängar med en maximal längd på 512 tecken.

En uppsättning delegerade behörighetsområden som begärs från en enda resursapplikation.

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.

Svar från att publicera en agent till Microsoft 365 / Microsoft Teams.

Inmatningsdefinitionsinformationen för ett Microsoft Fabric-verktyg som används för att konfigurera en agent.

Detaljer om en handling blockeras eftersom den kanske inte stämmer överens med användarens avsikt.

En offentlig instruktion om att fortsätta efter att en åtgärd blockerats.

Begär att hämta uppgifter för en modelltillgång.

Definition av modelldistribution

SKU-information

Representerar en begäran om en väntande uppladdning av en modellversion.

Representerar svaret för en modell som väntar på uppladdningsförfrågan.

Representerar en uppsättning parametrar som används för att styra samplingsbeteendet för en språkmodell under textgenereringen.

Källinformation för modellen

Modellversionsdefinition

Månatligt upprepningsschema.

Grupperar funktioner/anpassade verktyg under ett delat namnrymd.

Autentiseringsuppgifter som inte kräver autentisering

Utlösare en gång.

Utökade OpenAI-klientalternativ för att inkludera Azure Agents endpoint-konfiguration.

Säkerhetsinformation för anonym OpenApi-autentisering

autentiseringsinformation för OpenApiFunctionDefinition

Information om indatadefinition för en openapi-funktion.

Säkerhetsinformation för OpenApi managed_identity-autentisering

Säkerhetsschema för OpenApi managed_identity-autentisering

Säkerhetsinformation för OpenApi-project anslutningsautentisering

Säkerhetsschema för OpenApi managed_identity-autentisering

Information om indatadefinition för ett OpenAPI-verktyg som används för att konfigurera en agent.

Ett OpenAPI-verktyg lagrat i en verktygslåda.

Basmodell för typad optimeringskontext.

En OTLP (OpenTelemetry Protocol) telemetriexport-endpoint.

Ett gränssnitt som spårar inställningarna för sidsidig iteration

Ett gränssnitt som tillåter asynkron iteration både för slutförande och efter sida.

Representerar en begäran om en väntande uppladdning.

Representerar svaret på en väntande uppladdningsbegäran

Mallen för att välja fastigheter.

Ett minnesobjekt som innehåller en procedur extraherad från konversationer.

modellgränssnitt ProgrammaticToolCallingParam

Definitionen av promptagenten

Konfigurationsalternativ för ett textsvar från modellen. Kan vara oformaterad text eller strukturerade JSON-data.

Promptbaserad utvärderare

Promptkälla för datagenereringsjobb — text i raden tillhandahållen av användaren.

Prompt källa för utvärderargenereringsjobb — text i raden tillhandahållen av användaren.

Konfiguration för en one-shot prompt transformation utan jämförande utvärdering.

Konfiguration per protokoll för agentens slutpunkt.

En postmappning för ett enskilt protokoll och dess version.

En PSTN-destination för ett telefonöverföringsmål.

Valfria parametrar.

Konfiguration för innehållsfiltrering och säkerhetsfunktioner för ansvarsfull AI (RAI).

Deklarerar var begäran/svarstext finns så att innehållssäkerhetsräcken kan extrahera den.

En SSE-händelsetyp till textfältsväljare för strömmande anropsutdata.

modellgränssnitt RankingOptions

modellgränssnitt RealtimeAudioFormats

modellgränssnitt RealtimeAudioFormatsAudioPcm

modellgränssnitt RealtimeAudioFormatsAudioPcma

modellgränssnitt RealtimeAudioFormatsAudioPcmu

Ett realtidsevent med en kund.

Lägg till ett nytt Item i konversationens kontext, inklusive meddelanden, funktionsanrop och funktionsanropssvar. Denna händelse kan användas både för att fylla i en "historik" över konversationen och för att lägga till nya objekt mitt i strömmen, men har den nuvarande begränsningen att den inte kan fylla i assistentens ljudmeddelanden. Om det lyckas svarar servern med en conversation.item.created händelse, annars skickas en error händelse.

Skicka detta evenemang när du vill ta bort något föremål från konversationshistoriken. Servern svarar med en conversation.item.deleted händelse, om inte objektet inte finns i konversationshistoriken, i vilket fall servern svarar med ett felmeddelande.

Skicka denna händelse när du vill hämta serverns representation av ett specifikt objekt i konversationshistoriken. Detta är användbart, till exempel för att inspektera användarljud efter brusreducering och VAD. Servern svarar med en conversation.item.retrieved händelse, om inte objektet inte finns i konversationshistoriken, i vilket fall servern svarar med ett felmeddelande.

Skicka denna händelse för att förkorta ljudet från ett tidigare assistentmeddelande. Servern producerar ljud snabbare än realtid, så denna händelse är användbar när användaren avbryter för att förkorta ljud som redan skickats till klienten men ännu inte spelats. Detta synkroniserar serverns förståelse av ljudet med klientens uppspelning. Att trunkera ljudet tar bort serversidans texttranskription för att säkerställa att det inte finns text i kontexten som användaren inte har hört. Om det lyckas svarar servern med ett conversation.item.truncated event.

Skicka denna händelse för att lägga till ljudbyte i ingångsljudbufferten. Ljudbufferten är en tillfällig lagring som du kan skriva till och senare överföra. En "commit" skapar ett nytt användarmeddelande i konversationshistoriken från buffertinnehållet och rensar bufferten. Inmatningsljudtranskription (om aktiverad) genereras när bufferten commitas. Om VAD är aktiverat används ljudbufferten för att upptäcka tal och servern bestämmer när den ska comma. När server-VAD är inaktiverat måste du committa ljudbufferten manuellt. Brusreducering av ingångsljud tillämpas vid skrivning till ljudbufferten. Klienten kan välja hur mycket ljud som ska placeras i varje händelse upp till maximalt 15 MiB, till exempel kan streaming av mindre delar från klienten göra VAD mer responsiv. Till skillnad från de flesta andra klienthändelser skickar servern inget bekräftelsesvar på denna händelse.

Skicka denna händelse för att rensa ljudbytena i bufferten. Servern svarar med ett input_audio_buffer.cleared event.

Skicka denna händelse för att commita användarens ljudbuffert, vilket skapar ett nytt användarmeddelandeelement i konversationen. Denna händelse ger ett fel om ingångsljudbufferten är tom. När klienten är i Server-VAD-läge behöver den inte skicka denna händelse, servern kommer automatiskt att committera ljudbufferten. Att committa indataljudbufferten triggar ingångsljudtranskription (om det aktiveras i sessionskonfigurationen), men det skapar inget svar från modellen. Servern svarar med ett input_audio_buffer.committed event.

Endast WebRTC/SIP: Emittera för att stänga av den aktuella ljudresponsen. Detta får servern att sluta generera ljud och sända ut en output_audio_buffer.cleared händelse. Den här händelsen bör föregås av en response.cancel klienthändelse för att stoppa genereringen av det aktuella svaret. Läs mer.

Skicka denna händelse för att avbryta ett pågående svar. Servern svarar med en response.done händelse med statusen response.status=cancelled. Om det inte kommer något svar för att avbryta, svarar servern med ett felmeddelande. Det är säkert att ringa response.cancel även om inget svar pågår, ett fel kommer att returneras och sessionen förblir opåverkad.

Denna händelse instruerar servern att skapa ett svar, vilket innebär att modellinferens utlöses. När servern är i serverns VAD-läge skapar servern automatiskt svar. Ett svar kommer att innehålla minst ett objekt och kan ha två, i vilket fall det andra blir ett funktionsanrop. Dessa objekt kommer att läggas till i konversationshistoriken som standard. Servern svarar med en response.created händelse, händelser för skapade föremål och innehåll, och slutligen en response.done händelse som indikerar att svaret är klart. Händelsen response.create inkluderar inferenskonfiguration som instructions och tools. Om dessa är satta kommer de att åsidosätta sessionens konfiguration endast för detta svar. Svar kan skapas utanför standardkonversationen, vilket innebär att de kan ha godtycklig inmatning, och det är möjligt att inaktivera skrivandet av utdata till konversationen. Endast ett svar kan skriva till standardkonversationen åt gången, men annars kan flera svar skapas parallellt. Fältet metadata är ett bra sätt att särskilja flera samtidiga svar. Klienter kan ställa conversation in för none att skapa ett svar som inte skriver till standardkonversationen. Godtycklig indata kan tillhandahållas med fältet input , som är en array som accepterar råa objekt och referenser till befintliga objekt.

Ett enskilt objekt i en realtidskonversation.

Ett funktionsanrop i en konversation i realtid.

En funktion anropar ett utdata objekt i en realtidskonversation.

modellgränssnittet RealtimeConversationItemMessage

Ett assistentmeddelande i en konversation i realtid.

modellgränssnitt RealtimeConversationItemMessageAssistantContent

Ett systemmeddelande i en realtidskonversation kan användas för att ge ytterligare kontext eller instruktioner till modellen. Detta är liknande men skiljer sig från instruktionsprompten som ges i början av en konversation, eftersom systemmeddelanden kan läggas till när som helst i konversationen. För större förändringar i konversationens beteende, använd instruktioner, men för mindre uppdateringar (t.ex. "användaren frågar nu om ett annat ämne"), använd systemmeddelanden.

modellgränssnitt RealtimeConversationItemMessageSystemContent

Ett användarmeddelande i en konversation i realtid.

modellgränssnitt RealtimeConversationItemMessageUserContent

modellgränssnitt RealtimeFunctionTool

Ett realtidsobjekt som begär mänskligt godkännande av en verktygsinkallelse.

Ett realtidsobjekt som svarar på en MCP-godkännandeförfrågan.

modellgränssnitt RealtimeMCPError

modellgränssnitt RealtimeMCPHttpError

Ett realtidsverktyg för föremålslistor tillgängligt på en MCP-server.

modellgränssnitt RealtimeMCPProtocolError

Ett realtidsobjekt som representerar en anropning av ett verktyg på en MCP-server.

modellgränssnitt RealtimeMCPToolExecutionError

Konfiguration för resonemangskompatibla realtidsmodeller såsom gpt-realtime-2.

modellgränssnitt RealtimeResponseStatusDetaljer

modellgränssnitt RealtimeResponseStatusDetailsError

modellgränssnitt RealtimeResponseUsage

modellgränssnitt RealtimeResponseUsageInputTokenTDetails

modellgränssnitt RealtidSvarAnvändningIndataTokenDetaljerCachedTokenDetaljer

modellgränssnitt RealtimeResponseUsageOutputTokenDetails

Ett realtidsserverevent.

Skickas av servern när ett objekt läggs till i standardkonversationen. Detta kan hända i flera fall:

• När kunden skickar ett conversation.item.create event.
• När ingångsljudbufferten är committad. I detta fall kommer objektet att vara ett användarmeddelande som innehåller ljudet från bufferten.
• När modellen genererar ett svar. I detta fall skickas händelsen conversation.item.added när modellen börjar generera ett specifikt objekt, och därför kommer den ännu inte ha något innehåll (och status kommer att vara in_progress). Händelsen kommer att inkludera hela innehållet i objektet (förutom när modellen genererar ett svar) förutom ljuddata, som kan hämtas separat med en conversation.item.retrieve händelse om det behövs.

Returneras när en konversationspunkt skapas. Det finns flera scenarier som genererar den här händelsen:

• Servern genererar ett svar, som om det lyckas ger antingen ett eller två objekt, vilka kommer att vara av typ message (roll assistant) eller typ function_call.
• Ingångsljudbufferten har kommitterats, antingen av klienten eller servern (i server_vad läge). Servern tar innehållet från indataljudbufferten och lägger till det i ett nytt användarmeddelande.
• Kunden har skickat en conversation.item.create händelse för att lägga till ett nytt objekt i konversationen.

Returneras när ett objekt i konversationen tas bort av klienten med en conversation.item.delete händelse. Den här händelsen används för att synkronisera serverns förståelse av konversationshistoriken med klientens vy.

Returneras när en konversationspunkt är klar. Händelsen kommer att inkludera hela innehållet i objektet förutom ljuddata, som kan hämtas separat med en conversation.item.retrieve händelse vid behov.

Denna händelse är utgången av ljudtranskription för användarljud skrivet till användarens ljudbuffert. Transkriptionen börjar när indataljudbufferten committeras av klienten eller servern (när VAD är aktiverat). Transkribering sker asynkront med Responsskapandet, så denna händelse kan inträffa före eller efter Responshändelserna. Realtids-API-modeller accepterar ljud nativt, och därför är indatatranskribering en separat process som körs på en separat ASR-modell (automatisk taligenkänning). Transkriptionen kan avvika något från modellens tolkning och bör behandlas som en grov vägledning.

Returneras när textvärdet för en inmatad del av ljudtranskriberingen uppdateras med inkrementella transkriptionsresultat.

Returnerades när inmatad ljudtranskribering konfigurerades och en transkriberingsförfrågan för ett användarmeddelande misslyckades. Dessa händelser är separata från andra error händelser så att klienten kan identifiera den relaterade posten.

modellgränssnitt RealtimeServerEventConversationItemInputAudioTranscriptionFailedError

Returneras när ett inmatningsljudtranskriptionssegment identifieras för ett objekt.

Returneras när en konversationspunkt hämtas med conversation.item.retrieve. Detta tillhandahålls som ett sätt att hämta serverns representation av ett objekt, till exempel för att få tillgång till efterbehandlad ljuddata efter brusreducering och VAD. Den innehåller hela innehållet i objektet, inklusive ljuddata.

Returneras när ett tidigare assistent-ljudmeddelande trunkeras av klienten med en conversation.item.truncate händelse. Den här händelsen används för att synkronisera serverns förståelse av ljudet med klientens uppspelning. Denna åtgärd kommer att förkorta ljudet och ta bort serversidans texttranskription för att säkerställa att det inte finns någon text i kontexten som användaren inte har hört.

Returneras när ett fel uppstår, vilket kan vara ett klientproblem eller ett serverfel. De flesta fel kan återställas och sessionen förblir öppen, vi rekommenderar implementerare att övervaka och logga felmeddelanden som standard.

modellgränssnitt RealtimeServerEventErrorError

Returneras när ingångsljudbufferten rensas av klienten med en input_audio_buffer.clear händelse.

Returneras när en ingångsljudbuffert commitas, antingen av klienten eller automatiskt i serverns VAD-läge. Egenskapen item_id är ID:t för användarmeddelandet som ska skapas, så en conversation.item.created händelse skickas också till klienten.

Skickas av servern i server_vad läge för att indikera att tal har upptäckts i ljudbufferten. Detta kan hända när ljud läggs till bufferten (om inte tal redan är upptäckt). Klienten kan vilja använda denna händelse för att avbryta ljuduppspelningen eller ge visuell återkoppling till användaren. Klienten bör förvänta sig att få en input_audio_buffer.speech_stopped händelse när talet stoppas. Egenskapen item_id är ID:t för användarens meddelandeobjekt som skapas när talet upphör och som också inkluderas i händelsen input_audio_buffer.speech_stopped (om inte klienten manuellt commitar ljudbufferten under VAD-aktiveringen).

Återvände i server_vad läge när servern upptäcker slutet på tal i ljudbufferten. Servern skickar också en conversation.item.created händelse med användarens meddelandeobjekt som skapas från ljudbufferten.

Returnerades när serverns VAD-timeout triggas för ingångsljudbufferten. Detta är konfigurerat i idle_timeout_ms sessionens turn_detection inställningar, och det indikerar att det inte har upptäckts något tal under den konfigurerade längden. Fälten audio_start_ms och audio_end_ms anger segmentet av ljud efter att den senaste modellen har svarat fram till utlösningsögonblicket, som en förskjutning från början av ljud skrivet till indataljudbufferten. Detta innebär att den markerar det ljudsegment som var tyst och skillnaden mellan start- och slutvärdena kommer ungefär att matcha den konfigurerade timeouten. Det tomma ljudet kommer att sättas in i konversationen som ett input_audio objekt (det kommer att finnas en input_audio_buffer.committed händelse) och ett modellsvar kommer att genereras. Det kan finnas tal som inte utlöste VAD men ändå upptäcks av modellen, så modellen kan svara med något relevant för samtalet eller en uppmaning att fortsätta prata.

Returnerade när MCP-verktyg har slutförts för ett objekt.

Returnerat när man listar MCP-verktyg har misslyckats för en vara.

Återkommer när listningen av MCP-verktyg pågår för ett objekt.

Endast WebRTC/SIP: Sänds ut när utgångsljudbufferten rensas. Detta sker antingen i VAD-läge när användaren har avbrutit (input_audio_buffer.speech_started) eller när klienten har skickat output_audio_buffer.clear händelsen för att manuellt avbryta det aktuella ljudsvaret. Läs mer.

Sänds ut i början av ett svar för att ange de uppdaterade hastighetsgränserna. När ett svar skapas kommer vissa tokens att "reserveras" för utdatatoken, de hastighetsgränser som visas här speglar den reservationen, som sedan justeras därefter när svaret är klart.

modellgränssnitt RealtimeServerEventRateLimitsUpdatedRateLimits

Returneras när det modellgenererade ljudet uppdateras.

Returneras när det modellgenererade ljudet är klart. Sänds också ut när ett svar avbryts, är ofullständigt eller avbryts.

Returneras när den modellgenererade transkriptionen av ljudutgången uppdateras.

Returneras när den modellgenererade transkriptionen av ljudutgången är klar med strömning. Sänds också ut när ett svar avbryts, är ofullständigt eller avbryts.

Returneras när en ny innehållsdel läggs till i ett assistentmeddelandeobjekt under svarsgenerering.

modellgränssnitt RealtimeServerEventResponseContentPartAddedPart

Returneras när en innehållsdel är klar med strömmande i ett assistentmeddelande. Sänds också ut när ett svar avbryts, är ofullständigt eller avbryts.

modellgränssnitt RealtimeServerEventResponseContentPartDonePart

Returneras när ett nytt svar skapas. Den första händelsen vid responsskapande, där svaret är i initialt tillstånd av in_progress.

Returneras när ett svar är klart med streaming. Alltid utsänd, oavsett slutstatus. Svarobjektet som ingår i händelsen response.done kommer att inkludera alla utdata i svaret men utelämnar råljuddata. Klienter bör kontrollera status fältet för svaret för att avgöra om det var framgångsrikt (completed) eller om det fanns ett annat utfall: cancelled, failed, eller incomplete. Ett svar innehåller alla utdata som genererades under svaret, exklusive allt ljudinnehåll.

Returneras när de modellgenererade funktionsanropsargumenten uppdateras.

Returneras när de modellgenererade funktionsanropsargumenten är klara med strömningen. Sänds också ut när ett svar avbryts, är ofullständigt eller avbryts.

Returnerades när MCP-verktygsanropsargument uppdateras under responsgenerering.

Returnerades när MCP-verktygsanropsargument färdigställdes under responsgenereringen.

Återkom när ett MCP-verktygsanrop har slutförts framgångsrikt.

Återkom när ett MCP-verktygsanrop har misslyckats.

Återkom när ett MCP-verktygssamtal har startat och pågår.

Returneras när ett nytt föremål skapas under Responsgenerering.

Returneras när en vara är klar med streaming. Sänds också ut när ett svar avbryts, är ofullständigt eller avbryts.

Returneras när textvärdet för en "output_text"-innehållsdel uppdateras.

Returneras när textvärdet för en "output_text"-del är klart med streaming. Sänds också ut när ett svar avbryts, är ofullständigt eller avbryts.

Returneras när en session skapas. Sänds automatiskt ut när en ny anslutning etableras som den första serverhändelsen. Denna händelse kommer att innehålla standardkonfigurationen för sessionen.

Returneras när en session uppdateras med en session.update händelse, om det inte finns ett fel.

Endast GPT-5 och O-serie modeller Konfigurationsalternativ för resonemangsmodeller.

Modell för upprepningsschema.

Upprepningsbaserad utlösare.

Detaljer om det röda laget.

Abstrakt klass för målkonfiguration.

Förstärkningsfinjustering av datagenereringsresurs. Detta är en förhandsgranskningsfunktion.

Anroparens indata för ett förstärkningsfinjusteringsjobb för datagenerering. Detta är en förhandsgranskningsfunktion.

Filutdatakonfiguration för ett förstärkningsfinjusteringsjobb för datagenerering. Detta är en förhandsgranskningsfunktion.

Ett påminnelseverktyg som förvaras i en verktygslåda.

modellgränssnitt SvarAnvändningIndataTokensDetaljer

modellgränssnitt ResponsAnvändningUtdataTokensDetaljer

Konfiguration specifik för responsprotokollet.

En rutindefinition som återlämnas av tjänsten.

Basmodell för en rutinåtgärd.

Valfri auktorisationskonfiguration för en rutinmässig dispatch.

Basmodell för en manuell dispatch-last.

En enda rutinkörning returnerade från körhistorik-API:et.

Basmodell för en rutinmässig trigger.

Definition av matrisbaserad utvärderare — lagrar dimensioner som genereras av det genererade API:et. Används både för kvalitets- och säkerhetsbedömare.

En icke-dödlig varning som produceras under genereringen av bedömningsmatrisen när avslutade indata är tekniskt giltiga men sannolikt för svaga för att producera en högkvalitativ bedömningsmatris. Skrivskyddat; tjänstgenererad. Fortsatte med terminalen EvaluatorGenerationJob.

Operationstillstånd för en långvarig operation som skapar en körresurs.

ANPASSNING: SDK-FÖRBÄTTRING: den emitterade pollern upplöses till körningens terminallast result , som inte bär någon identifierare; runId håller den skapade körningen nåbar.

Definition av autentiseringsuppgifter för signatur för delad åtkomst (SAS)

Definition av SAS-autentiseringsuppgifter

Schemalägg modell.

En återkommande cron-baserad rutinutlösare.

Schemalägg körningsmodell.

Schemalägg uppgiftsmodell.

Sessionsstandarder tillämpades på sessioner skapade för en hostad agentversion.

En enda post i en kataloglista.

Svar från att lista en katalog i en sessionsandlåda.

Svar från att ladda upp en fil till en sessionsandlåda.

En enda Server-Sent Event-ram som sänds ut av den hostade agentens sessionslogström.

Varje bildruta innehåller ett event fält som identifierar händelsetypen och ett data fält som bär nyttolasten som klartext. Även om den nuvarande data nyttolasten är JSON-formaterad är dess schema inte kontraktsmässigt — ytterligare nycklar kan dyka upp och formatet kan ändras över tid. Klienter bör behandla data som en ogenomskinlig sträng och eventuellt försöka JSON-parsing.

Nya händelsetyper kan läggas till i framtiden. Klienter bör vänligt ignorera okända händelsetyper.

Wire-format:

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

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

Parametrarna för sharepoint-jordningsverktyget.

Information om indatadefinition för ett sharepoint-verktyg som används för att konfigurera en agent.

Ett skalverktyg förvarat i en verktygslåda. Denna modell är additiv till verktygslådans konfiguration och ändrar inte OpenAI-verktygskontraktet eller befintliga verktygsdefinitioner.

Konfigurationen för ett datagenereringsjobb med typen SimpleQnA.

Konfigurationen för ett uppgiftsgenererande datagenereringsjobb. Använd med utvärderingsscenarier med flera turer samt med prompt-, fil- eller agentkällor. Genererade datasetrader inkluderar fält som id, category, test_case_description, och desired_num_turns.

En SIP-destination för ett telefoniöverföringsmål.

En färdighetsresurs.

Inline-innehåll för att definiera en enkel färdighet utan att ladda upp filer. Följer agentskills.io SKILL.md specifikation.

(Förhandsvisning) En referens till en versionerad Foundry-färdighet.

modellgränssnitt SkillReferenceParam

En specifik version av en färdighet.

Tvingar modellen att anropa verktyget apply_patch när ett verktygsanrop körs.

Tvingar modellen att anropa shell-verktyget när ett verktygsanrop krävs.

modellgränssnitt SpecificProgrammaticToolCallingParam

Vägledning på naturligt språk för önskad optimering.

En strukturerad indata som kan delta i promptmallersättningar och verktygsargumentbindning.

Strukturerade utdata som kan skapas av agenten.

Övervakad finjustering av datagenereringsresurs. Detta är en förhandsgranskningsfunktion.

Indata som anroparen levererade för ett övervakat finjusteringsarbete för datagenerering. Detta är en förhandsgranskningsfunktion.

Filutdatakonfiguration för ett övervakat finjusteringsjobb för datagenerering. Detta är en förhandsgranskningsfunktion.

Definition av taxonomikategori.

Definition av underkategori taxonomi.

En Microsoft Teams Phone Extension-bindning som ägs av en röstagent.

En bindning för Microsoft Teams Phone Extension returnerades i en lista, inklusive dess entitetstagg.

En Microsoft Teams-destination för ett telefonöverföringsmål.

Kundtillhandahållen telemetrikonfiguration för export av containerloggar, spår och mätvärden.

En telemetriexport-endpoint-konfiguration.

Autentiseringskonfiguration för en telemetri-endpoint.

Gränssnitt som representerar telemetriåtgärder

En telefonbindning ägd av en röstagent.

En telefonbindning återvände i en lista, inklusive dess entitetstagg.

En varaktig, direkt eller kampanjskapad utgående samtalsintention.

En avbokningsbegäran inspelad för ett utgående samtal.

Det valfria exekveringsfönstret för ett direkt utgående anrop.

En begränsad och varaktig observation i livscykeln för ett telefonsamtal.

Detaljerad diagnostik för ett varaktigt inkommande samtal till en röstagent.

En sammanfattning av ett varaktigt inkommande samtal till en röstagent.

Detaljerad operatörsneutral tidpunkt för ett inkommande telefonsamtal.

Korrelation från en varaktig telefonsamtalslogg till dess kundnära Foundry-spårning.

Destinationen för ett utgående samtal.

En omprövningspolicy med ett fast intervall mellan utgående samtalsförsök.

Omprövningspolicyn för en varaktig utgående samtalsavsikt. max_attempts inkluderar första försöket. Strategispecifika inställningar definieras av den härledda policyn.

En destination för ett telefonöverföringsmål.

En namngiven destination dit röstagenten kan överföra ett samtal.

Telefonöverföringsmålen konfigurerade för en röstagent.

Ett objekt som anger det format som modellen måste mata ut. Konfiguration { "type": "json_schema" } möjliggör strukturerade utdata, vilket säkerställer att modellen matchar ditt angivna JSON-schema. Läs mer i guiden Strukturerade utdata. Standardformatet är { "type": "text" } utan ytterligare alternativ. Rekommenderas inte för gpt-4o och nyare modeller:* Inställning för att { "type": "json_object" } aktivera det äldre JSON-läget, vilket säkerställer att meddelandet modellen genererar är giltigt JSON. Att använda json_schema är att föredra för modeller som stöder det.

Baskonfiguration för formatet av genererade textsvar.

Konfigurerar genererade svar för att använda JSON-objektformat.

Konfigurerar genererade svar att använda ren text.

JSON-objektsvarsformat. En äldre metod för att generera JSON-svar. Användning json_schema rekommenderas för modeller som stöder det. Observera att modellen inte genererar JSON utan att ett system- eller användarmeddelande instruerar den att göra så.

JSON-schema svarsformat. Används för att generera strukturerade JSON-svar. Läs mer om strukturerade utdata.

Standardformat för svar. Används för att generera textsvar.

En rutinutlösare med en enda gångs timer.

Ett verktyg som kan användas för att generera ett svar.

Begränsar de verktyg som är tillgängliga för modellen till en fördefinierad uppsättning.

Anger att modellen ska använda ett inbyggt verktyg för att generera ett svar. Lär dig mer om inbyggda verktyg.

Anger att modellen ska använda ett inbyggt verktyg för att generera ett svar. Lär dig mer om inbyggda verktyg.

Anger att modellen ska använda ett inbyggt verktyg för att generera ett svar. Lär dig mer om inbyggda verktyg.

Anger att modellen ska använda ett inbyggt verktyg för att generera ett svar. Lär dig mer om inbyggda verktyg.

Använd det här alternativet för att tvinga modellen att anropa ett specifikt anpassat verktyg.

Anger att modellen ska använda ett inbyggt verktyg för att generera ett svar. Lär dig mer om inbyggda verktyg.

Använd det här alternativet för att tvinga modellen att anropa en specifik funktion.

Anger att modellen ska använda ett inbyggt verktyg för att generera ett svar. Lär dig mer om inbyggda verktyg.

Använd det här alternativet för att tvinga modellen att anropa ett specifikt verktyg på en fjärr-MCP-server.

Hur modellen ska välja vilket verktyg (eller verktyg) som ska användas när ett svar genereras. Se parametern tools för att se hur du anger vilka verktyg som modellen kan anropa.

Anger att modellen ska använda ett inbyggt verktyg för att generera ett svar. Lär dig mer om inbyggda verktyg.

Anger att modellen ska använda ett inbyggt verktyg för att generera ett svar. Lär dig mer om inbyggda verktyg.

Per-tool-konfiguration som styr verktygets synlighet och sökbeteende.

Beskrivning av ett verktyg som kan användas av en agent.

En project anslutningsresurs.

Hostad eller BYOT-verktygssökningskonfiguration för uppskjutna verktyg.

Ett verktygsverktygssökverktyg lagrat i en verktygslåda.

Konfigurationen för ett datagenereringsjobb med typen ToolUse. Detta är en förhandsgranskningsfunktion som endast används för finjustering av scenarier.

En verktygslåda som lagrar definitioner av återanvändbara verktyg för agenter.

Policykonfiguration för en verktygslåda, inklusive innehållssäkerhet och andra styrningsinställningar.

Ett verktygsverktygssökverktyg lagrat i en verktygslåda.

En automatiskt konfigurerad containermiljö för ett shell-verktyg lagrat i en verktygslåda.

En befintlig containermiljö för ett skalverktyg lagrat i en verktygslåda.

En exekveringsmiljö för ett skalverktyg lagrat i en verktygslåda. Denna miljömodell är anpassad till toolbox-konfiguration och ändrar inte OpenAI-skalmiljökontraktet.

Nätverksåtkomstpolicy för en automatiskt provisionerad toolbox shell-container.

En nätverkspolicy som inaktiverar utgående åtkomst från en toolbox shell-container.

En färdighetskälla som ingår i en verktygslåda.

En referens till en befintlig färdighet att inkludera i en verktygslåda.

En abstrakt representation av ett verktyg lagrat i en verktygslåda.

En specifik version av en verktygslåda.

De versioner som hör till en verktygslåda.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Valfria parametrar.

Gränssnitt som representerar en verktygslådas operationer.

Valfria parametrar.

Konfigurationen för ett datagenereringsjobb med typen Traces.

Spår källa för datagenereringsjobb — konversationsspår från Application Insights.

Spårar källa för utvärderargenereringsjobb — konversationsspår från Application Insights.

Användningsstatistik för modeller som faktureras efter ljudingångens längd.

Användningsstatistik för modeller fakturerade per tokenanvändning.

modellgränssnitt TranskriptTextAnvändningTokensInputTokenDetaljer

Ett språk som upptäcktes i transkriberat ljud.

Basmodell för utlösare av schemat.

En Twilio-bindning ägd av en röstagent.

En Twilio-bindning återlämnades i en lista, inklusive dess entitetstagg.

Begär kropp för att uppdatera en modellversion. Endast beskrivning och taggar kan ändras.

Begäran om att uppdatera en befintlig telefonbindning. Varje egendom är frivillig och bindningens leverantör är oföränderlig.

modellgränssnitt UpdateToolboxRequest

Konfigurerar effekter som appliceras på simulerat samtalsljud.

Konfigurerar antal, längd, ljudeffekter och simulerat användarbeteende i samtal.

Konfigurerar standardavbrottsbeteendet för den simulerade användaren.

Konfiguration för simulerat användaravbrottsbeteende.

Definierar ett testscenario. Simuleringskonfigurationsegenskaper som anges här åsidosätter motsvarande standardinställningar för datakällan.

Konfigurerar konversationsbeteende för den simulerade användaren.

Ett minnesobjekt som specifikt innehåller information om användarprofiler som extraherats från konversationer, till exempel preferenser, intressen och personliga uppgifter.

Versionsindikator som avgör vilken agent som stöder sessionen.

Versionsindikator som refererar till en specifik agentversion med namn.

modellgränssnitt VersionSelectionRule

modellgränssnitt VersionSelector

Animationsinställningar för en röstagentsession.

Ljudkonfigurationen för en röstagent. Dessa värden är sessionsstandardvärden och kan åsidosättas vid anslutning.

Inmata ljudkonfiguration för en röstagent.

Utdata ljudkonfiguration för en röstagent. Leverantörsspecifika fält väljs av voice_type:

• openai: voice och speed.
• azure-standard voice: , voice_locale, , speed, voice_temperature, custom_lexicon_url, custom_text_normalization_urlprefer_localesstylepitch, och volume.
• azure-custom: alla azure-standard fält utom style, plus custom_voice_endpoint_id.
• azure-personal: alla azure-standard fält utom style, plus personal_voice_model.
• avatar-voice-sync: alla azure-standard fält utom voice och style, plus personal_voice_model; röstnamnet härstammar från avataren.
• azure-realtime-native: voice och speed. format och output_audio_timestamp_types gäller alla rösttyper.

Avatarkonfiguration för en röstagent. Dessa värden är sessionsstandardvärden och kan åsidosättas vid anslutning.

En ICE-server som används för avatar WebRTC-förhandling.

Avatarplacering och rörelseinställningar.

Bakgrunden till avatarvideon.

Den rektangulära beskärningen applicerad på avatarvideo.

Avatar-videokodare och presentationsinställningar.

Avatarens videoupplösning.

English-optimized Azure semantic voice activity detection.

Multilingual Azure semantic voice activity detection.

Azure semantic voice activity detection.

Alternativ för att avbryta ett svar.

Kundhändelsen rtc.call.sdp.create : börjar WebRTC-signalering med ett SDP-erbjudande.

Klientevenemanget session.avatar.connect .

Klientevenemanget session.update .

Resultatet levereras när en röst-agent-anslutning stängs.

En sammankopplad, tvåvägs röstagentström.

Stöder exakt en for await iteration över serverhändelser; ett andra försök kastar. Att lämna loopen tidigt (break, , returneller ett oupptäckt fel i loopkroppen) stänger anslutningen som en bieffekt. Oigenkända serverhändelsetyper levereras som VoiceAgentUnknownEvent utan att strömmen avbryts. Felaktiga händelser misslyckas fortfarande med iterationen vid ett protokollfel.

Definitionen av röstagenten. Dess konfiguration (modell, instruktioner, ljud, verktyg och valfri avatar) driver en hanterad tal-till-tal-upplevelse. Etablera röstsessioner i realtid genom GET /agents/{agent_name}/endpoint/protocols/voice. Varje skapande eller uppdatering ger en ny oföränderlig version.

Server-side eko-avstängningsinställningar för inmatningsljud.

En servicehanterad kontroll som avslutar den aktiva konversationen.

Semantisk slut-av-yttrande-detekteringskonfiguration.

Alternativ delas av operationer som bygger en protokollhändelse åt uppringarens vägnar.

Ett inbyggt funktionsverktyg som körs av klienten.

Sessionsstart-hälsningskonfiguration för en röstagent.

Asynkron ingång-ljud-transkriberingskonfiguration. Utökar OpenAI:s realtidstranskriberingsalternativ med Azure- och MAI-transkriptionsmodeller, anpassade talmodeller och frasledtrådar.

Fält som delas av interim-responskonfigurationer.

En hälsning skriven av sessionsmodellen utifrån en scoped öppnings-tur-prompt.

Ett interimsvar genererat av en språkmodell.

Ett MCP-verktyg tillgängligt för en röstagent.

Ingångsljudbrusreduceringskonfiguration.

Alternativ för att koppla realtidsklienten till en röstagent.

Alternativ för Voice Agents realtidsklient.

Ett live-svar i realtid returnerades av röstagenttjänsten i både response.created och-händelserna response.done .

Egenskaper som delas av realtidssvar som returneras av röstagenttjänsten.

Parametrar som accepteras av en röstagent-händelse response.create .

Alternativ för att skapa ett svar.

Detaljer om ett WebRTC-signaleringsfel.

OpenAI semantiska VAD-inställningar för turdetektering.

Alternativ som delas av operationer som lägger till en konversationspunkt och som standard begär ett svar.

Alternativ delas av realtidssändningsoperationer.

Alternativ för att skicka textinmatning.

Alternativ för att returnera ett funktionsresultat.

Serverhändelsen response.animation_blendshapes.delta .

Serverhändelsen response.animation_blendshapes.done .

Serverhändelsen response.animation_viseme.delta .

Serverhändelsen response.animation_viseme.done .

Serverhändelsen response.audio_timestamp.delta .

Serverhändelsen response.audio_timestamp.done .

Serverhändelsen response.video.delta .

Serverhändelsen rtc.call.error : ett WebRTC-signaleringsfel.

Serverhändelsen rtc.call.sdp.created : SDP-svaret som fullbordar WebRTC-förhandling.

Serverhändelsen session.avatar.connecting .

Serverhändelsen session.avatar.switch_to_idle .

Serverhändelsen session.avatar.switch_to_speaking .

Serverhändelsen session.subagent.aborted .

Serverhändelsen session.subagent.completed .

Serverhändelsen session.subagent.started .

Serverhändelsen warning .

Detaljer om en icke-dödlig varning.

Serverbaserad röstaktivitetsdetektion.

Avatarinställningar accepterade av det stabila röstagent-kontraktet WebSocket.

De effektiva stabila realtidssessionsinställningarna återlämnas av röstagenttjänsten.

De stabila realtidssessionsinställningarna accepteras i ett session.update klientevent.

Alternativ för att uppdatera live-sessionen.

Ett statiskt interimsvar valt från konfigurerad text.

En syskon-Foundry-textagent som en röstagent kan konsultera som bakgrundsspecialist.

Konfiguration för syskon-Foundry-textagenter som en röstagent kan konsultera.

Policy för att leverera svar medan en röstagent väntar på en subagent.

En servicehanterad kontroll som agerar på den aktiva röstsessionen utan kundkod eller extern autentisering.

En deterministisk hälsning som renderas med röstagentens strukturerade indata och syntetiseras utan modellgenerering.

Ett verktyg som kan användas av en röstagent.

En referens till en Foundry-verktygslåda, som är en versionsbaserad verktygsbunt som körs via dess MCP-endpoint.

En transkriberad fras med tidsinformation.

Ett tidsstämplat ord i en input-ljudtranskription.

Konfiguration för att upptäcka en röstagent.

En serverhändelse vars trådtyp inte känns igen av denna version av SDK:n.

SDK:n levererar dessa händelser utan att stänga anslutningen eller tillämpa validering eller normalisering av kända händelser. Inspektera och validera råa fält innan du använder dem.

Alternativ skickas till VoiceAgentWebSocketTransport.connect.

Skapar VoiceAgentWebSocketTransport-instanser för VoiceAgentRealtimeClient.

Återuppringningar anropas av en VoiceAgentWebSocketTransport när anslutningshändelser inträffar.

En pluggbar WebSocket-transport som används av VoiceAgentRealtimeClient. Implementera detta gränssnitt för att anpassa hur realtidsanslutningen etableras, till exempel för att dirigera den genom ett autentiserat relä.

Metadata för ljudsegmentet i ett enskilt samtalsämne. För bring-your-own-storage (BYOS) inkluderar blob_urisvaret , en direkt kundlagrings-URI utan SAS-token, som kunden får tillgång till med sina egna inloggningsuppgifter. För Foundry-managed lagring blob_uri saknas och bytena strömmas genom objektets /audio/content rutt.

En ihållande röstkonversation. Foundry-kuvertet som äger en röstagents lagrade transkript, svar, per-tur-mätvärden och ljudet. Det är förälder-, behållnings- och borttagningsgränsen: att radera den kaskaderar till dess svar, artiklar, mätvärden och ljud. När slutförandet misslyckas förblir eventuella delvis bevarade svar, objekt och ljud läsbara.

En motor som ansvarar för samtalshantering för en röstagent.

Metadata för ett konversationsobjekt genererat ljud. För bring-your-own-storage (BYOS) inkluderar blob_urisvaret , en direkt kundlagrings-URI utan SAS-token, som kunden får tillgång till med sina egna inloggningsuppgifter. För Foundry-managed lagring blob_uri saknas och bytena strömmas genom objektets /audio/generated/content rutt.

En sluten referens till den hostade textagenten som äger konversationshanteringen för en röstagent. Den hostade agenten löses inom samma projekt och måste stödja protokollet invocations_ws , Voice Live-kompatibilitet och Bridge Protocol 1.0.

Metadata för den sammanslagna, helsamtalsstereoinspelningen av en röstkonversation (användarljud på vänster kanal, agentljud på höger). Byggd en gång från segmenten per tur efter sessionen och hållbart cached. Den gemensamma metadatan (format, samplingsfrekvens, kanaler, kanallayout, varaktighet) returneras för både Foundry-managed och bring-your-own-storage (BYOS)-inspelningar. För BYOS inkluderar blob_urisvaret även , URI:n för inspelningen i kundens egen lagring (ingen SAS-token), som kunden laddar ner med sina egna lagringsuppgifter. För Foundry blob_uri saknas lagring och bytena strömmas istället via /audio/content rutten.

Rollen tilldelad varje kanal i en sammanslagen stereoröstinspelning.

Ett bestående röstsvar som representerar en modell-inferensvändning inom en konversation. I listresultat output kan projektionen utelämnas; hämta hela svaret (GET .../responses/{response_id}) eller den sidade svarsrutten (GET .../responses/{response_id}/items) för dess utdata. created_at / completed_at är Foundrys hållbara ordertillägg.

Ljudkonfiguration för ett svar. Följer OpenAI Realtime GA-objektets audio form.

Den platta ljudutgångsprojektionen, med valfritt voice, voice_type, voice_locale, och format fält.

Egenskaper som delas av persisterade röstsvar.

Ett WebIQ-serversideverktyg.

Ett WebIQ-verktyg lagrat i en verktygslåda.

Användarens ungefärliga plats.

En webbsökningskonfiguration för bing anpassad sökning

Detta verktyg söker på webben efter relevanta resultat att använda i ett svar. Läs mer om sökverktyget web.

Sök på internet efter källor relaterade till prompten. Läs mer om sökverktyget web.

modellgränssnitt WebSearchToolFilters

Ett webbsökverktyg lagrat i en verktygslåda.

Schema för upprepning varje vecka.

Ett WorkIQ-serverside-verktyg.

Ett WorkIQ-verktyg lagrat i en verktygslåda.

Definitionen av arbetsflödesagenten.

Stödde A2A-protokollversioner.

En åtkomstgräns för aktivitetsprotokollet.

Typ av agentBlueprintReferenceType

Alias för AgentBlueprintReferenceUnion

Funktionsnycklar för agentdefinitionsoperationer som stöder villkorliga förhandsvisningsfunktioner.

Unionstyp för alla typer av agentdefinitioner. Stöder arbetsflöde, hostad, containerapp, prompt och externa agenter.

Konfiguration för routing, protokoll och auktorisation vid en agents slutpunkt.

Typ av AgentEndpointAuthorizationSchemeType

Alias för AgentEndpointAuthorizationSchemeUnion

Alias för AgentHarnessUnion

Status för en agentidentitet, tillämplig både på agentinstansidentiteten och agentens ritning.

Ett JSON-värde som används i Agent Insights-payloads.

Identifierar var en översikt av Agent Insights kommer ifrån.

Promptytan ändrades genom ett föreslaget fix.

Den kundrenderbara typen av agentinsikt föreslås lösning.

Triggern som startade en agent insight-runda.

Allvaret i en agentinsikt.

En agents livscykelstatus.

Definierar typen/typen av agent. Avgör vilken agentdefinitionsstruktur som används.

Vokabulär för frågeparametern expand på kandidatens LIST-endpoint. Denna öppna union håller SDK:er användbara när nya expand-nycklar levereras serversidan. Flera värden serialiseras som en komma-separerad frågeparameter.

Alias för AgentOptimizationCandidateOutputUnion

Kandidatens livscykeltillstånd.

Alias for AgentOptimizationConfigurationBaseUnion

Konfigurationstyper av optimeringsjobb.

Källtyper stöds av optimeringsutvärderingsset.

Logiska radformat stöds av optimeringsutvärderingsset.

Alias för AgentOptimizationEvaluationSetUnion

Mål för ett jobb med agentoptimering.

Alias för AgentOptimizationMutationUnion

Optimeringsfas som förbrukade modellens resurser.

Alias for AgentOptimizationTargetCompletionDataSourceUnion

Målkonfigurationstyper som stöds av optimeringsjobb.

Alias för AgentOptimizationTargetConfigurationUnion

Anledningen till att optimeringsprocessen avslutades. Tidiga uppsägningsskäl indikerar fortfarande ett framgångsrikt jobb; färdigställda kandidater finns kvar.

Alias för AgentOptimizationUserConversationSimulationDataSourceUnion

Typ av AgentProtocol

Status för en agentsession.

Agentens operativa tillstånd.

Indikerar källan till en agents operativa tillstånd. Tomt när tillståndet inte härstammar från en specifik källa.

Typ av agenttyp

Provisioneringsstatusen för en agentversion.

Det nedladdade ZIP-arkivet innehåller värdagent kod, exponerad som en webbläsarblob eller Node.js läsbar ström.

Den nedladdade agentens sessionsfil, exponerad som en webbläsarblob eller Node.js läsbar ström.

Valfria parametrar.

Strategier för attacker.

Tillgängliga frågetyper för Azure AI-sökning-verktyget.

Alias för BaseCredentialsUnion

ZIP-arkivet för standardversionen av en färdighet, exponerad som en webbläsar-blob eller Node.js läsbar ström.

WAV-ljudet för ett konversationsobjekt, exponerat som en webbläsarblob eller Node.js läsbar ström.

Den sammanslagna stereo WAV-inspelningen av en röstkonversation, exponerad som en webbläsarblob eller Node.js läsbar ström.

Det genererade WAV-ljudet för ett avbrutet samtalsobjekt, exponerat som en webbläsarblob eller Node.js läsbar ström.

Typ av CallableToolAllowedCaller

Hur paketberoenden löses vid distributionstillfället för en kodbaserad hostad agent.

Alias för ComparisonFilterValueItems

Typ av datormiljö

Typ (eller kategori) för anslutningen

Type of ContainerMemoryLimit

Typ av ContainerNetworkPolicyParamType

Alias för ContainerNetworkPolicyParamUnion

Typ av containerSkillType

Alias för ContainerSkillUnion

Ett gränssnitt som beskriver en resultatsida.

Alias för CreateTelephonyBindingRequestUnion

Typ av CreateTranscriptionResponseJsonUsageType

Alias för CreateTranscriptionResponseJsonUsageUnion

Typen av autentiseringsuppgifter som används av anslutningen

Typ av CustomToolParamFormatType

Alias för CustomToolParamFormatUnion

Alias for DataGenerationJobConfigurationUnion

Alias för DataGenerationJobInputsUnion

De stödda utdatafiltyperna för ett datagenereringsjobb.

Alias för DataGenerationJobOutputUnion

De stödda skrivlägena för datagenererande jobbutdata ger utdata.

De stödda scenarierna för ett datagenereringsjobb.

De stödda källtyperna för datagenereringsjobb.

Alias för DataGenerationJobSourceUnion

De stödda datagenereringsjobbtyperna.

Alias för DataGenerationJobUnion

Räkna upp för att fastställa typen av data.

Alias för DatasetVersionUnion

Dagar i veckan för upprepningsschema.

Typ av DeploymentType

Alias för DeploymentUnion

Den typen av digital arbetare.

ZIP-arkivet för en specificerad färdighetsversion, exponerad som en webbläsar-blob eller Node.js läsbar ström.

Nivån där utvärderingen utförs.

Typ av utvärderingsåtgärd.

Alias för EvaluationRuleActionUnion

Typ av utvärderingsregelhändelse.

Alias för EvaluationTargetUnion

Typ av indata från utvärderingstaxonomin.

Alias för EvaluationTaxonomyInputUnion

Alias för EvaluationVoiceModelConfigurationUnion

Utvärderarens kategori

Definition av typ av utvärderare

Alias för EvaluatorDefinitionUnion

De stödda källtyperna för utvärderargenereringsjobb.

Alias för EvaluatorGenerationJobSourceUnion

Måttenhetens riktning som anger om ett högre värde är bättre, ett lägre värde är bättre eller neutralt

Typ av utvärderare

Typ av utvärderare

Giltiga värden för innehållet i en binär fil.

Alias för filter

Typ av FoundryFeaturesOptInKeys

Artefaktprofilkategorin.

Signaler upptäckta i modellartefakten.

Modellens källtyp.

Varningskod för modellartefakter.

Modellens vikttyp.

Typ av funktionShellToolParamEnvironmentType

Alias för FunctionShellToolParamEnvironmentUnion

De typspecifika indata för att generera och skapa en agent.

En varningskategori dök upp på en genererad utvärderingsversion. Utbyggbar så att nya varningskategorier (t.ex. säkerhet, utgångskvalitet) kan införas utan att ändra något av.

Det binära Microsoft 365-apppaketet genererades för en Foundry-agent.

Ett kundkonfigurerbart GitHub Copilot-inbyggt verktyg.

Kända GitHub-utdelningar som kan starta en rutin.

Typ av grammatikSyntax

Typ av ImageGenAction

Typ av IndexType

Alias för IndexUnion

Kontrollera hur mycket arbete modellen kommer att utöva för att matcha stilen och funktionerna, särskilt ansiktsdrag, för indatabilder. Denna parameter stöds endast för gpt-image-1 och gpt-image-1.5 senare modeller, ej stödd för gpt-image-1-mini. Stöder high och low. Standardinställningen är low.

Alias för InsightRequestUnion

Alias för InsightResultUnion

Alias för InsightSampleUnion

Begäran om insikter.

En poller för en långvarig operation som skapar en jobbresurs.

Utvidgningsbara statusvärden delas av Foundry-jobb.

Typ av minnesobjekt.

Alias för MemoryItemUnion

Typ av minnesoperation.

Alias för MemoryStoreDefinitionUnion

Vilken typ av implementering av minneslager som ska användas.

Typ av MemoryStoreType

Status för en uppdateringsåtgärd för minneslagret.

Publiceringsomfattningen för den genererade Microsoft Teams-appen.

En klassificering av en handling som kanske inte stämmer överens med användarens avsikt. Ytterligare värden kan returneras.

Skriv alias för Node.js ReadableStream. På Node-mål löses detta till den faktiska typen NodeJS.ReadableStream. I webbläsare/react-native-mål löser plattformsvarianten till never, vilket naturligt faller ur union-typer.

Alias för OpenApiAuthDetailsUnion

Autentiseringstyp för OpenApi-slutpunkt. Tillåtna typer är:

• Anonym (ingen autentisering krävs)
• Project Anslutning (kräver project_connection_id till slutpunkten, som konfigurerat i AI Foundry)
• Managed_Identity (kräver målgrupp för identitetsbaserad autentisering)

Uppräkning som beskriver tillåtna åtgärdstillstånd.

Konfigurationsförändringarna och aggregerade utvärderingsresultat för en agent optimeringskandidat.

Typ av kontext som tillhandahålls till ett optimeringsarbetsflöde.

Alias för OptimizationContextUnion

Ett jobb för agentoptimering som följer indata, framsteg, status och resultat från kandidatutvärdering.

De utvärderade kandidater och identifierare av baslinjen och den bästa kandidaten från ett optimeringsjobb.

Typ av sidaOrder

Typen av väntande uppladdning.

Microsoft Agent Certification granskar status för Microsoft 365 Store-titeln publicerad för en agent.

Hur en anropsförfrågan/svarskropp tolkas för att hitta text för innehållssäkerhetsmoderering.

Författardeklarerad svarsform för anropsprotokollet.

Typ av rankerVersionTyp

Typ av realtidsljudformatTyp

Alias för RealtimeAudioFormatsUnion

Typ av RealtimeClientEventType

Alias för RealtimeClientEventUnion

Typ av RealtimeConversationItemMessageType

Alias för RealtimeConversationItemMessageUnion

Typ av RealtimeConversationItemType

Alias för RealtimeConversationItemUnion

modellgränssnitt RealtimeFunctionToolParameters

Typ av RealtimeMCPErrorType

Alias för RealtimeMCPErrorUnion

Begränsar ansträngningen på resonemang för resonemangskapabla realtidsmodeller såsom gpt-realtime-2.

Typ av RealtimeServerEventType

Alias for RealtimeServerEventUnion

Begränsar arbetet med resonemang för resonemangsmodeller. För närvarande stödda värden är none, minimal, , low, medium, highoch xhigh. Att minska resonemangsinsatsen kan resultera i snabbare svar och färre token som används vid resonemang i ett svar.

• gpt-5.1 går som standard till none, vilket inte utför resonemang. De stödda resonemangsvärdena för gpt-5.1 är none, low, medium, och high. Verktygsanrop stöds för alla resonemangsvärden i gpt-5.1.
• Alla modeller används som gpt-5.1 standard resonerande medium och stödjer noneinte.
• Modellen gpt-5-pro använder som standard (och stödjer bara) high resonemangsarbete.
• xhigh stöds för alla modeller efter gpt-5.1-codex-max.

Alias för ReasoningModeEnum

Alias för RecurrenceScheduleUnion

Typ av upprepning.

Alias för RedTeamTargetConfigUnion

Riskkategori för attackmålet.

De diskriminerande värderingar som stöds för rutinmässiga åtgärder.

Alias för RoutineActionUnion

Kända källvägar som kan producera en rutinkörning.

De stödda identiteterna för rutinmässig dispatch-auktorisering.

Diskriminatorvärdena stöds för manuella rutinmässiga dispatch-laster.

Alias för RoutineDispatchPayloadUnion

Kända livscykelfaser registrerade för en rutinkörning.

Status för en rutinrunda.

De diskriminatorvärden som stöds för rutinmässiga triggers.

Alias för RoutineTriggerUnion

Stabil sökbar maskinläsbar varningskod för en matrisgenererad inmatningskvalitetsvarning. Värden är snake_case; klienter måste tolerera ytterligare tjänstedefinierade identifierare.

Varningsallvarlighetsgrad för en varning för inmatningskvalitet vid bedömningsmatris. Initial värdemängd: warning.

Varningskälla för en varningssignal för matrisgenerering och varning för inmatningskvalitet. Per-käll-värden (prompt, agent, dataset) matchar källkategorin som är synlig för generationsruntimen. aggregate är ett syntetiskt värde som endast används för varningar beräknade över framgångsrikt lösta källor. traces exponeras inte eftersom spårkällor omvandlas till datamängdinnehåll uppströms.

En poller för en långvarig operation som skapar en körresurs.

Vilken typ av prov som används i analysen.

Status för schemaläggning av etablering.

Typ av uppgift.

Alias för ScheduleTaskUnion

Typ av sökningInnehållTyp

Typ av sökningKontextStorlek

Kända SSE-händelsetyper som sänds ut av den hostade agentens sessionsloggström. Ytterligare händelsetyper kan introduceras i framtida versioner.

De stödda frågetyperna för SimpleQnA-datagenereringsjobb används för finjustering av scenarier.

Agentattribut som kan optimeras.

Vilken typ av telemetridata som ska exporteras.

Typen av autentisering för en telemetri-endpoint.

Alias for TelemetryEndpointAuthUnion

Den typen av telemetriexport-endpoint.

Alias för TelemetryEndpointUnion

Transportprotokollet för telemetriexport.

Alias för TelephonyBindingListItemUnion

Livscykelstatusen för en telefonbindning.

Alias för TelephonyBindingUnion

Tidsstämpeln som används som grund för samtalets längd.

Kända tjänstegenererade skäl till att ett telefonsamtal avslutades, snarare än orsaker till ett övergripande utgående samtal. Ytterligare strängkoder kan returneras.

Livscykelstatusen för ett varaktigt utgående samtalsjobb.

Kända terminala orsaker till ett övergripande utgående samtalsjobb, som kan omfatta flera vårdgivareförsök. Dessa skiljer sig från individuella samtalslivscykel. Ytterligare strängkoder kan returneras.

Ett leverantörsneutralt livscykelhändelsenamn. Kända värden är stabila; ytterligare värden kan läggas till över tid.

Resultatet av en observation av telefonilivscykeln.

Kända tjänstegenererade orsaker till en telefonlivscykelhändelse. En händelseorsak beskriver inte nödvändigtvis det slutgiltiga resultatet av samtalet. Ytterligare strängkoder kan returneras.

Komponenten som levererade en observation av telefonlivscykeln.

Den leverantörsneutrala fasen nås via ett inkommande telefonsamtal.

Livscykelstatusen för ett inkommande telefonsamtal.

Källan till en tidsstämpel för telefonins livscykel.

Läget som används för att exponera ett telefonsamtal som en kundriktad Foundry-spårning.

Tillgänglighetsstatusen för en kundvänd telefonispårning.

Typen av destination för ett utgående samtal.

Återförsöksstrategin för ett utgående samtal.

Alias för TelephonyOutboundRetryPolicyUnion

En telefonileverantör som stöds av en agent bindande. Kända värden är stabila; ytterligare värden kan läggas till över tid.

Den typen av telefonöverföringsdestination. Kända värden är stabila; ytterligare värden kan läggas till över tid.

Alias för TelephonyTransferDestinationUnion

Typ av TextSvarFormatKonfigurationTyp

Stödde konfigurationer för klartext och strukturerade JSON-svar.

Alias för TextResponseFormatUnion

Styr vilket (om något) verktyg som anropas av modellen. none innebär att modellen inte anropar något verktyg och i stället genererar ett meddelande. auto innebär att modellen kan välja mellan att generera ett meddelande eller anropa ett eller flera verktyg. required innebär att modellen måste anropa ett eller flera verktyg.

Typ av verktygValParamTyp

Alias för ToolChoiceParamUnion

Typ av verktygSearchExecutionType

Typ av verktygstyp

Alias för ToolUnion

Alias för ToolboxShellEnvironmentUnion

Alias för ToolboxShellNetworkPolicyUnion

Alias för ToolboxSkillUnion

Stödda verktygstyper för verktyg lagrade i en verktygslåda.

Alias för ToolboxToolUnion

Svaret returneras av den senaste verktygslådans MCP-endpoint.

Typ av behandlingseffekt.

Typ av utlösare.

Alias för TriggerUnion

Effekt som kan tillämpas på simulerat samtalsljud. Unionen är utbyggbar för ytterligare effekter.

Alias för UserConversationSimulationInterruptionConfigurationUnion

Typen av versionsindikator som används för att bestämma agentversionen som stöder en session.

Alias för VersionIndicatorUnion

Typ av VersionSelectionRuleType

Alias för VersionSelectionRuleUnion

En animationsutdata producerad av en röstagentsession.

En typ av utdata-ljudtidsstämpel som stöds av en röstagent.

Transporten används för att leverera avatarens videoström.

Avatar-typen.

Ett stabilt v1-meddelande skickat av en klient via en röstagent WebSocket.

Anslutningstillstånd rapporteras av en realtids-röstagent-anslutning.

Anropas när en röst-agent-anslutning ändrar tillstånd.

Källan till referensljud som används för ekoborttagning.

Den semantiska slut-av-yttrande-detektionsmodellen.

Känslighetströskeln för detektion av semantiskt slut på yttranden.

Alias for VoiceAgentGreetingConfigUnion

Identifieraren för input-ljudtranskriptionsmodellen. Detta är ett modellnamn, inte ett Foundry-distributionsnamn. Speglar transkriptionsmodellerna som stöds av den hanterade röstbackend, och täcker OpenAI Realtime-transkriptionsmodeller samt Azure- och MAI-modellerna. Ytterligare värden kan läggas till över tid.

Alias for VoiceAgentInterimResponseConfigUnion

Ett tillstånd som kan utlösa en tillfällig reaktion.

Det maximala antalet utdatatoken eller bokstaven inf.

Inmatningsläget för brusreducering.

Felkoder som genereras av Voice Agents realtidsklient.

En händelse mottagen från en realtidskontakt mellan röstagent och röstagent.

Kända händelser behåller sina genererade typer och normalisering. Oigenkända trådtyper är inlindade i VoiceAgentUnknownEvent. Slå på type för att begränsa kända händelser, eller exkludera type === "unknown" innan du skickar en händelse till en hanterare med kända händelser.

Ett stabilt v1-meddelande skickat av tjänsten via en röstagent WebSocket.

Ytterligare fält som en röstagentsession kan inkludera i tjänsteutdata.

Den effektiva sessionskonfigurationen återvände i röst-agent sessionens livscykelhändelser.

Sessionskonfigurationen accepteras av en röstagent-sessionsuppdateringshändelse.

Anledningen till att en konsult med underagent avbröts.

En tjänsthanterad röstsessionskontrollåtgärd. Kända värden är stabila; ytterligare värden kan läggas till över tid.

Alias för VoiceAgentSystemToolUnion

Verktygsvalsbeteende för en röstagent.

När en verktygsinkallelse skapar ett uppföljningssvar. Ytterligare värden kan läggas till över tid.

Alias för VoiceAgentToolUnion

Transporten används för en röst-agent-anslutning.

Alias for VoiceAgentTurnDetectionConfigUnion

Strategin för att upptäcka turer. Ytterligare värden kan läggas till över tid.

Ett JSON-textmeddelande utbyttes över en etablerad röstagent WebSocket. Ljudbyte är base64-kodade i JSON-händelsefält.

WebSocket-subprotokollet stöds av en röst-agent-anslutning.

En ljudkodek. Ytterligare värden kan läggas till över tid.

Ett ljudbehållarformat. Ytterligare värden kan läggas till över tid.

En roll som röst-ljuddeltagare. Ytterligare värden kan läggas till över tid.

Alias för VoiceConversationEngineUnion

Livscykelstatusen för en pågående röstkonversation:

• in_progress: Live-sessionen är aktiv, eller så är slutförandet av persistens efter sessionen under behandling.
• completed: slutförandet lyckades efter normal eller klientstängning, end_conversation, en maxlång avslutning 1001 , eller en klient- eller nätverksfrånkoppling som tjänsten fortfarande kan slutföra.
• failed: ett terminalservice-, brygg-, lagrings- eller oåterkalleligt transportfel förhindrade slutförande.

Hur modellen som backar upp en röstagent fungerar. Detta är oberoende av arkitekturen (realtid eller kaskaderad), som tjänsten härleder från den valda modellen.

En utgångsmodalitet som agenten kan producera. animation och avatar används när en avatar konfigureras.

Röstimplementeringen. Ytterligare värden kan läggas till över tid.

Microsoft Foundry API-versioner

Typeguard för RestError

En anpassad feltyp för misslyckade pipelinebegäranden.

Kända värden för VoiceAgentConnectionState rapporteras av en realtids-samtals-röstagent-anslutning.