@azure/ai-agents package

Klasy

AgentsClient
ToolSet	Reprezentuje zestaw narzędzi z ich definicjami i zasobami.
ToolUtility	Klasa narzędzi do tworzenia różnych narzędzi.

Interfejsy

AISearchIndexResource	Zasób AI Search Index.
Agent	Reprezentuje agenta, który może wywoływać model i używać narzędzi.
AgentDeletionStatus	Stan operacji usuwania agenta.
AgentErrorDetail	Opisuje informacje o błędach zwracane przez interfejs API agentów.
AgentEventMessage	Każde zdarzenie w strumieniu zdarzeń wysyłanych przez serwer ma właściwość event i data: * Przykład zdarzenie: thread.created data: {"id": "thread_123", "object": "wątek", ...} Emitujemy zdarzenia za każdym razem, gdy zostanie utworzony nowy obiekt, przejdzie do nowego stanu lub jest przesyłane strumieniowo w częściach (różnice). Na przykład emitujemy thread.run.created po nowym uruchomieniu jest tworzony, thread.run.completed po zakończeniu przebiegu itd. Gdy agent wybierze aby utworzyć komunikat podczas przebiegu, emitujemy thread.message.created event, a thread.message.in_progress zdarzenia, wiele zdarzeń thread.message.delta, a na koniec thread.message.completed zdarzenie. Możemy dodać dodatkowe zdarzenia w czasie, dlatego zalecamy bezproblemową obsługę nieznanych zdarzeń w kodzie.
AgentEventMessageStream	Reprezentuje strumień komunikatu zdarzenia agenta.
AgentThread	Informacje o pojedynczym wątku skojarzonym z agentem.
AgentThreadCreationOptions	Szczegóły użyte do utworzenia nowego wątku agenta.
AgentV1Error	Ładunek błędu zwrócony przez interfejs API agentów.
AgentsClientOptionalParams	Parametry opcjonalne dla klienta.
AgentsNamedToolChoice	Określa narzędzie, które ma być używane przez model. Użyj polecenia , aby wymusić wywołanie określonego narzędzia przez model.
AgentsResponseFormat	Obiekt opisujący oczekiwane dane wyjściowe modelu. Jeśli json_object tylko typ function może zostać przekazany do tools przebiegu. Jeśli text model może zwrócić tekst lub dowolną wymaganą wartość.
AzureAISearchToolDefinition	Informacje o definicji danych wejściowych narzędzia wyszukiwania sztucznej inteligencji platformy Azure używane do konfigurowania agenta.
AzureAISearchToolResource	Zestaw zasobów indeksu używanych przez narzędzie azure_ai_search.
AzureFunctionBinding	Struktura przechowywania nazwy kolejki magazynu i identyfikatora URI.
AzureFunctionDefinition	Definicja funkcji platformy Azure.
AzureFunctionStorageQueue	Struktura przechowywania nazwy kolejki magazynu i identyfikatora URI.
AzureFunctionToolDefinition	Informacje o definicji danych wejściowych narzędzia funkcji platformy Azure używane do konfigurowania agenta.
BingGroundingSearchConfiguration	Wyszukaj konfigurację dla Bing Grounding
BingGroundingSearchToolParameters	Parametry narzędzia wyszukiwania uziemienia Bing.
BingGroundingToolDefinition	Informacje o definicji danych wejściowych narzędzia wyszukiwania uziemieniowego bing używane do konfigurowania agenta.
CodeInterpreterToolDefinition	Informacje o definicji danych wejściowych narzędzia interpretera kodu używane do konfigurowania agenta.
CodeInterpreterToolResource	Zestaw zasobów używanych przez narzędzie code_interpreter.
ConnectedAgentDetails	Informacje dotyczące łączenia jednego agenta z drugim jako narzędzia
ConnectedAgentToolDefinition	Informacje o definicji danych wejściowych dla narzędzia połączonego agenta, które definiuje agenta podrzędnego specyficznego dla domeny
CreateAgentOptionalParams	Parametry opcjonalne.
CreateThreadAndRunOptionalParams	Parametry opcjonalne.
DeleteAgentOptionalParams	Parametry opcjonalne.
FileDeletionStatus	Odpowiedź stanu z operacji usuwania pliku.
FileInfo	Reprezentuje agenta, który może wywoływać model i używać narzędzi.
FileListResponse	Dane odpowiedzi z operacji listy plików.
FileSearchRankingOptions	Opcje klasyfikacji wyszukiwania plików.
FileSearchToolCallContent	Obiekt zawartości wyniku wyszukiwania pliku.
FileSearchToolDefinition	Informacje o definicji wejściowej narzędzia wyszukiwania plików używane do konfigurowania agenta.
FileSearchToolDefinitionDetails	Opcje zastępują narzędzie wyszukiwania plików.
FileSearchToolResource	Zestaw zasobów używanych przez narzędzie file_search.
FilesDeleteFileOptionalParams	Parametry opcjonalne.
FilesGetFileContentOptionalParams	Parametry opcjonalne.
FilesGetFileOptionalParams	Parametry opcjonalne.
FilesListFilesOptionalParams	Parametry opcjonalne.
FilesOperations	Interfejs reprezentujący operacje na plikach.
FilesUploadFileOptionalParams	Parametry opcjonalne.
FunctionDefinition	Informacje o definicji danych wejściowych funkcji.
FunctionName	Nazwa funkcji, która będzie używana przy użyciu narzędzia function
FunctionToolDefinition	Informacje o definicji danych wejściowych narzędzia funkcji używane do konfigurowania agenta.
GetAgentOptionalParams	Parametry opcjonalne.
IncompleteRunDetails	Szczegółowe informacje o tym, dlaczego przebieg jest niekompletny. Jeśli przebieg nie jest niekompletny, zostanie null.
ListAgentsOptionalParams	Parametry opcjonalne.
MessageAttachment	W tym artykule opisano narzędzia dołączone do pliku.
MessageContent	Abstrakcyjna reprezentacja pojedynczego elementu zawartości komunikatu wątku.
MessageDelta	Reprezentuje typowany ładunek "delta" w ramach fragmentu różnicowego komunikatu przesyłania strumieniowego.
MessageDeltaChunk	Reprezentuje różnicę komunikatów, tj. wszystkie zmienione pola w wiadomości podczas przesyłania strumieniowego.
MessageDeltaContent	Abstrakcyjna podstawowa reprezentacja częściowego ładunku zawartości komunikatu przesyłanego strumieniowo.
MessageDeltaImageFileContent	Reprezentuje część zawartości pliku obrazu przesyłanego strumieniowo w ramach fragmentu różnicowego komunikatu przesyłania strumieniowego.
MessageDeltaImageFileContentObject	Reprezentuje ładunek "image_file" w ramach zawartości pliku obrazu przesyłania strumieniowego.
MessageDeltaTextAnnotation	Abstrakcyjna podstawowa reprezentacja adnotacji tekstowej przesyłanej strumieniowo zawartości tekstowej.
MessageDeltaTextContent	Reprezentuje część zawartości tekstowej przesyłanej strumieniowo w ramach fragmentu różnicowego komunikatu przesyłania strumieniowego.
MessageDeltaTextContentObject	Reprezentuje dane części zawartości tekstowej przesyłanej strumieniowo w ramach fragmentu różnicowego komunikatu przesyłania strumieniowego.
MessageDeltaTextFileCitationAnnotation	Reprezentuje cytat ze strumienia pliku zastosowany do części zawartości tekstowej przesyłania strumieniowego.
MessageDeltaTextFileCitationAnnotationObject	Reprezentuje dane cytatu przesyłanego strumieniowo pliku zastosowane do części zawartości tekstowej przesyłania strumieniowego.
MessageDeltaTextFilePathAnnotation	Reprezentuje adnotację ścieżki pliku przesyłanego strumieniowo zastosowaną do części zawartości tekstowej przesyłania strumieniowego.
MessageDeltaTextFilePathAnnotationObject	Reprezentuje dane adnotacji ścieżki pliku przesyłanego strumieniowo, które są stosowane do części zawartości tekstowej przesyłania strumieniowego.
MessageDeltaTextUrlCitationAnnotation	Cytat w wiadomości, który wskazuje na określony adres URL powiązany z wiadomością. Generowane, gdy agent używa narzędzi, takich jak "bing_grounding" do przeszukiwania Internetu.
MessageDeltaTextUrlCitationDetails	Reprezentacja cytatu z adresu URL, używana w treści wiadomości w wątku tekstowym.
MessageImageFileContent	Reprezentacja zawartości pliku obrazu w komunikacie wątku.
MessageImageFileDetails	Odwołanie do obrazu reprezentowane w zawartości komunikatu wątku.
MessageImageFileParam	Określa, w jaki sposób odwołuje się do wewnętrznie przesłanego pliku obrazu podczas tworzenia bloku pliku obrazu.
MessageImageUrlParam	Określa, w jaki sposób odwołuje się do adresu URL obrazu zewnętrznego podczas tworzenia bloku adresu URL obrazu.
MessageIncompleteDetails	Informacje zawierające dodatkowe szczegóły dotyczące komunikatu wprowadzającego niekompletny stan.
MessageInputContentBlock	Definiuje pojedynczy blok zawartości podczas tworzenia komunikatu. Pole "type" określa, czy jest to tekst, plik obrazu, czy zewnętrzny adres URL obrazu itp.
MessageInputImageFileBlock	Blok pliku obrazu w nowej wiadomości, odwołujący się do wewnętrznie przesłanego obrazu za pomocą identyfikatora pliku.
MessageInputImageUrlBlock	Blok adresu URL obrazu w nowej wiadomości, odwołujący się do obrazu zewnętrznego za pomocą adresu URL.
MessageInputTextBlock	Blok tekstu w nowej wiadomości, zawierający zawartość zwykłego tekstu.
MessageTextAnnotation	Abstrakcyjna reprezentacja adnotacji na zawartość wiadomości tekstowych.
MessageTextContent	Reprezentacja tekstowego elementu zawartości wiadomości wątku.
MessageTextDetails	Tekst i skojarzone adnotacje dla pojedynczego elementu zawartości wiadomości wątku agenta.
MessageTextFileCitationAnnotation	Cytat w komunikacie wskazujący określony cudzysłów z określonego pliku skojarzonego z agentem lub komunikatem. Generowane, gdy agent używa narzędzia "file_search" 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.
MessageTextUrlCitationAnnotation	Cytat w wiadomości, który wskazuje na określony adres URL powiązany z wiadomością. Generowane, gdy agent używa narzędzi, takich jak "bing_grounding" do przeszukiwania Internetu.
MessageTextUrlCitationDetails	Reprezentacja cytatu z adresu URL, używana w treści wiadomości w wątku tekstowym.
MessagesCreateMessageOptionalParams	Parametry opcjonalne.
MessagesGetMessageOptionalParams	Parametry opcjonalne.
MessagesListMessagesOptionalParams	Parametry opcjonalne.
MessagesOperations	Interfejs reprezentujący operacje Messages.
MessagesUpdateMessageOptionalParams	Parametry opcjonalne.
OpenApiAnonymousAuthDetails	Szczegóły zabezpieczeń uwierzytelniania anonimowego openApi
OpenApiAuthDetails	szczegóły uwierzytelniania dla elementu OpenApiFunctionDefinition
OpenApiConnectionAuthDetails	Szczegóły zabezpieczeń uwierzytelniania połączeń openApi
OpenApiConnectionSecurityScheme	Schemat zabezpieczeń uwierzytelniania interfejsu OpenApi managed_identity
OpenApiFunctionDefinition	Informacje o definicji danych wejściowych dla funkcji openapi.
OpenApiManagedAuthDetails	Szczegóły zabezpieczeń uwierzytelniania interfejsu OpenApi managed_identity
OpenApiManagedSecurityScheme	Schemat zabezpieczeń uwierzytelniania interfejsu OpenApi managed_identity
OpenApiToolDefinition	Informacje o definicji danych wejściowych narzędzia OpenAPI używane do konfigurowania agenta.
PageSettings	Opcje dla metody byPage
PagedAsyncIterableIterator	Interfejs, który umożliwia iterację asynchronialną zarówno do ukończenia, jak i według strony.
PollingOptions	Opcje konfigurowania zachowania sondowania.
PollingOptionsParams	Parametry opcjonalne konfigurujące zachowanie sondowania.
RequiredAction	Abstrakcyjna reprezentacja wymaganej akcji dla uruchomienia wątku agenta w celu kontynuowania.
RequiredFunctionToolCall	Reprezentacja żądanego wywołania narzędzia funkcji wymaganego przez model w celu kontynuowania oceny przebiegu.
RequiredFunctionToolCallDetails	Szczegółowe informacje dotyczące wywołania funkcji, podane przez wymaganą akcję wywołującą narzędzie funkcji, które zawiera nazwę i argumenty funkcji.
RequiredToolCall	Abstrakcyjna reprezentacja wywołania narzędzia wymaganego przez model do kontynuowania działania.
ResponseFormatJsonSchema	Opis celu formatu odpowiedzi, który jest używany przez model do określenia, jak odpowiedzieć w tym formacie.
ResponseFormatJsonSchemaType	Typ zdefiniowanego formatu odpowiedzi: json_schema
RunCompletionUsage	Statystyki użycia związane z uruchomieniem. Ta wartość będzie null, jeśli przebieg nie znajduje się w stanie terminalu (tj. in_progress, queueditp.).
RunError	Szczegóły błędu napotkane przez uruchomienie wątku agenta.
RunStep	Szczegółowe informacje o jednym kroku przebiegu wątku agenta.
RunStepAzureAISearchToolCall	Rekord wywołania narzędzia azure AI Search wystawiony przez model w ocenie zdefiniowanego narzędzia, który reprezentuje wykonane wyszukiwanie sztucznej inteligencji platformy Azure.
RunStepBingGroundingToolCall	Rekord wywołania narzędzia uziemania bing wystawiony przez model w ocenie zdefiniowanego narzędzia, który reprezentuje wykonane wyszukiwanie za pomocą uziemienia bing.
RunStepCodeInterpreterImageOutput	Reprezentacja danych wyjściowych obrazu emitowanych przez narzędzie interpretera kodu w odpowiedzi na wywołanie narzędzia przez model.
RunStepCodeInterpreterImageReference	Odwołanie do obrazu emitowane przez narzędzie interpretera kodu w odpowiedzi na wywołanie narzędzia przez model.
RunStepCodeInterpreterLogOutput	Reprezentacja danych wyjściowych dziennika emitowanych przez narzędzie interpretera kodu w odpowiedzi na wywołanie narzędzia przez model.
RunStepCodeInterpreterToolCall	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.
RunStepCodeInterpreterToolCallDetails	Szczegółowe informacje o wywołaniu interpretera kodu przez model.
RunStepCodeInterpreterToolCallOutput	Abstrakcyjna reprezentacja emitowanych danych wyjściowych z narzędzia interpretera kodu.
RunStepCompletionUsage	Statystyki użycia związane z krokiem uruchamiania.
RunStepDelta	Reprezentuje ładunek różnicowy we fragmentach kroku uruchamiania przesyłania strumieniowego.
RunStepDeltaChunk	Reprezentuje różnicę kroku uruchamiania, tj. wszelkie zmienione pola w kroku uruchamiania podczas przesyłania strumieniowego.
RunStepDeltaCodeInterpreterDetailItemObject	Reprezentuje dane wywołania narzędzia Interpreter kodu w wywołaniach narzędzi przebiegu przesyłania strumieniowego.
RunStepDeltaCodeInterpreterImageOutput	Reprezentuje dane wyjściowe obrazu utworzone za pomocą narzędzia interpretera kodu i reprezentowane w narzędziu delta kroku uruchamiania przesyłania strumieniowego.
RunStepDeltaCodeInterpreterImageOutputObject	Reprezentuje dane dla danych wyjściowych obrazu w narzędziu interpretera kodu kroku przesyłania strumieniowego.
RunStepDeltaCodeInterpreterLogOutput	Reprezentuje dane wyjściowe dziennika wygenerowane przez narzędzie Interpreter kodu i reprezentowane w narzędziu delta kroku przebiegu przesyłania strumieniowego wywołuje kolekcję.
RunStepDeltaCodeInterpreterOutput	Abstrakcyjna podstawowa reprezentacja danych wyjściowych narzędzia do uruchamiania przesyłania strumieniowego wywołuje dane wyjściowe narzędzia Interpreter kodu.
RunStepDeltaCodeInterpreterToolCall	Reprezentuje wywołanie narzędzia Interpreter kodu w szczegółach wywołania narzędzia przebiegu przesyłania strumieniowego.
RunStepDeltaDetail	Reprezentuje pojedynczy element szczegółów kroku przebiegu w ładunku różnicowym kroku przebiegu przesyłania strumieniowego.
RunStepDeltaFileSearchToolCall	Reprezentuje wywołanie narzędzia wyszukiwania plików w szczegółach wywołania narzędzia przebiegu przesyłania strumieniowego.
RunStepDeltaFunction	Reprezentuje dane funkcji w wywołaniu narzędzia funkcji kroku przebiegu przesyłania strumieniowego.
RunStepDeltaFunctionToolCall	Reprezentuje wywołanie narzędzia funkcji w szczegółach wywołania narzędzia przebiegu przesyłania strumieniowego.
RunStepDeltaMessageCreation	Reprezentuje tworzenie komunikatów w ramach delta kroku przebiegu przesyłania strumieniowego.
RunStepDeltaMessageCreationObject	Reprezentuje dane w obiekcie odpowiedzi na potrzeby tworzenia komunikatów kroków przebiegu przesyłania strumieniowego.
RunStepDeltaToolCall	Abstrakcyjna podstawowa reprezentacja pojedynczego wywołania narzędzia w szczegółach wywołania narzędzia delta kroku przebiegu przesyłania strumieniowego.
RunStepDeltaToolCallObject	Reprezentuje wywołanie wywołań narzędzi w ramach kroku przebiegu przesyłania strumieniowego.
RunStepDetails	Abstrakcyjna reprezentacja szczegółów dla kroku uruchamiania.
RunStepError	Informacje o błędzie skojarzone z krokiem uruchomienia, który zakończył się niepowodzeniem.
RunStepFileSearchToolCall	Rekord wywołania narzędzia do wyszukiwania plików wystawiony przez model w ocenie zdefiniowanego narzędzia, który reprezentuje wykonane wyszukiwanie plików.
RunStepFileSearchToolCallResult	Wynik wywołania narzędzia wyszukiwania plików.
RunStepFileSearchToolCallResults	Wyniki wyszukiwania plików.
RunStepFunctionToolCall	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ę.
RunStepFunctionToolCallDetails	Szczegółowe informacje o funkcji wywoływanej przez model.
RunStepMessageCreationDetails	Szczegółowe informacje skojarzone z krokiem uruchamiania tworzenia komunikatów.
RunStepMessageCreationReference	Szczegóły komunikatu utworzonego w ramach kroku uruchamiania.
RunStepOpenAPIToolCall	Rekord wywołania narzędzia OpenAPI, wystawiony przez model w ocenie zdefiniowanego narzędzia, który reprezentuje wykonane operacje OpenAPI.
RunStepToolCall	Abstrakcyjna reprezentacja szczegółowego wywołania narzędzia zarejestrowanego w ramach kroku uruchamiania dla istniejącego przebiegu.
RunStepToolCallDetails	Szczegółowe informacje skojarzone z narzędziami wywoływania kroków uruchamiania.
RunStepsGetRunStepOptionalParams	Parametry opcjonalne.
RunStepsListRunStepsOptionalParams	Parametry opcjonalne.
RunStepsOperations	Interfejs reprezentujący operacje RunSteps.
RunsCancelRunOptionalParams	Parametry opcjonalne.
RunsCreateRunOptionalParams	Parametry opcjonalne.
RunsGetRunOptionalParams	Parametry opcjonalne.
RunsListRunsOptionalParams	Parametry opcjonalne.
RunsOperations	Interfejs reprezentujący operacje uruchamiania.
RunsSubmitToolOutputsToRunOptionalParams	Parametry opcjonalne.
RunsUpdateRunOptionalParams	Parametry opcjonalne.
SubmitToolOutputsAction	Szczegóły wymaganych wywołań narzędzi, które muszą zostać przesłane do uruchomienia wątku agenta, aby kontynuować.
SubmitToolOutputsDetails	Szczegóły opisujące narzędzia, które powinny być wywoływane w celu przesyłania danych wyjściowych narzędzia.
ThreadDeletionStatus	Stan operacji usuwania wątku.
ThreadMessage	Pojedynczy, istniejący komunikat w wątku agenta.
ThreadMessageOptions	Pojedynczy komunikat w wątku agenta podany podczas tworzenia tego wątku dla stanu początkowego.
ThreadRun	Dane reprezentujące pojedynczy przebieg oceny wątku agenta.
ThreadsCreateThreadOptionalParams	Parametry opcjonalne.
ThreadsDeleteThreadOptionalParams	Parametry opcjonalne.
ThreadsGetThreadOptionalParams	Parametry opcjonalne.
ThreadsListThreadsOptionalParams	Parametry opcjonalne.
ThreadsOperations	Interfejs reprezentujący operacje Threads.
ThreadsUpdateThreadOptionalParams	Parametry opcjonalne.
ToolDefinition	Abstrakcyjna reprezentacja definicji narzędzia wejściowego, która może być używana przez agenta.
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.
ToolResources	Zestaw zasobów używanych przez narzędzia agenta. Zasoby są specyficzne dla typu narzędzia. Na przykład code_interpreter narzędzie wymaga listy identyfikatorów plików, a file_search narzędzie wymaga listy identyfikatorów magazynów wektorów.
TruncationObject	Określa sposób obcinania wątku przed uruchomieniem. Służy do kontrolowania początkowego okna kontekstu przebiegu.
UpdateAgentOptionalParams	Parametry opcjonalne.
VectorStore	Magazyn wektorów to kolekcja przetworzonych plików może być używana przez file_search narzędzie.
VectorStoreAutoChunkingStrategyRequest	Strategia domyślna. Ta strategia używa obecnie max_chunk_size_tokens z 800 i chunk_overlap_tokens z 400.
VectorStoreAutoChunkingStrategyResponse	Jest to zwracane, gdy strategia fragmentowania jest nieznana. Zazwyczaj jest to spowodowane tym, że plik został zaindeksowany przed wprowadzeniem koncepcji chunking_strategy w interfejsie API.
VectorStoreChunkingStrategyRequest	Abstrakcyjna reprezentacja konfiguracji strategii fragmentowania magazynu wektorów.
VectorStoreChunkingStrategyResponse	Abstrakcyjna reprezentacja konfiguracji strategii fragmentowania magazynu wektorów.
VectorStoreConfiguration	Konfiguracja magazynu wektorowego to lista źródeł danych używanych w przypadku użycia wielu plików do wyszukiwania plików przedsiębiorstwa.
VectorStoreConfigurations	Struktura zawierająca listę konfiguracji magazynu wektorowego, tj. listę identyfikatorów zasobów platformy Azure.
VectorStoreDataSource	Struktura zawierająca ścieżkę identyfikatora URI zasobu platformy Azure i typ zasobu pliku używanego jako źródło danych dla wyszukiwania plików przedsiębiorstwa.
VectorStoreDeletionStatus	Obiekt odpowiedzi do usuwania magazynu wektorów.
VectorStoreExpirationPolicy	Zasady wygasania magazynu wektorów.
VectorStoreFile	Opis pliku dołączonego do magazynu wektorów.
VectorStoreFileBatch	Partia plików dołączonych do magazynu wektorów.
VectorStoreFileBatchesCancelVectorStoreFileBatchOptionalParams	Parametry opcjonalne.
VectorStoreFileBatchesCreateVectorStoreFileBatchOptionalParams	Parametry opcjonalne.
VectorStoreFileBatchesGetVectorStoreFileBatchOptionalParams	Parametry opcjonalne.
VectorStoreFileBatchesListVectorStoreFileBatchFilesOptionalParams	Parametry opcjonalne.
VectorStoreFileBatchesOperations	Interfejs reprezentujący operacje VectorStoreFileBatches.
VectorStoreFileCount	Liczba plików przetwarzanych lub przetwarzanych przez ten magazyn wektorów pogrupowanych według stanu.
VectorStoreFileDeletionStatus	Obiekt odpowiedzi na potrzeby usuwania relacji pliku magazynu wektorów.
VectorStoreFileError	Szczegółowe informacje na temat błędu, który mógł wystąpić podczas przetwarzania pliku dla tego magazynu wektorów
VectorStoreFilesCreateVectorStoreFileOptionalParams	Parametry opcjonalne.
VectorStoreFilesDeleteVectorStoreFileOptionalParams	Parametry opcjonalne.
VectorStoreFilesGetVectorStoreFileOptionalParams	Parametry opcjonalne.
VectorStoreFilesListVectorStoreFilesOptionalParams	Parametry opcjonalne.
VectorStoreFilesOperations	Interfejs reprezentujący operacje VectorStoreFiles.
VectorStoreStaticChunkingStrategyOptions	Opcje konfigurowania strategii fragmentowania statycznego magazynu wektorów.
VectorStoreStaticChunkingStrategyRequest	Statycznie skonfigurowana strategia fragmentowania.
VectorStoreStaticChunkingStrategyResponse	Statycznie skonfigurowana strategia fragmentowania.
VectorStoresCreateVectorStoreOptionalParams	Parametry opcjonalne.
VectorStoresDeleteVectorStoreOptionalParams	Parametry opcjonalne.
VectorStoresGetVectorStoreOptionalParams	Parametry opcjonalne.
VectorStoresListVectorStoresOptionalParams	Parametry opcjonalne.
VectorStoresModifyVectorStoreOptionalParams	Parametry opcjonalne.
VectorStoresOperations	Interfejs reprezentujący operacje VectorStores.

Aliasy typu

AgentEventStreamData	Reprezentuje dane zdarzenia strumienia w agencie.
AgentRunResponse	Agent uruchamia odpowiedź z obsługą strumienia.
AgentStreamEvent	Alias dla AgentStreamEvent
AgentsNamedToolChoiceType	Dostępne typy narzędzi dla agentów o nazwach tools.
AgentsResponseFormatMode	Reprezentuje tryb, w którym model będzie obsługiwał format zwracany wywołania narzędzia.
AgentsResponseFormatOption	Alias dla AgentsResponseFormatOption
AgentsToolChoiceOption	Alias dla AgentsToolChoiceOption
AgentsToolChoiceOptionMode	Określa, w jaki sposób wybrane narzędzie będzie używane
AzureAISearchQueryType	Dostępne typy zapytań dla narzędzia Azure AI Search.
ContinuablePage	Interfejs opisujący stronę wyników.
FileContents	Prawidłowe wartości zawartości pliku binarnego.
FilePurpose	Możliwe wartości oznaczające zamierzone użycie pliku.
FileState	Stan pliku.
ImageDetailLevel	Określa poziom szczegółowości obrazu. Może to być wartość "auto", "niska", "wysoka" lub nieznana wartość przyszła.
IncompleteDetailsReason	Powód, dla którego przebieg jest niekompletny. Będzie to wskazywać, który limit tokenów został osiągnięty w trakcie przebiegu.
ListSortOrder	Dostępne opcje sortowania podczas żądania listy obiektów odpowiedzi.
MessageAttachmentToolDefinition	Alias dla messageAttachmentToolDefinition
MessageBlockType	Określa rodzaj bloku treści w wiadomości. Może to być tekst, plik obrazu, adres URL obrazu zewnętrznego lub nieznany przyszły typ.
MessageContentUnion	Alias dla MessageContentUnion
MessageDeltaContentUnion	Alias dla MessageDeltaContentUnion
MessageDeltaTextAnnotationUnion	Alias dla MessageDeltaTextAnnotationUnion
MessageIncompleteDetailsReason	Zestaw powodów opisujących, dlaczego wiadomość jest oznaczana jako niekompletna.
MessageInputContent	Alias dla MessageInputContent
MessageInputContentBlockUnion	Alias dla MessageInputContentBlockUnion
MessageRole	Możliwe wartości ról przypisanych do wiadomości w wątku.
MessageStatus	Możliwe wartości stanu wykonania dla komunikatu wątku.
MessageTextAnnotationUnion	Alias dla MessageTextAnnotationUnion
OpenApiAuthDetailsUnion	Alias dla OpenApiAuthDetailsUnion
OpenApiAuthType	Typ uwierzytelniania dla punktu końcowego OpenAPI. Dozwolone typy to: Anonimowy (uwierzytelnianie nie jest wymagane) Połączenie (wymaga connection_id do punktu końcowego, zgodnie z konfiguracją w AI Foundry) Managed_Identity (wymaga odbiorców do uwierzytelniania opartego na tożsamości)
RequiredActionUnion	Alias dla RequiredActionUnion
RequiredToolCallUnion	Alias dla RequiredToolCallUnion
ResponseFormat	Możliwe formaty odpowiedzi interfejsu API.
RunAdditionalFieldList	Lista dodatkowych pól do uwzględnienia w odpowiedzi.
RunStatus	Możliwe wartości stanu przebiegu wątku agenta.
RunStepCodeInterpreterToolCallOutputUnion	Alias dla RunStepCodeInterpreterToolCallOutputUnion
RunStepDeltaCodeInterpreterOutputUnion	Alias dla RunStepDeltaCodeInterpreterOutputUnion
RunStepDeltaDetailUnion	Alias dla RunStepDeltaDetailUnion
RunStepDeltaToolCallUnion	Alias dla RunStepDeltaToolCallUnion
RunStepDetailsUnion	Alias dla RunStepDetailsUnion
RunStepErrorCode	Możliwe wartości kodów błędów, które można przypisać krokowi uruchomienia, który zakończył się niepowodzeniem.
RunStepStatus	Możliwe wartości stanu kroku uruchamiania.
RunStepToolCallUnion	Alias dla RunStepToolCallUnion
RunStepType	Możliwe typy kroków uruchamiania.
ToolDefinitionUnion	Alias dla ToolDefinitionUnion
TruncationStrategy	Możliwe strategie obcinania dla wątku.
VectorStoreChunkingStrategyRequestType	Rodzaj strategii chunkingu
VectorStoreChunkingStrategyRequestUnion	Alias dla VectorStoreChunkingStrategyRequestUnion
VectorStoreChunkingStrategyResponseType	Rodzaj strategii chunkingu
VectorStoreChunkingStrategyResponseUnion	Alias dla VectorStoreChunkingStrategyResponseUnion
VectorStoreExpirationPolicyAnchor	Opisuje zależność między dniami a wygaśnięciem tego magazynu wektorów
VectorStoreFileBatchStatus	Stan wsadu pliku składnicy wektorów.
VectorStoreFileErrorCode	Warianty kodów błędów dla przetwarzania plików magazynu wektorów
VectorStoreFileStatus	Stan pliku magazynu wektorów
VectorStoreFileStatusFilter	Filtr parametrów zapytania dla punktu końcowego pobierania pliku magazynu wektorów
VectorStoreStatus	Możliwy status sklepu wektorowego

Wyliczenia

DoneEvent	Zdarzenie terminalu wskazujące pomyślne zakończenie strumienia.
ErrorEvent	Zdarzenie terminalu wskazujące błąd po stronie serwera podczas przesyłania strumieniowego.
KnownVersions	Wersje interfejsu API agentów sztucznej inteligencji platformy Azure
MessageStreamEvent	Zdarzenia przesyłania strumieniowego związane z operacją komunikatów
RunStepStreamEvent	Uruchamianie zdarzeń przesyłania strumieniowego związanych z operacją kroku
RunStreamEvent	Uruchamianie zdarzeń przesyłania strumieniowego związanych z operacją
ThreadStreamEvent	Zdarzenia przesyłania strumieniowego związane z operacjami wątków
VectorStoreDataSourceAssetType	Typ zasobu magazynu wektorowego. Typ zasobu może być uri_asset, w tym przypadku powinien zawierać identyfikator URI zasobu, w przypadku id_asset powinien zawierać identyfikator danych.
connectionToolType	Typy narzędzi połączeń używanych do konfigurowania agenta

Funkcje

isOutputOfType<T>(ToolDefinitionUnion | RequiredAction | RequiredToolCall, string)

Określa, czy dane wyjściowe mają określony typ.

Szczegóły funkcji

isOutputOfType<T>(ToolDefinitionUnion | RequiredAction | RequiredToolCall, string)

Określa, czy dane wyjściowe mają określony typ.

function isOutputOfType<T>(output: ToolDefinitionUnion | RequiredAction | RequiredToolCall, type: string): output

Parametry

output

ToolDefinitionUnion | RequiredAction | RequiredToolCall

Akcja do sprawdzenia, która może być typu RequiredAction, RequiredToolCalllub ToolDefinitionUnion.

type

string

Typ do sprawdzenia akcji.

Zwraca

output

Wartość logiczna wskazująca, czy akcja jest określonego typu.