@azure/ai-projects package

Classes

AIProjectClient

Le client principal pour le client AIProjectClient

VoiceAgentAuthenticationError

Une erreur a été signalée lors de l’acquisition d’un jeton d’accès Microsoft Entra.

VoiceAgentConnectionError

Une erreur générée par la connexion WebSocket.

VoiceAgentProtocolError

Une erreur est générée lorsqu’un message WebSocket ne correspond pas au protocole de l’agent vocal.

VoiceAgentRealtimeClient

Client pour établir des sessions en temps réel avec des agents vocaux Foundry gérés.

VoiceAgentRealtimeError

Erreur de base générée par le client en temps réel des agents vocaux.

Interfaces

@azure/ai-projects.Index
A2APreviewTool

Un agent implémentant le protocole A2A.

A2APreviewToolboxTool

Un outil A2A stocké dans une boîte à outils.

A2AProtocolConfiguration

Configuration spécifique au protocole A2A.

A2ATool

Un agent implémentant le protocole A2A.

A2AToolboxTool

Un outil A2A stocké dans une boîte à outils.

AIProjectClientOptionalParams

Paramètres facultatifs pour le client.

AISearchIndexResource

Une ressource d’index de recherche IA.

ActivityProtocolConfiguration

Configuration spécifique au protocole d’activité.

Agent

Agent d’interface modèle

AgentBlueprintReference

interface modèle AgentBlueprintReference

AgentCard

interface modèle AgentCard

AgentCardSkill

interface de modèle AgentCardSkill

AgentClusterInsightRequest

Informations sur l’ensemble des résultats de l’évaluation des agents

AgentClusterInsightResult

Aperçu de l’analyse du cluster d’agents.

AgentDataGenerationJobSource

Source d’agent pour les tâches de génération de données — référence à un agent pour récupérer des instructions et des métadonnées.

AgentDefinition

Interface de définition de base pour les agents. Contient le type d’agent et la configuration RAI facultative.

AgentEndpointAuthorizationScheme

interface de modèle AgentEndpointAuthorizationScheme

AgentEndpointConfig

interface modèle AgentEndpointConfig

AgentEvaluatorGenerationJobSource

Source d’agent pour les tâches de génération d’évaluateurs — référence à un agent pour récupérer des instructions et des métadonnées.

AgentHarness

(Aperçu) Un runtime géré et une boucle d’agent utilisés pour exécuter un agent de prompt.

AgentIdentity

interface modèle AgentIdentity

AgentInsight

Un problème persistant découvert à partir des traces d’un agent.

AgentInsightDetails

Détails supplémentaires sur les détails. Omise sauf demande de détails.

AgentInsightEstimatedCost

Coût estimé des Agent Insights.

AgentInsightHighlightedTrace

Une trace mise en avant qui apporte des preuves d’une vision d’un agent.

AgentInsightJsonObject

Un objet JSON utilisé dans les charges utiles Agent Insights.

AgentInsightLinkedTrace

Une référence de trace légère liée à l’intuition d’un agent comme preuve à l’appui.

AgentInsightMonitor

Un moniteur Agent Insights par agent qui gère la configuration, exécute et découvre les insights.

AgentInsightMonitorCreate

Champs acceptés lors de la création d’un moniteur Agent Insights pour un agent.

AgentInsightMonitorListItem

Un résumé du moniteur Agent Insights est rendu par les opérations de liste.

AgentInsightMonitorUpdate

Champs pouvant être mis à jour sur un moniteur Agent Insights.

AgentInsightProposedFix

Une solution recommandée pour un avis d’agent.

AgentInsightProposedFixChange

Un changement rendable par le client dans une solution proposée.

AgentInsightRecommendedAction

La remédiation recommandée pour un agent est un point de vue.

AgentInsightRun

Une série de longue durée qui analyse les traces d’un agent et met à jour ses informations.

AgentInsightRunCreate

Entrées utilisées lors de la création d’une exécution d’insight d’agent.

AgentInsightRunResult

Statistiques de résultats produites lorsqu’une run d’insight d’agent réussit.

AgentInsightSuspension

Raison structurée pour laquelle la génération programmée est suspendue pour un moniteur.

AgentInsightTokenUsage

Utilisation du jeton pour une exécution Agent Insights.

AgentInsightUpdate

Des champs qui peuvent être mis à jour selon les insights d’un agent.

AgentInsightsOverview

La vue d’ensemble efficace pour un moniteur Agent Insights.

AgentInsightsOverviewOverride

Un aperçu fourni par les utilisateurs qui devient immédiatement efficace et ensemence la génération suivante.

AgentOptimizationCandidate

Résultat agrégé de l’évaluation pour une configuration d’agent candidat unique sur toutes les tâches.

AgentOptimizationDatasetCriterion

Critère d’évaluation : une paire nom + instruction utilisée pour le notation par item.

AgentOptimizationDatasetInput

Modèle discriminé de base pour l’entrée de jeux de données. Soit des éléments en ligne, soit une référence enregistrée.

AgentOptimizationDatasetItem

Un seul élément dans un jeu de données en ligne.

AgentOptimizationEvaluatorRef

Référence à un évaluateur nommé, épinglé éventuellement sur une version.

AgentOptimizationInlineDatasetInput

Jeu de données en ligne — éléments fournis directement dans le corps de la demande.

AgentOptimizationJob

Ressource de travail d’optimisation de l’agent — un travail de longue durée qui optimise la configuration d’un agent (instructions, modèle, compétences, outils) pour maximiser les scores d’évaluation. En cas de succès, le résultat contient les candidats notés.

AgentOptimizationJobInputs

Entrées fournies par l’appelant pour un travail d’optimisation.

AgentOptimizationJobListItem

Représentation du poste mince restituée par le point de terminaison LIST.

AgentOptimizationJobProgress

Progression en vol ; Seulement rempli pendant que le statut est en file d’attente ou in_progress.

AgentOptimizationJobResult

Corps de résultat en état terminal. Populate lorsque le statut est réussi ou échoué.

AgentOptimizationOptions

Réglage des boutons et du mode exécution pour un travail d’optimisation.

AgentOptimizationReferenceDatasetInput

Référence à un jeu de données Foundry enregistré.

AgentSessionResource

Une session d’agent fournissant un bac à sable de calcul durable pour les invocations d’agents hébergés.

AgentTaxonomyInput

Configuration d’entrée pour la taxonomie d’évaluation lorsque le type d’entrée est agent.

AgentVersion

Représente une version spécifique d’un agent. Inclut les métadonnées, la gestion des versions, l’heure de création et la définition de l’agent.

AgenticIdentityPreviewCredentials

Définition des informations d’identification d’identité agentique

AgentsCreateAgentFromManifestOptionalParams

Paramètres facultatifs.

AgentsCreateAgentVersionFromManifestOptionalParams

Paramètres facultatifs.

AgentsCreateOptionalParams

Paramètres facultatifs.

AgentsCreateSessionOptionalParams

Paramètres facultatifs.

AgentsCreateTelephonyBindingOptionalParams

Paramètres facultatifs.

AgentsCreateVersionFromCodeOptionalParams

Paramètres facultatifs.

AgentsCreateVersionOptionalParams

Paramètres facultatifs.

AgentsDeleteOptionalParams

Paramètres facultatifs.

AgentsDeleteSessionFileOptionalParams

Paramètres facultatifs.

AgentsDeleteSessionOptionalParams

Paramètres facultatifs.

AgentsDeleteTelephonyBindingOptionalParams

Paramètres facultatifs.

AgentsDeleteVersionOptionalParams

Paramètres facultatifs.

AgentsDisableOptionalParams

Paramètres facultatifs.

AgentsDownloadAgentCodeOptionalParams

Paramètres facultatifs.

AgentsDownloadSessionFileOptionalParams

Paramètres facultatifs.

AgentsEnableOptionalParams

Paramètres facultatifs.

AgentsGetOptionalParams

Paramètres facultatifs.

AgentsGetSessionLogStreamOptionalParams

Paramètres facultatifs.

AgentsGetSessionOptionalParams

Paramètres facultatifs.

AgentsGetTelephonyBindingOptionalParams

Paramètres facultatifs.

AgentsGetVersionOptionalParams

Paramètres facultatifs.

AgentsListOptionalParams

Paramètres facultatifs.

AgentsListSessionFilesOptionalParams

Paramètres facultatifs.

AgentsListSessionsOptionalParams

Paramètres facultatifs.

AgentsListTelephonyBindingsOptionalParams

Paramètres facultatifs.

AgentsListTelephonyCallsOptionalParams

Paramètres facultatifs.

AgentsListVersionsOptionalParams

Paramètres facultatifs.

AgentsOperations

Interface représentant une opération d’agents.

AgentsStopSessionOptionalParams

Paramètres facultatifs.

AgentsUpdateAgentFromManifestOptionalParams

Paramètres facultatifs.

AgentsUpdateAgentObjectOptionalParams

Paramètres facultatifs.

AgentsUpdateOptionalParams

Paramètres facultatifs.

AgentsUpdateTelephonyBindingOptionalParams

Paramètres facultatifs.

AgentsUploadSessionFileOptionalParams

Paramètres facultatifs.

ApiErrorResponse

Réponse d’erreur en cas d’échec de l’API.

ApiKeyCredentials

Définition des informations d’identification de la clé API

ApplyPatchToolParam

Permet à l’assistant de créer, supprimer ou mettre à jour des fichiers en utilisant des diffs unifiées.

ApproximateLocation

Interface du modèle ApproximateLocation

ArtifactProfile

Profil d’artefact du modèle

AutoCodeInterpreterToolParam

Configuration d’un conteneur d’interpréteur de code. Vous pouvez éventuellement spécifier les ID des fichiers pour exécuter le code.

AzureAIAgentTarget

Représente une cible spécifiant un agent IA Azure.

AzureAIModelTarget

Représente une cible spécifiant un modèle IA Azure pour des opérations nécessitant une sélection de modèle.

AzureAISearchIndex

définition d’index Recherche Azure AI

AzureAISearchTool

Les informations de définition d’entrée pour un outil de recherche IA Azure utilisées pour configurer un agent.

AzureAISearchToolResource

Ensemble de ressources d’index utilisées par l’outil azure_ai_search.

AzureAISearchToolboxTool

Un outil Recherche Azure AI stocké dans une boîte à outils.

AzureAgentConfig

Options de configuration pour le point de terminaison agent de la méthode getOpenAIClient. Principalement utilisé pour les agents hébergés.

AzureFunctionBinding

Structure permettant de conserver storage nom de file d’attente et l’URI.

AzureFunctionDefinition

La définition de la fonction Azure.

AzureFunctionStorageQueue

Structure permettant de conserver storage nom de file d’attente et l’URI.

AzureFunctionTool

Les informations de définition d’entrée pour un outil de fonction Azure, telles qu’utilisées pour configurer un agent.

AzureOpenAIModelConfiguration

Azure OpenAI configuration de modèles. La version de l’API est sélectionnée par le service pour interroger le modèle.

BaseCredentials

Une classe de base pour les identifiants de connexion

BetaAgentInsightMonitorsCancelRunOptionalParams

Paramètres facultatifs.

BetaAgentInsightMonitorsCreateOptionalParams

Paramètres facultatifs.

BetaAgentInsightMonitorsCreateRunOptionalParams

Paramètres facultatifs.

BetaAgentInsightMonitorsDeleteOptionalParams

Paramètres facultatifs.

BetaAgentInsightMonitorsGetInsightOptionalParams

Paramètres facultatifs.

BetaAgentInsightMonitorsGetOptionalParams

Paramètres facultatifs.

BetaAgentInsightMonitorsGetRunOptionalParams

Paramètres facultatifs.

BetaAgentInsightMonitorsListInsightsOptionalParams

Paramètres facultatifs.

BetaAgentInsightMonitorsListOptionalParams

Paramètres facultatifs.

BetaAgentInsightMonitorsListRunsOptionalParams

Paramètres facultatifs.

BetaAgentInsightMonitorsOperations

Interface représentant une opération BetaAgentInsightMonitors.

BetaAgentInsightMonitorsResetOptionalParams

Paramètres facultatifs.

BetaAgentInsightMonitorsUpdateInsightOptionalParams

Paramètres facultatifs.

BetaAgentInsightMonitorsUpdateOptionalParams

Paramètres facultatifs.

BetaAgentsCancelOptimizationJobOptionalParams

Paramètres facultatifs.

BetaAgentsCreateFromPromptOptionalParams

Paramètres facultatifs.

BetaAgentsCreateOptimizationJobOptionalParams

Paramètres facultatifs.

BetaAgentsDeleteOptimizationJobOptionalParams

Paramètres facultatifs.

BetaAgentsGetOptimizationJobOptionalParams

Paramètres facultatifs.

BetaAgentsListOptimizationJobsOptionalParams

Paramètres facultatifs.

BetaAgentsOperations

Opérations pour les agents de gestion.

BetaDatasetsCancelGenerationJobOptionalParams

Paramètres facultatifs.

BetaDatasetsCreateGenerationJobOptionalParams

Paramètres facultatifs.

BetaDatasetsDeleteGenerationJobOptionalParams

Paramètres facultatifs.

BetaDatasetsGetGenerationJobOptionalParams

Paramètres facultatifs.

BetaDatasetsListGenerationJobsOptionalParams

Paramètres facultatifs.

BetaDatasetsOperations

Interface représentant les opérations d’un BetaDatasets.

BetaEvaluationTaxonomiesCreateOptionalParams

Paramètres facultatifs.

BetaEvaluationTaxonomiesDeleteOptionalParams

Paramètres facultatifs.

BetaEvaluationTaxonomiesGetOptionalParams

Paramètres facultatifs.

BetaEvaluationTaxonomiesListOptionalParams

Paramètres facultatifs.

BetaEvaluationTaxonomiesOperations

Interface représentant une opération BetaEvaluationTaxonomies.

BetaEvaluationTaxonomiesUpdateOptionalParams

Paramètres facultatifs.

BetaEvaluatorsCancelGenerationJobOptionalParams

Paramètres facultatifs.

BetaEvaluatorsCreateGenerationJobOptionalParams

Paramètres facultatifs.

BetaEvaluatorsCreateVersionOptionalParams

Paramètres facultatifs.

BetaEvaluatorsDeleteGenerationJobOptionalParams

Paramètres facultatifs.

BetaEvaluatorsDeleteVersionOptionalParams

Paramètres facultatifs.

BetaEvaluatorsGetCredentialsOptionalParams

Paramètres facultatifs.

BetaEvaluatorsGetGenerationJobOptionalParams

Paramètres facultatifs.

BetaEvaluatorsGetVersionOptionalParams

Paramètres facultatifs.

BetaEvaluatorsListGenerationJobsOptionalParams

Paramètres facultatifs.

BetaEvaluatorsListOptionalParams

Paramètres facultatifs.

BetaEvaluatorsListVersionsOptionalParams

Paramètres facultatifs.

BetaEvaluatorsOperations

Interface représentant les opérations d’un BetaEvaluators.

BetaEvaluatorsPendingUploadOptionalParams

Paramètres facultatifs.

BetaEvaluatorsUpdateVersionOptionalParams

Paramètres facultatifs.

BetaInsightsGenerateOptionalParams

Paramètres facultatifs.

BetaInsightsGetOptionalParams

Paramètres facultatifs.

BetaInsightsListOptionalParams

Paramètres facultatifs.

BetaInsightsOperations

Interface représentant une opération BetaInsights.

BetaMemoryStoresCreateMemoryOptionalParams

Paramètres facultatifs.

BetaMemoryStoresCreateOptionalParams

Paramètres facultatifs.

BetaMemoryStoresDeleteMemoryOptionalParams

Paramètres facultatifs.

BetaMemoryStoresDeleteOptionalParams

Paramètres facultatifs.

BetaMemoryStoresDeleteScopeOptionalParams

Paramètres facultatifs.

BetaMemoryStoresGetMemoryOptionalParams

Paramètres facultatifs.

BetaMemoryStoresGetOptionalParams

Paramètres facultatifs.

BetaMemoryStoresGetUpdateResultOptionalParams

Paramètres facultatifs.

BetaMemoryStoresListMemoriesOptionalParams

Paramètres facultatifs.

BetaMemoryStoresListOptionalParams

Paramètres facultatifs.

BetaMemoryStoresOperations

Interface représentant une opération BetaMemoryStores.

BetaMemoryStoresSearchMemoriesOptionalParams

Paramètres facultatifs.

BetaMemoryStoresUpdateMemoriesOptionalParams

Paramètres facultatifs.

BetaMemoryStoresUpdateMemoryOptionalParams

Paramètres facultatifs.

BetaMemoryStoresUpdateOptionalParams

Paramètres facultatifs.

BetaModelsCreateOptions

Options pour la méthode de création qui télécharge les fichiers locaux et enregistre une version du modèle.

BetaModelsDeleteOptionalParams

Paramètres facultatifs.

BetaModelsGetCredentialsOptionalParams

Paramètres facultatifs.

BetaModelsGetOptionalParams

Paramètres facultatifs.

BetaModelsListOptionalParams

Paramètres facultatifs.

BetaModelsListVersionsOptionalParams

Paramètres facultatifs.

BetaModelsOperations

Interface représentant les opérations d’un BetaModels.

BetaModelsPendingCreateVersionOptionalParams

Paramètres facultatifs.

BetaModelsPendingUploadOptionalParams

Paramètres facultatifs.

BetaModelsUpdateOptionalParams

Paramètres facultatifs.

BetaOperations

Interface représentant une opération Beta.

BetaRedTeamsCreateOptionalParams

Paramètres facultatifs.

BetaRedTeamsGetOptionalParams

Paramètres facultatifs.

BetaRedTeamsListOptionalParams

Paramètres facultatifs.

BetaRedTeamsOperations

Interface représentant une opération BetaRedTeams.

BetaRoutinesCreateOrUpdateOptionalParams

Paramètres facultatifs.

BetaRoutinesDeleteOptionalParams

Paramètres facultatifs.

BetaRoutinesDisableOptionalParams

Paramètres facultatifs.

BetaRoutinesDispatchOptionalParams

Paramètres facultatifs.

BetaRoutinesEnableOptionalParams

Paramètres facultatifs.

BetaRoutinesGetOptionalParams

Paramètres facultatifs.

BetaRoutinesListOptionalParams

Paramètres facultatifs.

BetaRoutinesListRunsOptionalParams

Paramètres facultatifs.

BetaRoutinesOperations

Interface représentant une opération BetaRoutines.

BetaSchedulesCreateOrUpdateOptionalParams

Paramètres facultatifs.

BetaSchedulesDeleteOptionalParams

Paramètres facultatifs.

BetaSchedulesGetOptionalParams

Paramètres facultatifs.

BetaSchedulesGetRunOptionalParams

Paramètres facultatifs.

BetaSchedulesListOptionalParams

Paramètres facultatifs.

BetaSchedulesListRunsOptionalParams

Paramètres facultatifs.

BetaSchedulesOperations

Interface représentant une opération BetaSchedules.

BetaSkillsCreateOptionalParams

Paramètres facultatifs.

BetaSkillsCreateVersionFromFilesOptionalParams

Paramètres facultatifs.

BetaSkillsDeleteOptionalParams

Paramètres facultatifs.

BetaSkillsDeleteVersionOptionalParams

Paramètres facultatifs.

BetaSkillsDownloadOptionalParams

Paramètres facultatifs.

BetaSkillsDownloadVersionOptionalParams

Paramètres facultatifs.

BetaSkillsGetOptionalParams

Paramètres facultatifs.

BetaSkillsGetVersionOptionalParams

Paramètres facultatifs.

BetaSkillsListOptionalParams

Paramètres facultatifs.

BetaSkillsListVersionsOptionalParams

Paramètres facultatifs.

BetaSkillsOperations

Interface représentant une opération BetaSkills.

BetaSkillsUpdateOptionalParams

Paramètres facultatifs.

BetaVoiceAgentsConversationsDeleteOptionalParams

Paramètres facultatifs.

BetaVoiceAgentsConversationsDownloadAudioItemOptionalParams

Paramètres facultatifs.

BetaVoiceAgentsConversationsDownloadAudioOptionalParams

Paramètres facultatifs.

BetaVoiceAgentsConversationsDownloadGeneratedAudioItemOptionalParams

Paramètres facultatifs.

BetaVoiceAgentsConversationsGetAudioItemOptionalParams

Paramètres facultatifs.

BetaVoiceAgentsConversationsGetAudioOptionalParams

Paramètres facultatifs.

BetaVoiceAgentsConversationsGetGeneratedAudioItemOptionalParams

Paramètres facultatifs.

BetaVoiceAgentsConversationsGetItemOptionalParams

Paramètres facultatifs.

BetaVoiceAgentsConversationsGetOptionalParams

Paramètres facultatifs.

BetaVoiceAgentsConversationsGetResponseOptionalParams

Paramètres facultatifs.

BetaVoiceAgentsConversationsListItemsOptionalParams

Paramètres facultatifs.

BetaVoiceAgentsConversationsListOptionalParams

Paramètres facultatifs.

BetaVoiceAgentsConversationsListResponseItemsOptionalParams

Paramètres facultatifs.

BetaVoiceAgentsConversationsListResponsesOptionalParams

Paramètres facultatifs.

BetaVoiceAgentsConversationsOperations

Opérations pour gérer les conversations des agents vocaux.

BetaVoiceAgentsOperations

Opérations pour la gestion des conversations des agents vocaux et de la téléphonie.

BetaVoiceAgentsTelephonyCancelCallJobOptionalParams

Paramètres facultatifs.

BetaVoiceAgentsTelephonyCreateBindingOptionalParams

Paramètres facultatifs.

BetaVoiceAgentsTelephonyCreateCallJobOptionalParams

Paramètres facultatifs.

BetaVoiceAgentsTelephonyDeleteBindingOptionalParams

Paramètres facultatifs.

BetaVoiceAgentsTelephonyEndCallOptionalParams

Paramètres facultatifs.

BetaVoiceAgentsTelephonyGetBindingOptionalParams

Paramètres facultatifs.

BetaVoiceAgentsTelephonyGetCallJobOptionalParams

Paramètres facultatifs.

BetaVoiceAgentsTelephonyGetCallOptionalParams

Paramètres facultatifs.

BetaVoiceAgentsTelephonyGetTransferTargetsOptionalParams

Paramètres facultatifs.

BetaVoiceAgentsTelephonyListBindingsOptionalParams

Paramètres facultatifs.

BetaVoiceAgentsTelephonyListCallsOptionalParams

Paramètres facultatifs.

BetaVoiceAgentsTelephonyOperations

Opérations pour la gestion de la téléphonie des agents vocaux.

BetaVoiceAgentsTelephonyReplaceTransferTargetsOptionalParams

Paramètres facultatifs.

BetaVoiceAgentsTelephonyTransferCallOptionalParams

Paramètres facultatifs.

BetaVoiceAgentsTelephonyUpdateBindingOptionalParams

Paramètres facultatifs.

BingCustomSearchConfiguration

Configuration de recherche personnalisée bing.

BingCustomSearchPreviewTool

Informations de définition d’entrée pour un outil de recherche personnalisé Bing tel qu’il est utilisé pour configurer un agent.

BingCustomSearchToolParameters

Paramètres de l’outil de recherche personnalisé bing.

BingGroundingSearchConfiguration

Rechercher la configuration de Bing grounding

BingGroundingSearchToolParameters

Paramètres de l’outil de recherche de base bing.

BingGroundingTool

Informations de définition d’entrée pour un outil de recherche de base bing tel qu’il est utilisé pour configurer un agent.

BlobReference

Détails de référence du blob.

BotServiceAuthorizationScheme

interface modèle BotServiceAuthorizationScheme

BotServiceRbacAuthorizationScheme

interface modèle BotServiceRbacAuthorizationScheme

BotServiceTenantAuthorizationScheme

interface modèle BotServiceTenantAuthorizationScheme

BrowserAutomationPreviewTool

Informations de définition d’entrée d’un outil d’automatisation de navigateur, telles qu’elles sont utilisées pour configurer un agent.

BrowserAutomationPreviewToolboxTool

Un outil d’automatisation du navigateur stocké dans une boîte à outils.

BrowserAutomationToolConnectionParameters

Définition des paramètres d’entrée pour la connexion utilisée par l’outil d’automatisation du navigateur.

BrowserAutomationToolParameters

Définition des paramètres d’entrée pour l’outil d’automatisation du navigateur.

CaptureStructuredOutputsTool

Un outil pour capturer des sorties structurées

ChartCoordinate

Coordonnées de la carte d’analyse.

ChatSummaryMemoryItem

Élément de mémoire contenant un résumé extrait des conversations.

ClusterInsightResult

Enseignements tirés de l’analyse des clusters.

ClusterTokenUsage

Utilisation du jeton pour l’analyse de cluster

CodeBasedEvaluatorDefinition

Définition d’un évaluateur basé sur le code python

CodeConfiguration

Configuration de déploiement basée sur le code pour un agent hébergé.

CodeInterpreterTool

Un outil qui exécute du code Python pour aider à générer une réponse à une invite.

CodeInterpreterToolboxTool

Un outil d’interprétation de code stocké dans une boîte à outils.

ComparisonFilter

Filtre utilisé pour comparer une clé d’attribut spécifiée à une valeur donnée à l’aide d’une opération de comparaison définie.

CompoundFilter

Combinez plusieurs filtres à l’aide and ou or.

ComputerTool

Outil qui contrôle un ordinateur virtuel. En savoir plus sur l’outil informatique.

ComputerUsePreviewTool

Outil qui contrôle un ordinateur virtuel. En savoir plus sur l’outil informatique.

Connection

Réponse de la liste et opérations d’obtention des connexions

ConnectionsGetOptionalParams

Paramètres facultatifs.

ConnectionsGetWithCredentialsOptionalParams

Paramètres facultatifs.

ConnectionsListOptionalParams

Paramètres facultatifs.

ConnectionsOperations

Interface représentant une opération de connexions.

ContainerAutoParam

interface modèle ContainerAutoParam

ContainerConfiguration

Configuration de déploiement basée sur un conteneur pour un agent hébergé.

ContainerNetworkPolicyAllowlistParam

interface de modèle ContainerNetworkPolicyAllowlistParam

ContainerNetworkPolicyDisabledParam

interface modèle ContainerNetworkPolicyDisabledParam

ContainerNetworkPolicyDomainSecretParam

interface de modèle ContainerNetworkPolicyDomainSecretParam

ContainerNetworkPolicyParam

Politique d’accès réseau pour le conteneur.

ContainerSkill

interface modèle ContainerSkill

ContinuousEvaluationRuleAction

Action de règle d’évaluation pour l’évaluation continue.

CosmosDBIndex

Définition de l’index CosmosDB Vector Store

CreateAgentVersionFromCodeContent

Corps de requête multi-parties pour mettre à jour ou versionner un agent basé sur le code (POST /agents/{name} et POST /agents/{name}/versions).

CreateAgentVersionFromCodeMetadata

Métadonnées JSON pour les opérations d’agent basées sur le code (créer, mettre à jour, créer version). Le nom de l’agent provient du paramètre de chemin de l’URL ou de l’en-tête x-ms-agent-name , il n’est donc pas inclus dans ce modèle. Le hachage de contenu (SHA-256 du zip) est transporté dans l’en-tête x-ms-code-zip-sha256 .

CreateSkillVersionFromFilesBody

Corps de demande multiparties pour créer une version de compétence à partir de fichiers. Accepte soit un seul fichier zip, soit plusieurs fichiers de compétences individuels (téléchargement de répertoire). Pour les téléchargements zip, le serveur extrait et valide le contenu. Pour les téléchargements de répertoires, les fichiers sont validés as-is.

CreateTeamsPhoneExtensionTelephonyBindingRequest

La demande de création d’un lien d’extension Téléphone Microsoft Teams.

CreateTelephonyBindingRequest

La demande de création d’une liaison téléphonique.

CreateTelephonyCallJobRequest

Une demande pour créer un seul appel sortant direct durable et durable.

CreateTranscriptionResponseJsonUsage

Statistiques d’utilisation du jeton pour la requête.

CreateTwilioTelephonyBindingRequest

La demande de création d’une liaison Twilio.

CronTrigger

Déclencheur basé sur Cron.

CustomCredential

Définition d’informations d’identification personnalisées

CustomGrammarFormatParam

Une grammaire définie par l’utilisateur.

CustomRoutineTrigger

Un déclencheur de routine d’événement personnalisé.

CustomTextFormatParam

Texte libre et sans contraintes.

CustomToolParam

Un outil personnalisé qui traite les entrées en utilisant un format spécifié. En savoir plus sur les outils customes

CustomToolParamFormat

Le format d’entrée de l’outil personnalisé. Par défaut, c’est le texte non contraint.

DailyRecurrenceSchedule

Calendrier de récurrence quotidien.

DataGenerationJob

Ressource pour l’emploi sur la génération de données.

DataGenerationJobInputs

Entrées fournies par l’appelant pour un travail de génération de données.

DataGenerationJobOptions

Options pour gérer les tâches de génération de données.

DataGenerationJobOutput

Fournir des informations pour un travail de génération de données.

DataGenerationJobOutputOptions

Options de sortie pour la génération de données.

DataGenerationJobResult

Résultat produit par un travail réussi de génération de données.

DataGenerationJobSource

Le modèle source de base pour les emplois de génération de données.

DataGenerationModelOptions

Options de modèles LLM pour les emplois de génération de données.

DataGenerationTokenUsage

Informations d’utilisation du token pour un travail de génération de données.

DatasetCredential

Représente une référence à un objet blob pour la consommation

DatasetDataGenerationJobOutput

Sortie de jeu de données pour un travail de génération de données.

DatasetEvaluatorGenerationJobSource

Source de jeu de données pour les emplois de génération d’évaluateurs — référence à un ensemble de données.

DatasetReference

Référence à un jeu de données Foundry versionné.

DatasetVersion

DatasetVersion définition

DatasetsCreateOrUpdateOptionalParams

Paramètres facultatifs.

DatasetsDeleteOptionalParams

Paramètres facultatifs.

DatasetsGetCredentialsOptionalParams

Paramètres facultatifs.

DatasetsGetOptionalParams

Paramètres facultatifs.

DatasetsListOptionalParams

Paramètres facultatifs.

DatasetsListVersionsOptionalParams

Paramètres facultatifs.

DatasetsOperations

Interface représentant une opération de jeux de données.

DatasetsPendingUploadOptionalParams

Paramètres facultatifs.

DeleteAgentResponse

Un objet d’agent supprimé

DeleteAgentVersionResponse

Une version d’agent supprimée Objet

DeleteMemoryResponse

Réponse pour la suppression d’un élément mémoire d’un magasin mémoire.

DeleteMemoryStoreResponse

modèle interface DeleteMemoryStoreResponse

DeleteSkillResponse

Une compétence supprimée.

DeleteSkillVersionResponse

Une version de compétence supprimée.

Deployment

Définition du déploiement du modèle

DeploymentsGetOptionalParams

Paramètres facultatifs.

DeploymentsListOptionalParams

Paramètres facultatifs.

DeploymentsOperations

Interface représentant une opération de déploiement.

Dimension

Une dimension unique — une dimension de qualité indépendante et mesurable au sein du plan de notation d’un évaluateur de grilles d’évaluation.

DispatchRoutineResponse

Les identifiants sont retournés après la mise en file d’attente d’une expédition de routine.

EmbeddingConfiguration

Classe de configuration d’incorporation

EmptyModelParam

interface modèle EmptyModelParam

EndpointBasedEvaluatorDefinition

Définition de l’évaluateur basé sur les points de terminaison. Le client possède et héberge un point de terminaison HTTP qui implémente le contrat d’évaluation. L’évaluateur fait référence à une connexion Project par son nom ; la connexion stocke l’URL et les identifiants du point de terminaison (clé API ou Entra ID). Au moment de l’exécution, le service résout la connexion pour obtenir l’URL du point de terminaison et les détails d’authentification, puis appelle le point de terminaison pour chaque ligne d’évaluation.

EntraAuthorizationScheme

interface modèle EntraAuthorizationScheme

EntraIDCredentials

Entra ID définition des identifiants

ErrorModel

interface modèle ErrorModel

EvalResult

Résultat de l’évaluation.

EvalRunResultCompareItem

Comparaison des paramètres d’un traitement par rapport à la ligne de base.

EvalRunResultComparison

Résultats de comparaison des cycles de traitement par rapport à la ligne de base.

EvalRunResultSummary

Statistiques récapitulatives d’une métrique dans une exécution d’évaluation.

EvaluationComparisonInsightRequest

Demande de comparaison d’évaluation

EvaluationComparisonInsightResult

Aperçu de la comparaison des évaluations.

EvaluationResultSample

Un échantillon du résultat de l’évaluation.

EvaluationRule

Modèle de règle d’évaluation.

EvaluationRuleAction

Modèle d’action d’évaluation.

EvaluationRuleFilter

Modèle de filtre d’évaluation.

EvaluationRulesCreateOrUpdateOptionalParams

Paramètres facultatifs.

EvaluationRulesDeleteOptionalParams

Paramètres facultatifs.

EvaluationRulesGetOptionalParams

Paramètres facultatifs.

EvaluationRulesListOptionalParams

Paramètres facultatifs.

EvaluationRulesOperations

Interface représentant une opération EvaluationRules.

EvaluationRunClusterInsightRequest

Aperçu de l’ensemble des résultats de l’évaluation

EvaluationRunClusterInsightResult

Les informations tirées de l’analyse de cluster d’exécution de l’évaluation.

EvaluationScheduleTask

Tâche d’évaluation de la planification.

EvaluationTarget

Classe de base pour les cibles avec support discriminateur.

EvaluationTaxonomy

Taxonomie d’évaluation Définition

EvaluationTaxonomyInput

Configuration d’entrée pour la taxonomie d’évaluation.

EvaluatorCredentialRequest

Organisme de demande pour obtenir les accréditations d’évaluateur

EvaluatorDefinition

Configuration de l’évaluateur de base avec discriminateur

EvaluatorGenerationArtifacts

Des artefacts de provenance gérés par service produits par un travail de génération évaluateur. Présent uniquement sur les ressources EvaluatorVersion créées via le pipeline de génération. Le jeu de données combiné-JSONL Foundry est en lecture seule et se résout en un jeu de données versionné dans un espace de noms réservé aux services.

EvaluatorGenerationInputs

Entrées fournies par l’appelant pour un travail de génération d’évaluateur.

EvaluatorGenerationJob

Ressource de génération de tâches d’évaluateur — un travail de longue durée qui génère des définitions d’évaluateurs basées sur des grilles d’évaluation à partir des sources de documents. En cas de succès, le résultat est l’EvaluatorVersion persistante.

EvaluatorGenerationJobSource

Le modèle source de base pour les emplois de génération d’évaluateurs. Polymorphe sur type.

EvaluatorGenerationTokenUsage

Résumé de la consommation de jetons pour un travail de génération d’évaluateur. Rempli lorsque le poste atteint un état terminal.

EvaluatorMetric

Mesure de l’évaluateur

EvaluatorVersion

Définition de l’évaluateur

ExternalAgentDefinition

La définition de l’agent externe. Représente un agent tiers hébergé en dehors de Foundry (par exemple, sur GCP ou AWS). L’enregistrement se fait uniquement par métadonnées : Foundry enregistre la définition de l’agent afin d’éclairer les expériences d’observabilité (traces, évaluations) sur les données OpenTelemetry émises par le client.

FabricDataAgentToolParameters

Paramètres de l’outil Agent de données de fabric.

FabricIQPreviewTool

Un outil FabricIQ côté serveur.

FabricIQPreviewToolboxTool

Un outil FabricIQ stocké dans une boîte à outils.

FieldMapping

Classe de configuration de mappage de champ

FileDataGenerationJobOutput

Sortie de fichier Azure OpenAI pour un travail de génération de données.

FileDataGenerationJobSource

Source de fichier pour les tâches de génération de données — entrée de fichiers Azure OpenAI.

FileDatasetVersion

FileDatasetDéfinition de version

FileSearchTool

Outil qui recherche le contenu pertinent à partir de fichiers chargés. En savoir plus sur l’outil de recherche de fichiers.

FileSearchToolboxTool

Un outil de recherche de fichiers stocké dans une boîte à outils.

FixedRatioVersionSelectionRule

Interface de modèle FixedRatioVersionSelectionRule

FolderDatasetVersion

FileDatasetDéfinition de version

FoundryModelWarning

Un avertissement associé à un modèle.

FunctionShellToolParam

Un outil qui permet au modèle d’exécuter des commandes shell.

FunctionShellToolParamEnvironment

Interface modèle FonctionShellToolParamEnvironnement

FunctionShellToolParamEnvironmentContainerReferenceParam

Interface de modèle FonctionShellToolParamEnvironnementConteneurRéférenceParam

FunctionShellToolParamEnvironmentLocalEnvironmentParam

Fonction d’interface de modèle FonctionShellToolParamEnvironnementLocalEnvironnementParam

FunctionTool

Définit une fonction dans votre propre code que le modèle peut choisir d’appeler. En savoir plus sur l’appel de fonction.

FunctionToolParam

interface de modèle FunctionToolParam

GenAITracingOptions

Options pour configurer le traçage GenAI sur une instance spécifique AIProjectClient.

Passez ces données sous la tracingOptions clé AIProjectClientOptionalParams pour activer le traçage GenAI lorsque le client est instancié. Chaque instance client maintient sa propre configuration de traçage indépendante.

GenerateVoiceAgentRequest

Les entrées pour générer un agent vocal. Seulement kind et name sont toujours obligatoires. Le service d’auteur développe ces entrées en un fichier complet et modifiable VoiceAgentDefinition, qui est ensuite créé via POST /agents. Les paramètres générés instructions et audio/voix sont stockés comme des champs séparés dans la définition d’agent obtenue, de sorte que l’appelant peut ensuite les modifier ou les remplacer via le versionnement standard de l’agent.

GetMicrosoft365PackageOptionalParams

Paramètres facultatifs.

GetMicrosoft365PublishDefaultsOptionalParams

Paramètres facultatifs.

GitHubCopilotHarness

(Aperçu) Le harnais géré de GitHub Copilot pour les agents de prompt.

GitHubCopilotToolsetConfig

Une dérogation d’activation pour un outil intégré de GitHub Copilot.

GitHubCopilotToolsetDefaultConfig

Le réglage d’activation par défaut pour les outils intégrés de GitHub Copilot.

GitHubCopilotToolsetPreview

(Aperçu) Paramètres de configuration pour les outils intégrés de GitHub Copilot.

GitHubIssueRoutineTrigger

Un déclencheur de routine de problème sur GitHub.

HeaderTelemetryEndpointAuth

Authentification secrète basée sur l’en-tête pour un point d’extrémité de télémétrie. La valeur secrète résolue est injectée sous forme d’en-tête HTTP.

HostedAgentDefinition

Définition de l’agent hébergé.

HourlyRecurrenceSchedule

Calendrier de récurrence horaire.

HumanEvaluationPreviewRuleAction

Action de règle d’évaluation pour l’évaluation humaine.

HybridSearchOptions

interface de modèle HybridSearchOptions

ImageGenTool

Un outil qui génère des images à partir des modèles d’images GPT.

ImageGenToolInputImageMask

Interface modèle ImageGenOutInputImageMask

IndexesCreateOrUpdateOptionalParams

Paramètres facultatifs.

IndexesDeleteOptionalParams

Paramètres facultatifs.

IndexesGetOptionalParams

Paramètres facultatifs.

IndexesListOptionalParams

Paramètres facultatifs.

IndexesListVersionsOptionalParams

Paramètres facultatifs.

IndexesOperations

Interface représentant une opération d’index.

InlineSkillParam

interface modèle InlineSkillParam

InlineSkillSourceParam

Charge utile de compétences en ligne

Insight

Corps de la réponse pour les informations sur le cluster.

InsightCluster

Un groupe d’échantillons d’analyse.

InsightGenerationRequest

L’organisme de la demande pour générer un insight.

InsightModelConfiguration

Configuration du modèle utilisé dans la génération d’insights.

InsightRequest

La demande du rapport d’analyses.

InsightResult

Le résultat de ces idées.

InsightSample

Un échantillon de l’analyse.

InsightScheduleTask

Tâche d’aperçu pour la planification.

InsightSummary

Résumé de l’analyse du cluster d’erreurs.

InsightsMetadata

Métadonnées sur les informations.

InvocationsProtocolConfiguration

Configuration spécifique au protocole d’invocations.

InvocationsWsProtocolConfiguration

Configuration spécifique au protocole d’invocations basé sur WebSocket.

InvokeAgentInvocationsApiDispatchPayload

Une charge utile manuelle utilisée pour tester l’envoi de routine d’une API d’invocations.

InvokeAgentInvocationsApiRoutineAction

Envoie une routine via l’API d’invocations brute. Exactement un des agent_name ou agent_endpoint_id doivent être fournis.

InvokeAgentResponsesApiDispatchPayload

Une charge utile manuelle utilisée pour tester une routine de dispatch d’API de réponses.

InvokeAgentResponsesApiRoutineAction

Envoie une routine via l’API de réponses. Exactement un des agent_name ou agent_endpoint_id doivent être fournis.

JobOperationState

État d’opération pour une opération de longue durée qui crée une ressource d’emploi.

PERSONNALISATION : AMÉLIORATION SDK : les sondeurs émis se résolvent vers la charge utile terminale result du travail, qui ne porte aucun identifiant ; jobId maintient le travail créé accessible.

LocalShellToolParam

Outil qui permet au modèle d’exécuter des commandes shell dans un environnement local.

LocalSkillParam

interface modèle LocalSkillParam

LogProbProperties

Un objet log-probabilité.

LoraConfig

Métadonnées spécifiques à l’adaptateur pour les modèles LoRA. Des disques servent la configuration moteur au moment du déploiement.

MCPListToolsTool

Outil disponible sur un serveur MCP.

MCPListToolsToolAnnotations

Interface modèle MCPListToolsToolAnnotations

MCPListToolsToolInputSchema

Interface du modèle MCPListToolsToolInputSchema

MCPTool

Donnez au modèle l’accès à des outils supplémentaires via des serveurs MCP (Remote Model Context Protocol). En savoir plus sur MCP.

MCPToolFilter

Un objet filtre pour spécifier quels outils sont autorisés.

MCPToolRequireApproval

interface modèle MCPToolRequireApproval

MCPToolboxTool

Un outil MCP stocké dans une boîte à outils.

ManagedAgentIdentityBlueprintReference

interface de modèle ManagedAgentIdentityBlueprintReference

ManagedAzureAISearchIndex

Définition d’index de Recherche Azure AI managée

McpProtocolConfiguration

Configuration spécifique au protocole MCP.

MemoryItem

Élément de mémoire unique stocké dans la mémoire et contenant du contenu et des métadonnées.

MemoryOperation

Représente une opération de mémoire unique (création, mise à jour ou suppression) effectuée sur un élément de mémoire.

MemorySearchItem

Élément de mémoire récupéré à partir de la recherche de mémoire.

MemorySearchOptions

Options de recherche de mémoire.

MemorySearchPreviewTool

Un outil d’intégration de souvenirs dans l’agent.

MemoryStore

Mémoire qui permet de stocker et de récupérer les mémoires des utilisateurs.

MemoryStoreDefaultDefinition

Implémentation de la mémoire par défaut.

MemoryStoreDefaultOptions

Configurations de stockage de mémoire par défaut.

MemoryStoreDefinition

Définition de base pour les configurations de stockage de mémoire.

MemoryStoreDeleteScopeResponse

Réponse à la suppression de mémoires d’une étendue.

MemoryStoreOperationUsage

Statistiques d’utilisation d’une opération de stockage de mémoire.

MemoryStoreSearchResponse

Réponse de recherche en mémoire.

MemoryStoreUpdateCompletedResult

Résultat de la mise à jour de la mémoire.

MemoryStoreUpdateResponse

Fournit l’état d’une opération de mise à jour de la mémoire précieuse.

Metadata

Ensemble de 16 paires clé-valeur pouvant être attachées à un objet. Cela peut être utile pour stocker des informations supplémentaires sur l’objet dans un format structuré et interroger des objets via l’API ou le tableau de bord. Les clés sont des chaînes dont la longueur maximale est de 64 caractères. Les valeurs sont des chaînes dont la longueur maximale est de 512 caractères.

Microsoft365PermissionScopes

Un ensemble de champs d’autorisation délégués demandés à une seule application de ressource.

Microsoft365PublishDefaults

Valeurs par défaut et précédemment publiées utilisées pour préremplir une demande de publication Microsoft 365 pour un agent Foundry.

Microsoft365PublishResponse

Réponse de la publication d’un agent sur Microsoft 365 / Microsoft Teams.

MicrosoftFabricPreviewTool

Les informations de définition d’entrée pour un outil Microsoft Fabric utilisées pour configurer un agent.

MisalignmentErrorDetailsResource

Les détails d’une action sont bloqués parce qu’elle peut ne pas correspondre à l’intention de l’utilisateur.

MisalignmentSteer

Une instruction publique de continuer après une action est bloquée.

ModelCredentialRequest

Demande d’obtenir des identifiants pour un asset modèle.

ModelDeployment

Définition du déploiement du modèle

ModelDeploymentSku

Informations sur la référence SKU

ModelPendingUploadRequest

Représente une demande de téléchargement en attente d’une version de modèle.

ModelPendingUploadResponse

Représente la réponse à une demande de téléchargement de modèle en attente.

ModelSamplingParams

Représente un ensemble de paramètres utilisés pour contrôler le comportement d’échantillonnage d’un modèle de langage pendant la génération de texte.

ModelSourceData

Informations sources pour le modèle

ModelVersion

Définition de la version du modèle

MonthlyRecurrenceSchedule

Calendrier mensuel de récurrence.

NamespaceToolParam

Groupe une fonction/outils personnalisés sous un espace de noms partagé.

NoAuthenticationCredentials

Informations d’identification qui ne nécessitent pas d’authentification

OneTimeTrigger

Déclencheur unique.

OpenAIClientOptionsWithAzureAgent

Extension des options client OpenAI pour inclure la configuration des terminaux Azure Agent.

OpenApiAnonymousAuthDetails

Détails de sécurité pour l’authentification anonyme OpenApi

OpenApiAuthDetails

détails d’authentification pour OpenApiFunctionDefinition

OpenApiFunctionDefinition

Informations de définition d’entrée pour une fonction openapi.

OpenApiManagedAuthDetails

Détails de sécurité pour l’authentification openApi managed_identity

OpenApiManagedSecurityScheme

Schéma de sécurité pour l’authentification openApi managed_identity

OpenApiProjectConnectionAuthDetails

Détails de sécurité pour l’authentification de connexion openApi project

OpenApiProjectConnectionSecurityScheme

Schéma de sécurité pour l’authentification openApi managed_identity

OpenApiTool

Informations de définition d’entrée pour un outil OpenAPI tel qu’utilisé pour configurer un agent.

OpenApiToolboxTool

Un outil OpenAPI stocké dans une boîte à outils.

OptimizedAgentIdentifier

Identifie l’agent Foundry enregistré à optimiser (demande uniquement). Les compétences, outils et system_prompt sont spécifiés dans options.optimization_config.

OtlpTelemetryEndpoint

Un point d’exportation de télémétrie OTLP (OpenTelemetry Protocol).

PageSettings

Interface qui suit les paramètres de l’itération paginée

PagedAsyncIterableIterator

Interface qui permet une itération itérable asynchrone à la fois à l’achèvement et à la page.

PendingUploadRequest

Représente une demande de téléchargement en attente.

PendingUploadResponse

Représente la réponse à une demande de téléchargement en attente

PickPropertiesVoiceAgentAudioConfig

Le modèle pour choisir des propriétés.

ProceduralMemoryItem

Un élément mémoire contenant une procédure extraite de conversations.

ProgrammaticToolCallingParam

interface de modèle ProgrammaticToolCallingParam

PromotionInfo

Métadonnées de promotion enregistrées lorsqu’un candidat est déployé auprès d’un agent Foundry.

PromptAgentDefinition

Définition de l’agent d’invite

PromptAgentDefinitionTextOptions

Options de configuration d’une réponse texte à partir du modèle. Peut être du texte brut ou des données JSON structurées.

PromptBasedEvaluatorDefinition

Évaluateur basé sur des invites

PromptDataGenerationJobSource

Source de prompt pour les tâches de génération de données — texte en ligne fourni par l’utilisateur.

PromptEvaluatorGenerationJobSource

Source de prompt pour les tâches de génération d’évaluateurs — texte en ligne fourni par l’utilisateur.

ProtocolConfiguration

Configuration par protocole pour le point de terminaison de l’agent.

ProtocolVersionRecord

Mappage d’enregistrements pour un protocole unique et sa version.

PstnTelephonyTransferDestination

Une destination RTPC pour une cible de transfert téléphonique.

PublishToMicrosoft365OptionalParams

Paramètres facultatifs.

RaiConfig

Configuration pour les fonctions de filtrage de contenu et de sécurité RAI (Responsible AI).

RaiInvocationModeration

Déclare où se trouve le texte de demande/réponse afin que les garde-fous de sécurité du contenu puissent l’extraire.

RaiSseTextSelector

Un type d’événement SSE vers le sélecteur de champ de texte pour diffuser la sortie des invocations.

RankingOptions

Interface modèle ClassementOptions

RealtimeAudioFormats

Interface de modèle RealtimeAudioFormats

RealtimeAudioFormatsAudioPcm

interface de modèle Temps réelFormatsAudioPcm

RealtimeAudioFormatsAudioPcma

interface modèle RealtimeAudioFormatsAudioPcma

RealtimeAudioFormatsAudioPcmu

interface modèle RealtimeAudioFormatsAudioPcmu

RealtimeClientEvent

Un événement client en temps réel.

RealtimeClientEventConversationItemCreate

Ajoutez un nouvel élément au contexte de la conversation, incluant les messages, appels de fonction et réponses d’appel de fonction. Cet événement peut être utilisé à la fois pour remplir un « historique » de la conversation et pour ajouter de nouveaux éléments en cours de route, mais il a la limitation actuelle qu’il ne peut pas remplir les messages audio de l’assistant. En cas de succès, le serveur répondra par un conversation.item.created événement, sinon un error événement sera envoyé.

RealtimeClientEventConversationItemDelete

Envoyez cet événement lorsque vous souhaitez supprimer un élément de l’historique des conversations. Le serveur répondra par un conversation.item.deleted événement, sauf si l’élément n’existe pas dans l’historique de la conversation, auquel cas le serveur répondra par une erreur.

RealtimeClientEventConversationItemRetrieve

Envoyez cet événement lorsque vous souhaitez récupérer la représentation d’un élément spécifique dans l’historique de conversation par le serveur. Cela est utile, par exemple, pour inspecter l’audio utilisateur après la réduction du bruit et le VAD. Le serveur répondra par un conversation.item.retrieved événement, sauf si l’élément n’existe pas dans l’historique de la conversation, auquel cas le serveur répondra par une erreur.

RealtimeClientEventConversationItemTruncate

Envoyez cet événement pour tronquer l’audio d’un message d’assistant précédent. Le serveur produira de l’audio plus rapidement que le temps réel, donc cet événement est utile lorsque l’utilisateur interrompt pour tronquer un audio déjà envoyé au client mais pas encore lu. Cela synchronisera la compréhension audio par le serveur avec la lecture du client. Raccourcir l’audio supprime la transcription du texte côté serveur pour s’assurer qu’il n’y a pas de texte dans le contexte qui n’a pas été entendu par l’utilisateur. En cas de succès, le serveur répondra par un conversation.item.truncated événement.

RealtimeClientEventInputAudioBufferAppend

Envoyez cet événement pour ajouter des octets audio au tampon audio d’entrée. La mémoire tampon audio est un stockage temporaire dans lequel vous pouvez écrire et que vous pouvez valider ultérieurement. Un « commit » crée un nouvel élément de message utilisateur dans l’historique des conversations à partir du contenu du tampon et efface le tampon. La transcription audio en entrée (si activée) sera générée lorsque le tampon sera validé. Si le VAD est activé, le tampon audio est utilisé pour détecter la parole et le serveur décide quand il doit valider. Lorsque le VAD serveur est désactivé, vous devez valider manuellement le tampon audio. La réduction du bruit audio d’entrée fonctionne sur les écritures dans la mémoire tampon audio. Le client peut choisir la quantité d’audio à placer dans chaque événement jusqu’à un maximum de 15 Mio ; par exemple, diffuser de plus petits morceaux depuis le client peut permettre au VAD d’être plus réactif. Contrairement à la plupart des autres événements clients, le serveur n’enverra pas de réponse de confirmation à cet événement.

RealtimeClientEventInputAudioBufferClear

Envoyez cet événement pour effacer les octets audio dans le tampon. Le serveur répondra par un input_audio_buffer.cleared événement.

RealtimeClientEventInputAudioBufferCommit

Envoyez cet événement pour valider le tampon audio d’entrée utilisateur, ce qui créera un nouvel élément de message utilisateur dans la conversation. Cet événement produira une erreur si le tampon audio d’entrée est vide. En mode VAD serveur, le client n’a pas besoin d’envoyer cet événement, le serveur valide automatiquement le tampon audio. Valider le tampon audio d’entrée déclenchera la transcription audio d’entrée (si activée dans la configuration de session), mais cela ne créera pas de réponse du modèle. Le serveur répondra par un input_audio_buffer.committed événement.

RealtimeClientEventOutputAudioBufferClear

WebRTC/SIP uniquement : Émettre pour couper la réponse audio actuelle. Cela déclenchera l’arrêt de générer de l’audio par le serveur et émettra un output_audio_buffer.cleared événement. Cet événement doit être précédé d’un response.cancel événement client pour arrêter la génération de la réponse actuelle. En savoir plus.

RealtimeClientEventResponseCancel

Envoyez cet événement pour annuler une réponse en cours. Le serveur répond avec un response.done événement avec l’état response.status=cancelled. S’il n’y a pas de réponse pour annuler, le serveur répondra par une erreur. Il est sûr d’appeler response.cancel même si aucune réponse n’est en cours, une erreur sera renvoyée et la session restera intacte.

RealtimeClientEventResponseCreate

Cet événement demande au serveur de créer une Réponse, ce qui signifie déclencher l’inférence du modèle. En mode VAD serveur, le serveur crée automatiquement des Réponses. Une Réponse comprendra au moins un Item, et peut en avoir deux, auquel cas le second sera un appel de fonction. Ces éléments seront ajoutés par défaut à l’historique des conversations. Le serveur répondra par un response.created événement, des événements pour les objets et le contenu créés, puis enfin un response.done événement indiquant que la réponse est terminée. L’événement response.create inclut la configuration d’inférence comme instructions et tools. Si ces paramètres sont réglés, ils supplanteront la configuration de la session uniquement pour cette Réponse. Les réponses peuvent être créées hors bande de la Conversation par défaut, ce qui signifie qu’elles peuvent avoir une entrée arbitraire, et il est possible de désactiver l’écriture de la sortie dans la Conversation. Une seule Réponse peut écrire dans la Conversation par défaut à la fois, mais sinon plusieurs Réponses peuvent être créées en parallèle. Le metadata champ est un bon moyen de clarifier plusieurs réponses simultanées. Les clients peuvent définir conversation pour none créer une Réponse qui n’écrit pas dans la Conversation par défaut. Une entrée arbitraire peut être fournie avec le input champ, qui est un tableau acceptant des éléments bruts et des références aux éléments existants.

RealtimeConversationItem

Élément unique dans une conversation en temps réel.

RealtimeConversationItemFunctionCall

Un élément d’appel de fonction dans une conversation en temps réel.

RealtimeConversationItemFunctionCallOutput

Un élément de sortie d’appel de fonction dans une conversation en temps réel.

RealtimeConversationItemMessage

interface du modèle RealtimeConversationItemMessage

RealtimeConversationItemMessageAssistant

Un message d’assistant dans une conversation en temps réel.

RealtimeConversationItemMessageAssistantContent

Interface de modèle Temps réelConversationArticleMessageAssistantContenu

RealtimeConversationItemMessageSystem

Un message système dans une conversation en temps réel peut être utilisé pour fournir un contexte ou des instructions supplémentaires au modèle. C’est similaire mais distinct de l’invite d’instructions fournie au début d’une conversation, car des messages système peuvent être ajoutés à tout moment de la conversation. Pour des changements majeurs dans le comportement de la conversation, utilisez des instructions, mais pour les mises à jour plus petites (par exemple « l’utilisateur pose maintenant une question sur un autre sujet »), utilisez les messages système.

RealtimeConversationItemMessageSystemContent

Interface du modèle Temps réelConversationMessageMessageSystèmeContenu

RealtimeConversationItemMessageUser

Un message utilisateur dans une conversation en temps réel.

RealtimeConversationItemMessageUserContent

Interface modèle Temps réelConversationMessageMessageUtilisateurContent

RealtimeFunctionTool

Interface de modèle RealtimeFunctionTool

RealtimeMCPApprovalRequest

Un objet en temps réel demandant l’approbation humaine d’une invocation d’outil.

RealtimeMCPApprovalResponse

Un élément Realtime répondant à une demande d’approbation MCP.

RealtimeMCPError

interface modèle RealtimeMCPError

RealtimeMCPHttpError

interface de modèle RealtimeMCPHttpError

RealtimeMCPListTools

Un outil de listage d’éléments en temps réel disponible sur un serveur MCP.

RealtimeMCPProtocolError

interface de modèle RealtimeMCPProtocolError

RealtimeMCPToolCall

Un élément en temps réel représentant une invocation d’un outil sur un serveur MCP.

RealtimeMCPToolExecutionError

interface de modèle RealtimeMCPToolExecutionError

RealtimeReasoning

Configuration pour des modèles en temps réel capables de raisonner tels que gpt-realtime-2.

RealtimeResponseStatusDetails

interface du modèle Temps réelRéponseStatutDétails

RealtimeResponseStatusDetailsError

interface de modèle Temps réelRéponseStatutDétailsErreur

RealtimeResponseUsage

interface de modèle RealtimeResponseUsage

RealtimeResponseUsageInputTokenDetails

Interface de modèle Temps réelRéponseUtilisationEntréeTokenDétails

RealtimeResponseUsageInputTokenDetailsCachedTokensDetails

interface modèle Temps réelRéponseUtilisationEntréeTokenDétailsCachedJetonsDétails

RealtimeResponseUsageOutputTokenDetails

interface de modèle RealtimeResponseUsageOutputTokenDetails

RealtimeServerEvent

Un événement serveur en temps réel.

RealtimeServerEventConversationItemAdded

Envoyée par le serveur lorsqu’un élément est ajouté à la conversation par défaut. Cela peut se produire dans plusieurs cas :

  • Quand le client envoie un conversation.item.create événement.
  • Lorsque le tampon audio d’entrée est validé. Dans ce cas, l’élément sera un message utilisateur contenant l’audio du tampon.
  • Lorsque le modèle génère une Réponse. Dans ce cas, l’événement conversation.item.added sera envoyé lorsque le modèle commencera à générer un Item spécifique, et donc il n’aura pas encore de contenu (et status sera in_progress). L’événement inclura le contenu complet de l’Élément (sauf lorsque le modèle génère une Réponse), à l’exception des données audio, qui peuvent être récupérées séparément avec un conversation.item.retrieve événement si nécessaire.
RealtimeServerEventConversationItemCreated

Retourné lorsqu’un élément de conversation est créé. Il existe plusieurs scénarios qui produisent cet événement :

  • Le serveur génère une Réponse qui, si elle réussit, produira soit un ou deux Items, qui seront de type message (rôle assistant) ou de type function_call.
  • Le tampon audio d’entrée a été validé, soit par le client, soit par le serveur (en server_vad mode). Le serveur prend le contenu du tampon audio d’entrée et l’ajoute à un nouvel élément de message utilisateur.
  • Le client a envoyé un conversation.item.create événement pour ajouter un nouvel élément à la conversation.
RealtimeServerEventConversationItemDeleted

Retourné lorsqu’un élément de la conversation est supprimé par le client avec un conversation.item.delete événement. Cet événement est utilisé pour synchroniser la compréhension du serveur de l’historique des conversations avec la vue du client.

RealtimeServerEventConversationItemDone

Retourné lorsqu’un sujet de conversation est finalisé. L’événement inclura le contenu complet de l’Item à l’exception des données audio, qui peuvent être récupérées séparément avec un conversation.item.retrieve événement si nécessaire.

RealtimeServerEventConversationItemInputAudioTranscriptionCompleted

Cet événement est la sortie de la transcription audio pour l’audio utilisateur écrite dans le tampon audio utilisateur. La transcription commence lorsque la mémoire tampon audio d’entrée est validée par le client ou le serveur (lorsque VAD est activé). La transcription s’exécute de manière asynchrone avec la création de la Réponse, donc cet événement peut survenir avant ou après les événements de la Réponse. Les modèles API temps réel acceptent l’audio nativement, et la transcription d’entrée est donc un processus distinct exécuté sur un modèle ASR (Automatic Speech Recognition) distinct. La transcription peut diverger quelque peu de l’interprétation du modèle et doit être considérée comme un guide approximatif.

RealtimeServerEventConversationItemInputAudioTranscriptionDelta

Retourné lorsque la valeur textuelle d’une partie de transcription audio d’entrée est mise à jour avec des résultats de transcription incrémentaux.

RealtimeServerEventConversationItemInputAudioTranscriptionFailed

Retournée lorsque la transcription audio en entrée est configurée, et qu’une requête de transcription pour un message utilisateur a échoué. Ces événements sont distincts des autres error événements afin que le client puisse identifier l’Élément associé.

RealtimeServerEventConversationItemInputAudioTranscriptionFailedError

Interface de modèle RealtimeÉvénementConversationItemEntréeAudioTranscriptionFailedError

RealtimeServerEventConversationItemInputAudioTranscriptionSegment

Retourné lorsqu’un segment de transcription audio en entrée est identifié pour un élément.

RealtimeServerEventConversationItemRetrieved

Retourné lorsqu’un élément de conversation est récupéré avec conversation.item.retrieve. Cela est fourni comme moyen d’obtenir la représentation d’un élément par le serveur, par exemple pour accéder aux données audio post-traitées après la suppression de bruit et le VAD. Il inclut l’intégralité du contenu de l’Item, y compris les données audio.

RealtimeServerEventConversationItemTruncated

Retourné lorsqu’un message audio d’assistant antérieur est tronqué par le client avec un conversation.item.truncate événement. Cet événement sert à synchroniser la compréhension audio par le serveur avec la lecture du client. Cette action tronquera l’audio et supprimera la transcription du texte côté serveur pour s’assurer qu’aucun texte dans le contexte n’ait été entendu par l’utilisateur.

RealtimeServerEventError

Retourné lorsqu’une erreur survient, qui peut être un problème client ou serveur. La plupart des erreurs sont réparables et la session restera ouverte, nous recommandons aux implémentateurs de surveiller et d’enregistrer les messages d’erreur par défaut.

RealtimeServerEventErrorError

interface de modèle RealtimeServerEventErrorError

RealtimeServerEventInputAudioBufferCleared

Retourné lorsque le tampon audio d’entrée est effacé par le client avec un input_audio_buffer.clear événement.

RealtimeServerEventInputAudioBufferCommitted

Retourné lorsqu’un tampon audio d’entrée est validé, soit par le client, soit automatiquement en mode VAD serveur. La item_id propriété est l’ID de l’élément de message utilisateur qui sera créé, ainsi un conversation.item.created événement sera également envoyé au client.

RealtimeServerEventInputAudioBufferSpeechStarted

Envoyé par le serveur lorsqu’il est en server_vad mode pour indiquer que la voix a été détectée dans le tampon audio. Cela peut se produire à tout moment où le son est ajouté au tampon (sauf si la parole est déjà détectée). Le client peut vouloir utiliser cet événement pour interrompre la lecture audio ou fournir un retour visuel à l’utilisateur. Le client doit s’attendre à recevoir un input_audio_buffer.speech_stopped événement lorsque la parole cesse. La item_id propriété est l’ID de l’élément du message utilisateur qui sera créé lorsque la parole s’arrête et sera également incluse dans l’événement input_audio_buffer.speech_stopped (sauf si le client commet manuellement le tampon audio lors de l’activation du VAD).

RealtimeServerEventInputAudioBufferSpeechStopped

Revenu en server_vad mode lorsque le serveur détecte la fin de la parole dans le tampon audio. Le serveur envoie également un conversation.item.created événement avec l’élément message utilisateur créé à partir du tampon audio.

RealtimeServerEventInputAudioBufferTimeoutTriggered

Retourné lorsque le délai d’attente du VAD du serveur est déclenché pour le tampon audio d’entrée. Cela est configuré idle_timeout_ms dans les turn_detection paramètres de la session, et cela indique qu’aucune voix n’a été détectée pendant la durée configurée. Les champs audio_start_ms et audio_end_ms indiquent le segment d’audio après la dernière réponse du modèle jusqu’au moment de déclenchement, en tant que décalage par rapport au début de l’audio écrit dans le tampon d'entrée audio. Cela signifie qu’il délimite le segment audio qui était muet et que la différence entre les valeurs de début et de fin correspondra à peu près au délai configuré. L’audio vide sera engagé dans la conversation en tant qu’élément input_audio (il y aura un input_audio_buffer.committed événement) et une réponse modèle sera générée. Il peut y avoir des paroles qui n’ont pas déclenché le VAD mais qui sont tout de même détectées par le modèle, donc le modèle peut répondre par quelque chose de pertinent à la conversation ou une invite à continuer de parler.

RealtimeServerEventMCPListToolsCompleted

Retourné lorsque la mise en vente des outils MCP est terminée pour un article.

RealtimeServerEventMCPListToolsFailed

Un retour lors de la mise en vente des outils MCP a échoué pour un article.

RealtimeServerEventMCPListToolsInProgress

Retourné lors de l'énumération des outils MCP en cours pour un élément.

RealtimeServerEventOutputAudioBufferCleared

WebRTC/SIP uniquement : Émis lorsque le tampon audio de sortie est effacé. Cela se produit soit en mode VAD lorsque l’utilisateur a interrompu input_audio_buffer.speech_started, soit lorsque le client a émis l’événement output_audio_buffer.clear pour couper manuellement la réponse audio actuelle. En savoir plus.

RealtimeServerEventRateLimitsUpdated

Émis au début d’une Réponse pour indiquer les limites de débit mises à jour. Lorsqu’une Réponse est créée, certains jetons sont « réservés » pour les jetons de sortie, les limites de taux indiquées ici reflètent cette réserve, qui est ensuite ajustée en conséquence une fois la Réponse terminée.

RealtimeServerEventRateLimitsUpdatedRateLimits

Interface de modèle RealtimeServerEventRateLimitsUpdatedRateLimits

RealtimeServerEventResponseAudioDelta

Retourné lorsque l’audio généré par le modèle est mis à jour.

RealtimeServerEventResponseAudioDone

Retourné lorsque l’audio généré par le modèle est terminé. Elles sont également émises lorsqu’une Réponse est interrompue, incomplète ou annulée.

RealtimeServerEventResponseAudioTranscriptDelta

Retourné lorsque la transcription générée par modèle de la sortie audio est mise à jour.

RealtimeServerEventResponseAudioTranscriptDone

Retourné lorsque la transcription générée par le modèle de la sortie audio est terminée en streaming. Elles sont également émises lorsqu’une Réponse est interrompue, incomplète ou annulée.

RealtimeServerEventResponseContentPartAdded

Retourné lorsqu’une nouvelle partie de contenu est ajoutée à un élément de message d’assistant lors de la génération de la réponse.

RealtimeServerEventResponseContentPartAddedPart

interface modèle RealtimeServerEventResponseContentPartAddedPart

RealtimeServerEventResponseContentPartDone

Retourné lorsqu’une partie de contenu est terminée de diffuser un message d’assistant. Elles sont également émises lorsqu’une Réponse est interrompue, incomplète ou annulée.

RealtimeServerEventResponseContentPartDonePart

interface modèle RealtimeServerEventResponseContentPartDonePart

RealtimeServerEventResponseCreated

Retourné lorsqu’une nouvelle Réponse est créée. Le premier événement de création de réponse, où la réponse est dans un état initial de in_progress.

RealtimeServerEventResponseDone

Retourné quand une réponse est terminée de streamer. Toujours émis, quel que soit l’état final. L’objet Réponse inclus dans l’événement response.done inclura tous les éléments de sortie de la Réponse mais omettra les données audio brutes. Les clients doivent vérifier le status champ de la Réponse pour déterminer si elle a été réussie (completed) ou s’il y a eu un autre résultat : cancelled, failed, ou incomplete. Une réponse contiendra tous les éléments générés pendant la réponse, à l’exclusion de tout contenu audio.

RealtimeServerEventResponseFunctionCallArgumentsDelta

Retourné lorsque les arguments d’appel de fonction générés par le modèle sont mis à jour.

RealtimeServerEventResponseFunctionCallArgumentsDone

Retourné lorsque les arguments d’appel de fonction générés par le modèle ont fini de streamer. Elles sont également émises lorsqu’une Réponse est interrompue, incomplète ou annulée.

RealtimeServerEventResponseMCPCallArgumentsDelta

Retourné lorsque les arguments d’appel de l’outil MCP sont mis à jour lors de la génération de la réponse.

RealtimeServerEventResponseMCPCallArgumentsDone

Retourné lorsque les arguments d’appel d’outil MCP sont finalisés lors de la génération de la réponse.

RealtimeServerEventResponseMCPCallCompleted

Retourné lorsqu’un appel à l’outil MCP a été terminé avec succès.

RealtimeServerEventResponseMCPCallFailed

Retourné lorsqu’un appel à l’outil MCP a échoué.

RealtimeServerEventResponseMCPCallInProgress

Retourné lorsqu’un appel à l’outil MCP a commencé et est en cours.

RealtimeServerEventResponseOutputItemAdded

Retourné lorsqu’un nouvel objet est créé lors de la génération de la Réponse.

RealtimeServerEventResponseOutputItemDone

Retourné lorsqu’un objet est terminé de streamer. Elles sont également émises lorsqu’une Réponse est interrompue, incomplète ou annulée.

RealtimeServerEventResponseTextDelta

Retourné lorsque la valeur texte d’une partie de contenu « output_text » est mise à jour.

RealtimeServerEventResponseTextDone

Retourné lorsque la valeur texte d’une partie de contenu « output_text » est terminée de streamer. Elles sont également émises lorsqu’une Réponse est interrompue, incomplète ou annulée.

RealtimeServerEventSessionCreated

Retourné lors de la création d’une session. Émis automatiquement lorsqu’une nouvelle connexion est établie comme premier événement serveur. Cet événement contiendra la configuration par défaut de la session.

RealtimeServerEventSessionUpdated

Retourné lorsqu’une session est mise à jour avec un session.update événement, sauf erreur en cas d’erreur.

Reasoning

Uniquement les modèles GPT-5 et O-Series Options de configuration pour les modèles de raisonnement.

RecurrenceSchedule

Modèle de calendrier de récurrence.

RecurrenceTrigger

Déclencheur basé sur la récurrence.

RedTeam

Détails de l’équipe rouge.

RedTeamTargetConfig

Classe abstraite pour la configuration cible.

ReminderPreviewToolboxTool

Un outil de rappel stocké dans une boîte à outils.

ResponseUsageInputTokensDetails

interface modèle ResponseUsageInputTokensDétails

ResponseUsageOutputTokensDetails

interface modèle ResponseUsageOutputTokensDetails

ResponsesProtocolConfiguration

Configuration spécifique au protocole de réponse.

Routine

Une définition de routine renvoyée par le service.

RoutineAction

Modèle de base pour une action de routine.

RoutineAuthorization

Configuration d’autorisation optionnelle pour une répartition de routine.

RoutineDispatchPayload

Modèle de base pour une charge utile de dispatch manuel.

RoutineRun

Une seule exécution de routine était renvoyée depuis l’API de l’historique des exécutions.

RoutineTrigger

Modèle de base pour un déclencheur de routine.

RubricBasedEvaluatorDefinition

Définition de l’évaluateur basée sur une grille d’évaluation — stocke les dimensions produites par l’API Gener. Utilisé à la fois pour les évaluateurs de qualité et de sécurité.

RubricGenerationInputQualityWarning

Un avis non fatal produit lors de la génération de l’évaluateur de grilles lorsque les entrées résolues sont techniquement valides mais probablement trop faibles pour produire une grille d’évaluation de haute qualité. Lecture seule ; généré par service. Persisté avec le terminal EvaluatorGenerationJob.

RunOperationState

État d’opération pour une opération de longue durée qui crée une ressource d’exécution.

PERSONNALISATION : AMÉLIORATION SDK : le poller émis se résout à la charge utile terminale result de la course, qui ne porte aucun identifiant ; runId garde la run créée accessible.

SASTokenCredentials

Définition des informations d’identification SAS (Shared Access Signature)

SasCredential

Définition des informations d’identification SAS

Schedule

Modèle de planification.

ScheduleRoutineTrigger

Un déclencheur récurrent basé sur un cron.

ScheduleRun

Planifier le modèle d’exécution.

ScheduleTask

Planifier le modèle de tâche.

SessionConfiguration

Les paramètres par défaut de session s’appliquent aux sessions créées pour une version d’agent hébergée.

SessionDirectoryEntry

Une seule entrée dans une liste de répertoire.

SessionDirectoryListResponse

Réponse à la liste d’un répertoire dans un bac à sable de session.

SessionFileWriteResponse

Réponse à l’envoi d’un fichier dans un bac à sable de session.

SessionLogEvent

Un seul Server-Sent trame d’événement émis par le flux de journal de session de l’agent hébergé.

Chaque trame contient un event champ identifiant le type d’événement et un data champ transportant la charge utile en texte brut. Bien que la charge utile actuelle data soit formatée en JSON, son schéma n’est pas contractuel — des clés supplémentaires peuvent apparaître et le format peut changer au fil du temps. Les clients doivent traiter data comme une chaîne opaque et essayer éventuellement l’analyse JSON.

De nouveaux types d’événements pourraient être ajoutés à l’avenir. Les clients doivent ignorer avec grâce les types d’événements non reconnus.

Format des fils :

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

Paramètres de l’outil de mise à la terre SharePoint.

SharepointPreviewTool

Informations de définition d’entrée pour un outil SharePoint, comme utilisé pour configurer un agent.

ShellToolboxTool

Un outil coquille rangé dans une boîte à outils. Ce modèle est additif à la configuration de la boîte à outils et ne modifie pas le contrat d’outil OpenAI ni les définitions existantes de la boîte à outils.

SimpleQnADataGenerationJobOptions

Les options pour un travail de génération de données avec le type SimpleQnA.

SimulationSeedDataGenerationJobOptions

Les options pour un travail de génération de données de seed par simulation. À utiliser avec des scénarios d’évaluation multi-tours ainsi qu’avec des sources de prompts, fichiers ou agents. Les lignes de jeux de données générées incluent des champs tels que id, category, test_case_description, et desired_num_turns.

SipTelephonyTransferDestination

Une destination SIP pour une cible de transfert téléphonique.

Skill

Une ressource de compétences.

SkillInlineContent

Contenu en ligne pour définir une compétence simple sans télécharger de fichiers. Suit la agentskills.io SKILL.md spécification.

SkillReference

(Aperçu) Une référence à une compétence version de Foundry.

SkillReferenceParam

interface modèle SkillReferenceParam

SkillVersion

Une version spécifique d’une compétence.

SpecificApplyPatchParam

Force le modèle à appeler l’outil apply_patch lors de l’exécution d’un appel d’outil.

SpecificFunctionShellParam

Force le modèle à appeler l’outil shell lorsqu’un appel d’outil est requis.

SpecificProgrammaticToolCallingParam

interface de modèle SpécifiqueProgramMaOutOutil AppelParam

StructuredInputDefinition

Une entrée structurée qui peut participer aux substitutions de modèles d’invite et à la liaison d’arguments d’outil.

StructuredOutputDefinition

Sortie structurée pouvant être produite par l’agent.

TaskGenerationDataGenerationJobOptions

Options pour la tâche de génération de tâches héritée, y compris le nombre maximal d’échantillons générés.

TaxonomyCategory

Définition de la catégorie de taxonomie.

TaxonomySubCategory

Définition de la sous-catégorie de taxonomie.

TeamsPhoneExtensionTelephonyBinding

Un lien Téléphone Microsoft Teams Extension appartenant à un agent vocal.

TeamsPhoneExtensionTelephonyBindingListItem

Un liaison Téléphone Microsoft Teams Extension est apparu dans une liste, incluant son tag entity.

TeamsTelephonyTransferDestination

Une destination Microsoft Teams pour une cible de transfert téléphonique.

TelemetryConfig

Configuration de télémétrie fournie par le client pour l’exportation de journaux de conteneurs, de traces et de métriques.

TelemetryEndpoint

Une configuration d’exportation télémétrique pour un point de terminaison.

TelemetryEndpointAuth

Configuration d’authentification pour un point de terminaison de télémétrie.

TelemetryOperations

Interface représentant les opérations de télémétrie

TelephonyBinding

Un lien téléphonique appartenant à un agent vocal.

TelephonyBindingListItem

Une liaison téléphonique est renvoyée dans une liste, incluant son tag d’entité.

TelephonyCallJob

Un engagement d’appel sortant direct ou créé par une campagne durable.

TelephonyCallJobCancellation

Une demande d’annulation enregistrée pour un appel sortant.

TelephonyCallJobSchedule

La fenêtre d’exécution optionnelle pour un appel sortant direct.

TelephonyCallLifecycleEvent

Une observation limitée et durable au cours du cycle de vie d’un appel téléphonique.

TelephonyCallRecord

Diagnostic détaillé d’un appel entrant durable à un agent vocal.

TelephonyCallSummary

Un résumé d’un appel entrant durable à un agent vocal.

TelephonyCallTiming

Synchronisation détaillée du fournisseur neutre pour un appel téléphonique entrant.

TelephonyCallTrace

Corrélation d’un enregistrement d’appel téléphonique durable à sa piste Foundry destinée au client.

TelephonyOutboundDestination

La destination d’un appel sortant.

TelephonyOutboundFixedIntervalRetryPolicy

Une politique de réessayage avec un intervalle fixe entre les tentatives d’appel sortant.

TelephonyOutboundRetryPolicy

La politique de retentative pour un seul appel sortant durable. max_attempts inclut la première tentative. Les paramètres spécifiques à la stratégie sont définis par la politique déduite.

TelephonyTransferDestination

Une destination pour une cible de transfert téléphonique.

TelephonyTransferTarget

Une destination nommée vers laquelle l’agent vocal peut transférer un appel.

TelephonyTransferTargets

Les cibles de transfert téléphonique configurées pour un seul agent vocal.

TextResponseFormat

Objet spécifiant le format que le modèle doit générer. La configuration { "type": "json_schema" } active les sorties structurées, ce qui garantit que le modèle correspond à votre schéma JSON fourni. En savoir plus dans le guide des sorties structurées. Le format par défaut n’est { "type": "text" } pas doté d’options supplémentaires. Non recommandé pour gpt-4o et modèles plus récents :* Réglage pour { "type": "json_object" } activer l’ancien mode JSON, qui garantit que le message généré par le modèle est un JSON valide. L’utilisation json_schema est recommandée pour les modèles qui le prennent en charge.

TextResponseFormatConfiguration

Configuration de base pour le format des réponses textuelles générées.

TextResponseFormatConfigurationResponseFormatJsonObject

Configure les réponses générées pour utiliser le format objet JSON.

TextResponseFormatConfigurationResponseFormatText

Configure les réponses générées pour utiliser du texte brut.

TextResponseFormatJsonObject

Format de réponse d’objet JSON. Méthode plus ancienne de génération de réponses JSON. L’utilisation json_schema est recommandée pour les modèles qui le prennent en charge. Notez que le modèle ne générera pas de JSON sans qu'un message système ou utilisateur ne lui demande de le faire.

TextResponseFormatJsonSchema

Format de réponse de schéma JSON. Utilisé pour générer des réponses JSON structurées. En savoir plus sur les sorties structurées.

TextResponseFormatText

Format de réponse par défaut. Utilisé pour générer des réponses de texte.

TimerRoutineTrigger

Un déclencheur de chronologie à un coup unique.

Tool

Outil qui peut être utilisé pour générer une réponse.

ToolChoiceAllowed

Limite les outils disponibles pour le modèle à un ensemble prédéfini.

ToolChoiceCodeInterpreter

Indique que le modèle doit utiliser un outil intégré pour générer une réponse. Learn plus sur les outils intégrés.

ToolChoiceComputer

Indique que le modèle doit utiliser un outil intégré pour générer une réponse. Learn plus sur les outils intégrés.

ToolChoiceComputerUse

Indique que le modèle doit utiliser un outil intégré pour générer une réponse. Learn plus sur les outils intégrés.

ToolChoiceComputerUsePreview

Indique que le modèle doit utiliser un outil intégré pour générer une réponse. Learn plus sur les outils intégrés.

ToolChoiceCustom

Utilisez cette option pour forcer le modèle à appeler un outil personnalisé spécifique.

ToolChoiceFileSearch

Indique que le modèle doit utiliser un outil intégré pour générer une réponse. Learn plus sur les outils intégrés.

ToolChoiceFunction

Utilisez cette option pour forcer le modèle à appeler une fonction spécifique.

ToolChoiceImageGeneration

Indique que le modèle doit utiliser un outil intégré pour générer une réponse. Learn plus sur les outils intégrés.

ToolChoiceMCP

Utilisez cette option pour forcer le modèle à appeler un outil spécifique sur un serveur MCP distant.

ToolChoiceParam

Comment le modèle doit sélectionner l’outil (ou les outils) à utiliser lors de la génération d’une réponse. Consultez le tools paramètre pour savoir comment spécifier les outils que le modèle peut appeler.

ToolChoiceWebSearchPreview

Indique que le modèle doit utiliser un outil intégré pour générer une réponse. Learn plus sur les outils intégrés.

ToolChoiceWebSearchPreview20250311

Indique que le modèle doit utiliser un outil intégré pour générer une réponse. Learn plus sur les outils intégrés.

ToolConfig

Configuration par outil qui contrôle la visibilité des outils et le comportement de recherche.

ToolDescription

Description d’un outil pouvant être utilisé par un agent.

ToolProjectConnection

Ressource de connexion project.

ToolSearchToolParam

Hébergé ou recherche d’outil BYOT pour la configuration des outils différés.

ToolSearchToolboxTool

Un outil de recherche de boîte à outils stocké dans une boîte à outils.

ToolUseFineTuningDataGenerationJobOptions

Les options pour un travail de génération de données avec le type ToolUse. Utilisé uniquement pour l’ajustement fin des scénarios.

ToolboxObject

Une boîte à outils qui stocke des définitions d’outils réutilisables pour les agents.

ToolboxPolicies

Configuration de politiques pour une boîte à outils, incluant la sécurité du contenu et d’autres réglages de gouvernance.

ToolboxSearchPreviewToolboxTool

Un outil de recherche de boîte à outils stocké dans une boîte à outils.

ToolboxShellContainerAutoEnvironment

Un environnement de conteneur provisionné automatiquement pour un outil shell stocké dans une boîte à outils.

ToolboxShellContainerReferenceEnvironment

Un environnement conteneur existant pour un outil shell stocké dans une boîte à outils.

ToolboxShellEnvironment

Un environnement d’exécution pour un outil shell stocké dans une boîte à outils. Ce modèle d’environnement est limité à la configuration de la boîte à outils et ne modifie pas le contrat d’environnement shell OpenAI.

ToolboxShellNetworkPolicy

Politique d’accès réseau pour un conteneur shell de boîte à outils provisionné automatiquement.

ToolboxShellNetworkPolicyDisabled

Une politique réseau qui désactive l’accès sortant depuis un conteneur shell toolbox.

ToolboxSkill

Une source de compétences incluse dans une boîte à outils.

ToolboxSkillReference

Une référence à une compétence existante à inclure dans une boîte à outils.

ToolboxTool

Une représentation abstraite d’un outil stocké dans une boîte à outils.

ToolboxVersionObject

Une version spécifique d’une boîte à outils.

ToolboxVersions

Les versions associées à une boîte à outils.

ToolboxesCreateVersionOptionalParams

Paramètres facultatifs.

ToolboxesDeleteOptionalParams

Paramètres facultatifs.

ToolboxesDeleteVersionOptionalParams

Paramètres facultatifs.

ToolboxesGetOptionalParams

Paramètres facultatifs.

ToolboxesGetVersionOptionalParams

Paramètres facultatifs.

ToolboxesInvokeLatestToolboxMcpOptionalParams

Paramètres facultatifs.

ToolboxesListOptionalParams

Paramètres facultatifs.

ToolboxesListVersionsOptionalParams

Paramètres facultatifs.

ToolboxesOperations

Interface représentant les opérations de la boîte à outils.

ToolboxesUpdateOptionalParams

Paramètres facultatifs.

TracesDataGenerationJobOptions

Les options pour un travail de génération de données avec le type Traces.

TracesDataGenerationJobSource

Source de traces pour les tâches de génération de données — traces de conversation issues d’Application Insights.

TracesEvaluatorGenerationJobSource

Source de traces pour les tâches de génération d’évaluateurs — traces de conversation issues d’Application Insights.

TranscriptTextUsageDuration

Statistiques d’utilisation des modèles facturées par durée d’entrée audio.

TranscriptTextUsageTokens

Statistiques d’utilisation pour les modèles facturés par utilisation de jeton.

TranscriptTextUsageTokensInputTokenDetails

Interface modèle Transcription TextUsageTokensInputTokenDetails

TranscriptionLanguage

Une langue détectée dans l’audio transcrit.

Trigger

Modèle de base pour le déclenchement de la planification.

TwilioTelephonyBinding

Une reliure Twilio appartenant à un agent vocal.

TwilioTelephonyBindingListItem

Un lien Twilio est retourné dans une liste, incluant son tag d’entité.

UpdateModelVersionRequest

Demande au corps de mise à jour d’une version de modèle. Seules les descriptions et les tags peuvent être modifiés.

UpdateTelephonyBindingRequest

La demande de mise à jour d’une liaison téléphonique existante. Chaque propriété est optionnelle et le fournisseur de la liaison est immuable.

UpdateToolboxRequest

interface modèle UpdateToolboxRequest

UserProfileMemoryItem

Élément de mémoire contenant spécifiquement des informations de profil utilisateur extraites des conversations, telles que les préférences, les intérêts et les détails personnels.

VersionIndicator

Indicateur de version déterminant quelle version de l’agent soutient la session.

VersionRefIndicator

Indicateur de version qui fait référence à une version spécifique de l’agent par son nom.

VersionSelectionRule

Interface de modèle VersionSelectionRule

VersionSelector

Interface du modèle Sélecteur de versions

VoiceAgentAnimationConfig

Paramètres d’animation pour une session d’agent vocal.

VoiceAgentAudioConfig

La configuration audio pour un agent vocal. Ces valeurs sont des valeurs par défaut de session et peuvent être écrasées lors de la connexion.

VoiceAgentAudioInputConfig

Entrée de la configuration audio pour un agent vocal.

VoiceAgentAudioOutputConfig

Sortie de la configuration audio pour un agent vocal. Les champs spécifiques au fournisseur sont sélectionnés par voice_type:

  • openai : voice et speed.
  • azure-standard: , , , , , custom_lexicon_url, custom_text_normalization_url, prefer_localesstyle, , pitch, , et volume. voice_temperaturespeedvoice_localevoice
  • azure-custom: tous les azure-standard corps sauf style, plus custom_voice_endpoint_id.
  • azure-personal: tous les azure-standard corps sauf style, plus personal_voice_model.
  • avatar-voice-sync: tous les azure-standard champs sauf voice et style, plus personal_voice_model; le nom de la voix est dérivé de l’avatar.
  • azure-realtime-native : voice et speed. format et output_audio_timestamp_types s’applique à tous les types de voix.
VoiceAgentAvatarConfig

Configuration d’avatar pour un agent vocal. Ces valeurs sont des valeurs par défaut de session et peuvent être écrasées lors de la connexion.

VoiceAgentAvatarIceServer

Un serveur ICE utilisé pour la négociation WebRTC des avatars.

VoiceAgentAvatarScene

Placement de l’avatar et réglages de mouvement.

VoiceAgentAvatarVideoBackground

L’arrière-plan de la vidéo d’avatar.

VoiceAgentAvatarVideoCrop

Le recadrage rectangulaire appliqué à la vidéo avatar.

VoiceAgentAvatarVideoParams

Encodeur vidéo Avatar et paramètres de présentation.

VoiceAgentAvatarVideoResolution

La résolution vidéo de l’avatar.

VoiceAgentAzureSemanticVadEnTurnDetection

Détection d’activité vocale sémantique Azure optimisée en anglais.

VoiceAgentAzureSemanticVadMultilingualTurnDetection

Détection d’activité vocale sémantique Azure multilingue.

VoiceAgentAzureSemanticVadTurnDetection

Détection d’activité vocale sémantique Azure.

VoiceAgentCancelResponseOptions

Options pour annuler une réponse.

VoiceAgentClientEventRtcCallSdpCreate

L’événement rtc.call.sdp.create client : commence la signalisation WebRTC avec une offre SDP.

VoiceAgentClientEventSessionAvatarConnect

L’événement session.avatar.connect client.

VoiceAgentClientEventSessionUpdate

L’événement session.update client.

VoiceAgentCloseResult

Résultat fourni lorsqu’une connexion voix et agent est coupée.

VoiceAgentConnection

Un flux d’agent vocal bidirectionnel et connecté.

Prend en charge exactement une for await itération sur les événements serveur ; une seconde tentative jette. Sortir de la boucle tôt (break, return, ou une erreur non détectée dans le corps de la boucle) ferme la connexion en conséquence. Les types d’événements serveur non reconnus sont livrés sous forme de VoiceAgentUnknownEvent sans interrompre le flux. Les événements malformés échouent toujours à l’itération avec une erreur de protocole.

VoiceAgentDefinition

La définition de l’agent vocal. Sa configuration (modèle, instructions, audio, outils et avatar optionnel) permet une expérience de reconnaissance vocale gérée. Établissez des sessions vocales en temps réel via GET /agents/{agent_name}/endpoint/protocols/voice. Chaque création ou mise à jour produit une nouvelle version immuable.

VoiceAgentEchoCancellation

Paramètres d’annulation d’écho côté serveur pour l’audio d’entrée.

VoiceAgentEndConversationSystemTool

Un contrôle géré par le service qui met fin à la conversation active.

VoiceAgentEndOfUtteranceDetection

Configuration sémantique de détection de fin d’énoncé.

VoiceAgentEventOptions

Options partagées par les opérations qui créent un événement protocolaire au nom de l’appelant.

VoiceAgentFunctionTool

Un outil fonctionnel natif exécuté par le client.

VoiceAgentGreetingConfig

Configuration de salutation de début de session pour un agent vocal.

VoiceAgentInputTranscription

Configuration asynchrone entrée-transcription audio. Étend les options de transcription en temps réel OpenAI avec les modèles de transcription Azure et MAI, des modèles de parole personnalisés et des indices de phrases.

VoiceAgentInterimResponseConfig

Champs partagés par les configurations de réponse intermédiaire.

VoiceAgentLlmGeneratedGreetingConfig

Une salutation rédigée par le modèle de session à partir d’une invite d’ouverture à tour avec portée optique.

VoiceAgentLlmInterimResponseConfig

Une réponse intermédiaire générée par un modèle de langage.

VoiceAgentMcpTool

Un outil MCP disponible pour un agent vocal.

VoiceAgentNoiseReduction

Configuration de réduction du bruit audio en entrée.

VoiceAgentRealtimeClientConnectOptions

Options pour connecter le client en temps réel à un agent vocal.

VoiceAgentRealtimeClientOptions

Options pour le client en temps réel Voice Agents.

VoiceAgentRealtimeResponse

Une réponse en temps réel en direct est renvoyée par le service d’agent vocal dans les deux response.createdresponse.done événements et les événements.

VoiceAgentRealtimeResponseBase

Propriétés partagées par des réponses en temps réel renvoyées par le service d’agent vocal.

VoiceAgentResponseCreateParams

Paramètres acceptés par un événement d’agent response.create vocal.

VoiceAgentResponseOptions

Options pour créer une réponse.

VoiceAgentRtcCallErrorDetails

Détails d’une erreur de signalisation WebRTC.

VoiceAgentSemanticVadTurnDetection

Paramètres sémantiques de détection de virage VAD OpenAI.

VoiceAgentSendItemOptions

Des options partagées par des opérations qui ajoutent un élément de conversation et, par défaut, demandent une réponse.

VoiceAgentSendOptions

Options partagées par les opérations d’envoi en temps réel.

VoiceAgentSendTextOptions

Options pour envoyer des textes.

VoiceAgentSendToolOutputOptions

Options pour retourner un résultat de fonction.

VoiceAgentServerEventResponseAnimationBlendshapesDelta

L’événement response.animation_blendshapes.delta serveur.

VoiceAgentServerEventResponseAnimationBlendshapesDone

L’événement response.animation_blendshapes.done serveur.

VoiceAgentServerEventResponseAnimationVisemeDelta

L’événement response.animation_viseme.delta serveur.

VoiceAgentServerEventResponseAnimationVisemeDone

L’événement response.animation_viseme.done serveur.

VoiceAgentServerEventResponseAudioTimestampDelta

L’événement response.audio_timestamp.delta serveur.

VoiceAgentServerEventResponseAudioTimestampDone

L’événement response.audio_timestamp.done serveur.

VoiceAgentServerEventResponseVideoDelta

L’événement response.video.delta serveur.

VoiceAgentServerEventRtcCallError

L’événement rtc.call.error serveur : une défaillance de signalisation WebRTC.

VoiceAgentServerEventRtcCallSdpCreated

L’événement rtc.call.sdp.created serveur : la réponse SDP qui complète la négociation WebRTC.

VoiceAgentServerEventSessionAvatarConnecting

L’événement session.avatar.connecting serveur.

VoiceAgentServerEventSessionAvatarSwitchToIdle

L’événement session.avatar.switch_to_idle serveur.

VoiceAgentServerEventSessionAvatarSwitchToSpeaking

L’événement session.avatar.switch_to_speaking serveur.

VoiceAgentServerEventSessionSubagentAborted

L’événement session.subagent.aborted serveur.

VoiceAgentServerEventSessionSubagentCompleted

L’événement session.subagent.completed serveur.

VoiceAgentServerEventSessionSubagentStarted

L’événement session.subagent.started serveur.

VoiceAgentServerEventWarning

L’événement warning serveur.

VoiceAgentServerEventWarningDetails

Détails d’un avertissement non fatal.

VoiceAgentServerVadTurnDetection

Détection d’activité vocale côté serveur.

VoiceAgentSessionAvatarConfig

Paramètres d’Avatar acceptés par le contrat stable-voice-agent WebSocket.

VoiceAgentSessionResponseConfig

Les réglages de session en temps réel efficaces et stables sont revenus par le service d’agent vocal.

VoiceAgentSessionUpdateConfig

Les paramètres de session en temps réel stables acceptés dans un session.update événement client.

VoiceAgentSessionUpdateOptions

Options pour mettre à jour la session en direct.

VoiceAgentStaticInterimResponseConfig

Une réponse intermédiaire statique sélectionnée à partir d’un texte configuré.

VoiceAgentSubagent

Un agent de textos Foundry frère et sœur qu’un agent vocal peut consulter en tant que spécialiste des arrière-plans.

VoiceAgentSubagentConfig

Configuration pour les agents textuels frères Foundry que l’agent vocal peut consulter.

VoiceAgentSubagentResponsePolicy

Politique pour fournir des réponses pendant qu’un agent vocal attend un sous-agent.

VoiceAgentSystemTool

Un contrôle géré par le service qui agit sur la session vocale active sans code client ni authentification externe.

VoiceAgentTemplateGreetingConfig

Un salut déterministe rendu avec les entrées structurées de l’agent vocal et synthétisé sans génération créée par le modèle.

VoiceAgentTool

Un outil utilisable par un agent vocal.

VoiceAgentToolboxTool

Une référence à une boîte à outils Foundry, qui est un ensemble versionné d’outils exécuté via son point d’extrémité MCP.

VoiceAgentTranscriptionPhrase

Une phrase transcrite avec des informations de synchronisation.

VoiceAgentTranscriptionWord

Un mot horodaté dans une transcription audio d’entrée.

VoiceAgentTurnDetectionConfig

Configuration de détection de virage pour un agent vocal.

VoiceAgentUnknownEvent

Un événement serveur dont le type de fil n’est pas reconnu par cette version du SDK.

Le SDK délivre ces événements sans fermer la connexion ni appliquer la validation ou la normalisation des événements connus. Inspectez et validez les champs bruts avant de les utiliser.

VoiceAgentWebSocketConnectOptions

Les options ont été transmises à VoiceAgentWebSocketTransport.connect.

VoiceAgentWebSocketFactory

Crée des instances VoiceAgentWebSocketTransport pour VoiceAgentRealtimeClient.

VoiceAgentWebSocketHandlers

Rappels invoqués par un VoiceAgentWebSocketTransport lors d’événements de connexion.

VoiceAgentWebSocketTransport

Un transport WebSocket branchable utilisé par VoiceAgentRealtimeClient. Implémentez cette interface pour personnaliser la manière dont la connexion en temps réel est établie, par exemple pour la faire passer par un relais authentifié.

VoiceAudioItem

Métadonnées pour le segment audio d’un seul élément de conversation. Pour le stockage brang-your-own-storage (BYOS), la réponse inclut blob_uri, un URI de stockage client direct sans jeton SAS, auquel le client accède avec ses propres identifiants. Pour le stockage géré par Foundry, blob_uri est absent et les octets sont diffusés en flux via la route de /audio/content l’élément.

VoiceConversation

Une conversation vocale persistante. L’enveloppe Foundry qui contient la transcription stockée d’un agent vocal, ses réponses, les métriques par tour et l’audio. C’est la frontière parent, de rétention et de suppression : la suppression de la frontière se propage en cascade à ses réponses, éléments, métriques et audio. Lorsque la finalisation échoue, toutes les réponses partielles persistantes, les éléments et l’audio des items restent lisibles.

VoiceConversationEngine

Un moteur qui gère la conversation pour un agent vocal.

VoiceGeneratedAudioItem

Métadonnées pour l’audio généré par un élément de conversation. Pour le stockage brang-your-own-storage (BYOS), la réponse inclut blob_uri, un URI de stockage client direct sans jeton SAS, auquel le client accède avec ses propres identifiants. Pour le stockage géré par Foundry, blob_uri est absent et les octets sont diffusés en flux via la route de /audio/generated/content l’élément.

VoiceHostedAgentConversationEngine

Une référence fermée à l’agent texte hébergé qui gère la conversation pour un agent vocal. L’agent hébergé est résolu au sein du même projet et doit prendre en charge le invocations_ws protocole, la compatibilité Voice Live et le Bridge Protocol 1.0.

VoiceRecording

Métadonnées pour l’enregistrement stéréo fusionné et complet d’une conversation vocale (audio utilisateur sur le canal gauche, audio agent sur le canal droit). Construit une fois à partir des segments par tour après la fin de la session et mis en cache de façon durable. Les métadonnées courantes (format, fréquence d’échantillonnage, canaux, disposition des canaux, durée) sont retournées pour les enregistrements gérés par Foundry et ceux bring-your-own-storage (BYOS). Pour BYOS, la réponse inclut blob_uriégalement , l’URI de l’enregistrement dans le stockage propre du client (pas de jeton SAS), que le client télécharge en utilisant ses propres identifiants de stockage. Pour Foundry, le stockage blob_uri géré par Foundry est absent et les octets sont diffusés via la /audio/content route à la place.

VoiceRecordingChannelLayout

Le rôle attribué à chaque canal d’un enregistrement vocal stéréo fusionné.

VoiceResponse

Une réponse vocale persistante représentant un tour d’inférence de modèle au sein d’une conversation. Dans les résultats de liste, la output projection peut être omise ; récupérer la réponse complète (GET .../responses/{response_id}) ou la route des éléments de réponse paginés (GET .../responses/{response_id}/items) pour ses éléments de sortie. created_at / completed_at sont des extensions de commande durables Foundry.

VoiceResponseAudio

Configuration audio pour une réponse. Suit la forme d’objet OpenAI Realtime GA audio .

VoiceResponseAudioOutput

La projection audio à réponse plate, avec option voice, voice_type, voice_locale, et format champs.

VoiceResponseBase

Propriétés partagées par des réponses vocales persistantes.

WebIQPreviewTool

Un outil WebIQ côté serveur.

WebIQPreviewToolboxTool

Un outil WebIQ stocké dans une boîte à outils.

WebSearchApproximateLocation

L’emplacement approximatif de l’utilisateur.

WebSearchConfiguration

Configuration de recherche web pour bing recherche personnalisée

WebSearchPreviewTool

Cet outil recherche sur le web des résultats pertinents à utiliser dans une réponse. En savoir plus sur l’outil de recherche web.

WebSearchTool

Cherchez sur Internet des sources liées à la consigne. En savoir plus sur l’outil de recherche web.

WebSearchToolFilters

interface de modèle WebSearchToolFilters

WebSearchToolboxTool

Un outil de recherche web stocké dans une boîte à outils.

WeeklyRecurrenceSchedule

Calendrier de récurrence hebdomadaire.

WorkIQPreviewTool

Un outil WorkIQ côté serveur.

WorkIQPreviewToolboxTool

Un outil WorkIQ stocké dans une boîte à outils.

WorkflowAgentDefinition

Définition de l’agent de workflow.

Alias de type

A2AProtocolVersion

Versions prises en charge du protocole A2A.

ActivityProtocolAccessBoundary

Une frontière d’accès pour le protocole d’activité.

AgentBlueprintReferenceType

Type d’AgentBlueprintReferenceType

AgentBlueprintReferenceUnion

Alias pour AgentBlueprintReferenceUnion

AgentDefinitionOptInKeys

Clés d’opt-in pour les opérations de définition d’agent prenant en charge les fonctionnalités de prévisualisation conditionnelle.

AgentDefinitionUnion

Type d’union pour tous les types de définition d’agent. Prend en charge le workflow, l’hébergement, l’application conteneur, les prompts et les agents externes.

AgentEndpoint

Configuration pour le routage, les protocoles et l’autorisation à un point d’accès agent.

AgentEndpointAuthorizationSchemeType

Type d’AgentEndpointAuthorizationSchemeType

AgentEndpointAuthorizationSchemeUnion

Alias for AgentEndpointAuthorizationSchemeUnion

AgentHarnessUnion

Alias pour AgentHarnessUnion

AgentIdentityStatus

Le statut de l’identité d’un agent, applicable à la fois à l’identité de l’instance de l’agent et au blueprint de l’agent.

AgentInsightJsonValue

Une valeur JSON utilisée dans les charges utiles Agent Insights.

AgentInsightOverviewSource

Identifie d’où provient un aperçu d’Agent Insights.

AgentInsightPromptSurface

La surface du prompt a été modifiée par une solution proposée.

AgentInsightProposedFixKind

Le type de solution proposée par un agent Insight, qui peut être rendu par le client.

AgentInsightRunTrigger

Le déclencheur qui a déclenché une run d’insight d’agent.

AgentInsightSeverity

La gravité de l’analyse d’un agent.

AgentInsightStatus

L’état du cycle de vie d’une analyse d’agent.

AgentKind

Définit le type/type d’agent. Détermine la structure de définition d’agent utilisée.

AgentOptimizationDatasetInputType

Valeurs discriminantes pour l’union d’entrée du jeu de données.

AgentOptimizationDatasetInputUnion

Alias for AgentOptimizationDatasetInputUnion

AgentProtocol

Type d’AgentProtocol

AgentSessionStatus

Le statut d’une session d’agent.

AgentState

L’état opérationnel d’un agent.

AgentStateSource

Indique la source de l’état opérationnel d’un agent. Vide lorsque l’état ne provient pas d’une source spécifique.

AgentType

Type d’agent type

AgentVersionStatus

Le statut de provisionnement d’une version agent.

AgentsDownloadAgentCodeResponse

L’archive ZIP téléchargée contenant le code agent hébergé, exposée sous forme de Blob de navigateur ou de Node.js flux lisible.

AgentsDownloadSessionFileResponse

Le fichier de session de l’agent téléchargé, exposé sous forme de blob de navigateur ou Node.js flux lisible.

AgentsPatchAgentObjectOptionalParams

Paramètres facultatifs.

AttackStrategy

Stratégies d’attaques.

AzureAISearchQueryType

Types de requêtes disponibles pour l’outil Recherche Azure AI.

BaseCredentialsUnion

Alias de BaseCredentialsUnion

BetaSkillsDownloadResponse

L’archive ZIP pour la version par défaut d’une compétence, exposée sous forme de Blob de navigateur ou Node.js flux lisible.

BetaVoiceAgentsConversationsDownloadAudioItemResponse

L’audio WAV d’un élément de conversation, exposé sous forme de Blob navigateur ou Node.js flux lisible.

BetaVoiceAgentsConversationsDownloadAudioResponse

L’enregistrement WAV stéréo fusionné d’une conversation vocale, exposé sous forme de Blob de navigateur ou de flux lisible Node.js.

BetaVoiceAgentsConversationsDownloadGeneratedAudioItemResponse

L’audio WAV généré pour un élément de conversation interrompu, exposé sous forme de Blob de navigateur ou de flux lisible Node.js.

CallableToolAllowedCaller

Type d’appelant CallableToolAllowedCalling

CodeDependencyResolution

Comment les dépendances de paquets sont résolues lors du déploiement pour un agent hébergé basé sur le code.

ComparisonFilterValueItems

Alias pour la comparaisonFilterValueItems

ComputerEnvironment

Type d’environnement informatique

ConnectionType

Type (ou catégorie) de la connexion

ContainerMemoryLimit

Type de ContainerMemoryLimit

ContainerNetworkPolicyParamType

Type de ContainerNetworkPolicyParamType

ContainerNetworkPolicyParamUnion

Alias pour ContainerNetworkPolicyParamUnion

ContainerSkillType

Type de ConteneurTypeCompétence

ContainerSkillUnion

Alias pour ContainerSkillUnion

ContinuablePage

Interface qui décrit une page de résultats.

CreateTelephonyBindingRequestUnion

Alias pour CreateTelephonyBindingRequestUnion

CreateTranscriptionResponseJsonUsageType

Type de CreateTranscriptionResponseJsonUsageType

CreateTranscriptionResponseJsonUsageUnion

Alias pour CreateTranscriptionResponseJsonUsageUnion

CredentialType

Type d’informations d’identification utilisé par la connexion

CustomToolParamFormatType

Type de CustomToolParamFormatType

CustomToolParamFormatUnion

Alias pour CustomToolParamFormatUnion

DataGenerationJobOptionsUnion

Alias pour DataGenerationJobOptionsUnion

DataGenerationJobOutputType

Les types de fichiers de sortie pris en charge pour un travail de génération de données.

DataGenerationJobOutputUnion

Alias pour DataGenerationJobOutputUnion

DataGenerationJobOutputWriteMode

Les modes d’écriture pris en charge pour les sorties de tâches de génération de données.

DataGenerationJobScenario

Les scénarios pris en charge pour un travail de génération de données.

DataGenerationJobSourceType

Les types de sources pris en charge pour les tâches de génération de données.

DataGenerationJobSourceUnion

Alias pour DataGenerationJobSourceUnion

DataGenerationJobType

Les types de tâches de génération de données pris en charge.

DatasetType

Énumération pour déterminer le type de données.

DatasetVersionUnion

Alias de DatasetVersionUnion

DayOfWeek

Jours de la semaine pour la planification de la récurrence.

DeploymentType

Type de déploiementType

DeploymentUnion

Alias de DeploymentUnion

DigitalWorkerType

Le type de travailleur du numérique.

DownloadVersionResponse

L’archive ZIP pour une version de compétence spécifiée, exposée sous forme de Blob de navigateur ou de Node.js flux lisible.

EvaluationLevel

Le niveau auquel l’évaluation est réalisée.

EvaluationRuleActionType

Type d’action d’évaluation.

EvaluationRuleActionUnion

Alias de EvaluationRuleActionUnion

EvaluationRuleEventType

Type de l’événement de règle d’évaluation.

EvaluationTargetUnion

Alias pour ÉvaluationUnioncible

EvaluationTaxonomyInputType

Type d’entrée de la taxonomie d’évaluation.

EvaluationTaxonomyInputUnion

Alias pour EvaluationTaxonomyInputUnion

EvaluatorCategory

La catégorie de l’évaluateur

EvaluatorDefinitionType

Définition du type d’évaluateur

EvaluatorDefinitionUnion

Alias de EvaluatorDefinitionUnion

EvaluatorGenerationJobSourceType

Les types de sources pris en charge pour les tâches de génération d’évaluateurs.

EvaluatorGenerationJobSourceUnion

Alias pour EvaluatorGenerationJobSourceUnion

EvaluatorMetricDirection

Direction de la métrique indiquant si une valeur supérieure est meilleure, une valeur inférieure est meilleure ou neutre

EvaluatorMetricType

Le type d’évaluateur

EvaluatorType

Le type d’évaluateur

FileContents

Valeurs valides pour le contenu d’un fichier binaire.

Filters

Alias pour filtres

FoundryFeaturesOptInKeys

Type de FoundryCaractéristiquesOptInKeys

FoundryModelArtifactProfileCategory

La catégorie profil d’artefacts.

FoundryModelArtifactProfileSignal

Signaux détectés dans l’artefact du modèle.

FoundryModelSourceType

Le type source du modèle.

FoundryModelWarningCode

Code d’avertissement pour les artefacts du modèle.

FoundryModelWeightType

Le type de poids du modèle.

FunctionShellToolParamEnvironmentType

Type de FunctionShellToolParamEnvironmentType

FunctionShellToolParamEnvironmentUnion

Alias pour FunctionShellToolParamEnvironmentUnion

GenerateAgentRequest

Les entrées spécifiques à chaque type pour générer et créer un agent.

GenerationWarningType

La catégorie d’un avertissement apparaissait sur une version d’évaluateur générée. Extensible afin que de nouvelles catégories d’avertissement (par exemple, sécurité, qualité de sortie) puissent être introduites sans changement de rupture.

GetMicrosoft365PackageResponse

Le paquet binaire de l’application Microsoft 365 généré pour un agent Foundry.

GitHubCopilotBuiltInTool

Un outil GitHub Copilot configurable par le client.

GitHubIssueEvent

Des événements connus sur GitHub émettent des événements qui peuvent déclencher une routine.

GrammarSyntax

Type de GrammarSyntaxe

ImageGenAction

Type d’ImageGenAction

IndexType

Type d’indexType

IndexUnion

Alias de IndexUnion

InputFidelity

Contrôler l’effort que le modèle exercera pour correspondre au style et aux caractéristiques, en particulier les caractéristiques faciales, des images d’entrée. Ce paramètre n’est pris en charge que pour gpt-image-1 et gpt-image-1.5 et les modèles ultérieurs, non pris en charge pour gpt-image-1-mini. Prend en charge high et low. La valeur par défaut est low.

InsightRequestUnion

Alias de InsightRequestUnion

InsightResultUnion

Alias de InsightResultUnion

InsightSampleUnion

Alias de InsightSampleUnion

InsightType

La demande des insights.

JobPoller

Un sondeur pour une opération de longue date qui crée une ressource d’emploi.

JobStatus

Valeurs de statut extensibles partagées par les emplois de Foundry.

MemoryItemKind

Type d’élément de mémoire.

MemoryItemUnion

Alias de MemoryItemUnion

MemoryOperationKind

Type d’opération de mémoire.

MemoryStoreDefinitionUnion

Alias de MemoryStoreDefinitionUnion

MemoryStoreKind

Type d’implémentation de la mémoire à utiliser.

MemoryStoreType

Type de MemoryStoreType

MemoryStoreUpdateStatus

État d’une opération de mise à jour de la mémoire stockée.

Microsoft365PublishScope

Le périmètre de publication de l’application Microsoft Teams générée.

MisalignmentErrorType

Une classification d’une action qui peut ne pas correspondre à l’intention de l’utilisateur. Des valeurs supplémentaires peuvent être retournées.

NodeReadableStream

Tapez l’alias pour Node.js ReadableStream. Sur les cibles Node, cela se résout au type réel de NodeJS.ReadableStream. Sur les cibles navigateur/react-native, la variante de plateforme se résout à never, ce qui disparaît naturellement des types d’union.

OpenApiAuthDetailsUnion

Alias de OpenApiAuthDetailsUnion

OpenApiAuthType

Type d’authentification pour le point de terminaison OpenApi. Les types autorisés sont :

  • Anonyme (aucune authentification requise)
  • Project Connexion (nécessite project_connection_id pour terminer, tel que configuré dans AI Foundry)
  • Managed_Identity (nécessite un public pour l’authentification basée sur l’identité)
OperationState

Enum décrivant les états de fonctionnement autorisés.

OptimizationAgentIdentifier

Identifie l’agent Foundry enregistré et la version optionnelle à optimiser.

OptimizationCandidate

Les changements de configuration et les résultats agrégés de l’évaluation pour un candidat à l’optimisation des agents.

OptimizationDatasetCriterion

Une instruction d’évaluation nommée utilisée pour noter un item d’optimisation de jeu de données.

OptimizationDatasetInput

La description de base d’un jeu de données en ligne ou enregistré fourni à un poste d’optimisation d’agent.

OptimizationDatasetInputType

Les formes prises en charge pour l’optimisation des données d’entrée : éléments en ligne ou une référence de jeu de données enregistrée.

OptimizationDatasetInputUnion

Un jeu de données d’optimisation fourni sous forme d’éléments en ligne ou une référence à un jeu de données Foundry enregistré.

OptimizationDatasetItem

Un élément d’optimisation en ligne contenant une requête, une réponse attendue et des critères d’évaluation.

OptimizationEvaluatorRef

Une référence à un évaluateur par son nom et une version optionnelle pour un poste d’optimisation d’agent.

OptimizationInlineDatasetInput

Les éléments du jeu de données d’optimisation sont fournis directement dans le corps de la demande.

OptimizationJob

Un poste d’optimisation d’agent qui suit les entrées, les progrès, le statut et les résultats d’évaluation des candidats.

OptimizationJobInputs

L’agent, les jeux de données, les évaluateurs et les options fournis à un projet d’optimisation d’agent.

OptimizationJobListItem

Un résumé d’un travail d’optimisation d’agent rendu par une opération de liste.

OptimizationJobProgress

Un instantané de progression contenant les décomptes de candidats complétés, le meilleur score et le temps d’exécution écoulé.

OptimizationJobResult

Les candidats évalués et identifient la référence et le meilleur candidat issus d’un poste d’optimisation.

OptimizationOptions

Paramètres qui contrôlent la génération de candidats, la sélection des modèles et l’évaluation pour un travail d’optimisation d’agent.

OptimizationReferenceDatasetInput

Une référence à un jeu de données Foundry enregistré par son nom et une version optionnelle pour l’optimisation des agents.

PageOrder

Type d’ordre de page

PendingUploadType

Type de téléchargement en attente.

PublishApprovalStatus

Le statut de la revue de la certification Microsoft Agent du titre de magasin Microsoft 365 publié pour un agent.

RaiInvocationContentType

Comment le corps de demande/réponse d’une invocation est analysé pour localiser le texte afin de la modération de la sécurité du contenu.

RaiInvocationMode

Forme de réponse déclarée par l’auteur pour le protocole d’invocations.

RankerVersionType

Type de RankerVersionType

RealtimeAudioFormatsType

Type de RealtimeAudioFormatsType

RealtimeAudioFormatsUnion

Alias pour RealtimeAudioFormatsUnion

RealtimeClientEventType

Type de RealtimeClientEventType

RealtimeClientEventUnion

Alias pour RealtimeClientEventUnion

RealtimeConversationItemMessageType

Type de RealtimeConversationItemMessageType

RealtimeConversationItemMessageUnion

Alias pour RealtimeConversationItemMessageUnion

RealtimeConversationItemType

Type de RealtimeConversationItemType

RealtimeConversationItemUnion

Alias pour RealtimeConversationItemUnion

RealtimeFunctionToolParameters

interface de modèle Temps réelParamètres de FonctionOutil

RealtimeMCPErrorType

Type de RealtimeMCPErrorType

RealtimeMCPErrorUnion

Alias pour RealtimeMCPErrorUnion

RealtimeReasoningEffort

Contraint l’effort de raisonnement pour des modèles en temps réel capables de raisonner tels que gpt-realtime-2.

RealtimeServerEventType

Type de RealtimeServerEventType

RealtimeServerEventUnion

Alias pour RealtimeServerEventUnion

ReasoningEffort

Limite l’effort sur le raisonnement des modèles de raisonnement. Les valeurs actuellement prises en charge sont none, minimal, low, medium, high, et xhigh. La réduction de l’effort de raisonnement peut entraîner des réponses plus rapides et l’utilisation d’un nombre inférieur de jetons sur le raisonnement dans une réponse.

  • gpt-5.1 par défaut , nonequi n’exécute pas de raisonnement. Les valeurs de raisonnement supportées pour gpt-5.1 sont none, low, medium, et high. Les appels d’outils sont pris en charge pour toutes les valeurs de raisonnement dans gpt-5.1.
  • Tous les modèles précédents gpt-5.1 par défaut utilisent medium l’effort de raisonnement, et ne supportent nonepas .
  • Le gpt-5-pro modèle utilise par défaut (et ne supporte que) high l’effort de raisonnement.
  • xhigh est supporté pour tous les modèles après gpt-5.1-codex-max.
ReasoningModeEnum

Alias pour ReasoningModeEnum

RecurrenceScheduleUnion

Alias de RecurrenceScheduleUnion

RecurrenceType

Type de récurrence.

RedTeamTargetConfigUnion

Alias pour RedTeamTargetConfigUnion

RiskCategory

Catégorie de risque pour l’objectif d’attaque.

RoutineActionType

Les valeurs discriminatrices sont prises en charge pour les actions de routine.

RoutineActionUnion

Alias pour RoutineActionUnion

RoutineAttemptSource

Des chemins sources connus qui peuvent produire une exécution de routine.

RoutineDispatchIdentity

Les identités prises en charge pour l’autorisation de répartition de routine.

RoutineDispatchPayloadType

Les valeurs de discriminateur prises en charge pour les charges utiles de répartition manuelle de routine.

RoutineDispatchPayloadUnion

Alias pour RoutineDispatchPayloadUnion

RoutineRunPhase

Phases de cycle de vie connues enregistrées pour une exécution de routine.

RoutineRunStatus

Le statut d’une course de routine.

RoutineTriggerType

Les valeurs discriminatrices prises en charge pour les déclencheurs de routine.

RoutineTriggerUnion

Alias pour RoutineTriggerUnion

RubricGenerationInputQualityWarningCode

Code d’avertissement stable, consultable et lisible par machine pour un avertissement de qualité d’entrée généré par une grille d’évaluation. Les valeurs sont snake_case; les clients doivent tolérer des identifiants définis par service supplémentaires.

RubricGenerationInputQualityWarningSeverity

Sévérité de l’avis pour un avertissement de qualité des entrées générant une grille d’évaluation. Ensemble initial de valeurs : warning.

RubricGenerationInputQualityWarningSource

Attribution de source d’avertissement pour un avertissement de qualité d’entrée généré par la grille d’évaluation. Les valeurs par source (prompt, agent, dataset) correspondent à la catégorie source visible à l’exécution de génération. aggregate est une valeur synthétique utilisée uniquement pour les avertissements calculés entre des sources résolues avec succès. traces n’est pas exposée car les sources de trace se résolvent en contenu de jeu de données en amont.

RunPoller

Un sondeur pour une opération de longue durée qui crée une ressource de course.

SampleType

Le type d’échantillon utilisé dans l’analyse.

ScheduleProvisioningStatus

Planifier l’état du provisionnement.

ScheduleTaskType

Type de la tâche.

ScheduleTaskUnion

Alias de ScheduleTaskUnion

SearchContentType

Type de rechercheContentType

SearchContextSize

Type de rechercheContextTaille

SessionLogEventType

Types d’événements SSE connus émis par le flux de journal de session de l’agent hébergé. D’autres types d’événements pourraient être introduits dans de futures versions.

SimpleQnAFineTuningQuestionType

Les types de questions pris en charge pour les tâches de génération de données SimpleQnA utilisés pour l’ajustement fin des scénarios.

TelemetryDataKind

Le type de données de télémétrie à exporter.

TelemetryEndpointAuthType

Le type d’authentification pour un point de terminaison de télémétrie.

TelemetryEndpointAuthUnion

Alias pour TelemetryEndpointAuthUnion

TelemetryEndpointKind

Le genre de point d’exportation de télémétrie.

TelemetryEndpointUnion

Alias pour TelemetryEndpointUnion

TelemetryTransportProtocol

Le protocole de transport pour l’exportation de télémétrie.

TelephonyBindingListItemUnion

Alias pour TelephonyBindingListItemUnion

TelephonyBindingStatus

L’état du cycle de vie d’une liaison téléphonique.

TelephonyBindingUnion

Alias pour TelephonyBindingUnion

TelephonyCallDurationBasis

L’horodatage utilisé comme base pour la durée de l’appel.

TelephonyCallEndReason

Des raisons connues générées par un service qui ont empêché un appel téléphonique, plutôt que des raisons d’un appel sortant global. Des codes de chaîne supplémentaires peuvent être retournés.

TelephonyCallJobStatus

Le statut de vie d’un service d’appel sortant durable.

TelephonyCallJobTerminalReason

Raisons terminales connues pour un appel sortant global, qui peut s’étendre sur plusieurs tentatives de fournisseurs. Ces raisons sont distinctes des raisons liées au cycle de vie des appels individuels. Des codes de chaîne supplémentaires peuvent être retournés.

TelephonyCallLifecycleEventName

Un nom d’événement de cycle de vie neutre pour le fournisseur. Les valeurs connues sont stables ; des valeurs supplémentaires peuvent être ajoutées au fil du temps.

TelephonyCallLifecycleEventOutcome

Le résultat d’une observation du cycle de vie téléphonique.

TelephonyCallLifecycleEventReason

Des raisons connues générées par le service pour un événement du cycle de vie téléphonique. Une raison d’événement ne décrit pas nécessairement le résultat final de l’appel. Des codes de chaîne supplémentaires peuvent être retournés.

TelephonyCallLifecycleEventSource

Le composant qui fournissait une observation du cycle de vie téléphonique.

TelephonyCallPhase

La phase neutre du fournisseur atteint par un appel téléphonique entrant.

TelephonyCallStatus

L’état du cycle de vie d’un appel téléphonique entrant.

TelephonyCallTimestampSource

La source d’un horodatage du cycle de vie téléphonique.

TelephonyCallTraceMode

Le mode utilisé pour exposer un appel téléphonique comme une trace Foundry destinée au client.

TelephonyCallTraceStatus

L’état de disponibilité d’une trace d’appel téléphonique destinée au client.

TelephonyOutboundDestinationType

Le type de destination pour un appel sortant.

TelephonyOutboundRetryPolicyType

La stratégie de réessai pour un appel sortant.

TelephonyOutboundRetryPolicyUnion

Alias pour TéléphonieSortantRetryPolicyUnion

TelephonyProvider

Un fournisseur de téléphonie soutenu par une liaison d’agent. Les valeurs connues sont stables ; des valeurs supplémentaires peuvent être ajoutées au fil du temps.

TelephonyTransferDestinationKind

Le genre de destination de transfert téléphonique. Les valeurs connues sont stables ; des valeurs supplémentaires peuvent être ajoutées au fil du temps.

TelephonyTransferDestinationUnion

Alias pour TelephonyTransferDestinationUnion

TextResponseFormatConfigurationType

Type de TextResponseFormatConfigurationType

TextResponseFormatConfigurationUnion

Prise en charge des configurations pour le texte brut et les réponses JSON structurées.

TextResponseFormatUnion

Alias pour TextResponseFormatUnion

ToolChoiceOptions

Contrôle (le cas échéant) l’outil appelé par le modèle. none signifie que le modèle n’appelle pas d’outil et génère plutôt un message. auto signifie que le modèle peut choisir entre générer un message ou appeler un ou plusieurs outils. required signifie que le modèle doit appeler un ou plusieurs outils.

ToolChoiceParamType

Type de ToolChoiceParamType

ToolChoiceParamUnion

Alias pour ToolChoiceParamUnion

ToolSearchExecutionType

Type d’OutilRechercheType d’exécution

ToolType

Type de type d’outil

ToolUnion

Alias pour ToolUnion

ToolboxShellEnvironmentUnion

Alias pour ToolboxShellEnvironmentUnion

ToolboxShellNetworkPolicyUnion

Alias pour ToolboxShellNetworkPolicyUnion

ToolboxSkillUnion

Alias pour ToolboxSkillUnion

ToolboxToolType

Types d’outils pris en charge pour les outils stockés dans une boîte à outils.

ToolboxToolUnion

Alias pour ToolboxToolUnion

ToolboxesInvokeLatestToolboxMcpResponse

La réponse est revenue par le dernier endpoint MCP de la toolbox.

TreatmentEffectType

Type d’effet de traitement.

TriggerType

Type de déclencheur.

TriggerUnion

Alias de TriggerUnion

VersionIndicatorType

Le type d’indicateur de version utilisé pour déterminer la version de l’agent qui soutient une session.

VersionIndicatorUnion

Alias pour VersionIndicatorUnion

VersionSelectionRuleType

Type de VersionSelectionRuleType

VersionSelectionRuleUnion

Alias pour VersionSelectionRuleUnion

VoiceAgentAnimationOutputType

Une animation produite par une session d’agent vocal.

VoiceAgentAudioTimestampType

Un type d’horodatage audio de sortie supporté par un agent vocal.

VoiceAgentAvatarOutputProtocol

Le transport utilisé pour livrer le flux vidéo de l’avatar.

VoiceAgentAvatarType

Le type avatar.

VoiceAgentClientEvent

Un message v1 stable envoyé par un client via un WebSocket à agent vocal.

VoiceAgentConnectionState

Les états de connexion sont rapportés par une connexion en temps réel avec un agent vocal.

VoiceAgentConnectionStateChangedHandler

Appelée lorsqu’une connexion voix change d’état.

VoiceAgentEchoCancellationReferenceSource

La source de référence audio utilisée pour l’annulation d’écho.

VoiceAgentEndOfUtteranceDetectionModel

Le modèle sémantique de détection de fin d’énoncé.

VoiceAgentEndOfUtteranceThresholdLevel

Le seuil de sensibilité pour la détection sémantique de fin d’énoncé.

VoiceAgentGreetingConfigUnion

Alias pour VoiceAgentGreetingConfigUnion

VoiceAgentInputTranscriptionModel

L’identifiant du modèle de transcription audio entrée. C’est un nom de modèle, pas un nom de déploiement Foundry. Reflète les modèles de transcription pris en charge par le backend vocal géré, couvrant les modèles de transcription en temps réel OpenAI ainsi que les modèles Azure et MAI. Des valeurs supplémentaires peuvent être ajoutées au fil du temps.

VoiceAgentInterimResponseConfigUnion

Alias pour VoiceAgentInterimResponseConfigUnion

VoiceAgentInterimResponseTrigger

Une condition qui pourrait déclencher une réponse provisoire.

VoiceAgentMaxOutputTokens

Le nombre maximal de jetons de sortie ou le littéral inf.

VoiceAgentNoiseReductionType

Le mode de réduction du bruit audio en entrée.

VoiceAgentRealtimeErrorCode

Codes d’erreur affichés par le client en temps réel des agents vocaux.

VoiceAgentRealtimeEvent

Un événement reçu d’une connexion en temps réel par agent vocal.

Les événements connus conservent leurs types générés et leur normalisation. Les types de fils non reconnus sont enveloppés dans VoiceAgentUnknownEvent. Activez type sur des événements connus précis, ou excluez type === "unknown" avant de passer un événement à un gestionnaire d’événements connus.

VoiceAgentServerEvent

Un message v1 stable envoyé par le service via un WebSocket à agent vocal.

VoiceAgentSessionIncludeOption

Des champs supplémentaires qu’une session d’agent vocal peut inclure dans les sorties du service.

VoiceAgentSessionResponse

La configuration effective de la session est revenue lors des événements du cycle de vie de la session de l’agent vocal.

VoiceAgentSessionUpdate

La configuration de la session est acceptée par un événement de mise à jour de session par agent vocal.

VoiceAgentSubagentAbortReason

La raison pour laquelle une consultation sur les sous-agents a été interrompue.

VoiceAgentSystemToolName

Une action de contrôle de session vocale gérée par le service. Les valeurs connues sont stables ; des valeurs supplémentaires peuvent être ajoutées au fil du temps.

VoiceAgentSystemToolUnion

Alias pour VoiceAgentSystemToolUnion

VoiceAgentToolChoice

Comportement de sélection d’outils pour un agent vocal.

VoiceAgentToolResponseScheduling

Quand une invocation d’outil crée une réponse de suivi. Des valeurs supplémentaires peuvent être ajoutées au fil du temps.

VoiceAgentToolUnion

Alias pour VoiceAgentToolUnion

VoiceAgentTransport

Le transport utilisé pour une connexion vocale-agent.

VoiceAgentTurnDetectionConfigUnion

Alias pour VoiceAgentTurnDetectionConfigUnion

VoiceAgentTurnDetectionType

La stratégie de détection de virage. Des valeurs supplémentaires peuvent être ajoutées au fil du temps.

VoiceAgentWebSocketMessage

Un message texte JSON échangé via un WebSocket d’agent vocal établi. Les octets audio sont codés en base 64 dans des champs d’événements JSON.

VoiceAgentWebSocketSubprotocol

Le sous-protocole WebSocket est pris en charge par une connexion agent vocal.

VoiceAudioCodec

Un codec audio. Des valeurs supplémentaires peuvent être ajoutées au fil du temps.

VoiceAudioContainerFormat

Un format conteneur audio. Des valeurs supplémentaires peuvent être ajoutées au fil du temps.

VoiceAudioRole

Un rôle de participant voix et audio. Des valeurs supplémentaires peuvent être ajoutées au fil du temps.

VoiceConversationEngineUnion

Alias pour VoiceConversationEngineUnion

VoiceConversationStatus

L’état du cycle de vie d’une conversation vocale persistante :

  • in_progress: la session en direct est active, ou la finalisation de la persistance post-session est en attente.
  • completed: finalisation réussie après une clôture normale ou client, end_conversation, une clôture à durée 1001 maximale, ou une déconnexion client ou réseau que le service peut encore finaliser.
  • failed: une défaillance de service terminal, de pont, de stockage ou de transport irréparable a empêché la finalisation.
VoiceModelType

Comment le modèle qui soutient un agent vocal est servi. Cela est indépendant de l’architecture (temps réel ou en cascade), que le service dérive du modèle sélectionné.

VoiceOutputModality

Une modalité de sortie que l’agent peut produire. animation et avatar sont utilisées lors de la configuration d’un avatar.

VoiceType

L’implémentation vocale. Des valeurs supplémentaires peuvent être ajoutées au fil du temps.

Énumérations

KnownApiVersions

Versions de l’API Microsoft Foundry

Functions

isRestError(unknown)

Typeguard pour RestError

Variables

RestError

Type d’erreur personnalisé pour les demandes de pipeline ayant échoué.

KnownVoiceAgentConnectionState

Valeurs connues de VoiceAgentConnectionState rapportées par une connexion en temps réel entre voix et agent.

Informations relatives à la fonction

isRestError(unknown)

Typeguard pour RestError

function isRestError(e: unknown): e is RestError

Paramètres

e

unknown

Quelque chose d’intercepté par une clause catch.

Retours

e is RestError

Détails de variable

RestError

Type d’erreur personnalisé pour les demandes de pipeline ayant échoué.

RestError: RestErrorConstructor

Type

KnownVoiceAgentConnectionState

Valeurs connues de VoiceAgentConnectionState rapportées par une connexion en temps réel entre voix et agent.

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

Type

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