@azure/openai-assistants package

Klasser

AssistantsClient	Klienthantering assistent-relaterade åtgärder.
AzureKeyCredential	En statisk nyckelbaserad autentiseringsuppgift som stöder uppdatering av det underliggande nyckelvärdet.
OpenAIKeyCredential	Klassen OpenAIKeyCredential representerar en OpenAI API-nyckel och används för att autentisera till en assistentklient för en OpenAI-slutpunkt.

Gränssnitt

Assistant	Representerar en assistent som kan anropa modellen och använda verktyg.
AssistantCreationOptions	Information om begäran som ska användas när du skapar en ny assistent.
AssistantDeletionStatus	Status för en assistent borttagningsåtgärd.
AssistantFile	Information om en fil som är kopplad till en assistent, som används av verktyg som kan läsa filer.
AssistantFileDeletionStatus	Status för en assistent filborttagningsåtgärd.
AssistantThread	Information om en tråd som är associerad med en assistent.
AssistantThreadCreationOptions	Informationen som används för att skapa en ny assistent tråd.
AssistantsClientOptions	Informationen som används för att skapa en assistent-klient *
CancelRunOptions	Den information som används för att avbryta en körning.
CodeInterpreterImageOutput	En representation av en bildutdata som genereras av ett kodtolkverktyg som svar på ett verktygsanrop av modellen.
CodeInterpreterImageReference	En bildreferens som genereras av ett kodtolkningsverktyg som svar på ett verktygsanrop av modellen.
CodeInterpreterLogOutput	En representation av loggutdata som genereras av ett kodtolkverktyg som svar på ett verktygsanrop av modellen.
CodeInterpreterToolCall	En post för ett anrop till ett kodtolkverktyg, utfärdat av modellen i utvärderingen av ett definierat verktyg, som representerar indata och utdata som används och genereras av kodtolken.
CodeInterpreterToolCallDetails	Detaljerad information om en kodtolk som anropas av modellen.
CodeInterpreterToolDefinition	Information om indatadefinitionen för ett kodtolkarverktyg som används för att konfigurera en assistent.
CreateAndRunThreadOptions	Den information som används när du skapar och omedelbart kör en ny assistent tråd.
CreateAssistantFileOptions	Den information som används för att skapa en assistent fil.
CreateAssistantOptions	Den information som används för att skapa en assistent.
CreateMessageOptions	Den information som används för att skapa ett meddelande.
CreateRunOptions	Informationen som används när du skapar en ny körning av en assistent tråd.
CreateRunRequestOptions	Den information som används för att skapa en körningsbegäran.
CreateThreadAndRunOptions	Den information som används för att skapa och köra en tråd.
CreateThreadOptions	Den information som används för att skapa en tråd.
DeleteAssistantFileOptions	Den information som används för att ta bort en assistent fil.
DeleteAssistantOptions	Den information som används för att ta bort en assistent.
DeleteFileOptions	Den information som används för att ta bort filer.
DeleteThreadOptions	Den information som används för att ta bort en tråd.
DeletionStatus	En abstrakt representation av resultatstatusen för en OpenAI-borttagningsåtgärd.
FileDeletionStatus	Ett statussvar från en filborttagningsåtgärd.
FileListResponse	Svarsdata från en fillisteåtgärd.
FunctionDefinition	Information om indatadefinitionen för en funktion.
FunctionToolCall	En post för ett anrop till ett funktionsverktyg, utfärdat av modellen i utvärderingen av ett definierat verktyg, som representerar de indata och utdata som förbrukas och genereras av den angivna funktionen.
FunctionToolCallDetails	Detaljerad information om funktionen som anropas av modellen.
FunctionToolDefinition	Information om indatadefinitionen för ett funktionsverktyg som används för att konfigurera en assistent.
GetAssistantFileOptions	Den information som används för att hämta en assistent fil.
GetAssistantOptions	Den information som används för att hämta en assistent.
GetFileOptions	Den information som används för att hämta filer.
GetMessageFileOptions	Den information som används för att hämta en meddelandefil.
GetMessageOptions	Den information som används för att hämta ett meddelande.
GetRunOptions	Den information som används för att få en körning.
GetRunStepOptions	Den information som används för att hämta ett körningssteg.
GetThreadOptions	Informationen som används för att hämta en tråd.
InputFile	Representerar en assistent som kan anropa modellen och använda verktyg.
ListAssistantFilesOptions	Den information som används för att lista assistent filer.
ListAssistantsOptions	Den information som används för att lista assistenter.
ListFilesOptions	Den information som används för att visa en lista över filer.
ListMessageFilesOptions	Den information som används för att lista meddelandefiler.
ListMessagesOptions	Den information som används för att lista meddelanden.
ListResponseOf	Svarsdata för en begärd lista över objekt.
ListRunStepsOptions	Den information som används för att lista körningssteg.
ListRunsOptions	Informationen som används för att lista körningar.
MessageFile	Information om en fil som är kopplad till ett assistent trådmeddelande.
MessageImageFileContent	En representation av bildfilinnehåll i ett trådmeddelande.
MessageImageFileDetails	En bildreferens som visas i trådmeddelandeinnehåll.
MessageTextContent	En representation av ett textobjekt med trådmeddelandeinnehåll.
MessageTextDetails	Texten och tillhörande anteckningar för ett enskilt objekt i assistent trådmeddelandeinnehåll.
MessageTextFileCitationAnnotation	Ett citat i meddelandet som pekar på ett specifikt citat från en specifik fil som är associerad med assistent eller meddelandet. Genereras när assistent använder hämtningsverktyget för att söka i filer.
MessageTextFileCitationDetails	En representation av en filbaserad textkitation, som används i en filbaserad anteckning av texttrådens meddelandeinnehåll.
MessageTextFilePathAnnotation	En källhänvisning i meddelandet som pekar på en fil som finns på en specifik sökväg.
MessageTextFilePathDetails	En inkapsling av ett bildfils-ID som används av meddelandebildinnehåll.
RequiredAction	En abstrakt representation av en obligatorisk åtgärd för att en assistent trådkörning ska fortsätta.
RequiredFunctionToolCall	En representation av ett begärt anrop till ett funktionsverktyg som modellen behöver för att fortsätta utvärderingen av en körning.
RetrievalToolCall	En post för ett anrop till ett hämtningsverktyg, utfärdat av modellen i utvärderingen av ett definierat verktyg, som representerar utförda hämtningsåtgärder.
RetrievalToolDefinition	Information om indatadefinitionen för ett hämtningsverktyg som används för att konfigurera en assistent.
RunError	Information om ett fel som påträffades av en assistent trådkörning.
RunStep	Detaljerad information om ett enda steg i en assistent trådkörning.
RunStepError	Felinformationen som är associerad med ett misslyckat körningssteg.
RunStepMessageCreationDetails	Den detaljerade information som är associerad med ett körningssteg för att skapa ett meddelande.
RunStepMessageCreationReference	Information om ett meddelande som skapats som en del av ett körningssteg.
RunStepToolCallDetails	Detaljerad information som är associerad med verktyg för att köra steganrop.
SubmitToolOutputsDetails	Information som beskriver verktyg som ska anropas för att skicka verktygsutdata.
SubmitToolOutputsToRunOptions	Den information som används för att skicka utdata från verktyget till en körning.
ThreadDeletionStatus	Status för en trådborttagningsåtgärd.
ThreadMessage	Ett enda befintligt meddelande i en assistent tråd.
ThreadRun	Data som representerar en enda utvärderingskörning av en assistent tråd.
ToolOutput	Data som tillhandahålls under ett verktyg matar ut överföring för att lösa väntande verktygsanrop och låta modellen fortsätta.
UpdateAssistantOptions	Information om begäran som ska användas när du ändrar en befintlig assistent.
UpdateAssistantRequestOptions	Den information som används för att uppdatera en assistent.
UpdateMessageOptions	Informationen som används för att uppdatera ett meddelande.
UpdateRunOptions	Den information som används för att uppdatera en körning.
UpdateThreadOptions	Informationen som används för att uppdatera en tråd.
UploadFileOptions	Den information som används för att ladda upp filer.

Typalias

CodeInterpreterToolCallOutput	Alias för CodeInterpreterToolCallOutput
FilePurpose	"fine-tune", "fine-tune-results", "assistants", "assistants_output"
ListSortOrder	"asc", "desc"
MessageContent	Alias för MessageContent
MessageRole	"user", "assistent"
MessageTextAnnotation	Alias för MessageTextAnnotation
RequiredToolCall	Alias för RequiredToolCall
RunStatus	"queued", "in_progress", "requires_action", "cancelling", "cancelled", "failed", "completed", "expired"
RunStepDetails	Alias för RunStepDetails
RunStepErrorCode	"server_error", "rate_limit_exceeded"
RunStepStatus	"in_progress", "cancelled", "failed", "completed", "expired"
RunStepType	"message_creation", "tool_calls"
ToolCall	Alias för ToolCall
ToolDefinition	En abstrakt representation av en definition av indataverktyget som en assistent kan använda.