@azure/ai-agents package

Klasser

AgentsClient
ToolSet	Representerar en uppsättning verktyg med sina definitioner och resurser.
ToolUtility	Verktygsklass för att skapa olika verktyg.

Gränssnitt

AISearchIndexResource	En resurs för AI-sökindex.
Agent	Representerar en agent som kan anropa modellen och använda verktyg.
AgentDeletionStatus	Status för en agentborttagningsåtgärd.
AgentErrorDetail	Beskriver felinformationen som returneras av agent-API:et.
AgentEventMessage	Varje händelse i en händelseström som skickas till servern har en egenskap event och data: * * Exempel Händelse: Thread.Created data: {"id": "thread_123", "object": "tråd", ...} Vi genererar händelser när ett nytt objekt skapas, övergår till ett nytt tillstånd eller håller på att strömmas i delar (delta). Vi genererar till exempel thread.run.created när en ny körning skapas, thread.run.completed när en körning har slutförts och så vidare. När en agent väljer för att skapa ett meddelande under en körning genererar vi en thread.message.created event, en thread.message.in_progress händelse, många thread.message.delta händelser och slutligen en thread.message.completed händelse. Vi kan lägga till ytterligare händelser över tid, så vi rekommenderar att du hanterar okända händelser på ett korrekt sätt i koden.
AgentEventMessageStream	Representerar en ström av agenthändelsemeddelande.
AgentThread	Information om en enda tråd som är associerad med en agent.
AgentThreadCreationOptions	Informationen som används för att skapa en ny agenttråd.
AgentV1Error	Felnyttolast som returnerades av agent-API:et.
AgentsClientOptionalParams	Valfria parametrar för klienten.
AgentsNamedToolChoice	Anger ett verktyg som modellen ska använda. Använd för att tvinga modellen att anropa ett specifikt verktyg.
AgentsResponseFormat	Ett objekt som beskriver modellens förväntade utdata. Om json_object endast function typ tools tillåts skickas till Kör. Om text modellen kan returnera text eller något värde som behövs.
AzureAISearchToolDefinition	Information om indatadefinitionen för ett Azure AI-sökverktyg som används för att konfigurera en agent.
AzureAISearchToolResource	En uppsättning indexresurser som används av verktyget azure_ai_search.
AzureFunctionBinding	Strukturen för att behålla lagringskönamnet och URI:n.
AzureFunctionDefinition	Definitionen av Azure-funktionen.
AzureFunctionStorageQueue	Strukturen för att behålla lagringskönamnet och URI:n.
AzureFunctionToolDefinition	Information om indatadefinitionen för ett azure-funktionsverktyg som används för att konfigurera en agent.
BingGroundingSearchConfiguration	Sökkonfiguration för Bing Jordning
BingGroundingSearchToolParameters	Parametrarna för sökverktyget för jordning i Bing.
BingGroundingToolDefinition	Information om indatadefinitionen för ett Bing-grundsökningsverktyg som används för att konfigurera en agent.
CodeInterpreterToolDefinition	Information om indatadefinition för ett kodtolkarverktyg som används för att konfigurera en agent.
CodeInterpreterToolResource	En uppsättning resurser som används av verktyget code_interpreter.
ConnectedAgentDetails	Information för att ansluta en agent till en annan som ett verktyg
ConnectedAgentToolDefinition	Information om indatadefinitionen för ett anslutet agentverktyg som definierar en domänspecifik underagent
CreateAgentOptionalParams	Valfria parametrar.
CreateThreadAndRunOptionalParams	Valfria parametrar.
DeleteAgentOptionalParams	Valfria parametrar.
FileDeletionStatus	Ett statussvar från en filborttagningsåtgärd.
FileInfo	Representerar en agent som kan anropa modellen och använda verktyg.
FileListResponse	Svarsdata från en fillisteåtgärd.
FileSearchRankingOptions	Rangordningsalternativ för filsökning.
FileSearchToolCallContent	Innehållsobjektet för filsökningsresultatet.
FileSearchToolDefinition	Information om indatadefinitionen för ett filsökningsverktyg som används för att konfigurera en agent.
FileSearchToolDefinitionDetails	Alternativ åsidosätter filsökningsverktyget.
FileSearchToolResource	En uppsättning resurser som används av verktyget file_search.
FilesDeleteFileOptionalParams	Valfria parametrar.
FilesGetFileContentOptionalParams	Valfria parametrar.
FilesGetFileOptionalParams	Valfria parametrar.
FilesListFilesOptionalParams	Valfria parametrar.
FilesOperations	Gränssnitt som representerar en filoperation.
FilesUploadFileOptionalParams	Valfria parametrar.
FunctionDefinition	Information om indatadefinition för en funktion.
FunctionName	Funktionsnamnet som ska användas om du använder verktyget function
FunctionToolDefinition	Information om indatadefinition för ett funktionsverktyg som används för att konfigurera en agent.
GetAgentOptionalParams	Valfria parametrar.
IncompleteRunDetails	Information om varför körningen är ofullständig. Blir null om körningen inte är ofullständig.
ListAgentsOptionalParams	Valfria parametrar.
MessageAttachment	Detta beskriver vilka verktyg en fil har kopplats till.
MessageContent	En abstrakt representation av ett enda objekt med trådmeddelandeinnehåll.
MessageDelta	Representerar den typerade "delta"-nyttolasten i ett deltasegment för strömmande meddelanden.
MessageDeltaChunk	Representerar ett meddelandedelta, d.v.s. ändrade fält i ett meddelande under strömning.
MessageDeltaContent	Den abstrakta basrepresentationen av en delvis strömmad meddelandeinnehållsnyttolast.
MessageDeltaImageFileContent	Representerar en strömmad bildfilinnehållsdel i ett strömningsmeddelandedelt segment.
MessageDeltaImageFileContentObject	Representerar nyttolasten "image_file" i strömmande bildfilinnehåll.
MessageDeltaTextAnnotation	Den abstrakta basrepresentationen av en strömmad textinnehållsdels textanteckning.
MessageDeltaTextContent	Representerar en strömmad textinnehållsdel i ett deltasegment för strömmande meddelanden.
MessageDeltaTextContentObject	Representerar data för en strömmad textinnehållsdel i ett deltasegment för strömmande meddelanden.
MessageDeltaTextFileCitationAnnotation	Representerar en strömmad filcitation som tillämpas på en strömmande textinnehållsdel.
MessageDeltaTextFileCitationAnnotationObject	Representerar data för en strömmad filcitation som tillämpas på en strömmande textinnehållsdel.
MessageDeltaTextFilePathAnnotation	Representerar en strömmad filsökvägsanteckning som tillämpas på en strömmande textinnehållsdel.
MessageDeltaTextFilePathAnnotationObject	Representerar data för en strömmad filsökvägsanteckning som tillämpas på en strömmande textinnehållsdel.
MessageDeltaTextUrlCitationAnnotation	En referens i meddelandet som pekar på en specifik URL som är kopplad till meddelandet. Genereras när agenten använder verktyg som "bing_grounding" för att söka på Internet.
MessageDeltaTextUrlCitationDetails	En representation av ett URL-citat som används i texttrådsmeddelandeinnehåll.
MessageImageFileContent	En representation av bildfilinnehåll i ett trådmeddelande.
MessageImageFileDetails	En bildreferens, som representeras i trådmeddelandeinnehåll.
MessageImageFileParam	Definierar hur en internt uppladdad bildfil refereras när ett bildfilsblock skapas.
MessageImageUrlParam	Definierar hur en extern bild-URL refereras när du skapar ett image-URL-block.
MessageIncompleteDetails	Information som ger ytterligare information om ett meddelande som anger en ofullständig status.
MessageInputContentBlock	Definierar ett enda innehållsblock när du skapar ett meddelande. Fältet "typ" avgör om det är text, en bildfil eller en extern bild-URL osv.
MessageInputImageFileBlock	Ett bildfilsblock i ett nytt meddelande som refererar till en internt uppladdad bild efter fil-ID.
MessageInputImageUrlBlock	Ett bild-URL-block i ett nytt meddelande som refererar till en extern bild med URL.
MessageInputTextBlock	Ett textblock i ett nytt meddelande som innehåller oformaterad text.
MessageTextAnnotation	En abstrakt representation av en anteckning till texttrådsmeddelandeinnehåll.
MessageTextContent	En representation av ett textobjekt med trådmeddelandeinnehåll.
MessageTextDetails	Texten och tillhörande anteckningar för ett enda objekt med agenttrådsmeddelandeinnehåll.
MessageTextFileCitationAnnotation	En källhänvisning i meddelandet som pekar på ett specifikt citattecken från en specifik fil som är associerad med agenten eller meddelandet. Genereras när agenten använder verktyget "file_search" för att söka i filer.
MessageTextFileCitationDetails	En representation av en filbaserad textcitation, som används i en filbaserad anteckning av texttrådsmeddelandeinnehåll.
MessageTextFilePathAnnotation	En källhänvisning i meddelandet som pekar på en fil som finns på en specifik sökväg.
MessageTextFilePathDetails	En inkapsling av ett bildfils-ID som används av meddelandebildinnehåll.
MessageTextUrlCitationAnnotation	En referens i meddelandet som pekar på en specifik URL som är kopplad till meddelandet. Genereras när agenten använder verktyg som "bing_grounding" för att söka på Internet.
MessageTextUrlCitationDetails	En representation av ett URL-citat som används i texttrådsmeddelandeinnehåll.
MessagesCreateMessageOptionalParams	Valfria parametrar.
MessagesGetMessageOptionalParams	Valfria parametrar.
MessagesListMessagesOptionalParams	Valfria parametrar.
MessagesOperations	Gränssnitt som representerar en meddelandeåtgärd.
MessagesUpdateMessageOptionalParams	Valfria parametrar.
OpenApiAnonymousAuthDetails	Säkerhetsinformation för anonym OpenApi-autentisering
OpenApiAuthDetails	autentiseringsinformation för OpenApiFunctionDefinition
OpenApiConnectionAuthDetails	Säkerhetsinformation för OpenApi-anslutningsautentisering
OpenApiConnectionSecurityScheme	Säkerhetsschema för OpenApi managed_identity-autentisering
OpenApiFunctionDefinition	Information om indatadefinition för en openapi-funktion.
OpenApiManagedAuthDetails	Säkerhetsinformation för OpenApi managed_identity-autentisering
OpenApiManagedSecurityScheme	Säkerhetsschema för OpenApi managed_identity-autentisering
OpenApiToolDefinition	Information om indatadefinition för ett OpenAPI-verktyg som används för att konfigurera en agent.
PageSettings	Alternativ för byPage-metoden
PagedAsyncIterableIterator	Ett gränssnitt som tillåter asynkron iteration både för slutförande och efter sida.
PollingOptions	Alternativ för att konfigurera avsökningsbeteende.
PollingOptionsParams	Valfria parametrar som konfigurerar avsökningsbeteende.
RequiredAction	En abstrakt representation av en obligatorisk åtgärd för att en agenttrådskörning ska fortsätta.
RequiredFunctionToolCall	En representation av ett begärt anrop till ett funktionsverktyg som krävs av modellen för att fortsätta utvärderingen av en körning.
RequiredFunctionToolCallDetails	Detaljerad information för ett funktionsanrop, som tillhandahålls av en obligatorisk åtgärd som anropar ett funktionsverktyg, som innehåller namnet på och argumenten för funktionen.
RequiredToolCall	En abstrakt representation av ett verktygsanrop som krävs av modellen för att fortsätta en körning.
ResponseFormatJsonSchema	En beskrivning av vad svarsformatet är till för, som används av modellen för att avgöra hur du ska svara i formatet.
ResponseFormatJsonSchemaType	Typ av svarsformat som definieras: json_schema
RunCompletionUsage	Användningsstatistik som är relaterad till körningen. Det här värdet blir null om körningen inte är i ett terminaltillstånd (dvs. in_progress, queuedosv.).
RunError	Information om ett fel som påträffas av en agenttrådskörning.
RunStep	Detaljerad information om ett enda steg i en agenttrådskörning.
RunStepAzureAISearchToolCall	En post för ett anrop till ett Azure AI Search-verktyg, utfärdat av modellen i utvärderingen av ett definierat verktyg, som representerar utförd Azure AI-sökning.
RunStepBingGroundingToolCall	En post för ett anrop till ett bing grounding-verktyg, utfärdat av modellen i utvärderingen av ett definierat verktyg, som representerar utförd sökning med bing grounding.
RunStepCodeInterpreterImageOutput	En representation av en bildutdata som genereras av ett kodtolkverktyg som svar på ett verktygsanrop av modellen.
RunStepCodeInterpreterImageReference	En bildreferens som genereras av ett kodtolkarverktyg som svar på ett verktygsanrop av modellen.
RunStepCodeInterpreterLogOutput	En representation av ett loggutdata som genereras av ett kodtolkverktyg som svar på ett verktygsanrop från modellen.
RunStepCodeInterpreterToolCall	En post för ett anrop till ett kodtolkningsverktyg, utfärdat av modellen i utvärderingen av ett definierat verktyg, som representerar indata och utdata som används och genereras av kodtolkaren.
RunStepCodeInterpreterToolCallDetails	Den detaljerade informationen om en kodtolk som anropas av modellen.
RunStepCodeInterpreterToolCallOutput	En abstrakt representation av utdata från ett kodtolkverktyg.
RunStepCompletionUsage	Användningsstatistik som är relaterad till körningssteget.
RunStepDelta	Representerar deltanyttolasten i ett strömningskörningsstegdelsegment.
RunStepDeltaChunk	Representerar ett körningsstegsdelta, d.v.s. ändrade fält i ett körningssteg under strömning.
RunStepDeltaCodeInterpreterDetailItemObject	Representerar kodtolkarverktygets anropsdata i ett strömningskörningsstegs verktygsanrop.
RunStepDeltaCodeInterpreterImageOutput	Representerar ett bildutdata enligt kodtolkverktyget och som representeras i ett strömningskörningsstegs deltaverktyg anropar samlingen.
RunStepDeltaCodeInterpreterImageOutputObject	Representerar data för ett strömningskörningsstegs kodtolkverktyg som anropar bildutdata.
RunStepDeltaCodeInterpreterLogOutput	Representerar en loggutdata som skapats av kodtolkverktyget och som representeras i ett strömningskörningsstegs deltaverktyg anropar samlingen.
RunStepDeltaCodeInterpreterOutput	Den abstrakta basrepresentationen av ett stegverktyg för strömningskörning anropar kodtolkverktygets utdata.
RunStepDeltaCodeInterpreterToolCall	Representerar ett kodtolkarverktygsanrop i ett strömningskörningsstegs verktygsanropsinformation.
RunStepDeltaDetail	Representerar ett detaljobjekt för ett enda körningssteg i ett direktuppspelningsstegs deltanyttolast.
RunStepDeltaFileSearchToolCall	Representerar ett filsökningsverktygsanrop i ett strömningskörningsstegs verktygsanropsinformation.
RunStepDeltaFunction	Representerar funktionsdata i ett strömningskörningssteg deltas funktionsverktygsanrop.
RunStepDeltaFunctionToolCall	Representerar ett funktionsverktygsanrop i ett strömningskörningsstegs verktygsanropsinformation.
RunStepDeltaMessageCreation	Representerar ett meddelande som skapas i ett strömningskörningsstegsdelta.
RunStepDeltaMessageCreationObject	Representerar data i ett svarsobjekt för skapande av strömningskörningssteg.
RunStepDeltaToolCall	Den abstrakta basrepresentationen av ett enda verktygsanrop i ett strömningskörningsstegs deltaverktygsanropsinformation.
RunStepDeltaToolCallObject	Representerar en anrop av verktygsanrop som en del av ett strömningskörningssteg.
RunStepDetails	En abstrakt representation av informationen för ett körningssteg.
RunStepError	Felinformationen som är associerad med ett misslyckat körningssteg.
RunStepFileSearchToolCall	En post för ett anrop till ett filsökningsverktyg, utfärdat av modellen i utvärderingen av ett definierat verktyg, som representerar utförd filsökning.
RunStepFileSearchToolCallResult	Anropsresultat för filsökningsverktyget.
RunStepFileSearchToolCallResults	Resultatet av filsökningen.
RunStepFunctionToolCall	En post för ett anrop till ett funktionsverktyg, utfärdat av modellen i utvärderingen av ett definierat verktyg, som representerar de indata och utdata som förbrukas och genereras av den angivna funktionen.
RunStepFunctionToolCallDetails	Detaljerad information om funktionen som anropas av modellen.
RunStepMessageCreationDetails	Detaljerad information som är associerad med ett körningssteg för meddelandeskapande.
RunStepMessageCreationReference	Information om ett meddelande som skapats som en del av ett körningssteg.
RunStepOpenAPIToolCall	En post för ett anrop till ett OpenAPI-verktyg, utfärdat av modellen i utvärderingen av ett definierat verktyg, som representerar utförda OpenAPI-åtgärder.
RunStepToolCall	En abstrakt representation av ett detaljerat verktygsanrop som registrerats i ett körningssteg för en befintlig körning.
RunStepToolCallDetails	Detaljerad information som är associerad med ett körningssteg som anropar verktyg.
RunStepsGetRunStepOptionalParams	Valfria parametrar.
RunStepsListRunStepsOptionalParams	Valfria parametrar.
RunStepsOperations	Gränssnitt som representerar en RunSteps-operation.
RunsCancelRunOptionalParams	Valfria parametrar.
RunsCreateRunOptionalParams	Valfria parametrar.
RunsGetRunOptionalParams	Valfria parametrar.
RunsListRunsOptionalParams	Valfria parametrar.
RunsOperations	Gränssnitt som representerar en Runs-åtgärd.
RunsSubmitToolOutputsToRunOptionalParams	Valfria parametrar.
RunsUpdateRunOptionalParams	Valfria parametrar.
SubmitToolOutputsAction	Information om nödvändiga verktygsanrop som måste skickas för att en agenttrådskörning ska kunna fortsätta.
SubmitToolOutputsDetails	Informationen som beskriver verktyg som ska anropas för att skicka verktygsutdata.
ThreadDeletionStatus	Status för en trådborttagningsåtgärd.
ThreadMessage	Ett enda befintligt meddelande i en agenttråd.
ThreadMessageOptions	Ett enda meddelande i en agenttråd, enligt vad som angavs när tråden skapades för dess ursprungliga tillstånd.
ThreadRun	Data som representerar en enda utvärderingskörning av en agenttråd.
ThreadsCreateThreadOptionalParams	Valfria parametrar.
ThreadsDeleteThreadOptionalParams	Valfria parametrar.
ThreadsGetThreadOptionalParams	Valfria parametrar.
ThreadsListThreadsOptionalParams	Valfria parametrar.
ThreadsOperations	Gränssnitt som representerar en Threads-åtgärd.
ThreadsUpdateThreadOptionalParams	Valfria parametrar.
ToolDefinition	En abstrakt representation av en definition av indataverktyg som en agent kan använda.
ToolOutput	Data som tillhandahålls under ett verktyg matar in för att lösa väntande verktygsanrop och låta modellen fortsätta.
ToolResources	En uppsättning resurser som används av agentens verktyg. Resurserna är specifika för typen av verktyg. Verktyget kräver till exempel code_interpreter en lista över fil-ID:t, medan file_search verktyget kräver en lista över vektorarkiv-ID:t.
TruncationObject	Kontroller för hur en tråd trunkeras före körningen. Använd det här alternativet om du vill styra körningens inledande kontextfönster.
UpdateAgentOptionalParams	Valfria parametrar.
VectorStore	Ett vektorlager är en samling bearbetade filer som kan användas av file_search verktyget.
VectorStoreAutoChunkingStrategyRequest	Standardstrategin. Den här strategin använder för närvarande en max_chunk_size_tokens på 800 och chunk_overlap_tokens på 400.
VectorStoreAutoChunkingStrategyResponse	Detta returneras när segmenteringsstrategin är okänd. Det beror vanligtvis på att filen indexerades innan konceptet chunking_strategy introducerades i API:et.
VectorStoreChunkingStrategyRequest	En abstrakt representation av en strategikonfiguration för segmentering av vektorlager.
VectorStoreChunkingStrategyResponse	En abstrakt representation av en strategikonfiguration för segmentering av vektorlager.
VectorStoreConfiguration	Vektorlagringskonfiguration är en lista över datakällor som används när flera filer kan användas för företagsfilsökningen.
VectorStoreConfigurations	Strukturen, som innehåller listan över konfigurationer av vektorlagring, t.ex. listan över azure-tillgångs-ID:n.
VectorStoreDataSource	Strukturen, som innehåller URI-sökvägen för Azure-tillgångar och tillgångstypen för filen som används som datakälla för företagsfilsökningen.
VectorStoreDeletionStatus	Svarsobjekt för att ta bort ett vektorlager.
VectorStoreExpirationPolicy	Förfalloprincipen för ett vektorlager.
VectorStoreFile	Beskrivning av en fil som är kopplad till ett vektorarkiv.
VectorStoreFileBatch	En batch med filer som är kopplade till ett vektorlager.
VectorStoreFileBatchesCancelVectorStoreFileBatchOptionalParams	Valfria parametrar.
VectorStoreFileBatchesCreateVectorStoreFileBatchOptionalParams	Valfria parametrar.
VectorStoreFileBatchesGetVectorStoreFileBatchOptionalParams	Valfria parametrar.
VectorStoreFileBatchesListVectorStoreFileBatchFilesOptionalParams	Valfria parametrar.
VectorStoreFileBatchesOperations	Gränssnitt som representerar en VectorStoreFileBatches-åtgärd.
VectorStoreFileCount	Antal filer som bearbetas eller bearbetas av det här vektorarkivet grupperat efter status.
VectorStoreFileDeletionStatus	Svarsobjekt för att ta bort en vektorlagringsfilrelation.
VectorStoreFileError	Information om felet som kan ha uppstått vid bearbetning av en fil för det här vektorarkivet
VectorStoreFilesCreateVectorStoreFileOptionalParams	Valfria parametrar.
VectorStoreFilesDeleteVectorStoreFileOptionalParams	Valfria parametrar.
VectorStoreFilesGetVectorStoreFileOptionalParams	Valfria parametrar.
VectorStoreFilesListVectorStoreFilesOptionalParams	Valfria parametrar.
VectorStoreFilesOperations	Gränssnitt som representerar en VectorStoreFiles-åtgärd.
VectorStoreStaticChunkingStrategyOptions	Alternativ för att konfigurera en strategi för statisk segmentering av vektorlager.
VectorStoreStaticChunkingStrategyRequest	En statiskt konfigurerad segmenteringsstrategi.
VectorStoreStaticChunkingStrategyResponse	En statiskt konfigurerad segmenteringsstrategi.
VectorStoresCreateVectorStoreOptionalParams	Valfria parametrar.
VectorStoresDeleteVectorStoreOptionalParams	Valfria parametrar.
VectorStoresGetVectorStoreOptionalParams	Valfria parametrar.
VectorStoresListVectorStoresOptionalParams	Valfria parametrar.
VectorStoresModifyVectorStoreOptionalParams	Valfria parametrar.
VectorStoresOperations	Gränssnitt som representerar en VectorStores-operation.

Typalias

AgentEventStreamData	Representerar en dataströmhändelse i agenten.
AgentRunResponse	Agenten kör svar med stöd för att strömma.
AgentStreamEvent	Alias för AgentStreamEvent
AgentsNamedToolChoiceType	Tillgängliga verktygstyper för agenter med namnet verktyg.
AgentsResponseFormatMode	Representerar det läge i vilket modellen ska hantera returformatet för ett verktygsanrop.
AgentsResponseFormatOption	Alias för AgentsResponseFormatOption
AgentsToolChoiceOption	Alias för AgentsToolChoiceOption
AgentsToolChoiceOptionMode	Anger hur verktygsvalet ska användas
AzureAISearchQueryType	Tillgängliga frågetyper för Azure AI Search-verktyget.
ContinuablePage	Ett gränssnitt som beskriver en resultatsida.
FileContents	Giltiga värden för innehållet i en binär fil.
FilePurpose	Möjliga värden som anger den avsedda användningen av en fil.
FileState	Filens tillstånd.
ImageDetailLevel	Anger detaljnivån för en bild. Kan vara "auto", "låg", "hög" eller ett okänt framtida värde.
IncompleteDetailsReason	Anledningen till att körningen är ofullständig. Detta pekar på vilken specifik tokengräns som uppnåddes under körningen.
ListSortOrder	De tillgängliga sorteringsalternativen när du begär en lista över svarsobjekt.
MessageAttachmentToolDefinition	Alias för MessageAttachmentToolDefinition
MessageBlockType	Anger vilken typ av innehållsblock som finns i ett meddelande. Det kan vara text, en bildfil, en extern bild-URL eller en okänd framtida typ.
MessageContentUnion	Alias för MessageContentUnion
MessageDeltaContentUnion	Alias för MessageDeltaContentUnion
MessageDeltaTextAnnotationUnion	Alias för MessageDeltaTextAnnotationUnion
MessageIncompleteDetailsReason	En uppsättning orsaker som beskriver varför ett meddelande markeras som ofullständigt.
MessageInputContent	Alias för MessageInputContent
MessageInputContentBlockUnion	Alias för MessageInputContentBlockUnion
MessageRole	Möjliga värden för roller som tillskrivs meddelanden i en tråd.
MessageStatus	Möjliga körningsstatusvärden för ett trådmeddelande.
MessageTextAnnotationUnion	Alias för MessageTextAnnotationUnion
OpenApiAuthDetailsUnion	Alias för OpenApiAuthDetailsUnion
OpenApiAuthType	Autentiseringstyp för OpenApi-slutpunkt. Tillåtna typer är: Anonym (ingen autentisering krävs) Anslutning (kräver connection_id till slutpunkten, som konfiguration i AI Foundry) Managed_Identity (kräver målgrupp för identitetsbaserad autentisering)
RequiredActionUnion	Alias för RequiredActionUnion
RequiredToolCallUnion	Alias för RequiredToolCallUnion
ResponseFormat	Möjliga API-svarsformat.
RunAdditionalFieldList	En lista över ytterligare fält som ska inkluderas i svaret.
RunStatus	Möjliga värden för statusen för en agenttrådskörning.
RunStepCodeInterpreterToolCallOutputUnion	Alias för RunStepCodeInterpreterToolCallOutputUnion
RunStepDeltaCodeInterpreterOutputUnion	Alias för RunStepDeltaCodeInterpreterOutputUnion
RunStepDeltaDetailUnion	Alias för RunStepDeltaDetailUnion
RunStepDeltaToolCallUnion	Alias för RunStepDeltaToolCallUnion
RunStepDetailsUnion	Alias för RunStepDetailsUnion
RunStepErrorCode	Möjliga felkodsvärden som kan hänföras till ett misslyckat körningssteg.
RunStepStatus	Möjliga värden för status för ett körningssteg.
RunStepToolCallUnion	Alias för RunStepToolCallUnion
RunStepType	Möjliga typer av körningssteg.
ToolDefinitionUnion	Alias för ToolDefinitionUnion
TruncationStrategy	Möjliga trunkeringsstrategier för tråden.
VectorStoreChunkingStrategyRequestType	Typ av segmenteringsstrategi
VectorStoreChunkingStrategyRequestUnion	Alias för VectorStoreChunkingStrategyRequestUnion
VectorStoreChunkingStrategyResponseType	Typ av segmenteringsstrategi
VectorStoreChunkingStrategyResponseUnion	Alias för VectorStoreChunkingStrategyResponseUnion
VectorStoreExpirationPolicyAnchor	Beskriver förhållandet mellan dagarna och förfallodatumet för det här vektorarkivet
VectorStoreFileBatchStatus	Status för batchen för vektorlagringsfilen.
VectorStoreFileErrorCode	Felkodsvarianter för bearbetning av vektorlagringsfiler
VectorStoreFileStatus	Status för vektorlagringsfil
VectorStoreFileStatusFilter	Frågeparameterfilter för slutpunkt för hämtning av vektorlagringsfiler
VectorStoreStatus	Möjlig status för vektorlagring

Uppräkningar

DoneEvent	Terminalhändelse som anger att en dataström har slutförts.
ErrorEvent	Terminalhändelse som anger ett fel på serversidan vid direktuppspelning.
KnownVersions	API-versioner för Azure AI Agents
MessageStreamEvent	Meddelandeåtgärdsrelaterade direktuppspelningshändelser
RunStepStreamEvent	Köra åtgärdsrelaterade direktuppspelningshändelser
RunStreamEvent	Köra åtgärdsrelaterade direktuppspelningshändelser
ThreadStreamEvent	Trådåtgärdsrelaterade direktuppspelningshändelser
VectorStoreDataSourceAssetType	Typ av vektorlagringstillgång. Tillgångstypen kan vara en uri_asset, i det här fallet ska den innehålla tillgångens URI-ID, i id_asset fall ska den innehålla data-ID:t.
connectionToolType	Typer av anslutningsverktyg som används för att konfigurera en agent

Funktioner

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

Avgör om de angivna utdata är av den angivna typen.

Funktionsinformation

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

Avgör om de angivna utdata är av den angivna typen.

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

Parametrar

output

ToolDefinitionUnion | RequiredAction | RequiredToolCall

Åtgärden att kontrollera, som kan vara av typen RequiredAction, RequiredToolCalleller ToolDefinitionUnion.

type

string

Den typ som åtgärden ska kontrolleras mot.

Returer

output

Ett booleskt värde som anger om åtgärden är av den angivna typen.