@azure/openai-assistants package

Классы

AssistantsClient	Клиент обрабатывает операции, связанные с помощник.
AzureKeyCredential	Учетные данные на основе статического ключа, поддерживающие обновление значения базового ключа.
OpenAIKeyCredential	Класс OpenAIKeyCredential представляет ключ API OpenAI и используется для проверки подлинности в клиенте Помощников для конечной точки OpenAI.

Интерфейсы

Assistant	Представляет помощник, который может вызывать модель и использовать средства.
AssistantCreationOptions	Сведения о запросе для использования при создании нового помощник.
AssistantDeletionStatus	Состояние операции удаления помощник.
AssistantFile	Сведения о файле, присоединенном к помощник, используемые средствами, которые могут считывать файлы.
AssistantFileDeletionStatus	Состояние операции удаления файла помощник.
AssistantThread	Сведения об одном потоке, связанном с помощник.
AssistantThreadCreationOptions	Сведения, используемые для создания нового потока помощник.
AssistantsClientOptions	Сведения, используемые для создания клиента помощник *
CancelRunOptions	Сведения, используемые для отмены выполнения.
CodeInterpreterImageOutput	Представление выходных данных изображения, выдаваемых интерпретатором кода в ответ на вызов средства моделью.
CodeInterpreterImageReference	Ссылка на изображение, выдаваемая интерпретатором кода в ответ на вызов средства моделью.
CodeInterpreterLogOutput	Представление выходных данных журнала, создаваемых интерпретатором кода в ответ на вызов средства моделью.
CodeInterpreterToolCall	Запись вызова средства интерпретатора кода, выданная моделью при оценке определенного средства, которая представляет входные и выходные данные, потребляемые и создаваемые интерпретатором кода.
CodeInterpreterToolCallDetails	Подробные сведения о вызове интерпретатора кода моделью.
CodeInterpreterToolDefinition	Входные сведения об определении для средства интерпретатора кода, используемые для настройки помощник.
CreateAndRunThreadOptions	Сведения, используемые при создании и немедленном запуске нового потока помощник.
CreateAssistantFileOptions	Сведения, используемые для создания файла помощник.
CreateAssistantOptions	Сведения, используемые для создания помощник.
CreateMessageOptions	Сведения, используемые для создания сообщения.
CreateRunOptions	Сведения, используемые при создании нового запуска потока помощник.
CreateRunRequestOptions	Сведения, используемые для создания запроса на выполнение.
CreateThreadAndRunOptions	Сведения, используемые для создания и запуска потока.
CreateThreadOptions	Сведения, используемые для создания потока.
DeleteAssistantFileOptions	Сведения, используемые для удаления файла помощник.
DeleteAssistantOptions	Сведения, используемые для удаления помощник.
DeleteFileOptions	Сведения, используемые для удаления файлов.
DeleteThreadOptions	Сведения, используемые для удаления потока.
DeletionStatus	Абстрактное представление состояния результата операции удаления OpenAI.
FileDeletionStatus	Ответ о состоянии операции удаления файла.
FileListResponse	Данные ответа из операции со списком файлов.
FunctionDefinition	Входные сведения об определении для функции.
FunctionToolCall	Запись вызова средства-функции, выданная моделью при оценке определенного средства, представляющая входные и выходные данные, потребляемые и создаваемые указанной функцией.
FunctionToolCallDetails	Подробные сведения о функции, вызванной моделью.
FunctionToolDefinition	Входные сведения об определении для средства функции, используемые для настройки помощник.
GetAssistantFileOptions	Сведения, используемые для получения файла помощник.
GetAssistantOptions	Сведения, используемые для получения помощник.
GetFileOptions	Сведения, используемые для получения файлов.
GetMessageFileOptions	Сведения, используемые для получения файла сообщения.
GetMessageOptions	Сведения, используемые для получения сообщения.
GetRunOptions	Сведения, используемые для получения запуска.
GetRunStepOptions	Сведения, используемые для получения шага выполнения.
GetThreadOptions	Сведения, используемые для получения потока.
InputFile	Представляет помощник, который может вызывать модель и использовать средства.
ListAssistantFilesOptions	Сведения, используемые для перечисления помощник файлов.
ListAssistantsOptions	Сведения, используемые для перечисления помощников.
ListFilesOptions	Сведения, используемые для вывода списка файлов.
ListMessageFilesOptions	Сведения, используемые для вывода списка файлов сообщений.
ListMessagesOptions	Сведения, используемые для вывода списка сообщений.
ListResponseOf	Данные ответа для запрошенного списка элементов.
ListRunStepsOptions	Сведения, используемые для перечисления шагов выполнения.
ListRunsOptions	Сведения, используемые для перечисления запусков.
MessageFile	Сведения о файле, присоединенном к сообщению потока помощник.
MessageImageFileContent	Представление содержимого файла изображения в сообщении потока.
MessageImageFileDetails	Ссылка на изображение, представленная в содержимом сообщения потока.
MessageTextContent	Представление текстового элемента содержимого сообщения потока.
MessageTextDetails	Текст и связанные заметки для одного элемента помощник содержимого сообщения потока.
MessageTextFileCitationAnnotation	Ссылка в сообщении, указывающая на определенную цитату из определенного файла, связанного с помощник или сообщением. Создается, когда помощник использует средство извлечения для поиска файлов.
MessageTextFileCitationDetails	Представление текстовой ссылки на основе файла, используемой в заметке на основе файла содержимого сообщения текстового потока.
MessageTextFilePathAnnotation	Ссылка в сообщении, указывающая на файл, расположенный по определенному пути.
MessageTextFilePathDetails	Инкапсуляция идентификатора файла изображения, используемого содержимым изображения сообщения.
RequiredAction	Абстрактное представление требуемого действия для продолжения выполнения потока помощник.
RequiredFunctionToolCall	Представление запрошенного вызова средства-функции, необходимого модели для продолжения оценки выполнения.
RetrievalToolCall	Запись вызова средства извлечения, выданная моделью при оценке определенного средства, представляющая выполненные действия извлечения.
RetrievalToolDefinition	Входные сведения об определении для средства извлечения, используемые для настройки помощник.
RunError	Сведения об ошибке, обнаруженной при выполнении потока помощник.
RunStep	Подробные сведения об одном шаге выполнения потока помощник.
RunStepError	Сведения об ошибке, связанные с неудачным этапом выполнения.
RunStepMessageCreationDetails	Подробные сведения, связанные с этапом запуска создания сообщения.
RunStepMessageCreationReference	Сведения о сообщении, созданном в рамках шага выполнения.
RunStepToolCallDetails	Подробные сведения, связанные со средствами вызова шага выполнения.
SubmitToolOutputsDetails	Сведения о средствах, которые должны вызываться для отправки выходных данных средства.
SubmitToolOutputsToRunOptions	Сведения, используемые для отправки выходных данных средства в выполнение.
ThreadDeletionStatus	Состояние операции удаления потока.
ThreadMessage	Одно существующее сообщение в потоке помощник.
ThreadRun	Данные, представляющие один запуск оценки потока помощник.
ToolOutput	Данные, предоставленные во время отправки выходных данных средства, разрешают ожидающие вызовы инструментов и позволяют модели продолжить работу.
UpdateAssistantOptions	Сведения о запросе, используемые при изменении существующего помощник.
UpdateAssistantRequestOptions	Сведения, используемые для обновления помощник.
UpdateMessageOptions	Сведения, используемые для обновления сообщения.
UpdateRunOptions	Сведения, используемые для обновления запуска.
UpdateThreadOptions	Сведения, используемые для обновления потока.
UploadFileOptions	Сведения, используемые для отправки файлов.

Псевдонимы типа

CodeInterpreterToolCallOutput	Псевдоним для CodeInterpreterToolCallOutput
FilePurpose	"fine-tune", "fine-tune-results", "assistants", "assistants_output"
ListSortOrder	"asc", "desc"
MessageContent	Псевдоним для MessageContent
MessageRole	"user", "помощник"
MessageTextAnnotation	Псевдоним для MessageTextAnnotation
RequiredToolCall	Псевдоним для RequiredToolCall
RunStatus	"queued", "in_progress", "requires_action", "cancelling", "cancelled", "failed", "completed", "expired"
RunStepDetails	Псевдоним для RunStepDetails
RunStepErrorCode	"server_error", "rate_limit_exceeded"
RunStepStatus	"in_progress", "отменено", "сбой", "завершено", "истек срок действия"
RunStepType	"message_creation", "tool_calls"
ToolCall	Псевдоним для ToolCall
ToolDefinition	Абстрактное представление определения средства ввода, которое может использовать помощник.