AssistantsClient class

Pakket:

@azure/openai-assistants

Clientafhandeling assistent gerelateerde bewerkingen.

Constructors

AssistantsClient(KeyCredential, AssistantsClientOptions)	Initialiseert een exemplaar van AssistantsClient voor gebruik met het niet-Azure OpenAI-eindpunt.
AssistantsClient(string, KeyCredential, AssistantsClientOptions)	Initialiseert een exemplaar van AssistantsClient voor gebruik met een OpenAI-resource.
AssistantsClient(string, TokenCredential, AssistantsClientOptions)	Initialiseert een exemplaar van AssistantsClient voor gebruik met een Azure OpenAI-resource.

Eigenschappen

pipeline

De pijplijn die door deze client wordt gebruikt om aanvragen te doen

Methoden

cancelRun(string, string, CancelRunOptions)	Hiermee annuleert u een uitvoering van een thread die wordt uitgevoerd.
createAssistant(AssistantCreationOptions, CreateAssistantOptions)	Hiermee maakt u een nieuwe assistent.
createAssistantFile(string, string, CreateAssistantFileOptions)	Voegt een eerder geüpload bestand toe aan een assistent voor gebruik door hulpprogramma's die bestanden kunnen lezen.
createMessage(string, string, string, CreateMessageOptions)	Hiermee maakt u een nieuw bericht op een opgegeven thread.
createRun(string, CreateRunOptions, CreateRunRequestOptions)	Hiermee maakt u een nieuwe uitvoering voor een assistent thread.
createThread(AssistantThreadCreationOptions, CreateThreadOptions)	Hiermee maakt u een nieuwe thread. Threads bevatten berichten en kunnen worden uitgevoerd door assistenten.
createThreadAndRun(CreateAndRunThreadOptions, CreateThreadAndRunOptions)	Hiermee maakt u een nieuwe assistent thread en start u onmiddellijk een uitvoering met behulp van die nieuwe thread.
deleteAssistant(string, DeleteAssistantOptions)	Hiermee verwijdert u een assistent.
deleteAssistantFile(string, string, DeleteAssistantFileOptions)	Hiermee wordt een eerder bijgevoegd bestand ontkoppeld van een assistent, waardoor het niet meer beschikbaar is voor gebruik door hulpprogramma's die bestanden kunnen lezen.
deleteFile(string, DeleteFileOptions)	Een eerder geüpload bestand verwijderen.
deleteThread(string, DeleteThreadOptions)	Hiermee verwijdert u een bestaande thread.
getAssistant(string, GetAssistantOptions)	Hiermee haalt u een bestaande assistent op.
getAssistantFile(string, string, GetAssistantFileOptions)	Hiermee wordt een bestand opgehaald dat is gekoppeld aan een assistent.
getFile(string, GetFileOptions)	Retourneert informatie over een specifiek bestand. Hiermee wordt geen bestandsinhoud opgehaald.
getMessage(string, string, GetMessageOptions)	Hiermee haalt u een bestaand bericht op van een bestaande thread.
getMessageFile(string, string, string, GetMessageFileOptions)	Hiermee haalt u informatie op over een bestandsbijlage bij een bericht in een thread.
getRun(string, string, GetRunOptions)	Hiermee haalt u een bestaande uitvoering op van een bestaande thread.
getRunStep(string, string, string, GetRunStepOptions)	Hiermee haalt u één uitvoeringsstap op van een threaduitvoering.
getThread(string, GetThreadOptions)	Hiermee haalt u informatie op over een bestaande thread.
listAssistantFiles(string, ListAssistantFilesOptions)	Hiermee haalt u een lijst op met bestanden die zijn gekoppeld aan een specifieke assistent, zoals gebruikt door hulpprogramma's die bestanden kunnen lezen.
listAssistants(ListAssistantsOptions)	Hiermee haalt u een lijst op met assistenten die eerder zijn gemaakt.
listFiles(ListFilesOptions)	Hiermee haalt u een lijst met eerder geüploade bestanden op.
listMessageFiles(string, string, ListMessageFilesOptions)	Hiermee haalt u een lijst op met eerder geüploade bestanden die zijn gekoppeld aan een bericht van een thread.
listMessages(string, ListMessagesOptions)	Hiermee haalt u een lijst op met berichten die aanwezig zijn in een thread.
listRuns(string, ListRunsOptions)	Hiermee wordt een lijst met uitvoeringen voor een opgegeven thread opgehaald.
listRunSteps(string, string, ListRunStepsOptions)	Hiermee haalt u een lijst met uitvoeringsstappen van een threaduitvoering op.
submitToolOutputsToRun(string, string, ToolOutput[], SubmitToolOutputsToRunOptions)	Verzendt uitvoer van hulpprogramma's zoals aangevraagd door hulpprogramma-aanroepen in een uitvoering. Uitvoeringen waarvoor de uitvoer van het hulpprogramma is verzonden, hebben de status 'requires_action' met een required_action.type 'submit_tool_outputs'.
updateAssistant(string, UpdateAssistantOptions, UpdateAssistantRequestOptions)	Hiermee wijzigt u een bestaande assistent.
updateMessage(string, string, UpdateMessageOptions)	Hiermee wijzigt u een bestaand bericht in een bestaande thread.
updateRun(string, string, UpdateRunOptions)	Hiermee wijzigt u een bestaande threaduitvoering.
updateThread(string, UpdateThreadOptions)	Hiermee wijzigt u een bestaande thread.
uploadFile(Uint8Array, string, UploadFileOptions)	Uploadt een bestand voor gebruik door andere bewerkingen.

Constructordetails

AssistantsClient(KeyCredential, AssistantsClientOptions)

Initialiseert een exemplaar van AssistantsClient voor gebruik met het niet-Azure OpenAI-eindpunt.

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

Parameters

openAiApiKey

KeyCredential

De API-sleutel die moet worden gebruikt om verbinding te maken met het niet-Azure OpenAI-eindpunt.

options

AssistantsClientOptions

De opties voor het configureren van de client.

Opmerkingen

AssistantsClient-objecten die met deze constructor zijn geïnitialiseerd, kunnen alleen worden gebruikt met het niet-Azure OpenAI-deductie-eindpunt. Als u AssistantsClient wilt gebruiken met een Azure OpenAI-resource, gebruikt u een constructor die in plaats daarvan een resource-URI en Azure-verificatiereferentie accepteert.

AssistantsClient(string, KeyCredential, AssistantsClientOptions)

Initialiseert een exemplaar van AssistantsClient voor gebruik met een OpenAI-resource.

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

Parameters

endpoint

string

De URI voor een Azure OpenAI-resource, inclusief protocol en hostnaam. Bijvoorbeeld: https://my-resource.openai.azure.com.

credential

KeyCredential

Een sleutelreferentie die wordt gebruikt voor verificatie bij een Azure OpenAI-resource.

options

AssistantsClientOptions

De opties voor het configureren van de client.

Opmerkingen

Met deze constructor wordt een AssistantsClient-object geïnitialiseerd dat alleen kan worden gebruikt met Azure OpenAI-resources. Als u AssistantsClient wilt gebruiken met een niet-Azure OpenAI-deductie-eindpunt, gebruikt u een constructor die in plaats daarvan een niet-Azure OpenAI API-sleutel accepteert.

AssistantsClient(string, TokenCredential, AssistantsClientOptions)

Initialiseert een exemplaar van AssistantsClient voor gebruik met een Azure OpenAI-resource.

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

Parameters

endpoint

string

De URI voor een Azure OpenAI-resource, inclusief protocol en hostnaam. Bijvoorbeeld: https://my-resource.openai.azure.com.

credential

TokenCredential

Een tokenreferentie die wordt gebruikt voor verificatie met een Azure OpenAI-resource.

options

AssistantsClientOptions

De opties voor het configureren van de client.

Eigenschapdetails

pipeline

De pijplijn die door deze client wordt gebruikt om aanvragen te doen

pipeline: Pipeline

Waarde van eigenschap

Pipeline

Methodedetails

cancelRun(string, string, CancelRunOptions)

Hiermee annuleert u een uitvoering van een thread die wordt uitgevoerd.

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

Parameters

threadId

string

runId

string

options

CancelRunOptions

Retouren

Promise<ThreadRun>

createAssistant(AssistantCreationOptions, CreateAssistantOptions)

Hiermee maakt u een nieuwe assistent.

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

Parameters

body

AssistantCreationOptions

options

CreateAssistantOptions

Retouren

Promise<Assistant>

createAssistantFile(string, string, CreateAssistantFileOptions)

Voegt een eerder geüpload bestand toe aan een assistent voor gebruik door hulpprogramma's die bestanden kunnen lezen.

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

Parameters

assistantId

string

fileId

string

options

CreateAssistantFileOptions

Retouren

Promise<AssistantFile>

createMessage(string, string, string, CreateMessageOptions)

Hiermee maakt u een nieuw bericht op een opgegeven thread.

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

Parameters

threadId

string

role

string

content

string

options

CreateMessageOptions

Retouren

Promise<ThreadMessage>

createRun(string, CreateRunOptions, CreateRunRequestOptions)

Hiermee maakt u een nieuwe uitvoering voor een assistent thread.

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

Parameters

threadId

string

createRunOptions

CreateRunOptions

options

CreateRunRequestOptions

Retouren

Promise<ThreadRun>

createThread(AssistantThreadCreationOptions, CreateThreadOptions)

Hiermee maakt u een nieuwe thread. Threads bevatten berichten en kunnen worden uitgevoerd door assistenten.

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

Parameters

body

AssistantThreadCreationOptions

options

CreateThreadOptions

Retouren

Promise<AssistantThread>

createThreadAndRun(CreateAndRunThreadOptions, CreateThreadAndRunOptions)

Hiermee maakt u een nieuwe assistent thread en start u onmiddellijk een uitvoering met behulp van die nieuwe thread.

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

Parameters

body

CreateAndRunThreadOptions

options

CreateThreadAndRunOptions

Retouren

Promise<ThreadRun>

deleteAssistant(string, DeleteAssistantOptions)

Hiermee verwijdert u een assistent.

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

Parameters

assistantId

string

options

DeleteAssistantOptions

Retouren

Promise<AssistantDeletionStatus>

deleteAssistantFile(string, string, DeleteAssistantFileOptions)

Hiermee wordt een eerder bijgevoegd bestand ontkoppeld van een assistent, waardoor het niet meer beschikbaar is voor gebruik door hulpprogramma's die bestanden kunnen lezen.

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

Parameters

assistantId

string

fileId

string

options

DeleteAssistantFileOptions

Retouren

Promise<AssistantFileDeletionStatus>

deleteFile(string, DeleteFileOptions)

Een eerder geüpload bestand verwijderen.

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

Parameters

fileId

string

options

DeleteFileOptions

Retouren

Promise<FileDeletionStatus>

deleteThread(string, DeleteThreadOptions)

Hiermee verwijdert u een bestaande thread.

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

Parameters

threadId

string

options

DeleteThreadOptions

Retouren

Promise<ThreadDeletionStatus>

getAssistant(string, GetAssistantOptions)

Hiermee haalt u een bestaande assistent op.

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

Parameters

assistantId

string

options

GetAssistantOptions

Retouren

Promise<Assistant>

getAssistantFile(string, string, GetAssistantFileOptions)

Hiermee wordt een bestand opgehaald dat is gekoppeld aan een assistent.

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

Parameters

assistantId

string

fileId

string

options

GetAssistantFileOptions

Retouren

Promise<AssistantFile>

getFile(string, GetFileOptions)

Retourneert informatie over een specifiek bestand. Hiermee wordt geen bestandsinhoud opgehaald.

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

Parameters

fileId

string

options

GetFileOptions

Retouren

Promise<InputFile>

getMessage(string, string, GetMessageOptions)

Hiermee haalt u een bestaand bericht op van een bestaande thread.

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

Parameters

threadId

string

messageId

string

options

GetMessageOptions

Retouren

Promise<ThreadMessage>

getMessageFile(string, string, string, GetMessageFileOptions)

Hiermee haalt u informatie op over een bestandsbijlage bij een bericht in een thread.

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

Parameters

threadId

string

messageId

string

fileId

string

options

GetMessageFileOptions

Retouren

Promise<MessageFile>

getRun(string, string, GetRunOptions)

Hiermee haalt u een bestaande uitvoering op van een bestaande thread.

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

Parameters

threadId

string

runId

string

options

GetRunOptions

Retouren

Promise<ThreadRun>

getRunStep(string, string, string, GetRunStepOptions)

Hiermee haalt u één uitvoeringsstap op van een threaduitvoering.

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

Parameters

threadId

string

runId

string

stepId

string

options

GetRunStepOptions

Retouren

Promise<RunStep>

getThread(string, GetThreadOptions)

Hiermee haalt u informatie op over een bestaande thread.

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

Parameters

threadId

string

options

GetThreadOptions

Retouren

Promise<AssistantThread>

listAssistantFiles(string, ListAssistantFilesOptions)

Hiermee haalt u een lijst op met bestanden die zijn gekoppeld aan een specifieke assistent, zoals gebruikt door hulpprogramma's die bestanden kunnen lezen.

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

Parameters

assistantId

string

options

ListAssistantFilesOptions

Retouren

Promise<ListResponseOf<AssistantFile>>

listAssistants(ListAssistantsOptions)

Hiermee haalt u een lijst op met assistenten die eerder zijn gemaakt.

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

Parameters

options

ListAssistantsOptions

Retouren

Promise<ListResponseOf<Assistant>>

listFiles(ListFilesOptions)

Hiermee haalt u een lijst met eerder geüploade bestanden op.

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

Parameters

options

ListFilesOptions

Retouren

Promise<FileListResponse>

listMessageFiles(string, string, ListMessageFilesOptions)

Hiermee haalt u een lijst op met eerder geüploade bestanden die zijn gekoppeld aan een bericht van een thread.

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

Parameters

threadId

string

messageId

string

options

ListMessageFilesOptions

Retouren

Promise<ListResponseOf<MessageFile>>

listMessages(string, ListMessagesOptions)

Hiermee haalt u een lijst op met berichten die aanwezig zijn in een thread.

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

Parameters

threadId

string

options

ListMessagesOptions

Retouren

Promise<ListResponseOf<ThreadMessage>>

listRuns(string, ListRunsOptions)

Hiermee wordt een lijst met uitvoeringen voor een opgegeven thread opgehaald.

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

Parameters

threadId

string

options

ListRunsOptions

Retouren

Promise<ListResponseOf<ThreadRun>>

listRunSteps(string, string, ListRunStepsOptions)

Hiermee haalt u een lijst met uitvoeringsstappen van een threaduitvoering op.

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

Parameters

threadId

string

runId

string

options

ListRunStepsOptions

Retouren

Promise<ListResponseOf<RunStep>>

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

Verzendt uitvoer van hulpprogramma's zoals aangevraagd door hulpprogramma-aanroepen in een uitvoering. Uitvoeringen waarvoor de uitvoer van het hulpprogramma is verzonden, hebben de status 'requires_action' met een required_action.type 'submit_tool_outputs'.

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

Parameters

threadId

string

runId

string

toolOutputs

ToolOutput[]

options

SubmitToolOutputsToRunOptions

Retouren

Promise<ThreadRun>

updateAssistant(string, UpdateAssistantOptions, UpdateAssistantRequestOptions)

Hiermee wijzigt u een bestaande assistent.

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

Parameters

assistantId

string

body

UpdateAssistantOptions

options

UpdateAssistantRequestOptions

Retouren

Promise<Assistant>

updateMessage(string, string, UpdateMessageOptions)

Hiermee wijzigt u een bestaand bericht in een bestaande thread.

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

Parameters

threadId

string

messageId

string

options

UpdateMessageOptions

Retouren

Promise<ThreadMessage>

updateRun(string, string, UpdateRunOptions)

Hiermee wijzigt u een bestaande threaduitvoering.

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

Parameters

threadId

string

runId

string

options

UpdateRunOptions

Retouren

Promise<ThreadRun>

updateThread(string, UpdateThreadOptions)

Hiermee wijzigt u een bestaande thread.

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

Parameters

threadId

string

options

UpdateThreadOptions

Retouren

Promise<AssistantThread>

uploadFile(Uint8Array, string, UploadFileOptions)

Uploadt een bestand voor gebruik door andere bewerkingen.

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

Parameters

file

Uint8Array

purpose

string

options

UploadFileOptions

Retouren

Promise<InputFile>