@azure/ai-agents package

Třídy

AgentsClient
ToolSet	Představuje sadu nástrojů s jejich definicemi a prostředky.
ToolUtility	Utility třída pro vytváření různých nástrojů.

Rozhraní

AISearchIndexResource	Zdroj indexu vyhledávání AI.
Agent	Představuje agenta, který může volat model a používat nástroje.
AgentDeletionStatus	Stav operace odstranění agenta.
AgentErrorDetail	Popisuje informace o chybě vrácené rozhraním API agentů.
AgentEventMessage	Každá událost v datovém proudu událostí odeslaných serverem má vlastnost event a data: * * Příklad Událost: thread.created data: {"id": "thread_123", "object": "vlákno", ...} Události generujeme při každém vytvoření nového objektu, přechodu na nový stav nebo streamované v částech (rozdíly). Například vygenerujeme thread.run.created při novém spuštění. se vytvoří, thread.run.completed po dokončení spuštění atd. Když agent zvolí vytvořit zprávu během spuštění, vygenerujeme thread.message.created event, a thread.message.in_progress události, mnoho událostí thread.message.delta a nakonec thread.message.completed událost. V průběhu času můžeme přidat další události, proto doporučujeme řádně zpracovávat neznámé události. v kódu.
AgentEventMessageStream	Představuje datový proud zprávy události agenta.
AgentThread	Informace o jednom vlákně přidruženém k agentu
AgentThreadCreationOptions	Podrobnosti použité k vytvoření nového vlákna agenta.
AgentV1Error	Datová část Error vrácená rozhraním API agentů.
AgentsClientOptionalParams	Volitelné parametry pro klienta.
AgentsNamedToolChoice	Určuje nástroj, který má model použít. Slouží k vynucení volání konkrétního nástroje modelu.
AgentsResponseFormat	Objekt popisující očekávaný výstup modelu. Je-li json_object povoleno předání pouze function typu tools do spuštění. Pokud text model může vrátit text nebo libovolnou potřebnou hodnotu.
AzureAISearchToolDefinition	Informace o definici vstupu pro vyhledávací nástroj Azure AI, jak slouží ke konfiguraci agenta.
AzureAISearchToolResource	Sada prostředků indexu, které nástroj azure_ai_search používá.
AzureFunctionBinding	Struktura pro zachování názvu fronty úložiště a identifikátoru URI.
AzureFunctionDefinition	Definice funkce Azure.
AzureFunctionStorageQueue	Struktura pro zachování názvu fronty úložiště a identifikátoru URI.
AzureFunctionToolDefinition	Informace o definici vstupu pro nástroj funkce Azure, které slouží ke konfiguraci agenta.
BingGroundingSearchConfiguration	Konfigurace vyhledávání pro Bing Grounding
BingGroundingSearchToolParameters	Parametry nástroje pro vyhledávání uzemnění Bing.
BingGroundingToolDefinition	Informace o definici vstupu pro vyhledávací nástroj Bingu, který se používá ke konfiguraci agenta.
CodeInterpreterToolDefinition	Informace o definici vstupu pro nástroj interpret kódu, který slouží ke konfiguraci agenta.
CodeInterpreterToolResource	Sada prostředků, které nástroj code_interpreter používá.
ConnectedAgentDetails	Informace pro propojení jednoho agenta s druhým jako nástroj
ConnectedAgentToolDefinition	Informace o definici vstupu pro nástroj připojeného agenta, který definuje dílčího agenta specifického pro doménu
CreateAgentOptionalParams	Volitelné parametry.
CreateThreadAndRunOptionalParams	Volitelné parametry.
DeleteAgentOptionalParams	Volitelné parametry.
FileDeletionStatus	Odpověď na stav operace odstranění souboru.
FileInfo	Představuje agenta, který může volat model a používat nástroje.
FileListResponse	Data odpovědi z operace se seznamem souborů.
FileSearchRankingOptions	Možnosti řazení pro vyhledávání souborů
FileSearchToolCallContent	Objekt obsahu výsledků hledání souboru.
FileSearchToolDefinition	Informace o definici vstupu pro nástroj pro vyhledávání souborů, jak se používá ke konfiguraci agenta.
FileSearchToolDefinitionDetails	Možnosti přepíšou nástroj pro vyhledávání souborů.
FileSearchToolResource	Sada prostředků, které nástroj file_search používá.
FilesDeleteFileOptionalParams	Volitelné parametry.
FilesGetFileContentOptionalParams	Volitelné parametry.
FilesGetFileOptionalParams	Volitelné parametry.
FilesListFilesOptionalParams	Volitelné parametry.
FilesOperations	Rozhraní reprezentující operace se soubory.
FilesUploadFileOptionalParams	Volitelné parametry.
FunctionDefinition	Informace o definici vstupu pro funkci.
FunctionName	Název funkce, který se použije, pokud používáte nástroj function
FunctionToolDefinition	Informace o definici vstupu pro nástroj funkce používané ke konfiguraci agenta.
GetAgentOptionalParams	Volitelné parametry.
IncompleteRunDetails	Podrobnosti o tom, proč je spuštění neúplné. Pokud spuštění není neúplné, bude null.
ListAgentsOptionalParams	Volitelné parametry.
MessageAttachment	Popisuje, ke kterým nástrojům byl soubor připojen.
MessageContent	Abstraktní reprezentace jedné položky obsahu zprávy vlákna.
MessageDelta	Představuje datovou část typu Delta v bloku delta streamovaných zpráv.
MessageDeltaChunk	Představuje rozdíl zprávy, tj. všechna změněná pole zprávy během streamování.
MessageDeltaContent	Abstraktní základní reprezentace datové části částečně streamovaného obsahu zprávy.
MessageDeltaImageFileContent	Představuje část obsahu streamovaného souboru obrázku v bloku delta streamovaných zpráv.
MessageDeltaImageFileContentObject	Představuje datovou část image_file v obsahu streamovaného souboru obrázku.
MessageDeltaTextAnnotation	Abstraktní základní reprezentace textové poznámky části streamovaného textu.
MessageDeltaTextContent	Představuje streamovanou část textového obsahu v bloku delta streamovaných zpráv.
MessageDeltaTextContentObject	Představuje data streamovaného textového obsahu v bloku delta streamovaných zpráv.
MessageDeltaTextFileCitationAnnotation	Představuje citaci streamovaného souboru použitou u části streamovaného textového obsahu.
MessageDeltaTextFileCitationAnnotationObject	Představuje data streamované citace souboru, která se používá u části streamovaného textového obsahu.
MessageDeltaTextFilePathAnnotation	Představuje poznámku k cestě k streamovaným souborům použitou u části streamovaného textového obsahu.
MessageDeltaTextFilePathAnnotationObject	Představuje data streamované poznámky k cestě k souboru, která se používá u části streamovaného textového obsahu.
MessageDeltaTextUrlCitationAnnotation	Citace ve zprávě, která odkazuje na konkrétní adresu URL spojenou se zprávou. Generuje, když agent používá k vyhledávání na internetu nástroje, jako je například "bing_grounding".
MessageDeltaTextUrlCitationDetails	Reprezentace citace adresy URL, která se používá v obsahu textové zprávy vlákna.
MessageImageFileContent	Reprezentace obsahu souboru obrázku ve zprávě vlákna.
MessageImageFileDetails	Odkaz na obrázek, jak je znázorněno v obsahu zprávy ve vlákně.
MessageImageFileParam	Definuje, jak se odkazuje na interně nahraný obrazový soubor při vytváření bloku obrazového souboru.
MessageImageUrlParam	Definuje, jak se odkazuje na adresu URL externího obrázku při vytváření bloku URL-image.
MessageIncompleteDetails	Informace s dalšími podrobnostmi o zprávě, která zadává neúplný stav
MessageInputContentBlock	Definuje jeden blok obsahu při vytváření zprávy. Pole Type určuje, jestli se jedná o text, soubor obrázku nebo adresu URL externího obrázku atd.
MessageInputImageFileBlock	Blok obrázkového souboru v nové zprávě, odkazující na interně nahraný obrázek podle ID souboru.
MessageInputImageUrlBlock	Blok adresy URL obrázku v nové zprávě, odkazující na externí obrázek pomocí adresy URL.
MessageInputTextBlock	Textový blok v nové zprávě, který obsahuje prostý text.
MessageTextAnnotation	Abstraktní reprezentace obsahu zprávy s textovým vláknem
MessageTextContent	Reprezentace textové položky obsahu zprávy vlákna.
MessageTextDetails	Text a přidružené poznámky pro jednu položku obsahu zprávy vlákna agenta.
MessageTextFileCitationAnnotation	Citace ve zprávě, která odkazuje na konkrétní citaci z konkrétního souboru přidruženého k agentu nebo zprávě. Generuje se, když agent k vyhledávání souborů používá nástroj file_search.
MessageTextFileCitationDetails	Reprezentace textových citací založených na souborech, jak se používá v anotaci obsahu zprávy textového vlákna.
MessageTextFilePathAnnotation	Citace ve zprávě, která odkazuje na soubor umístěný v určité cestě.
MessageTextFilePathDetails	Zapouzdření ID souboru obrázku používaného obsahem obrázku
MessageTextUrlCitationAnnotation	Citace ve zprávě, která odkazuje na konkrétní adresu URL spojenou se zprávou. Generuje, když agent používá k vyhledávání na internetu nástroje, jako je například "bing_grounding".
MessageTextUrlCitationDetails	Reprezentace citace adresy URL, která se používá v obsahu textové zprávy vlákna.
MessagesCreateMessageOptionalParams	Volitelné parametry.
MessagesGetMessageOptionalParams	Volitelné parametry.
MessagesListMessagesOptionalParams	Volitelné parametry.
MessagesOperations	Rozhraní reprezentující operace se zprávami.
MessagesUpdateMessageOptionalParams	Volitelné parametry.
OpenApiAnonymousAuthDetails	Podrobnosti zabezpečení pro anonymní ověřování OpenApi
OpenApiAuthDetails	podrobnosti o ověřování pro OpenApiFunctionDefinition
OpenApiConnectionAuthDetails	Podrobnosti o zabezpečení pro ověřování připojení OpenApi
OpenApiConnectionSecurityScheme	Schéma zabezpečení pro ověřování managed_identity OpenApi
OpenApiFunctionDefinition	Informace o definici vstupu pro funkci openapi.
OpenApiManagedAuthDetails	Podrobnosti zabezpečení pro ověřování managed_identity OpenApi
OpenApiManagedSecurityScheme	Schéma zabezpečení pro ověřování managed_identity OpenApi
OpenApiToolDefinition	Informace o definici vstupu pro nástroj OpenAPI, jak slouží ke konfiguraci agenta.
PageSettings	Možnosti pro metodu byPage
PagedAsyncIterableIterator	Rozhraní, které umožňuje asynchronní iteraci k dokončení i po stránce.
PollingOptions	Možnosti konfigurace chování dotazování
PollingOptionsParams	Volitelné parametry, které konfigurují chování dotazování.
RequiredAction	Pokračujte abstraktní reprezentací požadované akce pro spuštění vlákna agenta.
RequiredFunctionToolCall	Reprezentace požadovaného volání do nástroje funkce, které model potřebuje k pokračování v hodnocení spuštění.
RequiredFunctionToolCallDetails	Podrobné informace o vyvolání funkce, jak poskytuje požadovaná akce vyvolávající nástroj funkce, která obsahuje název funkce a argumenty funkce.
RequiredToolCall	Abstraktní reprezentace vyvolání nástroje, které model potřebuje k pokračování ve spuštění.
ResponseFormatJsonSchema	Popis formátu odpovědi, který model používá k určení způsobu reakce v tomto formátu.
ResponseFormatJsonSchemaType	Typ formátu odpovědi, který se definuje: json_schema
RunCompletionUsage	Statistiky využití související se spuštěním Tato hodnota bude null, pokud spuštění není v terminálovém stavu (tj. in_progress, queuedatd.).
RunError	Podrobnosti o chybě, ke které došlo při spuštění vlákna agenta.
RunStep	Podrobné informace o jednom kroku spuštění vlákna agenta
RunStepAzureAISearchToolCall	Záznam volání nástroje Azure AI Search vydaného modelem při vyhodnocení definovaného nástroje, který představuje spuštěné vyhledávání Azure AI.
RunStepBingGroundingToolCall	Záznam volání nástroje bingu pro uzemnění vydaného modelem při vyhodnocení definovaného nástroje, který představuje spuštěné vyhledávání pomocí zemnění Bingu.
RunStepCodeInterpreterImageOutput	Reprezentace výstupu obrázku generovaného nástrojem interpreta kódu v reakci na volání nástroje modelem.
RunStepCodeInterpreterImageReference	Odkaz na obrázek vygenerovaný nástrojem interpreta kódu v reakci na volání nástroje modelem.
RunStepCodeInterpreterLogOutput	Reprezentace výstupu protokolu generovaného nástrojem interpretu kódu v reakci na volání nástroje modelem.
RunStepCodeInterpreterToolCall	Záznam volání nástroje interpreta kódu vydaného modelem při vyhodnocení definovaného nástroje, který představuje vstupy a výstupy spotřebované a generované interpretem kódu.
RunStepCodeInterpreterToolCallDetails	Podrobné informace o vyvolání interpreta kódu modelem.
RunStepCodeInterpreterToolCallOutput	Abstraktní reprezentace vygenerovaného výstupu z nástroje interpreta kódu.
RunStepCompletionUsage	Statistiky využití související s krokem spuštění
RunStepDelta	Představuje rozdílovou datovou část v rozdílovém bloku kroku spuštění streamování.
RunStepDeltaChunk	Představuje rozdílový krok spuštění, tj. všechna změněná pole v kroku spuštění během streamování.
RunStepDeltaCodeInterpreterDetailItemObject	Představuje data volání nástroje Interpret kódu ve volání nástrojů kroku spuštění streamování.
RunStepDeltaCodeInterpreterImageOutput	Představuje výstup obrázku vytvořený interpretem kódu a jak je znázorněno v rozdílových voláních nástroje kroku spuštění streamování.
RunStepDeltaCodeInterpreterImageOutputObject	Představuje data pro výstup obrázku volání výstupu obrázku v kroku spuštění streamování.
RunStepDeltaCodeInterpreterLogOutput	Představuje výstupprotokoluhoho kódu a představuje výstup protokolu v kolekci rozdílových volání kroku spuštění streamování.
RunStepDeltaCodeInterpreterOutput	Abstraktní základní reprezentace výstupu nástroje kroku spuštění streamování volání výstupu nástroje Code Interpret.
RunStepDeltaCodeInterpreterToolCall	Představuje volání nástroje Interpret kódu v rámci podrobností o volání kroku spuštění streamování.
RunStepDeltaDetail	Představuje položku s podrobnostmi o jednom kroku spuštění v datové části kroku spuštění streamování.
RunStepDeltaFileSearchToolCall	Představuje volání nástroje pro vyhledávání souborů v rámci podrobností o volání kroku spuštění streamování.
RunStepDeltaFunction	Představuje data funkce ve volání nástroje funkce delta kroku spuštění streamování.
RunStepDeltaFunctionToolCall	Představuje volání nástroje funkce v rámci podrobností o volání kroku spuštění streamování.
RunStepDeltaMessageCreation	Představuje vytvoření zprávy v rámci rozdílu kroku spuštění streamování.
RunStepDeltaMessageCreationObject	Představuje data v rámci objektu odpovědi na vytvoření zprávy spuštění streamování.
RunStepDeltaToolCall	Abstraktní základní reprezentace jednoho volání nástroje v podrobnostech volání nástroje pro spuštění streamování.
RunStepDeltaToolCallObject	Představuje vyvolání volání nástrojů jako součást kroku spuštění streamování.
RunStepDetails	Abstraktní reprezentace podrobností o kroku spuštění.
RunStepError	Informace o chybě spojené s neúspěšným krokem spuštění
RunStepFileSearchToolCall	Záznam volání vyhledávacího nástroje souboru vydaného modelem při vyhodnocení definovaného nástroje, který představuje spuštěné vyhledávání souborů.
RunStepFileSearchToolCallResult	Výsledek volání nástroje pro vyhledávání souborů
RunStepFileSearchToolCallResults	Výsledky hledání souboru.
RunStepFunctionToolCall	Záznam volání nástroje funkce vydaného modelem při vyhodnocení definovaného nástroje, který představuje vstupy a výstup spotřebovaný a vygenerovaný zadanou funkcí.
RunStepFunctionToolCallDetails	Podrobné informace o funkci volané modelem.
RunStepMessageCreationDetails	Podrobné informace přidružené ke kroku spuštění při vytváření zprávy.
RunStepMessageCreationReference	Podrobnosti o zprávě vytvořené v rámci kroku spuštění
RunStepOpenAPIToolCall	Záznam volání nástroje OpenAPI, vydaného modelem při vyhodnocování definovaného nástroje, který představuje provedené operace OpenAPI.
RunStepToolCall	Abstraktní reprezentace podrobného volání nástroje zaznamenaného v kroku spuštění pro existující spuštění.
RunStepToolCallDetails	Podrobné informace přidružené k nástrojům pro volání kroku spuštění.
RunStepsGetRunStepOptionalParams	Volitelné parametry.
RunStepsListRunStepsOptionalParams	Volitelné parametry.
RunStepsOperations	Rozhraní reprezentující operace RunSteps.
RunsCancelRunOptionalParams	Volitelné parametry.
RunsCreateRunOptionalParams	Volitelné parametry.
RunsGetRunOptionalParams	Volitelné parametry.
RunsListRunsOptionalParams	Volitelné parametry.
RunsOperations	Rozhraní představující Spustí operace.
RunsSubmitToolOutputsToRunOptionalParams	Volitelné parametry.
RunsUpdateRunOptionalParams	Volitelné parametry.
SubmitToolOutputsAction	Podrobnosti o požadovaných voláních nástrojů, která musí být odeslána pro spuštění vlákna agenta, aby bylo možné pokračovat.
SubmitToolOutputsDetails	Podrobnosti popisující nástroje, které by měly být volány k odesílání výstupů nástrojů.
ThreadDeletionStatus	Stav operace odstranění vlákna.
ThreadMessage	Jedna existující zpráva v rámci vlákna agenta.
ThreadMessageOptions	Jedna zpráva v rámci vlákna agenta, jak je uvedeno během vytváření vlákna pro jeho počáteční stav.
ThreadRun	Data představující jedno zkušební spuštění vlákna agenta.
ThreadsCreateThreadOptionalParams	Volitelné parametry.
ThreadsDeleteThreadOptionalParams	Volitelné parametry.
ThreadsGetThreadOptionalParams	Volitelné parametry.
ThreadsListThreadsOptionalParams	Volitelné parametry.
ThreadsOperations	Rozhraní reprezentující operace Threads.
ThreadsUpdateThreadOptionalParams	Volitelné parametry.
ToolDefinition	Abstraktní reprezentace definice vstupního nástroje, kterou může agent používat.
ToolOutput	Data poskytnutá během odeslání výstupu nástroje za účelem vyřešení čekajících volání nástrojů a umožní modelu pokračovat.
ToolResources	Sada prostředků, které používají nástroje agenta. Prostředky jsou specifické pro typ nástroje. Nástroj například code_interpreter vyžaduje seznam ID souborů, zatímco file_search nástroj vyžaduje seznam ID úložiště vektorů.
TruncationObject	Určuje, jak bude vlákno před spuštěním zkráceno. Pomocí tohoto příkazu můžete řídit počáteční kontextové okno spuštění.
UpdateAgentOptionalParams	Volitelné parametry.
VectorStore	Vektorové úložiště je kolekce zpracovaných souborů, kterou může nástroj použít file_search .
VectorStoreAutoChunkingStrategyRequest	Výchozí strategie. Tato strategie v současné době používá max_chunk_size_tokens 800 a chunk_overlap_tokens 400.
VectorStoreAutoChunkingStrategyResponse	Tato hodnota se vrátí, když je strategie vytváření bloků dat neznámá. Důvodem je obvykle to, že soubor byl indexován před zavedením konceptu chunking_strategy v rozhraní API.
VectorStoreChunkingStrategyRequest	Abstraktní reprezentace konfigurace strategie vytváření bloků vektorového úložiště
VectorStoreChunkingStrategyResponse	Abstraktní reprezentace konfigurace strategie vytváření bloků vektorového úložiště
VectorStoreConfiguration	Konfigurace vektorového úložiště je seznam zdrojů dat, které se používají, když je možné použít více souborů pro podnikové vyhledávání souborů.
VectorStoreConfigurations	Struktura obsahující seznam konfigurací vektorového úložiště, tj. seznam ID prostředků Azure.
VectorStoreDataSource	Struktura obsahující cestu URI prostředku Azure a typ prostředku souboru použitého jako zdroj dat pro hledání souborů organizace.
VectorStoreDeletionStatus	Objekt odpovědi pro odstranění vektorového úložiště
VectorStoreExpirationPolicy	Zásady vypršení platnosti pro úložiště vektorů.
VectorStoreFile	Popis souboru připojeného k úložišti vektorů
VectorStoreFileBatch	Dávka souborů připojených k úložišti vektorů.
VectorStoreFileBatchesCancelVectorStoreFileBatchOptionalParams	Volitelné parametry.
VectorStoreFileBatchesCreateVectorStoreFileBatchOptionalParams	Volitelné parametry.
VectorStoreFileBatchesGetVectorStoreFileBatchOptionalParams	Volitelné parametry.
VectorStoreFileBatchesListVectorStoreFileBatchFilesOptionalParams	Volitelné parametry.
VectorStoreFileBatchesOperations	Rozhraní představující operace VectorStoreFileBatches.
VectorStoreFileCount	Počet zpracovaných nebo zpracovávaných souborů tímto úložištěm vektorů seskupených podle stavu
VectorStoreFileDeletionStatus	Objekt odpovědi pro odstranění relace souboru úložiště vektorů
VectorStoreFileError	Podrobnosti o chybě, ke které mohlo dojít při zpracování souboru pro toto úložiště vektorů
VectorStoreFilesCreateVectorStoreFileOptionalParams	Volitelné parametry.
VectorStoreFilesDeleteVectorStoreFileOptionalParams	Volitelné parametry.
VectorStoreFilesGetVectorStoreFileOptionalParams	Volitelné parametry.
VectorStoreFilesListVectorStoreFilesOptionalParams	Volitelné parametry.
VectorStoreFilesOperations	Rozhraní reprezentující operace VectorStoreFiles.
VectorStoreStaticChunkingStrategyOptions	Možnosti konfigurace strategie statického vytváření bloků dat v úložišti vektorů
VectorStoreStaticChunkingStrategyRequest	Staticky nakonfigurovaná strategie vytváření bloků dat.
VectorStoreStaticChunkingStrategyResponse	Staticky nakonfigurovaná strategie vytváření bloků dat.
VectorStoresCreateVectorStoreOptionalParams	Volitelné parametry.
VectorStoresDeleteVectorStoreOptionalParams	Volitelné parametry.
VectorStoresGetVectorStoreOptionalParams	Volitelné parametry.
VectorStoresListVectorStoresOptionalParams	Volitelné parametry.
VectorStoresModifyVectorStoreOptionalParams	Volitelné parametry.
VectorStoresOperations	Rozhraní reprezentující operace VectorStores.

Aliasy typu

AgentEventStreamData	Představuje data události streamu v agentu.
AgentRunResponse	Odpověď spuštění agenta s podporou streamování
AgentStreamEvent	Alias pro událost AgentStreamEvent
AgentsNamedToolChoiceType	Dostupné typy nástrojů pro agenty s názvem tools.
AgentsResponseFormatMode	Představuje režim, ve kterém bude model zpracovávat návratový formát volání nástroje.
AgentsResponseFormatOption	Alias pro AgentsResponseFormatOption
AgentsToolChoiceOption	Alias pro AgentsToolChoiceOption
AgentsToolChoiceOptionMode	Určuje, jak bude volba nástroje použita
AzureAISearchQueryType	Dostupné typy dotazů pro nástroj Azure AI Search.
ContinuablePage	Rozhraní, které popisuje stránku výsledků.
FileContents	Platné hodnoty pro obsah binárního souboru.
FilePurpose	Možné hodnoty označující zamýšlené použití souboru.
FileState	Stav souboru.
ImageDetailLevel	Určuje úroveň detailů obrazu. Může to být 'auto', 'nízká', 'vysoká' nebo neznámá budoucí hodnota.
IncompleteDetailsReason	Důvod, proč je spuštění neúplné. To bude odkazovat na to, ke kterému určitému limitu tokenu bylo dosaženo v průběhu spuštění.
ListSortOrder	Dostupné možnosti řazení při žádosti o seznam objektů odpovědí.
MessageAttachmentToolDefinition	Alias pro MessageAttachmentToolDefinition
MessageBlockType	Určuje druh bloku obsahu ve zprávě. Může to být text, soubor obrázku, adresa URL externího obrázku nebo neznámý typ budoucnosti.
MessageContentUnion	Alias pro MessageContentUnion
MessageDeltaContentUnion	Alias pro MessageDeltaContentUnion
MessageDeltaTextAnnotationUnion	Alias pro MessageDeltaTextAnnotationUnion
MessageIncompleteDetailsReason	Sada důvodů popisujících, proč je zpráva označena jako neúplná.
MessageInputContent	Alias pro MessageInputContent
MessageInputContentBlockUnion	Alias pro MessageInputContentBlockUnion
MessageRole	Možné hodnoty rolí přiřazených zprávám ve vlákně.
MessageStatus	Možné hodnoty stavu spuštění pro zprávu vlákna.
MessageTextAnnotationUnion	Alias pro MessageTextAnnotationUnion
OpenApiAuthDetailsUnion	Alias pro OpenApiAuthDetailsUnion
OpenApiAuthType	Typ ověření pro koncový bod OpenApi. Povolené typy jsou: Anonymní (není vyžadováno ověření) Připojení (vyžaduje connection_id ke koncovému bodu, jak je nastaveno v AI Foundry) Managed_Identity (vyžaduje cílovou skupinu pro ověření na základě identity)
RequiredActionUnion	Alias pro RequiredActionUnion
RequiredToolCallUnion	Alias pro RequiredToolCallUnion
ResponseFormat	Možné formáty odpovědí API.
RunAdditionalFieldList	Seznam dalších polí, která se mají zahrnout do odpovědi.
RunStatus	Možné hodnoty pro stav spuštění vlákna agenta.
RunStepCodeInterpreterToolCallOutputUnion	Alias pro RunStepCodeInterpreterToolCallOutputUnion
RunStepDeltaCodeInterpreterOutputUnion	Alias pro RunStepDeltaCodeInterpreterOutputUnion
RunStepDeltaDetailUnion	Alias pro RunStepDeltaDetailUnion
RunStepDeltaToolCallUnion	Alias pro RunStepDeltaToolCallUnion
RunStepDetailsUnion	Alias pro RunStepDetailsUnion
RunStepErrorCode	Možné hodnoty kódu chyby, které lze připsat neúspěšnému kroku spuštění.
RunStepStatus	Možné hodnoty pro stav kroku spuštění.
RunStepToolCallUnion	Alias pro RunStepToolCallUnion
RunStepType	Možné typy kroků spuštění.
ToolDefinitionUnion	Alias pro ToolDefinitionUnion
TruncationStrategy	Možné strategie zkrácení pro vlákno.
VectorStoreChunkingStrategyRequestType	Typ strategie chunkingu
VectorStoreChunkingStrategyRequestUnion	Alias pro VectorStoreChunkingStrategyRequestUnion
VectorStoreChunkingStrategyResponseType	Typ strategie chunkingu
VectorStoreChunkingStrategyResponseUnion	Alias pro VectorStoreChunkingStrategyResponseUnion
VectorStoreExpirationPolicyAnchor	Popisuje vztah mezi dny a vypršením platnosti tohoto vektorového úložiště
VectorStoreFileBatchStatus	Stav dávky souboru vektorového úložiště.
VectorStoreFileErrorCode	Varianty kódu chyby pro zpracování souborů vektorového úložiště
VectorStoreFileStatus	Stav souboru vektorového úložiště
VectorStoreFileStatusFilter	Filtr parametrů dotazu pro koncový bod načítání souborů vektorového úložiště
VectorStoreStatus	Možný stav vektorového úložiště

Výčty

DoneEvent	Událost terminálu označující úspěšný konec datového proudu.
ErrorEvent	Událost terminálu označující chybu na straně serveru při streamování
KnownVersions	Verze rozhraní API agentů Azure AI
MessageStreamEvent	Události streamování související s operací zpráv
RunStepStreamEvent	Spuštění událostí streamování souvisejících s operací kroku
RunStreamEvent	Události streamování související s operací spuštění
ThreadStreamEvent	Události streamování související s operací vlákna
VectorStoreDataSourceAssetType	Typ prostředku vektorového úložiště. Typ datového zdroje může být uri_asset, v tomto případě by měl obsahovat ID URI datového zdroje, v případě id_asset by měl obsahovat ID dat.
connectionToolType	Typy nástrojů pro připojení používané ke konfiguraci agenta

Funkce

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

Určuje, zda je daný výstup zadaného typu.

Podrobnosti funkce

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

Určuje, zda je daný výstup zadaného typu.

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

Parametry

output

ToolDefinitionUnion | RequiredAction | RequiredToolCall

Akce, která se má zkontrolovat, která může být typu RequiredAction, RequiredToolCallnebo ToolDefinitionUnion.

type

string

Typ, pro který chcete zkontrolovat akci.

Návraty

output

Logická hodnota označující, zda je akce zadaného typu.