@azure/ai-projects package

Classes

AIProjectClient

obtém o cliente OpenAI com opções opcionais de cliente OpenAI

Interfaces

@azure/ai-projects.Index
A2APreviewTool

Um agente que implementa o protocolo A2A.

A2APreviewToolboxTool

Uma ferramenta A2A armazenada em uma caixa de ferramentas.

A2AProtocolConfiguration

Configuração específica para o protocolo A2A.

AIProjectClientOptionalParams

Parâmetros opcionais para o cliente.

AISearchIndexResource

Um recurso de índice de pesquisa de IA.

ActivityProtocolConfiguration

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

Agent

Agente de interface de modelos

AgentBlueprintReference

interface do modelo AgentBlueprintReference

AgentCard

interface de modelo AgentCard

AgentCardSkill

interface do modelo AgentCardSkill

AgentClusterInsightRequest

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

AgentClusterInsightResult

Insights da análise de cluster de agentes.

AgentDataGenerationJobSource

Fonte de agente para trabalhos de geração de dados — referencia um agente para buscar instruções e metadados.

AgentDefinition

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

AgentEndpointAuthorizationScheme

interface de modelo AgenteEndpointAuthorizationScheme

AgentEndpointConfig

interface modelo AgentEndpointConfig

AgentEvaluatorGenerationJobSource

Source de agente para trabalhos de geração de avaliadores — faz referência a um agente para buscar instruções e metadados.

AgentIdentity

interface do modelo AgentIdentity

AgentSessionResource

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

AgentTaxonomyInput

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

AgentVersion

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

AgenticIdentityPreviewCredentials

Definição de credencial de identidade agêntica

AgentsCreateAgentFromManifestOptionalParams

Parâmetros opcionais.

AgentsCreateAgentVersionFromManifestOptionalParams

Parâmetros opcionais.

AgentsCreateOptionalParams

Parâmetros opcionais.

AgentsCreateSessionOptionalParams

Parâmetros opcionais.

AgentsCreateVersionFromCodeOptionalParams

Parâmetros opcionais.

AgentsCreateVersionOptionalParams

Parâmetros opcionais.

AgentsDeleteOptionalParams

Parâmetros opcionais.

AgentsDeleteSessionFileOptionalParams

Parâmetros opcionais.

AgentsDeleteSessionOptionalParams

Parâmetros opcionais.

AgentsDeleteVersionOptionalParams

Parâmetros opcionais.

AgentsDisableOptionalParams

Parâmetros opcionais.

AgentsDownloadAgentCodeOptionalParams

Parâmetros opcionais.

AgentsDownloadSessionFileOptionalParams

Parâmetros opcionais.

AgentsEnableOptionalParams

Parâmetros opcionais.

AgentsGetOptionalParams

Parâmetros opcionais.

AgentsGetSessionLogStreamOptionalParams

Parâmetros opcionais.

AgentsGetSessionOptionalParams

Parâmetros opcionais.

AgentsGetVersionOptionalParams

Parâmetros opcionais.

AgentsListOptionalParams

Parâmetros opcionais.

AgentsListSessionFilesOptionalParams

Parâmetros opcionais.

AgentsListSessionsOptionalParams

Parâmetros opcionais.

AgentsListVersionsOptionalParams

Parâmetros opcionais.

AgentsOperations

Interface que representa uma operação de Agentes.

AgentsStopSessionOptionalParams

Parâmetros opcionais.

AgentsUpdateAgentFromManifestOptionalParams

Parâmetros opcionais.

AgentsUpdateAgentObjectOptionalParams

Parâmetros opcionais.

AgentsUpdateOptionalParams

Parâmetros opcionais.

AgentsUploadSessionFileOptionalParams

Parâmetros opcionais.

ApiErrorResponse

Resposta de erro para falhas de API.

ApiKeyCredentials

Definição de credencial de chave de API

ApplyPatchToolParam

Permite que o assistente crie, exclua ou atualize arquivos usando diferenciais unificados.

ApproximateLocation

interface do modelo AproximaçãoLocalização

ArtifactProfile

Perfil de artefato do modelo

AutoCodeInterpreterToolParam

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

AzureAIAgentTarget

Representa um alvo especificando um agente de IA do Azure.

AzureAIModelTarget

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

AzureAISearchIndex

Definição de índice Pesquisa de IA do Azure 

AzureAISearchTool

A informação de definição de entrada para uma ferramenta de busca de IA do Azure usada para configurar um agente.

AzureAISearchToolResource

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

AzureAISearchToolboxTool

Uma ferramenta do Pesquisa de IA do Azure  armazenada em uma caixa de ferramentas.

AzureAgentConfig

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

AzureFunctionBinding

A estrutura para manter storage nome e URI da fila.

AzureFunctionDefinition

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

AzureFunctionStorageQueue

A estrutura para manter storage nome e URI da fila.

AzureFunctionTool

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

AzureOpenAIModelConfiguration

Azure OpenAI configuração de modelos. A versão da API seria selecionada pelo serviço para consultar o modelo.

BaseCredentials

Uma classe base para credenciais de conexão

BetaAgentsCancelOptimizationJobOptionalParams

Parâmetros opcionais.

BetaAgentsCreateOptimizationJobOptionalParams

Parâmetros opcionais.

BetaAgentsDeleteOptimizationJobOptionalParams

Parâmetros opcionais.

BetaAgentsGetOptimizationJobOptionalParams

Parâmetros opcionais.

BetaAgentsListOptimizationJobsOptionalParams

Parâmetros opcionais.

BetaAgentsOperations

Interface representando as operações de um BetaAgent.

BetaDatasetsCancelGenerationJobOptionalParams

Parâmetros opcionais.

BetaDatasetsCreateGenerationJobOptionalParams

Parâmetros opcionais.

BetaDatasetsDeleteGenerationJobOptionalParams

Parâmetros opcionais.

BetaDatasetsGetGenerationJobOptionalParams

Parâmetros opcionais.

BetaDatasetsListGenerationJobsOptionalParams

Parâmetros opcionais.

BetaDatasetsOperations

Interface representando operações de um BetaDatasets.

BetaEvaluationTaxonomiesCreateOptionalParams

Parâmetros opcionais.

BetaEvaluationTaxonomiesDeleteOptionalParams

Parâmetros opcionais.

BetaEvaluationTaxonomiesGetOptionalParams

Parâmetros opcionais.

BetaEvaluationTaxonomiesListOptionalParams

Parâmetros opcionais.

BetaEvaluationTaxonomiesOperations

Interface representando uma operação BetaEvaluationTaxonomies.

BetaEvaluationTaxonomiesUpdateOptionalParams

Parâmetros opcionais.

BetaEvaluatorsCancelGenerationJobOptionalParams

Parâmetros opcionais.

BetaEvaluatorsCreateGenerationJobOptionalParams

Parâmetros opcionais.

BetaEvaluatorsCreateVersionOptionalParams

Parâmetros opcionais.

BetaEvaluatorsDeleteGenerationJobOptionalParams

Parâmetros opcionais.

BetaEvaluatorsDeleteVersionOptionalParams

Parâmetros opcionais.

BetaEvaluatorsGetCredentialsOptionalParams

Parâmetros opcionais.

BetaEvaluatorsGetGenerationJobOptionalParams

Parâmetros opcionais.

BetaEvaluatorsGetVersionOptionalParams

Parâmetros opcionais.

BetaEvaluatorsListGenerationJobsOptionalParams

Parâmetros opcionais.

BetaEvaluatorsListOptionalParams

Parâmetros opcionais.

BetaEvaluatorsListVersionsOptionalParams

Parâmetros opcionais.

BetaEvaluatorsOperations

Interface representando as operações de um BetaEvaluator.

BetaEvaluatorsPendingUploadOptionalParams

Parâmetros opcionais.

BetaEvaluatorsUpdateVersionOptionalParams

Parâmetros opcionais.

BetaInsightsGenerateOptionalParams

Parâmetros opcionais.

BetaInsightsGetOptionalParams

Parâmetros opcionais.

BetaInsightsListOptionalParams

Parâmetros opcionais.

BetaInsightsOperations

Interface representando uma operação BetaInsights.

BetaMemoryStoresCreateMemoryOptionalParams

Parâmetros opcionais.

BetaMemoryStoresCreateOptionalParams

Parâmetros opcionais.

BetaMemoryStoresDeleteMemoryOptionalParams

Parâmetros opcionais.

BetaMemoryStoresDeleteOptionalParams

Parâmetros opcionais.

BetaMemoryStoresDeleteScopeOptionalParams

Parâmetros opcionais.

BetaMemoryStoresGetMemoryOptionalParams

Parâmetros opcionais.

BetaMemoryStoresGetOptionalParams

Parâmetros opcionais.

BetaMemoryStoresGetUpdateResultOptionalParams

Parâmetros opcionais.

BetaMemoryStoresListMemoriesOptionalParams

Parâmetros opcionais.

BetaMemoryStoresListOptionalParams

Parâmetros opcionais.

BetaMemoryStoresOperations

Interface representando operações do BetaMemoryStores.

BetaMemoryStoresSearchMemoriesOptionalParams

Parâmetros opcionais.

BetaMemoryStoresUpdateMemoriesOptionalParams

Parâmetros opcionais.

BetaMemoryStoresUpdateMemoryOptionalParams

Parâmetros opcionais.

BetaMemoryStoresUpdateOptionalParams

Parâmetros opcionais.

BetaModelsCreateOptions

Opções para o método de criação que faz upload de arquivos locais e registra uma versão do modelo.

BetaModelsDeleteOptionalParams

Parâmetros opcionais.

BetaModelsGetCredentialsOptionalParams

Parâmetros opcionais.

BetaModelsGetOptionalParams

Parâmetros opcionais.

BetaModelsListOptionalParams

Parâmetros opcionais.

BetaModelsListVersionsOptionalParams

Parâmetros opcionais.

BetaModelsOperations

Interface representando operações de um BetaModels.

BetaModelsPendingCreateVersionOptionalParams

Parâmetros opcionais.

BetaModelsPendingUploadOptionalParams

Parâmetros opcionais.

BetaModelsUpdateOptionalParams

Parâmetros opcionais.

BetaOperations

Interface representando uma operação Beta.

BetaRedTeamsCreateOptionalParams

Parâmetros opcionais.

BetaRedTeamsGetOptionalParams

Parâmetros opcionais.

BetaRedTeamsListOptionalParams

Parâmetros opcionais.

BetaRedTeamsOperations

Interface representando uma operação do BetaRedTeams.

BetaRoutinesCreateOrUpdateOptionalParams

Parâmetros opcionais.

BetaRoutinesDeleteOptionalParams

Parâmetros opcionais.

BetaRoutinesDisableOptionalParams

Parâmetros opcionais.

BetaRoutinesDispatchOptionalParams

Parâmetros opcionais.

BetaRoutinesEnableOptionalParams

Parâmetros opcionais.

BetaRoutinesGetOptionalParams

Parâmetros opcionais.

BetaRoutinesListOptionalParams

Parâmetros opcionais.

BetaRoutinesListRunsOptionalParams

Parâmetros opcionais.

BetaRoutinesOperations

Interface representando uma operação BetaRoutines.

BetaSchedulesCreateOrUpdateOptionalParams

Parâmetros opcionais.

BetaSchedulesDeleteOptionalParams

Parâmetros opcionais.

BetaSchedulesGetOptionalParams

Parâmetros opcionais.

BetaSchedulesGetRunOptionalParams

Parâmetros opcionais.

BetaSchedulesListOptionalParams

Parâmetros opcionais.

BetaSchedulesListRunsOptionalParams

Parâmetros opcionais.

BetaSchedulesOperations

Interface representando operações de BetaSchedules.

BetaSkillsCreateOptionalParams

Parâmetros opcionais.

BetaSkillsCreateVersionFromFilesOptionalParams

Parâmetros opcionais.

BetaSkillsDeleteOptionalParams

Parâmetros opcionais.

BetaSkillsDeleteVersionOptionalParams

Parâmetros opcionais.

BetaSkillsDownloadOptionalParams

Parâmetros opcionais.

BetaSkillsDownloadVersionOptionalParams

Parâmetros opcionais.

BetaSkillsGetOptionalParams

Parâmetros opcionais.

BetaSkillsGetVersionOptionalParams

Parâmetros opcionais.

BetaSkillsListOptionalParams

Parâmetros opcionais.

BetaSkillsListVersionsOptionalParams

Parâmetros opcionais.

BetaSkillsOperations

Interface representando uma operação BetaSkills.

BetaSkillsUpdateOptionalParams

Parâmetros opcionais.

BingCustomSearchConfiguration

Uma bing configuração de pesquisa personalizada.

BingCustomSearchPreviewTool

As informações de definição de entrada para um Bing ferramenta de pesquisa personalizada, conforme usado para configurar um agente.

BingCustomSearchToolParameters

O bing parâmetros da ferramenta de pesquisa personalizada.

BingGroundingSearchConfiguration

Configuração de pesquisa para a base de Bing

BingGroundingSearchToolParameters

O bing parâmetros da ferramenta de pesquisa de aterramento.

BingGroundingTool

As informações de definição de entrada para um bing ferramenta de pesquisa de aterramento, conforme usado para configurar um agente.

BlobReference

Detalhes de referência de blob.

BotServiceAuthorizationScheme

interface modelo BotServiceAuthorizationScheme

BotServiceRbacAuthorizationScheme

interface modelo BotServiceRbacAuthorizationScheme

BotServiceTenantAuthorizationScheme

interface modelo BotServiceTenantAuthorizationScheme

BrowserAutomationPreviewTool

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

BrowserAutomationPreviewToolboxTool

Uma ferramenta de automação de navegador armazenada em uma caixa de ferramentas.

BrowserAutomationToolConnectionParameters

Definição de parâmetros de entrada para a conexão usada pela Ferramenta de Automação do Navegador.

BrowserAutomationToolParameters

Definição de parâmetros de entrada para a Ferramenta de Automação do Navegador.

CaptureStructuredOutputsTool

Uma ferramenta para capturar saídas estruturadas

ChartCoordinate

Coordenadas para o gráfico de análise.

ChatSummaryMemoryItem

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

ClusterInsightResult

Insights da análise de cluster.

ClusterTokenUsage

Uso de token para análise de cluster

CodeBasedEvaluatorDefinition

Definição de avaliador baseada em código usando código python

CodeConfiguration

Configuração de implantação baseada em código para um agente hospedado.

CodeInterpreterTool

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

CodeInterpreterToolboxTool

Uma ferramenta de interpretação de código armazenada em uma caixa de ferramentas.

ComparisonFilter

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

CompoundFilter

Combinar vários filtros usando and ou or.

ComputerTool

Uma ferramenta que controla um computador virtual. Saiba mais sobre a ferramenta de computador.

ComputerUsePreviewTool

Uma ferramenta que controla um computador virtual. Saiba mais sobre a ferramenta de computador.

Connection

Resposta da lista e operações get connections

ConnectionsGetOptionalParams

Parâmetros opcionais.

ConnectionsGetWithCredentialsOptionalParams

Parâmetros opcionais.

ConnectionsListOptionalParams

Parâmetros opcionais.

ConnectionsOperations

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

ContainerAutoParam

interface de modelo ContainerAutoParam

ContainerConfiguration

Configuração de implantação baseada em contêiner para um agente hospedado.

ContainerNetworkPolicyAllowlistParam

interface model ContainerNetworkPolicyAllowlistParam

ContainerNetworkPolicyDisabledParam

interface de modelo ContainerNetworkPolicyDisabledParam

ContainerNetworkPolicyDomainSecretParam

interface de modelo ContainerNetworkPolicyDomainSecretParam

ContainerNetworkPolicyParam

Política de acesso à rede para o contêiner.

ContainerSkill

interface de modelo ContainerSkill

ContinuousEvaluationRuleAction

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

CosmosDBIndex

Definição de índice do repositório de vetores do CosmosDB

CreateAgentVersionFromCodeContent

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

CreateAgentVersionFromCodeMetadata

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

CreateSkillVersionFromFilesBody

Corpo de solicitação multiparte para criar uma versão de habilidade a partir de arquivos. Aceita um único arquivo zip ou múltiplos arquivos individuais de skill (upload de diretório). Para uploads em zip, o servidor extrai e valida o conteúdo. Para uploads de diretórios, os arquivos são validados as-is.

CronTrigger

Gatilho baseado em cron.

CustomCredential

Definição de credencial personalizada

CustomGrammarFormatParam

Uma gramática definida pelo usuário.

CustomRoutineTrigger

Um gatilho de rotina de evento personalizada.

CustomTextFormatParam

Texto livre e sem restrições.

CustomToolParam

Uma ferramenta personalizada que processa entradas usando um formato especificado. Saiba mais sobre as ferramentas custom

CustomToolParamFormat

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

DailyRecurrenceSchedule

Cronograma diário de recorrência.

DataGenerationJob

Geração de dados - recurso para vagas.

DataGenerationJobInputs

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

DataGenerationJobOptions

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

DataGenerationJobOutput

Saia informações para um trabalho de geração de dados.

DataGenerationJobOutputOptions

Opções de saída para o trabalho de geração de dados.

DataGenerationJobResult

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

DataGenerationJobSource

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

DataGenerationModelOptions

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

DataGenerationTokenUsage

Informações de uso de tokens para um trabalho de geração de dados.

DatasetCredential

Representa uma referência a um blob para consumo

DatasetDataGenerationJobOutput

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

DatasetEvaluatorGenerationJobSource

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

DatasetReference

Referência a um conjunto de dados versionado da Foundry.

DatasetVersion

Definição de DatasetVersion

DatasetsCreateOrUpdateOptionalParams

Parâmetros opcionais.

DatasetsDeleteOptionalParams

Parâmetros opcionais.

DatasetsGetCredentialsOptionalParams

Parâmetros opcionais.

DatasetsGetOptionalParams

Parâmetros opcionais.

DatasetsListOptionalParams

Parâmetros opcionais.

DatasetsListVersionsOptionalParams

Parâmetros opcionais.

DatasetsOperations

Interface que representa uma operação de conjuntos de dados.

DatasetsPendingUploadOptionalParams

Parâmetros opcionais.

DeleteAgentResponse

Um objeto de agente excluído

DeleteAgentVersionResponse

Um objeto de versão do agente excluído

DeleteMemoryResponse

Resposta para excluir um item de memória de um armazenamento de memória.

DeleteMemoryStoreResponse

interface do modelo DeleteMemoryStoreResponse

DeleteSkillResponse

Uma habilidade deletada.

DeleteSkillVersionResponse

Uma versão de habilidade deletada.

Deployment

Definição de implantação de modelo

DeploymentsGetOptionalParams

Parâmetros opcionais.

DeploymentsListOptionalParams

Parâmetros opcionais.

DeploymentsOperations

Interface representando uma operação de Implantações.

Dimension

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

DispatchRoutineResponse

Identificadores retornados após uma rotineira de despacho ser enfileirada.

EmbeddingConfiguration

Classe de configuração de inserção

EmptyModelParam

interface de modelo EmptyModelParam

EndpointBasedEvaluatorDefinition

Definição de avaliador baseada em endpoint. O cliente possui e hospeda um endpoint HTTP que implementa o contrato de avaliação. O avaliador faz referência a uma Conexão de Project pelo nome; a conexão armazena a URL e as credenciais do endpoint (API Key ou Entra ID). No momento da execução, o serviço resolve a conexão para obter a URL do endpoint e os detalhes de autenticação, e então chama o endpoint para cada linha de avaliação.

EntraAuthorizationScheme

interface modelo EntraAuthorizationScheme

EntraIDCredentials

Entra ID definição de credenciais

ErrorModel

Interface do modelo ErrorModel

EvalResult

Resultado da avaliação.

EvalRunResultCompareItem

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

EvalRunResultComparison

Os resultados da comparação para o tratamento são executados em relação à linha de base.

EvalRunResultSummary

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

EvaluationComparisonInsightRequest

Solicitação de comparação de avaliação

EvaluationComparisonInsightResult

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

EvaluationResultSample

Uma amostra do resultado da avaliação.

EvaluationRule

Modelo de regra de avaliação.

EvaluationRuleAction

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

EvaluationRuleFilter

Modelo de filtro de avaliação.

EvaluationRulesCreateOrUpdateOptionalParams

Parâmetros opcionais.

EvaluationRulesDeleteOptionalParams

Parâmetros opcionais.

EvaluationRulesGetOptionalParams

Parâmetros opcionais.

EvaluationRulesListOptionalParams

Parâmetros opcionais.

EvaluationRulesOperations

Interface que representa uma operação EvaluationRules.

EvaluationRunClusterInsightRequest

Insights sobre o conjunto de resultados da avaliação

EvaluationRunClusterInsightResult

Os insights da análise de cluster de execução de avaliação.

EvaluationScheduleTask

Tarefa de avaliação para o cronograma.

EvaluationTarget

Classe base para destinos com suporte a discriminadores.

EvaluationTaxonomy

Definição de taxonomia de avaliação

EvaluationTaxonomyInput

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

EvaluatorCredentialRequest

Órgão de solicitação para obtenção de credenciais de avaliador

EvaluatorDefinition

Configuração do avaliador base com discriminador

EvaluatorGenerationArtifacts

Artefatos de proveniência gerenciada por serviços produzidos por um trabalho de geração avaliador. Presente apenas nos recursos EvaluatorVersion criados via pipeline de geração. O conjunto de dados combinado-JSONL Foundry é somente leitura e resolve para um conjunto de dados versionado em um namespace reservado por serviços.

EvaluatorGenerationInputs

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

EvaluatorGenerationJob

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

EvaluatorGenerationJobSource

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

EvaluatorGenerationTokenUsage

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

EvaluatorMetric

Métrica do avaliador

EvaluatorVersion

Definição de avaliador

ExternalAgentDefinition

A definição de agente externo. Representa um agente terceirizado hospedado fora do Foundry (por exemplo, no GCP ou AWS). O registro é apenas para metadados: a Foundry registra a definição do agente para iluminar experiências de observabilidade (rastreios, avaliações) sobre dados emitidos pelo cliente da OpenTelemetry.

FabricDataAgentToolParameters

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

FabricIQPreviewTool

Uma ferramenta FabricIQ para o lado do servidor.

FabricIQPreviewToolboxTool

Uma ferramenta FabricIQ armazenada em uma caixa de ferramentas.

FieldMapping

Classe de configuração de mapeamento de campo

FileDataGenerationJobOutput

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

FileDataGenerationJobSource

Fonte de arquivo para trabalhos de geração de dados — entrada de arquivo Azure OpenAI.

FileDatasetVersion

Definição de FileDatasetVersion

FileSearchTool

Uma ferramenta que pesquisa conteúdo relevante de arquivos carregados. Saiba mais sobre a ferramenta de pesquisa de arquivos.

FileSearchToolboxTool

Uma ferramenta de busca de arquivos armazenada em uma caixa de ferramentas.

FixedRatioVersionSelectionRule

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

FolderDatasetVersion

Definição de FileDatasetVersion

FoundryModelWarning

Um aviso associado a um modelo.

FunctionShellToolParam

Uma ferramenta que permite ao modelo executar comandos de shell.

FunctionShellToolParamEnvironment

Interface do modelo FunçãoShellToolParamAmbiente

FunctionShellToolParamEnvironmentContainerReferenceParam

Interface do modelo FunçãoShellToolParamAmbienteContainerReferenceParam

FunctionShellToolParamEnvironmentLocalEnvironmentParam

Função de interface do modelo ShellToolParamAmbienteLocalAmbiente

FunctionTool

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

FunctionToolParam

interface de modelo FunctionToolParam

GenAITracingOptions

Opções para configurar o rastreamento GenAI em uma instância específica do AIProjectClient.

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

GitHubIssueRoutineTrigger

Um gatilho de rotina de problemas no GitHub.

HeaderTelemetryEndpointAuth

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

HostedAgentDefinition

A definição do agente hospedado.

HourlyRecurrenceSchedule

Cronograma de recorrência por hora.

HumanEvaluationPreviewRuleAction

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

HybridSearchOptions

interface de modelo HybridSearchOptions

ImageGenTool

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

ImageGenToolInputImageMask

interface do modelo ImageGenToolInputImageMask

IndexesCreateOrUpdateOptionalParams

Parâmetros opcionais.

IndexesDeleteOptionalParams

Parâmetros opcionais.

IndexesGetOptionalParams

Parâmetros opcionais.

IndexesListOptionalParams

Parâmetros opcionais.

IndexesListVersionsOptionalParams

Parâmetros opcionais.

IndexesOperations

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

InlineSkillParam

interface de modelo InlineSkillParam

InlineSkillSourceParam

Carga útil de habilidade inline

Insight

O corpo da resposta para insights de cluster.

InsightCluster

Um conjunto de amostras de análise.

InsightGenerationRequest

O órgão de solicitação para gerar um insight.

InsightModelConfiguration

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

InsightRequest

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

InsightResult

O resultado dos insights.

InsightSample

Uma amostra da análise.

InsightScheduleTask

Tarefa de insight para o agendamento.

InsightSummary

Resumo da análise do cluster de erros.

InsightsMetadata

Metadados sobre os insights.

InvocationsProtocolConfiguration

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

InvocationsWsProtocolConfiguration

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

InvokeAgentInvocationsApiDispatchPayload

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

InvokeAgentInvocationsApiRoutineAction

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

InvokeAgentResponsesApiDispatchPayload

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

InvokeAgentResponsesApiRoutineAction

Despacha uma rotina pela API de respostas. Exatamente um dos agent_name ou agent_endpoint_id deve ser fornecido.

LocalShellToolParam

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

LocalSkillParam

interface de modelo LocalSkillParam

LoraConfig

Metadados específicos do adaptador para modelos LoRA. Drives atendem à configuração do motor no momento da implantação.

MCPTool

Forneça ao modelo acesso a ferramentas adicionais por meio de servidores remotos do Protocolo de Contexto de Modelo (MCP). Learn mais sobre MCP.

MCPToolFilter

Um objeto filtro para especificar quais ferramentas são permitidas.

MCPToolRequireApproval

interface de modelo MCPToolRequireApproval

MCPToolboxTool

Uma ferramenta MCP armazenada em uma caixa de ferramentas.

ManagedAgentIdentityBlueprintReference

interface de modelo ManagedAgentIdentityBlueprintReference

ManagedAzureAISearchIndex

Definição de índice de Pesquisa de IA do Azure  gerenciado

McpProtocolConfiguration

Configuração específica do protocolo MCP.

MemoryItem

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

MemoryOperation

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

MemorySearchItem

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

MemorySearchOptions

Opções de pesquisa de memória.

MemorySearchPreviewTool

Uma ferramenta para integrar memórias ao agente.

MemoryStore

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

MemoryStoreDefaultDefinition

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

MemoryStoreDefaultOptions

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

MemoryStoreDefinition

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

MemoryStoreDeleteScopeResponse

Resposta para excluir memórias de um escopo.

MemoryStoreOperationUsage

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

MemoryStoreSearchResponse

Resposta de pesquisa de memória.

MemoryStoreUpdateCompletedResult

Resultado da atualização da memória.

MemoryStoreUpdateResponse

Fornece o status de uma operação de atualização do repositório de memória.

MicrosoftFabricPreviewTool

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

ModelCredentialRequest

Solicite a obtenção de credenciais para um ativo modelo.

ModelDeployment

Definição de implantação de modelo

ModelDeploymentSku

Informações de SKU

ModelPendingUploadRequest

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

ModelPendingUploadResponse

Representa a resposta para um modelo pendente de solicitação de upload.

ModelSamplingParams

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

ModelSourceData

Informações de origem para o modelo

ModelVersion

Definição de Versão do Modelo

MonthlyRecurrenceSchedule

Cronograma mensal de recorrência.

NamespaceToolParam

Grupos funcional/ferramentas personalizadas em um namespace compartilhado.

NoAuthenticationCredentials

Credenciais que não exigem autenticação

OneTimeTrigger

Gatilho único.

OpenAIClientOptionsWithAzureAgent

Ampliaram as opções do cliente OpenAI para incluir a configuração do endpoint do Azure Agent.

OpenApiAnonymousAuthDetails

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

OpenApiAuthDetails

detalhes de autenticação para OpenApiFunctionDefinition

OpenApiFunctionDefinition

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

OpenApiManagedAuthDetails

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

OpenApiManagedSecurityScheme

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

OpenApiProjectConnectionAuthDetails

Detalhes de segurança da autenticação de conexão do OpenApi project

OpenApiProjectConnectionSecurityScheme

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

OpenApiTool

As informações de definição de entrada para uma ferramenta OpenAPI, conforme usado para configurar um agente.

OpenApiToolboxTool

Uma ferramenta OpenAPI armazenada em uma caixa de ferramentas.

OptimizationAgentIdentifier

Identifica o agente registrado da Foundry para otimizar (apenas por requisição). Habilidades, ferramentas e system_prompt são especificados em options.optimization_config.

OptimizationCandidate

Resultado agregado da avaliação para uma única configuração de agente candidato em todas as tarefas.

OptimizationDatasetCriterion

Critério de avaliação: um par nome + instrução usado para pontuação por item.

OptimizationDatasetInput

Modelo discriminado base para entrada de conjuntos de dados. Ou itens em linha ou uma referência registrada.

OptimizationDatasetItem

Um único item em um conjunto de dados inline.

OptimizationEvaluatorRef

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

OptimizationInlineDatasetInput

Conjunto de dados inline — itens fornecidos diretamente no corpo da solicitação.

OptimizationJob

Recurso de trabalho de otimização de agentes — um trabalho de longa duração que otimiza a configuração do agente (instruções, modelo, habilidades, ferramentas) para maximizar as pontuações de avaliação. Em caso de sucesso, o resultado contém os candidatos pontuados.

OptimizationJobInputs

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

OptimizationJobListItem

Representação de trabalho limitada retornada pelo endpoint LIST.

OptimizationJobProgress

Progresso em voo; Só é preenchido enquanto o status está na fila ou in_progress.

OptimizationJobResult

Órgão de resultado do estado terminal. Populado quando o status é alcançado ou falhado.

OptimizationOptions

Ajuste de botões e modo de execução para um trabalho de otimização.

OptimizationReferenceDatasetInput

Referência a um conjunto de dados registrado da Foundry.

OtlpTelemetryEndpoint

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

PageSettings

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

PagedAsyncIterableIterator

Uma interface que permite iteração assíncrona iterável tanto para conclusão quanto por página.

PendingUploadRequest

Representa uma solicitação de upload pendente.

PendingUploadResponse

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

ProceduralMemoryItem

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

PromotionInfo

Metadados de promoção registrados quando um candidato é implantado para um agente da Foundry.

PromptAgentDefinition

A definição do agente de prompt

PromptAgentDefinitionTextOptions

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

PromptBasedEvaluatorDefinition

Avaliador baseado em prompt

PromptDataGenerationJobSource

Fonte de prompt para trabalhos de geração de dados — texto inline fornecido pelo usuário.

PromptEvaluatorGenerationJobSource

Fonte de prompt para trabalhos de geração de avaliadores — texto em linha fornecido pelo usuário.

ProtocolConfiguration

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

ProtocolVersionRecord

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

RaiConfig

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

RankingOptions

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

Reasoning

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

RecurrenceSchedule

Modelo de cronograma de recorrência.

RecurrenceTrigger

Gatilho baseado em recorrência.

RedTeam

Detalhes da equipe vermelha.

RedTeamTargetConfig

Classe abstrata para configuração de destino.

ReminderPreviewToolboxTool

Uma ferramenta de lembrete guardada em uma caixa de ferramentas.

ResponseUsageInputTokensDetails

Interface do modelo RespostaUsoTokensEntradaDetalhes

ResponseUsageOutputTokensDetails

interface de modelo RespostaUsoTokensSaídaDetalhes

ResponsesProtocolConfiguration

Configuração específica para o protocolo de resposta.

Routine

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

RoutineAction

Modelo base para uma ação rotineira.

RoutineDispatchPayload

Modelo base para uma carga útil de despacho manual.

RoutineRun

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

RoutineTrigger

Modelo base para um gatilho rotineiro.

RubricBasedEvaluatorDefinition

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

SASTokenCredentials

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

SasCredential

Definição de credencial SAS

Schedule

Modelo de agendamento.

ScheduleRoutineTrigger

Um gatilho recorrente baseado em crons.

ScheduleRun

Agendar modelo de execução.

ScheduleTask

Modelo de tarefa de agendamento.

SessionDirectoryEntry

Uma única entrada em uma listagem de diretório.

SessionDirectoryListResponse

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

SessionFileWriteResponse

Resposta ao enviar um arquivo para um sandbox de sessão.

SessionLogEvent

Um único quadro de evento Server-Sent emitido pelo fluxo de log de sessão do agente hospedado.

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

Novos tipos de eventos podem ser adicionados no futuro. Os clientes devem ignorar com elegância os tipos de eventos não reconhecidos.

Formato da fiação:

event: log
data: {"timestamp":"2026-03-10T09:33:17.121Z","stream":"stdout","message":"Starting server on port 18080"}

event: log
data: {"timestamp":"2026-03-10T09:34:52.714Z","stream":"status","message":"Successfully connected to container"}
SharepointGroundingToolParameters

Os parâmetros da ferramenta de aterramento do sharepoint.

SharepointPreviewTool

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

SimpleQnADataGenerationJobOptions

As opções para um trabalho de geração de dados com o tipo SimpleQnA.

Skill

Um recurso de habilidades.

SkillInlineContent

Conteúdo inline para definir uma habilidade simples sem precisar enviar arquivos. Segue a especificação agentskills.io SKILL.md.

SkillReferenceParam

interface do modelo SkillReferenceParam

SkillVersion

Uma versão específica de uma habilidade.

SpecificApplyPatchParam

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

SpecificFunctionShellParam

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

StructuredInputDefinition

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

StructuredOutputDefinition

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

TaxonomyCategory

Definição de categoria de taxonomia.

TaxonomySubCategory

Definição de subcategoria de taxonomia.

TelemetryConfig

Configuração de telemetria fornecida pelo cliente para exportar logs, rastreamentos e métricas de contêineres.

TelemetryEndpoint

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

TelemetryEndpointAuth

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

TelemetryOperations

Interface que representa operações de telemetria

TextResponseFormat

Um objeto que especifica o formato que o modelo deve gerar. A configuração { "type": "json_schema" } habilita saídas estruturadas, o que garante que o modelo corresponda ao esquema JSON fornecido. Saiba mais no guia Saídas Estruturadas. O formato padrão é { "type": "text" } sem opções adicionais. Não recomendado para gpt-4o e modelos mais recentes:* Configurando para { "type": "json_object" } ativar o modo JSON mais antigo, que garante que a mensagem gerada pelo modelo seja JSON válida. O uso json_schema é preferencial para modelos que dão suporte a ele.

TextResponseFormatConfiguration
TextResponseFormatConfigurationResponseFormatJsonObject
TextResponseFormatConfigurationResponseFormatText
TextResponseFormatJsonObject

Formato de resposta de objeto JSON. Um método mais antigo de geração de respostas JSON. O uso json_schema é recomendado para modelos que dão suporte a ele. Observe que o modelo não gerará JSON sem uma mensagem do sistema ou do usuário instruindo-o a fazer isso.

TextResponseFormatJsonSchema

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

TextResponseFormatText

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

TimerRoutineTrigger

Um gatilho de temporizador de um tiro só.

Tool

Uma ferramenta que pode ser usada para gerar uma resposta.

ToolChoiceAllowed

Restringe as ferramentas disponíveis para o modelo a um conjunto predefinido.

ToolChoiceCodeInterpreter

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

ToolChoiceComputer

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

ToolChoiceComputerUse

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

ToolChoiceComputerUsePreview

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

ToolChoiceCustom

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

ToolChoiceFileSearch

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

ToolChoiceFunction

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

ToolChoiceImageGeneration

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

ToolChoiceMCP

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

ToolChoiceParam

Como o modelo deve selecionar qual ferramenta (ou ferramentas) usar ao gerar uma resposta. Consulte o tools parâmetro para ver como especificar quais ferramentas o modelo pode chamar.

ToolChoiceWebSearchPreview

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

ToolChoiceWebSearchPreview20250311

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

ToolConfig

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

ToolDescription

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

ToolProjectConnection

Um recurso de conexão project.

ToolSearchToolParam

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

ToolUseFineTuningDataGenerationJobOptions

As opções para um trabalho de geração de dados com o tipo ToolUse. Usado apenas para ajustes finos de cenários.

ToolboxObject

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

ToolboxPolicies

Configuração de políticas para uma caixa de ferramentas, incluindo segurança de conteúdo e outras configurações de governança.

ToolboxSearchPreviewToolboxTool

Uma ferramenta de busca de caixa de ferramentas armazenada em uma caixa de ferramentas.

ToolboxSkill

Uma fonte de habilidades incluída em uma caixa de ferramentas.

ToolboxSkillReference

Uma referência a uma habilidade existente para incluir em uma caixa de ferramentas.

ToolboxTool

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

ToolboxVersionObject

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

ToolboxesCreateVersionOptionalParams

Parâmetros opcionais.

ToolboxesDeleteOptionalParams

Parâmetros opcionais.

ToolboxesDeleteVersionOptionalParams

Parâmetros opcionais.

ToolboxesGetOptionalParams

Parâmetros opcionais.

ToolboxesGetVersionOptionalParams

Parâmetros opcionais.

ToolboxesListOptionalParams

Parâmetros opcionais.

ToolboxesListVersionsOptionalParams

Parâmetros opcionais.

ToolboxesOperations

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

ToolboxesUpdateOptionalParams

Parâmetros opcionais.

TracesDataGenerationJobOptions

As opções para um trabalho de geração de dados com o tipo Traces.

TracesDataGenerationJobSource

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

TracesEvaluatorGenerationJobSource

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

Trigger

Modelo base para Trigger do agendamento.

UpdateModelVersionRequest

Solicite ao corpo para atualização de uma versão do modelo. Apenas descrições e tags podem ser modificadas.

UpdateToolboxRequest

interface do modelo UpdateToolboxRequest

UserProfileMemoryItem

Um item de memória que contém especificamente informações de perfil de usuário extraídas de conversas, como preferências, interesses e detalhes pessoais.

VersionIndicator

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

VersionRefIndicator

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

VersionSelectionRule

Interface do modelo VersãoRegra de Seleção

VersionSelector

Interface de modelo VersionSelector

WebSearchApproximateLocation

A localização aproximada do usuário.

WebSearchConfiguration

Uma configuração de pesquisa na Web para bing pesquisa personalizada

WebSearchPreviewTool

Essa ferramenta busca na internet resultados relevantes para usar em uma resposta. Saiba mais sobre a ferramenta de pesquisa web.

WebSearchTool

Pesquise na Internet fontes relacionadas ao prompt. Saiba mais sobre a ferramenta de pesquisa web.

WebSearchToolFilters

interface de modeloFiltrosFerramenta de Busca WebSearchTools

WebSearchToolboxTool

Uma ferramenta de busca na web armazenada em uma caixa de ferramentas.

WeeklyRecurrenceSchedule

Cronograma de recorrência semanal.

WorkIQPreviewTool

Uma ferramenta WorkIQ para o lado do servidor.

WorkIQPreviewToolboxTool

Uma ferramenta WorkIQ armazenada em uma caixa de ferramentas.

WorkflowAgentDefinition

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

Aliases de tipo

AgentBlueprintReferenceType

Tipo de AgentTipoReferênciaTipo de Recurso

AgentBlueprintReferenceUnion

Alias para AgentBlueprintReferenceUnion

AgentDefinitionOptInKeys

Chaves de opt-in de recursos para operações de definição de agentes, suportando agentes hospedados ou de workflow.

AgentDefinitionUnion

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

AgentEndpoint
AgentEndpointAuthorizationSchemeType

Tipo de AgenteEndpointAutorizaçãoSchemaType

AgentEndpointAuthorizationSchemeUnion

Alias for AgentEndpointAuthorizationSchemeUnion

AgentKind

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

AgentProtocol

Tipo de AgentProtocol

AgentSessionStatus

O status de uma sessão de agente.

AgentState

O estado operacional de um agente.

AgentType

Tipo de AgentType

AgentVersionStatus

O status de provisionamento de uma versão agente.

AgentsDownloadAgentCodeResponse
AgentsDownloadSessionFileResponse
AttackStrategy

Estratégias para ataques.

AzureAISearchQueryType

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

BaseCredentialsUnion

Alias para BaseCredentialsUnion

BetaSkillsDownloadResponse
CodeDependencyResolution

Como as dependências de pacotes são resolvidas na época da implantação para um agente hospedado baseado em código.

ComparisonFilterValueItems

Alias para ComparaçãoFilterValueItems

ComputerEnvironment

Tipo de Ambiente de Computador

ConnectionType

O tipo (ou categoria) da conexão

ContainerMemoryLimit

Tipo de ContainerMemoryLimit

ContainerNetworkPolicyParamType

Tipo de ContainerNetworkPolicyParamType

ContainerNetworkPolicyParamUnion

Alias para ContainerNetworkPolicyParamUnion

ContainerSkillType

Tipo de ContainerSkillType

ContainerSkillUnion

Alias para ContainerSkillUnion

ContinuablePage

Uma interface que descreve uma página de resultados.

CredentialType

O tipo de credencial usado pela conexão

CustomToolParamFormatType

Tipo de CustomToolParamFormatType

CustomToolParamFormatUnion

Alias for CustomToolParamFormatUnion

DataGenerationJobOptionsUnion

Alias para DataGeraçãoOpçõesEmprego União

DataGenerationJobOutputType

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

DataGenerationJobOutputUnion

Alias-deDadasGeraçãoEmpregoSaídaSindicato

DataGenerationJobScenario

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

DataGenerationJobSourceType

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

DataGenerationJobSourceUnion

Alias para DataGenerationJobSourceUnion

DataGenerationJobType

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

DatasetType

Enumerar para determinar o tipo de dados.

DatasetVersionUnion

Alias para DatasetVersionUnion

DayOfWeek

Dias da semana para cronograma de recorrência.

DeploymentType

Tipo de DeploymentType

DeploymentUnion

Alias para DeploymentUnion

DownloadVersionResponse
EvaluationLevel

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

EvaluationRuleActionType

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

EvaluationRuleActionUnion

Alias para EvaluationRuleActionUnion

EvaluationRuleEventType

Tipo do evento de regra de avaliação.

EvaluationTargetUnion

Nome de Avaliação SindicatoAlvo

EvaluationTaxonomyInputType

Tipo de entrada da taxonomia de avaliação.

EvaluationTaxonomyInputUnion

Alias para EvaluationTaxonomyInputUnion

EvaluatorCategory

A categoria do avaliador

EvaluatorDefinitionType

O tipo de definição do avaliador

EvaluatorDefinitionUnion

Alias para EvaluatorDefinitionUnion

EvaluatorGenerationJobSourceType

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

EvaluatorGenerationJobSourceUnion

Alias para AvaliatorGenerationJobSourceUnion

EvaluatorMetricDirection

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

EvaluatorMetricType

O tipo de avaliador

EvaluatorType

O tipo de avaliador

FileContents

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

Filters

Alias para Filtros

FoundryFeaturesOptInKeys

Tipo de FoundryFeaturesOptInKeys

FoundryModelArtifactProfileCategory

A categoria de perfil de artefatos.

FoundryModelArtifactProfileSignal

Sinais detectados no artefato do modelo.

FoundryModelSourceType

O tipo de origem do modelo.

FoundryModelWarningCode

Código de aviso para artefatos de modelos.

FoundryModelWeightType

O tipo de peso do modelo.

FunctionShellToolParamEnvironmentType

Tipo de FunçãoShellToolParamEnvironmentType

FunctionShellToolParamEnvironmentUnion

Alias para FunctionShellToolParamEnvironmentUnion

GitHubIssueEvent

Eventos conhecidos no GitHub emitem que podem disparar uma rotina.

GrammarSyntax

Tipo de GramáticaSintaxe

ImageGenAction

Tipo de ImageGenAction

IndexType

Tipo de IndexType

IndexUnion

Alias para IndexUnion

InputFidelity

Controlar o esforço que o modelo exercerá para corresponder ao estilo e aos recursos, especialmente os recursos faciais, das imagens de entrada. Esse parâmetro é suportado apenas para gpt-image-1 e gpt-image-1.5 modelos posteriores, não suportados para gpt-image-1-mini. Oferece suporte para high e low. Usa low como padrão.

InsightRequestUnion

Alias para InsightRequestUnion

InsightResultUnion

Alias para InsightResultUnion

InsightSampleUnion

Alias para InsightSampleUnion

InsightType

O pedido dos insights.

JobStatus

Valores de status extensíveis compartilhados pelos empregos da Foundry.

MemoryItemKind

Tipo de item de memória.

MemoryItemUnion

Alias para MemoryItemUnion

MemoryOperationKind

Tipo de operação de memória.

MemoryStoreDefinitionUnion

Alias para MemoryStoreDefinitionUnion

MemoryStoreKind

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

MemoryStoreType

Tipo de MemoryStoreType

MemoryStoreUpdateStatus

Status de uma operação de atualização do repositório de memória.

NodeReadableStream

Digite o alias para Node.js ReadableStream. Nos alvos Node, isso se resolve para o tipo NodeJS.ReadableStream real. Nos alvos nativos do navegador/react, a variante da plataforma resolve para never, que naturalmente sai dos tipos de união.

OpenApiAuthDetailsUnion

Alias para OpenApiAuthDetailsUnion

OpenApiAuthType

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

  • Anônimo (sem necessidade de autenticação)
  • Project Conexão (requer project_connection_id para o endpoint, conforme configurado no AI Foundry)
  • Managed_Identity (requer público-alvo para autenticação baseada em identidade)
OperationState

Enumeração que descreve os estados de operação permitidos.

OptimizationDatasetInputType

Valores discriminadores para a união de entrada do conjunto de dados.

OptimizationDatasetInputUnion

Alias para OtimizaçãoConjunto de DadosInputUnion

PageOrder

Tipo de Ordem de Página

PendingUploadType

O tipo de upload pendente.

RankerVersionType

Tipo de RankerVersionType

ReasoningEffort

Limita o esforço de raciocínio em modelos de raciocínio. Os valores atualmente suportados são none, minimal, low, medium, high, e xhigh. A redução do esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados no raciocínio de uma resposta.

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

Alias para RecurrenceScheduleUnion

RecurrenceType

Tipo de recorrência.

RedTeamTargetConfigUnion

Alias para RedTeamTargetConfigUnion

RiskCategory

Categoria de risco para o objetivo do ataque.

RoutineActionType

Os valores discriminadores suportados para ações rotineiras.

RoutineActionUnion

Nome de RotinaAçãoUnião

RoutineAttemptSource

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

RoutineDispatchPayloadType

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

RoutineDispatchPayloadUnion

Alias para RotinaDispatchPayloadUnion

RoutineRunPhase

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

RoutineRunStatus

O status de uma corrida rotineira.

RoutineTriggerType

Os valores do discriminador suportados para gatilhos rotineiros.

RoutineTriggerUnion

Alias para RoutineTriggerUnion

SampleType

O tipo de amostra usada na análise.

ScheduleProvisioningStatus

Agende o status de provisionamento.

ScheduleTaskType

Tipo da tarefa.

ScheduleTaskUnion

Alias para ScheduleTaskUnion

SearchContentType

Tipo de SearchContentType

SearchContextSize

Tipo de BuscaContextoTamanhoContexto

SessionLogEventType

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

SimpleQnAFineTuningQuestionType

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

TelemetryDataKind

O tipo de dados de telemetria a serem exportados.

TelemetryEndpointAuthType

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

TelemetryEndpointAuthUnion

Alias para TelemetryEndpointAuthUnion

TelemetryEndpointKind

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

TelemetryEndpointUnion

Alias for TelemetryEndpointUnion

TelemetryTransportProtocol

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

TextResponseFormatConfigurationType

Tipo de TextoRespostaFormatoConfiguraçãoTipo

TextResponseFormatConfigurationUnion
TextResponseFormatUnion

Alias para TextResponseFormatUnion

ToolChoiceParamType

Tipo de ToolChoiceParamType

ToolChoiceParamUnion

Alias para ToolChoiceParamUnion

ToolSearchExecutionType

Tipo de ToolSearchExecutionType

ToolType

Tipo de Tipo de Ferramenta

ToolUnion

Alias para ToolUnion

ToolboxSkillUnion

Alias: ToolboxSkillUnion

ToolboxToolType

Tipos de ferramentas suportados para ferramentas armazenadas em uma caixa de ferramentas.

ToolboxToolUnion

Alias para ToolboxToolUnion

TreatmentEffectType

Tipo de efeito de tratamento.

TriggerType

Tipo do gatilho.

TriggerUnion

Alias para TriggerUnion

VersionIndicatorType

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

VersionIndicatorUnion

Alias para VersionIndicatorUnion

VersionSelectionRuleType

Tipo de VersãoSeleçãoRegraTipo

VersionSelectionRuleUnion

Alias para VersionSelectionRuleUnion

Enumerações

KnownApiVersions

Versões da API do Microsoft Foundry

Funções

isRestError(unknown)

Typeguard para RestError

Variáveis

RestError

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

Detalhes da função

isRestError(unknown)

Typeguard para RestError

function isRestError(e: unknown): e

Parâmetros

e

unknown

Algo pego por uma cláusula catch.

Retornos

e

Detalhes da variável

RestError

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

RestError: RestErrorConstructor

Tipo