@azure/openai-assistants package

Classes

AssistantsClient	Gestion du client assistant opérations liées.
AzureKeyCredential	Informations d’identification basées sur une clé statique qui prend en charge la mise à jour de la valeur de clé sous-jacente.
OpenAIKeyCredential	La classe OpenAIKeyCredential représente une clé API OpenAI et est utilisée pour s’authentifier auprès d’un client Assistants pour un point de terminaison OpenAI.

Interfaces

Assistant	Représente une assistant qui peut appeler le modèle et utiliser des outils.
AssistantCreationOptions	Détails de la demande à utiliser lors de la création d’un assistant.
AssistantDeletionStatus	Status d’une opération de suppression de assistant.
AssistantFile	Informations sur un fichier joint à un assistant, telles qu’utilisées par les outils capables de lire des fichiers.
AssistantFileDeletionStatus	Status d’une opération de suppression de fichier assistant.
AssistantThread	Informations sur un thread unique associé à un assistant.
AssistantThreadCreationOptions	Détails utilisés pour créer un thread assistant.
AssistantsClientOptions	Détails utilisés pour créer un client assistant *
CancelRunOptions	Détails utilisés pour annuler une exécution.
CodeInterpreterImageOutput	Représentation d’une sortie d’image émise par un outil d’interpréteur de code en réponse à un appel d’outil par le modèle.
CodeInterpreterImageReference	Référence d’image émise par un outil d’interpréteur de code en réponse à un appel d’outil par le modèle.
CodeInterpreterLogOutput	Représentation d’une sortie de journal émise par un outil d’interpréteur de code en réponse à un appel d’outil par le modèle.
CodeInterpreterToolCall	Enregistrement d’un appel à un outil d’interpréteur de code, émis par le modèle dans l’évaluation d’un outil défini, qui représente les entrées et les sorties consommées et émises par l’interpréteur de code.
CodeInterpreterToolCallDetails	Informations détaillées sur l’appel d’un interpréteur de code par le modèle.
CodeInterpreterToolDefinition	Informations de définition d’entrée pour un outil d’interpréteur de code utilisés pour configurer un assistant.
CreateAndRunThreadOptions	Détails utilisés lors de la création et de l’exécution immédiate d’un nouveau thread assistant.
CreateAssistantFileOptions	Détails utilisés pour créer un fichier assistant.
CreateAssistantOptions	Détails utilisés pour créer un assistant.
CreateMessageOptions	Détails utilisés pour créer un message.
CreateRunOptions	Détails utilisés lors de la création d’une nouvelle exécution d’un thread assistant.
CreateRunRequestOptions	Détails utilisés pour créer une demande d’exécution.
CreateThreadAndRunOptions	Détails utilisés pour créer et exécuter un thread.
CreateThreadOptions	Détails utilisés pour créer un thread.
DeleteAssistantFileOptions	Détails utilisés pour supprimer un fichier assistant.
DeleteAssistantOptions	Détails utilisés pour supprimer un assistant.
DeleteFileOptions	Détails utilisés pour supprimer des fichiers.
DeleteThreadOptions	Détails utilisés pour supprimer un thread.
DeletionStatus	Représentation abstraite d’un résultat d’opération de suppression OpenAI status.
FileDeletionStatus	Réponse status d’une opération de suppression de fichier.
FileListResponse	Données de réponse d’une opération de liste de fichiers.
FunctionDefinition	Informations de définition d’entrée pour une fonction.
FunctionToolCall	Enregistrement d’un appel à un outil de fonction, émis par le modèle dans l’évaluation d’un outil défini, qui représente les entrées et la sortie consommées et émises par la fonction spécifiée.
FunctionToolCallDetails	Informations détaillées sur la fonction appelée par le modèle.
FunctionToolDefinition	Informations de définition d’entrée pour un outil de fonction utilisés pour configurer un assistant.
GetAssistantFileOptions	Détails utilisés pour obtenir un fichier assistant.
GetAssistantOptions	Détails utilisés pour obtenir un assistant.
GetFileOptions	Détails utilisés pour obtenir les fichiers.
GetMessageFileOptions	Détails utilisés pour obtenir un fichier de message.
GetMessageOptions	Détails utilisés pour obtenir un message.
GetRunOptions	Détails utilisés pour obtenir une exécution.
GetRunStepOptions	Détails utilisés pour obtenir une étape d’exécution.
GetThreadOptions	Détails utilisés pour obtenir un thread.
InputFile	Représente une assistant qui peut appeler le modèle et utiliser des outils.
ListAssistantFilesOptions	Détails utilisés pour répertorier assistant fichiers.
ListAssistantsOptions	Détails utilisés pour répertorier les assistants.
ListFilesOptions	Détails utilisés pour répertorier les fichiers.
ListMessageFilesOptions	Détails utilisés pour répertorier les fichiers de messages.
ListMessagesOptions	Détails utilisés pour répertorier les messages.
ListResponseOf	Données de réponse pour une liste d’éléments demandée.
ListRunStepsOptions	Détails utilisés pour répertorier les étapes d’exécution.
ListRunsOptions	Détails utilisés pour répertorier les exécutions.
MessageFile	Informations sur un fichier joint à un message de thread assistant.
MessageImageFileContent	Représentation du contenu du fichier image dans un message de thread.
MessageImageFileDetails	Référence d’image, telle que représentée dans le contenu du message de thread.
MessageTextContent	Représentation d’un élément textuel du contenu du message de thread.
MessageTextDetails	Texte et annotations associées pour un seul élément de assistant contenu du message de thread.
MessageTextFileCitationAnnotation	Citation dans le message qui pointe vers un guillemet spécifique d’un fichier spécifique associé au assistant ou au message. Généré lorsque le assistant utilise l’outil « récupération » pour rechercher des fichiers.
MessageTextFileCitationDetails	Représentation d’une citation de texte basée sur un fichier, telle qu’elle est utilisée dans une annotation basée sur un fichier du contenu de message de thread de texte.
MessageTextFilePathAnnotation	Citation dans le message qui pointe vers un fichier situé sur un chemin spécifique.
MessageTextFilePathDetails	Encapsulation d’un ID de fichier image, tel qu’utilisé par le contenu de l’image de message.
RequiredAction	Représentation abstraite d’une action requise pour qu’un thread assistant continue.
RequiredFunctionToolCall	Représentation d’un appel demandé à un outil de fonction, nécessaire au modèle pour poursuivre l’évaluation d’une exécution.
RetrievalToolCall	Enregistrement d’un appel à un outil de récupération, émis par le modèle dans l’évaluation d’un outil défini, qui représente des actions de récupération exécutées.
RetrievalToolDefinition	Informations de définition d’entrée pour un outil de récupération utilisés pour configurer un assistant.
RunError	Détails d’une erreur rencontrée par une exécution de thread assistant.
RunStep	Informations détaillées sur une étape unique d’une exécution de thread assistant.
RunStepError	Informations d’erreur associées à une étape d’exécution ayant échoué.
RunStepMessageCreationDetails	Informations détaillées associées à une étape de création de message.
RunStepMessageCreationReference	Détails d’un message créé dans le cadre d’une étape d’exécution.
RunStepToolCallDetails	Informations détaillées associées à une étape d’exécution appelant des outils.
SubmitToolOutputsDetails	Détails décrivant les outils qui doivent être appelés pour envoyer des sorties d’outil.
SubmitToolOutputsToRunOptions	Détails utilisés pour envoyer des sorties d’outil à une exécution.
ThreadDeletionStatus	Status d’une opération de suppression de thread.
ThreadMessage	Message unique existant dans un thread assistant.
ThreadRun	Données représentant une seule exécution d’évaluation d’un thread assistant.
ToolOutput	Les données fournies lors d’une soumission d’outil permettent de résoudre les appels d’outils en attente et de permettre au modèle de continuer.
UpdateAssistantOptions	Détails de la demande à utiliser lors de la modification d’un assistant existant.
UpdateAssistantRequestOptions	Détails utilisés pour mettre à jour un assistant.
UpdateMessageOptions	Détails utilisés pour mettre à jour un message.
UpdateRunOptions	Détails utilisés pour mettre à jour une exécution.
UpdateThreadOptions	Détails utilisés pour mettre à jour un thread.
UploadFileOptions	Détails utilisés pour charger des fichiers.

Alias de type

CodeInterpreterToolCallOutput	Alias pour CodeInterpreterToolCallOutput
FilePurpose	« affiner », « affiner-régler-résultats », « assistants », « assistants_output »
ListSortOrder	« asc », « desc »
MessageContent	Alias pour MessageContent
MessageRole	« user », « assistant »
MessageTextAnnotation	Alias pour MessageTextAnnotation
RequiredToolCall	Alias pour RequiredToolCall
RunStatus	« queued », « in_progress », « requires_action », « cancelling », « cancelled », « failed », « completed », « expired »
RunStepDetails	Alias pour RunStepDetails
RunStepErrorCode	« server_error », « rate_limit_exceeded »
RunStepStatus	« in_progress », « cancelled », « failed », « completed », « expired »
RunStepType	« message_creation », « tool_calls »
ToolCall	Alias pour ToolCall
ToolDefinition	Représentation abstraite d’une définition d’outil d’entrée qu’un assistant peut utiliser.