AssistantsClient class

Referência

Pacote:: @azure/openai-assistants

Tratamento de cliente assistente operações relacionadas.

Construtores

AssistantsClient(KeyCredential, AssistantsClientOptions)	Inicializa uma instância de AssistantsClient para uso com o ponto de extremidade OpenAI não Azure.
AssistantsClient(string, KeyCredential, AssistantsClientOptions)	Inicializa uma instância de AssistantsClient para uso com um recurso OpenAI.
AssistantsClient(string, TokenCredential, AssistantsClientOptions)	Inicializa uma instância do AssistantsClient para uso com um recurso openAI do Azure.

Propriedades

pipeline

O pipeline usado por esse cliente para fazer solicitações

Métodos

cancelRun(string, string, CancelRunOptions)	Cancela uma execução de um thread em andamento.
createAssistant(AssistantCreationOptions, CreateAssistantOptions)	Cria uma nova assistente.
createAssistantFile(string, string, CreateAssistantFileOptions)	Anexa um arquivo carregado anteriormente a um assistente para uso por ferramentas que podem ler arquivos.
createMessage(string, string, string, CreateMessageOptions)	Cria uma nova mensagem em um thread especificado.
createRun(string, CreateRunOptions, CreateRunRequestOptions)	Cria uma nova execução para um thread de assistente.
createThread(AssistantThreadCreationOptions, CreateThreadOptions)	Cria um novo thread. Os threads contêm mensagens e podem ser executados por assistentes.
createThreadAndRun(CreateAndRunThreadOptions, CreateThreadAndRunOptions)	Cria uma nova assistente thread e inicia imediatamente uma execução usando esse novo thread.
deleteAssistant(string, DeleteAssistantOptions)	Exclui um assistente.
deleteAssistantFile(string, string, DeleteAssistantFileOptions)	Desvincula um arquivo anexado anteriormente de um assistente, tornando-o indisponível para uso por ferramentas que podem ler arquivos.
deleteFile(string, DeleteFileOptions)	Exclua um arquivo carregado anteriormente.
deleteThread(string, DeleteThreadOptions)	Exclui um thread existente.
getAssistant(string, GetAssistantOptions)	Recupera um assistente existente.
getAssistantFile(string, string, GetAssistantFileOptions)	Recupera um arquivo anexado a um assistente.
getFile(string, GetFileOptions)	Retorna informações sobre um arquivo específico. Não recupera o conteúdo do arquivo.
getMessage(string, string, GetMessageOptions)	Obtém uma mensagem existente de um thread existente.
getMessageFile(string, string, string, GetMessageFileOptions)	Obtém informações sobre um anexo de arquivo a uma mensagem dentro de um thread.
getRun(string, string, GetRunOptions)	Obtém uma execução existente de um thread existente.
getRunStep(string, string, string, GetRunStepOptions)	Obtém uma única etapa de execução de uma execução de thread.
getThread(string, GetThreadOptions)	Obtém informações sobre um thread existente.
listAssistantFiles(string, ListAssistantFilesOptions)	Obtém uma lista de arquivos anexados a um assistente específico, conforme usado por ferramentas que podem ler arquivos.
listAssistants(ListAssistantsOptions)	Obtém uma lista de assistentes que foram criados anteriormente.
listFiles(ListFilesOptions)	Obtém uma lista de arquivos carregados anteriormente.
listMessageFiles(string, string, ListMessageFilesOptions)	Obtém uma lista de arquivos carregados anteriormente associados a uma mensagem de um thread.
listMessages(string, ListMessagesOptions)	Obtém uma lista de mensagens que existem em um thread.
listRuns(string, ListRunsOptions)	Obtém uma lista de execuções para um thread especificado.
listRunSteps(string, string, ListRunStepsOptions)	Obtém uma lista de etapas de execução de uma execução de thread.
submitToolOutputsToRun(string, string, ToolOutput[], SubmitToolOutputsToRunOptions)	Envia saídas de ferramentas conforme solicitado por chamadas de ferramenta em uma execução. As execuções que precisam de saídas de ferramenta enviada terão um status de "requires_action" com um required_action.tipo de "submit_tool_outputs".
updateAssistant(string, UpdateAssistantOptions, UpdateAssistantRequestOptions)	Modifica um assistente existente.
updateMessage(string, string, UpdateMessageOptions)	Modifica uma mensagem existente em um thread existente.
updateRun(string, string, UpdateRunOptions)	Modifica uma execução de thread existente.
updateThread(string, UpdateThreadOptions)	Modifica um thread existente.
uploadFile(Uint8Array, string, UploadFileOptions)	Carrega um arquivo para uso por outras operações.

Detalhes do construtor

AssistantsClient(KeyCredential, AssistantsClientOptions)

Inicializa uma instância de AssistantsClient para uso com o ponto de extremidade OpenAI não Azure.

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

Parâmetros

openAiApiKey: KeyCredential

A chave de API a ser usada ao se conectar ao ponto de extremidade openAI não Azure.

options: AssistantsClientOptions

As opções para configurar o cliente.

Comentários

Os objetos AssistantsClient inicializados com esse construtor só podem ser usados com o ponto de extremidade de inferência não Azure OpenAI. Para usar o AssistantsClient com um recurso openAI do Azure, use um construtor que aceite um URI de recurso e uma credencial de autenticação do Azure.

AssistantsClient(string, KeyCredential, AssistantsClientOptions)

Inicializa uma instância de AssistantsClient para uso com um recurso OpenAI.

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

Parâmetros

endpoint: string

O URI de um recurso openAI do Azure, incluindo o protocolo e o nome do host. Por exemplo: https://my-resource.openai.azure.com.

credential: KeyCredential

Uma credencial de chave usada para autenticar em um recurso do OpenAI do Azure.

options: AssistantsClientOptions

As opções para configurar o cliente.

Comentários

Esse construtor inicializa um objeto AssistantsClient que só pode ser usado com recursos do OpenAI do Azure. Para usar AssistantsClient com um ponto de extremidade de inferência OpenAI não Azure, use um construtor que aceite uma chave de API OpenAI que não seja do Azure.

AssistantsClient(string, TokenCredential, AssistantsClientOptions)

Inicializa uma instância do AssistantsClient para uso com um recurso openAI do Azure.

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

Parâmetros

endpoint: string

O URI de um recurso openAI do Azure, incluindo o protocolo e o nome do host. Por exemplo: https://my-resource.openai.azure.com.

credential: TokenCredential

Uma credencial de token usada para autenticar com um recurso openAI do Azure.

options: AssistantsClientOptions

As opções para configurar o cliente.

Detalhes da propriedade

pipeline

O pipeline usado por esse cliente para fazer solicitações

pipeline: Pipeline

Valor da propriedade

Pipeline

Detalhes do método

cancelRun(string, string, CancelRunOptions)

Cancela uma execução de um thread em andamento.

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

Parâmetros

threadId: string

runId: string

options: CancelRunOptions

Retornos

Promise<ThreadRun>

createAssistant(AssistantCreationOptions, CreateAssistantOptions)

Cria uma nova assistente.

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

Parâmetros

body: AssistantCreationOptions

options: CreateAssistantOptions

Retornos

Promise<Assistant>

createAssistantFile(string, string, CreateAssistantFileOptions)

Anexa um arquivo carregado anteriormente a um assistente para uso por ferramentas que podem ler arquivos.

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

Parâmetros

assistantId: string

fileId: string

options: CreateAssistantFileOptions

Retornos

Promise<AssistantFile>

createMessage(string, string, string, CreateMessageOptions)

Cria uma nova mensagem em um thread especificado.

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

Parâmetros

threadId: string

role: string

content: string

options: CreateMessageOptions

Retornos

Promise<ThreadMessage>

createRun(string, CreateRunOptions, CreateRunRequestOptions)

Cria uma nova execução para um thread de assistente.

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

Parâmetros

threadId: string

createRunOptions: CreateRunOptions

options: CreateRunRequestOptions

Retornos

Promise<ThreadRun>

createThread(AssistantThreadCreationOptions, CreateThreadOptions)

Cria um novo thread. Os threads contêm mensagens e podem ser executados por assistentes.

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

Parâmetros

body: AssistantThreadCreationOptions

options: CreateThreadOptions

Retornos

Promise<AssistantThread>

createThreadAndRun(CreateAndRunThreadOptions, CreateThreadAndRunOptions)

Cria uma nova assistente thread e inicia imediatamente uma execução usando esse novo thread.

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

Parâmetros

body: CreateAndRunThreadOptions

options: CreateThreadAndRunOptions

Retornos

Promise<ThreadRun>

deleteAssistant(string, DeleteAssistantOptions)

Exclui um assistente.

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

Parâmetros

assistantId: string

options: DeleteAssistantOptions

Retornos

Promise<AssistantDeletionStatus>

deleteAssistantFile(string, string, DeleteAssistantFileOptions)

Desvincula um arquivo anexado anteriormente de um assistente, tornando-o indisponível para uso por ferramentas que podem ler arquivos.

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

Parâmetros

assistantId: string

fileId: string

options: DeleteAssistantFileOptions

Retornos

Promise<AssistantFileDeletionStatus>

deleteFile(string, DeleteFileOptions)

Exclua um arquivo carregado anteriormente.

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

Parâmetros

fileId: string

options: DeleteFileOptions

Retornos

Promise<FileDeletionStatus>

deleteThread(string, DeleteThreadOptions)

Exclui um thread existente.

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

Parâmetros

threadId: string

options: DeleteThreadOptions

Retornos

Promise<ThreadDeletionStatus>

getAssistant(string, GetAssistantOptions)

Recupera um assistente existente.

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

Parâmetros

assistantId: string

options: GetAssistantOptions

Retornos

Promise<Assistant>

getAssistantFile(string, string, GetAssistantFileOptions)

Recupera um arquivo anexado a um assistente.

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

Parâmetros

assistantId: string

fileId: string

options: GetAssistantFileOptions

Retornos

Promise<AssistantFile>

getFile(string, GetFileOptions)

Retorna informações sobre um arquivo específico. Não recupera o conteúdo do arquivo.

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

Parâmetros

fileId: string

options: GetFileOptions

Retornos

Promise<InputFile>

getMessage(string, string, GetMessageOptions)

Obtém uma mensagem existente de um thread existente.

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

Parâmetros

threadId: string

messageId: string

options: GetMessageOptions

Retornos

Promise<ThreadMessage>

getMessageFile(string, string, string, GetMessageFileOptions)

Obtém informações sobre um anexo de arquivo a uma mensagem dentro de um thread.

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

Parâmetros

threadId: string

messageId: string

fileId: string

options: GetMessageFileOptions

Retornos

Promise<MessageFile>

getRun(string, string, GetRunOptions)

Obtém uma execução existente de um thread existente.

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

Parâmetros

threadId: string

runId: string

options: GetRunOptions

Retornos

Promise<ThreadRun>

getRunStep(string, string, string, GetRunStepOptions)

Obtém uma única etapa de execução de uma execução de thread.

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

Parâmetros

threadId: string

runId: string

stepId: string

options: GetRunStepOptions

Retornos

Promise<RunStep>

getThread(string, GetThreadOptions)

Obtém informações sobre um thread existente.

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

Parâmetros

threadId: string

options: GetThreadOptions

Retornos

Promise<AssistantThread>

listAssistantFiles(string, ListAssistantFilesOptions)

Obtém uma lista de arquivos anexados a um assistente específico, conforme usado por ferramentas que podem ler arquivos.

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

Parâmetros

assistantId: string

options: ListAssistantFilesOptions

Retornos

Promise<ListResponseOf<AssistantFile>>

listAssistants(ListAssistantsOptions)

Obtém uma lista de assistentes que foram criados anteriormente.

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

Parâmetros

options: ListAssistantsOptions

Retornos

Promise<ListResponseOf<Assistant>>

listFiles(ListFilesOptions)

Obtém uma lista de arquivos carregados anteriormente.

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

Parâmetros

options: ListFilesOptions

Retornos

Promise<FileListResponse>

listMessageFiles(string, string, ListMessageFilesOptions)

Obtém uma lista de arquivos carregados anteriormente associados a uma mensagem de um thread.

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

Parâmetros

threadId: string

messageId: string

options: ListMessageFilesOptions

Retornos

Promise<ListResponseOf<MessageFile>>

listMessages(string, ListMessagesOptions)

Obtém uma lista de mensagens que existem em um thread.

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

Parâmetros

threadId: string

options: ListMessagesOptions

Retornos

Promise<ListResponseOf<ThreadMessage>>

listRuns(string, ListRunsOptions)

Obtém uma lista de execuções para um thread especificado.

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

Parâmetros

threadId: string

options: ListRunsOptions

Retornos

Promise<ListResponseOf<ThreadRun>>

listRunSteps(string, string, ListRunStepsOptions)

Obtém uma lista de etapas de execução de uma execução de thread.

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

Parâmetros

threadId: string

runId: string

options: ListRunStepsOptions

Retornos

Promise<ListResponseOf<RunStep>>

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

Envia saídas de ferramentas conforme solicitado por chamadas de ferramenta em uma execução. As execuções que precisam de saídas de ferramenta enviada terão um status de "requires_action" com um required_action.tipo de "submit_tool_outputs".

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

Parâmetros

threadId: string

runId: string

toolOutputs: ToolOutput[]

options: SubmitToolOutputsToRunOptions

Retornos

Promise<ThreadRun>

updateAssistant(string, UpdateAssistantOptions, UpdateAssistantRequestOptions)

Modifica um assistente existente.

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

Parâmetros

assistantId: string

body: UpdateAssistantOptions

options: UpdateAssistantRequestOptions

Retornos

Promise<Assistant>

updateMessage(string, string, UpdateMessageOptions)

Modifica uma mensagem existente em um thread existente.

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

Parâmetros

threadId: string

messageId: string

options: UpdateMessageOptions

Retornos

Promise<ThreadMessage>

updateRun(string, string, UpdateRunOptions)

Modifica uma execução de thread existente.

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

Parâmetros

threadId: string

runId: string

options: UpdateRunOptions

Retornos

Promise<ThreadRun>

updateThread(string, UpdateThreadOptions)

Modifica um thread existente.

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

Parâmetros

threadId: string

options: UpdateThreadOptions

Retornos

Promise<AssistantThread>

uploadFile(Uint8Array, string, UploadFileOptions)

Carrega um arquivo para uso por outras operações.

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

Parâmetros

file: Uint8Array

purpose: string

options: UploadFileOptions

Retornos

Promise<InputFile>

Compartilhar via

AssistantsClient class

Construtores

Propriedades

Métodos

Detalhes do construtor

AssistantsClient(KeyCredential, AssistantsClientOptions)

Parâmetros

Comentários

AssistantsClient(string, KeyCredential, AssistantsClientOptions)

Parâmetros

Comentários

AssistantsClient(string, TokenCredential, AssistantsClientOptions)

Parâmetros

Detalhes da propriedade

pipeline

Valor da propriedade

Detalhes do método

cancelRun(string, string, CancelRunOptions)

Parâmetros

Retornos

createAssistant(AssistantCreationOptions, CreateAssistantOptions)

Parâmetros

Retornos

createAssistantFile(string, string, CreateAssistantFileOptions)

Parâmetros

Retornos

createMessage(string, string, string, CreateMessageOptions)

Parâmetros

Retornos

createRun(string, CreateRunOptions, CreateRunRequestOptions)

Parâmetros

Retornos

createThread(AssistantThreadCreationOptions, CreateThreadOptions)

Parâmetros

Retornos

createThreadAndRun(CreateAndRunThreadOptions, CreateThreadAndRunOptions)

Parâmetros

Retornos

deleteAssistant(string, DeleteAssistantOptions)

Parâmetros

Retornos

deleteAssistantFile(string, string, DeleteAssistantFileOptions)

Parâmetros

Retornos

deleteFile(string, DeleteFileOptions)

Parâmetros

Retornos

deleteThread(string, DeleteThreadOptions)

Parâmetros

Retornos

getAssistant(string, GetAssistantOptions)

Parâmetros

Retornos

getAssistantFile(string, string, GetAssistantFileOptions)

Parâmetros

Retornos

getFile(string, GetFileOptions)

Parâmetros

Retornos

getMessage(string, string, GetMessageOptions)

Parâmetros

Retornos

getMessageFile(string, string, string, GetMessageFileOptions)

Parâmetros

Retornos

getRun(string, string, GetRunOptions)

Parâmetros

Retornos

getRunStep(string, string, string, GetRunStepOptions)

Parâmetros

Retornos

getThread(string, GetThreadOptions)

Parâmetros

Retornos

listAssistantFiles(string, ListAssistantFilesOptions)

Parâmetros

Retornos

listAssistants(ListAssistantsOptions)

Parâmetros