AssistantsClient class

Initialise une instance d’AssistantsClient pour une utilisation avec le point de terminaison OpenAI non Azure.

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

Paramètres

Remarques

Les objets AssistantsClient initialisés avec ce constructeur ne peuvent être utilisés qu’avec le point de terminaison d’inférence OpenAI non Azure. Pour utiliser AssistantsClient avec une ressource Azure OpenAI, utilisez un constructeur qui accepte plutôt un URI de ressource et des informations d’identification d’authentification Azure.

Initialise un instance d’AssistantsClient pour une utilisation avec une ressource OpenAI.

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

Paramètres

Remarques

Ce constructeur initialise un objet AssistantsClient qui ne peut être utilisé qu’avec des ressources Azure OpenAI. Pour utiliser AssistantsClient avec un point de terminaison d’inférence Non-Azure OpenAI, utilisez un constructeur qui accepte une clé d’API OpenAI non-Azure à la place.

Initialise une instance d’AssistantsClient pour une utilisation avec une ressource Azure OpenAI.

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

Paramètres

Pipeline utilisé par ce client pour effectuer des requêtes

pipeline: Pipeline

Valeur de propriété

Annule une exécution d’un thread en cours.

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

Paramètres

Retours

Crée un assistant.

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

Paramètres

Retours

Joint un fichier précédemment chargé à un assistant à utiliser par des outils capables de lire des fichiers.

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

Paramètres

Retours

Crée un message sur un thread spécifié.

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

Paramètres

Retours

Crée une nouvelle exécution pour un thread assistant.

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

Paramètres

Retours

Crée un thread. Les threads contiennent des messages et peuvent être exécutés par des assistants.

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

Paramètres

Retours

Crée un thread assistant et démarre immédiatement une exécution à l’aide de ce nouveau thread.

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

Paramètres

Retours

Supprime un assistant.

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

Paramètres

Retours

Dissocie un fichier précédemment attaché d’un assistant, le rendant indisponible pour une utilisation par les outils capables de lire des fichiers.

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

Paramètres

Retours

Supprimez un fichier précédemment chargé.

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

Paramètres

Retours

Supprime un thread existant.

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

Paramètres

Retours

Récupère un assistant existant.

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

Paramètres

Retours

Récupère un fichier joint à un assistant.

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

Paramètres

Retours

Retourne des informations sur un fichier spécifique. Ne récupère pas le contenu du fichier.

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

Paramètres

Retours

Obtient un message existant à partir d’un thread existant.

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

Paramètres

Retours

Obtient des informations sur une pièce jointe à un message dans un thread.

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

Paramètres

Retours

Obtient une exécution existante à partir d’un thread existant.

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

Paramètres

Retours

Obtient une seule étape d’exécution à partir d’une exécution de thread.

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

Paramètres

Retours

Obtient des informations sur un thread existant.

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

Paramètres

Retours

Obtient la liste des fichiers joints à un assistant spécifique, tel qu’utilisé par les outils qui peuvent lire des fichiers.

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

Paramètres

Retours

Obtient la liste des assistants qui ont été créés précédemment.

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

Paramètres

Retours

Obtient une liste des fichiers précédemment chargés.

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

Paramètres

Retours

Obtient une liste des fichiers précédemment chargés associés à un message à partir d’un thread.

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

Paramètres

Retours

Obtient la liste des messages qui existent sur un thread.

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

Paramètres

Retours

Obtient une liste d’exécutions pour un thread spécifié.

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

Paramètres

Retours

Obtient la liste des étapes d’exécution d’une exécution de thread.

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

Paramètres

Retours

Envoie les sorties des outils comme demandé par les appels d’outils dans une exécution. Les exécutions qui nécessitent des sorties d’outil soumises auront un status de « requires_action » avec un required_action.type de « submit_tool_outputs ».

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

Paramètres

Retours

Modifie un assistant existant.

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

Paramètres

Retours

Modifie un message existant sur un thread existant.

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

Paramètres

Retours

Modifie une exécution de thread existante.

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

Paramètres

Retours

Modifie un thread existant.

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

Paramètres

Retours

Charge un fichier à utiliser par d’autres opérations.

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

Paramètres

Retours