Freigeben über


@azure/ai-projects package

Klassen

AIProjectClient

bekommt den OpenAI-Client mit optionalen OpenAI-Client-Optionen

Schnittstellen

@azure/ai-projects.Index
A2APreviewTool

Ein Agent, der das A2A-Protokoll implementiert.

AIProjectClientOptionalParams

Optionale Parameter für den Client.

AISearchIndexResource

Eine AI Search Index-Ressource.

Agent

Model Interface Agent

AgentClusterInsightRequest

Einblicke in die Ergebnisse der Agentenbewertung

AgentClusterInsightResult

Erkenntnisse aus der Agent-Cluster-Analyse.

AgentDefinition

Basisdefinitionsschnittstelle für Agenten. Enthält die Agentenart und die optionale RAI-Konfiguration.

AgentTaxonomyInput

Eingabekonfiguration für die Auswertungstaxonomie, wenn der Eingabetyp Agent ist.

AgentVersion

Stellt eine bestimmte Version eines Agenten dar. Enthält Metadaten, Versionierung, Erstellungszeit und Agentendefinition.

AgenticIdentityPreviewCredentials

Definition der Anmeldeinformationen für die Agentenidentität

AgentsCreateAgentFromManifestOptionalParams

Optionale Parameter.

AgentsCreateAgentVersionFromManifestOptionalParams

Optionale Parameter.

AgentsCreateOptionalParams

Optionale Parameter.

AgentsCreateVersionOptionalParams

Optionale Parameter.

AgentsDeleteOptionalParams

Optionale Parameter.

AgentsDeleteVersionOptionalParams

Optionale Parameter.

AgentsGetOptionalParams

Optionale Parameter.

AgentsGetVersionOptionalParams

Optionale Parameter.

AgentsListOptionalParams

Optionale Parameter.

AgentsListVersionsOptionalParams

Optionale Parameter.

AgentsOperations

Schnittstelle, die die Operationen eines Agenten darstellt.

AgentsUpdateAgentFromManifestOptionalParams

Optionale Parameter.

AgentsUpdateOptionalParams

Optionale Parameter.

Annotation

Eine Anmerkung, die sich auf einen Bereich von Ausgabetext bezieht.

ApiErrorResponse

Fehlerantwort bei API-Fehlern.

ApiKeyCredentials

Definition der API-Schlüsselanmeldeinformationen

ApplyPatchCreateFileOperationParam

Anleitung zum Erstellen einer neuen Datei über das apply_patch-Tool.

ApplyPatchDeleteFileOperationParam

Anleitung zum Löschen einer bestehenden Datei über das apply_patch-Tool.

ApplyPatchOperationParam

Eine der create_file, delete_file oder update_file Operationen, die dem apply_patch Werkzeug zugeteilt werden.

ApplyPatchToolParam

Ermöglicht es dem Assistenten, Dateien mit einheitlichen Differenzen zu erstellen, zu löschen oder zu aktualisieren.

ApplyPatchUpdateFileOperationParam

Anleitung zum Aktualisieren einer bestehenden Datei über das apply_patch-Tool.

ApproximateLocation

Modellschnittstelle: ApproximateLocation

AzureAIAgentTarget

Stellt ein Ziel dar, das einen Azure AI-Agent angibt.

AzureAIModelTarget

Stellt ein Ziel dar, das ein Azure AI-Modell für Vorgänge angibt, die eine Modellauswahl erfordern.

AzureAISearchIndex

Definition des Azure AI Search-Indexes

AzureAISearchTool

Die Eingabedefinitionsinformationen für ein Azure AI-Suchtool, das zum Konfigurieren eines Agents verwendet wird.

AzureAISearchToolResource

Eine Reihe von Indexressourcen, die vom tool azure_ai_search verwendet werden.

AzureFunctionBinding

Die Struktur zum Beibehalten des Namens und des URI der Speicherwarteschlange.

AzureFunctionDefinition

Die Definition der Azure-Funktion.

AzureFunctionStorageQueue

Die Struktur zum Beibehalten des Namens und des URI der Speicherwarteschlange.

AzureFunctionTool

Die Eingabedefinitionsinformationen für ein Azure-Funktionstool, wie sie zum Konfigurieren eines Agents verwendet werden.

AzureOpenAIModelConfiguration

Konfiguration des Azure OpenAI-Modells. Die API-Version wird vom Dienst für die Abfrage des Modells ausgewählt.

BaseCredentials

Eine Basisklasse für Verbindungsanmeldeinformationen

BetaEvaluationTaxonomiesCreateOptionalParams

Optionale Parameter.

BetaEvaluationTaxonomiesDeleteOptionalParams

Optionale Parameter.

BetaEvaluationTaxonomiesGetOptionalParams

Optionale Parameter.

BetaEvaluationTaxonomiesListOptionalParams

Optionale Parameter.

BetaEvaluationTaxonomiesOperations

Schnittstelle, die eine BetaEvaluationTaxonomies-Operation darstellt.

BetaEvaluationTaxonomiesUpdateOptionalParams

Optionale Parameter.

BetaEvaluatorsCreateVersionOptionalParams

Optionale Parameter.

BetaEvaluatorsDeleteVersionOptionalParams

Optionale Parameter.

BetaEvaluatorsGetVersionOptionalParams

Optionale Parameter.

BetaEvaluatorsListLatestVersionsOptionalParams

Optionale Parameter.

BetaEvaluatorsListVersionsOptionalParams

Optionale Parameter.

BetaEvaluatorsOperations

Schnittstelle stellt die Operationen eines BetaEvaluators dar.

BetaEvaluatorsUpdateVersionOptionalParams

Optionale Parameter.

BetaInsightsGenerateOptionalParams

Optionale Parameter.

BetaInsightsGetOptionalParams

Optionale Parameter.

BetaInsightsListOptionalParams

Optionale Parameter.

BetaInsightsOperations

Schnittstelle stellt eine BetaInsights-Operation dar.

BetaMemoryStoresCreateOptionalParams

Optionale Parameter.

BetaMemoryStoresDeleteOptionalParams

Optionale Parameter.

BetaMemoryStoresDeleteScopeOptionalParams

Optionale Parameter.

BetaMemoryStoresGetOptionalParams

Optionale Parameter.

BetaMemoryStoresGetUpdateResultOptionalParams

Optionale Parameter.

BetaMemoryStoresListOptionalParams

Optionale Parameter.

BetaMemoryStoresOperations

Schnittstelle stellt BetaMemoryStores-Operationen dar.

BetaMemoryStoresSearchMemoriesOptionalParams

Optionale Parameter.

BetaMemoryStoresUpdateMemoriesOptionalParams

Optionale Parameter.

BetaMemoryStoresUpdateOptionalParams

Optionale Parameter.

BetaOperations

Schnittstelle, die eine Beta-Operation darstellt.

BetaRedTeamsCreateOptionalParams

Optionale Parameter.

BetaRedTeamsGetOptionalParams

Optionale Parameter.

BetaRedTeamsListOptionalParams

Optionale Parameter.

BetaRedTeamsOperations

Schnittstelle stellt die Operationen von BetaRedTeams dar.

BetaSchedulesCreateOrUpdateOptionalParams

Optionale Parameter.

BetaSchedulesDeleteOptionalParams

Optionale Parameter.

BetaSchedulesGetOptionalParams

Optionale Parameter.

BetaSchedulesGetRunOptionalParams

Optionale Parameter.

BetaSchedulesListOptionalParams

Optionale Parameter.

BetaSchedulesListRunsOptionalParams

Optionale Parameter.

BetaSchedulesOperations

Schnittstelle, die eine BetaSchedules-Operation darstellt.

BingCustomSearchConfiguration

Eine benutzerdefinierte Bing-Suchkonfiguration.

BingCustomSearchPreviewTool

Die Eingabedefinitionsinformationen für ein benutzerdefiniertes Bing-Suchtool, die zum Konfigurieren eines Agents verwendet werden.

BingCustomSearchToolParameters

Die Parameter des benutzerdefinierten Bing-Suchwerkzeugs.

BingGroundingSearchConfiguration

Suchkonfiguration für Bing-Erdung

BingGroundingSearchToolParameters

Die Parameter des Suchwerkzeugs für die Bing-Erdung.

BingGroundingTool

Die Eingabedefinitionsinformationen für ein Bing-Grounding-Suchtool, wie zum Konfigurieren eines Agents verwendet.

BlobReference

Details zum Blobverweis.

BrowserAutomationPreviewTool

Die Eingabedefinitionsinformationen für ein Browser-Automatisierungstool, wie sie zum Konfigurieren eines Agenten verwendet werden.

BrowserAutomationToolConnectionParameters

Definition der Eingabeparameter für die Verbindung, die vom Browser Automation Tool verwendet wird.

BrowserAutomationToolParameters

Definition von Eingabeparametern für das Browser Automation Tool.

CaptureStructuredOutputsTool

Ein Tool zum Erfassen strukturierter Ausgaben

ChartCoordinate

Koordinaten für das Analysediagramm.

ChatSummaryMemoryItem

Ein Speicherelement, das eine Zusammenfassung enthält, die aus Unterhaltungen extrahiert wurde.

ClickParam

Ein Klickvorgang.

ClusterInsightResult

Erkenntnisse aus der Clusteranalyse.

ClusterTokenUsage

Token-Nutzung für die Cluster-Analyse

CodeBasedEvaluatorDefinition

Codebasierte Evaluatordefinition mit Python-Code

CodeInterpreterContainerAuto

Konfiguration für einen Codedolmetschercontainer. Geben Sie optional die IDs der Dateien an, für die der Code ausgeführt werden soll.

CodeInterpreterOutputImage

Die Bildausgabe des Code-Interpreters.

CodeInterpreterOutputLogs

Die Protokollausgabe aus dem Code-Interpreter.

CodeInterpreterTool

Ein Tool, das Python-Code ausführt, um eine Antwort auf eine Eingabeaufforderung zu generieren.

ComparisonFilter

Ein Filter zum Vergleichen eines angegebenen Attributschlüssels mit einem bestimmten Wert mithilfe eines definierten Vergleichsvorgangs.

CompoundFilter

Kombinieren mehrerer Filter mit and oder or.

ComputerAction

Modellschnittstelle ComputerAction

ComputerCallSafetyCheckParam

Eine ausstehende Sicherheitsüberprüfung für den Computertelefonanruf.

ComputerScreenshotImage

Ein Screenshotbild des Computers, das mit dem Computerverwendungstool verwendet wird.

ComputerUsePreviewTool

Ein Tool, das einen virtuellen Computer steuert. Erfahren Sie mehr über das Computertool.

Connection

Antwort aus der Liste und Vorgänge zum Abrufen von Verbindungen

ConnectionsGetOptionalParams

Optionale Parameter.

ConnectionsGetWithCredentialsOptionalParams

Optionale Parameter.

ConnectionsListOptionalParams

Optionale Parameter.

ConnectionsOperations

Schnittstelle, die eine Connections-Operation darstellt.

ContainerAppAgentDefinition

Die Definition des Container-App-Agents.

ContainerFileCitationBody

Eine Zitation für eine Containerdatei, die zur Generierung einer Modellantwort verwendet wird.

ContinuousEvaluationRuleAction

Auswertungsregelaktion für die kontinuierliche Auswertung.

CosmosDBIndex

Definition des CosmosDB-Vektorspeicher-Index

CronTrigger

Cron-basierter Trigger.

CustomCredential

Definition von benutzerdefinierten Anmeldeinformationen

CustomGrammarFormatParam

Eine vom Benutzer definierte Grammatik.

CustomTextFormatParam

Uneingeschränkter freier Text.

CustomToolParam

Ein benutzerdefiniertes Tool, das Eingaben in einem festgelegten Format verarbeitet. Erfahren Sie mehr über benutzerdefinierte Werkzeuge

CustomToolParamFormat

Das Eingabeformat für das benutzerdefinierte Tool. Standard ist uneingeschränkter Text.

DailyRecurrenceSchedule

Täglicher Wiederholungsplan.

DatasetCredential

Stellt einen Verweis auf ein Blob für die Nutzung dar

DatasetUploadOptions

Optionen zum Hochladen von Datensätzen

DatasetVersion

DatasetVersion-Definition

DatasetsCreateOrUpdateOptionalParams

Optionale Parameter.

DatasetsDeleteOptionalParams

Optionale Parameter.

DatasetsGetCredentialsOptionalParams

Optionale Parameter.

DatasetsGetOptionalParams

Optionale Parameter.

DatasetsListOptionalParams

Optionale Parameter.

DatasetsListVersionsOptionalParams

Optionale Parameter.

DatasetsOperations

Schnittstelle, die eine Datasets-Operation darstellt.

DatasetsPendingUploadOptionalParams

Optionale Parameter.

DeleteAgentResponse

Ein gelöschtes Agent-Objekt

DeleteAgentVersionResponse

Ein gelöschter Agent Version Objekt

DeleteMemoryStoreResponse

Modellschnittstelle DeleteMemoryStoreResponse

Deployment

Definition der Modellbereitstellung

DeploymentsGetOptionalParams

Optionale Parameter.

DeploymentsListOptionalParams

Optionale Parameter.

DeploymentsOperations

Schnittstelle, die einen Bereitstellungsvorgang darstellt.

DoubleClickAction

Eine Doppelklickaktion

Drag

Eine Ziehaktion

DragPoint

Ein x/y-Koordinatenpaar, z. B. { x: 100, y: 200 }.

EasyInputMessage

Meldungseingabe für das Modell mit einer Rolle für die Anweisung, gefolgt von der Hierarchie Anweisungen, die mit der developer Rolle angegeben werden, system haben Vorrang vor Anweisungen, die mit der user Rolle angegeben werden. Nachrichten mit der assistant Rolle werden davon ausgegangen, dass sie vom Modell in früheren Interaktionen generiert wurden.

EmbeddingConfiguration

Einbetten der Konfigurationsklasse

EntraIDCredentials

Definition der Entra ID-Anmeldeinformationen

ErrorModel

Modellschnittstellen-Fehlermodell

EvalResult

Ergebnis der Bewertung.

EvalRunResultCompareItem

Metrikvergleich für eine Behandlung mit dem Ausgangswert.

EvalRunResultComparison

Die Vergleichsergebnisse für die Behandlung werden mit dem Ausgangswert verglichen.

EvalRunResultSummary

Zusammenfassende Statistik einer Metrik in einem Auswertungslauf.

EvaluationComparisonInsightRequest

Anfrage zum Evaluierungsvergleich

EvaluationComparisonInsightResult

Erkenntnisse aus dem Bewertungsvergleich.

EvaluationResultSample

Ein Auszug aus dem Auswertungsergebnis.

EvaluationRule

Modell für Auswertungsregeln.

EvaluationRuleAction

Evaluierungs-Aktionsmodell.

EvaluationRuleFilter

Modell des Auswertungsfilters.

EvaluationRulesCreateOrUpdateOptionalParams

Optionale Parameter.

EvaluationRulesDeleteOptionalParams

Optionale Parameter.

EvaluationRulesGetOptionalParams

Optionale Parameter.

EvaluationRulesListOptionalParams

Optionale Parameter.

EvaluationRulesOperations

Schnittstelle, die einen EvaluationRules-Vorgang darstellt.

EvaluationRunClusterInsightRequest

Einblicke in die Evaluierungsergebnisse

EvaluationRunClusterInsightResult

Erkenntnisse aus der Cluster-Analyse des Evaluierungslaufs.

EvaluationScheduleTask

Auswertungsaufgabe für den Zeitplan.

EvaluationTaxonomy

Definition der Evaluierungstaxonomie

EvaluationTaxonomyInput

Eingabekonfiguration für die Auswertungstaxonomie.

EvaluatorDefinition

Konfiguration des Basisauswerters mit Diskriminator

EvaluatorMetric

Evaluator-Metrik

EvaluatorVersion

Definition des Evaluators

FabricDataAgentToolParameters

Die Parameter des Werkzeugs für den Fabric-Datenagenten.

FieldMapping

Konfigurationsklasse für die Feldzuordnung

FileCitationBody

Ein Verweis auf eine Datei.

FileDatasetVersion

FileDatasetVersion-Definition

FilePath

Ein Pfad zu einer Datei.

FileSearchTool

Ein Tool, das nach relevanten Inhalten aus hochgeladenen Dateien sucht. Erfahren Sie mehr über das Dateisuchwerkzeug.

FileSearchToolCallResults

Modellschnittstellen FileSearchToolCallResults

FolderDatasetVersion

FileDatasetVersion-Definition

FunctionAndCustomToolCallOutput

Modellschnittstellen-FunktionAndCustomToolCallOutput

FunctionAndCustomToolCallOutputInputFileContent

Eine Dateieingabe für das Modell.

FunctionAndCustomToolCallOutputInputImageContent

Eine Bildeingabe für das Modell. Erfahren Sie mehr über Bildeingaben.

FunctionAndCustomToolCallOutputInputTextContent

Eine Texteingabe für das Modell.

FunctionShellActionParam

Befehle und Limits beschreiben, wie der Shell-Tool-Aufruf ausgeführt wird.

FunctionShellCallOutputContentParam

Stdout und Stderr wurden für einen Teil eines Shell-Werkzeugaufrufs erfasst.

FunctionShellCallOutputExitOutcomeParam

Zeigt an, dass die Shell-Befehle abgeschlossen sind und einen Exit-Code zurückgegeben haben.

FunctionShellCallOutputOutcomeParam

Das Ausstiegs- oder Timeout-Ergebnis dieses Shell-Calls.

FunctionShellCallOutputTimeoutOutcomeParam

Zeigt an, dass der Shell-Aufruf das konfigurierte Zeitlimit überschritten hat.

FunctionShellToolParam

Ein Werkzeug, das es dem Modell ermöglicht, Shell-Befehle auszuführen.

FunctionTool

Definiert eine Funktion in Ihrem eigenen Code, die das Modell aufrufen kann. Erfahren Sie mehr über den Funktionsaufruf.

HostedAgentDefinition

Die Definition des gehosteten Agents.

HourlyRecurrenceSchedule

Stündlicher Wiederholungsplan.

HumanEvaluationPreviewRuleAction

Auswertungsregelaktion für die menschliche Auswertung.

HybridSearchOptions

Modellschnittstelle HybridSearchOptions

ImageGenTool

Ein Tool, das Bilder mithilfe der GPT-Bildmodelle generiert.

ImageGenToolInputImageMask

Modellschnittstelle: ImageGenToolInputImageMask.

IndexesCreateOrUpdateOptionalParams

Optionale Parameter.

IndexesDeleteOptionalParams

Optionale Parameter.

IndexesGetOptionalParams

Optionale Parameter.

IndexesListOptionalParams

Optionale Parameter.

IndexesListVersionsOptionalParams

Optionale Parameter.

IndexesOperations

Schnittstelle, die eine Indexes-Operation darstellt.

InputContent

Modellschnittstellen InputContent

InputContentInputFileContent

Eine Dateieingabe für das Modell.

InputContentInputImageContent

Eine Bildeingabe für das Modell. Erfahren Sie mehr über Bildeingaben.

InputContentInputTextContent

Eine Texteingabe für das Modell.

InputFileContentParam

Eine Dateieingabe für das Modell.

InputImageContentParamAutoParam

Eine Bildeingabe für das Modell. Erfahren Sie mehr über Bildeingaben

InputItem

Ein Element, das einen Teil des Kontexts darstellt, damit die Antwort vom Modell generiert wird. Kann Text-, Bild- und Audioeingaben sowie frühere Antworten des Assistenten und Die Ausgabe von Toolanrufen enthalten.

InputItemApplyPatchToolCallItemParam

Ein Werkzeugaufruf, der eine Anfrage darstellt, Dateien mit verschiedenen Patches zu erstellen, zu löschen oder zu aktualisieren.

InputItemApplyPatchToolCallOutputItemParam

Die gestreamte Ausgabe, die durch einen Apply-Patch-Tool-Aufruf ausgesendet wird.

InputItemCodeInterpreterToolCall

Ein Toolaufruf zum Ausführen von Code.

InputItemCompactionSummaryItemParam

Ein von der v1/responses/compact API generiertes Kompaktionselement.

InputItemComputerCallOutputItemParam

Die Ausgabe eines Computertoolaufrufs

InputItemComputerToolCall

Ein Toolaufruf eines von einem Computer verwendeten Tools Weitere Informationen finden Sie im Handbuch zur Computerbenutzung .

InputItemCustomToolCall

Ein Aufruf eines benutzerdefinierten Tools, das vom Modell erstellt wurde.

InputItemCustomToolCallOutput

Die Ausgabe eines benutzerdefinierten Werkzeugaufrufs aus deinem Code, der an das Modell zurückgesendet wird.

InputItemFileSearchToolCall

Die Ergebnisse eines Dateisuchtoolaufrufs. Weitere Informationen finden Sie in der Anleitung zur Dateisuche .

InputItemFunctionCallOutputItemParam

Die Ausgabe eines Funktionstoolaufrufs

InputItemFunctionShellCallItemParam

Ein Werkzeug, das eine Anfrage zur Ausführung eines oder mehrerer Shell-Befehle darstellt.

InputItemFunctionShellCallOutputItemParam

Die gestreamten Ausgabeobjekte, die von einem Shell-Tool ausgesendet werden.

InputItemFunctionToolCall

Ein Toolaufruf zum Ausführen einer Funktion. Weitere Informationen finden Sie in der Funktionsaufrufanleitung.

InputItemImageGenToolCall

Eine Vom Modell vorgenommene Anforderung zur Bildgenerierung.

InputItemLocalShellToolCall

Ein Toolaufruf zum Ausführen eines Befehls auf der lokalen Shell.

InputItemLocalShellToolCallOutput

Die Ausgabe eines Aufrufs eines lokalen Shelltools.

InputItemMcpApprovalRequest

Eine Anforderung für menschliche Genehmigung eines Toolaufrufs.

InputItemMcpApprovalResponse

Eine Antwort auf eine MCP-Genehmigungsanforderung.

InputItemMcpListTools

Eine Liste der auf einem MCP-Server verfügbaren Tools.

InputItemMcpToolCall

Ein Aufruf eines Tools auf einem MCP-Server.

InputItemOutputMessage

Eine Ausgabemeldung aus dem Modell.

InputItemReasoningItem

Eine Beschreibung der Gedankenkette, die von einem Begründungsmodell beim Generieren einer Antwort verwendet wird. Stellen Sie sicher, dass Sie diese Elemente in Ihre input Responses-API für spätere Runden eines Gesprächs aufnehmen, wenn Sie den Kontext manuell verwalten.

InputItemWebSearchToolCall

Die Ergebnisse eines Aufrufs eines Websuchwerkzeugs. Weitere Informationen finden Sie in der Anleitung zur Websuche .

InputTextContentParam

Eine Texteingabe für das Modell.

Insight

Der Antworttext für Cluster Insights.

InsightCluster

Ein Cluster von Analyseproben.

InsightModelConfiguration

Konfiguration des Modells, das bei der Generierung von Erkenntnissen verwendet wird.

InsightRequest

Die Anforderung des Insights-Berichts.

InsightResult

Das Ergebnis der Erkenntnisse.

InsightSample

Eine Probe aus der Analyse.

InsightScheduleTask

Insight-Aufgabe für den Zeitplan.

InsightSummary

Zusammenfassung der Fehlerclusteranalyse.

InsightsMetadata

Metadaten zu den Erkenntnissen.

ItemReferenceParam

Ein interner Bezeichner für ein Element, auf das verwiesen werden soll.

KeyPressAction

Eine Sammlung von Tastendrücken, die das Modell ausführen möchte.

LocalShellExecAction

Führen Sie einen Shellbefehl auf dem Server aus.

LocalShellToolParam

Ein Tool, mit dem das Modell Shellbefehle in einer lokalen Umgebung ausführen kann.

LogProb

Die Protokollwahrscheinlichkeit eines Tokens.

MCPListToolsTool

Ein Tool, das auf einem MCP-Server verfügbar ist.

MCPListToolsToolAnnotations

Modellschnittstelle: MCPListToolsToolAnnotations

MCPListToolsToolInputSchema

Modellschnittstelle MCPListToolsToolInputSchema

MCPTool

Gewähren Sie dem Modell Zugriff auf zusätzliche Tools über MCP-Server (Remote Model Context Protocol). Erfahren Sie mehr über MCP.

MCPToolFilter

Ein Filterobjekt, um anzugeben, welche Werkzeuge erlaubt sind.

MCPToolRequireApproval

Modellschnittstelle MCPToolRequireApproval

ManagedAzureAISearchIndex

Definition des Managed Azure AI Search-Index

MemoryItem

Ein einzelnes Speicherelement, das im Speicherspeicher gespeichert ist und Inhalte und Metadaten enthält.

MemoryOperation

Stellt einen einzelnen Speichervorgang (Erstellen, Aktualisieren oder Löschen) dar, der für ein Speicherelement ausgeführt wird.

MemorySearchItem

Ein aus der Speichersuche abgerufenes Speicherelement.

MemorySearchOptions

Optionen für die Speichersuche.

MemorySearchPreviewTool

Ein Werkzeug zur Integration von Erinnerungen in den Agenten.

MemoryStore

Ein Speicher, der Benutzerspeicher speichern und abrufen kann.

MemoryStoreDefaultDefinition

Standardimplementierung des Arbeitsspeichers.

MemoryStoreDefaultOptions

Standardkonfigurationen für Speicherspeicher.

MemoryStoreDefinition

Basisdefinition für Speicherspeicherkonfigurationen.

MemoryStoreDeleteScopeResponse

Antwort für das Löschen von Erinnerungen aus einem Bereich.

MemoryStoreOperationUsage

Verwendungsstatistiken eines Speichervorgangs.

MemoryStoreSearchResponse

Antwort auf die Speichersuche.

MemoryStoreUpdateCompletedResult

Ergebnis der Speicheraktualisierung.

MemoryStoreUpdateResponse

Stellt den Status eines Aktualisierungsvorgangs für den Arbeitsspeicher bereit.

MicrosoftFabricPreviewTool

Die Eingabedefinitionsinformationen für ein Microsoft Fabric-Tool, das zum Konfigurieren eines Agents verwendet wird.

ModelDeployment

Definition der Modellbereitstellung

ModelDeploymentSku

Sku-Informationen

ModelSamplingParams

Stellt eine Reihe von Parametern dar, die zum Steuern des Samplingverhaltens eines Sprachmodells während der Textgenerierung verwendet werden.

MonthlyRecurrenceSchedule

Monatlicher Wiederholungsplan.

Move

Aktion zur Änderung der Mauszeigerposition

NoAuthenticationCredentials

Anmeldeinformationen, für die keine Authentifizierung erforderlich ist

OneTimeTrigger

Einmaliger Auslöser.

OpenApiAnonymousAuthDetails

Sicherheitsdetails für die anonyme OpenApi-Authentifizierung

OpenApiAuthDetails

Authentifizierungsdetails für OpenApiFunctionDefinition

OpenApiFunctionDefinition

Die Eingabedefinitionsinformationen für eine openapi-Funktion.

OpenApiManagedAuthDetails

Sicherheitsdetails für die OpenApi-managed_identity-Authentifizierung

OpenApiManagedSecurityScheme

Sicherheitsschema für die OpenApi-managed_identity-Authentifizierung

OpenApiProjectConnectionAuthDetails

Sicherheitsdetails für die Authentifizierung von OpenApi-Projektverbindungen

OpenApiProjectConnectionSecurityScheme

Sicherheitsschema für die OpenApi-managed_identity-Authentifizierung

OpenApiTool

Die Eingabedefinitionsinformationen für ein OpenAPI-Tool, das zum Konfigurieren eines Agents verwendet wird.

OutputMessageContent

Modellschnittstelle OutputMessageContent

OutputMessageContentOutputTextContent

Eine Textausgabe aus dem Modell.

OutputMessageContentRefusalContent

Eine Ablehnung des Modells

PageSettings

Optionen für die byPage-Methode

PagedAsyncIterableIterator

Eine Schnittstelle, die eine asynchrone iterierbare Iteration sowohl zum Abschluss als auch nach Seite ermöglicht.

PendingUploadRequest

Stellt eine Anforderung für einen ausstehenden Upload dar.

PendingUploadResponse

Stellt die Antwort auf eine ausstehende Uploadanforderung dar

PromptAgentDefinition

Die Definition des Eingabeaufforderungs-Agents

PromptAgentDefinitionTextOptions

Konfigurationsoptionen für eine Textantwort aus dem Modell. Kann Nur-Text- oder strukturierte JSON-Daten sein.

PromptBasedEvaluatorDefinition

Eingabeaufforderungsbasierter Evaluator

ProtocolVersionRecord

Ein Datensatz-Mapping für ein einzelnes Protokoll und seine Version.

RaiConfig

Konfiguration für die Inhaltsfilterung und Sicherheitsfunktionen von Responsible AI (RAI).

RankingOptions

Model Interface RankingOptions

Reasoning

Nur GPT-5 und O-Serie Modelle Konfigurationsoptionen für Schlussfolgermodelle.

ReasoningTextContent

Argumentationstext aus dem Modell.

RecurrenceSchedule

Modell des Wiederholungszeitplans.

RecurrenceTrigger

Wiederholungsbasierter Trigger.

RedTeam

Details zum roten Team.

ResponseUsageInputTokensDetails

ModellschnittstellenAntwortNutzungEingabeTokensDetails

ResponseUsageOutputTokensDetails

Modellschnittstelle ResponseUsageOutputTokensDetails

RestorePollerOptions
SASTokenCredentials

Definition der SAS-Anmeldeinformationen (Shared Access Signature)

SasCredential

Definition der SAS-Anmeldeinformationen

Schedule

Modell planen.

ScheduleRun

Planen des Ausführungsmodells.

ScheduleTask

Aufgabenmodell planen.

Screenshot

Screenshotaktion

Scroll

Eine Scrollaktion

SharepointGroundingToolParameters

Die Parameter des Sharepoint-Erdungstools.

SharepointPreviewTool

Die Eingabedefinitionsinformationen für ein SharePoint-Tool, wie zum Konfigurieren eines Agents verwendet.

SpecificApplyPatchParam

Erzwingt das Modell, das apply_patch Tool aufzurufen, wenn ein Toolaufruf ausgeführt wird.

SpecificFunctionShellParam

Erzwingt das Modell, das Shelltool aufzurufen, wenn ein Toolaufruf erforderlich ist.

StructuredInputDefinition

Eine strukturierte Eingabe, die an der Ersetzung von Eingabeaufforderungsvorlagen und der Bindung von Werkzeugargumenten teilnehmen kann.

StructuredOutputDefinition

Eine strukturierte Ausgabe, die vom Agenten erzeugt werden kann.

Summary

Ein Zusammenfassungstext des Modells.

Target

Basisklasse für Ziele mit Diskriminatorunterstützung.

TargetConfig

Abstrakte Klasse für die Zielkonfiguration.

TaxonomyCategory

Definition der Taxonomie-Kategorie.

TaxonomySubCategory

Definition der Taxonomie-Unterkategorie.

TelemetryOperations

Schnittstelle, die Telemetrieoperationen repräsentiert

TextResponseFormatConfiguration

Ein Objekt, das das Format angibt, das das Modell ausgeben muss. Das Konfigurieren von { "type": "json_schema" } stellt strukturierte Ausgaben, die garantieren, dass das Modell Ihrem bereitgestellten JSON-Schema entspricht, sicher. Weitere Informationen finden Sie in der Anleitung „Strukturierte Ausgaben“. Das Standardformat ist { "type": "text" } ohne zusätzliche Optionen verfügbar. Nicht empfohlen für GPT-4o und neuere Modelle:* Einstellung aktiviert den { "type": "json_object" } älteren JSON-Modus, der sicherstellt, dass die vom Modell erzeugte Nachricht gültig JSON ist. Die Verwendung json_schema wird für Modelle bevorzugt, die sie unterstützen.

TextResponseFormatConfigurationResponseFormatJsonObject

JSON-Objektantwortformat. Eine ältere Methode zum Generieren von JSON-Antworten. Die Verwendung json_schema wird für Modelle empfohlen, die sie unterstützen. Beachten Sie, dass das Modell keine JSON ohne System- oder Benutzermeldung generiert, in der es dazu angewiesen wird.

TextResponseFormatConfigurationResponseFormatText

Standardantwortformat. Wird verwendet, um Textantworten zu generieren.

TextResponseFormatJsonSchema

JSON-Schemaantwortformat. Wird verwendet, um strukturierte JSON-Antworten zu generieren. Weitere Informationen zu Strukturierten Ausgaben.

Tool

Ein Tool, das zum Generieren einer Antwort verwendet werden kann.

ToolChoiceAllowed

Beschränkt die tools, die für das Modell verfügbar sind, auf einen vordefinierten Satz.

ToolChoiceCodeInterpreter

Gibt an, dass das Modell ein integriertes Tool zum Generieren einer Antwort verwenden soll. Erfahren Sie mehr über integrierte Tools.

ToolChoiceComputerUsePreview

Gibt an, dass das Modell ein integriertes Tool zum Generieren einer Antwort verwenden soll. Erfahren Sie mehr über integrierte Tools.

ToolChoiceCustom

Verwenden Sie diese Option, um zu erzwingen, dass das Modell ein bestimmtes benutzerdefiniertes Tool aufruft.

ToolChoiceFileSearch

Gibt an, dass das Modell ein integriertes Tool zum Generieren einer Antwort verwenden soll. Erfahren Sie mehr über integrierte Tools.

ToolChoiceFunction

Verwenden Sie diese Option, um zu erzwingen, dass das Modell eine bestimmte Funktion aufruft.

ToolChoiceImageGeneration

Gibt an, dass das Modell ein integriertes Tool zum Generieren einer Antwort verwenden soll. Erfahren Sie mehr über integrierte Tools.

ToolChoiceMCP

Verwenden Sie diese Option, um zu erzwingen, dass das Modell ein bestimmtes Tool auf einem Remote-MCP-Server aufruft.

ToolChoiceParam

Wie das Modell auswählen soll, welches Tool (oder welche Tools) beim Generieren einer Antwort verwendet werden soll. Sehen Sie sich den tools Parameter an, um zu sehen, wie Sie angeben, welche Tools das Modell aufrufen kann.

ToolChoiceWebSearchPreview

Gibt an, dass das Modell ein integriertes Tool zum Generieren einer Antwort verwenden soll. Erfahren Sie mehr über integrierte Tools.

ToolChoiceWebSearchPreview20250311

Gibt an, dass das Modell ein integriertes Tool zum Generieren einer Antwort verwenden soll. Erfahren Sie mehr über integrierte Tools.

ToolDescription

Beschreibung eines Werkzeugs, das von einem Agenten verwendet werden kann.

ToolProjectConnection

Eine Projektverbindungsressource.

TopLogProb

Die oberste Protokollwahrscheinlichkeit eines Tokens.

Trigger

Basismodell für Trigger des Zeitplans.

Type

Eine Aktion zum Eingeben von Text.

UrlCitationBody

Ein Zitat für eine Webressource, das zum Generieren einer Modellantwort verwendet wird.

UserProfileMemoryItem

Ein Speicherelement, das speziell Benutzerprofilinformationen enthält, die aus Unterhaltungen extrahiert wurden, z. B. Vorlieben, Interessen und persönliche Details.

VectorStoreFileAttributes

16 Schlüssel-Wert-Paare, die an ein Objekt angefügt werden können. Dies kann hilfreich sein, um zusätzliche Informationen zum Objekt in einem strukturierten Format zu speichern und Objekte über DIE API oder das Dashboard abzufragen. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit einer maximalen Länge von 512 Zeichen, Booleanen oder Zahlen.

Wait

Eine Warteaktion.

WebSearchActionFind

Aktionstyp „find“: Sucht innerhalb einer geladenen Seite nach einem Muster.

WebSearchActionOpenPage

Aktionstyp „open_page“ – Öffnet eine bestimmte URL aus Suchergebnissen.

WebSearchActionSearch

Aktionstyp „search“ – Führt eine Websuchabfrage aus.

WebSearchActionSearchSources

Modellschnittstelle WebSearchActionSearchSources

WebSearchApproximateLocation

Der ungefähre Standort des Nutzers.

WebSearchConfiguration

Eine Websuchkonfiguration für Bing Custom Search

WebSearchPreviewTool

Dieses Tool durchsucht im Web nach relevanten Ergebnissen, die in einer Antwort verwendet werden können. Erfahren Sie mehr über das Web-Suchwerkzeug.

WebSearchTool

Suchen Sie im Internet nach Quellen, die mit dem Prompt zu tun haben. Erfahren Sie mehr über das Web-Suchwerkzeug.

WebSearchToolFilters

Modelloberfläche WebSearchToolFilters

WeeklyRecurrenceSchedule

Wöchentlicher Wiederholungsplan.

WorkflowAgentDefinition

Die Definition des Workflow-Agents.

Typaliase

AgentDefinitionUnion

Vereinigungstyp für alle Agentendefinitionstypen. Unterstützt Workflow-, gehostete, Container-App- und Eingabeaufforderungs-Agents.

AgentKind

Definiert den Typ/die Art des Agenten. Legt fest, welche Agentendefinitionsstruktur verwendet wird.

AgentProtocol

Typ des AgentProtocol

AgentType

Typ des AgentTyps

AnnotationType

Typ der AnmerkungTyp

AnnotationUnion

Alias für AnnotationUnion

ApplyPatchCallOutputStatusParam

Ergebniswerte, die für apply_patch Werkzeugaufruf-Ausgaben gemeldet werden.

ApplyPatchCallStatusParam

Statuswerte werden für apply_patch Tool-Aufrufe gemeldet.

ApplyPatchOperationParamType

Art von ApplyPatchOperationParamType

ApplyPatchOperationParamUnion

Alias für ApplyPatchOperationParamUnion

AttackStrategy

Strategien für Angriffe.

AzureAISearchQueryType

Verfügbare Abfragetypen für das Azure AI Search-Tool.

BaseCredentialsUnion

Alias für BaseCredentialsUnion

ClickButtonType

Art von ClickButtonType

ComparisonFilterValueItems

Alias für ComparisonFilterValueItems

ComputerActionType

Typ von ComputerActionType

ComputerActionUnion

Alias für ComputerActionUnion

ComputerEnvironment

Typ von ComputerEnvironment

ConnectionType

Der Typ (oder die Kategorie) der Verbindung

ContainerMemoryLimit

Typ von ContainerMemoryLimit

ContinuablePage

Eine Schnittstelle, die eine Seite mit Ergebnissen beschreibt.

CredentialType

Der von der Verbindung verwendete Anmeldeinformationstyp

CustomToolParamFormatType

Typ von CustomToolParamFormatType

CustomToolParamFormatUnion

Alias für CustomToolParamFormatUnion

DatasetType

Aufzählung, um den Datentyp zu bestimmen.

DatasetVersionUnion

Alias für DatasetVersionUnion

DayOfWeek

Wochentage für den Wiederholungsplan.

DeploymentType

Art der BereitstellungTyp

DeploymentUnion

Alias für DeploymentUnion

DetailEnum

Art von DetailEnum

EvaluationRuleActionType

Art der Evaluierungsmaßnahme.

EvaluationRuleActionUnion

Alias für EvaluationRuleActionUnion

EvaluationRuleEventType

Typ des Auswertungsregelereignisses.

EvaluationTaxonomyInputType

Typ der Eingabe der Auswertungstaxonomie.

EvaluationTaxonomyInputUnion

Alias für die AuswertungTaxonomyInputUnion

EvaluatorCategory

Die Kategorie des Bewerters

EvaluatorDefinitionType

Der Typ der Definition des Evaluators

EvaluatorDefinitionUnion

Alias für EvaluatorDefinitionUnion

EvaluatorMetricDirection

Die Richtung der Metrik, die angibt, ob ein höherer Wert besser, ein niedrigerer Wert besser oder neutral ist

EvaluatorMetricType

Der Typ des Evaluators

EvaluatorType

Der Typ des Evaluators

Filters

Alias für Filter

FoundryFeaturesOptInKeys

Art der FoundryFeaturesOptInKeys

FunctionAndCustomToolCallOutputType

Typ von FunktionUndBenutzerdefiniertemToolAufrufOutputTyp

FunctionAndCustomToolCallOutputUnion

Alias for FunctionAndCustomToolCallOutputUnion

FunctionCallItemStatus

FunktionstypCallItemStatus

FunctionShellCallItemStatus

Statuswerte werden für Shell-Tool-Aufrufe gemeldet.

FunctionShellCallOutputOutcomeParamType

FunktionstypShellCallOutputOutcomeParamType

FunctionShellCallOutputOutcomeParamUnion

Alias für FunctionShellCallOutputOutcomeParamUnion

GrammarSyntax1

Art von GrammarSyntax1

ImageDetail

Art von BildDetail

IndexType

Typ des IndexType

IndexUnion

Alias für IndexUnion

InputContentType

Art von EingabeInhaltTyp

InputContentUnion

Alias für InputContentUnion

InputFidelity

Steuern Sie, wie viel Aufwand das Modell ausüben wird, um dem Stil und den Features, insbesondere Gesichtsmerkmalen, von Eingabebildern zu entsprechen. Der Parameter wird nur von gpt-image-1 unterstützt. Nicht unterstützt für gpt-image-1-mini. Unterstützt high und low. Wird standardmäßig auf low festgelegt.

InputItemType

Typ von EingabeArtikelTyp

InputItemUnion

Alias für InputItemUnion

InsightRequestUnion

Alias für InsightRequestUnion

InsightResultUnion

Alias für InsightResultUnion

InsightSampleUnion

Alias für InsightSampleUnion

InsightType

Die Anforderung der Einblicke.

MCPToolCallStatus

Typ von MCPToolCallStatus

MemoryItemKind

Art des Speicherelements.

MemoryItemUnion

Alias für MemoryItemUnion

MemoryOperationKind

Art der Speicheroperation.

MemoryStoreDefinitionUnion

Alias für MemoryStoreDefinitionUnion

MemoryStoreKind

Der Typ der zu verwendenden Speicherimplementierung.

MemoryStoreType

Typ von MemoryStoreType

MemoryStoreUpdateStatus

Status eines Aktualisierungsvorgangs für den Arbeitsspeicher.

OpenApiAuthDetailsUnion

Alias für OpenApiAuthDetailsUnion

OpenApiAuthType

Authentifizierungstyp für den OpenApi-Endpunkt. Folgende Typen sind zulässig:

  • Anonym (keine Authentifizierung erforderlich)
  • Projektverbindung (erfordert project_connection_id zum Endpunkt, wie es in AI Foundry eingerichtet ist)
  • Managed_Identity (erfordert Zielgruppe für identitätsbasierte Authentifizierung)
OperationState

Enumeration, die zulässige Betriebszustände beschreibt.

OutputMessageContentType

Art von OutputMessageInhaltTyp

OutputMessageContentUnion

Alias für OutputMessageContentUnion

PageOrder

Art der Seite Reihenfolge

PendingUploadType

Der Typ des ausstehenden Uploads.

RankerVersionType

Art von RankerVersionTyp

ReasoningEffort

Schränkt den Begründungsaufwand für Begründungsmodelle ein. Derzeit unterstützte Werte sind none, minimal, , low, medium, highund xhigh. Das Reduzieren von Begründungen kann zu schnelleren Antworten und weniger Token führen, die bei der Begründung in einer Antwort verwendet werden.

  • gpt-5.1 standardmäßig auf none, was kein Schlussfolgern ausführt. Die unterstützten Argumentationswerte für gpt-5.1 sind none, low, medium, und high. Toolaufrufe werden für alle Gründe in gpt-5.1 unterstützt.
  • Alle Modelle dienen vorher gpt-5.1 standardmäßig dem medium Reasoning-Aufwand und unterstützen nonenicht .
  • Das gpt-5-pro Modell basiert standardmäßig auf (und unterstützt nur) high den Schlussfolgerungsaufwand.
  • xhigh wird für alle Modelle nach gpt-5.1-codex-maxunterstützt.
RecurrenceScheduleUnion

Alias für RecurrenceScheduleUnion

RecurrenceType

Typ der Wiederholung.

RiskCategory

Risikokategorie für das Angriffsziel.

SampleType

Die Art der Probe, die für die Analyse verwendet wird.

ScheduleProvisioningStatus

Planen Sie den Bereitstellungsstatus.

ScheduleTaskType

Typ des Vorgangs.

ScheduleTaskUnion

Alias für ScheduleTaskUnion

SearchContextSize

Art von SuchContextSize

TargetConfigUnion

Alias für TargetConfigUnion

TargetUnion

Alias für TargetUnion

TextResponseFormatConfigurationType

Art von TextResponseFormatKonfigurationTyp

TextResponseFormatConfigurationUnion

Alias für TextResponseFormatConfigurationUnion

ToolChoiceParamType

Art of ToolChoiceParamType

ToolChoiceParamUnion

Alias für ToolChoiceParamUnion

ToolType

Art des Werkzeugtyps

ToolUnion

Alias für ToolUnion

TreatmentEffectType

Art der Behandlungswirkung.

TriggerType

Typ des Auslösers.

TriggerUnion

Alias für TriggerUnion

Enumerationen

KnownApiVersions

Microsoft Foundry API-Versionen

Functions

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

Erstellt einen Poller aus dem serialisierten Zustand eines anderen Pollers. Dies kann nützlich sein, wenn Sie Umfragen auf einem anderen Host erstellen möchten oder ein Poller erstellt werden muss, nachdem das ursprüngliche Abfragefeld nicht im Gültigkeitsbereich liegt.

Details zur Funktion

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

Erstellt einen Poller aus dem serialisierten Zustand eines anderen Pollers. Dies kann nützlich sein, wenn Sie Umfragen auf einem anderen Host erstellen möchten oder ein Poller erstellt werden muss, nachdem das ursprüngliche Abfragefeld nicht im Gültigkeitsbereich liegt.

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

Parameter

serializedState

string

sourceOperation

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

Gibt zurück

PollerLike<OperationState<TResult>, TResult>