@azure/ai-projects package

O principal cliente do AIProjectClient

Um erro surgiu ao adquirir um token de acesso Microsoft Entra.

Um erro gerado pela ligação WebSocket.

Um erro surge quando uma mensagem WebSocket não corresponde ao protocolo do agente de voz.

Cliente para estabelecer sessões em tempo real com agentes de voz geridos da Foundry.

Erro base levantado pelo cliente em tempo real dos Voice Agents.

Um agente implementando o protocolo A2A.

Uma ferramenta A2A guardada numa caixa de ferramentas.

Configuração específica do protocolo A2A.

Um agente implementando o protocolo A2A.

Uma ferramenta A2A guardada numa caixa de ferramentas.

Parâmetros opcionais para o cliente.

Um recurso AI Search Index.

Configuração específica do protocolo de atividade.

Agente da interface do modelo

interface do modelo AgentBlueprintReference

interface do modelo AgentCard

interface do modelo AgentCardSkill

Insights sobre o conjunto de resultados da avaliação do agente

Insights da análise de cluster de agentes.

Fonte de agente para trabalhos de geração de dados — referências a um agente para obter instruções e metadados.

Interface de definição de base para agentes. Contém o tipo de agente e a configuração RAI opcional.

interface modelo AgentEndpointAuthorizationScheme

interface model AgentEndpointConfig

Agente fonte para trabalhos de geração de avaliadores — referência a um agente para obter instruções e metadados.

(Pré-visualização) Um tempo de execução gerido e um ciclo de agente usados para executar um agente de prompt.

interface do modelo AgentIdentity

Um problema persistente descoberto a partir dos rastos de um agente.

Detalhes adicionais de análise. Omitido, a menos que sejam solicitados detalhes.

Custo estimado do Agent Insights.

Um traço destacado que fornece evidências para a perceção de um agente.

Um objeto JSON usado em cargas úteis do Agent Insights.

Uma referência leve de rastreio ligada ao insight de um agente como prova de apoio.

Um monitor Agent Insights por agente que detém a configuração, execuções e insights descobertos.

Campos aceites ao criar um monitor Agent Insights para um agente.

Um resumo do monitor Agent Insights devolvido por operações de lista.

Campos que podem ser atualizados num monitor Agent Insights.

Uma solução recomendada para uma análise de agente.

Uma alteração que pode ser renderizada pelo cliente numa correção proposta.

A remediação recomendada para um agente é uma perspetiva.

Uma longa duração que analisa os rastos de um agente e atualiza os seus insights.

Entradas usadas ao criar uma execução de insight de agente.

Estatísticas de resultados produzidas quando uma run de insight do agente tem sucesso.

Razão estruturada pela qual a geração programada está suspensa para um monitor.

Utilização de tokens numa execução Agent Insights.

Campos que podem ser atualizados com base no insight de um agente.

A visão geral eficaz para um monitor de Insights.

Uma visão geral fornecida pelo utilizador que se torna eficaz imediatamente e gera a próxima geração.

Resultado do candidato produzido por um trabalho de otimização de agentes.

Valores de base fornecidos pelo chamador que não podem ser resolvidos a partir do agente-alvo.

Um candidato gerado por um trabalho de otimização.

Resumo de avaliação comparativa para um candidato.

Saída base do candidato. Os tipos de trabalho definem modelos de saída derivada com os seus próprios campos.

Metadados de promoção registados para um candidato.

Definições de pesquisa de candidatos.

Configuração para otimizar um agente para qualidade medida.

Modelo base para configuração de otimização específica por tipo.

Custo monetário estimado. Presente apenas quando pelo menos um modelo contribuinte tiver dados de preços.

Um intervalo baixo/típico/teto para uma quantidade estimada. Os valores esperados podem ser fracionários, incluindo a estimativa das chamadas de modelo.

Inputs para estimar um trabalho de otimização de agentes.

Resultado devolvido ao estimar um trabalho de otimização de agentes.

Configuração de medição de qualidade reutilizável.

Modelo discriminado base para um conjunto de avaliação de otimização.

Referência a um avaliador nomeado, opcionalmente fixada a uma versão.

Identifica o agente Foundry que detém a configuração a otimizar.

Mutação de instruções.

Recurso de trabalho de otimização de agentes — um trabalho de longa duração que produz alterações candidatas à configuração de um agente Foundry.

Latência média para uma fase de otimização e modelo.

Resultado parcial ou terminal produzido por um trabalho de otimização de agentes.

Utilização agregada de tokens para uma fase e modelo de otimização.

Identifica um modelo utilizado por uma etapa de otimização ou avaliação.

Mutação modelo.

Mutação candidata base.

Resultado do candidato produzido por um trabalho de otimização de prompts.

Resumo dos candidatos produzidos por um trabalho de otimização de agentes.

Uma competência na superfície de otimização de agentes fornecida manualmente.

Mutações de habilidade.

Os atributos do agente e valores alternativos disponíveis para uma pesquisa de otimização de agentes.

Valores estimados agrupados por estágio de otimização.

Fonte base para um conjunto de avaliação de otimização por completação de alvos.

Faz referência a um conjunto de dados Foundry registado explicitamente versionado para avaliação de completamento de alvos.

Conjunto de avaliação contendo entradas independentes de volta única.

Fornece linhas de curva simples diretamente no pedido de otimização.

Um único item num conjunto de avaliação inline.

Configuração base do alvo para um trabalho de otimização.

Mutações de ferramentas.

Fonte base para um conjunto de avaliação de otimização de simulação de conversa de utilizador.

Faz referência a um conjunto de dados Foundry registado explicitamente versionado para avaliação de simulação de conversas de utilizador.

Conjunto de avaliação contendo cenários para conversas simuladas.

Fornece as avaliações dos casos de teste de simulação de conversa de utilizador diretamente no pedido de otimização.

interface do modelo AgentReference

Uma sessão de agente que fornece um sandbox computacional de longa duração para invocações de agentes alojados.

Configuração de entrada para a taxonomia de avaliação quando o tipo de entrada é agente.

Representa uma versão específica de um agente. Inclui metadados, controle de versão, tempo de criação e definição do agente.

Definição de credenciais de identidade de agente

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Interface que representa uma operação de agentes.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Resposta de erro para falhas de API.

Definição de credencial de chave de API

Permite ao assistente criar, eliminar ou atualizar ficheiros usando diferenciais unificados.

interface do modelo AproximaçãoLocalização

Perfil de artefactos do modelo

Configuração para um contêiner de interpretador de código. Opcionalmente, especifique as IDs dos arquivos nos quais executar o código.

Representa um alvo que especifica um agente IA do Azure.

Representa um alvo que especifica um modelo de IA do Azure para operações que requerem seleção de modelo.

Definição de Índice de Pesquisa do Azure AI

A informação de definição de entrada para uma ferramenta de pesquisa Azure AI usada para configurar um agente.

Um conjunto de recursos de índice usados pela ferramenta azure_ai_search.

Uma ferramenta Pesquisa de IA do Azure armazenada numa caixa de ferramentas.

Opções de configuração para o endpoint do agente do método getOpenAIClient. Usado principalmente para agentes alojados.

A estrutura para manter o nome da fila de storage e o URI.

A definição da função Azure.

A estrutura para manter o nome da fila de storage e o URI.

A informação de definição de entrada para uma Ferramenta de Função Azure, tal como usada para configurar um Agente.

Configuração do modelo Azure OpenAI. A versão da API seria selecionada pelo serviço para consultar o modelo.

Uma classe base para credenciais de conexão

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Interface representando uma operação do BetaAgentInsightMonitors.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Operações para agentes gestores.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Interface representando operações de BetaEvaluationTaxonomies.

Parâmetros opcionais.

Parâmetros opcionais.

Operações para BetaEvaluatorsOperations.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Interface que representa uma operação BetaInsights.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Interface representando operações BetaMemoryStores.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Opções para o método criar que carrega ficheiros locais e regista uma versão do modelo.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Interface representando operações de um BetaModels.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Interface representando operações Beta.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Interface representando uma operação do BetaRedTeams.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Interface representando operações de BetaRoutines.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Interface representando operações BetaSchedules.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Interface representando uma operação BetaSkills.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Operações para gerir conversas com agentes de voz.

Operações para gerir conversas de agentes de voz e telefonia.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Operações para gerir a telefonia de agentes de voz.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Uma configuração de pesquisa bing personalizada.

A informação de definição de entrada para uma ferramenta de pesquisa personalizada Bing usada para configurar um agente.

Os parâmetros da ferramenta de pesquisa personalizada do bing.

Pesquise configuração por Bing Grounding

Os parâmetros da ferramenta de pesquisa de bing grounding.

A informação de definição de entrada para uma ferramenta de pesquisa bing grounding usada para configurar um agente.

Detalhes de referência do Blob.

interface de modelo BotServiceAuthorizationScheme

interface modelo BotServiceRbacAuthorizationScheme

interface modelo BotServiceTenantAuthorizationScheme

As informações de definição de entrada para uma Ferramenta de Automação do Navegador, conforme usado para configurar um Agente.

Uma ferramenta de automação do navegador guardada numa caixa de ferramentas.

As informações de definição de entrada para uma Ferramenta de Automação do Navegador, conforme usado para configurar um Agente.

Definição de parâmetros de entrada para a conexão usada pela Browser Automation Tool.

Definição de parâmetros de entrada para a Browser Automation Tool.

Uma ferramenta de automação do navegador guardada numa caixa de ferramentas.

Uma ferramenta para capturar saídas estruturadas

Coordenadas para o gráfico de análise.

Uma ferramenta funcional que pode ser usada para gerar uma resposta.

Um item de memória que contém um resumo extraído de conversas.

Insights da análise de cluster.

Uso de token para análise de cluster

Definição do avaliador baseado em código usando código python

Configuração de implementação baseada em código para um agente alojado.

Uma ferramenta que executa código Python para ajudar a gerar uma resposta a um prompt.

Uma ferramenta interpretadora de código armazenada numa caixa de ferramentas.

Um filtro usado para comparar uma chave de atributo especificada com um determinado valor usando uma operação de comparação definida.

Combine vários filtros usando and ou or.

Uma ferramenta que controla um computador virtual. Saiba mais sobre a ferramenta informática.

Uma ferramenta que controla um computador virtual. Saiba mais sobre a ferramenta informática.

Resposta da lista e obter operações de conexões

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Interface que representa uma operação do Connections.

interface de modelo ContainerAutoParam

Configuração de implementação baseada em contentor para um agente alojado.

interface model ContainerNetworkPolicyAllowlistParam

interface de modelo ContainerNetworkPolicyDisabledParam

interface de modelo ContainerNetworkPolicyDomainSecretParam

Política de acesso à rede para o contentor.

interface do modelo ContainerSkill

Ação de regra de avaliação para avaliação contínua.

Definição de índice do CosmosDB Vetor Store

Corpo de pedido multiparte para atualização ou versionamento de um agente baseado em código (POST /agents/{name} e POST /agents/{name}/versions).

Metadados JSON para operações de agente baseadas em código (criar, atualizar, criar versão). O nome do agente provém do parâmetro de caminho URL ou do x-ms-agent-name cabeçalho, pelo que não está incluído neste modelo. O hash de conteúdo (SHA-256 do zip) é transportado no x-ms-code-zip-sha256 cabeçalho.

Corpo de pedido multiparte para criar uma versão de competência a partir de ficheiros. Aceita um único ficheiro zip ou vários ficheiros individuais de skill (upload do diretório). Para uploads zip, o servidor extrai e valida conteúdos. Para uploads de diretórios, os ficheiros são validados as-is.

O pedido para criar uma ligação de extensão Telefone do Microsoft Teams.

O pedido para criar uma ligação telefónica.

Um pedido para criar uma única chamada direta de saída duradoura.

Estatísticas de utilização de tokens para o pedido.

O pedido para criar uma encadernação Twilio.

Gatilho baseado em Cron.

Definição de credencial personalizada

Uma gramática definida pelo utilizador.

Um gatilho de rotina de eventos personalizada.

Texto livre e sem restrições.

Uma ferramenta personalizada que processa a entrada usando um formato especificado. Saiba mais sobre ferramentas personalizadas

O formato de entrada para a ferramenta personalizada. O padrão é texto sem restrições.

Esquema diário de recorrência.

Geração de Dados: recurso para empregos.

Configuração para gerir trabalhos de geração de dados.

Entradas fornecidas pelo chamador para um trabalho de geração de dados.

Produzir informação para um trabalho de geração de dados.

Resultado produzido por um trabalho bem-sucedido de geração de dados.

O modelo base de origem para trabalhos de geração de dados.

Opções de modelos LLM para trabalhos de geração de dados.

Informação de utilização de tokens para um trabalho de geração de dados.

Representa uma referência a um blob para consumo

Saída de conjunto de dados para um trabalho de geração de dados.

Fonte de conjunto de dados para trabalhos de geração de avaliadores — referência a um conjunto de dados.

Referência a um conjunto de dados Foundry versionado.

Definição de DatasetVersion

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Interface que representa operações de conjuntos de dados.

Parâmetros opcionais.

Um objeto de agente excluído

Um objeto de versão de agente excluído

Resposta à eliminação de um item de memória de um armazenamento de memória.

interface do modelo DeleteMemoryStoreResponse

Uma habilidade apagada.

Uma versão de habilidade eliminada.

Definição de implantação de modelo

Parâmetros opcionais.

Parâmetros opcionais.

Interface que representa uma operação de Implantações.

Uma única dimensão — uma dimensão de qualidade independente e mensurável dentro do plano de avaliação de um avaliador de rubricas.

Identificadores devolvidos após a entrada em fila de uma rotina.

Incorporando classe de configuração

interface de modelo EmptyModelParam

Definição de avaliador baseada em endpoint. O cliente detém e aloja um endpoint HTTP que implementa o contrato de avaliação. O avaliador referencia-se a um Project Connection pelo nome; a ligação armazena o URL e as credenciais do endpoint (API Key ou Entra ID). No momento da execução, o serviço resolve a ligação para obter a URL do endpoint e os detalhes de autenticação, e depois chama o endpoint para cada linha de avaliação.

interface modelo EntraAuthorizationScheme

Definição de credencial Entra ID

Interface do modelo ErrorModel

Resultado da avaliação.

Comparação métrica de um tratamento em relação à linha de base.

Os resultados de comparação para o tratamento são comparados com os valores basais.

Estatísticas resumidas de uma métrica em uma execução de avaliação.

Configura uma voz neural padrão Azure usada para converter texto em voz para avaliação através do endpoint Voice Live.

Pedido de comparação de avaliação

Insights da comparação da avaliação.

Recursos de trabalho para geração de dados de avaliação.

Entradas fornecidas pelo chamador para um trabalho de geração de dados de avaliação.

Configuração de saída do conjunto de dados para um trabalho de geração de dados de avaliação.

Configura o modelo que reproduz o utilizador simulado. Este modelo é separado do avaliado target.

Uma amostra do resultado da avaliação.

Modelo de regras de avaliação.

Modelo de ação de avaliação.

Modelo de filtro de avaliação.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Interface que representa uma operação EvaluationRules.

Insights sobre o conjunto de Resultados da Avaliação

Os insights da avaliação executam a análise de agrupamento.

Tarefa de avaliação do cronograma.

Classe base para alvos com suporte a discriminadores.

Definição de Taxonomia de Avaliação

Configuração de entrada para a taxonomia de avaliação.

Configuração de voz usada para converter texto para fala para avaliação através do endpoint Voice Live.

Entidade solicitante para obter credenciais de avaliador

Configuração do avaliador de base com discriminador

Artefactos de proveniência gerida por serviços produzidos por um trabalho de geração avaliador. Presente apenas nos recursos EvaluatorVersion criados através do pipeline de geração. O conjunto de dados combinado-JSONL Foundry é apenas de leitura e resolve para um conjunto de dados versionado num namespace reservado por serviços.

Entradas fornecidas pelo chamador para um trabalho de geração de avaliador.

Recurso de Geração de Trabalhos do Avaliador — um trabalho de longa duração que gera definições de avaliadores baseadas em rubricas a partir de materiais fonte. Em caso de sucesso, o resultado é a persistente EvaluatorVersion.

O modelo base de origem para empregos de geração de avaliadores. Polimórfico sobre type.

Resumo do consumo de tokens para um trabalho de geração de avaliadores. Preenchido quando o trabalho atinge um estado terminal.

Métrica do Avaliador

Definição do Avaliador

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Operações para AvaliadoresOperações.

Parâmetros opcionais.

A definição de agente externo. Representa um agente de terceiros alojado fora do Foundry (por exemplo, no GCP ou AWS). O registo é apenas para metadados: a Foundry regista a definição do agente para iluminar experiências de observabilidade (traços, avaliações) sobre dados OpenTelemetry emitidos pelo cliente.

Os parâmetros da ferramenta do agente de dados de malha.

Uma ferramenta FabricIQ do lado do servidor.

Uma ferramenta FabricIQ guardada numa caixa de ferramentas.

Classe de configuração de mapeamento de campo

Saída de ficheiro Azure OpenAI para um trabalho de geração de dados.

Fonte de ficheiro para trabalhos de geração de dados — Azure OpenAI input de ficheiros.

Definição FileDatasetVersion

Uma ferramenta que procura conteúdo relevante a partir de ficheiros carregados. Saiba mais sobre a ferramenta de pesquisa de ficheiros.

Uma ferramenta de pesquisa de ficheiros guardada numa caixa de ferramentas.

Interface do modelo Regra de Seleção FixaProporçãoVersão

Definição FileDatasetVersion

Um aviso associado a um modelo.

interface de modelo FunçãoObjeto

Os parâmetros que as funções aceitam, descritos como um objeto de esquema JSON. Consulte o guia para obter exemplos e a referência de esquema JSON para obter documentação sobre o formato. Omitir parameters define uma função com uma lista de parâmetros vazia.

Uma ferramenta que permite ao modelo executar comandos de shell.

Interface do modelo FunçãoShellToolParamAmbiente

Interface do modelo FunçãoShellToolParamAmbienteContainerReferenceParam

Função de interface do modelo ShellToolParamAmbienteLocalAmbienteParam

Define uma função no seu próprio código que o modelo pode optar por chamar. Saiba mais sobre chamadas de função.

interface de modelo FunctionToolParam

Opções para configurar o traçado GenAI numa instância específica do AIProjectClient.

Passe estes sob a tracingOptions chave AIProjectClientOptionalParams para permitir o rastreamento GenAI quando o cliente for instanciado. Cada instância cliente mantém a sua própria configuração independente de rastreamento.

As entradas para gerar um agente de voz. Apenas kind e name são sempre obrigatórios. O serviço de autoria expande estes inputs para um full editável VoiceAgentDefinition, que é depois criado através de POST /agents. As definições geradas instructions e áudio/voz são armazenadas como campos separados na definição resultante do agente, para que o chamador possa editar ou substituir qualquer uma delas posteriormente através da versão padrão do agente.

Parâmetros opcionais.

Parâmetros opcionais.

(Pré-visualização) O arnês gerido do GitHub Copilot para agentes de prompt.

Um override de habilitação para uma ferramenta integrada no GitHub Copilot.

A configuração padrão de ativação para as ferramentas integradas do GitHub Copilot.

(Pré-visualização) Overrides de configuração para as ferramentas integradas do GitHub Copilot.

Um gatilho de rotina de problemas no GitHub.

Autenticação secreta baseada em cabeçalho para um endpoint de telemetria. O valor secreto resolvido é injetado como um cabeçalho HTTP.

A definição do agente hospedado.

Cronograma de recorrência horária.

Ação da regra de avaliação para avaliação humana.

interface de modelo HybridSearchOptions

Uma ferramenta que gera imagens usando os modelos de imagem GPT.

Interface do modelo ImageGenToolInputImageMask

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Interface que representa uma operação de índices.

interface de modelo InlineSkillParam

Carga útil de competência em linha

O corpo de resposta para insights de cluster.

Um conjunto de amostras de análise.

O órgão do pedido para gerar um insight.

Configuração do modelo utilizado na geração de insights.

A solicitação do relatório de insights.

O resultado dos insights.

Uma amostra da análise.

Tarefa de insight para a agenda.

Resumo da análise de cluster de erros.

Metadados sobre os insights.

Configuração específica do protocolo de invocações.

Configuração específica do protocolo de invocações baseado em WebSocket.

Uma carga útil manual usada para testar a rotina de despacho de uma API de invocações.

Despacha uma rotina através da API de invocações brutas. Deve ser fornecido exatamente um dos agent_name ou agent_endpoint_id.

Um payload manual usado para testar a rotina de despacho de uma API de respostas.

Despacha uma rotina através da API de respostas. Deve ser fornecido exatamente um dos agent_name ou agent_endpoint_id.

Estado de operação para uma operação de longa duração que cria um recurso de trabalho.

PERSONALIZAÇÃO: SDK-IMPROVEMENT: os sondadores emitidos resolvem para a carga útil terminal result do trabalho, que não transporta identificador; jobId mantém o trabalho criado acessível.

Uma ferramenta que permite que o modelo execute comandos shell em um ambiente local.

interface modelo LocalSkillParam

Um objeto de probabilidade logarítmica.

Metadados específicos do adaptador para modelos LoRA. Drives que servem a configuração do motor no momento da implementação.

Uma ferramenta disponível em um servidor MCP.

Interface do modelo MCPListToolsToolAnnotations

interface do modelo MCPListToolsToolInputSchema

Dê ao modelo acesso a ferramentas adicionais por meio de servidores MCP (Model Context Protocol) remotos. Saiba mais sobre MCP.

Um objeto filtro para especificar quais as ferramentas permitidas.

interface de modelo MCPToolRequireApproval

Uma ferramenta MCP guardada numa caixa de ferramentas.

interface de modelo ManagedAgentIdentityBlueprintReference

Definição de Índice de Pesquisa de IA do Azure Gerenciado

Configuração específica do protocolo MCP.

Um único item de memória armazenado no armazenamento de memória, contendo conteúdo e metadados.

Representa uma única operação de memória (criar, atualizar ou excluir) executada em um item de memória.

Um item de memória recuperado da pesquisa de memória.

Opções de pesquisa de memória.

Uma ferramenta para integrar memórias no agente.

Um armazenamento de memória que pode armazenar e recuperar memórias do usuário.

Implementação de armazenamento de memória padrão.

Configurações de armazenamento de memória padrão.

Definição de base para configurações de armazenamento de memória.

Resposta para excluir memórias de um escopo.

Estatísticas de uso de uma operação de armazenamento de memória.

Resposta de pesquisa de memória.

Resultado da atualização de memória.

Fornece o status de uma operação de atualização de armazenamento de memória.

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 via API ou o painel. As teclas são cadeias com um comprimento máximo de 64 caracteres. Os valores são cadeias com um comprimento máximo de 512 caracteres.

Um conjunto de escopos de permissões delegadas solicitados a uma única aplicação de recurso.

Valores padrão e anteriormente publicados usados para pré-preencher um pedido de publicação do Microsoft 365 para um agente Foundry.

Resposta da publicação de um agente para Microsoft 365 / Microsoft Teams.

A informação de definição de entrada para uma ferramenta Microsoft Fabric usada para configurar um agente.

Os detalhes de uma ação são bloqueados porque podem não estar alinhados com a intenção do utilizador.

Uma instrução pública para continuar após uma ação é bloqueada.

Pedido para obter credenciais de um asset modelo.

Definição de implantação de modelo

Informações sobre Sku

Representa um pedido de carregamento pendente de uma versão do modelo.

Representa a resposta para um pedido de upload pendente de modelo.

Representa um conjunto de parâmetros usados para controlar o comportamento de amostragem de um modelo de linguagem durante a geração de texto.

Informação de origem para o modelo

Definição de Versão do Modelo

Esquema mensal de recorrência.

Agrupa a função/ferramentas personalizadas num namespace partilhado.

Credenciais que não exigem autenticação

Gatilho único.

Opções de cliente OpenAI estendidas para incluir a configuração do endpoint do Azure Agent.

Detalhes de segurança para autenticação anônima OpenApi

detalhes de autenticação para OpenApiFunctionDefinition

As informações de definição de entrada para uma função openapi.

Detalhes de segurança para autenticação OpenApi managed_identity

Esquema de segurança para autenticação OpenApi managed_identity

Detalhes de segurança para autenticação de ligação do project OpenApi

Esquema de segurança para autenticação OpenApi managed_identity

As informações de definição de entrada para uma ferramenta OpenAPI como usada para configurar um agente.

Uma ferramenta OpenAPI armazenada numa caixa de ferramentas.

Modelo base para contexto de otimização tipada.

Um endpoint de exportação de telemetria OTLP (OpenTelemetry Protocol).

Uma interface que rastreia as configurações para iteração paginada

Uma interface que permite iteração assíncrona iterável até a conclusão e por página.

Representa uma solicitação para um carregamento pendente.

Representa a resposta para uma solicitação de carregamento pendente

O modelo para escolher propriedades.

Um item de memória contendo um procedimento extraído de conversas.

interface de modelo ProgrammaticToolCallingParam

A definição do agente de prompt

Opções de configuração para uma resposta de texto do modelo. Pode ser texto simples ou dados JSON estruturados.

Avaliador baseado em prompts

Fonte de prompt para trabalhos de geração de dados — texto em linha fornecido pelo utilizador.

Código de prompt para trabalhos de geração de avaliadores — texto em linha fornecido pelo utilizador.

Configuração para uma transformação one-shot num prompt sem avaliação comparativa.

Configuração por protocolo para o endpoint do agente.

Um mapeamento de registro para um único protocolo e sua versão.

Um destino PSTN para um destino de transferência telefónica.

Parâmetros opcionais.

Configuração para filtragem de conteúdo de IA Responsável (RAI) e recursos de segurança.

Declara onde reside o texto de pedido/resposta para que as proteções de segurança do conteúdo possam extraí-lo.

Um seletor de tipo de evento SSE para campo de texto para streaming de saída de invocação.

Interface de modelo Opções de classificação

interface de modelo RealtimeAudioFormatos

interface de modelo Tempo realÁudioFormatosÁudioPcm

interface de modelo RealtimeAudioFormatsAudioPcma

interface de modelo RealtimeAudioFormatsAudioPcmu

Um evento cliente em tempo real.

Adicione um novo Item ao contexto da Conversa, incluindo mensagens, chamadas de função e respostas de chamadas de função. Este evento pode ser usado tanto para preencher um "histórico" da conversa como para adicionar novos itens a meio do fluxo, mas tem a limitação atual de não poder preencher mensagens áudio do assistente. Se for bem-sucedido, o servidor responderá com um conversation.item.created evento, caso contrário um error evento será enviado.

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.

Envie este evento quando quiser recuperar a representação do servidor de um item específico no histórico de conversas. Isto é útil, por exemplo, para inspecionar o áudio do utilizador 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.

Envie este evento para truncar o áudio de uma mensagem de assistente anterior. O servidor produz áudio mais rápido do que em tempo real, por isso este evento é útil quando o utilizador interrompe para truncar áudio que já foi enviado para o cliente mas ainda não foi reproduzido. Isto sincroniza a compreensão do áudio pelo servidor com a reprodução do cliente. Truncar áudio apaga a transcrição do texto do lado do servidor para garantir que não há texto no contexto que não tenha sido ouvido pelo utilizador. Se for bem-sucedido, o servidor responderá com um conversation.item.truncated evento.

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 confirmar posteriormente. Um "commit" cria um novo item de mensagem de utilizador 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 detetar a fala e o servidor decide quando compromete. Quando o VAD do servidor está desativado, tem de confirmar manualmente o buffer de áudio. A redução do ruído do áudio de entrada funciona nas gravações 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 blocos do cliente pode permitir que o VAD seja mais responsivo. Ao contrário da maioria dos outros eventos do cliente, o servidor não enviará uma resposta de confirmação a este evento.

Envie este evento para limpar os bytes de áudio no buffer. O servidor responde com um input_audio_buffer.cleared evento.

Envie este evento para comprometer o buffer de áudio de entrada do utilizador, o que criará um novo elemento de mensagem de utilizador na conversa. Este evento gerará um erro se o buffer de áudio de entrada estiver vazio. Quando está em modo VAD do Servidor, o cliente não precisa de enviar este evento, o servidor compromete automaticamente o buffer de áudio. Confirmar o buffer de áudio de entrada desencadeia a transcrição de áudio de entrada (se ativada na configuração da sessão), mas não gera resposta do modelo. O servidor responde com um input_audio_buffer.committed evento.

Apenas WebRTC/SIP: Emita para cortar a resposta de áudio atual. Isto 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 de cliente para interromper a geração da resposta atual. Mais informações.

Envie este evento para cancelar uma resposta em curso. 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 não haja resposta em curso, um erro será devolvido e a sessão permanecerá inalterada.

Este evento instrui o servidor a criar uma Resposta, o que significa desencadear a inferência do modelo. Quando está em modo VAD do servidor, o servidor cria respostas automaticamente. Uma Resposta incluirá pelo menos um Item, podendo ter dois, caso em que o segundo será uma chamada de função. Estes Itens serão adicionados ao histórico de conversas por defeito. O servidor responde com um response.created evento, eventos para Itens e conteúdos criados, e finalmente um response.done evento para indicar que a Resposta está concluída. O response.create evento inclui a configuração de inferência como instructions e tools. Se estes estiverem 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 desativar a escrita da saída na Conversa. Apenas uma Resposta pode escrever na Conversa padrão de cada vez, mas, caso contrário, podem ser criadas múltiplas Respostas 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 escreve na Conversa padrão. Pode ser fornecida entrada arbitrária com o input campo, que é um array que aceita Itens brutos e referências a Itens existentes.

Um único item dentro de uma conversa em tempo real.

Um item de chamada de função numa conversa em tempo real.

Um item de saída que chama uma função numa conversa em tempo real.

interface do modelo RealtimeConversationItemMessage

Um item de mensagem de assistente numa conversa em tempo real.

Interface do modelo Tempo RealConversaItemMensagemAssistente Conteúdo

Uma mensagem do sistema numa conversa em tempo real pode ser usada para fornecer contexto adicional ou instruções ao modelo. Isto é semelhante, mas distinto do prompt de instruções fornecido no início de uma conversa, pois as mensagens do sistema podem ser adicionadas em qualquer momento da conversa. Para mudanças significativas no comportamento da conversa, use instruções, mas para atualizações menores (por exemplo, "o utilizador está agora a perguntar sobre um tema diferente"), use mensagens do sistema.

Interface do modelo Tempo RealConversaItemMensagemConteúdo

Um item de mensagem de utilizador numa conversa em tempo real.

Interface do modelo Tempo RealConversaItemMensagemConteúdo do Utilizador

Interface do modelo RealtimeFunctionTool

Um item em tempo real a pedir aprovação humana para uma invocação de ferramenta.

Um item em tempo real a responder a um pedido de aprovação MCP.

interface de modelo RealtimeMCPError

interface de modelo RealtimeMCPHttpError

Ferramentas de listagem de itens em tempo real disponíveis num servidor MCP.

interface de modelo RealtimeMCPProtocolError

Um item em tempo real que representa uma invocação de uma ferramenta num servidor MCP.

interface de modelo RealtimeMCPToolExecutionError

Configuração para modelos em tempo real com capacidade de raciocínio, como gpt-realtime-2.

interface do modelo RealtimeResponseStatusDetails

interface do modelo Tempo realRespostaEstadoEstadoDetalhesErro

interface do modelo RealtimeResponseUsage

Interface do modelo Tempo RealRespostaUtilizaçãoInputTokenDetalhes

Interface do modelo Tempo RealRespostaUsoInputTokenDetalhesCachedTokensDetalhes

Interface do modelo RealtimeRespostaUsoSaídaTokenDetalhes

Um evento de servidor em tempo real.

Enviado pelo servidor quando um Item é adicionado à Conversa padrão. Isto pode acontecer em vários casos:

• Quando o cliente envia um conversation.item.create evento.
• Quando o buffer de áudio de entrada é confirmado. Neste caso, o item será uma mensagem de utilizador contendo o áudio do buffer.
• Quando o modelo está a gerar uma Resposta. Neste caso, o conversation.item.added evento será enviado quando o modelo começar a gerar um Item específico, e assim ainda não terá conteúdo (e status será in_progress). O evento incluirá o conteúdo completo do Item (exceto quando o modelo está a gerar uma Resposta), exceto os dados de áudio, que podem ser recuperados separadamente com um conversation.item.retrieve evento, se necessário.

Devolvido quando um item de conversa é criado. Existem vários cenários que produzem este evento:

• O servidor está a gerar uma Resposta que, se bem-sucedida, produzirá um ou dois Itens, que serão do tipo message (papel assistant) ou do tipo function_call.
• O buffer de áudio de entrada foi comprometido, seja pelo cliente ou pelo servidor (em server_vad modo). O servidor recolhe o conteúdo do buffer de áudio de entrada e adiciona-o a um novo item de mensagem de utilizador.
• O cliente enviou um conversation.item.create evento para adicionar um novo Item à Conversa.

Devolvido quando um elemento da conversa é eliminado pelo cliente com um conversation.item.delete evento. Este evento é usado para sincronizar a compreensão do histórico de conversas pelo servidor com a visão do cliente.

Devolvido quando um assunto da conversa é finalizado. O evento incluirá o conteúdo completo do Item, exceto os dados de áudio, que podem ser recuperados separadamente com o conversation.item.retrieve evento, se necessário.

Este evento é a saída da transcrição áudio para áudio do utilizador escrita no buffer de áudio do utilizador. A transcrição começa quando o buffer de áudio de entrada é confirmado pelo cliente ou servidor (quando o VAD está ativado). A transcrição corre de forma assíncrona com a criação de Resposta, pelo que este evento pode ocorrer antes ou depois dos eventos de Resposta. Os modelos de API em tempo real aceitam áudio nativamente, e assim a transcrição de entrada é um processo separado executado num modelo ASR (Reconhecimento Automático de Fala) distinto. A transcrição pode divergir um pouco da interpretação do modelo e deve ser tratada como um guia aproximado.

Devolvido quando o valor de texto de uma parte de conteúdo de transcrição áudio de entrada é atualizado com resultados incrementais de transcrição.

Devolvido quando a transcrição áudio de entrada é configurada e um pedido de transcrição para uma mensagem de utilizador falha. Estes eventos são separados de outros error eventos para que o cliente possa identificar o Item relacionado.

Interface de modelo RealtimeServerEventConversationItemInputÁudioTranscriçãoFailedError

Devolvido quando um segmento de transcrição áudio de entrada é identificado para um item.

Devolvido quando um item de conversa é recuperado com conversation.item.retrieve. Isto é fornecido como uma forma de obter a representação do servidor de um item, por exemplo, para aceder aos 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.

Devolvido quando um item de mensagem áudio de assistente anterior é truncado pelo cliente com um conversation.item.truncate evento. Este evento é usado para sincronizar a compreensão do áudio pelo servidor com a reprodução do cliente. Esta ação trunca o áudio e remove a transcrição do texto do lado do servidor para garantir que não há texto no contexto que não tenha sido ouvido pelo utilizador.

É devolvido quando ocorre um erro, que pode ser um problema do cliente ou do servidor. A maioria dos erros é recuperável e a sessão permanecerá aberta; recomendamos aos implementadores que monitorizem e gravem as mensagens de erro por defeito.

interface de modelo RealtimeServerEventErrorError

Devolvido quando o buffer de áudio de entrada é apagado pelo cliente com um input_audio_buffer.clear evento.

Devolvido quando um buffer de áudio de entrada é confirmado, seja pelo cliente ou automaticamente em modo VAD do servidor. A item_id propriedade é o ID do item de mensagem do utilizador que será criado, pelo que um conversation.item.created evento também será enviado ao cliente.

Enviado pelo servidor quando está em server_vad modo para indicar que a fala foi detetada no buffer de áudio. Isto pode acontecer sempre que o áudio é adicionado ao buffer (a menos que a fala já seja detetada). O cliente pode querer usar este evento para interromper a reprodução de áudio ou fornecer feedback visual ao utilizador. O cliente deve esperar receber um input_audio_buffer.speech_stopped evento quando a fala cessar. A item_id propriedade é o ID do item de mensagem do utilizador 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).

Devolvido em server_vad modo quando o servidor deteta o fim da fala no buffer de áudio. O servidor também enviará um conversation.item.created evento com o item de mensagem do utilizador criado a partir do buffer de áudio.

Devolvido quando o timeout do VAD do servidor é ativado para o buffer de áudio de entrada. Isto está configurado nas idle_timeout_msturn_detection definições da sessão e indica que não foi detetada qualquer fala durante a duração configurada. Os campos audio_start_ms e audio_end_ms indicam o segmento de áudio após a resposta do último modelo até ao tempo de ativação, como um desvio a partir do início do áudio escrito no buffer de entrada de áudio. Isto significa que demarca o segmento de áudio que estava silencioso e a diferença entre os valores de início e fim corresponde aproximadamente ao timeout configurado. O áudio vazio será comprometido com a conversa como um input_audio item (haverá um input_audio_buffer.committed evento) e será gerada uma resposta modelo. Pode haver fala que não desencadeou o VAD mas que ainda assim é detetada pelo modelo, pelo que o modelo pode responder com algo relevante para a conversa ou um estímulo para continuar a falar.

Devolvido quando as ferramentas MCP listadas estão concluídas para um artigo.

Devolvi quando as ferramentas MCP à venda falharam para um artigo.

Devolvido quando está em curso a listagem de ferramentas MCP para um item.

Apenas WebRTC/SIP: Emitido quando o buffer de áudio de saída é limpo. Isso acontece no modo VAD quando o utilizador interrompeu (input_audio_buffer.speech_started) ou quando o cliente emitiu o evento output_audio_buffer.clear para cortar manualmente a resposta de áudio atual. Mais informações.

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 apresentados refletem essa reserva, que é então ajustada em conformidade assim que a Resposta é concluída.

Interface de modelo RealtimeServerEventRateLimitsUpdatedRateLimits

Devolvido quando o áudio gerado pelo modelo é atualizado.

Devolvido quando o áudio gerado pelo modelo está concluído. Também é emitido quando uma Resposta é interrompida, incompleta ou cancelada.

Devolvido quando a transcrição gerada pelo modelo da saída de áudio é atualizada.

Devolvido quando a transcrição gerada pelo modelo da saída de áudio termina de ser transmitida. Também é emitido quando uma Resposta é interrompida, incompleta ou cancelada.

Devolvido quando uma nova parte de conteúdo é adicionada a um item de mensagem de assistente durante a geração de respostas.

interface do modelo RealtimeServerEventResponseContentPartAddedPart

Devolvido quando uma parte de conteúdo termina de ser transmitida numa mensagem de assistente. Também é emitido quando uma Resposta é interrompida, incompleta ou cancelada.

interface do modelo RealtimeServerEventResponseContentPartDonePart

Devolvido quando uma nova Resposta é criada. O primeiro evento de criação da resposta, onde a resposta está num estado inicial de in_progress.

Devolvido quando uma resposta termina de ser transmitida. Sempre emitido, independentemente do estado final. O objeto Resposta incluído no response.done evento incluirá todos os itens de saída na Resposta, mas omitirá os dados de áudio brutos. 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 áudio.

Devolvido quando os argumentos de chamada de função gerados pelo modelo são atualizados.

Devolvido quando os argumentos da chamada de função gerados pelo modelo terminam de ser transmitidos. Também é emitido quando uma Resposta é interrompida, incompleta ou cancelada.

Devolvidos quando os argumentos das chamadas de ferramenta MCP são atualizados durante a geração da resposta.

Devolvidos quando os argumentos das chamadas de ferramenta MCP são finalizados durante a geração da resposta.

Devolvido quando uma chamada de ferramenta MCP é concluída com sucesso.

Devolvido quando uma chamada de ferramenta MCP falhou.

Devolvido quando uma chamada de ferramenta MCP começou e está em curso.

Devolvido quando um novo Item é criado durante a geração da Resposta.

Devolvido quando um item termina de ser transmitido. Também é emitido quando uma Resposta é interrompida, incompleta ou cancelada.

Devolvido quando o valor de texto de uma parte de conteúdo "output_text" é atualizado.

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.

Devolvido quando uma Sessão é criada. Emitido automaticamente quando uma nova ligação é estabelecida como o primeiro evento do servidor. Este evento conterá a configuração padrão da Sessão.

Devolvido quando uma sessão é atualizada com um session.update evento, a menos que haja um erro.

Apenas modelos GPT-5 e O-Series Opções de configuração para modelos de raciocínio.

Modelo de cronograma de recorrência.

Gatilho baseado em recorrência.

Detalhes da equipe vermelha.

Classe abstrata para configuração de destino.

Reforçar o ajuste fino do recurso de geração de dados. Esta é uma funcionalidade de pré-visualização.

Entradas fornecidas pelo chamador para um trabalho de refinamento de afinação de geração de dados. Esta é uma funcionalidade de pré-visualização.

Configuração de saída de ficheiro para um trabalho de afinação fina de reforço de dados. Esta é uma funcionalidade de pré-visualização.

Uma ferramenta de lembrete guardada numa caixa de ferramentas.

Interface do modelo RespostaUtilizaçãoInputTokensDetalhes

interface do modelo RespostaUsoTokensSaídaDetalhes

Configuração específica do protocolo de respostas.

Uma definição rotineira devolvida pelo serviço.

Modelo base para uma ação rotineira.

Configuração opcional de autorização para um despacho rotineiro.

Modelo base para uma carga útil de despacho manual.

Uma única execução rotineira retornava da API de histórico de execuções.

Modelo base para um gatilho rotineiro.

Definição de avaliador baseada em rubricas — armazena dimensões produzidas pela API de geração. Usado tanto para avaliadores de qualidade como de segurança.

Um aviso não fatal produzido durante a geração do avaliador de rubricas quando os inputs resolvidos são tecnicamente válidos, mas provavelmente demasiado fracos para produzir uma rubrica de alta qualidade. Apenas leitura; gerado por serviço. Persisti com o terminal EvaluatorGenerationJob.

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 transporta identificador; runId mantém a execução criada acessível.

Definição de credenciais de Assinatura de Acesso Compartilhado (SAS)

Definição de credenciais SAS

Modelo de programação.

Um gatilho rotineiro recorrente baseado em crons.

Agendar modelo de execução.

Agendar modelo de tarefa.

Os padrões de sessão aplicam-se a sessões criadas para uma versão de agente alojada.

Uma única entrada numa listagem de diretório.

Resposta ao listar um diretório num sandbox de sessão.

Resposta ao carregar um ficheiro para um sandbox de sessão.

Uma única Server-Sent frame de evento emitida pelo fluxo de log de sessão do agente alojado.

Cada frame contém um event campo que identifica o tipo de evento e um data campo que transporta a carga útil como texto simples. Embora a carga útil atual data seja formatada em JSON, o seu esquema não é contratual — podem aparecer chaves adicionais e o formato pode mudar ao longo do tempo. Os clientes devem tratar data como uma string opaca e, opcionalmente, tentar análise sintáctica JSON.

Novos tipos de eventos poderão ser adicionados no futuro. Os clientes devem ignorar cuidadosamente os tipos de eventos não reconhecidos.

Formato da linha:

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

Os parâmetros da ferramenta de aterramento do sharepoint.

As informações de definição de entrada para uma ferramenta do sharepoint como usado para configurar um agente.

Uma ferramenta de concha guardada numa caixa de ferramentas. Este 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.

A configuração para um trabalho de geração de dados com o tipo SimpleQnA.

A configuração para um trabalho de geração de dados de geração de tarefas. Use com cenários de avaliação multiturno e com fontes de prompt, ficheiro ou agente. As linhas de conjunto de dados geradas incluem campos como id, category, test_case_description, e desired_num_turns.

Um destino SIP para um destino de transferência telefónica.

Um recurso de competências.

Conteúdo inline para definir uma competência simples sem carregar ficheiros. Segue a especificação agentskills.io SKILL.md.

(Pré-visualização) Uma referência a uma habilidade versionada da Foundry.

interface do modelo SkillReferenceParam

Uma versão específica de uma habilidade.

Força o modelo a chamar a ferramenta apply_patch ao executar uma chamada de ferramenta.

Obriga o modelo a chamar a ferramenta shell quando é necessária uma chamada de ferramenta.

interface de modelo EspecificaProgramáticaToolCallingParam

Orientação em linguagem natural para a otimização desejada.

Uma entrada estruturada que pode participar de substituições de modelo de prompt e vinculação de argumento de ferramenta.

Uma saída estruturada que pode ser produzida pelo agente.

Recurso supervisionado de ajuste fino para a geração de dados. Esta é uma funcionalidade de pré-visualização.

Entradas fornecidas pelo chamador para um trabalho supervisionado de afinação fina de geração de dados. Esta é uma funcionalidade de pré-visualização.

Configuração de saída de ficheiro para um trabalho supervisionado de afinação fina de geração de dados. Esta é uma funcionalidade de pré-visualização.

Definição de categoria de taxonomia.

Definição de subcategoria de taxonomia.

Uma ligação da Telefone do Microsoft Teams Extension pertencente a um agente de voz.

Uma ligação da Telefone do Microsoft Teams Extension regressava numa lista, incluindo a sua etiqueta de entidade.

Um destino do Microsoft Teams para um destino de transferência telefónica.

Configuração de telemetria fornecida pelo cliente para exportar registos de contentores, traços e métricas.

Uma configuração de endpoint de exportação de telemetria.

Configuração de autenticação para um endpoint de telemetria.

Interface que representa operações de telemetria

Uma ligação telefónica pertencente a um agente de voz.

Uma ligação telefónica deveria numa lista, incluindo a sua etiqueta de entidade.

Uma intenção de chamada de saída direta ou criada pela campanha duradoura.

Um pedido de cancelamento gravado para uma chamada de saída.

A janela de execução opcional para uma chamada de saída direta.

Uma observação duradoura e limitada no ciclo de vida de uma chamada telefónica.

Diagnósticos detalhados para uma chamada de entrada duradoura para um agente de voz.

Um resumo de uma chamada recebida duradoura para um agente de voz.

Temporização detalhada neutra em relação ao fornecedor para uma chamada telefónica de entrada.

Correlação de um registo duradouro de chamadas telefónicas para o seu rastreio Foundry voltado para o cliente.

O destino de uma chamada de saída.

Uma política de retentativa com um intervalo fixo entre as tentativas de chamada de saída.

A política de retentativa para uma intenção duradoura de chamada de saída. max_attempts inclui a primeira tentativa. Os contextos específicos da estratégia são definidos pela política derivada.

Um destino para um destino de transferência telefónica.

Um destino nomeado para onde o agente de voz pode transferir uma chamada.

Os alvos de transferência telefónica configurados para um agente de voz.

Um objeto que especifica o formato que o modelo deve produzir. 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 de Resultados Estruturados. O formato padrão é { "type": "text" } sem opções adicionais. Não recomendado para gpt-4o e modelos mais recentes:* Definir para { "type": "json_object" } ativar o modo JSON antigo, que garante que a mensagem gerada pelo modelo é JSON válida. O uso json_schema é preferível para modelos que o suportam.

Configuração base para o formato das respostas de texto geradas.

Configura as respostas geradas para usar o formato de objeto JSON.

Configura as respostas geradas para usar texto simples.

Formato de resposta de objeto JSON. Um método mais antigo de gerar respostas JSON. O uso json_schema é recomendado para modelos que o suportam. Observe que o modelo não gerará JSON sem uma mensagem do sistema ou do usuário instruindo-o a fazê-lo.

Formato de resposta do esquema JSON. Usado para gerar respostas JSON estruturadas. Saiba mais sobre Saídas Estruturadas.

Formato de resposta padrão. Usado para gerar respostas de texto.

Um gatilho de temporizador de um só tiro.

Uma ferramenta que pode ser usada para gerar uma resposta.

Restringe as ferramentas disponíveis para o modelo a um conjunto pré-definido.

Indica que o modelo deve usar uma ferramenta interna para gerar uma resposta. Saiba mais sobre ferramentas integradas.

Indica que o modelo deve usar uma ferramenta interna para gerar uma resposta. Saiba mais sobre ferramentas integradas.

Indica que o modelo deve usar uma ferramenta interna para gerar uma resposta. Saiba mais sobre ferramentas integradas.

Indica que o modelo deve usar uma ferramenta interna para gerar uma resposta. Saiba mais sobre ferramentas integradas.

Use esta opção para forçar o modelo a chamar uma ferramenta personalizada específica.

Indica que o modelo deve usar uma ferramenta interna para gerar uma resposta. Saiba mais sobre ferramentas integradas.

Use esta opção para forçar o modelo a chamar uma função específica.

Indica que o modelo deve usar uma ferramenta interna para gerar uma resposta. Saiba mais sobre ferramentas integradas.

Use esta opção para forçar o modelo a chamar uma ferramenta específica em um servidor MCP remoto.

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.

Indica que o modelo deve usar uma ferramenta interna para gerar uma resposta. Saiba mais sobre ferramentas integradas.

Indica que o modelo deve usar uma ferramenta interna para gerar uma resposta. Saiba mais sobre ferramentas integradas.

Configuração por ferramenta que controla a visibilidade da ferramenta e o comportamento de pesquisa.

Descrição de uma ferramenta que pode ser usada por um agente.

Um recurso de ligação a projectos.

Configuração de pesquisa de ferramentas hospedadas ou BYOT para ferramentas diferidas.

Uma ferramenta de pesquisa de caixa de ferramentas armazenada numa caixa de ferramentas.

A configuração para um trabalho de geração de dados com o tipo ToolUse. Esta é uma funcionalidade de pré-visualização usada apenas para ajustes finos de cenários.

Uma caixa de ferramentas que armazena definições de ferramentas reutilizáveis para agentes.

Configuração de políticas para uma caixa de ferramentas, incluindo segurança de conteúdos e outras definições de governação.

Uma ferramenta de pesquisa de caixa de ferramentas armazenada numa caixa de ferramentas.

Um ambiente de contentor provisionado automaticamente para uma ferramenta shell armazenada numa caixa de ferramentas.

Um ambiente existente de contentores para uma ferramenta shell guardado numa caixa de ferramentas.

Um ambiente de execução para uma ferramenta shell armazenada numa caixa de ferramentas. Este modelo de ambiente está orientado para a configuração da caixa de ferramentas e não modifica o contrato do ambiente do shell OpenAI.

Política de acesso à rede para um contentor shell toolbox provisionado automaticamente.

Uma política de rede que desativa o acesso de saída a partir de um contentor shell toolbox.

Uma fonte de competências incluída numa caixa de ferramentas.

Uma referência a uma competência existente para incluir numa caixa de ferramentas.

Uma representação abstrata de uma ferramenta armazenada numa caixa de ferramentas.

Uma versão específica de uma caixa de ferramentas.

As versões associadas a uma caixa de ferramentas.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Interface representando as operações de uma caixa de ferramentas.

Parâmetros opcionais.

A configuração para um trabalho de geração de dados com o tipo Traces.

Fontes de rastreios para trabalhos de geração de dados — traços de conversa do Application Insights.

Fontes de traços para trabalhos de geração de avaliadores — traços de conversa provenientes do Application Insights.

Estatísticas de utilização para modelos faturadas pela duração da entrada de áudio.

Estatísticas de utilização para modelos faturados por token de uso.

Interface do modelo TranscriçãoTextoUtilizaçãoTokensInputTokenDetalhes

Uma língua detetada em áudio transcrito.

Modelo base para Trigger do cronograma.

Uma encadernação Twilio pertencente a um agente de voz.

Uma ligação Twilio deveria numa lista, incluindo a sua etiqueta de entidade.

Solicite ao organismo a atualização de uma versão do modelo. Apenas a descrição e as etiquetas podem ser modificadas.

O pedido para atualizar uma ligação telefónica existente. Cada propriedade é opcional e o fornecedor da vinculação é imutável.

interface do modelo UpdateToolboxRequest

Configura efeitos aplicados ao áudio simulado de conversas.

Configura o número, duração, efeitos áudio e comportamento simulado do utilizador nas conversas.

Configura o comportamento de interrupção padrão para o utilizador simulado.

Configuração para comportamento simulado de interrupção do utilizador.

Define um cenário de teste. As propriedades da configuração da simulação aqui especificadas sobrepõem-se aos valores predefinidos correspondentes da fonte de dados.

Configura o comportamento das conversas para o utilizador simulado.

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.

Indicador de versão que determina qual versão do agente faz backup da sessão.

Indicador de versão que faz referência a uma versão específica do agente pelo nome.

Interface do modelo VersionSelectionRule

Interface do modelo VersionSelector

Definições de animação para uma sessão de agente de voz.

A configuração áudio para um agente de voz. Estes valores são os valores padrão da sessão e podem ser ultrapassados durante a ligação.

Introdução da configuração de áudio para um agente de voz.

Configuração de áudio de saída para um agente de voz. Os campos específicos do fornecedor são selecionados por voice_type:

• openai: voice e speed.
• azure-standard: , , , , , , custom_text_normalization_url, prefer_localesstyle, , pitch, e volume. custom_lexicon_urlvoice_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 os azure-standard campos exceto voice e style, mais personal_voice_model; o nome da voz deriva do avatar.
• azure-realtime-native: voice e speed. format e output_audio_timestamp_types aplica-se a todos os tipos de voz.

Configuração de avatar para um agente de voz. Estes valores são os valores padrão da sessão e podem ser ultrapassados durante a ligação.

Um servidor ICE usado para negociação de avatares WebRTC.

Colocação do avatar e definições de movimento.

O fundo do vídeo do avatar.

O corte retangular aplicado ao vídeo avatar.

Codificador de vídeo Avatar e definições de apresentação.

A resolução do vídeo do avatar.

Deteção de atividade semântica de voz do Azure otimizada para inglês.

Deteção de atividade semântica de voz em Azure multilíngue.

Deteção de atividade semântica de voz em Azure.

Opções para cancelar uma resposta.

O rtc.call.sdp.create evento do cliente: inicia a sinalização WebRTC com uma oferta SDP.

O session.avatar.connect evento do cliente.

O session.update evento do cliente.

Resultado fornecido quando a ligação entre o agente de voz é encerrada.

Um fluxo de agente de voz bidirecional e interligado.

Suporta exatamente uma for await iteração sobre eventos do servidor; uma segunda tentativa lança. Sair do loop cedo (break, return, ou um erro não detetado no corpo do loop) fecha a ligação como efeito secundário. Tipos de eventos de servidor não reconhecidos são entregues como VoiceAgentUnknownEvent sem interromper o fluxo. Eventos malformados continuam a falhar na iteração devido a um erro de protocolo.

A definição de agente de voz. A sua configuração (modelo, instruções, áudio, ferramentas e avatar opcional) impulsiona uma experiência gerida de fala para fala. Estabeleça sessões de voz em tempo real através de GET /agents/{agent_name}/endpoint/protocols/voice. Cada criação ou atualização produz uma nova versão imutável.

Definições de cancelamento de eco do lado do servidor para áudio de entrada.

Um controlo gerido por serviços que termina a conversa ativa.

Configuração semântica de deteção de fim de enunciado.

Opções partilhadas por operações que constroem um evento de protocolo em nome do chamador.

Uma ferramenta funcional nativa executada pelo cliente.

Configuração de saudação de início de sessão para um agente de voz.

Configuração assíncrona de entrada e transcrição áudio. Expande as opções de transcrição em tempo real do OpenAI com os modelos de transcrição Azure e MAI, modelos de fala personalizados e dicas de frase.

Campos partilhados por configurações de resposta intermédia.

Uma saudação criada pelo modelo de sessão a partir de um prompt de abertura e turno com escopo.

Uma resposta intermédia gerada por um modelo de linguagem.

Uma ferramenta MCP disponível para um agente de voz.

Configuração de redução de ruído de áudio de entrada.

Opções para ligar o cliente em tempo real a um agente de voz.

Opções para o cliente em tempo real Voice Agents.

Uma resposta em tempo real em tempo real devolvida pelo serviço de voice-agent em ambos response.createdresponse.done os eventos.

Propriedades partilhadas por respostas em tempo real devolvidas pelo serviço de voice-agent.

Parâmetros aceites por um evento de voice-agent response.create .

Opções para criar uma resposta.

Detalhes de um erro de sinalização WebRTC.

Definições semânticas de deteção de curvas VAD da OpenAI.

Opções partilhadas por operações que adicionam um item de conversa e, por defeito, solicitam uma resposta.

Opções partilhadas pelas operações de envio em tempo real.

Opções para enviar mensagens de texto.

Opções para devolver um resultado de função.

O response.animation_blendshapes.delta evento do servidor.

O response.animation_blendshapes.done evento do servidor.

O response.animation_viseme.delta evento do servidor.

O response.animation_viseme.done evento do servidor.

O response.audio_timestamp.delta evento do servidor.

O response.audio_timestamp.done evento do servidor.

O response.video.delta evento do servidor.

O rtc.call.error evento do servidor: uma falha de sinalização WebRTC.

O rtc.call.sdp.created evento do servidor: a resposta SDP que conclui a negociação do WebRTC.

O session.avatar.connecting evento do servidor.

O session.avatar.switch_to_idle evento do servidor.

O session.avatar.switch_to_speaking evento do servidor.

O session.subagent.aborted evento do servidor.

O session.subagent.completed evento do servidor.

O session.subagent.started evento do servidor.

O warning evento do servidor.

Detalhes de um aviso não fatal.

Deteção de atividade de voz do lado do servidor.

Definições de avatar aceites pelo contrato estável de voice-agent WebSocket.

As definições estáveis de sessão em tempo real efetivas são devolvidas pelo serviço de voice-agent.

As definições estáveis de sessão em tempo real aceites num session.update evento cliente.

Opções para atualizar a sessão ao vivo.

Uma resposta intermédia estática selecionada de texto configurado.

Um agente de texto irmão da Foundry que um agente de voz pode consultar como especialista em background.

Configuração para agentes de texto irmãos da Foundry que um agente de voz pode consultar.

Política para entregar respostas enquanto um agente de voz espera por um subagente.

Um controlo gerido por serviços que atua na sessão de voz ativa sem código do cliente ou autenticação externa.

Uma saudação determinística renderizada com as entradas estruturadas do agente de voz e sintetizada sem geração criada pelo modelo.

Uma ferramenta utilizável por um agente de voz.

Uma referência a uma caixa de ferramentas Foundry, que é um conjunto versionado de ferramentas executado através do seu endpoint MCP.

Uma frase transcrita com informação de tempo.

Uma palavra com carimbo temporal numa transcrição áudio de entrada.

Configuração de deteção de curvas para um agente de voz.

Um evento de servidor cujo tipo de fio não é reconhecido por esta versão do SDK.

O SDK entrega estes eventos sem fechar a ligação ou aplicar validação ou normalização de eventos conhecidos. Inspecione e valide os campos brutos antes de os usar.

As opções passaram para o VoiceAgentWebSocketTransport.connect.

Cria instâncias VoiceAgentWebSocketTransport para o VoiceAgentRealtimeClient.

Chamadas de retorno invocadas por um VoiceAgentWebSocketTransport à medida que ocorrem eventos de ligação.

Um transporte WebSocket plugável usado pelo VoiceAgentRealtimeClient. Implemente esta interface para personalizar a forma como a ligação em tempo real é estabelecida, por exemplo, para a encaminhar através de um relé autenticado.

Metadados para o segmento á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 acede com as suas próprias credenciais. Para armazenamento gerido pela Foundry, blob_uri está ausente e os bytes são transmitidos pela rota do /audio/content item.

Uma conversa de voz persistente. O envelope da Foundry que detém a transcrição armazenada de um agente de voz, respostas, métricas por turno e áudio. É o limite pai, retenção e eliminação: a sua eliminação desencadeia as suas respostas, itens, métricas e áudio. Quando a finalização falha, quaisquer respostas parciais persistentes, itens e áudio do item permanecem legíveis.

Um motor que gere conversas para um agente de voz.

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 acede com as suas próprias credenciais. Para armazenamento gerido pela Foundry, blob_uri está ausente e os bytes são transmitidos pela rota do /audio/generated/content item.

Uma referência fechada ao agente de texto alojado que gere a gestão de conversas para um agente de voz. O agente alojado é resolvido dentro do mesmo projeto e deve suportar o invocations_ws protocolo, compatibilidade Voice Live e Bridge Protocol 1.0.

Metadados para a gravação estéreo combinada e de chamada inteira de uma conversa de voz (áudio do utilizador no canal esquerdo, áudio do agente no direito). Construído uma vez a partir dos segmentos por turno após o fim da sessão e armazenado em cache de forma duradoura. Os metadados comuns (formato, taxa de amostragem, canais, disposição do canal, duração) são devolvidos tanto para gravações geridas pela Foundry como para gravações de trazer o seu próprio armazenamento (BYOS). Para BYOS, a resposta inclui blob_uritambém , o URI da gravação no armazenamento próprio do cliente (sem token SAS), que o cliente descarrega usando as suas próprias credenciais de armazenamento. Para o armazenamento blob_uri gerido pela Foundry, está ausente e os bytes são transmitidos pela /audio/content rota em vez disso.

O papel atribuído a cada canal de uma gravação de voz estéreo fundida.

Uma resposta de voz persistente que representa uma reviravolta de inferência de modelo dentro de uma conversa. Nos resultados da lista, a output projeção pode ser omitida; recuperar a resposta completa (GET .../responses/{response_id}) ou a rota dos itens de resposta paginados (GET .../responses/{response_id}/items) para os seus itens de saída. created_at / completed_at são extensões de encomenda duráveis da Foundry.

Configuração de áudio para uma resposta. Segue a forma do objeto OpenAI Realtime GA audio .

A projeção de saída áudio de resposta plana, com opcionais voice, voice_type, voice_locale, e format campos.

Propriedades partilhadas por respostas de voz persistentes.

Uma ferramenta WebIQ do lado do servidor.

Uma ferramenta WebIQ guardada numa caixa de ferramentas.

A localização aproximada do utilizador.

Uma configuração de pesquisa web para pesquisa personalizada bing

Esta ferramenta pesquisa na web resultados relevantes para usar numa resposta. Saiba mais sobre a ferramenta pesquisa web.

Pesquise na Internet fontes relacionadas com o prompt. Saiba mais sobre a ferramenta pesquisa web.

interface do modelo WebSearchToolFilters

Uma ferramenta de pesquisa web guardada numa caixa de ferramentas.

Esquema semanal de recorrência.

Uma ferramenta WorkIQ do lado do servidor.

Uma ferramenta WorkIQ guardada numa caixa de ferramentas.

A definição do agente de fluxo de trabalho.

Versões suportadas pelo protocolo A2A.

Um limite de acesso para o protocolo de atividade.

Tipo de AgenteBlueprintReferenceType

Alias para AgentBlueprintReferenceUnion

Chaves de opt-in de funcionalidades para operações de definição de agentes que suportam funcionalidades de pré-visualização condicional.

Tipo de união para todos os tipos de definição de agente. Suporta workflow, alojamento, aplicação container, prompt e agentes externos.

Configuração para encaminhamento, protocolos e autorização num endpoint agente.

Tipo de AgenteEndpointAuthorizationSchemeType

Alias para AgentEndpointAuthorizationSchemeUnion

Alias para AgentHarnessUnion

O estado da identidade de um agente, aplicável tanto à identidade da instância do agente como ao blueprint do agente.

Um valor JSON usado em payloads do Agent Insights.

Identifica de onde veio uma visão geral do Agent Insights.

A superfície do Prompt foi alterada por uma solução proposta.

O tipo de correção proposta por um agente insight, que é renderizável pelo cliente.

O gatilho que iniciou uma run de insight para agentes.

A gravidade da perceção de um agente.

O estado do ciclo de vida de um agente insight.

Define o tipo/tipo de agente. Determina qual estrutura de definição de agente é usada.

Vocabulário para o expand parâmetro de consulta no endpoint candidato LIST. Esta união aberta mantém os SDKs utilizáveis quando novas chaves de expansão são enviadas do lado do servidor. Múltiplos valores são serializados como um parâmetro de consulta separado por vírgulas.

Alias para AgentOptimizationCandidateOutputUnion

O estado do ciclo de vida do candidato.

Alias for AgentOptimizationConfigurationBaseUnion

Otimização de tipos de configuração de trabalho.

Tipos de fonte suportados por conjuntos de avaliação de otimização.

Formatos lógicos de linhas suportados por conjuntos de avaliação de otimização.

Alias para AgentOptimizationEvaluationSetUnion

Objetivo para um trabalho de otimização de agentes.

Alias para AgentOptimizationMutationUnion

Fase de otimização que consumiu recursos do modelo.

Alias for AgentOptimizationTargetCompletionDataSourceUnion

Tipos de configuração alvo suportados por trabalhos de otimização.

Alias for AgentOptimizationTargetConfigurationUnion

Razão pela qual o processo de otimização terminou. As razões de rescisão antecipada ainda indicam um emprego bem-sucedido; os candidatos concluídos continuam disponíveis.

Alias for AgentOptimizationUserConversationSimulationDataSourceUnion

Tipo de AgentProtocol

O estado de uma sessão de agente.

O estado operacional de um agente.

Indica a origem do estado operacional de um agente. Vazio quando o estado não é derivado de uma fonte específica.

Tipo de AgentType

O estado de provisionamento de uma versão agente.

O arquivo ZIP descarregado contendo o código agente alojado, exposto como um Blob do navegador ou Node.js fluxo legível.

O ficheiro de sessão do agente descarregado, exposto como um Blob do navegador ou Node.js fluxo legível.

Parâmetros opcionais.

Estratégias para ataques.

Tipos de consulta disponíveis para a ferramenta Pesquisa de IA do Azure.

Alias para BaseCredentialsUnion

O arquivo ZIP para a versão padrão de uma competência, exposto como um Blob do navegador ou Node.js fluxo legível.

O áudio WAV de um elemento de conversa, exposto como um Blob do navegador ou Node.js fluxo legível.

A gravação WAV estéreo fundida de uma conversa de voz, exposta como um Blob do navegador ou Node.js fluxo legível.

O áudio WAV gerado para um elemento de conversa interrompido, exposto como um Blob do navegador ou Node.js fluxo legível.

Tipo de CallableToolAllowedCaller

Como as dependências de pacotes são resolvidas no momento da implementação para um agente hospedado baseado em código.

Alias para ComparaçãoFilterValueItems

Tipo de Ambiente de Computador

O tipo (ou categoria) da conexão

Tipo de ContainerMemoryLimit

Tipo de ContainerNetworkPolicyParamType

Alias para ContainerNetworkPolicyParamUnion

Tipo de ContainerSkillType

Alias para ContainerSkillUnion

Uma interface que descreve uma página de resultados.

Alias para CreateTelephonyBindingRequestUnion

Tipo de CriarTranscriçãoRespostaJsonUsoTipo

Alias para CreateTranscriptionResponseJsonUsageUnion

O tipo de credencial usado pela conexão

Tipo de CustomToolParamFormatType

Alias for CustomToolParamFormatUnion

Alias for DataGenerationJobConfigurationUnion

Alias para DataGenerationJobInputsUnion

Os tipos de ficheiros de saída suportados para um trabalho de geração de dados.

Alias para DataGenerationJobOutputUnion

Os modos de escrita suportados para as saídas de trabalhos de geração de dados.

Os cenários suportados para um trabalho de geração de dados.

Os tipos de fonte suportados para trabalhos de geração de dados.

Alias for DataGenerationJobSourceUnion

Os tipos de trabalho de geração de dados suportados.

Alias para DataGenerationJobUnion

Enum para determinar o tipo de dados.

Alias para DatasetVersionUnion

Dias da semana para esquema de recorrência.

Tipo de DeploymentType

Alias para DeploymentUnion

O tipo de trabalhador digital.

O arquivo ZIP para uma versão de habilidade especificada, exposto como um Blob do navegador ou Node.js fluxo legível.

O nível em que a avaliação é realizada.

Tipo de ação de avaliação.

Alias para EvaluationRuleActionUnion

Tipo de evento da regra de avaliação.

Pseudónimo de AvaliaçãoSindicatoalvo

Tipo de entrada da taxonomia de avaliação.

Alias para AvaliaçãoTaxonomiaInputUnion

Alias for EvaluationVoiceModelConfigurationUnion

A categoria do avaliador

O tipo de definição do avaliador

Alias para EvaluatorDefinitionUnion

Os tipos de fonte suportados para trabalhos de geração de avaliadores.

Alias para EvaluatorGenerationJobSourceUnion

A direção da métrica que indica se um valor mais alto é melhor, um valor menor é melhor ou neutro

O tipo do avaliador

O tipo do avaliador

Valores válidos para o conteúdo de um arquivo binário.

Alias para Filtros

Tipo de FoundryCaracterísticasOptInKeys

A categoria do perfil de artefactos.

Sinais detetados no artefacto do modelo.

O tipo de origem do modelo.

Código de aviso para artefactos do modelo.

O tipo de peso do modelo.

Tipo de FunçãoShellToolParamEnvironmentType

Alias para FunctionShellToolParamEnvironmentUnion

Os inputs específicos do tipo para gerar e criar um agente.

Categoria de um aviso surgiu numa versão gerada pelo avaliador. Extensível para que novas categorias de aviso (por exemplo, segurança, qualidade de saída) possam ser introduzidas sem alteração interrompida.

O pacote binário da aplicação Microsoft 365 gerado para um agente Foundry.

Uma ferramenta integrada no GitHub Copilot configurável pelo cliente.

Conhecidos no GitHub emitem eventos que podem lançar uma rotina.

Tipo de GramáticaSintaxe

Tipo de ImageGenAction

Tipo de IndexType

Alias para IndexUnion

Controle quanto esforço o modelo irá exercer para corresponder ao estilo e características, especialmente características faciais, das imagens de entrada. Este parâmetro é suportado apenas para gpt-image-1 e gpt-image-1.5 modelos posteriores, não suportados para gpt-image-1-mini. Suporta high e low. O padrão é low.

Alias para InsightRequestUnion

Alias para InsightResultUnion

Alias para InsightSampleUnion

O pedido dos insights.

Um sondador para uma operação de longa duração que cria um recurso de emprego.

Valores de estatuto extensíveis partilhados pelos empregos da Foundry.

Tipo de item de memória.

Alias para MemoryItemUnion

Tipo de operação de memória.

Alias para MemoryStoreDefinitionUnion

O tipo de implementação de armazenamento de memória a ser usado.

Tipo de MemoryStoreType

Status de uma operação de atualização de armazenamento de memória.

O âmbito de publicação para a aplicação Microsoft Teams gerada.

Uma classificação de uma ação que pode não estar alinhada com a intenção do utilizador. Valores adicionais podem ser devolvidos.

Escreve o alias para Node.js ReadableStream. Nos alvos Node, isto resolve para o tipo NodeJS.ReadableStream real. Nos alvos browser/react-native, a variante da plataforma resolve para never, que sai naturalmente dos tipos de união.

Alias para OpenApiAuthDetailsUnion

Tipo de autenticação para o ponto de extremidade OpenApi. Os tipos permitidos são:

• Anónimo (sem necessidade de autenticação)
• Project Ligação (requer project_connection_id para o endpoint, conforme configurado no AI Foundry)
• Managed_Identity (requer audiência para autenticação baseada em identidade)

Enum descrevendo estados de operação permitidos.

As alterações de configuração e os resultados agregados da avaliação para um candidato à otimização do agente.

Tipo de contexto fornecido a um fluxo de trabalho de otimização.

Alias para OptimizationContextUnion

Um trabalho de otimização de agentes que acompanha inputs, progresso, estado e resultados de avaliação de candidatos.

Os candidatos avaliados e identificadores da linha de base e do melhor candidato de um trabalho de otimização.

Tipo de Ordem de Página

O tipo de carregamento pendente.

O estado da revisão da Certificação de Agente Microsoft do título da loja Microsoft 365 publicado para um agente.

Como o corpo do pedido/resposta de uma invocação é analisado para localizar texto para moderação de segurança de conteúdo.

Forma de resposta declarada pelo autor para o protocolo de invocações.

Tipo de RankerVersionType

Tipo de RealtimeAudioFormatosType

Alias para RealtimeAudioFormatsUnion

Tipo de RealtimeClienteEventType

Alias para RealtimeClientEventUnion

Tipo de Tipo de MensagemConversaItemEm Tempo Real

Alias para RealtimeConversationItemMessageUnion

Tipo de Tipo de ItemType de Conversa em Tempo Real

Alias para RealtimeConversationItemUnion

interface do modelo RealtimeFunctionToolParameters

Tipo de RealtimeMCPErrorType

Alias para RealtimeMCPErrorUnion

Restringe o esforço no raciocínio para modelos de tempo real com capacidade de raciocínio, como gpt-realtime-2.

Tipo de RealtimeServerEventType

Alias para RealtimeServerEventUnion

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. Reduzir o esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados no raciocínio em uma resposta.

• gpt-5.1 por defeito é none, que não executa raciocínio. Os valores de raciocínio suportados para gpt-5.1 são none, low, medium, e high. As chamadas de ferramenta são suportadas para todos os valores de raciocínio no gpt-5.1.
• Todos os modelos anteriores gpt-5.1 ao padrão de medium esforço de raciocínio, e não suportam none.
• O gpt-5-pro modelo utiliza por defeito (e apenas suporta) high o esforço de raciocínio.
• xhigh é suportado para todos os modelos após gpt-5.1-codex-max.

Alias para ReasoningModeEnum

Alias para RecurrenceScheduleUnion

Tipo de recorrência.

Alias para RedTeamTargetConfigUnion

Categoria de risco para o objetivo de ataque.

Os valores do discriminador suportam ações rotineiras.

Pseudónimo de RoutineActionUnion

Caminhos de origem conhecidos que podem produzir uma execução rotineira.

As identidades suportadas para autorização rotineira de despacho.

Os valores discriminadores suportados para cargas úteis de despacho rotineiro manual.

Alias para RoutineDispatchPayloadUnion

Fases conhecidas do ciclo de vida registadas para uma execução rotineira.

O estado de uma corrida rotineira.

Os valores discriminadores suportados para gatilhos rotineiros.

Alias para RoutineTriggerUnion

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.

Aviso de gravidade para um aviso de qualidade de entrada na geração de rubricas. Conjunto inicial de valores: warning.

Atribuição de fonte de aviso para um aviso de qualidade de entrada por geração de rubricas. Os valores por fonte (prompt, agent, dataset) correspondem à categoria de origem visível ao 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 rastreio se resolvem em conteúdo do conjunto de dados a montante.

Um sondador para uma operação de longa duração que cria um recurso de execução.

O tipo de amostra utilizada na análise.

Agendar status de provisionamento.

Tipo de tarefa.

Alias para ScheduleTaskUnion

Tipo de PesquisaContentType

Tipo de PesquisaContextoTamanhoContexto

Tipos conhecidos de eventos SSE emitidos pelo fluxo de registo de sessão do agente hospedado. Tipos adicionais de eventos poderão ser introduzidos em versões futuras.

Os tipos de perguntas suportados para trabalhos de geração de dados SimpleQnA usados para ajustes finos de cenários.

Atributo de agente que pode ser otimizado.

O tipo de dados de telemetria a exportar.

O tipo de autenticação para um endpoint de telemetria.

Alias para TelemetryEndpointAuthUnion

O tipo de endpoint de exportação de telemetria.

Alias for TelemetryEndpointUnion

O protocolo de transporte para exportação de telemetria.

Alias for TelephonyBindingListItemUnion

O estado do ciclo de vida de uma ligação telefónica.

Alias para TelephonyBindingUnion

O carimbo temporal utilizado como base para a duração da chamada.

Razões conhecidas geradas pelo serviço para que uma chamada telefónica terminasse, em vez de razões para um trabalho geral de chamada de saída. Códigos de cadeia adicionais podem ser devolvidos.

O estado de ciclo de vida de uma chamada de saída duradoura.

Razões terminais conhecidas para um trabalho geral de chamada de saída, que pode abranger várias tentativas de fornecedores. Estes são distintos das razões do ciclo de vida das chamadas individuais. Códigos de cadeia adicionais podem ser devolvidos.

Um nome de evento de ciclo de vida neutro em relação ao fornecedor. Os valores conhecidos são estáveis; valores adicionais podem ser adicionados ao longo do tempo.

O resultado de uma observação do ciclo de vida da telefonia.

Razões conhecidas geradas pelo serviço para um evento do ciclo de vida da telefonia. Uma razão de evento não descreve necessariamente o resultado final da chamada. Códigos de cadeia adicionais podem ser devolvidos.

O componente que fornecia a observação do ciclo de vida da telefonia.

A fase neutra do fornecedor atingida por uma chamada telefónica recebida.

O estado do ciclo de vida de uma chamada telefónica de entrada.

A fonte de um carimbo temporal do ciclo de vida da telefonia.

O modo utilizado para expor uma chamada telefónica como um rastreio Foundry voltado para o cliente.

O estado de disponibilidade de um rastreio de chamada telefónica dirigido ao cliente.

O tipo de destino para uma chamada de saída.

A estratégia de retentativa para uma chamada de saída.

Alias para TelefoniaOutboundRetryPolicyUnion

Um fornecedor de telefonia suportado por uma ligação de agente. Os valores conhecidos são estáveis; valores adicionais podem ser adicionados ao longo do tempo.

O tipo de destino de transferência telefónica. Os valores conhecidos são estáveis; valores adicionais podem ser adicionados ao longo do tempo.

Alias para TelephonyTransferDestinationUnion

Tipo de TextoRespostaFormatoConfiguraçãoTipo

Suportava configurações para texto simples e respostas JSON estruturadas.

Alias para TextResponseFormatUnion

Controla qual (se houver) ferramenta é 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.

Tipo de ToolChoiceParamType

Alias para ToolChoiceParamUnion

Tipo de ToolSearchExecutionType

Tipo de Tipo de Ferramenta

Alias para ToolUnion

Alias para ToolboxShellEnvironmentUnion

Alias para ToolboxShellNetworkPolicyUnion

Alias para ToolboxSkillUnion

Tipos de ferramentas suportados para ferramentas armazenadas numa caixa de ferramentas.

Alias para ToolboxToolUnion

A resposta foi devolvida pelo último endpoint MCP da toolbox.

Tipo de efeito do tratamento.

Tipo de gatilho.

Alias para TriggerUnion

Efeito que pode ser aplicado a áudio simulado de conversa. A união é extensível para efeitos adicionais.

Alias para UserConversationSimulationInterruptionConfigurationUnion

O tipo de indicador de versão usado para determinar a versão do agente que apoia uma sessão.

Alias para VersionIndicatorUnion

Tipo de VersãoRegraSeleção

Alias para VersionSelectionRuleUnion

Um resultado de animação produzido por uma sessão de voice-agent.

Um tipo de timestamp de áudio de saída suportado por um agente de voz.

O transporte usado para entregar a transmissão de vídeo do avatar.

O tipo avatar.

Uma mensagem v1 estável enviada por um cliente através de um WebSocket com agente de voz.

Os estados de ligação são reportados por uma ligação em tempo real entre um agente de voz.

Chamada quando uma ligação de voz e agente muda de estado.

A fonte de áudio de referência usada para cancelamento de eco.

O modelo semântico de deteção de fim de enunciação.

O limiar de sensibilidade para a deteção semântica de fim de enunciado.

Alias para VoiceAgentGreetingConfigUnion

O identificador do modelo de transcrição áudio-entrada. Este é um nome de modelo, não um nome de implementação Foundry. Espelha os modelos de transcrição suportados pelo backend de voz gerida, abrangendo os modelos de transcrição em tempo real OpenAI, bem como os modelos Azure e MAI. Podem ser adicionados valores adicionais ao longo do tempo.

Alias para VoiceAgentInterimResponseConfigUnion

Uma condição que pode desencadear uma resposta provisória.

A contagem máxima de tokens de saída ou o literal inf.

O modo de redução de ruído de áudio de entrada.

Códigos de erro gerados pelo cliente em tempo real dos Agentes de Voz.

Um evento recebido de uma ligação em tempo real com um agente de voz.

Os eventos conhecidos mantêm os seus tipos gerados e a normalização. Tipos de fios não reconhecidos estão envolvidos em VoiceAgentUnknownEvent. Ligue type para eventos conhecidos restritos, ou exclua type === "unknown" antes de passar um evento a um gestor de eventos conhecidos.

Uma mensagem v1 estável enviada pelo serviço através de um agente de voz WebSocket.

Campos adicionais que uma sessão de agente de voz pode incluir nas saídas do serviço.

A configuração efetiva da sessão regressou nos eventos do ciclo de vida da sessão do agente de voz.

A configuração da sessão é aceite por um evento de atualização de sessão com agente de voz.

A razão pela qual a consulta de subagentes foi abortada.

Uma ação de controlo de sessão de voz gerida por serviço. Os valores conhecidos são estáveis; valores adicionais podem ser adicionados ao longo do tempo.

Alias para VoiceAgentSystemToolUnion

Comportamento de seleção de ferramentas para um agente de voz.

Quando uma invocação de ferramenta cria uma resposta de seguimento. Podem ser adicionados valores adicionais ao longo do tempo.

Alias para VoiceAgentToolUnion

O transporte usado para uma ligação de voz e agente.

Alias para VoiceAgentTurnDetectionConfigUnion

A estratégia de deteção de curvas. Podem ser adicionados valores adicionais ao longo do tempo.

Uma mensagem de texto JSON trocada através de um WebSocket de voz já estabelecido. Os bytes de áudio são codificados em base64 nos campos de eventos JSON.

O subprotocolo WebSocket é suportado por uma ligação de agente de voz.

Um codec de áudio. Podem ser adicionados valores adicionais ao longo do tempo.

Um formato de contentor de áudio. Podem ser adicionados valores adicionais ao longo do tempo.

Um papel de participante voz-áudio. Podem ser adicionados valores adicionais ao longo do tempo.

Pseudónimo para VoiceConversationEngineUnion

O estado do ciclo de vida de uma conversa vocal 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 fecho normal ou do cliente, end_conversation, um fecho 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.

Como o modelo que apoia um agente de voz é servido. Isto é independente da arquitetura (em tempo real ou em cascata), que o serviço deriva do modelo selecionado.

Uma modalidade de saída que o agente pode produzir. animation e avatar são usados quando um avatar é configurado.

A implementação por voz. Podem ser adicionados valores adicionais ao longo do tempo.

Versões da API do Microsoft Foundry

Typeguard para RestError

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

Valores conhecidos do VoiceAgentConnectionState reportados por uma ligação de voz e agente em tempo real.