@azure/ai-projects package

Classes

AIProjectClient	O principal cliente do AIProjectClient
VoiceAgentAuthenticationError	Um erro foi gerado ao adquirir um token de acesso Microsoft Entra.
VoiceAgentConnectionError	Um erro gerado pela conexão WebSocket.
VoiceAgentProtocolError	Um erro gerado quando uma mensagem WebSocket não corresponde ao protocolo do agente de voz.
VoiceAgentRealtimeClient	Cliente para estabelecer sessões em tempo real com agentes de voz gerenciados da Foundry.
VoiceAgentRealtimeError	Erro base levantado pelo cliente em tempo real dos Voice Agents.

Interfaces

@azure/ai-projects.Index

A2APreviewTool	Um agente que implementa o protocolo A2A.
A2APreviewToolboxTool	Uma ferramenta A2A armazenada em uma caixa de ferramentas.
A2AProtocolConfiguration	Configuração específica para o protocolo A2A.
A2ATool	Um agente que implementa o protocolo A2A.
A2AToolboxTool	Uma ferramenta A2A armazenada em uma caixa de ferramentas.
AIProjectClientOptionalParams	Parâmetros opcionais para o cliente.
AISearchIndexResource	Um recurso de índice de pesquisa de IA.
ActivityProtocolConfiguration	Configuração específica para o protocolo de atividade.
Agent	Agente de interface de modelos
AgentBlueprintReference	interface do modelo AgentBlueprintReference
AgentCard	interface de modelo AgentCard
AgentCardSkill	interface do modelo AgentCardSkill
AgentClusterInsightRequest	Insights sobre o conjunto de resultados da avaliação do agente
AgentClusterInsightResult	Insights da análise de cluster de agentes.
AgentDataGenerationJobSource	Fonte de agente para trabalhos de geração de dados — referencia um agente para buscar instruções e metadados.
AgentDefinition	Interface de definição de base para agentes. Contém o tipo de agente e a configuração RAI opcional.
AgentEndpointAuthorizationScheme	interface de modelo AgenteEndpointAuthorizationScheme
AgentEndpointConfig	interface modelo AgentEndpointConfig
AgentEvaluatorGenerationJobSource	Source de agente para trabalhos de geração de avaliadores — faz referência a um agente para buscar instruções e metadados.
AgentHarness	(Prévia) Um runtime gerenciado e um loop de agente usados para executar um agente de prompt.
AgentIdentity	interface do modelo AgentIdentity
AgentInsight	Um problema persistente descoberto a partir dos rastros de um agente.
AgentInsightDetails	Detalhes adicionais de detalhes. Omitido, a menos que detalhes sejam solicitados.
AgentInsightEstimatedCost	Custo estimado do Agent Insights.
AgentInsightHighlightedTrace	Um traço destacado que fornece evidências para a percepção de um agente.
AgentInsightJsonObject	Um objeto JSON usado em cargas úteis do Agent Insights.
AgentInsightLinkedTrace	Uma referência leve de rastreamento ligada ao insight de um agente como evidência de apoio.
AgentInsightMonitor	Um monitor Agent Insights por agente que controla a configuração, execuções e insights descobertos.
AgentInsightMonitorCreate	Campos aceitos ao criar um monitor de Insight para Agente para um agente.
AgentInsightMonitorListItem	Um resumo do monitor Agent Insights retornado pelas operações da lista.
AgentInsightMonitorUpdate	Campos que podem ser atualizados em um monitor de Agent Insights.
AgentInsightProposedFix	Uma solução recomendada para uma visão de agente.
AgentInsightProposedFixChange	Uma alteração renderizável pelo cliente em uma correção proposta.
AgentInsightRecommendedAction	A remediação recomendada para um agente é uma visão.
AgentInsightRun	Uma série de longa duração que analisa os rastros de um agente e atualiza os insights desse agente.
AgentInsightRunCreate	Entradas usadas ao criar uma execução de insight de agente.
AgentInsightRunResult	Estatísticas de resultados produzidas quando uma run de insight do agente é bem-sucedida.
AgentInsightSuspension	Motivo estruturado pelo qual a geração programada é suspensa para um monitor.
AgentInsightTokenUsage	Uso de token para uma execução do Agent Insights.
AgentInsightUpdate	Campos que podem ser atualizados com insights de um agente.
AgentInsightsOverview	A visão geral eficaz para um monitor de Insights.
AgentInsightsOverviewOverride	Uma visão geral fornecida pelo usuário que se torna eficaz imediatamente e gera a próxima geração.
AgentOptimizationCandidate	Resultado agregado da avaliação para uma única configuração de agente candidato em todas as tarefas.
AgentOptimizationDatasetCriterion	Critério de avaliação: um par nome + instrução usado para pontuação por item.
AgentOptimizationDatasetInput	Modelo discriminado base para entrada de conjuntos de dados. Ou itens em linha ou uma referência registrada.
AgentOptimizationDatasetItem	Um único item em um conjunto de dados inline.
AgentOptimizationEvaluatorRef	Referência a um avaliador nomeado, opcionalmente fixada em uma versão.
AgentOptimizationInlineDatasetInput	Conjunto de dados inline — itens fornecidos diretamente no corpo da solicitação.
AgentOptimizationJob	Recurso de trabalho de otimização de agentes — um trabalho de longa duração que otimiza a configuração do agente (instruções, modelo, habilidades, ferramentas) para maximizar as pontuações de avaliação. Em caso de sucesso, o resultado contém os candidatos pontuados.
AgentOptimizationJobInputs	Entradas fornecidas pelo chamador para um trabalho de otimização.
AgentOptimizationJobListItem	Representação de trabalho limitada retornada pelo endpoint LIST.
AgentOptimizationJobProgress	Progresso em voo; Só é preenchido enquanto o status está na fila ou in_progress.
AgentOptimizationJobResult	Órgão de resultado do estado terminal. Populado quando o status é alcançado ou falhado.
AgentOptimizationOptions	Ajuste de botões e modo de execução para um trabalho de otimização.
AgentOptimizationReferenceDatasetInput	Referência a um conjunto de dados registrado da Foundry.
AgentSessionResource	Uma sessão de agente que fornece uma sandbox computacional de longa duração para invocações de agentes hospedadas.
AgentTaxonomyInput	Configuração de entrada para a taxonomia de avaliação quando o tipo de entrada é agente.
AgentVersion	Representa uma versão específica de um agente. Inclui metadados, controle de versão, tempo de criação e definição de agente.
AgenticIdentityPreviewCredentials	Definição de credencial de identidade agêntica
AgentsCreateAgentFromManifestOptionalParams	Parâmetros opcionais.
AgentsCreateAgentVersionFromManifestOptionalParams	Parâmetros opcionais.
AgentsCreateOptionalParams	Parâmetros opcionais.
AgentsCreateSessionOptionalParams	Parâmetros opcionais.
AgentsCreateTelephonyBindingOptionalParams	Parâmetros opcionais.
AgentsCreateVersionFromCodeOptionalParams	Parâmetros opcionais.
AgentsCreateVersionOptionalParams	Parâmetros opcionais.
AgentsDeleteOptionalParams	Parâmetros opcionais.
AgentsDeleteSessionFileOptionalParams	Parâmetros opcionais.
AgentsDeleteSessionOptionalParams	Parâmetros opcionais.
AgentsDeleteTelephonyBindingOptionalParams	Parâmetros opcionais.
AgentsDeleteVersionOptionalParams	Parâmetros opcionais.
AgentsDisableOptionalParams	Parâmetros opcionais.
AgentsDownloadAgentCodeOptionalParams	Parâmetros opcionais.
AgentsDownloadSessionFileOptionalParams	Parâmetros opcionais.
AgentsEnableOptionalParams	Parâmetros opcionais.
AgentsGetOptionalParams	Parâmetros opcionais.
AgentsGetSessionLogStreamOptionalParams	Parâmetros opcionais.
AgentsGetSessionOptionalParams	Parâmetros opcionais.
AgentsGetTelephonyBindingOptionalParams	Parâmetros opcionais.
AgentsGetVersionOptionalParams	Parâmetros opcionais.
AgentsListOptionalParams	Parâmetros opcionais.
AgentsListSessionFilesOptionalParams	Parâmetros opcionais.
AgentsListSessionsOptionalParams	Parâmetros opcionais.
AgentsListTelephonyBindingsOptionalParams	Parâmetros opcionais.
AgentsListTelephonyCallsOptionalParams	Parâmetros opcionais.
AgentsListVersionsOptionalParams	Parâmetros opcionais.
AgentsOperations	Interface que representa uma operação de Agentes.
AgentsStopSessionOptionalParams	Parâmetros opcionais.
AgentsUpdateAgentFromManifestOptionalParams	Parâmetros opcionais.
AgentsUpdateAgentObjectOptionalParams	Parâmetros opcionais.
AgentsUpdateOptionalParams	Parâmetros opcionais.
AgentsUpdateTelephonyBindingOptionalParams	Parâmetros opcionais.
AgentsUploadSessionFileOptionalParams	Parâmetros opcionais.
ApiErrorResponse	Resposta de erro para falhas de API.
ApiKeyCredentials	Definição de credencial de chave de API
ApplyPatchToolParam	Permite que o assistente crie, exclua ou atualize arquivos usando diferenciais unificados.
ApproximateLocation	interface do modelo AproximaçãoLocalização
ArtifactProfile	Perfil de artefato do modelo
AutoCodeInterpreterToolParam	Configuração para um contêiner de interpretador de código. Opcionalmente, especifique as IDs dos arquivos nos quais executar o código.
AzureAIAgentTarget	Representa um alvo especificando um agente de IA do Azure.
AzureAIModelTarget	Representa um alvo especificando um modelo de IA do Azure para operações que exigem seleção de modelo.
AzureAISearchIndex	Definição de índice Pesquisa de IA do Azure
AzureAISearchTool	A informação de definição de entrada para uma ferramenta de busca de IA do Azure usada para configurar um agente.
AzureAISearchToolResource	Um conjunto de recursos de índice usados pela ferramenta azure_ai_search.
AzureAISearchToolboxTool	Uma ferramenta do Pesquisa de IA do Azure  armazenada em uma caixa de ferramentas.
AzureAgentConfig	Opções de configuração para o endpoint agente do método getOpenAIClient. Usado principalmente para agentes hospedados.
AzureFunctionBinding	A estrutura para manter storage nome e URI da fila.
AzureFunctionDefinition	A definição de função Azure.
AzureFunctionStorageQueue	A estrutura para manter storage nome e URI da fila.
AzureFunctionTool	A informação de definição de entrada para uma Ferramenta de Função do Azure, usada para configurar um Agente.
AzureOpenAIModelConfiguration	Azure OpenAI configuração de modelos. A versão da API seria selecionada pelo serviço para consultar o modelo.
BaseCredentials	Uma classe base para credenciais de conexão
BetaAgentInsightMonitorsCancelRunOptionalParams	Parâmetros opcionais.
BetaAgentInsightMonitorsCreateOptionalParams	Parâmetros opcionais.
BetaAgentInsightMonitorsCreateRunOptionalParams	Parâmetros opcionais.
BetaAgentInsightMonitorsDeleteOptionalParams	Parâmetros opcionais.
BetaAgentInsightMonitorsGetInsightOptionalParams	Parâmetros opcionais.
BetaAgentInsightMonitorsGetOptionalParams	Parâmetros opcionais.
BetaAgentInsightMonitorsGetRunOptionalParams	Parâmetros opcionais.
BetaAgentInsightMonitorsListInsightsOptionalParams	Parâmetros opcionais.
BetaAgentInsightMonitorsListOptionalParams	Parâmetros opcionais.
BetaAgentInsightMonitorsListRunsOptionalParams	Parâmetros opcionais.
BetaAgentInsightMonitorsOperations	Interface representando uma operação do BetaAgentInsightMonitors.
BetaAgentInsightMonitorsResetOptionalParams	Parâmetros opcionais.
BetaAgentInsightMonitorsUpdateInsightOptionalParams	Parâmetros opcionais.
BetaAgentInsightMonitorsUpdateOptionalParams	Parâmetros opcionais.
BetaAgentsCancelOptimizationJobOptionalParams	Parâmetros opcionais.
BetaAgentsCreateFromPromptOptionalParams	Parâmetros opcionais.
BetaAgentsCreateOptimizationJobOptionalParams	Parâmetros opcionais.
BetaAgentsDeleteOptimizationJobOptionalParams	Parâmetros opcionais.
BetaAgentsGetOptimizationJobOptionalParams	Parâmetros opcionais.
BetaAgentsListOptimizationJobsOptionalParams	Parâmetros opcionais.
BetaAgentsOperations	Operações para agentes gerenciadores.
BetaDatasetsCancelGenerationJobOptionalParams	Parâmetros opcionais.
BetaDatasetsCreateGenerationJobOptionalParams	Parâmetros opcionais.
BetaDatasetsDeleteGenerationJobOptionalParams	Parâmetros opcionais.
BetaDatasetsGetGenerationJobOptionalParams	Parâmetros opcionais.
BetaDatasetsListGenerationJobsOptionalParams	Parâmetros opcionais.
BetaDatasetsOperations	Interface representando operações de um BetaDatasets.
BetaEvaluationTaxonomiesCreateOptionalParams	Parâmetros opcionais.
BetaEvaluationTaxonomiesDeleteOptionalParams	Parâmetros opcionais.
BetaEvaluationTaxonomiesGetOptionalParams	Parâmetros opcionais.
BetaEvaluationTaxonomiesListOptionalParams	Parâmetros opcionais.
BetaEvaluationTaxonomiesOperations	Interface representando uma operação BetaEvaluationTaxonomies.
BetaEvaluationTaxonomiesUpdateOptionalParams	Parâmetros opcionais.
BetaEvaluatorsCancelGenerationJobOptionalParams	Parâmetros opcionais.
BetaEvaluatorsCreateGenerationJobOptionalParams	Parâmetros opcionais.
BetaEvaluatorsCreateVersionOptionalParams	Parâmetros opcionais.
BetaEvaluatorsDeleteGenerationJobOptionalParams	Parâmetros opcionais.
BetaEvaluatorsDeleteVersionOptionalParams	Parâmetros opcionais.
BetaEvaluatorsGetCredentialsOptionalParams	Parâmetros opcionais.
BetaEvaluatorsGetGenerationJobOptionalParams	Parâmetros opcionais.
BetaEvaluatorsGetVersionOptionalParams	Parâmetros opcionais.
BetaEvaluatorsListGenerationJobsOptionalParams	Parâmetros opcionais.
BetaEvaluatorsListOptionalParams	Parâmetros opcionais.
BetaEvaluatorsListVersionsOptionalParams	Parâmetros opcionais.
BetaEvaluatorsOperations	Interface representando as operações de um BetaEvaluator.
BetaEvaluatorsPendingUploadOptionalParams	Parâmetros opcionais.
BetaEvaluatorsUpdateVersionOptionalParams	Parâmetros opcionais.
BetaInsightsGenerateOptionalParams	Parâmetros opcionais.
BetaInsightsGetOptionalParams	Parâmetros opcionais.
BetaInsightsListOptionalParams	Parâmetros opcionais.
BetaInsightsOperations	Interface representando uma operação BetaInsights.
BetaMemoryStoresCreateMemoryOptionalParams	Parâmetros opcionais.
BetaMemoryStoresCreateOptionalParams	Parâmetros opcionais.
BetaMemoryStoresDeleteMemoryOptionalParams	Parâmetros opcionais.
BetaMemoryStoresDeleteOptionalParams	Parâmetros opcionais.
BetaMemoryStoresDeleteScopeOptionalParams	Parâmetros opcionais.
BetaMemoryStoresGetMemoryOptionalParams	Parâmetros opcionais.
BetaMemoryStoresGetOptionalParams	Parâmetros opcionais.
BetaMemoryStoresGetUpdateResultOptionalParams	Parâmetros opcionais.
BetaMemoryStoresListMemoriesOptionalParams	Parâmetros opcionais.
BetaMemoryStoresListOptionalParams	Parâmetros opcionais.
BetaMemoryStoresOperations	Interface representando operações do BetaMemoryStores.
BetaMemoryStoresSearchMemoriesOptionalParams	Parâmetros opcionais.
BetaMemoryStoresUpdateMemoriesOptionalParams	Parâmetros opcionais.
BetaMemoryStoresUpdateMemoryOptionalParams	Parâmetros opcionais.
BetaMemoryStoresUpdateOptionalParams	Parâmetros opcionais.
BetaModelsCreateOptions	Opções para o método de criação que faz upload de arquivos locais e registra uma versão do modelo.
BetaModelsDeleteOptionalParams	Parâmetros opcionais.
BetaModelsGetCredentialsOptionalParams	Parâmetros opcionais.
BetaModelsGetOptionalParams	Parâmetros opcionais.
BetaModelsListOptionalParams	Parâmetros opcionais.
BetaModelsListVersionsOptionalParams	Parâmetros opcionais.
BetaModelsOperations	Interface representando operações de um BetaModels.
BetaModelsPendingCreateVersionOptionalParams	Parâmetros opcionais.
BetaModelsPendingUploadOptionalParams	Parâmetros opcionais.
BetaModelsUpdateOptionalParams	Parâmetros opcionais.
BetaOperations	Interface representando uma operação Beta.
BetaRedTeamsCreateOptionalParams	Parâmetros opcionais.
BetaRedTeamsGetOptionalParams	Parâmetros opcionais.
BetaRedTeamsListOptionalParams	Parâmetros opcionais.
BetaRedTeamsOperations	Interface representando uma operação do BetaRedTeams.
BetaRoutinesCreateOrUpdateOptionalParams	Parâmetros opcionais.
BetaRoutinesDeleteOptionalParams	Parâmetros opcionais.
BetaRoutinesDisableOptionalParams	Parâmetros opcionais.
BetaRoutinesDispatchOptionalParams	Parâmetros opcionais.
BetaRoutinesEnableOptionalParams	Parâmetros opcionais.
BetaRoutinesGetOptionalParams	Parâmetros opcionais.
BetaRoutinesListOptionalParams	Parâmetros opcionais.
BetaRoutinesListRunsOptionalParams	Parâmetros opcionais.
BetaRoutinesOperations	Interface representando uma operação BetaRoutines.
BetaSchedulesCreateOrUpdateOptionalParams	Parâmetros opcionais.
BetaSchedulesDeleteOptionalParams	Parâmetros opcionais.
BetaSchedulesGetOptionalParams	Parâmetros opcionais.
BetaSchedulesGetRunOptionalParams	Parâmetros opcionais.
BetaSchedulesListOptionalParams	Parâmetros opcionais.
BetaSchedulesListRunsOptionalParams	Parâmetros opcionais.
BetaSchedulesOperations	Interface representando operações de BetaSchedules.
BetaSkillsCreateOptionalParams	Parâmetros opcionais.
BetaSkillsCreateVersionFromFilesOptionalParams	Parâmetros opcionais.
BetaSkillsDeleteOptionalParams	Parâmetros opcionais.
BetaSkillsDeleteVersionOptionalParams	Parâmetros opcionais.
BetaSkillsDownloadOptionalParams	Parâmetros opcionais.
BetaSkillsDownloadVersionOptionalParams	Parâmetros opcionais.
BetaSkillsGetOptionalParams	Parâmetros opcionais.
BetaSkillsGetVersionOptionalParams	Parâmetros opcionais.
BetaSkillsListOptionalParams	Parâmetros opcionais.
BetaSkillsListVersionsOptionalParams	Parâmetros opcionais.
BetaSkillsOperations	Interface representando uma operação BetaSkills.
BetaSkillsUpdateOptionalParams	Parâmetros opcionais.
BetaVoiceAgentsConversationsDeleteOptionalParams	Parâmetros opcionais.
BetaVoiceAgentsConversationsDownloadAudioItemOptionalParams	Parâmetros opcionais.
BetaVoiceAgentsConversationsDownloadAudioOptionalParams	Parâmetros opcionais.
BetaVoiceAgentsConversationsDownloadGeneratedAudioItemOptionalParams	Parâmetros opcionais.
BetaVoiceAgentsConversationsGetAudioItemOptionalParams	Parâmetros opcionais.
BetaVoiceAgentsConversationsGetAudioOptionalParams	Parâmetros opcionais.
BetaVoiceAgentsConversationsGetGeneratedAudioItemOptionalParams	Parâmetros opcionais.
BetaVoiceAgentsConversationsGetItemOptionalParams	Parâmetros opcionais.
BetaVoiceAgentsConversationsGetOptionalParams	Parâmetros opcionais.
BetaVoiceAgentsConversationsGetResponseOptionalParams	Parâmetros opcionais.
BetaVoiceAgentsConversationsListItemsOptionalParams	Parâmetros opcionais.
BetaVoiceAgentsConversationsListOptionalParams	Parâmetros opcionais.
BetaVoiceAgentsConversationsListResponseItemsOptionalParams	Parâmetros opcionais.
BetaVoiceAgentsConversationsListResponsesOptionalParams	Parâmetros opcionais.
BetaVoiceAgentsConversationsOperations	Operações para gerenciar conversas de agentes de voz.
BetaVoiceAgentsOperations	Operações para gerenciamento de conversas de agentes de voz e telefonia.
BetaVoiceAgentsTelephonyCancelCallJobOptionalParams	Parâmetros opcionais.
BetaVoiceAgentsTelephonyCreateBindingOptionalParams	Parâmetros opcionais.
BetaVoiceAgentsTelephonyCreateCallJobOptionalParams	Parâmetros opcionais.
BetaVoiceAgentsTelephonyDeleteBindingOptionalParams	Parâmetros opcionais.
BetaVoiceAgentsTelephonyEndCallOptionalParams	Parâmetros opcionais.
BetaVoiceAgentsTelephonyGetBindingOptionalParams	Parâmetros opcionais.
BetaVoiceAgentsTelephonyGetCallJobOptionalParams	Parâmetros opcionais.
BetaVoiceAgentsTelephonyGetCallOptionalParams	Parâmetros opcionais.
BetaVoiceAgentsTelephonyGetTransferTargetsOptionalParams	Parâmetros opcionais.
BetaVoiceAgentsTelephonyListBindingsOptionalParams	Parâmetros opcionais.
BetaVoiceAgentsTelephonyListCallsOptionalParams	Parâmetros opcionais.
BetaVoiceAgentsTelephonyOperations	Operações para gerenciamento de telefonia de agentes de voz.
BetaVoiceAgentsTelephonyReplaceTransferTargetsOptionalParams	Parâmetros opcionais.
BetaVoiceAgentsTelephonyTransferCallOptionalParams	Parâmetros opcionais.
BetaVoiceAgentsTelephonyUpdateBindingOptionalParams	Parâmetros opcionais.
BingCustomSearchConfiguration	Uma bing configuração de pesquisa personalizada.
BingCustomSearchPreviewTool	As informações de definição de entrada para um Bing ferramenta de pesquisa personalizada, conforme usado para configurar um agente.
BingCustomSearchToolParameters	O bing parâmetros da ferramenta de pesquisa personalizada.
BingGroundingSearchConfiguration	Configuração de pesquisa para a base de Bing
BingGroundingSearchToolParameters	O bing parâmetros da ferramenta de pesquisa de aterramento.
BingGroundingTool	As informações de definição de entrada para um bing ferramenta de pesquisa de aterramento, conforme usado para configurar um agente.
BlobReference	Detalhes de referência de blob.
BotServiceAuthorizationScheme	interface modelo BotServiceAuthorizationScheme
BotServiceRbacAuthorizationScheme	interface modelo BotServiceRbacAuthorizationScheme
BotServiceTenantAuthorizationScheme	interface modelo BotServiceTenantAuthorizationScheme
BrowserAutomationPreviewTool	As informações de definição de entrada para uma Ferramenta de Automação do Navegador, conforme usado para configurar um Agente.
BrowserAutomationPreviewToolboxTool	Uma ferramenta de automação de navegador armazenada em uma caixa de ferramentas.
BrowserAutomationToolConnectionParameters	Definição de parâmetros de entrada para a conexão usada pela Ferramenta de Automação do Navegador.
BrowserAutomationToolParameters	Definição de parâmetros de entrada para a Ferramenta de Automação do Navegador.
CaptureStructuredOutputsTool	Uma ferramenta para capturar saídas estruturadas
ChartCoordinate	Coordenadas para o gráfico de análise.
ChatSummaryMemoryItem	Um item de memória que contém um resumo extraído de conversas.
ClusterInsightResult	Insights da análise de cluster.
ClusterTokenUsage	Uso de token para análise de cluster
CodeBasedEvaluatorDefinition	Definição de avaliador baseada em código usando código python
CodeConfiguration	Configuração de implantação baseada em código para um agente hospedado.
CodeInterpreterTool	Uma ferramenta que executa código Python para ajudar a gerar uma resposta a um prompt.
CodeInterpreterToolboxTool	Uma ferramenta de interpretação de código armazenada em uma caixa de ferramentas.
ComparisonFilter	Um filtro usado para comparar uma chave de atributo especificada com um determinado valor usando uma operação de comparação definida.
CompoundFilter	Combinar vários filtros usando and ou or.
ComputerTool	Uma ferramenta que controla um computador virtual. Saiba mais sobre a ferramenta de computador.
ComputerUsePreviewTool	Uma ferramenta que controla um computador virtual. Saiba mais sobre a ferramenta de computador.
Connection	Resposta da lista e operações get connections
ConnectionsGetOptionalParams	Parâmetros opcionais.
ConnectionsGetWithCredentialsOptionalParams	Parâmetros opcionais.
ConnectionsListOptionalParams	Parâmetros opcionais.
ConnectionsOperations	Interface que representa uma operação de conexões.
ContainerAutoParam	interface de modelo ContainerAutoParam
ContainerConfiguration	Configuração de implantação baseada em contêiner para um agente hospedado.
ContainerNetworkPolicyAllowlistParam	interface model ContainerNetworkPolicyAllowlistParam
ContainerNetworkPolicyDisabledParam	interface de modelo ContainerNetworkPolicyDisabledParam
ContainerNetworkPolicyDomainSecretParam	interface de modelo ContainerNetworkPolicyDomainSecretParam
ContainerNetworkPolicyParam	Política de acesso à rede para o contêiner.
ContainerSkill	interface de modelo ContainerSkill
ContinuousEvaluationRuleAction	Ação de regra de avaliação para avaliação contínua.
CosmosDBIndex	Definição de índice do repositório de vetores do CosmosDB
CreateAgentVersionFromCodeContent	Corpo de requisição multiparte para atualização ou versionamento de um agente baseado em código (POST /agents/{name} e POST /agents/{name}/versions).
CreateAgentVersionFromCodeMetadata	Metadados JSON para operações de agentes baseadas em código (criar, atualizar, criar versão). O nome do agente vem do parâmetro de caminho URL ou do x-ms-agent-name cabeçalho, portanto não está incluído nesse modelo. O hash de conteúdo (SHA-256 do zip) é transportado no x-ms-code-zip-sha256 cabeçalho.
CreateSkillVersionFromFilesBody	Corpo de solicitação multiparte para criar uma versão de habilidade a partir de arquivos. Aceita um único arquivo zip ou múltiplos arquivos individuais de skill (upload de diretório). Para uploads em zip, o servidor extrai e valida o conteúdo. Para uploads de diretórios, os arquivos são validados as-is.
CreateTeamsPhoneExtensionTelephonyBindingRequest	O pedido para criar uma extensão do Telefonia do Microsoft Teams.
CreateTelephonyBindingRequest	O pedido para criar uma ligação telefônica.
CreateTelephonyCallJobRequest	Um pedido para criar um trabalho durável de chamada direta de saída.
CreateTranscriptionResponseJsonUsage	Estatísticas de uso de tokens para a solicitação.
CreateTwilioTelephonyBindingRequest	O pedido para criar uma encadração Twilio.
CronTrigger	Gatilho baseado em cron.
CustomCredential	Definição de credencial personalizada
CustomGrammarFormatParam	Uma gramática definida pelo usuário.
CustomRoutineTrigger	Um gatilho de rotina de evento personalizada.
CustomTextFormatParam	Texto livre e sem restrições.
CustomToolParam	Uma ferramenta personalizada que processa entradas usando um formato especificado. Saiba mais sobre as ferramentas custom
CustomToolParamFormat	O formato de entrada para a ferramenta personalizada. O padrão é texto sem restrições.
DailyRecurrenceSchedule	Cronograma diário de recorrência.
DataGenerationJob	Geração de dados - recurso para vagas.
DataGenerationJobInputs	Entradas fornecidas pelo chamador para um trabalho de geração de dados.
DataGenerationJobOptions	Opções para gerenciar trabalhos de geração de dados.
DataGenerationJobOutput	Saia informações para um trabalho de geração de dados.
DataGenerationJobOutputOptions	Opções de saída para o trabalho de geração de dados.
DataGenerationJobResult	Resultado produzido por um trabalho bem-sucedido de geração de dados.
DataGenerationJobSource	O modelo base de origem para trabalhos de geração de dados.
DataGenerationModelOptions	Opções de modelos de LLM para trabalhos de geração de dados.
DataGenerationTokenUsage	Informações de uso de tokens para um trabalho de geração de dados.
DatasetCredential	Representa uma referência a um blob para consumo
DatasetDataGenerationJobOutput	Saída de conjunto de dados para um trabalho de geração de dados.
DatasetEvaluatorGenerationJobSource	Fonte de conjunto de dados para trabalhos de geração de avaliadores — referência a um conjunto de dados.
DatasetReference	Referência a um conjunto de dados versionado da Foundry.
DatasetVersion	Definição de DatasetVersion
DatasetsCreateOrUpdateOptionalParams	Parâmetros opcionais.
DatasetsDeleteOptionalParams	Parâmetros opcionais.
DatasetsGetCredentialsOptionalParams	Parâmetros opcionais.
DatasetsGetOptionalParams	Parâmetros opcionais.
DatasetsListOptionalParams	Parâmetros opcionais.
DatasetsListVersionsOptionalParams	Parâmetros opcionais.
DatasetsOperations	Interface que representa uma operação de conjuntos de dados.
DatasetsPendingUploadOptionalParams	Parâmetros opcionais.
DeleteAgentResponse	Um objeto de agente excluído
DeleteAgentVersionResponse	Um objeto de versão do agente excluído
DeleteMemoryResponse	Resposta para excluir um item de memória de um armazenamento de memória.
DeleteMemoryStoreResponse	interface do modelo DeleteMemoryStoreResponse
DeleteSkillResponse	Uma habilidade deletada.
DeleteSkillVersionResponse	Uma versão de habilidade deletada.
Deployment	Definição de implantação de modelo
DeploymentsGetOptionalParams	Parâmetros opcionais.
DeploymentsListOptionalParams	Parâmetros opcionais.
DeploymentsOperations	Interface representando uma operação de Implantações.
Dimension	Uma única dimensão — uma dimensão de qualidade independente e mensurável dentro do plano de avaliação de um avaliador de rubricas.
DispatchRoutineResponse	Identificadores retornados após uma rotineira de despacho ser enfileirada.
EmbeddingConfiguration	Classe de configuração de inserção
EmptyModelParam	interface de modelo EmptyModelParam
EndpointBasedEvaluatorDefinition	Definição de avaliador baseada em endpoint. O cliente possui e hospeda um endpoint HTTP que implementa o contrato de avaliação. O avaliador faz referência a uma Conexão de Project pelo nome; a conexão armazena a URL e as credenciais do endpoint (API Key ou Entra ID). No momento da execução, o serviço resolve a conexão para obter a URL do endpoint e os detalhes de autenticação, e então chama o endpoint para cada linha de avaliação.
EntraAuthorizationScheme	interface modelo EntraAuthorizationScheme
EntraIDCredentials	Entra ID definição de credenciais
ErrorModel	Interface do modelo ErrorModel
EvalResult	Resultado da avaliação.
EvalRunResultCompareItem	Comparação métrica para um tratamento em relação à linha de base.
EvalRunResultComparison	Os resultados da comparação para o tratamento são executados em relação à linha de base.
EvalRunResultSummary	Estatísticas resumidas de uma métrica em uma execução de avaliação.
EvaluationComparisonInsightRequest	Solicitação de comparação de avaliação
EvaluationComparisonInsightResult	Insights da comparação de avaliação.
EvaluationResultSample	Uma amostra do resultado da avaliação.
EvaluationRule	Modelo de regra de avaliação.
EvaluationRuleAction	Modelo de ação de avaliação.
EvaluationRuleFilter	Modelo de filtro de avaliação.
EvaluationRulesCreateOrUpdateOptionalParams	Parâmetros opcionais.
EvaluationRulesDeleteOptionalParams	Parâmetros opcionais.
EvaluationRulesGetOptionalParams	Parâmetros opcionais.
EvaluationRulesListOptionalParams	Parâmetros opcionais.
EvaluationRulesOperations	Interface que representa uma operação EvaluationRules.
EvaluationRunClusterInsightRequest	Insights sobre o conjunto de resultados da avaliação
EvaluationRunClusterInsightResult	Os insights da análise de cluster de execução de avaliação.
EvaluationScheduleTask	Tarefa de avaliação para o cronograma.
EvaluationTarget	Classe base para destinos com suporte a discriminadores.
EvaluationTaxonomy	Definição de taxonomia de avaliação
EvaluationTaxonomyInput	Configuração de entrada para a taxonomia de avaliação.
EvaluatorCredentialRequest	Órgão de solicitação para obtenção de credenciais de avaliador
EvaluatorDefinition	Configuração do avaliador base com discriminador
EvaluatorGenerationArtifacts	Artefatos de proveniência gerenciada por serviços produzidos por um trabalho de geração avaliador. Presente apenas nos recursos EvaluatorVersion criados via pipeline de geração. O conjunto de dados combinado-JSONL Foundry é somente leitura e resolve para um conjunto de dados versionado em um namespace reservado por serviços.
EvaluatorGenerationInputs	Entradas fornecidas pelo chamador para um trabalho de geração de avaliador.
EvaluatorGenerationJob	Recurso de Geração de Avaliação — um trabalho de longa duração que gera definições de avaliadores baseadas em rubricas a partir dos materiais fonte. Em caso de sucesso, o resultado é a persistência do EvaluatorVersion.
EvaluatorGenerationJobSource	O modelo base de fonte para cargos de geração de avaliadores. Polimórfico sobre type.
EvaluatorGenerationTokenUsage	Resumo do consumo de tokens para um trabalho de geração de avaliador. Preenchido quando o trabalho atinge um estado terminal.
EvaluatorMetric	Métrica do avaliador
EvaluatorVersion	Definição de avaliador
ExternalAgentDefinition	A definição de agente externo. Representa um agente terceirizado hospedado fora do Foundry (por exemplo, no GCP ou AWS). O registro é apenas para metadados: a Foundry registra a definição do agente para iluminar experiências de observabilidade (rastreios, avaliações) sobre dados emitidos pelo cliente da OpenTelemetry.
FabricDataAgentToolParameters	Os parâmetros da ferramenta do agente de dados de malha.
FabricIQPreviewTool	Uma ferramenta FabricIQ para o lado do servidor.
FabricIQPreviewToolboxTool	Uma ferramenta FabricIQ armazenada em uma caixa de ferramentas.
FieldMapping	Classe de configuração de mapeamento de campo
FileDataGenerationJobOutput	Saída de arquivo Azure OpenAI para um trabalho de geração de dados.
FileDataGenerationJobSource	Fonte de arquivo para trabalhos de geração de dados — entrada de arquivo Azure OpenAI.
FileDatasetVersion	Definição de FileDatasetVersion
FileSearchTool	Uma ferramenta que pesquisa conteúdo relevante de arquivos carregados. Saiba mais sobre a ferramenta de pesquisa de arquivos.
FileSearchToolboxTool	Uma ferramenta de busca de arquivos armazenada em uma caixa de ferramentas.
FixedRatioVersionSelectionRule	interface do modelo Regra de Seleção FixaProporçãoVersão
FolderDatasetVersion	Definição de FileDatasetVersion
FoundryModelWarning	Um aviso associado a um modelo.
FunctionShellToolParam	Uma ferramenta que permite ao modelo executar comandos de shell.
FunctionShellToolParamEnvironment	Interface do modelo FunçãoShellToolParamAmbiente
FunctionShellToolParamEnvironmentContainerReferenceParam	Interface do modelo FunçãoShellToolParamAmbienteContainerReferenceParam
FunctionShellToolParamEnvironmentLocalEnvironmentParam	Função de interface do modelo ShellToolParamAmbienteLocalAmbiente
FunctionTool	Define uma função em seu próprio código que o modelo pode optar por chamar. Saiba mais sobre a chamada de função.
FunctionToolParam	interface de modelo FunctionToolParam
GenAITracingOptions	Opções para configurar o rastreamento GenAI em uma instância específica do AIProjectClient. Passe esses dados sob a tracingOptions chave AIProjectClientOptionalParams para habilitar o rastreamento GenAI quando o cliente for instanciado. Cada instância cliente mantém sua própria configuração independente de rastreamento.
GenerateVoiceAgentRequest	As entradas para gerar um agente de voz. Apenas kind e name são sempre obrigatórios. O serviço de autoria expande essas entradas em um , completo e editável VoiceAgentDefinition, que é então criado por meio de POST /agents. As configurações geradas instructions e de áudio/voz são armazenadas como campos separados na definição resultante do agente, para que o chamador possa editar ou sobrescrever qualquer uma delas posteriormente via versionamento padrão do agente.
GetMicrosoft365PackageOptionalParams	Parâmetros opcionais.
GetMicrosoft365PublishDefaultsOptionalParams	Parâmetros opcionais.
GitHubCopilotHarness	(Prévia) O chicote gerenciado do GitHub Copilot para agentes de prompt.
GitHubCopilotToolsetConfig	Uma sobreposição de habilitação para uma ferramenta embutida do GitHub Copilot.
GitHubCopilotToolsetDefaultConfig	A configuração padrão de habilitação para as ferramentas integradas do GitHub Copilot.
GitHubCopilotToolsetPreview	(Prévia) Overries de configuração para as ferramentas integradas do GitHub Copilot.
GitHubIssueRoutineTrigger	Um gatilho de rotina de problemas no GitHub.
HeaderTelemetryEndpointAuth	Autenticação secreta baseada em cabeçalho para um endpoint de telemetria. O valor secreto resolvido é injetado como um cabeçalho HTTP.
HostedAgentDefinition	A definição do agente hospedado.
HourlyRecurrenceSchedule	Cronograma de recorrência por hora.
HumanEvaluationPreviewRuleAction	Ação de regra de avaliação para avaliação humana.
HybridSearchOptions	interface de modelo HybridSearchOptions
ImageGenTool	Uma ferramenta que gera imagens usando os modelos de imagem GPT.
ImageGenToolInputImageMask	interface do modelo ImageGenToolInputImageMask
IndexesCreateOrUpdateOptionalParams	Parâmetros opcionais.
IndexesDeleteOptionalParams	Parâmetros opcionais.
IndexesGetOptionalParams	Parâmetros opcionais.
IndexesListOptionalParams	Parâmetros opcionais.
IndexesListVersionsOptionalParams	Parâmetros opcionais.
IndexesOperations	Interface que representa uma operação de índices.
InlineSkillParam	interface de modelo InlineSkillParam
InlineSkillSourceParam	Carga útil de habilidade inline
Insight	O corpo da resposta para insights de cluster.
InsightCluster	Um conjunto de amostras de análise.
InsightGenerationRequest	O órgão de solicitação para gerar um insight.
InsightModelConfiguration	Configuração do modelo usado na geração de insights.
InsightRequest	A solicitação do relatório de insights.
InsightResult	O resultado dos insights.
InsightSample	Uma amostra da análise.
InsightScheduleTask	Tarefa de insight para o agendamento.
InsightSummary	Resumo da análise do cluster de erros.
InsightsMetadata	Metadados sobre os insights.
InvocationsProtocolConfiguration	Configuração específica para o protocolo de invocações.
InvocationsWsProtocolConfiguration	Configuração específica para o protocolo de invocações baseado em WebSocket.
InvokeAgentInvocationsApiDispatchPayload	Uma carga útil manual usada para testar o despacho rotineiro de uma API de invocações.
InvokeAgentInvocationsApiRoutineAction	Despacha uma rotina através da API de invocações brutas. Exatamente um dos agent_name ou agent_endpoint_id deve ser fornecido.
InvokeAgentResponsesApiDispatchPayload	Um payload manual usado para testar o despacho de rotina de uma API de respostas.
InvokeAgentResponsesApiRoutineAction	Despacha uma rotina pela API de respostas. Exatamente um dos agent_name ou agent_endpoint_id deve ser fornecido.
JobOperationState	Estado operacional para uma operação de longa duração que cria um recurso de trabalho. PERSONALIZAÇÃO: SDK-IMPROVEMENT: os pollers emitidos resolvem para a carga útil terminal result do trabalho, que não carrega identificador; jobId mantém o trabalho criado acessível.
LocalShellToolParam	Uma ferramenta que permite que o modelo execute comandos de shell em um ambiente local.
LocalSkillParam	interface de modelo LocalSkillParam
LogProbProperties	Um objeto de probabilidade logarítmica.
LoraConfig	Metadados específicos do adaptador para modelos LoRA. Drives atendem à configuração do motor no momento da implantação.
MCPListToolsTool	Uma ferramenta disponível em um servidor MCP.
MCPListToolsToolAnnotations	Interface de modelo MCPListToolsToolAnnotations
MCPListToolsToolInputSchema	interface do modelo MCPListToolsToolInputSchema
MCPTool	Forneça ao modelo acesso a ferramentas adicionais por meio de servidores remotos do Protocolo de Contexto de Modelo (MCP). Learn mais sobre MCP.
MCPToolFilter	Um objeto filtro para especificar quais ferramentas são permitidas.
MCPToolRequireApproval	interface de modelo MCPToolRequireApproval
MCPToolboxTool	Uma ferramenta MCP armazenada em uma caixa de ferramentas.
ManagedAgentIdentityBlueprintReference	interface de modelo ManagedAgentIdentityBlueprintReference
ManagedAzureAISearchIndex	Definição de índice de Pesquisa de IA do Azure  gerenciado
McpProtocolConfiguration	Configuração específica do protocolo MCP.
MemoryItem	Um único item de memória armazenado no armazenamento de memória, contendo conteúdo e metadados.
MemoryOperation	Representa uma única operação de memória (criar, atualizar ou excluir) executada em um item de memória.
MemorySearchItem	Um item de memória recuperado da pesquisa de memória.
MemorySearchOptions	Opções de pesquisa de memória.
MemorySearchPreviewTool	Uma ferramenta para integrar memórias ao agente.
MemoryStore	Um armazenamento de memória que pode armazenar e recuperar memórias do usuário.
MemoryStoreDefaultDefinition	Implementação de armazenamento de memória padrão.
MemoryStoreDefaultOptions	Configurações padrão do armazenamento de memória.
MemoryStoreDefinition	Definição de base para configurações de armazenamento de memória.
MemoryStoreDeleteScopeResponse	Resposta para excluir memórias de um escopo.
MemoryStoreOperationUsage	Estatísticas de uso de uma operação de armazenamento de memória.
MemoryStoreSearchResponse	Resposta de pesquisa de memória.
MemoryStoreUpdateCompletedResult	Resultado da atualização da memória.
MemoryStoreUpdateResponse	Fornece o status de uma operação de atualização do repositório de memória.
Metadata	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado e consultar objetos por meio da API ou do painel. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.
Microsoft365PermissionScopes	Um conjunto de escopos de permissões delegadas solicitados a uma única aplicação de recurso.
Microsoft365PublishDefaults	Valores padrão e já publicados anteriormente usados para preencher uma solicitação de publicação do Microsoft 365 para um agente Foundry.
Microsoft365PublishResponse	Resposta ao publicar um agente para Microsoft 365 / Microsoft Teams.
MicrosoftFabricPreviewTool	A informação de definição de entrada para uma ferramenta Microsoft Fabric usada para configurar um agente.
MisalignmentErrorDetailsResource	Detalhes de uma ação bloqueados porque podem não estar alinhados com a intenção do usuário.
MisalignmentSteer	Uma instrução pública para continuar após uma ação é bloqueada.
ModelCredentialRequest	Solicite a obtenção de credenciais para um ativo modelo.
ModelDeployment	Definição de implantação de modelo
ModelDeploymentSku	Informações de SKU
ModelPendingUploadRequest	Representa um pedido de upload pendente de uma versão do modelo.
ModelPendingUploadResponse	Representa a resposta para um modelo pendente de solicitação de upload.
ModelSamplingParams	Representa um conjunto de parâmetros usados para controlar o comportamento de amostragem de um modelo de linguagem durante a geração de texto.
ModelSourceData	Informações de origem para o modelo
ModelVersion	Definição de Versão do Modelo
MonthlyRecurrenceSchedule	Cronograma mensal de recorrência.
NamespaceToolParam	Grupos funcional/ferramentas personalizadas em um namespace compartilhado.
NoAuthenticationCredentials	Credenciais que não exigem autenticação
OneTimeTrigger	Gatilho único.
OpenAIClientOptionsWithAzureAgent	Ampliaram as opções do cliente OpenAI para incluir a configuração do endpoint do Azure Agent.
OpenApiAnonymousAuthDetails	Detalhes de segurança para autenticação anônima do OpenApi
OpenApiAuthDetails	detalhes de autenticação para OpenApiFunctionDefinition
OpenApiFunctionDefinition	As informações de definição de entrada para uma função openapi.
OpenApiManagedAuthDetails	Detalhes de segurança para autenticação de managed_identity OpenApi
OpenApiManagedSecurityScheme	Esquema de segurança para autenticação de managed_identity OpenApi
OpenApiProjectConnectionAuthDetails	Detalhes de segurança da autenticação de conexão do OpenApi project
OpenApiProjectConnectionSecurityScheme	Esquema de segurança para autenticação de managed_identity OpenApi
OpenApiTool	As informações de definição de entrada para uma ferramenta OpenAPI, conforme usado para configurar um agente.
OpenApiToolboxTool	Uma ferramenta OpenAPI armazenada em uma caixa de ferramentas.
OptimizedAgentIdentifier	Identifica o agente registrado da Foundry para otimizar (apenas por requisição). Habilidades, ferramentas e system_prompt são especificados em options.optimization_config.
OtlpTelemetryEndpoint	Um endpoint de exportação de telemetria OTLP (OpenTelemetry Protocol).
PageSettings	Uma interface que rastreia as configurações da iteração paginada
PagedAsyncIterableIterator	Uma interface que permite iteração assíncrona iterável tanto para conclusão quanto por página.
PendingUploadRequest	Representa uma solicitação de upload pendente.
PendingUploadResponse	Representa a resposta para uma solicitação de upload pendente
PickPropertiesVoiceAgentAudioConfig	O modelo para escolher propriedades.
ProceduralMemoryItem	Um item de memória contendo um procedimento extraído de conversas.
ProgrammaticToolCallingParam	interface de modelo ProgrammaticToolCallingParam
PromotionInfo	Metadados de promoção registrados quando um candidato é implantado para um agente da Foundry.
PromptAgentDefinition	A definição do agente de prompt
PromptAgentDefinitionTextOptions	Opções de configuração para uma resposta de texto do modelo. Pode ser texto sem formatação ou dados JSON estruturados.
PromptBasedEvaluatorDefinition	Avaliador baseado em prompt
PromptDataGenerationJobSource	Fonte de prompt para trabalhos de geração de dados — texto inline fornecido pelo usuário.
PromptEvaluatorGenerationJobSource	Fonte de prompt para trabalhos de geração de avaliadores — texto em linha fornecido pelo usuário.
ProtocolConfiguration	Configuração por protocolo para o endpoint do agente.
ProtocolVersionRecord	Um mapeamento de registro para um único protocolo e sua versão.
PstnTelephonyTransferDestination	Um destino PSTN para um destino de transferência telefônica.
PublishToMicrosoft365OptionalParams	Parâmetros opcionais.
RaiConfig	Configuração para filtragem de conteúdo e recursos de segurança de IA Responsável (RAI).
RaiInvocationModeration	Declara onde o texto de solicitação/resposta está para que as proteções de segurança do conteúdo possam extraí-lo.
RaiSseTextSelector	Um seletor de tipo de evento SSE para campo de texto para streaming de saída de invocação.
RankingOptions	interface de modelo Opções de classificação
RealtimeAudioFormats	interface de modelo RealtimeAudioFormatos
RealtimeAudioFormatsAudioPcm	interface de modelo RealtimeÁudioFormatosÁudioPcm
RealtimeAudioFormatsAudioPcma	interface de modelo RealtimeÁudioFormatosÁudioPcma
RealtimeAudioFormatsAudioPcmu	interface de modelo RealtimeAudioFormatsAudioPcmu
RealtimeClientEvent	Um evento em tempo real com clientes.
RealtimeClientEventConversationItemCreate	Adicione um novo Item ao contexto da Conversa, incluindo mensagens, chamadas de função e respostas de chamadas de função. Esse evento pode ser usado tanto para preencher um "histórico" da conversa quanto para adicionar novos itens no meio do fluxo, mas tem a limitação atual de que não pode preencher mensagens de áudio do assistente. Se for bem-sucedido, o servidor responderá com um conversation.item.created evento, caso contrário, um error evento será enviado.
RealtimeClientEventConversationItemDelete	Envie este evento quando quiser remover qualquer item do histórico de conversas. O servidor responderá com um conversation.item.deleted evento, a menos que o item não exista no histórico da conversa, caso em que o servidor responderá com um erro.
RealtimeClientEventConversationItemRetrieve	Envie esse evento quando quiser recuperar a representação do servidor de um item específico no histórico de conversas. Isso é útil, por exemplo, para inspecionar o áudio do usuário após cancelamento de ruído e VAD. O servidor responderá com um conversation.item.retrieved evento, a menos que o item não exista no histórico da conversa, caso em que o servidor responderá com um erro.
RealtimeClientEventConversationItemTruncate	Envie este evento para truncar o áudio de uma mensagem de assistente anterior. O servidor produzirá áudio mais rápido que em tempo real, então esse evento é útil quando o usuário interrompe para truncar áudio que já foi enviado ao cliente, mas ainda não foi reproduzido. Isso sincroniza a compreensão do áudio do servidor com a reprodução do cliente. Truncar o áudio apagará a transcrição do texto do lado do servidor para garantir que não haja texto no contexto que não tenha sido ouvido pelo usuário. Se for bem-sucedido, o servidor responderá com um conversation.item.truncated evento.
RealtimeClientEventInputAudioBufferAppend	Envie este evento para adicionar bytes de áudio ao buffer de áudio de entrada. O buffer de áudio é um armazenamento temporário no qual você pode gravar e posteriormente confirmar. Um "commit" cria um novo item de mensagem de usuário no histórico de conversas a partir do conteúdo do buffer e limpa o buffer. A transcrição de áudio de entrada (se ativada) será gerada quando o buffer for confirmado. Se o VAD estiver ativado, o buffer de áudio é usado para detectar a fala e o servidor decidirá quando comprometer. Quando o VAD do servidor é desativado, você deve confirmar manualmente o buffer de áudio. A redução de ruído de áudio de entrada opera durante escritas no buffer de áudio. O cliente pode escolher quanto áudio colocar em cada evento até um máximo de 15 MiB, por exemplo, transmitir pequenos trechos do cliente pode permitir que o VAD seja mais responsivo. Diferente da maioria dos outros eventos do cliente, o servidor não enviará uma resposta de confirmação para esse evento.
RealtimeClientEventInputAudioBufferClear	Envie esse evento para limpar os bytes de áudio no buffer. O servidor responderá com um input_audio_buffer.cleared evento.
RealtimeClientEventInputAudioBufferCommit	Envie esse evento para comprometer o buffer de áudio de entrada do usuário, o que criará um novo item de mensagem de usuário na conversa. Esse evento gerará um erro se o buffer de áudio de entrada estiver vazio. Quando está no modo VAD do servidor, o cliente não precisa enviar esse evento, o servidor irá automaticamente comprometer o buffer de áudio. Confirmar o buffer de áudio de entrada aciona a transcrição de áudio de entrada (se ativada na configuração da sessão), mas não gera resposta do modelo. O servidor responderá com um input_audio_buffer.committed evento.
RealtimeClientEventOutputAudioBufferClear	Apenas WebRTC/SIP: Emita para cortar a resposta de áudio atual. Isso faz com que o servidor pare de gerar áudio e emita um output_audio_buffer.cleared evento. Esse evento deve ser precedido por um response.cancel evento cliente para interromper a geração da resposta atual. Saiba mais.
RealtimeClientEventResponseCancel	Envie este evento para cancelar uma resposta em andamento. O servidor responderá com um response.done evento com um status de response.status=cancelled. Se não houver resposta para cancelar, o servidor responderá com um erro. É seguro ligar, response.cancel mesmo que nenhuma resposta esteja em andamento, um erro será retornado e a sessão permanecerá intacta.
RealtimeClientEventResponseCreate	Esse evento instrui o servidor a criar uma Resposta, o que significa disparar a inferência do modelo. Quando está no modo VAD do servidor, o servidor criará respostas automaticamente. Uma Resposta incluirá pelo menos um item, e pode ter dois, caso em que o segundo será uma chamada de função. Esses itens serão adicionados ao histórico de conversas por padrão. O servidor responderá com um response.created evento, eventos para itens e conteúdo criados, e finalmente um response.done evento indicando que a resposta foi concluída. O response.create evento inclui configuração de inferência como instructions e tools. Se esses forem definidos, eles substituirão a configuração da Sessão apenas para esta Resposta. As respostas podem ser criadas fora da banda da Conversa padrão, o que significa que podem ter entrada arbitrária, e é possível desabilitar a gravação da saída na Conversa. Apenas uma Resposta pode escrever na Conversa padrão por vez, mas, caso contrário, múltiplas Respostas podem ser criadas em paralelo. O metadata campo é uma boa forma de desambiguar múltiplas respostas simultâneas. Os clientes podem definir conversation para none criar uma Resposta que não escreva na Conversa padrão. Entrada arbitrária pode ser fornecida com o input campo, que é um array aceitando Itens brutos e referências a Itens existentes.
RealtimeConversationItem	Um único item dentro de uma conversa em tempo real.
RealtimeConversationItemFunctionCall	Um item de chamada de função em uma conversa em tempo real.
RealtimeConversationItemFunctionCallOutput	Uma função chama item de saída em uma conversa em tempo real.
RealtimeConversationItemMessage	interface de modelo RealtimeConversationItemMessage
RealtimeConversationItemMessageAssistant	Um item de mensagem de assistente em uma conversa em tempo real.
RealtimeConversationItemMessageAssistantContent	interface de modelo Tempo realConversaItemMensagemAssistente Conteúdo
RealtimeConversationItemMessageSystem	Uma mensagem do sistema em uma conversa em tempo real pode ser usada para fornecer contexto adicional ou instruções ao modelo. Isso é semelhante, mas distinto do prompt de instrução fornecido no início de uma conversa, já que mensagens do sistema podem ser adicionadas a qualquer momento da conversa. Para mudanças significativas no comportamento da conversa, use instruções, mas para atualizações menores (por exemplo, "o usuário agora está perguntando sobre um assunto diferente"), use mensagens do sistema.
RealtimeConversationItemMessageSystemContent	Interface de modelo Tempo RealConversaItemMensagemConteúdo
RealtimeConversationItemMessageUser	Um item de mensagem de usuário em uma conversa em tempo real.
RealtimeConversationItemMessageUserContent	Interface do modelo Tempo RealConversaItemMensagemUsuárioConteúdo
RealtimeFunctionTool	Interface de modelo RealtimeFunctionTool
RealtimeMCPApprovalRequest	Um item em tempo real solicitando aprovação humana para uma invocação de ferramenta.
RealtimeMCPApprovalResponse	Um item em tempo real respondendo a uma solicitação de aprovação do MCP.
RealtimeMCPError	interface de modelo RealtimeMCPError
RealtimeMCPHttpError	interface de modelo RealtimeMCPHttpError
RealtimeMCPListTools	Ferramentas de listagem de itens em tempo real disponíveis em um servidor MCP.
RealtimeMCPProtocolError	interface de modelo RealtimeMCPProtocolError
RealtimeMCPToolCall	Um item em tempo real representando a invocação de uma ferramenta em um servidor MCP.
RealtimeMCPToolExecutionError	interface de modelo RealtimeMCPToolExecutionError
RealtimeReasoning	Configuração para modelos em tempo real com capacidade de raciocínio, como gpt-realtime-2.
RealtimeResponseStatusDetails	interface do modelo Tempo realRespostaStatusDetalhes
RealtimeResponseStatusDetailsError	interface do modelo Tempo realRespostaStatusDetalhesErro
RealtimeResponseUsage	interface de modelo RealtimeResponseUsage
RealtimeResponseUsageInputTokenDetails	interface do modelo RealtimeRespostaUsoEntradaTokenDetalhes
RealtimeResponseUsageInputTokenDetailsCachedTokensDetails	interface do modelo RealtimeRespostaUsoEntradaTokenDetalhesCachedTokensDetalhes
RealtimeResponseUsageOutputTokenDetails	interface de modelo Tempo realRespostaUsoSaídaTokenDetalhes
RealtimeServerEvent	Um evento de servidor em tempo real.
RealtimeServerEventConversationItemAdded	Enviado pelo servidor quando um item é adicionado à Conversa padrão. Isso pode acontecer em vários casos: Quando o cliente envia um conversation.item.create evento. Quando o buffer de áudio de entrada é confirmado. Nesse caso, o item será uma mensagem de usuário contendo o áudio do buffer. Quando o modelo está gerando uma Resposta. Nesse caso, o conversation.item.added evento será enviado quando o modelo começar a gerar um Item específico, e portanto ele ainda não terá nenhum conteúdo (e status será in_progress). O evento incluirá o conteúdo completo do Item (exceto quando o modelo estiver gerando uma Resposta), exceto os dados de áudio, que podem ser recuperados separadamente com um conversation.item.retrieve evento, se necessário.
RealtimeServerEventConversationItemCreated	Devolvido quando um item de conversa é criado. Há vários cenários que produzem este evento: O servidor está gerando uma Resposta que, se bem-sucedida, produzirá um ou dois Itens, que serão do tipo message (função assistant) ou do tipo function_call. O buffer de áudio de entrada foi comprometido, seja pelo cliente ou pelo servidor (no server_vad modo). O servidor pega o conteúdo do buffer de áudio de entrada e o adiciona a um novo item de mensagem de usuário. O cliente enviou um conversation.item.create evento para adicionar um novo item à conversa.
RealtimeServerEventConversationItemDeleted	Devolvido quando um item da conversa é excluído pelo cliente com um conversation.item.delete evento. Esse evento é usado para sincronizar a compreensão do servidor sobre o histórico de conversas com a exibição do cliente.
RealtimeServerEventConversationItemDone	Retorna quando um item de conversa é finalizado. O evento incluirá o conteúdo completo do Item, exceto os dados de áudio, que podem ser recuperados separadamente com um conversation.item.retrieve evento, se necessário.
RealtimeServerEventConversationItemInputAudioTranscriptionCompleted	Esse evento é a saída da transcrição de áudio do usuário escrita no buffer de áudio do usuário. A transcrição começa quando o buffer de áudio de entrada é confirmado pelo cliente ou servidor (quando o VAD está habilitado). A transcrição roda de forma assíncrona com a criação de Resposta, então esse evento pode ocorrer antes ou depois dos eventos de Resposta. Modelos de API em tempo real aceitam áudio nativamente, e assim a transcrição de entrada é um processo separado executado em um modelo ASR (Reconhecimento Automático de Fala) separado. A transcrição pode divergir um pouco da interpretação do modelo e deve ser tratada como um guia aproximado.
RealtimeServerEventConversationItemInputAudioTranscriptionDelta	Retornado quando o valor de texto de uma parte de conteúdo de transcrição de áudio de entrada é atualizado com resultados incrementais da transcrição.
RealtimeServerEventConversationItemInputAudioTranscriptionFailed	Devolvido quando a transcrição de áudio de entrada é configurada e uma solicitação de transcrição para uma mensagem de usuário falhou. Esses eventos são separados de outros error eventos para que o cliente possa identificar o Item relacionado.
RealtimeServerEventConversationItemInputAudioTranscriptionFailedError	interface do modelo RealtimeServerEventConversationItemInputAudioTranscriptionFailedError
RealtimeServerEventConversationItemInputAudioTranscriptionSegment	Retornado quando um segmento de transcrição de áudio de entrada é identificado para um item.
RealtimeServerEventConversationItemRetrieved	Retornado quando um item de conversa é recuperado com conversation.item.retrieve. Isso é fornecido como uma forma de obter a representação do servidor de um item, por exemplo, para acessar os dados de áudio pós-processados após cancelamento de ruído e VAD. Inclui o conteúdo completo do item, incluindo dados de áudio.
RealtimeServerEventConversationItemTruncated	Retornado quando um item de mensagem de áudio anterior do assistente é truncado pelo cliente com um conversation.item.truncate evento. Esse evento é usado para sincronizar a compreensão do áudio pelo servidor com a reprodução do cliente. Essa ação truncará o áudio e removerá a transcrição do texto do lado do servidor para garantir que não haja texto no contexto que não tenha sido ouvido pelo usuário.
RealtimeServerEventError	Retorna quando ocorre um erro, que pode ser um problema do cliente ou do servidor. A maioria dos erros pode ser recuperada e a sessão permanecerá aberta; recomendamos aos implementadores que monitorem e registrem mensagens de erro por padrão.
RealtimeServerEventErrorError	interface de modelo RealtimeServerEventErrorError
RealtimeServerEventInputAudioBufferCleared	Retornado quando o buffer de áudio de entrada é limpo pelo cliente com um input_audio_buffer.clear evento.
RealtimeServerEventInputAudioBufferCommitted	Retornado quando um buffer de áudio de entrada é confirmado, seja pelo cliente ou automaticamente no modo VAD do servidor. A item_id propriedade é o ID do item de mensagem do usuário que será criado, portanto um conversation.item.created evento também será enviado ao cliente.
RealtimeServerEventInputAudioBufferSpeechStarted	Enviado pelo servidor quando está em server_vad modo para indicar que a fala foi detectada no buffer de áudio. Isso pode acontecer sempre que áudio for adicionado ao buffer (a menos que a fala já tiver sido detectada). O cliente pode querer usar esse evento para interromper a reprodução de áudio ou fornecer feedback visual ao usuário. O cliente deve esperar receber um input_audio_buffer.speech_stopped evento quando a fala parar. A item_id propriedade é o ID do item de mensagem do usuário que será criado quando a fala parar e também será incluído no input_audio_buffer.speech_stopped evento (a menos que o cliente faça commit manual do buffer de áudio durante a ativação do VAD).
RealtimeServerEventInputAudioBufferSpeechStopped	Retorna no server_vad modo quando o servidor detecta o fim da fala no buffer de áudio. O servidor também enviará um conversation.item.created evento com o item de mensagem do usuário criado a partir do buffer de áudio.
RealtimeServerEventInputAudioBufferTimeoutTriggered	Retornado quando o timeout do VAD do servidor é acionado para o buffer de áudio de entrada. Isso é configurado nas idle_timeout_msturn_detection configurações da sessão, e indica que não houve nenhuma fala detectada durante a duração configurada. Os campos audio_start_ms e audio_end_ms indicam o segmento de áudio após a última resposta do modelo até o momento do gatilho, como um deslocamento a partir do início do áudio escrito no buffer de áudio de entrada. Isso significa que demarca o segmento de áudio que estava silencioso e a diferença entre os valores inicial e final corresponderá aproximadamente ao tempo de espera configurado. O áudio vazio será comprometido com a conversa como um input_audio item (haverá um input_audio_buffer.committed evento) e uma resposta modelo será gerada. Pode haver fala que não acionou o DAV, mas ainda assim é detectada pelo modelo, então o modelo pode responder com algo relevante para a conversa ou um prompt para continuar falando.
RealtimeServerEventMCPListToolsCompleted	Devolvido quando listar ferramentas MCP foi concluído para um item.
RealtimeServerEventMCPListToolsFailed	Devolvimento quando listar ferramentas MCP falhou em um item.
RealtimeServerEventMCPListToolsInProgress	Retorna quando a listagem de ferramentas MCP está em progresso para um item.
RealtimeServerEventOutputAudioBufferCleared	Apenas WebRTC/SIP: Emitido quando o buffer de áudio de saída é limpo. Isso acontece no modo VAD quando o usuário interrompe (input_audio_buffer.speech_started) ou quando o cliente emite o evento output_audio_buffer.clear para cortar manualmente a resposta de áudio atual. Saiba mais.
RealtimeServerEventRateLimitsUpdated	Emitido no início de uma Resposta para indicar os limites de taxa atualizados. Quando uma Resposta é criada, alguns tokens serão "reservados" para os tokens de saída, os limites de taxa aqui mostrados refletem essa reserva, que é então ajustada conforme a Resposta é concluída.
RealtimeServerEventRateLimitsUpdatedRateLimits	interface de modelo RealtimeServerEventRateLimitsUpdatedRateLimits
RealtimeServerEventResponseAudioDelta	Retorna quando o áudio gerado pelo modelo é atualizado.
RealtimeServerEventResponseAudioDone	Retornado quando o áudio gerado pelo modelo é concluído. Também é emitido quando uma Resposta é interrompida, incompleta ou cancelada.
RealtimeServerEventResponseAudioTranscriptDelta	Retornado quando a transcrição gerada pelo modelo da saída de áudio é atualizada.
RealtimeServerEventResponseAudioTranscriptDone	Retornado quando a transcrição gerada pelo modelo da saída de áudio é feita em streaming. Também é emitido quando uma Resposta é interrompida, incompleta ou cancelada.
RealtimeServerEventResponseContentPartAdded	Retornado quando uma nova parte de conteúdo é adicionada a um item de mensagem do assistente durante a geração da resposta.
RealtimeServerEventResponseContentPartAddedPart	interface do modelo RealtimeServerEventResponseContentPartAddedPart
RealtimeServerEventResponseContentPartDone	Retornado quando uma parte de conteúdo termina de ser transmitida em um item de mensagem de assistente. Também é emitido quando uma Resposta é interrompida, incompleta ou cancelada.
RealtimeServerEventResponseContentPartDonePart	interface do modelo RealtimeServerEventRespostaConteúdoParteFeita
RealtimeServerEventResponseCreated	Retornado quando uma nova Resposta é criada. O primeiro evento de criação de resposta, onde a resposta está em um estado inicial de in_progress.
RealtimeServerEventResponseDone	Retorna quando uma resposta termina de transmitir. Sempre emitido, não importa o estado final. O objeto Resposta incluído no response.done evento incluirá todos os itens de saída na Resposta, mas omitirá os dados brutos de áudio. Os clientes devem verificar o status campo da Resposta para determinar se foi bem-sucedida (completed) ou se houve outro resultado: cancelled, failed, ou incomplete. Uma resposta conterá todos os itens de saída gerados durante a resposta, excluindo qualquer conteúdo de áudio.
RealtimeServerEventResponseFunctionCallArgumentsDelta	Retornado quando os argumentos de chamada de função gerados pelo modelo são atualizados.
RealtimeServerEventResponseFunctionCallArgumentsDone	Devolvido quando os argumentos de chamada de função gerados pelo modelo terminam de ser transmitidos. Também é emitido quando uma Resposta é interrompida, incompleta ou cancelada.
RealtimeServerEventResponseMCPCallArgumentsDelta	Retornado quando os argumentos de chamada de ferramenta MCP são atualizados durante a geração da resposta.
RealtimeServerEventResponseMCPCallArgumentsDone	Retornado quando os argumentos da chamada de ferramenta MCP são finalizados durante a geração da resposta.
RealtimeServerEventResponseMCPCallCompleted	Devolvido quando uma chamada de ferramenta MCP foi concluída com sucesso.
RealtimeServerEventResponseMCPCallFailed	Retornado quando uma chamada de ferramenta MCP falhou.
RealtimeServerEventResponseMCPCallInProgress	Devolvido quando uma chamada de ferramenta MCP começou e está em andamento.
RealtimeServerEventResponseOutputItemAdded	Devolvido quando um novo Item é criado durante a geração da Resposta.
RealtimeServerEventResponseOutputItemDone	Devolvido quando um item termina de ser transmitido. Também é emitido quando uma Resposta é interrompida, incompleta ou cancelada.
RealtimeServerEventResponseTextDelta	Retornado quando o valor de texto de uma parte de conteúdo "output_text" é atualizado.
RealtimeServerEventResponseTextDone	Devolvido quando o valor de texto de uma parte de conteúdo "output_text" termina de ser transmitido. Também é emitido quando uma Resposta é interrompida, incompleta ou cancelada.
RealtimeServerEventSessionCreated	Retorna quando uma Sessão é criada. Emitido automaticamente quando uma nova conexão é estabelecida como o primeiro evento do servidor. Este evento conterá a configuração padrão da Sessão.
RealtimeServerEventSessionUpdated	Retorna quando uma sessão é atualizada com um session.update evento, a menos que haja um erro.
Reasoning	Apenas modelos GPT-5 e O-Series Opções de configuração para modelos de raciocínio.
RecurrenceSchedule	Modelo de cronograma de recorrência.
RecurrenceTrigger	Gatilho baseado em recorrência.
RedTeam	Detalhes da equipe vermelha.
RedTeamTargetConfig	Classe abstrata para configuração de destino.
ReminderPreviewToolboxTool	Uma ferramenta de lembrete guardada em uma caixa de ferramentas.
ResponseUsageInputTokensDetails	Interface do modelo RespostaUsoTokensEntradaDetalhes
ResponseUsageOutputTokensDetails	interface de modelo RespostaUsoTokensSaídaDetalhes
ResponsesProtocolConfiguration	Configuração específica para o protocolo de resposta.
Routine	Uma definição rotineira retornada pelo serviço.
RoutineAction	Modelo base para uma ação rotineira.
RoutineAuthorization	Configuração opcional de autorização para um despacho rotineiro.
RoutineDispatchPayload	Modelo base para uma carga útil de despacho manual.
RoutineRun	Uma única execução rotineira retornava da API de histórico de execuções.
RoutineTrigger	Modelo base para um gatilho rotineiro.
RubricBasedEvaluatorDefinition	Definição de avaliador baseada em rubrica — armazena dimensões produzidas pela API de geração. Usado tanto para avaliadores de qualidade quanto de segurança.
RubricGenerationInputQualityWarning	Um aviso não fatal produzido durante a geração do avaliador de rubricas quando as entradas resolvidas são tecnicamente válidas, mas provavelmente muito fracas para produzir uma rubrica de alta qualidade. Somente leitura; Gerado por serviço. Persisti com o terminal EvaluatorGenerationJob.
RunOperationState	Estado de operação para uma operação de longa duração que cria um recurso de execução. PERSONALIZAÇÃO: SDK-MELHORIA: o poller emitido resolve para a carga útil terminal result da execução, que não carrega identificador; runId mantém a execução criada acessível.
SASTokenCredentials	Definição de credencial de SAS (Assinatura de Acesso Compartilhado)
SasCredential	Definição de credencial SAS
Schedule	Modelo de agendamento.
ScheduleRoutineTrigger	Um gatilho recorrente baseado em crons.
ScheduleRun	Agendar modelo de execução.
ScheduleTask	Modelo de tarefa de agendamento.
SessionConfiguration	Os padrões de sessão são aplicados a sessões criadas para uma versão de agente hospedada.
SessionDirectoryEntry	Uma única entrada em uma listagem de diretório.
SessionDirectoryListResponse	Resposta ao listar um diretório em um sandbox de sessão.
SessionFileWriteResponse	Resposta ao enviar um arquivo para um sandbox de sessão.
SessionLogEvent	Um único quadro de evento Server-Sent emitido pelo fluxo de log de sessão do agente hospedado. Cada quadro contém um event campo identificando o tipo de evento e um data campo contendo a carga útil como texto simples. Embora a carga útil atual data seja formatada em JSON, seu esquema não é contratual — chaves adicionais podem aparecer e o formato pode mudar ao longo do tempo. Os clientes devem tratar data como uma string opaca e, opcionalmente, tentar análise sintática JSON. Novos tipos de eventos podem ser adicionados no futuro. Os clientes devem ignorar com elegância os tipos de eventos não reconhecidos. Formato da fiação: 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	Os parâmetros da ferramenta de aterramento do sharepoint.
SharepointPreviewTool	As informações de definição de entrada para uma ferramenta do sharepoint, conforme usado para configurar um agente.
ShellToolboxTool	Uma ferramenta de concha guardada em uma caixa de ferramentas. Esse modelo é aditivo à configuração da caixa de ferramentas e não modifica o contrato da ferramenta OpenAI nem as definições existentes da caixa de ferramentas.
SimpleQnADataGenerationJobOptions	As opções para um trabalho de geração de dados com o tipo SimpleQnA.
SimulationSeedDataGenerationJobOptions	As opções para um trabalho de geração de dados semente por simulação. Use com cenários de avaliação multiturno e com fontes de prompt, arquivo ou agente. As linhas de conjunto de dados geradas incluem campos como id, category, test_case_description, e desired_num_turns.
SipTelephonyTransferDestination	Um destino SIP para um destino de transferência telefônica.
Skill	Um recurso de habilidades.
SkillInlineContent	Conteúdo inline para definir uma habilidade simples sem precisar enviar arquivos. Segue a especificação agentskills.io SKILL.md.
SkillReference	(Prévia) Uma referência a uma habilidade versão da Foundry.
SkillReferenceParam	interface do modelo SkillReferenceParam
SkillVersion	Uma versão específica de uma habilidade.
SpecificApplyPatchParam	Força o modelo a chamar a ferramenta apply_patch ao executar uma chamada de ferramenta.
SpecificFunctionShellParam	Força o modelo a chamar a ferramenta de shell quando uma chamada de ferramenta é necessária.
SpecificProgrammaticToolCallingParam	interface do modelo EspecificaProgramáticaFerramentalParamParam.
StructuredInputDefinition	Uma entrada estruturada que pode participar de substituições de modelo de prompt e associação de argumento de ferramenta.
StructuredOutputDefinition	Uma saída estruturada que pode ser produzida pelo agente.
TaskGenerationDataGenerationJobOptions	Opções para o trabalho de geração de tarefas legado, incluindo o número máximo de amostras geradas.
TaxonomyCategory	Definição de categoria de taxonomia.
TaxonomySubCategory	Definição de subcategoria de taxonomia.
TeamsPhoneExtensionTelephonyBinding	Uma vinculação da Telefonia do Microsoft Teams Extension pertencente a um agente de voz.
TeamsPhoneExtensionTelephonyBindingListItem	Uma vinculação da Telefonia do Microsoft Teams Extension retornava em uma lista, incluindo sua tag de entidade.
TeamsTelephonyTransferDestination	Um destino do Microsoft Teams para um destino de transferência telefônica.
TelemetryConfig	Configuração de telemetria fornecida pelo cliente para exportar logs, rastreamentos e métricas de contêineres.
TelemetryEndpoint	Uma configuração de exportação de telemetria no endpoint.
TelemetryEndpointAuth	Configuração de autenticação para um endpoint de telemetria.
TelemetryOperations	Interface que representa operações de telemetria
TelephonyBinding	Uma ligação telefônica pertencente a um agente de voz.
TelephonyBindingListItem	Uma ligação telefônica retornava em uma lista, incluindo sua tag de entidade.
TelephonyCallJob	Uma intenção de chamada de saída direta ou criada por campanhas duradoura.
TelephonyCallJobCancellation	Um pedido de cancelamento gravado para um trabalho de chamada de saída.
TelephonyCallJobSchedule	A janela de execução opcional para uma chamada de saída direta.
TelephonyCallLifecycleEvent	Uma observação duradoura e limitada no ciclo de vida de uma chamada telefônica.
TelephonyCallRecord	Diagnósticos detalhados para uma chamada recebida duradoura para um agente de voz.
TelephonyCallSummary	Um resumo de uma chamada recebida duradoura para um agente de voz.
TelephonyCallTiming	Tempo detalhado neutro em relação ao provedor para uma chamada telefônica recebida.
TelephonyCallTrace	Correlação de um registro duradouro de chamadas telefônicas para seu rastro Foundry voltado para o cliente.
TelephonyOutboundDestination	O destino de uma chamada de saída.
TelephonyOutboundFixedIntervalRetryPolicy	Uma política de retentativa com intervalo fixo entre as tentativas de chamada de saída.
TelephonyOutboundRetryPolicy	A política de retentativa para uma intenção de chamada de saída duradoura. max_attempts inclui a primeira tentativa. Configurações específicas de estratégia são definidas pela política derivada.
TelephonyTransferDestination	Um destino para um alvo de transferência telefônica.
TelephonyTransferTarget	Um destino nomeado para o qual o agente de voz pode transferir uma chamada.
TelephonyTransferTargets	Os alvos de transferência telefônica configurados para um agente de voz.
TextResponseFormat	Um objeto que especifica o formato que o modelo deve gerar. A configuração { "type": "json_schema" } habilita saídas estruturadas, o que garante que o modelo corresponda ao esquema JSON fornecido. Saiba mais no guia Saídas Estruturadas. O formato padrão é { "type": "text" } sem opções adicionais. Não recomendado para gpt-4o e modelos mais recentes:* Configurando para { "type": "json_object" } ativar o modo JSON mais antigo, que garante que a mensagem gerada pelo modelo seja JSON válida. O uso json_schema é preferencial para modelos que dão suporte a ele.
TextResponseFormatConfiguration	Configuração base para o formato das respostas de texto geradas.
TextResponseFormatConfigurationResponseFormatJsonObject	Configura as respostas geradas para usar o formato de objeto JSON.
TextResponseFormatConfigurationResponseFormatText	Configura respostas geradas para usar texto simples.
TextResponseFormatJsonObject	Formato de resposta de objeto JSON. Um método mais antigo de geração de respostas JSON. O uso json_schema é recomendado para modelos que dão suporte a ele. Observe que o modelo não gerará JSON sem uma mensagem do sistema ou do usuário instruindo-o a fazer isso.
TextResponseFormatJsonSchema	Formato de resposta de esquema JSON. Usado para gerar respostas JSON estruturadas. Saiba mais sobre saídas estruturadas.
TextResponseFormatText	Formato de resposta padrão. Usado para gerar respostas de texto.
TimerRoutineTrigger	Um gatilho de temporizador de um tiro só.
Tool	Uma ferramenta que pode ser usada para gerar uma resposta.
ToolChoiceAllowed	Restringe as ferramentas disponíveis para o modelo a um conjunto predefinido.
ToolChoiceCodeInterpreter	Indica que o modelo deve usar uma ferramenta interna para gerar uma resposta. Learn mais sobre ferramentas internas.
ToolChoiceComputer	Indica que o modelo deve usar uma ferramenta interna para gerar uma resposta. Learn mais sobre ferramentas internas.
ToolChoiceComputerUse	Indica que o modelo deve usar uma ferramenta interna para gerar uma resposta. Learn mais sobre ferramentas internas.
ToolChoiceComputerUsePreview	Indica que o modelo deve usar uma ferramenta interna para gerar uma resposta. Learn mais sobre ferramentas internas.
ToolChoiceCustom	Use essa opção para forçar o modelo a chamar uma ferramenta personalizada específica.
ToolChoiceFileSearch	Indica que o modelo deve usar uma ferramenta interna para gerar uma resposta. Learn mais sobre ferramentas internas.
ToolChoiceFunction	Use essa opção para forçar o modelo a chamar uma função específica.
ToolChoiceImageGeneration	Indica que o modelo deve usar uma ferramenta interna para gerar uma resposta. Learn mais sobre ferramentas internas.
ToolChoiceMCP	Use essa opção para forçar o modelo a chamar uma ferramenta específica em um servidor MCP remoto.
ToolChoiceParam	Como o modelo deve selecionar qual ferramenta (ou ferramentas) usar ao gerar uma resposta. Consulte o tools parâmetro para ver como especificar quais ferramentas o modelo pode chamar.
ToolChoiceWebSearchPreview	Indica que o modelo deve usar uma ferramenta interna para gerar uma resposta. Learn mais sobre ferramentas internas.
ToolChoiceWebSearchPreview20250311	Indica que o modelo deve usar uma ferramenta interna para gerar uma resposta. Learn mais sobre ferramentas internas.
ToolConfig	Configuração por ferramenta que controla a visibilidade da ferramenta e o comportamento de busca.
ToolDescription	Descrição de uma ferramenta que pode ser usada por um agente.
ToolProjectConnection	Um recurso de conexão project.
ToolSearchToolParam	Configuração de busca de ferramentas hospedadas ou BYOT para ferramentas diferidas.
ToolSearchToolboxTool	Uma ferramenta de busca de caixa de ferramentas armazenada em uma caixa de ferramentas.
ToolUseFineTuningDataGenerationJobOptions	As opções para um trabalho de geração de dados com o tipo ToolUse. Usado apenas para ajustes finos de cenários.
ToolboxObject	Uma caixa de ferramentas que armazena definições de ferramentas reutilizáveis para agentes.
ToolboxPolicies	Configuração de políticas para uma caixa de ferramentas, incluindo segurança de conteúdo e outras configurações de governança.
ToolboxSearchPreviewToolboxTool	Uma ferramenta de busca de caixa de ferramentas armazenada em uma caixa de ferramentas.
ToolboxShellContainerAutoEnvironment	Um ambiente de contêiner provisionado automaticamente para uma ferramenta shell armazenada em uma caixa de ferramentas.
ToolboxShellContainerReferenceEnvironment	Um ambiente de contêiner existente para uma ferramenta shell armazenada em uma caixa de ferramentas.
ToolboxShellEnvironment	Um ambiente de execução para uma ferramenta shell armazenada em uma caixa de ferramentas. Esse modelo de ambiente é direcionado para a configuração de toolbox e não modifica o contrato do ambiente do shell OpenAI.
ToolboxShellNetworkPolicy	Política de acesso à rede para um contêiner shell toolbox provisionado automaticamente.
ToolboxShellNetworkPolicyDisabled	Uma política de rede que desativa o acesso de saída a partir de um contêiner shell toolbox.
ToolboxSkill	Uma fonte de habilidades incluída em uma caixa de ferramentas.
ToolboxSkillReference	Uma referência a uma habilidade existente para incluir em uma caixa de ferramentas.
ToolboxTool	Uma representação abstrata de uma ferramenta armazenada em uma caixa de ferramentas.
ToolboxVersionObject	Uma versão específica de uma caixa de ferramentas.
ToolboxVersions	As versões associadas a uma caixa de ferramentas.
ToolboxesCreateVersionOptionalParams	Parâmetros opcionais.
ToolboxesDeleteOptionalParams	Parâmetros opcionais.
ToolboxesDeleteVersionOptionalParams	Parâmetros opcionais.
ToolboxesGetOptionalParams	Parâmetros opcionais.
ToolboxesGetVersionOptionalParams	Parâmetros opcionais.
ToolboxesInvokeLatestToolboxMcpOptionalParams	Parâmetros opcionais.
ToolboxesListOptionalParams	Parâmetros opcionais.
ToolboxesListVersionsOptionalParams	Parâmetros opcionais.
ToolboxesOperations	Interface representando as operações de uma caixa de ferramentas.
ToolboxesUpdateOptionalParams	Parâmetros opcionais.
TracesDataGenerationJobOptions	As opções para um trabalho de geração de dados com o tipo Traces.
TracesDataGenerationJobSource	Rastreamentos para trabalhos de geração de dados — traços de conversa do Application Insights.
TracesEvaluatorGenerationJobSource	Fontes de rastreamento para trabalhos de geração de avaliadores — traços de conversa do Application Insights.
TranscriptTextUsageDuration	Estatísticas de uso para modelos faturadas por duração de entrada de áudio.
TranscriptTextUsageTokens	Estatísticas de uso para modelos faturados por uso de token.
TranscriptTextUsageTokensInputTokenDetails	Interface do modelo Transcrição TextoTextoTokensEntradaTokenDetalhes
TranscriptionLanguage	Uma língua detectada em áudio transcrito.
Trigger	Modelo base para Trigger do agendamento.
TwilioTelephonyBinding	Uma encadração Twilio pertencente a um agente de voz.
TwilioTelephonyBindingListItem	Uma ligação Twilio retornava em uma lista, incluindo sua tag de entidade.
UpdateModelVersionRequest	Solicite ao corpo para atualização de uma versão do modelo. Apenas descrições e tags podem ser modificadas.
UpdateTelephonyBindingRequest	O pedido para atualizar uma ligação telefônica existente. Cada propriedade é opcional e o fornecedor da vinculação é imutável.
UpdateToolboxRequest	interface do modelo UpdateToolboxRequest
UserProfileMemoryItem	Um item de memória que contém especificamente informações de perfil de usuário extraídas de conversas, como preferências, interesses e detalhes pessoais.
VersionIndicator	Indicador de versão determinando qual versão do agente faz backup da sessão.
VersionRefIndicator	Indicador de versão que faz referência a uma versão específica do agente pelo nome.
VersionSelectionRule	Interface do modelo VersãoRegra de Seleção
VersionSelector	Interface de modelo VersionSelector
VoiceAgentAnimationConfig	Configurações de animação para uma sessão de agente de voz.
VoiceAgentAudioConfig	A configuração de áudio para um agente de voz. Esses valores são os padrões da sessão e podem ser sobrescritos ao conectar.
VoiceAgentAudioInputConfig	Configuração de áudio de entrada para um agente de voz.
VoiceAgentAudioOutputConfig	Configuração de áudio de saída para um agente de voz. Campos específicos de cada provedor são selecionados por voice_type: openai: voice e speed. azure-standard: , , , , , custom_lexicon_url, custom_text_normalization_url, prefer_localesstyle, , pitch, , e volume. voice_temperaturespeedvoice_localevoice azure-custom: todos os azure-standard corpos exceto style, mais custom_voice_endpoint_id. azure-personal: todos os azure-standard corpos exceto style, mais personal_voice_model. avatar-voice-sync: todos azure-standard os campos, exceto voice e style, mais personal_voice_model; o nome da voz é derivado do avatar. azure-realtime-native: voice e speed. format e output_audio_timestamp_types se aplica a todos os tipos de voz.
VoiceAgentAvatarConfig	Configuração de avatar para um agente de voz. Esses valores são os padrões da sessão e podem ser sobrescritos ao conectar.
VoiceAgentAvatarIceServer	Um servidor ICE usado para negociação de avatares WebRTC.
VoiceAgentAvatarScene	Posicionamento do avatar e configurações de movimento.
VoiceAgentAvatarVideoBackground	O fundo do vídeo do avatar.
VoiceAgentAvatarVideoCrop	O corte retangular aplicado ao vídeo avatar.
VoiceAgentAvatarVideoParams	Codificador de vídeo Avatar e configurações de apresentação.
VoiceAgentAvatarVideoResolution	A resolução do vídeo do avatar.
VoiceAgentAzureSemanticVadEnTurnDetection	Detecção de atividade semântica de voz do Azure otimizada para inglês.
VoiceAgentAzureSemanticVadMultilingualTurnDetection	Detecção de atividade semântica de voz do Azure multilíngue.
VoiceAgentAzureSemanticVadTurnDetection	Azure detecção semântica de atividade de voz.
VoiceAgentCancelResponseOptions	Opções para cancelar uma resposta.
VoiceAgentClientEventRtcCallSdpCreate	O rtc.call.sdp.create evento do cliente: inicia a sinalização do WebRTC com uma oferta SDP.
VoiceAgentClientEventSessionAvatarConnect	O session.avatar.connect evento com o cliente.
VoiceAgentClientEventSessionUpdate	O session.update evento com o cliente.
VoiceAgentCloseResult	Resultado fornecido quando a conexão de um agente de voz é encerrada.
VoiceAgentConnection	Um fluxo de agente de voz bidirecional conectado. Suporta exatamente uma for await iteração sobre eventos do servidor; uma segunda tentativa lança. Sair do loop antes do tempo (break, return, ou um erro não detectado no corpo do loop) fecha a conexão como efeito colateral. Tipos de eventos de servidor não reconhecidos são entregues como VoiceAgentUnknownEvent sem interromper a transmissão. Eventos malformados ainda falham na iteração com um erro de protocolo.
VoiceAgentDefinition	A definição de agente de voz. Sua configuração (modelo, instruções, áudio, ferramentas e avatar opcional) impulsiona uma experiência gerenciada de fala para fala. Estabeleça sessões de voz em tempo real através GET /agents/{agent_name}/endpoint/protocols/voicede . Cada criação ou atualização gera uma nova versão imutável.
VoiceAgentEchoCancellation	Configurações de cancelamento de eco do lado do servidor para áudio de entrada.
VoiceAgentEndConversationSystemTool	Um controle gerenciado por serviços que encerra a conversa ativa.
VoiceAgentEndOfUtteranceDetection	Configuração semântica de detecção de fim de enunciado.
VoiceAgentEventOptions	Opções compartilhadas por operações que constroem um evento de protocolo em nome do chamador.
VoiceAgentFunctionTool	Uma ferramenta de função nativa executada pelo cliente.
VoiceAgentGreetingConfig	Configuração de saudação de início de sessão para um agente de voz.
VoiceAgentInputTranscription	Configuração assíncrona de entrada e transcrição áudio. Amplia as opções de transcrição em tempo real do OpenAI com os modelos de transcrição Azure e MAI, modelos personalizados de fala e dicas de frase.
VoiceAgentInterimResponseConfig	Campos compartilhados por configurações de resposta intermediária.
VoiceAgentLlmGeneratedGreetingConfig	Uma saudação criada pelo modelo de sessão a partir de um prompt de abertura com escopo.
VoiceAgentLlmInterimResponseConfig	Uma resposta intermediária gerada por um modelo de linguagem.
VoiceAgentMcpTool	Uma ferramenta MCP disponível para um agente de voz.
VoiceAgentNoiseReduction	Configuração de redução de ruído de áudio de entrada.
VoiceAgentRealtimeClientConnectOptions	Opções para conectar o cliente em tempo real a um agente de voz.
VoiceAgentRealtimeClientOptions	Opções para o cliente em tempo real Voice Agents.
VoiceAgentRealtimeResponse	Uma resposta ao vivo em tempo real retornada pelo serviço de agente de voz em ambos response.createdresponse.done os eventos.
VoiceAgentRealtimeResponseBase	Propriedades compartilhadas por respostas em tempo real retornadas pelo serviço de agente de voz.
VoiceAgentResponseCreateParams	Parâmetros aceitos por um evento de agente response.create de voz.
VoiceAgentResponseOptions	Opções para criar uma resposta.
VoiceAgentRtcCallErrorDetails	Detalhes de um erro de sinalização WebRTC.
VoiceAgentSemanticVadTurnDetection	Configurações semânticas de detecção de curva VAD da OpenAI.
VoiceAgentSendItemOptions	Opções compartilhadas por operações que adicionam um item de conversa e, por padrão, solicitam uma resposta.
VoiceAgentSendOptions	Opções compartilhadas por operações de envio em tempo real.
VoiceAgentSendTextOptions	Opções para enviar texto de entrada.
VoiceAgentSendToolOutputOptions	Opções para retornar um resultado de função.
VoiceAgentServerEventResponseAnimationBlendshapesDelta	O response.animation_blendshapes.delta evento do servidor.
VoiceAgentServerEventResponseAnimationBlendshapesDone	O response.animation_blendshapes.done evento do servidor.
VoiceAgentServerEventResponseAnimationVisemeDelta	O response.animation_viseme.delta evento do servidor.
VoiceAgentServerEventResponseAnimationVisemeDone	O response.animation_viseme.done evento do servidor.
VoiceAgentServerEventResponseAudioTimestampDelta	O response.audio_timestamp.delta evento do servidor.
VoiceAgentServerEventResponseAudioTimestampDone	O response.audio_timestamp.done evento do servidor.
VoiceAgentServerEventResponseVideoDelta	O response.video.delta evento do servidor.
VoiceAgentServerEventRtcCallError	O rtc.call.error evento do servidor: uma falha de sinalização WebRTC.
VoiceAgentServerEventRtcCallSdpCreated	O rtc.call.sdp.created evento do servidor: a resposta SDP que completa a negociação do WebRTC.
VoiceAgentServerEventSessionAvatarConnecting	O session.avatar.connecting evento do servidor.
VoiceAgentServerEventSessionAvatarSwitchToIdle	O session.avatar.switch_to_idle evento do servidor.
VoiceAgentServerEventSessionAvatarSwitchToSpeaking	O session.avatar.switch_to_speaking evento do servidor.
VoiceAgentServerEventSessionSubagentAborted	O session.subagent.aborted evento do servidor.
VoiceAgentServerEventSessionSubagentCompleted	O session.subagent.completed evento do servidor.
VoiceAgentServerEventSessionSubagentStarted	O session.subagent.started evento do servidor.
VoiceAgentServerEventWarning	O warning evento do servidor.
VoiceAgentServerEventWarningDetails	Detalhes de um aviso não fatal.
VoiceAgentServerVadTurnDetection	Detecção de atividade de voz no servidor.
VoiceAgentSessionAvatarConfig	Configurações de avatar aceitas pelo contrato WebSocket de agente de voz estável.
VoiceAgentSessionResponseConfig	As configurações estáveis de sessão em tempo real retornadas pelo serviço de agente de voz.
VoiceAgentSessionUpdateConfig	As configurações estáveis de sessão em tempo real aceitas em um session.update evento cliente.
VoiceAgentSessionUpdateOptions	Opções para atualizar a sessão ao vivo.
VoiceAgentStaticInterimResponseConfig	Uma resposta intermédia estática selecionada de texto configurado.
VoiceAgentSubagent	Um agente de texto irmão da Foundry que um agente de voz pode consultar como especialista em bastidores.
VoiceAgentSubagentConfig	Configuração para agentes de texto irmãos do Foundry que um agente de voz pode consultar.
VoiceAgentSubagentResponsePolicy	Política para entregar respostas enquanto um agente de voz espera por um subagente.
VoiceAgentSystemTool	Um controle gerenciado por serviços que atua na sessão de voz ativa sem código do cliente ou autenticação externa.
VoiceAgentTemplateGreetingConfig	Uma saudação determinística renderizada com as entradas estruturadas do agente de voz e sintetizada sem geração criada pelo modelo.
VoiceAgentTool	Uma ferramenta utilizável por um agente de voz.
VoiceAgentToolboxTool	Uma referência a uma caixa de ferramentas Foundry, que é um pacote versionado de ferramentas executado através de seu endpoint MCP.
VoiceAgentTranscriptionPhrase	Uma frase transcrita com informações de tempo.
VoiceAgentTranscriptionWord	Uma palavra com carimbo de hora em uma transcrição de áudio de entrada.
VoiceAgentTurnDetectionConfig	Configuração de detecção de curva para um agente de voz.
VoiceAgentUnknownEvent	Um evento de servidor cujo tipo de fio não é reconhecido por esta versão do SDK. O SDK entrega esses eventos sem fechar a conexão ou aplicar validação ou normalização de eventos conhecidos. Inspecione e valide os campos brutos antes de usá-los.
VoiceAgentWebSocketConnectOptions	Opções passadas para VoiceAgentWebSocketTransport.connect.
VoiceAgentWebSocketFactory	Cria instâncias de VoiceAgentWebSocketTransport para VoiceAgentRealtimeClient.
VoiceAgentWebSocketHandlers	Retornos de chamada invocados por um VoiceAgentWebSocketTransport à medida que eventos de conexão ocorrem.
VoiceAgentWebSocketTransport	Um transporte WebSocket plugável usado pelo VoiceAgentRealtimeClient. Implemente essa interface para personalizar como a conexão em tempo real é estabelecida, por exemplo, para roteá-la por um relé autenticado.
VoiceAudioItem	Metadados para o segmento de áudio de um único item de conversa. Para o armazenamento de bring your-own-storage (BYOS), a resposta inclui blob_uri, um URI de armazenamento direto do cliente sem token SAS, que o cliente acessa com suas próprias credenciais. Para armazenamento gerenciado pela Foundry, blob_uri está ausente e os bytes são transmitidos pela rota do /audio/content item.
VoiceConversation	Uma conversa persistente de voz. O envelope da Foundry que possui a transcrição armazenada do agente de voz, respostas, métricas por turno e áudio. É o parent, retenção e limite de exclusão: exclui-lo faz cascata para suas respostas, itens, métricas e áudio. Quando a finalização falha, quaisquer respostas parciais persistentes, itens e áudio do item permanecem legíveis.
VoiceConversationEngine	Um motor que gerencia conversas para um agente de voz.
VoiceGeneratedAudioItem	Metadados do áudio gerado por um item de conversa. Para o armazenamento de bring your-own-storage (BYOS), a resposta inclui blob_uri, um URI de armazenamento direto do cliente sem token SAS, que o cliente acessa com suas próprias credenciais. Para armazenamento gerenciado pela Foundry, blob_uri está ausente e os bytes são transmitidos pela rota do /audio/generated/content item.
VoiceHostedAgentConversationEngine	Uma referência fechada ao agente de texto hospedado que é responsável pelo manejo de conversas para um agente de voz. O agente hospedado é resolvido dentro do mesmo projeto e deve suportar o invocations_ws protocolo, compatibilidade com Voice Live e Bridge Protocol 1.0.
VoiceRecording	Metadados para a gravação estéreo mesclada de toda a chamada de uma conversa de voz (áudio do usuário no canal esquerdo, áudio do agente no direito). Construído uma vez a partir dos segmentos por turno após o término da sessão e armazenado em cache de forma duradoura. Os metadados comuns (formato, taxa de amostragem, canais, layout do canal, duração) são retornados tanto para gravações gerenciadas pela Foundry quanto para gravações de transporte de armazenamento próprio (BYOS). Para BYOS, a resposta também inclui blob_uri, o URI da gravação no armazenamento próprio do cliente (sem token SAS), que o cliente baixa usando suas próprias credenciais de armazenamento. Para o armazenamento gerenciado blob_uri pela Foundry, não existe e os bytes são transmitidos pela /audio/content rota.
VoiceRecordingChannelLayout	A função atribuída a cada canal de uma gravação de voz estéreo mesclada.
VoiceResponse	Uma resposta de voz persistente representando uma reviravolta de inferência do modelo dentro de uma conversa. Nos resultados da lista, a output projeção pode ser omitida; recupere a resposta completa (GET .../responses/{response_id}) ou a rota dos itens de resposta paginados (GET .../responses/{response_id}/items) para seus itens de saída. created_at / completed_at são extensões duráveis de ordenação da Foundry.
VoiceResponseAudio	Configuração de áudio para uma resposta. Segue o formato do objeto OpenAI Realtime GA audio .
VoiceResponseAudioOutput	A projeção de saída de áudio de resposta plana, com opcionais voice, voice_type, voice_locale, e format campos.
VoiceResponseBase	Propriedades compartilhadas por respostas de voz persistentes.
WebIQPreviewTool	Uma ferramenta WebIQ para o lado do servidor.
WebIQPreviewToolboxTool	Uma ferramenta WebIQ armazenada em uma caixa de ferramentas.
WebSearchApproximateLocation	A localização aproximada do usuário.
WebSearchConfiguration	Uma configuração de pesquisa na Web para bing pesquisa personalizada
WebSearchPreviewTool	Essa ferramenta busca na internet resultados relevantes para usar em uma resposta. Saiba mais sobre a ferramenta de pesquisa web.
WebSearchTool	Pesquise na Internet fontes relacionadas ao prompt. Saiba mais sobre a ferramenta de pesquisa web.
WebSearchToolFilters	interface de modeloFiltrosFerramenta de Busca WebSearchTools
WebSearchToolboxTool	Uma ferramenta de busca na web armazenada em uma caixa de ferramentas.
WeeklyRecurrenceSchedule	Cronograma de recorrência semanal.
WorkIQPreviewTool	Uma ferramenta WorkIQ para o lado do servidor.
WorkIQPreviewToolboxTool	Uma ferramenta WorkIQ armazenada em uma caixa de ferramentas.
WorkflowAgentDefinition	A definição do agente de fluxo de trabalho.

Aliases de tipo

A2AProtocolVersion	Versões do protocolo A2A suportadas.
ActivityProtocolAccessBoundary	Um limite de acesso para o protocolo de atividade.
AgentBlueprintReferenceType	Tipo de AgentTipoReferênciaTipo de Recurso
AgentBlueprintReferenceUnion	Alias para AgentBlueprintReferenceUnion
AgentDefinitionOptInKeys	Chaves de opt-in de recursos para operações de definição de agentes que suportam recursos de pré-visualização condicional.
AgentDefinitionUnion	Tipo de união para todos os tipos de definição de agente. Suporta workflow, hospedado, app de container, prompt e agentes externos.
AgentEndpoint	Configuração para roteamento, protocolos e autorização em um ponto final do agente.
AgentEndpointAuthorizationSchemeType	Tipo de AgenteEndpointAutorizaçãoSchemaType
AgentEndpointAuthorizationSchemeUnion	Alias for AgentEndpointAuthorizationSchemeUnion
AgentHarnessUnion	Alias para AgentHarnessUnion
AgentIdentityStatus	O status da identidade de um agente, aplicável tanto à identidade da instância do agente quanto ao blueprint do agente.
AgentInsightJsonValue	Um valor JSON usado em payloads do Agent Insights.
AgentInsightOverviewSource	Identifica de onde veio uma visão geral do Agent Insights.
AgentInsightPromptSurface	A superfície do Prompt foi alterada por uma solução proposta.
AgentInsightProposedFixKind	O tipo de solução proposta pelo agente que pode renderizar o cliente.
AgentInsightRunTrigger	O gatilho que iniciou uma run de insight de agente.
AgentInsightSeverity	A gravidade da percepção de um agente.
AgentInsightStatus	O status do ciclo de vida de um insight de agente.
AgentKind	Define o tipo/tipo de agente. Determina qual estrutura de definição de agente é usada.
AgentOptimizationDatasetInputType	Valores discriminadores para a união de entrada do conjunto de dados.
AgentOptimizationDatasetInputUnion	Alias para AgentOptimizationDatasetInputUnion
AgentProtocol	Tipo de AgentProtocol
AgentSessionStatus	O status de uma sessão de agente.
AgentState	O estado operacional de um agente.
AgentStateSource	Indica a origem do estado operacional do agente. Vazio quando o estado não é derivado de uma fonte específica.
AgentType	Tipo de AgentType
AgentVersionStatus	O status de provisionamento de uma versão agente.
AgentsDownloadAgentCodeResponse	O arquivo ZIP baixado contendo código agente hospedado, exposto como um Blob do navegador ou Node.js fluxo legível.
AgentsDownloadSessionFileResponse	O arquivo de sessão do agente baixado, exposto como um Blob do navegador ou Node.js fluxo legível.
AgentsPatchAgentObjectOptionalParams	Parâmetros opcionais.
AttackStrategy	Estratégias para ataques.
AzureAISearchQueryType	Tipos de consulta disponíveis para a ferramenta Pesquisa de IA do Azure .
BaseCredentialsUnion	Alias para BaseCredentialsUnion
BetaSkillsDownloadResponse	O arquivo ZIP para a versão padrão de uma habilidade, exposto como um Blob do navegador ou Node.js fluxo legível.
BetaVoiceAgentsConversationsDownloadAudioItemResponse	O áudio WAV de um item de conversa, exposto como um Blob do navegador ou Node.js fluxo legível.
BetaVoiceAgentsConversationsDownloadAudioResponse	A gravação estéreo WAV fundida de uma conversa de voz, exposta como um Blob do navegador ou Node.js fluxo legível.
BetaVoiceAgentsConversationsDownloadGeneratedAudioItemResponse	O áudio WAV gerado para um item de conversa interrompido, exposto como um Blob do navegador ou Node.js fluxo legível.
CallableToolAllowedCaller	Tipo de ChamadorFerramentaPermitida
CodeDependencyResolution	Como as dependências de pacotes são resolvidas na época da implantação para um agente hospedado baseado em código.
ComparisonFilterValueItems	Alias para ComparaçãoFilterValueItems
ComputerEnvironment	Tipo de Ambiente de Computador
ConnectionType	O tipo (ou categoria) da conexão
ContainerMemoryLimit	Tipo de ContainerMemoryLimit
ContainerNetworkPolicyParamType	Tipo de ContainerNetworkPolicyParamType
ContainerNetworkPolicyParamUnion	Alias para ContainerNetworkPolicyParamUnion
ContainerSkillType	Tipo de ContainerSkillType
ContainerSkillUnion	Alias para ContainerSkillUnion
ContinuablePage	Uma interface que descreve uma página de resultados.
CreateTelephonyBindingRequestUnion	Alias para CreateTelephonyBindingRequestUnion
CreateTranscriptionResponseJsonUsageType	Tipo de CriarRespostaTranscriçãoJsonUsoTipo
CreateTranscriptionResponseJsonUsageUnion	Alias para CreateTranscriptionResponseJsonUsageUnion
CredentialType	O tipo de credencial usado pela conexão
CustomToolParamFormatType	Tipo de CustomToolParamFormatType
CustomToolParamFormatUnion	Alias for CustomToolParamFormatUnion
DataGenerationJobOptionsUnion	Alias para DataGeraçãoOpçõesEmprego União
DataGenerationJobOutputType	Os tipos de arquivo de saída suportados para um trabalho de geração de dados.
DataGenerationJobOutputUnion	Alias-deDadasGeraçãoEmpregoSaídaSindicato
DataGenerationJobOutputWriteMode	Os modos de escrita suportados para saídas de trabalhos de geração de dados.
DataGenerationJobScenario	Os cenários suportados para um trabalho de geração de dados.
DataGenerationJobSourceType	Os tipos de fonte suportados para trabalhos de geração de dados.
DataGenerationJobSourceUnion	Alias para DataGenerationJobSourceUnion
DataGenerationJobType	Os tipos de trabalho de geração de dados suportados.
DatasetType	Enumerar para determinar o tipo de dados.
DatasetVersionUnion	Alias para DatasetVersionUnion
DayOfWeek	Dias da semana para cronograma de recorrência.
DeploymentType	Tipo de DeploymentType
DeploymentUnion	Alias para DeploymentUnion
DigitalWorkerType	O tipo de trabalhador digital.
DownloadVersionResponse	O arquivo ZIP para uma versão específica de habilidade, exposto como um Blob do navegador ou Node.js fluxo legível.
EvaluationLevel	O nível em que a avaliação é realizada.
EvaluationRuleActionType	Tipo de ação de avaliação.
EvaluationRuleActionUnion	Alias para EvaluationRuleActionUnion
EvaluationRuleEventType	Tipo do evento de regra de avaliação.
EvaluationTargetUnion	Nome de Avaliação SindicatoAlvo
EvaluationTaxonomyInputType	Tipo de entrada da taxonomia de avaliação.
EvaluationTaxonomyInputUnion	Alias para EvaluationTaxonomyInputUnion
EvaluatorCategory	A categoria do avaliador
EvaluatorDefinitionType	O tipo de definição do avaliador
EvaluatorDefinitionUnion	Alias para EvaluatorDefinitionUnion
EvaluatorGenerationJobSourceType	Os tipos de fonte suportados para trabalhos de geração de avaliadores.
EvaluatorGenerationJobSourceUnion	Alias para AvaliatorGenerationJobSourceUnion
EvaluatorMetricDirection	A direção da métrica que indica se um valor mais alto é melhor, um valor mais baixo é melhor ou neutro
EvaluatorMetricType	O tipo de avaliador
EvaluatorType	O tipo de avaliador
FileContents	Valores válidos para o conteúdo de um arquivo binário.
Filters	Alias para Filtros
FoundryFeaturesOptInKeys	Tipo de FoundryFeaturesOptInKeys
FoundryModelArtifactProfileCategory	A categoria de perfil de artefatos.
FoundryModelArtifactProfileSignal	Sinais detectados no artefato do modelo.
FoundryModelSourceType	O tipo de origem do modelo.
FoundryModelWarningCode	Código de aviso para artefatos de modelos.
FoundryModelWeightType	O tipo de peso do modelo.
FunctionShellToolParamEnvironmentType	Tipo de FunçãoShellToolParamEnvironmentType
FunctionShellToolParamEnvironmentUnion	Alias para FunctionShellToolParamEnvironmentUnion
GenerateAgentRequest	As entradas específicas de tipo para gerar e criar um agente.
GenerationWarningType	Categoria de um aviso surgiu em uma versão gerada pelo avaliador. Extensível para que novas categorias de alerta (por exemplo, segurança, qualidade de saída) possam ser introduzidas sem uma alteração interrompida.
GetMicrosoft365PackageResponse	O pacote binário do aplicativo Microsoft 365 gerado para um agente Foundry.
GitHubCopilotBuiltInTool	Uma ferramenta integrada do GitHub Copilot configurável pelo cliente.
GitHubIssueEvent	Eventos conhecidos no GitHub emitem que podem disparar uma rotina.
GrammarSyntax	Tipo de GramáticaSintaxe
ImageGenAction	Tipo de ImageGenAction
IndexType	Tipo de IndexType
IndexUnion	Alias para IndexUnion
InputFidelity	Controlar o esforço que o modelo exercerá para corresponder ao estilo e aos recursos, especialmente os recursos faciais, das imagens de entrada. Esse parâmetro é suportado apenas para gpt-image-1 e gpt-image-1.5 modelos posteriores, não suportados para gpt-image-1-mini. Oferece suporte para high e low. Usa low como padrão.
InsightRequestUnion	Alias para InsightRequestUnion
InsightResultUnion	Alias para InsightResultUnion
InsightSampleUnion	Alias para InsightSampleUnion
InsightType	O pedido dos insights.
JobPoller	Um pesquisador para uma operação de longa duração que gera um recurso de emprego.
JobStatus	Valores de status extensíveis compartilhados pelos empregos da Foundry.
MemoryItemKind	Tipo de item de memória.
MemoryItemUnion	Alias para MemoryItemUnion
MemoryOperationKind	Tipo de operação de memória.
MemoryStoreDefinitionUnion	Alias para MemoryStoreDefinitionUnion
MemoryStoreKind	O tipo de implementação de armazenamento de memória a ser usada.
MemoryStoreType	Tipo de MemoryStoreType
MemoryStoreUpdateStatus	Status de uma operação de atualização do repositório de memória.
Microsoft365PublishScope	O escopo de publicação para o aplicativo Microsoft Teams gerado.
MisalignmentErrorType	Uma classificação de uma ação que pode não estar alinhada com a intenção do usuário. Valores adicionais podem ser retornados.
NodeReadableStream	Digite o alias para Node.js ReadableStream. Nos alvos Node, isso se resolve para o tipo NodeJS.ReadableStream real. Nos alvos nativos do navegador/react, a variante da plataforma resolve para never, que naturalmente sai dos tipos de união.
OpenApiAuthDetailsUnion	Alias para OpenApiAuthDetailsUnion
OpenApiAuthType	Tipo de autenticação para o ponto de extremidade OpenApi. Os tipos permitidos são: Anônimo (sem necessidade de autenticação) Project Conexão (requer project_connection_id para o endpoint, conforme configurado no AI Foundry) Managed_Identity (requer público-alvo para autenticação baseada em identidade)
OperationState	Enumeração que descreve os estados de operação permitidos.
OptimizationAgentIdentifier	Identifica o agente registrado da Foundry e a versão opcional a otimizar.
OptimizationCandidate	As mudanças de configuração e os resultados agregados da avaliação para um candidato à otimização de agentes.
OptimizationDatasetCriterion	Uma instrução de avaliação nomeada usada para pontuar um item de conjunto de dados de otimização.
OptimizationDatasetInput	A descrição básica de um conjunto de dados inline ou registrado fornecida para um trabalho de otimização de agentes.
OptimizationDatasetInputType	As formas suportadas de entrada de conjunto de dados de otimização: itens inline ou uma referência registrada de conjunto de dados.
OptimizationDatasetInputUnion	Um conjunto de dados de otimização fornecido como itens inline ou uma referência a um conjunto de dados registrado na Foundry.
OptimizationDatasetItem	Um item de conjunto de dados de otimização inline contendo uma consulta, resposta esperada e critérios de avaliação.
OptimizationEvaluatorRef	Uma referência a um avaliador pelo nome e versão opcional para um trabalho de otimização de agente.
OptimizationInlineDatasetInput	Itens do conjunto de dados de otimização fornecidos diretamente no corpo da solicitação.
OptimizationJob	Um trabalho de otimização de agentes que acompanha entradas, progresso, status e resultados de avaliação de candidatos.
OptimizationJobInputs	O agente, conjuntos de dados, avaliadores e opções fornecidos a um trabalho de otimização de agentes.
OptimizationJobListItem	Um resumo de um trabalho de otimização de agente retornado por uma operação de lista.
OptimizationJobProgress	Um snapshot de progresso contendo contagens de candidatos concluídos, a melhor pontuação e o tempo de execução decorrido.
OptimizationJobResult	Os candidatos avaliados e identificadores da linha de base e do melhor candidato de um trabalho de otimização.
OptimizationOptions	Configurações que controlam a geração de candidatos, seleção de modelos e avaliação para um trabalho de otimização de agentes.
OptimizationReferenceDatasetInput	Uma referência a um conjunto de dados registrado da Foundry pelo nome e versão opcional para otimização de agentes.
PageOrder	Tipo de Ordem de Página
PendingUploadType	O tipo de upload pendente.
PublishApprovalStatus	O status de revisão da Certificação de Agente Microsoft do título da loja Microsoft 365 publicado para um agente.
RaiInvocationContentType	Como o corpo de solicitação/resposta de uma invocação é analisado para localizar texto para moderação de segurança de conteúdo.
RaiInvocationMode	Forma de resposta declarada pelo autor para o protocolo de invocações.
RankerVersionType	Tipo de RankerVersionType
RealtimeAudioFormatsType	Tipo de RealtimeAudioFormatosType
RealtimeAudioFormatsUnion	Alias para RealtimeAudioFormatsUnion
RealtimeClientEventType	Tipo de RealtimeClienteEventType
RealtimeClientEventUnion	Alias para RealtimeClientEventUnion
RealtimeConversationItemMessageType	Tipo de Tipo de MensagemConversaConversaRealTempo
RealtimeConversationItemMessageUnion	Alias para RealtimeConversationItemMessageUnion
RealtimeConversationItemType	Tipo de Tipo de ItemType de Conversa em Tempo Real
RealtimeConversationItemUnion	Alias para RealtimeConversationItemUnion
RealtimeFunctionToolParameters	interface do modelo Tempo realFunçãoParâmetros da Ferramenta
RealtimeMCPErrorType	Tipo de RealtimeMCPErrorType
RealtimeMCPErrorUnion	Nome alternativo para RealtimeMCPErrorUnion
RealtimeReasoningEffort	Restringe o esforço no raciocínio para modelos em tempo real com capacidade de raciocínio, como gpt-realtime-2.
RealtimeServerEventType	Tipo de RealtimeServerEventType
RealtimeServerEventUnion	Alias para RealtimeServerEventUnion
ReasoningEffort	Limita o esforço de raciocínio em modelos de raciocínio. Os valores atualmente suportados são none, minimal, low, medium, high, e xhigh. A redução do esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados no raciocínio de uma resposta. gpt-5.1 por padrão é none, que não executa raciocínio. Os valores de raciocínio suportados para gpt-5.1 são none, low, medium, e high. Há suporte para chamadas de ferramenta para todos os valores de raciocínio no gpt-5.1. Todos os modelos anteriores gpt-5.1 padrão para medium o esforço de raciocínio, e não suportam none. O gpt-5-pro modelo usa (e suporta high ) apenas o esforço de raciocínio. xhigh é suportado para todos os modelos após gpt-5.1-codex-max.
ReasoningModeEnum	Alias para ReasoningModeEnum
RecurrenceScheduleUnion	Alias para RecurrenceScheduleUnion
RecurrenceType	Tipo de recorrência.
RedTeamTargetConfigUnion	Alias para RedTeamTargetConfigUnion
RiskCategory	Categoria de risco para o objetivo do ataque.
RoutineActionType	Os valores discriminadores suportados para ações rotineiras.
RoutineActionUnion	Nome de RotinaAçãoUnião
RoutineAttemptSource	Caminhos de origem conhecidos que podem produzir uma execução rotineira.
RoutineDispatchIdentity	As identidades suportadas para autorização rotineira de despacho.
RoutineDispatchPayloadType	Os valores discriminadores suportados para cargas úteis de despacho rotineiro manual.
RoutineDispatchPayloadUnion	Alias para RotinaDispatchPayloadUnion
RoutineRunPhase	Fases conhecidas do ciclo de vida registradas para uma execução rotineira.
RoutineRunStatus	O status de uma corrida rotineira.
RoutineTriggerType	Os valores do discriminador suportados para gatilhos rotineiros.
RoutineTriggerUnion	Alias para RoutineTriggerUnion
RubricGenerationInputQualityWarningCode	Código de aviso estável, pesquisável e legível por máquina para um aviso de qualidade de entrada gerado por rubrica. Os valores são snake_case; os clientes devem tolerar identificadores adicionais definidos pelo serviço.
RubricGenerationInputQualityWarningSeverity	Severidade do aviso para um alerta de qualidade de entrada por geração de rubricas. Conjunto inicial de valores: warning.
RubricGenerationInputQualityWarningSource	Atribuição da fonte do aviso para um aviso de qualidade de entrada por geração de rubrica. Valores por fonte (prompt, agent, dataset) correspondem à categoria de origem visível para o runtime de geração. aggregate é um valor sintético usado apenas para avisos calculados entre fontes resolvidas com sucesso. traces não é exposto porque as fontes de rastreamento se resolvem em conteúdo do conjunto de dados a montante.
RunPoller	Um poller para uma operação de longa duração que cria um recurso de execução.
SampleType	O tipo de amostra usada na análise.
ScheduleProvisioningStatus	Agende o status de provisionamento.
ScheduleTaskType	Tipo da tarefa.
ScheduleTaskUnion	Alias para ScheduleTaskUnion
SearchContentType	Tipo de SearchContentType
SearchContextSize	Tipo de BuscaContextoTamanhoContexto
SessionLogEventType	Tipos conhecidos de eventos SSE emitidos pelo fluxo de log de sessão do agente hospedado. Tipos adicionais de eventos podem ser introduzidos em versões futuras.
SimpleQnAFineTuningQuestionType	Os tipos de perguntas suportados para trabalhos de geração de dados no SimpleQnA usados para ajustes finos de cenários.
TelemetryDataKind	O tipo de dados de telemetria a serem exportados.
TelemetryEndpointAuthType	O tipo de autenticação para um endpoint de telemetria.
TelemetryEndpointAuthUnion	Alias para TelemetryEndpointAuthUnion
TelemetryEndpointKind	O tipo de endpoint de exportação de telemetria.
TelemetryEndpointUnion	Alias for TelemetryEndpointUnion
TelemetryTransportProtocol	O protocolo de transporte para exportação de telemetria.
TelephonyBindingListItemUnion	Alias for TelephonyBindingListItemUnion
TelephonyBindingStatus	O status do ciclo de vida de uma ligação de telefonia.
TelephonyBindingUnion	Alias: TelephonyBindingUnion
TelephonyCallDurationBasis	O carimbo de data usado como base para a duração da chamada.
TelephonyCallEndReason	Razões conhecidas geradas por serviços que levaram uma chamada telefônica ao fim, em vez de razões para um trabalho geral de chamada de saída. Códigos de string adicionais podem ser retornados.
TelephonyCallJobStatus	O status de ciclo de vida de um serviço durável de chamada de saída.
TelephonyCallJobTerminalReason	Razões terminais conhecidas para um trabalho geral de chamada de saída, que pode abranger várias tentativas de provedores. Esses fatores são distintos dos motivos do ciclo de vida individual das chamadas. Códigos de string adicionais podem ser retornados.
TelephonyCallLifecycleEventName	Um nome de evento de ciclo de vida neutro em relação ao provedor. Valores conhecidos são estáveis; valores adicionais podem ser adicionados ao longo do tempo.
TelephonyCallLifecycleEventOutcome	O resultado de uma observação do ciclo de vida da telefonia.
TelephonyCallLifecycleEventReason	Razões conhecidas geradas pelo serviço para um evento do ciclo de vida da telefonia. Uma razão de evento não necessariamente descreve o resultado final da chamada. Códigos de string adicionais podem ser retornados.
TelephonyCallLifecycleEventSource	O componente que fornecia a observação do ciclo de vida da telefonia.
TelephonyCallPhase	A fase neutra do provedor alcançada por uma chamada telefônica recebida.
TelephonyCallStatus	O status do ciclo de vida de uma chamada telefônica recebida.
TelephonyCallTimestampSource	A fonte de um timestamp do ciclo de vida da telefonia.
TelephonyCallTraceMode	O modo usado para expor uma chamada telefônica como um rastreamento Foundry voltado para o cliente.
TelephonyCallTraceStatus	O status de disponibilidade de um rastreamento de chamada telefônica voltado para o cliente.
TelephonyOutboundDestinationType	O tipo de destino para uma chamada de saída.
TelephonyOutboundRetryPolicyType	A estratégia de retentativa para uma chamada de saída.
TelephonyOutboundRetryPolicyUnion	Nome de TelefoniaOutboundRetryPolicyUnion
TelephonyProvider	Um provedor de telefonia suportado por um vinculante de agente. Valores conhecidos são estáveis; valores adicionais podem ser adicionados ao longo do tempo.
TelephonyTransferDestinationKind	O tipo de destino de transferência telefônica. Valores conhecidos são estáveis; valores adicionais podem ser adicionados ao longo do tempo.
TelephonyTransferDestinationUnion	Alias para TelephonyTransferDestinationUnion
TextResponseFormatConfigurationType	Tipo de TextoRespostaFormatoConfiguraçãoTipo
TextResponseFormatConfigurationUnion	Suportava configurações para texto simples e respostas JSON estruturadas.
TextResponseFormatUnion	Alias para TextResponseFormatUnion
ToolChoiceOptions	Controla qual ferramenta (se houver) é chamada pelo modelo. none significa que o modelo não chamará nenhuma ferramenta e, em vez disso, gerará uma mensagem. auto significa que o modelo pode escolher entre gerar uma mensagem ou chamar uma ou mais ferramentas. required significa que o modelo deve chamar uma ou mais ferramentas.
ToolChoiceParamType	Tipo de ToolChoiceParamType
ToolChoiceParamUnion	Alias para ToolChoiceParamUnion
ToolSearchExecutionType	Tipo de ToolSearchExecutionType
ToolType	Tipo de Tipo de Ferramenta
ToolUnion	Alias para ToolUnion
ToolboxShellEnvironmentUnion	Alias para ToolboxShellEnvironmentUnion
ToolboxShellNetworkPolicyUnion	Alias para ToolboxShellNetworkPolicyUnion
ToolboxSkillUnion	Alias: ToolboxSkillUnion
ToolboxToolType	Tipos de ferramentas suportados para ferramentas armazenadas em uma caixa de ferramentas.
ToolboxToolUnion	Alias para ToolboxToolUnion
ToolboxesInvokeLatestToolboxMcpResponse	A resposta retornou pelo endpoint MCP mais recente do toolbox.
TreatmentEffectType	Tipo de efeito de tratamento.
TriggerType	Tipo do gatilho.
TriggerUnion	Alias para TriggerUnion
VersionIndicatorType	O tipo de indicador de versão usado para determinar a versão do agente que faz backup de uma sessão.
VersionIndicatorUnion	Alias para VersionIndicatorUnion
VersionSelectionRuleType	Tipo de VersãoSeleçãoRegraTipo
VersionSelectionRuleUnion	Alias para VersionSelectionRuleUnion
VoiceAgentAnimationOutputType	Uma animação produzida por uma sessão de agente de voz.
VoiceAgentAudioTimestampType	Um tipo de timestamp de áudio de saída suportado por um agente de voz.
VoiceAgentAvatarOutputProtocol	O transporte usado para entregar a transmissão de vídeo do avatar.
VoiceAgentAvatarType	O tipo avatar.
VoiceAgentClientEvent	Uma mensagem v1 estável enviada por um cliente via WebSocket com agente de voz.
VoiceAgentConnectionState	Os estados de conexão são reportados por uma conexão em tempo real com agente de voz.
VoiceAgentConnectionStateChangedHandler	É chamado quando uma conexão de voz muda de estado.
VoiceAgentEchoCancellationReferenceSource	A fonte de áudio de referência usada para cancelamento de eco.
VoiceAgentEndOfUtteranceDetectionModel	O modelo semântico de detecção de fim de enunciado.
VoiceAgentEndOfUtteranceThresholdLevel	O limiar de sensibilidade para a detecção semântica de fim de enunciação.
VoiceAgentGreetingConfigUnion	Alias para VoiceAgentGreetingConfigUnion
VoiceAgentInputTranscriptionModel	O identificador do modelo de transcrição de áudio de entrada. Este é um nome de modelo, não um nome de implantação Foundry. Espelha os modelos de transcrição suportados pelo backend de voz gerenciada, abrangendo os modelos de transcrição em tempo real do OpenAI, além dos modelos Azure e MAI. Valores adicionais podem ser adicionados ao longo do tempo.
VoiceAgentInterimResponseConfigUnion	Alias para VoiceAgentInterimResponseConfigUnion
VoiceAgentInterimResponseTrigger	Uma condição que pode desencadear uma resposta intermediária.
VoiceAgentMaxOutputTokens	A contagem máxima de tokens de saída ou o literal inf.
VoiceAgentNoiseReductionType	O modo de redução de ruído de áudio de entrada.
VoiceAgentRealtimeErrorCode	Códigos de erro levantados pelo cliente em tempo real dos Agentes de Voz.
VoiceAgentRealtimeEvent	Um evento recebido de uma conexão em tempo real com um agente de voz. Eventos conhecidos mantêm seus tipos gerados e a normalização. Tipos de fios não reconhecidos são encapsulados em VoiceAgentUnknownEvent. Ligue type para eventos conhecidos restritos, ou exclua type === "unknown" antes de passar um evento para um manipulador de eventos conhecidos.
VoiceAgentServerEvent	Uma mensagem v1 estável enviada pelo serviço via WebSocket com agente de voz.
VoiceAgentSessionIncludeOption	Campos adicionais que uma sessão de agente de voz pode incluir nas saídas do serviço.
VoiceAgentSessionResponse	A configuração efetiva da sessão retornava nos eventos do ciclo de vida da sessão do agente de voz.
VoiceAgentSessionUpdate	A configuração da sessão é aceita por um evento de atualização de sessão com agente de voz.
VoiceAgentSubagentAbortReason	O motivo pelo qual a consulta com subagentes foi abortada.
VoiceAgentSystemToolName	Uma ação de controle de sessão de voz gerenciada por serviço. Valores conhecidos são estáveis; valores adicionais podem ser adicionados ao longo do tempo.
VoiceAgentSystemToolUnion	Alias para VoiceAgentSystemToolUnion
VoiceAgentToolChoice	Comportamento de seleção de ferramentas para um agente de voz.
VoiceAgentToolResponseScheduling	Quando uma invocação de ferramenta cria uma resposta de acompanhamento. Valores adicionais podem ser adicionados ao longo do tempo.
VoiceAgentToolUnion	Alias para VoiceAgentToolUnion
VoiceAgentTransport	O transporte usado para conexão de voz e agente.
VoiceAgentTurnDetectionConfigUnion	Alias para VoiceAgentTurnDetectionConfigUnion
VoiceAgentTurnDetectionType	A estratégia de detecção de curva. Valores adicionais podem ser adicionados ao longo do tempo.
VoiceAgentWebSocketMessage	Uma mensagem de texto JSON trocada por um WebSocket de agente de voz estabelecido. Bytes de áudio são codificados em base64 nos campos de eventos JSON.
VoiceAgentWebSocketSubprotocol	O subprotocolo WebSocket é suportado por uma conexão de agente de voz.
VoiceAudioCodec	Um codec de áudio. Valores adicionais podem ser adicionados ao longo do tempo.
VoiceAudioContainerFormat	Um formato de contêiner de áudio. Valores adicionais podem ser adicionados ao longo do tempo.
VoiceAudioRole	Um papel de participante por voz-áudio. Valores adicionais podem ser adicionados ao longo do tempo.
VoiceConversationEngineUnion	Alias/VoiceConversationEngineUnion
VoiceConversationStatus	O status do ciclo de vida de uma conversa por voz persistente: in_progress: a sessão ao vivo está ativa, ou a finalização da persistência pós-sessão está pendente. completed: finalização bem-sucedida após o fechamento normal ou do cliente, end_conversation, um fechamento de duração 1001 máxima, ou uma desconexão do cliente ou da rede que o serviço ainda pode finalizar. failed: uma falha de serviço terminal, ponte, armazenamento ou transporte irrecuperável impediu a finalização.
VoiceModelType	Como o modelo que apoia um agente de voz é servido. Isso é independente da arquitetura (em tempo real ou em cascata), que o serviço deriva do modelo selecionado.
VoiceOutputModality	Uma modalidade de saída que o agente pode produzir. animation e avatar são usados quando um avatar é configurado.
VoiceType	A implementação por voz. Valores adicionais podem ser adicionados ao longo do tempo.

Enumerações

KnownApiVersions

Versões da API do Microsoft Foundry

Funções

isRestError(unknown)

Typeguard para RestError

Variáveis

RestError	Um tipo de erro personalizado para solicitações de pipeline com falha.
KnownVoiceAgentConnectionState	Valores conhecidos do VoiceAgentConnectionState reportados por uma conexão em tempo real entre voz e agente.

Detalhes da função

isRestError(unknown)

Typeguard para RestError

function isRestError(e: unknown): e is RestError

Parâmetros

e

unknown

Algo pego por uma cláusula catch.

Retornos

e is RestError

Detalhes da variável

RestError

Um tipo de erro personalizado para solicitações de pipeline com falha.

RestError: RestErrorConstructor

Tipo

RestErrorConstructor

KnownVoiceAgentConnectionState

Valores conhecidos do VoiceAgentConnectionState reportados por uma conexão em tempo real entre voz e agente.

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

Tipo

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