@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 implementando o protocolo A2A.

A2APreviewToolboxTool

Uma ferramenta A2A guardada numa caixa de ferramentas.

A2AProtocolConfiguration

Configuração específica do protocolo A2A.

AIProjectClientOptionalParams

Parâmetros opcionais para o cliente.

AISearchIndexResource

Um recurso AI Search Index.

ActivityProtocolConfiguration

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

Agent

Agente da interface do modelo

AgentBlueprintReference

interface do modelo AgentBlueprintReference

AgentCard

interface do 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 — referências a um agente para obter 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 modelo AgentEndpointAuthorizationScheme

AgentEndpointConfig

interface model AgentEndpointConfig

AgentEvaluatorGenerationJobSource

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

AgentIdentity

interface do modelo AgentIdentity

AgentSessionResource

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

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 do agente.

AgenticIdentityPreviewCredentials

Definição de credenciais de identidade de agente

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 ao assistente criar, eliminar ou atualizar ficheiros usando diferenciais unificados.

ApproximateLocation

interface do modelo AproximaçãoLocalização

ArtifactProfile

Perfil de artefactos 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 que especifica um agente IA do Azure.

AzureAIModelTarget

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

AzureAISearchIndex

Pesquisa de IA do Azure Index Definition

AzureAISearchTool

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

AzureAISearchToolResource

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

AzureAISearchToolboxTool

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

AzureAgentConfig

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

AzureFunctionBinding

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

AzureFunctionDefinition

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

AzureFunctionStorageQueue

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

AzureFunctionTool

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

AzureOpenAIModelConfiguration

Configuração do modelo Azure OpenAI. 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 operações de 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 dos BetaEvaluators.

BetaEvaluatorsPendingUploadOptionalParams

Parâmetros opcionais.

BetaEvaluatorsUpdateVersionOptionalParams

Parâmetros opcionais.

BetaInsightsGenerateOptionalParams

Parâmetros opcionais.

BetaInsightsGetOptionalParams

Parâmetros opcionais.

BetaInsightsListOptionalParams

Parâmetros opcionais.

BetaInsightsOperations

Interface que representa 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 BetaMemoryStores.

BetaMemoryStoresSearchMemoriesOptionalParams

Parâmetros opcionais.

BetaMemoryStoresUpdateMemoriesOptionalParams

Parâmetros opcionais.

BetaMemoryStoresUpdateMemoryOptionalParams

Parâmetros opcionais.

BetaMemoryStoresUpdateOptionalParams

Parâmetros opcionais.

BetaModelsCreateOptions

Opções para o método criar que carrega ficheiros locais e regista 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 operações 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 operações de 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 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 configuração de pesquisa bing personalizada.

BingCustomSearchPreviewTool

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

BingCustomSearchToolParameters

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

BingGroundingSearchConfiguration

Pesquise configuração por Bing Grounding

BingGroundingSearchToolParameters

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

BingGroundingTool

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

BlobReference

Detalhes de referência do Blob.

BotServiceAuthorizationScheme

interface de 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 do navegador guardada numa caixa de ferramentas.

BrowserAutomationToolConnectionParameters

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

BrowserAutomationToolParameters

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

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 do avaliador baseado em código usando código python

CodeConfiguration

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

CodeInterpreterTool

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

CodeInterpreterToolboxTool

Uma ferramenta interpretadora de código armazenada numa 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

Combine vários filtros usando and ou or.

ComputerTool

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

ComputerUsePreviewTool

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

Connection

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

ConnectionsGetOptionalParams

Parâmetros opcionais.

ConnectionsGetWithCredentialsOptionalParams

Parâmetros opcionais.

ConnectionsListOptionalParams

Parâmetros opcionais.

ConnectionsOperations

Interface que representa uma operação do Connections.

ContainerAutoParam

interface de modelo ContainerAutoParam

ContainerConfiguration

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

ContainerNetworkPolicyAllowlistParam

interface model ContainerNetworkPolicyAllowlistParam

ContainerNetworkPolicyDisabledParam

interface de modelo ContainerNetworkPolicyDisabledParam

ContainerNetworkPolicyDomainSecretParam

interface de modelo ContainerNetworkPolicyDomainSecretParam

ContainerNetworkPolicyParam

Política de acesso à rede para o contentor.

ContainerSkill

interface do modelo ContainerSkill

ContinuousEvaluationRuleAction

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

CosmosDBIndex

Definição de índice do CosmosDB Vetor Store

CreateAgentVersionFromCodeContent

Corpo de pedido 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 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.

CreateSkillVersionFromFilesBody

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.

CronTrigger

Gatilho baseado em Cron.

CustomCredential

Definição de credencial personalizada

CustomGrammarFormatParam

Uma gramática definida pelo utilizador.

CustomRoutineTrigger

Um gatilho de rotina de eventos personalizada.

CustomTextFormatParam

Texto livre e sem restrições.

CustomToolParam

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

CustomToolParamFormat

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

DailyRecurrenceSchedule

Esquema diário de recorrência.

DataGenerationJob

Geração de Dados: recurso para empregos.

DataGenerationJobInputs

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

DataGenerationJobOptions

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

DataGenerationJobOutput

Produzir informação 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 LLM para trabalhos de geração de dados.

DataGenerationTokenUsage

Informação de utilização 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 Foundry versionado.

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 operações de conjuntos de dados.

DatasetsPendingUploadOptionalParams

Parâmetros opcionais.

DeleteAgentResponse

Um objeto de agente excluído

DeleteAgentVersionResponse

Um objeto de versão de agente excluído

DeleteMemoryResponse

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

DeleteMemoryStoreResponse

interface do modelo DeleteMemoryStoreResponse

DeleteSkillResponse

Uma habilidade apagada.

DeleteSkillVersionResponse

Uma versão de habilidade eliminada.

Deployment

Definição de implantação de modelo

DeploymentsGetOptionalParams

Parâmetros opcionais.

DeploymentsListOptionalParams

Parâmetros opcionais.

DeploymentsOperations

Interface que representa 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 devolvidos após a entrada em fila de uma rotina.

EmbeddingConfiguration

Incorporando classe de configuração

EmptyModelParam

interface de modelo EmptyModelParam

EndpointBasedEvaluatorDefinition

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.

EntraAuthorizationScheme

interface modelo EntraAuthorizationScheme

EntraIDCredentials

Definição de credencial Entra ID

ErrorModel

Interface do modelo ErrorModel

EvalResult

Resultado da avaliação.

EvalRunResultCompareItem

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

EvalRunResultComparison

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

EvalRunResultSummary

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

EvaluationComparisonInsightRequest

Pedido de comparação de avaliação

EvaluationComparisonInsightResult

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

EvaluationResultSample

Uma amostra do resultado da avaliação.

EvaluationRule

Modelo de regras 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 avaliação executam a análise de agrupamento.

EvaluationScheduleTask

Tarefa de avaliação do cronograma.

EvaluationTarget

Classe base para alvos com suporte a discriminadores.

EvaluationTaxonomy

Definição de Taxonomia de Avaliação

EvaluationTaxonomyInput

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

EvaluatorCredentialRequest

Entidade solicitante para obter credenciais de avaliador

EvaluatorDefinition

Configuração do avaliador de base com discriminador

EvaluatorGenerationArtifacts

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.

EvaluatorGenerationInputs

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

EvaluatorGenerationJob

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.

EvaluatorGenerationJobSource

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

EvaluatorGenerationTokenUsage

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

EvaluatorMetric

Métrica do Avaliador

EvaluatorVersion

Definição do Avaliador

ExternalAgentDefinition

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.

FabricDataAgentToolParameters

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

FabricIQPreviewTool

Uma ferramenta FabricIQ do lado do servidor.

FabricIQPreviewToolboxTool

Uma ferramenta FabricIQ guardada numa caixa de ferramentas.

FieldMapping

Classe de configuração de mapeamento de campo

FileDataGenerationJobOutput

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

FileDataGenerationJobSource

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

FileDatasetVersion

Definição FileDatasetVersion

FileSearchTool

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

FileSearchToolboxTool

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

FixedRatioVersionSelectionRule

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

FolderDatasetVersion

Definição 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 ShellToolParamAmbienteLocalAmbienteParam

FunctionTool

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

FunctionToolParam

interface de modelo FunctionToolParam

GenAITracingOptions

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.

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 horária.

HumanEvaluationPreviewRuleAction

Ação da 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 competência em linha

Insight

O corpo de resposta para insights de cluster.

InsightCluster

Um conjunto de amostras de análise.

InsightGenerationRequest

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

InsightModelConfiguration

Configuração do modelo utilizado 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 a agenda.

InsightSummary

Resumo da análise de cluster de erros.

InsightsMetadata

Metadados sobre os insights.

InvocationsProtocolConfiguration

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

InvocationsWsProtocolConfiguration

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

InvokeAgentInvocationsApiDispatchPayload

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

InvokeAgentInvocationsApiRoutineAction

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

InvokeAgentResponsesApiDispatchPayload

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

InvokeAgentResponsesApiRoutineAction

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

LocalShellToolParam

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

LocalSkillParam

interface modelo LocalSkillParam

LoraConfig

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

MCPTool

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

MCPToolFilter

Um objeto filtro para especificar quais as ferramentas permitidas.

MCPToolRequireApproval

interface de modelo MCPToolRequireApproval

MCPToolboxTool

Uma ferramenta MCP guardada numa caixa de ferramentas.

ManagedAgentIdentityBlueprintReference

interface de modelo ManagedAgentIdentityBlueprintReference

ManagedAzureAISearchIndex

Managed Pesquisa de IA do Azure Index Definition

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 no 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 de armazenamento de memória padrão.

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 de memória.

MemoryStoreUpdateResponse

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

MicrosoftFabricPreviewTool

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

ModelCredentialRequest

Pedido para obter credenciais de um asset modelo.

ModelDeployment

Definição de implantação de modelo

ModelDeploymentSku

Informações sobre Sku

ModelPendingUploadRequest

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

ModelPendingUploadResponse

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

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ção de origem para o modelo

ModelVersion

Definição de Versão do Modelo

MonthlyRecurrenceSchedule

Esquema mensal de recorrência.

NamespaceToolParam

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

NoAuthenticationCredentials

Credenciais que não exigem autenticação

OneTimeTrigger

Gatilho único.

OpenAIClientOptionsWithAzureAgent

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

OpenApiAnonymousAuthDetails

Detalhes de segurança para autenticação anônima 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 OpenApi managed_identity

OpenApiManagedSecurityScheme

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

OpenApiProjectConnectionAuthDetails

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

OpenApiProjectConnectionSecurityScheme

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

OpenApiTool

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

OpenApiToolboxTool

Uma ferramenta OpenAPI armazenada numa caixa de ferramentas.

OptimizationAgentIdentifier

Identifica o agente registado da Foundry a otimizar (apenas pedido). Competências, ferramentas e system_prompt estão especificadas em options.optimization_config.

OptimizationCandidate

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

OptimizationDatasetCriterion

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

OptimizationDatasetInput

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

OptimizationDatasetItem

Um único item num conjunto de dados inline.

OptimizationEvaluatorRef

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

OptimizationInlineDatasetInput

Conjunto de dados inline — itens fornecidos diretamente no corpo do pedido.

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, competências, ferramentas) para maximizar as pontuações de avaliação. Em caso de sucesso, o resultado contém candidatos pontuados.

OptimizationJobInputs

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

OptimizationJobListItem

A representação do trabalho é reduzida devolvida pelo endpoint LIST.

OptimizationJobProgress

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

OptimizationJobResult

Órgão do resultado do estado terminal. Povoado quando o estatuto é conseguido ou falhado.

OptimizationOptions

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

OptimizationReferenceDatasetInput

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

OtlpTelemetryEndpoint

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

PageSettings

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

PagedAsyncIterableIterator

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

PendingUploadRequest

Representa uma solicitação para um carregamento pendente.

PendingUploadResponse

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

ProceduralMemoryItem

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

PromotionInfo

Metadados de promoção registados quando um candidato é enviado a 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 simples ou dados JSON estruturados.

PromptBasedEvaluatorDefinition

Avaliador baseado em prompts

PromptDataGenerationJobSource

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

PromptEvaluatorGenerationJobSource

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

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 de IA Responsável (RAI) e recursos de segurança.

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 numa caixa de ferramentas.

ResponseUsageInputTokensDetails

Interface do modelo RespostaUtilizaçãoInputTokensDetalhes

ResponseUsageOutputTokensDetails

interface do modelo RespostaUsoTokensSaídaDetalhes

ResponsesProtocolConfiguration

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

Routine

Uma definição rotineira devolvida 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 rubricas — armazena dimensões produzidas pela API de geração. Usado tanto para avaliadores de qualidade como de segurança.

SASTokenCredentials

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

SasCredential

Definição de credenciais SAS

Schedule

Modelo de programação.

ScheduleRoutineTrigger

Um gatilho rotineiro recorrente baseado em crons.

ScheduleRun

Agendar modelo de execução.

ScheduleTask

Agendar modelo de tarefa.

SessionDirectoryEntry

Uma única entrada numa listagem de diretório.

SessionDirectoryListResponse

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

SessionFileWriteResponse

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

SessionLogEvent

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

Os parâmetros da ferramenta de aterramento do sharepoint.

SharepointPreviewTool

As informações de definição de entrada para uma ferramenta do sharepoint como 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 competências.

SkillInlineContent

Conteúdo inline para definir uma competência simples sem carregar ficheiros. 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

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

StructuredInputDefinition

Uma entrada estruturada que pode participar de substituições de modelo de prompt e vinculaçã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 registos de contentores, traços e métricas.

TelemetryEndpoint

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

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 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.

TextResponseFormatConfiguration
TextResponseFormatConfigurationResponseFormatJsonObject
TextResponseFormatConfigurationResponseFormatText
TextResponseFormatJsonObject

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.

TextResponseFormatJsonSchema

Formato de resposta do 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 só tiro.

Tool

Uma ferramenta que pode ser usada para gerar uma resposta.

ToolChoiceAllowed

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

ToolChoiceCodeInterpreter

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

ToolChoiceComputer

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

ToolChoiceComputerUse

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

ToolChoiceComputerUsePreview

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

ToolChoiceCustom

Use esta 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. Saiba mais sobre ferramentas integradas.

ToolChoiceFunction

Use esta 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. Saiba mais sobre ferramentas integradas.

ToolChoiceMCP

Use esta 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. Saiba mais sobre ferramentas integradas.

ToolChoiceWebSearchPreview20250311

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

ToolConfig

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

ToolDescription

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

ToolProjectConnection

Um recurso de ligação a projectos.

ToolSearchToolParam

Configuração de pesquisa 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 ajustar cenários finos.

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údos e outras definições de governação.

ToolboxSearchPreviewToolboxTool

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

ToolboxSkill

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

ToolboxSkillReference

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

ToolboxTool

Uma representação abstrata de uma ferramenta armazenada numa 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

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

TracesEvaluatorGenerationJobSource

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

Trigger

Modelo base para Trigger do cronograma.

UpdateModelVersionRequest

Solicite ao organismo a atualização de uma versão do modelo. Apenas a descrição e as etiquetas 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 que determina 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 VersionSelectionRule

VersionSelector

Interface do modelo VersionSelector

WebSearchApproximateLocation

A localização aproximada do utilizador.

WebSearchConfiguration

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

WebSearchPreviewTool

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

WebSearchTool

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

WebSearchToolFilters

interface do modelo WebSearchToolFilters

WebSearchToolboxTool

Uma ferramenta de pesquisa web guardada numa caixa de ferramentas.

WeeklyRecurrenceSchedule

Esquema semanal de recorrência.

WorkIQPreviewTool

Uma ferramenta WorkIQ do lado do servidor.

WorkIQPreviewToolboxTool

Uma ferramenta WorkIQ guardada numa caixa de ferramentas.

WorkflowAgentDefinition

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

Aliases de Tipo

AgentBlueprintReferenceType

Tipo de AgenteBlueprintReferenceType

AgentBlueprintReferenceUnion

Alias para AgentBlueprintReferenceUnion

AgentDefinitionOptInKeys

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

AgentDefinitionUnion

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

AgentEndpoint
AgentEndpointAuthorizationSchemeType

Tipo de AgenteEndpointAuthorizationSchemeType

AgentEndpointAuthorizationSchemeUnion

Alias para AgentEndpointAuthorizationSchemeUnion

AgentKind

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

AgentProtocol

Tipo de AgentProtocol

AgentSessionStatus

O estado de uma sessão de agente.

AgentState

O estado operacional de um agente.

AgentType

Tipo de AgentType

AgentVersionStatus

O estado 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 no momento da implementaçã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 DataGenerationJobOptionsUnion

DataGenerationJobOutputType

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

DataGenerationJobOutputUnion

Alias para DataGenerationJobOutputUnion

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 for DataGenerationJobSourceUnion

DataGenerationJobType

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

DatasetType

Enum para determinar o tipo de dados.

DatasetVersionUnion

Alias para DatasetVersionUnion

DayOfWeek

Dias da semana para esquema 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 de evento da regra de avaliação.

EvaluationTargetUnion

Pseudónimo de AvaliaçãoSindicatoalvo

EvaluationTaxonomyInputType

Tipo de entrada da taxonomia de avaliação.

EvaluationTaxonomyInputUnion

Alias para AvaliaçãoTaxonomiaInputUnion

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 EvaluatorGenerationJobSourceUnion

EvaluatorMetricDirection

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

EvaluatorMetricType

O tipo do avaliador

EvaluatorType

O tipo do avaliador

FileContents

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

Filters

Alias para Filtros

FoundryFeaturesOptInKeys

Tipo de FoundryCaracterísticasOptInKeys

FoundryModelArtifactProfileCategory

A categoria do perfil de artefactos.

FoundryModelArtifactProfileSignal

Sinais detetados no artefacto do modelo.

FoundryModelSourceType

O tipo de origem do modelo.

FoundryModelWarningCode

Código de aviso para artefactos do modelo.

FoundryModelWeightType

O tipo de peso do modelo.

FunctionShellToolParamEnvironmentType

Tipo de FunçãoShellToolParamEnvironmentType

FunctionShellToolParamEnvironmentUnion

Alias para FunctionShellToolParamEnvironmentUnion

GitHubIssueEvent

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

GrammarSyntax

Tipo de GramáticaSintaxe

ImageGenAction

Tipo de ImageGenAction

IndexType

Tipo de IndexType

IndexUnion

Alias para IndexUnion

InputFidelity

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.

InsightRequestUnion

Alias para InsightRequestUnion

InsightResultUnion

Alias para InsightResultUnion

InsightSampleUnion

Alias para InsightSampleUnion

InsightType

O pedido dos insights.

JobStatus

Valores de estatuto extensíveis partilhados 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 usado.

MemoryStoreType

Tipo de MemoryStoreType

MemoryStoreUpdateStatus

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

NodeReadableStream

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.

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 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)
OperationState

Enum descrevendo estados de operação permitidos.

OptimizationDatasetInputType

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

OptimizationDatasetInputUnion

Alias para OptimizationDatasetInputUnion

PageOrder

Tipo de Ordem de Página

PendingUploadType

O tipo de carregamento 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. 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.
RecurrenceScheduleUnion

Alias para RecurrenceScheduleUnion

RecurrenceType

Tipo de recorrência.

RedTeamTargetConfigUnion

Alias para RedTeamTargetConfigUnion

RiskCategory

Categoria de risco para o objetivo de ataque.

RoutineActionType

Os valores do discriminador suportam ações rotineiras.

RoutineActionUnion

Pseudónimo de RoutineActionUnion

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 RoutineDispatchPayloadUnion

RoutineRunPhase

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

RoutineRunStatus

O estado de uma corrida rotineira.

RoutineTriggerType

Os valores discriminadores suportados para gatilhos rotineiros.

RoutineTriggerUnion

Alias para RoutineTriggerUnion

SampleType

O tipo de amostra utilizada na análise.

ScheduleProvisioningStatus

Agendar status de provisionamento.

ScheduleTaskType

Tipo de tarefa.

ScheduleTaskUnion

Alias para ScheduleTaskUnion

SearchContentType

Tipo de PesquisaContentType

SearchContextSize

Tipo de PesquisaContextoTamanhoContexto

SessionLogEventType

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.

SimpleQnAFineTuningQuestionType

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

TelemetryDataKind

O tipo de dados de telemetria a exportar.

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 para ToolboxSkillUnion

ToolboxToolType

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

ToolboxToolUnion

Alias para ToolboxToolUnion

TreatmentEffectType

Tipo de efeito do tratamento.

TriggerType

Tipo de gatilho.

TriggerUnion

Alias para TriggerUnion

VersionIndicatorType

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

VersionIndicatorUnion

Alias para VersionIndicatorUnion

VersionSelectionRuleType

Tipo de VersãoRegraSeleção

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 de Função

isRestError(unknown)

Typeguard para RestError

function isRestError(e: unknown): e

Parâmetros

e

unknown

Algo apanhado por uma cláusula de captura.

Devoluções

e

Detalhes das variáveis

RestError

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

RestError: RestErrorConstructor

Tipo