@azure/ai-projects package

Klassen

AIProjectClient

De hoofdclient voor de AIProjectClient

VoiceAgentAuthenticationError

Een foutmelding bij het verkrijgen van een Microsoft Entra toegangstoken.

VoiceAgentConnectionError

Een foutmelding veroorzaakt door de WebSocket-verbinding.

VoiceAgentProtocolError

Een foutmelding die wordt weergegeven wanneer een WebSocket-bericht niet overeenkomt met het voice-agent-protocol.

VoiceAgentRealtimeClient

Klant voor het opzetten van realtime sessies met beheerde Foundry voice agents.

VoiceAgentRealtimeError

Basisfout veroorzaakt door de realtime client van de Voice Agents.

Interfaces

@azure/ai-projects.Index
A2APreviewTool

Een agent die het A2A-protocol implementeert.

A2APreviewToolboxTool

Een A2A-tool opgeslagen in een gereedschapskist.

A2AProtocolConfiguration

Configuratie specifiek voor het A2A-protocol.

A2ATool

Een agent die het A2A-protocol implementeert.

A2AToolboxTool

Een A2A-tool opgeslagen in een gereedschapskist.

AIProjectClientOptionalParams

Optionele parameters voor de client.

AISearchIndexResource

Een AI-zoekindexbron.

ActivityProtocolConfiguration

Configuratie specifiek voor het activiteitsprotocol.

Agent

modelinterface Agent

AgentBlueprintReference

modelinterface AgentBlueprintReference

AgentCard

modelinterface AgentCard

AgentCardSkill

modelinterface AgentCardSkill

AgentClusterInsightRequest

Inzichten in de set resultaten van agentevaluatie

AgentClusterInsightResult

Inzichten uit de analyse van de agentcluster.

AgentDataGenerationJobSource

Agent source voor datageneratietaken — verwijst naar een agent om instructies en metadata van op te halen.

AgentDefinition

Basisdefinitie-interface voor agenten. Bevat het type agent en optionele RAI-configuratie.

AgentEndpointAuthorizationScheme

modelinterface AgentEndpointAuthorizationScheme

AgentEndpointConfig

modelinterface AgentEndpointConfig

AgentEvaluatorGenerationJobSource

Agent source voor evaluatorgeneratie-taken — verwijst naar een agent om instructies en metadata van op te halen.

AgentHarness

(Preview) Een beheerde runtime en agent-lus die wordt gebruikt om een prompt-agent uit te voeren.

AgentIdentity

modelinterface AgentIdentity

AgentInsight

Een aanhoudend probleem ontdekt op basis van de sporen van een agent.

AgentInsightDetails

Aanvullende inzichten. Wordt weggelaten tenzij er om details worden gevraagd.

AgentInsightEstimatedCost

Geschatte kosten van Agent Insights.

AgentInsightHighlightedTrace

Een gemarkeerde trace die bewijs levert voor een agentinzicht.

AgentInsightJsonObject

Een JSON-object dat wordt gebruikt in Agent Insights-payloads.

AgentInsightLinkedTrace

Een lichtgewicht trace-referentie gekoppeld aan een agentinzicht als ondersteunend bewijs.

AgentInsightMonitor

Een per-agent Agent Insights-monitor die eigenaar is van configuratie, uitvoeringen en ontdekte inzichten.

AgentInsightMonitorCreate

Velden worden geaccepteerd bij het maken van een Agent Insights-monitor voor een agent.

AgentInsightMonitorListItem

Een Agent Insights-monitorsamenvatting die door lijstoperaties wordt teruggegeven.

AgentInsightMonitorUpdate

Velden die bijgewerkt kunnen worden op een Agent Insights-monitor.

AgentInsightProposedFix

Een aanbevolen oplossing voor een makelaarsinzicht.

AgentInsightProposedFixChange

Een door de klant renderbare wijziging in een voorgestelde oplossing.

AgentInsightRecommendedAction

De aanbevolen remediatie voor een agent inzicht.

AgentInsightRun

Een langlopende run die de traces van één agent analyseert en de inzichten van die agent bijwerkt.

AgentInsightRunCreate

Invoer gebruikt bij het maken van een agent insight runt.

AgentInsightRunResult

Resultaatstatistieken die worden geproduceerd wanneer een agent insight-run slaagt.

AgentInsightSuspension

Gestructureerde reden waarom geplande generatie wordt opgeschort voor een monitor.

AgentInsightTokenUsage

Tokengebruik voor een Agent Insights-run.

AgentInsightUpdate

Velden die bijgewerkt kunnen worden op basis van een agent inzicht.

AgentInsightsOverview

Het effectieve overzicht voor een Agent Insights-monitor.

AgentInsightsOverviewOverride

Een door gebruikers verstrekt overzicht dat direct van kracht wordt en de volgende generatie zaait.

AgentOptimizationAgentCandidateOutput

Kandidaatoutput geproduceerd door een agent-optimalisatieklus.

AgentOptimizationBaselineAgentConfiguration

Door de beller geleverde baseline agentwaarden die niet kunnen worden opgelost vanuit de doelagent.

AgentOptimizationCandidate

Een kandidaat die wordt gegenereerd door een optimalisatiebaan.

AgentOptimizationCandidateEvaluation

Vergelijkende evaluatiesamenvatting voor een kandidaat.

AgentOptimizationCandidateOutput

Basiskandidaat-output. Jobtypes definiëren afgeleide outputmodellen met hun eigen velden.

AgentOptimizationCandidatePromotionInfo

Promotiemetadata die voor een kandidaat is vastgelegd.

AgentOptimizationCandidateSearchConfiguration

Instellingen voor kandidaatzoek.

AgentOptimizationConfiguration

Configuratie om een agent te optimaliseren voor gemeten kwaliteit.

AgentOptimizationConfigurationBase

Basismodel voor type-specifieke optimalisatieconfiguratie.

AgentOptimizationCostEstimate

Geschatte kosten. Alleen aanwezig wanneer ten minste één bijdragend model prijsgegevens heeft.

AgentOptimizationEstimateBand

Een laag/typisch/plafondbereik voor een geschatte hoeveelheid. Verwachte waarden kunnen fractioneel zijn, inclusief geschatte aantal modeloproepen.

AgentOptimizationEstimateInputs

Invoer voor het schatten van een agent-optimalisatieklus.

AgentOptimizationEstimateResult

Resultaat werd teruggegeven bij het schatten van een agent-optimalisatieklus.

AgentOptimizationEvaluationConfiguration

Herbruikbare kwaliteitsmetingsconfiguratie.

AgentOptimizationEvaluationSet

Basis gediscrimineerd model voor een optimalisatie-evaluatieset.

AgentOptimizationEvaluator

Verwijzing naar een benoemde evaluator, optioneel vastgepind aan een versie.

AgentOptimizationFoundryAgentTargetConfiguration

Identificeert de Foundry-agent die eigenaar is van de te optimaliseren configuratie.

AgentOptimizationInstructionsMutation

Instructiemutatie.

AgentOptimizationJob

Agent optimalisatie taakbron — een langlopende taak die kandidaatwijzigingen veroorzaakt in een Foundry agentconfiguratie.

AgentOptimizationJobLatency

Gemiddelde latentie voor één optimalisatiefase en model.

AgentOptimizationJobResult

Gedeeltelijk of eindresultaat geproduceerd door een agentoptimalisatieklus.

AgentOptimizationJobTokenUsage

Geaggregeerd tokengebruik voor één optimalisatiefase en model.

AgentOptimizationModelConfiguration

Identificeert een model dat wordt gebruikt door een optimalisatie- of evaluatiestap.

AgentOptimizationModelMutation

Modelmutatie.

AgentOptimizationMutation

Basiskandidaatmutatie.

AgentOptimizationPromptCandidateOutput

Kandidaatoutput geproduceerd door een prompt-optimalisatieklus.

AgentOptimizationResultCandidateSummary

Overzicht van kandidaten die zijn geproduceerd door een agentoptimalisatieklus.

AgentOptimizationSkill

Een vaardigheid in het handmatig aangeleverde agentoptimalisatieoppervlak.

AgentOptimizationSkillsMutation

Vaardigheidsmutaties.

AgentOptimizationSpace

De agentattributen en alternatieve waarden die beschikbaar zijn voor een agentoptimalisatiezoek.

AgentOptimizationStageEstimate

Geschatte waarden gegroepeerd per optimalisatiefase.

AgentOptimizationTargetCompletionDataSource

Basisbron voor een evaluatieset van doelvoltooiing optimalisatie.

AgentOptimizationTargetCompletionDatasetReferenceDataSource

Verwijst naar een expliciet versiegegradeerde geregistreerde Foundry-dataset voor evaluatie van doelvoltooiing.

AgentOptimizationTargetCompletionEvaluationSet

Evaluatieset met onafhankelijke enkele beurten invoer.

AgentOptimizationTargetCompletionInlineDataSource

Levert direct enkelvoudige rijen in het optimalisatieverzoek.

AgentOptimizationTargetCompletionTestCase

Een enkel item in een inline evaluatieset.

AgentOptimizationTargetConfiguration

Basisdoelconfiguratie voor een optimalisatieklus.

AgentOptimizationToolsMutation

Gereedschapsmutaties.

AgentOptimizationUserConversationSimulationDataSource

Basisbron voor een gebruikersgesprek-simulatie-optimalisatie-evaluatieset.

AgentOptimizationUserConversationSimulationDatasetReferenceDataSource

Verwijst naar een expliciet versiegegradeerde geregistreerde Foundry-dataset voor evaluatie van gebruikersconversatiesimulaties.

AgentOptimizationUserConversationSimulationEvaluationSet

Evaluatieset met scenario's voor gesimuleerde gesprekken.

AgentOptimizationUserConversationSimulationInlineDataSource

Levert Evals-gebruikersconversatiesimulatie-testcases direct in de optimalisatievraag.

AgentReference

modelinterface AgentReference

AgentSessionResource

Een agentsessie die een langlevende compute-sandbox biedt voor gehoste agent-aanroepen.

AgentTaxonomyInput

Invoerconfiguratie voor de evaluatietaxonomie wanneer het invoertype agent is.

AgentVersion

Vertegenwoordigt een specifieke versie van een agent. Omvat metagegevens, versiebeheer, aanmaaktijd en agentdefinitie.

AgenticIdentityPreviewCredentials

Definitie van agentische identiteitsreferenties

AgentsCancelOptimizationJobOptionalParams

Optionele parameters.

AgentsCreateAgentFromManifestOptionalParams

Optionele parameters.

AgentsCreateAgentVersionFromManifestOptionalParams

Optionele parameters.

AgentsCreateOptimizationJobOptionalParams

Optionele parameters.

AgentsCreateOptionalParams

Optionele parameters.

AgentsCreateSessionOptionalParams

Optionele parameters.

AgentsCreateTelephonyBindingOptionalParams

Optionele parameters.

AgentsCreateVersionFromCodeOptionalParams

Optionele parameters.

AgentsCreateVersionOptionalParams

Optionele parameters.

AgentsDeleteOptimizationJobOptionalParams

Optionele parameters.

AgentsDeleteOptionalParams

Optionele parameters.

AgentsDeleteSessionFileOptionalParams

Optionele parameters.

AgentsDeleteSessionOptionalParams

Optionele parameters.

AgentsDeleteTelephonyBindingOptionalParams

Optionele parameters.

AgentsDeleteVersionOptionalParams

Optionele parameters.

AgentsDisableOptionalParams

Optionele parameters.

AgentsDownloadAgentCodeOptionalParams

Optionele parameters.

AgentsDownloadSessionFileOptionalParams

Optionele parameters.

AgentsEnableOptionalParams

Optionele parameters.

AgentsEstimateOptimizationJobOptionalParams

Optionele parameters.

AgentsGetOptimizationCandidateOptionalParams

Optionele parameters.

AgentsGetOptimizationJobOptionalParams

Optionele parameters.

AgentsGetOptionalParams

Optionele parameters.

AgentsGetSessionLogStreamOptionalParams

Optionele parameters.

AgentsGetSessionOptionalParams

Optionele parameters.

AgentsGetTelephonyBindingOptionalParams

Optionele parameters.

AgentsGetVersionOptionalParams

Optionele parameters.

AgentsListOptimizationCandidatesOptionalParams

Optionele parameters.

AgentsListOptimizationJobsOptionalParams

Optionele parameters.

AgentsListOptionalParams

Optionele parameters.

AgentsListSessionFilesOptionalParams

Optionele parameters.

AgentsListSessionsOptionalParams

Optionele parameters.

AgentsListTelephonyBindingsOptionalParams

Optionele parameters.

AgentsListTelephonyCallsOptionalParams

Optionele parameters.

AgentsListVersionsOptionalParams

Optionele parameters.

AgentsOperations

Interface die de operaties van een agent vertegenwoordigt.

AgentsPromoteOptimizationCandidateOptionalParams

Optionele parameters.

AgentsStopSessionOptionalParams

Optionele parameters.

AgentsUpdateAgentFromManifestOptionalParams

Optionele parameters.

AgentsUpdateAgentObjectOptionalParams

Optionele parameters.

AgentsUpdateOptionalParams

Optionele parameters.

AgentsUpdateTelephonyBindingOptionalParams

Optionele parameters.

AgentsUploadSessionFileOptionalParams

Optionele parameters.

ApiErrorResponse

Foutreactie voor API-fouten.

ApiKeyCredentials

Definitie van API-sleutel

ApplyPatchToolParam

Stelt de assistent in staat om bestanden aan te maken, verwijderen of bijwerken met behulp van unified diffs.

ApproximateLocation

modelinterface ApproximateLocation

ArtifactProfile

Artefactprofiel van het model

AutoCodeInterpreterToolParam

Configuratie voor een code-interpretercontainer. Geef desgewenst de id's van de bestanden op waarop de code moet worden uitgevoerd.

AzureAIAgentTarget

Vertegenwoordigt een doel dat een Azure AI-agent specificeert.

AzureAIModelTarget

Vertegenwoordigt een doel dat een Azure AI-model specificeert voor bewerkingen die modelselectie vereisen.

AzureAISearchIndex

Azure AI Zoeken indexdefinitie

AzureAISearchTool

De inputdefinitie-informatie voor een Azure AI-zoektool zoals gebruikt om een agent te configureren.

AzureAISearchToolResource

Een set indexbronnen die worden gebruikt door het hulpprogramma azure_ai_search.

AzureAISearchToolboxTool

Een Azure AI Zoeken-tool opgeslagen in een toolbox.

AzureAgentConfig

Configuratieopties voor het agent-eindpunt van de getOpenAIClient-methode. Voornamelijk gebruikt voor gehoste agenten.

AzureFunctionBinding

De structuur voor het behouden van storage wachtrijnaam en URI.

AzureFunctionDefinition

De definitie van de Azure-functie.

AzureFunctionStorageQueue

De structuur voor het behouden van storage wachtrijnaam en URI.

AzureFunctionTool

De inputdefinitie-informatie voor een Azure Function Tool, zoals gebruikt om een Agent te configureren.

AzureOpenAIModelConfiguration

Azure OpenAI-modelconfiguratie. De API-versie wordt door de service geselecteerd voor het opvragen van het model.

BaseCredentials

Een basisklasse voor verbindingsreferenties

BetaAgentInsightMonitorsCancelRunOptionalParams

Optionele parameters.

BetaAgentInsightMonitorsCreateOptionalParams

Optionele parameters.

BetaAgentInsightMonitorsCreateRunOptionalParams

Optionele parameters.

BetaAgentInsightMonitorsDeleteOptionalParams

Optionele parameters.

BetaAgentInsightMonitorsGetInsightOptionalParams

Optionele parameters.

BetaAgentInsightMonitorsGetOptionalParams

Optionele parameters.

BetaAgentInsightMonitorsGetRunOptionalParams

Optionele parameters.

BetaAgentInsightMonitorsListInsightsOptionalParams

Optionele parameters.

BetaAgentInsightMonitorsListOptionalParams

Optionele parameters.

BetaAgentInsightMonitorsListRunsOptionalParams

Optionele parameters.

BetaAgentInsightMonitorsOperations

Interface die een BetaAgentInsightMonitors-operaties vertegenwoordigt.

BetaAgentInsightMonitorsResetOptionalParams

Optionele parameters.

BetaAgentInsightMonitorsUpdateInsightOptionalParams

Optionele parameters.

BetaAgentInsightMonitorsUpdateOptionalParams

Optionele parameters.

BetaAgentsCreateFromPromptOptionalParams

Optionele parameters.

BetaAgentsOperations

Operaties voor het beheren van agenten.

BetaEvaluationTaxonomiesCreateOptionalParams

Optionele parameters.

BetaEvaluationTaxonomiesDeleteOptionalParams

Optionele parameters.

BetaEvaluationTaxonomiesGetOptionalParams

Optionele parameters.

BetaEvaluationTaxonomiesListOptionalParams

Optionele parameters.

BetaEvaluationTaxonomiesOperations

Interface die een BetaEvaluationTaxonomies-operatie vertegenwoordigt.

BetaEvaluationTaxonomiesUpdateOptionalParams

Optionele parameters.

BetaEvaluatorsGetCredentialsOptionalParams

Optionele parameters.

BetaEvaluatorsOperations

Operaties voor BetaEvaluatorsOperations.

BetaEvaluatorsPendingUploadOptionalParams

Optionele parameters.

BetaInsightsGenerateOptionalParams

Optionele parameters.

BetaInsightsGetOptionalParams

Optionele parameters.

BetaInsightsListOptionalParams

Optionele parameters.

BetaInsightsOperations

Interface die een BetaInsights-operatie vertegenwoordigt.

BetaMemoryStoresCreateMemoryOptionalParams

Optionele parameters.

BetaMemoryStoresCreateOptionalParams

Optionele parameters.

BetaMemoryStoresDeleteMemoryOptionalParams

Optionele parameters.

BetaMemoryStoresDeleteOptionalParams

Optionele parameters.

BetaMemoryStoresDeleteScopeOptionalParams

Optionele parameters.

BetaMemoryStoresGetMemoryOptionalParams

Optionele parameters.

BetaMemoryStoresGetOptionalParams

Optionele parameters.

BetaMemoryStoresGetUpdateResultOptionalParams

Optionele parameters.

BetaMemoryStoresListMemoriesOptionalParams

Optionele parameters.

BetaMemoryStoresListOptionalParams

Optionele parameters.

BetaMemoryStoresOperations

Interface die een BetaMemoryStores-operatie vertegenwoordigt.

BetaMemoryStoresSearchMemoriesOptionalParams

Optionele parameters.

BetaMemoryStoresUpdateMemoriesOptionalParams

Optionele parameters.

BetaMemoryStoresUpdateMemoryOptionalParams

Optionele parameters.

BetaMemoryStoresUpdateOptionalParams

Optionele parameters.

BetaModelsCreateOptions

Opties voor de create-methode die lokale bestanden uploadt en een modelversie registreert.

BetaModelsDeleteOptionalParams

Optionele parameters.

BetaModelsGetCredentialsOptionalParams

Optionele parameters.

BetaModelsGetOptionalParams

Optionele parameters.

BetaModelsListOptionalParams

Optionele parameters.

BetaModelsListVersionsOptionalParams

Optionele parameters.

BetaModelsOperations

Interface die een BetaModels-operatie vertegenwoordigt.

BetaModelsPendingCreateVersionOptionalParams

Optionele parameters.

BetaModelsPendingUploadOptionalParams

Optionele parameters.

BetaModelsUpdateOptionalParams

Optionele parameters.

BetaOperations

Interface die een bèta-operatie vertegenwoordigt.

BetaRedTeamsCreateOptionalParams

Optionele parameters.

BetaRedTeamsGetOptionalParams

Optionele parameters.

BetaRedTeamsListOptionalParams

Optionele parameters.

BetaRedTeamsOperations

Interface die de BetaRedTeams-operaties vertegenwoordigt.

BetaRoutinesCreateOrUpdateOptionalParams

Optionele parameters.

BetaRoutinesDeleteOptionalParams

Optionele parameters.

BetaRoutinesDisableOptionalParams

Optionele parameters.

BetaRoutinesDispatchOptionalParams

Optionele parameters.

BetaRoutinesEnableOptionalParams

Optionele parameters.

BetaRoutinesGetOptionalParams

Optionele parameters.

BetaRoutinesListOptionalParams

Optionele parameters.

BetaRoutinesListRunsOptionalParams

Optionele parameters.

BetaRoutinesOperations

Interface die een BetaRoutines-operatie vertegenwoordigt.

BetaSchedulesCreateOrUpdateOptionalParams

Optionele parameters.

BetaSchedulesDeleteOptionalParams

Optionele parameters.

BetaSchedulesGetOptionalParams

Optionele parameters.

BetaSchedulesGetRunOptionalParams

Optionele parameters.

BetaSchedulesListOptionalParams

Optionele parameters.

BetaSchedulesListRunsOptionalParams

Optionele parameters.

BetaSchedulesOperations

Interface die een BetaSchedules-operatie vertegenwoordigt.

BetaSkillsCreateOptionalParams

Optionele parameters.

BetaSkillsCreateVersionFromFilesOptionalParams

Optionele parameters.

BetaSkillsDeleteOptionalParams

Optionele parameters.

BetaSkillsDeleteVersionOptionalParams

Optionele parameters.

BetaSkillsDownloadOptionalParams

Optionele parameters.

BetaSkillsDownloadVersionOptionalParams

Optionele parameters.

BetaSkillsGetOptionalParams

Optionele parameters.

BetaSkillsGetVersionOptionalParams

Optionele parameters.

BetaSkillsListOptionalParams

Optionele parameters.

BetaSkillsListVersionsOptionalParams

Optionele parameters.

BetaSkillsOperations

Interface die een BetaSkills-operatie vertegenwoordigt.

BetaSkillsUpdateOptionalParams

Optionele parameters.

BetaVoiceAgentsConversationsDeleteOptionalParams

Optionele parameters.

BetaVoiceAgentsConversationsDownloadAudioItemOptionalParams

Optionele parameters.

BetaVoiceAgentsConversationsDownloadAudioOptionalParams

Optionele parameters.

BetaVoiceAgentsConversationsDownloadGeneratedAudioItemOptionalParams

Optionele parameters.

BetaVoiceAgentsConversationsGetAudioItemOptionalParams

Optionele parameters.

BetaVoiceAgentsConversationsGetAudioOptionalParams

Optionele parameters.

BetaVoiceAgentsConversationsGetGeneratedAudioItemOptionalParams

Optionele parameters.

BetaVoiceAgentsConversationsGetItemOptionalParams

Optionele parameters.

BetaVoiceAgentsConversationsGetOptionalParams

Optionele parameters.

BetaVoiceAgentsConversationsGetResponseOptionalParams

Optionele parameters.

BetaVoiceAgentsConversationsListItemsOptionalParams

Optionele parameters.

BetaVoiceAgentsConversationsListOptionalParams

Optionele parameters.

BetaVoiceAgentsConversationsListResponseItemsOptionalParams

Optionele parameters.

BetaVoiceAgentsConversationsListResponsesOptionalParams

Optionele parameters.

BetaVoiceAgentsConversationsOperations

Operations voor het beheren van spraakagentgesprekken.

BetaVoiceAgentsOperations

Operaties voor het beheren van spraakagentgesprekken en telefonie.

BetaVoiceAgentsTelephonyCancelCallJobOptionalParams

Optionele parameters.

BetaVoiceAgentsTelephonyCreateBindingOptionalParams

Optionele parameters.

BetaVoiceAgentsTelephonyCreateCallJobOptionalParams

Optionele parameters.

BetaVoiceAgentsTelephonyDeleteBindingOptionalParams

Optionele parameters.

BetaVoiceAgentsTelephonyEndCallOptionalParams

Optionele parameters.

BetaVoiceAgentsTelephonyGetBindingOptionalParams

Optionele parameters.

BetaVoiceAgentsTelephonyGetCallJobOptionalParams

Optionele parameters.

BetaVoiceAgentsTelephonyGetCallOptionalParams

Optionele parameters.

BetaVoiceAgentsTelephonyGetTransferTargetsOptionalParams

Optionele parameters.

BetaVoiceAgentsTelephonyListBindingsOptionalParams

Optionele parameters.

BetaVoiceAgentsTelephonyListCallsOptionalParams

Optionele parameters.

BetaVoiceAgentsTelephonyOperations

Operaties voor het beheren van spraakagententelefonie.

BetaVoiceAgentsTelephonyReplaceTransferTargetsOptionalParams

Optionele parameters.

BetaVoiceAgentsTelephonyTransferCallOptionalParams

Optionele parameters.

BetaVoiceAgentsTelephonyUpdateBindingOptionalParams

Optionele parameters.

BingCustomSearchConfiguration

Een bing aangepaste zoekconfiguratie.

BingCustomSearchPreviewTool

De informatie over de invoerdefinitie voor een Bing aangepaste zoekfunctie, zoals wordt gebruikt voor het configureren van een agent.

BingCustomSearchToolParameters

De bing aangepaste zoekprogrammaparameters.

BingGroundingSearchConfiguration

Zoekconfiguratie voor Bing Grounding

BingGroundingSearchToolParameters

De bing parameters voor zoekhulpprogramma's.

BingGroundingTool

De informatie over de invoerdefinitie voor een bing grounding search tool zoals wordt gebruikt voor het configureren van een agent.

BlobReference

Details van de blobreferentie.

BotServiceAuthorizationScheme

modelinterface BotServiceAuthorizationScheme

BotServiceRbacAuthorizationScheme

modelinterface BotServiceRbacAuthorizationScheme

BotServiceTenantAuthorizationScheme

modelinterface BotServiceTenantAuthorizationScheme

BrowserAutomationPreviewTool

De invoerdefinitie-informatie voor een Browser Automation Tool, zoals gebruikt om een Agent te configureren.

BrowserAutomationPreviewToolboxTool

Een browserautomatiseringstool opgeslagen in een toolbox.

BrowserAutomationTool

De invoerdefinitie-informatie voor een Browser Automation Tool, zoals gebruikt om een Agent te configureren.

BrowserAutomationToolConnectionParameters

Definitie van invoerparameters voor de verbinding die wordt gebruikt door de Browser Automation Tool.

BrowserAutomationToolParameters

Definitie van invoerparameters voor de Browser Automation Tool.

BrowserAutomationToolboxTool

Een browserautomatiseringstool opgeslagen in een toolbox.

CaptureStructuredOutputsTool

Een tool voor het vastleggen van gestructureerde outputs

ChartCoordinate

Coördinaten voor de analysegrafiek.

ChatCompletionTool

Een functiehulpprogramma dat kan worden gebruikt om een antwoord te genereren.

ChatSummaryMemoryItem

Een geheugenitem met een samenvatting uit gesprekken.

ClusterInsightResult

Inzichten uit de clusteranalyse.

ClusterTokenUsage

Tokengebruik voor clusteranalyse

CodeBasedEvaluatorDefinition

Definitie van een beoordelaar op basis van code met behulp van python-code

CodeConfiguration

Code-gebaseerde deploymentconfiguratie voor een gehoste agent.

CodeInterpreterTool

Een tool die Python-code draait om te helpen bij het genereren van een reactie op een prompt.

CodeInterpreterToolboxTool

Een code-interpretertool opgeslagen in een gereedschapskist.

ComparisonFilter

Een filter dat wordt gebruikt om een opgegeven kenmerksleutel te vergelijken met een bepaalde waarde met behulp van een gedefinieerde vergelijkingsbewerking.

CompoundFilter

Meerdere filters combineren met and of or.

ComputerTool

Een hulpprogramma waarmee een virtuele computer wordt bestuurd. Meer informatie over de computertool.

ComputerUsePreviewTool

Een hulpprogramma waarmee een virtuele computer wordt bestuurd. Meer informatie over de computertool.

Connection

Reactie uit de lijst en verbindingen ophalen bewerkingen

ConnectionsGetOptionalParams

Optionele parameters.

ConnectionsGetWithCredentialsOptionalParams

Optionele parameters.

ConnectionsListOptionalParams

Optionele parameters.

ConnectionsOperations

Interface die een Connections-bewerkingen vertegenwoordigt.

ContainerAutoParam

modelinterface ContainerAutoParam

ContainerConfiguration

Container-gebaseerde deploymentconfiguratie voor een gehoste agent.

ContainerNetworkPolicyAllowlistParam

modelinterface ContainerNetworkPolicyAllowlistParam

ContainerNetworkPolicyDisabledParam

modelinterface ContainerNetworkPolicyDisabledParam

ContainerNetworkPolicyDomainSecretParam

modelinterface ContainerNetworkPolicyDomainSecretParam

ContainerNetworkPolicyParam

Netwerktoegangsbeleid voor de container.

ContainerSkill

modelinterface ContainerSkill

ContinuousEvaluationRuleAction

Evaluatieregelactie voor continue evaluatie.

CosmosDBIndex

Definitie van CosmosDB Vector Store-index

CreateAgentVersionFromCodeContent

Multipart request body voor het updaten of versieëren van een code-gebaseerde agent (POST /agents/{name} en POST /agents/{name}/versies).

CreateAgentVersionFromCodeMetadata

JSON-metadata voor code-gebaseerde agentoperaties (aanmaken, bijwerken, versie maken). De agentnaam komt van de URL-padparameter of de x-ms-agent-name header, dus deze is niet opgenomen in dit model. De inhoudshash (SHA-256 van de zip) wordt in de x-ms-code-zip-sha256 header gedragen.

CreateSkillVersionFromFilesBody

Multipart request body voor het maken van een vaardigheidsversie uit bestanden. Accepteert ofwel één zip-bestand of meerdere individuele vaardigheidsbestanden (directory-upload). Voor zip-uploads extraht en valideert de server de inhoud. Voor directory-uploads worden bestanden gevalideerd as-is.

CreateTeamsPhoneExtensionTelephonyBindingRequest

Het verzoek om een Microsoft Teams-telefoon Extensie-binding aan te maken.

CreateTelephonyBindingRequest

Het verzoek om een telefoniebinding te maken.

CreateTelephonyCallJobRequest

Een verzoek om één duurzame directe uitgaande oproep te creëren.

CreateTranscriptionResponseJsonUsage

Tokengebruiksstatistieken voor het verzoek.

CreateTwilioTelephonyBindingRequest

Het verzoek om een Twilio-binding te maken.

CronTrigger

Cron gebaseerde trigger.

CustomCredential

Definitie van aangepaste referenties

CustomGrammarFormatParam

Een grammatica gedefinieerd door de gebruiker.

CustomRoutineTrigger

Een aangepaste event routine trigger.

CustomTextFormatParam

Onbeperkte vrije vorm tekst.

CustomToolParam

Een aangepaste tool die input verwerkt met een gespecificeerd formaat. Meer informatie over customhulpprogramma's

CustomToolParamFormat

Het invoerformaat voor de aangepaste tool. Standaard is onbeperkte tekst.

DailyRecurrenceSchedule

Dagelijks herhalingsschema.

DataGenerationJob

Bron voor banen voor datageneratie.

DataGenerationJobConfiguration

Configuratie voor het beheren van datageneratietaken.

DataGenerationJobInputs

Door de beller geleverde invoer voor een datageneratietaak.

DataGenerationJobOutput

Output informatie voor een datageneratieklus.

DataGenerationJobResult

Resultaat geproduceerd door een succesvolle datageneratieklus.

DataGenerationJobSource

Het basisbronmodel voor datageneratiebanen.

DataGenerationModelOptions

LLM-modellen voor datageneratie-banen.

DataGenerationTokenUsage

Tokengebruiksinformatie voor een datageneratietaak.

DatasetCredential

Vertegenwoordigt een verwijzing naar een blob voor consumptie

DatasetDataGenerationJobOutput

Dataset-output voor een datageneratieklus.

DatasetEvaluatorGenerationJobSource

Datasetbron voor beoordelaarsgenererende taken — verwijzing naar een dataset.

DatasetReference

Verwijzing naar een versiegevatte Foundry Dataset.

DatasetVersion

Definitie van datasetversie

DatasetsCancelGenerationJobOptionalParams

Optionele parameters.

DatasetsCreateGenerationJobOptionalParams

Optionele parameters.

DatasetsCreateOrUpdateOptionalParams

Optionele parameters.

DatasetsDeleteGenerationJobOptionalParams

Optionele parameters.

DatasetsDeleteOptionalParams

Optionele parameters.

DatasetsGetCredentialsOptionalParams

Optionele parameters.

DatasetsGetGenerationJobOptionalParams

Optionele parameters.

DatasetsGetOptionalParams

Optionele parameters.

DatasetsListGenerationJobsOptionalParams

Optionele parameters.

DatasetsListOptionalParams

Optionele parameters.

DatasetsListVersionsOptionalParams

Optionele parameters.

DatasetsOperations

Interface die een bewerking van datasets vertegenwoordigt.

DatasetsPendingUploadOptionalParams

Optionele parameters.

DeleteAgentResponse

Een verwijderd agentobject

DeleteAgentVersionResponse

Een verwijderde agentversie Object

DeleteMemoryResponse

Reactie voor het verwijderen van een geheugenitem uit een geheugenopslag.

DeleteMemoryStoreResponse

modelinterface DeleteMemoryStoreResponse

DeleteSkillResponse

Een verwijderde vaardigheid.

DeleteSkillVersionResponse

Een verwijderde vaardigheidsversie.

Deployment

Definitie van modelimplementatie

DeploymentsGetOptionalParams

Optionele parameters.

DeploymentsListOptionalParams

Optionele parameters.

DeploymentsOperations

Interface die een implementatiebewerkingen vertegenwoordigt.

Dimension

Een enkele dimensie — één onafhankelijke, meetbare kwaliteitsdimensie binnen het beoordelingsschema van een beoordelingsbeoordelaar.

DispatchRoutineResponse

Identifiers worden teruggegeven nadat een routinematige dispatch in de wachtrij is gezet.

EmbeddingConfiguration

Configuratieklasse insluiten

EmptyModelParam

modelinterface EmptyModelParam

EndpointBasedEvaluatorDefinition

Definitie van een endpoint-gebaseerde evaluator. De klant bezit en host een HTTP-endpoint dat het evaluatiecontract implementeert. De evaluator verwijst naar een Project Connection bij naam; de verbinding slaat de endpoint-URL en inloggegevens (API-sleutel of Entra ID) op. Tijdens de uitvoering lost de service de verbinding op om de endpoint-URL en authenticatiegegevens te verkrijgen, waarna het endpoint voor elke evaluatierij wordt aangeroepen.

EntraAuthorizationScheme

modelinterface EntraAuthorizationScheme

EntraIDCredentials

Entra ID credential definitie

ErrorModel

modelinterface ErrorModel

EvalResult

Resultaat van de evaluatie.

EvalRunResultCompareItem

Metrische vergelijking voor een behandeling ten opzichte van de baseline.

EvalRunResultComparison

Vergelijkingsresultaten voor behandeling lopen tegen de uitgangswaarde.

EvalRunResultSummary

Samenvattende statistieken van een metrische waarde in een evaluatierun.

EvaluationAzureStandardVoiceModelConfiguration

Configureert een Azure-standaard neurale stem die wordt gebruikt om tekst naar spraak om te zetten voor evaluatie via het Voice Live-eindpunt.

EvaluationComparisonInsightRequest

Evaluatie Vergelijking Aanvraag

EvaluationComparisonInsightResult

Inzichten uit de evaluatievergelijking.

EvaluationDataGenerationJob

Bron voor het genereren van evaluatiegegevens.

EvaluationDataGenerationJobInputs

Door de beller geleverde invoer voor een evaluatiedata-genererende taak.

EvaluationDataGenerationJobOutputConfiguration

Dataset-uitvoerconfiguratie voor een evaluatiedatageneratietaak.

EvaluationModelConfiguration

Stel het model in dat de gesimuleerde gebruiker afspeelt. Dit model staat los van het geëvalueerde target.

EvaluationResultSample

Een greep uit het evaluatieresultaat.

EvaluationRule

Model voor evaluatieregels.

EvaluationRuleAction

Evaluatie actiemodel.

EvaluationRuleFilter

Evaluatie filtermodel.

EvaluationRulesCreateOrUpdateOptionalParams

Optionele parameters.

EvaluationRulesDeleteOptionalParams

Optionele parameters.

EvaluationRulesGetOptionalParams

Optionele parameters.

EvaluationRulesListOptionalParams

Optionele parameters.

EvaluationRulesOperations

Interface die een EvaluationRules-bewerkingen vertegenwoordigt.

EvaluationRunClusterInsightRequest

Inzichten in de set evaluatieresultaten

EvaluationRunClusterInsightResult

Inzichten uit de evaluatie voeren clusteranalyse uit.

EvaluationScheduleTask

Evaluatietaak voor het rooster.

EvaluationTarget

Basisklasse voor doelen met discriminatorondersteuning.

EvaluationTaxonomy

Evaluatie taxonomie definitie

EvaluationTaxonomyInput

Invoerconfiguratie voor de evaluatietaxonomie.

EvaluationVoiceModelConfiguration

Spraakconfiguratie gebruikt om tekst naar spraak om te zetten voor evaluatie via het Voice Live-eindpunt.

EvaluatorCredentialRequest

Verzoek om het orgaan om de beoordelaarsgegevens te verkrijgen

EvaluatorDefinition

Configuratie van basisbeoordelaar met discriminator

EvaluatorGenerationArtifacts

Service-beheerde herkomstartefacten geproduceerd door een evaluatorgeneratieklus. Alleen aanwezig op EvaluatorVersion-bronnen die via de generatiepijplijn zijn gemaakt. De gecombineerde-JSONL Foundry Dataset is alleen-lezen en wordt opgelost naar een versiegereserveerde dataset in een service-reserved namespace.

EvaluatorGenerationInputs

Door de beller geleverde invoer voor een evaluatorgeneratietaak.

EvaluatorGenerationJob

Evaluator Generatie Job resource — een langlopende baan die op rubric-gebaseerde evaluatordefinities genereert uit bronmateriaal. Bij succes is het resultaat de persistent EvaluatorVersion.

EvaluatorGenerationJobSource

Het basisbronmodel voor begeleidingsbanen voor evaluatorgeneratie. Polymorf over type.

EvaluatorGenerationTokenUsage

Tokenconsumptie-samenvatting voor een taak als evaluator genereren. Gevuld wanneer de functie een terminale status bereikt.

EvaluatorMetric

Evaluator metriek

EvaluatorVersion

Definitie van evaluator

EvaluatorsCancelGenerationJobOptionalParams

Optionele parameters.

EvaluatorsCreateGenerationJobOptionalParams

Optionele parameters.

EvaluatorsCreateVersionOptionalParams

Optionele parameters.

EvaluatorsDeleteGenerationJobOptionalParams

Optionele parameters.

EvaluatorsDeleteVersionOptionalParams

Optionele parameters.

EvaluatorsGetGenerationJobOptionalParams

Optionele parameters.

EvaluatorsGetVersionOptionalParams

Optionele parameters.

EvaluatorsListGenerationJobsOptionalParams

Optionele parameters.

EvaluatorsListOptionalParams

Optionele parameters.

EvaluatorsListVersionsOptionalParams

Optionele parameters.

EvaluatorsOperations

Operaties voor EvaluatorsOperaties.

EvaluatorsUpdateVersionOptionalParams

Optionele parameters.

ExternalAgentDefinition

De definitie van externe agent. Vertegenwoordigt een externe agent die buiten Foundry wordt gehost (bijvoorbeeld op GCP of AWS). Registratie is uitsluitend metadata: Foundry registreert de agentdefinitie om observabiliteitservaringen (traces, evaluaties) te verlichten over door klanten uitgezonden OpenTelemetrie-gegevens.

FabricDataAgentToolParameters

De parameters van de fabric data agent.

FabricIQPreviewTool

Een FabricIQ-server-side tool.

FabricIQPreviewToolboxTool

Een FabricIQ-tool opgeslagen in een gereedschapskist.

FieldMapping

Configuratieklasse voor veldtoewijzing

FileDataGenerationJobOutput

Azure OpenAI-bestandsuitvoer voor een datageneratietaak.

FileDataGenerationJobSource

Bestandsbron voor datageneratietaken — Azure OpenAI bestandsinvoer.

FileDatasetVersion

Definitie van FileDatasetVersion

FileSearchTool

Een hulpprogramma waarmee wordt gezocht naar relevante inhoud uit geüploade bestanden. Meer informatie over de tool voor het zoeken naar bestanden.

FileSearchToolboxTool

Een bestandszoektool opgeslagen in een gereedschapskist.

FixedRatioVersionSelectionRule

modelinterface FixedRatioVersionSelectionRule

FolderDatasetVersion

Definitie van FileDatasetVersion

FoundryModelWarning

Een waarschuwing die bij een model hoort.

FunctionObject

modelinterface FunctionObject

FunctionParameters

De parameters die door de functies worden geaccepteerd, worden beschreven als een JSON-schemaobject. Zie de handleiding voor voorbeelden en de naslaginformatie over het JSON-schema voor documentatie over de indeling. Als u parameters weglaat, wordt een functie met een lege parameterlijst gedefinieerd.

FunctionShellToolParam

Een tool waarmee het model shell-commando's kan uitvoeren.

FunctionShellToolParamEnvironment

modelinterface FunctionShellToolParamEnvironment

FunctionShellToolParamEnvironmentContainerReferenceParam

modelinterface FunctionShellToolParamEnvironmentContainerReferenceParam

FunctionShellToolParamEnvironmentLocalEnvironmentParam

modelinterface FunctieShellToolParamEnvironmentLocalEnvironmentParam

FunctionTool

Definieert een functie in uw eigen code die het model kan aanroepen. Meer informatie over het aanroepen van functies.

FunctionToolParam

modelinterface FunctionToolParam

GenAITracingOptions

Opties voor het configureren van GenAI-tracering op een specifieke AIProjectClient-instantie.

Geef deze onder de tracingOptions sleutel van AIProjectClientOptionalParams om GenAI-tracering mogelijk te maken wanneer de client wordt geïnstantieerd. Elke clientinstantie onderhoudt zijn eigen onafhankelijke traceerconfiguratie.

GenerateVoiceAgentRequest

De invoer voor het genereren van een spraakagent. Alleen kind en name zijn altijd verplicht. De authoring-service breidt deze invoer uit tot een volledig, bewerkbaar VoiceAgentDefinition, dat vervolgens wordt aangemaakt via POST /agents. De gegenereerde instructions en audio/spraakinstellingen worden als aparte velden opgeslagen in de resulterende agentdefinitie, zodat de beller ze later kan bewerken of overschrijven via standaard agentversiebeheer.

GetMicrosoft365PackageOptionalParams

Optionele parameters.

GetMicrosoft365PublishDefaultsOptionalParams

Optionele parameters.

GitHubCopilotHarness

(Preview) De GitHub Copilot beheerde het harnas voor promptagenten.

GitHubCopilotToolsetConfig

Een enablement-override voor een ingebouwde tool van GitHub Copilot.

GitHubCopilotToolsetDefaultConfig

De standaard inactivatie-instelling voor de ingebouwde tools van GitHub Copilot.

GitHubCopilotToolsetPreview

(Preview) Configuratie-overrides voor GitHub Copilot ingebouwde tools.

GitHubIssueRoutineTrigger

Een GitHub-issue routine-trigger.

HeaderTelemetryEndpointAuth

Header-gebaseerde geheime authenticatie voor een telemetrie-endpoint. De opgeloste geheime waarde wordt geïnjecteerd als een HTTP-header.

HostedAgentDefinition

De definitie van de gehoste agent.

HourlyRecurrenceSchedule

Herhalingsschema per uur.

HumanEvaluationPreviewRuleAction

Evaluatieregelactie voor menselijke evaluatie.

HybridSearchOptions

modelinterface HybridSearchOptions

ImageGenTool

Een tool die afbeeldingen genereert met behulp van de GPT-beeldmodellen.

ImageGenToolInputImageMask

modelinterface ImageGenToolInputImageMask

IndexesCreateOrUpdateOptionalParams

Optionele parameters.

IndexesDeleteOptionalParams

Optionele parameters.

IndexesGetOptionalParams

Optionele parameters.

IndexesListOptionalParams

Optionele parameters.

IndexesListVersionsOptionalParams

Optionele parameters.

IndexesOperations

Interface die een Indexes-bewerkingen vertegenwoordigt.

InlineSkillParam

modelinterface InlineSkillParam

InlineSkillSourceParam

Inline vaardigheidslading

Insight

De antwoordbody voor clusterinzichten.

InsightCluster

Een cluster van analysemonsters.

InsightGenerationRequest

Het verzoeklichaam om een inzicht te genereren.

InsightModelConfiguration

Configuratie van het model dat wordt gebruikt bij het genereren van inzichten.

InsightRequest

De aanvraag van het inzichtenrapport.

InsightResult

Het resultaat van de inzichten.

InsightSample

Een voorbeeld uit de analyse.

InsightScheduleTask

Inzichttaak voor het rooster.

InsightSummary

Samenvatting van de analyse van het foutencluster.

InsightsMetadata

Metadata over de inzichten.

InvocationsProtocolConfiguration

Configuratie specifiek voor het invocations-protocol.

InvocationsWsProtocolConfiguration

Configuratie specifiek voor het WebSocket-gebaseerde invocationsprotocol.

InvokeAgentInvocationsApiDispatchPayload

Een handmatige payload die wordt gebruikt om een invocations API-routine dispatch te testen.

InvokeAgentInvocationsApiRoutineAction

Stuurt een routine via de ruwe aanroep-API. Precies één van agent_name of agent_endpoint_id moet worden verstrekt.

InvokeAgentResponsesApiDispatchPayload

Een handmatige payload die wordt gebruikt om de routinedispatch van een response-API te testen.

InvokeAgentResponsesApiRoutineAction

Stuurt een routine via de responses-API. Precies één van agent_name of agent_endpoint_id moet worden verstrekt.

JobOperationState

Operationele status voor een langlopende operatie die een taakbron creëert.

AANPASSING: SDK-VERBETERING: de uitgezonden pollers lossen zich op naar de terminale result payload van de job, die geen identificatie bevat; jobId houdt de aangemaakte job bereikbaar.

LocalShellToolParam

Een hulpprogramma waarmee het model shell-opdrachten kan uitvoeren in een lokale omgeving.

LocalSkillParam

modelinterface LocalSkillParam

LogProbProperties

Een log-kansobject.

LoraConfig

Adapter-specifieke metadata voor LoRA-modellen. Drives die de motorconfiguratie tijdens de inzet bedienen.

MCPListToolsTool

Een hulpprogramma dat beschikbaar is op een MCP-server.

MCPListToolsToolAnnotations

modelinterface MCPListToolsToolAnnotaties

MCPListToolsToolInputSchema

modelinterface MCPListToolsToolInputSchema

MCPTool

Geef het model toegang tot aanvullende tools via externe MCP-servers (Model Context Protocol). Meer informatie over MCP.

MCPToolFilter

Een filterobject om aan te geven welke tools zijn toegestaan.

MCPToolRequireApproval

modelinterface MCPToolRequireApproval

MCPToolboxTool

Een MCP-tool opgeslagen in een gereedschapskist.

ManagedAgentIdentityBlueprintReference

modelinterface ManagedAgentIdentityBlueprintReference

ManagedAzureAISearchIndex

Definitie van beheerde Azure AI Zoeken-index

McpProtocolConfiguration

Configuratie specifiek voor het MCP-protocol.

MemoryItem

Een enkel geheugenitem dat is opgeslagen in het geheugenarchief en dat inhoud en metadata bevat.

MemoryOperation

Vertegenwoordigt een enkele geheugenbewerking (maken, bijwerken of verwijderen) die wordt uitgevoerd op een geheugenitem.

MemorySearchItem

Een opgehaald geheugenitem uit het geheugen zoeken.

MemorySearchOptions

Zoekopties voor geheugen.

MemorySearchPreviewTool

Een hulpmiddel om herinneringen in de agent te integreren.

MemoryStore

Een geheugenarchief dat gebruikersgeheugens kan opslaan en ophalen.

MemoryStoreDefaultDefinition

Implementatie van standaardgeheugenopslag.

MemoryStoreDefaultOptions

Standaard configuraties voor geheugenopslag.

MemoryStoreDefinition

Basisdefinitie voor configuraties van geheugenopslag.

MemoryStoreDeleteScopeResponse

Antwoord voor het verwijderen van herinneringen uit een scope.

MemoryStoreOperationUsage

Gebruiksstatistieken van een geheugenopslagbewerking.

MemoryStoreSearchResponse

Antwoord op geheugenzoekopdrachten.

MemoryStoreUpdateCompletedResult

Resultaat geheugenupdate.

MemoryStoreUpdateResponse

Geeft de status weer van een updatebewerking voor het geheugenarchief.

Metadata

Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling en het opvragen van objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.

Microsoft365PermissionScopes

Een set gedelegeerde permissiescopes die worden aangevraagd bij een enkele resource-applicatie.

Microsoft365PublishDefaults

Standaard- en eerder gepubliceerde waarden die worden gebruikt om een Microsoft 365 publicatieverzoek voor een Foundry-agent vooraf in te vullen.

Microsoft365PublishResponse

Reactie van het publiceren van een agent naar Microsoft 365 / Microsoft Teams.

MicrosoftFabricPreviewTool

De inputdefinitie-informatie voor een Microsoft Fabric-tool zoals gebruikt om een agent te configureren.

MisalignmentErrorDetailsResource

Details van een actie worden geblokkeerd omdat deze mogelijk niet overeenkomt met de intentie van de gebruiker.

MisalignmentSteer

Een openbare instructie om door te gaan nadat een actie is geblokkeerd.

ModelCredentialRequest

Verzoek om credentials op te halen voor een model-asset.

ModelDeployment

Definitie van modelimplementatie

ModelDeploymentSku

SKU-informatie

ModelPendingUploadRequest

Vertegenwoordigt een verzoek voor een hangende upload van een modelversie.

ModelPendingUploadResponse

Geeft het antwoord voor een model dat in behandeling is om een uploadverzoek te ontvangen.

ModelSamplingParams

Vertegenwoordigt een set parameters die worden gebruikt voor het bepalen van het steekproefgedrag van een taalmodel tijdens het genereren van tekst.

ModelSourceData

Broninformatie voor het model

ModelVersion

Definitie van modelversie

MonthlyRecurrenceSchedule

Maandelijks herhalingsschema.

NamespaceToolParam

Groepfunctie/aangepaste tools onder een gedeelde naamruimte.

NoAuthenticationCredentials

Referenties waarvoor geen verificatie is vereist

OneTimeTrigger

Eenmalige trigger.

OpenAIClientOptionsWithAzureAgent

Uitgebreide OpenAI-clientopties om de configuratie van Azure Agent-endpoints op te nemen.

OpenApiAnonymousAuthDetails

Beveiligingsdetails voor anonieme OpenApi-verificatie

OpenApiAuthDetails

verificatiedetails voor OpenApiFunctionDefinition

OpenApiFunctionDefinition

De informatie over de invoerdefinitie voor een openapi-functie.

OpenApiManagedAuthDetails

Beveiligingsdetails voor OpenApi managed_identity-verificatie

OpenApiManagedSecurityScheme

Beveiligingsschema voor OpenApi managed_identity-verificatie

OpenApiProjectConnectionAuthDetails

Beveiligingsdetails voor OpenApi project-verbindingsverificatie

OpenApiProjectConnectionSecurityScheme

Beveiligingsschema voor OpenApi managed_identity-verificatie

OpenApiTool

De informatie over de invoerdefinitie voor een OpenAPI-hulpprogramma zoals wordt gebruikt voor het configureren van een agent.

OpenApiToolboxTool

Een OpenAPI-tool opgeslagen in een gereedschapskist.

OptimizationContext

Basismodel voor getypeerde optimalisatiecontext.

OtlpTelemetryEndpoint

Een OTLP (OpenTelemetry Protocol) telemetrie-export-endpoint.

PageSettings

Een interface waarmee de instellingen voor gepaginade iteratie worden bijgehouden

PagedAsyncIterableIterator

Een interface waarmee asynchrone iteratie zowel kan worden voltooid als per pagina.

PendingUploadRequest

Vertegenwoordigt een aanvraag voor een upload die in afwachting is.

PendingUploadResponse

Vertegenwoordigt het antwoord op een in behandeling zijnde uploadaanvraag

PickPropertiesVoiceAgentAudioConfig

Het sjabloon voor het kiezen van woningen.

ProceduralMemoryItem

Een geheugenitem met een procedure die uit gesprekken is gehaald.

ProgrammaticToolCallingParam

modelinterface ProgrammaticToolCallingParam

PromptAgentDefinition

De definitie van de promptagent

PromptAgentDefinitionTextOptions

Configuratieopties voor een tekstantwoord van het model. Dit kunnen tekst zonder opmaak of gestructureerde JSON-gegevens zijn.

PromptBasedEvaluatorDefinition

Prompt-gebaseerde evaluator

PromptDataGenerationJobSource

Promptbron voor datageneratietaken — inline tekst geleverd door de gebruiker.

PromptEvaluatorGenerationJobSource

Promptbron voor evaluatorgeneratietaken — inline tekst geleverd door de gebruiker.

PromptOptimizationConfiguration

Configuratie voor een eenmalige prompttransformatie zonder vergelijkende evaluatie.

ProtocolConfiguration

Per-protocol configuratie voor het agent-eindpunt.

ProtocolVersionRecord

Een recordtoewijzing voor een enkel protocol en de versie ervan.

PstnTelephonyTransferDestination

Een PSTN-bestemming voor een telefonie-overdrachtsdoel.

PublishToMicrosoft365OptionalParams

Optionele parameters.

RaiConfig

Configuratie voor Responsible AI (RAI) contentfiltering en veiligheidsfuncties.

RaiInvocationModeration

Geeft aan waar verzoek-/antwoordtekst zich bevindt zodat inhoudsveiligheidsmaatregelen deze kunnen extraheren.

RaiSseTextSelector

Een SSE-gebeurtenistype-naar-tekstveldselector voor het streamen van aanroepuitvoer.

RankingOptions

modelinterface RankingOptions

RealtimeAudioFormats

modelinterface RealtimeAudioFormats

RealtimeAudioFormatsAudioPcm

modelinterface RealtimeAudioFormatsAudioPcm

RealtimeAudioFormatsAudioPcma

modelinterface RealtimeAudioFormatsAudioPcma

RealtimeAudioFormatsAudioPcmu

modelinterface RealtimeAudioFormatsAudioPcmu

RealtimeClientEvent

Een realtime klantevenement.

RealtimeClientEventConversationItemCreate

Voeg een nieuw item toe aan de context van het gesprek, inclusief berichten, functieaanroepen en functieoproepantwoorden. Dit event kan zowel worden gebruikt om een "geschiedenis" van het gesprek te vullen als om nieuwe items halverwege de stream toe te voegen, maar heeft de huidige beperking dat het geen assistent-audioberichten kan invullen. Als het lukt, reageert de server met een conversation.item.created gebeurtenis, anders wordt er een error gebeurtenis verzonden.

RealtimeClientEventConversationItemDelete

Stuur dit evenement wanneer je een item uit de gespreksgeschiedenis wilt verwijderen. De server zal reageren met een conversation.item.deleted gebeurtenis, tenzij het item niet in de gespreksgeschiedenis staat, in welk geval de server met een foutmelding zal reageren.

RealtimeClientEventConversationItemRetrieve

Stuur dit event wanneer je de weergave van een specifiek item van de server in de gespreksgeschiedenis wilt ophalen. Dit is bijvoorbeeld nuttig om gebruikersaudio te inspecteren na ruisonderdrukking en VAD. De server zal reageren met een conversation.item.retrieved gebeurtenis, tenzij het item niet in de gespreksgeschiedenis staat, in welk geval de server met een foutmelding zal reageren.

RealtimeClientEventConversationItemTruncate

Stuur dit evenement om het geluid van een eerder assistent-bericht in te korten. De server produceert audio sneller dan realtime, dus dit event is nuttig wanneer de gebruiker onderbreekt om audio die al naar de client is gestuurd maar nog niet is afgespeeld, af te korten. Dit synchroniseert het begrip van de server van de audio met de weergave van de client. Het afkappen van audio verwijdert de server-side teksttranscript om te garanderen dat er geen tekst in de context is die de gebruiker niet heeft gehoord. Als het lukt, reageert de server met een conversation.item.truncated gebeurtenis.

RealtimeClientEventInputAudioBufferAppend

Stuur dit event om audiobytes toe te voegen aan de input-audiobuffer. De audiobuffer is tijdelijke opslag waarnaar u kunt schrijven en later doorvoeren. Een "commit" maakt een nieuw gebruikersbericht aan in de conversatiegeschiedenis vanuit de bufferinhoud en wist de buffer. Input-audiotranscriptie (indien ingeschakeld) wordt gegenereerd wanneer de buffer wordt gecommit. Als VAD is ingeschakeld, wordt de audiobuffer gebruikt om spraak te detecteren en bepaalt de server wanneer hij commit. Wanneer Server VAD is uitgeschakeld, moet je de audiobuffer handmatig committen. Geluidreductie van invoer werkt bij het schrijven naar de audiobuffer. De client kan kiezen hoeveel audio hij in elk event plaatst tot maximaal 15 MiB; bijvoorbeeld kan het streamen van kleinere stukken van de client de VAD responsiever maken. In tegenstelling tot de meeste andere clientevenementen stuurt de server geen bevestigingsantwoord op dit evenement.

RealtimeClientEventInputAudioBufferClear

Stuur dit event om de audiobytes in de buffer te wissen. De server reageert met een input_audio_buffer.cleared gebeurtenis.

RealtimeClientEventInputAudioBufferCommit

Stuur dit event om de gebruikersinvoer audiobuffer te committen, wat een nieuw gebruikersberichtitem in het gesprek aanmaakt. Dit event zal een fout veroorzaken als de input-audiobuffer leeg is. Wanneer de server VAD-modus is, hoeft de client dit event niet te verzenden; de server committeert automatisch de audiobuffer. Het committen van de input audio buffer zal input audio transcriptie triggeren (indien ingeschakeld in de sessieconfiguratie), maar het genereert geen respons van het model. De server reageert met een input_audio_buffer.committed gebeurtenis.

RealtimeClientEventOutputAudioBufferClear

Alleen WebRTC/SIP: Emit om de huidige audiorespons af te snijden. Dit zorgt ervoor dat de server stopt met het genereren van audio en een output_audio_buffer.cleared event uitzendt. Deze gebeurtenis moet worden voorafgegaan door een response.cancel clientgebeurtenis om het genereren van het huidige antwoord te stoppen. Meer informatie.

RealtimeClientEventResponseCancel

Stuur dit evenement om een lopende reactie te annuleren. De server reageert met een response.done gebeurtenis met de status .response.status=cancelled Als er geen reactie is om te annuleren, reageert de server met een foutmelding. Het is veilig om te bellen response.cancel , zelfs als er geen reactie in gang is, een foutmelding wordt teruggegeven en blijft de sessie onaangetast.

RealtimeClientEventResponseCreate

Dit event instrueert de server om een Response te maken, wat betekent dat modelinferentie wordt geactiveerd. Wanneer de server in Server VAD-modus staat, maakt de server automatisch antwoorden aan. Een Response bevat ten minste één Item, en kan er twee hebben, in welk geval de tweede een functieaanroep zal zijn. Deze items worden standaard aan de gespreksgeschiedenis toegevoegd. De server reageert met een response.created gebeurtenis, gebeurtenissen voor Items en gemaakte content, en tenslotte een response.done gebeurtenis om aan te geven dat de reactie voltooid is. De response.create gebeurtenis bevat inferentieconfiguraties zoals instructions en tools. Als deze zijn ingesteld, zullen ze alleen de configuratie van de sessie voor deze reactie overschrijven. Reacties kunnen buiten de standaard Conversation worden aangemaakt, wat betekent dat ze willekeurige input kunnen hebben, en het is mogelijk om het schrijven van de output naar de Conversation uit te schakelen. Er kan slechts één Response tegelijk naar het standaard Conversation worden geschreven, maar verder kunnen meerdere Responses parallel worden aangemaakt. Het metadata veld is een goede manier om meerdere gelijktijdige antwoorden te onderscheiden. Clients kunnen instellen conversation op none om een Response te maken die niet naar de standaard Conversation schrijft. Willekeurige invoer kan worden geleverd met het input veld, dat een array is die ruwe items en verwijzingen naar bestaande items accepteert.

RealtimeConversationItem

Eén item in een Realtime-gesprek.

RealtimeConversationItemFunctionCall

Een functie-aanroepitem in een realtime gesprek.

RealtimeConversationItemFunctionCallOutput

Een functie call outputitem in een realtime conversatie.

RealtimeConversationItemMessage

modelinterface RealtimeConversationItemMessage

RealtimeConversationItemMessageAssistant

Een assistent-bericht in een realtime gesprek.

RealtimeConversationItemMessageAssistantContent

modelinterface RealtimeConversationItemMessageAssistantContent

RealtimeConversationItemMessageSystem

Een systeembericht in een realtime conversatie kan worden gebruikt om extra context of instructies aan het model te geven. Dit is vergelijkbaar maar verschillend van de instructieprompt die aan het begin van een gesprek wordt gegeven, omdat systeemberichten op elk moment in het gesprek kunnen worden toegevoegd. Voor grote veranderingen in het gedrag van het gesprek gebruik je instructies, maar voor kleinere updates (bijvoorbeeld "de gebruiker vraagt nu naar een ander onderwerp"), gebruik systeemberichten.

RealtimeConversationItemMessageSystemContent

modelinterface RealtimeConversationItemMessageSystemInhoud

RealtimeConversationItemMessageUser

Een gebruikersbericht in een realtime conversatie.

RealtimeConversationItemMessageUserContent

modelinterface RealtimeConversationItemMessageUserContent

RealtimeFunctionTool

modelinterface RealtimeFunctionTool

RealtimeMCPApprovalRequest

Een Realtime item dat menselijke goedkeuring vraagt voor een tool-invocation.

RealtimeMCPApprovalResponse

Een Realtime item dat reageert op een MCP-goedkeuringsverzoek.

RealtimeMCPError

modelinterface RealtimeMCPError

RealtimeMCPHttpError

modelinterface RealtimeMCPHttpError

RealtimeMCPListTools

Een Realtime itemlijsttool beschikbaar op een MCP-server.

RealtimeMCPProtocolError

modelinterface RealtimeMCPProtocolError

RealtimeMCPToolCall

Een Realtime-item dat een aanroep van een tool op een MCP-server vertegenwoordigt.

RealtimeMCPToolExecutionError

modelinterface RealtimeMCPToolExecutionError

RealtimeReasoning

Configuratie voor realtime-modellen die redeneerbaar zijn, zoals gpt-realtime-2.

RealtimeResponseStatusDetails

modelinterface RealtimeResponseStatusDetails

RealtimeResponseStatusDetailsError

modelinterface RealtimeResponseStatusDetailsError

RealtimeResponseUsage

modelinterface RealtimeResponseUsage

RealtimeResponseUsageInputTokenDetails

modelinterface RealtimeResponseUsageInputTokenDetails

RealtimeResponseUsageInputTokenDetailsCachedTokensDetails

modelinterface RealtimeResponseUsageInputTokenDetailsGecachedTokenDetails

RealtimeResponseUsageOutputTokenDetails

modelinterface RealtimeResponseUsageOutputTokenDetails

RealtimeServerEvent

Een realtime servergebeurtenis.

RealtimeServerEventConversationItemAdded

Verzonden door de server wanneer een Item wordt toegevoegd aan de standaard Conversation. Dit kan in verschillende gevallen gebeuren:

  • Wanneer de klant een conversation.item.create evenement stuurt.
  • Wanneer de input-audiobuffer wordt toegewijd. In dit geval zal het item een gebruikersbericht zijn met de audio uit de buffer.
  • Wanneer het model een Response genereert. In dit geval wordt het conversation.item.added event verzonden wanneer het model begint met het genereren van een specifiek Item, en zal het dus nog geen inhoud hebben (en status zal het zijn in_progress). Het event bevat de volledige inhoud van het item (behalve wanneer het model een Response genereert), behalve audiodata, die indien nodig apart met een conversation.item.retrieve event kunnen worden opgehaald.
RealtimeServerEventConversationItemCreated

Wordt teruggegeven wanneer er een conversatie-item wordt aangemaakt. Er zijn verschillende scenario's die deze gebeurtenis produceren:

  • De server genereert een Antwoord, dat als het lukt één of twee Items oplevert, die van type message (rol assistant) of type function_callzijn.
  • De input audio buffer is gecommit, hetzij door de client of de server (in server_vad modus). De server neemt de inhoud van de invoer-audiobuffer en voegt deze toe aan een nieuw gebruikersbericht-item.
  • De klant heeft een conversation.item.create event gestuurd om een nieuw item aan het gesprek toe te voegen.
RealtimeServerEventConversationItemDeleted

Teruggebracht wanneer een item in het gesprek door de client wordt verwijderd met een conversation.item.delete gebeurtenis. Deze gebeurtenis wordt gebruikt om het begrip van de gespreksgeschiedenis van de server te synchroniseren met de weergave van de client.

RealtimeServerEventConversationItemDone

Teruggestuurd wanneer een gespreksonderwerp is afgerond. Het evenement bevat de volledige inhoud van het Item, behalve audiogegevens, die indien nodig apart met een conversation.item.retrieve gebeurtenis kunnen worden opgehaald.

RealtimeServerEventConversationItemInputAudioTranscriptionCompleted

Dit event is de output van audiotranscriptie voor gebruikersaudio geschreven naar de gebruikersaudiobuffer. Transcriptie begint wanneer de invoeraudiobuffer wordt doorgevoerd door de client of server (wanneer VAD is ingeschakeld). Transcriptie verloopt asynchroon met het aanmaken van Response, dus dit event kan vóór of na de Response-events plaatsvinden. Realtime API-modellen accepteren audio native, en dus is invoertranscriptie een apart proces dat draait op een apart ASR (Automatic Speech Recognition) model. Het transcript kan enigszins afwijken van de interpretatie van het model en moet als een ruwe richtlijn worden behandeld.

RealtimeServerEventConversationItemInputAudioTranscriptionDelta

Wordt teruggegeven wanneer de tekstwaarde van een invoer audiotranscriptie-inhoud wordt bijgewerkt met incrementele transcriptieresultaten.

RealtimeServerEventConversationItemInputAudioTranscriptionFailed

Teruggegeven wanneer de invoer audiotranscriptie is geconfigureerd en een transcriptieverzoek voor een gebruikersbericht mislukte. Deze gebeurtenissen zijn gescheiden van andere error gebeurtenissen, zodat de cliënt het gerelateerde Item kan identificeren.

RealtimeServerEventConversationItemInputAudioTranscriptionFailedError

modelinterface RealtimeServerEventConversationItemInputAudioTranscriptionFailedError

RealtimeServerEventConversationItemInputAudioTranscriptionSegment

Teruggegeven wanneer een input audio-transcriptiesegment voor een item wordt geïdentificeerd.

RealtimeServerEventConversationItemRetrieved

Teruggebracht wanneer een gespreksitem wordt opgehaald met conversation.item.retrieve. Dit wordt aangeboden als een manier om de weergave van een item van de server op te halen, bijvoorbeeld om toegang te krijgen tot de nabewerkte audiodata na ruisonderdrukking en VAD. Het bevat de volledige inhoud van het Item, inclusief audiogegevens.

RealtimeServerEventConversationItemTruncated

Teruggegeven wanneer een eerder assistent-audiobericht door de client wordt afgekapt met een conversation.item.truncate gebeurtenis. Dit event wordt gebruikt om het begrip van de server van de audio te synchroniseren met de weergave van de client. Deze actie zal de audio inkorten en het server-side teksttranscript verwijderen om te garanderen dat er geen tekst in de context is die de gebruiker niet heeft gehoord.

RealtimeServerEventError

Wordt teruggegeven wanneer er een fout optreedt, wat een client- of serverprobleem kan zijn. De meeste fouten zijn herstelbaar en de sessie blijft open; wij raden implementatoren aan om standaard foutmeldingen te monitoren en te loggen.

RealtimeServerEventErrorError

modelinterface RealtimeServerEventErrorError

RealtimeServerEventInputAudioBufferCleared

Teruggegeven wanneer de input audio buffer door de client wordt gewist met een input_audio_buffer.clear gebeurtenis.

RealtimeServerEventInputAudioBufferCommitted

Teruggegeven wanneer een input-audiobuffer wordt gecommit, hetzij door de client of automatisch in server VAD-modus. De item_id eigenschap is de ID van het gebruikersberichtitem dat wordt aangemaakt, dus er wordt ook een conversation.item.created event naar de client gestuurd.

RealtimeServerEventInputAudioBufferSpeechStarted

Verzonden door de server wanneer in server_vad modus om aan te geven dat spraak is gedetecteerd in de audiobuffer. Dit kan gebeuren telkens wanneer audio aan de buffer wordt toegevoegd (tenzij spraak al is gedetecteerd). De client kan dit evenement willen gebruiken om de audioweergave te onderbreken of visuele feedback aan de gebruiker te geven. De cliënt moet verwachten een input_audio_buffer.speech_stopped gebeurtenis te ontvangen wanneer de spraak stopt. De item_id eigenschap is de ID van het gebruikersberichtitem dat wordt aangemaakt wanneer spraak stopt en ook in het input_audio_buffer.speech_stopped evenement wordt opgenomen (tenzij de client handmatig de audiobuffer commit tijdens de activatie van de VAD).

RealtimeServerEventInputAudioBufferSpeechStopped

Teruggebracht in server_vad modus wanneer de server het einde van spraak in de audiobuffer detecteert. De server zal ook een conversation.item.created event sturen met het gebruikersberichtitem dat is aangemaakt vanuit de audiobuffer.

RealtimeServerEventInputAudioBufferTimeoutTriggered

Teruggegeven wanneer de Server VAD-timeout wordt geactiveerd voor de input audio buffer. Dit is geconfigureerd in idle_timeout_ms de turn_detection instellingen van de sessie, en het geeft aan dat er gedurende de geconfigureerde duur geen spraak is gedetecteerd. De audio_start_ms en audio_end_ms velden geven het audiosegment aan na het laatste modelantwoord tot de triggertijd, als een offset vanaf het begin van de audio die naar de invoeraudiobuffer is geschreven. Dit betekent dat het het segment van de audio afbakent dat stil was en dat het verschil tussen de start- en eindwaarden ongeveer overeenkomt met de geconfigureerde timeout. De lege audio wordt als een input_audio item aan het gesprek vastgelegd (er zal een input_audio_buffer.committed gebeurtenis zijn) en er wordt een modelantwoord gegenereerd. Er kan spraak zijn die geen VAD heeft getriggerd, maar toch door het model wordt gedetecteerd, dus het model kan reageren met iets relevants voor het gesprek of een prompt om door te spreken.

RealtimeServerEventMCPListToolsCompleted

Geretourneerd wanneer MCP-tools zijn voltooid voor een item.

RealtimeServerEventMCPListToolsFailed

Teruggebracht bij het vermelden van MCP-tools is het mislukt voor een item.

RealtimeServerEventMCPListToolsInProgress

Wordt geretourneerd wanneer het tonen van MCP-tools aan de gang is voor een item.

RealtimeServerEventOutputAudioBufferCleared

Alleen WebRTC/SIP: Wordt uitgezonden wanneer de output-audiobuffer is gewist. Dit gebeurt in VAD-modus wanneer de gebruiker de (input_audio_buffer.speech_started) heeft onderbroken, of wanneer de client het output_audio_buffer.clear event heeft verzonden om de huidige audiorespons handmatig af te breken. Meer informatie.

RealtimeServerEventRateLimitsUpdated

Uitgezonden aan het begin van een Response om de bijgewerkte snelheidslimieten aan te geven. Wanneer een Response wordt aangemaakt, worden sommige tokens "gereserveerd" voor de output tokens; de hier getoonde tarieflimieten weerspiegelen die reservering, die vervolgens wordt aangepast zodra de Response is voltooid.

RealtimeServerEventRateLimitsUpdatedRateLimits

modelinterface RealtimeServerEventRateLimitsUpdatedRateLimits

RealtimeServerEventResponseAudioDelta

Teruggegeven wanneer de door het model gegenereerde audio wordt bijgewerkt.

RealtimeServerEventResponseAudioDone

Teruggegeven wanneer de door het model gegenereerde audio klaar is. Ook uitgezonden wanneer een reactie wordt onderbroken, onvolledig of geannuleerd.

RealtimeServerEventResponseAudioTranscriptDelta

Teruggegeven wanneer de modelgegenereerde transcriptie van audio-uitvoer wordt bijgewerkt.

RealtimeServerEventResponseAudioTranscriptDone

Wordt teruggegeven wanneer de door het model gegenereerde transcriptie van audio-uitvoer is afgerond met streamen. Ook uitgezonden wanneer een reactie wordt onderbroken, onvolledig of geannuleerd.

RealtimeServerEventResponseContentPartAdded

Teruggegeven wanneer een nieuw inhoudsdeel wordt toegevoegd aan een assistent-berichtitem tijdens het genereren van reacties.

RealtimeServerEventResponseContentPartAddedPart

modelinterface RealtimeServerEventResponseContentPartAddedPart

RealtimeServerEventResponseContentPartDone

Teruggebracht wanneer een contentonderdeel klaar is met streamen in een assistent-berichtitem. Ook uitgezonden wanneer een reactie wordt onderbroken, onvolledig of geannuleerd.

RealtimeServerEventResponseContentPartDonePart

modelinterface RealtimeServerEventResponseContentPartDonePart

RealtimeServerEventResponseCreated

Teruggegeven wanneer een nieuwe Response wordt aangemaakt. De eerste gebeurtenis van responscreatie, waarbij de respons in een begintoestand van in_progressis.

RealtimeServerEventResponseDone

Teruggestuurd wanneer een reactie klaar is met streamen. Altijd uitgezonden, ongeacht de uiteindelijke toestand. Het Response-object dat in het response.done event is opgenomen, bevat alle uitvoeritems in de Response, maar laat de ruwe audiodata weg. Cliënten moeten het status veld van de Response controleren om te bepalen of het succesvol was (completed) of dat er een ander resultaat was: cancelled, failed, of incomplete. Een reactie bevat alle uitvoeritems die tijdens de reactie zijn gegenereerd, exclusief eventuele audio-inhoud.

RealtimeServerEventResponseFunctionCallArgumentsDelta

Teruggegeven wanneer de door het model gegenereerde functieaanroepargumenten worden bijgewerkt.

RealtimeServerEventResponseFunctionCallArgumentsDone

Teruggegeven wanneer de door het model gegenereerde functie-aanroepargumenten klaar zijn met streamen. Ook uitgezonden wanneer een reactie wordt onderbroken, onvolledig of geannuleerd.

RealtimeServerEventResponseMCPCallArgumentsDelta

Teruggegeven wanneer MCP-tooloproepargumenten worden bijgewerkt tijdens responsgeneratie.

RealtimeServerEventResponseMCPCallArgumentsDone

Teruggegeven wanneer MCP-tooloproepargumenten worden afgerond tijdens responsgeneratie.

RealtimeServerEventResponseMCPCallCompleted

Teruggekeerd wanneer een MCP-toolcall succesvol is voltooid.

RealtimeServerEventResponseMCPCallFailed

Teruggekeerd wanneer een MCP-tooloproep is mislukt.

RealtimeServerEventResponseMCPCallInProgress

Teruggebracht wanneer een MCP-tooloproep is begonnen en bezig is.

RealtimeServerEventResponseOutputItemAdded

Teruggegeven wanneer een nieuw item wordt aangemaakt tijdens het genereren van de respons.

RealtimeServerEventResponseOutputItemDone

Teruggebracht wanneer een item klaar is met streamen. Ook uitgezonden wanneer een reactie wordt onderbroken, onvolledig of geannuleerd.

RealtimeServerEventResponseTextDelta

Teruggegeven wanneer de tekstwaarde van een "output_text"-inhoudsdeel wordt bijgewerkt.

RealtimeServerEventResponseTextDone

Wordt teruggegeven wanneer de tekstwaarde van een "output_text"-inhoudsdeel is gestreamd. Ook uitgezonden wanneer een reactie wordt onderbroken, onvolledig of geannuleerd.

RealtimeServerEventSessionCreated

Teruggegeven wanneer een sessie wordt aangemaakt. Automatisch verzonden wanneer een nieuwe verbinding wordt opgezet als eerste servergebeurtenis. Dit event bevat de standaard sessieconfiguratie.

RealtimeServerEventSessionUpdated

Teruggegeven wanneer een sessie wordt bijgewerkt met een session.update gebeurtenis, tenzij er een fout is.

Reasoning

Alleen GPT-5 en O-serie modellen Configuratieopties voor redeneermodellen.

RecurrenceSchedule

Model voor herhalingsschema.

RecurrenceTrigger

Trigger op basis van herhaling.

RedTeam

Rode teamdetails.

RedTeamTargetConfig

Abstracte klasse voor doelconfiguratie.

ReinforcementFineTuningDataGenerationJob

Bunt voor het fijn afstemmen van datageneratie voor versterking. Dit is een preview-functie.

ReinforcementFineTuningDataGenerationJobInputs

Door de beller geleverde invoer voor een versterkings-finetuning datageneratietaak. Dit is een preview-functie.

ReinforcementFineTuningDataGenerationJobOutputConfiguration

Bestandsuitvoerconfiguratie voor een versterkings-fine-tuning datageneratietaak. Dit is een preview-functie.

ReminderPreviewToolboxTool

Een herinneringstool opgeslagen in een gereedschapskist.

ResponseUsageInputTokensDetails

modelinterface ResponseUsageInputTokensDetails

ResponseUsageOutputTokensDetails

modelinterface ResponseUsageOutputTokensDetails

ResponsesProtocolConfiguration

Configuratie specifiek voor het responsprotocol.

Routine

Een routinedefinitie die door de dienst wordt teruggegeven.

RoutineAction

Basismodel voor een routinematige actie.

RoutineAuthorization

Optionele autorisatieconfiguratie voor een routinematige dispatch.

RoutineDispatchPayload

Basismodel voor een handmatige dispatch-payload.

RoutineRun

Een enkele routine-run werd teruggegeven vanuit de run history API.

RoutineTrigger

Basismodel voor een routine-trigger.

RubricBasedEvaluatorDefinition

Rubric-gebaseerde evaluatordefinitie — slaat dimensies op die door de genererende API worden geproduceerd. Gebruikt voor zowel kwaliteits- als veiligheidsbeoordelaars.

RubricGenerationInputQualityWarning

Een niet-dodelijk advies dat wordt geproduceerd tijdens het genereren van een rubric-evaluator wanneer de ingevoerde input technisch geldig is, maar waarschijnlijk te zwak om een hoogwaardige rubric te produceren. Alleen-lezen; dienstgegenereerd. Bleef doorgaan met de terminal EvaluatorGenerationJob.

RunOperationState

Operationele status voor een langlopende operatie die een run-resource creëert.

AANPASSING: SDK-VERBETERING: de uitgezonden poller lost op naar de terminale result payload van de run, die geen identificatie bevat; runId houdt de aangemaakte run bereikbaar.

SASTokenCredentials

Definitie van SAS-referenties (Shared Access Signature)

SasCredential

Definitie van SAS-referenties

Schedule

Schema model.

ScheduleRoutineTrigger

Een terugkerende cron-gebaseerde routine-trigger.

ScheduleRun

Model voor planning.

ScheduleTask

Taakmodel plannen.

SessionConfiguration

Sessiestandaardwaarden werden toegepast op sessies die waren gemaakt voor een versie van een gehoste agent.

SessionDirectoryEntry

Een enkele vermelding in een directory.

SessionDirectoryListResponse

Reactie op het vermelden van een map in een sessiesandbox.

SessionFileWriteResponse

Reactie op het uploaden van een bestand naar een sessiesandbox.

SessionLogEvent

Een enkel Server-Sent Event-frame dat wordt uitgezonden door de logstroom van de gehoste agent.

Elk frame bevat een event veld dat het gebeurtenistype identificeert en een data veld dat de payload als platte tekst draagt. Hoewel de huidige data payload JSON-geformatteerd is, is het schema niet contractueel — extra sleutels kunnen verschijnen en het formaat kan in de loop van de tijd veranderen. Clients moeten het als een ondoorzichtige string behandelen data en optioneel JSON-parsing proberen.

Nieuwe gebeurtenistypes kunnen in de toekomst worden toegevoegd. Klanten moeten onbekende gebeurtenistypes op een elegante manier negeren.

Draadformaat:

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

De parameters van de sharepoint-aardingstool.

SharepointPreviewTool

De informatie over de invoerdefinitie voor een SharePoint-hulpprogramma zoals wordt gebruikt voor het configureren van een agent.

ShellToolboxTool

Een schild gereedschap opgeslagen in een gereedschapskist. Dit model is toevoegend aan toolboxconfiguratie en wijzigt het OpenAI-toolcontract of bestaande toolboxtooldefinities niet.

SimpleQnADataGenerationJobConfiguration

De configuratie voor een datageneratietaak met het type SimpleQnA.

SimulationSeedDataGenerationJobConfiguration

De configuratie voor een taak genererende data-generatietaak. Gebruik met evaluatiescenario's voor meerdere beurten en met prompt-, bestands- of agentbronnen. Gegenereerde dataset-rijen omvatten velden zoals id, category, test_case_description, en desired_num_turns.

SipTelephonyTransferDestination

Een SIP-bestemming voor een telefonie-overdrachtsdoel.

Skill

Een vaardigheidsbron.

SkillInlineContent

Inline content om een eenvoudige vaardigheid te definiëren zonder bestanden te uploaden. Volgt de agentskills.io SKILL.md specificatie.

SkillReference

(Preview) Een verwijzing naar een versieversie van Foundry-vaardigheid.

SkillReferenceParam

modelinterface SkillReferenceParam

SkillVersion

Een specifieke versie van een vaardigheid.

SpecificApplyPatchParam

Hiermee dwingt u het model om het apply_patch hulpprogramma aan te roepen bij het uitvoeren van een hulpprogramma-aanroep.

SpecificFunctionShellParam

Dwingt het model om het shell-hulpprogramma aan te roepen wanneer een hulpprogramma-aanroep is vereist.

SpecificProgrammaticToolCallingParam

modelinterface SpecificProgrammaticToolCallingParam

SteeringPromptOptimizationContext

Natuurlijke taalbegeleiding voor de gewenste optimalisatie.

StructuredInputDefinition

Een gestructureerde invoer die kan deelnemen aan snelle sjabloonvervangingen en het binden van gereedschapsargumenten.

StructuredOutputDefinition

Een gestructureerde uitvoer die door de agent kan worden geproduceerd.

SupervisedFineTuningDataGenerationJob

Toezicht op het fijnafstellen van datageneratie als bron. Dit is een preview-functie.

SupervisedFineTuningDataGenerationJobInputs

Door de beller geleverde invoer voor een supervise, fijn afstemmende datageneratietaak. Dit is een preview-functie.

SupervisedFineTuningDataGenerationJobOutputConfiguration

Bestandsuitvoerconfiguratie voor een gecontroleerde fijnafstemming van datageneratie. Dit is een preview-functie.

TaxonomyCategory

Definitie van taxonomiecategorie.

TaxonomySubCategory

Definitie van subcategorie taxonomie.

TeamsPhoneExtensionTelephonyBinding

Een Microsoft Teams-telefoon Extension-binding die eigendom is van een spraakagent.

TeamsPhoneExtensionTelephonyBindingListItem

Een binding voor Microsoft Teams-telefoon Extension werd teruggegeven in een lijst, inclusief de entity tag.

TeamsTelephonyTransferDestination

Een Microsoft Teams-bestemming voor een telefonie-overdrachtsdoel.

TelemetryConfig

Door klanten geleverde telemetrieconfiguratie voor het exporteren van containerlogs, traces en metrics.

TelemetryEndpoint

Een telemetrie-export-endpointconfiguratie.

TelemetryEndpointAuth

Authenticatieconfiguratie voor een telemetrie-endpoint.

TelemetryOperations

Interface die telemetriebewerkingen vertegenwoordigt

TelephonyBinding

Een telefoniebinding in bezit van een stemagent.

TelephonyBindingListItem

Een telefoniebinding keerde terug in een lijst, inclusief de entiteitstag.

TelephonyCallJob

Een duurzame directe of door de campagne gecreëerde intentie voor uitgaande oproepen.

TelephonyCallJobCancellation

Een annuleringsverzoek geregistreerd voor een uitgaande oproepklus.

TelephonyCallJobSchedule

Het optionele uitvoeringsvenster voor een directe uitgaande aanroep.

TelephonyCallLifecycleEvent

Een begrensde, duurzame observatie in de levenscyclus van één telefoongesprek.

TelephonyCallRecord

Gedetailleerde diagnostiek voor een duurzaam inkomend gesprek met een spraakagent.

TelephonyCallSummary

Een samenvatting van een duurzaam inkomend gesprek met een spraakagent.

TelephonyCallTiming

Gedetailleerde provider-neutrale timing voor een inkomend telefoongesprek.

TelephonyCallTrace

Correlatie van een duurzame telefonie-gespreksgeschiedenis tot de klantgerichte Foundry-trace.

TelephonyOutboundDestination

De bestemming van een uitgaande oproep.

TelephonyOutboundFixedIntervalRetryPolicy

Een herkansingsbeleid met een vast interval tussen uitgaande oproeppogingen.

TelephonyOutboundRetryPolicy

Het herkansingsbeleid voor één duurzame uitgaande oproepintentie. max_attempts Inclusief de eerste poging. Strategiespecifieke instellingen worden gedefinieerd door het afgeleide beleid.

TelephonyTransferDestination

Een bestemming voor een telefonie-overdrachtsdoel.

TelephonyTransferTarget

Een benoemde bestemming waarnaar de spraakagent een oproep kan doorverbinden.

TelephonyTransferTargets

De telefoonoverdrachtsdoelen zijn ingesteld voor één spraakagent.

TextResponseFormat

Een object dat de indeling aangeeft die het model moet uitvoeren. { "type": "json_schema" } Als u gestructureerde uitvoer configureert, zorgt u ervoor dat het model overeenkomt met het opgegeven JSON-schema. Meer informatie vindt u in de handleiding Structured Outputs. De standaardindeling is { "type": "text" } zonder extra opties. Niet aanbevolen voor GPT-4o en nieuwere modellen:* Instelling om de oudere JSON-modus in { "type": "json_object" } te schakelen, die ervoor zorgt dat het bericht dat het model genereert geldig JSON is. Het is aanbevolen om json_schema te gebruiken voor modellen die dit ondersteunen.

TextResponseFormatConfiguration

Basisconfiguratie voor het formaat van gegenereerde tekstreacties.

TextResponseFormatConfigurationResponseFormatJsonObject

Configureert gegenereerde antwoorden om het JSON-objectformaat te gebruiken.

TextResponseFormatConfigurationResponseFormatText

Configureert gegenereerde antwoorden om platte tekst te gebruiken.

TextResponseFormatJsonObject

JSON-objectantwoordindeling. Een oudere methode voor het genereren van JSON-antwoorden. Het gebruik json_schema wordt aanbevolen voor modellen die dit ondersteunen. Houd er rekening mee dat het model geen JSON genereert zonder een systeem- of gebruikersbericht waarin het wordt geïnstrueerd om dit te doen.

TextResponseFormatJsonSchema

JSON Schema-antwoordindeling. Wordt gebruikt om gestructureerde JSON-antwoorden te genereren. Meer informatie over gestructureerde uitvoer.

TextResponseFormatText

De standaard antwoordindeling. Wordt gebruikt om tekstreacties te genereren.

TimerRoutineTrigger

Een one-shot timer routine-trigger.

Tool

Een hulpprogramma dat kan worden gebruikt om een antwoord te genereren.

ToolChoiceAllowed

Hiermee beperkt u de hulpprogramma's die beschikbaar zijn voor het model tot een vooraf gedefinieerde set.

ToolChoiceCodeInterpreter

Geeft aan dat het model een ingebouwd hulpprogramma moet gebruiken om een antwoord te genereren. Meer informatie over ingebouwde hulpprogramma's.

ToolChoiceComputer

Geeft aan dat het model een ingebouwd hulpprogramma moet gebruiken om een antwoord te genereren. Meer informatie over ingebouwde hulpprogramma's.

ToolChoiceComputerUse

Geeft aan dat het model een ingebouwd hulpprogramma moet gebruiken om een antwoord te genereren. Meer informatie over ingebouwde hulpprogramma's.

ToolChoiceComputerUsePreview

Geeft aan dat het model een ingebouwd hulpprogramma moet gebruiken om een antwoord te genereren. Meer informatie over ingebouwde hulpprogramma's.

ToolChoiceCustom

Gebruik deze optie om af te dwingen dat het model een specifiek aangepast hulpprogramma aanroept.

ToolChoiceFileSearch

Geeft aan dat het model een ingebouwd hulpprogramma moet gebruiken om een antwoord te genereren. Meer informatie over ingebouwde hulpprogramma's.

ToolChoiceFunction

Gebruik deze optie om af te dwingen dat het model een specifieke functie aanroept.

ToolChoiceImageGeneration

Geeft aan dat het model een ingebouwd hulpprogramma moet gebruiken om een antwoord te genereren. Meer informatie over ingebouwde hulpprogramma's.

ToolChoiceMCP

Gebruik deze optie om af te dwingen dat het model een specifiek hulpprogramma aanroept op een externe MCP-server.

ToolChoiceParam

Hoe het model moet selecteren welk hulpprogramma (of hulpprogramma's) moeten worden gebruikt bij het genereren van een antwoord. Zie de tools parameter om te zien welke hulpprogramma's het model kan aanroepen.

ToolChoiceWebSearchPreview

Geeft aan dat het model een ingebouwd hulpprogramma moet gebruiken om een antwoord te genereren. Meer informatie over ingebouwde hulpprogramma's.

ToolChoiceWebSearchPreview20250311

Geeft aan dat het model een ingebouwd hulpprogramma moet gebruiken om een antwoord te genereren. Meer informatie over ingebouwde hulpprogramma's.

ToolConfig

Per-tool configuratie die de zichtbaarheid en zoekgedrag van het tool bepaalt.

ToolDescription

Beschrijving van een tool die door een agent kan worden gebruikt.

ToolProjectConnection

Een project verbindingsresource.

ToolSearchToolParam

Gehoste of BYOT-toolzoekconfiguratie voor uitgestelde tools.

ToolSearchToolboxTool

Een toolbox-zoektool opgeslagen in een toolbox.

ToolUseFineTuningDataGenerationJobConfiguration

De configuratie voor een datageneratietaak met het type ToolUse. Dit is een previewfunctie die alleen wordt gebruikt voor het fijn afstellen van scenario's.

ToolboxObject

Een gereedschapskist die herbruikbare tooldefinities voor agenten opslaat.

ToolboxPolicies

Beleidsconfiguratie voor een toolbox, inclusief inhoudsveiligheid en andere governance-instellingen.

ToolboxSearchPreviewToolboxTool

Een toolbox-zoektool opgeslagen in een toolbox.

ToolboxShellContainerAutoEnvironment

Een automatisch geprovisioneerde containeromgeving voor een shell-tool, opgeslagen in een toolbox.

ToolboxShellContainerReferenceEnvironment

Een bestaande containeromgeving voor een shell-tool opgeslagen in een toolbox.

ToolboxShellEnvironment

Een uitvoeringsomgeving voor een shell-tool opgeslagen in een toolbox. Dit omgevingsmodel is beperkt tot toolboxconfiguratie en wijzigt het OpenAI-shell-omgevingscontract niet.

ToolboxShellNetworkPolicy

Netwerktoegangsbeleid voor een automatisch geprovisioneerde toolbox shellcontainer.

ToolboxShellNetworkPolicyDisabled

Een netwerkbeleid dat uitgaande toegang uit een toolbox shell-container uitschakelt.

ToolboxSkill

Een vaardigheidsbron die in een gereedschapskist zit.

ToolboxSkillReference

Een verwijzing naar een bestaande vaardigheid om in een gereedschapskist op te nemen.

ToolboxTool

Een abstracte weergave van een gereedschap opgeslagen in een gereedschapskist.

ToolboxVersionObject

Een specifieke versie van een gereedschapskist.

ToolboxVersions

De versies die bij een gereedschapskist horen.

ToolboxesCreateVersionOptionalParams

Optionele parameters.

ToolboxesDeleteOptionalParams

Optionele parameters.

ToolboxesDeleteVersionOptionalParams

Optionele parameters.

ToolboxesGetOptionalParams

Optionele parameters.

ToolboxesGetVersionOptionalParams

Optionele parameters.

ToolboxesInvokeLatestToolboxMcpOptionalParams

Optionele parameters.

ToolboxesListOptionalParams

Optionele parameters.

ToolboxesListVersionsOptionalParams

Optionele parameters.

ToolboxesOperations

Interface die de bewerkingen van een toolbox vertegenwoordigt.

ToolboxesUpdateOptionalParams

Optionele parameters.

TracesDataGenerationJobConfiguration

De configuratie voor een datageneratietaak met het type Traces.

TracesDataGenerationJobSource

Traces source voor datageneratie-taken — conversatietraces uit Application Insights.

TracesEvaluatorGenerationJobSource

Traces bron voor beoordelaarsgeneratie — conversatietraces uit Application Insights.

TranscriptTextUsageDuration

Gebruiksstatistieken voor modellen die worden gefactureerd op basis van de duur van audio-invoer.

TranscriptTextUsageTokens

Gebruiksstatistieken voor modellen die per tokengebruik worden gefactureerd.

TranscriptTextUsageTokensInputTokenDetails

modelinterface TranscriptTextUsageTokensInputTokenDetails

TranscriptionLanguage

Een taal die wordt gedetecteerd in getranscribeerde audio.

Trigger

Basismodel voor Trigger van het rooster.

TwilioTelephonyBinding

Een Twilio-binding die eigendom is van een stemagent.

TwilioTelephonyBindingListItem

Een Twilio-binding werd teruggegeven in een lijst, inclusief de entiteitstag.

UpdateModelVersionRequest

Verzoek om de body voor het updaten van een modelversie. Alleen beschrijvingen en tags kunnen worden aangepast.

UpdateTelephonyBindingRequest

Het verzoek om een bestaande telefoniebinding bij te werken. Elke eigendom is optioneel en de aanbieder van de binding is onveranderlijk.

UpdateToolboxRequest

modelinterface UpdateToolboxRequest

UserConversationSimulationAudioEffectsConfiguration

Configuratie effecten toegepast op gesimuleerde gespreksaudio.

UserConversationSimulationConfiguration

Stelt het aantal, de lengte, de audio-effecten en het gesimuleerde gebruikersgedrag van gesprekken in.

UserConversationSimulationDefaultInterruptionConfiguration

Stelt het standaard onderbrekingsgedrag in voor de gesimuleerde gebruiker.

UserConversationSimulationInterruptionConfiguration

Configuratie voor gesimuleerd gebruikersonderbrekingsgedrag.

UserConversationSimulationTestCase

Definieert één testscenario. De hier gespecificeerde configuratie-eigenschappen overschrijven de bijbehorende standaardwaarden van de gegevensbron.

UserConversationSimulationUserBehaviorConfiguration

Stelt het gespreksgedrag in voor de gesimuleerde gebruiker.

UserProfileMemoryItem

Een geheugenitem dat specifiek gebruikersprofielinformatie bevat die is geëxtraheerd uit gesprekken, zoals voorkeuren, interesses en persoonlijke gegevens.

VersionIndicator

Versieindicator die bepaalt welke agentversie de sessie ondersteunt.

VersionRefIndicator

Versieindicator die een specifieke agentversie bij naam verwijst.

VersionSelectionRule

modelinterface VersionSelectionRule

VersionSelector

modelinterface VersionSelector

VoiceAgentAnimationConfig

Animatie-instellingen voor een voice-agent sessie.

VoiceAgentAudioConfig

De audioconfiguratie voor een voice agent. Deze waarden zijn sessiestandaardwaarden en kunnen worden overschreven bij het verbinden.

VoiceAgentAudioInputConfig

Voer audioconfiguratie in voor een spraakagent.

VoiceAgentAudioOutputConfig

Output audioconfiguratie voor een spraakagent. Aanbiederspecifieke velden worden geselecteerd door voice_type:

  • openai: voice en speed.
  • azure-standard: , voice_locale, , speed, voice_temperature, custom_lexicon_url, custom_text_normalization_url, prefer_localesstyle, , pitch, en volume. voice
  • azure-custom: alle azure-standard velden behalve style, plus custom_voice_endpoint_id.
  • azure-personal: alle azure-standard velden behalve style, plus personal_voice_model.
  • avatar-voice-sync: alle azure-standard velden behalve voice en style, plus personal_voice_model; de stemnaam is afgeleid van de avatar.
  • azure-realtime-native: voice en speed. format en output_audio_timestamp_types op elk stemtype van toepassing zijn.
VoiceAgentAvatarConfig

Avatarconfiguratie voor een voice agent. Deze waarden zijn sessiestandaardwaarden en kunnen worden overschreven bij het verbinden.

VoiceAgentAvatarIceServer

Een ICE-server gebruikt voor avatar WebRTC-onderhandelingen.

VoiceAgentAvatarScene

Avatar-plaatsing en bewegingsinstellingen.

VoiceAgentAvatarVideoBackground

De achtergrond van de avatarvideo.

VoiceAgentAvatarVideoCrop

De rechthoekige crop toegepast op avatarvideo's.

VoiceAgentAvatarVideoParams

Avatar-video-encoder en presentatie-instellingen.

VoiceAgentAvatarVideoResolution

De videoresolutie van de avatar.

VoiceAgentAzureSemanticVadEnTurnDetection

English-optimized Azure semantic voice activity detection.

VoiceAgentAzureSemanticVadMultilingualTurnDetection

Multilingual Azure semantic voice activity detection.

VoiceAgentAzureSemanticVadTurnDetection

Azure semantic voice activity detection.

VoiceAgentCancelResponseOptions

Opties om een reactie te annuleren.

VoiceAgentClientEventRtcCallSdpCreate

Het rtc.call.sdp.create klantevenement: begint met WebRTC-signalering met een SDP-aanbod.

VoiceAgentClientEventSessionAvatarConnect

Het session.avatar.connect klantevenement.

VoiceAgentClientEventSessionUpdate

Het session.update klantevenement.

VoiceAgentCloseResult

Resultaat geleverd wanneer een spraak-agentverbinding wordt gesloten.

VoiceAgentConnection

Een verbonden, bidirectionele voice-agent-stroom.

Ondersteunt precies één for await iteratie over servergebeurtenissen; een tweede poging gooit dit. Het vroegtijdig verlaten van de lus (break, , returnof een onopgemerkte fout in het luslichaam) sluit de verbinding als neveneffect. Niet-herkende servergebeurtenistypen worden geleverd als VoiceAgentUnknownEvent zonder de stroom te onderbreken. Misvormde gebeurtenissen mislukken nog steeds bij de iteratie met een protocolfout.

VoiceAgentDefinition

De definitie van de voice agent. De configuratie (model, instructies, audio, tools en optionele avatar) zorgt voor een beheerde spraak-naar-spraak ervaring. Zet realtime spraaksessies op via GET /agents/{agent_name}/endpoint/protocols/voice. Elke creatie of update levert een nieuwe, onveranderlijke versie op.

VoiceAgentEchoCancellation

Serverzijde echo-onderdrukkingsinstellingen voor inputaudio.

VoiceAgentEndConversationSystemTool

Een servicebeheerde controle die het actieve gesprek beëindigt.

VoiceAgentEndOfUtteranceDetection

Semantische einde-van-uiting-detectieconfiguratie.

VoiceAgentEventOptions

Opties gedeeld door operaties die namens de beller een protocolevent opbouwen.

VoiceAgentFunctionTool

Een native functietool uitgevoerd door de client.

VoiceAgentGreetingConfig

Sessiestart-begroetingsconfiguratie voor een spraakagent.

VoiceAgentInputTranscription

Asynchrone input-audio transcriptieconfiguratie. Breidt de OpenAI Realtime transcriptieopties uit met de Azure- en MAI-transcriptiemodellen, aangepaste spraakmodellen en zinsaanwijzingen.

VoiceAgentInterimResponseConfig

Velden gedeeld door interim-responsconfiguraties.

VoiceAgentLlmGeneratedGreetingConfig

Een begroeting geschreven door het sessiemodel op basis van een scoped opening-turn prompt.

VoiceAgentLlmInterimResponseConfig

Een tussentijdse respons gegenereerd door een taalmodel.

VoiceAgentMcpTool

Een MCP-tool beschikbaar voor een stemagent.

VoiceAgentNoiseReduction

Input audio ruisonderdrukkingsconfiguratie.

VoiceAgentRealtimeClientConnectOptions

Opties om de realtime client te verbinden met een voice agent.

VoiceAgentRealtimeClientOptions

Opties voor de realtime client van Voice Agents.

VoiceAgentRealtimeResponse

Een live realtime reactie van de voice-agent service in beide response.created en response.done gebeurtenissen.

VoiceAgentRealtimeResponseBase

Eigenschappen gedeeld door realtime antwoorden die door de voice-agent service worden teruggegeven.

VoiceAgentResponseCreateParams

Parameters die worden geaccepteerd door een voice-agent-gebeurtenis response.create .

VoiceAgentResponseOptions

Opties om een reactie te maken.

VoiceAgentRtcCallErrorDetails

Details van een WebRTC-signaleringsfout.

VoiceAgentSemanticVadTurnDetection

OpenAI semantische VAD-beurtdetectie-instellingen.

VoiceAgentSendItemOptions

Opties gedeeld door operaties die een gespreksitem toevoegen en standaard een antwoord aanvragen.

VoiceAgentSendOptions

Opties gedeeld door realtime verzendoperaties.

VoiceAgentSendTextOptions

Opties voor het verzenden van tekstinvoer.

VoiceAgentSendToolOutputOptions

Opties om een functieresultaat terug te geven.

VoiceAgentServerEventResponseAnimationBlendshapesDelta

Het response.animation_blendshapes.delta serverevenement.

VoiceAgentServerEventResponseAnimationBlendshapesDone

Het response.animation_blendshapes.done serverevenement.

VoiceAgentServerEventResponseAnimationVisemeDelta

Het response.animation_viseme.delta serverevenement.

VoiceAgentServerEventResponseAnimationVisemeDone

Het response.animation_viseme.done serverevenement.

VoiceAgentServerEventResponseAudioTimestampDelta

Het response.audio_timestamp.delta serverevenement.

VoiceAgentServerEventResponseAudioTimestampDone

Het response.audio_timestamp.done serverevenement.

VoiceAgentServerEventResponseVideoDelta

Het response.video.delta serverevenement.

VoiceAgentServerEventRtcCallError

Het rtc.call.error serverevent: een WebRTC-signaalfout.

VoiceAgentServerEventRtcCallSdpCreated

Het rtc.call.sdp.created serverevent: het SDP-antwoord dat de WebRTC-onderhandeling voltooit.

VoiceAgentServerEventSessionAvatarConnecting

Het session.avatar.connecting serverevenement.

VoiceAgentServerEventSessionAvatarSwitchToIdle

Het session.avatar.switch_to_idle serverevenement.

VoiceAgentServerEventSessionAvatarSwitchToSpeaking

Het session.avatar.switch_to_speaking serverevenement.

VoiceAgentServerEventSessionSubagentAborted

Het session.subagent.aborted serverevenement.

VoiceAgentServerEventSessionSubagentCompleted

Het session.subagent.completed serverevenement.

VoiceAgentServerEventSessionSubagentStarted

Het session.subagent.started serverevenement.

VoiceAgentServerEventWarning

Het warning serverevenement.

VoiceAgentServerEventWarningDetails

Details van een niet-dodelijke waarschuwing.

VoiceAgentServerVadTurnDetection

Server-side spraakactiviteitsdetectie.

VoiceAgentSessionAvatarConfig

Avatarinstellingen worden geaccepteerd door het stabiele voice-agent WebSocket-contract.

VoiceAgentSessionResponseConfig

De effectieve stabiele realtime sessie-instellingen die door de voice-agent service worden teruggegeven.

VoiceAgentSessionUpdateConfig

De stabiele realtime sessie-instellingen worden geaccepteerd in een session.update clientgebeurtenis.

VoiceAgentSessionUpdateOptions

Opties om de live sessie bij te werken.

VoiceAgentStaticInterimResponseConfig

Een statisch tussentijds antwoord geselecteerd uit geconfigureerde tekst.

VoiceAgentSubagent

Een broer-zus Foundry tekstagent die een spraakagent kan raadplegen als achtergrondspecialist.

VoiceAgentSubagentConfig

Configuratie voor zuster-Foundry tekstagenten die een spraakagent kan raadplegen.

VoiceAgentSubagentResponsePolicy

Beleid voor het leveren van antwoorden terwijl een spraakagent wacht op een subagent.

VoiceAgentSystemTool

Een servicebeheerde controle die werkt op de actieve spraaksessie zonder klantcode of externe authenticatie.

VoiceAgentTemplateGreetingConfig

Een deterministische begroeting weergegeven met de gestructureerde input van de voice agent en gesynthetiseerd zonder door het model geschreven generatie.

VoiceAgentTool

Een tool die gebruikt kan worden door een stemagent.

VoiceAgentToolboxTool

Een verwijzing naar een Foundry toolbox, een versiegekleurde bundel tools die via het MCP-eindpunt worden uitgevoerd.

VoiceAgentTranscriptionPhrase

Een getranscribeerde zin met timinginformatie.

VoiceAgentTranscriptionWord

Een tijdstempelwoord in een input-audiotranscriptie.

VoiceAgentTurnDetectionConfig

Beurtdetectieconfiguratie voor een spraakagent.

VoiceAgentUnknownEvent

Een serverevent waarvan het draadtype niet wordt herkend door deze versie van de SDK.

De SDK levert deze gebeurtenissen zonder de verbinding te sluiten of bekende-gebeurtenisvalidatie of normalisatie toe te passen. Inspecteer en valideer ruwe velden voordat je ze gebruikt.

VoiceAgentWebSocketConnectOptions

Opties doorgegeven aan VoiceAgentWebSocketTransport.connect.

VoiceAgentWebSocketFactory

Maakt VoiceAgentWebSocketTransport-instanties aan voor VoiceAgentRealtimeClient.

VoiceAgentWebSocketHandlers

Callbacks die door een VoiceAgentWebSocketTransport worden aangeroepen terwijl verbindingsgebeurtenissen plaatsvinden.

VoiceAgentWebSocketTransport

Een plug-able WebSocket-transport gebruikt door VoiceAgentRealtimeClient. Implementeer deze interface om aan te passen hoe de realtime verbinding tot stand komt, bijvoorbeeld om deze via een geauthenticeerd relais te routeren.

VoiceAudioItem

Metadata voor het audiosegment van een enkel gespreksitem. Voor bring-your-own-storage (BYOS) bevat blob_uride respons , een directe klantopslag-URI zonder SAS-token, die de klant met zijn eigen inloggegevens benadert. Voor Foundry-managed opslag blob_uri ontbreekt en worden de bytes via de /audio/content route van het item gestreamd.

VoiceConversation

Een aanhoudend gesprek. De Foundry-envelop die het opgeslagen transcript, antwoorden, per-beurt metrics en audio van een voice-agent bezit. Het is de grens voor ouder, behoud en verwijdering: het verwijderen ervan leidt tot de reacties, items, metrics en audio. Wanneer de finalisatie mislukt, blijven gedeeltelijk overgeleverde reacties, items en itemaudio leesbaar.

VoiceConversationEngine

Een engine die de gespreksafhandeling voor een spraakagent beheert.

VoiceGeneratedAudioItem

Metadata voor de door een gespreksitem gegenereerde audio. Voor bring-your-own-storage (BYOS) bevat blob_uride respons , een directe klantopslag-URI zonder SAS-token, die de klant met zijn eigen inloggegevens benadert. Voor Foundry-managed opslag blob_uri ontbreekt en worden de bytes via de /audio/generated/content route van het item gestreamd.

VoiceHostedAgentConversationEngine

Een gesloten verwijzing naar de gehoste tekstagent die verantwoordelijk is voor het afhandelen van gesprekken voor een spraakagent. De gehoste agent wordt binnen hetzelfde project opgelost en moet het invocations_ws protocol, Voice Live-compatibiliteit en Bridge Protocol 1.0 ondersteunen.

VoiceRecording

Metadata voor de samengevoegde, volledige gespreksstereo-opname van een spraakgesprek (gebruikersaudio op het linkerkanaal, agentaudio op het rechterkanaal). Één keer opgebouwd uit de per-beurt segmenten nadat de sessie is afgelopen en duurzaam gecached. De gemeenschappelijke metadata (formaat, samplefrequentie, kanalen, kanaalindeling, duur) wordt teruggegeven voor zowel Foundry-beheerde als bring-your-own-storage (BYOS) opnames. Voor BYOS omvat blob_urihet antwoord ook , de URI van de opname in de eigen opslag van de klant (geen SAS-token), die de klant downloadt met zijn eigen opslaggegevens. Voor Foundry ontbreekt de beheerde opslag blob_uri en worden de bytes via de /audio/content route gestreamd.

VoiceRecordingChannelLayout

De rol die aan elk kanaal van een samengevoegde stereo-geluidsopname wordt toegekend.

VoiceResponse

Een aanhoudende stemrespons die één model-inferentie-wending binnen een gesprek vertegenwoordigt. In lijstresultaten kan de output projectie worden weggelaten; haal de volledige respons (GET .../responses/{response_id}) of de gepagedde antwoord-items route (GET .../responses/{response_id}/items) op voor de outputitems. created_at / completed_at zijn Foundry duurzame orderuitbreidingen.

VoiceResponseAudio

Audioconfiguratie voor een antwoord. Volgt de vorm van het OpenAI Realtime GA-object audio .

VoiceResponseAudioOutput

De vlakke respons audio-output projectie, met optionele voice, voice_type, voice_locale, en format velden.

VoiceResponseBase

Eigenschappen die gedeeld worden door aanhoudende spraakreacties.

WebIQPreviewTool

Een WebIQ-server-side tool.

WebIQPreviewToolboxTool

Een WebIQ-tool opgeslagen in een gereedschapskist.

WebSearchApproximateLocation

De ongeveer locatie van de gebruiker.

WebSearchConfiguration

Een webzoekconfiguratie voor bing aangepaste zoekopdrachten

WebSearchPreviewTool

Deze tool zoekt op het web naar relevante resultaten om in een reactie te gebruiken. Meer informatie over het webzoekprogramma.

WebSearchTool

Zoek op internet naar bronnen die met de prompt te maken hebben. Meer informatie over het webzoekprogramma.

WebSearchToolFilters

modelinterface WebSearchToolFilters

WebSearchToolboxTool

Een webzoektool opgeslagen in een gereedschapskist.

WeeklyRecurrenceSchedule

Wekelijks herhalingsschema.

WorkIQPreviewTool

Een WorkIQ-server-side tool.

WorkIQPreviewToolboxTool

Een WorkIQ-tool opgeslagen in een gereedschapskist.

WorkflowAgentDefinition

De definitie van de workflowagent.

Type-aliassen

A2AProtocolVersion

Ondersteunde A2A-protocolversies.

ActivityProtocolAccessBoundary

Een toegangsgrens voor het activiteitsprotocol.

AgentBlueprintReferenceType

Type of AgentBlueprintReferenceType

AgentBlueprintReferenceUnion

Alias voor AgentBlueprintReferenceUnion

AgentDefinitionOptInKeys

Functie-opt-in sleutels voor agentdefinitieoperaties die voorwaardelijke previewfuncties ondersteunen.

AgentDefinitionUnion

Unietype voor alle definitietypen van agenten. Ondersteunt workflow, gehosted, container-app, prompt en externe agenten.

AgentEndpoint

Configuratie voor routering, protocollen en autorisatie op een agent-eindpunt.

AgentEndpointAuthorizationSchemeType

Type van AgentEndpointAuthorizationSchemeType

AgentEndpointAuthorizationSchemeUnion

Alias voor AgentEndpointAuthorizationSchemeUnion

AgentHarnessUnion

Alias voor AgentHarnessUnion

AgentIdentityStatus

De status van een agentidentiteit, van toepassing op zowel de agent-instantieidentiteit als het agentblauwdruk.

AgentInsightJsonValue

Een JSON-waarde die wordt gebruikt in Agent Insights-payloads.

AgentInsightOverviewSource

Geeft aan waar een overzicht van Agent Insights vandaan komt.

AgentInsightPromptSurface

Het promptoppervlak is veranderd door een voorgestelde oplossing.

AgentInsightProposedFixKind

Het door klanten renderbare type agent insight voorgestelde oplossing.

AgentInsightRunTrigger

De trigger die een agent insight run in gang zette.

AgentInsightSeverity

De ernst van een agent-inzicht.

AgentInsightStatus

De levenscyclusstatus van een agentinzicht.

AgentKind

Definieert het type/type agent. Bepaalt welke agentdefinitiestructuur wordt gebruikt.

AgentOptimizationCandidateExpand

Vocabulaire voor de expand queryparameter op het kandidaat-LIST-eindpunt. Deze open union houdt SDK's bruikbaar wanneer nieuwe expand-keys server-side worden geleverd. Meerdere waarden worden geserialiseerd als één komma-gescheiden queryparameter.

AgentOptimizationCandidateOutputUnion

Alias for AgentOptimizationCandidateOutputUnion

AgentOptimizationCandidateStatus

De levenscyclusstatus van de kandidaat.

AgentOptimizationConfigurationBaseUnion

Alias for AgentOptimizationConfigurationBaseUnion

AgentOptimizationConfigurationType

Configuratietypes voor optimalisatietaken.

AgentOptimizationDataSourceType

Brontypes ondersteund door optimalisatie-evaluatiesets.

AgentOptimizationEvaluationSetType

Logische rijformaten ondersteund door optimalisatie-evaluatiesets.

AgentOptimizationEvaluationSetUnion

Alias voor AgentOptimizationEvaluationSetUnion

AgentOptimizationGoal

Doel voor een agent-optimalisatiebaan.

AgentOptimizationMutationUnion

Alias voor AgentOptimizationMutationUnion

AgentOptimizationStage

Fase van optimalisatie die modelbronnen verbruikte.

AgentOptimizationTargetCompletionDataSourceUnion

Alias for AgentOptimizationTargetCompletionDataSourceUnion

AgentOptimizationTargetConfigurationType

Doelconfiguratietypen die worden ondersteund door optimalisatiejobs.

AgentOptimizationTargetConfigurationUnion

Alias voor AgentOptimizationTargetConfigurationUnion

AgentOptimizationTerminationReason

Reden dat het optimalisatieproces is beëindigd. Redenen voor vroegtijdig ontslag wijzen nog steeds op een succesvolle baan; voltooide kandidaten blijven beschikbaar.

AgentOptimizationUserConversationSimulationDataSourceUnion

Alias voor AgentOptimizationUserConversationSimulationDataSourceUnion

AgentProtocol

Soort agentProtocol

AgentSessionStatus

De status van een agentensessie.

AgentState

De operationele staat van een agent.

AgentStateSource

Geeft de bron van de operationele staat van een agent aan. Leeg wanneer de toestand niet afkomstig is van een specifieke bron.

AgentType

Type of AgentType

AgentVersionStatus

De provisioningstatus van een agentversie.

AgentsDownloadAgentCodeResponse

Het gedownloade ZIP-archief bevat gehoste agentcode, blootgesteld als een browserblob of Node.js leesbare stream.

AgentsDownloadSessionFileResponse

Het gedownloade agent-sessiebestand, blootgesteld als een browserblob of Node.js leesbare stream.

AgentsPatchAgentObjectOptionalParams

Optionele parameters.

AttackStrategy

Strategieën voor aanvallen.

AzureAISearchQueryType

Beschikbare querytypen voor de Azure AI Zoeken-tool.

BaseCredentialsUnion

Alias voor BaseCredentialsUnion

BetaSkillsDownloadResponse

Het ZIP-archief voor de standaardversie van een vaardigheid, zichtbaar als een browser-Blob of Node.js leesbare stream.

BetaVoiceAgentsConversationsDownloadAudioItemResponse

De WAV-audio voor een conversatie-item, zichtbaar als een browserblob of Node.js leesbare stream.

BetaVoiceAgentsConversationsDownloadAudioResponse

De samengevoegde stereo WAV-opname van een spraakgesprek, zichtbaar als een browserblob of Node.js leesbare stream.

BetaVoiceAgentsConversationsDownloadGeneratedAudioItemResponse

De gegenereerde WAV-audio voor een onderbroken gespreksitem, zichtbaar als een browserblob of Node.js leesbare stream.

CallableToolAllowedCaller

Type of CallableToolAllowedCaller

CodeDependencyResolution

Hoe pakketafhankelijkheden bij de implementatie worden opgelost voor een code-gebaseerde gehoste agent.

ComparisonFilterValueItems

Alias voor ComparisonFilterValueItems

ComputerEnvironment

Type of ComputerEnvironment

ConnectionType

Het type (of categorie) van de verbinding

ContainerMemoryLimit

Type of ContainerMemoryLimit

ContainerNetworkPolicyParamType

Type of ContainerNetworkPolicyParamType

ContainerNetworkPolicyParamUnion

Alias voor ContainerNetworkPolicyParamUnion

ContainerSkillType

Type ContainerVaardigheidstype

ContainerSkillUnion

Alias voor ContainerSkillUnion

ContinuablePage

Een interface die een pagina met resultaten beschrijft.

CreateTelephonyBindingRequestUnion

Alias voor CreateTelephonyBindingRequestUnion

CreateTranscriptionResponseJsonUsageType

Type van CreateTranscriptionResponseJsonUsageType

CreateTranscriptionResponseJsonUsageUnion

Alias voor CreateTranscriptionResponseJsonUsageUnion

CredentialType

Het referentietype dat door de verbinding wordt gebruikt

CustomToolParamFormatType

Type of CustomToolParamFormatType

CustomToolParamFormatUnion

Alias voor CustomToolParamFormatUnion

DataGenerationJobConfigurationUnion

Alias for DataGenerationJobConfigurationUnion

DataGenerationJobInputsUnion

Alias voor DataGenerationJobInputsUnion

DataGenerationJobOutputType

De ondersteunde uitvoerbestandstypen voor een datageneratieklus.

DataGenerationJobOutputUnion

Alias voor DataGenerationJobOutputUnion

DataGenerationJobOutputWriteMode

De ondersteunde schrijfmodi voor datageneratie-taken uitvoeren.

DataGenerationJobScenario

De ondersteunde scenario's voor een datageneratietaak.

DataGenerationJobSourceType

De ondersteunde brontypes voor datageneratietaken.

DataGenerationJobSourceUnion

Alias voor DataGenerationJobSourceUnion

DataGenerationJobType

De ondersteunde datageneratie-taaktypes.

DataGenerationJobUnion

Alias voor DataGenerationJobUnion

DatasetType

Opsomming om het type gegevens te bepalen.

DatasetVersionUnion

Alias voor DatasetVersionUnion

DayOfWeek

Dagen van de week voor het herhalingsschema.

DeploymentType

Type implementatieType

DeploymentUnion

Alias voor DeploymentUnion

DigitalWorkerType

Het type digitale werker.

DownloadVersionResponse

Het ZIP-archief voor een gespecificeerde vaardigheidsversie, zichtbaar als een browser-Blob of Node.js leesbare stream.

EvaluationLevel

Het niveau waarop de evaluatie wordt uitgevoerd.

EvaluationRuleActionType

Aard van de evaluatieactie.

EvaluationRuleActionUnion

Alias voor EvaluationRuleActionUnion

EvaluationRuleEventType

Type van de gebeurtenis van de evaluatieregel.

EvaluationTargetUnion

Alias voor EvaluationTargetUnion

EvaluationTaxonomyInputType

Type van de taxonomie-invoer van de evaluatie.

EvaluationTaxonomyInputUnion

Alias voor evaluatieTaxonomieInputUnie

EvaluationVoiceModelConfigurationUnion

Alias for EvaluationVoiceModelConfigurationUnion

EvaluatorCategory

De categorie van de evaluator

EvaluatorDefinitionType

De definitie van het type beoordelaar

EvaluatorDefinitionUnion

Alias voor EvaluatorDefinitionUnion

EvaluatorGenerationJobSourceType

De ondersteunde brontypes voor evaluatorgeneratie-opdrachten.

EvaluatorGenerationJobSourceUnion

Alias voor EvaluatorGenerationJobSourceUnion

EvaluatorMetricDirection

De richting van de metriek die aangeeft of een hogere waarde beter, een lagere waarde beter of neutraal is

EvaluatorMetricType

Het type van de evaluator

EvaluatorType

Het type van de evaluator

FileContents

Geldige waarden voor de inhoud van een binair bestand.

Filters

Alias voor filters

FoundryFeaturesOptInKeys

Type of FoundryFeaturesOptInKeys

FoundryModelArtifactProfileCategory

De categorie artefactprofiel.

FoundryModelArtifactProfileSignal

Signalen gedetecteerd in het modelartefact.

FoundryModelSourceType

Het brontype van het model.

FoundryModelWarningCode

Waarschuwingscode voor modelartefacten.

FoundryModelWeightType

Het type gewicht van het model.

FunctionShellToolParamEnvironmentType

Type functieShellToolParamEnvironmentType

FunctionShellToolParamEnvironmentUnion

Alias voor FunctionShellToolParamEnvironmentUnion

GenerateAgentRequest

De type-specifieke input voor het genereren en creëren van een agent.

GenerationWarningType

Een categorie van een waarschuwing verscheen op een gegenereerde evaluatorversie. Uitbreidbaar zodat nieuwe waarschuwingscategorieën (bijv. veiligheid, uitvoerkwaliteit) kunnen worden geïntroduceerd zonder een brekende wijziging.

GetMicrosoft365PackageResponse

Het binaire Microsoft 365-apppakket werd gegenereerd voor een Foundry-agent.

GitHubCopilotBuiltInTool

Een door de klant configureerbare GitHub Copilot-tool.

GitHubIssueEvent

Bekende GitHub-uitwerpgebeurtenissen die een routine kunnen activeren.

GrammarSyntax

Type grammaticaSyntaxis

ImageGenAction

Type of ImageGenAction

IndexType

Soort indexType

IndexUnion

Alias voor IndexUnion

InputFidelity

Bepaal hoeveel inspanning het model zal uitoefenen om overeen te komen met de stijl en kenmerken, met name gezichtskenmerken, van invoerafbeeldingen. Deze parameter wordt alleen ondersteund voor gpt-image-1 en gpt-image-1.5 en latere modellen, niet ondersteund voor gpt-image-1-mini. Ondersteunt high en low. Wordt standaard ingesteld op low.

InsightRequestUnion

Alias voor InsightRequestUnion

InsightResultUnion

Alias voor InsightResultUnion

InsightSampleUnion

Alias voor InsightSampleUnion

InsightType

Het verzoek van de inzichten.

JobPoller

Een poller voor een langlopende operatie die een jobbron creëert.

JobStatus

Uitbreidbare statuswaarden gedeeld door Foundry-banen.

MemoryItemKind

Soort geheugenitem.

MemoryItemUnion

Alias voor MemoryItemUnion

MemoryOperationKind

Soort geheugenwerking.

MemoryStoreDefinitionUnion

Alias voor MemoryStoreDefinitionUnion

MemoryStoreKind

Het type implementatie van de geheugenopslag dat moet worden gebruikt.

MemoryStoreType

Type van MemoryStoreType

MemoryStoreUpdateStatus

Status van een updatebewerking van het geheugen.

Microsoft365PublishScope

De publicatiescope voor de gegenereerde Microsoft Teams-app.

MisalignmentErrorType

Een classificatie van een handeling die mogelijk niet overeenkomt met de intentie van de gebruiker. Extra waarden kunnen worden teruggegeven.

NodeReadableStream

Typ alias voor Node.js ReadableStream. Op Node-doelen wordt dit opgelost naar het daadwerkelijke NodeJS.ReadableStream-type. Op browser/react-native targets lost de platformvariant op naar never, wat vanzelf uit uniontypes valt.

OpenApiAuthDetailsUnion

Alias voor OpenApiAuthDetailsUnion

OpenApiAuthType

Verificatietype voor OpenApi-eindpunt. Toegestane soorten zijn:

  • Anoniem (geen authenticatie vereist)
  • Project Verbinding (vereist project_connection_id naar het eindpunt, zoals ingesteld in AI Foundry)
  • Managed_Identity (vereist publiek voor verificatie op basis van identiteit)
OperationState

Enum beschrijft de toegestane bewerkingstoestanden.

OptimizationCandidate

De configuratiewijzigingen en geaggregeerde evaluatieresultaten voor een kandidaat voor agentoptimalisatie.

OptimizationContextType

Type context geleverd aan een optimalisatieworkflow.

OptimizationContextUnion

Alias voor OptimizationContextUnion

OptimizationJob

Een agentoptimalisatiebaan die input, voortgang, status en resultaten van kandidaatbeoordeling bijhoudt.

OptimizationJobResult

De evalueerde kandidaten en identificaties van de basislijn en beste kandidaat van een optimalisatiefunctie.

PageOrder

Type of PageOrder

PendingUploadType

Het type upload dat in afwachting is.

PublishApprovalStatus

De Microsoft Agent Certification reviewstatus van de Microsoft 365 Store-titel gepubliceerd voor een agent.

RaiInvocationContentType

Hoe een aanroepingsverzoek/respons-body wordt ontleed om tekst te vinden voor content-safety moderatie.

RaiInvocationMode

Door de auteur gedeclareerde responsvorm voor het aanroepprotocol.

RankerVersionType

Type RankerVersieType

RealtimeAudioFormatsType

Type of RealtimeAudioFormatsType

RealtimeAudioFormatsUnion

Alias voor RealtimeAudioFormatsUnion

RealtimeClientEventType

Type van RealtimeClientEventType

RealtimeClientEventUnion

Alias for RealtimeClientEventUnion

RealtimeConversationItemMessageType

Type of RealtimeConversationItemMessageType

RealtimeConversationItemMessageUnion

Alias voor RealtimeConversationItemMessageUnion

RealtimeConversationItemType

Type of RealtimeConversationItemType

RealtimeConversationItemUnion

Alias voor RealtimeConversationItemUnion

RealtimeFunctionToolParameters

modelinterface RealtimeFunctionToolParameters

RealtimeMCPErrorType

Type of RealtimeMCPErrorType

RealtimeMCPErrorUnion

Alias voor RealtimeMCPErrorUnion

RealtimeReasoningEffort

Beperkt de inspanning op redeneren voor realtime-modellen die redeneerbaar zijn zoals gpt-realtime-2.

RealtimeServerEventType

Type van RealtimeServerEventType

RealtimeServerEventUnion

Alias voor RealtimeServerEventUnion

ReasoningEffort

Beperkt de inspanning voor redenering bij redeneringsmodellen. Momenteel ondersteunde waarden zijn none, , , minimal, lowmedium, en highxhigh. Het verminderen van redeneringsinspanningen kan leiden tot snellere antwoorden en minder tokens die worden gebruikt voor redenering in een antwoord.

  • gpt-5.1 standaard op none, wat geen redeneren uitvoert. De ondersteunde redeneerwaarden voor gpt-5.1 zijn none, low, , mediumen high. Hulpprogramma-aanroepen worden ondersteund voor alle redeneringswaarden in gpt-5.1.
  • Alle modellen vóór gpt-5.1 de standaard gebruiken medium redeneerinspanning, en ondersteunen nonegeen .
  • Het gpt-5-pro model gebruikt standaard (en ondersteunt alleen) high redeneerinspanning.
  • xhigh wordt ondersteund voor alle modellen na gpt-5.1-codex-max.
ReasoningModeEnum

Alias voor ReasoningModeEnum

RecurrenceScheduleUnion

Alias voor RecurrenceScheduleUnion

RecurrenceType

Type herhaling.

RedTeamTargetConfigUnion

Alias for RedTeamTargetConfigUnion

RiskCategory

Risicocategorie voor het aanvalsdoel.

RoutineActionType

De discriminatorwaarden die worden ondersteund voor routinematige handelingen.

RoutineActionUnion

Alias voor RoutineActionUnion

RoutineAttemptSource

Bekende bronpaden die een routinerun kunnen produceren.

RoutineDispatchIdentity

De ondersteunde identiteiten voor routinematige dispatchautorisatie.

RoutineDispatchPayloadType

De discriminatorwaarden werden ondersteund voor handmatige routinematige dispatch-payloads.

RoutineDispatchPayloadUnion

Alias voor RoutineDispatchPayloadUnion

RoutineRunPhase

Bekende levenscyclusfasen geregistreerd voor een routine-run.

RoutineRunStatus

De status van een routinerun.

RoutineTriggerType

De discriminatorwaarden die worden ondersteund voor routinematige triggers.

RoutineTriggerUnion

Alias voor RoutineTriggerUnion

RubricGenerationInputQualityWarningCode

Stabiele doorzoekbare, machineleesbare waarschuwingscode voor een rubric-generatie inputkwaliteitswaarschuwing. Waarden zijn snake_case; clients moeten extra service-defined identifiers tolereren.

RubricGenerationInputQualityWarningSeverity

Adviserende ernst voor een waarschuwing voor invoerkwaliteit van rubric-generatie. Initiële waardeset: warning.

RubricGenerationInputQualityWarningSource

Waarschuwingsbron-toeschrijving voor een waarschuwing voor rubric-generatie invoerkwaliteit. Per-source waarden (prompt, agent, dataset) komen overeen met de broncategorie die zichtbaar is voor de generatieruntime. aggregate is een synthetische waarde die alleen wordt gebruikt voor waarschuwingen die zijn berekend over succesvol opgeloste bronnen. traces wordt niet blootgesteld omdat trace-bronnen upstream worden omgezet in datasetinhoud.

RunPoller

Een poller voor een langlopende operatie die een runresource creëert.

SampleType

Het type monster dat in de analyse wordt gebruikt.

ScheduleProvisioningStatus

Planningsstatus inplannen.

ScheduleTaskType

Type taak.

ScheduleTaskUnion

Alias voor ScheduleTaskUnion

SearchContentType

Type zoekInhoudType

SearchContextSize

Type zoekContextSize

SessionLogEventType

Bekende SSE-gebeurtenistypes die worden verzonden door de sessielogstroom van de gehoste agent. Aanvullende gebeurtenistypen kunnen in toekomstige versies worden geïntroduceerd.

SimpleQnAFineTuningQuestionType

De ondersteunde vraagtypes voor SimpleQnA-datageneratietaken worden gebruikt voor het fijn afstemmen van scenario's.

TargetAttribute

Agent-attribuut dat geoptimaliseerd kan worden.

TelemetryDataKind

Het type telemetriegegevens dat geëxporteerd moet worden.

TelemetryEndpointAuthType

Het type authenticatie voor een telemetrie-endpoint.

TelemetryEndpointAuthUnion

Alias for TelemetryEndpointAuthUnion

TelemetryEndpointKind

Het soort telemetrie-export-endpoint.

TelemetryEndpointUnion

Alias voor TelemetryEndpointUnion

TelemetryTransportProtocol

Het transportprotocol voor telemetrie-export.

TelephonyBindingListItemUnion

Alias voor TelephonyBindingListItemUnion

TelephonyBindingStatus

De levenscyclusstatus van een telefoniebinding.

TelephonyBindingUnion

Alias voor TelephonyBindingUnion

TelephonyCallDurationBasis

De tijdstempel die als basis wordt gebruikt voor de duur van het gesprek.

TelephonyCallEndReason

Bekende door de dienst veroorzaakte redenen waarom één telefoongesprek eindigde, in plaats van redenen voor een totale uitgaande oproep. Aanvullende stringcodes kunnen worden teruggegeven.

TelephonyCallJobStatus

De levenscyclusstatus van een duurzame uitgaande oproepopdracht.

TelephonyCallJobTerminalReason

Bekende terminale redenen voor een totale uitgaande oproep, die meerdere providers kan omvatten. Deze verschillen van individuele oproeplevenscyclusredenen. Aanvullende stringcodes kunnen worden teruggegeven.

TelephonyCallLifecycleEventName

Een provider-neutrale levenscyclusgebeurtenisnaam. Bekende waarden zijn stabiel; in de loop van de tijd kunnen extra waarden worden toegevoegd.

TelephonyCallLifecycleEventOutcome

Het resultaat van één observatie van de telefonielevenscyclus.

TelephonyCallLifecycleEventReason

Bekende door de dienst veroorzaakte redenen voor een telefonie-levenscyclusgebeurtenis. Een gebeurtenisreden beschrijft niet noodzakelijkerwijs de uiteindelijke uitkomst van de call. Aanvullende stringcodes kunnen worden teruggegeven.

TelephonyCallLifecycleEventSource

De component die een telefonie-levenscycluswaarneming leverde.

TelephonyCallPhase

De provider-neutrale fase wordt bereikt via een inkomend telefoniegesprek.

TelephonyCallStatus

De levenscyclusstatus van een inkomend telefoniegesprek.

TelephonyCallTimestampSource

De bron van een telefoonlevenscyclustijdstempel.

TelephonyCallTraceMode

De modus die wordt gebruikt om een telefoniegesprek bloot te stellen als een klantgerichte Foundry-trace.

TelephonyCallTraceStatus

De beschikbaarheidsstatus van een klantgerichte telefonieoproeptrace.

TelephonyOutboundDestinationType

Het type bestemming voor een uitgaande oproep.

TelephonyOutboundRetryPolicyType

De herkansingsstrategie voor een uitgaande oproep.

TelephonyOutboundRetryPolicyUnion

Alias voor TelephonyOutboundRetryPolicyUnion

TelephonyProvider

Een telefonieprovider ondersteund door een agent binding. Bekende waarden zijn stabiel; in de loop van de tijd kunnen extra waarden worden toegevoegd.

TelephonyTransferDestinationKind

Het soort telefoonoverdrachtsbestemming. Bekende waarden zijn stabiel; in de loop van de tijd kunnen extra waarden worden toegevoegd.

TelephonyTransferDestinationUnion

Alias voor TelephonyTransferDestinationUnion

TextResponseFormatConfigurationType

Type TekstAntwoordFormaatConfiguratieType

TextResponseFormatConfigurationUnion

Ondersteunde configuraties voor platte tekst en gestructureerde JSON-antwoorden.

TextResponseFormatUnion

Alias voor TextResponseFormatUnion

ToolChoiceOptions

Hiermee bepaalt u welke (indien van toepassing) hulpprogramma's worden aangeroepen door het model. none betekent dat het model geen hulpprogramma aanroept en in plaats daarvan een bericht genereert. auto betekent dat het model kan kiezen tussen het genereren van een bericht of het aanroepen van een of meer hulpprogramma's. required betekent dat het model een of meer hulpprogramma's moet aanroepen.

ToolChoiceParamType

Type ToolKeuzeParamType

ToolChoiceParamUnion

Alias voor ToolChoiceParamUnion

ToolSearchExecutionType

Type of ToolSearchExecutionType

ToolType

Type GereedschapType

ToolUnion

Alias voor ToolUnion

ToolboxShellEnvironmentUnion

Alias voor ToolboxShellEnvironmentUnion

ToolboxShellNetworkPolicyUnion

Alias voor ToolboxShellNetworkPolicyUnion

ToolboxSkillUnion

Alias voor ToolboxSkillUnion

ToolboxToolType

Ondersteunde gereedschapstypen voor gereedschappen opgeslagen in een gereedschapskist.

ToolboxToolUnion

Alias voor ToolboxToolUnion

ToolboxesInvokeLatestToolboxMcpResponse

Het antwoord wordt teruggegeven door het nieuwste toolbox MCP-eindpunt.

TreatmentEffectType

Type behandelingseffect.

TriggerType

Type van de trekker.

TriggerUnion

Alias voor TriggerUnion

UserConversationSimulationAudioEffect

Effect dat kan worden toegepast op gesimuleerde gespreksaudio. De vereniging is uitbreidbaar voor extra effecten.

UserConversationSimulationInterruptionConfigurationUnion

Alias for UserConversationSimulationInterruptionConfigurationUnion

VersionIndicatorType

Het type versie-indicator dat wordt gebruikt om de agentversie te bepalen die een sessie ondersteunt.

VersionIndicatorUnion

Alias voor VersionIndicatorUnion

VersionSelectionRuleType

Type VersieSelectieRegelType

VersionSelectionRuleUnion

Alias voor VersionSelectionRuleUnion

VoiceAgentAnimationOutputType

Een animatie-output geproduceerd door een voice-agent-sessie.

VoiceAgentAudioTimestampType

Een output-audio tijdstempel type ondersteund door een spraakagent.

VoiceAgentAvatarOutputProtocol

Het transport dat wordt gebruikt om de avatar-videostream te leveren.

VoiceAgentAvatarType

Het avatar-type.

VoiceAgentClientEvent

Een stabiel v1-bericht verzonden door een client via een voice-agent WebSocket.

VoiceAgentConnectionState

Verbindingstoestanden gerapporteerd door een spraak-agent realtime verbinding.

VoiceAgentConnectionStateChangedHandler

Opgeroepen wanneer een spraak-agentverbinding van toestand verandert.

VoiceAgentEchoCancellationReferenceSource

De bron van referentieaudio die wordt gebruikt voor echo-onderdrukking.

VoiceAgentEndOfUtteranceDetectionModel

Het semantische einde-van-uit-uiting-detectiemodel.

VoiceAgentEndOfUtteranceThresholdLevel

De gevoeligheidsdrempel voor semantische einde-van-uit-uiting-detectie.

VoiceAgentGreetingConfigUnion

Alias for VoiceAgentGreetingConfigUnion

VoiceAgentInputTranscriptionModel

De input-audio transcriptiemodel-identificatie. Dit is een modelnaam, geen Foundry-implementatienaam. Spiegelt de transcriptiemodellen die worden ondersteund door de beheerde spraakbackend, en omvat de OpenAI Realtime transcriptiemodellen plus de Azure- en MAI-modellen. Er kunnen in de loop van de tijd extra waarden worden toegevoegd.

VoiceAgentInterimResponseConfigUnion

Alias for VoiceAgentInterimResponseConfigUnion

VoiceAgentInterimResponseTrigger

Een aandoening die een tussentijdse reactie kan uitlokken.

VoiceAgentMaxOutputTokens

Het maximale aantal outputtokens of het letterlijke inf.

VoiceAgentNoiseReductionType

De input-audio-ruisonderdrukkingsmodus.

VoiceAgentRealtimeErrorCode

Foutcodes die door de realtime client van de Voice Agents worden opgeroepen.

VoiceAgentRealtimeEvent

Een gebeurtenis ontvangen van een spraak-agent realtime verbinding.

Bekende gebeurtenissen behouden hun gegenereerde types en normalisatie. Niet-herkende draadtypen zijn omwikkeld met VoiceAgentUnknownEvent. Schakel type over op smalle bekende gebeurtenissen, of sluit type === "unknown" uit voordat je een gebeurtenis doorgeeft aan een bekende gebeurtenishandler.

VoiceAgentServerEvent

Een stabiel v1-bericht verzonden door de dienst via een voice-agent WebSocket.

VoiceAgentSessionIncludeOption

Aanvullende velden die een spraakagent-sessie kan bevatten in service-outputs.

VoiceAgentSessionResponse

De effectieve sessieconfiguratie keerde terug in spraak-agent sessie levenscyclusgebeurtenissen.

VoiceAgentSessionUpdate

De sessieconfiguratie wordt geaccepteerd door een spraak-agent sessie-updategebeurtenis.

VoiceAgentSubagentAbortReason

De reden dat een consultatie met een subagent werd afgebroken.

VoiceAgentSystemToolName

Een door de service beheerde spraaksessie-controleactie. Bekende waarden zijn stabiel; in de loop van de tijd kunnen extra waarden worden toegevoegd.

VoiceAgentSystemToolUnion

Alias voor VoiceAgentSystemToolUnion

VoiceAgentToolChoice

Toolselectiegedrag voor een voice agent.

VoiceAgentToolResponseScheduling

Wanneer een tool-invocation een vervolgrespons veroorzaakt. Er kunnen in de loop van de tijd extra waarden worden toegevoegd.

VoiceAgentToolUnion

Alias voor VoiceAgentToolUnion

VoiceAgentTransport

Het transport dat wordt gebruikt voor een spraak-agentverbinding.

VoiceAgentTurnDetectionConfigUnion

Alias for VoiceAgentTurnDetectionConfigUnion

VoiceAgentTurnDetectionType

De strategie voor beurtdetectie. Er kunnen in de loop van de tijd extra waarden worden toegevoegd.

VoiceAgentWebSocketMessage

Een JSON-tekstbericht uitgewisseld via een gevestigde voice-agent WebSocket. Audiobytes zijn base64-gecodeerd in JSON-gebeurtenisvelden.

VoiceAgentWebSocketSubprotocol

Het WebSocket-subprotocol wordt ondersteund door een spraak-agentverbinding.

VoiceAudioCodec

Een audiocodec. Er kunnen in de loop van de tijd extra waarden worden toegevoegd.

VoiceAudioContainerFormat

Een audiocontainerformaat. Er kunnen in de loop van de tijd extra waarden worden toegevoegd.

VoiceAudioRole

Een voice-audio deelnemerrol. Er kunnen in de loop van de tijd extra waarden worden toegevoegd.

VoiceConversationEngineUnion

Alias voor VoiceConversationEngineUnion

VoiceConversationStatus

De levenscyclusstatus van een aanhoudend spraakgesprek:

  • in_progress: de live sessie is actief, of de afronding van de persistentie na de sessie is nog in behandeling.
  • completed: de finalisatie is geslaagd na een normale of client-sluiting, end_conversation, een maximale duur 1001 van de afsluiting, of een client- of netwerkonderbreking die de dienst nog kan afronden.
  • failed: een terminalservice, brug, opslag of onherstelbaar transportfout voorkwam de finalisatie.
VoiceModelType

Hoe het model dat een voice agent ondersteunt wordt bediend. Dit is onafhankelijk van de architectuur (realtime of gecascadeerd), die de service afleidt van het gekozen model.

VoiceOutputModality

Een uitvoermodaliteit die de agent kan produceren. animation en avatar worden gebruikt wanneer een avatar wordt geconfigureerd.

VoiceType

De spraakimplementatie. Er kunnen in de loop van de tijd extra waarden worden toegevoegd.

Enums

KnownApiVersions

Microsoft Foundry API-versies

Functies

isRestError(unknown)

Typeguard voor RestError

Variabelen

RestError

Een aangepast fouttype voor mislukte pijplijnaanvragen.

KnownVoiceAgentConnectionState

Bekende waarden van VoiceAgentConnectionState gerapporteerd door een spraak-agent realtime verbinding.

Functiedetails

isRestError(unknown)

Typeguard voor RestError

function isRestError(e: unknown): e is RestError

Parameters

e

unknown

Iets betrapt door een catch-component.

Retouren

e is RestError

Variabele details

RestError

Een aangepast fouttype voor mislukte pijplijnaanvragen.

RestError: RestErrorConstructor

Type

KnownVoiceAgentConnectionState

Bekende waarden van VoiceAgentConnectionState gerapporteerd door een spraak-agent realtime verbinding.

KnownVoiceAgentConnectionState: { Closing: "closing", Connected: "connected", Connecting: "connecting", Disconnected: "disconnected" }

Type

{ Closing: "closing", Connected: "connected", Connecting: "connecting", Disconnected: "disconnected" }