@azure/ai-projects package

Classes

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

Interfaces

@azure/ai-projects.Index

A2APreviewTool	Um agente implementando o protocolo A2A.
AIProjectClientOptionalParams	Parâmetros opcionais para o cliente.
AISearchIndexResource	Um recurso AI Search Index.
Agent	Agente da interface do modelo
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.
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.
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.
Annotation	Uma anotação que se aplica a um espaço de texto de saída.
ApiErrorResponse	Resposta de erro para falhas de API.
ApiKeyCredentials	Definição de credencial de chave de API
ApplyPatchCreateFileOperationParam	Instrução para criar um novo ficheiro através da ferramenta apply_patch.
ApplyPatchDeleteFileOperationParam	Instrução para eliminar um ficheiro existente através da ferramenta apply_patch.
ApplyPatchOperationParam	Uma das operações create_file, delete_file ou update_file fornecidas à ferramenta apply_patch.
ApplyPatchToolParam	Permite ao assistente criar, eliminar ou atualizar ficheiros usando diferenciais unificados.
ApplyPatchUpdateFileOperationParam	Instrução para atualizar um ficheiro existente através da ferramenta apply_patch.
ApproximateLocation	interface do modelo AproximaçãoLocalização
AzureAIAgentTarget	Representa um destino especificando um agente de IA do Azure.
AzureAIModelTarget	Representa um alvo que especifica um modelo Azure AI para operações que requerem seleção de modelo.
AzureAISearchIndex	Definição de Índice de Pesquisa do Azure AI
AzureAISearchTool	As informações de definição de entrada para uma ferramenta de pesquisa de IA do Azure usada para configurar um agente.
AzureAISearchToolResource	Um conjunto de recursos de índice usados pela ferramenta `azure_ai_search`.
AzureFunctionBinding	A estrutura para manter o nome da fila de armazenamento e o URI.
AzureFunctionDefinition	A definição da função do Azure.
AzureFunctionStorageQueue	A estrutura para manter o nome da fila de armazenamento e o URI.
AzureFunctionTool	As informações de definição de entrada para uma Ferramenta de Função do Azure, conforme usado para configurar um Agente.
AzureOpenAIModelConfiguration	Configuração do modelo do 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
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.
BetaEvaluatorsCreateVersionOptionalParams	Parâmetros opcionais.
BetaEvaluatorsDeleteVersionOptionalParams	Parâmetros opcionais.
BetaEvaluatorsGetVersionOptionalParams	Parâmetros opcionais.
BetaEvaluatorsListLatestVersionsOptionalParams	Parâmetros opcionais.
BetaEvaluatorsListVersionsOptionalParams	Parâmetros opcionais.
BetaEvaluatorsOperations	Interface representando as operações dos BetaEvaluators.
BetaEvaluatorsUpdateVersionOptionalParams	Parâmetros opcionais.
BetaInsightsGenerateOptionalParams	Parâmetros opcionais.
BetaInsightsGetOptionalParams	Parâmetros opcionais.
BetaInsightsListOptionalParams	Parâmetros opcionais.
BetaInsightsOperations	Interface que representa 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 BetaMemoryStores.
BetaMemoryStoresSearchMemoriesOptionalParams	Parâmetros opcionais.
BetaMemoryStoresUpdateMemoriesOptionalParams	Parâmetros opcionais.
BetaMemoryStoresUpdateOptionalParams	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.
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.
BingCustomSearchConfiguration	Uma configuração de pesquisa personalizada do Bing.
BingCustomSearchPreviewTool	As informações de definição de entrada para uma ferramenta de pesquisa personalizada do Bing, conforme usado para configurar um agente.
BingCustomSearchToolParameters	Os parâmetros da ferramenta de pesquisa personalizada do Bing.
BingGroundingSearchConfiguration	Configuração de pesquisa para o Bing Grounding
BingGroundingSearchToolParameters	Os parâmetros da ferramenta de pesquisa de aterramento do Bing.
BingGroundingTool	As informações de definição de entrada para uma ferramenta de pesquisa de aterramento do Bing, conforme usado para configurar um agente.
BlobReference	Detalhes de referência do Blob.
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 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.
ClickParam	Uma ação de clique.
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
CodeInterpreterContainerAuto	Configuração para um contêiner de interpretador de código. Opcionalmente, especifique as IDs dos arquivos nos quais executar o código.
CodeInterpreterOutputImage	A saída de imagem do interpretador de código.
CodeInterpreterOutputLogs	A saída de logs do interpretador de código.
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	Combine vários filtros usando `and` ou `or`.
ComputerAction	interface do modelo ComputerAction
ComputerCallSafetyCheckParam	Uma verificação de segurança pendente para a chamada no computador.
ComputerScreenshotImage	Uma imagem de captura de tela do computador usada com a ferramenta de uso do computador.
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.
ContainerAppAgentDefinition	A definição do agente do aplicativo de contêiner.
ContainerFileCitationBody	Uma citação para um ficheiro contentor usado para gerar uma resposta de modelo.
ContinuousEvaluationRuleAction	Ação de regra de avaliação para avaliação contínua.
CosmosDBIndex	Definição de índice do CosmosDB Vetor Store
CronTrigger	Gatilho baseado em Cron.
CustomCredential	Definição de credencial personalizada
CustomGrammarFormatParam	Uma gramática definida pelo utilizador.
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.
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 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
DeleteMemoryStoreResponse	interface do modelo DeleteMemoryStoreResponse
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.
DoubleClickAction	Uma ação de clique duplo.
Drag	Uma ação de arrastar.
DragPoint	Um par de coordenadas x/y, por exemplo. `{ x: 100, y: 200 }`
EasyInputMessage	Uma entrada de mensagem para o modelo com uma função que indica a adesão a uma hierarquia de instruções. As instruções dadas com a `developer` função ou `system` têm precedência sobre as instruções dadas com a `user` função. Presume-se que as mensagens com a `assistant` função tenham sido geradas pelo modelo em interações anteriores.
EmbeddingConfiguration	Incorporando classe de configuração
EntraIDCredentials	Definição de credenciais do 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.
EvaluationTaxonomy	Definição de Taxonomia de Avaliação
EvaluationTaxonomyInput	Configuração de entrada para a taxonomia de avaliação.
EvaluatorDefinition	Configuração do avaliador de base com discriminador
EvaluatorMetric	Métrica do Avaliador
EvaluatorVersion	Definição do Avaliador
FabricDataAgentToolParameters	Os parâmetros da ferramenta do agente de dados de malha.
FieldMapping	Classe de configuração de mapeamento de campo
FileCitationBody	Uma citação a um ficheiro.
FileDatasetVersion	Definição FileDatasetVersion
FilePath	Um caminho para um arquivo.
FileSearchTool	Uma ferramenta que procura conteúdo relevante a partir de ficheiros carregados. Saiba mais sobre a ferramenta de pesquisa de ficheiros.
FileSearchToolCallResults	Interface do modelo FicheiroPesquisaFerramentaChamadaResultados
FolderDatasetVersion	Definição FileDatasetVersion
FunctionAndCustomToolCallOutput	Interface do modelo FunçãoAndCustomToolCallOutput
FunctionAndCustomToolCallOutputInputFileContent	Uma entrada de arquivo para o modelo.
FunctionAndCustomToolCallOutputInputImageContent	Uma entrada de imagem para o modelo. Saiba mais sobre entradas de imagem.
FunctionAndCustomToolCallOutputInputTextContent	Uma entrada de texto para o modelo.
FunctionShellActionParam	Comandos e limites que descrevem como executar a chamada à ferramenta shell.
FunctionShellCallOutputContentParam	Capturei stdout e stderr para uma parte da saída de uma chamada de ferramenta shell.
FunctionShellCallOutputExitOutcomeParam	Indica que os comandos shell terminaram e devolveram um código de saída.
FunctionShellCallOutputOutcomeParam	O resultado de saída ou tempo de espera associado a esta chamada shell.
FunctionShellCallOutputTimeoutOutcomeParam	Indica que a chamada shell excedeu o limite de tempo configurado.
FunctionShellToolParam	Uma ferramenta que permite ao modelo executar comandos de shell.
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.
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.
InputContent	Interface do modelo Conteúdo de Entrada
InputContentInputFileContent	Uma entrada de arquivo para o modelo.
InputContentInputImageContent	Uma entrada de imagem para o modelo. Saiba mais sobre entradas de imagem.
InputContentInputTextContent	Uma entrada de texto para o modelo.
InputFileContentParam	Uma entrada de arquivo para o modelo.
InputImageContentParamAutoParam	Uma entrada de imagem para o modelo. Aprenda sobre entradas de imagem
InputItem	Um item que representa parte do contexto para a resposta a ser gerada pelo modelo. Pode conter texto, imagens e entradas de áudio, bem como respostas anteriores de assistentes e saídas de chamadas de ferramenta.
InputItemApplyPatchToolCallItemParam	Uma chamada de ferramenta que representa um pedido para criar, eliminar ou atualizar ficheiros usando diferentes patches.
InputItemApplyPatchToolCallOutputItemParam	A saída transmitida emitida por uma chamada de ferramenta apply patch.
InputItemCodeInterpreterToolCall	Uma chamada de ferramenta para executar código.
InputItemCompactionSummaryItemParam	Um item de compactação gerado pela `v1/responses/compact` API.
InputItemComputerCallOutputItemParam	A saída de uma chamada de ferramenta de computador.
InputItemComputerToolCall	Uma chamada de ferramenta para uma ferramenta de uso de computador. Consulte o guia de uso do computador para obter mais informações.
InputItemCustomToolCall	Uma chamada a uma ferramenta personalizada criada pelo modelo.
InputItemCustomToolCallOutput	A saída de uma chamada de ferramenta personalizada do teu código, a ser enviada de volta para o modelo.
InputItemFileSearchToolCall	Os resultados de uma chamada de ferramenta de pesquisa de arquivos. Consulte o guia de pesquisa de arquivos para obter mais informações.
InputItemFunctionCallOutputItemParam	A saída de uma chamada de ferramenta funcional.
InputItemFunctionShellCallItemParam	Uma ferramenta que representa um pedido para executar um ou mais comandos shell.
InputItemFunctionShellCallOutputItemParam	Os itens de saída transmitidos por uma ferramenta shell chamam.
InputItemFunctionToolCall	Uma chamada de ferramenta para executar uma função. Consulte o guia de chamada de função para obter mais informações.
InputItemImageGenToolCall	Um pedido de geração de imagem feito pelo modelo.
InputItemLocalShellToolCall	Uma chamada de ferramenta para executar um comando no shell local.
InputItemLocalShellToolCallOutput	A saída de uma chamada de ferramenta shell local.
InputItemMcpApprovalRequest	Um pedido de aprovação humana de uma invocação de ferramenta.
InputItemMcpApprovalResponse	Uma resposta a uma solicitação de aprovação de MCP.
InputItemMcpListTools	Uma lista de ferramentas disponíveis em um servidor MCP.
InputItemMcpToolCall	Uma invocação de uma ferramenta em um servidor MCP.
InputItemOutputMessage	Uma mensagem de saída do modelo.
InputItemReasoningItem	Uma descrição da cadeia de pensamento usada por um modelo de raciocínio ao gerar uma resposta. Certifique-se de incluir estes itens na `input` sua API de Respostas para os turnos seguintes de uma conversa se estiver a gerir o contexto manualmente.
InputItemWebSearchToolCall	Os resultados de uma chamada de ferramenta de pesquisa na web. Consulte o guia de pesquisa na Web para obter mais informações.
InputTextContentParam	Uma entrada de texto para o modelo.
Insight	O corpo de resposta para insights de cluster.
InsightCluster	Um conjunto de amostras de análise.
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.
ItemReferenceParam	Um identificador interno para um item a ser referenciado.
KeyPressAction	Uma coleção de pressionamentos de teclas que o modelo gostaria de realizar.
LocalShellExecAction	Execute um comando shell no servidor.
LocalShellToolParam	Uma ferramenta que permite que o modelo execute comandos shell em um ambiente local.
LogProb	A probabilidade logarítmica de um token.
MCPListToolsTool	Uma ferramenta disponível em um servidor MCP.
MCPListToolsToolAnnotations	Interface do modelo MCPListToolsToolAnnotations
MCPListToolsToolInputSchema	interface do modelo MCPListToolsToolInputSchema
MCPTool	Dê ao modelo acesso a ferramentas adicionais por meio de servidores MCP (Model Context Protocol) remotos. Saiba mais sobre o MCP.
MCPToolFilter	Um objeto filtro para especificar quais as ferramentas permitidas.
MCPToolRequireApproval	interface de modelo MCPToolRequireApproval
ManagedAzureAISearchIndex	Definição de Índice de Pesquisa de IA do Azure Gerenciado
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	As informações de definição de entrada para uma ferramenta do Microsoft Fabric como usada para configurar um agente.
ModelDeployment	Definição de implantação de modelo
ModelDeploymentSku	Informações sobre 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	Esquema mensal de recorrência.
Move	Uma ação de movimento do mouse.
NoAuthenticationCredentials	Credenciais que não exigem autenticação
OneTimeTrigger	Gatilho único.
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 conexão de projeto 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.
OutputMessageContent	interface de modelo SaídaMensagemConteúdo
OutputMessageContentOutputTextContent	Uma saída de texto do modelo.
OutputMessageContentRefusalContent	Uma recusa do modelo.
PageSettings	Opções para o método byPage
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
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
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.
ReasoningTextContent	Texto de raciocínio do modelo.
RecurrenceSchedule	Modelo de cronograma de recorrência.
RecurrenceTrigger	Gatilho baseado em recorrência.
RedTeam	Detalhes da equipe vermelha.
ResponseUsageInputTokensDetails	Interface do modelo RespostaUtilizaçãoInputTokensDetalhes
ResponseUsageOutputTokensDetails	interface do modelo RespostaUsoTokensSaídaDetalhes
RestorePollerOptions
SASTokenCredentials	Definição de credenciais de Assinatura de Acesso Compartilhado (SAS)
SasCredential	Definição de credenciais SAS
Schedule	Modelo de programação.
ScheduleRun	Agendar modelo de execução.
ScheduleTask	Agendar modelo de tarefa.
Screenshot	Uma ação de captura de tela.
Scroll	Uma ação de rolagem.
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.
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.
Summary	Um texto resumo do modelo.
Target	Classe base para alvos 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 representando operações de telemetria
TextResponseFormatConfiguration	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 Saídas estruturadas. 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.
TextResponseFormatConfigurationResponseFormatJsonObject	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.
TextResponseFormatConfigurationResponseFormatText	Formato de resposta padrão. Usado para gerar respostas de texto.
TextResponseFormatJsonSchema	Formato de resposta do esquema JSON. Usado para gerar respostas JSON estruturadas. Saiba mais sobre Saídas Estruturadas.
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.
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.
ToolDescription	Descrição de uma ferramenta que pode ser usada por um agente.
ToolProjectConnection	Um recurso de conexão de projeto.
TopLogProb	A probabilidade máxima do log de um token.
Trigger	Modelo base para Trigger do cronograma.
Type	Uma ação para digitar texto.
UrlCitationBody	Uma citação para um recurso da Web usado para gerar uma resposta de modelo.
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.
VectorStoreFileAttributes	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado e consultar objetos via API ou o painel. As teclas são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres, booleanos ou números.
Wait	Uma ação de espera.
WebSearchActionFind	Tipo de ação "localizar": procura um padrão dentro de uma página carregada.
WebSearchActionOpenPage	Tipo de ação "open_page" - Abre um URL específico dos resultados da pesquisa.
WebSearchActionSearch	Tipo de ação "pesquisar" - Executa uma consulta de pesquisa na Web.
WebSearchActionSearchSources	interface do modelo WebSearchActionSearchSources
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 de pesquisa na web.
WebSearchTool	Pesquise na Internet fontes relacionadas com o prompt. Saiba mais sobre a ferramenta de pesquisa na web.
WebSearchToolFilters	interface do modelo WebSearchToolFilters
WeeklyRecurrenceSchedule	Esquema semanal de recorrência.
WorkflowAgentDefinition	A definição do agente de fluxo de trabalho.

Aliases de Tipo

AgentDefinitionUnion	Tipo de união para todos os tipos de definição de agente. Suporta fluxo de trabalho, hospedado, aplicativo de contêiner e agentes de prompt.
AgentKind	Define o tipo/tipo de agente. Determina qual estrutura de definição de agente é usada.
AgentProtocol	Tipo de AgentProtocol
AgentType	Tipo de AgentType
AnnotationType	Tipo de AnotaçãoTipo
AnnotationUnion	Alias para AnnotationUnion
ApplyPatchCallOutputStatusParam	Valores de resultado reportados para apply_patch saídas de chamadas de ferramenta.
ApplyPatchCallStatusParam	Valores de estado reportados para chamadas apply_patch ferramentas.
ApplyPatchOperationParamType	Tipo de ApplyPatchOperationParamType
ApplyPatchOperationParamUnion	Alias para ApplyPatchOperationParamUnion
AttackStrategy	Estratégias para ataques.
AzureAISearchQueryType	Tipos de consulta disponíveis para a ferramenta Azure AI Search.
BaseCredentialsUnion	Alias para BaseCredentialsUnion
ClickButtonType	Tipo de ClickButtonType
ComparisonFilterValueItems	Alias para ComparaçãoFilterValueItems
ComputerActionType	Tipo de ComputerActionType
ComputerActionUnion	Alias para ComputerActionUnion
ComputerEnvironment	Tipo de Ambiente de Computador
ConnectionType	O tipo (ou categoria) da conexão
ContainerMemoryLimit	Tipo de ContainerMemoryLimit
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	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
DetailEnum	Tipo de DetalheEnum
EvaluationRuleActionType	Tipo de ação de avaliação.
EvaluationRuleActionUnion	Alias para EvaluationRuleActionUnion
EvaluationRuleEventType	Tipo de evento da regra de avaliação.
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
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
Filters	Alias para Filtros
FoundryFeaturesOptInKeys	Tipo de FoundryCaracterísticasOptInKeys
FunctionAndCustomToolCallOutputType	Tipo de FunçãoAndCustomToolCallOutputType
FunctionAndCustomToolCallOutputUnion	Alias para FunctionandCustomToolCallOutputUnion
FunctionCallItemStatus	Tipo de FunçãoChamarItemEstado.
FunctionShellCallItemStatus	Valores de estado reportados para chamadas de ferramentas shell.
FunctionShellCallOutputOutcomeParamType	Tipo de FunçãoShellChamadaSaídaResultadoParamTipo
FunctionShellCallOutputOutcomeParamUnion	Alias para FunctionShellCallOutputOutcomeParamUnion
GrammarSyntax1	Tipo de GrammarSyntax1
ImageDetail	Tipo de ImageDetail
IndexType	Tipo de IndexType
IndexUnion	Alias para IndexUnion
InputContentType	Tipo de InputContentType
InputContentUnion	Alias para InputContentUnion
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 só é suportado para `gpt-image-1`. Sem suporte para `gpt-image-1-mini`. Suporta `high` e `low`. O padrão é `low`.
InputItemType	Tipo de InputItemType
InputItemUnion	Alias para InputItemUnion
InsightRequestUnion	Alias para InsightRequestUnion
InsightResultUnion	Alias para InsightResultUnion
InsightSampleUnion	Alias para InsightSampleUnion
InsightType	O pedido dos insights.
MCPToolCallStatus	Tipo de MCPToolCallStatus
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.
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 Connection (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.
OutputMessageContentType	Tipo de SaídaMensagemContentType
OutputMessageContentUnion	Alias para OutputMessageContentUnion
PageOrder	Tipo de Ordem de Página
PendingUploadType	O tipo de carregamento pendente.
RankerVersionType	Tipo de RankerVersionType
ReasoningEffort	Restringe o esforço no raciocínio para 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.
RiskCategory	Categoria de risco para o objetivo de ataque.
SampleType	O tipo de amostra utilizada na análise.
ScheduleProvisioningStatus	Agendar status de provisionamento.
ScheduleTaskType	Tipo de tarefa.
ScheduleTaskUnion	Alias para ScheduleTaskUnion
SearchContextSize	Tipo de PesquisaContextoTamanhoContexto
TargetConfigUnion	Alias para TargetConfigUnion
TargetUnion	Alias para TargetUnion
TextResponseFormatConfigurationType	Tipo de TextoRespostaFormatoConfiguraçãoTipo
TextResponseFormatConfigurationUnion	Alias para TextResponseFormatConfigurationUnion
ToolChoiceParamType	Tipo de ToolChoiceParamType
ToolChoiceParamUnion	Alias para ToolChoiceParamUnion
ToolType	Tipo de Tipo de Ferramenta
ToolUnion	Alias para ToolUnion
TreatmentEffectType	Tipo de efeito do tratamento.
TriggerType	Tipo de gatilho.
TriggerUnion	Alias para TriggerUnion

Enumerações

KnownApiVersions

Versões da API do Microsoft Foundry

Funções

restorePoller<TResponse, TResult>(AIProjectClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Cria um poller a partir do estado serializado de outro poller. Isso pode ser útil quando você deseja criar pollers em um host diferente ou um poller precisa ser construído depois que o original não está no escopo.

Detalhes de Função

restorePoller<TResponse, TResult>(AIProjectClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

function restorePoller<TResponse, TResult>(client: AIProjectClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parâmetros

client: AIProjectClient

serializedState: string

sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>

options: RestorePollerOptions<TResult, PathUncheckedResponse>

Devoluções

PollerLike<OperationState<TResult>, TResult>

Comentários

Esta página foi útil?