@azure/ai-projects package

Klasser

AIProjectClient

får OpenAI-klienten med valfria OpenAI-klientalternativ

Gränssnitt

@azure/ai-projects.Index
A2APreviewTool

En agent som implementerar A2A-protokollet.

AIProjectClientOptionalParams

Valfria parametrar för klienten.

AISearchIndexResource

En resurs för AI-sökindex.

Agent

modellgränssnittsagent

AgentClusterInsightRequest

Insikter om resultaten av agentutvärderingen

AgentClusterInsightResult

Insikter från agentklusteranalysen.

AgentDefinition

Basdefinitionsgränssnitt för agenter. Innehåller agenttypen och valfri RAI-konfiguration.

AgentTaxonomyInput

Indatakonfiguration för utvärderingstaxonomin när indatatypen är agent.

AgentVersion

Representerar en specifik version av en agent. Innehåller metadata, versionshantering, skapandetid och agentdefinition.

AgenticIdentityPreviewCredentials

Definition av autentiseringsuppgifter för agentidentitet

AgentsCreateAgentFromManifestOptionalParams

Valfria parametrar.

AgentsCreateAgentVersionFromManifestOptionalParams

Valfria parametrar.

AgentsCreateOptionalParams

Valfria parametrar.

AgentsCreateVersionOptionalParams

Valfria parametrar.

AgentsDeleteOptionalParams

Valfria parametrar.

AgentsDeleteVersionOptionalParams

Valfria parametrar.

AgentsGetOptionalParams

Valfria parametrar.

AgentsGetVersionOptionalParams

Valfria parametrar.

AgentsListOptionalParams

Valfria parametrar.

AgentsListVersionsOptionalParams

Valfria parametrar.

AgentsOperations

Gränssnitt som representerar en agents åtgärder.

AgentsUpdateAgentFromManifestOptionalParams

Valfria parametrar.

AgentsUpdateOptionalParams

Valfria parametrar.

Annotation

En anteckning som gäller för ett intervall med utdatatext.

ApiErrorResponse

Felsvar för API-fel.

ApiKeyCredentials

Definition av API-nyckelautentiseringsuppgifter

ApplyPatchCreateFileOperationParam

Instruktion för att skapa en ny fil via apply_patch-verktyget.

ApplyPatchDeleteFileOperationParam

Instruktion för att ta bort en befintlig fil via apply_patch-verktyget.

ApplyPatchOperationParam

En av de create_file, delete_file eller update_file operationerna som tillförs apply_patch verktyget.

ApplyPatchToolParam

Tillåter assistenten att skapa, radera eller uppdatera filer med enhetliga diffar.

ApplyPatchUpdateFileOperationParam

Instruktion för att uppdatera en befintlig fil via apply_patch verktyget.

ApproximateLocation

modellgränssnitt ApproximateLocation

AzureAIAgentTarget

Representerar ett mål som anger en Azure AI-agent.

AzureAIModelTarget

Representerar ett mål som anger en Azure AI-modell för åtgärder som kräver modellval.

AzureAISearchIndex

Definition av Azure AI-sökindex

AzureAISearchTool

Information om indatadefinitionen för ett Azure AI-sökverktyg som används för att konfigurera en agent.

AzureAISearchToolResource

En uppsättning indexresurser som används av verktyget azure_ai_search.

AzureFunctionBinding

Strukturen för att behålla lagringskönamnet och URI:n.

AzureFunctionDefinition

Definitionen av Azure-funktionen.

AzureFunctionStorageQueue

Strukturen för att behålla lagringskönamnet och URI:n.

AzureFunctionTool

Information om indatadefinitionen för ett Azure-funktionsverktyg, som används för att konfigurera en agent.

AzureOpenAIModelConfiguration

Konfiguration av Azure OpenAI-modell. API-versionen väljs av tjänsten för att fråga modellen.

BaseCredentials

En basklass för autentiseringsuppgifter för anslutning

BetaEvaluationTaxonomiesCreateOptionalParams

Valfria parametrar.

BetaEvaluationTaxonomiesDeleteOptionalParams

Valfria parametrar.

BetaEvaluationTaxonomiesGetOptionalParams

Valfria parametrar.

BetaEvaluationTaxonomiesListOptionalParams

Valfria parametrar.

BetaEvaluationTaxonomiesOperations

Gränssnitt som representerar en BetaEvaluationTaxonomies-operation.

BetaEvaluationTaxonomiesUpdateOptionalParams

Valfria parametrar.

BetaEvaluatorsCreateVersionOptionalParams

Valfria parametrar.

BetaEvaluatorsDeleteVersionOptionalParams

Valfria parametrar.

BetaEvaluatorsGetVersionOptionalParams

Valfria parametrar.

BetaEvaluatorsListLatestVersionsOptionalParams

Valfria parametrar.

BetaEvaluatorsListVersionsOptionalParams

Valfria parametrar.

BetaEvaluatorsOperations

Gränssnitt som representerar en BetaEvaluators operationer.

BetaEvaluatorsUpdateVersionOptionalParams

Valfria parametrar.

BetaInsightsGenerateOptionalParams

Valfria parametrar.

BetaInsightsGetOptionalParams

Valfria parametrar.

BetaInsightsListOptionalParams

Valfria parametrar.

BetaInsightsOperations

Gränssnitt som representerar en BetaInsights-operation.

BetaMemoryStoresCreateOptionalParams

Valfria parametrar.

BetaMemoryStoresDeleteOptionalParams

Valfria parametrar.

BetaMemoryStoresDeleteScopeOptionalParams

Valfria parametrar.

BetaMemoryStoresGetOptionalParams

Valfria parametrar.

BetaMemoryStoresGetUpdateResultOptionalParams

Valfria parametrar.

BetaMemoryStoresListOptionalParams

Valfria parametrar.

BetaMemoryStoresOperations

Gränssnitt som representerar en BetaMemoryStores-operation.

BetaMemoryStoresSearchMemoriesOptionalParams

Valfria parametrar.

BetaMemoryStoresUpdateMemoriesOptionalParams

Valfria parametrar.

BetaMemoryStoresUpdateOptionalParams

Valfria parametrar.

BetaOperations

Gränssnitt som representerar en betaoperation.

BetaRedTeamsCreateOptionalParams

Valfria parametrar.

BetaRedTeamsGetOptionalParams

Valfria parametrar.

BetaRedTeamsListOptionalParams

Valfria parametrar.

BetaRedTeamsOperations

Gränssnitt som representerar BetaRedTeams-operationer.

BetaSchedulesCreateOrUpdateOptionalParams

Valfria parametrar.

BetaSchedulesDeleteOptionalParams

Valfria parametrar.

BetaSchedulesGetOptionalParams

Valfria parametrar.

BetaSchedulesGetRunOptionalParams

Valfria parametrar.

BetaSchedulesListOptionalParams

Valfria parametrar.

BetaSchedulesListRunsOptionalParams

Valfria parametrar.

BetaSchedulesOperations

Gränssnitt som representerar en BetaSchedules-operation.

BingCustomSearchConfiguration

En anpassad sökkonfiguration i Bing.

BingCustomSearchPreviewTool

Information om indatadefinitionen för ett anpassat sökverktyg i Bing som används för att konfigurera en agent.

BingCustomSearchToolParameters

Parametrarna för det anpassade sökverktyget i Bing.

BingGroundingSearchConfiguration

Sökkonfiguration för Bing Jordning

BingGroundingSearchToolParameters

Parametrarna för sökverktyget för jordning i Bing.

BingGroundingTool

Information om indatadefinitionen för ett Bing-grundsökningsverktyg som används för att konfigurera en agent.

BlobReference

Information om blobreferens.

BrowserAutomationPreviewTool

Information om indatadefinitionen för ett webbläsarautomatiseringsverktyg, som används för att konfigurera en agent.

BrowserAutomationToolConnectionParameters

Definition av indataparametrar för anslutningen som används av Browser Automation Tool.

BrowserAutomationToolParameters

Definition av inmatningsparametrar för Browser Automation Tool.

CaptureStructuredOutputsTool

Ett verktyg för att fånga strukturerade resultat

ChartCoordinate

Koordinater för analysdiagrammet.

ChatSummaryMemoryItem

Ett minnesobjekt som innehåller en sammanfattning som extraherats från konversationer.

ClickParam

En klickåtgärd.

ClusterInsightResult

Insikter från klusteranalysen.

ClusterTokenUsage

Tokenanvändning för klusteranalys

CodeBasedEvaluatorDefinition

Kodbaserad utvärderardefinition med hjälp av python-kod

CodeInterpreterContainerAuto

Konfiguration för en kodtolkarcontainer. Du kan också ange ID:t för de filer som koden ska köras på.

CodeInterpreterOutputImage

Bilden utdata från kodtolkaren.

CodeInterpreterOutputLogs

Loggarna utdata från kodtolkaren.

CodeInterpreterTool

Ett verktyg som kör Python-kod för att generera ett svar på en fråga.

ComparisonFilter

Ett filter som används för att jämföra en angiven attributnyckel med ett angivet värde med hjälp av en definierad jämförelseåtgärd.

CompoundFilter

Kombinera flera filter med and eller or.

ComputerAction

modell gränssnitt ComputerAction

ComputerCallSafetyCheckParam

En väntande säkerhetskontroll för datorsamtalet.

ComputerScreenshotImage

En skärmbild av datorn som används med datoranvändningsverktyget.

ComputerUsePreviewTool

Ett verktyg som styr en virtuell dator. Läs mer om datorverktyget.

Connection

Åtgärder för svar från listan och hämta anslutningar

ConnectionsGetOptionalParams

Valfria parametrar.

ConnectionsGetWithCredentialsOptionalParams

Valfria parametrar.

ConnectionsListOptionalParams

Valfria parametrar.

ConnectionsOperations

Gränssnitt som representerar en anslutningsåtgärd.

ContainerAppAgentDefinition

Definitionen av containerappens agent.

ContainerFileCitationBody

En referens till en containerfil som används för att generera ett modellsvar.

ContinuousEvaluationRuleAction

Åtgärd för utvärderingsregel för kontinuerlig utvärdering.

CosmosDBIndex

Definition av CosmosDB Vector Store-index

CronTrigger

Cron-baserad utlösare.

CustomCredential

Definition av anpassade autentiseringsuppgifter

CustomGrammarFormatParam

En grammatik definierad av användaren.

CustomTextFormatParam

Obegränsad fri text.

CustomToolParam

Ett anpassat verktyg som bearbetar indata med ett specificerat format. Lär dig mer om anpassade verktyg

CustomToolParamFormat

Inmatningsformatet för det anpassade verktyget. Standard är obegränsad text.

DailyRecurrenceSchedule

Dagligt upprepningsschema.

DatasetCredential

Representerar en referens till en blob för förbrukning

DatasetUploadOptions

Alternativ för att ladda upp datauppsättningar

DatasetVersion

DatasetVersionsdefinition

DatasetsCreateOrUpdateOptionalParams

Valfria parametrar.

DatasetsDeleteOptionalParams

Valfria parametrar.

DatasetsGetCredentialsOptionalParams

Valfria parametrar.

DatasetsGetOptionalParams

Valfria parametrar.

DatasetsListOptionalParams

Valfria parametrar.

DatasetsListVersionsOptionalParams

Valfria parametrar.

DatasetsOperations

Gränssnitt som representerar en Datasets-operation.

DatasetsPendingUploadOptionalParams

Valfria parametrar.

DeleteAgentResponse

Ett borttaget agentobjekt

DeleteAgentVersionResponse

Ett borttaget agentversionsobjekt

DeleteMemoryStoreResponse

modellgränssnitt DeleteMemoryStoreResponse

Deployment

Definition av modelldistribution

DeploymentsGetOptionalParams

Valfria parametrar.

DeploymentsListOptionalParams

Valfria parametrar.

DeploymentsOperations

Gränssnitt som representerar en distributionsåtgärd.

DoubleClickAction

En dubbelklicksåtgärd.

Drag

En dragåtgärd.

DragPoint

Ett x/y-koordinatpar, t.ex. { x: 100, y: 200 }.

EasyInputMessage

Ett meddelande som matas in till modellen med en roll som anger instruktionen efter hierarkin. Instruktioner som ges med developer rollen eller system har företräde framför instruktioner som ges med user rollen. Meddelanden med assistant rollen antas ha genererats av modellen i tidigare interaktioner.

EmbeddingConfiguration

Konfigurationsklass för inbäddning

EntraIDCredentials

Definition av autentiseringsuppgifter för Entra-ID

ErrorModel

modellgränssnitt Felmodell

EvalResult

Resultat av utvärderingen.

EvalRunResultCompareItem

Metrisk jämförelse för en behandling mot baslinjen.

EvalRunResultComparison

Jämförelseresultat för behandling körs mot baslinjen.

EvalRunResultSummary

Sammanfattande statistik för ett mått i en utvärderingskörning.

EvaluationComparisonInsightRequest

Begäran om utvärderingsjämförelse

EvaluationComparisonInsightResult

Insikter från utvärderingsjämförelsen.

EvaluationResultSample

Ett exempel från utvärderingsresultatet.

EvaluationRule

Modell för utvärderingsregel.

EvaluationRuleAction

Åtgärdsmodell för utvärdering.

EvaluationRuleFilter

Modell för utvärderingsfilter.

EvaluationRulesCreateOrUpdateOptionalParams

Valfria parametrar.

EvaluationRulesDeleteOptionalParams

Valfria parametrar.

EvaluationRulesGetOptionalParams

Valfria parametrar.

EvaluationRulesListOptionalParams

Valfria parametrar.

EvaluationRulesOperations

Gränssnitt som representerar en EvaluationRules-åtgärd.

EvaluationRunClusterInsightRequest

Insikter om uppsättningen av utvärderingsresultat

EvaluationRunClusterInsightResult

Insikter från utvärderingen kör klusteranalys.

EvaluationScheduleTask

Utvärderingsuppgift för schemat.

EvaluationTaxonomy

Definition av taxonomi för utvärdering

EvaluationTaxonomyInput

Indatakonfiguration för utvärderingstaxonomin.

EvaluatorDefinition

Konfiguration av basutvärderare med diskriminator

EvaluatorMetric

Utvärderare Metriska mått

EvaluatorVersion

Definition av utvärderare

FabricDataAgentToolParameters

Parametrarna för verktyget för infrastrukturdataagenten.

FieldMapping

Konfigurationsklass för fältmappning

FileCitationBody

En källhänvisning till en fil.

FileDatasetVersion

FilDatasetVersionsdefinition

FilePath

En sökväg till en fil.

FileSearchTool

Ett verktyg som söker efter relevant innehåll från uppladdade filer. Läs mer om filsökningsverktyget.

FileSearchToolCallResults

modellgränssnitt FileSearchToolCallResults

FolderDatasetVersion

FilDatasetVersionsdefinition

FunctionAndCustomToolCallOutput

modellgränssnittet FunctionAndCustomToolCallOutput

FunctionAndCustomToolCallOutputInputFileContent

En filinmatning till modellen.

FunctionAndCustomToolCallOutputInputImageContent

En bildinmatning till modellen. Lär dig mer om bildindata.

FunctionAndCustomToolCallOutputInputTextContent

En textinmatning till modellen.

FunctionShellActionParam

Kommandon och begränsningar som beskriver hur man kör shell-verktygsanropet.

FunctionShellCallOutputContentParam

Fångade stdout och stderr för en del av ett skalverktygsanrop.

FunctionShellCallOutputExitOutcomeParam

Indikerar att skalkommandona avslutades och returnerade en avslutningskod.

FunctionShellCallOutputOutcomeParam

Utgången eller timeout-resultatet av detta shell-call.

FunctionShellCallOutputTimeoutOutcomeParam

Indikerar att skalanropet överskred sin konfigurerade tidsgräns.

FunctionShellToolParam

Ett verktyg som låter modellen utföra skalkommandon.

FunctionTool

Definierar en funktion i din egen kod som modellen kan välja att anropa. Läs mer om funktionsanrop.

HostedAgentDefinition

Definitionen av den värdbaserade agenten.

HourlyRecurrenceSchedule

Schema för upprepning per timme.

HumanEvaluationPreviewRuleAction

Utvärderingsregelåtgärd för mänsklig utvärdering.

HybridSearchOptions

modellgränssnitt HybridSearchOptions

ImageGenTool

Ett verktyg som genererar bilder med hjälp av GPT-bildmodellerna.

ImageGenToolInputImageMask

modellgränssnittet ImageGenToolInputImageMask

IndexesCreateOrUpdateOptionalParams

Valfria parametrar.

IndexesDeleteOptionalParams

Valfria parametrar.

IndexesGetOptionalParams

Valfria parametrar.

IndexesListOptionalParams

Valfria parametrar.

IndexesListVersionsOptionalParams

Valfria parametrar.

IndexesOperations

Gränssnitt som representerar en indexåtgärder.

InputContent

modellgränssnitt InputContent

InputContentInputFileContent

En filinmatning till modellen.

InputContentInputImageContent

En bildinmatning till modellen. Lär dig mer om bildindata.

InputContentInputTextContent

En textinmatning till modellen.

InputFileContentParam

En filinmatning till modellen.

InputImageContentParamAutoParam

En bildinmatning till modellen. Lär dig om bildinmatningar

InputItem

Ett objekt som representerar en del av kontexten för svaret som ska genereras av modellen. Kan innehålla text, bilder och ljudindata, samt tidigare assistentsvar och verktygsanropsutdata.

InputItemApplyPatchToolCallItemParam

Ett verktygsanrop som representerar en förfrågan om att skapa, ta bort eller uppdatera filer med hjälp av olika patchar.

InputItemApplyPatchToolCallOutputItemParam

Den strömmade utdata som sänds ut av ett apply patch-verktygsanrop.

InputItemCodeInterpreterToolCall

Ett verktygsanrop för att köra kod.

InputItemCompactionSummaryItemParam

Ett kompaktionsobjekt genererat av API:etv1/responses/compact.

InputItemComputerCallOutputItemParam

Utdata från ett datorverktygsanrop.

InputItemComputerToolCall

Ett verktygsanrop till ett datoranvändningsverktyg. Mer information finns i guiden för datoranvändning .

InputItemCustomToolCall

Ett anrop till ett anpassat verktyg skapat av modellen.

InputItemCustomToolCallOutput

Resultatet av ett anpassat verktygsanrop från din kod, som skickas tillbaka till modellen.

InputItemFileSearchToolCall

Resultatet av ett filsökningsverktygsanrop. Mer information finns i filsökningsguiden .

InputItemFunctionCallOutputItemParam

Utdata från ett funktionsverktygsanrop.

InputItemFunctionShellCallItemParam

Ett verktyg som representerar en förfrågan om att utföra ett eller flera skalkommandon.

InputItemFunctionShellCallOutputItemParam

De strömmade utdataobjekten som sänds ut av ett skalverktygsanrop.

InputItemFunctionToolCall

Ett verktygsanrop för att köra en funktion. Mer information finns i funktionssamtalsguiden .

InputItemImageGenToolCall

En begäran om bildgenerering som gjorts av modellen.

InputItemLocalShellToolCall

Ett verktygsanrop för att köra ett kommando i det lokala gränssnittet.

InputItemLocalShellToolCallOutput

Utdata från ett lokalt gränssnittsverktygsanrop.

InputItemMcpApprovalRequest

En begäran om mänskligt godkännande av ett verktygsanrop.

InputItemMcpApprovalResponse

Ett svar på en begäran om MCP-godkännande.

InputItemMcpListTools

En lista över verktyg som är tillgängliga på en MCP-server.

InputItemMcpToolCall

Ett anrop av ett verktyg på en MCP-server.

InputItemOutputMessage

Ett utdatameddelande från modellen.

InputItemReasoningItem

En beskrivning av den tankekedja som används av en resonemangsmodell när ett svar genereras. Se till att inkludera dessa objekt i Responses input API för kommande omgångar av en konversation om du manuellt hanterar kontext.

InputItemWebSearchToolCall

Resultatet av ett webbsökningsverktyg som anropas. Se webbsökguiden för mer information.

InputTextContentParam

En textinmatning till modellen.

Insight

Svarstexten för klusterinsikter.

InsightCluster

Ett kluster av analysprover.

InsightModelConfiguration

Konfiguration av modellen som används i insiktsgenereringen.

InsightRequest

Begäran om insiktsrapporten.

InsightResult

Resultatet av insikterna.

InsightSample

Ett smakprov från analysen.

InsightScheduleTask

Insiktsuppgift för schemat.

InsightSummary

Sammanfattning av felklusteranalysen.

InsightsMetadata

Metadata om insikterna.

ItemReferenceParam

En intern identifierare för ett objekt att referera till.

KeyPressAction

En samling tangenttryckningar som modellen vill utföra.

LocalShellExecAction

Kör ett gränssnittskommando på servern.

LocalShellToolParam

Ett verktyg som gör att modellen kan köra gränssnittskommandon i en lokal miljö.

LogProb

Loggens sannolikhet för en token.

MCPListToolsTool

Ett verktyg som är tillgängligt på en MCP-server.

MCPListToolsToolAnnotations

modellgränssnitt MCPListToolsToolAnnotations

MCPListToolsToolInputSchema

modellgränssnitt MCPListToolsToolInputSchema

MCPTool

Ge modellen åtkomst till ytterligare verktyg via MCP-servrar (Remote Model Context Protocol). Läs mer om MCP.

MCPToolFilter

Ett filterobjekt för att specificera vilka verktyg som är tillåtna.

MCPToolRequireApproval

modellgränssnitt MCPToolRequireApproval

ManagedAzureAISearchIndex

Definition av hanterat Azure AI-sökindex

MemoryItem

Ett enskilt minnesobjekt som lagras i minneslagret och som innehåller innehåll och metadata.

MemoryOperation

Representerar en enskild minnesåtgärd (skapa, uppdatera eller ta bort) som utförs på ett minnesobjekt.

MemorySearchItem

Ett hämtat minnesobjekt från minnessökningen.

MemorySearchOptions

Alternativ för minnessökning.

MemorySearchPreviewTool

Ett verktyg för att integrera minnen i agenten.

MemoryStore

Ett minneslager som kan lagra och hämta användarminnen.

MemoryStoreDefaultDefinition

Standardimplementering av minneslager.

MemoryStoreDefaultOptions

Standardkonfigurationer för minneslager.

MemoryStoreDefinition

Grundläggande definition för minneslagringskonfigurationer.

MemoryStoreDeleteScopeResponse

Svar för att ta bort minnen från ett omfång.

MemoryStoreOperationUsage

Användningsstatistik för en minneslagringsåtgärd.

MemoryStoreSearchResponse

Svar på minnessökning.

MemoryStoreUpdateCompletedResult

Resultat av minnesuppdatering.

MemoryStoreUpdateResponse

Anger status för en uppdateringsåtgärd för minneslagret.

MicrosoftFabricPreviewTool

Information om indatadefinitionen för ett Microsoft Fabric-verktyg som används för att konfigurera en agent.

ModelDeployment

Definition av modelldistribution

ModelDeploymentSku

SKU-information

ModelSamplingParams

Representerar en uppsättning parametrar som används för att styra samplingsbeteendet för en språkmodell under textgenereringen.

MonthlyRecurrenceSchedule

Månatligt upprepningsschema.

Move

En musflyttningsåtgärd.

NoAuthenticationCredentials

Autentiseringsuppgifter som inte kräver autentisering

OneTimeTrigger

Utlösare en gång.

OpenApiAnonymousAuthDetails

Säkerhetsinformation för anonym OpenApi-autentisering

OpenApiAuthDetails

autentiseringsinformation för OpenApiFunctionDefinition

OpenApiFunctionDefinition

Information om indatadefinition för en openapi-funktion.

OpenApiManagedAuthDetails

Säkerhetsinformation för OpenApi managed_identity-autentisering

OpenApiManagedSecurityScheme

Säkerhetsschema för OpenApi managed_identity-autentisering

OpenApiProjectConnectionAuthDetails

Säkerhetsinformation för autentisering av OpenApi-projektanslutning

OpenApiProjectConnectionSecurityScheme

Säkerhetsschema för OpenApi managed_identity-autentisering

OpenApiTool

Information om indatadefinition för ett OpenAPI-verktyg som används för att konfigurera en agent.

OutputMessageContent

modellgränssnitt OutputMessageContent

OutputMessageContentOutputTextContent

En textutgång från modellen.

OutputMessageContentRefusalContent

En vägran från modellen.

PageSettings

Alternativ för byPage-metoden

PagedAsyncIterableIterator

Ett gränssnitt som tillåter asynkron iteration både för slutförande och efter sida.

PendingUploadRequest

Representerar en begäran om en väntande uppladdning.

PendingUploadResponse

Representerar svaret på en väntande uppladdningsbegäran

PromptAgentDefinition

Definitionen av promptagenten

PromptAgentDefinitionTextOptions

Konfigurationsalternativ för ett textsvar från modellen. Kan vara oformaterad text eller strukturerade JSON-data.

PromptBasedEvaluatorDefinition

Promptbaserad utvärderare

ProtocolVersionRecord

En postmappning för ett enskilt protokoll och dess version.

RaiConfig

Konfiguration för innehållsfiltrering och säkerhetsfunktioner för ansvarsfull AI (RAI).

RankingOptions

modellgränssnitt RankingOptions

Reasoning

Endast GPT-5 och O-serie modeller Konfigurationsalternativ för resonemangsmodeller.

ReasoningTextContent

Resonerande text från modellen.

RecurrenceSchedule

Modell för upprepningsschema.

RecurrenceTrigger

Upprepningsbaserad utlösare.

RedTeam

Detaljer om det röda laget.

ResponseUsageInputTokensDetails

modellgränssnitt SvarAnvändningIndataTokensDetaljer

ResponseUsageOutputTokensDetails

modellgränssnitt ResponsAnvändningUtdataTokensDetaljer

RestorePollerOptions
SASTokenCredentials

Definition av autentiseringsuppgifter för signatur för delad åtkomst (SAS)

SasCredential

Definition av SAS-autentiseringsuppgifter

Schedule

Schemalägg modell.

ScheduleRun

Schemalägg körningsmodell.

ScheduleTask

Schemalägg uppgiftsmodell.

Screenshot

En skärmbildsåtgärd.

Scroll

En scrollningsåtgärd.

SharepointGroundingToolParameters

Parametrarna för sharepoint-jordningsverktyget.

SharepointPreviewTool

Information om indatadefinition för ett sharepoint-verktyg som används för att konfigurera en agent.

SpecificApplyPatchParam

Tvingar modellen att anropa verktyget apply_patch när ett verktygsanrop körs.

SpecificFunctionShellParam

Tvingar modellen att anropa shell-verktyget när ett verktygsanrop krävs.

StructuredInputDefinition

En strukturerad indata som kan delta i promptmallersättningar och verktygsargumentbindning.

StructuredOutputDefinition

Strukturerade utdata som kan skapas av agenten.

Summary

En sammanfattningstext från modellen.

Target

Basklass för mål med stöd för diskriminator.

TargetConfig

Abstrakt klass för målkonfiguration.

TaxonomyCategory

Definition av taxonomikategori.

TaxonomySubCategory

Definition av underkategori taxonomi.

TelemetryOperations

Gränssnitt som representerar telemetrioperationer

TextResponseFormatConfiguration

Ett objekt som anger det format som modellen måste mata ut. Konfiguration { "type": "json_schema" } möjliggör strukturerade utdata, vilket säkerställer att modellen matchar ditt angivna JSON-schema. Läs mer i guiden Strukturerade utdata. Standardformatet är { "type": "text" } utan ytterligare alternativ. Rekommenderas inte för gpt-4o och nyare modeller:* Inställning för att { "type": "json_object" } aktivera det äldre JSON-läget, vilket säkerställer att meddelandet modellen genererar är giltigt JSON. Att använda json_schema är att föredra för modeller som stöder det.

TextResponseFormatConfigurationResponseFormatJsonObject

JSON-objektsvarsformat. En äldre metod för att generera JSON-svar. Användning json_schema rekommenderas för modeller som stöder det. Observera att modellen inte genererar JSON utan ett system- eller användarmeddelande som instruerar den att göra det.

TextResponseFormatConfigurationResponseFormatText

Standardformat för svar. Används för att generera textsvar.

TextResponseFormatJsonSchema

JSON-schema svarsformat. Används för att generera strukturerade JSON-svar. Läs mer om strukturerade utdata.

Tool

Ett verktyg som kan användas för att generera ett svar.

ToolChoiceAllowed

Begränsar de verktyg som är tillgängliga för modellen till en fördefinierad uppsättning.

ToolChoiceCodeInterpreter

Anger att modellen ska använda ett inbyggt verktyg för att generera ett svar. Läs mer om inbyggda verktyg.

ToolChoiceComputerUsePreview

Anger att modellen ska använda ett inbyggt verktyg för att generera ett svar. Läs mer om inbyggda verktyg.

ToolChoiceCustom

Använd det här alternativet för att tvinga modellen att anropa ett specifikt anpassat verktyg.

ToolChoiceFileSearch

Anger att modellen ska använda ett inbyggt verktyg för att generera ett svar. Läs mer om inbyggda verktyg.

ToolChoiceFunction

Använd det här alternativet för att tvinga modellen att anropa en specifik funktion.

ToolChoiceImageGeneration

Anger att modellen ska använda ett inbyggt verktyg för att generera ett svar. Läs mer om inbyggda verktyg.

ToolChoiceMCP

Använd det här alternativet för att tvinga modellen att anropa ett specifikt verktyg på en fjärr-MCP-server.

ToolChoiceParam

Hur modellen ska välja vilket verktyg (eller verktyg) som ska användas när ett svar genereras. Se parametern tools för att se hur du anger vilka verktyg som modellen kan anropa.

ToolChoiceWebSearchPreview

Anger att modellen ska använda ett inbyggt verktyg för att generera ett svar. Läs mer om inbyggda verktyg.

ToolChoiceWebSearchPreview20250311

Anger att modellen ska använda ett inbyggt verktyg för att generera ett svar. Läs mer om inbyggda verktyg.

ToolDescription

Beskrivning av ett verktyg som kan användas av en agent.

ToolProjectConnection

En projektanslutningsresurs.

TopLogProb

Den högsta loggens sannolikhet för en token.

Trigger

Basmodell för utlösare av schemat.

Type

En åtgärd för att skriva in text.

UrlCitationBody

En källhänvisning för en webbresurs som används för att generera ett modellsvar.

UserProfileMemoryItem

Ett minnesobjekt som specifikt innehåller information om användarprofiler som extraherats från konversationer, till exempel preferenser, intressen och personliga uppgifter.

VectorStoreFileAttributes

Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format och fråga efter objekt via API eller instrumentpanelen. Nycklar är strängar med en maximal längd på 64 tecken. Värden är strängar med en maximal längd på 512 tecken, booleska värden eller tal.

Wait

En väntåtgärd.

WebSearchActionFind

Åtgärdstyp "find": Söker efter ett mönster på en inläst sida.

WebSearchActionOpenPage

Åtgärdstyp "open_page" – Öppnar en specifik URL från sökresultat.

WebSearchActionSearch

Åtgärdstyp "sök" – Utför en webbsökningsfråga.

WebSearchActionSearchSources

modellgränssnitt WebSearchActionSearchSources

WebSearchApproximateLocation

Användarens ungefärliga plats.

WebSearchConfiguration

En webbsökningskonfiguration för Bing anpassad sökning

WebSearchPreviewTool

Detta verktyg söker på webben efter relevanta resultat att använda i ett svar. Lär dig mer om webbsökverktyget.

WebSearchTool

Sök på internet efter källor relaterade till prompten. Lär dig mer om webbsökverktyget.

WebSearchToolFilters

modellgränssnitt WebSearchToolFilters

WeeklyRecurrenceSchedule

Schema för upprepning varje vecka.

WorkflowAgentDefinition

Definitionen av arbetsflödesagenten.

Typalias

AgentDefinitionUnion

Unionstyp för alla typer av agentdefinitioner. Stöder arbetsflöde, värdbaserade, containerappar och promptagenter.

AgentKind

Definierar typen/typen av agent. Avgör vilken agentdefinitionsstruktur som används.

AgentProtocol

Typ av AgentProtocol

AgentType

Typ av agenttyp

AnnotationType

Typ av AnnotationType

AnnotationUnion

Alias för AnnotationUnion

ApplyPatchCallOutputStatusParam

Utfallsvärden rapporteras för apply_patch verktygssamtalsutdata.

ApplyPatchCallStatusParam

Statusvärden rapporteras för apply_patch verktygsanrop.

ApplyPatchOperationParamType

Typ av ApplyPatchOperationParamType

ApplyPatchOperationParamUnion

Alias för ApplyPatchOperationParamUnion

AttackStrategy

Strategier för attacker.

AzureAISearchQueryType

Tillgängliga frågetyper för Azure AI Search-verktyget.

BaseCredentialsUnion

Alias för BaseCredentialsUnion

ClickButtonType

Typ av ClickButtonType

ComparisonFilterValueItems

Alias för ComparisonFilterValueItems

ComputerActionType

Typ av ComputerActionType

ComputerActionUnion

Alias för ComputerActionUnion

ComputerEnvironment

Typ av datormiljö

ConnectionType

Typ (eller kategori) för anslutningen

ContainerMemoryLimit

Type of ContainerMemoryLimit

ContinuablePage

Ett gränssnitt som beskriver en resultatsida.

CredentialType

Typen av autentiseringsuppgifter som används av anslutningen

CustomToolParamFormatType

Typ av CustomToolParamFormatType

CustomToolParamFormatUnion

Alias för CustomToolParamFormatUnion

DatasetType

Räkna upp för att fastställa typen av data.

DatasetVersionUnion

Alias för DatasetVersionUnion

DayOfWeek

Dagar i veckan för upprepningsschema.

DeploymentType

Typ av DeploymentType

DeploymentUnion

Alias för DeploymentUnion

DetailEnum

Typ av detaljEnum

EvaluationRuleActionType

Typ av utvärderingsåtgärd.

EvaluationRuleActionUnion

Alias för EvaluationRuleActionUnion

EvaluationRuleEventType

Typ av utvärderingsregelhändelse.

EvaluationTaxonomyInputType

Typ av indata från utvärderingstaxonomin.

EvaluationTaxonomyInputUnion

Alias för EvaluationTaxonomyInputUnion

EvaluatorCategory

Utvärderarens kategori

EvaluatorDefinitionType

Definition av typ av utvärderare

EvaluatorDefinitionUnion

Alias för EvaluatorDefinitionUnion

EvaluatorMetricDirection

Måttenhetens riktning som anger om ett högre värde är bättre, ett lägre värde är bättre eller neutralt

EvaluatorMetricType

Typ av utvärderare

EvaluatorType

Typ av utvärderare

Filters

Alias för filter

FoundryFeaturesOptInKeys

Typ av FoundryFeaturesOptInKeys

FunctionAndCustomToolCallOutputType

Typ av FunktionOchSpecialVerktygAnropUtTyp

FunctionAndCustomToolCallOutputUnion

Alias för FunctionandCustomToolCallOutputUnion

FunctionCallItemStatus

Typ av funktionCallItemStatus

FunctionShellCallItemStatus

Statusvärden rapporteras för skalverktygsanrop.

FunctionShellCallOutputOutcomeParamType

Typ av funktionShellCallOutputOutcomeParamType

FunctionShellCallOutputOutcomeParamUnion

Alias för FunctionShellCallOutputOutcomeParamUnion

GrammarSyntax1

Typ av GrammarSyntax1

ImageDetail

Typ av bilddetalj

IndexType

Typ av IndexType

IndexUnion

Alias för IndexUnion

InputContentType

Typ av InputContentType

InputContentUnion

Alias för InputContentUnion

InputFidelity

Kontrollera hur mycket arbete modellen kommer att utöva för att matcha stilen och funktionerna, särskilt ansiktsdrag, för indatabilder. Den här parametern stöds endast för gpt-image-1. Stöds inte för gpt-image-1-mini. Stöder high och low. Standardinställningen är low.

InputItemType

Typ av InputItemType

InputItemUnion

Alias för InputItemUnion

InsightRequestUnion

Alias för InsightRequestUnion

InsightResultUnion

Alias för InsightResultUnion

InsightSampleUnion

Alias för InsightSampleUnion

InsightType

Begäran om insikter.

MCPToolCallStatus

Typ av MCPToolCallStatus

MemoryItemKind

Typ av minnesobjekt.

MemoryItemUnion

Alias för MemoryItemUnion

MemoryOperationKind

Typ av minnesoperation.

MemoryStoreDefinitionUnion

Alias för MemoryStoreDefinitionUnion

MemoryStoreKind

Vilken typ av implementering av minneslager som ska användas.

MemoryStoreType

Typ av MemoryStoreType

MemoryStoreUpdateStatus

Status för en uppdateringsåtgärd för minneslagret.

OpenApiAuthDetailsUnion

Alias för OpenApiAuthDetailsUnion

OpenApiAuthType

Autentiseringstyp för OpenApi-slutpunkt. Tillåtna typer är:

  • Anonym (ingen autentisering krävs)
  • Projektanslutning (kräver project_connection_id till slutpunkten, som konfigurerat i AI Foundry)
  • Managed_Identity (kräver målgrupp för identitetsbaserad autentisering)
OperationState

Uppräkning som beskriver tillåtna åtgärdstillstånd.

OutputMessageContentType

Typ av OutputMessageContentType

OutputMessageContentUnion

Alias för OutputMessageContentUnion

PageOrder

Typ av sidaOrder

PendingUploadType

Typen av väntande uppladdning.

RankerVersionType

Typ av rankerVersionTyp

ReasoningEffort

Begränsar arbetet med resonemang för resonemangsmodeller. För närvarande stödda värden är none, minimal, , low, medium, highoch xhigh. Att minska resonemangsinsatsen kan resultera i snabbare svar och färre token som används vid resonemang i ett svar.

  • gpt-5.1 går som standard till none, vilket inte utför resonemang. De stödda resonemangsvärdena för gpt-5.1 är none, low, medium, och high. Verktygsanrop stöds för alla resonemangsvärden i gpt-5.1.
  • Alla modeller används som gpt-5.1 standard resonerande medium och stödjer noneinte.
  • Modellen gpt-5-pro använder som standard (och stödjer bara) high resonemangsarbete.
  • xhigh stöds för alla modeller efter gpt-5.1-codex-max.
RecurrenceScheduleUnion

Alias för RecurrenceScheduleUnion

RecurrenceType

Typ av upprepning.

RiskCategory

Riskkategori för attackmålet.

SampleType

Vilken typ av prov som används i analysen.

ScheduleProvisioningStatus

Status för schemaläggning av etablering.

ScheduleTaskType

Typ av uppgift.

ScheduleTaskUnion

Alias för ScheduleTaskUnion

SearchContextSize

Typ av sökningKontextStorlek

TargetConfigUnion

Alias för TargetConfigUnion

TargetUnion

Alias för TargetUnion

TextResponseFormatConfigurationType

Typ av TextSvarFormatKonfigurationTyp

TextResponseFormatConfigurationUnion

Alias för TextResponseFormatConfigurationUnion

ToolChoiceParamType

Typ av verktygValParamTyp

ToolChoiceParamUnion

Alias för ToolChoiceParamUnion

ToolType

Typ av verktygstyp

ToolUnion

Alias för ToolUnion

TreatmentEffectType

Typ av behandlingseffekt.

TriggerType

Typ av utlösare.

TriggerUnion

Alias för TriggerUnion

Uppräkningar

KnownApiVersions

Microsoft Foundry API-versioner

Funktioner

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

Skapar en poller från det serialiserade tillståndet för en annan poller. Detta kan vara användbart när du vill skapa pollers på en annan värd eller om en poller måste konstrueras när den ursprungliga inte finns i omfånget.

Funktionsinformation

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

Skapar en poller från det serialiserade tillståndet för en annan poller. Detta kan vara användbart när du vill skapa pollers på en annan värd eller om en poller måste konstrueras när den ursprungliga inte finns i omfånget.

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

Parametrar

serializedState

string

sourceOperation

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

Returer

PollerLike<OperationState<TResult>, TResult>