AssistantsClient class

Inizializza un'istanza di AssistantsClient da usare con l'endpoint OpenAI non di Azure.

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

Parametri

Commenti

Gli oggetti AssistantsClient inizializzati con questo costruttore possono essere usati solo con l'endpoint di inferenza non Azure OpenAI. Per usare AssistantsClient con una risorsa OpenAI di Azure, usare un costruttore che accetta invece un URI di risorsa e credenziali di autenticazione di Azure.

Inizializza un'istanza di AssistantsClient da usare con una risorsa OpenAI.

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

Parametri

Commenti

Questo costruttore inizializza un oggetto AssistantsClient che può essere usato solo con le risorse OpenAI di Azure. Per usare AssistantsClient con un endpoint di inferenza non Azure OpenAI, usare invece un costruttore che accetta una chiave API non Azure OpenAI.

Inizializza un'istanza di AssistantsClient da usare con una risorsa OpenAI di Azure.

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

Parametri

Pipeline usata da questo client per effettuare richieste

pipeline: Pipeline

Valore della proprietà

Annulla un'esecuzione di un thread in corso.

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

Parametri

Restituisce

Crea una nuova assistente.

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

Parametri

Restituisce

Collega un file caricato in precedenza a un assistente da usare dagli strumenti che possono leggere i file.

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

Parametri

Restituisce

Crea un nuovo messaggio in un thread specificato.

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

Parametri

Restituisce

Crea una nuova esecuzione per un thread assistente.

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

Parametri

Restituisce

Crea un nuovo thread. I thread contengono messaggi e possono essere eseguiti da assistenti.

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

Parametri

Restituisce

Crea un nuovo thread assistente e avvia immediatamente un'esecuzione usando tale nuovo thread.

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

Parametri

Restituisce

Elimina un assistente.

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

Parametri

Restituisce

Scollega un file collegato in precedenza da un assistente, rendendolo non disponibile per l'uso da parte di strumenti che possono leggere i file.

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

Parametri

Restituisce

Eliminare un file caricato in precedenza.

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

Parametri

Restituisce

Elimina un thread esistente.

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

Parametri

Restituisce

Recupera un assistente esistente.

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

Parametri

Restituisce

Recupera un file collegato a un assistente.

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

Parametri

Restituisce

Restituisce informazioni su un file specifico. Non recupera il contenuto del file.

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

Parametri

Restituisce

Ottiene un messaggio esistente da un thread esistente.

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

Parametri

Restituisce

Ottiene informazioni su un allegato di file a un messaggio all'interno di un thread.

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

Parametri

Restituisce

Ottiene un'esecuzione esistente da un thread esistente.

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

Parametri

Restituisce

Ottiene un singolo passaggio di esecuzione da un thread eseguito.

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

Parametri

Restituisce

Ottiene informazioni su un thread esistente.

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

Parametri

Restituisce

Ottiene un elenco di file collegati a un assistente specifico, come usato dagli strumenti che possono leggere i file.

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

Parametri

Restituisce

Ottiene un elenco di assistenti creati in precedenza.

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

Parametri

Restituisce

Ottiene un elenco di file caricati in precedenza.

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

Parametri

Restituisce

Ottiene un elenco di file caricati in precedenza associati a un messaggio da un thread.

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

Parametri

Restituisce

Ottiene un elenco di messaggi esistenti in un thread.

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

Parametri

Restituisce

Ottiene un elenco di esecuzioni per un thread specificato.

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

Parametri

Restituisce

Ottiene un elenco di passaggi di esecuzione da un'esecuzione di thread.

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

Parametri

Restituisce

Invia output dagli strumenti richiesti dalle chiamate degli strumenti in un'esecuzione. Le esecuzioni necessarie per gli output degli strumenti inviati avranno uno stato "requires_action" con un required_action.tipo di "submit_tool_outputs".

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

Parametri

Restituisce

Modifica un assistente esistente.

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

Parametri

Restituisce

Modifica un messaggio esistente in un thread esistente.

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

Parametri

Restituisce

Modifica un'esecuzione di thread esistente.

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

Parametri

Restituisce

Modifica un thread esistente.

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

Parametri

Restituisce

Carica un file da usare da altre operazioni.

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

Parametri

Restituisce