@azure/ai-agents package

Osztályok

AgentsClient
MCPTool	A Model Context Protocol (MCP) kiszolgálókhoz csatlakozó eszköz. Támogatja az MCP szerverkapcsolatok és az engedélyezett eszközök dinamikus kezelését.
OpenApiTool	Olyan eszköz, amely OpenAPI-specifikációk alapján kéri le az információkat. A kezdeti API-definícióval (név, leírás, specifikáció, hitelesítés) inicializálva ez az osztály további API-definíciók dinamikus hozzáadását és eltávolítását is támogatja.
ToolSet	A definíciókkal és erőforrásokkal rendelkező eszközök készletét jelöli.
ToolUtility	Segédprogram-osztály különböző eszközök létrehozásához.

Interfészek

AISearchIndexResource	AI Search Index erőforrás.
ActivityFunctionDefinition	Egy függvény tevékenységdefiníciós adatai.
ActivityFunctionParameters	A tevékenységfüggvény meghatározásához használt paraméterek.
Agent	Olyan ügynököt jelöl, amely meghívhatja a modellt, és eszközöket használhat.
AgentDeletionStatus	Ügynöktörlési művelet állapota.
AgentErrorDetail	Az ügynök API által visszaadott hibainformációkat ismerteti.
AgentEventMessage	A kiszolgáló által küldött eseményfolyam minden eseménye rendelkezik és eventdata tulajdonsága van: Example event: thread.created data: {"id": "thread_123", "object": "thread", ...} Eseményeket bocsátunk ki, amikor új objektum jön létre, áttűn egy új állapotra, vagy részekben (eltérésekben) streameljük őket. Kibocsátjuk thread.run.created például egy új futtatás létrehozásakor, thread.run.completed a futtatás befejeződésekor stb. Amikor egy ügynök úgy dönt, hogy üzenetet hoz létre egy futás során, egy , egy thread.message.in_progress eseményt, sok thread.message.delta eseményt és végül egy thread.message.completed eseményt bocsátunk thread.message.created eventki. Idővel további eseményeket is hozzáadhatunk, ezért javasoljuk, hogy az ismeretlen eseményeket a kódban gondosan kezelje.
AgentEventMessageStream	Ügynökesemény-üzenetfolyamot jelöl.
AgentThread	Az ügynökhöz társított egyetlen szálra vonatkozó információk.
AgentThreadCreationOptions	Az új ügynökszál létrehozásához használt részletek.
AgentV1Error	Az ügynök API által visszaadott hiba hasznos adat.
AgentsClientOptionalParams	Az ügyfél opcionális paraméterei.
AgentsNamedToolChoice	Megadja, hogy a modellnek mely eszközt kell használnia. Ezzel kényszeríti a modellt egy adott eszköz meghívására.
AgentsResponseFormat	A modell várható kimenetét leíró objektum. Ha json_object csak function a típus tools adható át a futtatásnak. Ha text a modell szöveget vagy bármilyen szükséges értéket tud visszaadni.
AzureAISearchToolDefinition	Egy Azure AI-keresőeszköz bemeneti definíciós információi az ügynök konfigurálásához.
AzureAISearchToolResource	Az azure_ai_search eszköz által használt indexerőforrások készlete.
AzureFunctionBinding	A tárolási üzenetsor nevének és URI-jának megőrzésére szolgáló struktúra.
AzureFunctionDefinition	Az Azure-függvény definíciója.
AzureFunctionStorageQueue	A tárolási üzenetsor nevének és URI-jának megőrzésére szolgáló struktúra.
AzureFunctionToolCallDetails	Az Azure-függvényhívás leírása. Az összes mező jelen van a befejezett futtatási lépésben, de csak néhány mező van jelen a RunStepDeltaAzureFunctionToolCallban.
AzureFunctionToolDefinition	Az ügynök konfigurálásához használt azure-függvényeszköz bemeneti definíciós információi.
BingCustomSearchConfiguration	Egyéni bing keresési konfiguráció.
BingCustomSearchToolDefinition	A Bing egyéni keresőeszközének bemeneti definíciós adatai az ügynök konfigurálásához használva.
BingCustomSearchToolParameters	A bing egyéni keresőeszköz paraméterei.
BingGroundingSearchConfiguration	Keresés a Bing földelési konfigurációjában
BingGroundingSearchToolParameters	A bing földelő keresőeszköz paraméterei.
BingGroundingToolDefinition	Az ügynök konfigurálásához használt bing földelési keresőeszköz bemeneti definíciós információi.
BrowserAutomationToolCallDetails	A böngészőautomatizálási eszköz hívásának részletei.
BrowserAutomationToolCallStep	A böngészőautomatizálási eszköz végrehajtásának egyetlen lépését ismerteti.
BrowserAutomationToolConnectionParameters	A böngészőautomatizálási eszköz által használt kapcsolat bemeneti paramétereinek meghatározása.
BrowserAutomationToolDefinition	A böngészőautomatizálási eszköz bemeneti definíciós adatai az ügynök konfigurálásához használt módon.
BrowserAutomationToolParameters	A böngészőautomatizálási eszköz bemeneti paramétereinek meghatározása.
CodeInterpreterToolDefinition	Az ügynök konfigurálásához használt kódértelmező eszköz bemeneti definíciós információi.
CodeInterpreterToolResource	A code_interpreter eszköz által használt erőforrások készlete.
ConnectedAgentDetails	Információk az egyik ügynök eszközként való összekapcsolásához
ConnectedAgentToolDefinition	A tartományspecifikus alügynököt meghatározó csatlakoztatott ügynökeszköz bemeneti definíciós információi
CreateAgentOptionalParams	Nem kötelező paraméterek.
CreateThreadAndRunOptionalParams	Nem kötelező paraméterek.
DeepResearchBingGroundingConnection	A Bing földelési erőforrás kapcsolati erőforrás-azonosítója.
DeepResearchDetails	A Deep Research eszköz részletei.
DeepResearchToolDefinition	Az ügynök konfigurálásához használt mélykutatási eszköz bemeneti definíciós információi.
DeleteAgentOptionalParams	Nem kötelező paraméterek.
FabricDataAgentToolParameters	A hálóadatügynök eszköz paraméterei.
FileDeletionStatus	Egy fájltörlési művelet állapotválasza.
FileInfo	Olyan ügynököt jelöl, amely meghívhatja a modellt, és eszközöket használhat.
FileListResponse	A fájllistaművelet válaszadatai.
FileSearchRankingOptions	A fájlkeresés rangsorolási beállításai.
FileSearchToolCallContent	A fájlkeresés eredménye tartalomobjektum.
FileSearchToolDefinition	Az ügynök konfigurálásához használt fájlkereső eszköz bemeneti definíciós információi.
FileSearchToolDefinitionDetails	A fájlkereső eszköz beállításai felülbírálhatók.
FileSearchToolResource	A file_search eszköz által használt erőforrások készlete.
FilesDeleteFileOptionalParams	Nem kötelező paraméterek.
FilesGetFileContentOptionalParams	Nem kötelező paraméterek.
FilesGetFileOptionalParams	Nem kötelező paraméterek.
FilesListFilesOptionalParams	Nem kötelező paraméterek.
FilesOperations	A Fájlok műveleteit képviselő felület.
FilesUploadFileOptionalParams	Nem kötelező paraméterek.
FunctionArgument	A függvény argumentuma és leírása.
FunctionDefinition	Egy függvény bemeneti definíciós információi.
FunctionName	A használni kívánt függvény neve, ha a function eszközt használja
FunctionToolDefinition	Az ügynök konfigurálásához használt függvényeszköz bemeneti definíciós információi.
GetAgentOptionalParams	Nem kötelező paraméterek.
IncompleteRunDetails	Részletek a futtatás sikertelenségéről. null lesz, ha a futtatás nem fejeződött be.
ListAgentsOptionalParams	Nem kötelező paraméterek.
MCPApprovalPerTool	Testreszabott MCP jóváhagyási objektum, jóváhagyást igénylő és nem igénylő eszközök listázása
MCPToolDefinition	Az MCP-kiszolgálóvégpontot meghatározó MCP-eszköz bemeneti definíciós adatai
MCPToolList	Az objektum, amely tartalmazza a jóváhagyáshoz szükséges eszközök listáját.
MCPToolResource	A mcp eszköz által használt erőforrások készlete.
MessageAttachment	Ez azt ismerteti, hogy mely eszközökhöz lett csatolva egy fájl.
MessageContent	A szálüzenet-tartalom egyetlen elemének absztrakt ábrázolása.
MessageDeletionStatus	A szálüzenet-törlési művelet állapota.
MessageDelta	A beírt "delta" hasznos adatokat jelöli egy streamelési üzenet különbözeti adattömbje között.
MessageDeltaChunk	Üzenetváltozást jelöl, azaz az üzenet módosított mezőit a streamelés során.
MessageDeltaContent	A részlegesen streamelt üzenettartalom hasznos adatainak absztrakt alapábrázolása.
MessageDeltaImageFileContent	Streamelt képfájl tartalomrészét jelöli egy streamelési üzenet változástömbjébe.
MessageDeltaImageFileContentObject	A "image_file" hasznos adattartalmat jelöli a streamelt képfájl tartalmában.
MessageDeltaTextAnnotation	A streamelt szöveges tartalomrész szöveges jegyzeteinek absztrakt alapábrázolása.
MessageDeltaTextContent	Streamelt szöveges tartalomrészt jelöl egy streamelt üzenet különbözeti adattömbjébe.
MessageDeltaTextContentObject	Egy streamelt szöveges tartalomrész adatait jeleníti meg egy streamelt üzenet különbözeti adattömbén belül.
MessageDeltaTextFileCitationAnnotation	Streamelt fájl idézetét jelöli, amely egy streamelt szöveges tartalomrészre van alkalmazva.
MessageDeltaTextFileCitationAnnotationObject	Egy streamelt fájl idézetének adatait jelöli a streamelt szöveges tartalomrészre alkalmazott módon.
MessageDeltaTextFilePathAnnotation	Streamelt fájl elérési útjának széljegyzetét jelöli, amely egy streamelt szöveges tartalomrészre van alkalmazva.
MessageDeltaTextFilePathAnnotationObject	A streamelt fájl elérési útjának széljegyzeteinek adatait jeleníti meg a streamelt szöveg tartalomrészére alkalmazott módon.
MessageDeltaTextUrlCitationAnnotation	Az üzenetben található idézet, amely az üzenethez társított URL-címre mutat. Akkor jön létre, amikor az ügynök olyan eszközöket használ, mint a "bing_grounding" az interneten való kereséshez.
MessageDeltaTextUrlCitationDetails	Az URL-idézet ábrázolása, a szöveges szál üzenet tartalmában.
MessageImageFileContent	Képfájl tartalmának ábrázolása egy szálüzenetben.
MessageImageFileDetails	Képhivatkozás a szálüzenet tartalmában látható módon.
MessageImageFileParam	Meghatározza, hogy a rendszer hogyan hivatkozik egy belsőleg feltöltött képfájlra egy képfájlblokk létrehozásakor.
MessageImageUrlParam	Meghatározza, hogy a rendszer hogyan hivatkozik egy külső kép URL-címére egy kép-URL-blokk létrehozásakor.
MessageIncompleteDetails	Információ a hiányos állapotot beírt üzenetről.
MessageInputContentBlock	Egyetlen tartalomblokkot határoz meg egy üzenet létrehozásakor. A típus mező határozza meg, hogy szövegről, képfájlról vagy külső kép URL-címről van-e szó.
MessageInputImageFileBlock	Egy képfájlblokk egy új üzenetben, amely egy belsőleg feltöltött képre hivatkozik fájlazonosító alapján.
MessageInputImageUrlBlock	Egy kép-URL blokk egy új üzenetben, amely egy külső képre hivatkozik URL-cím alapján.
MessageInputTextBlock	Egy szövegblokk egy új üzenetben, amely egyszerű szöveges tartalmat tartalmaz.
MessageTextAnnotation	A szövegesszál-üzenet tartalmának jegyzeteinek absztrakt ábrázolása.
MessageTextContent	A szálüzenet-tartalom szöveges elemének ábrázolása.
MessageTextDetails	Az ügynökszál-üzenet tartalmának egyetlen eleméhez tartozó szöveg és kapcsolódó széljegyzetek.
MessageTextFileCitationAnnotation	Az üzeneten belüli idézet, amely az ügynökhöz vagy az üzenethez társított adott fájlból származó adott idézetre mutat. Akkor jön létre, amikor az ügynök a "file_search" eszközzel keres fájlokat.
MessageTextFileCitationDetails	Egy fájlalapú szöveges idézet ábrázolása, amelyet a szöveges szál üzenettartalmak fájlalapú jegyzeteiben használnak.
MessageTextFilePathAnnotation	Egy idézet az üzenetben, amely egy adott elérési úton található fájlra mutat.
MessageTextFilePathDetails	Képfájl-azonosító beágyazása az üzenet képtartalmai által használt módon.
MessageTextUrlCitationAnnotation	Az üzenetben található idézet, amely az üzenethez társított URL-címre mutat. Akkor jön létre, amikor az ügynök olyan eszközöket használ, mint a "bing_grounding" az interneten való kereséshez.
MessageTextUrlCitationDetails	Az URL-idézet ábrázolása, a szöveges szál üzenet tartalmában.
MessagesCreateMessageOptionalParams	Nem kötelező paraméterek.
MessagesDeleteOptionalParams	Nem kötelező paraméterek.
MessagesGetMessageOptionalParams	Nem kötelező paraméterek.
MessagesListMessagesOptionalParams	Nem kötelező paraméterek.
MessagesOperations	Az Üzenetek műveleteket képviselő felület.
MessagesUpdateMessageOptionalParams	Nem kötelező paraméterek.
MicrosoftFabricToolDefinition	Az ügynök konfigurálásához használt Microsoft Fabric-eszközök bemeneti definíciós információi.
OpenApiAnonymousAuthDetails	Az OpenApi névtelen hitelesítés biztonsági adatai
OpenApiAuthDetails	az OpenApiFunctionDefinition hitelesítési adatai
OpenApiConnectionAuthDetails	Az OpenApi-kapcsolat hitelesítésének biztonsági részletei
OpenApiConnectionSecurityScheme	Az OpenApi managed_identity hitelesítés biztonsági sémája
OpenApiFunctionDefinition	Egy openapi-függvény bemeneti definíciós információi.
OpenApiManagedAuthDetails	Az OpenApi managed_identity hitelesítés biztonsági adatai
OpenApiManagedSecurityScheme	Az OpenApi managed_identity hitelesítés biztonsági sémája
OpenApiToolDefinition	Az ügynök konfigurálásához használt OpenAPI-eszközök bemeneti definíciós információi.
PageSettings	A byPage metódus beállításai
PagedAsyncIterableIterator	Egy felület, amely lehetővé teszi az aszinkron iterálást mind a befejezésig, mind az oldal szerint.
PollingOptions	A lekérdezési viselkedés konfigurálásának lehetőségei.
PollingOptionsParams	Nem kötelező paraméterek a lekérdezési viselkedés konfigurálásához.
RequiredAction	Egy ügynökszál futtatásához szükséges művelet absztrakt ábrázolása a folytatáshoz.
RequiredFunctionToolCall	Egy függvényeszközhöz kért hívás ábrázolása, amelyre a modellnek szüksége van a futtatás kiértékelésének folytatásához.
RequiredFunctionToolCallDetails	A függvényhívások részletes információi, amelyeket egy függvényeszközt meghívó kötelező művelet tartalmaz, amely tartalmazza a függvény nevét és argumentumait.
RequiredMcpToolCall	Egy MCP-eszköz kért hívásának reprezentációja, amelyre a modellnek szüksége van a futtatás kiértékelésének folytatásához.
RequiredToolCall	A modell által a futtatás folytatásához szükséges eszközhívás absztrakt ábrázolása.
ResponseFormatJsonSchema	A válaszformátum célját leíró információ, amelyet a modell arra használ, hogy meghatározza, hogyan válaszoljon az adott formátumban.
ResponseFormatJsonSchemaType	A definiált válaszformátum típusa: json_schema
RunCompletionUsage	A futtatáshoz kapcsolódó használati statisztikák. Ez az érték null lesz, ha a futtatás nincs terminálállapotban (például in_progress, queuedstb.).
RunError	Az ügynökszál-futtatás során észlelt hiba részletei.
RunStep	Részletes információk az ügynökszál-futtatás egyetlen lépéséről.
RunStepActivityDetails	A futtatási lépéstevékenységekhez kapcsolódó részletes információk.
RunStepAzureAISearchToolCall	Az Azure AI Search eszközre irányuló hívás rekordja, amelyet a modell adott ki egy meghatározott eszköz kiértékelése során, amely a végrehajtott Azure AI-keresést jelöli.
RunStepAzureFunctionToolCall	Egy Azure-függvényeszköz hívásának rekordja.
RunStepBingCustomSearchToolCall	A modell által egy meghatározott eszköz kiértékelése során kiadott Bing egyéni keresési eszköz hívásának rekordja, amely a Bing egyéni kereséssel végrehajtott keresést jelöli.
RunStepBingGroundingToolCall	A bing földelő eszköz hívásának rekordja, amelyet a modell adott ki egy meghatározott eszköz kiértékelése során, amely a bing földeléssel végzett végrehajtott keresést jelöli.
RunStepBrowserAutomationToolCall	Az ügynök által kiadott böngészőautomatizálási eszköz hívásának rögzítése.
RunStepCodeInterpreterImageOutput	Egy kódértelmező eszköz által a modell eszközhívására adott válaszként kibocsátott képkimenet ábrázolása.
RunStepCodeInterpreterImageReference	Egy kódértelmező eszköz által a modell eszközhívására adott válaszként kibocsátott képhivatkozás.
RunStepCodeInterpreterLogOutput	Egy kódértelmező eszköz által a modell eszközhívására adott válaszként kibocsátott naplókimenet ábrázolása.
RunStepCodeInterpreterToolCall	Egy kódértelmező eszköz hívásának rekordja, amelyet a modell adott ki egy meghatározott eszköz kiértékelése során, amely a kódértelmező által felhasznált és kibocsátott bemeneteket és kimeneteket jelöli.
RunStepCodeInterpreterToolCallDetails	A modell által meghívást hívó kódértelmező részletes információi.
RunStepCodeInterpreterToolCallOutput	Egy kódértelmező eszköz által kibocsátott kimenet absztrakt ábrázolása.
RunStepCompletionUsage	A futtatási lépéshez kapcsolódó használati statisztikák.
RunStepConnectedAgent	Részletes információk a csatlakoztatott ügynök eszközhívásáról.
RunStepConnectedAgentToolCall	A csatlakoztatott ügynökhöz intézett hívás rögzítése.
RunStepDeepResearchToolCall	A modell által egy meghatározott eszköz értékelése során kiadott Deep Research eszköz hívásának rögzítése, amely a végrehajtott mélykutatási műveleteket képviseli.
RunStepDeepResearchToolCallDetails	Részletes információk a modell által végzett mélykutatási feladatokról.
RunStepDelta	A streamelési futtatási lépés különbözeti adattömbjének különbözeti hasznos adatait jelöli.
RunStepDeltaAzureAISearchToolCall	Az Azure AI keresést jelöli egy streamelési futtatási lépésben.
RunStepDeltaAzureFunctionToolCall	Az Azure-függvényeszköz hívását jelöli egy streamelési futtatási lépésben.
RunStepDeltaBingGroundingToolCall	A Bing földelési eszköz hívását jelöli egy streamelési futtatási lépésben.
RunStepDeltaChunk	Egy futtatási lépés változását jelöli, azaz a futtatási lépésben a streamelés során módosított mezőket.
RunStepDeltaCodeInterpreterDetailItemObject	A Kódértelmező eszköz hívási adatait jelöli egy streamelési lépés eszközhívásaiban.
RunStepDeltaCodeInterpreterImageOutput	Egy képkimenetet jelöl a Kód értelmező eszközének megfelelően, és a streamelési futtatási lépés deltaeszköz-hívásgyűjteményében látható módon.
RunStepDeltaCodeInterpreterImageOutputObject	A streamelési futtatási lépés Kódértelmezési eszközének képkimenetét jelöli.
RunStepDeltaCodeInterpreterLogOutput	A Kódértelmezési eszköz által előállított és a streamelési futtatási lépés deltaeszköz-hívásgyűjteményében szereplő naplókimenetet jelöli.
RunStepDeltaCodeInterpreterOutput	A streamelési futtatási lépés eszköz hívásának Kódértelmezési eszköz kimenetének absztrakt alapábra-ábrázolása.
RunStepDeltaCodeInterpreterToolCall	Egy kódértelmező eszköz hívását jelöli a streamelési lépés eszközhívási adatai között.
RunStepDeltaConnectedAgentToolCall	A csatlakoztatott ügynök meghívását jelöli egy streamelési futtatási lépés részeként.
RunStepDeltaCustomBingGroundingToolCall	A Bing egyéni keresési eszközhívását jelöli egy streamelési futtatási lépésben.
RunStepDeltaDeepResearchToolCall	A mélyreható kutatást egy streamelési futtatási lépésben jelöli.
RunStepDeltaDetail	Egyetlen futtatási lépés részletes elemét jelöli egy streamelési futtatási lépés különbözeti hasznos adataiban.
RunStepDeltaFileSearchToolCall	Egy fájlkereső eszköz hívását jelöli a streamelési futtatási lépés eszközhívási adatai között.
RunStepDeltaFunction	A delta függvényeszköz-hívásának streamelési futtatási lépésében szereplő függvényadatokat jelöli.
RunStepDeltaFunctionToolCall	Egy függvényeszköz hívását jelöli a streamelési lépés eszközhívási adatai között.
RunStepDeltaMCPObject	Az mcp meghívását jelöli egy streamelési futtatási lépés részeként.
RunStepDeltaMcpToolCall	A függvényadatokat egy streamelési futtatási lépés MCP-hívásában jelöli.
RunStepDeltaMessageCreation	Üzenetlétrehozás egy streamelési lépés változásán belül.
RunStepDeltaMessageCreationObject	A streamelési futtatási lépés üzenetlétrehozási válaszobjektumában lévő adatokat jelöli.
RunStepDeltaMicrosoftFabricToolCall	A Microsoft Fabric eszközhívást jelöli egy streamelési futtatási lépésben.
RunStepDeltaOpenAPIObject	Az openapi meghívását jelenti egy streamelési futtatási lépés részeként.
RunStepDeltaOpenAPIToolCall	Az openapi eszközhívást jelöli egy streamelési futtatási lépésben.
RunStepDeltaSharepointToolCall	A SharePoint-eszköz hívását jelöli egy streamelési futtatási lépésben.
RunStepDeltaToolCall	Egyetlen eszközhívás absztrakt alapábrázolása a streamelési futtatási lépés deltaeszköz-hívásának részletein belül.
RunStepDeltaToolCallObject	Az eszközhívások meghívását jelöli egy streamelési futtatási lépés részeként.
RunStepDetails	Egy futtatási lépés részleteinek absztrakt ábrázolása.
RunStepDetailsActivity	Az adott lépéshez kapcsolódó tevékenységek listáját jelöli.
RunStepError	A sikertelen futtatási lépéshez társított hibainformációk.
RunStepFileSearchToolCall	Egy fájlkereső eszköz hívásának rekordja, amelyet a modell adott ki egy meghatározott eszköz kiértékelése során, amely a végrehajtott fájlkeresést jelöli.
RunStepFileSearchToolCallResult	A fájlkereső eszköz hívásának eredménye.
RunStepFileSearchToolCallResults	A fájlkeresés eredményei.
RunStepFunctionToolCall	Egy függvényeszközre irányuló hívás rekordja, amelyet a modell adott eszköz kiértékelése során adott ki, amely a megadott függvény által felhasznált és kibocsátott bemeneteket és kimeneteket jelöli.
RunStepFunctionToolCallDetails	A modell által hívott függvény részletes információi.
RunStepMcpToolCall	Egy MCP-eszköz hívásának rekordja, amelyet a modell egy meghatározott eszköz kiértékelése során ad ki, és amely a végrehajtott MCP-műveleteket jelöli.
RunStepMessageCreationDetails	Az üzenetlétrehozási futtatási lépéshez kapcsolódó részletes információk.
RunStepMessageCreationReference	A futtatási lépés részeként létrehozott üzenet részletei.
RunStepMicrosoftFabricToolCall	Egy Microsoft Fabric-eszköz hívásának rekordja, amelyet a modell adott ki egy meghatározott eszköz kiértékelése során, amely a végrehajtott Microsoft Fabric-műveleteket jelöli.
RunStepOpenAPIToolCall	Egy OpenAPI-eszköz hívásának rekordja, amelyet a modell egy definiált eszköz kiértékelése során ad ki, és amely a végrehajtott OpenAPI-műveleteket jelöli.
RunStepSharepointToolCall	Egy SharePoint-eszköz hívásának rekordja, amelyet a modell adott ki egy meghatározott eszköz kiértékelése során, amely a végrehajtott SharePoint-műveleteket jelöli.
RunStepToolCall	Egy meglévő futtatás futtatási lépésében rögzített részletes eszközhívás absztrakt ábrázolása.
RunStepToolCallDetails	A futtatási lépés hívó eszközeivel kapcsolatos részletes információk.
RunStepsGetRunStepOptionalParams	Nem kötelező paraméterek.
RunStepsListRunStepsOptionalParams	Nem kötelező paraméterek.
RunStepsOperations	A RunSteps műveleteket képviselő felület.
RunsCancelRunOptionalParams	Nem kötelező paraméterek.
RunsCreateRunOptionalParams	Nem kötelező paraméterek.
RunsGetRunOptionalParams	Nem kötelező paraméterek.
RunsListRunsOptionalParams	Nem kötelező paraméterek.
RunsOperations	A futtatási műveleteket képviselő felület.
RunsSubmitToolOutputsToRunOptionalParams	Nem kötelező paraméterek.
RunsUpdateRunOptionalParams	Nem kötelező paraméterek.
SharepointGroundingToolParameters	A sharepoint földelő eszköz paraméterei.
SharepointToolDefinition	Az ügynök konfigurálásához használt sharepoint-eszközök bemeneti definíciós információi.
SubmitToolApprovalAction	A szükséges eszközhívás-jóváhagyás részletei, amelyeket el kell küldeni az ügynökszál futtatásához.
SubmitToolApprovalDetails	A jóváhagyandó eszközöket leíró részletek.
SubmitToolOutputsAction	Az ügynökszál futtatásához el kell küldeni a szükséges eszközhívások részleteit a folytatáshoz.
SubmitToolOutputsDetails	Az eszközkimenetek küldéséhez meghívandó eszközöket leíró részletek.
ThreadDeletionStatus	A száltörlési művelet állapota.
ThreadMessage	Egyetlen, meglévő üzenet egy ügynökszálon belül.
ThreadMessageOptions	Egyetlen üzenet egy ügynökszálon belül, a szál kezdeti állapotának létrehozása során megadott módon.
ThreadRun	Ügynökszál egyetlen kiértékelési futását képviselő adatok.
ThreadsCreateThreadOptionalParams	Nem kötelező paraméterek.
ThreadsDeleteThreadOptionalParams	Nem kötelező paraméterek.
ThreadsGetThreadOptionalParams	Nem kötelező paraméterek.
ThreadsListThreadsOptionalParams	Nem kötelező paraméterek.
ThreadsOperations	A szálak műveleteit képviselő felület.
ThreadsUpdateThreadOptionalParams	Nem kötelező paraméterek.
ToolApproval	Az eszköz által megadott adatok elküldve feloldják a függőben lévő eszközhívásokat, és engedélyezik a modell folytatását.
ToolConnection	Kapcsolati erőforrás.
ToolDefinition	Az ügynök által használható beviteli eszközdefiníció absztrakt ábrázolása.
ToolOutput	Az eszköz által megadott adatok elküldve feloldják a függőben lévő eszközhívásokat, és engedélyezik a modell folytatását.
ToolResources	Az ügynök eszközei által használt erőforrások készlete. Az erőforrások az eszköz típusára vonatkoznak. Az eszköznek például code_interpreter a fájlazonosítók listájára van szüksége, míg az file_search eszköznek a vektortároló azonosítóinak listájára van szüksége.
TruncationObject	Azt szabályozza, hogy a futtatás előtt hogyan csonkolja a szálat. Ezzel szabályozhatja a futtatás kezdeti környezeti ablakát.
UpdateAgentOptionalParams	Nem kötelező paraméterek.
VectorStore	A vektortár az eszköz által file_search használható feldolgozott fájlok gyűjteménye.
VectorStoreAutoChunkingStrategyRequest	Az alapértelmezett stratégia. Ez a stratégia jelenleg 800 max_chunk_size_tokens és 400-chunk_overlap_tokens használ.
VectorStoreAutoChunkingStrategyResponse	Ezt akkor adja vissza a rendszer, ha az adattömb-készítési stratégia ismeretlen. Ez általában azért van, mert a fájlt indexelték, mielőtt a chunking_strategy koncepciót bevezették az API-ban.
VectorStoreChunkingStrategyRequest	Egy vektortároló adattömb-stratégiai konfigurációjának absztrakt ábrázolása.
VectorStoreChunkingStrategyResponse	Egy vektortároló adattömb-stratégiai konfigurációjának absztrakt ábrázolása.
VectorStoreConfiguration	A vektoros tárolókonfiguráció az adatforrások listája, amelyet akkor használnak, ha több fájl használható a vállalati fájlkereséshez.
VectorStoreConfigurations	A vektoros tárolókonfigurációk listáját, azaz az Azure-objektumazonosítók listáját tartalmazó struktúra.
VectorStoreDataSource	Az Azure-objektum URI-útvonalát és a vállalati fájlkeresés adatforrásaként használt fájl eszköztípusát tartalmazó struktúra.
VectorStoreDeletionStatus	Válaszobjektum vektortároló törléséhez.
VectorStoreExpirationPolicy	A vektortároló lejárati szabályzata.
VectorStoreFile	Vektortárolóhoz csatolt fájl leírása.
VectorStoreFileBatch	Egy vektortárolóhoz csatolt fájlköteg.
VectorStoreFileBatchesCancelVectorStoreFileBatchOptionalParams	Nem kötelező paraméterek.
VectorStoreFileBatchesCreateVectorStoreFileBatchOptionalParams	Nem kötelező paraméterek.
VectorStoreFileBatchesGetVectorStoreFileBatchOptionalParams	Nem kötelező paraméterek.
VectorStoreFileBatchesListVectorStoreFileBatchFilesOptionalParams	Nem kötelező paraméterek.
VectorStoreFileBatchesOperations	A VectorStoreFileBatches műveleteket képviselő felület.
VectorStoreFileCount	A vektortároló által feldolgozott vagy feldolgozott fájlok száma állapot szerint csoportosítva.
VectorStoreFileDeletionStatus	Válaszobjektum vektortároló-fájlkapcsolat törléséhez.
VectorStoreFileError	A vektortároló fájljának feldolgozása során esetlegesen előforduló hiba részletei
VectorStoreFilesCreateVectorStoreFileOptionalParams	Nem kötelező paraméterek.
VectorStoreFilesDeleteVectorStoreFileOptionalParams	Nem kötelező paraméterek.
VectorStoreFilesGetVectorStoreFileOptionalParams	Nem kötelező paraméterek.
VectorStoreFilesListVectorStoreFilesOptionalParams	Nem kötelező paraméterek.
VectorStoreFilesOperations	A VectorStoreFiles műveleteket reprezentáló felület.
VectorStoreStaticChunkingStrategyOptions	A vektortároló statikus adattömbolási stratégiájának konfigurálásának lehetőségei.
VectorStoreStaticChunkingStrategyRequest	Statikusan konfigurált adattömb-stratégia.
VectorStoreStaticChunkingStrategyResponse	Statikusan konfigurált adattömb-stratégia.
VectorStoresCreateVectorStoreOptionalParams	Nem kötelező paraméterek.
VectorStoresDeleteVectorStoreOptionalParams	Nem kötelező paraméterek.
VectorStoresGetVectorStoreOptionalParams	Nem kötelező paraméterek.
VectorStoresListVectorStoresOptionalParams	Nem kötelező paraméterek.
VectorStoresModifyVectorStoreOptionalParams	Nem kötelező paraméterek.
VectorStoresOperations	A VectorStores műveleteket képviselő felület.

Típusaliasok

AgentEventStreamData	Streames eseményadatokat jelöl az ügynökben.
AgentRunResponse	Ügynök futtatási válasza a stream támogatásával.
AgentStreamEvent	Az AgentStreamEvent alia
AgentsNamedToolChoiceType	Elérhető eszköztípusok az ügynökök által megnevezett eszközökhöz.
AgentsResponseFormatMode	Azt a módot jelöli, amelyben a modell kezeli az eszközhívás visszatérési formátumát.
AgentsResponseFormatOption	Az AgentsResponseFormatOption aliasa
AgentsToolChoiceOption	Az AgentsToolChoiceOption alia
AgentsToolChoiceOptionMode	Megadja a választott eszköz használatának módját
AzureAISearchQueryType	Az Azure AI Search eszközhöz elérhető lekérdezéstípusok.
ContinuablePage	Egy találatoldalt leíró felület.
FileContents	Bináris fájl tartalmának érvényes értékei.
FilePurpose	A fájl rendeltetésszerű használatát jelző lehetséges értékek.
FileState	A fájl állapota.
ImageDetailLevel	Megadja a kép részletességi szintjét. Lehet "automatikus", "alacsony", "magas" vagy ismeretlen jövőbeli érték.
IncompleteDetailsReason	A futtatás oka nem teljes. Ez arra mutat, hogy a futtatás során melyik jogkivonat-korlát lett elérve.
ListSortOrder	A válaszobjektumok listájának lekérésekor rendelkezésre álló rendezési lehetőségek.
MCPRequiredApproval	Az MCPRequiredApproval alia
MessageAttachmentToolDefinition	A MessageAttachmentToolDefinition aliasa
MessageBlockType	Megadja az üzeneten belüli tartalomblokk típusát. Lehet szöveg, képfájl, külső kép URL-címe vagy ismeretlen jövőbeli típus.
MessageContentUnion	A MessageContentUnion alia
MessageDeltaContentUnion	A MessageDeltaContentUnion alia
MessageDeltaTextAnnotationUnion	A MessageDeltaTextAnnotationUnion alia
MessageIncompleteDetailsReason	Okok összessége, amelyek leírják, hogy miért van egy üzenet hiányosként megjelölve.
MessageInputContent	A MessageInputContent alia
MessageInputContentBlockUnion	A MessageInputContentBlockUnion alia
MessageRole	A szál üzeneteihez rendelt szerepkörök lehetséges értékei.
MessageStatus	A szálüzenet lehetséges végrehajtási állapotértékei.
MessageTextAnnotationUnion	A MessageTextAnnotationUnion alia
OpenApiAuthDetailsUnion	Az OpenApiAuthDetailsUnion álneve
OpenApiAuthType	Az OpenApi-végpont hitelesítési típusa. Az engedélyezett típusok a következők: Névtelen (nincs szükség hitelesítésre) Kapcsolat (végponthoz connection_id szükséges, az AI Foundryben beállított módon) Managed_Identity (célközönség szükséges az identitásalapú hitelesítéshez)
RequiredActionUnion	A RequiredActionUnion alia
RequiredToolCallUnion	A RequiredToolCallUnion alia
ResponseFormat	Lehetséges API-válaszformátumok.
RunAdditionalFieldList	A válaszban szerepeltetni kívánt további mezők listája.
RunStatus	Az ügynökszál futtatásának lehetséges értékei.
RunStepCodeInterpreterToolCallOutputUnion	A RunStepCodeInterpreterToolCallOutputUnion alia
RunStepDeltaCodeInterpreterOutputUnion	A RunStepDeltaCodeInterpreterOutputUnion alia
RunStepDeltaDetailUnion	A RunStepDeltaDetailUnion alia
RunStepDeltaToolCallUnion	A RunStepDeltaToolCallUnion alia
RunStepDetailsUnion	A RunStepDetailsUnion alia
RunStepErrorCode	A sikertelen futtatási lépésnek tulajdonítható lehetséges hibakódértékek.
RunStepStatus	A futtatási lépés állapotának lehetséges értékei.
RunStepToolCallUnion	A RunStepToolCallUnion alia
RunStepType	A futtatási lépések lehetséges típusai.
ToolDefinitionUnion	A ToolDefinitionUnion alia
TruncationStrategy	A szál lehetséges csonkítási stratégiái.
VectorStoreChunkingStrategyRequestType	A darabolási stratégia típusa
VectorStoreChunkingStrategyRequestUnion	A VectorStoreChunkingStrategyRequestUnion alia
VectorStoreChunkingStrategyResponseType	A darabolási stratégia típusa
VectorStoreChunkingStrategyResponseUnion	A VectorStoreChunkingStrategyResponseUnion alia
VectorStoreExpirationPolicyAnchor	A vektortároló napjai és lejárata közötti kapcsolatot ismerteti
VectorStoreFileBatchStatus	A vektortároló fájlkötegének állapota.
VectorStoreFileErrorCode	Hibakód-változatok a vektortár fájlfeldolgozásához
VectorStoreFileStatus	Vektortároló fájl állapota
VectorStoreFileStatusFilter	Lekérdezési paraméterszűrő vektortár fájllekérési végpontjához
VectorStoreStatus	Vektortároló lehetséges állapota

Enumerációk

DoneEvent	A stream sikeres végét jelző terminálesemény.
ErrorEvent	A kiszolgálóoldali hibát jelző terminálesemény a streamelés során.
KnownVersions	Azure AI Agents API-verziók
MessageStreamEvent	Üzenetművelettel kapcsolatos streamelési események
RunStepStreamEvent	Lépésművelettel kapcsolatos streamelési események futtatása
RunStreamEvent	Művelettel kapcsolatos streamelési események futtatása
ThreadStreamEvent	Szálművelettel kapcsolatos streamelési események
VectorStoreDataSourceAssetType	A vektortároló eszköz típusa. Az eszköz típusa lehet uri_asset, ebben az esetben tartalmazza az eszköz URI azonosítóját, id_asset esetben az adatazonosítót.
connectionToolType	Ügynök konfigurálásához használt kapcsolati eszközök típusai

Függvények

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

Meghatározza, hogy a megadott kimenet a megadott típusú-e.

Függvény adatai

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

Meghatározza, hogy a megadott kimenet a megadott típusú-e.

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

Paraméterek

output

ToolDefinitionUnion | RequiredAction | RequiredToolCall

Az ellenőrizni kívánt művelet, amely lehet RequiredAction, RequiredToolCallvagy ToolDefinitionUniontípusú.

type

string

Az a típus, amely alapján ellenőrizni szeretné a műveletet.

Válaszok

output

Logikai érték, amely jelzi, hogy a művelet a megadott típusú-e.