@azure/openai-assistants package
Classes
| AssistantsClient |
Opérations liées à l’assistant de manutention du client. |
| AzureKeyCredential |
Informations d’identification statiques basées sur une clé qui prend en charge la mise à jour de la valeur de clé sous-jacente. |
| OpenAIKeyCredential |
La classe OpenAIKeyCredential représente une clé d’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 un 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 |
Statut d’une opération de suppression de l’assistant. |
| AssistantFile |
Informations sur un fichier joint à un assistant, telles qu’elles sont utilisées par les outils capables de lire les fichiers. |
| AssistantFileDeletionStatus |
État d’une opération de suppression de fichier de l’assistant. |
| AssistantThread |
Informations sur un seul thread associé à un assistant. |
| AssistantThreadCreationOptions |
Détails utilisés pour créer un nouveau fil d’assistant. |
| AssistantsClientOptions |
Détails utilisés pour créer un client Assistant * |
| CancelRunOptions |
Détails utilisés pour annuler une course. |
| 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 lors de l’évaluation d’un outil défini, qui représente les entrées et sorties consommées et émises par l’interpréteur de code. |
| CodeInterpreterToolCallDetails |
Informations détaillées sur un appel d’interpréteur de code par le modèle. |
| CodeInterpreterToolDefinition |
Informations de définition d’entrée pour un outil d’interprétation de code utilisé pour configurer un assistant. |
| CreateAndRunThreadOptions |
Les détails utilisés lors de la création et de l’exécution immédiate d’un nouveau fil d’assistant. |
| CreateAssistantFileOptions |
Détails utilisés pour créer un fichier d’assistant. |
| CreateAssistantOptions |
Les 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 d’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 fil de discussion. |
| CreateThreadOptions |
Détails utilisés pour créer un fil. |
| DeleteAssistantFileOptions |
Détails utilisés pour supprimer un fichier d’assistant. |
| DeleteAssistantOptions |
Les détails utilisés pour supprimer un assistant. |
| DeleteFileOptions |
Les détails utilisés pour supprimer des fichiers. |
| DeleteThreadOptions |
Les détails utilisés pour supprimer un fil. |
| DeletionStatus |
Représentation abstraite de l’état du résultat d’une opération de suppression OpenAI. |
| FileDeletionStatus |
Réponse d’état 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 lors de l’évaluation d’un outil défini, qui représente les entrées et 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 d’un outil de fonction utilisé pour configurer un assistant. |
| GetAssistantFileOptions |
Les détails utilisés pour obtenir un fichier d’assistant. |
| GetAssistantOptions |
Les détails utilisés pour obtenir un assistant. |
| GetFileOptions |
Les détails utilisés pour obtenir des fichiers. |
| GetMessageFileOptions |
Détails utilisés pour obtenir un fichier de message. |
| GetMessageOptions |
Les détails utilisés pour obtenir un message. |
| GetRunOptions |
Les détails utilisés pour obtenir une course. |
| GetRunStepOptions |
Les détails utilisés pour obtenir une étape d’exécution. |
| GetThreadOptions |
Les détails utilisés pour obtenir un fil. |
| InputFile |
Représente un assistant qui peut appeler le modèle et utiliser des outils. |
| ListAssistantFilesOptions |
Détails utilisés pour répertorier les fichiers de l’assistant. |
| ListAssistantsOptions |
Les détails utilisés pour répertorier les assistants. |
| ListFilesOptions |
Les 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 fil de discussion de l’assistant. |
| MessageImageFileContent |
Représentation du contenu du fichier image dans un message de thread. |
| MessageImageFileDetails |
Référence d’image, telle qu’elle est représentée dans le contenu du message de thread. |
| MessageTextContent |
Représentation d’un élément textuel de contenu de message de thread. |
| MessageTextDetails |
Texte et annotations associées pour un seul élément du contenu du message de fil de discussion de l’assistant. |
| MessageTextFileCitationAnnotation |
Une citation dans le message qui pointe vers une citation spécifique d’un fichier spécifique associé à l’Assistant ou au message. Généré lorsque l’assistant utilise l’outil de recherche de fichiers. |
| MessageTextFileCitationDetails |
Représentation d’une citation de texte basée sur un fichier, telle qu’utilisée dans une annotation basée sur un fichier de contenu de message de thread de texte. |
| MessageTextFilePathAnnotation |
Citation dans le message qui pointe vers un fichier situé à un chemin d’accès 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 d’assistant se poursuive. |
| RequiredFunctionToolCall |
Représentation d’un appel demandé à un outil de fonction, nécessaire par le modèle pour poursuivre l’évaluation d’une exécution. |
| RetrievalToolCall |
Enregistrement d’un appel à un outil d’extraction, émis par le modèle en évaluation d’un outil défini, qui représente les actions d’extraction exécutées. |
| RetrievalToolDefinition |
Informations de définition d’entrée d’un outil d’extraction utilisé pour configurer un assistant. |
| RunError |
Détails d’une erreur rencontrée par l’exécution d’un thread d’assistant. |
| RunStep |
Informations détaillées sur une seule étape de l’exécution d’un thread d’assistant. |
| RunStepError |
Informations d’erreur associées à une étape d’exécution ayant échoué. |
| RunStepMessageCreationDetails |
Informations détaillées associées à une étape d’exécution 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 à des outils d’appel d’étape d’exécution. |
| SubmitToolOutputsDetails |
Détails décrivant les outils qui doivent être appelés pour envoyer des sorties d’outil. |
| SubmitToolOutputsToRunOptions |
Détails utilisés pour soumettre les sorties d’outil à une exécution. |
| ThreadDeletionStatus |
État d’une opération de suppression de thread. |
| ThreadMessage |
Un message unique existant dans un fil d’assistant. |
| ThreadRun |
Données représentant une seule exécution d’évaluation d’un thread d’assistant. |
| ToolOutput |
Les données fournies lors d’une soumission d’outil génère une soumission pour résoudre les appels d’outils en attente et 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 fil. |
| UploadFileOptions |
Les détails utilisés pour télécharger les fichiers. |
Alias de type
| CodeInterpreterToolCallOutput |
Alias de CodeInterpreterToolCallOutput |
| FilePurpose |
« Fine-Tune », « Fine-Tune-Results », « Assistants », « assistants_output » |
| ListSortOrder |
« asc », « desc » |
| MessageContent |
Alias de MessageContent |
| MessageRole |
« utilisateur », « assistant » |
| MessageTextAnnotation |
Alias de MessageTextAnnotation |
| RequiredToolCall |
Alias de RequiredToolCall |
| RunStatus |
« en file d’attente », « in_progress », « requires_action », « annulation », « annulé », « échec », « terminé », « expiré » |
| RunStepDetails |
Alias de RunStepDetails |
| RunStepErrorCode |
« server_error », « rate_limit_exceeded » |
| RunStepStatus |
« in_progress », « annulé », « échoué », « terminé », « expiré » |
| RunStepType |
« message_creation », « tool_calls » |
| ToolCall |
Alias pour ToolCall |
| ToolDefinition |
Représentation abstraite d’une définition d’outil de saisie qu’un assistant peut utiliser. |
