@azure/openai-assistants package

Třídy

AssistantsClient	Klient zpracovává operace související s asistent.
AzureKeyCredential	Přihlašovací údaje založené na statickém klíči, které podporují aktualizaci hodnoty podkladového klíče.
OpenAIKeyCredential	Třída OpenAIKeyCredential představuje klíč rozhraní API OpenAI a používá se k ověření v klientovi Assistants pro koncový bod OpenAI.

Rozhraní

Assistant	Představuje asistent, který může volat model a používat nástroje.
AssistantCreationOptions	Podrobnosti o požadavku, které se mají použít při vytváření nového asistent.
AssistantDeletionStatus	Stav operace odstranění asistent.
AssistantFile	Informace o souboru připojeném k asistent, které používají nástroje, které můžou číst soubory.
AssistantFileDeletionStatus	Stav operace odstranění souboru asistent.
AssistantThread	Informace o jednom vlákně přidruženém k asistent.
AssistantThreadCreationOptions	Podrobnosti použité k vytvoření nového vlákna asistent.
AssistantsClientOptions	Podrobnosti použité k vytvoření klienta asistent *
CancelRunOptions	Podrobnosti použité ke zrušení spuštění
CodeInterpreterImageOutput	Reprezentace výstupu obrázku vygenerovaného nástrojem interpretu kódu v reakci na volání nástroje modelem.
CodeInterpreterImageReference	Odkaz na obrázek vygenerovaný nástrojem interpretu 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 interpretu kódu vystavený 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 volání interpretu kódu modelem.
CodeInterpreterToolDefinition	Informace o definici vstupu pro nástroj interpretu kódu, které slouží ke konfiguraci asistent.
CreateAndRunThreadOptions	Podrobnosti použité při vytváření a okamžitém spuštění nového asistent vlákna.
CreateAssistantFileOptions	Podrobnosti použité k vytvoření souboru asistent.
CreateAssistantOptions	Podrobnosti použité k vytvoření asistent.
CreateMessageOptions	Podrobnosti použité k vytvoření zprávy
CreateRunOptions	Podrobnosti použité při vytváření nového spuštění asistent vlákna.
CreateRunRequestOptions	Podrobnosti použité k vytvoření žádosti o 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í souboru asistent.
DeleteAssistantOptions	Podrobnosti použité k odstranění asistent.
DeleteFileOptions	Podrobnosti použité k odstraně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 z operace odstranění souboru.
FileListResponse	Data odpovědi z operace seznamu souborů.
FunctionDefinition	Informace o definici vstupu funkce.
FunctionToolCall	Záznam volání funkčního nástroje vystavený modelem při vyhodnocení definovaného nástroje, který představuje vstupy a výstupy spotřebované a generované zadanou funkcí.
FunctionToolCallDetails	Podrobné informace o funkci volanou modelem
FunctionToolDefinition	Informace o definici vstupu pro nástroj funkce, které slouží ke konfiguraci asistent.
GetAssistantFileOptions	Podrobnosti použité k získání souboru asistent
GetAssistantOptions	Podrobnosti použité k získání asistent
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í spuštění
GetRunStepOptions	Podrobnosti použité k získání kroku spuštění
GetThreadOptions	Podrobnosti použité k získání vlákna
InputFile	Představuje asistent, který může volat model a používat nástroje.
ListAssistantFilesOptions	Podrobnosti použité k výpisu asistent souborů
ListAssistantsOptions	Podrobnosti použité k výpisu asistentů
ListFilesOptions	Podrobnosti použité k výpisu souborů
ListMessageFilesOptions	Podrobnosti použité k výpisu souborů zpráv
ListMessagesOptions	Podrobnosti použité k výpisu zpráv
ListResponseOf	Data odpovědi pro požadovaný seznam položek.
ListRunStepsOptions	Podrobnosti použité k výpisu kroků spuštění
ListRunsOptions	Podrobnosti použité k výpisu spuštění
MessageFile	Informace o souboru připojeném ke zprávě asistent 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 vlákna.
MessageTextContent	Reprezentace textové položky obsahu zprávy vlákna.
MessageTextDetails	Text a přidružené poznámky pro jednu položku asistent obsahu zprávy vlákna.
MessageTextFileCitationAnnotation	Citace ve zprávě, která odkazuje na konkrétní citaci z konkrétního souboru přidruženého k asistent nebo zprávě. Generuje se, když asistent používá k vyhledávání souborů nástroj pro načítání.
MessageTextFileCitationDetails	Reprezentace textové citace založené na souboru, jak se používá v souborové poznámce obsahu zprávy textového vlákna.
MessageTextFilePathAnnotation	Citace ve zprávě, která odkazuje na soubor umístěný na konkrétní cestě.
MessageTextFilePathDetails	Zapouzdření ID souboru obrázku, jak se používá v obsahu obrázku zprávy.
RequiredAction	Abstraktní znázornění požadované akce pro asistent spuštění vlákna pro pokračování.
RequiredFunctionToolCall	Reprezentace požadovaného volání funkčního nástroje, kterou model potřebuje k pokračování vyhodnocení spuštění.
RetrievalToolCall	Záznam volání nástroje pro načítání vystavený modelem při vyhodnocení definovaného nástroje, který představuje provedené akce načtení.
RetrievalToolDefinition	Informace o definici vstupu pro nástroj pro načítání, které slouží ke konfiguraci asistent.
RunError	Podrobnosti o chybě, ke které došlo asistent spuštění vlákna.
RunStep	Podrobné informace o jednom kroku asistent spuštění vlákna.
RunStepError	Informace o chybě spojené s neúspěšným krokem spuštění.
RunStepMessageCreationDetails	Podrobné informace související s vytvořením zprávy spustí krok.
RunStepMessageCreationReference	Podrobnosti o zprávě vytvořené jako součást kroku spuštění
RunStepToolCallDetails	Podrobné informace související s nástroji 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ýstupu nástroje do spuštění.
ThreadDeletionStatus	Stav operace odstranění vlákna.
ThreadMessage	Jedna existující zpráva v rámci vlákna asistent.
ThreadRun	Data představující jedno spuštění vyhodnocení vlákna asistent.
ToolOutput	Data poskytnutá během nástroje výstupu odeslání vyřeší čekající volání nástroje a umožní modelu pokračovat.
UpdateAssistantOptions	Podrobnosti o požadavku, které se mají použít při úpravě existujícího asistent.
UpdateAssistantRequestOptions	Podrobnosti použité k aktualizaci asistent.
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	"fine-tune", "fine-tune-results", "assistants", "assistants_output"
ListSortOrder	"asc", "desc"
MessageContent	Alias pro MessageContent
MessageRole	"user", "asistent"
MessageTextAnnotation	Alias pro MessageTextAnnotation
RequiredToolCall	Alias pro RequiredToolCall
RunStatus	"queued", "in_progress", "requires_action", "cancelling", "cancelled", "failed", "completed", "expired"
RunStepDetails	Alias pro RunStepDetails
RunStepErrorCode	"server_error", "rate_limit_exceeded"
RunStepStatus	"in_progress", "cancelled", "failed", "completed", "expired"
RunStepType	"message_creation", "tool_calls"
ToolCall	Alias pro ToolCall
ToolDefinition	Abstraktní reprezentace definice vstupního nástroje, kterou může asistent použít.