@azure/ai-agents package

Classes

AgentsClient
MCPTool	Uma ferramenta que se conecta a servidores MCP (Model Context Protocol). Suporta o gerenciamento dinâmico de conexões de servidor MCP e ferramentas permitidas.
OpenApiTool	Uma ferramenta que recupera informações usando especificações OpenAPI. Inicializada com uma definição de API inicial (nome, descrição, especificação, autenticação), essa classe também dá suporte à adição e remoção de definições de API adicionais dinamicamente.
ToolSet	Representa um conjunto de ferramentas com suas definições e recursos.
ToolUtility	Classe de utilitário para criar várias ferramentas.

Interfaces

AISearchIndexResource	Um recurso de índice de pesquisa de IA.
ActivityFunctionDefinition	As informações de definição de atividade para uma função.
ActivityFunctionParameters	Os parâmetros usados para a definição da função de atividade.
Agent	Representa um agente que pode chamar o modelo e usar ferramentas.
AgentDeletionStatus	O status de uma operação de exclusão de agente.
AgentErrorDetail	Descreve as informações de erro retornadas pela API dos agentes.
AgentEventMessage	Cada evento em um fluxo de eventos enviados pelo servidor tem uma propriedade event e data: Example event: thread.created data: {"id": "thread_123", "object": "thread", ...} Emitimos eventos sempre que um novo objeto é criado, faz a transição para um novo estado ou está sendo transmitido em partes (deltas). Por exemplo, emitimos thread.run.created quando uma nova execução é criada, thread.run.completed quando uma execução é concluída e assim por diante. Quando um Agente opta por criar uma mensagem durante uma execução, emitimos um thread.message.created event, um thread.message.in_progress evento, muitos thread.message.delta eventos e, finalmente, um thread.message.completed evento. Podemos acrescentar eventos adicionais ao longo do tempo, portanto, recomendamos tratar eventos desconhecidos normalmente em seu código.
AgentEventMessageStream	Representa um fluxo de mensagem de evento do agente.
AgentThread	Informações sobre um único thread associado a um agente.
AgentThreadCreationOptions	Os detalhes usados para criar um thread de agente.
AgentV1Error	Carga de erro retornada pela API de agentes.
AgentsClientOptionalParams	Parâmetros opcionais para o cliente.
AgentsNamedToolChoice	Especifica uma ferramenta que o modelo deve usar. Use para forçar o modelo a chamar uma ferramenta específica.
AgentsResponseFormat	Um objeto que descreve a saída esperada do modelo. Se for json_object, somente function do tipo tools terão permissão para ser passadas para a Execução. Se for text, o modelo poderá retornar texto ou qualquer valor necessário.
AzureAISearchToolDefinition	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.
AzureFunctionToolCallDetails	A descrição da chamada de função do Azure. Todos os campos estão presentes na etapa de execução concluída, no entanto, apenas alguns campos estão presentes no RunStepDeltaAzureFunctionToolCall.
AzureFunctionToolDefinition	As informações de definição de entrada para uma ferramenta de função do azure, conforme usado para configurar um agente.
BingCustomSearchConfiguration	Uma configuração de pesquisa personalizada do bing.
BingCustomSearchToolDefinition	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.
BingGroundingToolDefinition	As informações de definição de entrada para uma ferramenta de pesquisa de aterramento do bing, conforme usado para configurar um agente.
BrowserAutomationToolCallDetails	Detalhes de uma chamada da ferramenta Automação do Navegador.
BrowserAutomationToolCallStep	Descreve uma única etapa da execução de uma ferramenta de automação do navegador.
BrowserAutomationToolConnectionParameters	Definição de parâmetros de entrada para a conexão usada pela Ferramenta de Automação do Navegador.
BrowserAutomationToolDefinition	As informações de definição de entrada para uma Ferramenta de Automação do Navegador, conforme usado para configurar um Agente.
BrowserAutomationToolParameters	Definição de parâmetros de entrada para a Ferramenta de Automação do Navegador.
CodeInterpreterToolDefinition	As informações de definição de entrada para uma ferramenta de interpretador de código, conforme usado para configurar um agente.
CodeInterpreterToolResource	Um conjunto de recursos que são usados pela ferramenta code_interpreter.
ConnectedAgentDetails	Informações para conectar um agente a outro como uma ferramenta
ConnectedAgentToolDefinition	As informações de definição de entrada para uma ferramenta de agente conectado que define um subagente específico do domínio
CreateAgentOptionalParams	Parâmetros opcionais.
CreateThreadAndRunOptionalParams	Parâmetros opcionais.
DeepResearchBingGroundingConnection	A ID do recurso de conexão para o recurso de aterramento do Bing.
DeepResearchDetails	Os detalhes da ferramenta Deep Research.
DeepResearchToolDefinition	As informações de definição de entrada para uma ferramenta Deep Research usadas para configurar um agente.
DeleteAgentOptionalParams	Parâmetros opcionais.
FabricDataAgentToolParameters	Os parâmetros da ferramenta do agente de dados de malha.
FileDeletionStatus	Uma resposta de status de uma operação de exclusão de arquivo.
FileInfo	Representa um agente que pode chamar o modelo e usar ferramentas.
FileListResponse	Os dados de resposta de uma operação de lista de arquivos.
FileSearchRankingOptions	Opções de classificação para pesquisa de arquivo.
FileSearchToolCallContent	O objeto de conteúdo do resultado da pesquisa de arquivo.
FileSearchToolDefinition	As informações de definição de entrada para uma ferramenta de pesquisa de arquivo, conforme usado para configurar um agente.
FileSearchToolDefinitionDetails	As opções substituem a ferramenta de pesquisa de arquivos.
FileSearchToolResource	Um conjunto de recursos que são usados pela ferramenta file_search.
FilesDeleteFileOptionalParams	Parâmetros opcionais.
FilesGetFileContentOptionalParams	Parâmetros opcionais.
FilesGetFileOptionalParams	Parâmetros opcionais.
FilesListFilesOptionalParams	Parâmetros opcionais.
FilesOperations	Interface que representa uma operação de arquivos.
FilesUploadFileOptionalParams	Parâmetros opcionais.
FunctionArgument	O argumento e a descrição da função.
FunctionDefinition	As informações de definição de entrada para uma função.
FunctionName	O nome da função que será usado, se estiver usando a ferramenta function
FunctionToolDefinition	As informações de definição de entrada para uma ferramenta de função, conforme usado para configurar um agente.
GetAgentOptionalParams	Parâmetros opcionais.
IncompleteRunDetails	Detalhes sobre por que a execução está incompleta. Será null se a execução não estiver incompleta.
ListAgentsOptionalParams	Parâmetros opcionais.
MCPApprovalPerTool	Objeto de aprovação MCP personalizado, listando ferramentas que exigem e não exigem aprovações
MCPToolDefinition	As informações de definição de entrada para uma ferramenta MCP que define um endpoint do servidor MCP
MCPToolList	O objeto, contendo a lista de ferramentas para aprovações.
MCPToolResource	Um conjunto de recursos que são usados pela ferramenta mcp.
MessageAttachment	Isso descreve quais ferramentas um arquivo foi anexado.
MessageContent	Uma representação abstrata de um único item de conteúdo de mensagem de thread.
MessageDeletionStatus	O status de uma operação de exclusão de mensagem de thread.
MessageDelta	Representa o conteúdo "delta" digitado dentro de uma parte delta de mensagem de streaming.
MessageDeltaChunk	Representa um delta de mensagem, ou seja, todos os campos alterados em uma mensagem durante o streaming.
MessageDeltaContent	A representação base abstrata de um conteúdo parcial de mensagens transmitidas.
MessageDeltaImageFileContent	Representa uma parte de conteúdo de arquivo de imagem transmitida dentro de uma parte delta de mensagem de streaming.
MessageDeltaImageFileContentObject	Representa a carga 'image_file' no conteúdo do arquivo de imagem de streaming.
MessageDeltaTextAnnotation	A representação base abstrata da anotação de texto de uma parte de conteúdo de texto transmitido.
MessageDeltaTextContent	Representa uma parte de conteúdo de texto transmitido dentro de uma parte delta de mensagem de streaming.
MessageDeltaTextContentObject	Representa os dados de uma parte de conteúdo de texto transmitido dentro de uma parte delta de mensagem de streaming.
MessageDeltaTextFileCitationAnnotation	Representa uma citação de arquivo transmitida aplicada a uma parte de conteúdo de texto de streaming.
MessageDeltaTextFileCitationAnnotationObject	Representa os dados de uma citação de arquivo transmitido, conforme aplicado a uma parte de conteúdo de texto de streaming.
MessageDeltaTextFilePathAnnotation	Representa uma anotação de caminho de arquivo transmitido aplicada a uma parte de conteúdo de texto de streaming.
MessageDeltaTextFilePathAnnotationObject	Representa os dados de uma anotação de caminho de arquivo transmitido, conforme aplicado a uma parte de conteúdo de texto de streaming.
MessageDeltaTextUrlCitationAnnotation	Uma citação na mensagem que aponta para um URL específico associado à mensagem. Gerado quando o agente usa ferramentas como 'bing_grounding' para pesquisar na Internet.
MessageDeltaTextUrlCitationDetails	Uma representação de uma citação de URL, conforme usado no conteúdo da mensagem de encadeamento de texto.
MessageImageFileContent	Uma representação do conteúdo do arquivo de imagem em uma mensagem de thread.
MessageImageFileDetails	Uma referência de imagem, conforme representado no conteúdo da mensagem de thread.
MessageImageFileParam	Define como um arquivo de imagem carregado internamente é referenciado ao criar um bloco de arquivo de imagem.
MessageImageUrlParam	Define como um URL de imagem externa é referenciado ao criar um bloco de URL de imagem.
MessageIncompleteDetails	Informações que fornecem detalhes adicionais sobre uma mensagem que insere um status incompleto.
MessageInputContentBlock	Define um único bloco de conteúdo ao criar uma mensagem. O campo "tipo" determina se é texto, um arquivo de imagem ou uma URL de imagem externa, etc.
MessageInputImageFileBlock	Um bloco de arquivo de imagem em uma nova mensagem, fazendo referência a uma imagem carregada internamente por ID de arquivo.
MessageInputImageUrlBlock	Um bloco de URL de imagem em uma nova mensagem, fazendo referência a uma imagem externa por URL.
MessageInputTextBlock	Um bloco de texto em uma nova mensagem, contendo conteúdo de texto sem formatação.
MessageTextAnnotation	Uma representação abstrata de uma anotação no conteúdo da mensagem de thread de texto.
MessageTextContent	Uma representação de um item textual do conteúdo da mensagem de thread.
MessageTextDetails	O texto e as anotações associadas para um único item de conteúdo de mensagem de thread do agente.
MessageTextFileCitationAnnotation	Uma citação dentro da mensagem que aponta para uma citação específica de um arquivo específico associado ao agente ou à mensagem. Gerado quando o agente usa a ferramenta 'file_search' para pesquisar arquivos.
MessageTextFileCitationDetails	Uma representação de uma citação de texto baseada em arquivo, conforme usado em uma anotação baseada em arquivo do conteúdo da mensagem de thread de texto.
MessageTextFilePathAnnotation	Uma citação dentro da mensagem que aponta para um arquivo localizado em um caminho específico.
MessageTextFilePathDetails	Um encapsulamento de uma ID de arquivo de imagem, conforme usado pelo conteúdo da imagem da mensagem.
MessageTextUrlCitationAnnotation	Uma citação na mensagem que aponta para um URL específico associado à mensagem. Gerado quando o agente usa ferramentas como 'bing_grounding' para pesquisar na Internet.
MessageTextUrlCitationDetails	Uma representação de uma citação de URL, conforme usado no conteúdo da mensagem de encadeamento de texto.
MessagesCreateMessageOptionalParams	Parâmetros opcionais.
MessagesDeleteOptionalParams	Parâmetros opcionais.
MessagesGetMessageOptionalParams	Parâmetros opcionais.
MessagesListMessagesOptionalParams	Parâmetros opcionais.
MessagesOperations	Interface que representa uma operação de mensagens.
MessagesUpdateMessageOptionalParams	Parâmetros opcionais.
MicrosoftFabricToolDefinition	As informações de definição de entrada para uma ferramenta do Microsoft Fabric, conforme usado para configurar um agente.
OpenApiAnonymousAuthDetails	Detalhes de segurança para autenticação anônima do OpenApi
OpenApiAuthDetails	detalhes de autenticação para OpenApiFunctionDefinition
OpenApiConnectionAuthDetails	Detalhes de segurança para autenticação de conexão OpenApi
OpenApiConnectionSecurityScheme	Esquema de segurança para autenticação de managed_identity OpenApi
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
OpenApiToolDefinition	As informações de definição de entrada para uma ferramenta OpenAPI, conforme usado para configurar um agente.
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.
PollingOptions	Opções para configurar o comportamento de sondagem.
PollingOptionsParams	Parâmetros opcionais que configuram o comportamento de sondagem.
RequiredAction	Uma representação abstrata de uma ação necessária para que uma execução de thread de agente continue.
RequiredFunctionToolCall	Uma representação de uma chamada solicitada para uma ferramenta de função, necessária pelo modelo para continuar a avaliação de uma execução.
RequiredFunctionToolCallDetails	As informações detalhadas de uma invocação de função, conforme fornecido por uma ação necessária invocando uma ferramenta de função, que inclui o nome e os argumentos para a função.
RequiredMcpToolCall	Uma representação de uma chamada solicitada para uma ferramenta MCP, necessária para o modelo continuar a avaliação de uma execução.
RequiredToolCall	Uma representação abstrata de uma invocação de ferramenta necessária pelo modelo para continuar uma execução.
ResponseFormatJsonSchema	Uma descrição de para que serve o formato de resposta, usada pelo modelo para determinar a forma de responder no formato.
ResponseFormatJsonSchemaType	O tipo de formato de resposta que está sendo definido: json_schema
RunCompletionUsage	Estatísticas de uso relacionadas à execução. Esse valor será null se a execução não estiver em um estado terminal (ou seja, in_progress, queuedetc.).
RunError	Os detalhes de um erro, conforme encontrado por uma execução de thread do agente.
RunStep	Informações detalhadas sobre uma única etapa de uma execução de thread do agente.
RunStepActivityDetails	As informações detalhadas associadas a uma etapa de execução.
RunStepAzureAISearchToolCall	Um registro de uma chamada para uma ferramenta do Azure AI Search, emitida pelo modelo na avaliação de uma ferramenta definida, que representa a pesquisa de IA do Azure executada.
RunStepAzureFunctionToolCall	Um registro de uma chamada para uma ferramenta do Azure Function.
RunStepBingCustomSearchToolCall	Um registro de uma chamada para uma ferramenta de Pesquisa Personalizada do Bing, emitida pelo modelo na avaliação de uma ferramenta definida, que representa a pesquisa executada com a Pesquisa Personalizada do Bing.
RunStepBingGroundingToolCall	Um registro de uma chamada para uma ferramenta de aterramento do bing, emitido pelo modelo na avaliação de uma ferramenta definida, que representa a pesquisa executada com o aterramento do bing.
RunStepBrowserAutomationToolCall	Um registro de uma chamada para uma ferramenta de automação do navegador emitida pelo agente.
RunStepCodeInterpreterImageOutput	Uma representação de uma saída de imagem emitida por uma ferramenta de interpretador de código em resposta a uma chamada de ferramenta pelo modelo.
RunStepCodeInterpreterImageReference	Uma referência de imagem emitida por uma ferramenta de interpretador de código em resposta a uma chamada de ferramenta pelo modelo.
RunStepCodeInterpreterLogOutput	Uma representação de uma saída de log emitida por uma ferramenta de interpretador de código em resposta a uma chamada de ferramenta pelo modelo.
RunStepCodeInterpreterToolCall	Um registro de uma chamada para uma ferramenta de interpretador de código, emitido pelo modelo na avaliação de uma ferramenta definida, que representa entradas e saídas consumidas e emitidas pelo interpretador de código.
RunStepCodeInterpreterToolCallDetails	As informações detalhadas sobre uma invocação de interpretador de código pelo modelo.
RunStepCodeInterpreterToolCallOutput	Uma representação abstrata de uma saída emitida de uma ferramenta de interpretador de código.
RunStepCompletionUsage	Estatísticas de uso relacionadas à etapa de execução.
RunStepConnectedAgent	As informações detalhadas sobre a chamada da ferramenta do agente conectado.
RunStepConnectedAgentToolCall	Um registro de uma chamada para o agente conectado.
RunStepDeepResearchToolCall	Um registro de uma chamada para uma ferramenta de pesquisa profunda, emitida pelo modelo na avaliação de uma ferramenta definida, que representa operações de pesquisa profunda executadas.
RunStepDeepResearchToolCallDetails	As informações detalhadas sobre as tarefas de pesquisa profunda executadas pelo modelo.
RunStepDelta	Representa o conteúdo delta em uma parte delta da etapa de execução de streaming.
RunStepDeltaAzureAISearchToolCall	Representa o Azure AI Search em uma etapa de execução de streaming.
RunStepDeltaAzureFunctionToolCall	Representa a chamada da ferramenta Azure Function em uma etapa de execução de streaming.
RunStepDeltaBingGroundingToolCall	Representa a chamada da ferramenta de aterramento do bing em uma etapa de execução de streaming.
RunStepDeltaChunk	Representa um delta da etapa de execução, ou seja, todos os campos alterados em uma etapa de execução durante o streaming.
RunStepDeltaCodeInterpreterDetailItemObject	Representa os dados de chamada da ferramenta Interpretador de Código em chamadas de ferramenta de uma etapa de execução de streaming.
RunStepDeltaCodeInterpreterImageOutput	Representa uma saída de imagem como produzida pela ferramenta interpretador de código e representada na coleção de chamadas de ferramenta delta de uma etapa de execução de streaming.
RunStepDeltaCodeInterpreterImageOutputObject	Representa os dados da saída da imagem de chamada da ferramenta Interpretador de Código de uma etapa de streaming.
RunStepDeltaCodeInterpreterLogOutput	Representa uma saída de log, conforme produzido pela ferramenta Interpretador de Código e representado na coleção de chamadas de ferramenta delta de uma etapa de execução de streaming.
RunStepDeltaCodeInterpreterOutput	A representação base abstrata de uma saída da ferramenta interpretador de código da chamada de execução de streaming.
RunStepDeltaCodeInterpreterToolCall	Representa uma chamada de ferramenta interpretador de código nos detalhes da chamada da ferramenta de uma etapa de execução de streaming.
RunStepDeltaConnectedAgentToolCall	Representa a invocação do agente conectado como parte de uma etapa de execução de streaming.
RunStepDeltaCustomBingGroundingToolCall	Representa a chamada da ferramenta Pesquisa Personalizada do Bing em uma etapa de execução de streaming.
RunStepDeltaDeepResearchToolCall	Representa a pesquisa Deep em uma etapa de execução de streaming.
RunStepDeltaDetail	Representa um item de detalhes de etapa de execução única no conteúdo delta de uma etapa de execução de streaming.
RunStepDeltaFileSearchToolCall	Representa uma chamada de ferramenta de pesquisa de arquivo nos detalhes da chamada da ferramenta de uma etapa de execução de streaming.
RunStepDeltaFunction	Representa os dados de função em uma chamada de ferramenta de função delta da etapa de execução de streaming.
RunStepDeltaFunctionToolCall	Representa uma chamada de ferramenta de função nos detalhes da chamada da ferramenta de uma etapa de execução de streaming.
RunStepDeltaMCPObject	Representa uma invocação de mcp como parte de uma etapa de execução de streaming.
RunStepDeltaMcpToolCall	Representa os dados da função em uma chamada MCP da etapa de execução de streaming.
RunStepDeltaMessageCreation	Representa uma criação de mensagem em um delta da etapa de execução de streaming.
RunStepDeltaMessageCreationObject	Representa os dados em um objeto de resposta de criação de mensagem de etapa de execução de streaming.
RunStepDeltaMicrosoftFabricToolCall	Representa a chamada da ferramenta Microsoft Fabric em uma etapa de execução de streaming.
RunStepDeltaOpenAPIObject	Representa uma invocação de openapi como parte de uma etapa de execução de streaming.
RunStepDeltaOpenAPIToolCall	Representa a chamada da ferramenta openapi em uma etapa de execução de streaming.
RunStepDeltaSharepointToolCall	Representa a chamada de ferramenta do SharePoint em uma etapa de execução de streaming.
RunStepDeltaToolCall	A representação base abstrata de uma única chamada de ferramenta nos detalhes da chamada da ferramenta delta de uma etapa de streaming.
RunStepDeltaToolCallObject	Representa uma invocação de chamadas de ferramenta como parte de uma etapa de execução de streaming.
RunStepDetails	Uma representação abstrata dos detalhes de uma etapa de execução.
RunStepDetailsActivity	Representa a lista de atividades associadas à etapa especificada.
RunStepError	As informações de erro associadas a uma etapa de execução com falha.
RunStepFileSearchToolCall	Um registro de uma chamada para uma ferramenta de pesquisa de arquivos, emitido pelo modelo na avaliação de uma ferramenta definida, que representa a pesquisa de arquivo executada.
RunStepFileSearchToolCallResult	Resultado da chamada da ferramenta de pesquisa de arquivo.
RunStepFileSearchToolCallResults	Os resultados da pesquisa de arquivos.
RunStepFunctionToolCall	Um registro de uma chamada para uma ferramenta de função, emitido pelo modelo na avaliação de uma ferramenta definida, que representa as entradas e a saída consumidas e emitidas pela função especificada.
RunStepFunctionToolCallDetails	As informações detalhadas sobre a função chamada pelo modelo.
RunStepMcpToolCall	Um registro de uma chamada para uma ferramenta MCP, emitida pelo modelo na avaliação de uma ferramenta definida, que representa as ações MCP executadas.
RunStepMessageCreationDetails	As informações detalhadas associadas a uma etapa de execução de criação de mensagem.
RunStepMessageCreationReference	Os detalhes de uma mensagem criada como parte de uma etapa de execução.
RunStepMicrosoftFabricToolCall	Um registro de uma chamada para uma ferramenta do Microsoft Fabric, emitida pelo modelo na avaliação de uma ferramenta definida, que representa operações executadas do Microsoft Fabric.
RunStepOpenAPIToolCall	Um registro de uma chamada para uma ferramenta OpenAPI, emitida pelo modelo na avaliação de uma ferramenta definida, que representa as operações OpenAPI executadas.
RunStepSharepointToolCall	Um registro de uma chamada para uma ferramenta do SharePoint, emitido pelo modelo na avaliação de uma ferramenta definida, que representa ações executadas do SharePoint.
RunStepToolCall	Uma representação abstrata de uma chamada de ferramenta detalhada, conforme registrado em uma etapa de execução para uma execução existente.
RunStepToolCallDetails	As informações detalhadas associadas a uma etapa de execução de ferramentas de chamada.
RunStepsGetRunStepOptionalParams	Parâmetros opcionais.
RunStepsListRunStepsOptionalParams	Parâmetros opcionais.
RunStepsOperations	Interface que representa uma operação RunSteps.
RunsCancelRunOptionalParams	Parâmetros opcionais.
RunsCreateRunOptionalParams	Parâmetros opcionais.
RunsGetRunOptionalParams	Parâmetros opcionais.
RunsListRunsOptionalParams	Parâmetros opcionais.
RunsOperations	Interface que representa uma operação de Execução.
RunsSubmitToolOutputsToRunOptionalParams	Parâmetros opcionais.
RunsUpdateRunOptionalParams	Parâmetros opcionais.
SharepointGroundingToolParameters	Os parâmetros da ferramenta de aterramento do sharepoint.
SharepointToolDefinition	As informações de definição de entrada para uma ferramenta do sharepoint, conforme usado para configurar um agente.
SubmitToolApprovalAction	Os detalhes para a aprovação de chamada de ferramenta necessária que deve ser enviada para que uma execução de thread do agente continue.
SubmitToolApprovalDetails	Os detalhes que descrevem as ferramentas que devem ser aprovadas.
SubmitToolOutputsAction	Os detalhes das chamadas de ferramenta necessárias que devem ser enviadas para uma execução de thread do agente para continuar.
SubmitToolOutputsDetails	Os detalhes que descrevem as ferramentas que devem ser chamadas para enviar saídas de ferramenta.
ThreadDeletionStatus	O status de uma operação de exclusão de thread.
ThreadMessage	Uma única mensagem existente dentro de um thread do agente.
ThreadMessageOptions	Uma única mensagem dentro de um thread de agente, conforme fornecido durante a criação desse thread para seu estado inicial.
ThreadRun	Dados que representam uma única execução de avaliação de um thread de agente.
ThreadsCreateThreadOptionalParams	Parâmetros opcionais.
ThreadsDeleteThreadOptionalParams	Parâmetros opcionais.
ThreadsGetThreadOptionalParams	Parâmetros opcionais.
ThreadsListThreadsOptionalParams	Parâmetros opcionais.
ThreadsOperations	Interface que representa uma operação Threads.
ThreadsUpdateThreadOptionalParams	Parâmetros opcionais.
ToolApproval	Os dados fornecidos durante um envio de saídas de ferramenta para resolver chamadas de ferramenta pendentes e permitir que o modelo continue.
ToolConnection	Um recurso de conexão.
ToolDefinition	Uma representação abstrata de uma definição de ferramenta de entrada que um agente pode usar.
ToolOutput	Os dados fornecidos durante um envio de saídas de ferramenta para resolver chamadas de ferramenta pendentes e permitir que o modelo continue.
ToolResources	Um conjunto de recursos que são usados pelas ferramentas do agente. Os recursos são específicos para o tipo de ferramenta. Por exemplo, a ferramenta code_interpreter requer uma lista de IDs de arquivo, enquanto a ferramenta file_search requer uma lista de IDs do repositório de vetores.
TruncationObject	Controla como um thread será truncado antes da execução. Use isso para controlar a janela de contexto inicial da execução.
UpdateAgentOptionalParams	Parâmetros opcionais.
VectorStore	Um repositório de vetores é uma coleção de arquivos processados que pode ser usado pela ferramenta file_search.
VectorStoreAutoChunkingStrategyRequest	A estratégia padrão. Atualmente, essa estratégia usa um max_chunk_size_tokens de 800 e chunk_overlap_tokens de 400.
VectorStoreAutoChunkingStrategyResponse	Isso é retornado quando a estratégia de divisão em partes é desconhecida. Normalmente, isso ocorre porque o arquivo foi indexado antes do conceito de chunking_strategy ser introduzido na API.
VectorStoreChunkingStrategyRequest	Uma representação abstrata de uma configuração de estratégia de agrupamento do repositório de vetores.
VectorStoreChunkingStrategyResponse	Uma representação abstrata de uma configuração de estratégia de agrupamento do repositório de vetores.
VectorStoreConfiguration	A configuração de armazenamento vetor é a lista de fontes de dados, usada quando vários arquivos podem ser usados para a pesquisa de arquivos corporativos.
VectorStoreConfigurations	A estrutura, que contém a lista de configurações de armazenamento de vetor, ou seja, a lista de IDs de ativos do azure.
VectorStoreDataSource	A estrutura, que contém o caminho do URI do ativo do Azure e o tipo de ativo do arquivo usado como fonte de dados para a pesquisa de arquivos corporativos.
VectorStoreDeletionStatus	Objeto de resposta para excluir um repositório de vetores.
VectorStoreExpirationPolicy	A política de expiração de um repositório de vetores.
VectorStoreFile	Descrição de um arquivo anexado a um repositório de vetores.
VectorStoreFileBatch	Um lote de arquivos anexados a um repositório de vetores.
VectorStoreFileBatchesCancelVectorStoreFileBatchOptionalParams	Parâmetros opcionais.
VectorStoreFileBatchesCreateVectorStoreFileBatchOptionalParams	Parâmetros opcionais.
VectorStoreFileBatchesGetVectorStoreFileBatchOptionalParams	Parâmetros opcionais.
VectorStoreFileBatchesListVectorStoreFileBatchFilesOptionalParams	Parâmetros opcionais.
VectorStoreFileBatchesOperations	Interface que representa uma operação VectorStoreFileBatches.
VectorStoreFileCount	Contagens de arquivos processados ou processados por esse repositório de vetores agrupados por status.
VectorStoreFileDeletionStatus	Objeto de resposta para excluir uma relação de arquivo do repositório de vetores.
VectorStoreFileError	Detalhes sobre o erro que pode ter ocorrido durante o processamento de um arquivo para este repositório de vetores
VectorStoreFilesCreateVectorStoreFileOptionalParams	Parâmetros opcionais.
VectorStoreFilesDeleteVectorStoreFileOptionalParams	Parâmetros opcionais.
VectorStoreFilesGetVectorStoreFileOptionalParams	Parâmetros opcionais.
VectorStoreFilesListVectorStoreFilesOptionalParams	Parâmetros opcionais.
VectorStoreFilesOperations	Interface que representa uma operação VectorStoreFiles.
VectorStoreStaticChunkingStrategyOptions	Opções para configurar uma estratégia de agrupamento estático do repositório de vetores.
VectorStoreStaticChunkingStrategyRequest	Uma estratégia de agrupamento configurada estaticamente.
VectorStoreStaticChunkingStrategyResponse	Uma estratégia de agrupamento configurada estaticamente.
VectorStoresCreateVectorStoreOptionalParams	Parâmetros opcionais.
VectorStoresDeleteVectorStoreOptionalParams	Parâmetros opcionais.
VectorStoresGetVectorStoreOptionalParams	Parâmetros opcionais.
VectorStoresListVectorStoresOptionalParams	Parâmetros opcionais.
VectorStoresModifyVectorStoreOptionalParams	Parâmetros opcionais.
VectorStoresOperations	Interface que representa uma operação VectorStores.

Aliases de tipo

AgentEventStreamData	Representa um fluxo de dados de evento no agente.
AgentRunResponse	O agente executa a resposta com suporte para transmissão.
AgentStreamEvent	Alias para AgentStreamEvent
AgentsNamedToolChoiceType	Tipos de ferramentas disponíveis para agentes chamados ferramentas.
AgentsResponseFormatMode	Representa o modo no qual o modelo manipulará o formato de retorno de uma chamada de ferramenta.
AgentsResponseFormatOption	Alias para AgentsResponseFormatOption
AgentsToolChoiceOption	Alias para AgentsToolChoiceOption
AgentsToolChoiceOptionMode	Especifica como a escolha da ferramenta será usada
AzureAISearchQueryType	Tipos de consulta disponíveis para a ferramenta Azure AI Search.
ContinuablePage	Uma interface que descreve uma página de resultados.
FileContents	Valores válidos para o conteúdo de um arquivo binário.
FilePurpose	Os valores possíveis que denotam o uso pretendido de um arquivo.
FileState	O estado do arquivo.
ImageDetailLevel	Especifica o nível de detalhe de uma imagem. Pode ser 'auto', 'low', 'high' ou um valor futuro desconhecido.
IncompleteDetailsReason	O motivo pelo qual a execução está incompleta. Isso apontará para qual limite de token específico foi atingido ao longo da execução.
ListSortOrder	As opções de classificação disponíveis ao solicitar uma lista de objetos de resposta.
MCPRequiredApproval	Alias para MCPRequiredApproval
MessageAttachmentToolDefinition	Alias para MessageAttachmentToolDefinition
MessageBlockType	Especifica o tipo de bloco de conteúdo em uma mensagem. Pode ser texto, um arquivo de imagem, um URL de imagem externa ou um tipo futuro desconhecido.
MessageContentUnion	Alias para MessageContentUnion
MessageDeltaContentUnion	Alias para MessageDeltaContentUnion
MessageDeltaTextAnnotationUnion	Alias para MessageDeltaTextAnnotationUnion
MessageIncompleteDetailsReason	Um conjunto de motivos que descrevem por que uma mensagem é marcada como incompleta.
MessageInputContent	Alias para MessageInputContent
MessageInputContentBlockUnion	Alias para MessageInputContentBlockUnion
MessageRole	Os valores possíveis para funções atribuídas a mensagens em um thread.
MessageStatus	Os possíveis valores de status de execução para uma mensagem de thread.
MessageTextAnnotationUnion	Alias para MessageTextAnnotationUnion
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 (requer connection_id ao endpoint, conforme configurado no AI Foundry) Managed_Identity (requer público-alvo para autenticação baseada em identidade)
RequiredActionUnion	Alias para RequiredActionUnion
RequiredToolCallUnion	Alias para RequiredToolCallUnion
ResponseFormat	Possíveis formatos de resposta da API.
RunAdditionalFieldList	Uma lista de campos adicionais a serem incluídos na resposta.
RunStatus	Valores possíveis para o status de uma execução de thread do agente.
RunStepCodeInterpreterToolCallOutputUnion	Alias para RunStepCodeInterpreterToolCallOutputUnion
RunStepDeltaCodeInterpreterOutputUnion	Alias para RunStepDeltaCodeInterpreterOutputUnion
RunStepDeltaDetailUnion	Alias para RunStepDeltaDetailUnion
RunStepDeltaToolCallUnion	Alias para RunStepDeltaToolCallUnion
RunStepDetailsUnion	Alias para RunStepDetailsUnion
RunStepErrorCode	Possíveis valores de código de erro atribuíveis a uma etapa de execução com falha.
RunStepStatus	Valores possíveis para o status de uma etapa de execução.
RunStepToolCallUnion	Alias para RunStepToolCallUnion
RunStepType	Os tipos possíveis de etapas de execução.
ToolDefinitionUnion	Alias para ToolDefinitionUnion
TruncationStrategy	Possíveis estratégias de truncamento para o thread.
VectorStoreChunkingStrategyRequestType	Tipo de estratégia de agrupamento
VectorStoreChunkingStrategyRequestUnion	Alias para VectorStoreChunkingStrategyRequestUnion
VectorStoreChunkingStrategyResponseType	Tipo de estratégia de agrupamento
VectorStoreChunkingStrategyResponseUnion	Alias para VectorStoreChunkingStrategyResponseUnion
VectorStoreExpirationPolicyAnchor	Descreve a relação entre os dias e a expiração desse repositório de vetores
VectorStoreFileBatchStatus	O status do lote de arquivos de armazenamento de vetores.
VectorStoreFileErrorCode	Variantes de código de erro para processamento de arquivos de armazenamento de vetores
VectorStoreFileStatus	Status do arquivo de armazenamento de vetores
VectorStoreFileStatusFilter	Filtro de parâmetro de consulta para ponto de extremidade de recuperação de arquivo de armazenamento vetorial
VectorStoreStatus	Status possível do armazenamento de vetores

Enumerações

DoneEvent	Evento de terminal que indica o fim bem-sucedido de um fluxo.
ErrorEvent	Evento de terminal que indica um erro do lado do servidor durante o streaming.
KnownVersions	Versões da API dos Agentes de IA do Azure
MessageStreamEvent	Eventos de streaming relacionados à operação de mensagem
RunStepStreamEvent	Executar eventos de streaming relacionados à operação de etapa
RunStreamEvent	Executar eventos de streaming relacionados à operação
ThreadStreamEvent	Eventos de streaming relacionados à operação de thread
VectorStoreDataSourceAssetType	Tipo de ativo de armazenamento vetorial. O tipo de ativo pode ser um uri_asset, neste caso, deve conter o ID do URI do ativo, no caso de id_asset, deve conter o ID de dados.
connectionToolType	Tipos de ferramentas de conexão usadas para configurar um agente

Funções

isOutputOfType<T>(ToolDefinitionUnion | RequiredAction | RequiredToolCall, string)

Determina se a saída determinada é do tipo especificado.

Detalhes da função

isOutputOfType<T>(ToolDefinitionUnion | RequiredAction | RequiredToolCall, string)

Determina se a saída determinada é do tipo especificado.

function isOutputOfType<T>(output: ToolDefinitionUnion | RequiredAction | RequiredToolCall, type: string): output

Parâmetros

output

ToolDefinitionUnion | RequiredAction | RequiredToolCall

A ação para verificar, que pode ser do tipo RequiredAction, RequiredToolCallou ToolDefinitionUnion.

type

string

O tipo no qual verificar a ação.

Retornos

output

Um booliano que indica se a ação é do tipo especificado.