@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 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
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 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.
Annotation	Uma anotação que se aplica a um intervalo 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 arquivo via a ferramenta apply_patch.
ApplyPatchDeleteFileOperationParam	Instrução para excluir um arquivo existente via a ferramenta apply_patch.
ApplyPatchOperationParam	Uma das operações create_file, delete_file ou update_file fornecidas à ferramenta apply_patch.
ApplyPatchToolParam	Permite que o assistente crie, exclua ou atualize arquivos usando diferenciais unificados.
ApplyPatchUpdateFileOperationParam	Instrução para atualizar um arquivo existente via a ferramenta apply_patch.
ApproximateLocation	interface do modelo AproximaçãoLocalização
AzureAIAgentTarget	Representa um destino que especifica um agente de IA do Azure.
AzureAIModelTarget	Representa um destino que especifica um modelo de IA do Azure para operações que exigem seleção de modelo.
AzureAISearchIndex	Definição de índice do Azure AI Search
AzureAISearchTool	As informações de definição de entrada para uma ferramenta de pesquisa de IA do Azure, conforme usado 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 OpenAI do Azure. 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 uma operação 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 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.
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 aterramento do Bing
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 de 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 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.
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 de avaliador baseada 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 da imagem do interpretador de código.
CodeInterpreterOutputLogs	A saída de logs do interpretador de código.
CodeInterpreterTool	Uma ferramenta que executa o 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`.
ComputerAction	interface do modelo ComputerAction
ComputerCallSafetyCheckParam	Uma verificação de segurança pendente para a chamada de 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 de computador.
Connection	Resposta da lista e operações get connections
ConnectionsGetOptionalParams	Parâmetros opcionais.
ConnectionsGetWithCredentialsOptionalParams	Parâmetros opcionais.
ConnectionsListOptionalParams	Parâmetros opcionais.
ConnectionsOperations	Interface que representa uma operação de conexões.
ContainerAppAgentDefinition	A definição do agente de aplicativo de contêiner.
ContainerFileCitationBody	Uma citação para um arquivo container 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 repositório de vetores do CosmosDB
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 ferramentas personalizadas
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
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.
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 mensagem de entrada para o modelo com uma função que indica a hierarquia de instruções a seguir. As instruções fornecidas com a função `developer` ou `system` têm precedência sobre as instruções fornecidas com a função `user`. Presume-se que as mensagens com a `assistant` função tenham sido geradas pelo modelo em interações anteriores.
EmbeddingConfiguration	Classe de configuração de inserção
EntraIDCredentials	Definição de credencial de ID do Entra
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
FileCitationBody	Uma citação a um arquivo.
FileDatasetVersion	Definição de FileDatasetVersion
FilePath	Um caminho para um arquivo.
FileSearchTool	Uma ferramenta que pesquisa conteúdo relevante de arquivos carregados. Saiba mais sobre a ferramenta de pesquisa de arquivos.
FileSearchToolCallResults	Interface de modelo FicheiroPesquisaFerramentaChamadaResultados
FolderDatasetVersion	Definição de FileDatasetVersion
FunctionAndCustomToolCallOutput	Função da interface do modelo Função e SaídaFerramenta Personalizada
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 de 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 retornaram um código de saída.
FunctionShellCallOutputOutcomeParam	O resultado de saída ou tempo de espera associado a essa 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 em seu próprio código que o modelo pode optar por chamar. Saiba mais sobre a chamada de função.
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.
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 entradas de texto, imagens e áudio, bem como respostas anteriores do assistente e saídas de chamadas de ferramenta.
InputItemApplyPatchToolCallItemParam	Uma chamada de ferramenta que representa uma solicitação para criar, excluir ou atualizar arquivos usando patches diferenciais.
InputItemApplyPatchToolCallOutputItemParam	A saída transmitida emitida por uma chamada de ferramenta de aplicação de patch.
InputItemCodeInterpreterToolCall	Uma chamada de ferramenta para executar o 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 para uma ferramenta personalizada criada pelo modelo.
InputItemCustomToolCallOutput	A saída de uma chamada de ferramenta personalizada do seu código, sendo enviada de volta para o modelo.
InputItemFileSearchToolCall	Os resultados de uma chamada de ferramenta de pesquisa de arquivo. Consulte o guia de pesquisa de arquivos para obter mais informações.
InputItemFunctionCallOutputItemParam	A saída de uma chamada de ferramenta de função.
InputItemFunctionShellCallItemParam	Uma ferramenta que representa uma solicitação para executar um ou mais comandos shell.
InputItemFunctionShellCallOutputItemParam	Os itens de saída transmitidos emitidos 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	Uma solicitação de geração de imagem feita pelo modelo.
InputItemLocalShellToolCall	Uma chamada de ferramenta para executar um comando no shell local.
InputItemLocalShellToolCallOutput	A saída de uma chamada de ferramenta de shell local.
InputItemMcpApprovalRequest	Uma solicitação de aprovação humana de uma invocação de ferramenta.
InputItemMcpApprovalResponse	Uma resposta a uma solicitação de aprovação do 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 esses itens na `input` API de Respostas para turnos subsequentes de uma conversa se você estiver gerenciando 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 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.
ItemReferenceParam	Um identificador interno para um item a ser referenciado.
KeyPressAction	Uma coleção de pressionamentos de teclas que o modelo deseja realizar.
LocalShellExecAction	Execute um comando shell no servidor.
LocalShellToolParam	Uma ferramenta que permite que o modelo execute comandos de shell em um ambiente local.
LogProb	A probabilidade de log de um token.
MCPListToolsTool	Uma ferramenta disponível em um servidor MCP.
MCPListToolsToolAnnotations	Interface de modelo MCPListToolsToolAnnotations
MCPListToolsToolInputSchema	interface do modelo MCPListToolsToolInputSchema
MCPTool	Conceda ao modelo acesso a ferramentas adicionais por meio de servidores remotos do Protocolo de Contexto de Modelo. Saiba mais sobre o MCP.
MCPToolFilter	Um objeto filtro para especificar quais ferramentas são 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 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	As informações de definição de entrada para uma ferramenta do Microsoft Fabric, conforme usado 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.
Move	Uma ação de movimentação do mouse.
NoAuthenticationCredentials	Credenciais que não exigem autenticação
OneTimeTrigger	Gatilho único.
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 para autenticação de conexão de projeto OpenApi
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.
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 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.
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 RespostaUsoTokensEntradaDetalhes
ResponseUsageOutputTokensDetails	interface de modelo RespostaUsoTokensSaídaDetalhes
RestorePollerOptions
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.
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, conforme usado para configurar um agente.
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.
Summary	Um texto resumido do modelo.
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 representando operações de telemetria
TextResponseFormatConfiguration	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.
TextResponseFormatConfigurationResponseFormatJsonObject	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 um sistema ou mensagem de usuário instruindo-o a fazê-lo.
TextResponseFormatConfigurationResponseFormatText	Formato de resposta padrão. Usado para gerar respostas de texto.
TextResponseFormatJsonSchema	Formato de resposta de 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 predefinido.
ToolChoiceCodeInterpreter	Indica que o modelo deve usar uma ferramenta interna para gerar uma resposta. Saiba mais sobre ferramentas internas.
ToolChoiceComputerUsePreview	Indica que o modelo deve usar uma ferramenta interna para gerar uma resposta. Saiba 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. Saiba 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. Saiba 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. Saiba mais sobre ferramentas internas.
ToolChoiceWebSearchPreview20250311	Indica que o modelo deve usar uma ferramenta interna para gerar uma resposta. Saiba mais sobre ferramentas internas.
ToolDescription	Descrição de uma ferramenta que pode ser usada por um agente.
ToolProjectConnection	Um recurso de conexão de projeto.
TopLogProb	A probabilidade de log superior de um token.
Trigger	Modelo base para Trigger do agendamento.
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 por meio da API ou do painel. As chaves 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, boolianos ou números.
Wait	Uma ação de espera.
WebSearchActionFind	Tipo de ação "localizar": pesquisa um padrão em uma página carregada.
WebSearchActionOpenPage	Tipo de ação "open_page" - abre uma URL específica dos resultados da pesquisa.
WebSearchActionSearch	Tipo de ação "pesquisa" - Executa uma consulta de pesquisa na Web.
WebSearchActionSearchSources	interface do modelo WebSearchActionSearchSources
WebSearchApproximateLocation	A localização aproximada do usuário.
WebSearchConfiguration	Uma configuração de busca web para busca personalizada do Bing
WebSearchPreviewTool	Essa ferramenta busca na internet resultados relevantes para usar em uma resposta. Saiba mais sobre a ferramenta de busca na web.
WebSearchTool	Pesquise na Internet fontes relacionadas ao prompt. Saiba mais sobre a ferramenta de busca na web.
WebSearchToolFilters	interface de modeloFiltrosFerramenta de Busca WebSearchTools
WeeklyRecurrenceSchedule	Cronograma de recorrência semanal.
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. Oferece suporte a agentes de fluxo de trabalho, hospedados, de contêiner e 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 AnnotationType
AnnotationUnion	Alias para AnnotationUnion
ApplyPatchCallOutputStatusParam	Valores de resultado reportados para apply_patch saídas de chamadas de ferramenta.
ApplyPatchCallStatusParam	Valores de status reportados para chamadas de apply_patch ferramenta.
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	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
DetailEnum	Tipo de DetalheEnum
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
FunctionAndCustomToolCallOutputType	Tipo de FunçãoAndCustomToolCallOutputType
FunctionAndCustomToolCallOutputUnion	Alias para FunctionAndCustomToolCallOutputUnion
FunctionCallItemStatus	Tipo de FunçãoChamadaItemStatus
FunctionShellCallItemStatus	Valores de status reportados para chamadas de ferramentas shell.
FunctionShellCallOutputOutcomeParamType	Tipo de FunçãoShellChamaSaídaResultadoParamType
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-se para InputContentUnion
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 só tem suporte para `gpt-image-1`. Sem suporte para `gpt-image-1-mini`. Oferece suporte a `high` e `low`. Usa `low` como padrão.
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 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) Conexão de Projeto (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.
OutputMessageContentType	Tipo de SaídaMensagemConteúdoTipo
OutputMessageContentUnion	Alias para OutputMessageContentUnion
PageOrder	Tipo de Ordem de Página
PendingUploadType	O tipo de upload 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`. 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
SearchContextSize	Tipo de BuscaContextoTamanhoContexto
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 de tratamento.
TriggerType	Tipo do 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 sondador do estado serializado de outro sondador. Isso pode ser útil quando você deseja criar sondadores em um host diferente ou um sondador precisa ser construído depois que o original não estiver no escopo.

Detalhes da 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>

Retornos

PollerLike<OperationState<TResult>, TResult>

Comentários

Esta página foi útil?