@azure/ai-projects package

Třídy

AIProjectClient

Hlavní klient pro AIProjectClient

VoiceAgentAuthenticationError

Chyba při získávání přístupového tokenu Microsoft Entra.

VoiceAgentConnectionError

Chyba způsobená připojením přes WebSocket.

VoiceAgentProtocolError

Chyba vyvolaná, když zpráva WebSocket neodpovídá protokolu hlasového agenta.

VoiceAgentRealtimeClient

Klient pro navazování relací v reálném čase s řízenými hlasovými agenty Foundry.

VoiceAgentRealtimeError

Základní chyba zjištěná klientem Voice Agents v reálném čase.

Rozhraní

@azure/ai-projects.Index
A2APreviewTool

Agent implementující protokol A2A.

A2APreviewToolboxTool

Nástroj A2A uložený v kufříku s nářadím.

A2AProtocolConfiguration

Konfigurace specifická pro protokol A2A.

A2ATool

Agent implementující protokol A2A.

A2AToolboxTool

Nástroj A2A uložený v kufříku s nářadím.

AIProjectClientOptionalParams

Volitelné parametry pro klienta.

AISearchIndexResource

Zdroj indexu vyhledávání AI.

ActivityProtocolConfiguration

Konfigurace specifická pro protokol aktivity.

Agent

Model Interface Agent

AgentBlueprintReference

modelové rozhraní AgentBlueprintReference

AgentCard

modelové rozhraní AgentCard

AgentCardSkill

modelové rozhraní AgentCardSkill

AgentClusterInsightRequest

Přehledy o sadě výsledků vyhodnocení agenta

AgentClusterInsightResult

Poznatky z analýzy shluku agentů.

AgentDataGenerationJobSource

Zdroj agenta pro úlohy generování dat — odkazuje na agenta pro načítání instrukcí a metadat.

AgentDefinition

Základní definiční rozhraní pro agenty. Obsahuje druh agenta a volitelnou konfiguraci RAI.

AgentEndpointAuthorizationScheme

modelové rozhraní AgentEndpointAuthorizationScheme

AgentEndpointConfig

modelové rozhraní AgentEndpointConfig

AgentEvaluatorGenerationJobSource

Zdrojový kód agenta pro úlohy generující evaluator — odkazuje na agenta pro načítání instrukcí a metadat.

AgentHarness

(Náhled) Spravovaný běh a agentní smyčka používaná k vykonání prompt agenta.

AgentIdentity

modelové rozhraní AgentIdentity

AgentInsight

Přetrvávající problém odhalený ze stopy agenta.

AgentInsightDetails

Další podrobnosti. Vynecháno, pokud nejsou požadovány podrobnosti.

AgentInsightEstimatedCost

Odhadované náklady Agent Insights.

AgentInsightHighlightedTrace

Zvýrazněná stopa, která poskytuje důkaz pro vhled agenta.

AgentInsightJsonObject

JSON objekt používaný v payloadech Agent Insights.

AgentInsightLinkedTrace

Lehká stopová reference spojená s agentem jako podpůrným důkazem.

AgentInsightMonitor

Monitor Agent Insights na jednoho agenta, který vlastní konfiguraci, spouště a objevuje poznatky.

AgentInsightMonitorCreate

Pole přijímána při vytváření monitoru Agent Insights pro agenta.

AgentInsightMonitorListItem

Souhrn monitoru Agent Insights vrácený podle operací seznamu.

AgentInsightMonitorUpdate

Pole, která lze aktualizovat na monitoru Agent Insights.

AgentInsightProposedFix

Doporučená oprava pro vhled agenta.

AgentInsightProposedFixChange

Zákaznicky vykreslitelná změna navrhované opravy.

AgentInsightRecommendedAction

Doporučená sanace pro vhled agenta.

AgentInsightRun

Dlouhodobý běh, který analyzuje stopy jednoho agenta a aktualizuje jeho poznatky.

AgentInsightRunCreate

Vstupy používané při vytváření agentního vhledu běží.

AgentInsightRunResult

Výsledné statistiky vytvořené, když je úspěšný průběh agentního vhledu.

AgentInsightSuspension

Strukturovaný důvod, proč je plánovaná výroba u monitoru pozastavena.

AgentInsightTokenUsage

Využití tokenů pro běh Agent Insights.

AgentInsightUpdate

Pole, která lze aktualizovat v agentském insightu.

AgentInsightsOverview

Efektivní přehled pro monitor Agent Insights.

AgentInsightsOverviewOverride

Přehled poskytnutý uživatelem, který okamžitě nabývá účinnosti a zasévá další generaci.

AgentOptimizationCandidate

Agregovaný výsledek hodnocení konfigurace jednoho kandidáta na agenta napříč všemi úkoly.

AgentOptimizationDatasetCriterion

Hodnotící kritérium: pár jméno + instrukce používaný pro hodnocení jednotlivých položek.

AgentOptimizationDatasetInput

Základní diskriminační model pro vstup do datové sady. Buď inline položky, nebo registrovaný referenční zdroj.

AgentOptimizationDatasetItem

Jeden prvek v inline datasetu.

AgentOptimizationEvaluatorRef

Odkaz na jmenovaného hodnotitele, volitelně připnutý k verzi.

AgentOptimizationInlineDatasetInput

Inline dataset — položky dodávané přímo v těle požadavků.

AgentOptimizationJob

Zdroj práce optimalizace agentů — dlouhodobá práce, která optimalizuje konfiguraci agenta (instrukce, model, dovednosti, nástroje) za účelem maximalizace hodnotících skóre. Při úspěchu výsledek obsahuje ohodnocení kandidátů.

AgentOptimizationJobInputs

Vstupy dodané volajícím pro optimalizační úlohu.

AgentOptimizationJobListItem

Úzká reprezentace pracovních míst vrácená endpointem LIST.

AgentOptimizationJobProgress

Průběh během letu; Pouze když je status ve frontě nebo in_progress.

AgentOptimizationJobResult

Tělo výsledků v terminálním stavu. Vyplněné, když je status úspěšný nebo neúspěšný.

AgentOptimizationOptions

Ladění knoflíků a režimu běhu pro optimalizační úkol.

AgentOptimizationReferenceDatasetInput

Odkaz na registrovanou datovou sadu Foundry.

AgentSessionResource

Agentní relace poskytující dlouhotrvající výpočetní sandbox pro hostované volání agentů.

AgentTaxonomyInput

Konfigurace vstupu pro taxonomii vyhodnocení, pokud je typ vstupu agent.

AgentVersion

Představuje konkrétní verzi agenta. Zahrnuje metadata, správu verzí, čas vytvoření a definici agenta.

AgenticIdentityPreviewCredentials

Definice přihlašovacích údajů identity agenta

AgentsCreateAgentFromManifestOptionalParams

Volitelné parametry.

AgentsCreateAgentVersionFromManifestOptionalParams

Volitelné parametry.

AgentsCreateOptionalParams

Volitelné parametry.

AgentsCreateSessionOptionalParams

Volitelné parametry.

AgentsCreateTelephonyBindingOptionalParams

Volitelné parametry.

AgentsCreateVersionFromCodeOptionalParams

Volitelné parametry.

AgentsCreateVersionOptionalParams

Volitelné parametry.

AgentsDeleteOptionalParams

Volitelné parametry.

AgentsDeleteSessionFileOptionalParams

Volitelné parametry.

AgentsDeleteSessionOptionalParams

Volitelné parametry.

AgentsDeleteTelephonyBindingOptionalParams

Volitelné parametry.

AgentsDeleteVersionOptionalParams

Volitelné parametry.

AgentsDisableOptionalParams

Volitelné parametry.

AgentsDownloadAgentCodeOptionalParams

Volitelné parametry.

AgentsDownloadSessionFileOptionalParams

Volitelné parametry.

AgentsEnableOptionalParams

Volitelné parametry.

AgentsGetOptionalParams

Volitelné parametry.

AgentsGetSessionLogStreamOptionalParams

Volitelné parametry.

AgentsGetSessionOptionalParams

Volitelné parametry.

AgentsGetTelephonyBindingOptionalParams

Volitelné parametry.

AgentsGetVersionOptionalParams

Volitelné parametry.

AgentsListOptionalParams

Volitelné parametry.

AgentsListSessionFilesOptionalParams

Volitelné parametry.

AgentsListSessionsOptionalParams

Volitelné parametry.

AgentsListTelephonyBindingsOptionalParams

Volitelné parametry.

AgentsListTelephonyCallsOptionalParams

Volitelné parametry.

AgentsListVersionsOptionalParams

Volitelné parametry.

AgentsOperations

Rozhraní reprezentující operace agentů.

AgentsStopSessionOptionalParams

Volitelné parametry.

AgentsUpdateAgentFromManifestOptionalParams

Volitelné parametry.

AgentsUpdateAgentObjectOptionalParams

Volitelné parametry.

AgentsUpdateOptionalParams

Volitelné parametry.

AgentsUpdateTelephonyBindingOptionalParams

Volitelné parametry.

AgentsUploadSessionFileOptionalParams

Volitelné parametry.

ApiErrorResponse

Chybová odpověď při selhání rozhraní API.

ApiKeyCredentials

Definice přihlašovacích údajů klíče rozhraní API

ApplyPatchToolParam

Umožňuje asistentovi vytvářet, mazat nebo aktualizovat soubory pomocí sjednocených rozdílů.

ApproximateLocation

modelové rozhraní ApproximateLocation

ArtifactProfile

Profil artefaktu modelu

AutoCodeInterpreterToolParam

Konfigurace kontejneru interpretu kódu Volitelně zadejte ID souborů, na kterých se má kód spustit.

AzureAIAgentTarget

Představuje cíl specifikující Azure AI agenta.

AzureAIModelTarget

Představuje cíl specifikující Azure AI model pro operace vyžadující výběr modelu.

AzureAISearchIndex

Definice indexu Azure AI Vyhledávač

AzureAISearchTool

Vstupní definice informací pro vyhledávací nástroj Azure AI, jak se používá ke konfiguraci agenta.

AzureAISearchToolResource

Sada prostředků indexu, které nástroj azure_ai_search používá.

AzureAISearchToolboxTool

Nástroj Azure AI Vyhledávač uložený v toolboxu.

AzureAgentConfig

Konfigurační možnosti pro agentní endpoint metody getOpenAIClient. Hlavně se používá pro hostované agenty.

AzureFunctionBinding

Struktura pro zachování názvu fronty a identifikátoru URI storage.

AzureFunctionDefinition

Definice funkce Azure.

AzureFunctionStorageQueue

Struktura pro zachování názvu fronty a identifikátoru URI storage.

AzureFunctionTool

Vstupní definice pro Azure Function Tool, jak se používá ke konfiguraci agenta.

AzureOpenAIModelConfiguration

Azure konfiguraci modelu OpenAI. Služba by vybrala verzi rozhraní API pro dotazování modelu.

BaseCredentials

Základní třída pro pověření pro připojení

BetaAgentInsightMonitorsCancelRunOptionalParams

Volitelné parametry.

BetaAgentInsightMonitorsCreateOptionalParams

Volitelné parametry.

BetaAgentInsightMonitorsCreateRunOptionalParams

Volitelné parametry.

BetaAgentInsightMonitorsDeleteOptionalParams

Volitelné parametry.

BetaAgentInsightMonitorsGetInsightOptionalParams

Volitelné parametry.

BetaAgentInsightMonitorsGetOptionalParams

Volitelné parametry.

BetaAgentInsightMonitorsGetRunOptionalParams

Volitelné parametry.

BetaAgentInsightMonitorsListInsightsOptionalParams

Volitelné parametry.

BetaAgentInsightMonitorsListOptionalParams

Volitelné parametry.

BetaAgentInsightMonitorsListRunsOptionalParams

Volitelné parametry.

BetaAgentInsightMonitorsOperations

Rozhraní reprezentující operace BetaAgentInsightMonitors.

BetaAgentInsightMonitorsResetOptionalParams

Volitelné parametry.

BetaAgentInsightMonitorsUpdateInsightOptionalParams

Volitelné parametry.

BetaAgentInsightMonitorsUpdateOptionalParams

Volitelné parametry.

BetaAgentsCancelOptimizationJobOptionalParams

Volitelné parametry.

BetaAgentsCreateFromPromptOptionalParams

Volitelné parametry.

BetaAgentsCreateOptimizationJobOptionalParams

Volitelné parametry.

BetaAgentsDeleteOptimizationJobOptionalParams

Volitelné parametry.

BetaAgentsGetOptimizationJobOptionalParams

Volitelné parametry.

BetaAgentsListOptimizationJobsOptionalParams

Volitelné parametry.

BetaAgentsOperations

Provoz pro správu agentů.

BetaDatasetsCancelGenerationJobOptionalParams

Volitelné parametry.

BetaDatasetsCreateGenerationJobOptionalParams

Volitelné parametry.

BetaDatasetsDeleteGenerationJobOptionalParams

Volitelné parametry.

BetaDatasetsGetGenerationJobOptionalParams

Volitelné parametry.

BetaDatasetsListGenerationJobsOptionalParams

Volitelné parametry.

BetaDatasetsOperations

Rozhraní reprezentující operace BetaDatasets.

BetaEvaluationTaxonomiesCreateOptionalParams

Volitelné parametry.

BetaEvaluationTaxonomiesDeleteOptionalParams

Volitelné parametry.

BetaEvaluationTaxonomiesGetOptionalParams

Volitelné parametry.

BetaEvaluationTaxonomiesListOptionalParams

Volitelné parametry.

BetaEvaluationTaxonomiesOperations

Rozhraní reprezentující operace BetaEvaluationTaxonomies.

BetaEvaluationTaxonomiesUpdateOptionalParams

Volitelné parametry.

BetaEvaluatorsCancelGenerationJobOptionalParams

Volitelné parametry.

BetaEvaluatorsCreateGenerationJobOptionalParams

Volitelné parametry.

BetaEvaluatorsCreateVersionOptionalParams

Volitelné parametry.

BetaEvaluatorsDeleteGenerationJobOptionalParams

Volitelné parametry.

BetaEvaluatorsDeleteVersionOptionalParams

Volitelné parametry.

BetaEvaluatorsGetCredentialsOptionalParams

Volitelné parametry.

BetaEvaluatorsGetGenerationJobOptionalParams

Volitelné parametry.

BetaEvaluatorsGetVersionOptionalParams

Volitelné parametry.

BetaEvaluatorsListGenerationJobsOptionalParams

Volitelné parametry.

BetaEvaluatorsListOptionalParams

Volitelné parametry.

BetaEvaluatorsListVersionsOptionalParams

Volitelné parametry.

BetaEvaluatorsOperations

Rozhraní reprezentující operace BetaEvaluators.

BetaEvaluatorsPendingUploadOptionalParams

Volitelné parametry.

BetaEvaluatorsUpdateVersionOptionalParams

Volitelné parametry.

BetaInsightsGenerateOptionalParams

Volitelné parametry.

BetaInsightsGetOptionalParams

Volitelné parametry.

BetaInsightsListOptionalParams

Volitelné parametry.

BetaInsightsOperations

Rozhraní reprezentující operace BetaInsights.

BetaMemoryStoresCreateMemoryOptionalParams

Volitelné parametry.

BetaMemoryStoresCreateOptionalParams

Volitelné parametry.

BetaMemoryStoresDeleteMemoryOptionalParams

Volitelné parametry.

BetaMemoryStoresDeleteOptionalParams

Volitelné parametry.

BetaMemoryStoresDeleteScopeOptionalParams

Volitelné parametry.

BetaMemoryStoresGetMemoryOptionalParams

Volitelné parametry.

BetaMemoryStoresGetOptionalParams

Volitelné parametry.

BetaMemoryStoresGetUpdateResultOptionalParams

Volitelné parametry.

BetaMemoryStoresListMemoriesOptionalParams

Volitelné parametry.

BetaMemoryStoresListOptionalParams

Volitelné parametry.

BetaMemoryStoresOperations

Rozhraní reprezentující operace BetaMemoryStores.

BetaMemoryStoresSearchMemoriesOptionalParams

Volitelné parametry.

BetaMemoryStoresUpdateMemoriesOptionalParams

Volitelné parametry.

BetaMemoryStoresUpdateMemoryOptionalParams

Volitelné parametry.

BetaMemoryStoresUpdateOptionalParams

Volitelné parametry.

BetaModelsCreateOptions

Možnosti pro metodu vytváření, která nahrává lokální soubory a registruje verzi modelu.

BetaModelsDeleteOptionalParams

Volitelné parametry.

BetaModelsGetCredentialsOptionalParams

Volitelné parametry.

BetaModelsGetOptionalParams

Volitelné parametry.

BetaModelsListOptionalParams

Volitelné parametry.

BetaModelsListVersionsOptionalParams

Volitelné parametry.

BetaModelsOperations

Rozhraní reprezentující operace BetaModels.

BetaModelsPendingCreateVersionOptionalParams

Volitelné parametry.

BetaModelsPendingUploadOptionalParams

Volitelné parametry.

BetaModelsUpdateOptionalParams

Volitelné parametry.

BetaOperations

Rozhraní reprezentující Beta operace.

BetaRedTeamsCreateOptionalParams

Volitelné parametry.

BetaRedTeamsGetOptionalParams

Volitelné parametry.

BetaRedTeamsListOptionalParams

Volitelné parametry.

BetaRedTeamsOperations

Rozhraní reprezentující operace BetaRedTeams.

BetaRoutinesCreateOrUpdateOptionalParams

Volitelné parametry.

BetaRoutinesDeleteOptionalParams

Volitelné parametry.

BetaRoutinesDisableOptionalParams

Volitelné parametry.

BetaRoutinesDispatchOptionalParams

Volitelné parametry.

BetaRoutinesEnableOptionalParams

Volitelné parametry.

BetaRoutinesGetOptionalParams

Volitelné parametry.

BetaRoutinesListOptionalParams

Volitelné parametry.

BetaRoutinesListRunsOptionalParams

Volitelné parametry.

BetaRoutinesOperations

Rozhraní reprezentující operace BetaRoutines.

BetaSchedulesCreateOrUpdateOptionalParams

Volitelné parametry.

BetaSchedulesDeleteOptionalParams

Volitelné parametry.

BetaSchedulesGetOptionalParams

Volitelné parametry.

BetaSchedulesGetRunOptionalParams

Volitelné parametry.

BetaSchedulesListOptionalParams

Volitelné parametry.

BetaSchedulesListRunsOptionalParams

Volitelné parametry.

BetaSchedulesOperations

Rozhraní reprezentující operace BetaSchedules.

BetaSkillsCreateOptionalParams

Volitelné parametry.

BetaSkillsCreateVersionFromFilesOptionalParams

Volitelné parametry.

BetaSkillsDeleteOptionalParams

Volitelné parametry.

BetaSkillsDeleteVersionOptionalParams

Volitelné parametry.

BetaSkillsDownloadOptionalParams

Volitelné parametry.

BetaSkillsDownloadVersionOptionalParams

Volitelné parametry.

BetaSkillsGetOptionalParams

Volitelné parametry.

BetaSkillsGetVersionOptionalParams

Volitelné parametry.

BetaSkillsListOptionalParams

Volitelné parametry.

BetaSkillsListVersionsOptionalParams

Volitelné parametry.

BetaSkillsOperations

Rozhraní reprezentující operace BetaSkills.

BetaSkillsUpdateOptionalParams

Volitelné parametry.

BetaVoiceAgentsConversationsDeleteOptionalParams

Volitelné parametry.

BetaVoiceAgentsConversationsDownloadAudioItemOptionalParams

Volitelné parametry.

BetaVoiceAgentsConversationsDownloadAudioOptionalParams

Volitelné parametry.

BetaVoiceAgentsConversationsDownloadGeneratedAudioItemOptionalParams

Volitelné parametry.

BetaVoiceAgentsConversationsGetAudioItemOptionalParams

Volitelné parametry.

BetaVoiceAgentsConversationsGetAudioOptionalParams

Volitelné parametry.

BetaVoiceAgentsConversationsGetGeneratedAudioItemOptionalParams

Volitelné parametry.

BetaVoiceAgentsConversationsGetItemOptionalParams

Volitelné parametry.

BetaVoiceAgentsConversationsGetOptionalParams

Volitelné parametry.

BetaVoiceAgentsConversationsGetResponseOptionalParams

Volitelné parametry.

BetaVoiceAgentsConversationsListItemsOptionalParams

Volitelné parametry.

BetaVoiceAgentsConversationsListOptionalParams

Volitelné parametry.

BetaVoiceAgentsConversationsListResponseItemsOptionalParams

Volitelné parametry.

BetaVoiceAgentsConversationsListResponsesOptionalParams

Volitelné parametry.

BetaVoiceAgentsConversationsOperations

Operace pro správu hovorů s hlasovými agenty.

BetaVoiceAgentsOperations

Provoz pro správu hovorů s hlasovými agenty a telefonií.

BetaVoiceAgentsTelephonyCancelCallJobOptionalParams

Volitelné parametry.

BetaVoiceAgentsTelephonyCreateBindingOptionalParams

Volitelné parametry.

BetaVoiceAgentsTelephonyCreateCallJobOptionalParams

Volitelné parametry.

BetaVoiceAgentsTelephonyDeleteBindingOptionalParams

Volitelné parametry.

BetaVoiceAgentsTelephonyEndCallOptionalParams

Volitelné parametry.

BetaVoiceAgentsTelephonyGetBindingOptionalParams

Volitelné parametry.

BetaVoiceAgentsTelephonyGetCallJobOptionalParams

Volitelné parametry.

BetaVoiceAgentsTelephonyGetCallOptionalParams

Volitelné parametry.

BetaVoiceAgentsTelephonyGetTransferTargetsOptionalParams

Volitelné parametry.

BetaVoiceAgentsTelephonyListBindingsOptionalParams

Volitelné parametry.

BetaVoiceAgentsTelephonyListCallsOptionalParams

Volitelné parametry.

BetaVoiceAgentsTelephonyOperations

Provoz pro správu telefonie hlasových agentů.

BetaVoiceAgentsTelephonyReplaceTransferTargetsOptionalParams

Volitelné parametry.

BetaVoiceAgentsTelephonyTransferCallOptionalParams

Volitelné parametry.

BetaVoiceAgentsTelephonyUpdateBindingOptionalParams

Volitelné parametry.

BingCustomSearchConfiguration

Konfigurace vlastního vyhledávání bing.

BingCustomSearchPreviewTool

Informace o definici vstupu pro Bing vlastní vyhledávací nástroj, který slouží ke konfiguraci agenta.

BingCustomSearchToolParameters

Parametry vlastního vyhledávacího nástroje bing.

BingGroundingSearchConfiguration

Konfigurace hledání pro Bing uzemnění

BingGroundingSearchToolParameters

Parametry bing uzemnění vyhledávacího nástroje.

BingGroundingTool

Informace o definici vstupu pro bing vyhledávací nástroj, který slouží ke konfiguraci agenta.

BlobReference

Podrobnosti o referenčních informacích o objektech blob.

BotServiceAuthorizationScheme

modelové rozhraní BotServiceAuthorizationScheme

BotServiceRbacAuthorizationScheme

modelové rozhraní BotServiceRbacAuthorizationScheme

BotServiceTenantAuthorizationScheme

modelové rozhraní BotServiceTenantAuthorizationScheme

BrowserAutomationPreviewTool

Informace o definici vstupu pro nástroj pro automatizaci prohlížeče, který se používá ke konfiguraci agenta.

BrowserAutomationPreviewToolboxTool

Nástroj pro automatizaci prohlížeče uložený v nástrojové krabici.

BrowserAutomationToolConnectionParameters

Definice vstupních parametrů pro připojení používané nástrojem pro automatizaci prohlížeče.

BrowserAutomationToolParameters

Definice vstupních parametrů pro nástroj pro automatizaci prohlížeče.

CaptureStructuredOutputsTool

Nástroj pro zachycení strukturovaných výstupů

ChartCoordinate

Souřadnice pro analytický diagram.

ChatSummaryMemoryItem

Paměťová položka obsahující souhrn extrahovaný z konverzací.

ClusterInsightResult

Postřehy ze shlukové analýzy.

ClusterTokenUsage

Použití tokenu pro clusterovou analýzu

CodeBasedEvaluatorDefinition

Definice vyhodnocovače založená na kódu pomocí pythonského kódu

CodeConfiguration

Konfigurace nasazení založená na kódu pro hostovaného agenta.

CodeInterpreterTool

Nástroj, který spouští Python kód, aby pomohl generovat odpověď na výzvu.

CodeInterpreterToolboxTool

Nástroj pro interpretaci kódu uložený v nástrojové krabici.

ComparisonFilter

Filtr použitý k porovnání zadaného klíče atributu s danou hodnotou pomocí definované operace porovnání.

CompoundFilter

Kombinování více filtrů pomocí and nebo or.

ComputerTool

Nástroj, který řídí virtuální počítač. Přečtěte si další informace o počítačovém nástroji.

ComputerUsePreviewTool

Nástroj, který řídí virtuální počítač. Přečtěte si další informace o počítačovém nástroji.

Connection

Operace odpovědi ze seznamu a získání připojení

ConnectionsGetOptionalParams

Volitelné parametry.

ConnectionsGetWithCredentialsOptionalParams

Volitelné parametry.

ConnectionsListOptionalParams

Volitelné parametry.

ConnectionsOperations

Rozhraní představující operace Connections.

ContainerAutoParam

modelové rozhraní ContainerAutoParam

ContainerConfiguration

Konfigurace nasazení na bázi kontejnerů pro hostovaného agenta.

ContainerNetworkPolicyAllowlistParam

modelové rozhraní ContainerNetworkPolicyAllowlistParam

ContainerNetworkPolicyDisabledParam

modelové rozhraní ContainerNetworkPolicyDisabledParam

ContainerNetworkPolicyDomainSecretParam

modelové rozhraní ContainerNetworkPolicyDomainSecretParam

ContainerNetworkPolicyParam

Síťová přístupová politika pro kontejner.

ContainerSkill

modelové rozhraní ContainerSkill

ContinuousEvaluationRuleAction

Akce pravidla vyhodnocení pro průběžné vyhodnocování.

CosmosDBIndex

Definice indexu úložiště vektorů CosmosDB

CreateAgentVersionFromCodeContent

Vícedílné tělo požadavků pro aktualizaci nebo verzování kódového agenta (POST /agents/{name} a POST /agents/{name}/versions).

CreateAgentVersionFromCodeMetadata

JSON metadata pro operace agentů založených na kódu (vytváření, aktualizace, vytváření verze). Jméno agenta pochází z parametru URL cesty nebo hlavičky x-ms-agent-name , takže není zahrnuto v tomto modelu. Hash obsahu (SHA-256 zipu) je uveden v hlavičce x-ms-code-zip-sha256 .

CreateSkillVersionFromFilesBody

Vícedílné tělo požadavků pro vytvoření verze dovednosti ze souborů. Přijímá buď jeden zip soubor, nebo více jednotlivých souborů dovedností (nahrávání adresáře). Pro nahrání zip souborů server obsah extrahuje a ověřuje. Pro nahrávání adresářů jsou soubory ověřeny as-is.

CreateTeamsPhoneExtensionTelephonyBindingRequest

Žádost o vytvoření vazby Telefon v Microsoft Teams Extension.

CreateTelephonyBindingRequest

Žádost o vytvoření telefonické vazby.

CreateTelephonyCallJobRequest

Žádost o vytvoření jednoho trvalého úkolu pro přímý odchozí hovor.

CreateTranscriptionResponseJsonUsage

Statistiky využití tokenů pro požadavek.

CreateTwilioTelephonyBindingRequest

Žádost o vytvoření vazby ve Twilio.

CronTrigger

Spouštěč založený na Cronu.

CustomCredential

Vlastní definice přihlašovacích údajů

CustomGrammarFormatParam

Gramatiku definovanou uživatelem.

CustomRoutineTrigger

Spouštěč vlastních událostí.

CustomTextFormatParam

Neomezený volný text.

CustomToolParam

Vlastní nástroj, který zpracovává vstupy ve specifikovaném formátu. Další informace o nástrojích custom tools

CustomToolParamFormat

Vstupní formát pro vlastní nástroj. Výchozí je neomezený text.

DailyRecurrenceSchedule

Denní plán opakování.

DataGenerationJob

Zdroj pracovních pozic pro generování dat.

DataGenerationJobInputs

Vstupy dodávané volajícím pro úkol generování dat.

DataGenerationJobOptions

Možnosti správy pracovních míst pro generování dat.

DataGenerationJobOutput

Výstupní informace pro práci generující data.

DataGenerationJobOutputOptions

Možnosti výstupu pro generování dat.

DataGenerationJobResult

Výsledkem je úspěšná práce generující data.

DataGenerationJobSource

Základní zdrojový model pro práce generující data.

DataGenerationModelOptions

Možnosti modelování LLM pro práce generující data.

DataGenerationTokenUsage

Informace o využití tokenů pro práci generující data.

DatasetCredential

Představuje odkaz na objekt blob určený ke spotřebě

DatasetDataGenerationJobOutput

Výstup datové sady pro generování dat.

DatasetEvaluatorGenerationJobSource

Zdroj datové sady pro úkoly generování hodnotitelů — odkaz na datovou sadu.

DatasetReference

Odkaz na verzovanou Foundry datovou sadu.

DatasetVersion

Definice DatasetVersion

DatasetsCreateOrUpdateOptionalParams

Volitelné parametry.

DatasetsDeleteOptionalParams

Volitelné parametry.

DatasetsGetCredentialsOptionalParams

Volitelné parametry.

DatasetsGetOptionalParams

Volitelné parametry.

DatasetsListOptionalParams

Volitelné parametry.

DatasetsListVersionsOptionalParams

Volitelné parametry.

DatasetsOperations

Rozhraní reprezentující operace s datovými sadami.

DatasetsPendingUploadOptionalParams

Volitelné parametry.

DeleteAgentResponse

Odstraněný objekt agenta

DeleteAgentVersionResponse

Objekt verze odstraněného agenta

DeleteMemoryResponse

Odpověď na smazání položky z paměťového úložiště.

DeleteMemoryStoreResponse

rozhraní modelu DeleteMemoryStoreResponse

DeleteSkillResponse

Vymazaná dovednost.

DeleteSkillVersionResponse

Vymazaná verze se schopností.

Deployment

Definice nasazení modelu

DeploymentsGetOptionalParams

Volitelné parametry.

DeploymentsListOptionalParams

Volitelné parametry.

DeploymentsOperations

Rozhraní představující Deployments operations.

Dimension

Jedna dimenze — jedna nezávislá, měřitelná kvalitativní dimenze v rámci hodnoticího plánu hodnotitele hodnotícího hodnotitelství.

DispatchRoutineResponse

Identifikátory vrácené po zařazení rutinního odeslání.

EmbeddingConfiguration

Vložení konfigurační třídy

EmptyModelParam

modelové rozhraní EmptyModelParam

EndpointBasedEvaluatorDefinition

Definice hodnotitele založeného na koncových točkách. Zákazník vlastní a hostuje HTTP endpoint, který implementuje hodnotící smlouvu. Evaluator odkazuje na Project Connection jménem; spojení ukládá URL koncového bodu a přihlašovací údaje (API klíč nebo Entra ID). Při spuštění služba vyřeší spojení, aby získala URL koncového bodu a autentizační údaje, poté volá konec pro každý hodnotící řádek.

EntraAuthorizationScheme

Model interface EntraAuthorizationScheme

EntraIDCredentials

Definice přihlašovacího oprávnění Entra ID

ErrorModel

modelové rozhraní ErrorModel

EvalResult

Výsledek vyhodnocení.

EvalRunResultCompareItem

Porovnání metrik léčby s výchozí hodnotou.

EvalRunResultComparison

Výsledky srovnání léčby jsou v porovnání s výchozí hodnotou.

EvalRunResultSummary

Souhrnná statistika metriky v běhu vyhodnocení.

EvaluationComparisonInsightRequest

Žádost o porovnání vyhodnocení

EvaluationComparisonInsightResult

Postřehy z porovnání hodnocení.

EvaluationResultSample

Ukázka z výsledku vyhodnocení.

EvaluationRule

Model vyhodnocovacího pravidla.

EvaluationRuleAction

Akční model vyhodnocení.

EvaluationRuleFilter

Model filtru vyhodnocení.

EvaluationRulesCreateOrUpdateOptionalParams

Volitelné parametry.

EvaluationRulesDeleteOptionalParams

Volitelné parametry.

EvaluationRulesGetOptionalParams

Volitelné parametry.

EvaluationRulesListOptionalParams

Volitelné parametry.

EvaluationRulesOperations

Rozhraní reprezentující operace EvaluationRules.

EvaluationRunClusterInsightRequest

Poznatky o sadě výsledků vyhodnocení

EvaluationRunClusterInsightResult

Poznatky z vyhodnocení spustí shlukovou analýzu.

EvaluationScheduleTask

Vyhodnocení úlohy pro harmonogram.

EvaluationTarget

Základní třída pro cíle s podporou diskriminátoru.

EvaluationTaxonomy

Definice taxonomie hodnocení

EvaluationTaxonomyInput

Konfigurace vstupu pro taxonomii vyhodnocení.

EvaluatorCredentialRequest

Tělo žádostí o získání kvalifikace hodnotitele

EvaluatorDefinition

Základní konfigurace vyhodnocovače s diskriminátorem

EvaluatorGenerationArtifacts

Artefakty provenence spravované službou vytvořené prací generující hodnotitele. Přítomné pouze na zdrojích EvaluatorVersion vytvořených generačním pipeline. Kombinovaná JSONL Foundry datasada je pouze pro čtení a přechází do verzované datové sady v jmenném prostoru rezervovaném pro službu.

EvaluatorGenerationInputs

Vstupy dodávané volajícím pro generování hodnotitele.

EvaluatorGenerationJob

Resource Evaluator Generation Job — dlouhodobá práce, která generuje definice hodnotitelů založené na hodnoticích hodnoticích metodách ze zdrojových materiálů. Při úspěchu je výsledkem přetrvávající EvaluatorVersion.

EvaluatorGenerationJobSource

Základní zdrojový model pro pracovní pozice generující hodnotitele. Polymorfní nad type.

EvaluatorGenerationTokenUsage

Shrnutí spotřeby tokenů pro práci generující hodnotitele. Objeví se, když úkol dosáhne terminálního stavu.

EvaluatorMetric

Metrika hodnotitele

EvaluatorVersion

Definice hodnotitele

ExternalAgentDefinition

Definice externího agenta. Reprezentuje agenta třetí strany hostovaného mimo Foundry (například na GCP nebo AWS). Registrace je pouze metadata: Foundry zaznamenává definici agenta, aby osvětlila pozorovatelné zkušenosti (stopy, hodnocení) nad zákaznicky emitovanými daty OpenTelemetry.

FabricDataAgentToolParameters

Parametry nástroje agenta dat prostředků Fabric.

FabricIQPreviewTool

Nástroj na straně serveru FabricIQ.

FabricIQPreviewToolboxTool

Nástroj FabricIQ uložený v nástrojové bedně.

FieldMapping

Třída konfigurace mapování polí

FileDataGenerationJobOutput

Azure OpenAI file output for a data generation job.

FileDataGenerationJobSource

Zdroj souboru pro data generation jobs — Azure OpenAI file input.

FileDatasetVersion

Definice FileDatasetVersion

FileSearchTool

Nástroj, který hledá relevantní obsah z nahraných souborů. Přečtěte si další informace o nástroji pro vyhledávání souborů.

FileSearchToolboxTool

Nástroj pro vyhledávání souborů uložený v toolboxu.

FixedRatioVersionSelectionRule

modelové rozhraní FixedRatioVersionSelectionRule

FolderDatasetVersion

Definice FileDatasetVersion

FoundryModelWarning

Varování spojené s modelem.

FunctionShellToolParam

Nástroj, který umožňuje modelu provádět příkazy shellu.

FunctionShellToolParamEnvironment

modelové rozhraní FunctionShellToolParamEnvironment

FunctionShellToolParamEnvironmentContainerReferenceParam

model interface FunctionShellToolParamEnvironmentContainerReferenceParam

FunctionShellToolParamEnvironmentLocalEnvironmentParam

Model interface FunctionShellToolParamEnvironmentLocalEnvironmentParam

FunctionTool

Ve vašem vlastním kódu definuje funkci, kterou může model volitelně volat. Přečtěte si další informace o volání funkcí.

FunctionToolParam

modelové rozhraní FunctionToolParam

GenAITracingOptions

Možnosti konfigurace sledování GenAI na konkrétní instanci AIProjectClient.

Tyto přenášejte pod tracingOptions klíč AIProjectClientOptionalParams, abyste umožnili sledování GenAI při instanci klienta. Každá klientská instance si udržuje vlastní nezávislou konfiguraci trasování.

GenerateVoiceAgentRequest

Vstupy pro generování hlasového agenta. Pouze kind a jsou vždy vyžadovány name . Služba pro autorství tyto vstupy rozšiřuje do plného, upravovatelného VoiceAgentDefinition, který je pak vytvořen pomocí POST /agents. Generovaná instructions a zvuková/hlasová nastavení jsou uložena jako samostatná pole ve výsledné definici agenta, takže volající může libovolné pole později upravovat nebo přepsat pomocí standardního verzování agenta.

GetMicrosoft365PackageOptionalParams

Volitelné parametry.

GetMicrosoft365PublishDefaultsOptionalParams

Volitelné parametry.

GitHubCopilotHarness

(Náhled) Spravovaný postroj GitHub Copilot pro prompt agenty.

GitHubCopilotToolsetConfig

Přepsání povolení pro vestavěný nástroj GitHub Copilot.

GitHubCopilotToolsetDefaultConfig

Výchozí nastavení pro vestavěné nástroje GitHub Copilot.

GitHubCopilotToolsetPreview

(Náhled) Konfigurační přepsání vestavěných nástrojů GitHub Copilot.

GitHubIssueRoutineTrigger

Rutinní spouštěč s problémem na GitHub.

HeaderTelemetryEndpointAuth

Tajné ověřování založené na hlavičkách pro telemetrický endpoint. Vyřešení hodnoty tajemství je vloženo jako HTTP hlavička.

HostedAgentDefinition

Definice hostovaného agenta.

HourlyRecurrenceSchedule

Hodinový plán opakování.

HumanEvaluationPreviewRuleAction

Akce pravidla vyhodnocení pro lidské hodnocení.

HybridSearchOptions

modelové rozhraní HybridSearchOptions

ImageGenTool

Nástroj, který generuje obrázky pomocí GPT modelů obrazů.

ImageGenToolInputImageMask

modelové rozhraní ImageGenGenToolInputImageMask

IndexesCreateOrUpdateOptionalParams

Volitelné parametry.

IndexesDeleteOptionalParams

Volitelné parametry.

IndexesGetOptionalParams

Volitelné parametry.

IndexesListOptionalParams

Volitelné parametry.

IndexesListVersionsOptionalParams

Volitelné parametry.

IndexesOperations

Rozhraní reprezentující a Indexuje operace.

InlineSkillParam

modelové rozhraní InlineSkillParam

InlineSkillSourceParam

Inline skill payload

Insight

Text odpovědi pro cluster insights.

InsightCluster

Shluk vzorků analýzy.

InsightGenerationRequest

Tělo požadavků pro generování poznatků.

InsightModelConfiguration

Konfigurace modelu použitého při generování náhledů.

InsightRequest

Žádost o zprávu o přehledech.

InsightResult

Výsledek poznatků.

InsightSample

Ukázka z analýzy.

InsightScheduleTask

Úkol Insight pro plán.

InsightSummary

Shrnutí analýzy shluků chyb.

InsightsMetadata

Metadata o poznatcích.

InvocationsProtocolConfiguration

Konfigurace specifická pro protokol volání.

InvocationsWsProtocolConfiguration

Konfigurace specifická pro protokol invocations založený na WebSocketu.

InvokeAgentInvocationsApiDispatchPayload

Manuální payload používaný k testování vysílání rutin API pro volání.

InvokeAgentInvocationsApiRoutineAction

Odesílá rutinu přes API pro raw invocations. Musí být poskytnuta přesně jedna z agent_name nebo agent_endpoint_id.

InvokeAgentResponsesApiDispatchPayload

Manuální payload používaný k testování rutiny pro odpovědí API při vysílání.

InvokeAgentResponsesApiRoutineAction

Odesílá rutinu přes API odpovědí. Musí být poskytnuta přesně jedna z agent_name nebo agent_endpoint_id.

JobOperationState

Stav operace pro dlouhodobě běžící operaci, která vytváří pracovní zdroj.

PŘIZPŮSOBENÍ: SDK-VYLEPŠENÍ: vysílané dotazovače se rozliší na terminální payload úlohy result , který nenese žádný identifikátor; jobId udržuje vytvořenou úlohu dosažitelnou.

LocalShellToolParam

Nástroj, který umožňuje modelu spouštět shell příkazy v místním prostředí.

LocalSkillParam

modelové rozhraní LocalSkillParam

LogProbProperties

Logaritmický pravděpodobnostní objekt.

LoraConfig

Metadata specifická pro adaptér pro LoRA modely. Řídí konfiguraci motoru při nasazení.

MCPListToolsTool

Nástroj dostupný na serveru MCP.

MCPListToolsToolAnnotations

modelové rozhraní MCPListToolsToolAnnotations

MCPListToolsToolInputSchema

modelové rozhraní MCPListToolsToolInputSchema

MCPTool

Udělte modelu přístup k dalším nástrojům prostřednictvím vzdálených serverů MCP (Model Context Protocol). Vyučte si další informace o MCP.

MCPToolFilter

Filtrační objekt, který určuje, které nástroje jsou povoleny.

MCPToolRequireApproval

modelové rozhraní MCPToolRequireApproval

MCPToolboxTool

MCP nástroj uložený v nástrojové krabici.

ManagedAgentIdentityBlueprintReference

modelové rozhraní ManagedAgentIdentityBlueprintReference

ManagedAzureAISearchIndex

Definace indexu Managed Azure AI Vyhledávač

McpProtocolConfiguration

Konfigurace specifická pro protokol MCP.

MemoryItem

Jedna paměťová položka uložená v paměťovém úložišti, která obsahuje obsah a metadata.

MemoryOperation

Představuje jednu operaci s pamětí (vytvoření, aktualizaci nebo odstranění) provedenou s položkou paměti.

MemorySearchItem

Načtená položka paměti z vyhledávání v paměti.

MemorySearchOptions

Možnosti vyhledávání v paměti.

MemorySearchPreviewTool

Nástroj pro integraci pamětí do agenta.

MemoryStore

Úložiště paměti, které může ukládat a načítat uživatelské paměti.

MemoryStoreDefaultDefinition

Výchozí implementace úložiště paměti.

MemoryStoreDefaultOptions

Výchozí konfigurace úložiště paměti.

MemoryStoreDefinition

Základní definice pro konfigurace paměťových úložišť.

MemoryStoreDeleteScopeResponse

Odpověď pro smazání pamětí z rozsahu.

MemoryStoreOperationUsage

Statistika využití operace úložiště paměti.

MemoryStoreSearchResponse

Odpověď na vyhledávání v paměti.

MemoryStoreUpdateCompletedResult

Výsledek aktualizace paměti.

MemoryStoreUpdateResponse

Poskytuje stav operace aktualizace úložiště paměti.

Metadata

Sada 16 párů klíč-hodnota, které lze připojit k objektu. To může být užitečné pro ukládání dalších informací o objektu ve strukturovaném formátu a dotazování na objekty prostřednictvím rozhraní API nebo řídicího panelu. Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce s maximální délkou 512 znaků.

Microsoft365PermissionScopes

Sada delegovaných rozsahů oprávnění požadovaných od jedné aplikace zdroje.

Microsoft365PublishDefaults

Výchozí a dříve publikované hodnoty používané k předvyplnění Microsoft 365 publikačního požadavku pro agenta Foundry.

Microsoft365PublishResponse

Odpověď z publikace agenta na Microsoft 365 / Microsoft Teams.

MicrosoftFabricPreviewTool

Vstupní definice pro nástroj Microsoft Fabric používaná ke konfiguraci agenta.

MisalignmentErrorDetailsResource

Detaily akce jsou blokovány, protože nemusí odpovídat záměru uživatele.

MisalignmentSteer

Veřejný pokyn pro pokračování po zablokování určité akce.

ModelCredentialRequest

Požadavek na získání přihlašovacích údajů pro modelový asset.

ModelDeployment

Definice nasazení modelu

ModelDeploymentSku

Informace o skladové posílce

ModelPendingUploadRequest

Představuje požadavek na čekající nahrání verze modelu.

ModelPendingUploadResponse

Představuje odpověď na požadavek na nahrání modelu.

ModelSamplingParams

Představuje sadu parametrů sloužících k řízení chování vzorkování jazykového modelu během generování textu.

ModelSourceData

Zdrojové informace pro model

ModelVersion

Definice verze modelu

MonthlyRecurrenceSchedule

Měsíční plán opakování.

NamespaceToolParam

Seskupuje funkční/vlastní nástroje pod sdíleným jmenným prostorem.

NoAuthenticationCredentials

Přihlašovací údaje, které nevyžadují ověření

OneTimeTrigger

Jednorázová spouštěč.

OpenAIClientOptionsWithAzureAgent

Rozšířené možnosti klienta OpenAI o konfiguraci endpointu Azure Agent.

OpenApiAnonymousAuthDetails

Podrobnosti zabezpečení pro anonymní ověřování OpenApi

OpenApiAuthDetails

podrobnosti o ověřování pro OpenApiFunctionDefinition

OpenApiFunctionDefinition

Informace o definici vstupu pro funkci openapi.

OpenApiManagedAuthDetails

Podrobnosti zabezpečení pro ověřování managed_identity OpenApi

OpenApiManagedSecurityScheme

Schéma zabezpečení pro ověřování managed_identity OpenApi

OpenApiProjectConnectionAuthDetails

Podrobnosti zabezpečení pro ověřování připojení project OpenApi

OpenApiProjectConnectionSecurityScheme

Schéma zabezpečení pro ověřování managed_identity OpenApi

OpenApiTool

Informace o definici vstupu pro nástroj OpenAPI, jak slouží ke konfiguraci agenta.

OpenApiToolboxTool

Nástroj OpenAPI uložený v toolboxu.

OptimizedAgentIdentifier

Identifikuje registrovaného agenta Foundry pro optimalizaci (pouze na žádost). Dovednosti, nástroje a system_prompt jsou specifikovány v options.optimization_config.

OtlpTelemetryEndpoint

Endpoint pro export telemetrie OTLP (OpenTelemetry Protocol).

PageSettings

Rozhraní, které sleduje nastavení stránkované iterace

PagedAsyncIterableIterator

Rozhraní, které umožňuje asynchronní iteraci k dokončení i po stránce.

PendingUploadRequest

Představuje požadavek na čekající nahrání.

PendingUploadResponse

Představuje odpověď na čekající žádost o nahrání

PickPropertiesVoiceAgentAudioConfig

Šablona pro výběr nemovitostí.

ProceduralMemoryItem

Paměťový prvek obsahující postup extrahovaný z konverzací.

ProgrammaticToolCallingParam

modelové rozhraní ProgrammaticToolCallingParam

PromotionInfo

Metadata povýšení zaznamenaná při nasazení kandidáta k agentovi Foundry.

PromptAgentDefinition

Definice agenta výzvy

PromptAgentDefinitionTextOptions

Možnosti konfigurace textové odpovědi z modelu Může to být prostý text nebo strukturovaná data JSON.

PromptBasedEvaluatorDefinition

Hodnotitel založený na výzvě

PromptDataGenerationJobSource

Zdroj promptu pro úkoly generování dat — text v textu poskytnutý uživatelem.

PromptEvaluatorGenerationJobSource

Zdroj promptu pro úlohy generování hodnotitelů — text v textu poskytnutý uživatelem.

ProtocolConfiguration

Konfigurace pro protokol pro koncový bod agenta.

ProtocolVersionRecord

Mapování záznamů pro jeden protokol a jeho verzi.

PstnTelephonyTransferDestination

PSTN cíl pro telekomunikační přenos.

PublishToMicrosoft365OptionalParams

Volitelné parametry.

RaiConfig

Konfigurace pro filtrování obsahu a bezpečnostní funkce zodpovědné umělé inteligence (RAI).

RaiInvocationModeration

Deklaruje, kde se nachází text žádosti/odpovědi, aby jej mohly získat bezpečnostní zábrany obsahu.

RaiSseTextSelector

Výběr typu události SSE do textového pole pro streamování výstupů volání.

RankingOptions

Rozhraní modelů RankingOptions

RealtimeAudioFormats

modelové rozhraní RealtimeAudioFormats

RealtimeAudioFormatsAudioPcm

modelové rozhraní RealtimeAudioFormatsAudioPcm

RealtimeAudioFormatsAudioPcma

modelové rozhraní RealtimeAudioFormatsAudioPcma

RealtimeAudioFormatsAudioPcmu

modelové rozhraní RealtimeAudioFormatsAudioPcmu

RealtimeClientEvent

Akce pro klienta v reálném čase.

RealtimeClientEventConversationItemCreate

Přidejte do kontextu konverzace nový Předmět, včetně zpráv, volání funkcí a odpovědí na volání funkcí. Tato událost může být použita jak k naplnění "historie" konverzace, tak k přidání nových položek uprostřed streamu, ale má současné omezení, že nemůže vyplnit zvukové zprávy asistenta. Pokud je úspěšný, server odpoví událostíconversation.item.created, jinak bude odeslána událost.error

RealtimeClientEventConversationItemDelete

Tuto událost pošlete tehdy, když chcete odstranit nějakou položku z historie konverzace. Server odpoví událostí conversation.item.deleted , pokud tato položka v historii konverzace neexistuje, v takovém případě server odpoví chybou.

RealtimeClientEventConversationItemRetrieve

Tuto událost pošli, když chcete získat serverovou reprezentaci konkrétního předmětu v historii konverzace. To je užitečné například pro kontrolu uživatelského zvuku po potlačení šumu a VAD. Server odpoví událostí conversation.item.retrieved , pokud tato položka v historii konverzace neexistuje, v takovém případě server odpoví chybou.

RealtimeClientEventConversationItemTruncate

Pošlete tuto událost ke zkrácení zvuku předchozí asistentské zprávy. Server bude produkovat zvuk rychleji než v reálném čase, takže tato událost je užitečná, když uživatel přeruší zvuk a zkrátí zvuk, který již byl klientovi odeslán, ale ještě nebyl přehrán. Tím se synchronizuje porozumění zvuku serverem s přehráváním klienta. Zkrácení zvuku smaže přepis textu na straně serveru, aby se zajistilo, že v kontextu není text, který uživatel neslyšel. Pokud je to úspěšné, server odpoví událostí conversation.item.truncated .

RealtimeClientEventInputAudioBufferAppend

Pošlete tuto událost a připojte audio bajty do vstupní audio buffer. Zvukový pufr je dočasné úložiště, do kterého můžete zapisovat a později zavést. "Commit" vytvoří novou položku uživatelské zprávy v historii konverzace z obsahu bufferu a vymaže buffer. Vstupní přepis zvuku (pokud je zapnutý) bude generován při commitování bufferu. Pokud je VAD povolen, audio buffer se použije k detekci řeči a server rozhodne, kdy se projeví commit. Když je Server VAD vypnutý, musíte audio buffer uložit ručně. Redukce šumu u vstupu audio signálu probíhá při zápisech do vyrovnávací paměti zvuku. Klient si může zvolit, kolik zvuku umístí do každé události až do maxima 15 MiB, například streamování menších částí z klienta může umožnit VAD být citlivější. Na rozdíl od většiny ostatních klientských událostí server na tuto událost neodešle potvrzovací odpověď.

RealtimeClientEventInputAudioBufferClear

Pošli tuto událost pro vymazání audio bajtů v bufferu. Server odpoví událostí input_audio_buffer.cleared .

RealtimeClientEventInputAudioBufferCommit

Odešlete tuto událost pro uložení uživatelského vstupního audio bufferu, který vytvoří novou položku uživatelské zprávy v konverzaci. Tato událost způsobí chybu, pokud je vstupní audio buffer prázdný. V režimu Server VAD klient nemusí tuto událost odesílat, server automaticky uloží audio buffer. Commitování vstupního audio bufferu spustí vstupní audio transkripci (pokud je v konfiguraci relace povoleno), ale nevytvoří odpověď z modelu. Server odpoví událostí input_audio_buffer.committed .

RealtimeClientEventOutputAudioBufferClear

Pouze WebRTC/SIP: Vysílejte tak, abyste přerušili aktuální zvukovou odezvu. To spustí způsob, že server přestane generovat zvuk a vygeneruje událost.output_audio_buffer.cleared Tato událost by měla předcházet response.cancel události klienta, aby se zastavilo generování aktuální odpovědi. Další informace.

RealtimeClientEventResponseCancel

Pošlete tuto událost ke zrušení probíhající odpovědi. Server odpoví událostí se stavem response.doneresponse.status=cancelled. Pokud nepřijde odpověď na zrušení, server odpoví chybou. Je bezpečné volat response.cancel , i když žádná odpověď neprobíhá, chyba se vrátí a relace zůstane neovlivněna.

RealtimeClientEventResponseCreate

Tato událost instruuje server, aby vytvořil odpověď, což znamená spuštění modelové inference. V režimu Server VAD server automaticky vytvoří odpovědi. Odpověď bude obsahovat alespoň jednu položku a může mít dvě, v takovém případě bude druhá voláním funkce. Tyto položky budou ve výchozím nastavení přidány do historie konverzací. Server odpoví událostí response.created , událostmi pro položky a vytvořený obsah a nakonec událostí response.done , která oznamuje, že odpověď je dokončena. Událost response.create zahrnuje inferenční konfiguraci jako instructions a tools. Pokud jsou tyto nastavení nastavené, přepíší konfiguraci relace pouze pro tuto odpověď. Odpovědi lze vytvářet mimo pásmo výchozí konverzace, což znamená, že mohou mít libovolný vstup, a je možné deaktivovat zápis výstupu do konverzace. Pouze jedna odpověď může zapsat do výchozí konverzace najednou, jinak však lze paralelně vytvářet více odpovědí. Pole metadata je dobrý způsob, jak rozlišit více současných odpovědí. Klienti mohou nastavit conversation na none vytvoření odpovědi, která se nezapíše do výchozí konverzace. Libovolný vstup může být poskytnut pomocí input pole, což je pole přijímající surové položky a odkazy na existující položky.

RealtimeConversationItem

Jedna položka v konverzaci v reálném čase

RealtimeConversationItemFunctionCall

Funkční volací položka v reálném čase konverzace.

RealtimeConversationItemFunctionCallOutput

Funkce volání vydává položku v reálném čase konverzace.

RealtimeConversationItemMessage

Rozhraní modelu: RealtimeConversationItemMessage

RealtimeConversationItemMessageAssistant

Položka zprávy asistenta v reálném čase.

RealtimeConversationItemMessageAssistantContent

modelové rozhraní RealtimeKonverzacePoložkaAsistent zprávObsah

RealtimeConversationItemMessageSystem

Systémová zpráva v reálném čase může být použita k poskytnutí dalšího kontextu nebo instrukcí modelu. To je podobné, ale odlišné od instrukční výzvy na začátku konverzace, protože systémové zprávy lze přidávat kdykoli během konverzace. Pro zásadní změny chování konverzace použijte instrukce, ale pro menší aktualizace (např. "uživatel se nyní ptá na jiné téma") použijte systémové zprávy.

RealtimeConversationItemMessageSystemContent

modelové rozhraní RealtimeKonverzacePoložkaZprávaSystém Obsah

RealtimeConversationItemMessageUser

Uživatelská zpráva v reálném čase konverzace.

RealtimeConversationItemMessageUserContent

modelové rozhraní RealtimeKonverzacePoložkaZprávaUživatelský obsah

RealtimeFunctionTool

modelové rozhraní RealtimeFunctionTool

RealtimeMCPApprovalRequest

Položka v reálném čase žádající o lidský souhlas s vyvoláním nástroje.

RealtimeMCPApprovalResponse

Položka v reálném čase reagující na žádost o schválení MCP.

RealtimeMCPError

modelové rozhraní RealtimeMCPError

RealtimeMCPHttpError

modelové rozhraní RealtimeMCPHttpError

RealtimeMCPListTools

Nástroje pro výpis položek v reálném čase dostupné na MCP serveru.

RealtimeMCPProtocolError

modelové rozhraní RealtimeMCPProtocolError

RealtimeMCPToolCall

Položka v reálném čase představující vyvolání nástroje na MCP serveru.

RealtimeMCPToolExecutionError

modelové rozhraní RealtimeMCPToolExecutionError

RealtimeReasoning

Konfigurace pro modely schopné uvažování v reálném čase, jako je gpt-realtime-2.

RealtimeResponseStatusDetails

modelové rozhraní RealtimeResponseStatusDetails

RealtimeResponseStatusDetailsError

modelové rozhraní RealtimeResponseStatusDetailsError

RealtimeResponseUsage

modelové rozhraní RealtimeResponseUsage

RealtimeResponseUsageInputTokenDetails

modelové rozhraní RealtimeResponseUsageInputTokenDetails

RealtimeResponseUsageInputTokenDetailsCachedTokensDetails

modelové rozhraní RealtimeResponseUsageInputTokenDetailsCachedTokensDetails

RealtimeResponseUsageOutputTokenDetails

Rozhraní modelu: RealtimeResponseUsageOutputTokenDetails

RealtimeServerEvent

Událost na serveru v reálném čase.

RealtimeServerEventConversationItemAdded

Odesílá ho server, když je položka přidána do výchozí konverzace. To se může stát v několika případech:

  • Když klient odešle událost.conversation.item.create
  • Když je vstupní audio buffer uložen. V tomto případě bude položkou uživatelská zpráva obsahující zvuk z bufferu.
  • Když model generuje odpověď. V tomto případě bude událost odeslánaconversation.item.added, když model začne generovat konkrétní položku, a tedy zatím nebude obsahovat (a status bude ).in_progress Událost bude obsahovat celý obsah položky (kromě případů, kdy model generuje odpověď), kromě zvukových dat, která lze v případě potřeby získat samostatně s událostí conversation.item.retrieve .
RealtimeServerEventConversationItemCreated

Vrací se, když je vytvořena konverzační položka. Existuje několik scénářů, které vygenerují tuto událost:

  • Server generuje odpověď, která v případě úspěchu vyprodukuje buď jednu nebo dvě položky, které budou typu message (role assistant) nebo typu function_call.
  • Vstupní audio buffer byl uložen buď klientem, nebo serverem (v režimu server_vad ). Server vezme obsah vstupního audio bufferu a přidá ho do nové položky uživatelské zprávy.
  • Klient poslal conversation.item.create událost pro přidání nové položky do konverzace.
RealtimeServerEventConversationItemDeleted

Vrátí se, když klient smaže položku v konverzaci s událostí conversation.item.delete . Tato událost slouží k synchronizaci porozumění historii konverzací serveru se zobrazením klienta.

RealtimeServerEventConversationItemDone

Vráceno, když je téma konverzace finalizováno. Akce bude obsahovat celý obsah položky kromě zvukových dat, která lze v případě potřeby získat samostatně s událostí conversation.item.retrieve .

RealtimeServerEventConversationItemInputAudioTranscriptionCompleted

Tato událost je výstupem audio transkripce uživatelského zvuku zapsaného do uživatelského audio bufferu. Přepis začíná, když klient nebo server potvrdí vstupní zvukovou vyrovnávací paměť (když je povolen VAD). Přepis běží asynchronně s tvorbou Response, takže tato událost může nastat před nebo po událostech Response. Modely API v reálném čase přijímají zvuk nativně, a proto je vstupní transkripce samostatným procesem běžícím na samostatném modelu ASR (automatické rozpoznávání řeči). Přepis se může poněkud lišit od interpretace modelu a měl by být považován za hrubý vodítko.

RealtimeServerEventConversationItemInputAudioTranscriptionDelta

Vrací se, když je textová hodnota vstupní části transkripce zvuku aktualizována o inkrementální výsledky transkripce.

RealtimeServerEventConversationItemInputAudioTranscriptionFailed

Vráceno při konfiguraci vstupního audio přepisu a neúspěšném přepisu uživatelské zprávy. Tyto události jsou oddělené od ostatních error událostí, aby klient mohl identifikovat příslušnou položku.

RealtimeServerEventConversationItemInputAudioTranscriptionFailedError

modelové rozhraní RealtimeServerEventKonverzacePoložkaVstupAudioTranskripcionChyba

RealtimeServerEventConversationItemInputAudioTranscriptionSegment

Vráceno, když je pro položku identifikován vstupní audio transkripční segment.

RealtimeServerEventConversationItemRetrieved

Vráceno, když je konverzační položka načtena s .conversation.item.retrieve Toto je poskytováno jako způsob, jak získat reprezentaci položky ze serveru, například pro přístup k postzpracovaným audio datům po potlačení šumu a VAD. Obsahuje celý obsah Předmětu, včetně zvukových dat.

RealtimeServerEventConversationItemTruncated

Vráceno, když klient zkrátí předchozí položku zvukové zprávy asistenta událostí conversation.item.truncate . Tato událost slouží k synchronizaci porozumění zvuku serverem s přehráváním klienta. Tato akce zkrátí audio a odstraní přepis textu na straně serveru, aby se zajistilo, že v kontextu není text, který uživatel neslyšel.

RealtimeServerEventError

Vrací se, když dojde k chybě, která může být problém klienta nebo serveru. Většina chyb je obnovitelná a relace zůstane otevřená, doporučujeme implementátorům monitorovat a zaznamenávat chybové zprávy jako výchozí hodnotu.

RealtimeServerEventErrorError

modelové rozhraní RealtimeServerEventErrorError

RealtimeServerEventInputAudioBufferCleared

Vrátí se, když klient vymaže vstupní audio buffer událostí input_audio_buffer.clear .

RealtimeServerEventInputAudioBufferCommitted

Vrací se, když je vstupní audio buffer uložen, buď klientem, nebo automaticky v serverovém VAD režimu. Vlastností item_id je ID položky uživatelské zprávy, která bude vytvořena, takže conversation.item.created událost bude také odeslána klientovi.

RealtimeServerEventInputAudioBufferSpeechStarted

Server je odesílal v server_vad režimu k indikaci, že byla v audio bufferu detekována řeč. To se může stát kdykoli, když je do bufferu přidán zvuk (pokud už není řeč detekována). Klient může chtít tuto událost použít k přerušení přehrávání zvuku nebo k poskytnutí vizuální zpětné vazby uživateli. Klient by měl očekávat, že se objeví událost, input_audio_buffer.speech_stopped kdy řeč přestane řečit. Vlastností item_id je ID položky uživatelské zprávy, která se vytvoří při ukončení hovoru a bude také zahrnuta do události input_audio_buffer.speech_stopped (pokud klient ručně nezaznamená audio buffer při aktivaci VAD).

RealtimeServerEventInputAudioBufferSpeechStopped

Vrací se v režimu server_vad , když server detekuje konec řeči v audio bufferu. Server také odešle conversation.item.created událost s položkou uživatelské zprávy, která je vytvořena z audio bufferu.

RealtimeServerEventInputAudioBufferTimeoutTriggered

Vrátí se, když se spustí časový limit serverového VAD pro vstupní audio buffer. To je nastaveno v idle_timeout_msturn_detection nastavení relace a naznačuje, že po nastavenou dobu nebyl detekován žádný hlas. Pole audio_start_ms označují audio_end_ms segment zvuku po poslední odezvě modelu až do doby aktivace jako posun od začátku zvuku zapsaného do vstupní vyrovnávací paměti zvuku. To znamená, že vyznačuje segment zvuku, který byl tichý, a rozdíl mezi počáteční a koncovou hodnotou přibližně odpovídá nastavenému timeoutu. Prázdné audio bude do konverzace vloženo jako input_audio součást (bude tam událost input_audio_buffer.committed ) a bude generována modelová odpověď. Může existovat řeč, která VAD nespustila, ale model ji přesto detekuje, takže model může odpovědět něčím relevantním pro konverzaci nebo výzvou k pokračování.

RealtimeServerEventMCPListToolsCompleted

Vráceno při vypisování MCP nástrojů dokončených pro položku.

RealtimeServerEventMCPListToolsFailed

Vráceno při vypisování MCP nástrojů, které selhaly pro položku.

RealtimeServerEventMCPListToolsInProgress

Když probíhá výpis nástrojů MCP pro položku, je vráceno.

RealtimeServerEventOutputAudioBufferCleared

Pouze WebRTC/SIP: Vysíla, když je vymazána výstupní audio buffer. K tomu dochází buď v režimu VAD, když uživatel přerušil (input_audio_buffer.speech_started), nebo když klient vyvolal output_audio_buffer.clear událost, aby ručně přerušil aktuální zvukovou odpověď. Další informace.

RealtimeServerEventRateLimitsUpdated

Vysílají se na začátku odpovědi, aby označily aktualizované limity sazeb. Když je Odpověď vytvořena, některé tokeny budou "rezervovány" pro výstupní tokeny, přičemž zde zobrazené limity rychlosti odrážejí tuto rezervaci, která je následně upravena po dokončení Odpovědi.

RealtimeServerEventRateLimitsUpdatedRateLimits

modelové rozhraní RealtimeServerEventRateLimitsUpdatedRateLimits

RealtimeServerEventResponseAudioDelta

Vrátí se, když je model generovaný zvuk aktualizován.

RealtimeServerEventResponseAudioDone

Vrátí se, když je model generovaný zvuk hotový. Také se vysílají, když je odpověď přerušena, neúplná nebo zrušena.

RealtimeServerEventResponseAudioTranscriptDelta

Vráceno při aktualizaci modelem generované transkripce audio výstupu.

RealtimeServerEventResponseAudioTranscriptDone

Vráceno poté, co je modelem generovaná transkripce audio výstupu dokončena streamováním. Také se vysílají, když je odpověď přerušena, neúplná nebo zrušena.

RealtimeServerEventResponseContentPartAdded

Vrátí se, když je nová část obsahu přidána do položky zprávy asistenta během generování odpovědi.

RealtimeServerEventResponseContentPartAddedPart

modelové rozhraní RealtimeServerEventResponseContentPartAddedPart

RealtimeServerEventResponseContentPartDone

Vrátí se, když část obsahu dokončí streamování v položce zprávy asistenta. Také se vysílají, když je odpověď přerušena, neúplná nebo zrušena.

RealtimeServerEventResponseContentPartDonePart

modelové rozhraní RealtimeServerEventResponseContentPartDonePart

RealtimeServerEventResponseCreated

Vrátí se, když je vytvořena nová odpověď. První událost tvorby odpovědi, kdy je odpověď v počátečním stavu .in_progress

RealtimeServerEventResponseDone

Vráceno, když je Odpověď hotová se streamováním. Vždy vyzařován, bez ohledu na konečný stav. Objekt Response zahrnutý response.done v události bude obsahovat všechny výstupní položky v Response, ale vynechá surová zvuková data. Klienti by měli zkontrolovat status pole odpovědi, aby zjistili, zda byla úspěšná (completed) nebo zda byl jiný výsledek: cancelled, failed, nebo incomplete. Odpověď bude obsahovat všechny výstupní položky, které byly během odpovědi generovány, s výjimkou jakéhokoli zvukového obsahu.

RealtimeServerEventResponseFunctionCallArgumentsDelta

Vrací se, když jsou argumenty volání funkcí generovaných modelem aktualizovány.

RealtimeServerEventResponseFunctionCallArgumentsDone

Vrátí se, když jsou argumenty volání funkcí generované modelem ukončeny streamování. Také se vysílají, když je odpověď přerušena, neúplná nebo zrušena.

RealtimeServerEventResponseMCPCallArgumentsDelta

Vráceno, když jsou argumenty volání nástrojů MCP aktualizovány během generování odpovědí.

RealtimeServerEventResponseMCPCallArgumentsDone

Vráceno, když jsou argumenty volání nástrojů MCP finalizovány během generování odpovědí.

RealtimeServerEventResponseMCPCallCompleted

Vráceno, když je úspěšně dokončeno volání nástroje MCP.

RealtimeServerEventResponseMCPCallFailed

Vráceno, když volání nástroje MCP selhalo.

RealtimeServerEventResponseMCPCallInProgress

Vráceno, když začalo volání nástroje MCP a probíhá.

RealtimeServerEventResponseOutputItemAdded

Vráceno při vytvoření nové položky během generování Response.

RealtimeServerEventResponseOutputItemDone

Vráceno po dokončení streamování položky. Také se vysílají, když je odpověď přerušena, neúplná nebo zrušena.

RealtimeServerEventResponseTextDelta

Vrátí se, když je textová hodnota části "output_text" aktualizována.

RealtimeServerEventResponseTextDone

Vrátí se, když textová hodnota části "output_text" obsahu skončí streamováním. Také se vysílají, když je odpověď přerušena, neúplná nebo zrušena.

RealtimeServerEventSessionCreated

Vrací se při vytvoření relace. Automaticky se vysílají při navázání nového připojení jako první událost serveru. Tato událost bude obsahovat výchozí konfiguraci relace.

RealtimeServerEventSessionUpdated

Vrátí se, když je relace aktualizována událostí session.update , pokud není chyba.

Reasoning

Pouze modely GPT-5 a O-Series Možnosti konfigurace pro modely uvažování.

RecurrenceSchedule

Model plánu opakování.

RecurrenceTrigger

Spouštěč založený na opakování.

RedTeam

Podrobnosti o červeném týmu.

RedTeamTargetConfig

Abstraktní třída pro cílovou konfiguraci.

ReminderPreviewToolboxTool

Nástroj na připomínku uložený v kufříku s nářadím.

ResponseUsageInputTokensDetails

Model rozhraní ResponseUsageInputTokensDetails

ResponseUsageOutputTokensDetails

Model Interface ResponseUsageOutputTokensDetails

ResponsesProtocolConfiguration

Konfigurace specifická pro protokol odpovědí.

Routine

Rutinní definice vrácená službou.

RoutineAction

Základní model pro rutinní akci.

RoutineAuthorization

Volitelná autorizační konfigurace pro rutinní vysílání.

RoutineDispatchPayload

Základní model pro ruční dispečerní náklad.

RoutineRun

Jeden běh rutiny se vrátil z API pro historii běhů.

RoutineTrigger

Základní model pro rutinní spouštěč.

RubricBasedEvaluatorDefinition

Definice hodnotitele založená na rubrikách — ukládá dimenze vytvořené generovaným API. Používá se jak pro hodnotitele kvality, tak bezpečnosti.

RubricGenerationInputQualityWarning

Nefatální doporučení vytvořené při generování hodnotitele hodnotících hodnotitelů, když jsou vyřešené vstupy technicky platné, ale pravděpodobně příliš slabé na vytvoření vysoce kvalitní hodnotící hodnoticí hodnotící Pouze pro čtení; Generované službou. Pokračoval jsem v terminálním EvaluatorGenerationJob.

RunOperationState

Stav operace pro dlouhodobě běžící operaci, která vytváří zdroj běhu.

PŘIZPŮSOBENÍ: SDK-VYLEPŠENÍ: vysílaný poller se vyřeší na terminální result payload běhu, který nenese žádný identifikátor; runId udržuje vytvořený běh dosažitelný.

SASTokenCredentials

Definice přihlašovacích údajů sdíleného přístupového podpisu (SAS)

SasCredential

Definice přihlašovacích údajů SAS

Schedule

Model plánu.

ScheduleRoutineTrigger

Opakovaný spouštěč rutiny založený na crona.

ScheduleRun

Naplánujte si model spuštění.

ScheduleTask

Naplánujte model úlohy.

SessionConfiguration

Výchozí nastavení relací se vztahovalo na relace vytvořené pro verzi hostovaného agenta.

SessionDirectoryEntry

Jeden záznam v seznamu adresářů.

SessionDirectoryListResponse

Odpověď z zařazení adresáře do sandboxu relace.

SessionFileWriteResponse

Odpověď při nahrání souboru do sandboxu relace.

SessionLogEvent

Jeden Server-Sent Event rámec vygenerovaný hostovaným proudem relace agenta.

Každý rámec obsahuje event pole označující typ události a data pole nesoucí užitečný obsah jako prostý text. Ačkoliv je data aktuální payload formátován v JSON, jeho schéma není smluvní — mohou se objevit další klíče a formát se může v průběhu času měnit. Klienti by měli považovat data za neprůhledný řetězec a případně zkusit JSON parsování.

V budoucnu mohou být přidány nové typy událostí. Klienti by měli s grácií ignorovat nerozpoznané typy událostí.

Formát drátu:

event: log
data: {"timestamp":"2026-03-10T09:33:17.121Z","stream":"stdout","message":"Starting server on port 18080"}

event: log
data: {"timestamp":"2026-03-10T09:34:52.714Z","stream":"status","message":"Successfully connected to container"}
SharepointGroundingToolParameters

Parametry nástroje pro uzemnění služby SharePoint.

SharepointPreviewTool

Informace o definici vstupu pro nástroj služby SharePoint, jak slouží ke konfiguraci agenta.

ShellToolboxTool

Nástroj z obalu uložený v kufříku s nářadím. Tento model je aditivní do konfigurace toolboxu a nemění kontrakt OpenAI ani stávající definice toolboxu.

SimpleQnADataGenerationJobOptions

Možnosti pro práci generující data s SimpleQnA jsou uvedeny.

SimulationSeedDataGenerationJobOptions

Možnosti pro generování simulačních dat na základě seedu. Použijte s vícekolovými evaluačními scénáři a se zdroji promptů, souborů nebo agentů. Generované řádky datové sady zahrnují pole jako id, category, test_case_description, a desired_num_turns.

SipTelephonyTransferDestination

SIP cíl pro telekomunikační přenos.

Skill

Zdroj dovedností.

SkillInlineContent

Vložený obsah pro definování jednoduché dovednosti bez nahrávání souborů. Řídí se specifikací agentskills.io SKILL.md.

SkillReference

(Náhled) Odkaz na verzizovanou dovednost Foundry.

SkillReferenceParam

modelové rozhraní SkillReferenceParam

SkillVersion

Specifická verze dovednosti.

SpecificApplyPatchParam

Při provádění volání nástroje vynutí model volat nástroj apply_patch.

SpecificFunctionShellParam

Vynutí, aby model volal nástroj prostředí, když je požadováno volání nástroje.

SpecificProgrammaticToolCallingParam

modelové rozhraní SpecificProgrammaticToolCallingParam

StructuredInputDefinition

Strukturovaný vstup, který se může podílet na nahrazení předlohy výzvy a vázání argumentů nástroje.

StructuredOutputDefinition

Strukturovaný výstup, který může vytvořit agent.

TaskGenerationDataGenerationJobOptions

Možnosti pro legacy úkoly generování úloh, včetně maximálního počtu generovaných vzorků.

TaxonomyCategory

Definice kategorie taxonomie.

TaxonomySubCategory

Definice podkategorie Taxonomie.

TeamsPhoneExtensionTelephonyBinding

Vazba Telefon v Microsoft Teams Extension vlastněná hlasovým agentem.

TeamsPhoneExtensionTelephonyBindingListItem

Vazba Telefon v Microsoft Teams Extension se vrátila v seznamu, včetně jeho entity tagu.

TeamsTelephonyTransferDestination

Cílová destinace Microsoft Teams pro telekomunikační přenos.

TelemetryConfig

Konfigurace telemetrie dodaná zákazníkem pro export kontejnerových logů, stop a metrik.

TelemetryEndpoint

Konfigurace endpointu pro exportování telemetrie.

TelemetryEndpointAuth

Konfigurace autentizace pro telemetrický endpoint.

TelemetryOperations

Rozhraní reprezentující telemetrické operace

TelephonyBinding

Telefonní vazba vlastněná hlasovým agentem.

TelephonyBindingListItem

Telefonní vazba se vrátila v seznamu, včetně jeho entity tagu.

TelephonyCallJob

Trvalý přímý nebo kampaňou vytvořený odchozí záměr hovoru.

TelephonyCallJobCancellation

Žádost o zrušení zaznamenána pro odchozí hovorovou práci.

TelephonyCallJobSchedule

Volitelné okno pro přímý odchozí hovor.

TelephonyCallLifecycleEvent

Ohraničené trvalé pozorování v životním cyklu jednoho telefonního hovoru.

TelephonyCallRecord

Podrobná diagnostika pro trvalý příchozí hovor hlasovému agentovi.

TelephonyCallSummary

Shrnutí trvalého příchozího hovoru hlasovému agentovi.

TelephonyCallTiming

Podrobné načasování pro příchozí telefonní hovor nezávislé na poskytovateli.

TelephonyCallTrace

Korelace mezi trvalým záznamem telefonních hovorů a jeho zákaznicky orientovaným Foundry trasováním.

TelephonyOutboundDestination

Cíl odchozího hovoru.

TelephonyOutboundFixedIntervalRetryPolicy

Politika opakování s pevně stanoveným intervalem mezi pokusy o odchozí hovor.

TelephonyOutboundRetryPolicy

Politika opakování pro jeden trvalý úmysl odchozího hovoru. max_attempts zahrnuje první pokus. Strategicky specifická nastavení jsou definována odvozenou politikou.

TelephonyTransferDestination

Cíl pro telekomunikační přestup.

TelephonyTransferTarget

Pojmenované místo, kam může hlasový agent přesměrovat hovor.

TelephonyTransferTargets

Přenos telefonie cílí na jednoho hlasového agenta.

TextResponseFormat

Objekt určující formát, který musí model vypíše. Konfigurace { "type": "json_schema" } umožňuje strukturované výstupy, které zajistí, že model bude odpovídat zadanému schématu JSON. Další informace najdete v průvodci strukturovanými výstupy. Výchozí formát je { "type": "text" } bez dalších možností. Nedoporučuje se pro gpt-4o a novější modely:* Nastavení pro { "type": "json_object" } zapnutí staršího JSON režimu, který zajišťuje, že zpráva generovaná modelem je platná JSON. Použití json_schema je upřednostňované pro modely, které ho podporují.

TextResponseFormatConfiguration

Základní konfigurace formátu generovaných textových odpovědí.

TextResponseFormatConfigurationResponseFormatJsonObject

Konfiguruje generované odpovědi pro použití formátu objektů JSON.

TextResponseFormatConfigurationResponseFormatText

Konfiguruje generované odpovědi tak, aby používaly prostý text.

TextResponseFormatJsonObject

Formát odpovědi objektu JSON. Starší metoda generování odpovědí JSON. Použití json_schema se doporučuje pro modely, které ho podporují. Všimněte si, že model nebude generovat JSON bez systémové nebo uživatelské zprávy, která jej k tomu instruuje.

TextResponseFormatJsonSchema

Formát odpovědi schématu JSON Slouží ke generování strukturovaných odpovědí JSON. Přečtěte si další informace o strukturovaných výstupech.

TextResponseFormatText

Výchozí formát odpovědi Používá se ke generování textových odpovědí.

TimerRoutineTrigger

Jednorázový časovač na spustění rutiny.

Tool

Nástroj, který lze použít k vygenerování odpovědi.

ToolChoiceAllowed

Omezuje nástroje dostupné pro model na předem definovanou sadu.

ToolChoiceCodeInterpreter

Označuje, že model by měl k vygenerování odpovědi použít integrovaný nástroj. Vyučte si další informace o integrovaných nástrojích.

ToolChoiceComputer

Označuje, že model by měl k vygenerování odpovědi použít integrovaný nástroj. Vyučte si další informace o integrovaných nástrojích.

ToolChoiceComputerUse

Označuje, že model by měl k vygenerování odpovědi použít integrovaný nástroj. Vyučte si další informace o integrovaných nástrojích.

ToolChoiceComputerUsePreview

Označuje, že model by měl k vygenerování odpovědi použít integrovaný nástroj. Vyučte si další informace o integrovaných nástrojích.

ToolChoiceCustom

Tuto možnost použijte, pokud chcete model vynutit volání konkrétního vlastního nástroje.

ToolChoiceFileSearch

Označuje, že model by měl k vygenerování odpovědi použít integrovaný nástroj. Vyučte si další informace o integrovaných nástrojích.

ToolChoiceFunction

Tuto možnost použijte k vynucení volání konkrétní funkce modelu.

ToolChoiceImageGeneration

Označuje, že model by měl k vygenerování odpovědi použít integrovaný nástroj. Vyučte si další informace o integrovaných nástrojích.

ToolChoiceMCP

Tuto možnost použijte k vynucení volání konkrétního nástroje na vzdáleném serveru MCP.

ToolChoiceParam

Způsob, jakým má model vybrat nástroj (nebo nástroje), který se má použít při generování odpovědi V parametru tools se dozvíte, jak určit nástroje, které model může volat.

ToolChoiceWebSearchPreview

Označuje, že model by měl k vygenerování odpovědi použít integrovaný nástroj. Vyučte si další informace o integrovaných nástrojích.

ToolChoiceWebSearchPreview20250311

Označuje, že model by měl k vygenerování odpovědi použít integrovaný nástroj. Vyučte si další informace o integrovaných nástrojích.

ToolConfig

Konfigurace pro každý nástroj, která řídí viditelnost nástrojů a chování vyhledávání.

ToolDescription

Popis nástroje, který může agent použít.

ToolProjectConnection

Prostředek připojení project.

ToolSearchToolParam

Konfigurace pro vyhledávání v rámci hostovaných nebo BYOT nástrojů pro odložené nástroje.

ToolSearchToolboxTool

Nástroj pro vyhledávání v krabici s nářadím uložený v krabici s nářadím.

ToolUseFineTuningDataGenerationJobOptions

Možnosti pro práci generující data s typem ToolUse. Používá se pouze pro doladění scénářů.

ToolboxObject

Nástrojová sada, která uchovává znovupoužitelné definice nástrojů pro agenty.

ToolboxPolicies

Konfigurace politik pro toolbox, včetně nastavení bezpečnosti obsahu a dalších správ.

ToolboxSearchPreviewToolboxTool

Nástroj pro vyhledávání v krabici s nářadím uložený v krabici s nářadím.

ToolboxShellContainerAutoEnvironment

Automaticky vytvořené kontejnerové prostředí pro shell tool uložené v toolboxu.

ToolboxShellContainerReferenceEnvironment

Existující kontejnerové prostředí pro nástroj shell uložené v nástrojové krabici.

ToolboxShellEnvironment

Prostředí pro provádění shell nástroje uloženého v nástrojové krabici. Tento model prostředí je přizpůsoben konfiguraci toolboxu a nemění kontrakt shellového prostředí OpenAI.

ToolboxShellNetworkPolicy

Síťová přístupová politika pro automaticky provisionovaný shellový kontejner toolboxu.

ToolboxShellNetworkPolicyDisabled

Síťová politika, která zakazuje odchozí přístup z kontejneru shellu toolboxu.

ToolboxSkill

Zdroj dovedností zahrnutý v nástrojové sadě.

ToolboxSkillReference

Odkaz na existující dovednost, kterou je třeba zahrnout do nástrojového balíčku.

ToolboxTool

Abstraktní zobrazení nástroje uloženého v nástrojové bedně.

ToolboxVersionObject

Specifická verze nářadí.

ToolboxVersions

Verze spojené s nástrojovou kufříkem.

ToolboxesCreateVersionOptionalParams

Volitelné parametry.

ToolboxesDeleteOptionalParams

Volitelné parametry.

ToolboxesDeleteVersionOptionalParams

Volitelné parametry.

ToolboxesGetOptionalParams

Volitelné parametry.

ToolboxesGetVersionOptionalParams

Volitelné parametry.

ToolboxesInvokeLatestToolboxMcpOptionalParams

Volitelné parametry.

ToolboxesListOptionalParams

Volitelné parametry.

ToolboxesListVersionsOptionalParams

Volitelné parametry.

ToolboxesOperations

Rozhraní reprezentující operace Toolbox.

ToolboxesUpdateOptionalParams

Volitelné parametry.

TracesDataGenerationJobOptions

Možnosti pro práci generující data s typem Traces.

TracesDataGenerationJobSource

Traces source pro data generation jobs — konverzační trace z Application Insights.

TracesEvaluatorGenerationJobSource

Traces source pro pozice generování hodnotitelů — konverzační stopy z Application Insights.

TranscriptTextUsageDuration

Statistiky využití modelů účtované podle délky vstupu zvuku.

TranscriptTextUsageTokens

Statistiky využití modelů účtované podle využití tokenů.

TranscriptTextUsageTokensInputTokenDetails

Model Interface PřepisTextPoužitíTokenyVstupDetaily tokenu

TranscriptionLanguage

Jazyk detekovaný v přepisovaném zvuku.

Trigger

Základní model pro Trigger plánu.

TwilioTelephonyBinding

Twilio vazba vlastněná hlasovým agentem.

TwilioTelephonyBindingListItem

Twilio vazba se vrátila v seznamu včetně jeho entity tagu.

UpdateModelVersionRequest

Tělo požadavku pro aktualizaci verze modelu. Pouze popis a štítky lze upravovat.

UpdateTelephonyBindingRequest

Žádost o aktualizaci existujícího telefonního vazby. Každá vlastnost je volitelná a poskytovatel vazby je neměnný.

UpdateToolboxRequest

modelové rozhraní UpdateToolboxRequest

UserProfileMemoryItem

Paměťová položka konkrétně obsahující informace o profilu uživatele extrahované z konverzací, jako jsou preference, zájmy a osobní údaje.

VersionIndicator

Indikátor verze určující, která verze agenta podporuje relaci.

VersionRefIndicator

Indikátor verze, který odkazuje na konkrétní verzi agenta podle jména.

VersionSelectionRule

modelové rozhraní VersionSelectionRule

VersionSelector

modelové rozhraní VersionSelector

VoiceAgentAnimationConfig

Nastavení animace pro hlasovou agentní seanci.

VoiceAgentAudioConfig

Zvuková konfigurace pro hlasového agenta. Tyto hodnoty jsou výchozí relace a mohou být při připojení přepsány.

VoiceAgentAudioInputConfig

Konfigurace vstupního zvuku pro hlasového agenta.

VoiceAgentAudioOutputConfig

Výstupní audio konfigurace pro hlasového agenta. Pole specifická pro poskytovatele jsou vybírána prostřednictvím voice_type:

  • openai: voice a speed.
  • azure-standard: voice, , voice_locale, speed, voice_temperature, custom_lexicon_url, custom_text_normalization_urlprefer_locales, style, , pitcha .volume
  • azure-custom: všechna azure-standard pole kromě style, plus custom_voice_endpoint_id.
  • azure-personal: všechna azure-standard pole kromě style, plus personal_voice_model.
  • avatar-voice-sync: všechna azure-standard pole kromě voice a , styleplus personal_voice_model; jméno hlasu je odvozeno od avatara.
  • azure-realtime-native: voice a speed. format a platí output_audio_timestamp_types pro každý typ hlasu.
VoiceAgentAvatarConfig

Konfigurace avatara pro hlasového agenta. Tyto hodnoty jsou výchozí relace a mohou být při připojení přepsány.

VoiceAgentAvatarIceServer

ICE server používaný pro vyjednávání avatarů WebRTC.

VoiceAgentAvatarScene

Umístění avatarů a nastavení pohybu.

VoiceAgentAvatarVideoBackground

Pozadí videa avatara.

VoiceAgentAvatarVideoCrop

Obdélníkový ořez aplikovaný na video avatara.

VoiceAgentAvatarVideoParams

Nastavení video enkodéru a prezentace Avatara.

VoiceAgentAvatarVideoResolution

Rozlišení videa s avatarem.

VoiceAgentAzureSemanticVadEnTurnDetection

Detekce sémantické hlasové aktivity v Azure optimalizované pro angličtinu.

VoiceAgentAzureSemanticVadMultilingualTurnDetection

Multilingual Azure semantic voice activity detection.

VoiceAgentAzureSemanticVadTurnDetection

Azure semantic voice activity detection.

VoiceAgentCancelResponseOptions

Možnosti, jak zrušit odpověď.

VoiceAgentClientEventRtcCallSdpCreate

Klientská rtc.call.sdp.create událost: začíná signalizaci WebRTC nabídkou SDP.

VoiceAgentClientEventSessionAvatarConnect

Klientská session.avatar.connect akce.

VoiceAgentClientEventSessionUpdate

Klientská session.update akce.

VoiceAgentCloseResult

Výsledek je poskytnut při uzavření hlasového spojení agenta.

VoiceAgentConnection

Propojený, obousměrný hlasový agentní proud.

Podporuje přesně jednu for await iteraci přes serverové události; druhý pokus hodí. Předčasné ukončení smyčky (break, return, nebo nezaznamenaná chyba v těle smyčky) uzavře spojení jako vedlejší efekt. Nerozpoznané typy serverových událostí jsou doručovány jako VoiceAgentUnknownEvent bez přerušení streamu. Deformované události stále selžou při iteraci kvůli chybě protokolu.

VoiceAgentDefinition

Definice hlasového agenta. Jeho konfigurace (model, instrukce, zvuk, nástroje a volitelný avatar) zajišťuje spravovaný zážitek z převodu řeči na řeč. Vytvořte hlasové sezení v reálném čase prostřednictvím GET /agents/{agent_name}/endpoint/protocols/voice. Každé vytvoření nebo aktualizace vytváří novou neměnnou verzi.

VoiceAgentEchoCancellation

Nastavení potlačení echo na straně serveru pro vstupní zvuk.

VoiceAgentEndConversationSystemTool

Řízení řízené službou, které ukončuje aktivní konverzaci.

VoiceAgentEndOfUtteranceDetection

Konfigurace detekce sémantického konce výpovědi.

VoiceAgentEventOptions

Možnosti sdílené operacemi, které vytvářejí protokolovou událost jménem volajícího.

VoiceAgentFunctionTool

Nativní funkční nástroj spuštěný klientem.

VoiceAgentGreetingConfig

Konfigurace uvítání při zahájení relace pro hlasového agenta.

VoiceAgentInputTranscription

Konfigurace asynchronního vstupně-audio transkripce. Rozšiřuje možnosti OpenAI Realtime přepisu o transkripční modely Azure a MAI, vlastní modely řeči a nápovědy k frázím.

VoiceAgentInterimResponseConfig

Pole sdílená konfiguracemi s přechodnou odezvou.

VoiceAgentLlmGeneratedGreetingConfig

Pozdrav vytvořený modelem session na základě scoped úvodního promptu.

VoiceAgentLlmInterimResponseConfig

Mezitím vygenerovaná jazykovým modelem.

VoiceAgentMcpTool

MCP nástroj dostupný hlasovému agentovi.

VoiceAgentNoiseReduction

Konfigurace redukce šumu na vstupu zvuku.

VoiceAgentRealtimeClientConnectOptions

Možnosti propojení klienta v reálném čase s hlasovým agentem.

VoiceAgentRealtimeClientOptions

Možnosti pro klienta Voice Agents v reálném čase.

VoiceAgentRealtimeResponse

Živá odpověď v reálném čase vrácená službou hlasového agenta v obou response.created událostech response.done .

VoiceAgentRealtimeResponseBase

Vlastnosti sdílené odpověďmi v reálném čase vrácenými službou hlasového agenta.

VoiceAgentResponseCreateParams

Parametry přijímací hlasová událost.response.create

VoiceAgentResponseOptions

Možnosti, jak vytvořit odpověď.

VoiceAgentRtcCallErrorDetails

Podrobnosti o chybě signalizace WebRTC.

VoiceAgentSemanticVadTurnDetection

Nastavení detekce tahů OpenAI pro sémantické VAD.

VoiceAgentSendItemOptions

Možnosti sdílené operacemi, které přidávají položku konverzace a ve výchozím nastavení požadují odpověď.

VoiceAgentSendOptions

Možnosti sdílené operacemi v reálném čase.

VoiceAgentSendTextOptions

Možnosti pro odesílání textového vstupu.

VoiceAgentSendToolOutputOptions

Možnosti pro vrácení výsledku funkce.

VoiceAgentServerEventResponseAnimationBlendshapesDelta

Událost response.animation_blendshapes.delta na serveru.

VoiceAgentServerEventResponseAnimationBlendshapesDone

Událost response.animation_blendshapes.done na serveru.

VoiceAgentServerEventResponseAnimationVisemeDelta

Událost response.animation_viseme.delta na serveru.

VoiceAgentServerEventResponseAnimationVisemeDone

Událost response.animation_viseme.done na serveru.

VoiceAgentServerEventResponseAudioTimestampDelta

Událost response.audio_timestamp.delta na serveru.

VoiceAgentServerEventResponseAudioTimestampDone

Událost response.audio_timestamp.done na serveru.

VoiceAgentServerEventResponseVideoDelta

Událost response.video.delta na serveru.

VoiceAgentServerEventRtcCallError

Událost rtc.call.error serveru: selhání signalizace WebRTC.

VoiceAgentServerEventRtcCallSdpCreated

Serverová rtc.call.sdp.created událost: SDP odpověď, která dokončuje WebRTC vyjednávání.

VoiceAgentServerEventSessionAvatarConnecting

Událost session.avatar.connecting na serveru.

VoiceAgentServerEventSessionAvatarSwitchToIdle

Událost session.avatar.switch_to_idle na serveru.

VoiceAgentServerEventSessionAvatarSwitchToSpeaking

Událost session.avatar.switch_to_speaking na serveru.

VoiceAgentServerEventSessionSubagentAborted

Událost session.subagent.aborted na serveru.

VoiceAgentServerEventSessionSubagentCompleted

Událost session.subagent.completed na serveru.

VoiceAgentServerEventSessionSubagentStarted

Událost session.subagent.started na serveru.

VoiceAgentServerEventWarning

Událost warning na serveru.

VoiceAgentServerEventWarningDetails

Podrobnosti o varování, které není smrtelné.

VoiceAgentServerVadTurnDetection

Detekce hlasové aktivity na straně serveru.

VoiceAgentSessionAvatarConfig

Nastavení avatarů přijata smlouvou o stabilním hlasovém agentu WebSocket.

VoiceAgentSessionResponseConfig

Efektivní stabilní nastavení reálných relací vrácená službou hlasového agenta.

VoiceAgentSessionUpdateConfig

Stabilní nastavení reálných relací přijata v klientské události session.update .

VoiceAgentSessionUpdateOptions

Možnosti aktualizace živé relace.

VoiceAgentStaticInterimResponseConfig

Statická mezitím odpověď vybraná z nakonfigurovaného textu.

VoiceAgentSubagent

Sourozenecký textový agent Foundry, kterého může hlasový agent konzultovat jako specialistu na pozadí.

VoiceAgentSubagentConfig

Konfigurace pro sourozenské textové agenty Foundry, které může hlasový agent konzultovat.

VoiceAgentSubagentResponsePolicy

Pravidla pro doručování odpovědí, zatímco hlasový agent čeká na subagenta.

VoiceAgentSystemTool

Řízení řízené službou, které působí na aktivní hlasové relaci bez zákaznického kódu nebo externí autentizace.

VoiceAgentTemplateGreetingConfig

Deterministické pozdravení vykreslené strukturovanými vstupy hlasového agenta a syntetizované bez generování vytvořeného modelem.

VoiceAgentTool

Nástroj použitelný hlasovým agentem.

VoiceAgentToolboxTool

Odkaz na Foundry toolbox, což je verzovaný balíček nástrojů spuštěný přes jeho MCP endpoint.

VoiceAgentTranscriptionPhrase

Přepsaná fráze s informacemi o načasování.

VoiceAgentTranscriptionWord

Slovo s časovou značkou v vstupně-audio transkripci.

VoiceAgentTurnDetectionConfig

Konfigurace detekce tahu pro hlasového agenta.

VoiceAgentUnknownEvent

Serverová událost, jejíž typ vodiče není touto verzí SDK rozpoznán.

SDK doručuje tyto události bez uzavření spojení nebo aplikace validace či normalizace známých událostí. Před použitím kontrolujte a ověřujte surová pole.

VoiceAgentWebSocketConnectOptions

Možnosti byly předány VoiceAgentWebSocketTransport.connect.

VoiceAgentWebSocketFactory

Vytváří instance VoiceAgentWebSocketTransport pro VoiceAgentRealtimeClient.

VoiceAgentWebSocketHandlers

Callbacky jsou vyvolávány VoiceAgentWebSocketTransportem při událostech spojení.

VoiceAgentWebSocketTransport

Připojitelný WebSocket transport používaný VoiceAgentRealtimeClient. Toto rozhraní implementujte pro přizpůsobení způsobu navázání spojení v reálném čase, například pro směrování přes autentizované relé.

VoiceAudioItem

Metadata pro zvukový segment jednoho tématu konverzace. Pro přinášení vlastního úložiště (BYOS) odpověď zahrnuje blob_uri, přímý zákaznický úložiště URI bez SAS tokenu, ke kterému zákazník přistupuje se svými vlastními přihlašovacími údajůmi. Pro úložiště spravované Foundry chybí blob_uri a bajty jsou streamovány trasou /audio/content položky.

VoiceConversation

Trvalý hlasový rozhovor. Obálka Foundry, která vlastní uložený přepis hlasového agenta, odpovědi, metriky za tah a zvuk. Je to hranice rodiče, uchování a mazání: její smazání se následně přenáší na její odpovědi, položky, metriky a zvuk. Když finalizace selže, jakékoli částečně přetrvávající odpovědi, položky a audio položky zůstávají čitelné.

VoiceConversationEngine

Engine, který řídí zpracování konverzace pro hlasového agenta.

VoiceGeneratedAudioItem

Metadata pro generovaný zvuk v konverzačním prvku. Pro přinášení vlastního úložiště (BYOS) odpověď zahrnuje blob_uri, přímý zákaznický úložiště URI bez SAS tokenu, ke kterému zákazník přistupuje se svými vlastními přihlašovacími údajůmi. Pro úložiště spravované Foundry chybí blob_uri a bajty jsou streamovány trasou /audio/generated/content položky.

VoiceHostedAgentConversationEngine

Uzavřená zmínka o hostovaném textovém agentovi, který řídí konverzaci pro hlasového agenta. Hostovaný agent je vyřešen ve stejném projektu a musí podporovat invocations_ws protokol, kompatibilitu s Voice Live a Bridge Protocol 1.0.

VoiceRecording

Metadata pro sloučený, celohovorový stereozáznam hlasového rozhovoru (uživatelský zvuk na levém kanálu, agent na pravém). Postavený jednou z jednotlivých segmentů po skončení seance a trvale uložený do paměti. Běžná metadata (formát, vzorkovací frekvence, kanály, rozložení kanálů, délka) se vracejí jak pro nahrávky spravované Foundry, tak pro nahrávky typu bring-your-own storage (BYOS). U BYOS odpověď také obsahuje blob_uri, URI záznamu ve vlastním úložišti zákazníka (bez SAS tokenu), které zákazník stáhne pomocí svých vlastních přihlašovacích údajů. U Foundry chybí úložiště blob_uri spravované a bajty jsou streamovány touto cestou /audio/content .

VoiceRecordingChannelLayout

Role přiřazená každému kanálu sloučeného stereo hlasového záznamu.

VoiceResponse

Přetrvávající hlasová odpověď reprezentující jeden modelový závěrový obrat v rámci konverzace. Ve výsledcích seznamu může být projekce output vynechána; pro výstupní položky lze získat celou odpověď (GET .../responses/{response_id}) nebo stránkovanou odpověď-položky (GET .../responses/{response_id}/items) pro výstupní položky. created_at / completed_at jsou trvalé objednávkové rozšíření Foundry.

VoiceResponseAudio

Audio konfigurace pro odpověď. Následuje tvar objektu OpenAI Realtime GA audio .

VoiceResponseAudioOutput

Plochá zvuková výstupní projekce, s volitelnými voice, voice_type, voice_locale, a format poli.

VoiceResponseBase

Vlastnosti sdílené trvalými hlasovými odpověďmi.

WebIQPreviewTool

WebIQ nástroj na straně serveru.

WebIQPreviewToolboxTool

WebIQ nástroj uložený v nástrojové krabici.

WebSearchApproximateLocation

Přibližná poloha uživatele.

WebSearchConfiguration

Konfigurace vyhledávání na webu pro bing vlastní vyhledávání

WebSearchPreviewTool

Tento nástroj vyhledává na webu relevantní výsledky pro odpověď. Přečtěte si další informace o nástroji pro vyhledávání webu .

WebSearchTool

Hledejte na internetu zdroje související s tímto zadáním. Přečtěte si další informace o nástroji pro vyhledávání webu .

WebSearchToolFilters

modelové rozhraní WebSearchToolFilters

WebSearchToolboxTool

Nástroj pro webové vyhledávání uložený v nástrojové sadě.

WeeklyRecurrenceSchedule

Týdenní plán opakování.

WorkIQPreviewTool

WorkIQ nástroj na straně serveru.

WorkIQPreviewToolboxTool

Nástroj WorkIQ uložený v krabici s nářadím.

WorkflowAgentDefinition

Definice agenta pracovního postupu.

Aliasy typu

A2AProtocolVersion

Podporované verze protokolu A2A.

ActivityProtocolAccessBoundary

Přístupová hranice pro protokol aktivity.

AgentBlueprintReferenceType

Typ agentaPlánReferenceTyp

AgentBlueprintReferenceUnion

Alias pro AgentBlueprintReferenceUnion

AgentDefinitionOptInKeys

Klíče pro přihlášení funkcí pro operace definice agenta podporující funkce podmíněného náhledu.

AgentDefinitionUnion

Sjednocený typ pro všechny typy definic agentů. Podporuje workflow, hostované, kontejnerové aplikace, prompt a externí agenty.

AgentEndpoint

Konfigurace směrování, protokolů a autorizace na agentním koncovém bodě.

AgentEndpointAuthorizationSchemeType

Typ agentaKoncový bodAutorizační schéma

AgentEndpointAuthorizationSchemeUnion

Alias pro AgentEndpointAuthorizationSchemeUnion

AgentHarnessUnion

Alias pro AgentHarnessUnion

AgentIdentityStatus

Stav identity agenta, použitelný jak pro identitu instance agenta, tak pro blueprint agenta.

AgentInsightJsonValue

JSON hodnota používaná v payloadech Agent Insights.

AgentInsightOverviewSource

Identifikuje, odkud pochází přehled Agent Insights.

AgentInsightPromptSurface

Povrch výzvy změněn navrhovanou opravou.

AgentInsightProposedFixKind

Navrhované řešení agenta, které lze vykreslit na zákazníka.

AgentInsightRunTrigger

Spouštěč, který spustil běh agentského vhledu.

AgentInsightSeverity

Závažnost agentního vhledu.

AgentInsightStatus

Životní cyklus vhledu do agenta.

AgentKind

Definuje typ/druh agenta. Určuje, která struktura definice agenta se použije.

AgentOptimizationDatasetInputType

Hodnoty diskriminátoru pro sjednocení vstupů datové sady.

AgentOptimizationDatasetInputUnion

Alias pro AgentOptimizationDatasetInputUnion

AgentProtocol

Typ protokolu agenta

AgentSessionStatus

Stav agentní sezení.

AgentState

Provozní stav agenta.

AgentStateSource

Označuje zdroj provozního stavu agenta. Prázdný, když stav není odvozen z konkrétního zdroje.

AgentType

Typ agenta

AgentVersionStatus

Stav provisioningu agentní verze.

AgentsDownloadAgentCodeResponse

Stažený archiv ZIP obsahující hostovaný kód agenta, vystavený jako Blob prohlížeče nebo Node.js čitelný stream.

AgentsDownloadSessionFileResponse

Stažený soubor relace agenta, vystavený jako Blob prohlížeče nebo Node.js čitelný stream.

AgentsPatchAgentObjectOptionalParams

Volitelné parametry.

AttackStrategy

Strategie pro útoky.

AzureAISearchQueryType

Dostupné typy dotazů pro nástroj Azure AI Vyhledávač.

BaseCredentialsUnion

Alias pro BaseCredentialsUnion

BetaSkillsDownloadResponse

ZIP archiv výchozí verze dovednosti, vystavený jako prohlížečový blob nebo Node.js čitelný stream.

BetaVoiceAgentsConversationsDownloadAudioItemResponse

WAV zvuk pro konverzační položku, zobrazený jako prohlížečový Blob nebo Node.js čitelný stream.

BetaVoiceAgentsConversationsDownloadAudioResponse

Sloučený stereo WAV záznam hlasového rozhovoru, vystavený jako Blob prohlížeče nebo Node.js čitelný stream.

BetaVoiceAgentsConversationsDownloadGeneratedAudioItemResponse

Generovaný WAV zvuk pro přerušený konverzační prvek, vystavený jako prohlížečový Blob nebo Node.js čitelný stream.

CallableToolAllowedCaller

Typ CallableToolAllowedCaller

CodeDependencyResolution

Jak jsou závislosti balíčků řešeny při nasazení pro agenta hostovaného na bázi kódu.

ComparisonFilterValueItems

Alias pro ComparisonFilterValueItems

ComputerEnvironment

Typ ComputerEnvironment

ConnectionType

Typ (nebo kategorie) připojení

ContainerMemoryLimit

Typ ContainerMemoryLimit

ContainerNetworkPolicyParamType

Typ ContainerNetworkPolicyParamType

ContainerNetworkPolicyParamUnion

Alias pro ContainerNetworkPolicyParamUnion

ContainerSkillType

Typ kontejneruDovednost

ContainerSkillUnion

Alias pro ContainerSkillUnion

ContinuablePage

Rozhraní, které popisuje stránku výsledků.

CreateTelephonyBindingRequestUnion

Alias pro CreateTelephonyBindingRequestUnion

CreateTranscriptionResponseJsonUsageType

Typ CreateTranscriptionResponseJsonUsageType

CreateTranscriptionResponseJsonUsageUnion

Alias pro CreateTranscriptionResponseJsonUsageUnion

CredentialType

Typ přihlašovacích údajů používaný připojením

CustomToolParamFormatType

Typ CustomToolParamFormatType

CustomToolParamFormatUnion

Alias for CustomToolParamFormatUnion

DataGenerationJobOptionsUnion

Alias pro DataGenerationJobOptionsUnion

DataGenerationJobOutputType

Podporované typy výstupních souborů pro generování dat.

DataGenerationJobOutputUnion

Alias pro DataGenerationJobOutputUnion

DataGenerationJobOutputWriteMode

Podporované režimy zápisu pro generování dat jako výstupy úloh.

DataGenerationJobScenario

Podporované scénáře pro práci generující data.

DataGenerationJobSourceType

Podporované typy zdrojů pro úlohy generování dat.

DataGenerationJobSourceUnion

Alias pro DataGenerationJobSourceUnion

DataGenerationJobType

Podporované typy úloh pro generování dat.

DatasetType

Výčet určující typ dat.

DatasetVersionUnion

Alias pro DatasetVersionUnion

DayOfWeek

Dny v týdnu pro plán opakování.

DeploymentType

Typ typu nasazení

DeploymentUnion

Alias pro DeploymentUnion

DigitalWorkerType

Typ digitálního pracovníka.

DownloadVersionResponse

ZIP archiv pro specifikovanou verzi dovednosti, vystavený jako prohlížečový blob nebo Node.js čitelný stream.

EvaluationLevel

Úroveň, na které se hodnocení provádí.

EvaluationRuleActionType

Typ vyhodnocovací akce.

EvaluationRuleActionUnion

Alias pro EvaluationRuleActionUnion

EvaluationRuleEventType

Typ události pravidla vyhodnocení.

EvaluationTargetUnion

Pseudonymem pro EvaluationTargetUnion

EvaluationTaxonomyInputType

Typ vstupu taxonomie vyhodnocení.

EvaluationTaxonomyInputUnion

Alias pro vyhodnoceníTaxonomyInputUnion

EvaluatorCategory

Kategorie hodnotitele

EvaluatorDefinitionType

Typ definice hodnotitele

EvaluatorDefinitionUnion

Alias pro EvalidatorDefinitionUnion

EvaluatorGenerationJobSourceType

Podporované typy zdrojů pro generování hodnotitelů.

EvaluatorGenerationJobSourceUnion

Alias pro EvaluatorGenerationJobSourceUnion

EvaluatorMetricDirection

Směr metriky označující, zda je vyšší hodnota lepší, nižší hodnota lepší nebo neutrální

EvaluatorMetricType

Typ hodnotitele

EvaluatorType

Typ hodnotitele

FileContents

Platné hodnoty pro obsah binárního souboru.

Filters

Alias pro filtry

FoundryFeaturesOptInKeys

Typ FoundryFeaturesOptInKeys

FoundryModelArtifactProfileCategory

Kategorie profilu artefaktu.

FoundryModelArtifactProfileSignal

Signály detekované v modelovém artefaktu.

FoundryModelSourceType

Typ zdroje modelu.

FoundryModelWarningCode

Varovný kód pro artefakty modelů.

FoundryModelWeightType

Typ hmotnosti modelu.

FunctionShellToolParamEnvironmentType

Typ funkceShellToolParamEnvironmentType

FunctionShellToolParamEnvironmentUnion

Alias pro FunctionShellToolParamEnvironmentUnion

GenerateAgentRequest

Vstupy specifické pro druh pro generování a vytváření agenta.

GenerationWarningType

Kategorie varování se objevila na generované hodnotící verzi. Rozšiřitelné, takže lze zavést nové varovné kategorie (např. bezpečnost, kvalita výstupu) bez přerušení změny.

GetMicrosoft365PackageResponse

Binární balíček aplikací Microsoft 365 generovaný pro agenta Foundry.

GitHubCopilotBuiltInTool

Vestavěný nástroj GitHub Copilot, který lze konfigurovat zákazníkem.

GitHubIssueEvent

Známé události s GitHub, které mohou spustit rutinu.

GrammarSyntax

Typ gramatikySyntaxe

ImageGenAction

Typ ImageGenAction

IndexType

Typ indexType

IndexUnion

Alias pro IndexUnion

InputFidelity

Určete, kolik úsilí bude model vyvíjet, aby odpovídal stylu a funkcím, zejména obličejových rysů, vstupních obrázků. Tento parametr je podporován pouze pro gpt-image-1 a gpt-image-1.5 a pozdější modely, které nejsou podporovány pro gpt-image-1-mini. Podporuje high a low. Výchozí hodnota je low.

InsightRequestUnion

Alias pro InsightRequestUnion

InsightResultUnion

Alias pro InsightResultUnion

InsightSampleUnion

Alias pro InsightSampleUnion

InsightType

Žádost o postřehy.

JobPoller

Průzkum pro dlouhodobě fungující operaci, která vytváří pracovní zdroj.

JobStatus

Rozšiřitelné statusové hodnoty sdílené s Foundry pracovními místy.

MemoryItemKind

Druh paměťové položky.

MemoryItemUnion

Alias pro MemoryItemUnion

MemoryOperationKind

Druh provozu paměti.

MemoryStoreDefinitionUnion

Alias pro MemoryStoreDefinitionUnion

MemoryStoreKind

Typ implementace úložiště paměti, která se má použít.

MemoryStoreType

Typ MemoryStore

MemoryStoreUpdateStatus

Stav operace aktualizace úložiště paměti.

Microsoft365PublishScope

Publikační rozsah pro generovanou aplikaci Microsoft Teams.

MisalignmentErrorType

Klasifikace činnosti, která nemusí odpovídat záměru uživatele. Další hodnoty mohou být vráceny.

NodeReadableStream

Zadejte alias pro Node.js ReadableStream. Na Node targets se to vyřeší na skutečný typ NodeJS.ReadableStream. Na targetech prohlížeče/react-native se varianta platformy vyřeší na never, což přirozeně vypadne z typů sjednocení.

OpenApiAuthDetailsUnion

Alias pro OpenApiAuthDetailsUnion

OpenApiAuthType

Typ ověření pro koncový bod OpenApi. Povolené typy jsou:

  • Anonymní (není vyžadováno ověření)
  • Project Connection (vyžaduje project_connection_id na koncový bod podle nastavení v AI Foundry)
  • Managed_Identity (vyžaduje cílovou skupinu pro ověření na základě identity)
OperationState

Výčet popisující povolené stavy operací.

OptimizationAgentIdentifier

Identifikuje registrovaného agenta Foundry a volitelnou verzi pro optimalizaci.

OptimizationCandidate

Změny konfigurace a agregované výsledky hodnocení pro kandidáta na optimalizaci agenta.

OptimizationDatasetCriterion

Pojmenovaná hodnotící instrukce používaná k hodnocení položky optimalizační datové sady.

OptimizationDatasetInput

Základní popis inline nebo registrované datové sady poskytnutý pro optimalizační úlohu agenta.

OptimizationDatasetInputType

Podporované formy vstupu optimalizačních datových sad: inline položky nebo registrovaná reference datové sady.

OptimizationDatasetInputUnion

Optimalizační datasada dodávaná jako inline položky nebo odkaz na registrovanou datovou sadu Foundry.

OptimizationDatasetItem

Inline optimalizační dataset obsahující dotaz, očekávanou odpověď a hodnotící kritéria.

OptimizationEvaluatorRef

Odkaz na hodnotitele jménem a volitelná verze pro optimalizaci agenta.

OptimizationInlineDatasetInput

Položky optimalizační datové sady jsou přímo v těle požadavku.

OptimizationJob

Práce optimalizace agenta, která sleduje vstupy, pokrok, stav a výsledky hodnocení kandidátů.

OptimizationJobInputs

Agent, datové sady, hodnotitelé a možnosti poskytované pro optimalizaci agenta.

OptimizationJobListItem

Shrnutí role optimalizace agenta vrácené operací seznamu.

OptimizationJobProgress

Snímek průběhu obsahující počet dokončených kandidátů, nejlepší skóre a uplynulý čas provedení.

OptimizationJobResult

Vyhodnocovali kandidáty a identifikátory výchozího a nejlepšího kandidáta z optimalizační práce.

OptimizationOptions

Nastavení, která řídí generování kandidátů, výběr modelu a hodnocení pro optimalizaci agentů.

OptimizationReferenceDatasetInput

Odkaz na registrovanou datovou sadu Foundry podle názvu a volitelnou verzi pro optimalizaci agenta.

PageOrder

Typ pořadí stránek

PendingUploadType

Typ čekajícího nahrání.

PublishApprovalStatus

Stav kontroly certifikace Microsoft Agent pro název obchodu Microsoft 365 zveřejněný pro agenta.

RaiInvocationContentType

Jak je tělo žádosti/odpovědi vyvolán pro nalezení textu pro moderování obsahu a bezpečnosti obsahu.

RaiInvocationMode

Autorem deklarovaný tvar odpovědi pro protokol volání.

RankerVersionType

Typ rankeraVerziTyp

RealtimeAudioFormatsType

Typ RealtimeAudioFormátTyp

RealtimeAudioFormatsUnion

Alias pro RealtimeAudioFormatsUnion

RealtimeClientEventType

Typ události RealtimeClientEvent

RealtimeClientEventUnion

Alias pro RealtimeClientEventUnion

RealtimeConversationItemMessageType

Typ RealtimeKonverzacePoložkaTyp zprávy

RealtimeConversationItemMessageUnion

Alias pro RealtimeConversationItemMessageUnion

RealtimeConversationItemType

Typ RealtimeKonverzacePoložkaTyp

RealtimeConversationItemUnion

Alias pro RealtimeConversationItemUnion

RealtimeFunctionToolParameters

Rozhraní modelu RealtimeFunctionToolParameters

RealtimeMCPErrorType

Typ RealtimeMCPErrorType

RealtimeMCPErrorUnion

Alias pro RealtimeMCPErrorUnion

RealtimeReasoningEffort

Omezuje úsilí při uvažování u realtime modelů schopných uvažování, jako je gpt-realtime-2.

RealtimeServerEventType

Typ události RealtimeServerEvent

RealtimeServerEventUnion

Alias pro RealtimeServerEventUnion

ReasoningEffort

Omezuje úsilí na odůvodnění modelů odůvodňování. Aktuálně podporované hodnoty jsou none, minimal, low, medium, high, a .xhigh Snížení úsilí o odůvodnění může vést k rychlejším odpovědím a menšímu počtu tokenů používaných při odůvodnění v odpovědi.

  • gpt-5.1 výchozí je , nonekteré neprovádí uvažování. Podporované hodnoty uvažování pro gpt-5.1 jsou none, low, medium, a high. Volání nástrojů jsou podporována pro všechny hodnoty odůvodnění v gpt-5.1.
  • Všechny předchozí modely gpt-5.1 se standardně zaměřují na medium úsilí o uvažování a nepodporují none.
  • Model gpt-5-pro ve výchozím nastavení využívá (a pouze podporuje) high úsilí o uvažování.
  • xhigh je podporováno pro všechny modely po gpt-5.1-codex-max.
ReasoningModeEnum

Alias pro ReasoningModeEnum

RecurrenceScheduleUnion

Alias pro RecurrenceScheduleUnion

RecurrenceType

Typ opakování.

RedTeamTargetConfigUnion

Alias for RedTeamTargetConfigUnion

RiskCategory

Kategorie rizika pro cíl útoku.

RoutineActionType

Diskriminační hodnoty podporované pro rutinní činy.

RoutineActionUnion

Alias pro RoutineActionUnion

RoutineAttemptSource

Známé zdrojové cesty, které mohou vytvořit rutinní běh.

RoutineDispatchIdentity

Podporované identity pro rutinní autorizaci odeslání.

RoutineDispatchPayloadType

Diskriminační hodnoty podporované pro manuální rutinní dispečerské náklady.

RoutineDispatchPayloadUnion

Alias pro RoutineDispatchPayloadUnion

RoutineRunPhase

Známé fáze životního cyklu zaznamenané pro rutinní běh.

RoutineRunStatus

Stav rutinního běhu.

RoutineTriggerType

Diskriminační hodnoty podporované pro rutinní spouštěče.

RoutineTriggerUnion

Alias pro RoutineTriggerUnion

RubricGenerationInputQualityWarningCode

Stabilní vyhledávatelný strojově čitelný varovný kód pro generování rubrik pro varování kvality vstupu. Hodnoty jsou snake_case; klienti musí tolerovat další identifikátory definované službou.

RubricGenerationInputQualityWarningSeverity

Varování o kvalitě vstupu generované rubrikou. Počáteční množina warninghodnot: .

RubricGenerationInputQualityWarningSource

Zdroj varování pro generování rubriky a kvalitu vstupu. Hodnoty pro zdroj (prompt, agent, dataset) odpovídají zdrojové kategorii viditelné pro generační runtime. aggregate je syntetická hodnota používaná pouze pro varování vypočítaná napříč úspěšně vyřizenými zdroji. traces není vystaven, protože trace sources se rozkládají do obsahu datové sady výše v proudu.

RunPoller

Dotazník pro dlouhodobě běžící operaci, která vytváří zdroj běhu.

SampleType

Typ vzorku použitého při analýze.

ScheduleProvisioningStatus

Naplánujte si stav zřizování.

ScheduleTaskType

Typ úkolu

ScheduleTaskUnion

Alias pro ScheduleTaskUnion

SearchContentType

Typ vyhledáváníObsahTyp

SearchContextSize

Typ SearchContextSize

SessionLogEventType

Známé typy událostí SSE vysílané logem hostovaného agenta. Další typy událostí mohou být zavedeny v budoucích verzích.

SimpleQnAFineTuningQuestionType

Podporované typy otázek pro úlohy generování dat SimpleQnA používané pro doladění scénářů.

TelemetryDataKind

Typ telemetrických dat k exportu.

TelemetryEndpointAuthType

Typ autentizace pro telemetrický endpoint.

TelemetryEndpointAuthUnion

Alias for TelemetryEndpointAuthUnion

TelemetryEndpointKind

Typ endpointu pro export telemetrie.

TelemetryEndpointUnion

Alias for TelemetryEndpointUnion

TelemetryTransportProtocol

Transportní protokol pro export telemetrie.

TelephonyBindingListItemUnion

Alias pro TelephonyBindingListItemUnion

TelephonyBindingStatus

Životní cyklus telefonního vazby.

TelephonyBindingUnion

Alias pro TelephonyBindingUnion

TelephonyCallDurationBasis

Časové razítko sloužilo jako základ pro délku hovoru.

TelephonyCallEndReason

Známé důvody generované službou, proč jeden telefonní hovor skončil, nikoli důvody pro celkovou odchozí zakázku. Další kódy řetězců mohou být vráceny.

TelephonyCallJobStatus

Životní cyklus trvalé odchozí call zakázky.

TelephonyCallJobTerminalReason

Známé důvody pro celkové odchozí hovory, které mohou zahrnovat více pokusů o poskytování služeb. Tyto se liší od důvodů životního cyklu jednotlivých hovorů. Další kódy řetězců mohou být vráceny.

TelephonyCallLifecycleEventName

Název události životního cyklu nezávislý na poskytovateli. Známé hodnoty jsou stabilní; v průběhu času mohou být přidávány další hodnoty.

TelephonyCallLifecycleEventOutcome

Výsledek jednoho pozorování životního cyklu telefonie.

TelephonyCallLifecycleEventReason

Známé důvody generované službou pro životní cyklus telefonní komunikace. Důvod události nemusí nutně popisovat konečný výsledek hovoru. Další kódy řetězců mohou být vráceny.

TelephonyCallLifecycleEventSource

Komponenta, která zajišťovala pozorování životního cyklu telefonie.

TelephonyCallPhase

Neutrální fáze poskytovatele dosažená příchozím telefonickým hovorem.

TelephonyCallStatus

Životní cyklus příchozího telefonního hovoru.

TelephonyCallTimestampSource

Zdroj časového razítka životního cyklu telefonie.

TelephonyCallTraceMode

Režim používaný k odhalení telefonního hovoru jako zákaznicky orientovaného Foundry trasování.

TelephonyCallTraceStatus

Stav dostupnosti telefonního hovoru zaměřeného na zákazníka.

TelephonyOutboundDestinationType

Typ destinace pro odchozí hovor.

TelephonyOutboundRetryPolicyType

Strategie opakování pro odchozí hovor.

TelephonyOutboundRetryPolicyUnion

Alias pro TelephonyOutboundRetryPolicyUnion

TelephonyProvider

Poskytovatel telefonie podporovaný agentovým vázáním. Známé hodnoty jsou stabilní; v průběhu času mohou být přidávány další hodnoty.

TelephonyTransferDestinationKind

Typ telekomunikačního přestupního místa. Známé hodnoty jsou stabilní; v průběhu času mohou být přidávány další hodnoty.

TelephonyTransferDestinationUnion

Alias pro TelephonyTransferDestinationUnion

TextResponseFormatConfigurationType

Typ textuOdpověďFormátKonfiguraceTyp

TextResponseFormatConfigurationUnion

Podporovala konfigurace pro prostý text a strukturované JSON odpovědi.

TextResponseFormatUnion

Alias pro TextResponseFormatUnion

ToolChoiceOptions

Určuje, který nástroj model volá, pokud nějaký existuje. none znamená, že model nebude volat žádný nástroj a místo toho vygeneruje zprávu. auto znamená, že model si může vybrat mezi generováním zprávy nebo voláním jednoho nebo více nástrojů. required znamená, že model musí použít několik nástrojů.

ToolChoiceParamType

Typ nástrojeChoiceParamType

ToolChoiceParamUnion

Alias pro ToolChoiceParamUnion

ToolSearchExecutionType

Typ nástrojeVyhledáváníProváděníTyp

ToolType

Typ nástroje

ToolUnion

Alias pro ToolUnion

ToolboxShellEnvironmentUnion

Alias pro ToolboxShellEnvironmentUnion

ToolboxShellNetworkPolicyUnion

Alias pro ToolboxShellNetworkPolicyUnion

ToolboxSkillUnion

Alias pro ToolboxSkillUnion

ToolboxToolType

Podporované typy nástrojů pro nástroje uložené v nástrojové krabici.

ToolboxToolUnion

Alias pro ToolboxToolUnion

ToolboxesInvokeLatestToolboxMcpResponse

Odpověď vrácená z nejnovějšího endpointu toolbox MCP.

TreatmentEffectType

Typ účinku ošetření.

TriggerType

Typ spouštěče.

TriggerUnion

Alias pro TriggerUnion

VersionIndicatorType

Typ indikátoru verze používaný k určení agentní verze zálohující relaci.

VersionIndicatorUnion

Alias pro VersionIndicatorUnion

VersionSelectionRuleType

Typ verzeVýběrPravidloTyp

VersionSelectionRuleUnion

Alias pro VersionSelectionRuleUnion

VoiceAgentAnimationOutputType

Animace vytvořená hlasovou agentní sezením.

VoiceAgentAudioTimestampType

Časový typ výstupního zvuku podporovaný hlasovým agentem.

VoiceAgentAvatarOutputProtocol

Transport, který doručoval video stream avatara.

VoiceAgentAvatarType

Typ avatara.

VoiceAgentClientEvent

Stabilní zpráva v1 odeslaná klientem přes hlasový agent WebSocket.

VoiceAgentConnectionState

Stavy spojení hlášené hlasovým agentem v reálném čase.

VoiceAgentConnectionStateChangedHandler

Volá, když se spojení hlasového agenta změní ve svém stavu.

VoiceAgentEchoCancellationReferenceSource

Zdroj referenčního zvuku používaného pro potlačení ozvěny.

VoiceAgentEndOfUtteranceDetectionModel

Sémantický model detekce koncové věty.

VoiceAgentEndOfUtteranceThresholdLevel

Práh citlivosti pro sémantickou detekci konce věty.

VoiceAgentGreetingConfigUnion

Alias for VoiceAgentGreetingConfigUnion

VoiceAgentInputTranscriptionModel

Identifikátor modelu transkripce vstupně-audio. Je to název modelu, ne název nasazení ve Foundry. Zrcadlí transkripční modely podporované spravovaným hlasovým backendem, pokrývající OpenAI realtime transkripční modely plus modely Azure a MAI. Další hodnoty mohou být přidány v průběhu času.

VoiceAgentInterimResponseConfigUnion

Alias for VoiceAgentInterimResponseConfigUnion

VoiceAgentInterimResponseTrigger

Stav, který může vyvolat dočasnou reakci.

VoiceAgentMaxOutputTokens

Maximální počet výstupních tokenů nebo literál inf.

VoiceAgentNoiseReductionType

Režim redukce šumu na vstupním zvuku.

VoiceAgentRealtimeErrorCode

Chybové kódy vyvolávané klientem Voice Agents v reálném čase.

VoiceAgentRealtimeEvent

Událost přijatá z hlasového agenta v reálném čase.

Známé události si zachovávají své generované typy a normalizaci. Nerozpoznané typy drátů jsou zabaleny do VoiceAgentUnknownEvent. Přepněte na úzké známé události, nebo vynechejte typetype === "unknown" před předáním události obslužníkovi známé události.

VoiceAgentServerEvent

Stabilní zpráva v1 odeslaná službou přes hlasový agent WebSocket.

VoiceAgentSessionIncludeOption

Další pole, která může hlasová agentní relace obsahovat ve výstupech služeb.

VoiceAgentSessionResponse

Efektivní konfigurace relace se vrátila v životním cyklu hlasových agentů.

VoiceAgentSessionUpdate

Konfigurace relace je přijata aktualizací relace hlasovým agentem.

VoiceAgentSubagentAbortReason

Důvod, proč byla konzultace se subagentem zrušena.

VoiceAgentSystemToolName

Servisně řízená akce řízení hlasové relace. Známé hodnoty jsou stabilní; v průběhu času mohou být přidávány další hodnoty.

VoiceAgentSystemToolUnion

Alias pro VoiceAgentSystemToolUnion

VoiceAgentToolChoice

Chování při výběru nástroje pro hlasového agenta.

VoiceAgentToolResponseScheduling

Když vyvolání nástroje vyvolá následnou odpověď. Další hodnoty mohou být přidány v průběhu času.

VoiceAgentToolUnion

Alias pro VoiceAgentToolUnion

VoiceAgentTransport

Transport použitý pro spojení hlasu a agenta.

VoiceAgentTurnDetectionConfigUnion

Alias for VoiceAgentTurnDetectionConfigUnion

VoiceAgentTurnDetectionType

Strategie detekce zatáčení. Další hodnoty mohou být přidány v průběhu času.

VoiceAgentWebSocketMessage

Textová zpráva JSON vyměněná přes zavedený hlasový agent WebSocket. Audio bajty jsou kódovány base64 v JSON eventových polích.

VoiceAgentWebSocketSubprotocol

Subprotokol WebSocket podporovaný hlasovým agentem.

VoiceAudioCodec

Audio kodek. Další hodnoty mohou být přidány v průběhu času.

VoiceAudioContainerFormat

Formát audio kontejneru. Další hodnoty mohou být přidány v průběhu času.

VoiceAudioRole

Role hlasového a audio účastníka. Další hodnoty mohou být přidány v průběhu času.

VoiceConversationEngineUnion

Alias pro VoiceConversationEngineUnion

VoiceConversationStatus

Životní cyklus trvalé hlasové konverzace:

  • in_progress: živá relace je aktivní, nebo je dokončena po-relace na dokončení trvalosti.
  • completed: dokončení úspěšné po běžném nebo klientském uzavření, end_conversation, uzavření s maximální dobou trvání 1001 nebo odpojení klienta či sítě, které služba může stále dokončit.
  • failed: selhání terminální služby, mostu, úložiště nebo nenapravitelného transportu zabránilo dokončení dokončení.
VoiceModelType

Jak je model podporující hlasového agenta poskytován. To je nezávislé na architektuře (v reálném čase nebo kaskádě), kterou služba odvozuje z vybraného modelu.

VoiceOutputModality

Výstupní modalita, kterou může agent produkovat. animation a avatar používají se při konfiguraci avatara.

VoiceType

Implementace hlasu. Další hodnoty mohou být přidány v průběhu času.

Výčty

KnownApiVersions

Verze API Microsoft Foundry

Funkce

isRestError(unknown)

Typeguard pro RestError

Proměnné

RestError

Vlastní typ chyby pro neúspěšné požadavky kanálu.

KnownVoiceAgentConnectionState

Známé hodnoty VoiceAgentConnectionState hlášené hlasovým agentem v reálném čase.

Podrobnosti funkce

isRestError(unknown)

Typeguard pro RestError

function isRestError(e: unknown): e is RestError

Parametry

e

unknown

Něco zachyceného klauzulí catch.

Návraty

e is RestError

Podrobnosti proměnné

RestError

Vlastní typ chyby pro neúspěšné požadavky kanálu.

RestError: RestErrorConstructor

Typ

KnownVoiceAgentConnectionState

Známé hodnoty VoiceAgentConnectionState hlášené hlasovým agentem v reálném čase.

KnownVoiceAgentConnectionState: { Closing: "closing", Connected: "connected", Connecting: "connecting", Disconnected: "disconnected" }

Typ

{ Closing: "closing", Connected: "connected", Connecting: "connecting", Disconnected: "disconnected" }