@azure/ai-projects package

Klassen

AIProjectClient

krijgt de OpenAI-client met optionele OpenAI-clientopties

Interfaces

@azure/ai-projects.Index

A2APreviewTool	Een agent die het A2A-protocol implementeert.
AIProjectClientOptionalParams	Optionele parameters voor de client.
AISearchIndexResource	Een AI-zoekindexbron.
Agent	modelinterface Agent
AgentClusterInsightRequest	Inzichten in de set resultaten van agentevaluatie
AgentClusterInsightResult	Inzichten uit de analyse van de agentcluster.
AgentDefinition	Basisdefinitie-interface voor agenten. Bevat het type agent en optionele RAI-configuratie.
AgentTaxonomyInput	Invoerconfiguratie voor de evaluatietaxonomie wanneer het invoertype agent is.
AgentVersion	Vertegenwoordigt een specifieke versie van een agent. Omvat metagegevens, versiebeheer, aanmaaktijd en agentdefinitie.
AgenticIdentityPreviewCredentials	Definitie van agentische identiteitsreferenties
AgentsCreateAgentFromManifestOptionalParams	Optionele parameters.
AgentsCreateAgentVersionFromManifestOptionalParams	Optionele parameters.
AgentsCreateOptionalParams	Optionele parameters.
AgentsCreateVersionOptionalParams	Optionele parameters.
AgentsDeleteOptionalParams	Optionele parameters.
AgentsDeleteVersionOptionalParams	Optionele parameters.
AgentsGetOptionalParams	Optionele parameters.
AgentsGetVersionOptionalParams	Optionele parameters.
AgentsListOptionalParams	Optionele parameters.
AgentsListVersionsOptionalParams	Optionele parameters.
AgentsOperations	Interface die de operaties van een agent vertegenwoordigt.
AgentsUpdateAgentFromManifestOptionalParams	Optionele parameters.
AgentsUpdateOptionalParams	Optionele parameters.
Annotation	Een aantekening die van toepassing is op een reeks uitvoerteksten.
ApiErrorResponse	Foutreactie voor API-fouten.
ApiKeyCredentials	Definitie van API-sleutel
ApplyPatchCreateFileOperationParam	Instructie voor het aanmaken van een nieuw bestand via de apply_patch-tool.
ApplyPatchDeleteFileOperationParam	Instructie voor het verwijderen van een bestaand bestand via de apply_patch-tool.
ApplyPatchOperationParam	Een van de create_file, delete_file of update_file bewerkingen die aan het apply_patch gereedschap worden geleverd.
ApplyPatchToolParam	Stelt de assistent in staat om bestanden aan te maken, verwijderen of bijwerken met behulp van unified diffs.
ApplyPatchUpdateFileOperationParam	Instructie voor het bijwerken van een bestaand bestand via de apply_patch-tool.
ApproximateLocation	modelinterface ApproximateLocation
AzureAIAgentTarget	Vertegenwoordigt een doel dat een Azure AI-agent opgeeft.
AzureAIModelTarget	Vertegenwoordigt een doel dat een Azure AI-model opgeeft voor bewerkingen waarvoor modelselectie is vereist.
AzureAISearchIndex	Definitie van Azure AI-zoekindex
AzureAISearchTool	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.
AzureFunctionTool	De invoerdefinitiegegevens voor een Azure Function Tool, zoals gebruikt om een agent te configureren.
AzureOpenAIModelConfiguration	Configuratie van het Azure OpenAI-model. De API-versie wordt door de service geselecteerd voor het opvragen van het model.
BaseCredentials	Een basisklasse voor verbindingsreferenties
BetaEvaluationTaxonomiesCreateOptionalParams	Optionele parameters.
BetaEvaluationTaxonomiesDeleteOptionalParams	Optionele parameters.
BetaEvaluationTaxonomiesGetOptionalParams	Optionele parameters.
BetaEvaluationTaxonomiesListOptionalParams	Optionele parameters.
BetaEvaluationTaxonomiesOperations	Interface die een BetaEvaluationTaxonomies-operatie vertegenwoordigt.
BetaEvaluationTaxonomiesUpdateOptionalParams	Optionele parameters.
BetaEvaluatorsCreateVersionOptionalParams	Optionele parameters.
BetaEvaluatorsDeleteVersionOptionalParams	Optionele parameters.
BetaEvaluatorsGetVersionOptionalParams	Optionele parameters.
BetaEvaluatorsListLatestVersionsOptionalParams	Optionele parameters.
BetaEvaluatorsListVersionsOptionalParams	Optionele parameters.
BetaEvaluatorsOperations	Interface die de operaties van een BetaEvaluator vertegenwoordigt.
BetaEvaluatorsUpdateVersionOptionalParams	Optionele parameters.
BetaInsightsGenerateOptionalParams	Optionele parameters.
BetaInsightsGetOptionalParams	Optionele parameters.
BetaInsightsListOptionalParams	Optionele parameters.
BetaInsightsOperations	Interface die een BetaInsights-operatie vertegenwoordigt.
BetaMemoryStoresCreateOptionalParams	Optionele parameters.
BetaMemoryStoresDeleteOptionalParams	Optionele parameters.
BetaMemoryStoresDeleteScopeOptionalParams	Optionele parameters.
BetaMemoryStoresGetOptionalParams	Optionele parameters.
BetaMemoryStoresGetUpdateResultOptionalParams	Optionele parameters.
BetaMemoryStoresListOptionalParams	Optionele parameters.
BetaMemoryStoresOperations	Interface die een BetaMemoryStores-operatie vertegenwoordigt.
BetaMemoryStoresSearchMemoriesOptionalParams	Optionele parameters.
BetaMemoryStoresUpdateMemoriesOptionalParams	Optionele parameters.
BetaMemoryStoresUpdateOptionalParams	Optionele parameters.
BetaOperations	Interface die een bèta-operatie vertegenwoordigt.
BetaRedTeamsCreateOptionalParams	Optionele parameters.
BetaRedTeamsGetOptionalParams	Optionele parameters.
BetaRedTeamsListOptionalParams	Optionele parameters.
BetaRedTeamsOperations	Interface die de BetaRedTeams-operaties vertegenwoordigt.
BetaSchedulesCreateOrUpdateOptionalParams	Optionele parameters.
BetaSchedulesDeleteOptionalParams	Optionele parameters.
BetaSchedulesGetOptionalParams	Optionele parameters.
BetaSchedulesGetRunOptionalParams	Optionele parameters.
BetaSchedulesListOptionalParams	Optionele parameters.
BetaSchedulesListRunsOptionalParams	Optionele parameters.
BetaSchedulesOperations	Interface die een BetaSchedules-operatie vertegenwoordigt.
BingCustomSearchConfiguration	Een aangepaste zoekconfiguratie van bing.
BingCustomSearchPreviewTool	De invoerdefinitiegegevens voor een aangepast zoekhulpmiddel van Bing zoals gebruikt om een agent te configureren.
BingCustomSearchToolParameters	De parameters van de aangepaste zoektool van Bing.
BingGroundingSearchConfiguration	Zoekconfiguratie voor Bing Grounding
BingGroundingSearchToolParameters	De parameters van de bing grounding zoektool.
BingGroundingTool	De informatie over de invoerdefinitie voor een bing grounding search-hulpprogramma zoals wordt gebruikt voor het configureren van een agent.
BlobReference	Details van de blobreferentie.
BrowserAutomationPreviewTool	De invoerdefinitie-informatie voor een Browser Automation Tool, zoals gebruikt om een Agent te configureren.
BrowserAutomationToolConnectionParameters	Definitie van invoerparameters voor de verbinding die wordt gebruikt door de Browser Automation Tool.
BrowserAutomationToolParameters	Definitie van invoerparameters voor de Browser Automation Tool.
CaptureStructuredOutputsTool	Een tool voor het vastleggen van gestructureerde outputs
ChartCoordinate	Coördinaten voor de analysegrafiek.
ChatSummaryMemoryItem	Een geheugenitem met een samenvatting uit gesprekken.
ClickParam	Een klikactie.
ClusterInsightResult	Inzichten uit de clusteranalyse.
ClusterTokenUsage	Tokengebruik voor clusteranalyse
CodeBasedEvaluatorDefinition	Definitie van een beoordelaar op basis van code met behulp van python-code
CodeInterpreterContainerAuto	Configuratie voor een code-interpretercontainer. Geef desgewenst de id's van de bestanden op waarop de code moet worden uitgevoerd.
CodeInterpreterOutputImage	De uitvoer van de afbeelding van de code-interpreter.
CodeInterpreterOutputLogs	De logboekuitvoer van de code-interpreter.
CodeInterpreterTool	Een hulpprogramma waarmee Python-code wordt uitgevoerd om een reactie op een prompt te genereren.
ComparisonFilter	Een filter dat wordt gebruikt om een opgegeven kenmerksleutel te vergelijken met een bepaalde waarde met behulp van een gedefinieerde vergelijkingsbewerking.
CompoundFilter	Meerdere filters combineren met and of or.
ComputerAction	modelinterface ComputerAction
ComputerCallSafetyCheckParam	Een veiligheidscontrole in behandeling voor de computeroproep.
ComputerScreenshotImage	Een schermopnameafbeelding van een computer die wordt gebruikt met het hulpprogramma voor computergebruik.
ComputerUsePreviewTool	Een hulpprogramma waarmee een virtuele computer wordt bestuurd. Meer informatie over de computertool.
Connection	Reactie uit de lijst en verbindingen ophalen bewerkingen
ConnectionsGetOptionalParams	Optionele parameters.
ConnectionsGetWithCredentialsOptionalParams	Optionele parameters.
ConnectionsListOptionalParams	Optionele parameters.
ConnectionsOperations	Interface die een Connections-bewerkingen vertegenwoordigt.
ContainerAppAgentDefinition	De definitie van de container-app-agent.
ContainerFileCitationBody	Een citatie voor een containerbestand dat wordt gebruikt om een modelantwoord te genereren.
ContinuousEvaluationRuleAction	Evaluatieregelactie voor continue evaluatie.
CosmosDBIndex	Definitie van CosmosDB Vector Store-index
CronTrigger	Cron gebaseerde trigger.
CustomCredential	Definitie van aangepaste referenties
CustomGrammarFormatParam	Een grammatica gedefinieerd door de gebruiker.
CustomTextFormatParam	Onbeperkte vrije vorm tekst.
CustomToolParam	Een aangepaste tool die input verwerkt met een gespecificeerd formaat. Lees meer over aangepaste tools
CustomToolParamFormat	Het invoerformaat voor de aangepaste tool. Standaard is onbeperkte tekst.
DailyRecurrenceSchedule	Dagelijks herhalingsschema.
DatasetCredential	Vertegenwoordigt een verwijzing naar een blob voor consumptie
DatasetUploadOptions	Opties voor het uploaden van gegevenssets
DatasetVersion	Definitie van datasetversie
DatasetsCreateOrUpdateOptionalParams	Optionele parameters.
DatasetsDeleteOptionalParams	Optionele parameters.
DatasetsGetCredentialsOptionalParams	Optionele parameters.
DatasetsGetOptionalParams	Optionele parameters.
DatasetsListOptionalParams	Optionele parameters.
DatasetsListVersionsOptionalParams	Optionele parameters.
DatasetsOperations	Interface die een bewerking van datasets vertegenwoordigt.
DatasetsPendingUploadOptionalParams	Optionele parameters.
DeleteAgentResponse	Een verwijderd agentobject
DeleteAgentVersionResponse	Een verwijderde agentversie Object
DeleteMemoryStoreResponse	modelinterface DeleteMemoryStoreResponse
Deployment	Definitie van modelimplementatie
DeploymentsGetOptionalParams	Optionele parameters.
DeploymentsListOptionalParams	Optionele parameters.
DeploymentsOperations	Interface die een implementatiebewerkingen vertegenwoordigt.
DoubleClickAction	Een actie met dubbelklikken.
Drag	Een sleepactie.
DragPoint	Een x/y-coördinaatpaar, bijvoorbeeld { x: 100, y: 200 }.
EasyInputMessage	Een berichtinvoer voor het model met een rol die de instructies in de volgende hiërarchie aangeeft. Instructies met de developer of system rol hebben voorrang op instructies die met de user rol worden gegeven. Berichten met de assistant rol worden verondersteld te zijn gegenereerd door het model in eerdere interacties.
EmbeddingConfiguration	Configuratieklasse insluiten
EntraIDCredentials	Definitie van Entra-ID-referenties
ErrorModel	modelinterface ErrorModel
EvalResult	Resultaat van de evaluatie.
EvalRunResultCompareItem	Metrische vergelijking voor een behandeling ten opzichte van de baseline.
EvalRunResultComparison	Vergelijkingsresultaten voor behandeling lopen tegen de uitgangswaarde.
EvalRunResultSummary	Samenvattende statistieken van een metrische waarde in een evaluatierun.
EvaluationComparisonInsightRequest	Evaluatie Vergelijking Aanvraag
EvaluationComparisonInsightResult	Inzichten uit de evaluatievergelijking.
EvaluationResultSample	Een greep uit het evaluatieresultaat.
EvaluationRule	Model voor evaluatieregels.
EvaluationRuleAction	Evaluatie actiemodel.
EvaluationRuleFilter	Evaluatie filtermodel.
EvaluationRulesCreateOrUpdateOptionalParams	Optionele parameters.
EvaluationRulesDeleteOptionalParams	Optionele parameters.
EvaluationRulesGetOptionalParams	Optionele parameters.
EvaluationRulesListOptionalParams	Optionele parameters.
EvaluationRulesOperations	Interface die een EvaluationRules-bewerkingen vertegenwoordigt.
EvaluationRunClusterInsightRequest	Inzichten in de set evaluatieresultaten
EvaluationRunClusterInsightResult	Inzichten uit de evaluatie voeren clusteranalyse uit.
EvaluationScheduleTask	Evaluatietaak voor het rooster.
EvaluationTaxonomy	Evaluatie taxonomie definitie
EvaluationTaxonomyInput	Invoerconfiguratie voor de evaluatietaxonomie.
EvaluatorDefinition	Configuratie van basisbeoordelaar met discriminator
EvaluatorMetric	Evaluator metriek
EvaluatorVersion	Definitie van evaluator
FabricDataAgentToolParameters	De parameters van de fabric data agent.
FieldMapping	Configuratieklasse voor veldtoewijzing
FileCitationBody	Een bronvermelding naar een bestand.
FileDatasetVersion	Definitie van FileDatasetVersion
FilePath	Een pad naar een bestand.
FileSearchTool	Een hulpprogramma waarmee wordt gezocht naar relevante inhoud uit geüploade bestanden. Meer informatie over de tool voor het zoeken naar bestanden.
FileSearchToolCallResults	modelinterface FileSearchToolCallResults
FolderDatasetVersion	Definitie van FileDatasetVersion
FunctionAndCustomToolCallOutput	modelinterface FunctionAndCustomToolCallOutput
FunctionAndCustomToolCallOutputInputFileContent	Een bestandsinvoer voor het model.
FunctionAndCustomToolCallOutputInputImageContent	Een afbeeldingsinvoer voor het model. Meer informatie over afbeeldingsinvoer.
FunctionAndCustomToolCallOutputInputTextContent	Een tekstinvoer voor het model.
FunctionShellActionParam	Commando's en limieten die beschrijven hoe je de shell tool call uitvoert.
FunctionShellCallOutputContentParam	Stdout en Stderr vastgelegd voor een deel van een shell tool call-uitvoer.
FunctionShellCallOutputExitOutcomeParam	Geeft aan dat de shell-commando's zijn voltooid en een exitcode hebben teruggegeven.
FunctionShellCallOutputOutcomeParam	De exit- of timeout-uitkomst die samenhangt met deze shellcall.
FunctionShellCallOutputTimeoutOutcomeParam	Geeft aan dat de shell-oproep de geconfigureerde tijdslimiet heeft overschreden.
FunctionShellToolParam	Een tool waarmee het model shell-commando's kan uitvoeren.
FunctionTool	Definieert een functie in uw eigen code die het model kan aanroepen. Meer informatie over het aanroepen van functies.
HostedAgentDefinition	De definitie van de gehoste agent.
HourlyRecurrenceSchedule	Herhalingsschema per uur.
HumanEvaluationPreviewRuleAction	Evaluatieregelactie voor menselijke evaluatie.
HybridSearchOptions	modelinterface HybridSearchOptions
ImageGenTool	Een tool die afbeeldingen genereert met behulp van de GPT-beeldmodellen.
ImageGenToolInputImageMask	modelinterface ImageGenToolInputImageMask
IndexesCreateOrUpdateOptionalParams	Optionele parameters.
IndexesDeleteOptionalParams	Optionele parameters.
IndexesGetOptionalParams	Optionele parameters.
IndexesListOptionalParams	Optionele parameters.
IndexesListVersionsOptionalParams	Optionele parameters.
IndexesOperations	Interface die een Indexes-bewerkingen vertegenwoordigt.
InputContent	modelinterface InputContent
InputContentInputFileContent	Een bestandsinvoer voor het model.
InputContentInputImageContent	Een afbeeldingsinvoer voor het model. Meer informatie over afbeeldingsinvoer.
InputContentInputTextContent	Een tekstinvoer voor het model.
InputFileContentParam	Een bestandsinvoer voor het model.
InputImageContentParamAutoParam	Een afbeeldingsinvoer voor het model. Leer over beeldinvoer
InputItem	Een item dat een deel van de context vertegenwoordigt voor het antwoord dat door het model wordt gegenereerd. Kan tekst, afbeeldingen en audio-invoer bevatten, evenals eerdere antwoorden van assistenten en uitvoer van hulpprogramma-oproepen.
InputItemApplyPatchToolCallItemParam	Een tool-aanroep die een verzoek vertegenwoordigt om bestanden aan te maken, te verwijderen of bij te werken met behulp van verschillende patches.
InputItemApplyPatchToolCallOutputItemParam	De gestreamde output wordt uitgezonden door een apply patch tool-aanroep.
InputItemCodeInterpreterToolCall	Een aanroep van een hulpprogramma om code uit te voeren.
InputItemCompactionSummaryItemParam	Een compactie-item dat door de v1/responses/compact API wordt gegenereerd.
InputItemComputerCallOutputItemParam	De uitvoer van een aanroep van een computerhulpprogramma.
InputItemComputerToolCall	Een oproep aan een computergebruikshulpmiddel. Zie de handleiding voor computergebruik voor meer informatie.
InputItemCustomToolCall	Een aanroep naar een aangepaste tool die door het model is gemaakt.
InputItemCustomToolCallOutput	De output van een aangepaste tool-aanroep vanuit je code, die wordt teruggestuurd naar het model.
InputItemFileSearchToolCall	De resultaten van een aanroep van een zoekprogramma voor bestanden. Zie de handleiding voor het zoeken naar bestanden voor meer informatie.
InputItemFunctionCallOutputItemParam	De uitvoer van een functiehulpmiddeloproep.
InputItemFunctionShellCallItemParam	Een tool die een verzoek vertegenwoordigt om één of meer shell-commando's uit te voeren.
InputItemFunctionShellCallOutputItemParam	De gestreamde uitvoeritems worden uitgezonden door een shelltool-aanroep.
InputItemFunctionToolCall	Een aanroep van een hulpprogramma om een functie uit te voeren. Zie de handleiding voor het aanroepen van functies voor meer informatie.
InputItemImageGenToolCall	Een aanvraag voor het genereren van afbeeldingen door het model.
InputItemLocalShellToolCall	Een aanroep van een hulpprogramma om een opdracht uit te voeren in de lokale shell.
InputItemLocalShellToolCallOutput	De uitvoer van een lokale shell tool aanroep.
InputItemMcpApprovalRequest	Een verzoek om menselijke goedkeuring van een aanroep van een hulpmiddel.
InputItemMcpApprovalResponse	Een reactie op een MCP-goedkeuringsaanvraag.
InputItemMcpListTools	Een lijst met hulpprogramma's die beschikbaar zijn op een MCP-server.
InputItemMcpToolCall	Een aanroep van een hulpprogramma op een MCP-server.
InputItemOutputMessage	Een uitvoerbericht van het model.
InputItemReasoningItem	Een beschrijving van de gedachtenketen die wordt gebruikt door een redeneringsmodel tijdens het genereren van een antwoord. Zorg ervoor dat je deze items in je input Responses API opneemt voor volgende beurten van een gesprek als je handmatig de context beheert.
InputItemWebSearchToolCall	De resultaten van een aanroep van een webzoektool. Zie de zoekgids op internet voor meer informatie.
InputTextContentParam	Een tekstinvoer voor het model.
Insight	De antwoordbody voor clusterinzichten.
InsightCluster	Een cluster van analysemonsters.
InsightModelConfiguration	Configuratie van het model dat wordt gebruikt bij het genereren van inzichten.
InsightRequest	De aanvraag van het inzichtenrapport.
InsightResult	Het resultaat van de inzichten.
InsightSample	Een voorbeeld uit de analyse.
InsightScheduleTask	Inzichttaak voor het rooster.
InsightSummary	Samenvatting van de analyse van het foutencluster.
InsightsMetadata	Metadata over de inzichten.
ItemReferenceParam	Een interne id voor een item waarnaar moet worden verwezen.
KeyPressAction	Een verzameling toetsaanslagen die het model graag zou willen uitvoeren.
LocalShellExecAction	Voer een shell-opdracht uit op de server.
LocalShellToolParam	Een hulpprogramma waarmee het model shell-opdrachten kan uitvoeren in een lokale omgeving.
LogProb	De logboekkans van een token.
MCPListToolsTool	Een hulpprogramma dat beschikbaar is op een MCP-server.
MCPListToolsToolAnnotations	modelinterface MCPListToolsToolAnnotaties
MCPListToolsToolInputSchema	modelinterface MCPListToolsToolInputSchema
MCPTool	Geef het model toegang tot aanvullende hulpprogramma's via MCP-servers (Remote Model Context Protocol). Meer informatie over MCP.
MCPToolFilter	Een filterobject om aan te geven welke tools zijn toegestaan.
MCPToolRequireApproval	modelinterface MCPToolRequireApproval
ManagedAzureAISearchIndex	Definitie van beheerde Azure AI-zoekindex
MemoryItem	Een enkel geheugenitem dat is opgeslagen in het geheugenarchief en dat inhoud en metadata bevat.
MemoryOperation	Vertegenwoordigt een enkele geheugenbewerking (maken, bijwerken of verwijderen) die wordt uitgevoerd op een geheugenitem.
MemorySearchItem	Een opgehaald geheugenitem uit het geheugen zoeken.
MemorySearchOptions	Zoekopties voor geheugen.
MemorySearchPreviewTool	Een hulpmiddel om herinneringen in de agent te integreren.
MemoryStore	Een geheugenarchief dat gebruikersgeheugens kan opslaan en ophalen.
MemoryStoreDefaultDefinition	Implementatie van standaardgeheugenopslag.
MemoryStoreDefaultOptions	Standaard configuraties voor geheugenopslag.
MemoryStoreDefinition	Basisdefinitie voor configuraties van geheugenopslag.
MemoryStoreDeleteScopeResponse	Antwoord voor het verwijderen van herinneringen uit een scope.
MemoryStoreOperationUsage	Gebruiksstatistieken van een geheugenopslagbewerking.
MemoryStoreSearchResponse	Antwoord op geheugenzoekopdrachten.
MemoryStoreUpdateCompletedResult	Resultaat geheugenupdate.
MemoryStoreUpdateResponse	Geeft de status weer van een updatebewerking voor het geheugenarchief.
MicrosoftFabricPreviewTool	De informatie over de invoerdefinitie voor een Microsoft Fabric-hulpprogramma zoals wordt gebruikt voor het configureren van een agent.
ModelDeployment	Definitie van modelimplementatie
ModelDeploymentSku	SKU-informatie
ModelSamplingParams	Vertegenwoordigt een set parameters die worden gebruikt voor het bepalen van het steekproefgedrag van een taalmodel tijdens het genereren van tekst.
MonthlyRecurrenceSchedule	Maandelijks herhalingsschema.
Move	Een actie voor het verplaatsen van de muis.
NoAuthenticationCredentials	Referenties waarvoor geen verificatie is vereist
OneTimeTrigger	Eenmalige trigger.
OpenApiAnonymousAuthDetails	Beveiligingsdetails voor anonieme OpenApi-verificatie
OpenApiAuthDetails	verificatiedetails voor OpenApiFunctionDefinition
OpenApiFunctionDefinition	De informatie over de invoerdefinitie voor een openapi-functie.
OpenApiManagedAuthDetails	Beveiligingsdetails voor OpenApi managed_identity-verificatie
OpenApiManagedSecurityScheme	Beveiligingsschema voor OpenApi managed_identity-verificatie
OpenApiProjectConnectionAuthDetails	Beveiligingsdetails voor verificatie van OpenApi-projectverbindingen
OpenApiProjectConnectionSecurityScheme	Beveiligingsschema voor OpenApi managed_identity-verificatie
OpenApiTool	De informatie over de invoerdefinitie voor een OpenAPI-hulpprogramma zoals wordt gebruikt voor het configureren van een agent.
OutputMessageContent	modelinterface OutputMessageContent
OutputMessageContentOutputTextContent	Een tekstuitvoer van het model.
OutputMessageContentRefusalContent	Een weigering van het model.
PageSettings	Opties voor de methode byPage
PagedAsyncIterableIterator	Een interface waarmee asynchrone iteratie zowel kan worden voltooid als per pagina.
PendingUploadRequest	Vertegenwoordigt een aanvraag voor een upload die in afwachting is.
PendingUploadResponse	Vertegenwoordigt het antwoord op een in behandeling zijnde uploadaanvraag
PromptAgentDefinition	De definitie van de promptagent
PromptAgentDefinitionTextOptions	Configuratieopties voor een tekstantwoord van het model. Dit kunnen tekst zonder opmaak of gestructureerde JSON-gegevens zijn.
PromptBasedEvaluatorDefinition	Prompt-gebaseerde evaluator
ProtocolVersionRecord	Een recordtoewijzing voor een enkel protocol en de versie ervan.
RaiConfig	Configuratie voor Responsible AI (RAI) contentfiltering en veiligheidsfuncties.
RankingOptions	modelinterface RankingOptions
Reasoning	Alleen GPT-5 en O-serie modellen Configuratieopties voor redeneermodellen.
ReasoningTextContent	Redenerende tekst uit het model.
RecurrenceSchedule	Model voor herhalingsschema.
RecurrenceTrigger	Trigger op basis van herhaling.
RedTeam	Rode teamdetails.
ResponseUsageInputTokensDetails	modelinterface ResponseUsageInputTokensDetails
ResponseUsageOutputTokensDetails	modelinterface ResponseUsageOutputTokensDetails
RestorePollerOptions
SASTokenCredentials	Definitie van SAS-referenties (Shared Access Signature)
SasCredential	Definitie van SAS-referenties
Schedule	Schema model.
ScheduleRun	Model voor planning.
ScheduleTask	Taakmodel plannen.
Screenshot	Een schermopnameactie.
Scroll	Een scrollactie.
SharepointGroundingToolParameters	De parameters van de sharepoint-aardingstool.
SharepointPreviewTool	De informatie over de invoerdefinitie voor een SharePoint-hulpprogramma zoals wordt gebruikt voor het configureren van een agent.
SpecificApplyPatchParam	Hiermee dwingt u het model om het apply_patch hulpprogramma aan te roepen bij het uitvoeren van een hulpprogramma-aanroep.
SpecificFunctionShellParam	Dwingt het model om het shell-hulpprogramma aan te roepen wanneer een hulpprogramma-aanroep is vereist.
StructuredInputDefinition	Een gestructureerde invoer die kan deelnemen aan snelle sjabloonvervangingen en het binden van gereedschapsargumenten.
StructuredOutputDefinition	Een gestructureerde uitvoer die door de agent kan worden geproduceerd.
Summary	Een samenvattende tekst van het model.
Target	Basisklasse voor doelen met discriminatorondersteuning.
TargetConfig	Abstracte klasse voor doelconfiguratie.
TaxonomyCategory	Definitie van taxonomiecategorie.
TaxonomySubCategory	Definitie van subcategorie taxonomie.
TelemetryOperations	Interface die telemetrieoperaties vertegenwoordigt
TextResponseFormatConfiguration	Een object dat de indeling aangeeft die het model moet uitvoeren. { "type": "json_schema" } Als u gestructureerde uitvoer configureert, zorgt u ervoor dat het model overeenkomt met het opgegeven JSON-schema. Meer informatie vindt u in de handleiding Structured Outputs. De standaardindeling is { "type": "text" } zonder extra opties. Niet aanbevolen voor GPT-4o en nieuwere modellen:* Instelling om de oudere JSON-modus in { "type": "json_object" } te schakelen, die ervoor zorgt dat het bericht dat het model genereert geldig JSON is. Het is aanbevolen om json_schema te gebruiken voor modellen die dit ondersteunen.
TextResponseFormatConfigurationResponseFormatJsonObject	JSON-objectantwoordindeling. Een oudere methode voor het genereren van JSON-antwoorden. Het gebruik json_schema wordt aanbevolen voor modellen die dit ondersteunen. Houd er rekening mee dat het model geen JSON genereert zonder een systeem- of gebruikersbericht waarin het wordt geïnstrueerd om dit te doen.
TextResponseFormatConfigurationResponseFormatText	De standaard antwoordindeling. Wordt gebruikt om tekstreacties te genereren.
TextResponseFormatJsonSchema	JSON Schema-antwoordindeling. Wordt gebruikt om gestructureerde JSON-antwoorden te genereren. Meer informatie over gestructureerde uitvoer.
Tool	Een hulpprogramma dat kan worden gebruikt om een antwoord te genereren.
ToolChoiceAllowed	Hiermee beperkt u de hulpprogramma's die beschikbaar zijn voor het model tot een vooraf gedefinieerde set.
ToolChoiceCodeInterpreter	Geeft aan dat het model een ingebouwd hulpprogramma moet gebruiken om een antwoord te genereren. Meer informatie over ingebouwde hulpprogramma's.
ToolChoiceComputerUsePreview	Geeft aan dat het model een ingebouwd hulpprogramma moet gebruiken om een antwoord te genereren. Meer informatie over ingebouwde hulpprogramma's.
ToolChoiceCustom	Gebruik deze optie om af te dwingen dat het model een specifiek aangepast hulpprogramma aanroept.
ToolChoiceFileSearch	Geeft aan dat het model een ingebouwd hulpprogramma moet gebruiken om een antwoord te genereren. Meer informatie over ingebouwde hulpprogramma's.
ToolChoiceFunction	Gebruik deze optie om af te dwingen dat het model een specifieke functie aanroept.
ToolChoiceImageGeneration	Geeft aan dat het model een ingebouwd hulpprogramma moet gebruiken om een antwoord te genereren. Meer informatie over ingebouwde hulpprogramma's.
ToolChoiceMCP	Gebruik deze optie om af te dwingen dat het model een specifiek hulpprogramma aanroept op een externe MCP-server.
ToolChoiceParam	Hoe het model moet selecteren welk hulpprogramma (of hulpprogramma's) moeten worden gebruikt bij het genereren van een antwoord. Zie de tools parameter om te zien welke hulpprogramma's het model kan aanroepen.
ToolChoiceWebSearchPreview	Geeft aan dat het model een ingebouwd hulpprogramma moet gebruiken om een antwoord te genereren. Meer informatie over ingebouwde hulpprogramma's.
ToolChoiceWebSearchPreview20250311	Geeft aan dat het model een ingebouwd hulpprogramma moet gebruiken om een antwoord te genereren. Meer informatie over ingebouwde hulpprogramma's.
ToolDescription	Beschrijving van een tool die door een agent kan worden gebruikt.
ToolProjectConnection	Een bron voor projectverbinding.
TopLogProb	De grootste logboekkans van een token.
Trigger	Basismodel voor Trigger van het rooster.
Type	Een actie om tekst te typen.
UrlCitationBody	Een bronvermelding voor een webresource die wordt gebruikt om een modelantwoord te genereren.
UserProfileMemoryItem	Een geheugenitem dat specifiek gebruikersprofielinformatie bevat die is geëxtraheerd uit gesprekken, zoals voorkeuren, interesses en persoonlijke gegevens.
VectorStoreFileAttributes	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling en het opvragen van objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens, booleaanse waarden of getallen.
Wait	Een wachtactie.
WebSearchActionFind	Actietype 'zoeken': zoekt naar een patroon binnen een geladen pagina.
WebSearchActionOpenPage	Actietype 'open_page': hiermee opent u een specifieke URL uit zoekresultaten.
WebSearchActionSearch	Actietype 'zoeken': voert een webzoekquery uit.
WebSearchActionSearchSources	modelinterface WebSearchActionSearchSources
WebSearchApproximateLocation	De ongeveer locatie van de gebruiker.
WebSearchConfiguration	Een webzoekconfiguratie voor Bing aangepaste zoekopdrachten
WebSearchPreviewTool	Deze tool zoekt op het web naar relevante resultaten om in een reactie te gebruiken. Lees meer over de zoektool op het web.
WebSearchTool	Zoek op internet naar bronnen die met de prompt te maken hebben. Lees meer over de zoektool op het web.
WebSearchToolFilters	modelinterface WebSearchToolFilters
WeeklyRecurrenceSchedule	Wekelijks herhalingsschema.
WorkflowAgentDefinition	De definitie van de workflowagent.

Type-aliassen

AgentDefinitionUnion	Unietype voor alle definitietypen van agenten. Ondersteunt workflow-, gehoste, container-app en prompt-agents.
AgentKind	Definieert het type/type agent. Bepaalt welke agentdefinitiestructuur wordt gebruikt.
AgentProtocol	Soort agentProtocol
AgentType	Type of AgentType
AnnotationType	Type annotatieType
AnnotationUnion	Alias voor AnnotationUnion
ApplyPatchCallOutputStatusParam	Uitkomstwaarden gerapporteerd voor apply_patch tool-oproepoutputs.
ApplyPatchCallStatusParam	Statuswaarden gerapporteerd voor apply_patch tool-aanroepen.
ApplyPatchOperationParamType	Type van ApplyPatchOperationParamType
ApplyPatchOperationParamUnion	Alias voor ApplyPatchOperationParamUnion
AttackStrategy	Strategieën voor aanvallen.
AzureAISearchQueryType	Beschikbare querytypen voor Azure AI Search-tool.
BaseCredentialsUnion	Alias voor BaseCredentialsUnion
ClickButtonType	Type of ClickButtonType
ComparisonFilterValueItems	Alias voor ComparisonFilterValueItems
ComputerActionType	Type of ComputerActionType
ComputerActionUnion	Alias voor ComputerActionUnion
ComputerEnvironment	Type of ComputerEnvironment
ConnectionType	Het type (of categorie) van de verbinding
ContainerMemoryLimit	Type of ContainerMemoryLimit
ContinuablePage	Een interface die een pagina met resultaten beschrijft.
CredentialType	Het referentietype dat door de verbinding wordt gebruikt
CustomToolParamFormatType	Type of CustomToolParamFormatType
CustomToolParamFormatUnion	Alias voor CustomToolParamFormatUnion
DatasetType	Opsomming om het type gegevens te bepalen.
DatasetVersionUnion	Alias voor DatasetVersionUnion
DayOfWeek	Dagen van de week voor het herhalingsschema.
DeploymentType	Type implementatieType
DeploymentUnion	Alias voor DeploymentUnion
DetailEnum	Type of DetailEnum
EvaluationRuleActionType	Aard van de evaluatieactie.
EvaluationRuleActionUnion	Alias voor EvaluationRuleActionUnion
EvaluationRuleEventType	Type van de gebeurtenis van de evaluatieregel.
EvaluationTaxonomyInputType	Type van de taxonomie-invoer van de evaluatie.
EvaluationTaxonomyInputUnion	Alias voor evaluatieTaxonomieInputUnie
EvaluatorCategory	De categorie van de evaluator
EvaluatorDefinitionType	De definitie van het type beoordelaar
EvaluatorDefinitionUnion	Alias voor EvaluatorDefinitionUnion
EvaluatorMetricDirection	De richting van de metriek die aangeeft of een hogere waarde beter, een lagere waarde beter of neutraal is
EvaluatorMetricType	Het type van de evaluator
EvaluatorType	Het type van de evaluator
Filters	Alias voor filters
FoundryFeaturesOptInKeys	Type of FoundryFeaturesOptInKeys
FunctionAndCustomToolCallOutputType	Type of FunctionAndCustomToolCallOutputType
FunctionAndCustomToolCallOutputUnion	Alias for FunctionAndCustomToolCallOutputUnion
FunctionCallItemStatus	Type van FunctieCallItemStatus
FunctionShellCallItemStatus	Statuswaarden gerapporteerd voor shell-toolaanroepen.
FunctionShellCallOutputOutcomeParamType	Type FunctieShellCallOutputOutcomeParamType
FunctionShellCallOutputOutcomeParamUnion	Alias voor FunctionShellCallOutputOutcomeParamUnion
GrammarSyntax1	Type GrammaticaSyntax1
ImageDetail	Type AfbeeldingDetail
IndexType	Soort indexType
IndexUnion	Alias voor IndexUnion
InputContentType	Type of InputContentType
InputContentUnion	Alias voor InputContentUnion
InputFidelity	Bepaal hoeveel inspanning het model zal uitoefenen om overeen te komen met de stijl en kenmerken, met name gezichtskenmerken, van invoerafbeeldingen. Deze parameter wordt alleen ondersteund voor gpt-image-1. Niet ondersteund voor gpt-image-1-mini. Ondersteunt high en low. Standaardwaarde is low.
InputItemType	Type of InputItemType
InputItemUnion	Alias voor InputItemUnion
InsightRequestUnion	Alias voor InsightRequestUnion
InsightResultUnion	Alias voor InsightResultUnion
InsightSampleUnion	Alias voor InsightSampleUnion
InsightType	Het verzoek van de inzichten.
MCPToolCallStatus	Type van MCPToolCallStatus
MemoryItemKind	Soort geheugenitem.
MemoryItemUnion	Alias voor MemoryItemUnion
MemoryOperationKind	Soort geheugenwerking.
MemoryStoreDefinitionUnion	Alias voor MemoryStoreDefinitionUnion
MemoryStoreKind	Het type implementatie van de geheugenopslag dat moet worden gebruikt.
MemoryStoreType	Type van MemoryStoreType
MemoryStoreUpdateStatus	Status van een updatebewerking van het geheugen.
OpenApiAuthDetailsUnion	Alias voor OpenApiAuthDetailsUnion
OpenApiAuthType	Verificatietype voor OpenApi-eindpunt. Toegestane soorten zijn: Anoniem (geen authenticatie vereist) Project Connection (vereist project_connection_id naar het eindpunt, zoals ingesteld in AI Foundry) Managed_Identity (vereist publiek voor verificatie op basis van identiteit)
OperationState	Enum beschrijft de toegestane bewerkingstoestanden.
OutputMessageContentType	Type of OutputMessageContentType
OutputMessageContentUnion	Alias voor OutputMessageContentUnion
PageOrder	Type of PageOrder
PendingUploadType	Het type upload dat in afwachting is.
RankerVersionType	Type RankerVersieType
ReasoningEffort	Beperkingen voor redenering voor redeneringsmodellen. Momenteel ondersteunde waarden zijn none, , , minimal, lowmedium, en highxhigh. Het verminderen van redeneringsinspanningen kan leiden tot snellere antwoorden en minder tokens die worden gebruikt voor redenering in een antwoord. gpt-5.1 standaard op none, wat geen redeneren uitvoert. De ondersteunde redeneerwaarden voor gpt-5.1 zijn none, low, , mediumen high. Hulpprogramma-aanroepen worden ondersteund voor alle redeneringswaarden in gpt-5.1. Alle modellen vóór gpt-5.1 de standaard gebruiken medium redeneerinspanning, en ondersteunen nonegeen . Het gpt-5-pro model gebruikt standaard (en ondersteunt alleen) high redeneerinspanning. xhigh wordt ondersteund voor alle modellen na gpt-5.1-codex-max.
RecurrenceScheduleUnion	Alias voor RecurrenceScheduleUnion
RecurrenceType	Type herhaling.
RiskCategory	Risicocategorie voor het aanvalsdoel.
SampleType	Het type monster dat in de analyse wordt gebruikt.
ScheduleProvisioningStatus	Planningsstatus inplannen.
ScheduleTaskType	Type taak.
ScheduleTaskUnion	Alias voor ScheduleTaskUnion
SearchContextSize	Type zoekContextSize
TargetConfigUnion	Alias voor TargetConfigUnion
TargetUnion	Alias voor TargetUnion
TextResponseFormatConfigurationType	Type TekstAntwoordFormaatConfiguratieType
TextResponseFormatConfigurationUnion	Alias voor TextResponseFormatConfigurationUnion
ToolChoiceParamType	Type ToolKeuzeParamType
ToolChoiceParamUnion	Alias voor ToolChoiceParamUnion
ToolType	Type GereedschapType
ToolUnion	Alias voor ToolUnion
TreatmentEffectType	Type behandelingseffect.
TriggerType	Type van de trekker.
TriggerUnion	Alias voor TriggerUnion

Enums

KnownApiVersions

Microsoft Foundry API-versies

Functies

restorePoller<TResponse, TResult>(AIProjectClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Hiermee maakt u een poller op basis van de geserialiseerde status van een andere poller. Dit kan handig zijn als u pollers wilt maken op een andere host of een poller moet worden gemaakt nadat het oorspronkelijke poller niet binnen het bereik valt.

Functiedetails

restorePoller<TResponse, TResult>(AIProjectClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Hiermee maakt u een poller op basis van de geserialiseerde status van een andere poller. Dit kan handig zijn als u pollers wilt maken op een andere host of een poller moet worden gemaakt nadat het oorspronkelijke poller niet binnen het bereik valt.

function restorePoller<TResponse, TResult>(client: AIProjectClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client

AIProjectClient

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Retouren

PollerLike<OperationState<TResult>, TResult>