@azure/openai-assistants package

Třídy

AssistantsClient	Operace související s asistentem pro zpracování klientů.
AzureKeyCredential	Přihlašovací údaje založené na statickém klíči, které podporují aktualizaci hodnoty základního klíče.
OpenAIKeyCredential	Třída OpenAIKeyCredential představuje klíč OpenAI API a používá se k ověření do klienta Assistants pro koncový bod OpenAI.

Rozhraní

Assistant	Představuje asistenta, který může volat model a používat nástroje.
AssistantCreationOptions	Podrobnosti požadavku, které se mají použít při vytváření nového asistenta.
AssistantDeletionStatus	Stav operace odstranění asistenta.
AssistantFile	Informace o souboru připojeném k asistentovi, jak jej používají nástroje, které mohou číst soubory.
AssistantFileDeletionStatus	Stav operace odstranění pomocného souboru.
AssistantThread	Informace o jednom vlákně přidruženém k asistentovi.
AssistantThreadCreationOptions	Podrobnosti použité k vytvoření nového pomocného vlákna.
AssistantsClientOptions	Podrobnosti použité k vytvoření klienta asistenta *
CancelRunOptions	Podrobnosti použité ke zrušení spuštění.
CodeInterpreterImageOutput	Reprezentace výstupu obrázku generovaného nástrojem interpreta kódu v reakci na volání nástroje modelem.
CodeInterpreterImageReference	Odkaz na obrázek vygenerovaný nástrojem interpreta kódu v reakci na volání nástroje modelem.
CodeInterpreterLogOutput	Reprezentace výstupu protokolu generovaného nástrojem interpretu kódu v reakci na volání nástroje modelem.
CodeInterpreterToolCall	Záznam volání nástroje interpreta kódu vydaného modelem při vyhodnocení definovaného nástroje, který představuje vstupy a výstupy spotřebované a generované interpretem kódu.
CodeInterpreterToolCallDetails	Podrobné informace o vyvolání interpreta kódu modelem.
CodeInterpreterToolDefinition	Informace o definici vstupu pro nástroj pro interpretaci kódu, který se používá ke konfiguraci asistenta.
CreateAndRunThreadOptions	Detaily použité při vytváření a okamžitém spuštění nového pomocného vlákna.
CreateAssistantFileOptions	Podrobnosti použité k vytvoření pomocného souboru.
CreateAssistantOptions	Podrobnosti použité k vytvoření asistenta.
CreateMessageOptions	Podrobnosti použité k vytvoření zprávy.
CreateRunOptions	Podrobnosti použité při vytváření nového spuštění pomocného vlákna.
CreateRunRequestOptions	Podrobnosti použité k vytvoření požadavku na spuštění.
CreateThreadAndRunOptions	Podrobnosti použité k vytvoření a spuštění vlákna.
CreateThreadOptions	Podrobnosti použité k vytvoření vlákna.
DeleteAssistantFileOptions	Podrobnosti použité k odstranění pomocného souboru.
DeleteAssistantOptions	Podrobnosti použité k odstranění asistenta.
DeleteFileOptions	Podrobnosti používané k mazání souborů.
DeleteThreadOptions	Podrobnosti použité k odstranění vlákna.
DeletionStatus	Abstraktní znázornění stavu výsledku operace odstranění OpenAI.
FileDeletionStatus	Odpověď na stav operace odstranění souboru.
FileListResponse	Data odpovědi z operace se seznamem souborů.
FunctionDefinition	Informace o definici vstupu pro funkci.
FunctionToolCall	Záznam volání nástroje funkce vydaného modelem při vyhodnocení definovaného nástroje, který představuje vstupy a výstup spotřebovaný a vygenerovaný zadanou funkcí.
FunctionToolCallDetails	Podrobné informace o funkci volané modelem.
FunctionToolDefinition	Informace o definici vstupu pro nástroj funkce, který se používá ke konfiguraci asistenta.
GetAssistantFileOptions	Podrobnosti použité k získání souboru asistenta.
GetAssistantOptions	Podrobnosti použité k získání asistenta.
GetFileOptions	Podrobnosti použité k získání souborů.
GetMessageFileOptions	Podrobnosti použité k získání souboru zprávy.
GetMessageOptions	Podrobnosti použité k získání zprávy.
GetRunOptions	Podrobnosti použité k získání běhu.
GetRunStepOptions	Podrobnosti použité k získání kroku běhu.
GetThreadOptions	Podrobnosti použité k získání vlákna.
InputFile	Představuje asistenta, který může volat model a používat nástroje.
ListAssistantFilesOptions	Podrobnosti používané k vypsání pomocných souborů.
ListAssistantsOptions	Podrobnosti používané k vypsání asistentů.
ListFilesOptions	Podrobnosti použité k vypsání souborů.
ListMessageFilesOptions	Podrobnosti používané k vypsání souborů zpráv.
ListMessagesOptions	Podrobnosti používané k vypsání zpráv.
ListResponseOf	Data odpovědi pro požadovaný seznam položek.
ListRunStepsOptions	Podrobnosti použité k vypsání kroků spuštění.
ListRunsOptions	Podrobnosti použité k spuštění seznamu.
MessageFile	Informace o souboru připojeném ke zprávě pomocného vlákna.
MessageImageFileContent	Reprezentace obsahu souboru obrázku ve zprávě vlákna.
MessageImageFileDetails	Odkaz na obrázek, jak je znázorněno v obsahu zprávy ve vlákně.
MessageTextContent	Reprezentace textové položky obsahu zprávy vlákna.
MessageTextDetails	Text a související anotace pro jednu položku obsahu zprávy pomocného vlákna.
MessageTextFileCitationAnnotation	Citace ve zprávě, která odkazuje na konkrétní citaci z konkrétního souboru přidruženého k asistentovi nebo zprávě. Generuje, když asistent používá k vyhledávání souborů nástroj pro načítání.
MessageTextFileCitationDetails	Reprezentace textových citací založených na souborech, jak se používá v anotaci obsahu zprávy textového vlákna.
MessageTextFilePathAnnotation	Citace ve zprávě, která odkazuje na soubor umístěný v určité cestě.
MessageTextFilePathDetails	Zapouzdření ID souboru obrázku používaného obsahem obrázku
RequiredAction	Abstraktní reprezentace požadované akce pro pokračování běhu pomocného vlákna.
RequiredFunctionToolCall	Reprezentace požadovaného volání do nástroje funkce, které model potřebuje k pokračování v hodnocení spuštění.
RetrievalToolCall	Záznam volání vyhledávacího nástroje, vydaný modelem při hodnocení definovaného nástroje, který představuje provedené načítání.
RetrievalToolDefinition	Informace o definici vstupu pro nástroj pro vyhledávání, který se používá ke konfiguraci asistenta.
RunError	Podrobnosti o chybě, ke které došlo při spuštění pomocného vlákna.
RunStep	Podrobné informace o jednom kroku běhu pomocného vlákna.
RunStepError	Informace o chybě spojené s neúspěšným krokem spuštění
RunStepMessageCreationDetails	Podrobné informace přidružené ke kroku spuštění při vytváření zprávy.
RunStepMessageCreationReference	Podrobnosti o zprávě vytvořené v rámci kroku spuštění
RunStepToolCallDetails	Podrobné informace přidružené k nástrojům pro volání kroku spuštění.
SubmitToolOutputsDetails	Podrobnosti popisující nástroje, které by měly být volány k odesílání výstupů nástrojů.
SubmitToolOutputsToRunOptions	Podrobnosti použité k odeslání výstupů nástrojů ke spuštění.
ThreadDeletionStatus	Stav operace odstranění vlákna.
ThreadMessage	Jedna existující zpráva v pomocném vlákně.
ThreadRun	Data reprezentující jeden vyhodnocovací běh pomocného vlákna.
ToolOutput	Data poskytnutá během odeslání výstupu nástroje za účelem vyřešení čekajících volání nástrojů a umožní modelu pokračovat.
UpdateAssistantOptions	Podrobnosti požadavku, které se mají použít při úpravách existujícího asistenta.
UpdateAssistantRequestOptions	Podrobnosti použité k aktualizaci asistenta.
UpdateMessageOptions	Podrobnosti použité k aktualizaci zprávy.
UpdateRunOptions	Podrobnosti použité k aktualizaci spuštění.
UpdateThreadOptions	Podrobnosti použité k aktualizaci vlákna.
UploadFileOptions	Podrobnosti použité k nahrání souborů.

Aliasy typu

CodeInterpreterToolCallOutput	Alias pro CodeInterpreterToolCallOutput
FilePurpose	"doladit", "doladit výsledky", "asistenti", "assistants_output"
ListSortOrder	"ASC", "DESC"
MessageContent	Alias pro MessageContent
MessageRole	"uživatel", "asistent"
MessageTextAnnotation	Alias pro MessageTextAnnotation
RequiredToolCall	Alias pro RequiredToolCall
RunStatus	"ve frontě", "in_progress", "requires_action", "zrušení", "zrušeno", "nezdařilo se", "dokončeno", "vypršelo"
RunStepDetails	Alias pro RunStepDetails
RunStepErrorCode	"server_error", "rate_limit_exceeded"
RunStepStatus	"in_progress", "zrušeno", "nezdařilo se", "dokončeno", "vypršela"
RunStepType	"message_creation", "tool_calls"
ToolCall	Alias pro volání nástrojů
ToolDefinition	Abstraktní reprezentace definice vstupního nástroje, kterou může asistent použít.