@azure/openai-assistants package
Klasy
| AssistantsClient |
Operacje związane z asystentem obsługi klienta. |
| 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 usługi Assistants dla punktu końcowego OpenAI. |
Interfejsy
| Assistant |
Reprezentuje asystenta, który może wywoływać model i używać narzędzi. |
| AssistantCreationOptions |
Szczegóły żądania do użycia podczas tworzenia nowego asystenta. |
| AssistantDeletionStatus |
Stan operacji usuwania asystenta. |
| AssistantFile |
Informacje o pliku dołączonym do asystenta, używane przez narzędzia, które mogą odczytywać pliki. |
| AssistantFileDeletionStatus |
Stan operacji usuwania pliku w asystencie. |
| AssistantThread |
Informacje o pojedynczym wątku powiązanym z asystentem. |
| AssistantThreadCreationOptions |
Szczegóły użyte do utworzenia nowego wątku asystenta. |
| AssistantsClientOptions |
Szczegóły użyte do utworzenia asystenta klienta * |
| CancelRunOptions |
Szczegóły użyte 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 wystawiony 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 danych wejściowych dla narzędzia interpretera kodu używanego do konfigurowania asystenta. |
| CreateAndRunThreadOptions |
Szczegóły używane podczas tworzenia i natychmiastowego uruchamiania nowego wątku asystenta. |
| CreateAssistantFileOptions |
Szczegóły użyte do utworzenia pliku asystenta. |
| CreateAssistantOptions |
Szczegóły użyte do utworzenia asystenta. |
| CreateMessageOptions |
Szczegóły użyte do utworzenia wiadomości. |
| CreateRunOptions |
Szczegóły używane podczas tworzenia nowego przebiegu wątku asystenta. |
| 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 asystenta. |
| DeleteAssistantOptions |
Szczegóły użyte do usunięcia asystenta. |
| 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 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 dla narzędzia funkcyjnego używanego do konfigurowania asystenta. |
| GetAssistantFileOptions |
Szczegóły użyte do pobrania pliku asystenta. |
| GetAssistantOptions |
Dane użyte do uzyskania asystenta. |
| GetFileOptions |
Szczegóły używane do pobierania plików. |
| GetMessageFileOptions |
Szczegóły użyte do pobrania pliku wiadomości. |
| GetMessageOptions |
Szczegóły użyte do otrzymania wiadomości. |
| GetRunOptions |
Szczegóły użyte do uruchomienia biegu. |
| GetRunStepOptions |
Szczegóły użyte do uzyskania kroku uruchomienia. |
| GetThreadOptions |
Szczegóły użyte do uzyskania wątku. |
| InputFile |
Reprezentuje asystenta, który może wywoływać model i używać narzędzi. |
| ListAssistantFilesOptions |
Szczegóły używane do wyświetlania listy plików asystenta. |
| 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 listy wiadomości. |
| ListResponseOf |
Dane odpowiedzi dla żądanej listy elementów. |
| ListRunStepsOptions |
Szczegóły używane do wyświetlenia listy kroków uruchamiania. |
| ListRunsOptions |
Szczegóły używane do wyświetlania listy przebiegów. |
| MessageFile |
Informacje o pliku dołączonym do komunikatu w wątku asystenta. |
| 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 treści komunikatu wątku asystenta. |
| MessageTextFileCitationAnnotation |
Cytat w komunikacie wskazujący określony cudzysłów z określonego pliku skojarzonego z asystentem lub komunikatem. Generowane, gdy asystent używa narzędzia "odzyskiwanie" do wyszukiwania plików. |
| MessageTextFileCitationDetails |
Reprezentacja cytatu tekstowego opartego na pliku, używana w adnotacji opartej na plikach zawartości wiadomości 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 komunikatu. |
| RequiredAction |
Abstrakcyjna reprezentacja akcji wymaganej do kontynuowania przebiegu wątku asystenta. |
| RequiredFunctionToolCall |
Reprezentacja żądanego wywołania narzędzia funkcji wymaganego przez model w celu kontynuowania oceny przebiegu. |
| RetrievalToolCall |
Rekord wywołania narzędzia do pobierania, wydany przez model w ocenie zdefiniowanego narzędzia, który reprezentuje wykonane akcje pobierania. |
| RetrievalToolDefinition |
Informacje o definicji danych wejściowych dla narzędzia do pobierania używane do konfigurowania asystenta. |
| RunError |
Szczegóły błędu napotkanego przez wątek asystenta są uruchamiane. |
| RunStep |
Szczegółowe informacje o pojedynczym kroku przebiegu wątku asystenta. |
| RunStepError |
Informacje o błędzie skojarzone z krokiem uruchomienia, który zakończył się niepowodzeniem. |
| RunStepMessageCreationDetails |
Szczegółowe informacje skojarzone z krokiem uruchamiania tworzenia komunikatów. |
| RunStepMessageCreationReference |
Szczegóły komunikatu utworzonego w ramach kroku uruchamiania. |
| RunStepToolCallDetails |
Szczegółowe informacje skojarzone z narzędziami wywoływania kroków uruchamiania. |
| SubmitToolOutputsDetails |
Szczegóły opisujące narzędzia, które powinny być wywoływane w celu przesyłania danych wyjściowych narzędzia. |
| SubmitToolOutputsToRunOptions |
Szczegóły używane do przesyłania danych wyjściowych narzędzia do przebiegu. |
| ThreadDeletionStatus |
Stan operacji usuwania wątku. |
| ThreadMessage |
Pojedyncza, istniejąca wiadomość w wątku asystenta. |
| ThreadRun |
Dane reprezentujące pojedynczy przebieg oceny wątku asystenta. |
| ToolOutput |
Dane dostarczone podczas przesyłania danych wyjściowych narzędzia do rozwiązywania oczekujących wywołań narzędzi i umożliwiają kontynuowanie modelu. |
| UpdateAssistantOptions |
Szczegóły żądania, które mają być używane podczas modyfikowania istniejącego asystenta. |
| UpdateAssistantRequestOptions |
Szczegóły używane do aktualizowania asystenta. |
| UpdateMessageOptions |
Szczegóły używane do aktualizowania wiadomości. |
| UpdateRunOptions |
Szczegóły używane do aktualizowania przebiegu. |
| UpdateThreadOptions |
Szczegóły używane do aktualizowania wątku. |
| UploadFileOptions |
Szczegóły używane do przesyłania plików. |
Aliasy typu
| CodeInterpreterToolCallOutput |
Alias dla CodeInterpreterToolCallOutput |
| FilePurpose |
"dostrojenie", "dostrojenie wyników", "asystenci", "assistants_output" |
| ListSortOrder |
"asc", "desc" |
| MessageContent |
Alias dla MessageContent |
| MessageRole |
"użytkownik", "asystent" |
| MessageTextAnnotation |
Alias dla adnotacji MessageTextAnnotation |
| RequiredToolCall |
Alias dla RequiredToolCall |
| RunStatus |
"W kolejce", "in_progress", "requires_action", "Anulowanie", "Anulowanie", "Niepowodzenie", "Ukończone", "Wygasłe" |
| RunStepDetails |
Alias dla RunStepDetails |
| RunStepErrorCode |
"server_error", "rate_limit_exceeded" |
| RunStepStatus |
"in_progress", "anulowane", "nieudane", "ukończone", "wygasłe" |
| RunStepType |
"message_creation", "tool_calls" |
| ToolCall |
Alias dla ToolCall |
| ToolDefinition |
Abstrakcyjna reprezentacja definicji narzędzia wejściowego, z której może korzystać asystent. |
