AssistantsClient class

Inicializa una instancia de AssistantsClient para su uso con el punto de conexión de OpenAI que no es de Azure.

new AssistantsClient(openAiApiKey: KeyCredential, options?: AssistantsClientOptions)

Parámetros

Comentarios

Los objetos AssistantsClient inicializados con este constructor solo se pueden usar con el punto de conexión de inferencia de OpenAI que no es de Azure. Para usar AssistantsClient con un recurso de Azure OpenAI, use un constructor que acepte un URI de recurso y una credencial de autenticación de Azure en su lugar.

Inicializa una instancia de AssistantsClient para su uso con un recurso openAI.

new AssistantsClient(endpoint: string, credential: KeyCredential, options?: AssistantsClientOptions)

Parámetros

Comentarios

Este constructor inicializa un objeto AssistantsClient que solo se puede usar con recursos de Azure OpenAI. Para usar AssistantsClient con un punto de conexión de inferencia de OpenAI que no sea de Azure, use un constructor que acepte una clave de API openAI que no sea de Azure.

Inicializa una instancia de AssistantsClient para su uso con un recurso de Azure OpenAI.

new AssistantsClient(endpoint: string, credential: TokenCredential, options?: AssistantsClientOptions)

Parámetros

Canalización usada por este cliente para realizar solicitudes

pipeline: Pipeline

Valor de propiedad

Cancela una ejecución de un subproceso en curso.

function cancelRun(threadId: string, runId: string, options?: CancelRunOptions): Promise<ThreadRun>

Parámetros

Devoluciones

Crea un nuevo asistente.

function createAssistant(body: AssistantCreationOptions, options?: CreateAssistantOptions): Promise<Assistant>

Parámetros

Devoluciones

Adjunta un archivo cargado previamente a un asistente para que lo usen las herramientas que pueden leer archivos.

function createAssistantFile(assistantId: string, fileId: string, options?: CreateAssistantFileOptions): Promise<AssistantFile>

Parámetros

Devoluciones

Crea un nuevo mensaje en un subproceso especificado.

function createMessage(threadId: string, role: string, content: string, options?: CreateMessageOptions): Promise<ThreadMessage>

Parámetros

Devoluciones

Crea una nueva ejecución para un subproceso de asistente.

function createRun(threadId: string, createRunOptions: CreateRunOptions, options?: CreateRunRequestOptions): Promise<ThreadRun>

Parámetros

Devoluciones

Crea un subproceso. Los subprocesos contienen mensajes y los asistentes pueden ejecutarlos.

function createThread(body?: AssistantThreadCreationOptions, options?: CreateThreadOptions): Promise<AssistantThread>

Parámetros

Devoluciones

Crea un nuevo subproceso de asistente e inicia inmediatamente una ejecución con ese nuevo subproceso.

function createThreadAndRun(body: CreateAndRunThreadOptions, options?: CreateThreadAndRunOptions): Promise<ThreadRun>

Parámetros

Devoluciones

Elimina un asistente.

function deleteAssistant(assistantId: string, options?: DeleteAssistantOptions): Promise<AssistantDeletionStatus>

Parámetros

Devoluciones

Desvincula un archivo adjunto previamente de un asistente, lo que lo representa para que lo usen las herramientas que pueden leer archivos.

function deleteAssistantFile(assistantId: string, fileId: string, options?: DeleteAssistantFileOptions): Promise<AssistantFileDeletionStatus>

Parámetros

Devoluciones

Elimine un archivo cargado anteriormente.

function deleteFile(fileId: string, options?: DeleteFileOptions): Promise<FileDeletionStatus>

Parámetros

Devoluciones

Elimina un subproceso existente.

function deleteThread(threadId: string, options?: DeleteThreadOptions): Promise<ThreadDeletionStatus>

Parámetros

Devoluciones

Recupera un asistente existente.

function getAssistant(assistantId: string, options?: GetAssistantOptions): Promise<Assistant>

Parámetros

Devoluciones

Recupera un archivo adjunto a un asistente.

function getAssistantFile(assistantId: string, fileId: string, options?: GetAssistantFileOptions): Promise<AssistantFile>

Parámetros

Devoluciones

Devuelve información sobre un archivo específico. No recupera el contenido del archivo.

function getFile(fileId: string, options?: GetFileOptions): Promise<InputFile>

Parámetros

Devoluciones

Obtiene un mensaje existente de un subproceso existente.

function getMessage(threadId: string, messageId: string, options?: GetMessageOptions): Promise<ThreadMessage>

Parámetros

Devoluciones

Obtiene información sobre los datos adjuntos de un archivo a un mensaje dentro de un subproceso.

function getMessageFile(threadId: string, messageId: string, fileId: string, options?: GetMessageFileOptions): Promise<MessageFile>

Parámetros

Devoluciones

Obtiene una ejecución existente desde un subproceso existente.

function getRun(threadId: string, runId: string, options?: GetRunOptions): Promise<ThreadRun>

Parámetros

Devoluciones

Obtiene un solo paso de ejecución de una ejecución de una ejecución de subprocesos.

function getRunStep(threadId: string, runId: string, stepId: string, options?: GetRunStepOptions): Promise<RunStep>

Parámetros

Devoluciones

Obtiene información sobre un subproceso existente.

function getThread(threadId: string, options?: GetThreadOptions): Promise<AssistantThread>

Parámetros

Devoluciones

Obtiene una lista de archivos adjuntos a un asistente específico, tal como lo usan las herramientas que pueden leer archivos.

function listAssistantFiles(assistantId: string, options?: ListAssistantFilesOptions): Promise<ListResponseOf<AssistantFile>>

Parámetros

Devoluciones

Obtiene una lista de asistentes creados anteriormente.

function listAssistants(options?: ListAssistantsOptions): Promise<ListResponseOf<Assistant>>

Parámetros

Devoluciones

Obtiene una lista de archivos cargados previamente.

function listFiles(options?: ListFilesOptions): Promise<FileListResponse>

Parámetros

Devoluciones

Obtiene una lista de archivos cargados previamente asociados a un mensaje de un subproceso.

function listMessageFiles(threadId: string, messageId: string, options?: ListMessageFilesOptions): Promise<ListResponseOf<MessageFile>>

Parámetros

Devoluciones

Obtiene una lista de mensajes que existen en un subproceso.

function listMessages(threadId: string, options?: ListMessagesOptions): Promise<ListResponseOf<ThreadMessage>>

Parámetros

Devoluciones

Obtiene una lista de ejecuciones para un subproceso especificado.

function listRuns(threadId: string, options?: ListRunsOptions): Promise<ListResponseOf<ThreadRun>>

Parámetros

Devoluciones

Obtiene una lista de pasos de ejecución de una ejecución de subprocesos.

function listRunSteps(threadId: string, runId: string, options?: ListRunStepsOptions): Promise<ListResponseOf<RunStep>>

Parámetros

Devoluciones

Envía salidas de las herramientas solicitadas por las llamadas de herramienta en una ejecución. Las ejecuciones que necesitan salidas de herramienta enviadas tendrán el estado "requires_action" con un required_action.type de "submit_tool_outputs".

function submitToolOutputsToRun(threadId: string, runId: string, toolOutputs: ToolOutput[], options?: SubmitToolOutputsToRunOptions): Promise<ThreadRun>

Parámetros

Devoluciones

Modifica un asistente existente.

function updateAssistant(assistantId: string, body: UpdateAssistantOptions, options?: UpdateAssistantRequestOptions): Promise<Assistant>

Parámetros

Devoluciones

Modifica un mensaje existente en un subproceso existente.

function updateMessage(threadId: string, messageId: string, options?: UpdateMessageOptions): Promise<ThreadMessage>

Parámetros

Devoluciones

Modifica una ejecución de subproceso existente.

function updateRun(threadId: string, runId: string, options?: UpdateRunOptions): Promise<ThreadRun>

Parámetros

Devoluciones

Modifica un subproceso existente.

function updateThread(threadId: string, options?: UpdateThreadOptions): Promise<AssistantThread>

Parámetros

Devoluciones

Carga un archivo para que lo usen otras operaciones.

function uploadFile(file: Uint8Array, purpose: string, options?: UploadFileOptions): Promise<InputFile>

Parámetros

Devoluciones