AssistantsClient class
Klient zpracovává operace související s asistent.
Konstruktory
| Assistants |
Inicializuje instanci AssistantsClient pro použití s koncovým bodem OpenAI mimo Azure. |
| Assistants |
Inicializuje instanci AssistantsClient pro použití s prostředkem OpenAI. |
| Assistants |
Inicializuje instanci AssistantsClient pro použití s prostředkem Azure OpenAI. |
Vlastnosti
| pipeline | Kanál používaný tímto klientem k provádění požadavků |
Metody
| cancel |
Zruší spuštění probíhajícího vlákna. |
| create |
Vytvoří nový asistent. |
| create |
Připojí dříve nahraný soubor k asistent pro použití nástroji, které můžou číst soubory. |
| create |
Vytvoří novou zprávu v zadaném vlákně. |
| create |
Vytvoří nové spuštění pro vlákno asistent. |
| create |
Vytvoří nové vlákno. Vlákna obsahují zprávy a můžou je spouštět asistenti. |
| create |
Vytvoří nové vlákno asistent a okamžitě spustí spuštění pomocí nového vlákna. |
| delete |
Odstraní asistent. |
| delete |
Zruší propojení dříve připojeného souboru s asistent a znemožní jeho použití nástroji, které můžou číst soubory. |
| delete |
Odstraňte dříve nahraný soubor. |
| delete |
Odstraní existující vlákno. |
| get |
Načte existující asistent. |
| get |
Načte soubor připojený k asistent. |
| get |
Vrátí informace o konkrétním souboru. Nenačte obsah souboru. |
| get |
Získá existující zprávu z existujícího vlákna. |
| get |
Získá informace o souboru přílohy zprávy v rámci vlákna. |
| get |
Získá existující spuštění z existujícího vlákna. |
| get |
Získá jeden krok spuštění z podprocesu. |
| get |
Získá informace o existujícím vlákně. |
| list |
Získá seznam souborů připojených ke konkrétnímu asistent, jak je používají nástroje, které mohou číst soubory. |
| list |
Získá seznam dříve vytvořených pomocníků. |
| list |
Získá seznam dříve nahraných souborů. |
| list |
Získá seznam dříve nahraných souborů přidružených ke zprávě z vlákna. |
| list |
Získá seznam zpráv, které existují ve vlákně. |
| list |
Získá seznam spuštění pro zadané vlákno. |
| list |
Získá seznam kroků spuštění ze spuštění vlákna. |
| submit |
Odesílá výstupy z nástrojů podle požadavků volání nástrojů při spuštění. Spuštění, která vyžadují odeslané výstupy nástrojů, budou mít stav "requires_action" s required_action.typem "submit_tool_outputs". |
| update |
Upraví existující asistent. |
| update |
Upraví existující zprávu v existujícím vlákně. |
| update |
Upraví existující spuštění vlákna. |
| update |
Upraví existující vlákno. |
| upload |
Nahraje soubor pro použití jinými operacemi. |
Podrobnosti konstruktoru
AssistantsClient(KeyCredential, AssistantsClientOptions)
Inicializuje instanci AssistantsClient pro použití s koncovým bodem OpenAI mimo Azure.
new AssistantsClient(openAiApiKey: KeyCredential, options?: AssistantsClientOptions)Parametry
- openAiApiKey
- KeyCredential
Klíč rozhraní API, který se použije při připojování ke koncovému bodu OpenAI mimo Azure.
- options
- AssistantsClientOptions
Možnosti konfigurace klienta.
Poznámky
Objekty AssistantsClient inicializované pomocí tohoto konstruktoru je možné použít pouze s koncovým bodem odvozovače OpenAI mimo Azure. Pokud chcete použít AssistantsClient s prostředkem Azure OpenAI, použijte místo toho konstruktor, který přijímá identifikátor URI prostředku a přihlašovací údaje ověřování Azure.
AssistantsClient(string, KeyCredential, AssistantsClientOptions)
Inicializuje instanci AssistantsClient pro použití s prostředkem OpenAI.
new AssistantsClient(endpoint: string, credential: KeyCredential, options?: AssistantsClientOptions)Parametry
- endpoint
-
string
Identifikátor URI prostředku Azure OpenAI, včetně protokolu a názvu hostitele. Příklad: https://my-resource.openai.azure.com.
- credential
- KeyCredential
Přihlašovací údaje klíče používané k ověření prostředku Azure OpenAI.
- options
- AssistantsClientOptions
Možnosti konfigurace klienta.
Poznámky
Tento konstruktor inicializuje objekt AssistantsClient, který se dá použít pouze s prostředky Azure OpenAI. Pokud chcete použít AssistantsClient s koncovým bodem odvozovací služby OpenAI mimo Azure, použijte místo toho konstruktor, který přijímá klíč rozhraní API jiného typu než Azure OpenAI.
AssistantsClient(string, TokenCredential, AssistantsClientOptions)
Inicializuje instanci AssistantsClient pro použití s prostředkem Azure OpenAI.
new AssistantsClient(endpoint: string, credential: TokenCredential, options?: AssistantsClientOptions)Parametry
- endpoint
-
string
Identifikátor URI prostředku Azure OpenAI, včetně protokolu a názvu hostitele. Příklad: https://my-resource.openai.azure.com.
- credential
- TokenCredential
Přihlašovací údaje tokenu použité k ověření prostředku Azure OpenAI.
- options
- AssistantsClientOptions
Možnosti konfigurace klienta.
Podrobnosti vlastnosti
pipeline
Podrobnosti metody
cancelRun(string, string, CancelRunOptions)
Zruší spuštění probíhajícího vlákna.
function cancelRun(threadId: string, runId: string, options?: CancelRunOptions): Promise<ThreadRun>Parametry
- threadId
-
string
- runId
-
string
- options
- CancelRunOptions
Návraty
Promise<ThreadRun>
createAssistant(AssistantCreationOptions, CreateAssistantOptions)
Vytvoří nový asistent.
function createAssistant(body: AssistantCreationOptions, options?: CreateAssistantOptions): Promise<Assistant>Parametry
- options
- CreateAssistantOptions
Návraty
Promise<Assistant>
createAssistantFile(string, string, CreateAssistantFileOptions)
Připojí dříve nahraný soubor k asistent pro použití nástroji, které můžou číst soubory.
function createAssistantFile(assistantId: string, fileId: string, options?: CreateAssistantFileOptions): Promise<AssistantFile>Parametry
- assistantId
-
string
- fileId
-
string
- options
- CreateAssistantFileOptions
Návraty
Promise<AssistantFile>
createMessage(string, string, string, CreateMessageOptions)
Vytvoří novou zprávu v zadaném vlákně.
function createMessage(threadId: string, role: string, content: string, options?: CreateMessageOptions): Promise<ThreadMessage>Parametry
- threadId
-
string
- role
-
string
- content
-
string
- options
- CreateMessageOptions
Návraty
Promise<ThreadMessage>
createRun(string, CreateRunOptions, CreateRunRequestOptions)
Vytvoří nové spuštění pro vlákno asistent.
function createRun(threadId: string, createRunOptions: CreateRunOptions, options?: CreateRunRequestOptions): Promise<ThreadRun>Parametry
- threadId
-
string
- createRunOptions
- CreateRunOptions
- options
- CreateRunRequestOptions
Návraty
Promise<ThreadRun>
createThread(AssistantThreadCreationOptions, CreateThreadOptions)
Vytvoří nové vlákno. Vlákna obsahují zprávy a můžou je spouštět asistenti.
function createThread(body?: AssistantThreadCreationOptions, options?: CreateThreadOptions): Promise<AssistantThread>Parametry
- options
- CreateThreadOptions
Návraty
Promise<AssistantThread>
createThreadAndRun(CreateAndRunThreadOptions, CreateThreadAndRunOptions)
Vytvoří nové vlákno asistent a okamžitě spustí spuštění pomocí nového vlákna.
function createThreadAndRun(body: CreateAndRunThreadOptions, options?: CreateThreadAndRunOptions): Promise<ThreadRun>Parametry
- options
- CreateThreadAndRunOptions
Návraty
Promise<ThreadRun>
deleteAssistant(string, DeleteAssistantOptions)
Odstraní asistent.
function deleteAssistant(assistantId: string, options?: DeleteAssistantOptions): Promise<AssistantDeletionStatus>Parametry
- assistantId
-
string
- options
- DeleteAssistantOptions
Návraty
Promise<AssistantDeletionStatus>
deleteAssistantFile(string, string, DeleteAssistantFileOptions)
Zruší propojení dříve připojeného souboru s asistent a znemožní jeho použití nástroji, které můžou číst soubory.
function deleteAssistantFile(assistantId: string, fileId: string, options?: DeleteAssistantFileOptions): Promise<AssistantFileDeletionStatus>Parametry
- assistantId
-
string
- fileId
-
string
- options
- DeleteAssistantFileOptions
Návraty
Promise<AssistantFileDeletionStatus>
deleteFile(string, DeleteFileOptions)
Odstraňte dříve nahraný soubor.
function deleteFile(fileId: string, options?: DeleteFileOptions): Promise<FileDeletionStatus>Parametry
- fileId
-
string
- options
- DeleteFileOptions
Návraty
Promise<FileDeletionStatus>
deleteThread(string, DeleteThreadOptions)
Odstraní existující vlákno.
function deleteThread(threadId: string, options?: DeleteThreadOptions): Promise<ThreadDeletionStatus>Parametry
- threadId
-
string
- options
- DeleteThreadOptions
Návraty
Promise<ThreadDeletionStatus>
getAssistant(string, GetAssistantOptions)
Načte existující asistent.
function getAssistant(assistantId: string, options?: GetAssistantOptions): Promise<Assistant>Parametry
- assistantId
-
string
- options
- GetAssistantOptions
Návraty
Promise<Assistant>
getAssistantFile(string, string, GetAssistantFileOptions)
Načte soubor připojený k asistent.
function getAssistantFile(assistantId: string, fileId: string, options?: GetAssistantFileOptions): Promise<AssistantFile>Parametry
- assistantId
-
string
- fileId
-
string
- options
- GetAssistantFileOptions
Návraty
Promise<AssistantFile>
getFile(string, GetFileOptions)
Vrátí informace o konkrétním souboru. Nenačte obsah souboru.
function getFile(fileId: string, options?: GetFileOptions): Promise<InputFile>Parametry
- fileId
-
string
- options
- GetFileOptions
Návraty
Promise<InputFile>
getMessage(string, string, GetMessageOptions)
Získá existující zprávu z existujícího vlákna.
function getMessage(threadId: string, messageId: string, options?: GetMessageOptions): Promise<ThreadMessage>Parametry
- threadId
-
string
- messageId
-
string
- options
- GetMessageOptions
Návraty
Promise<ThreadMessage>
getMessageFile(string, string, string, GetMessageFileOptions)
Získá informace o souboru přílohy zprávy v rámci vlákna.
function getMessageFile(threadId: string, messageId: string, fileId: string, options?: GetMessageFileOptions): Promise<MessageFile>Parametry
- threadId
-
string
- messageId
-
string
- fileId
-
string
- options
- GetMessageFileOptions
Návraty
Promise<MessageFile>
getRun(string, string, GetRunOptions)
Získá existující spuštění z existujícího vlákna.
function getRun(threadId: string, runId: string, options?: GetRunOptions): Promise<ThreadRun>Parametry
- threadId
-
string
- runId
-
string
- options
- GetRunOptions
Návraty
Promise<ThreadRun>
getRunStep(string, string, string, GetRunStepOptions)
Získá jeden krok spuštění z podprocesu.
function getRunStep(threadId: string, runId: string, stepId: string, options?: GetRunStepOptions): Promise<RunStep>Parametry
- threadId
-
string
- runId
-
string
- stepId
-
string
- options
- GetRunStepOptions
Návraty
Promise<RunStep>
getThread(string, GetThreadOptions)
Získá informace o existujícím vlákně.
function getThread(threadId: string, options?: GetThreadOptions): Promise<AssistantThread>Parametry
- threadId
-
string
- options
- GetThreadOptions
Návraty
Promise<AssistantThread>
listAssistantFiles(string, ListAssistantFilesOptions)
Získá seznam souborů připojených ke konkrétnímu asistent, jak je používají nástroje, které mohou číst soubory.
function listAssistantFiles(assistantId: string, options?: ListAssistantFilesOptions): Promise<ListResponseOf<AssistantFile>>Parametry
- assistantId
-
string
- options
- ListAssistantFilesOptions
Návraty
Promise<ListResponseOf<AssistantFile>>
listAssistants(ListAssistantsOptions)
Získá seznam dříve vytvořených pomocníků.
function listAssistants(options?: ListAssistantsOptions): Promise<ListResponseOf<Assistant>>Parametry
- options
- ListAssistantsOptions
Návraty
Promise<ListResponseOf<Assistant>>
listFiles(ListFilesOptions)
Získá seznam dříve nahraných souborů.
function listFiles(options?: ListFilesOptions): Promise<FileListResponse>Parametry
- options
- ListFilesOptions
Návraty
Promise<FileListResponse>
listMessageFiles(string, string, ListMessageFilesOptions)
Získá seznam dříve nahraných souborů přidružených ke zprávě z vlákna.
function listMessageFiles(threadId: string, messageId: string, options?: ListMessageFilesOptions): Promise<ListResponseOf<MessageFile>>Parametry
- threadId
-
string
- messageId
-
string
- options
- ListMessageFilesOptions
Návraty
Promise<ListResponseOf<MessageFile>>
listMessages(string, ListMessagesOptions)
Získá seznam zpráv, které existují ve vlákně.
function listMessages(threadId: string, options?: ListMessagesOptions): Promise<ListResponseOf<ThreadMessage>>Parametry
- threadId
-
string
- options
- ListMessagesOptions
Návraty
Promise<ListResponseOf<ThreadMessage>>
listRuns(string, ListRunsOptions)
Získá seznam spuštění pro zadané vlákno.
function listRuns(threadId: string, options?: ListRunsOptions): Promise<ListResponseOf<ThreadRun>>Parametry
- threadId
-
string
- options
- ListRunsOptions
Návraty
Promise<ListResponseOf<ThreadRun>>
listRunSteps(string, string, ListRunStepsOptions)
Získá seznam kroků spuštění ze spuštění vlákna.
function listRunSteps(threadId: string, runId: string, options?: ListRunStepsOptions): Promise<ListResponseOf<RunStep>>Parametry
- threadId
-
string
- runId
-
string
- options
- ListRunStepsOptions
Návraty
Promise<ListResponseOf<RunStep>>
submitToolOutputsToRun(string, string, ToolOutput[], SubmitToolOutputsToRunOptions)
Odesílá výstupy z nástrojů podle požadavků volání nástrojů při spuštění. Spuštění, která vyžadují odeslané výstupy nástrojů, budou mít stav "requires_action" s required_action.typem "submit_tool_outputs".
function submitToolOutputsToRun(threadId: string, runId: string, toolOutputs: ToolOutput[], options?: SubmitToolOutputsToRunOptions): Promise<ThreadRun>Parametry
- threadId
-
string
- runId
-
string
- toolOutputs
- options
- SubmitToolOutputsToRunOptions
Návraty
Promise<ThreadRun>
updateAssistant(string, UpdateAssistantOptions, UpdateAssistantRequestOptions)
Upraví existující asistent.
function updateAssistant(assistantId: string, body: UpdateAssistantOptions, options?: UpdateAssistantRequestOptions): Promise<Assistant>Parametry
- assistantId
-
string
- options
- UpdateAssistantRequestOptions
Návraty
Promise<Assistant>
updateMessage(string, string, UpdateMessageOptions)
Upraví existující zprávu v existujícím vlákně.
function updateMessage(threadId: string, messageId: string, options?: UpdateMessageOptions): Promise<ThreadMessage>Parametry
- threadId
-
string
- messageId
-
string
- options
- UpdateMessageOptions
Návraty
Promise<ThreadMessage>
updateRun(string, string, UpdateRunOptions)
Upraví existující spuštění vlákna.
function updateRun(threadId: string, runId: string, options?: UpdateRunOptions): Promise<ThreadRun>Parametry
- threadId
-
string
- runId
-
string
- options
- UpdateRunOptions
Návraty
Promise<ThreadRun>
updateThread(string, UpdateThreadOptions)
Upraví existující vlákno.
function updateThread(threadId: string, options?: UpdateThreadOptions): Promise<AssistantThread>Parametry
- threadId
-
string
- options
- UpdateThreadOptions
Návraty
Promise<AssistantThread>
uploadFile(Uint8Array, string, UploadFileOptions)
Nahraje soubor pro použití jinými operacemi.
function uploadFile(file: Uint8Array, purpose: string, options?: UploadFileOptions): Promise<InputFile>Parametry
- file
-
Uint8Array
- purpose
-
string
- options
- UploadFileOptions
Návraty
Promise<InputFile>
Azure SDK for JavaScript
Váš názor
Připravujeme: V průběhu roku 2024 budeme postupně vyřazovat problémy z GitHub coby mechanismus zpětné vazby pro obsah a nahrazovat ho novým systémem zpětné vazby. Další informace naleznete v tématu: https://aka.ms/ContentUserFeedback.
Odeslat a zobrazit názory pro