AssistantsClient class

Ссылка

Пакет:: @azure/openai-assistants

Предупреждение

Теперь этот API является нерекомендуемым.

The Azure OpenAI Assistants client library for JavaScript beta will be retired on January 14th, 2025. Please migrate to the stable OpenAI SDK for JavaScript using the migration guide before that date.

Операции, связанные с помощником по работе с клиентом.

Конструкторы

AssistantsClient(KeyCredential, AssistantsClientOptions)	Инициализирует экземпляр AssistantsClient для использования с конечной точкой OpenAI, отличной от Azure.
AssistantsClient(string, KeyCredential, AssistantsClientOptions)	Инициализирует экземпляр AssistantsClient для использования с ресурсом OpenAI.
AssistantsClient(string, TokenCredential, AssistantsClientOptions)	Инициализирует экземпляр AssistantsClient для использования с ресурсом Azure OpenAI.

Свойства

pipeline

Конвейер, используемый этим клиентом для выполнения запросов

Методы

cancelRun(string, string, CancelRunOptions)	Отменяет выполнение потока выполнения.
createAssistant(AssistantCreationOptions, CreateAssistantOptions)	Создает помощника.
createAssistantFile(string, string, CreateAssistantFileOptions)	Присоединяет ранее загруженный файл к помощнику для использования средствами, которые могут считывать файлы.
createMessage(string, string, string, CreateMessageOptions)	Создает новое сообщение в указанном потоке.
createRun(string, CreateRunOptions, CreateRunRequestOptions)	Создает новый запуск для потока помощника.
createThread(AssistantThreadCreationOptions, CreateThreadOptions)	Создает новый поток. Потоки содержат сообщения и могут выполняться помощниками.
createThreadAndRun(CreateAndRunThreadOptions, CreateThreadAndRunOptions)	Создает новый поток помощника и немедленно запускает запуск с помощью этого нового потока.
deleteAssistant(string, DeleteAssistantOptions)	Удаляет помощника.
deleteAssistantFile(string, string, DeleteAssistantFileOptions)	Отменяет связь с ранее присоединенным файлом от помощника, отрисовывая его недоступно для использования средствами, которые могут читать файлы.
deleteFile(string, DeleteFileOptions)	Удалите ранее отправленный файл.
deleteThread(string, DeleteThreadOptions)	Удаляет существующий поток.
getAssistant(string, GetAssistantOptions)	Извлекает существующего помощника.
getAssistantFile(string, string, GetAssistantFileOptions)	Извлекает файл, подключенный к помощнику.
getFile(string, GetFileOptions)	Возвращает сведения о конкретном файле. Не извлекает содержимое файла.
getMessage(string, string, GetMessageOptions)	Возвращает существующее сообщение из существующего потока.
getMessageFile(string, string, string, GetMessageFileOptions)	Возвращает сведения о вложении файла в сообщение в потоке.
getRun(string, string, GetRunOptions)	Возвращает существующий запуск из существующего потока.
getRunStep(string, string, string, GetRunStepOptions)	Возвращает один шаг выполнения из потока.
getThread(string, GetThreadOptions)	Возвращает сведения о существующем потоке.
listAssistantFiles(string, ListAssistantFilesOptions)	Получает список файлов, присоединенных к конкретному помощнику, как используется средствами, которые могут читать файлы.
listAssistants(ListAssistantsOptions)	Возвращает список помощников, созданных ранее.
listFiles(ListFilesOptions)	Возвращает список ранее отправленных файлов.
listMessageFiles(string, string, ListMessageFilesOptions)	Возвращает список ранее отправленных файлов, связанных с сообщением из потока.
listMessages(string, ListMessagesOptions)	Возвращает список сообщений, существующих в потоке.
listRuns(string, ListRunsOptions)	Возвращает список запусков для указанного потока.
listRunSteps(string, string, ListRunStepsOptions)	Возвращает список шагов выполнения из выполнения потока.
submitToolOutputsToRun(string, string, ToolOutput[], SubmitToolOutputsToRunOptions)	Отправляет выходные данные из средств, запрашиваемых вызовами инструментов в выполнении. Запуски, необходимые для отправки выходных данных средства, будут иметь состояние "requires_action" с типом required_action.type "submit_tool_outputs".
updateAssistant(string, UpdateAssistantOptions, UpdateAssistantRequestOptions)	Изменяет существующий помощник.
updateMessage(string, string, UpdateMessageOptions)	Изменяет существующее сообщение в существующем потоке.
updateRun(string, string, UpdateRunOptions)	Изменяет существующий запуск потока.
updateThread(string, UpdateThreadOptions)	Изменяет существующий поток.
uploadFile(Uint8Array, string, UploadFileOptions)	Отправляет файл для использования другими операциями.

Сведения о конструкторе

AssistantsClient(KeyCredential, AssistantsClientOptions)

Инициализирует экземпляр AssistantsClient для использования с конечной точкой OpenAI, отличной от Azure.

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

Параметры

openAiApiKey: KeyCredential

Ключ API, используемый при подключении к конечной точке, отличной от Azure OpenAI.

options: AssistantsClientOptions

Параметры настройки клиента.

Объекты AssistantsClient, инициализированные с этим конструктором, можно использовать только с конечной точкой вывода, отличной от Azure OpenAI. Чтобы использовать AssistantsClient с ресурсом Azure OpenAI, используйте конструктор, который принимает URI ресурса и учетные данные проверки подлинности Azure.

AssistantsClient(string, KeyCredential, AssistantsClientOptions)

Инициализирует экземпляр AssistantsClient для использования с ресурсом OpenAI.

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

Параметры

endpoint: string

URI для ресурса Azure OpenAI, включая протокол и имя узла. Например, https://my-resource.openai.azure.com.

credential: KeyCredential

Ключевые учетные данные, используемые для проверки подлинности в ресурсе Azure OpenAI.

options: AssistantsClientOptions

Параметры настройки клиента.

Этот конструктор инициализирует объект AssistantsClient, который можно использовать только с ресурсами Azure OpenAI. Чтобы использовать AssistantsClient с конечной точкой вывода, отличной от Azure OpenAI, используйте конструктор, принимаюющий ключ API, отличный от Azure OpenAI.

AssistantsClient(string, TokenCredential, AssistantsClientOptions)

Инициализирует экземпляр AssistantsClient для использования с ресурсом Azure OpenAI.

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

Параметры

endpoint: string

URI для ресурса Azure OpenAI, включая протокол и имя узла. Например, https://my-resource.openai.azure.com.

credential: TokenCredential

Учетные данные маркера, используемые для проверки подлинности с помощью ресурса Azure OpenAI.

options: AssistantsClientOptions

Параметры настройки клиента.

Сведения о свойстве

pipeline

Конвейер, используемый этим клиентом для выполнения запросов

pipeline: Pipeline

Значение свойства

Pipeline

Сведения о методе

cancelRun(string, string, CancelRunOptions)

Отменяет выполнение потока выполнения.

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

Параметры

threadId: string

runId: string

options: CancelRunOptions

Возвращаемое значение

Promise<ThreadRun>

createAssistant(AssistantCreationOptions, CreateAssistantOptions)

Создает помощника.

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

Параметры

body: AssistantCreationOptions

options: CreateAssistantOptions

Возвращаемое значение

Promise<Assistant>

createAssistantFile(string, string, CreateAssistantFileOptions)

Присоединяет ранее загруженный файл к помощнику для использования средствами, которые могут считывать файлы.

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

Параметры

assistantId: string

fileId: string

options: CreateAssistantFileOptions

Возвращаемое значение

Promise<AssistantFile>

createMessage(string, string, string, CreateMessageOptions)

Создает новое сообщение в указанном потоке.

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

Параметры

threadId: string

role: string

content: string

options: CreateMessageOptions

Возвращаемое значение

Promise<ThreadMessage>

createRun(string, CreateRunOptions, CreateRunRequestOptions)

Создает новый запуск для потока помощника.

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

Параметры

threadId: string

createRunOptions: CreateRunOptions

options: CreateRunRequestOptions

Возвращаемое значение

Promise<ThreadRun>

createThread(AssistantThreadCreationOptions, CreateThreadOptions)

Создает новый поток. Потоки содержат сообщения и могут выполняться помощниками.

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

Параметры

body: AssistantThreadCreationOptions

options: CreateThreadOptions

Возвращаемое значение

Promise<AssistantThread>

createThreadAndRun(CreateAndRunThreadOptions, CreateThreadAndRunOptions)

Создает новый поток помощника и немедленно запускает запуск с помощью этого нового потока.

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

Параметры

body: CreateAndRunThreadOptions

options: CreateThreadAndRunOptions

Возвращаемое значение

Promise<ThreadRun>

deleteAssistant(string, DeleteAssistantOptions)

Удаляет помощника.

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

Параметры

assistantId: string

options: DeleteAssistantOptions

Возвращаемое значение

Promise<AssistantDeletionStatus>

deleteAssistantFile(string, string, DeleteAssistantFileOptions)

Отменяет связь с ранее присоединенным файлом от помощника, отрисовывая его недоступно для использования средствами, которые могут читать файлы.

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

Параметры

assistantId: string

fileId: string

options: DeleteAssistantFileOptions

Возвращаемое значение

Promise<AssistantFileDeletionStatus>

deleteFile(string, DeleteFileOptions)

Удалите ранее отправленный файл.

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

Параметры

fileId: string

options: DeleteFileOptions

Возвращаемое значение

Promise<FileDeletionStatus>

deleteThread(string, DeleteThreadOptions)

Удаляет существующий поток.

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

Параметры

threadId: string

options: DeleteThreadOptions

Возвращаемое значение

Promise<ThreadDeletionStatus>

getAssistant(string, GetAssistantOptions)

Извлекает существующего помощника.

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

Параметры

assistantId: string

options: GetAssistantOptions

Возвращаемое значение

Promise<Assistant>

getAssistantFile(string, string, GetAssistantFileOptions)

Извлекает файл, подключенный к помощнику.

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

Параметры

assistantId: string

fileId: string

options: GetAssistantFileOptions

Возвращаемое значение

Promise<AssistantFile>

getFile(string, GetFileOptions)

Возвращает сведения о конкретном файле. Не извлекает содержимое файла.

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

Параметры

fileId: string

options: GetFileOptions

Возвращаемое значение

Promise<InputFile>

getMessage(string, string, GetMessageOptions)

Возвращает существующее сообщение из существующего потока.

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

Параметры

threadId: string

messageId: string

options: GetMessageOptions

Возвращаемое значение

Promise<ThreadMessage>

getMessageFile(string, string, string, GetMessageFileOptions)

Возвращает сведения о вложении файла в сообщение в потоке.

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

Параметры

threadId: string

messageId: string

fileId: string

options: GetMessageFileOptions

Возвращаемое значение

Promise<MessageFile>

getRun(string, string, GetRunOptions)

Возвращает существующий запуск из существующего потока.

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

Параметры

threadId: string

runId: string

options: GetRunOptions

Возвращаемое значение

Promise<ThreadRun>

getRunStep(string, string, string, GetRunStepOptions)

Возвращает один шаг выполнения из потока.

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

Параметры

threadId: string

runId: string

stepId: string

options: GetRunStepOptions

Возвращаемое значение

Promise<RunStep>

getThread(string, GetThreadOptions)

Возвращает сведения о существующем потоке.

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

Параметры

threadId: string

options: GetThreadOptions

Возвращаемое значение

Promise<AssistantThread>

listAssistantFiles(string, ListAssistantFilesOptions)

Получает список файлов, присоединенных к конкретному помощнику, как используется средствами, которые могут читать файлы.

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

Параметры

assistantId: string

options: ListAssistantFilesOptions

Возвращаемое значение

Promise<ListResponseOf<AssistantFile>>

listAssistants(ListAssistantsOptions)

Возвращает список помощников, созданных ранее.

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

Параметры

options: ListAssistantsOptions

Возвращаемое значение

Promise<ListResponseOf<Assistant>>

listFiles(ListFilesOptions)

Возвращает список ранее отправленных файлов.

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

Параметры

options: ListFilesOptions

Возвращаемое значение

Promise<FileListResponse>

listMessageFiles(string, string, ListMessageFilesOptions)

Возвращает список ранее отправленных файлов, связанных с сообщением из потока.

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

Параметры

threadId: string

messageId: string

options: ListMessageFilesOptions

Возвращаемое значение

Promise<ListResponseOf<MessageFile>>

listMessages(string, ListMessagesOptions)

Возвращает список сообщений, существующих в потоке.

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

Параметры

threadId: string

options: ListMessagesOptions

Возвращаемое значение

Promise<ListResponseOf<ThreadMessage>>

listRuns(string, ListRunsOptions)

Возвращает список запусков для указанного потока.

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

Параметры

threadId: string

options: ListRunsOptions

Возвращаемое значение

Promise<ListResponseOf<ThreadRun>>

listRunSteps(string, string, ListRunStepsOptions)

Возвращает список шагов выполнения из выполнения потока.

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

Параметры

threadId: string

runId: string

options: ListRunStepsOptions

Возвращаемое значение

Promise<ListResponseOf<RunStep>>

submitToolOutputsToRun(string, string, ToolOutput[], SubmitToolOutputsToRunOptions)

Отправляет выходные данные из средств, запрашиваемых вызовами инструментов в выполнении. Запуски, необходимые для отправки выходных данных средства, будут иметь состояние "requires_action" с типом required_action.type "submit_tool_outputs".

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

Параметры

threadId: string

runId: string

toolOutputs: ToolOutput[]

options: SubmitToolOutputsToRunOptions

Возвращаемое значение

Promise<ThreadRun>

updateAssistant(string, UpdateAssistantOptions, UpdateAssistantRequestOptions)

Изменяет существующий помощник.

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

Параметры

assistantId: string

body: UpdateAssistantOptions

options: UpdateAssistantRequestOptions

Возвращаемое значение

Promise<Assistant>

updateMessage(string, string, UpdateMessageOptions)

Изменяет существующее сообщение в существующем потоке.

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

Параметры

threadId: string

messageId: string

options: UpdateMessageOptions

Возвращаемое значение

Promise<ThreadMessage>

updateRun(string, string, UpdateRunOptions)

Изменяет существующий запуск потока.

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

Параметры

threadId: string

runId: string

options: UpdateRunOptions

Возвращаемое значение

Promise<ThreadRun>

updateThread(string, UpdateThreadOptions)

Изменяет существующий поток.

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

Параметры

threadId: string

options: UpdateThreadOptions

Возвращаемое значение

Promise<AssistantThread>

uploadFile(Uint8Array, string, UploadFileOptions)

Отправляет файл для использования другими операциями.

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

Параметры

file: Uint8Array

purpose: string

options: UploadFileOptions

Возвращаемое значение

Promise<InputFile>

Поделиться через

AssistantsClient class

Конструкторы

Свойства

Методы

Сведения о конструкторе

AssistantsClient(KeyCredential, AssistantsClientOptions)

Параметры

Комментарии

AssistantsClient(string, KeyCredential, AssistantsClientOptions)

Параметры

Комментарии

AssistantsClient(string, TokenCredential, AssistantsClientOptions)

Параметры

Сведения о свойстве

pipeline

Значение свойства

Сведения о методе

cancelRun(string, string, CancelRunOptions)

Параметры

Возвращаемое значение

createAssistant(AssistantCreationOptions, CreateAssistantOptions)

Параметры

Возвращаемое значение

createAssistantFile(string, string, CreateAssistantFileOptions)

Параметры

Возвращаемое значение

createMessage(string, string, string, CreateMessageOptions)

Параметры

Возвращаемое значение

createRun(string, CreateRunOptions, CreateRunRequestOptions)

Параметры

Возвращаемое значение

createThread(AssistantThreadCreationOptions, CreateThreadOptions)

Параметры

Возвращаемое значение

createThreadAndRun(CreateAndRunThreadOptions, CreateThreadAndRunOptions)

Параметры

Возвращаемое значение

deleteAssistant(string, DeleteAssistantOptions)

Параметры

Возвращаемое значение

deleteAssistantFile(string, string, DeleteAssistantFileOptions)

Параметры

Возвращаемое значение

deleteFile(string, DeleteFileOptions)

Параметры

Возвращаемое значение

deleteThread(string, DeleteThreadOptions)

Параметры

Возвращаемое значение

getAssistant(string, GetAssistantOptions)

Параметры

Возвращаемое значение

getAssistantFile(string, string, GetAssistantFileOptions)

Параметры

Возвращаемое значение

getFile(string, GetFileOptions)

Параметры

Возвращаемое значение

getMessage(string, string, GetMessageOptions)

Параметры

Возвращаемое значение

getMessageFile(string, string, string, GetMessageFileOptions)

Параметры

Возвращаемое значение

getRun(string, string, GetRunOptions)

Параметры

Возвращаемое значение

getRunStep(string, string, string, GetRunStepOptions)

Параметры

Возвращаемое значение

getThread(string, GetThreadOptions)

Параметры

Возвращаемое значение

listAssistantFiles(string, ListAssistantFilesOptions)

Параметры

Возвращаемое значение

listAssistants(ListAssistantsOptions)

Параметры