@azure/ai-agents package

Klassen

AgentsClient
ToolSet	Vertegenwoordigt een set hulpprogramma's met hun definities en resources.
ToolUtility	Hulpprogrammaklasse voor het maken van verschillende hulpprogramma's.

Interfaces

AISearchIndexResource	Een AI-zoekindexbron.
Agent	Vertegenwoordigt een agent die het model kan aanroepen en hulpprogramma's kan gebruiken.
AgentDeletionStatus	De status van een agentverwijderingsbewerking.
AgentErrorDetail	Beschrijft de foutinformatie die wordt geretourneerd door de agents-API.
AgentEventMessage	Elke gebeurtenis in een gebeurtenisstroom die door de server wordt verzonden, heeft een eigenschap event en data: * * Voorbeeld gebeurtenis: thread.created gegevens: {"id": "thread_123", "object": "thread", ...} We verzenden gebeurtenissen wanneer een nieuw object wordt gemaakt, overgangen naar een nieuwe status of worden uitgevoerd gestreamd in delen (delta's). We verzenden bijvoorbeeld thread.run.created wanneer er een nieuwe uitvoering wordt uitgevoerd wordt gemaakt, thread.run.completed wanneer een uitvoering is voltooid, enzovoort. Wanneer een agent kiest om een bericht te maken tijdens een uitvoering, verzenden we een thread.message.created event, a thread.message.in_progress gebeurtenis, veel thread.message.delta gebeurtenissen en ten slotte een thread.message.completed gebeurtenis. We kunnen na verloop van tijd extra gebeurtenissen toevoegen, dus we raden u aan om onbekende gebeurtenissen probleemloos te verwerken in uw code.
AgentEventMessageStream	Vertegenwoordigt een stroom van agent-gebeurtenisbericht.
AgentThread	Informatie over één thread die is gekoppeld aan een agent.
AgentThreadCreationOptions	De details die worden gebruikt om een nieuwe agentthread te maken.
AgentV1Error	Fout-payload geretourneerd door de agents-API.
AgentsClientOptionalParams	Optionele parameters voor de client.
AgentsNamedToolChoice	Hiermee geeft u een hulpprogramma op dat het model moet gebruiken. Gebruik dit om het model te dwingen een specifiek hulpprogramma aan te roepen.
AgentsResponseFormat	Een object met een beschrijving van de verwachte uitvoer van het model. Als json_object alleen function het type tools mag worden doorgegeven aan de uitvoering. Als text het model tekst of een willekeurige waarde kan retourneren die nodig is.
AzureAISearchToolDefinition	De informatie over de invoerdefinitie voor een Azure AI-zoekprogramma dat wordt gebruikt voor het configureren van een agent.
AzureAISearchToolResource	Een set indexbronnen die worden gebruikt door het hulpprogramma azure_ai_search.
AzureFunctionBinding	De structuur voor het behouden van de naam en URI van de opslagwachtrij.
AzureFunctionDefinition	De definitie van de Azure-functie.
AzureFunctionStorageQueue	De structuur voor het behouden van de naam en URI van de opslagwachtrij.
AzureFunctionToolDefinition	De informatie over de invoerdefinitie voor een azure-functieprogramma zoals wordt gebruikt voor het configureren van een agent.
BingGroundingSearchConfiguration	Zoekconfiguratie voor Bing Grounding
BingGroundingSearchToolParameters	De parameters van de bing grounding zoektool.
BingGroundingToolDefinition	De informatie over de invoerdefinitie voor een bing grounding search-hulpprogramma zoals wordt gebruikt voor het configureren van een agent.
CodeInterpreterToolDefinition	De informatie over de invoerdefinitie voor een code-interpreter die wordt gebruikt om een agent te configureren.
CodeInterpreterToolResource	Een set resources die worden gebruikt door het hulpprogramma code_interpreter.
ConnectedAgentDetails	Informatie voor het verbinden van de ene agent met de andere als hulpmiddel
ConnectedAgentToolDefinition	De invoerdefinitie-informatie voor een connected agent-tool die een domeinspecifieke subagent definieert
CreateAgentOptionalParams	Optionele parameters.
CreateThreadAndRunOptionalParams	Optionele parameters.
DeleteAgentOptionalParams	Optionele parameters.
FileDeletionStatus	Een statusreactie van een bestandsverwijderingsbewerking.
FileInfo	Vertegenwoordigt een agent die het model kan aanroepen en hulpprogramma's kan gebruiken.
FileListResponse	De antwoordgegevens van een bestandslijstbewerking.
FileSearchRankingOptions	Classificatieopties voor het zoeken naar bestanden.
FileSearchToolCallContent	Het inhoudsobject voor het zoekresultaat van het bestand.
FileSearchToolDefinition	De informatie over de invoerdefinitie voor een hulpprogramma voor het zoeken van bestanden zoals wordt gebruikt voor het configureren van een agent.
FileSearchToolDefinitionDetails	Opties worden overschreven voor het hulpprogramma voor het zoeken naar bestanden.
FileSearchToolResource	Een set resources die worden gebruikt door het hulpprogramma file_search.
FilesDeleteFileOptionalParams	Optionele parameters.
FilesGetFileContentOptionalParams	Optionele parameters.
FilesGetFileOptionalParams	Optionele parameters.
FilesListFilesOptionalParams	Optionele parameters.
FilesOperations	Interface die een bestandsbewerkingen vertegenwoordigt.
FilesUploadFileOptionalParams	Optionele parameters.
FunctionDefinition	De informatie over de invoerdefinitie voor een functie.
FunctionName	De functienaam die wordt gebruikt als u het hulpprogramma function gebruikt
FunctionToolDefinition	De informatie over de invoerdefinitie voor een functiehulpprogramma zoals wordt gebruikt voor het configureren van een agent.
GetAgentOptionalParams	Optionele parameters.
IncompleteRunDetails	Details over waarom de uitvoering onvolledig is. Wordt null als de uitvoering niet onvolledig is.
ListAgentsOptionalParams	Optionele parameters.
MessageAttachment	Hier wordt beschreven aan welke hulpprogramma's een bestand is gekoppeld.
MessageContent	Een abstracte weergave van één item van threadberichtinhoud.
MessageDelta	Vertegenwoordigt de getypte 'delta'-nettolading in een deltasegment van een streamingbericht.
MessageDeltaChunk	Vertegenwoordigt een berichtdelta, bijvoorbeeld gewijzigde velden in een bericht tijdens het streamen.
MessageDeltaContent	De abstracte basisweergave van een gedeeltelijk gestreamde nettolading van berichtinhoud.
MessageDeltaImageFileContent	Vertegenwoordigt een deel van de inhoud van een gestreamd afbeeldingsbestand in een deltasegment van een streamingbericht.
MessageDeltaImageFileContentObject	Vertegenwoordigt de nettolading 'image_file' binnen inhoud van het streaming-afbeeldingsbestand.
MessageDeltaTextAnnotation	De abstracte basisweergave van de tekstaantekening van een gestreamd tekstinhoudsonderdeel.
MessageDeltaTextContent	Vertegenwoordigt een gestreamd tekstinhoudsonderdeel in een deltasegment van een streamingbericht.
MessageDeltaTextContentObject	Vertegenwoordigt de gegevens van een gestreamd tekstinhoudsonderdeel in een deltasegment van een streamingbericht.
MessageDeltaTextFileCitationAnnotation	Vertegenwoordigt een gestreamde bestandsvermelding die is toegepast op een inhoudsonderdeel voor streamingtekst.
MessageDeltaTextFileCitationAnnotationObject	Vertegenwoordigt de gegevens van een gestreamde bestandsvermelding zoals toegepast op een inhoudsonderdeel voor streamingtekst.
MessageDeltaTextFilePathAnnotation	Vertegenwoordigt een gestreamde bestandspadaantekening die is toegepast op een inhoudsonderdeel voor streamingtekst.
MessageDeltaTextFilePathAnnotationObject	Vertegenwoordigt de gegevens van een gestreamde bestandspadaantekening zoals toegepast op een inhoudsonderdeel voor streamingtekst.
MessageDeltaTextUrlCitationAnnotation	Een citaat in het bericht dat verwijst naar een specifieke URL die aan het bericht is gekoppeld. Gegenereerd wanneer de agent tools zoals 'bing_grounding' gebruikt om op internet te zoeken.
MessageDeltaTextUrlCitationDetails	Een weergave van een URL-citaat, zoals gebruikt in de inhoud van tekstthreads.
MessageImageFileContent	Een weergave van inhoud van afbeeldingsbestanden in een threadbericht.
MessageImageFileDetails	Een afbeeldingsreferentie, zoals aangegeven in threadberichtinhoud.
MessageImageFileParam	Definieert hoe naar een intern geüpload afbeeldingsbestand wordt verwezen bij het maken van een afbeeldingsbestandblok.
MessageImageUrlParam	Definieert hoe naar een externe afbeeldings-URL wordt verwezen bij het maken van een afbeeldings-URL-blok.
MessageIncompleteDetails	Informatie over aanvullende informatie over een bericht dat een onvolledige status invoert.
MessageInputContentBlock	Definieert één inhoudsblok bij het maken van een bericht. Het veld 'type' bepaalt of het tekst, een afbeeldingsbestand of een externe afbeeldings-URL is, enzovoort.
MessageInputImageFileBlock	Een afbeeldingsbestandsblok in een nieuw bericht, dat verwijst naar een intern geüploade afbeelding op basis van bestands-ID.
MessageInputImageUrlBlock	Een afbeelding-URL-blok in een nieuw bericht, dat per URL naar een externe afbeelding verwijst.
MessageInputTextBlock	Een tekstblok in een nieuw bericht, dat inhoud zonder opmaak bevat.
MessageTextAnnotation	Een abstracte weergave van een aantekening voor de inhoud van het tekstthreadbericht.
MessageTextContent	Een weergave van een tekstueel item van threadberichtinhoud.
MessageTextDetails	De tekst en de bijbehorende aantekeningen voor één item van de inhoud van agentthreadberichten.
MessageTextFileCitationAnnotation	Een bronvermelding in het bericht die verwijst naar een specifiek citaat uit een specifiek bestand dat is gekoppeld aan de agent of het bericht. Gegenereerd wanneer de agent het hulpprogramma 'file_search' gebruikt om bestanden te doorzoeken.
MessageTextFileCitationDetails	Een weergave van een tekstvermelding op basis van bestanden, zoals wordt gebruikt in een op bestanden gebaseerde aantekening van inhoud van tekstthreadberichten.
MessageTextFilePathAnnotation	Een bronvermelding in het bericht dat verwijst naar een bestand dat zich op een specifiek pad bevindt.
MessageTextFilePathDetails	Een inkapseling van een afbeeldingsbestands-id, zoals wordt gebruikt door inhoud van berichtafbeelding.
MessageTextUrlCitationAnnotation	Een citaat in het bericht dat verwijst naar een specifieke URL die aan het bericht is gekoppeld. Gegenereerd wanneer de agent tools zoals 'bing_grounding' gebruikt om op internet te zoeken.
MessageTextUrlCitationDetails	Een weergave van een URL-citaat, zoals gebruikt in de inhoud van tekstthreads.
MessagesCreateMessageOptionalParams	Optionele parameters.
MessagesGetMessageOptionalParams	Optionele parameters.
MessagesListMessagesOptionalParams	Optionele parameters.
MessagesOperations	Interface die een Berichten-bewerking voorstelt.
MessagesUpdateMessageOptionalParams	Optionele parameters.
OpenApiAnonymousAuthDetails	Beveiligingsdetails voor anonieme OpenApi-verificatie
OpenApiAuthDetails	verificatiedetails voor OpenApiFunctionDefinition
OpenApiConnectionAuthDetails	Beveiligingsdetails voor OpenApi-verbindingsverificatie
OpenApiConnectionSecurityScheme	Beveiligingsschema voor OpenApi managed_identity-verificatie
OpenApiFunctionDefinition	De informatie over de invoerdefinitie voor een openapi-functie.
OpenApiManagedAuthDetails	Beveiligingsdetails voor OpenApi managed_identity-verificatie
OpenApiManagedSecurityScheme	Beveiligingsschema voor OpenApi managed_identity-verificatie
OpenApiToolDefinition	De informatie over de invoerdefinitie voor een OpenAPI-hulpprogramma zoals wordt gebruikt voor het configureren van een agent.
PageSettings	Opties voor de methode byPage
PagedAsyncIterableIterator	Een interface waarmee asynchrone iteratie zowel kan worden voltooid als per pagina.
PollingOptions	Opties voor het configureren van pollinggedrag.
PollingOptionsParams	Optionele parameters voor het configureren van pollinggedrag.
RequiredAction	Een abstracte weergave van een vereiste actie voor een agentthread die wordt uitgevoerd om door te gaan.
RequiredFunctionToolCall	Een weergave van een aangevraagde aanroep naar een functiehulpprogramma, dat nodig is voor het model om de evaluatie van een uitvoering voort te zetten.
RequiredFunctionToolCallDetails	De gedetailleerde informatie voor een functie-aanroep, zoals opgegeven door een vereiste actie die een functiehulpmiddel aanroept, die de naam van en argumenten voor de functie bevat.
RequiredToolCall	Een abstracte weergave van een aanroep van een hulpprogramma dat nodig is voor het model om door te gaan met een uitvoering.
ResponseFormatJsonSchema	Een beschrijving van waar de antwoordindeling voor dient, die door het model wordt gebruikt om te bepalen hoe het model in de indeling moet reageren.
ResponseFormatJsonSchemaType	Het type antwoordindeling dat wordt gedefinieerd: json_schema
RunCompletionUsage	Gebruiksstatistieken met betrekking tot de uitvoering. Deze waarde wordt null als de uitvoering niet de status terminal heeft (dat wil bijvoorbeeld in_progress, queued, enzovoort).
RunError	De details van een fout die wordt aangetroffen door een agentthreaduitvoering.
RunStep	Gedetailleerde informatie over één stap van een agentthreaduitvoering.
RunStepAzureAISearchToolCall	Een record van een aanroep naar een Azure AI Search-hulpprogramma dat is uitgegeven door het model in evaluatie van een gedefinieerd hulpprogramma dat de uitgevoerde Azure AI-zoekopdracht vertegenwoordigt.
RunStepBingGroundingToolCall	Een record van een aanroep naar een bing-grounding-hulpprogramma, uitgegeven door het model in evaluatie van een gedefinieerd hulpprogramma, dat een uitgevoerde zoekopdracht vertegenwoordigt met bing grounding.
RunStepCodeInterpreterImageOutput	Een weergave van een afbeeldingsuitvoer die wordt verzonden door een code-interpreter-hulpprogramma als reactie op een door het model aanroep van een hulpprogramma.
RunStepCodeInterpreterImageReference	Een afbeeldingsverwijzing die wordt verzonden door een code-interpreter-hulpprogramma als reactie op een aanroep van het hulpprogramma door het model.
RunStepCodeInterpreterLogOutput	Een weergave van een logboekuitvoer die wordt verzonden door een code-interpreter-hulpprogramma als reactie op een door het model aanroep van een hulpprogramma.
RunStepCodeInterpreterToolCall	Een record van een aanroep naar een code-interpreter-hulpprogramma dat is uitgegeven door het model tijdens de evaluatie van een gedefinieerd hulpprogramma, dat invoer en uitvoer vertegenwoordigt die worden verbruikt en verzonden door de code-interpreter.
RunStepCodeInterpreterToolCallDetails	De gedetailleerde informatie over het aanroepen van een code-interpreter door het model.
RunStepCodeInterpreterToolCallOutput	Een abstracte weergave van een verzonden uitvoer van een code-interpreter-hulpprogramma.
RunStepCompletionUsage	Gebruiksstatistieken met betrekking tot de uitvoeringsstap.
RunStepDelta	Vertegenwoordigt de deltapayload in een delta-segment van een streaming-runstap.
RunStepDeltaChunk	Vertegenwoordigt een delta van een uitvoeringsstap, dat wil bijvoorbeeld eventuele gewijzigde velden in een uitvoeringsstap tijdens het streamen.
RunStepDeltaCodeInterpreterDetailItemObject	Vertegenwoordigt de aanroepgegevens van het hulpprogramma Code Interpreter in de hulpprogramma-aanroepen van een streaminguitvoeringsstap.
RunStepDeltaCodeInterpreterImageOutput	Vertegenwoordigt een uitvoer van afbeeldingen zoals geproduceerd het code-interpreter-hulpprogramma en zoals weergegeven in de delta-toolverzameling van een streaming-uitvoeringsstap.
RunStepDeltaCodeInterpreterImageOutputObject	Vertegenwoordigt de gegevens voor de uitvoer van de code-interpreter van een streaminguitvoeringsstap.
RunStepDeltaCodeInterpreterLogOutput	Vertegenwoordigt een logboekuitvoer die wordt geproduceerd door het hulpprogramma Code Interpreter en zoals weergegeven in de delta-hulpprogrammaverzameling van een streaming-uitvoeringsstap.
RunStepDeltaCodeInterpreterOutput	De abstracte basisweergave van de uitvoer van het hulpprogramma code-interpreter van een streaminguitvoeringsstap.
RunStepDeltaCodeInterpreterToolCall	Vertegenwoordigt een aanroep van het hulpprogramma Code Interpreter binnen de aanroepgegevens van het hulpprogramma van een streaminguitvoeringsstap.
RunStepDeltaDetail	Vertegenwoordigt een detailitem met één uitvoeringsstap in de delta-nettolading van een streaming-uitvoeringsstap.
RunStepDeltaFileSearchToolCall	Vertegenwoordigt een aanroep van een hulpprogramma voor het zoeken van bestanden binnen de aanroepgegevens van een streaminguitvoeringsstap.
RunStepDeltaFunction	Vertegenwoordigt de functiegegevens in de aanroep van een functiehulpprogramma van een streaming-runstap van Delta.
RunStepDeltaFunctionToolCall	Vertegenwoordigt een functiehulpmiddeloproep binnen de aanroepgegevens van een streaming-runstap.
RunStepDeltaMessageCreation	Vertegenwoordigt een bericht dat wordt gemaakt binnen een delta van een streaming-uitvoeringsstap.
RunStepDeltaMessageCreationObject	Vertegenwoordigt de gegevens in een antwoordobject voor het maken van een streaming-run-stapbericht.
RunStepDeltaToolCall	De abstracte basisweergave van één hulpprogramma-aanroep binnen de delta-aanroepgegevens van een streaminguitvoeringsstap.
RunStepDeltaToolCallObject	Vertegenwoordigt een aanroep van hulpprogrammaaanroepen als onderdeel van een streaminguitvoeringsstap.
RunStepDetails	Een abstracte weergave van de details voor een uitvoeringsstap.
RunStepError	De foutinformatie die is gekoppeld aan een mislukte uitvoeringsstap.
RunStepFileSearchToolCall	Een record van een aanroep naar een hulpprogramma voor het zoeken van bestanden, uitgegeven door het model in evaluatie van een gedefinieerd hulpprogramma, dat staat voor uitgevoerde bestandszoekopdrachten.
RunStepFileSearchToolCallResult	Resultaat van het aanroepen van het hulpprogramma voor het zoeken van bestanden.
RunStepFileSearchToolCallResults	De resultaten van het zoeken naar bestanden.
RunStepFunctionToolCall	Een record van een aanroep naar een functiehulpprogramma, uitgegeven door het model in evaluatie van een gedefinieerd hulpprogramma, dat de verbruikte invoer en uitvoer vertegenwoordigt en die door de opgegeven functie wordt verzonden.
RunStepFunctionToolCallDetails	De gedetailleerde informatie over de functie die door het model wordt aangeroepen.
RunStepMessageCreationDetails	De gedetailleerde informatie die is gekoppeld aan een stap voor het maken van een bericht.
RunStepMessageCreationReference	De details van een bericht dat is gemaakt als onderdeel van een uitvoeringsstap.
RunStepOpenAPIToolCall	Een record van een aanroep naar een OpenAPI-tool, uitgegeven door het model ter evaluatie van een gedefinieerd hulpprogramma, dat uitgevoerde OpenAPI-bewerkingen vertegenwoordigt.
RunStepToolCall	Een abstracte weergave van een gedetailleerde toolaanroep zoals vastgelegd in een uitvoeringsstap voor een bestaande uitvoering.
RunStepToolCallDetails	De gedetailleerde informatie die is gekoppeld aan een hulpprogramma voor het aanroepen van een uitvoeringsstap.
RunStepsGetRunStepOptionalParams	Optionele parameters.
RunStepsListRunStepsOptionalParams	Optionele parameters.
RunStepsOperations	Interface die een RunSteps-bewerking vertegenwoordigt.
RunsCancelRunOptionalParams	Optionele parameters.
RunsCreateRunOptionalParams	Optionele parameters.
RunsGetRunOptionalParams	Optionele parameters.
RunsListRunsOptionalParams	Optionele parameters.
RunsOperations	Interface die een Runs-bewerkingen vertegenwoordigt.
RunsSubmitToolOutputsToRunOptionalParams	Optionele parameters.
RunsUpdateRunOptionalParams	Optionele parameters.
SubmitToolOutputsAction	De details voor vereiste hulpprogrammaaanroepen die moeten worden verzonden voor een agentthreaduitvoering om door te gaan.
SubmitToolOutputsDetails	De details over hulpprogramma's die moeten worden aangeroepen om uitvoer van hulpprogramma's te verzenden.
ThreadDeletionStatus	De status van een threadverwijderingsbewerking.
ThreadMessage	Eén bestaand bericht binnen een agentthread.
ThreadMessageOptions	Eén bericht binnen een agentthread, zoals is opgegeven tijdens het maken van die thread voor de oorspronkelijke status.
ThreadRun	Gegevens die één evaluatierun van een agentthread vertegenwoordigen.
ThreadsCreateThreadOptionalParams	Optionele parameters.
ThreadsDeleteThreadOptionalParams	Optionele parameters.
ThreadsGetThreadOptionalParams	Optionele parameters.
ThreadsListThreadsOptionalParams	Optionele parameters.
ThreadsOperations	Interface die een Threads-bewerkingen vertegenwoordigt.
ThreadsUpdateThreadOptionalParams	Optionele parameters.
ToolDefinition	Een abstracte weergave van een definitie van een invoerhulpprogramma die een agent kan gebruiken.
ToolOutput	De gegevens die tijdens een hulpprogramma worden verstrekt, verzenden om openstaande hulpprogramma-aanroepen op te lossen en het model door te laten gaan.
ToolResources	Een set resources die worden gebruikt door de hulpprogramma's van de agent. De resources zijn specifiek voor het type hulpprogramma. Voor het code_interpreter hulpprogramma is bijvoorbeeld een lijst met bestands-id's vereist, terwijl voor het file_search hulpprogramma een lijst met vectoropslag-id's is vereist.
TruncationObject	Besturingselementen voor hoe een thread wordt afgekapt voordat de uitvoering wordt uitgevoerd. Gebruik deze optie om het eerste contextvenster van de uitvoering te beheren.
UpdateAgentOptionalParams	Optionele parameters.
VectorStore	Een vectorarchief is een verzameling verwerkte bestanden die door het file_search hulpprogramma kunnen worden gebruikt.
VectorStoreAutoChunkingStrategyRequest	De standaardstrategie. Deze strategie maakt momenteel gebruik van een max_chunk_size_tokens van 800 en chunk_overlap_tokens van 400.
VectorStoreAutoChunkingStrategyResponse	Dit wordt geretourneerd wanneer de segmenteringsstrategie onbekend is. Dit komt meestal doordat het bestand is geïndexeerd voordat het chunking_strategy concept in de API werd geïntroduceerd.
VectorStoreChunkingStrategyRequest	Een abstracte weergave van een segmenteringsstrategieconfiguratie voor vectoropslag.
VectorStoreChunkingStrategyResponse	Een abstracte weergave van een segmenteringsstrategieconfiguratie voor vectoropslag.
VectorStoreConfiguration	Vector-opslagconfiguratie is de lijst met gegevensbronnen die worden gebruikt wanneer meerdere bestanden kunnen worden gebruikt voor het zoeken naar bedrijfsbestanden.
VectorStoreConfigurations	De structuur, die de lijst met vectoropslagconfiguraties bevat, bijvoorbeeld de lijst met azure-asset-id's.
VectorStoreDataSource	De structuur, met het URI-pad van Azure-assets en het assettype van het bestand dat wordt gebruikt als gegevensbron voor het zoeken naar ondernemingsbestanden.
VectorStoreDeletionStatus	Antwoordobject voor het verwijderen van een vectorarchief.
VectorStoreExpirationPolicy	Het verloopbeleid voor een vectorarchief.
VectorStoreFile	Beschrijving van een bestand dat is gekoppeld aan een vectorarchief.
VectorStoreFileBatch	Een batch bestanden die zijn gekoppeld aan een vectorarchief.
VectorStoreFileBatchesCancelVectorStoreFileBatchOptionalParams	Optionele parameters.
VectorStoreFileBatchesCreateVectorStoreFileBatchOptionalParams	Optionele parameters.
VectorStoreFileBatchesGetVectorStoreFileBatchOptionalParams	Optionele parameters.
VectorStoreFileBatchesListVectorStoreFileBatchFilesOptionalParams	Optionele parameters.
VectorStoreFileBatchesOperations	Interface die een VectorStoreFileBatches-bewerking vertegenwoordigt.
VectorStoreFileCount	Het aantal bestanden dat wordt verwerkt of verwerkt door dit vectorarchief, gegroepeerd op status.
VectorStoreFileDeletionStatus	Antwoordobject voor het verwijderen van een bestandsrelatie van een vectorarchief.
VectorStoreFileError	Details over de fout die kan zijn opgetreden tijdens het verwerken van een bestand voor dit vectorarchief
VectorStoreFilesCreateVectorStoreFileOptionalParams	Optionele parameters.
VectorStoreFilesDeleteVectorStoreFileOptionalParams	Optionele parameters.
VectorStoreFilesGetVectorStoreFileOptionalParams	Optionele parameters.
VectorStoreFilesListVectorStoreFilesOptionalParams	Optionele parameters.
VectorStoreFilesOperations	Interface die een VectorStoreFiles-bewerking vertegenwoordigt.
VectorStoreStaticChunkingStrategyOptions	Opties voor het configureren van een statische segmenteringsstrategie voor vectoropslag.
VectorStoreStaticChunkingStrategyRequest	Een statisch geconfigureerde segmenteringsstrategie.
VectorStoreStaticChunkingStrategyResponse	Een statisch geconfigureerde segmenteringsstrategie.
VectorStoresCreateVectorStoreOptionalParams	Optionele parameters.
VectorStoresDeleteVectorStoreOptionalParams	Optionele parameters.
VectorStoresGetVectorStoreOptionalParams	Optionele parameters.
VectorStoresListVectorStoresOptionalParams	Optionele parameters.
VectorStoresModifyVectorStoreOptionalParams	Optionele parameters.
VectorStoresOperations	Interface die een VectorStores-operatie vertegenwoordigt.

Type-aliassen

AgentEventStreamData	Vertegenwoordigt een stream-gebeurtenisgegevens in de agent.
AgentRunResponse	Agent voert antwoord uit met ondersteuning voor stream.
AgentStreamEvent	Alias voor AgentStreamEvent
AgentsNamedToolChoiceType	Beschikbare tooltypen voor agents met de naam tools.
AgentsResponseFormatMode	Vertegenwoordigt de modus waarin het model de return-indeling van een gereedschapsaanroep zal verwerken.
AgentsResponseFormatOption	Alias voor AgentsResponseFormatOption
AgentsToolChoiceOption	Alias voor AgentsToolChoiceOption
AgentsToolChoiceOptionMode	Geeft aan hoe de gereedschapskeuze wordt gebruikt
AzureAISearchQueryType	Beschikbare querytypen voor Azure AI Search-tool.
ContinuablePage	Een interface die een pagina met resultaten beschrijft.
FileContents	Geldige waarden voor de inhoud van een binair bestand.
FilePurpose	De mogelijke waarden die het beoogde gebruik van een bestand aangeven.
FileState	De status van het bestand.
ImageDetailLevel	Hiermee geeft u het detailniveau van een afbeelding op. Kan 'auto', 'laag', 'hoog' of een onbekende toekomstige waarde zijn.
IncompleteDetailsReason	De reden waarom de uitvoering onvolledig is. Hiermee wordt verwijst naar welke specifieke tokenlimiet is bereikt tijdens de uitvoering.
ListSortOrder	De beschikbare sorteeropties bij het opvragen van een lijst met antwoordobjecten.
MessageAttachmentToolDefinition	Alias voor MessageAttachmentToolDefinition
MessageBlockType	Hiermee geeft u het type inhoudsblok in een bericht op. Dit kan tekst zijn, een afbeeldingsbestand, een externe afbeeldings-URL of een onbekend toekomstig type.
MessageContentUnion	Alias voor MessageContentUnion
MessageDeltaContentUnion	Alias voor MessageDeltaContentUnion
MessageDeltaTextAnnotationUnion	Alias voor MessageDeltaTextAnnotationUnion
MessageIncompleteDetailsReason	Een reeks redenen waarom een bericht als onvolledig is gemarkeerd.
MessageInputContent	Alias voor MessageInputContent
MessageInputContentBlockUnion	Alias voor MessageInputContentBlockUnion
MessageRole	De mogelijke waarden voor rollen die zijn toegewezen aan berichten in een thread.
MessageStatus	De mogelijke waarden voor de uitvoeringsstatus van een threadbericht.
MessageTextAnnotationUnion	Alias voor MessageTextAnnotationUnion
OpenApiAuthDetailsUnion	Alias voor OpenApiAuthDetailsUnion
OpenApiAuthType	Verificatietype voor OpenApi-eindpunt. Toegestane soorten zijn: Anoniem (geen authenticatie vereist) Verbinding (vereist connection_id naar eindpunt, zoals ingesteld in AI Foundry) Managed_Identity (vereist publiek voor verificatie op basis van identiteit)
RequiredActionUnion	Alias voor RequiredActionUnion
RequiredToolCallUnion	Alias voor RequiredToolCallUnion
ResponseFormat	Mogelijke API-responsformaten.
RunAdditionalFieldList	Een lijst met extra velden die moeten worden opgenomen in het antwoord.
RunStatus	Mogelijke waarden voor de status van een agentthread-run.
RunStepCodeInterpreterToolCallOutputUnion	Alias voor RunStepCodeInterpreterToolCallOutputUnion
RunStepDeltaCodeInterpreterOutputUnion	Alias voor RunStepDeltaCodeInterpreterOutputUnion
RunStepDeltaDetailUnion	Alias voor RunStepDeltaDetailUnion
RunStepDeltaToolCallUnion	Alias voor RunStepDeltaToolCallUnion
RunStepDetailsUnion	Alias voor RunStepDetailsUnion
RunStepErrorCode	Mogelijke foutcodewaarden die kunnen worden toegeschreven aan een mislukte uitvoeringsstap.
RunStepStatus	Mogelijke waarden voor de status van een uitvoeringsstap.
RunStepToolCallUnion	Alias voor RunStepToolCallUnion
RunStepType	De mogelijke soorten loopstappen.
ToolDefinitionUnion	Alias voor ToolDefinitionUnion
TruncationStrategy	Mogelijke afkapstrategieën voor de draad.
VectorStoreChunkingStrategyRequestType	Soort chunking-strategie
VectorStoreChunkingStrategyRequestUnion	Alias voor VectorStoreChunkingStrategyRequestUnion
VectorStoreChunkingStrategyResponseType	Soort chunking-strategie
VectorStoreChunkingStrategyResponseUnion	Alias voor VectorStoreChunkingStrategyResponseUnion
VectorStoreExpirationPolicyAnchor	Beschrijft de relatie tussen de dagen en de vervaldatum van deze vectoropslag
VectorStoreFileBatchStatus	De status van de batch van het vectorwinkelbestand.
VectorStoreFileErrorCode	Foutcodevarianten voor de verwerking van vectorbestanden
VectorStoreFileStatus	Bestandsstatus van vectoropslag
VectorStoreFileStatusFilter	Queryparameterfilter voor eindpunt voor het ophalen van vectorbestanden
VectorStoreStatus	Vector opslaan mogelijke status

Enums

DoneEvent	Terminal-gebeurtenis die het einde van een stream aangeeft.
ErrorEvent	Terminal-gebeurtenis die een fout aan de serverzijde aangeeft tijdens het streamen.
KnownVersions	Versies van de Azure AI Agents-API
MessageStreamEvent	Gerelateerde streaming-gebeurtenissen voor berichtbewerkingen
RunStepStreamEvent	Gerelateerde streaming-gebeurtenissen voor stapbewerkingen uitvoeren
RunStreamEvent	Gebeurtenissen met betrekking tot het uitvoeren van streaming
ThreadStreamEvent	Gerelateerde streaming-gebeurtenissen voor threadbewerkingen
VectorStoreDataSourceAssetType	Type vectoropslagmiddel. Het activatype kan een uri_asset zijn, in dit geval moet het een URI-ID van het activum bevatten, in het geval van id_asset moet het de gegevens-ID bevatten.
connectionToolType	Typen verbindingshulpprogramma's die worden gebruikt om een agent te configureren

Functies

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

Bepaalt of de opgegeven uitvoer van het opgegeven type is.

Functiedetails

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

Bepaalt of de opgegeven uitvoer van het opgegeven type is.

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

Parameters

output

ToolDefinitionUnion | RequiredAction | RequiredToolCall

De actie die moet worden gecontroleerd, die van het type RequiredAction, RequiredToolCallof ToolDefinitionUnionkan zijn.

type

string

Het type waarop de actie moet worden gecontroleerd.

Retouren

output

Een Booleaanse waarde die aangeeft of de actie van het opgegeven type is.