@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.
AIProjectClientOptionalParams	Parâmetros opcionais para o cliente.
AISearchIndexResource	Um recurso de índice de pesquisa de IA.
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.
AgentDefinition	Interface de definição de base para agentes. Contém o tipo de agente e a configuração RAI opcional.
AgentEndpoint	interface modelo AgentEndpoint
AgentEndpointAuthorizationScheme	interface de modelo AgenteEndpointAuthorizationScheme
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.
AgentsCreateVersionOptionalParams	Parâmetros opcionais.
AgentsDeleteOptionalParams	Parâmetros opcionais.
AgentsDeleteVersionOptionalParams	Parâmetros opcionais.
AgentsGetOptionalParams	Parâmetros opcionais.
AgentsGetVersionOptionalParams	Parâmetros opcionais.
AgentsListOptionalParams	Parâmetros opcionais.
AgentsListVersionsOptionalParams	Parâmetros opcionais.
AgentsOperations	Interface que representa uma operação de Agentes.
AgentsUpdateAgentFromManifestOptionalParams	Parâmetros opcionais.
AgentsUpdateOptionalParams	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
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	Pesquisa de IA do Azure  Index Definition
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.
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
BetaAgentsCreateSessionOptionalParams	Parâmetros opcionais.
BetaAgentsDeleteSessionFileOptionalParams	Parâmetros opcionais.
BetaAgentsDeleteSessionOptionalParams	Parâmetros opcionais.
BetaAgentsDownloadSessionFileOptionalParams	Parâmetros opcionais.
BetaAgentsGetSessionOptionalParams	Parâmetros opcionais.
BetaAgentsListSessionFilesOptionalParams	Parâmetros opcionais.
BetaAgentsListSessionsOptionalParams	Parâmetros opcionais.
BetaAgentsOperations	Interface representando as operações de um BetaAgent.
BetaAgentsPatchAgentObjectOptionalParams	Parâmetros opcionais.
BetaAgentsUploadSessionFileOptionalParams	Parâmetros opcionais.
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.
BetaEvaluatorsCreateVersionOptionalParams	Parâmetros opcionais.
BetaEvaluatorsDeleteVersionOptionalParams	Parâmetros opcionais.
BetaEvaluatorsGetVersionOptionalParams	Parâmetros opcionais.
BetaEvaluatorsListOptionalParams	Parâmetros opcionais.
BetaEvaluatorsListVersionsOptionalParams	Parâmetros opcionais.
BetaEvaluatorsOperations	Interface representando as operações de um BetaEvaluator.
BetaEvaluatorsUpdateVersionOptionalParams	Parâmetros opcionais.
BetaInsightsGenerateOptionalParams	Parâmetros opcionais.
BetaInsightsGetOptionalParams	Parâmetros opcionais.
BetaInsightsListOptionalParams	Parâmetros opcionais.
BetaInsightsOperations	Interface representando uma operação BetaInsights.
BetaMemoryStoresCreateOptionalParams	Parâmetros opcionais.
BetaMemoryStoresDeleteOptionalParams	Parâmetros opcionais.
BetaMemoryStoresDeleteScopeOptionalParams	Parâmetros opcionais.
BetaMemoryStoresGetOptionalParams	Parâmetros opcionais.
BetaMemoryStoresGetUpdateResultOptionalParams	Parâmetros opcionais.
BetaMemoryStoresListOptionalParams	Parâmetros opcionais.
BetaMemoryStoresOperations	Interface representando operações do BetaMemoryStores.
BetaMemoryStoresSearchMemoriesOptionalParams	Parâmetros opcionais.
BetaMemoryStoresUpdateMemoriesOptionalParams	Parâmetros opcionais.
BetaMemoryStoresUpdateOptionalParams	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.
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.
BetaSkillsDeleteOptionalParams	Parâmetros opcionais.
BetaSkillsDownloadOptionalParams	Parâmetros opcionais.
BetaSkillsGetOptionalParams	Parâmetros opcionais.
BetaSkillsListOptionalParams	Parâmetros opcionais.
BetaSkillsOperations	Interface representando uma operação BetaSkills.
BetaSkillsUpdateOptionalParams	Parâmetros opcionais.
BetaToolboxesCreateVersionOptionalParams	Parâmetros opcionais.
BetaToolboxesDeleteOptionalParams	Parâmetros opcionais.
BetaToolboxesDeleteVersionOptionalParams	Parâmetros opcionais.
BetaToolboxesGetOptionalParams	Parâmetros opcionais.
BetaToolboxesGetVersionOptionalParams	Parâmetros opcionais.
BetaToolboxesListOptionalParams	Parâmetros opcionais.
BetaToolboxesListVersionsOptionalParams	Parâmetros opcionais.
BetaToolboxesOperations	Interface representando operações do BetaToolboxs.
BetaToolboxesUpdateOptionalParams	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
BrowserAutomationPreviewTool	As informações de definição de entrada para uma Ferramenta de Automação do Navegador, conforme usado para configurar um Agente.
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.
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
ConnectionsGetDefaultOptionalParams	Parâmetros opcionais para getDefault.
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
CreateFromPackageOptionalParams	Parâmetros opcionais.
CronTrigger	Gatilho baseado em cron.
CustomCredential	Definição de credencial personalizada
CustomGrammarFormatParam	Uma gramática definida pelo usuário.
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.
DatasetCredential	Representa uma referência a um blob para consumo
DatasetUploadOptions	Opções para carregar conjuntos de dados
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
DeleteMemoryStoreResponse	interface do modelo DeleteMemoryStoreResponse
DeleteSkillResponse	Um objeto de habilidade excluído
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.
EmbeddingConfiguration	Classe de configuração de inserção
EmptyModelParam	interface de modelo EmptyModelParam
EntraAuthorizationScheme	interface modelo EntraAuthorizationScheme
EntraIDCredentials	Entra ID definição de credenciais
EntraIsolationKeySource	interface de modelo EntraIsolationKeySource
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.
EvaluationTaxonomy	Definição de taxonomia de avaliação
EvaluationTaxonomyInput	Configuração de entrada para a taxonomia de avaliação.
EvaluatorDefinition	Configuração do avaliador base com discriminador
EvaluatorMetric	Métrica do avaliador
EvaluatorVersion	Definição de avaliador
FabricDataAgentToolParameters	Os parâmetros da ferramenta do agente de dados de malha.
FieldMapping	Classe de configuração de mapeamento de campo
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.
FixedRatioVersionSelectionRule	interface do modelo Regra de Seleção FixaProporçãoVersão
FolderDatasetVersion	Definição de FileDatasetVersion
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
HeaderIsolationKeySource	interface do modelo CabeçalhoIsolamentoKeySource
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.
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.
IsolationKeySource	interface de modelo IsolationKeySource
LocalShellToolParam	Uma ferramenta que permite que o modelo execute comandos de shell em um ambiente local.
LocalSkillParam	interface de modelo LocalSkillParam
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
ManagedAgentIdentityBlueprintReference	interface de modelo ManagedAgentIdentityBlueprintReference
ManagedAzureAISearchIndex	Managed Pesquisa de IA do Azure  Index Definition
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.
ModelDeployment	Definição de implantação de modelo
ModelDeploymentSku	Informações de SKU
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.
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.
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
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
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.
ResponseUsageInputTokensDetails	Interface do modelo RespostaUsoTokensEntradaDetalhes
ResponseUsageOutputTokensDetails	interface de modelo RespostaUsoTokensSaídaDetalhes
SASTokenCredentials	Definição de credencial de SAS (Assinatura de Acesso Compartilhado)
SasCredential	Definição de credencial SAS
Schedule	Modelo de agendamento.
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.
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.
SkillObject	Um objeto de habilidade.
SkillReferenceParam	interface do modelo SkillReferenceParam
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.
Target	Classe base para destinos com suporte a discriminadores.
TargetConfig	Classe abstrata para configuração de destino.
TaxonomyCategory	Definição de categoria de taxonomia.
TaxonomySubCategory	Definição de subcategoria de taxonomia.
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.
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.
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.
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.
ToolboxVersionObject	Uma versão específica de uma caixa de ferramentas.
Trigger	Modelo base para Trigger do agendamento.
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
WeeklyRecurrenceSchedule	Cronograma de recorrência semanal.
WorkIQPreviewTool	Uma ferramenta WorkIQ para o lado do servidor.
WorkIQPreviewToolParameters	Os parâmetros da ferramenta WorkIQ.
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. Oferece suporte a agentes de fluxo de trabalho, hospedados, de contêiner e de prompt.
AgentEndpointAuthorizationSchemeType	Tipo de AgenteEndpointAutorizaçãoSchemaType
AgentEndpointAuthorizationSchemeUnion	Alias for AgentEndpointAuthorizationSchemeUnion
AgentEndpointProtocol	Tipo de AgentEndpointProtocol
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.
AgentType	Tipo de AgentType
AttackStrategy	Estratégias para ataques.
AzureAISearchQueryType	Tipos de consulta disponíveis para a ferramenta Pesquisa de IA do Azure .
BaseCredentialsUnion	Alias para BaseCredentialsUnion
BetaAgentsDownloadSessionFileResponse
BetaSkillsDownloadResponse
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
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
EvaluationRuleActionType	Tipo de ação de avaliação.
EvaluationRuleActionUnion	Alias para EvaluationRuleActionUnion
EvaluationRuleEventType	Tipo do evento de regra de avaliação.
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
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
Filters	Alias para Filtros
FoundryFeaturesOptInKeys	Tipo de FoundryFeaturesOptInKeys
FunctionShellToolParamEnvironmentType	Tipo de FunçãoShellToolParamEnvironmentType
FunctionShellToolParamEnvironmentUnion	Alias para FunctionShellToolParamEnvironmentUnion
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.
IsolationKeySourceKind	Tipo de IsolationKeySourceKind
IsolationKeySourceUnion	Alias para IsolationKeySourceUnion
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.
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.
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.
RiskCategory	Categoria de risco para o objetivo do ataque.
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
TargetConfigUnion	Alias para TargetConfigUnion
TargetUnion	Alias para TargetUnion
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
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
VersionSelectionRuleUnion	Alias para VersionSelectionRuleUnion
VersionSelectorType	Tipo de VersionSelectorType

Enumerações

KnownApiVersions

Versões da API do Microsoft Foundry

Variáveis

RestError

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

Detalhes da variável

RestError

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

RestError: RestErrorConstructor

Tipo

RestErrorConstructor