AssistantsClient class

Paket:

@azure/openai-assistants

Klienthantering assistent relaterade åtgärder.

Konstruktorer

AssistantsClient(KeyCredential, AssistantsClientOptions)	Initierar en instans av AssistantsClient för användning med slutpunkten icke-Azure OpenAI.
AssistantsClient(string, KeyCredential, AssistantsClientOptions)	Initierar en instans av AssistantsClient för användning med en OpenAI-resurs.
AssistantsClient(string, TokenCredential, AssistantsClientOptions)	Initierar en instans av AssistantsClient för användning med en Azure OpenAI-resurs.

Egenskaper

pipeline

Pipelinen som används av den här klienten för att göra begäranden

Metoder

cancelRun(string, string, CancelRunOptions)	Avbryter en körning av en pågående tråd.
createAssistant(AssistantCreationOptions, CreateAssistantOptions)	Skapar en ny assistent.
createAssistantFile(string, string, CreateAssistantFileOptions)	Bifogar en tidigare uppladdad fil till en assistent för användning av verktyg som kan läsa filer.
createMessage(string, string, string, CreateMessageOptions)	Skapar ett nytt meddelande i en angiven tråd.
createRun(string, CreateRunOptions, CreateRunRequestOptions)	Skapar en ny körning för en assistent tråd.
createThread(AssistantThreadCreationOptions, CreateThreadOptions)	Skapar en ny tråd. Trådar innehåller meddelanden och kan köras av assistenter.
createThreadAndRun(CreateAndRunThreadOptions, CreateThreadAndRunOptions)	Skapar en ny assistent tråd och startar omedelbart en körning med den nya tråden.
deleteAssistant(string, DeleteAssistantOptions)	Tar bort en assistent.
deleteAssistantFile(string, string, DeleteAssistantFileOptions)	Avlänkar en tidigare bifogad fil från en assistent, vilket gör den otillgänglig för användning av verktyg som kan läsa filer.
deleteFile(string, DeleteFileOptions)	Ta bort en tidigare uppladdad fil.
deleteThread(string, DeleteThreadOptions)	Tar bort en befintlig tråd.
getAssistant(string, GetAssistantOptions)	Hämtar en befintlig assistent.
getAssistantFile(string, string, GetAssistantFileOptions)	Hämtar en fil som är kopplad till en assistent.
getFile(string, GetFileOptions)	Returnerar information om en specifik fil. Hämtar inte filinnehåll.
getMessage(string, string, GetMessageOptions)	Hämtar ett befintligt meddelande från en befintlig tråd.
getMessageFile(string, string, string, GetMessageFileOptions)	Hämtar information om en filbilaga till ett meddelande i en tråd.
getRun(string, string, GetRunOptions)	Hämtar en befintlig körning från en befintlig tråd.
getRunStep(string, string, string, GetRunStepOptions)	Hämtar ett enda körningssteg från en trådkörning.
getThread(string, GetThreadOptions)	Hämtar information om en befintlig tråd.
listAssistantFiles(string, ListAssistantFilesOptions)	Hämtar en lista över filer som är kopplade till en specifik assistent, som används av verktyg som kan läsa filer.
listAssistants(ListAssistantsOptions)	Hämtar en lista över assistenter som skapades tidigare.
listFiles(ListFilesOptions)	Hämtar en lista över tidigare uppladdade filer.
listMessageFiles(string, string, ListMessageFilesOptions)	Hämtar en lista över tidigare uppladdade filer som är associerade med ett meddelande från en tråd.
listMessages(string, ListMessagesOptions)	Hämtar en lista över meddelanden som finns i en tråd.
listRuns(string, ListRunsOptions)	Hämtar en lista över körningar för en angiven tråd.
listRunSteps(string, string, ListRunStepsOptions)	Hämtar en lista över körningssteg från en trådkörning.
submitToolOutputsToRun(string, string, ToolOutput[], SubmitToolOutputsToRunOptions)	Skickar utdata från verktyg som begärs av verktygsanrop i en körning. Körningar som behöver skickade verktygsutdata har statusen "requires_action" med en required_action.type av "submit_tool_outputs".
updateAssistant(string, UpdateAssistantOptions, UpdateAssistantRequestOptions)	Ändrar en befintlig assistent.
updateMessage(string, string, UpdateMessageOptions)	Ändrar ett befintligt meddelande i en befintlig tråd.
updateRun(string, string, UpdateRunOptions)	Ändrar en befintlig trådkörning.
updateThread(string, UpdateThreadOptions)	Ändrar en befintlig tråd.
uploadFile(Uint8Array, string, UploadFileOptions)	Laddar upp en fil för användning av andra åtgärder.

Konstruktorinformation

AssistantsClient(KeyCredential, AssistantsClientOptions)

Initierar en instans av AssistantsClient för användning med slutpunkten icke-Azure OpenAI.

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

Parametrar

openAiApiKey

KeyCredential

DEN API-nyckel som ska användas när du ansluter till slutpunkten för icke-Azure OpenAI.

options

AssistantsClientOptions

Alternativen för att konfigurera klienten.

Kommentarer

AssistantsClient-objekt som initierats med den här konstruktorn kan endast användas med slutpunkten för inferens för icke-Azure OpenAI. Om du vill använda AssistantsClient med en Azure OpenAI-resurs använder du en konstruktor som accepterar en resurs-URI och Azure-autentiseringsautentiseringsautentisering i stället.

AssistantsClient(string, KeyCredential, AssistantsClientOptions)

Initierar en instans av AssistantsClient för användning med en OpenAI-resurs.

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

Parametrar

endpoint

string

URI för en Azure OpenAI-resurs, inklusive protokoll och värdnamn. Exempel: https://my-resource.openai.azure.com.

credential

KeyCredential

En nyckelautentiseringsuppgift som används för att autentisera till en Azure OpenAI-resurs.

options

AssistantsClientOptions

Alternativen för att konfigurera klienten.

Kommentarer

Den här konstruktorn initierar ett AssistantsClient-objekt som bara kan användas med Azure OpenAI-resurser. Om du vill använda AssistantsClient med en slutpunkt för icke-Azure OpenAI-slutsatsdragning använder du en konstruktor som accepterar en icke-Azure OpenAI API-nyckel i stället.

AssistantsClient(string, TokenCredential, AssistantsClientOptions)

Initierar en instans av AssistantsClient för användning med en Azure OpenAI-resurs.

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

Parametrar

endpoint

string

URI för en Azure OpenAI-resurs, inklusive protokoll och värdnamn. Exempel: https://my-resource.openai.azure.com.

credential

TokenCredential

En tokenautentiseringsuppgift som används för att autentisera med en Azure OpenAI-resurs.

options

AssistantsClientOptions

Alternativen för att konfigurera klienten.

Egenskapsinformation

pipeline

Pipelinen som används av den här klienten för att göra begäranden

pipeline: Pipeline

Egenskapsvärde

Pipeline

Metodinformation

cancelRun(string, string, CancelRunOptions)

Avbryter en körning av en pågående tråd.

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

Parametrar

threadId

string

runId

string

options

CancelRunOptions

Returer

Promise<ThreadRun>

createAssistant(AssistantCreationOptions, CreateAssistantOptions)

Skapar en ny assistent.

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

Parametrar

body

AssistantCreationOptions

options

CreateAssistantOptions

Returer

Promise<Assistant>

createAssistantFile(string, string, CreateAssistantFileOptions)

Bifogar en tidigare uppladdad fil till en assistent för användning av verktyg som kan läsa filer.

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

Parametrar

assistantId

string

fileId

string

options

CreateAssistantFileOptions

Returer

Promise<AssistantFile>

createMessage(string, string, string, CreateMessageOptions)

Skapar ett nytt meddelande i en angiven tråd.

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

Parametrar

threadId

string

role

string

content

string

options

CreateMessageOptions

Returer

Promise<ThreadMessage>

createRun(string, CreateRunOptions, CreateRunRequestOptions)

Skapar en ny körning för en assistent tråd.

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

Parametrar

threadId

string

createRunOptions

CreateRunOptions

options

CreateRunRequestOptions

Returer

Promise<ThreadRun>

createThread(AssistantThreadCreationOptions, CreateThreadOptions)

Skapar en ny tråd. Trådar innehåller meddelanden och kan köras av assistenter.

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

Parametrar

body

AssistantThreadCreationOptions

options

CreateThreadOptions

Returer

Promise<AssistantThread>

createThreadAndRun(CreateAndRunThreadOptions, CreateThreadAndRunOptions)

Skapar en ny assistent tråd och startar omedelbart en körning med den nya tråden.

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

Parametrar

body

CreateAndRunThreadOptions

options

CreateThreadAndRunOptions

Returer

Promise<ThreadRun>

deleteAssistant(string, DeleteAssistantOptions)

Tar bort en assistent.

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

Parametrar

assistantId

string

options

DeleteAssistantOptions

Returer

Promise<AssistantDeletionStatus>

deleteAssistantFile(string, string, DeleteAssistantFileOptions)

Avlänkar en tidigare bifogad fil från en assistent, vilket gör den otillgänglig för användning av verktyg som kan läsa filer.

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

Parametrar

assistantId

string

fileId

string

options

DeleteAssistantFileOptions

Returer

Promise<AssistantFileDeletionStatus>

deleteFile(string, DeleteFileOptions)

Ta bort en tidigare uppladdad fil.

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

Parametrar

fileId

string

options

DeleteFileOptions

Returer

Promise<FileDeletionStatus>

deleteThread(string, DeleteThreadOptions)

Tar bort en befintlig tråd.

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

Parametrar

threadId

string

options

DeleteThreadOptions

Returer

Promise<ThreadDeletionStatus>

getAssistant(string, GetAssistantOptions)

Hämtar en befintlig assistent.

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

Parametrar

assistantId

string

options

GetAssistantOptions

Returer

Promise<Assistant>

getAssistantFile(string, string, GetAssistantFileOptions)

Hämtar en fil som är kopplad till en assistent.

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

Parametrar

assistantId

string

fileId

string

options

GetAssistantFileOptions

Returer

Promise<AssistantFile>

getFile(string, GetFileOptions)

Returnerar information om en specifik fil. Hämtar inte filinnehåll.

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

Parametrar

fileId

string

options

GetFileOptions

Returer

Promise<InputFile>

getMessage(string, string, GetMessageOptions)

Hämtar ett befintligt meddelande från en befintlig tråd.

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

Parametrar

threadId

string

messageId

string

options

GetMessageOptions

Returer

Promise<ThreadMessage>

getMessageFile(string, string, string, GetMessageFileOptions)

Hämtar information om en filbilaga till ett meddelande i en tråd.

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

Parametrar

threadId

string

messageId

string

fileId

string

options

GetMessageFileOptions

Returer

Promise<MessageFile>

getRun(string, string, GetRunOptions)

Hämtar en befintlig körning från en befintlig tråd.

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

Parametrar

threadId

string

runId

string

options

GetRunOptions

Returer

Promise<ThreadRun>

getRunStep(string, string, string, GetRunStepOptions)

Hämtar ett enda körningssteg från en trådkörning.

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

Parametrar

threadId

string

runId

string

stepId

string

options

GetRunStepOptions

Returer

Promise<RunStep>

getThread(string, GetThreadOptions)

Hämtar information om en befintlig tråd.

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

Parametrar

threadId

string

options

GetThreadOptions

Returer

Promise<AssistantThread>

listAssistantFiles(string, ListAssistantFilesOptions)

Hämtar en lista över filer som är kopplade till en specifik assistent, som används av verktyg som kan läsa filer.

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

Parametrar

assistantId

string

options

ListAssistantFilesOptions

Returer

Promise<ListResponseOf<AssistantFile>>

listAssistants(ListAssistantsOptions)

Hämtar en lista över assistenter som skapades tidigare.

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

Parametrar

options

ListAssistantsOptions

Returer

Promise<ListResponseOf<Assistant>>

listFiles(ListFilesOptions)

Hämtar en lista över tidigare uppladdade filer.

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

Parametrar

options

ListFilesOptions

Returer

Promise<FileListResponse>

listMessageFiles(string, string, ListMessageFilesOptions)

Hämtar en lista över tidigare uppladdade filer som är associerade med ett meddelande från en tråd.

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

Parametrar

threadId

string

messageId

string

options

ListMessageFilesOptions

Returer

Promise<ListResponseOf<MessageFile>>

listMessages(string, ListMessagesOptions)

Hämtar en lista över meddelanden som finns i en tråd.

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

Parametrar

threadId

string

options

ListMessagesOptions

Returer

Promise<ListResponseOf<ThreadMessage>>

listRuns(string, ListRunsOptions)

Hämtar en lista över körningar för en angiven tråd.

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

Parametrar

threadId

string

options

ListRunsOptions

Returer

Promise<ListResponseOf<ThreadRun>>

listRunSteps(string, string, ListRunStepsOptions)

Hämtar en lista över körningssteg från en trådkörning.

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

Parametrar

threadId

string

runId

string

options

ListRunStepsOptions

Returer

Promise<ListResponseOf<RunStep>>

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

Skickar utdata från verktyg som begärs av verktygsanrop i en körning. Körningar som behöver skickade verktygsutdata har statusen "requires_action" med en required_action.type av "submit_tool_outputs".

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

Parametrar

threadId

string

runId

string

toolOutputs

ToolOutput[]

options

SubmitToolOutputsToRunOptions

Returer

Promise<ThreadRun>

updateAssistant(string, UpdateAssistantOptions, UpdateAssistantRequestOptions)

Ändrar en befintlig assistent.

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

Parametrar

assistantId

string

body

UpdateAssistantOptions

options

UpdateAssistantRequestOptions

Returer

Promise<Assistant>

updateMessage(string, string, UpdateMessageOptions)

Ändrar ett befintligt meddelande i en befintlig tråd.

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

Parametrar

threadId

string

messageId

string

options

UpdateMessageOptions

Returer

Promise<ThreadMessage>

updateRun(string, string, UpdateRunOptions)

Ändrar en befintlig trådkörning.

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

Parametrar

threadId

string

runId

string

options

UpdateRunOptions

Returer

Promise<ThreadRun>

updateThread(string, UpdateThreadOptions)

Ändrar en befintlig tråd.

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

Parametrar

threadId

string

options

UpdateThreadOptions

Returer

Promise<AssistantThread>

uploadFile(Uint8Array, string, UploadFileOptions)

Laddar upp en fil för användning av andra åtgärder.

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

Parametrar

file

Uint8Array

purpose

string

options

UploadFileOptions

Returer

Promise<InputFile>