@azure/openai-assistants package

Klasy

AssistantsClient	Obsługa asystent operacji związanych z klientem.
AzureKeyCredential	Poświadczenie oparte na kluczu statycznym, które obsługuje aktualizowanie bazowej wartości klucza.
OpenAIKeyCredential	Klasa OpenAIKeyCredential reprezentuje klucz interfejsu API OpenAI i służy do uwierzytelniania w kliencie Asystentów dla punktu końcowego openAI.

Interfejsy

Assistant	Reprezentuje asystent, które mogą wywoływać model i używać narzędzi.
AssistantCreationOptions	Szczegóły żądania do użycia podczas tworzenia nowego asystent.
AssistantDeletionStatus	Stan operacji usuwania asystent.
AssistantFile	Informacje o pliku dołączonym do asystent, używane przez narzędzia, które mogą odczytywać pliki.
AssistantFileDeletionStatus	Stan operacji usuwania pliku asystent.
AssistantThread	Informacje o pojedynczym wątku skojarzonym z asystent.
AssistantThreadCreationOptions	Szczegóły użyte do utworzenia nowego wątku asystent.
AssistantsClientOptions	Szczegóły używane do tworzenia klienta asystent *
CancelRunOptions	Szczegóły używane do anulowania przebiegu.
CodeInterpreterImageOutput	Reprezentacja danych wyjściowych obrazu emitowanych przez narzędzie interpretera kodu w odpowiedzi na wywołanie narzędzia przez model.
CodeInterpreterImageReference	Odwołanie do obrazu emitowane przez narzędzie interpretera kodu w odpowiedzi na wywołanie narzędzia przez model.
CodeInterpreterLogOutput	Reprezentacja danych wyjściowych dziennika emitowanych przez narzędzie interpretera kodu w odpowiedzi na wywołanie narzędzia przez model.
CodeInterpreterToolCall	Rekord wywołania narzędzia interpretera kodu wystawionego przez model w ocenie zdefiniowanego narzędzia, który reprezentuje dane wejściowe i wyjściowe używane i emitowane przez interpreter kodu.
CodeInterpreterToolCallDetails	Szczegółowe informacje o wywołaniu interpretera kodu przez model.
CodeInterpreterToolDefinition	Informacje o definicji wejściowej narzędzia interpretera kodu używane do konfigurowania asystent.
CreateAndRunThreadOptions	Szczegóły używane podczas tworzenia i natychmiastowego uruchamiania nowego wątku asystent.
CreateAssistantFileOptions	Szczegóły użyte do utworzenia pliku asystent.
CreateAssistantOptions	Szczegóły użyte do utworzenia asystent.
CreateMessageOptions	Szczegóły użyte do utworzenia komunikatu.
CreateRunOptions	Szczegóły używane podczas tworzenia nowego uruchomienia wątku asystent.
CreateRunRequestOptions	Szczegóły użyte do utworzenia żądania uruchomienia.
CreateThreadAndRunOptions	Szczegóły używane do tworzenia i uruchamiania wątku.
CreateThreadOptions	Szczegóły użyte do utworzenia wątku.
DeleteAssistantFileOptions	Szczegóły używane do usuwania pliku asystent.
DeleteAssistantOptions	Szczegóły używane do usuwania asystent.
DeleteFileOptions	Szczegóły używane do usuwania plików.
DeleteThreadOptions	Szczegóły użyte do usunięcia wątku.
DeletionStatus	Abstrakcyjna reprezentacja stanu wyniku operacji usuwania openAI.
FileDeletionStatus	Odpowiedź stanu z operacji usuwania pliku.
FileListResponse	Dane odpowiedzi z operacji listy plików.
FunctionDefinition	Informacje o definicji danych wejściowych dla funkcji.
FunctionToolCall	Rekord wywołania narzędzia funkcji wystawiony przez model w ocenie zdefiniowanego narzędzia, który reprezentuje dane wejściowe i wyjściowe używane i emitowane przez określoną funkcję.
FunctionToolCallDetails	Szczegółowe informacje o funkcji wywoływanej przez model.
FunctionToolDefinition	Informacje o definicji danych wejściowych narzędzia funkcji używane do konfigurowania asystent.
GetAssistantFileOptions	Szczegóły używane do pobierania pliku asystent.
GetAssistantOptions	Szczegóły używane do uzyskania asystent.
GetFileOptions	Szczegóły używane do pobierania plików.
GetMessageFileOptions	Szczegóły użyte do pobrania pliku komunikatu.
GetMessageOptions	Szczegóły użyte do pobrania komunikatu.
GetRunOptions	Szczegóły użyte do uruchomienia.
GetRunStepOptions	Szczegóły użyte do uzyskania kroku uruchamiania.
GetThreadOptions	Szczegóły używane do pobierania wątku.
InputFile	Reprezentuje asystent, które mogą wywoływać model i używać narzędzi.
ListAssistantFilesOptions	Szczegóły używane do wyświetlania listy plików asystent.
ListAssistantsOptions	Szczegóły używane do wyświetlania listy asystentów.
ListFilesOptions	Szczegóły używane do wyświetlania listy plików.
ListMessageFilesOptions	Szczegóły używane do wyświetlania listy plików wiadomości.
ListMessagesOptions	Szczegóły używane do wyświetlania komunikatów.
ListResponseOf	Dane odpowiedzi dla żądanej listy elementów.
ListRunStepsOptions	Szczegóły używane do wyświetlania listy kroków uruchamiania.
ListRunsOptions	Szczegóły używane do wyświetlania listy przebiegów.
MessageFile	Informacje o pliku dołączonym do komunikatu asystent wątku.
MessageImageFileContent	Reprezentacja zawartości pliku obrazu w komunikacie wątku.
MessageImageFileDetails	Odwołanie do obrazu, reprezentowane w zawartości komunikatu wątku.
MessageTextContent	Reprezentacja tekstowego elementu zawartości wiadomości wątku.
MessageTextDetails	Tekst i skojarzone adnotacje dla pojedynczego elementu asystent zawartości wiadomości wątku.
MessageTextFileCitationAnnotation	Cytat w komunikacie wskazujący określony cytat z określonego pliku skojarzonego z asystent lub komunikatem. Generowane, gdy asystent używa narzędzia "pobieranie" do wyszukiwania plików.
MessageTextFileCitationDetails	Reprezentacja cytatu tekstowego opartego na pliku, która jest używana w adnotacji opartej na pliku zawartości wiadomości wątek tekstowych.
MessageTextFilePathAnnotation	Cytat w komunikacie wskazującym plik znajdujący się w określonej ścieżce.
MessageTextFilePathDetails	Hermetyzacja identyfikatora pliku obrazu używanego przez zawartość obrazu wiadomości.
RequiredAction	Abstrakcyjna reprezentacja wymaganej akcji dla uruchomienia wątku asystent w celu kontynuowania.
RequiredFunctionToolCall	Reprezentacja żądanego wywołania do narzędzia funkcji potrzebnego przez model do kontynuowania oceny przebiegu.
RetrievalToolCall	Rekord wywołania narzędzia do pobierania, wystawiony przez model w ocenie zdefiniowanego narzędzia, który reprezentuje wykonane akcje pobierania.
RetrievalToolDefinition	Informacje o definicji danych wejściowych narzędzia pobierania używane do konfigurowania asystent.
RunError	Szczegóły błędu napotkane przez uruchomienie wątku asystent.
RunStep	Szczegółowe informacje o pojedynczym kroku przebiegu wątku asystent.
RunStepError	Informacje o błędzie skojarzone z krokiem uruchomienia, który zakończył się niepowodzeniem.
RunStepMessageCreationDetails	Szczegółowe informacje skojarzone z krokiem przebiegu tworzenia komunikatów.
RunStepMessageCreationReference	Szczegóły komunikatu utworzonego w ramach kroku uruchamiania.
RunStepToolCallDetails	Szczegółowe informacje skojarzone z narzędziami wywołującymi krok uruchomienia.
SubmitToolOutputsDetails	Szczegóły opisujące narzędzia, które powinny być wywoływane w celu przesyłania danych wyjściowych narzędzi.
SubmitToolOutputsToRunOptions	Szczegóły używane do przesyłania danych wyjściowych narzędzia do uruchomienia.
ThreadDeletionStatus	Stan operacji usuwania wątku.
ThreadMessage	Pojedynczy, istniejący komunikat w wątku asystent.
ThreadRun	Dane reprezentujące pojedynczy przebieg oceny wątku asystent.
ToolOutput	Dane podane podczas przesyłania danych wyjściowych narzędzia w celu rozwiązania oczekujących wywołań narzędzi i umożliwiają kontynuowanie modelu.
UpdateAssistantOptions	Szczegóły żądania do użycia podczas modyfikowania istniejącej asystent.
UpdateAssistantRequestOptions	Szczegóły używane do aktualizowania asystent.
UpdateMessageOptions	Szczegóły używane do aktualizowania komunikatu.
UpdateRunOptions	Szczegóły używane do aktualizowania przebiegu.
UpdateThreadOptions	Szczegóły używane do aktualizowania wątku.
UploadFileOptions	Szczegóły używane do przekazywania plików.

Aliasy typu

CodeInterpreterToolCallOutput	Alias dla CodeInterpreterToolCallOutput
FilePurpose	"fine-tune", "fine-tune-results", "assistants", "assistants_output"
ListSortOrder	"asc", "desc"
MessageContent	Alias komunikatuContent
MessageRole	"user", "asystent"
MessageTextAnnotation	Alias dla elementu MessageTextAnnotation
RequiredToolCall	Alias dla requiredToolCall
RunStatus	"queued", "in_progress", "requires_action", "cancelling", "cancelled", "failed", "completed", "expired"
RunStepDetails	Alias dla elementu RunStepDetails
RunStepErrorCode	"server_error", "rate_limit_exceeded"
RunStepStatus	"in_progress", "anulowane", "failed", "completed", "expired"
RunStepType	"message_creation", "tool_calls"
ToolCall	Alias narzędzia ToolCall
ToolDefinition	Abstrakcyjna reprezentacja definicji narzędzia wejściowego, która może być używana przez asystent.