Compartir a través de


@azure/openai-assistants package

Clases

AssistantsClient

Control de clientes asistente operaciones relacionadas.

AzureKeyCredential

Una 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 usarán al crear un nuevo asistente.

AssistantDeletionStatus

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

AssistantFile

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

AssistantFileDeletionStatus

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

AssistantThread

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

AssistantThreadCreationOptions

Los detalles usados para crear un nuevo subproceso de asistente.

AssistantsClientOptions

Los detalles usados para crear un cliente de asistente *

CancelRunOptions

Los detalles usados 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 parte del modelo.

CodeInterpreterImageReference

Referencia de imagen emitida por una herramienta de intérprete de código en respuesta a una llamada de herramienta por parte del 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 parte del 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 del intérprete de código por parte del modelo.

CodeInterpreterToolDefinition

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

CreateAndRunThreadOptions

Los detalles usados al crear e ejecutar inmediatamente un nuevo subproceso de asistente.

CreateAssistantFileOptions

Los detalles usados para crear un archivo asistente.

CreateAssistantOptions

Los detalles usados para crear un asistente.

CreateMessageOptions

Los detalles usados para crear un mensaje.

CreateRunOptions

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

CreateRunRequestOptions

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

CreateThreadAndRunOptions

Los detalles usados para crear y ejecutar un subproceso.

CreateThreadOptions

Los detalles usados para crear un subproceso.

DeleteAssistantFileOptions

Los detalles usados para eliminar un archivo asistente.

DeleteAssistantOptions

Los detalles usados para eliminar un asistente.

DeleteFileOptions

Los detalles usados para eliminar archivos.

DeleteThreadOptions

Los detalles usados para eliminar un subproceso.

DeletionStatus

Representación abstracta de un estado de resultado de la operación de eliminación de OpenAI.

FileDeletionStatus

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

FileListResponse

Los 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 la salida consumidas y emitidas por la función especificada.

FunctionToolCallDetails

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

FunctionToolDefinition

Información de definición de entrada de una herramienta de función que se usa para configurar un asistente.

GetAssistantFileOptions

Los detalles usados para obtener un archivo asistente.

GetAssistantOptions

Los detalles usados para obtener un asistente.

GetFileOptions

Los detalles usados para obtener archivos.

GetMessageFileOptions

Los detalles usados para obtener un archivo de mensaje.

GetMessageOptions

Los detalles usados para obtener un mensaje.

GetRunOptions

Los detalles usados para obtener una ejecución.

GetRunStepOptions

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

GetThreadOptions

Los detalles usados para obtener un subproceso.

InputFile

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

ListAssistantFilesOptions

Los detalles usados para enumerar asistente archivos.

ListAssistantsOptions

Los detalles usados para enumerar asistentes.

ListFilesOptions

Los detalles usados para enumerar archivos.

ListMessageFilesOptions

Los detalles usados para enumerar los archivos de mensajes.

ListMessagesOptions

Los detalles usados para enumerar los mensajes.

ListResponseOf

Los datos de respuesta de una lista solicitada de elementos.

ListRunStepsOptions

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

ListRunsOptions

Los detalles usados para enumerar ejecuciones.

MessageFile

Información sobre un archivo adjunto a un mensaje de subproceso 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

Texto y anotaciones asociadas para un único elemento de asistente contenido del mensaje de subproceso.

MessageTextFileCitationAnnotation

Cita dentro del mensaje que apunta a una cita específica de un archivo específico asociado con el asistente o el mensaje. Se genera cuando el asistente usa la herramienta "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, tal como lo usa el contenido de la imagen del mensaje.

RequiredAction

Representación abstracta de una acción necesaria para que se ejecute un subproceso de asistente 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.

RetrievalToolCall

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

RetrievalToolDefinition

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

RunError

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

RunStep

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

RunStepError

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

Los detalles de un mensaje creado como parte de un paso de ejecución.

RunStepToolCallDetails

Información detallada asociada a las herramientas de llamada de pasos de ejecución.

SubmitToolOutputsDetails

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

SubmitToolOutputsToRunOptions

Los detalles usados para enviar salidas de herramienta a una ejecución.

ThreadDeletionStatus

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

ThreadMessage

Un único mensaje existente dentro de un subproceso de asistente.

ThreadRun

Datos que representan una sola ejecución de evaluación de un subproceso de 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

Detalles de la solicitud que se van a usar al modificar un asistente existente.

UpdateAssistantRequestOptions

Los detalles usados para actualizar un asistente.

UpdateMessageOptions

Los detalles usados para actualizar un mensaje.

UpdateRunOptions

Los detalles usados para actualizar una ejecución.

UpdateThreadOptions

Los detalles usados para actualizar un subproceso.

UploadFileOptions

Los detalles usados para cargar archivos.

Alias de tipos

CodeInterpreterToolCallOutput

Alias de CodeInterpreterToolCallOutput

FilePurpose

"fine-tune", "fine-tune-results", "assistants", "assistants_output"

ListSortOrder

"asc", "desc"

MessageContent

Alias para MessageContent

MessageRole

"user", "asistente"

MessageTextAnnotation

Alias para MessageTextAnnotation

RequiredToolCall

Alias para RequiredToolCall

RunStatus

"queued", "in_progress", "requires_action", "cancelling", "cancelled", "failed", "completed", "expired"

RunStepDetails

Alias para RunStepDetails

RunStepErrorCode

"server_error", "rate_limit_exceeded"

RunStepStatus

"in_progress", "canceled", "failed", "completed", "expired"

RunStepType

"message_creation", "tool_calls"

ToolCall

Alias de ToolCall

ToolDefinition

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