AssistantsClient class

Inicializa uma instância de AssistantsClient para utilização com o ponto final não Azure OpenAI.

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

Parâmetros

Observações

AssistantsClient objects initialized with this constructor can only be used with the non-Azure OpenAI inference endpoint. Para utilizar AssistantsClient com um recurso do Azure OpenAI, utilize um construtor que aceite um URI de recurso e uma credencial de autenticação do Azure.

Inicializa uma instância de AssistantsClient para utilização com um recurso OpenAI.

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

Parâmetros

Observações

Este construtor inicializa um objeto AssistantsClient que só pode ser utilizado com recursos do Azure OpenAI. Para utilizar AssistantsClient com um ponto final de inferência não Azure OpenAI, utilize um construtor que aceite uma chave de API OpenAI que não seja do Azure.

Inicializa uma instância de AssistantsClient para utilização com um recurso do Azure OpenAI.

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

Parâmetros

O pipeline utilizado por este cliente para fazer pedidos

pipeline: Pipeline

Valor de Propriedade

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

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

Parâmetros

Devoluções

Cria uma nova assistente.

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

Parâmetros

Devoluções

Anexa um ficheiro carregado anteriormente a um assistente para utilização por ferramentas que podem ler ficheiros.

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

Parâmetros

Devoluções

Cria uma nova mensagem num thread especificado.

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

Parâmetros

Devoluções

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

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

Parâmetros

Devoluções

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

Devoluções

Cria um novo assistente thread e inicia imediatamente uma execução com esse novo thread.

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

Parâmetros

Devoluções

Elimina uma assistente.

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

Parâmetros

Devoluções

Desassocia um ficheiro previamente anexado de um assistente, tornando-o indisponível para utilização por ferramentas que podem ler ficheiros.

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

Parâmetros

Devoluções

Elimine um ficheiro carregado anteriormente.

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

Parâmetros

Devoluções

Elimina um thread existente.

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

Parâmetros

Devoluções

Obtém uma assistente existente.

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

Parâmetros

Devoluções

Obtém um ficheiro anexado a um assistente.

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

Parâmetros

Devoluções

Devolve informações sobre um ficheiro específico. Não obtém conteúdo de ficheiro.

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

Parâmetros

Devoluções

Obtém uma mensagem existente a partir de um thread existente.

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

Parâmetros

Devoluções

Obtém informações sobre um anexo de ficheiro para uma mensagem dentro de um tópico.

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

Parâmetros

Devoluções

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

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

Parâmetros

Devoluções

Obtém um único passo de execução de uma execução de thread.

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

Parâmetros

Devoluções

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

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

Parâmetros

Devoluções

Obtém uma lista de ficheiros anexados a um assistente específico, conforme utilizado pelas ferramentas que podem ler ficheiros.

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

Parâmetros

Devoluções

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

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

Parâmetros

Devoluções

Obtém uma lista de ficheiros carregados anteriormente.

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

Parâmetros

Devoluções

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

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

Parâmetros

Devoluções

Obtém uma lista de mensagens que existem num tópico.

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

Parâmetros

Devoluções

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

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

Parâmetros

Devoluções

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

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

Parâmetros

Devoluções

Submete saídas de ferramentas, conforme pedido por chamadas de ferramentas numa execução. As execuções que precisam de saídas de ferramentas submetidas terão o estado "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

Devoluções

Modifica uma assistente existente.

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

Parâmetros

Devoluções

Modifica uma mensagem existente num thread existente.

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

Parâmetros

Devoluções

Modifica uma execução de thread existente.

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

Parâmetros

Devoluções

Modifica um thread existente.

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

Parâmetros

Devoluções

Carrega um ficheiro para utilização por outras operações.

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

Parâmetros

Devoluções