AssistantsClient class

Pakiet:

@azure/openai-assistants

Ostrzeżenie

Ten interfejs API jest już przestarzały.

The Azure OpenAI Assistants client library for JavaScript beta will be retired on January 14th, 2025. Please migrate to the stable OpenAI SDK for JavaScript using the migration guide before that date.

Operacje związane z asystentem obsługi klienta.

Konstruktory

AssistantsClient(KeyCredential, AssistantsClientOptions)	Inicjuje wystąpienie elementu AssistantsClient do użycia z punktem końcowym innej niż Azure OpenAI.
AssistantsClient(string, KeyCredential, AssistantsClientOptions)	Inicjuje wystąpienie Elementu AssistantsClient do użycia z zasobem OpenAI.
AssistantsClient(string, TokenCredential, AssistantsClientOptions)	Inicjuje wystąpienie elementu AssistantsClient do użycia z zasobem usługi Azure OpenAI.

Właściwości

pipeline

Potok używany przez tego klienta do tworzenia żądań

Metody

cancelRun(string, string, CancelRunOptions)	Anuluje przebieg wątku w toku.
createAssistant(AssistantCreationOptions, CreateAssistantOptions)	Tworzy nowego asystenta.
createAssistantFile(string, string, CreateAssistantFileOptions)	Dołącza wcześniej przekazany plik do asystenta do użytku przez narzędzia, które mogą odczytywać pliki.
createMessage(string, string, string, CreateMessageOptions)	Tworzy nowy komunikat w określonym wątku.
createRun(string, CreateRunOptions, CreateRunRequestOptions)	Tworzy nowy przebieg dla wątku asystenta.
createThread(AssistantThreadCreationOptions, CreateThreadOptions)	Tworzy nowy wątek. Wątki zawierają komunikaty i mogą być uruchamiane przez asystentów.
createThreadAndRun(CreateAndRunThreadOptions, CreateThreadAndRunOptions)	Tworzy nowy wątek asystenta i natychmiast uruchamia przebieg przy użyciu tego nowego wątku.
deleteAssistant(string, DeleteAssistantOptions)	Usuwa asystenta.
deleteAssistantFile(string, string, DeleteAssistantFileOptions)	Odłącza wcześniej dołączony plik od asystenta, co sprawia, że jest niedostępny do użycia przez narzędzia, które mogą odczytywać pliki.
deleteFile(string, DeleteFileOptions)	Usuń wcześniej przekazany plik.
deleteThread(string, DeleteThreadOptions)	Usuwa istniejący wątek.
getAssistant(string, GetAssistantOptions)	Pobiera istniejącego asystenta.
getAssistantFile(string, string, GetAssistantFileOptions)	Pobiera plik dołączony do asystenta.
getFile(string, GetFileOptions)	Zwraca informacje o określonym pliku. Nie pobiera zawartości pliku.
getMessage(string, string, GetMessageOptions)	Pobiera istniejący komunikat z istniejącego wątku.
getMessageFile(string, string, string, GetMessageFileOptions)	Pobiera informacje o załączniku pliku do wiadomości w wątku.
getRun(string, string, GetRunOptions)	Pobiera istniejące uruchomienie z istniejącego wątku.
getRunStep(string, string, string, GetRunStepOptions)	Pobiera pojedynczy krok przebiegu z uruchomienia wątku.
getThread(string, GetThreadOptions)	Pobiera informacje o istniejącym wątku.
listAssistantFiles(string, ListAssistantFilesOptions)	Pobiera listę plików dołączonych do określonego asystenta, co jest używane przez narzędzia, które mogą odczytywać pliki.
listAssistants(ListAssistantsOptions)	Pobiera listę asystentów, które zostały wcześniej utworzone.
listFiles(ListFilesOptions)	Pobiera listę wcześniej przekazanych plików.
listMessageFiles(string, string, ListMessageFilesOptions)	Pobiera listę wcześniej przekazanych plików skojarzonych z komunikatem z wątku.
listMessages(string, ListMessagesOptions)	Pobiera listę komunikatów, które istnieją w wątku.
listRuns(string, ListRunsOptions)	Pobiera listę przebiegów dla określonego wątku.
listRunSteps(string, string, ListRunStepsOptions)	Pobiera listę kroków uruchamiania z przebiegu wątku.
submitToolOutputsToRun(string, string, ToolOutput[], SubmitToolOutputsToRunOptions)	Przesyła dane wyjściowe z narzędzi zgodnie z żądaniem wywołań narzędzi w przebiegu. Uruchomienia wymagające przesłanych danych wyjściowych narzędzia będą miały stan "requires_action" z required_action.typem "submit_tool_outputs".
updateAssistant(string, UpdateAssistantOptions, UpdateAssistantRequestOptions)	Modyfikuje istniejącego asystenta.
updateMessage(string, string, UpdateMessageOptions)	Modyfikuje istniejący komunikat w istniejącym wątku.
updateRun(string, string, UpdateRunOptions)	Modyfikuje istniejący przebieg wątku.
updateThread(string, UpdateThreadOptions)	Modyfikuje istniejący wątek.
uploadFile(Uint8Array, string, UploadFileOptions)	Przekazuje plik do użycia przez inne operacje.

Szczegóły konstruktora

AssistantsClient(KeyCredential, AssistantsClientOptions)

Inicjuje wystąpienie elementu AssistantsClient do użycia z punktem końcowym innej niż Azure OpenAI.

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

Parametry

openAiApiKey

KeyCredential

Klucz interfejsu API do użycia podczas nawiązywania połączenia z punktem końcowym spoza usługi Azure OpenAI.

options

AssistantsClientOptions

Opcje konfigurowania klienta.

Uwagi

AssistantsClient obiekty zainicjowane za pomocą tego konstruktora mogą być używane tylko z punktem końcowym wnioskowania innego niż Azure OpenAI. Aby użyć elementu AssistantsClient z zasobem usługi Azure OpenAI, użyj konstruktora, który zamiast tego akceptuje identyfikator URI zasobu i poświadczenia uwierzytelniania platformy Azure.

AssistantsClient(string, KeyCredential, AssistantsClientOptions)

Inicjuje wystąpienie Elementu AssistantsClient do użycia z zasobem OpenAI.

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

Parametry

endpoint

string

Identyfikator URI zasobu usługi Azure OpenAI, w tym protokół i nazwa hosta. Na przykład: https://my-resource.openai.azure.com.

credential

KeyCredential

Poświadczenia klucza używane do uwierzytelniania w zasobie usługi Azure OpenAI.

options

AssistantsClientOptions

Opcje konfigurowania klienta.

Uwagi

Ten konstruktor inicjuje obiekt AssistantsClient, który może być używany tylko z zasobami usługi Azure OpenAI. Aby użyć klasy AssistantsClient z punktem końcowym wnioskowania innego niż Azure OpenAI, użyj konstruktora akceptującego klucz interfejsu API innego niż Azure OpenAI.

AssistantsClient(string, TokenCredential, AssistantsClientOptions)

Inicjuje wystąpienie elementu AssistantsClient do użycia z zasobem usługi Azure OpenAI.

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

Parametry

endpoint

string

Identyfikator URI zasobu usługi Azure OpenAI, w tym protokół i nazwa hosta. Na przykład: https://my-resource.openai.azure.com.

credential

TokenCredential

Poświadczenia tokenu używane do uwierzytelniania za pomocą zasobu usługi Azure OpenAI.

options

AssistantsClientOptions

Opcje konfigurowania klienta.

Szczegóły właściwości

pipeline

Potok używany przez tego klienta do tworzenia żądań

pipeline: Pipeline

Wartość właściwości

Pipeline

Szczegóły metody

cancelRun(string, string, CancelRunOptions)

Anuluje przebieg wątku w toku.

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

Parametry

threadId

string

runId

string

options

CancelRunOptions

Zwraca

Promise<ThreadRun>

createAssistant(AssistantCreationOptions, CreateAssistantOptions)

Tworzy nowego asystenta.

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

Parametry

body

AssistantCreationOptions

options

CreateAssistantOptions

Zwraca

Promise<Assistant>

createAssistantFile(string, string, CreateAssistantFileOptions)

Dołącza wcześniej przekazany plik do asystenta do użytku przez narzędzia, które mogą odczytywać pliki.

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

Parametry

assistantId

string

fileId

string

options

CreateAssistantFileOptions

Zwraca

Promise<AssistantFile>

createMessage(string, string, string, CreateMessageOptions)

Tworzy nowy komunikat w określonym wątku.

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

Parametry

threadId

string

role

string

content

string

options

CreateMessageOptions

Zwraca

Promise<ThreadMessage>

createRun(string, CreateRunOptions, CreateRunRequestOptions)

Tworzy nowy przebieg dla wątku asystenta.

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

Parametry

threadId

string

createRunOptions

CreateRunOptions

options

CreateRunRequestOptions

Zwraca

Promise<ThreadRun>

createThread(AssistantThreadCreationOptions, CreateThreadOptions)

Tworzy nowy wątek. Wątki zawierają komunikaty i mogą być uruchamiane przez asystentów.

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

Parametry

body

AssistantThreadCreationOptions

options

CreateThreadOptions

Zwraca

Promise<AssistantThread>

createThreadAndRun(CreateAndRunThreadOptions, CreateThreadAndRunOptions)

Tworzy nowy wątek asystenta i natychmiast uruchamia przebieg przy użyciu tego nowego wątku.

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

Parametry

body

CreateAndRunThreadOptions

options

CreateThreadAndRunOptions

Zwraca

Promise<ThreadRun>

deleteAssistant(string, DeleteAssistantOptions)

Usuwa asystenta.

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

Parametry

assistantId

string

options

DeleteAssistantOptions

Zwraca

Promise<AssistantDeletionStatus>

deleteAssistantFile(string, string, DeleteAssistantFileOptions)

Odłącza wcześniej dołączony plik od asystenta, co sprawia, że jest niedostępny do użycia przez narzędzia, które mogą odczytywać pliki.

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

Parametry

assistantId

string

fileId

string

options

DeleteAssistantFileOptions

Zwraca

Promise<AssistantFileDeletionStatus>

deleteFile(string, DeleteFileOptions)

Usuń wcześniej przekazany plik.

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

Parametry

fileId

string

options

DeleteFileOptions

Zwraca

Promise<FileDeletionStatus>

deleteThread(string, DeleteThreadOptions)

Usuwa istniejący wątek.

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

Parametry

threadId

string

options

DeleteThreadOptions

Zwraca

Promise<ThreadDeletionStatus>

getAssistant(string, GetAssistantOptions)

Pobiera istniejącego asystenta.

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

Parametry

assistantId

string

options

GetAssistantOptions

Zwraca

Promise<Assistant>

getAssistantFile(string, string, GetAssistantFileOptions)

Pobiera plik dołączony do asystenta.

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

Parametry

assistantId

string

fileId

string

options

GetAssistantFileOptions

Zwraca

Promise<AssistantFile>

getFile(string, GetFileOptions)

Zwraca informacje o określonym pliku. Nie pobiera zawartości pliku.

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

Parametry

fileId

string

options

GetFileOptions

Zwraca

Promise<InputFile>

getMessage(string, string, GetMessageOptions)

Pobiera istniejący komunikat z istniejącego wątku.

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

Parametry

threadId

string

messageId

string

options

GetMessageOptions

Zwraca

Promise<ThreadMessage>

getMessageFile(string, string, string, GetMessageFileOptions)

Pobiera informacje o załączniku pliku do wiadomości w wątku.

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

Parametry

threadId

string

messageId

string

fileId

string

options

GetMessageFileOptions

Zwraca

Promise<MessageFile>

getRun(string, string, GetRunOptions)

Pobiera istniejące uruchomienie z istniejącego wątku.

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

Parametry

threadId

string

runId

string

options

GetRunOptions

Zwraca

Promise<ThreadRun>

getRunStep(string, string, string, GetRunStepOptions)

Pobiera pojedynczy krok przebiegu z uruchomienia wątku.

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

Parametry

threadId

string

runId

string

stepId

string

options

GetRunStepOptions

Zwraca

Promise<RunStep>

getThread(string, GetThreadOptions)

Pobiera informacje o istniejącym wątku.

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

Parametry

threadId

string

options

GetThreadOptions

Zwraca

Promise<AssistantThread>

listAssistantFiles(string, ListAssistantFilesOptions)

Pobiera listę plików dołączonych do określonego asystenta, co jest używane przez narzędzia, które mogą odczytywać pliki.

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

Parametry

assistantId

string

options

ListAssistantFilesOptions

Zwraca

Promise<ListResponseOf<AssistantFile>>

listAssistants(ListAssistantsOptions)

Pobiera listę asystentów, które zostały wcześniej utworzone.

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

Parametry

options

ListAssistantsOptions

Zwraca

Promise<ListResponseOf<Assistant>>

listFiles(ListFilesOptions)

Pobiera listę wcześniej przekazanych plików.

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

Parametry

options

ListFilesOptions

Zwraca

Promise<FileListResponse>

listMessageFiles(string, string, ListMessageFilesOptions)

Pobiera listę wcześniej przekazanych plików skojarzonych z komunikatem z wątku.

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

Parametry

threadId

string

messageId

string

options

ListMessageFilesOptions

Zwraca

Promise<ListResponseOf<MessageFile>>

listMessages(string, ListMessagesOptions)

Pobiera listę komunikatów, które istnieją w wątku.

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

Parametry

threadId

string

options

ListMessagesOptions

Zwraca

Promise<ListResponseOf<ThreadMessage>>

listRuns(string, ListRunsOptions)

Pobiera listę przebiegów dla określonego wątku.

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

Parametry

threadId

string

options

ListRunsOptions

Zwraca

Promise<ListResponseOf<ThreadRun>>

listRunSteps(string, string, ListRunStepsOptions)

Pobiera listę kroków uruchamiania z przebiegu wątku.

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

Parametry

threadId

string

runId

string

options

ListRunStepsOptions

Zwraca

Promise<ListResponseOf<RunStep>>

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

Przesyła dane wyjściowe z narzędzi zgodnie z żądaniem wywołań narzędzi w przebiegu. Uruchomienia wymagające przesłanych danych wyjściowych narzędzia będą miały stan "requires_action" z required_action.typem "submit_tool_outputs".

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

Parametry

threadId

string

runId

string

toolOutputs

ToolOutput[]

options

SubmitToolOutputsToRunOptions

Zwraca

Promise<ThreadRun>

updateAssistant(string, UpdateAssistantOptions, UpdateAssistantRequestOptions)

Modyfikuje istniejącego asystenta.

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

Parametry

assistantId

string

body

UpdateAssistantOptions

options

UpdateAssistantRequestOptions

Zwraca

Promise<Assistant>

updateMessage(string, string, UpdateMessageOptions)

Modyfikuje istniejący komunikat w istniejącym wątku.

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

Parametry

threadId

string

messageId

string

options

UpdateMessageOptions

Zwraca

Promise<ThreadMessage>

updateRun(string, string, UpdateRunOptions)

Modyfikuje istniejący przebieg wątku.

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

Parametry

threadId

string

runId

string

options

UpdateRunOptions

Zwraca

Promise<ThreadRun>

updateThread(string, UpdateThreadOptions)

Modyfikuje istniejący wątek.

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

Parametry

threadId

string

options

UpdateThreadOptions

Zwraca

Promise<AssistantThread>

uploadFile(Uint8Array, string, UploadFileOptions)

Przekazuje plik do użycia przez inne operacje.

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

Parametry

file

Uint8Array

purpose

string

options

UploadFileOptions

Zwraca

Promise<InputFile>