@azure/openai-assistants package
Классы
| AssistantsClient |
Операции, связанные с помощником по работе с клиентом. |
| AzureKeyCredential |
Учетные данные на основе статического ключа, поддерживающие обновление базового значения ключа. |
| OpenAIKeyCredential |
Класс OpenAIKeyCredential представляет собой ключ API OpenAI и используется для аутентификации в клиенте Assistants для конечной точки 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 |
"тонкая настройка", "тонкая настройка-результаты", "ассистенты", "assistants_output" |
| ListSortOrder |
"ASC", "DESC" |
| MessageContent |
Псевдоним для MessageContent |
| MessageRole |
«пользователь», «помощник» |
| MessageTextAnnotation |
Псевдоним для MessageTextAnnotation |
| RequiredToolCall |
Псевдоним для RequiredToolCall |
| RunStatus |
"queued", "in_progress", "requires_action", "canceling", "cancelled", "failed", "completed", "expired" |
| RunStepDetails |
Псевдоним для RunStepDetails |
| RunStepErrorCode |
"server_error", "rate_limit_exceeded" |
| RunStepStatus |
"in_progress", "отменено", "не пройдено", "завершено", "просрочено" |
| RunStepType |
"message_creation", "tool_calls" |
| ToolCall |
Псевдоним для ToolCall |
| ToolDefinition |
Абстрактное представление определения инструмента ввода, которое может использовать помощник. |
