Compartir a través de


@azure/openai-assistants package

Clases

AssistantsClient

Operaciones relacionadas con el asistente de manejo de clientes.

AzureKeyCredential

Credencial basada en clave estática que admite la actualización del valor de clave subyacente.

OpenAIKeyCredential

La clase OpenAIKeyCredential representa una clave de API de OpenAI y se usa para autenticarse en un cliente de Assistants para un punto de conexión de OpenAI.

Interfaces

Assistant

Representa un asistente que puede llamar al modelo y usar herramientas.

AssistantCreationOptions

Los detalles de la solicitud que se utilizarán al crear un nuevo asistente.

AssistantDeletionStatus

Estado de una operación de eliminación del asistente.

AssistantFile

Información sobre un archivo adjunto a un asistente, tal como lo usan las herramientas que pueden leer archivos.

AssistantFileDeletionStatus

El estado de una operación de eliminación de archivos del asistente.

AssistantThread

Información sobre un único subproceso asociado a un asistente.

AssistantThreadCreationOptions

Los detalles utilizados para crear un nuevo subproceso del asistente.

AssistantsClientOptions

Los detalles usados para crear un cliente auxiliar *

CancelRunOptions

Los detalles utilizados para cancelar una ejecución.

CodeInterpreterImageOutput

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.

CodeInterpreterImageReference

Referencia de imagen emitida por una herramienta de intérprete de código en respuesta a una llamada de herramienta por el modelo.

CodeInterpreterLogOutput

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.

CodeInterpreterToolCall

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.

CodeInterpreterToolCallDetails

Información detallada sobre una invocación de intérprete de código por parte del modelo.

CodeInterpreterToolDefinition

La información de definición de entrada para una herramienta de intérprete de código tal como se usa para configurar un asistente.

CreateAndRunThreadOptions

Los detalles utilizados al crear y ejecutar inmediatamente un nuevo subproceso del asistente.

CreateAssistantFileOptions

Los detalles utilizados para crear un archivo de asistente.

CreateAssistantOptions

Los detalles utilizados para crear un asistente.

CreateMessageOptions

Los detalles utilizados para crear un mensaje.

CreateRunOptions

Los detalles utilizados al crear una nueva ejecución de un subproceso asistente.

CreateRunRequestOptions

Los detalles utilizados para crear una solicitud de ejecución.

CreateThreadAndRunOptions

Los detalles utilizados para crear y ejecutar un subproceso.

CreateThreadOptions

Los detalles utilizados para crear un hilo.

DeleteAssistantFileOptions

Los detalles utilizados para eliminar un archivo asistente.

DeleteAssistantOptions

Los detalles utilizados para eliminar un asistente.

DeleteFileOptions

Los detalles utilizados para eliminar archivos.

DeleteThreadOptions

Los detalles utilizados para eliminar un hilo.

DeletionStatus

Una representación abstracta del estado del resultado de una operación de eliminación de OpenAI.

FileDeletionStatus

Respuesta de estado de una operación de eliminación de archivos.

FileListResponse

Datos de respuesta de una operación de lista de archivos.

FunctionDefinition

Información de definición de entrada de una función.

FunctionToolCall

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.

FunctionToolCallDetails

Información detallada sobre la función a la que llama el modelo.

FunctionToolDefinition

La información de definición de entrada para una herramienta de función tal como se utiliza para configurar un asistente.

GetAssistantFileOptions

Los detalles utilizados para obtener un archivo asistente.

GetAssistantOptions

Los detalles utilizados para conseguir un asistente.

GetFileOptions

Los detalles utilizados para obtener archivos.

GetMessageFileOptions

Los detalles utilizados para obtener un archivo de mensaje.

GetMessageOptions

Los detalles utilizados para recibir un mensaje.

GetRunOptions

Los detalles utilizados para obtener una carrera.

GetRunStepOptions

Los detalles utilizados para obtener un paso de ejecución.

GetThreadOptions

Los detalles utilizados para obtener un hilo.

InputFile

Representa un asistente que puede llamar al modelo y usar herramientas.

ListAssistantFilesOptions

Los detalles utilizados para enumerar los archivos del asistente.

ListAssistantsOptions

Los detalles utilizados para enumerar a los asistentes.

ListFilesOptions

Los detalles utilizados para enumerar archivos.

ListMessageFilesOptions

Los detalles utilizados para enumerar los archivos de mensajes.

ListMessagesOptions

Los detalles utilizados para enumerar los mensajes.

ListResponseOf

Los datos de respuesta de una lista solicitada de elementos.

ListRunStepsOptions

Los detalles utilizados para enumerar los pasos de ejecución.

ListRunsOptions

Los detalles utilizados para enumerar las carreras.

MessageFile

Información sobre un archivo adjunto a un mensaje de subproceso del asistente.

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.

MessageTextContent

Representación de un elemento textual del contenido del mensaje de subproceso.

MessageTextDetails

El texto y las anotaciones asociadas para un solo elemento del contenido del mensaje del subproceso asistente.

MessageTextFileCitationAnnotation

Cita dentro del mensaje que apunta a una cita específica de un archivo específico asociado al asistente o al mensaje. Se genera cuando el asistente utiliza la herramienta de "recuperación" 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.

RequiredAction

Una representación abstracta de una acción necesaria para que continúe la ejecución de un subproceso asistente.

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.

RetrievalToolCall

Registro de una llamada a una herramienta de recuperación, emitida por el modelo en la evaluación de una herramienta definida, que representa acciones de recuperación ejecutadas.

RetrievalToolDefinition

La información de definición de entrada para una herramienta de recuperación tal como se usa para configurar un asistente.

RunError

Los detalles de un error encontrado por una ejecución de subproceso asistente.

RunStep

Información detallada sobre un solo paso de la ejecución de un subproceso asistente.

RunStepError

La información de error asociada a un paso de ejecución con errores.

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.

RunStepToolCallDetails

Información detallada asociada a una herramienta de llamada de paso de ejecución.

SubmitToolOutputsDetails

Detalles que describen las herramientas a las que se debe llamar para enviar las salidas de la herramienta.

SubmitToolOutputsToRunOptions

Los detalles utilizados para enviar salidas de herramientas a una ejecución.

ThreadDeletionStatus

Estado de una operación de eliminación de subprocesos.

ThreadMessage

Un único mensaje existente dentro de un hilo del asistente.

ThreadRun

Datos que representan una sola ejecución de evaluación de un subproceso asistente.

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.

UpdateAssistantOptions

Los detalles de la solicitud que se utilizarán al modificar un asistente existente.

UpdateAssistantRequestOptions

Los detalles utilizados para actualizar un asistente.

UpdateMessageOptions

Los detalles utilizados para actualizar un mensaje.

UpdateRunOptions

Los detalles utilizados para actualizar una ejecución.

UpdateThreadOptions

Los detalles utilizados para actualizar un subproceso.

UploadFileOptions

Los detalles utilizados para cargar archivos.

Alias de tipos

CodeInterpreterToolCallOutput

Alias para CodeInterpreterToolCallOutput

FilePurpose

"afinar", "ajustar resultados", "asistentes", "assistants_output"

ListSortOrder

"asc", "desc"

MessageContent

Alias para MessageContent

MessageRole

"usuario", "asistente"

MessageTextAnnotation

Alias para MessageTextAnnotation

RequiredToolCall

Alias de RequiredToolCall

RunStatus

"en cola", "in_progress", "requires_action", "cancelando", "cancelado", "fallido", "completado", "caducado"

RunStepDetails

Alias para RunStepDetails

RunStepErrorCode

"server_error", "rate_limit_exceeded"

RunStepStatus

"in_progress", "cancelado", "fallido", "completado", "caducado"

RunStepType

"message_creation", "tool_calls"

ToolCall

Alias de ToolCall

ToolDefinition

Una representación abstracta de una definición de herramienta de entrada que un asistente puede usar.