@azure/ai-projects package

Clases

AIProjectClient

El cliente principal para el AIProjectClient

VoiceAgentAuthenticationError

Se ha generado un error al adquirir un token de acceso Microsoft Entra.

VoiceAgentConnectionError

Un error generado por la conexión WebSocket.

VoiceAgentProtocolError

Se genera un error cuando un mensaje WebSocket no coincide con el protocolo del agente de voz.

VoiceAgentRealtimeClient

Cliente para establecer sesiones en tiempo real con agentes de voz gestionados de Foundry.

VoiceAgentRealtimeError

Error base generado por el cliente en tiempo real de Voice Agents.

Interfaces

@azure/ai-projects.Index
A2APreviewTool

Un agente que implementa el protocolo A2A.

A2APreviewToolboxTool

Una herramienta A2A almacenada en una caja de herramientas.

A2AProtocolConfiguration

Configuración específica del protocolo A2A.

A2ATool

Un agente que implementa el protocolo A2A.

A2AToolboxTool

Una herramienta A2A almacenada en una caja de herramientas.

AIProjectClientOptionalParams

Parámetros opcionales para el cliente.

AISearchIndexResource

Un recurso de AI Search Index.

ActivityProtocolConfiguration

Configuración específica del protocolo de actividad.

Agent

Agente de interfaz de modelo

AgentBlueprintReference

interfaz de modelo AgentBlueprintReference

AgentCard

interfaz de modelo AgentCard

AgentCardSkill

interfaz de modelo AgentCardSkill

AgentClusterInsightRequest

Información sobre el conjunto de resultados de evaluación de agentes

AgentClusterInsightResult

Información del análisis del clúster de agentes.

AgentDataGenerationJobSource

Fuente de agente para trabajos de generación de datos — referencia a un agente para obtener instrucciones y metadatos.

AgentDefinition

Interfaz de definición base para agentes. Contiene el tipo de agente y la configuración RAI opcional.

AgentEndpointAuthorizationScheme

interfaz de modelo AgentEndpointAuthorizationScheme

AgentEndpointConfig

interfaz de modelo AgentEndpointConfig

AgentEvaluatorGenerationJobSource

Fuente de agentes para trabajos de generación de evaluadores — referencia a un agente para obtener instrucciones y metadatos.

AgentHarness

(Vista previa) Un bucle de ejecución y agente gestionado usado para ejecutar un agente de prompt.

AgentIdentity

interfaz de modelo AgentIdentity

AgentInsight

Un problema persistente descubierto a partir de las huellas de un agente.

AgentInsightDetails

Detalles adicionales de información. Omitido a menos que se pidan detalles.

AgentInsightEstimatedCost

Coste estimado de Agent Insights.

AgentInsightHighlightedTrace

Un rastro resaltado que aporta evidencia de una visión de un agente.

AgentInsightJsonObject

Un objeto JSON utilizado en cargas útiles de Agent Insights.

AgentInsightLinkedTrace

Una referencia ligera de rastreo vinculada a la visión de un agente como prueba de apoyo.

AgentInsightMonitor

Un monitor de Insight por agente que posee la configuración, ejecuta y descubre los insights descubiertos.

AgentInsightMonitorCreate

Campos aceptados al crear un monitor de Agent Insights para un agente.

AgentInsightMonitorListItem

Un resumen de monitor de Agent Insights devuelto por operaciones de lista.

AgentInsightMonitorUpdate

Campos que se pueden actualizar en un monitor de Agent Insights.

AgentInsightProposedFix

Una solución recomendada para una visión de agente.

AgentInsightProposedFixChange

Un cambio que el cliente puede renderizar en una solución propuesta.

AgentInsightRecommendedAction

La remediación recomendada para una visión de agente.

AgentInsightRun

Una etapa de larga duración que analiza las trazas de un agente y actualiza sus conocimientos.

AgentInsightRunCreate

Entradas utilizadas al crear una ejecución de insight de agente.

AgentInsightRunResult

Estadísticas de resultados producidas cuando una partida de Agent Insight tiene éxito.

AgentInsightSuspension

Razón estructurada por la que la generación programada está suspendida para un monitor.

AgentInsightTokenUsage

Uso de tokens para una partida de Agent Insights.

AgentInsightUpdate

Campos que pueden actualizarse según la visión de un agente.

AgentInsightsOverview

La visión general eficaz para un monitor de Agent Insights.

AgentInsightsOverviewOverride

Una visión general proporcionada por los usuarios que entra en vigor de inmediato y siembra la siguiente generación.

AgentOptimizationCandidate

Resultado agregado de la evaluación para una configuración de agente candidato único en todas las tareas.

AgentOptimizationDatasetCriterion

Criterio de evaluación: un par nombre + instrucción utilizado para la puntuación por ítem.

AgentOptimizationDatasetInput

Modelo base discriminado para la entrada de conjuntos de datos. Ya sea con elementos en línea o con una referencia registrada.

AgentOptimizationDatasetItem

Un solo elemento en un conjunto de datos en línea.

AgentOptimizationEvaluatorRef

Referencia a un evaluador nombrado, opcionalmente fijado a una versión.

AgentOptimizationInlineDatasetInput

Conjunto de datos en línea — elementos suministrados directamente en el cuerpo de la solicitud.

AgentOptimizationJob

Recurso de trabajo de optimización de agentes: un trabajo de larga duración que optimiza la configuración de un agente (instrucciones, modelo, habilidades, herramientas) para maximizar las puntuaciones de evaluación. En caso de éxito, el resultado contiene candidatos puntuados.

AgentOptimizationJobInputs

Entradas suministradas por el llamador para un trabajo de optimización.

AgentOptimizationJobListItem

Representación de trabajo limitada devuelta por el endpoint LIST.

AgentOptimizationJobProgress

Progreso en vuelo; Solo se llena mientras el estado está en cola o in_progress.

AgentOptimizationJobResult

Órgano de resultado en estado terminal. Se pobla cuando el estado es exitoso o fallado.

AgentOptimizationOptions

Ajuste de perillas y modo de ejecución para un trabajo de optimización.

AgentOptimizationReferenceDatasetInput

Referencia a un conjunto de datos registrado de Foundry.

AgentSessionResource

Una sesión de agente que proporciona un sandbox de cómputo de larga duración para invocaciones de agentes alojados.

AgentTaxonomyInput

Configuración de entrada para la taxonomía de evaluación cuando el tipo de entrada es agente.

AgentVersion

Representa una versión específica de un agente. Incluye metadatos, control de versiones, tiempo de creación y definición del agente.

AgenticIdentityPreviewCredentials

Definición de credenciales de identidad agencial

AgentsCreateAgentFromManifestOptionalParams

Parámetros opcionales.

AgentsCreateAgentVersionFromManifestOptionalParams

Parámetros opcionales.

AgentsCreateOptionalParams

Parámetros opcionales.

AgentsCreateSessionOptionalParams

Parámetros opcionales.

AgentsCreateTelephonyBindingOptionalParams

Parámetros opcionales.

AgentsCreateVersionFromCodeOptionalParams

Parámetros opcionales.

AgentsCreateVersionOptionalParams

Parámetros opcionales.

AgentsDeleteOptionalParams

Parámetros opcionales.

AgentsDeleteSessionFileOptionalParams

Parámetros opcionales.

AgentsDeleteSessionOptionalParams

Parámetros opcionales.

AgentsDeleteTelephonyBindingOptionalParams

Parámetros opcionales.

AgentsDeleteVersionOptionalParams

Parámetros opcionales.

AgentsDisableOptionalParams

Parámetros opcionales.

AgentsDownloadAgentCodeOptionalParams

Parámetros opcionales.

AgentsDownloadSessionFileOptionalParams

Parámetros opcionales.

AgentsEnableOptionalParams

Parámetros opcionales.

AgentsGetOptionalParams

Parámetros opcionales.

AgentsGetSessionLogStreamOptionalParams

Parámetros opcionales.

AgentsGetSessionOptionalParams

Parámetros opcionales.

AgentsGetTelephonyBindingOptionalParams

Parámetros opcionales.

AgentsGetVersionOptionalParams

Parámetros opcionales.

AgentsListOptionalParams

Parámetros opcionales.

AgentsListSessionFilesOptionalParams

Parámetros opcionales.

AgentsListSessionsOptionalParams

Parámetros opcionales.

AgentsListTelephonyBindingsOptionalParams

Parámetros opcionales.

AgentsListTelephonyCallsOptionalParams

Parámetros opcionales.

AgentsListVersionsOptionalParams

Parámetros opcionales.

AgentsOperations

Interfaz que representa las operaciones de los agentes.

AgentsStopSessionOptionalParams

Parámetros opcionales.

AgentsUpdateAgentFromManifestOptionalParams

Parámetros opcionales.

AgentsUpdateAgentObjectOptionalParams

Parámetros opcionales.

AgentsUpdateOptionalParams

Parámetros opcionales.

AgentsUpdateTelephonyBindingOptionalParams

Parámetros opcionales.

AgentsUploadSessionFileOptionalParams

Parámetros opcionales.

ApiErrorResponse

Respuesta de error para errores de API.

ApiKeyCredentials

Definición de credenciales de clave de API

ApplyPatchToolParam

Permite al asistente crear, eliminar o actualizar archivos usando diferenciales unificados.

ApproximateLocation

interfaz del modelo AproximadamenteUbicación

ArtifactProfile

Perfil de artefacto del modelo

AutoCodeInterpreterToolParam

Configuración de un contenedor de intérpretes de código. Opcionalmente, especifique los identificadores de los archivos en los que ejecutar el código.

AzureAIAgentTarget

Representa un objetivo que especifica un agente de IA de Azure.

AzureAIModelTarget

Representa un objetivo que especifica un modelo de IA de Azure para operaciones que requieren selección de modelo.

AzureAISearchIndex

definición de índice de Búsqueda de Azure AI

AzureAISearchTool

La información de definición de entrada para una herramienta de búsqueda de IA de Azure utilizada para configurar un agente.

AzureAISearchToolResource

Conjunto de recursos de índice utilizados por la herramienta azure_ai_search.

AzureAISearchToolboxTool

Una herramienta de Búsqueda de Azure AI almacenada en una caja de herramientas.

AzureAgentConfig

Opciones de configuración para el endpoint del agente del método getOpenAIClient. Principalmente usado para agentes alojados.

AzureFunctionBinding

Estructura para mantener storage nombre y URI de la cola.

AzureFunctionDefinition

La definición de función Azure.

AzureFunctionStorageQueue

Estructura para mantener storage nombre y URI de la cola.

AzureFunctionTool

La información de definición de entrada para una Herramienta de Función de Azure, tal como se usa para configurar un Agente.

AzureOpenAIModelConfiguration

Azure configuración del modelo openAI. El servicio seleccionaría la versión de la API para consultar el modelo.

BaseCredentials

Una clase base para las credenciales de conexión

BetaAgentInsightMonitorsCancelRunOptionalParams

Parámetros opcionales.

BetaAgentInsightMonitorsCreateOptionalParams

Parámetros opcionales.

BetaAgentInsightMonitorsCreateRunOptionalParams

Parámetros opcionales.

BetaAgentInsightMonitorsDeleteOptionalParams

Parámetros opcionales.

BetaAgentInsightMonitorsGetInsightOptionalParams

Parámetros opcionales.

BetaAgentInsightMonitorsGetOptionalParams

Parámetros opcionales.

BetaAgentInsightMonitorsGetRunOptionalParams

Parámetros opcionales.

BetaAgentInsightMonitorsListInsightsOptionalParams

Parámetros opcionales.

BetaAgentInsightMonitorsListOptionalParams

Parámetros opcionales.

BetaAgentInsightMonitorsListRunsOptionalParams

Parámetros opcionales.

BetaAgentInsightMonitorsOperations

Interfaz que representa una operación de BetaAgentInsightMonitors.

BetaAgentInsightMonitorsResetOptionalParams

Parámetros opcionales.

BetaAgentInsightMonitorsUpdateInsightOptionalParams

Parámetros opcionales.

BetaAgentInsightMonitorsUpdateOptionalParams

Parámetros opcionales.

BetaAgentsCancelOptimizationJobOptionalParams

Parámetros opcionales.

BetaAgentsCreateFromPromptOptionalParams

Parámetros opcionales.

BetaAgentsCreateOptimizationJobOptionalParams

Parámetros opcionales.

BetaAgentsDeleteOptimizationJobOptionalParams

Parámetros opcionales.

BetaAgentsGetOptimizationJobOptionalParams

Parámetros opcionales.

BetaAgentsListOptimizationJobsOptionalParams

Parámetros opcionales.

BetaAgentsOperations

Operaciones para agentes gestores.

BetaDatasetsCancelGenerationJobOptionalParams

Parámetros opcionales.

BetaDatasetsCreateGenerationJobOptionalParams

Parámetros opcionales.

BetaDatasetsDeleteGenerationJobOptionalParams

Parámetros opcionales.

BetaDatasetsGetGenerationJobOptionalParams

Parámetros opcionales.

BetaDatasetsListGenerationJobsOptionalParams

Parámetros opcionales.

BetaDatasetsOperations

Interfaz que representa las operaciones de un BetaDatasets.

BetaEvaluationTaxonomiesCreateOptionalParams

Parámetros opcionales.

BetaEvaluationTaxonomiesDeleteOptionalParams

Parámetros opcionales.

BetaEvaluationTaxonomiesGetOptionalParams

Parámetros opcionales.

BetaEvaluationTaxonomiesListOptionalParams

Parámetros opcionales.

BetaEvaluationTaxonomiesOperations

Interfaz que representa una operación de BetaEvaluationTaxonomies.

BetaEvaluationTaxonomiesUpdateOptionalParams

Parámetros opcionales.

BetaEvaluatorsCancelGenerationJobOptionalParams

Parámetros opcionales.

BetaEvaluatorsCreateGenerationJobOptionalParams

Parámetros opcionales.

BetaEvaluatorsCreateVersionOptionalParams

Parámetros opcionales.

BetaEvaluatorsDeleteGenerationJobOptionalParams

Parámetros opcionales.

BetaEvaluatorsDeleteVersionOptionalParams

Parámetros opcionales.

BetaEvaluatorsGetCredentialsOptionalParams

Parámetros opcionales.

BetaEvaluatorsGetGenerationJobOptionalParams

Parámetros opcionales.

BetaEvaluatorsGetVersionOptionalParams

Parámetros opcionales.

BetaEvaluatorsListGenerationJobsOptionalParams

Parámetros opcionales.

BetaEvaluatorsListOptionalParams

Parámetros opcionales.

BetaEvaluatorsListVersionsOptionalParams

Parámetros opcionales.

BetaEvaluatorsOperations

Interfaz que representa las operaciones de un BetaEvaluators.

BetaEvaluatorsPendingUploadOptionalParams

Parámetros opcionales.

BetaEvaluatorsUpdateVersionOptionalParams

Parámetros opcionales.

BetaInsightsGenerateOptionalParams

Parámetros opcionales.

BetaInsightsGetOptionalParams

Parámetros opcionales.

BetaInsightsListOptionalParams

Parámetros opcionales.

BetaInsightsOperations

Interfaz que representa una operación de BetaInsights.

BetaMemoryStoresCreateMemoryOptionalParams

Parámetros opcionales.

BetaMemoryStoresCreateOptionalParams

Parámetros opcionales.

BetaMemoryStoresDeleteMemoryOptionalParams

Parámetros opcionales.

BetaMemoryStoresDeleteOptionalParams

Parámetros opcionales.

BetaMemoryStoresDeleteScopeOptionalParams

Parámetros opcionales.

BetaMemoryStoresGetMemoryOptionalParams

Parámetros opcionales.

BetaMemoryStoresGetOptionalParams

Parámetros opcionales.

BetaMemoryStoresGetUpdateResultOptionalParams

Parámetros opcionales.

BetaMemoryStoresListMemoriesOptionalParams

Parámetros opcionales.

BetaMemoryStoresListOptionalParams

Parámetros opcionales.

BetaMemoryStoresOperations

Interfaz que representa una operación de BetaMemoryStores.

BetaMemoryStoresSearchMemoriesOptionalParams

Parámetros opcionales.

BetaMemoryStoresUpdateMemoriesOptionalParams

Parámetros opcionales.

BetaMemoryStoresUpdateMemoryOptionalParams

Parámetros opcionales.

BetaMemoryStoresUpdateOptionalParams

Parámetros opcionales.

BetaModelsCreateOptions

Opciones para el método de creación que sube archivos locales y registra una versión del modelo.

BetaModelsDeleteOptionalParams

Parámetros opcionales.

BetaModelsGetCredentialsOptionalParams

Parámetros opcionales.

BetaModelsGetOptionalParams

Parámetros opcionales.

BetaModelsListOptionalParams

Parámetros opcionales.

BetaModelsListVersionsOptionalParams

Parámetros opcionales.

BetaModelsOperations

Interfaz que representa una operación de BetaModels.

BetaModelsPendingCreateVersionOptionalParams

Parámetros opcionales.

BetaModelsPendingUploadOptionalParams

Parámetros opcionales.

BetaModelsUpdateOptionalParams

Parámetros opcionales.

BetaOperations

Interfaz que representa una operación Beta.

BetaRedTeamsCreateOptionalParams

Parámetros opcionales.

BetaRedTeamsGetOptionalParams

Parámetros opcionales.

BetaRedTeamsListOptionalParams

Parámetros opcionales.

BetaRedTeamsOperations

Interfaz que representa una operación de BetaRedTeams.

BetaRoutinesCreateOrUpdateOptionalParams

Parámetros opcionales.

BetaRoutinesDeleteOptionalParams

Parámetros opcionales.

BetaRoutinesDisableOptionalParams

Parámetros opcionales.

BetaRoutinesDispatchOptionalParams

Parámetros opcionales.

BetaRoutinesEnableOptionalParams

Parámetros opcionales.

BetaRoutinesGetOptionalParams

Parámetros opcionales.

BetaRoutinesListOptionalParams

Parámetros opcionales.

BetaRoutinesListRunsOptionalParams

Parámetros opcionales.

BetaRoutinesOperations

Interfaz que representa una operación de BetaRoutines.

BetaSchedulesCreateOrUpdateOptionalParams

Parámetros opcionales.

BetaSchedulesDeleteOptionalParams

Parámetros opcionales.

BetaSchedulesGetOptionalParams

Parámetros opcionales.

BetaSchedulesGetRunOptionalParams

Parámetros opcionales.

BetaSchedulesListOptionalParams

Parámetros opcionales.

BetaSchedulesListRunsOptionalParams

Parámetros opcionales.

BetaSchedulesOperations

Interfaz que representa una operación de BetaSchedules.

BetaSkillsCreateOptionalParams

Parámetros opcionales.

BetaSkillsCreateVersionFromFilesOptionalParams

Parámetros opcionales.

BetaSkillsDeleteOptionalParams

Parámetros opcionales.

BetaSkillsDeleteVersionOptionalParams

Parámetros opcionales.

BetaSkillsDownloadOptionalParams

Parámetros opcionales.

BetaSkillsDownloadVersionOptionalParams

Parámetros opcionales.

BetaSkillsGetOptionalParams

Parámetros opcionales.

BetaSkillsGetVersionOptionalParams

Parámetros opcionales.

BetaSkillsListOptionalParams

Parámetros opcionales.

BetaSkillsListVersionsOptionalParams

Parámetros opcionales.

BetaSkillsOperations

Interfaz que representa una operación de BetaSkills.

BetaSkillsUpdateOptionalParams

Parámetros opcionales.

BetaVoiceAgentsConversationsDeleteOptionalParams

Parámetros opcionales.

BetaVoiceAgentsConversationsDownloadAudioItemOptionalParams

Parámetros opcionales.

BetaVoiceAgentsConversationsDownloadAudioOptionalParams

Parámetros opcionales.

BetaVoiceAgentsConversationsDownloadGeneratedAudioItemOptionalParams

Parámetros opcionales.

BetaVoiceAgentsConversationsGetAudioItemOptionalParams

Parámetros opcionales.

BetaVoiceAgentsConversationsGetAudioOptionalParams

Parámetros opcionales.

BetaVoiceAgentsConversationsGetGeneratedAudioItemOptionalParams

Parámetros opcionales.

BetaVoiceAgentsConversationsGetItemOptionalParams

Parámetros opcionales.

BetaVoiceAgentsConversationsGetOptionalParams

Parámetros opcionales.

BetaVoiceAgentsConversationsGetResponseOptionalParams

Parámetros opcionales.

BetaVoiceAgentsConversationsListItemsOptionalParams

Parámetros opcionales.

BetaVoiceAgentsConversationsListOptionalParams

Parámetros opcionales.

BetaVoiceAgentsConversationsListResponseItemsOptionalParams

Parámetros opcionales.

BetaVoiceAgentsConversationsListResponsesOptionalParams

Parámetros opcionales.

BetaVoiceAgentsConversationsOperations

Operaciones para gestionar conversaciones de agentes de voz.

BetaVoiceAgentsOperations

Operaciones para gestionar conversaciones de agentes de voz y telefonía.

BetaVoiceAgentsTelephonyCancelCallJobOptionalParams

Parámetros opcionales.

BetaVoiceAgentsTelephonyCreateBindingOptionalParams

Parámetros opcionales.

BetaVoiceAgentsTelephonyCreateCallJobOptionalParams

Parámetros opcionales.

BetaVoiceAgentsTelephonyDeleteBindingOptionalParams

Parámetros opcionales.

BetaVoiceAgentsTelephonyEndCallOptionalParams

Parámetros opcionales.

BetaVoiceAgentsTelephonyGetBindingOptionalParams

Parámetros opcionales.

BetaVoiceAgentsTelephonyGetCallJobOptionalParams

Parámetros opcionales.

BetaVoiceAgentsTelephonyGetCallOptionalParams

Parámetros opcionales.

BetaVoiceAgentsTelephonyGetTransferTargetsOptionalParams

Parámetros opcionales.

BetaVoiceAgentsTelephonyListBindingsOptionalParams

Parámetros opcionales.

BetaVoiceAgentsTelephonyListCallsOptionalParams

Parámetros opcionales.

BetaVoiceAgentsTelephonyOperations

Operaciones para gestionar la telefonía de agentes de voz.

BetaVoiceAgentsTelephonyReplaceTransferTargetsOptionalParams

Parámetros opcionales.

BetaVoiceAgentsTelephonyTransferCallOptionalParams

Parámetros opcionales.

BetaVoiceAgentsTelephonyUpdateBindingOptionalParams

Parámetros opcionales.

BingCustomSearchConfiguration

Una bing configuración de búsqueda personalizada.

BingCustomSearchPreviewTool

La información de definición de entrada de un Bing herramienta de búsqueda personalizada como se usa para configurar un agente.

BingCustomSearchToolParameters

El bing parámetros de la herramienta de búsqueda personalizada.

BingGroundingSearchConfiguration

Configuración de búsqueda para Bing grounding

BingGroundingSearchToolParameters

Parámetros de la herramienta de búsqueda bing base.

BingGroundingTool

La información de definición de entrada de una herramienta de búsqueda de bing base como se usa para configurar un agente.

BlobReference

Detalles de referencia de blobs.

BotServiceAuthorizationScheme

interfaz modelo BotServiceAuthorizationScheme

BotServiceRbacAuthorizationScheme

interfaz modelo BotServiceRbacAuthorizationScheme

BotServiceTenantAuthorizationScheme

interfaz modelo BotServiceTenantAuthorizationScheme

BrowserAutomationPreviewTool

La información de definición de entrada para una herramienta de automatización del navegador, tal como se usa para configurar un agente.

BrowserAutomationPreviewToolboxTool

Una herramienta de automatización de navegadores almacenada en una caja de herramientas.

BrowserAutomationToolConnectionParameters

Definición de parámetros de entrada para la conexión utilizada por la herramienta de automatización del navegador.

BrowserAutomationToolParameters

Definición de parámetros de entrada para la herramienta de automatización del navegador.

CaptureStructuredOutputsTool

Una herramienta para capturar resultados estructurados

ChartCoordinate

Coordenadas para el gráfico de análisis.

ChatSummaryMemoryItem

Un elemento de memoria que contiene un resumen extraído de conversaciones.

ClusterInsightResult

Información del análisis de clústeres.

ClusterTokenUsage

Uso de tokens para el análisis de clústeres

CodeBasedEvaluatorDefinition

Definición de evaluador basada en código usando código python

CodeConfiguration

Configuración de despliegue basada en código para un agente alojado.

CodeInterpreterTool

Una herramienta que ejecuta código en Python para ayudar a generar una respuesta a un prompt.

CodeInterpreterToolboxTool

Una herramienta intérprete de código almacenada en una caja de herramientas.

ComparisonFilter

Filtro usado para comparar una clave de atributo especificada con un valor determinado mediante una operación de comparación definida.

CompoundFilter

Combine varios filtros mediante and o or.

ComputerTool

Herramienta que controla un equipo virtual. Obtenga más información sobre la herramienta informática.

ComputerUsePreviewTool

Herramienta que controla un equipo virtual. Obtenga más información sobre la herramienta informática.

Connection

Operaciones de respuesta de la lista y obtención de conexiones

ConnectionsGetOptionalParams

Parámetros opcionales.

ConnectionsGetWithCredentialsOptionalParams

Parámetros opcionales.

ConnectionsListOptionalParams

Parámetros opcionales.

ConnectionsOperations

Interfaz que representa una operación de conexiones.

ContainerAutoParam

interfaz de modelo ContainerAutoParam

ContainerConfiguration

Configuración de despliegue basada en contenedores para un agente alojado.

ContainerNetworkPolicyAllowlistParam

interfaz de modelo ContainerNetworkPolicyAllowlistParam

ContainerNetworkPolicyDisabledParam

interfaz de modelo ContainerNetworkPolicyDisabledParam

ContainerNetworkPolicyDomainSecretParam

interfaz de modelo ContainerNetworkPolicyDomainSecretParam

ContainerNetworkPolicyParam

Política de acceso a la red para el contenedor.

ContainerSkill

interfaz de modelo ContainerSkill

ContinuousEvaluationRuleAction

Acción de regla de evaluación para la evaluación continua.

CosmosDBIndex

Definición de índice de almacén de vectores de CosmosDB

CreateAgentVersionFromCodeContent

Cuerpo de solicitud multiparte para actualizar o versionar un agente basado en código (POST /agents/{name} y POST /agents/{name}/versiones).

CreateAgentVersionFromCodeMetadata

Metadatos JSON para operaciones de agentes basadas en código (crear, actualizar, crear versión). El nombre del agente proviene del parámetro de ruta de URL o de la x-ms-agent-name cabecera, por lo que no está incluido en este modelo. El hash de contenido (SHA-256 del zip) se lleva en la x-ms-code-zip-sha256 cabecera.

CreateSkillVersionFromFilesBody

Solicitud multiparte para crear una versión de habilidad a partir de archivos. Acepta un solo archivo zip o varios archivos de habilidades individuales (carga de directorios). Para las subidas en zip, el servidor extrae y valida el contenido. Para la subida de directorios, los archivos se validan as-is.

CreateTeamsPhoneExtensionTelephonyBindingRequest

La solicitud para crear una asignación de extensión de Teléfono Microsoft Teams.

CreateTelephonyBindingRequest

La solicitud para crear un enlace telefónico.

CreateTelephonyCallJobRequest

Una solicitud para crear un trabajo duradero de llamada directa saliente.

CreateTranscriptionResponseJsonUsage

Estadísticas de uso de tokens para la solicitud.

CreateTwilioTelephonyBindingRequest

La solicitud para crear una encuadernación Twilio.

CronTrigger

Disparador basado en cron.

CustomCredential

Definición de credenciales personalizadas

CustomGrammarFormatParam

Una gramática definida por el usuario.

CustomRoutineTrigger

Un activador de rutina de eventos personalizada.

CustomTextFormatParam

Texto libre y sin restricciones.

CustomToolParam

Una herramienta personalizada que procesa la entrada usando un formato especificado. Obtenga más información sobre las herramientas custom

CustomToolParamFormat

El formato de entrada para la herramienta personalizada. Por defecto, el texto no está restringido.

DailyRecurrenceSchedule

Calendario diario de recurrencia.

DataGenerationJob

Recurso de empleo de Generación de Datos.

DataGenerationJobInputs

Entradas suministradas por el llamador para un trabajo de generación de datos.

DataGenerationJobOptions

Opciones para gestionar trabajos de generación de datos.

DataGenerationJobOutput

Información de salida para un trabajo de generación de datos.

DataGenerationJobOutputOptions

Opciones de salida para el trabajo de generación de datos.

DataGenerationJobResult

Resultado producido por un trabajo exitoso de generación de datos.

DataGenerationJobSource

El modelo base de código fuente para trabajos de generación de datos.

DataGenerationModelOptions

Opciones de modelos LLM para trabajos de generación de datos.

DataGenerationTokenUsage

Información sobre el uso de tokens para un trabajo de generación de datos.

DatasetCredential

Representa una referencia a un blob para el consumo

DatasetDataGenerationJobOutput

Salida de conjunto de datos para un trabajo de generación de datos.

DatasetEvaluatorGenerationJobSource

Fuente de datos para trabajos de generación de evaluadores — referencia a un conjunto de datos.

DatasetReference

Referencia a un conjunto de datos versionado de Foundry.

DatasetVersion

Definición de DatasetVersion

DatasetsCreateOrUpdateOptionalParams

Parámetros opcionales.

DatasetsDeleteOptionalParams

Parámetros opcionales.

DatasetsGetCredentialsOptionalParams

Parámetros opcionales.

DatasetsGetOptionalParams

Parámetros opcionales.

DatasetsListOptionalParams

Parámetros opcionales.

DatasetsListVersionsOptionalParams

Parámetros opcionales.

DatasetsOperations

Interfaz que representa operaciones de conjuntos de datos.

DatasetsPendingUploadOptionalParams

Parámetros opcionales.

DeleteAgentResponse

Un objeto de agente eliminado

DeleteAgentVersionResponse

Un objeto de versión de agente eliminado

DeleteMemoryResponse

Respuesta por eliminar un elemento de memoria de un almacén de memoria.

DeleteMemoryStoreResponse

interfaz de modelo DeleteMemoryStoreResponse

DeleteSkillResponse

Una habilidad eliminada.

DeleteSkillVersionResponse

Una versión de habilidad eliminada.

Deployment

Definición de implementación de modelo

DeploymentsGetOptionalParams

Parámetros opcionales.

DeploymentsListOptionalParams

Parámetros opcionales.

DeploymentsOperations

Interfaz que representa una operación de despliegues.

Dimension

Una dimensión única — una dimensión de calidad independiente y medible dentro del plan de puntuación de un evaluador de rúbricas.

DispatchRoutineResponse

Los identificadores se devuelven tras la cola de un despacho rutinario.

EmbeddingConfiguration

Clase de configuración de incrustación

EmptyModelParam

interfaz de modelo EmptyModelParam

EndpointBasedEvaluatorDefinition

Definición de evaluador basada en endpoints. El cliente posee y aloja un endpoint HTTP que implementa el contrato de evaluación. El evaluador referencia a una Conexión de Project por su nombre; la conexión almacena la URL y las credenciales del endpoint (API Key o Entra ID). En el momento de la ejecución, el servicio resuelve la conexión para obtener la URL del endpoint y los detalles de autenticación, y luego llama al endpoint para cada fila de evaluación.

EntraAuthorizationScheme

interfaz de modelo EntraAuthorizationScheme

EntraIDCredentials

Definición de credenciales Entra ID

ErrorModel

Interfaz de modelo ErrorModel

EvalResult

Resultado de la evaluación.

EvalRunResultCompareItem

Comparación métrica de un tratamiento con la línea de base.

EvalRunResultComparison

Los resultados de la comparación para el tratamiento se comparan con la línea de base.

EvalRunResultSummary

Estadísticas de resumen de una métrica en una ejecución de evaluación.

EvaluationComparisonInsightRequest

Solicitud de comparación de evaluación

EvaluationComparisonInsightResult

Perspectivas de la comparación de la evaluación.

EvaluationResultSample

Una muestra del resultado de la evaluación.

EvaluationRule

Modelo de regla de evaluación.

EvaluationRuleAction

Modelo de acción de evaluación.

EvaluationRuleFilter

Modelo de filtro de evaluación.

EvaluationRulesCreateOrUpdateOptionalParams

Parámetros opcionales.

EvaluationRulesDeleteOptionalParams

Parámetros opcionales.

EvaluationRulesGetOptionalParams

Parámetros opcionales.

EvaluationRulesListOptionalParams

Parámetros opcionales.

EvaluationRulesOperations

Interfaz que representa una operación EvaluationRules.

EvaluationRunClusterInsightRequest

Información sobre el conjunto de resultados de la evaluación

EvaluationRunClusterInsightResult

La información de la evaluación ejecuta el análisis de clústeres.

EvaluationScheduleTask

Tarea de evaluación para el horario.

EvaluationTarget

Clase base para destinos con compatibilidad con discriminadores.

EvaluationTaxonomy

Definición de taxonomía de evaluación

EvaluationTaxonomyInput

Configuración de entrada para la taxonomía de evaluación.

EvaluatorCredentialRequest

Organismo de solicitud para obtener las credenciales del evaluador

EvaluatorDefinition

Configuración del evaluador base con discriminador

EvaluatorGenerationArtifacts

Artefactos de procedencia gestionados por servicios producidos por un trabajo de generación evaluador. Presente solo en recursos EvaluatorVersion creados mediante la pipeline de generación. El conjunto de datos combinado-JSONL de Foundry es de solo lectura y se resuelve a un conjunto de datos versionado en un espacio de nombres reservado por servicio.

EvaluatorGenerationInputs

Entradas suministradas por el llamador para un trabajo de generación de evaluadores.

EvaluatorGenerationJob

Recurso de Generación de Trabajos de Evaluador — un trabajo de larga duración que genera definiciones de evaluadores basadas en rúbricas a partir de materiales fuente. En caso de éxito, el resultado es la EvaluatorVersion persistida.

EvaluatorGenerationJobSource

El modelo base de fuentes para los trabajos de generación de evaluadores. Polimórfico sobre type.

EvaluatorGenerationTokenUsage

Resumen de consumo de tokens para un trabajo de generación de evaluadores. Se llena cuando el trabajo alcanza un estado terminal.

EvaluatorMetric

Métrica del evaluador

EvaluatorVersion

Definición del evaluador

ExternalAgentDefinition

La definición de agente externo. Representa a un agente externo alojado fuera de Foundry (por ejemplo, en GCP o AWS). El registro es solo de metadatos: Foundry registra la definición del agente para iluminar experiencias de observabilidad (trazas, evaluaciones) sobre los datos emitidos por el cliente de OpenTelemetry.

FabricDataAgentToolParameters

Los parámetros de la herramienta Fabric Data Agent.

FabricIQPreviewTool

Una herramienta FabricIQ para el lado del servidor.

FabricIQPreviewToolboxTool

Una herramienta FabricIQ guardada en una caja de herramientas.

FieldMapping

Clase de configuración de mapeo de campos

FileDataGenerationJobOutput

Salida de archivo Azure OpenAI para un trabajo de generación de datos.

FileDataGenerationJobSource

Fuente de archivo para trabajos de generación de datos — Entrada de archivos Azure OpenAI.

FileDatasetVersion

FileDatasetVersion (Definición)

FileSearchTool

Herramienta que busca contenido relevante de los archivos cargados. Obtén más información sobre la herramienta de búsqueda de archivos.

FileSearchToolboxTool

Una herramienta de búsqueda de archivos almacenada en una caja de herramientas.

FixedRatioVersionSelectionRule

interfaz de modelo FactoredRatioVersionSelectionRule

FolderDatasetVersion

FileDatasetVersion (Definición)

FoundryModelWarning

Una advertencia asociada a un modelo.

FunctionShellToolParam

Una herramienta que permite al modelo ejecutar comandos de shell.

FunctionShellToolParamEnvironment

Interfaz de modelo FunciónShellHerramientaParamEntorno

FunctionShellToolParamEnvironmentContainerReferenceParam

Interfaz de modelo FunciónShellHerramientaParamEntornoContenedorReferenciaParam

FunctionShellToolParamEnvironmentLocalEnvironmentParam

Interfaz de modelo FunciónShellHerramientaParamEntornoLocalEntornoParam

FunctionTool

Define una función en tu propio código a la que el modelo puede elegir llamar. Aprende más sobre la llamada de funciones.

FunctionToolParam

interfaz de modelo FunctionToolParam

GenAITracingOptions

Opciones para configurar el trazado GenAI en una instancia específica de AIProjectClient.

Pásala estos bajo la tracingOptions clave AIProjectClientOptionalParams para habilitar el trazado GenAI cuando el cliente sea instanciado. Cada instancia cliente mantiene su propia configuración independiente de trazado.

GenerateVoiceAgentRequest

Las entradas para generar un agente de voz. Solo kind y name siempre son obligatorios. El servicio de autoría amplía estas entradas en un , completo y editable VoiceAgentDefinition, que luego se crea mediante POST /agents. Los ajustes generados instructions y de audio/voz se almacenan como campos separados en la definición resultante del agente, por lo que el llamante puede editar o anular cualquiera de ellos posteriormente mediante el versionado estándar del agente.

GetMicrosoft365PackageOptionalParams

Parámetros opcionales.

GetMicrosoft365PublishDefaultsOptionalParams

Parámetros opcionales.

GitHubCopilotHarness

(Vista previa) El arnés gestionado de GitHub Copilot para agentes de prompt.

GitHubCopilotToolsetConfig

Una anulación de habilitación para una herramienta integrada de GitHub Copilot.

GitHubCopilotToolsetDefaultConfig

La configuración predeterminada de habilitación para las herramientas integradas de GitHub Copilot.

GitHubCopilotToolsetPreview

(Vista previa) Anulaciones de configuración para las herramientas integradas de GitHub Copilot.

GitHubIssueRoutineTrigger

Un disparador de rutina de problemas en GitHub.

HeaderTelemetryEndpointAuth

Autenticación secreta basada en encabezado para un punto final de telemetría. El valor secreto resuelto se inyecta como una cabecera HTTP.

HostedAgentDefinition

La definición del agente hospedado.

HourlyRecurrenceSchedule

Programación de periodicidad por hora.

HumanEvaluationPreviewRuleAction

Acción de regla de evaluación para la evaluación humana.

HybridSearchOptions

interfaz de modelo HybridSearchOptions

ImageGenTool

Una herramienta que genera imágenes usando los modelos de imagen GPT.

ImageGenToolInputImageMask

interfaz de modelo ImageGenToolInputImageMask

IndexesCreateOrUpdateOptionalParams

Parámetros opcionales.

IndexesDeleteOptionalParams

Parámetros opcionales.

IndexesGetOptionalParams

Parámetros opcionales.

IndexesListOptionalParams

Parámetros opcionales.

IndexesListVersionsOptionalParams

Parámetros opcionales.

IndexesOperations

Interfaz que representa una operación de índices.

InlineSkillParam

interfaz modelo InlineSkillParam

InlineSkillSourceParam

Carga útil de habilidades en línea

Insight

El cuerpo de respuesta para la información del clúster.

InsightCluster

Un grupo de muestras de análisis.

InsightGenerationRequest

El organismo de solicitud para generar una información.

InsightModelConfiguration

Configuración del modelo utilizado en la generación de información.

InsightRequest

La solicitud del informe de información.

InsightResult

El resultado de las ideas.

InsightSample

Una muestra del análisis.

InsightScheduleTask

Tarea de información para la programación.

InsightSummary

Resumen del análisis de conglomerados de errores.

InsightsMetadata

Metadatos sobre la información.

InvocationsProtocolConfiguration

Configuración específica del protocolo de invocaciones.

InvocationsWsProtocolConfiguration

Configuración específica del protocolo de invocaciones basado en WebSocket.

InvokeAgentInvocationsApiDispatchPayload

Una carga útil manual usada para probar el despacho rutinario de una API de invocaciones.

InvokeAgentInvocationsApiRoutineAction

Despacha una rutina a través de la API de invocaciones en bruto. Exactamente uno de los agent_name o agent_endpoint_id debe proporcionarse.

InvokeAgentResponsesApiDispatchPayload

Una carga útil manual utilizada para probar el despacho rutinario de una API de respuestas.

InvokeAgentResponsesApiRoutineAction

Despacha una rutina a través de la API de respuestas. Exactamente uno de los agent_name o agent_endpoint_id debe proporcionarse.

JobOperationState

Estado de operación para una operación de larga duración que crea un recurso de empleo.

PERSONALIZACIÓN: MEJORA SDK: los encuestadores emitidos se resuelven a la carga útil terminal result del trabajo, que no lleva identificador; jobId mantiene accesible el trabajo creado.

LocalShellToolParam

Herramienta que permite al modelo ejecutar comandos de shell en un entorno local.

LocalSkillParam

interfaz de modelo LocalSkillParam

LogProbProperties

Un objeto de probabilidad logarítmica.

LoraConfig

Metadatos específicos del adaptador para modelos LoRA. Unidades que sirven a la configuración del motor en el momento del despliegue.

MCPListToolsTool

Una herramienta disponible en un servidor MCP.

MCPListToolsToolAnnotations

Interfaz de modelo: MCPListToolsToolAnnotations

MCPListToolsToolInputSchema

interfaz de modelo MCPListToolsToolInputSchema

MCPTool

Asigne al modelo acceso a herramientas adicionales a través de servidores remotos del Protocolo de Contexto de Modelo (MCP). Más información sobre MCP.

MCPToolFilter

Un objeto filtro para especificar qué herramientas están permitidas.

MCPToolRequireApproval

interfaz de modelo MCPToolRequireApproval

MCPToolboxTool

Una herramienta MCP guardada en una caja de herramientas.

ManagedAgentIdentityBlueprintReference

interfaz de modelo: AgenteGestionadoIdidReferenciaBlueprintT

ManagedAzureAISearchIndex

Definición de índice de Búsqueda de Azure AI administrada

McpProtocolConfiguration

Configuración específica del protocolo MCP.

MemoryItem

Un único elemento de memoria almacenado en el almacén de memoria, que contiene contenido y metadatos.

MemoryOperation

Representa una única operación de memoria (crear, actualizar o eliminar) realizada en un elemento de memoria.

MemorySearchItem

Un elemento de memoria recuperado de la búsqueda de memoria.

MemorySearchOptions

Opciones de búsqueda de memoria.

MemorySearchPreviewTool

Una herramienta para integrar los recuerdos en el agente.

MemoryStore

Un almacén de memoria que puede almacenar y recuperar recuerdos de usuario.

MemoryStoreDefaultDefinition

Implementación predeterminada del almacén de memoria.

MemoryStoreDefaultOptions

Configuraciones predeterminadas del almacén de memoria.

MemoryStoreDefinition

Definición base para configuraciones de almacén de memoria.

MemoryStoreDeleteScopeResponse

Respuesta para eliminar memorias de un ámbito.

MemoryStoreOperationUsage

Estadísticas de uso de una operación de almacén de memoria.

MemoryStoreSearchResponse

Respuesta de búsqueda de memoria.

MemoryStoreUpdateCompletedResult

Resultado de la actualización de memoria.

MemoryStoreUpdateResponse

Proporciona el estado de una operación de actualización del almacén de memoria.

Metadata

Conjunto de 16 pares clave-valor que se pueden adjuntar a un objeto. Esto puede ser útil para almacenar información adicional sobre el objeto en un formato estructurado y consultar objetos a través de la API o el panel. Las claves son cadenas con una longitud máxima de 64 caracteres. Los valores son cadenas con una longitud máxima de 512 caracteres.

Microsoft365PermissionScopes

Un conjunto de ámbitos de permiso delegados solicitados a una única aplicación de recurso.

Microsoft365PublishDefaults

Valores predeterminados y previamente publicados usados para precompletar una solicitud de publicación de Microsoft 365 para un agente de Foundry.

Microsoft365PublishResponse

Respuesta tras publicar un agente en Microsoft 365 / Microsoft Teams.

MicrosoftFabricPreviewTool

La información de definición de entrada para una herramienta de Microsoft Fabric usada para configurar un agente.

MisalignmentErrorDetailsResource

Los detalles de una acción se bloquean porque puede no coincidir con la intención del usuario.

MisalignmentSteer

Una instrucción pública para continuar después de que una acción sea bloqueada.

ModelCredentialRequest

Solicitar obtener credenciales para un activo modelo.

ModelDeployment

Definición de implementación de modelo

ModelDeploymentSku

Información de SKU

ModelPendingUploadRequest

Representa una solicitud de subida pendiente de una versión del modelo.

ModelPendingUploadResponse

Representa la respuesta a una solicitud pendiente de subida.

ModelSamplingParams

Representa un conjunto de parámetros usados para controlar el comportamiento de muestreo de un modelo de lenguaje durante la generación de texto.

ModelSourceData

Información de origen para el modelo

ModelVersion

Definición de versión del modelo

MonthlyRecurrenceSchedule

Programa de periodicidad mensual.

NamespaceToolParam

Agrupa la función/herramientas personalizadas bajo un espacio de nombres compartido.

NoAuthenticationCredentials

Credenciales que no requieren autenticación

OneTimeTrigger

Disparador único.

OpenAIClientOptionsWithAzureAgent

Ampliaron las opciones de cliente de OpenAI para incluir la configuración de endpoints de Azure Agent.

OpenApiAnonymousAuthDetails

Detalles de seguridad para la autenticación anónima de OpenApi

OpenApiAuthDetails

detalles de autenticación de OpenApiFunctionDefinition

OpenApiFunctionDefinition

Información de definición de entrada para una función openapi.

OpenApiManagedAuthDetails

Detalles de seguridad para la autenticación de openApi managed_identity

OpenApiManagedSecurityScheme

Esquema de seguridad para la autenticación de openApi managed_identity

OpenApiProjectConnectionAuthDetails

Detalles de seguridad para la autenticación de conexión de OpenApi project

OpenApiProjectConnectionSecurityScheme

Esquema de seguridad para la autenticación de openApi managed_identity

OpenApiTool

La información de definición de entrada de una herramienta OpenAPI como se usa para configurar un agente.

OpenApiToolboxTool

Una herramienta OpenAPI almacenada en una caja de herramientas.

OptimizedAgentIdentifier

Identifica al agente registrado de Foundry para optimizar (solo solicitud). Las habilidades, herramientas y system_prompt se especifican en options.optimization_config.

OtlpTelemetryEndpoint

Un punto final de exportación de telemetría OTLP (OpenTelemetry Protocol).

PageSettings

Interfaz que realiza un seguimiento de la configuración de la iteración paginada

PagedAsyncIterableIterator

Interfaz que permite la iteración asincrónica tanto a la finalización como a la página.

PendingUploadRequest

Representa una solicitud de una carga pendiente.

PendingUploadResponse

Representa la respuesta a una solicitud de carga pendiente

PickPropertiesVoiceAgentAudioConfig

La plantilla para elegir propiedades.

ProceduralMemoryItem

Un elemento de memoria que contiene un procedimiento extraído de conversaciones.

ProgrammaticToolCallingParam

interfaz de modelo: ProgrammaticToolCallingParam

PromotionInfo

Metadatos de promoción registrados cuando un candidato es desplegado a un agente de Foundry.

PromptAgentDefinition

Definición del agente del símbolo del sistema

PromptAgentDefinitionTextOptions

Opciones de configuración para una respuesta de texto del modelo. Puede ser texto sin formato o datos JSON estructurados.

PromptBasedEvaluatorDefinition

Evaluador basado en indicaciones

PromptDataGenerationJobSource

Fuente de aviso para trabajos de generación de datos — texto en línea proporcionado por el usuario.

PromptEvaluatorGenerationJobSource

Fuente de prompt para trabajos de generación de evaluadores — texto en línea proporcionado por el usuario.

ProtocolConfiguration

Configuración por protocolo para el punto final del agente.

ProtocolVersionRecord

Una asignación de registros para un solo protocolo y su versión.

PstnTelephonyTransferDestination

Un destino PSTN para un destino de transferencia telefónica.

PublishToMicrosoft365OptionalParams

Parámetros opcionales.

RaiConfig

Configuración para funciones de seguridad y filtrado de contenido de IA responsable (RAI).

RaiInvocationModeration

Declara dónde reside el texto de solicitud/respuesta para que las barreras de seguridad del contenido puedan extraerlo.

RaiSseTextSelector

Un selector de tipo evento SSE a campo de texto para transmitir la salida de invocación.

RankingOptions

interfaz de modelo Opciones de clasificación

RealtimeAudioFormats

interfaz de modelo RealtimeAudioFormatos

RealtimeAudioFormatsAudioPcm

interfaz de modelo RealtimeAudioFormatosAudioPcm

RealtimeAudioFormatsAudioPcma

interfaz de modelo: RealtimeAudioFormatosAudioPcma

RealtimeAudioFormatsAudioPcmu

interfaz de modelo RealtimeAudioFormatosAudioPcmu

RealtimeClientEvent

Un evento en tiempo real con clientes.

RealtimeClientEventConversationItemCreate

Añade un nuevo elemento al contexto de la conversación, incluyendo mensajes, llamadas a funciones y respuestas a llamadas de función. Este evento puede usarse tanto para llenar un "historial" de la conversación como para añadir nuevos elementos a mitad de camino, pero tiene la limitación actual de que no puede llenar mensajes de audio del asistente. Si tiene éxito, el servidor responderá con un conversation.item.created evento, de lo contrario se enviará un error evento.

RealtimeClientEventConversationItemDelete

Envía este evento cuando quieras eliminar cualquier elemento del historial de conversaciones. El servidor responderá con un conversation.item.deleted evento, a menos que el elemento no exista en el historial de conversaciones, en cuyo caso el servidor responderá con un error.

RealtimeClientEventConversationItemRetrieve

Envía este evento cuando quieras recuperar la representación del servidor de un elemento específico en el historial de conversaciones. Esto es útil, por ejemplo, para inspeccionar el audio del usuario tras la cancelación de ruido y el VAD. El servidor responderá con un conversation.item.retrieved evento, a menos que el elemento no exista en el historial de conversaciones, en cuyo caso el servidor responderá con un error.

RealtimeClientEventConversationItemTruncate

Envía este evento para truncar el audio de un mensaje de asistente anterior. El servidor produce audio más rápido que en tiempo real, por lo que este evento es útil cuando el usuario interrumpe para truncar audio que ya se ha enviado al cliente pero aún no se ha reproducido. Esto sincronizará la comprensión del audio por parte del servidor con la reproducción del cliente. Truncar el audio eliminará la transcripción del texto del lado del servidor para asegurarse de que no haya texto en el contexto que el usuario no haya escuchado. Si tiene éxito, el servidor responderá con un conversation.item.truncated evento.

RealtimeClientEventInputAudioBufferAppend

Envía este evento para añadir bytes de audio al búfer de audio de entrada. El búfer de audio es un almacenamiento temporal en el que puede escribir y confirmar posteriormente. Un "commit" creará un nuevo elemento de mensaje de usuario en el historial de conversaciones desde el contenido del búfer y borrará el búfer. La transcripción de audio de entrada (si está habilitada) se generará cuando el búfer se confirme. Si el VAD está activado, el búfer de audio se utiliza para detectar el habla y el servidor decidirá cuándo hacer el comet. Cuando el VAD del servidor está desactivado, se debe manejar el búfer de audio manualmente. La reducción del ruido del audio de entrada se realiza al escribir en el búfer de audio. El cliente puede elegir cuánto audio colocar en cada evento hasta un máximo de 15 MiB; por ejemplo, reproducir fragmentos más pequeños desde el cliente puede permitir que el VAD sea más responsivo. A diferencia de la mayoría de los eventos del cliente, el servidor no enviará una respuesta de confirmación a este evento.

RealtimeClientEventInputAudioBufferClear

Envía este evento para borrar los bytes de audio en el búfer. El servidor responderá con un input_audio_buffer.cleared evento.

RealtimeClientEventInputAudioBufferCommit

Envía este evento para comprometer el búfer de audio de entrada del usuario, lo que creará un nuevo elemento de mensaje de usuario en la conversación. Este evento generará un error si el búfer de audio de entrada está vacío. Cuando está en modo VAD de servidor, el cliente no necesita enviar este evento, el servidor comprometerá automáticamente el búfer de audio. Confirmar el búfer de audio de entrada activará la transcripción de audio de entrada (si está activada en la configuración de sesión), pero no generará una respuesta del modelo. El servidor responderá con un input_audio_buffer.committed evento.

RealtimeClientEventOutputAudioBufferClear

Solo WebRTC/SIP: Emite para cortar la respuesta de audio actual. Esto hará que el servidor deje de generar audio y emita un output_audio_buffer.cleared evento. Este evento debe ir precedido por un response.cancel evento de cliente para detener la generación de la respuesta actual. Obtenga más información.

RealtimeClientEventResponseCancel

Envía este evento para cancelar una respuesta en curso. El servidor responderá con un response.done evento con un estado de response.status=cancelled. Si no hay respuesta para cancelar, el servidor responderá con un error. Es seguro llamar response.cancel aunque no haya respuesta en curso, se devolverá un error y la sesión permanecerá intacta.

RealtimeClientEventResponseCreate

Este evento indica al servidor que genere una Respuesta, lo que significa activar la inferencia del modelo. Cuando está en modo VAD del servidor, el servidor creará respuestas automáticamente. Una Respuesta incluirá al menos un Ítem, y puede tener dos, en cuyo caso el segundo será una llamada de función. Estos elementos se añadirán al historial de conversaciones por defecto. El servidor responderá con un response.created evento, eventos para Elementos y contenido creado, y finalmente un response.done evento para indicar que la Respuesta ha terminado. El response.create evento incluye la configuración de inferencia como instructions y tools. Si estas se activan, anularán la configuración de la sesión solo para esta respuesta. Las respuestas pueden crearse fuera de banda de la Conversación predeterminada, lo que significa que pueden tener una entrada arbitraria, y es posible desactivar la escritura de la salida en la Conversación. Solo una Respuesta puede escribir en la Conversación predeterminada a la vez, pero por lo demás se pueden crear varias Respuestas en paralelo. El metadata campo es una buena forma de desambiguar múltiples respuestas simultáneas. Los clientes pueden configurar conversation para none crear una Respuesta que no escriba en la Conversación predeterminada. Se puede proporcionar entrada arbitraria con el input campo, que es un array que acepta elementos en bruto y referencias a elementos existentes.

RealtimeConversationItem

Un solo elemento dentro de una conversación en tiempo real.

RealtimeConversationItemFunctionCall

Un elemento de llamada a función en una conversación en tiempo real.

RealtimeConversationItemFunctionCallOutput

Una función que llama a un elemento de salida en una conversación en tiempo real.

RealtimeConversationItemMessage

interfaz de modelo RealtimeConversationItemMessage

RealtimeConversationItemMessageAssistant

Un elemento de mensaje de asistente en una conversación en tiempo real.

RealtimeConversationItemMessageAssistantContent

interfaz de modelo Tiempo realConversaciónÍtemMensajeAsistente Contenido

RealtimeConversationItemMessageSystem

Un mensaje del sistema en una conversación en tiempo real puede usarse para proporcionar contexto adicional o instrucciones al modelo. Esto es similar pero distinto de la instrucción que se proporciona al inicio de una conversación, ya que los mensajes del sistema pueden añadirse en cualquier momento de la conversación. Para cambios importantes en el comportamiento de la conversación, usa instrucciones, pero para actualizaciones menores (por ejemplo, "el usuario ahora pregunta sobre otro tema"), usa mensajes del sistema.

RealtimeConversationItemMessageSystemContent

interfaz de modelo Tiempo realConversaciónÍtemMensajeSistemaContenido

RealtimeConversationItemMessageUser

Un elemento de mensaje de usuario en una conversación en tiempo real.

RealtimeConversationItemMessageUserContent

interfaz de modelo Tiempo realConversaciónÍtemMensajeContenido de Usuario

RealtimeFunctionTool

interfaz de modelo RealtimeFunctionTool

RealtimeMCPApprovalRequest

Un ítem en tiempo real que solicita aprobación humana para una invocación de herramienta.

RealtimeMCPApprovalResponse

Un ítem en tiempo real que responde a una solicitud de aprobación MCP.

RealtimeMCPError

interfaz de modelo RealtimeMCPError

RealtimeMCPHttpError

interfaz de modelo RealtimeMCPHttpError

RealtimeMCPListTools

Herramientas de listado de elementos en tiempo real disponibles en un servidor MCP.

RealtimeMCPProtocolError

interfaz de modelo RealtimeMCPProtocolError

RealtimeMCPToolCall

Un elemento en tiempo real que representa una invocación de una herramienta en un servidor MCP.

RealtimeMCPToolExecutionError

interfaz de modelo RealtimeMCPToolExecutionError

RealtimeReasoning

Configuración para modelos en tiempo real con capacidad de razonamiento como gpt-realtime-2.

RealtimeResponseStatusDetails

interfaz de modelo Tiempo realRespuestaEstadoEstadoDetalles

RealtimeResponseStatusDetailsError

interfaz de modelo Tiempo realRespuestaEstadoEstadoDetallesError

RealtimeResponseUsage

interfaz de modelo RealtimeResponseUsage

RealtimeResponseUsageInputTokenDetails

interfaz de modelo Tiempo realRespuestaUsoEntradaDetallesTokenDetalles.

RealtimeResponseUsageInputTokenDetailsCachedTokensDetails

Interfaz de modelo Tiempo realRespuestaUsoEntradaDetallesTokensCachéDetalles

RealtimeResponseUsageOutputTokenDetails

interfaz de modelo RealtimeResponseUsageOutputTokenDetails

RealtimeServerEvent

Un evento en tiempo real del servidor.

RealtimeServerEventConversationItemAdded

Enviado por el servidor cuando se añade un Elemento a la Conversación por defecto. Esto puede ocurrir en varios casos:

  • Cuando el cliente envía un conversation.item.create evento.
  • Cuando el búfer de audio de entrada está comprometido. En este caso, el elemento será un mensaje de usuario que contendrá el audio del búfer.
  • Cuando el modelo genera una respuesta. En este caso, el conversation.item.added evento se enviará cuando el modelo empiece a generar un Elemento específico, y por tanto aún no tendrá contenido (y status será in_progress). El evento incluirá el contenido completo del Elemento (excepto cuando el modelo está generando una Respuesta) excepto los datos de audio, que pueden recuperarse por separado con un conversation.item.retrieve evento si es necesario.
RealtimeServerEventConversationItemCreated

Se devuelven cuando se crea un elemento de conversación. Hay varios escenarios que generan este evento:

  • El servidor genera una Respuesta que, si tiene éxito, producirá uno o dos Ítems, que serán de tipo message (rol assistant) o function_callde tipo .
  • El búfer de audio de entrada ha sido confirmado, ya sea por el cliente o por el servidor (en modo).server_vad El servidor tomará el contenido del búfer de audio de entrada y lo añadirá a un nuevo elemento de mensaje de usuario.
  • El cliente ha enviado un conversation.item.create evento para añadir un nuevo elemento a la conversación.
RealtimeServerEventConversationItemDeleted

Se devuelve cuando un elemento de la conversación es eliminado por el cliente con un conversation.item.delete evento. Este evento se usa para sincronizar la comprensión del servidor del historial de conversaciones con la vista del cliente.

RealtimeServerEventConversationItemDone

Devuelven cuando se finaliza un punto de conversación. El evento incluirá el contenido completo del Elemento excepto los datos de audio, que pueden recuperarse por separado con un conversation.item.retrieve evento si es necesario.

RealtimeServerEventConversationItemInputAudioTranscriptionCompleted

Este evento es la salida de la transcripción de audio del usuario escrita en el búfer de audio del usuario. La transcripción comienza cuando el cliente o el servidor confirman el búfer de audio de entrada (cuando VAD está habilitado). La transcripción se ejecuta de forma asíncrona con la creación de Respuesta, por lo que este evento puede ocurrir antes o después de los eventos de Respuesta. Los modelos API en tiempo real aceptan audio de forma nativa, por lo que la transcripción de entrada es un proceso separado que se ejecuta en un modelo ASR (Reconocimiento Automático de Voz) distinto. La transcripción puede divergir algo de la interpretación del modelo y debe tratarse como una guía aproximada.

RealtimeServerEventConversationItemInputAudioTranscriptionDelta

Se devuelve cuando se actualiza el valor de texto de una parte de contenido de transcripción de audio de entrada con resultados incrementales de transcripción.

RealtimeServerEventConversationItemInputAudioTranscriptionFailed

Se devuelven cuando se configura la transcripción de audio de entrada y falla una solicitud de transcripción para un mensaje de usuario. Estos eventos son independientes de otros error eventos para que el cliente pueda identificar el Elemento relacionado.

RealtimeServerEventConversationItemInputAudioTranscriptionFailedError

Interfaz de modelo RealtimeServerEventConversationItemInputAudioTranscriptionFailedError

RealtimeServerEventConversationItemInputAudioTranscriptionSegment

Se devuelve cuando se identifica un segmento de transcripción de audio de entrada para un elemento.

RealtimeServerEventConversationItemRetrieved

Devuelta cuando se recupera un elemento de conversación con conversation.item.retrieve. Esto se proporciona como una forma de obtener la representación del servidor de un elemento, por ejemplo, para acceder a los datos de audio postprocesados tras la cancelación de ruido y el VAD. Incluye el contenido completo del Artículo, incluyendo datos de audio.

RealtimeServerEventConversationItemTruncated

Se devuelven cuando un elemento anterior de un mensaje de audio de asistente es truncado por el cliente con un conversation.item.truncate evento. Este evento se utiliza para sincronizar la comprensión del audio del servidor con la reproducción del cliente. Esta acción truncará el audio y eliminará la transcripción del texto del lado del servidor para asegurar que no haya texto en el contexto que el usuario no haya escuchado.

RealtimeServerEventError

Se devuelve cuando ocurre un error, que puede ser un problema del cliente o del servidor. La mayoría de los errores son recuperables y la sesión permanecerá abierta; recomendamos a los implementadores que monitoreen y registren los mensajes de error por defecto.

RealtimeServerEventErrorError

interfaz de modelo RealtimeServerEventErrorError

RealtimeServerEventInputAudioBufferCleared

Se devuelven cuando el cliente borra el búfer de audio de entrada con un input_audio_buffer.clear evento.

RealtimeServerEventInputAudioBufferCommitted

Se devuelven cuando se compromete un búfer de audio de entrada, ya sea por el cliente o automáticamente en modo VAD del servidor. La item_id propiedad es el ID del elemento de mensaje de usuario que se creará, por lo que también se enviará un conversation.item.created evento al cliente.

RealtimeServerEventInputAudioBufferSpeechStarted

Enviado por el servidor cuando está en server_vad modo para indicar que se ha detectado voz en el búfer de audio. Esto puede ocurrir en cualquier momento al añadir sonido a la memoria intermedia (a menos que ya se detecte voz). El cliente puede querer utilizar este evento para interrumpir la reproducción de audio o proporcionar retroalimentación visual al usuario. El cliente debe esperar recibir un input_audio_buffer.speech_stopped evento cuando el habla se detiene. La item_id propiedad es el ID del elemento del mensaje de usuario que se creará cuando el habla se detenga y que también se incluirá en el input_audio_buffer.speech_stopped evento (a menos que el cliente comprometa manualmente el búfer de audio durante la activación del VAD).

RealtimeServerEventInputAudioBufferSpeechStopped

Devuelven el server_vad modo cuando el servidor detecta el fin del habla en el búfer de audio. El servidor también enviará un conversation.item.created evento con el elemento de mensaje de usuario que se crea a partir del búfer de audio.

RealtimeServerEventInputAudioBufferTimeoutTriggered

Se devuelve cuando se activa el tiempo de espera del VAD del servidor para el búfer de audio de entrada. Esto se configura idle_timeout_ms en la turn_detection configuración de la sesión, e indica que no se ha detectado ninguna voz durante la duración configurada. Los campos audio_start_ms y audio_end_ms indican el segmento de audio después de la última respuesta del modelo hasta el momento de activación, como desplazamiento desde el principio del audio escrito al búfer de audio de entrada. Esto significa que delimita el segmento de audio que estaba en silencio y la diferencia entre los valores de inicio y final coincidirá aproximadamente con el tiempo de espera configurado. El audio vacío se comprometerá en la conversación como un input_audio elemento (habrá un input_audio_buffer.committed evento) y se generará una respuesta modelo. Puede haber un discurso que no activó el VAD pero que el modelo aún detecta, por lo que el modelo puede responder con algo relevante para la conversación o con un prompt para que continúe hablando.

RealtimeServerEventMCPListToolsCompleted

Devuelta cuando se ha completado la lista de herramientas MCP para un artículo.

RealtimeServerEventMCPListToolsFailed

Devuelto cuando las herramientas MCP han fallado al anunciar un artículo.

RealtimeServerEventMCPListToolsInProgress

Se devuelve cuando la enumeración de las herramientas de MCP de un elemento está en curso.

RealtimeServerEventOutputAudioBufferCleared

Solo WebRTC/SIP: Se emite cuando se borra el búfer de audio de salida. Esto sucede en modo VAD cuando el usuario ha interrumpido (input_audio_buffer.speech_started) o cuando el cliente ha emitido el output_audio_buffer.clear evento para cortar manualmente la respuesta de audio actual. Obtenga más información.

RealtimeServerEventRateLimitsUpdated

Emitido al inicio de una Respuesta para indicar los límites de tasa actualizados. Cuando se crea una Respuesta, algunos tokens se "reservan" para los tokens de salida; los límites de tasa mostrados aquí reflejan esa reserva, que luego se ajusta en consecuencia una vez completada la Respuesta.

RealtimeServerEventRateLimitsUpdatedRateLimits

interfaz de modelo RealtimeServerEventRateLimitsUpdatedRateLimits

RealtimeServerEventResponseAudioDelta

Se devuelven cuando se actualiza el audio generado por el modelo.

RealtimeServerEventResponseAudioDone

Se devuelven cuando termina el audio generado por el modelo. También se emite cuando una Respuesta se interrumpe, es incompleta o se cancela.

RealtimeServerEventResponseAudioTranscriptDelta

Se devuelven cuando se actualiza la transcripción generada por el modelo de la salida de audio.

RealtimeServerEventResponseAudioTranscriptDone

Devuelven cuando la transcripción generada por el modelo de la salida de audio termina de transmitir. También se emite cuando una Respuesta se interrumpe, es incompleta o se cancela.

RealtimeServerEventResponseContentPartAdded

Se devuelven cuando se añade una nueva parte de contenido a un elemento de mensaje asistente durante la generación de respuestas.

RealtimeServerEventResponseContentPartAddedPart

interfaz de modelo RealtimeServerEventResponseContentPartAddedPart

RealtimeServerEventResponseContentPartDone

Se devuelven cuando una parte de contenido termina de transmitirse en un elemento de mensaje de asistente. También se emite cuando una Respuesta se interrumpe, es incompleta o se cancela.

RealtimeServerEventResponseContentPartDonePart

interfaz de modelo RealtimeServerEventResponseContentPartDonePart

RealtimeServerEventResponseCreated

Se devuelven cuando se crea una nueva Respuesta. El primer evento de creación de respuesta, donde la respuesta está en un estado inicial de in_progress.

RealtimeServerEventResponseDone

Devuelven cuando una respuesta termina de transmitirse. Siempre emitidos, sin importar el estado final. El objeto Respuesta incluido en el response.done evento incluirá todos los elementos de salida en la Respuesta, pero omitirá los datos de audio en bruto. Los clientes deben consultar el status campo de la Respuesta para determinar si ha sido exitosa (completed) o si ha habido otro resultado: cancelled, failed, o incomplete. Una respuesta contendrá todos los elementos de salida que se generaron durante la respuesta, excluyendo cualquier contenido de audio.

RealtimeServerEventResponseFunctionCallArgumentsDelta

Devuelta cuando se actualizan los argumentos de la llamada a función generados por el modelo.

RealtimeServerEventResponseFunctionCallArgumentsDone

Se devuelven cuando los argumentos de la llamada a función generados por el modelo terminan de fluir. También se emite cuando una Respuesta se interrumpe, es incompleta o se cancela.

RealtimeServerEventResponseMCPCallArgumentsDelta

Se devuelven cuando se actualizan los argumentos de llamada a la herramienta MCP durante la generación de respuesta.

RealtimeServerEventResponseMCPCallArgumentsDone

Se devuelven cuando se finalizan los argumentos de llamada a la herramienta MCP durante la generación de respuesta.

RealtimeServerEventResponseMCPCallCompleted

Devuelta cuando una llamada a la herramienta MCP se ha completado con éxito.

RealtimeServerEventResponseMCPCallFailed

Devuelven cuando una llamada a la herramienta MCP ha fallado.

RealtimeServerEventResponseMCPCallInProgress

Devuelta cuando ha comenzado y está en curso una llamada de la herramienta MCP.

RealtimeServerEventResponseOutputItemAdded

Se devuelve cuando se crea un nuevo Elemento durante la generación de la Respuesta.

RealtimeServerEventResponseOutputItemDone

Devuelven cuando un Item termina de transmitirse. También se emite cuando una Respuesta se interrumpe, es incompleta o se cancela.

RealtimeServerEventResponseTextDelta

Se devuelve cuando se actualiza el valor de texto de una parte de contenido "output_text".

RealtimeServerEventResponseTextDone

Se devuelve cuando el valor de texto de una parte de contenido "output_text" termina de transmitirse. También se emite cuando una Respuesta se interrumpe, es incompleta o se cancela.

RealtimeServerEventSessionCreated

Devuelven cuando se crea una sesión. Se emite automáticamente cuando se establece una nueva conexión como el primer evento del servidor. Este evento contendrá la configuración predeterminada de la sesión.

RealtimeServerEventSessionUpdated

Se devuelven cuando una sesión se actualiza con un session.update evento, salvo que haya un error.

Reasoning

Solo modelos GPT-5 y O-Series Opciones de configuración para modelos de razonamiento.

RecurrenceSchedule

Modelo de programación de periodicidad.

RecurrenceTrigger

Desencadenador basado en recurrencia.

RedTeam

Detalles del equipo rojo.

RedTeamTargetConfig

Clase abstracta para la configuración de destino.

ReminderPreviewToolboxTool

Una herramienta de recordatorio guardada en una caja de herramientas.

ResponseUsageInputTokensDetails

interfaz de modelo RespuestaUsoTokenEntradaDetalles

ResponseUsageOutputTokensDetails

interfaz de modelo RespuestaUsoTokenSalidaDetalles

ResponsesProtocolConfiguration

Configuración específica del protocolo de respuestas.

Routine

Una definición rutinaria devolvida por el servicio.

RoutineAction

Modelo base para una acción rutinaria.

RoutineAuthorization

Configuración opcional de autorización para un despacho rutinario.

RoutineDispatchPayload

Modelo base para una carga útil de despacho manual.

RoutineRun

Una única ejecución de rutina devolvía desde la API de historial de ejecuciones.

RoutineTrigger

Modelo base para un disparador rutinario.

RubricBasedEvaluatorDefinition

Definición de evaluador basada en rúbricas: almacena las dimensiones producidas por la API de generación. Se utiliza tanto para evaluadores de calidad como de seguridad.

RubricGenerationInputQualityWarning

Un aviso no fatal producido durante la generación del evaluador de rúbricas cuando las entradas resueltas son técnicamente válidas pero probablemente demasiado débiles para producir una rúbrica de alta calidad. Solo lectura; generado por servicio. Persistió con el terminal EvaluatorGenerationJob.

RunOperationState

Estado de operación para una operación de larga duración que crea un recurso de ejecución.

PERSONALIZACIÓN: MEJORA SDK: el sondeador emitido se resuelve a la carga útil terminal result de la ejecución, que no lleva identificador; runId mantiene la ejecución creada accesible.

SASTokenCredentials

Definición de credenciales de firma de acceso compartido (SAS)

SasCredential

Definición de credenciales de SAS

Schedule

Modelo de programación.

ScheduleRoutineTrigger

Un disparador recurrente basado en crons.

ScheduleRun

Programar modelo de ejecución.

ScheduleTask

Modelo de tareas de programación.

SessionConfiguration

Los valores predeterminados de sesión se aplican a sesiones creadas para una versión de agente alojada.

SessionDirectoryEntry

Una sola entrada en un listado de directorio.

SessionDirectoryListResponse

Respuesta a la publicación de un directorio en un sandbox de sesión.

SessionFileWriteResponse

Respuesta tras subir un archivo a un sandbox de sesión.

SessionLogEvent

Un único Server-Sent marco de evento emitido por el flujo de registro de sesión del agente alojado.

Cada trama contiene un event campo que identifica el tipo de evento y un data campo que transporta la carga útil como texto plano. Aunque la carga útil actual data está formateada en JSON, su esquema no es contractual: pueden aparecer claves adicionales y el formato puede cambiar con el tiempo. Los clientes deben tratar data como una cadena opaca y, opcionalmente, intentar analizar JSON.

En el futuro se pueden añadir nuevos tipos de eventos. Los clientes deben ignorar con elegancia los tipos de eventos no reconocidos.

Formato de cable:

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

Los parámetros de la herramienta de conexión a tierra de SharePoint.

SharepointPreviewTool

La información de definición de entrada de una herramienta de sharepoint como se usa para configurar un agente.

ShellToolboxTool

Una herramienta de carcasa guardada en una caja de herramientas. Este modelo es aditivo a la configuración de la caja de herramientas y no modifica el contrato de la herramienta OpenAI ni las definiciones existentes de la caja de herramientas.

SimpleQnADataGenerationJobOptions

Las opciones para un trabajo de generación de datos con el tipo SimpleQnA.

SimulationSeedDataGenerationJobOptions

Las opciones para un trabajo de generación de datos semilla en simulación. Úsalo con escenarios de evaluación multiturno y con fuentes de prompt, archivo o agente. Las filas de conjuntos generadas incluyen campos como id, category, test_case_description, y desired_num_turns.

SipTelephonyTransferDestination

Un destino SIP para un destino de transferencia telefónica.

Skill

Un recurso de habilidades.

SkillInlineContent

Contenido en línea para definir una habilidad sencilla sin subir archivos. Sigue la especificación agentskills.io SKILL.md.

SkillReference

(Avance) Una referencia a una habilidad versionada de Foundry.

SkillReferenceParam

interfaz de modelo SkillReferenceParam

SkillVersion

Una versión específica de una habilidad.

SpecificApplyPatchParam

Obliga al modelo a llamar a la herramienta apply_patch al ejecutar una llamada a herramienta.

SpecificFunctionShellParam

Obliga al modelo a llamar a la herramienta de shell cuando se requiere una llamada a herramienta.

SpecificProgrammaticToolCallingParam

interfaz de modelo EspecificaProgramáticaHerramientaLlamandoParam

StructuredInputDefinition

Una entrada estructurada que puede participar en sustituciones de plantillas de solicitud y enlace de argumentos de herramientas.

StructuredOutputDefinition

Salida estructurada que el agente puede generar.

TaskGenerationDataGenerationJobOptions

Opciones para el trabajo de generación de tareas heredadas, incluyendo el número máximo de muestras generadas.

TaxonomyCategory

Definición de categoría de taxonomía.

TaxonomySubCategory

Definición de subcategoría de taxonomía.

TeamsPhoneExtensionTelephonyBinding

Un enlace de extensión de Teléfono Microsoft Teams Extension propiedad de un agente de voz.

TeamsPhoneExtensionTelephonyBindingListItem

Una vinculación de Teléfono Microsoft Teams Extension devolvía en una lista, incluyendo su etiqueta de entidad.

TeamsTelephonyTransferDestination

Un destino de Microsoft Teams para un destino de transferencia telefónica.

TelemetryConfig

Configuración de telemetría suministrada por el cliente para exportar registros de contenedores, trazas y métricas.

TelemetryEndpoint

Una configuración de endpoint de exportación de telemetría.

TelemetryEndpointAuth

Configuración de autenticación para un endpoint de telemetría.

TelemetryOperations

Interfaz que representa las operaciones de telemetría

TelephonyBinding

Una vinculación telefónica propiedad de un agente de voz.

TelephonyBindingListItem

Un enlace de telefonía devuelvo en una lista, incluyendo su etiqueta de entidad.

TelephonyCallJob

Una intención de llamada saliente directa o creada por la campaña duradera.

TelephonyCallJobCancellation

Una solicitud de cancelación registrada para una llamada saliente.

TelephonyCallJobSchedule

La ventana de ejecución opcional para una llamada directa saliente.

TelephonyCallLifecycleEvent

Una observación duradera y limitada en el ciclo de vida de una llamada telefónica.

TelephonyCallRecord

Diagnósticos detallados para una llamada entrante duradera a un agente de voz.

TelephonyCallSummary

Un resumen de una llamada entrante duradera a un agente de voz.

TelephonyCallTiming

Tiempo detallado neutral respecto al proveedor para una llamada telefónica entrante.

TelephonyCallTrace

Correlación desde un registro duradero de llamadas telefónicas hasta su rastreo Foundry orientado al cliente.

TelephonyOutboundDestination

El destino de una llamada saliente.

TelephonyOutboundFixedIntervalRetryPolicy

Una política de reintentos con un intervalo fijo entre intentos de llamada saliente.

TelephonyOutboundRetryPolicy

La política de reintento para una intención duradera de llamada saliente. max_attempts incluye el primer intento. Los entornos específicos de la estrategia se definen por la política derivada.

TelephonyTransferDestination

Un destino para un destino de transferencia telefónica.

TelephonyTransferTarget

Un destino designado al que el agente de voz puede transferir una llamada.

TelephonyTransferTargets

Los objetivos de transferencia telefónica configurados para un solo agente de voz.

TextResponseFormat

Objeto que especifica el formato que debe generar el modelo. { "type": "json_schema" } La configuración habilita las salidas estructuradas, lo que garantiza que el modelo coincida con el esquema JSON proporcionado. Aprende más en la guía de Structured Outputs. El formato predeterminado es { "type": "text" } sin opciones adicionales. No recomendado para gpt-4o y modelos más recientes:* Configurar para { "type": "json_object" } activar el modo JSON antiguo, que asegura que el mensaje generado por el modelo sea JSON válido. Se prefiere usar json_schema para los modelos que lo admiten.

TextResponseFormatConfiguration

Configuración base para el formato de respuestas de texto generadas.

TextResponseFormatConfigurationResponseFormatJsonObject

Configura las respuestas generadas para usar el formato de objeto JSON.

TextResponseFormatConfigurationResponseFormatText

Configura las respuestas generadas para usar texto plano.

TextResponseFormatJsonObject

Formato de respuesta de objeto JSON. Un método anterior para generar respuestas JSON. Se recomienda usar json_schema para los modelos que lo admiten. Tenga en cuenta que el modelo no generará JSON sin un mensaje del usuario o del sistema que lo indique.

TextResponseFormatJsonSchema

Formato de respuesta del esquema JSON. Se usa para generar respuestas JSON estructuradas. Aprende más sobre Structured Outputs.

TextResponseFormatText

Formato de respuesta predeterminado. Se usa para generar respuestas de texto.

TimerRoutineTrigger

Un disparador de temporizador de un solo golpe.

Tool

Herramienta que se puede usar para generar una respuesta.

ToolChoiceAllowed

Restringe las herramientas disponibles para el modelo a un conjunto predefinido.

ToolChoiceCodeInterpreter

Indica que el modelo debe usar una herramienta integrada para generar una respuesta. Learn más sobre las herramientas integradas.

ToolChoiceComputer

Indica que el modelo debe usar una herramienta integrada para generar una respuesta. Learn más sobre las herramientas integradas.

ToolChoiceComputerUse

Indica que el modelo debe usar una herramienta integrada para generar una respuesta. Learn más sobre las herramientas integradas.

ToolChoiceComputerUsePreview

Indica que el modelo debe usar una herramienta integrada para generar una respuesta. Learn más sobre las herramientas integradas.

ToolChoiceCustom

Use esta opción para forzar al modelo a llamar a una herramienta personalizada específica.

ToolChoiceFileSearch

Indica que el modelo debe usar una herramienta integrada para generar una respuesta. Learn más sobre las herramientas integradas.

ToolChoiceFunction

Use esta opción para forzar al modelo a llamar a una función específica.

ToolChoiceImageGeneration

Indica que el modelo debe usar una herramienta integrada para generar una respuesta. Learn más sobre las herramientas integradas.

ToolChoiceMCP

Use esta opción para forzar al modelo a llamar a una herramienta específica en un servidor MCP remoto.

ToolChoiceParam

Cómo debe seleccionar el modelo qué herramienta (o herramientas) se van a usar al generar una respuesta. Consulte el tools parámetro para ver cómo especificar las herramientas a las que puede llamar el modelo.

ToolChoiceWebSearchPreview

Indica que el modelo debe usar una herramienta integrada para generar una respuesta. Learn más sobre las herramientas integradas.

ToolChoiceWebSearchPreview20250311

Indica que el modelo debe usar una herramienta integrada para generar una respuesta. Learn más sobre las herramientas integradas.

ToolConfig

Configuración por herramienta que controla la visibilidad de la herramienta y el comportamiento de búsqueda.

ToolDescription

Descripción de una herramienta que puede ser utilizada por un agente.

ToolProjectConnection

Un recurso de conexión project.

ToolSearchToolParam

Configuración de búsqueda de herramientas alojadas o BYOT para herramientas diferidas.

ToolSearchToolboxTool

Una herramienta de búsqueda de caja de herramientas almacenada en una caja de herramientas.

ToolUseFineTuningDataGenerationJobOptions

Las opciones para un trabajo de generación de datos con el tipo ToolUse. Se usa solo para ajustar escenarios finos.

ToolboxObject

Una caja de herramientas que almacena definiciones de herramientas reutilizables para agentes.

ToolboxPolicies

Configuración de políticas para una caja de herramientas, incluyendo seguridad de contenidos y otros ajustes de gobernanza.

ToolboxSearchPreviewToolboxTool

Una herramienta de búsqueda de caja de herramientas almacenada en una caja de herramientas.

ToolboxShellContainerAutoEnvironment

Un entorno de contenedor provisionado automáticamente para una herramienta shell almacenada en una caja de herramientas.

ToolboxShellContainerReferenceEnvironment

Un entorno de contenedor existente para una herramienta de carcasa almacenado en una caja de herramientas.

ToolboxShellEnvironment

Un entorno de ejecución para una herramienta shell almacenada en una caja de herramientas. Este modelo de entorno está adaptado a la configuración de caja de herramientas y no modifica el contrato de entorno de OpenAI en shell.

ToolboxShellNetworkPolicy

Política de acceso a la red para un contenedor shell de toolbox provisionado automáticamente.

ToolboxShellNetworkPolicyDisabled

Una política de red que deshabilita el acceso saliente desde un contenedor de shell toolbox.

ToolboxSkill

Una fuente de habilidades incluida en una caja de herramientas.

ToolboxSkillReference

Una referencia a una habilidad existente para incluir en una caja de herramientas.

ToolboxTool

Una representación abstracta de una herramienta almacenada en una caja de herramientas.

ToolboxVersionObject

Una versión específica de una caja de herramientas.

ToolboxVersions

Las versiones asociadas a una caja de herramientas.

ToolboxesCreateVersionOptionalParams

Parámetros opcionales.

ToolboxesDeleteOptionalParams

Parámetros opcionales.

ToolboxesDeleteVersionOptionalParams

Parámetros opcionales.

ToolboxesGetOptionalParams

Parámetros opcionales.

ToolboxesGetVersionOptionalParams

Parámetros opcionales.

ToolboxesInvokeLatestToolboxMcpOptionalParams

Parámetros opcionales.

ToolboxesListOptionalParams

Parámetros opcionales.

ToolboxesListVersionsOptionalParams

Parámetros opcionales.

ToolboxesOperations

Interfaz que representa las operaciones de una caja de herramientas.

ToolboxesUpdateOptionalParams

Parámetros opcionales.

TracesDataGenerationJobOptions

Las opciones para un trabajo de generación de datos con el tipo Traces.

TracesDataGenerationJobSource

Fuentes de trazas para trabajos de generación de datos — trazas de conversación de Application Insights.

TracesEvaluatorGenerationJobSource

Fuentes de trazas para trabajos de generación de evaluadores — trazos de conversación de Application Insights.

TranscriptTextUsageDuration

Estadísticas de uso para modelos facturadas por duración de entrada de audio.

TranscriptTextUsageTokens

Estadísticas de uso para modelos facturados por uso de token.

TranscriptTextUsageTokensInputTokenDetails

Interfaz del modelo TranscripciónTextoUsuariosTokensEntradaDetallesTokens

TranscriptionLanguage

Un idioma detectado en audio transcrito.

Trigger

Modelo base para el Disparador del horario.

TwilioTelephonyBinding

Una encuadernación Twilio propiedad de un agente de voz.

TwilioTelephonyBindingListItem

Una vinculación Twilio devolvía en una lista, incluyendo su etiqueta de entidad.

UpdateModelVersionRequest

Solicita al cuerpo la actualización de una versión del modelo. Solo se pueden modificar la descripción y las etiquetas.

UpdateTelephonyBindingRequest

La solicitud para actualizar una vinculación telefónica existente. Cada propiedad es opcional y el proveedor de la vinculación es inmutable.

UpdateToolboxRequest

interfaz de modelo UpdateToolboxRequest

UserProfileMemoryItem

Un elemento de memoria que contiene específicamente información de perfil de usuario extraída de conversaciones, como preferencias, intereses y datos personales.

VersionIndicator

Indicador de versión que determina qué versión del agente respalda la sesión.

VersionRefIndicator

Indicador de versión que hace referencia a una versión específica del agente por su nombre.

VersionSelectionRule

interfaz de modelo VersiónReglaSelección

VersionSelector

Interfaz de modelo VersionSelector

VoiceAgentAnimationConfig

Ajustes de animación para una sesión de agente de voz.

VoiceAgentAudioConfig

La configuración de audio para un agente de voz. Estos valores son valores predeterminados de la sesión y pueden ser anulados al conectarse.

VoiceAgentAudioInputConfig

Configuración de audio de entrada para un agente de voz.

VoiceAgentAudioOutputConfig

Configuración de audio de salida para un agente de voz. Los campos específicos del proveedor se seleccionan por:voice_type

  • openai: voice y speed.
  • azure-standard: voice, voice_locale, speed, voice_temperature, custom_lexicon_url, custom_text_normalization_url, prefer_locales, style, , pitch, , y volume.
  • azure-custom: todos los azure-standard cuerpos excepto style, más custom_voice_endpoint_id.
  • azure-personal: todos los azure-standard cuerpos excepto style, más personal_voice_model.
  • avatar-voice-sync: todos los azure-standard campos excepto voice y style, más personal_voice_model; el nombre de la voz deriva del avatar.
  • azure-realtime-native: voice y speed. format y output_audio_timestamp_types aplica a todos los tipos de voz.
VoiceAgentAvatarConfig

Configuración de avatar para un agente de voz. Estos valores son valores predeterminados de la sesión y pueden ser anulados al conectarse.

VoiceAgentAvatarIceServer

Un servidor ICE utilizado para la negociación de avatares WebRTC.

VoiceAgentAvatarScene

Colocación del avatar y ajustes de movimiento.

VoiceAgentAvatarVideoBackground

El fondo del vídeo del avatar.

VoiceAgentAvatarVideoCrop

El recorte rectangular aplicado al vídeo avatar.

VoiceAgentAvatarVideoParams

Codificador de vídeo Avatar y ajustes de presentación.

VoiceAgentAvatarVideoResolution

La resolución del vídeo avatar.

VoiceAgentAzureSemanticVadEnTurnDetection

Detección de actividad semántica de voz en Azure optimizada para inglés.

VoiceAgentAzureSemanticVadMultilingualTurnDetection

Detección de actividad semántica de voz en Azure multilingüe.

VoiceAgentAzureSemanticVadTurnDetection

Detección de actividad semántica de voz en Azure.

VoiceAgentCancelResponseOptions

Opciones para cancelar una respuesta.

VoiceAgentClientEventRtcCallSdpCreate

El rtc.call.sdp.create evento con clientes: comienza la señalización de WebRTC con una oferta SDP.

VoiceAgentClientEventSessionAvatarConnect

El session.avatar.connect evento con el cliente.

VoiceAgentClientEventSessionUpdate

El session.update evento con el cliente.

VoiceAgentCloseResult

Resultado proporcionado cuando se cierra la conexión entre voz y agente.

VoiceAgentConnection

Un flujo de voz bidireccional y conectado.

Soporta exactamente una for await iteración sobre eventos del servidor; un segundo intento lanza. Salir del bucle antes de tiempo (break, return, o un error no detectado en el cuerpo del bucle) cierra la conexión como efecto secundario. Los tipos de eventos de servidor no reconocidos se entregan como VoiceAgentUnknownEvent sin interrumpir la transmisión. Los eventos malformados siguen fallando la iteración con un error de protocolo.

VoiceAgentDefinition

La definición de agente de voz. Su configuración (modelo, instrucciones, audio, herramientas y avatar opcional) impulsa una experiencia gestionada de voz a voz. Establece sesiones de voz en tiempo real a través GET /agents/{agent_name}/endpoint/protocols/voicede . Cada creación o actualización produce una nueva versión inmutable.

VoiceAgentEchoCancellation

Ajustes de cancelación de eco en el lado del servidor para el audio de entrada.

VoiceAgentEndConversationSystemTool

Un control gestionado por servicios que termina la conversación activa.

VoiceAgentEndOfUtteranceDetection

Configuración semántica de detección de fin de enunciado.

VoiceAgentEventOptions

Opciones compartidas por las operaciones que generan un evento de protocolo en nombre del llamante.

VoiceAgentFunctionTool

Una herramienta de función nativa ejecutada por el cliente.

VoiceAgentGreetingConfig

Configuración de saludo de inicio de sesión para un agente de voz.

VoiceAgentInputTranscription

Configuración asíncrona de transcripción de audio de entrada. Extiende las opciones de transcripción en tiempo real de OpenAI con los modelos de transcripción de Azure y MAI, modelos de voz personalizados y consejos de frase.

VoiceAgentInterimResponseConfig

Campos compartidos por configuraciones de respuesta intermedia.

VoiceAgentLlmGeneratedGreetingConfig

Un saludo creado por el modelo de sesión a partir de un prompt de apertura con alcance definido.

VoiceAgentLlmInterimResponseConfig

Una respuesta intermedia generada por un modelo de lenguaje.

VoiceAgentMcpTool

Una herramienta MCP disponible para un agente de voz.

VoiceAgentNoiseReduction

Configuración de reducción de ruido de audio de entrada.

VoiceAgentRealtimeClientConnectOptions

Opciones para conectar el cliente en tiempo real a un agente de voz.

VoiceAgentRealtimeClientOptions

Opciones para el cliente en tiempo real de Voice Agents.

VoiceAgentRealtimeResponse

Una respuesta en tiempo real en directo devuelto por el servicio de agente de voz en ambos response.createdresponse.done eventos.

VoiceAgentRealtimeResponseBase

Propiedades compartidas por respuestas en tiempo real devueltas por el servicio de agente de voz.

VoiceAgentResponseCreateParams

Parámetros aceptados por un evento de agente response.create de voz.

VoiceAgentResponseOptions

Opciones para crear una respuesta.

VoiceAgentRtcCallErrorDetails

Detalles de un error de señalización WebRTC.

VoiceAgentSemanticVadTurnDetection

Configuración semántica de detección de giro VAD de OpenAI.

VoiceAgentSendItemOptions

Opciones compartidas por operaciones que añaden un elemento de conversación y, por defecto, solicitan una respuesta.

VoiceAgentSendOptions

Opciones compartidas por operaciones de envío en tiempo real.

VoiceAgentSendTextOptions

Opciones para enviar entrada de texto.

VoiceAgentSendToolOutputOptions

Opciones para devolver un resultado de función.

VoiceAgentServerEventResponseAnimationBlendshapesDelta

El response.animation_blendshapes.delta evento del servidor.

VoiceAgentServerEventResponseAnimationBlendshapesDone

El response.animation_blendshapes.done evento del servidor.

VoiceAgentServerEventResponseAnimationVisemeDelta

El response.animation_viseme.delta evento del servidor.

VoiceAgentServerEventResponseAnimationVisemeDone

El response.animation_viseme.done evento del servidor.

VoiceAgentServerEventResponseAudioTimestampDelta

El response.audio_timestamp.delta evento del servidor.

VoiceAgentServerEventResponseAudioTimestampDone

El response.audio_timestamp.done evento del servidor.

VoiceAgentServerEventResponseVideoDelta

El response.video.delta evento del servidor.

VoiceAgentServerEventRtcCallError

El rtc.call.error evento del servidor: fallo de señalización WebRTC.

VoiceAgentServerEventRtcCallSdpCreated

El rtc.call.sdp.created evento del servidor: la respuesta SDP que completa la negociación de WebRTC.

VoiceAgentServerEventSessionAvatarConnecting

El session.avatar.connecting evento del servidor.

VoiceAgentServerEventSessionAvatarSwitchToIdle

El session.avatar.switch_to_idle evento del servidor.

VoiceAgentServerEventSessionAvatarSwitchToSpeaking

El session.avatar.switch_to_speaking evento del servidor.

VoiceAgentServerEventSessionSubagentAborted

El session.subagent.aborted evento del servidor.

VoiceAgentServerEventSessionSubagentCompleted

El session.subagent.completed evento del servidor.

VoiceAgentServerEventSessionSubagentStarted

El session.subagent.started evento del servidor.

VoiceAgentServerEventWarning

El warning evento del servidor.

VoiceAgentServerEventWarningDetails

Detalles de una advertencia no fatal.

VoiceAgentServerVadTurnDetection

Detección de actividad de voz en el servidor.

VoiceAgentSessionAvatarConfig

Configuración de Avatar aceptada por el contrato estable de agente de voz WebSocket.

VoiceAgentSessionResponseConfig

Los ajustes estables de sesión en tiempo real efectivos devueltos por el servicio de agente de voz.

VoiceAgentSessionUpdateConfig

La configuración estable de sesión en tiempo real aceptada en un session.update evento cliente.

VoiceAgentSessionUpdateOptions

Opciones para actualizar la sesión en directo.

VoiceAgentStaticInterimResponseConfig

Una respuesta interina estática seleccionada de texto configurado.

VoiceAgentSubagent

Un agente de texto hermano de Foundry al que un agente de voz puede consultar como especialista en segundo plano.

VoiceAgentSubagentConfig

Configuración para agentes de texto hermanos de Foundry que un agente de voz puede consultar.

VoiceAgentSubagentResponsePolicy

Política para entregar respuestas mientras un agente de voz espera a un subagente.

VoiceAgentSystemTool

Un control gestionado por servicios que actúa sobre la sesión de voz activa sin código del cliente ni autenticación externa.

VoiceAgentTemplateGreetingConfig

Un saludo determinista renderizado con las entradas estructuradas del agente de voz y sintetizado sin generación creada por el modelo.

VoiceAgentTool

Una herramienta que puede usar un agente de voz.

VoiceAgentToolboxTool

Una referencia a una caja de herramientas Foundry, que es un conjunto versionado de herramientas ejecutado a través de su endpoint MCP.

VoiceAgentTranscriptionPhrase

Una frase transcrita con información de tiempo.

VoiceAgentTranscriptionWord

Una palabra con marca de tiempo en una transcripción de audio de entrada.

VoiceAgentTurnDetectionConfig

Configuración de detección de giro para un agente de voz.

VoiceAgentUnknownEvent

Un evento de servidor cuyo tipo de cable no es reconocido por esta versión del SDK.

El SDK entrega estos eventos sin cerrar la conexión ni aplicar validación o normalización de eventos conocidos. Inspecciona y valida los campos en bruto antes de usarlos.

VoiceAgentWebSocketConnectOptions

Las opciones pasaron a VoiceAgentWebSocketTransport.connect.

VoiceAgentWebSocketFactory

Crea instancias de VoiceAgentWebSocketTransport para VoiceAgentRealtimeClient.

VoiceAgentWebSocketHandlers

Llamadas de devolución invocadas por un VoiceAgentWebSocketTransport cuando ocurren eventos de conexión.

VoiceAgentWebSocketTransport

Un transporte WebSocket enchufable utilizado por VoiceAgentRealtimeClient. Implementa esta interfaz para personalizar cómo se establece la conexión en tiempo real, por ejemplo, para enrutarla a través de un relé autenticado.

VoiceAudioItem

Metadatos para el segmento de audio de un solo elemento de conversación. Para el almacenamiento de traer tu propio (BYOS), la respuesta incluye blob_uri, un URI de almacenamiento directo del cliente sin token SAS, al que el cliente accede con sus propias credenciales. Para el almacenamiento gestionado por Foundry, blob_uri está ausente y los bytes se transmiten a través de la ruta del /audio/content elemento.

VoiceConversation

Una conversación persistente de voz. El sobre de Foundry que posee la transcripción almacenada de un agente de voz, respuestas, métricas por turno y audio. Es el límite padre, retención y eliminación: eliminarlo se propaga en cascada a sus respuestas, elementos, métricas y audio. Cuando la finalización falla, cualquier respuesta parcial persistente, elementos y audio del ítem permanecen legibles.

VoiceConversationEngine

Un motor que maneja conversaciones para un agente de voz.

VoiceGeneratedAudioItem

Metadatos del audio generado por un elemento de conversación. Para el almacenamiento de traer tu propio (BYOS), la respuesta incluye blob_uri, un URI de almacenamiento directo del cliente sin token SAS, al que el cliente accede con sus propias credenciales. Para el almacenamiento gestionado por Foundry, blob_uri está ausente y los bytes se transmiten a través de la ruta del /audio/generated/content elemento.

VoiceHostedAgentConversationEngine

Una referencia cerrada al agente de texto alojado que gestiona la conversación para un agente de voz. El agente alojado se resuelve dentro del mismo proyecto y debe soportar el invocations_ws protocolo, la compatibilidad con Voice Live y el Protocolo Bridge 1.0.

VoiceRecording

Metadatos para la grabación estéreo combinada de toda la llamada de una conversación de voz (audio del usuario en el canal izquierdo, audio del agente en el derecho). Se construye una vez a partir de los segmentos por turno tras la sesión y se almacena en caché de forma duradera. Los metadatos comunes (formato, frecuencia de muestreo, canales, disposición del canal, duración) se devuelven tanto para grabaciones gestionadas por Foundry como para grabaciones de traer su propio almacenamiento (BYOS). Para BYOS, la respuesta también incluye blob_uri, el URI de la grabación en el almacenamiento propio del cliente (sin token SAS), que el cliente descarga usando sus propias credenciales de almacenamiento. Para Foundry, el almacenamiento blob_uri gestionado por Foundry no está disponible y los bytes se transmiten en streaming a través de la /audio/content ruta en su lugar.

VoiceRecordingChannelLayout

El papel asignado a cada canal de una grabación de voz estéreo fusionada.

VoiceResponse

Una respuesta de voz persistente que representa un giro de inferencia de modelo dentro de una conversación. En los resultados de la lista la output proyección puede omitirse; recuperar la respuesta completa (GET .../responses/{response_id}) o la ruta de los ítems de respuesta paginados (GET .../responses/{response_id}/items) para sus elementos de salida. created_at / completed_at son extensiones duraderas de ordenación de Foundry.

VoiceResponseAudio

Configuración de audio para una respuesta. Sigue la forma del objeto OpenAI Realtime GA audio .

VoiceResponseAudioOutput

La proyección de salida de audio de respuesta plana, con opciones voice, voice_type, voice_locale, y format campos.

VoiceResponseBase

Propiedades compartidas por respuestas de voz persistentes.

WebIQPreviewTool

Una herramienta WebIQ para el lado del servidor.

WebIQPreviewToolboxTool

Una herramienta WebIQ almacenada en una caja de herramientas.

WebSearchApproximateLocation

La ubicación aproximada del usuario.

WebSearchConfiguration

Una configuración de búsqueda web para bing búsqueda personalizada

WebSearchPreviewTool

Esta herramienta busca en la web resultados relevantes para usar en una respuesta. Obtenga más información sobre la herramienta de búsqueda web.

WebSearchTool

Busca en Internet fuentes relacionadas con el tema. Obtenga más información sobre la herramienta de búsqueda web.

WebSearchToolFilters

interfaz de modelosWebSearchToolFilters

WebSearchToolboxTool

Una herramienta de búsqueda web almacenada en una caja de herramientas.

WeeklyRecurrenceSchedule

Calendario de recurrencia semanal.

WorkIQPreviewTool

Una herramienta WorkIQ para el lado del servidor.

WorkIQPreviewToolboxTool

Una herramienta WorkIQ guardada en una caja de herramientas.

WorkflowAgentDefinition

La definición del agente de flujo de trabajo.

Alias de tipos

A2AProtocolVersion

Versiones compatibles con el protocolo A2A.

ActivityProtocolAccessBoundary

Un límite de acceso para el protocolo de actividad.

AgentBlueprintReferenceType

Tipo de AgentTipo de ReferenciaModelo de Trabajo

AgentBlueprintReferenceUnion

Alias para AgentBlueprintReferenceUnion

AgentDefinitionOptInKeys

Claves de opt-in para funciones de definición de agentes que soportan funciones de vista previa condicional.

AgentDefinitionUnion

Tipo de unión para todos los tipos de definición de agente. Soporta flujo de trabajo, alojado, aplicación de contenedores, prompt y agentes externos.

AgentEndpoint

Configuración para enrutamiento, protocolos y autorización en un punto final de agente.

AgentEndpointAuthorizationSchemeType

Tipo de AgentEndpointAuthorizationSchemeType

AgentEndpointAuthorizationSchemeUnion

Alias para AgentEndpointAuthorizationSchemeUnion

AgentHarnessUnion

Alias para AgentHarnessUnion

AgentIdentityStatus

El estado de la identidad de un agente, aplicable tanto a la identidad de instancia del agente como al blueprint del agente.

AgentInsightJsonValue

Un valor JSON utilizado en las cargas útiles de Agent Insights.

AgentInsightOverviewSource

Identifica de dónde proviene una visión general de Agent Insights.

AgentInsightPromptSurface

La superficie del Prompt cambió por una solución propuesta.

AgentInsightProposedFixKind

El tipo de solución propuesta por un agente que puede renderizar el cliente.

AgentInsightRunTrigger

El detonante que inició una misión de Agent Insight.

AgentInsightSeverity

La gravedad de la visión de un agente.

AgentInsightStatus

El estado del ciclo de vida de una visión de un agente.

AgentKind

Define el tipo / tipo de agente. Determina qué estructura de definición de agente se utiliza.

AgentOptimizationDatasetInputType

Valores discriminadores para la unión de entrada del conjunto de datos.

AgentOptimizationDatasetInputUnion

Alias para AgentOptimizationDatasetInputUnion

AgentProtocol

Tipo de AgentProtocol

AgentSessionStatus

El estado de una sesión de agentes.

AgentState

El estado operativo de un agente.

AgentStateSource

Indica la fuente del estado operativo del agente. Vacío cuando el estado no se deriva de una fuente específica.

AgentType

Tipo de AgentType

AgentVersionStatus

El estado de aprovisionamiento de una versión agente.

AgentsDownloadAgentCodeResponse

El archivo ZIP descargado que contiene el código agente alojado, expuesto como un Blob del navegador o Node.js flujo legible.

AgentsDownloadSessionFileResponse

El archivo de sesión del agente descargado, expuesto como un Blob del navegador o Node.js flujo legible.

AgentsPatchAgentObjectOptionalParams

Parámetros opcionales.

AttackStrategy

Estrategias para los ataques.

AzureAISearchQueryType

Tipos de consulta disponibles para la herramienta Búsqueda de Azure AI.

BaseCredentialsUnion

Alias de BaseCredentialsUnion

BetaSkillsDownloadResponse

El archivo ZIP de la versión predeterminada de una habilidad, expuesto como un Blob de navegador o Node.js flujo legible.

BetaVoiceAgentsConversationsDownloadAudioItemResponse

El audio WAV de un elemento de conversación, expuesto como un Blob del navegador o Node.js flujo legible.

BetaVoiceAgentsConversationsDownloadAudioResponse

La grabación WAV estéreo fusionada de una conversación de voz, expuesta como un Blob de navegador o un flujo legible Node.js.

BetaVoiceAgentsConversationsDownloadGeneratedAudioItemResponse

El audio WAV generado para un elemento de conversación interrumpida, expuesto como un Blob del navegador o un flujo legible Node.js.

CallableToolAllowedCaller

Tipo de Llamador CallableToolAllowedCaller

CodeDependencyResolution

Cómo se resuelven las dependencias de paquetes en el momento del despliegue para un agente alojado basado en código.

ComparisonFilterValueItems

Alias para ComparaciónFilterValueItems

ComputerEnvironment

Tipo de Entorno Informático

ConnectionType

Tipo (o categoría) de la conexión

ContainerMemoryLimit

Tipo de ContainerMemoryLimit

ContainerNetworkPolicyParamType

Tipo de ContainerNetworkPolicyParamType

ContainerNetworkPolicyParamUnion

Alias para ContainerNetworkPolicyParamUnion

ContainerSkillType

Tipo de ContainerSkillType

ContainerSkillUnion

Alias para ContainerSkillUnion

ContinuablePage

Interfaz que describe una página de resultados.

CreateTelephonyBindingRequestUnion

Alias para CreateTelephonyBindingRequestUnion

CreateTranscriptionResponseJsonUsageType

Tipo de CrearRespuestaJsonUsoTipo

CreateTranscriptionResponseJsonUsageUnion

Alias para CreateTranscriptionResponseJsonUsageUnion

CredentialType

El tipo de credencial utilizado por la conexión

CustomToolParamFormatType

Tipo de CustomToolParamFormatType

CustomToolParamFormatUnion

Alias para CustomToolParamFormatUnion

DataGenerationJobOptionsUnion

Alias para DataGenerationJobOptionsUnion

DataGenerationJobOutputType

Los tipos de archivo de salida soportados para un trabajo de generación de datos.

DataGenerationJobOutputUnion

Alias para DataGenerationJobOutputUnion

DataGenerationJobOutputWriteMode

Los modos de escritura soportados para la generación de datos de trabajos de salida.

DataGenerationJobScenario

Los escenarios soportados para un trabajo de generación de datos.

DataGenerationJobSourceType

Los tipos de código soportados para trabajos de generación de datos.

DataGenerationJobSourceUnion

Alias para DataGenerationJobSourceUnion

DataGenerationJobType

Los tipos de trabajo de generación de datos soportados.

DatasetType

Enumeración para determinar el tipo de datos.

DatasetVersionUnion

Alias de DatasetVersionUnion

DayOfWeek

Días de la semana para el programa de recurrencia.

DeploymentType

Tipo de implementaciónTipo

DeploymentUnion

Alias de DeploymentUnion

DigitalWorkerType

El tipo de trabajador digital.

DownloadVersionResponse

El archivo ZIP de una versión de habilidad especificada, expuesto como un Blob de navegador o Node.js flujo legible.

EvaluationLevel

El nivel en el que se realiza la evaluación.

EvaluationRuleActionType

Tipo de acción de evaluación.

EvaluationRuleActionUnion

Alias de EvaluationRuleActionUnion

EvaluationRuleEventType

Tipo de evento de regla de evaluación.

EvaluationTargetUnion

Alias para EvaluationTargetUnion

EvaluationTaxonomyInputType

Tipo de entrada de la taxonomía de evaluación.

EvaluationTaxonomyInputUnion

Alias de EvaluationTaxonomyInputUnion

EvaluatorCategory

La categoría del evaluador

EvaluatorDefinitionType

El tipo de definición del evaluador

EvaluatorDefinitionUnion

Alias de EvaluatorDefinitionUnion

EvaluatorGenerationJobSourceType

Los tipos de código soportados para trabajos de generación de evaluadores.

EvaluatorGenerationJobSourceUnion

Alias para EvaluatorGenerationJobSourceUnion

EvaluatorMetricDirection

La dirección de la métrica que indica si un valor más alto es mejor, un valor más bajo es mejor o neutral

EvaluatorMetricType

El tipo de evaluador

EvaluatorType

El tipo de evaluador

FileContents

Valores válidos para el contenido de un archivo binario.

Filters

Alias para filtros

FoundryFeaturesOptInKeys

Tipo de FoundryCaracterísticasOptInKeys

FoundryModelArtifactProfileCategory

La categoría de perfil de artefactos.

FoundryModelArtifactProfileSignal

Señales detectadas en el artefacto del modelo.

FoundryModelSourceType

El tipo de origen del modelo.

FoundryModelWarningCode

Código de advertencia para artefactos de modelos.

FoundryModelWeightType

El tipo de peso del modelo.

FunctionShellToolParamEnvironmentType

Tipo de FunciónShellToolParamEntornoTipo

FunctionShellToolParamEnvironmentUnion

Alias para FunctionShellToolParamEnvironmentUnion

GenerateAgentRequest

Las entradas específicas de tipo para generar y crear un agente.

GenerationWarningType

La categoría de una advertencia apareció en una versión generada por evaluador. Extensible para que se puedan introducir nuevas categorías de advertencia (por ejemplo, seguridad, calidad de salida) sin ningún cambio interrumpido.

GetMicrosoft365PackageResponse

El paquete binario de la aplicación Microsoft 365 generado para un agente de Foundry.

GitHubCopilotBuiltInTool

Una herramienta integrada de GitHub Copilot configurable por el cliente.

GitHubIssueEvent

Eventos conocidos de GitHub emiten que pueden activar una rutina.

GrammarSyntax

Tipo de gramáticaSintaxis

ImageGenAction

Tipo de ImageGenAction

IndexType

Tipo de IndexType

IndexUnion

Alias de IndexUnion

InputFidelity

Controlar cuánto esfuerzo ejercerá el modelo para que coincida con el estilo y las características, especialmente las características faciales, de las imágenes de entrada. Este parámetro solo es compatible con y gpt-image-1gpt-image-1.5 modelos posteriores, no soportados para gpt-image-1-mini. Admite high y low. Tiene como valor predeterminado low.

InsightRequestUnion

Alias de InsightRequestUnion

InsightResultUnion

Alias de InsightResultUnion

InsightSampleUnion

Alias de InsightSampleUnion

InsightType

La solicitud de las ideas.

JobPoller

Un encuestador para una operación de larga duración que crea un recurso de empleo.

JobStatus

Valores de estatus extensibles compartidos por los trabajos de fundición.

MemoryItemKind

Tipo de elemento de memoria.

MemoryItemUnion

Alias de MemoryItemUnion

MemoryOperationKind

Tipo de operación de memoria.

MemoryStoreDefinitionUnion

Alias de MemoryStoreDefinitionUnion

MemoryStoreKind

El tipo de implementación del almacén de memoria que se va a usar.

MemoryStoreType

Tipo de MemoryStoreType

MemoryStoreUpdateStatus

Estado de una operación de actualización del almacén de memoria.

Microsoft365PublishScope

El alcance de publicación para la aplicación generada de Microsoft Teams.

MisalignmentErrorType

Una clasificación de una acción que puede no coincidir con la intención del usuario. Se pueden devolver valores adicionales.

NodeReadableStream

Escribe alias para Node.js ReadableStream. En los objetivos Node esto se resuelve al tipo NodeJS.ReadableStream real. En los objetivos de navegador/react-native, la variante de plataforma se resuelve a never, que desaparece naturalmente de los tipos union.

OpenApiAuthDetailsUnion

Alias de OpenApiAuthDetailsUnion

OpenApiAuthType

Tipo de autenticación para el punto de conexión de OpenApi. Los tipos permitidos son:

  • Anónimo (no se requiere autenticación)
  • Project Conexión (requiere project_connection_id para terminar, tal como se configura en AI Foundry)
  • Managed_Identity (requiere audiencia para la autenticación basada en identidad)
OperationState

Enumeración que describe los estados de operación permitidos.

OptimizationAgentIdentifier

Identifica el agente registrado de Foundry y la versión opcional a optimizar.

OptimizationCandidate

Los cambios de configuración y los resultados agregados de evaluación para un candidato a optimización de agentes.

OptimizationDatasetCriterion

Una instrucción de evaluación nombrada utilizada para puntuar un ítem de un conjunto de datos de optimización.

OptimizationDatasetInput

La descripción base de un conjunto de datos en línea o registrado proporcionado a un trabajo de optimización de agentes.

OptimizationDatasetInputType

Las formas soportadas para la entrada de datos de optimización: elementos en línea o una referencia registrada del conjunto de datos.

OptimizationDatasetInputUnion

Un conjunto de datos de optimización proporcionado como elementos en línea o una referencia a un conjunto de datos registrado en Foundry.

OptimizationDatasetItem

Un elemento de conjunto de datos de optimización en línea que contiene una consulta, respuesta esperada y criterios de evaluación.

OptimizationEvaluatorRef

Una referencia a un evaluador por nombre y versión opcional para un trabajo de optimización de agentes.

OptimizationInlineDatasetInput

Los elementos del conjunto de datos de optimización se proporcionan directamente en el cuerpo de la solicitud.

OptimizationJob

Un trabajo de optimización de agentes que rastrea entradas, progreso, estado y resultados de evaluación de candidatos.

OptimizationJobInputs

El agente, los conjuntos de datos, los evaluadores y las opciones proporcionados a un trabajo de optimización de agentes.

OptimizationJobListItem

Un resumen de un trabajo de optimización de agente devuelto por una operación de lista.

OptimizationJobProgress

Una instantánea de progreso que contiene los recuentos de candidatos completados, la mejor puntuación y el tiempo de ejecución transcurrido.

OptimizationJobResult

Los candidatos evaluados e identificadores de la línea base y mejor candidato de un puesto de optimización.

OptimizationOptions

Configuraciones que controlan la generación de candidatos, selección de modelos y evaluación para un trabajo de optimización de agentes.

OptimizationReferenceDatasetInput

Una referencia a un conjunto de datos registrado de Foundry por nombre y versión opcional para optimización de agentes.

PageOrder

Tipo de orden de página

PendingUploadType

El tipo de carga pendiente.

PublishApprovalStatus

El estado de revisión de la Certificación de Agente Microsoft sobre el título de la tienda Microsoft 365 publicado para un agente.

RaiInvocationContentType

Cómo se analiza el cuerpo de una solicitud/respuesta de invocación para localizar el texto y la regulación de seguridad de contenido.

RaiInvocationMode

Forma de respuesta declarada por el autor para el protocolo de invocaciones.

RankerVersionType

Tipo de RankerVersionType

RealtimeAudioFormatsType

Tipo de RealtimeAudioFormatosType

RealtimeAudioFormatsUnion

Alias para RealtimeAudioFormatsUnion

RealtimeClientEventType

Tipo de RealtimeClientEventType

RealtimeClientEventUnion

Alias para RealtimeClientEventUnion

RealtimeConversationItemMessageType

Tipo de Tipo de MensajeConversaciónEn Tiempo Real

RealtimeConversationItemMessageUnion

Alias para RealtimeConversationItemMessageUnion

RealtimeConversationItemType

Tipo de Tipo de ConversaciónRealTipo

RealtimeConversationItemUnion

Alias para RealtimeConversationItemUnion

RealtimeFunctionToolParameters

interfaz de modelo RealtimeFunctionToolParameters

RealtimeMCPErrorType

Tipo de RealtimeMCPErrorType

RealtimeMCPErrorUnion

Alias para RealtimeMCPErrorUnion

RealtimeReasoningEffort

Restringe el esfuerzo en el razonamiento para modelos en tiempo real capaces de razonar como gpt-realtime-2.

RealtimeServerEventType

Tipo de RealtimeServerEventType

RealtimeServerEventUnion

Alias para RealtimeServerEventUnion

ReasoningEffort

Restringe el esfuerzo en el razonamiento de los modelos de razonamiento. Los valores actualmente soportados son none, minimal, low, medium, high, y xhigh. Reducir el esfuerzo de razonamiento puede dar lugar a respuestas más rápidas y menos tokens usados en el razonamiento en una respuesta.

  • gpt-5.1 por defecto es none, que no realiza razonamiento. Los valores de razonamiento soportados para gpt-5.1 son none, low, medium, y high. Las llamadas a herramientas se admiten para todos los valores de razonamiento en gpt-5.1.
  • Todos los modelos anteriores gpt-5.1 por defecto a medium un esfuerzo de razonamiento, y no soportan none.
  • El gpt-5-pro modelo se basa por defecto (y solo soporta) high el esfuerzo de razonamiento.
  • xhigh se soporta para todos los modelos posteriores gpt-5.1-codex-maxa .
ReasoningModeEnum

Alias para ReasoningModeEnum

RecurrenceScheduleUnion

Alias de RecurrenceScheduleUnion

RecurrenceType

Tipo de recurrencia.

RedTeamTargetConfigUnion

Alias para RedTeamTargetConfigUnion

RiskCategory

Categoría de riesgo para el objetivo del ataque.

RoutineActionType

Los valores discriminadores soportados para acciones rutinarias.

RoutineActionUnion

Alias de RoutineActionUnion

RoutineAttemptSource

Rutas de fuente conocidas que pueden producir una ejecución rutinaria.

RoutineDispatchIdentity

Las identidades soportadas para la autorización rutinaria de despacho.

RoutineDispatchPayloadType

Los valores discriminadores soportados para cargas útiles de despacho manual rutinario.

RoutineDispatchPayloadUnion

Alias para RoutineDispatchPayloadUnion

RoutineRunPhase

Fases conocidas del ciclo de vida registradas para una ejecución rutinaria.

RoutineRunStatus

El estado de una carrera rutinaria.

RoutineTriggerType

Los valores discriminadores soportados para disparadores rutinarios.

RoutineTriggerUnion

Alias para RoutineTriggerUnion

RubricGenerationInputQualityWarningCode

Código de advertencia estable y lector por máquina para una advertencia de calidad de entrada generada por rúbricas. Los valores son snake_case; los clientes deben tolerar identificadores adicionales definidos por el servicio.

RubricGenerationInputQualityWarningSeverity

Advertencia de severidad para una advertencia de calidad de entrada por generación de rúbricas. Conjunto inicial de valores: warning.

RubricGenerationInputQualityWarningSource

Advertencia atribución de fuente para una advertencia de calidad de entrada por generación de rúbricas. Los valores por fuente (prompt, agent, dataset) coinciden con la categoría de fuente visible en el tiempo de ejecución de generación. aggregate es un valor sintético usado únicamente para advertencias calculadas entre fuentes resueltas con éxito. traces no se expone porque las fuentes traza se resuelven en contenido del conjunto de datos aguas arriba.

RunPoller

Un encuestador para una operación de larga duración que crea un recurso de ejecución.

SampleType

El tipo de muestra utilizada en el análisis.

ScheduleProvisioningStatus

Programar el estado de aprovisionamiento.

ScheduleTaskType

Tipo de la tarea.

ScheduleTaskUnion

Alias para ScheduleTaskUnion

SearchContentType

Tipo de SearchContentType

SearchContextSize

Tipo de búsquedaContextoTamaño

SessionLogEventType

Tipos de eventos SSE conocidos emitidos por el flujo de registro de sesión del agente alojado. En futuras versiones podrían introducirse tipos de eventos adicionales.

SimpleQnAFineTuningQuestionType

Los tipos de preguntas soportados para trabajos de generación de datos en SimpleQnA usados para ajustar escenarios finos.

TelemetryDataKind

El tipo de datos de telemetría que hay que exportar.

TelemetryEndpointAuthType

El tipo de autenticación para un endpoint de telemetría.

TelemetryEndpointAuthUnion

Alias para TelemetryEndpointAuthUnion

TelemetryEndpointKind

Del tipo de endpoint de exportación de telemetría.

TelemetryEndpointUnion

Alias para TelemetryEndpointUnion

TelemetryTransportProtocol

El protocolo de transporte para la exportación de telemetría.

TelephonyBindingListItemUnion

Alias for TelephonyBindingListItemUnion

TelephonyBindingStatus

El estado del ciclo de vida de una vinculación telefónica.

TelephonyBindingUnion

Alias para TelephonyBindingUnion

TelephonyCallDurationBasis

La marca de tiempo utilizada como base para la duración de la llamada.

TelephonyCallEndReason

Razones conocidas generadas por el servicio que terminaron una llamada telefónica, en lugar de razones para una llamada saliente general. Se pueden devolver códigos de cadena adicionales.

TelephonyCallJobStatus

El estado de vida de un trabajo duradero de llamadas salientes.

TelephonyCallJobTerminalReason

Razones terminales conocidas para un trabajo general de llamada saliente, que puede abarcar varios intentos de proveedores. Estas son distintas de las razones del ciclo de vida de las llamadas individuales. Se pueden devolver códigos de cadena adicionales.

TelephonyCallLifecycleEventName

Un nombre de evento de ciclo de vida neutral respecto al proveedor. Los valores conocidos son estables; con el tiempo se pueden añadir valores adicionales.

TelephonyCallLifecycleEventOutcome

El resultado de una observación del ciclo de vida de la telefonía.

TelephonyCallLifecycleEventReason

Razones conocidas generadas por el servicio para un evento del ciclo de vida de la telefonía. Una razón de evento no describe necesariamente el resultado final de la llamada. Se pueden devolver códigos de cadena adicionales.

TelephonyCallLifecycleEventSource

El componente que proporcionaba una observación del ciclo de vida de la telefonía.

TelephonyCallPhase

La fase de neutralidad del proveedor alcanzada mediante una llamada telefónica entrante.

TelephonyCallStatus

El estado del ciclo de vida de una llamada telefónica entrante.

TelephonyCallTimestampSource

La fuente de una marca temporal del ciclo de vida de la telefonía.

TelephonyCallTraceMode

El modo utilizado para exponer una llamada telefónica como un rastreo de Foundry orientado al cliente.

TelephonyCallTraceStatus

El estado de disponibilidad de un rastreo de llamadas telefónicas orientado al cliente.

TelephonyOutboundDestinationType

El tipo de destino para una llamada saliente.

TelephonyOutboundRetryPolicyType

La estrategia de reintento para una llamada saliente.

TelephonyOutboundRetryPolicyUnion

Alias para TelefoníaSalidaRetryPolicyUnion.

TelephonyProvider

Un proveedor de telefonía soportado por un agente vinculante. Los valores conocidos son estables; con el tiempo se pueden añadir valores adicionales.

TelephonyTransferDestinationKind

El tipo de destino de transferencia telefónica. Los valores conocidos son estables; con el tiempo se pueden añadir valores adicionales.

TelephonyTransferDestinationUnion

Alias para TelephonyTransferDestinationUnion

TextResponseFormatConfigurationType

Tipo de TextoRespuestaFormatoConfiguraciónTipo

TextResponseFormatConfigurationUnion

Soportaban configuraciones para texto plano y respuestas JSON estructuradas.

TextResponseFormatUnion

Alias para TextResponseFormatUnion

ToolChoiceOptions

Controla la herramienta a la que llama el modelo (si existe). none significa que el modelo no llamará a ninguna herramienta y, en su lugar, generará un mensaje. auto significa que el modelo puede elegir entre generar un mensaje o llamar a una o varias herramientas. required significa que el modelo debe llamar a una o varias herramientas.

ToolChoiceParamType

Tipo de ToolChoiceParamType

ToolChoiceParamUnion

Alias para ToolChoiceParamUnion

ToolSearchExecutionType

Tipo de ToolSearchExecutionType

ToolType

Tipo de Tipo de Herramienta

ToolUnion

Alias de ToolUnion

ToolboxShellEnvironmentUnion

Alias para ToolboxShellEnvironmentUnion

ToolboxShellNetworkPolicyUnion

Alias para ToolboxShellNetworkPolicyUnion

ToolboxSkillUnion

Alias para ToolboxSkillUnion

ToolboxToolType

Tipos de herramientas compatibles para herramientas almacenadas en una caja de herramientas.

ToolboxToolUnion

Alias para ToolboxToolUnion

ToolboxesInvokeLatestToolboxMcpResponse

La respuesta devuelve el último endpoint MCP de la caja de herramientas.

TreatmentEffectType

Tipo de efecto del tratamiento.

TriggerType

Tipo de desencadenante.

TriggerUnion

Alias de TriggerUnion

VersionIndicatorType

El tipo de indicador de versión utilizado para determinar la versión del agente que respalda una sesión.

VersionIndicatorUnion

Alias para VersionIndicatorUnion

VersionSelectionRuleType

Tipo de versiónSelectionRuleType

VersionSelectionRuleUnion

Alias para VersionSelectionRuleUnion

VoiceAgentAnimationOutputType

Una salida de animación producida por una sesión de agente de voz.

VoiceAgentAudioTimestampType

Un tipo de marca temporal de audio de salida soportado por un agente de voz.

VoiceAgentAvatarOutputProtocol

El transporte utilizado para entregar la transmisión de vídeo del avatar.

VoiceAgentAvatarType

El tipo avatar.

VoiceAgentClientEvent

Un mensaje estable v1 enviado por un cliente a través de un WebSocket de un agente de voz.

VoiceAgentConnectionState

Los estados de conexión se informan por una conexión en tiempo real entre un agente de voz.

VoiceAgentConnectionStateChangedHandler

Se llama cuando una conexión de voz y agente cambia de estado.

VoiceAgentEchoCancellationReferenceSource

La fuente de audio de referencia utilizada para la cancelación de eco.

VoiceAgentEndOfUtteranceDetectionModel

El modelo semántico de detección de fin de enunciado.

VoiceAgentEndOfUtteranceThresholdLevel

El umbral de sensibilidad para la detección semántica de fin de enunciación.

VoiceAgentGreetingConfigUnion

Alias para VoiceAgentGreetingConfigUnion

VoiceAgentInputTranscriptionModel

El identificador de modelo de transcripción de audio de entrada. Este es un nombre de modelo, no un nombre de despliegue de Foundry. Refleja los modelos de transcripción soportados por el backend de voz gestionado, cubriendo los modelos de transcripción en tiempo real de OpenAI más los modelos de Azure y MAI. Se pueden agregar valores adicionales a lo largo del tiempo.

VoiceAgentInterimResponseConfigUnion

Alias para VoiceAgentInterimResponseConfigUnion

VoiceAgentInterimResponseTrigger

Una condición que puede desencadenar una respuesta intermedia.

VoiceAgentMaxOutputTokens

El conteo máximo de tokens de salida o el literal inf.

VoiceAgentNoiseReductionType

El modo de reducción de ruido de audio de entrada.

VoiceAgentRealtimeErrorCode

Códigos de error generados por el cliente en tiempo real de Voice Agents.

VoiceAgentRealtimeEvent

Un evento recibido de una conexión en tiempo real con agente de voz.

Los eventos conocidos conservan sus tipos generados y su normalización. Los tipos de cable no reconocidos están envuelto en VoiceAgentUnknownEvent. Activa type a eventos conocidos específicos, o excluye type === "unknown" antes de pasar un evento a un gestor de eventos conocidos.

VoiceAgentServerEvent

Un mensaje v1 estable enviado por el servicio a través de un WebSocket de agente de voz.

VoiceAgentSessionIncludeOption

Campos adicionales que una sesión de agente de voz puede incluir en las salidas del servicio.

VoiceAgentSessionResponse

La configuración efectiva de la sesión se repetía en los eventos del ciclo de vida de la sesión con agentes de voz.

VoiceAgentSessionUpdate

La configuración de la sesión es aceptada por un evento de actualización de sesión con agente de voz.

VoiceAgentSubagentAbortReason

La razón por la que se abortó una consulta con subagentes.

VoiceAgentSystemToolName

Una acción de control de sesión de voz gestionada por servicios. Los valores conocidos son estables; con el tiempo se pueden añadir valores adicionales.

VoiceAgentSystemToolUnion

Alias para VoiceAgentSystemToolUnion

VoiceAgentToolChoice

Comportamiento de selección de herramientas para un agente de voz.

VoiceAgentToolResponseScheduling

Cuando una invocación de herramienta crea una respuesta de seguimiento. Se pueden agregar valores adicionales a lo largo del tiempo.

VoiceAgentToolUnion

Alias para VoiceAgentToolUnion

VoiceAgentTransport

El transporte usado para una conexión de voz y agente.

VoiceAgentTurnDetectionConfigUnion

Alias para VoiceAgentTurnDetectionConfigUnion

VoiceAgentTurnDetectionType

La estrategia de detección de giros. Se pueden agregar valores adicionales a lo largo del tiempo.

VoiceAgentWebSocketMessage

Un mensaje de texto JSON intercambiado a través de un agente de voz establecido WebSocket. Los bytes de audio están codificados en base 64 en campos de eventos JSON.

VoiceAgentWebSocketSubprotocol

El subprotocolo WebSocket es soportado por una conexión de voz y agente.

VoiceAudioCodec

Un códec de audio. Se pueden agregar valores adicionales a lo largo del tiempo.

VoiceAudioContainerFormat

Un formato de contenedor de audio. Se pueden agregar valores adicionales a lo largo del tiempo.

VoiceAudioRole

Un papel de participante de voz y audio. Se pueden agregar valores adicionales a lo largo del tiempo.

VoiceConversationEngineUnion

Alias para VoiceConversationEngineUnion

VoiceConversationStatus

Estado del ciclo de vida de una conversación de voz persistente:

  • in_progress: la sesión en vivo está activa, o la finalización de persistencia posterior a la sesión está pendiente.
  • completed: finalización exitosa tras el cierre normal o del cliente, end_conversation, un cierre de duración 1001 máxima, o una desconexión del cliente o red que el servicio aún puede finalizar.
  • failed: un fallo de servicio terminal, puente, almacenamiento o transporte irrecuperable impidió la finalización.
VoiceModelType

Cómo se sirve el modelo que respalda un agente de voz. Esto es independiente de la arquitectura (en tiempo real o en cascada), que el servicio deriva del modelo seleccionado.

VoiceOutputModality

Una modalidad de salida que el agente puede producir. animation y avatar se utilizan cuando se configura un avatar.

VoiceType

La implementación por voz. Se pueden agregar valores adicionales a lo largo del tiempo.

Enumeraciones

KnownApiVersions

Versiones de la API de Microsoft Foundry

Funciones

isRestError(unknown)

Typeguard para RestError

Variables

RestError

Tipo de error personalizado para solicitudes de canalización con error.

KnownVoiceAgentConnectionState

Valores conocidos de VoiceAgentConnectionState reportados por una conexión en tiempo real entre voz y agente.

Detalles de la función

isRestError(unknown)

Typeguard para RestError

function isRestError(e: unknown): e is RestError

Parámetros

e

unknown

Algo capturado por una cláusula catch.

Devoluciones

e is RestError

Detalles de variables

RestError

Tipo de error personalizado para solicitudes de canalización con error.

RestError: RestErrorConstructor

Tipo

KnownVoiceAgentConnectionState

Valores conocidos de VoiceAgentConnectionState reportados por una conexión en tiempo real entre voz y agente.

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

Tipo

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