@azure/openai-assistants package
Klasser
| AssistantsClient |
Klienthanteringsassistentrelaterade operationer. |
| 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 |
Begärandeinformationen som ska användas när du skapar en ny assistent. |
| AssistantDeletionStatus |
Status för en borttagningsåtgärd för assistenten. |
| AssistantFile |
Information om en fil som är kopplad till en assistent och som används av verktyg som kan läsa filer. |
| AssistantFileDeletionStatus |
Status för en åtgärd för att ta bort en fil i assistenten. |
| AssistantThread |
Information om en enskild tråd som är associerad med en assistent. |
| AssistantThreadCreationOptions |
Informationen som används för att skapa en ny assistenttråd. |
| AssistantsClientOptions |
Informationen som används för att skapa en assistentklient * |
| CancelRunOptions |
Informationen 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 kodtolkarverktyg som svar på ett verktygsanrop av modellen. |
| CodeInterpreterLogOutput |
En representation av ett loggutdata som genereras av ett kodtolkverktyg som svar på ett verktygsanrop från modellen. |
| CodeInterpreterToolCall |
En post för ett anrop till ett kodtolkningsverktyg, utfärdat av modellen i utvärderingen av ett definierat verktyg, som representerar indata och utdata som används och genereras av kodtolkaren. |
| CodeInterpreterToolCallDetails |
Den detaljerade informationen om en kodtolk som anropas av modellen. |
| CodeInterpreterToolDefinition |
Indatadefinitionsinformationen för ett kodtolkverktyg 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 assistenttråd. |
| CreateAssistantFileOptions |
Informationen som används för att skapa en assistentfil. |
| CreateAssistantOptions |
Informationen som används för att skapa en assistent. |
| CreateMessageOptions |
Informationen som används för att skapa ett meddelande. |
| CreateRunOptions |
Den information som används när du skapar en ny körning av en assistenttråd. |
| CreateRunRequestOptions |
Informationen som används för att skapa en körningsbegäran. |
| CreateThreadAndRunOptions |
Information som används för att skapa och köra en tråd. |
| CreateThreadOptions |
Detaljerna som används för att skapa en tråd. |
| DeleteAssistantFileOptions |
Informationen som används för att ta bort en assistentfil. |
| DeleteAssistantOptions |
Informationen som används för att ta bort en assistent. |
| DeleteFileOptions |
Informationen som används för att ta bort filer. |
| DeleteThreadOptions |
Informationen som används för att ta bort en tråd. |
| DeletionStatus |
En abstrakt representation av resultatstatus 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 indatadefinition 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 |
Informationen som används för att hämta en assistentfil. |
| GetAssistantOptions |
Detaljerna används för att få en assistent. |
| GetFileOptions |
Informationen som används för att hämta filer. |
| GetMessageFileOptions |
Informationen som används för att hämta en meddelandefil. |
| GetMessageOptions |
Informationen som används för att få ett meddelande. |
| GetRunOptions |
Detaljerna som används för att få en körning. |
| GetRunStepOptions |
Informationen som används för att hämta ett körningssteg. |
| GetThreadOptions |
Detaljerna som används för att få en tråd. |
| InputFile |
Representerar en assistent som kan anropa modellen och använda verktyg. |
| ListAssistantFilesOptions |
Informationen som används för att lista assistentfiler. |
| ListAssistantsOptions |
Informationen som används för att lista assistenter. |
| ListFilesOptions |
Informationen som används för att lista filer. |
| ListMessageFilesOptions |
Informationen som används för att lista meddelandefiler. |
| ListMessagesOptions |
Informationen 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 visa körningssteg. |
| ListRunsOptions |
Den information som används för att lista körningar. |
| MessageFile |
Information om en fil som är bifogad i ett trådmeddelande i assistenten. |
| MessageImageFileContent |
En representation av bildfilinnehåll i ett trådmeddelande. |
| MessageImageFileDetails |
En bildreferens, som representeras i trådmeddelandeinnehåll. |
| MessageTextContent |
En representation av ett textobjekt med trådmeddelandeinnehåll. |
| MessageTextDetails |
Texten och associerade anteckningar för ett enskilt objekt i meddelandeinnehållet i assistenttråden. |
| MessageTextFileCitationAnnotation |
Ett citat i meddelandet som pekar på ett specifikt citat från en specifik fil som är associerad med assistenten eller meddelandet. Genereras när assistenten använder verktyget "hämta" för att söka efter filer. |
| MessageTextFileCitationDetails |
En representation av en filbaserad textcitation, som används i en filbaserad anteckning av texttrådsmeddelandeinnehå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 åtgärd som krävs för att en assistenttrådkörning ska fortsätta. |
| RequiredFunctionToolCall |
En representation av ett begärt anrop till ett funktionsverktyg som krävs av modellen 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 |
Indatadefinitionsinformationen för ett hämtningsverktyg som används för att konfigurera en assistent. |
| RunError |
Information om ett fel som påträffas av en assistenttrådkörning. |
| RunStep |
Detaljerad information om ett enda steg i en assistenttrådkörning. |
| RunStepError |
Felinformationen som är associerad med ett misslyckat körningssteg. |
| RunStepMessageCreationDetails |
Detaljerad information som är associerad med ett körningssteg för meddelandeskapande. |
| RunStepMessageCreationReference |
Information om ett meddelande som skapats som en del av ett körningssteg. |
| RunStepToolCallDetails |
Detaljerad information som är associerad med ett körningssteg som anropar verktyg. |
| SubmitToolOutputsDetails |
Informationen som beskriver verktyg som ska anropas för att skicka verktygsutdata. |
| SubmitToolOutputsToRunOptions |
Den information som används för att skicka verktygsutdata till en körning. |
| ThreadDeletionStatus |
Status för en trådborttagningsåtgärd. |
| ThreadMessage |
Ett enda, befintligt meddelande i en assistenttråd. |
| ThreadRun |
Data som representerar en enda utvärderingskörning av en assistenttråd. |
| ToolOutput |
Data som tillhandahålls under ett verktyg matar in för att lösa väntande verktygsanrop och låta modellen fortsätta. |
| UpdateAssistantOptions |
Begärandeinformationen som ska användas när du ändrar en befintlig assistent. |
| UpdateAssistantRequestOptions |
Informationen som används för att uppdatera en assistent. |
| UpdateMessageOptions |
Den information 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 |
Informationen som används för att ladda upp filer. |
Typalias
| CodeInterpreterToolCallOutput |
Alias för CodeInterpreterToolCallOutput |
| FilePurpose |
"finjustera", "finjustera-resultat", "assistenter", "assistants_output" |
| ListSortOrder |
"asc", "desc" |
| MessageContent |
Alias för MessageContent |
| MessageRole |
"användare", "assistent" |
| MessageTextAnnotation |
Alias för MessageTextAnnotation |
| RequiredToolCall |
Alias för RequiredToolCall |
| RunStatus |
"i kö", "in_progress", "requires_action", "avbryter", "avbruten", "misslyckades", "slutförd", "har upphört att gälla" |
| RunStepDetails |
Alias för RunStepDetails |
| RunStepErrorCode |
"server_error", "rate_limit_exceeded" |
| RunStepStatus |
"in_progress", "avbruten", "misslyckad", "slutförd", "utgången" |
| RunStepType |
"message_creation", "tool_calls" |
| ToolCall |
Alias för ToolCall |
| ToolDefinition |
En abstrakt representation av en definition av ett indataverktyg som en assistent kan använda. |
