@azure/ai-agents package

Clases

AgentsClient
MCPTool	Una herramienta que se conecta a los servidores del protocolo de contexto del modelo (MCP). Admite la gestión dinámica de las conexiones del servidor MCP y las herramientas permitidas.
OpenApiTool	Una herramienta que recupera información utilizando las especificaciones de OpenAPI. Inicializada con una definición de API inicial (nombre, descripción, especificación, autenticación), esta clase también admite la adición y eliminación de definiciones de API adicionales de forma dinámica.
ToolSet	Representa un conjunto de herramientas con sus definiciones y recursos.
ToolUtility	Clase de utilidad para crear varias herramientas.

Interfaces

AISearchIndexResource	Un recurso de AI Search Index.
ActivityFunctionDefinition	La información de definición de actividad para una función.
ActivityFunctionParameters	Los parámetros utilizados para la definición de la función de actividad.
Agent	Representa un agente que puede llamar al modelo y usar herramientas.
AgentDeletionStatus	Estado de una operación de eliminación del agente.
AgentErrorDetail	Describe la información de error devuelta por la API de agentes.
AgentEventMessage	Cada evento de un flujo de eventos enviados por el servidor tiene una propiedad event y data: Example event: thread.created data: {"id": "thread_123", "object": "thread", ...} Los eventos se emiten cada vez que se crea un nuevo objeto, se realiza la transición a un nuevo estado o se transmiten en partes (delta). Por ejemplo, thread.run.created se emite cuando se crea una nueva ejecución, thread.run.completed cuando se completa una ejecución, etc. Cuando un agente elige crear un mensaje durante una ejecución, emitimos un thread.message.created event, un thread.message.in_progress evento, muchos thread.message.delta eventos y, finalmente, un thread.message.completed evento. Puede que agreguemos eventos adicionales a lo largo del tiempo, por lo que se recomienda controlar los eventos desconocidos correctamente en el código.
AgentEventMessageStream	Representa un flujo de mensaje de evento del agente.
AgentThread	Información sobre un único subproceso asociado a un agente.
AgentThreadCreationOptions	Detalles usados para crear un subproceso de agente.
AgentV1Error	Carga de error devuelta por la API de agentes.
AgentsClientOptionalParams	Parámetros opcionales para el cliente.
AgentsNamedToolChoice	Especifica una herramienta que debe usar el modelo. Use para forzar al modelo a llamar a una herramienta específica.
AgentsResponseFormat	Objeto que describe la salida esperada del modelo. Si json_object solo function se permite pasar el tipo tools a la ejecución. Si text el modelo puede devolver texto o cualquier valor necesario.
AzureAISearchToolDefinition	La información de definición de entrada de una herramienta de búsqueda de Azure AI como se usa para configurar un agente.
AzureAISearchToolResource	Conjunto de recursos de índice utilizados por la herramienta azure_ai_search.
AzureFunctionBinding	Estructura para mantener el nombre y el URI de la cola de almacenamiento.
AzureFunctionDefinition	Definición de la función de Azure.
AzureFunctionStorageQueue	Estructura para mantener el nombre y el URI de la cola de almacenamiento.
AzureFunctionToolCallDetails	Descripción de la llamada a la función de Azure. Todos los campos están presentes en el paso de ejecución completado, pero solo algunos campos están presentes en RunStepDeltaAzureFunctionToolCall.
AzureFunctionToolDefinition	La información de definición de entrada de una herramienta de función de Azure como se usa para configurar un agente.
BingCustomSearchConfiguration	Una configuración de búsqueda personalizada de Bing.
BingCustomSearchToolDefinition	La información de definición de entrada para una herramienta de búsqueda personalizada de Bing tal como se usa para configurar un agente.
BingCustomSearchToolParameters	Los parámetros de la herramienta de búsqueda personalizada de Bing.
BingGroundingSearchConfiguration	Configuración de búsqueda para Bing Grounding
BingGroundingSearchToolParameters	Los parámetros de la herramienta de búsqueda de conexión a tierra de Bing.
BingGroundingToolDefinition	La información de definición de entrada de una herramienta de búsqueda de bing grounding como se usa para configurar un agente.
BrowserAutomationToolCallDetails	Detalles de una llamada a la herramienta de automatización del navegador.
BrowserAutomationToolCallStep	Describe un solo paso de la ejecución de una herramienta de automatización del navegador.
BrowserAutomationToolConnectionParameters	Definición de parámetros de entrada para la conexión utilizada por la herramienta de automatización del navegador.
BrowserAutomationToolDefinition	La información de definición de entrada para una herramienta de automatización del navegador, tal como se usa para configurar un agente.
BrowserAutomationToolParameters	Definición de parámetros de entrada para la herramienta de automatización del navegador.
CodeInterpreterToolDefinition	La información de definición de entrada de una herramienta de intérprete de código como se usa para configurar un agente.
CodeInterpreterToolResource	Conjunto de recursos que usa la herramienta code_interpreter.
ConnectedAgentDetails	Información para conectar un agente con otro como herramienta
ConnectedAgentToolDefinition	La información de definición de entrada para una herramienta de agente conectada que define un subagente específico del dominio
CreateAgentOptionalParams	Parámetros opcionales.
CreateThreadAndRunOptionalParams	Parámetros opcionales.
DeepResearchBingGroundingConnection	El identificador de recurso de conexión para el recurso de conexión a tierra de Bing.
DeepResearchDetails	Los detalles de la herramienta Investigación profunda.
DeepResearchToolDefinition	La información de definición de entrada para una herramienta de investigación profunda que se utiliza para configurar un agente.
DeleteAgentOptionalParams	Parámetros opcionales.
FabricDataAgentToolParameters	Los parámetros de la herramienta Fabric Data Agent.
FileDeletionStatus	Respuesta de estado de una operación de eliminación de archivos.
FileInfo	Representa un agente que puede llamar al modelo y usar herramientas.
FileListResponse	Datos de respuesta de una operación de lista de archivos.
FileSearchRankingOptions	Opciones de clasificación para la búsqueda de archivos.
FileSearchToolCallContent	Objeto de contenido del resultado de la búsqueda de archivos.
FileSearchToolDefinition	La información de definición de entrada de una herramienta de búsqueda de archivos como se usa para configurar un agente.
FileSearchToolDefinitionDetails	Las opciones invalidan la herramienta de búsqueda de archivos.
FileSearchToolResource	Conjunto de recursos que usa la herramienta file_search.
FilesDeleteFileOptionalParams	Parámetros opcionales.
FilesGetFileContentOptionalParams	Parámetros opcionales.
FilesGetFileOptionalParams	Parámetros opcionales.
FilesListFilesOptionalParams	Parámetros opcionales.
FilesOperations	Interfaz que representa operaciones de archivos.
FilesUploadFileOptionalParams	Parámetros opcionales.
FunctionArgument	El argumento y la descripción de la función.
FunctionDefinition	Información de definición de entrada de una función.
FunctionName	El nombre de la función que se usará, si usa la herramienta function
FunctionToolDefinition	La información de definición de entrada de una herramienta de función como se usa para configurar un agente.
GetAgentOptionalParams	Parámetros opcionales.
IncompleteRunDetails	Detalles sobre por qué la ejecución está incompleta. Se null si la ejecución no está incompleta.
ListAgentsOptionalParams	Parámetros opcionales.
MCPApprovalPerTool	Objeto de aprobación MCP personalizado, enumerando herramientas que requieren y no requieren aprobaciones
MCPToolDefinition	La información de definición de entrada para una herramienta MCP que define un punto final de servidor MCP
MCPToolList	El objeto, que contiene la lista de herramientas para las aprobaciones.
MCPToolResource	Conjunto de recursos que usa la herramienta mcp.
MessageAttachment	Esto describe a qué herramientas se ha adjuntado un archivo.
MessageContent	Representación abstracta de un solo elemento del contenido del mensaje de subproceso.
MessageDeletionStatus	El estado de una operación de eliminación de mensajes de subproceso.
MessageDelta	Representa la carga "delta" con tipo dentro de un fragmento delta del mensaje de streaming.
MessageDeltaChunk	Representa un delta de mensaje, es decir, los campos modificados de un mensaje durante el streaming.
MessageDeltaContent	Representación base abstracta de una carga de contenido de mensaje transmitido parcial.
MessageDeltaImageFileContent	Representa una parte del contenido de un archivo de imagen transmitido dentro de un fragmento delta del mensaje de streaming.
MessageDeltaImageFileContentObject	Representa la carga "image_file" dentro del contenido del archivo de imagen de streaming.
MessageDeltaTextAnnotation	Representación base abstracta de la anotación de texto de un elemento de contenido de texto transmitido.
MessageDeltaTextContent	Representa una parte de contenido de texto transmitido dentro de un fragmento delta del mensaje de streaming.
MessageDeltaTextContentObject	Representa los datos de una parte de contenido de texto transmitido dentro de un fragmento delta del mensaje de streaming.
MessageDeltaTextFileCitationAnnotation	Representa una cita de archivo transmitido aplicada a una parte de contenido de texto de streaming.
MessageDeltaTextFileCitationAnnotationObject	Representa los datos de una cita de archivo transmitido como se aplica a una parte de contenido de texto de streaming.
MessageDeltaTextFilePathAnnotation	Representa una anotación de ruta de acceso de archivo transmitida aplicada a una parte de contenido de texto de streaming.
MessageDeltaTextFilePathAnnotationObject	Representa los datos de una anotación de ruta de acceso de archivo transmitido como se aplica a una parte de contenido de texto de streaming.
MessageDeltaTextUrlCitationAnnotation	Una cita dentro del mensaje que apunta a una URL específica asociada con el mensaje. Se genera cuando el agente utiliza herramientas como 'bing_grounding' para buscar en Internet.
MessageDeltaTextUrlCitationDetails	Representación de una cita de URL, tal como se utiliza en el contenido de los mensajes de los hilos de texto.
MessageImageFileContent	Representación del contenido del archivo de imagen en un mensaje de subproceso.
MessageImageFileDetails	Referencia de imagen, como se representa en el contenido del mensaje de subproceso.
MessageImageFileParam	Define cómo se hace referencia a un archivo de imagen cargado internamente al crear un bloque de archivo de imagen.
MessageImageUrlParam	Define cómo se hace referencia a una URL de imagen externa al crear un bloque de URL de imagen.
MessageIncompleteDetails	Información que proporciona detalles adicionales sobre un mensaje que especifica un estado incompleto.
MessageInputContentBlock	Define un único bloque de contenido al crear un mensaje. El campo "type" determina si es texto, un archivo de imagen o una dirección URL de imagen externa, etc.
MessageInputImageFileBlock	Un bloque de archivo de imagen en un mensaje nuevo, que hace referencia a una imagen cargada internamente por ID de archivo.
MessageInputImageUrlBlock	Un bloque de URL de imagen en un mensaje nuevo, que hace referencia a una imagen externa por URL.
MessageInputTextBlock	Un bloque de texto en un mensaje nuevo, que contiene contenido de texto sin formato.
MessageTextAnnotation	Representación abstracta de una anotación en el contenido del mensaje de subproceso de texto.
MessageTextContent	Representación de un elemento textual del contenido del mensaje de subproceso.
MessageTextDetails	Texto y anotaciones asociadas para un único elemento del contenido del mensaje del subproceso del agente.
MessageTextFileCitationAnnotation	Cita dentro del mensaje que apunta a una cita específica de un archivo específico asociado al agente o al mensaje. Se genera cuando el agente usa la herramienta "file_search" para buscar archivos.
MessageTextFileCitationDetails	Representación de una cita de texto basada en archivos, como se usa en una anotación basada en archivos del contenido del mensaje de subproceso de texto.
MessageTextFilePathAnnotation	Cita dentro del mensaje que apunta a un archivo ubicado en una ruta de acceso específica.
MessageTextFilePathDetails	Encapsulación de un identificador de archivo de imagen, como se usa en el contenido de la imagen del mensaje.
MessageTextUrlCitationAnnotation	Una cita dentro del mensaje que apunta a una URL específica asociada con el mensaje. Se genera cuando el agente utiliza herramientas como 'bing_grounding' para buscar en Internet.
MessageTextUrlCitationDetails	Representación de una cita de URL, tal como se utiliza en el contenido de los mensajes de los hilos de texto.
MessagesCreateMessageOptionalParams	Parámetros opcionales.
MessagesDeleteOptionalParams	Parámetros opcionales.
MessagesGetMessageOptionalParams	Parámetros opcionales.
MessagesListMessagesOptionalParams	Parámetros opcionales.
MessagesOperations	Interfaz que representa una operación de mensajes.
MessagesUpdateMessageOptionalParams	Parámetros opcionales.
MicrosoftFabricToolDefinition	La información de definición de entrada de una herramienta de Microsoft Fabric como se usa para configurar un agente.
OpenApiAnonymousAuthDetails	Detalles de seguridad para la autenticación anónima de OpenApi
OpenApiAuthDetails	detalles de autenticación de OpenApiFunctionDefinition
OpenApiConnectionAuthDetails	Detalles de seguridad de la autenticación de conexión de OpenApi
OpenApiConnectionSecurityScheme	Esquema de seguridad para la autenticación de openApi managed_identity
OpenApiFunctionDefinition	Información de definición de entrada para una función openapi.
OpenApiManagedAuthDetails	Detalles de seguridad para la autenticación de openApi managed_identity
OpenApiManagedSecurityScheme	Esquema de seguridad para la autenticación de openApi managed_identity
OpenApiToolDefinition	La información de definición de entrada de una herramienta OpenAPI como se usa para configurar un agente.
PageSettings	Opciones para el método byPage
PagedAsyncIterableIterator	Interfaz que permite la iteración asincrónica tanto a la finalización como a la página.
PollingOptions	Opciones para configurar el comportamiento de sondeo.
PollingOptionsParams	Parámetros opcionales que configuran el comportamiento de sondeo.
RequiredAction	Representación abstracta de una acción necesaria para que se ejecute un subproceso de agente para continuar.
RequiredFunctionToolCall	Representación de una llamada solicitada a una herramienta de función, que necesita el modelo para continuar la evaluación de una ejecución.
RequiredFunctionToolCallDetails	La información detallada de una invocación de función, tal como se proporciona en una acción necesaria que invoca una herramienta de función, que incluye el nombre de los argumentos y a la función.
RequiredMcpToolCall	Una representación de una llamada solicitada a una herramienta MCP, necesaria para que el modelo continúe la evaluación de una ejecución.
RequiredToolCall	Representación abstracta de una invocación de herramienta que necesita el modelo para continuar una ejecución.
ResponseFormatJsonSchema	Descripción del formato de respuesta que usa el modelo para determinar cómo responder en el formato.
ResponseFormatJsonSchemaType	Tipo de formato de respuesta que se va a definir: json_schema
RunCompletionUsage	Estadísticas de uso relacionadas con la ejecución. Este valor se null si la ejecución no está en un estado terminal (es decir, in_progress, queued, etc.).
RunError	Detalles de un error detectado por una ejecución de subproceso del agente.
RunStep	Información detallada sobre un solo paso de una ejecución de subproceso de agente.
RunStepActivityDetails	La información detallada asociada con las actividades de un paso de ejecución.
RunStepAzureAISearchToolCall	Registro de una llamada a una herramienta de Azure AI Search, emitida por el modelo en evaluación de una herramienta definida, que representa la búsqueda de Azure AI ejecutada.
RunStepAzureFunctionToolCall	Registro de una llamada a una herramienta de Azure Function.
RunStepBingCustomSearchToolCall	Registro de una llamada a una herramienta de búsqueda personalizada de Bing, emitida por el modelo en evaluación de una herramienta definida, que representa la búsqueda ejecutada con Bing Custom Search.
RunStepBingGroundingToolCall	Registro de una llamada a una herramienta bing grounding, emitida por el modelo en evaluación de una herramienta definida, que representa la búsqueda ejecutada con bing grounding.
RunStepBrowserAutomationToolCall	Un registro de una llamada a una herramienta de automatización del navegador emitida por el agente.
RunStepCodeInterpreterImageOutput	Representación de una salida de imagen emitida por una herramienta de intérprete de código en respuesta a una llamada de herramienta por el modelo.
RunStepCodeInterpreterImageReference	Referencia de imagen emitida por una herramienta de intérprete de código en respuesta a una llamada de herramienta por el modelo.
RunStepCodeInterpreterLogOutput	Representación de una salida de registro emitida por una herramienta de intérprete de código en respuesta a una llamada de herramienta por el modelo.
RunStepCodeInterpreterToolCall	Registro de una llamada a una herramienta de intérprete de código, emitida por el modelo en evaluación de una herramienta definida, que representa entradas y salidas consumidas y emitidas por el intérprete de código.
RunStepCodeInterpreterToolCallDetails	Información detallada sobre una invocación de intérprete de código por parte del modelo.
RunStepCodeInterpreterToolCallOutput	Representación abstracta de una salida emitida desde una herramienta de intérprete de código.
RunStepCompletionUsage	Estadísticas de uso relacionadas con el paso de ejecución.
RunStepConnectedAgent	La información detallada sobre la llamada a la herramienta del agente conectado.
RunStepConnectedAgentToolCall	Un registro de una llamada al agente conectado.
RunStepDeepResearchToolCall	Un registro de una llamada a una herramienta de investigación profunda, emitido por el modelo en evaluación de una herramienta definida, que representa las operaciones de investigación profunda ejecutadas.
RunStepDeepResearchToolCallDetails	La información detallada sobre las tareas de investigación profunda realizadas por el modelo.
RunStepDelta	Representa la carga diferencial en un fragmento delta del paso de ejecución de streaming.
RunStepDeltaAzureAISearchToolCall	Representa la búsqueda de Azure AI en un paso de ejecución de streaming.
RunStepDeltaAzureFunctionToolCall	Representa la llamada a la herramienta de Azure Functions en un paso de ejecución de streaming.
RunStepDeltaBingGroundingToolCall	Representa la llamada a la herramienta de conexión a tierra de Bing en un paso de ejecución de streaming.
RunStepDeltaChunk	Representa un delta de paso de ejecución, es decir, los campos modificados de un paso de ejecución durante el streaming.
RunStepDeltaCodeInterpreterDetailItemObject	Representa los datos de llamada de la herramienta De intérprete de código en las llamadas a herramientas de un paso de ejecución de streaming.
RunStepDeltaCodeInterpreterImageOutput	Representa una salida de imagen como se genera la herramienta de intérprete de código y como se representa en la colección de llamadas de la herramienta delta del paso de ejecución de streaming.
RunStepDeltaCodeInterpreterImageOutputObject	Representa los datos de la salida de la imagen de llamada a la imagen de la herramienta de intérprete de código de un paso de ejecución de streaming.
RunStepDeltaCodeInterpreterLogOutput	Representa una salida de registro generada por la herramienta De intérprete de código y como se representa en la colección de llamadas de la herramienta delta del paso de ejecución de streaming.
RunStepDeltaCodeInterpreterOutput	Representación base abstracta de la salida de la herramienta de intérprete de código de una herramienta de ejecución de streaming.
RunStepDeltaCodeInterpreterToolCall	Representa una llamada de herramienta de intérprete de código dentro de los detalles de la llamada de herramienta del paso de ejecución de streaming.
RunStepDeltaConnectedAgentToolCall	Representa la invocación del agente conectado como parte de un paso de ejecución de streaming.
RunStepDeltaCustomBingGroundingToolCall	Representa la llamada a la herramienta de búsqueda personalizada de Bing en un paso de ejecución de streaming.
RunStepDeltaDeepResearchToolCall	Representa la investigación profunda en un paso de ejecución de transmisión.
RunStepDeltaDetail	Representa un único elemento de detalle del paso de ejecución en la carga diferencial de un paso de ejecución de streaming.
RunStepDeltaFileSearchToolCall	Representa una llamada a la herramienta de búsqueda de archivos dentro de los detalles de la llamada de herramienta del paso de ejecución de streaming.
RunStepDeltaFunction	Representa los datos de función en una llamada a la herramienta de función del paso de ejecución de streaming delta.
RunStepDeltaFunctionToolCall	Representa una llamada de herramienta de función dentro de los detalles de la llamada de herramienta del paso de ejecución de streaming.
RunStepDeltaMCPObject	Representa una invocación de mcp como parte de un paso de ejecución de streaming.
RunStepDeltaMcpToolCall	Representa los datos de la función en una llamada MCP de paso de ejecución de secuencia.
RunStepDeltaMessageCreation	Representa una creación de mensajes dentro de un delta del paso de ejecución de streaming.
RunStepDeltaMessageCreationObject	Representa los datos dentro de un objeto de respuesta de creación de mensajes de paso de ejecución de streaming.
RunStepDeltaMicrosoftFabricToolCall	Representa la llamada a la herramienta de Microsoft Fabric en un paso de ejecución de streaming.
RunStepDeltaOpenAPIObject	Representa una invocación de openapi como parte de un paso de ejecución de streaming.
RunStepDeltaOpenAPIToolCall	Representa la llamada a la herramienta openapi en un paso de ejecución de streaming.
RunStepDeltaSharepointToolCall	Representa la llamada a la herramienta de SharePoint en un paso de ejecución de streaming.
RunStepDeltaToolCall	Representación base abstracta de una sola llamada de herramienta dentro de los detalles de la llamada a la herramienta delta del paso de ejecución de streaming.
RunStepDeltaToolCallObject	Representa una invocación de llamadas a herramientas como parte de un paso de ejecución de streaming.
RunStepDetails	Representación abstracta de los detalles de un paso de ejecución.
RunStepDetailsActivity	Representa la lista de actividades asociadas con el paso dado.
RunStepError	La información de error asociada a un paso de ejecución con errores.
RunStepFileSearchToolCall	Un registro de una llamada a una herramienta de búsqueda de archivos, emitida por el modelo en evaluación de una herramienta definida, que representa la búsqueda de archivos ejecutada.
RunStepFileSearchToolCallResult	Resultado de la llamada de la herramienta de búsqueda de archivos.
RunStepFileSearchToolCallResults	Resultados de la búsqueda de archivos.
RunStepFunctionToolCall	Registro de una llamada a una herramienta de función, emitida por el modelo en evaluación de una herramienta definida, que representa las entradas y salidas consumidas y emitidas por la función especificada.
RunStepFunctionToolCallDetails	Información detallada sobre la función a la que llama el modelo.
RunStepMcpToolCall	Un registro de una llamada a una herramienta MCP, emitido por el modelo en la evaluación de una herramienta definida, que representa las acciones MCP ejecutadas.
RunStepMessageCreationDetails	Información detallada asociada a un paso de ejecución de creación de mensajes.
RunStepMessageCreationReference	Detalles de un mensaje creado como parte de un paso de ejecución.
RunStepMicrosoftFabricToolCall	Un registro de una llamada a una herramienta de Microsoft Fabric, emitida por el modelo en evaluación de una herramienta definida, que representa las operaciones ejecutadas de Microsoft Fabric.
RunStepOpenAPIToolCall	Un registro de una llamada a una herramienta OpenAPI, emitido por el modelo en la evaluación de una herramienta definida, que representa las operaciones OpenAPI ejecutadas.
RunStepSharepointToolCall	Un registro de una llamada a una herramienta de SharePoint, emitida por el modelo en evaluación de una herramienta definida, que representa las acciones ejecutadas de SharePoint.
RunStepToolCall	Representación abstracta de una llamada de herramienta detallada como registrada dentro de un paso de ejecución para una ejecución existente.
RunStepToolCallDetails	Información detallada asociada a una herramienta de llamada de paso de ejecución.
RunStepsGetRunStepOptionalParams	Parámetros opcionales.
RunStepsListRunStepsOptionalParams	Parámetros opcionales.
RunStepsOperations	Interfaz que representa operaciones RunSteps.
RunsCancelRunOptionalParams	Parámetros opcionales.
RunsCreateRunOptionalParams	Parámetros opcionales.
RunsGetRunOptionalParams	Parámetros opcionales.
RunsListRunsOptionalParams	Parámetros opcionales.
RunsOperations	Interfaz que representa operaciones de ejecución.
RunsSubmitToolOutputsToRunOptionalParams	Parámetros opcionales.
RunsUpdateRunOptionalParams	Parámetros opcionales.
SharepointGroundingToolParameters	Los parámetros de la herramienta de conexión a tierra de SharePoint.
SharepointToolDefinition	La información de definición de entrada de una herramienta de sharepoint como se usa para configurar un agente.
SubmitToolApprovalAction	Los detalles de la aprobación de llamadas a herramientas necesarias que se deben enviar para que continúe la ejecución de un subproceso de agente.
SubmitToolApprovalDetails	Los detalles que describen las herramientas que deben aprobarse.
SubmitToolOutputsAction	Los detalles de las llamadas a herramientas necesarias que se deben enviar para que se ejecute un subproceso del agente para continuar.
SubmitToolOutputsDetails	Detalles que describen las herramientas a las que se debe llamar para enviar las salidas de la herramienta.
ThreadDeletionStatus	Estado de una operación de eliminación de subprocesos.
ThreadMessage	Un único mensaje existente dentro de un subproceso del agente.
ThreadMessageOptions	Un único mensaje dentro de un subproceso del agente, tal como se proporciona durante la creación de ese subproceso para su estado inicial.
ThreadRun	Datos que representan una sola ejecución de evaluación de un subproceso de agente.
ThreadsCreateThreadOptionalParams	Parámetros opcionales.
ThreadsDeleteThreadOptionalParams	Parámetros opcionales.
ThreadsGetThreadOptionalParams	Parámetros opcionales.
ThreadsListThreadsOptionalParams	Parámetros opcionales.
ThreadsOperations	Interfaz que representa operaciones de subprocesos.
ThreadsUpdateThreadOptionalParams	Parámetros opcionales.
ToolApproval	Los datos proporcionados durante un envío de la herramienta generan el envío para resolver las llamadas a herramientas pendientes y permitir que el modelo continúe.
ToolConnection	Un recurso de conexión.
ToolDefinition	Representación abstracta de una definición de herramienta de entrada que un agente puede usar.
ToolOutput	Los datos proporcionados durante un envío de la herramienta generan el envío para resolver las llamadas a herramientas pendientes y permitir que el modelo continúe.
ToolResources	Conjunto de recursos que usan las herramientas del agente. Los recursos son específicos del tipo de herramienta. Por ejemplo, la herramienta code_interpreter requiere una lista de identificadores de archivo, mientras que la file_search herramienta requiere una lista de identificadores de almacén de vectores.
TruncationObject	Controla cómo se truncará un subproceso antes de la ejecución. Úselo para controlar la ventana de contexto inicial de la ejecución.
UpdateAgentOptionalParams	Parámetros opcionales.
VectorStore	Un almacén vectorial es una colección de archivos procesados que pueden ser usados por la herramienta file_search.
VectorStoreAutoChunkingStrategyRequest	Estrategia predeterminada. Actualmente, esta estrategia usa un max_chunk_size_tokens de 800 y chunk_overlap_tokens de 400.
VectorStoreAutoChunkingStrategyResponse	Esto se devuelve cuando se desconoce la estrategia de fragmentación. Normalmente, esto se debe a que el archivo se indizó antes de que se introdujera el concepto de chunking_strategy en la API.
VectorStoreChunkingStrategyRequest	Representación abstracta de una configuración de estrategia de fragmentación del almacén de vectores.
VectorStoreChunkingStrategyResponse	Representación abstracta de una configuración de estrategia de fragmentación del almacén de vectores.
VectorStoreConfiguration	La configuración de almacenamiento vectorial es la lista de orígenes de datos, que se usan cuando se pueden usar varios archivos para la búsqueda de archivos empresariales.
VectorStoreConfigurations	La estructura, que contiene la lista de configuraciones de almacenamiento vectorial, es decir, la lista de identificadores de recursos de Azure.
VectorStoreDataSource	Estructura que contiene la ruta de acceso del URI del recurso de Azure y el tipo de recurso del archivo que se usa como origen de datos para la búsqueda de archivos de empresa.
VectorStoreDeletionStatus	Objeto de respuesta para eliminar un almacén de vectores.
VectorStoreExpirationPolicy	Directiva de expiración de un almacén de vectores.
VectorStoreFile	Descripción de un archivo adjunto a un almacén de vectores.
VectorStoreFileBatch	Un lote de archivos adjuntos a un almacén de vectores.
VectorStoreFileBatchesCancelVectorStoreFileBatchOptionalParams	Parámetros opcionales.
VectorStoreFileBatchesCreateVectorStoreFileBatchOptionalParams	Parámetros opcionales.
VectorStoreFileBatchesGetVectorStoreFileBatchOptionalParams	Parámetros opcionales.
VectorStoreFileBatchesListVectorStoreFileBatchFilesOptionalParams	Parámetros opcionales.
VectorStoreFileBatchesOperations	Interfaz que representa una operación VectorStoreFileBatches.
VectorStoreFileCount	Recuentos de archivos procesados o procesados por este almacén de vectores agrupados por estado.
VectorStoreFileDeletionStatus	Objeto de respuesta para eliminar una relación de archivo de almacén vectorial.
VectorStoreFileError	Detalles sobre el error que puede haber ocurrido al procesar un archivo para este almacén de vectores
VectorStoreFilesCreateVectorStoreFileOptionalParams	Parámetros opcionales.
VectorStoreFilesDeleteVectorStoreFileOptionalParams	Parámetros opcionales.
VectorStoreFilesGetVectorStoreFileOptionalParams	Parámetros opcionales.
VectorStoreFilesListVectorStoreFilesOptionalParams	Parámetros opcionales.
VectorStoreFilesOperations	Interfaz que representa una operación VectorStoreFiles.
VectorStoreStaticChunkingStrategyOptions	Opciones para configurar una estrategia de fragmentación estática del almacén de vectores.
VectorStoreStaticChunkingStrategyRequest	Una estrategia de fragmentación configurada estáticamente.
VectorStoreStaticChunkingStrategyResponse	Una estrategia de fragmentación configurada estáticamente.
VectorStoresCreateVectorStoreOptionalParams	Parámetros opcionales.
VectorStoresDeleteVectorStoreOptionalParams	Parámetros opcionales.
VectorStoresGetVectorStoreOptionalParams	Parámetros opcionales.
VectorStoresListVectorStoresOptionalParams	Parámetros opcionales.
VectorStoresModifyVectorStoreOptionalParams	Parámetros opcionales.
VectorStoresOperations	Interfaz que representa una operación de VectorStores.

Alias de tipos

AgentEventStreamData	Representa un flujo de datos de eventos en el agente.
AgentRunResponse	Respuesta de ejecución del agente con compatibilidad para transmitir.
AgentStreamEvent	Alias de AgentStreamEvent
AgentsNamedToolChoiceType	Tipos de herramientas disponibles para las herramientas con nombre de los agentes.
AgentsResponseFormatMode	Representa el modo en el que el modelo controlará el formato de retorno de una llamada a la herramienta.
AgentsResponseFormatOption	Alias de AgentsResponseFormatOption
AgentsToolChoiceOption	Alias de AgentsToolChoiceOption
AgentsToolChoiceOptionMode	Especifica cómo se utilizará la elección de la herramienta
AzureAISearchQueryType	Tipos de consulta disponibles para la herramienta de búsqueda de Azure AI.
ContinuablePage	Interfaz que describe una página de resultados.
FileContents	Valores válidos para el contenido de un archivo binario.
FilePurpose	Los valores posibles que denotan el uso previsto de un archivo.
FileState	Estado del archivo.
ImageDetailLevel	Especifica el nivel de detalle de una imagen. Puede ser 'automático', 'bajo', 'alto' o un valor futuro desconocido.
IncompleteDetailsReason	Motivo por el que la ejecución está incompleta. Esto apuntará a qué límite de tokens específico se alcanzó durante el transcurso de la ejecución.
ListSortOrder	Las opciones de ordenación disponibles al solicitar una lista de objetos de respuesta.
MCPRequiredApproval	Alias para MCPRequiredApproval
MessageAttachmentToolDefinition	Alias para MessageAttachmentToolDefinition
MessageBlockType	Especifica el tipo de bloque de contenido dentro de un mensaje. Puede ser texto, un archivo de imagen, una URL de imagen externa o un tipo futuro desconocido.
MessageContentUnion	Alias de MessageContentUnion
MessageDeltaContentUnion	Alias de MessageDeltaContentUnion
MessageDeltaTextAnnotationUnion	Alias de MessageDeltaTextAnnotationUnion
MessageIncompleteDetailsReason	Conjunto de razones que describen por qué un mensaje está marcado como incompleto.
MessageInputContent	Alias de MessageInputContent
MessageInputContentBlockUnion	Alias de MessageInputContentBlockUnion
MessageRole	Los valores posibles de los roles atribuidos a los mensajes de un hilo.
MessageStatus	Los posibles valores de estado de ejecución para un mensaje de subproceso.
MessageTextAnnotationUnion	Alias de MessageTextAnnotationUnion
OpenApiAuthDetailsUnion	Alias de OpenApiAuthDetailsUnion
OpenApiAuthType	Tipo de autenticación para el punto de conexión de OpenApi. Los tipos permitidos son: Anónimo (no se requiere autenticación) Conexión (requiere connection_id al punto final, como se configuró en AI Foundry) Managed_Identity (requiere audiencia para la autenticación basada en identidad)
RequiredActionUnion	Alias de RequiredActionUnion
RequiredToolCallUnion	Alias de RequiredToolCallUnion
ResponseFormat	Posibles formatos de respuesta de API.
RunAdditionalFieldList	Lista de campos adicionales que se van a incluir en la respuesta.
RunStatus	Valores posibles para el estado de la ejecución de un subproceso de agente.
RunStepCodeInterpreterToolCallOutputUnion	Alias de RunStepCodeInterpreterToolCallOutputUnion
RunStepDeltaCodeInterpreterOutputUnion	Alias de RunStepDeltaCodeInterpreterOutputUnion
RunStepDeltaDetailUnion	Alias de RunStepDeltaDetailUnion
RunStepDeltaToolCallUnion	Alias para RunStepDeltaToolCallUnion
RunStepDetailsUnion	Alias de RunStepDetailsUnion
RunStepErrorCode	Posibles valores de código de error atribuibles a un paso de ejecución erróneo.
RunStepStatus	Valores posibles para el estado de un paso de ejecución.
RunStepToolCallUnion	Alias de RunStepToolCallUnion
RunStepType	Los tipos posibles de pasos de ejecución.
ToolDefinitionUnion	Alias de ToolDefinitionUnion
TruncationStrategy	Posibles estrategias de truncamiento para el subproceso.
VectorStoreChunkingStrategyRequestType	Tipo de estrategia de fragmentación
VectorStoreChunkingStrategyRequestUnion	Alias de VectorStoreChunkingStrategyRequestUnion
VectorStoreChunkingStrategyResponseType	Tipo de estrategia de fragmentación
VectorStoreChunkingStrategyResponseUnion	Alias de VectorStoreChunkingStrategyResponseUnion
VectorStoreExpirationPolicyAnchor	Describe la relación entre los días y la caducidad de este almacén de vectores
VectorStoreFileBatchStatus	El estado del lote de archivos de almacenamiento de vectores.
VectorStoreFileErrorCode	Variantes de código de error para el procesamiento de archivos de almacenamiento vectorial
VectorStoreFileStatus	Estado del archivo de almacenamiento vectorial
VectorStoreFileStatusFilter	Filtro de parámetros de consulta para el punto de conexión de recuperación de archivos de almacenamiento vectorial
VectorStoreStatus	Estado posible del almacenamiento de vectores

Enumeraciones

DoneEvent	Evento de terminal que indica el final correcto de una secuencia.
ErrorEvent	Evento de terminal que indica un error del lado servidor mientras se transmite.
KnownVersions	Versiones de la API de Azure AI Agents
MessageStreamEvent	Eventos de streaming relacionados con la operación de mensajes
RunStepStreamEvent	Ejecución de eventos de streaming relacionados con la operación de paso
RunStreamEvent	Ejecución de eventos de streaming relacionados con la operación
ThreadStreamEvent	Eventos de streaming relacionados con la operación de subproceso
VectorStoreDataSourceAssetType	Tipo de activo de almacenamiento vectorial. El tipo de activo puede ser un uri_asset, en este caso debe contener el ID de URI del activo, en el caso de id_asset debe contener el ID de datos.
connectionToolType	Tipos de herramientas de conexión usadas para configurar un agente

Funciones

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

Determina si la salida especificada es del tipo especificado.

Detalles de la función

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

Determina si la salida especificada es del tipo especificado.

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

Parámetros

output

ToolDefinitionUnion | RequiredAction | RequiredToolCall

Acción que se va a comprobar, que puede ser de tipo RequiredAction, RequiredToolCallo ToolDefinitionUnion.

type

string

Tipo en el que se va a comprobar la acción.

Devoluciones

output

Valor booleano que indica si la acción es del tipo especificado.