@azure/ai-projects package

Classi

AIProjectClient

Il client principale per l'AIProjectClient

VoiceAgentAuthenticationError

Un errore è stato generato durante l'acquisizione di un token di accesso Microsoft Entra.

VoiceAgentConnectionError

Un errore generato dalla connessione WebSocket.

VoiceAgentProtocolError

Un errore si genera quando un messaggio WebSocket non corrisponde al protocollo voice-agent.

VoiceAgentRealtimeClient

Client per stabilire sessioni in tempo reale con agenti vocali gestiti di Foundry.

VoiceAgentRealtimeError

Errore base generato dal client in tempo reale degli agenti vocali.

Interfacce

@azure/ai-projects.Index
A2APreviewTool

Un agente che implementa il protocollo A2A.

A2APreviewToolboxTool

Uno strumento A2A conservato in una cassetta degli attrezzi.

A2AProtocolConfiguration

Configurazione specifica per il protocollo A2A.

A2ATool

Un agente che implementa il protocollo A2A.

A2AToolboxTool

Uno strumento A2A conservato in una cassetta degli attrezzi.

AIProjectClientOptionalParams

Parametri facoltativi per il client.

AISearchIndexResource

Una risorsa dell'indice di ricerca AI.

ActivityProtocolConfiguration

Configurazione specifica per il protocollo di attività.

Agent

Agente dell'interfaccia modello

AgentBlueprintReference

interfaccia modello AgentBlueprintReference

AgentCard

interfaccia modello AgentCard

AgentCardSkill

interfaccia modello AgentCardSkill

AgentClusterInsightRequest

Informazioni dettagliate sul set di risultati della valutazione dell'agente

AgentClusterInsightResult

Informazioni dettagliate dall'analisi del cluster di agenti.

AgentDataGenerationJobSource

Sorgente di agente per lavori di generazione dati — riferimenti a un agente per recuperare istruzioni e metadati.

AgentDefinition

Interfaccia di definizione di base per gli agenti. Contiene il tipo di agente e la configurazione RAI facoltativa.

AgentEndpointAuthorizationScheme

interfaccia modello AgentEndpointAuthorizationScheme

AgentEndpointConfig

interfaccia modello AgentEndpointConfig

AgentEvaluatorGenerationJobSource

Source dell'agente per i lavori di generazione del valutatore — riferimenti a un agente per recuperare istruzioni e metadati.

AgentHarness

(Anteprima) Un runtime gestito e un loop di agente usati per eseguire un agente di prompt.

AgentIdentity

interfaccia modello AgentIdentity

AgentInsight

Un problema persistente scoperto dalle tracce di un agente.

AgentInsightDetails

Ulteriori dettagli di approfondimento. Omesso a meno che non vengano richiesti dettagli.

AgentInsightEstimatedCost

Costo stimato di Agent Insights.

AgentInsightHighlightedTrace

Una traccia evidenziata che fornisce prove di un'intuizione di un agente.

AgentInsightJsonObject

Un oggetto JSON utilizzato nei payload di Agent Insights.

AgentInsightLinkedTrace

Un riferimento leggero collegato a un intuito di un agente come prova a supporto.

AgentInsightMonitor

Un monitor Agent Insights per agente che possiede la configurazione, l'esecuzione e gli insight scoperti.

AgentInsightMonitorCreate

I campi accettati quando si crea un monitor Agent Insights per un agente.

AgentInsightMonitorListItem

Un riassunto del monitor Agent Insights restituito tramite operazioni di lista.

AgentInsightMonitorUpdate

Campi che possono essere aggiornati su un monitor Agent Insights.

AgentInsightProposedFix

Una soluzione consigliata per un'analisi dell'agente.

AgentInsightProposedFixChange

Una modifica renderizzabile dal cliente in una soluzione proposta.

AgentInsightRecommendedAction

La bonifica raccomandata per un agente è una visione.

AgentInsightRun

Una serie di lunga durata che analizza le tracce di un agente e aggiorna le sue intuizioni.

AgentInsightRunCreate

Input utilizzati durante la creazione di un insight per agenti eseguiti.

AgentInsightRunResult

Statistiche di risultato prodotte quando una run di insight dell'agente ha successo.

AgentInsightSuspension

Motivo strutturato per cui la generazione programmata è sospesa per un monitor.

AgentInsightTokenUsage

Utilizzo del token per una run Agent Insights.

AgentInsightUpdate

Campi che possono essere aggiornati in base alle intuizioni di un agente.

AgentInsightsOverview

La panoramica efficace per un monitor Agent Insights.

AgentInsightsOverviewOverride

Una panoramica fornita dagli utenti che diventa immediatamente efficace e genera la generazione successiva.

AgentOptimizationCandidate

Risultato aggregato della valutazione per una configurazione di singolo agente candidato su tutti i compiti.

AgentOptimizationDatasetCriterion

Criterio di valutazione: una coppia nome + istruzione utilizzata per il punteggio per singolo item.

AgentOptimizationDatasetInput

Modello discriminato di base per l'input del dataset. O in linea, o con una referenza registrata.

AgentOptimizationDatasetItem

Un singolo elemento in un dataset inline.

AgentOptimizationEvaluatorRef

Riferimento a un valutatore nominato, opzionalmente fissato su una versione.

AgentOptimizationInlineDatasetInput

Dataset inline — elementi forniti direttamente nel corpo della richiesta.

AgentOptimizationJob

Risorsa di lavoro per l'ottimizzazione dell'agente — un lavoro di lunga durata che ottimizza la configurazione di un agente (istruzioni, modello, competenze, strumenti) per massimizzare i punteggi di valutazione. Al successo, il risultato contiene i candidati punteggiati.

AgentOptimizationJobInputs

Input forniti dal chiamante per un lavoro di ottimizzazione.

AgentOptimizationJobListItem

Rappresentazione del lavoro ridotta dall'endpoint LIST.

AgentOptimizationJobProgress

Progressi in volo; Popolati solo mentre lo stato è in coda o in_progress.

AgentOptimizationJobResult

Corpo del risultato in stato terminale. Popolati quando lo status viene superato o fallito.

AgentOptimizationOptions

Regolare manopole e modalità run per un lavoro di ottimizzazione.

AgentOptimizationReferenceDatasetInput

Riferimento a un dataset registrato di Foundry.

AgentSessionResource

Una sessione di agente che fornisce un sandbox di calcolo di lunga durata per le invocazioni di agenti ospitate.

AgentTaxonomyInput

Configurazione dell'input per la tassonomia di valutazione quando il tipo di input è agente.

AgentVersion

Rappresenta una versione specifica di un agente. Include metadati, controllo delle versioni, ora di creazione e definizione dell'agente.

AgenticIdentityPreviewCredentials

Definizione delle credenziali di identità agentica

AgentsCreateAgentFromManifestOptionalParams

Parametri facoltativi.

AgentsCreateAgentVersionFromManifestOptionalParams

Parametri facoltativi.

AgentsCreateOptionalParams

Parametri facoltativi.

AgentsCreateSessionOptionalParams

Parametri facoltativi.

AgentsCreateTelephonyBindingOptionalParams

Parametri facoltativi.

AgentsCreateVersionFromCodeOptionalParams

Parametri facoltativi.

AgentsCreateVersionOptionalParams

Parametri facoltativi.

AgentsDeleteOptionalParams

Parametri facoltativi.

AgentsDeleteSessionFileOptionalParams

Parametri facoltativi.

AgentsDeleteSessionOptionalParams

Parametri facoltativi.

AgentsDeleteTelephonyBindingOptionalParams

Parametri facoltativi.

AgentsDeleteVersionOptionalParams

Parametri facoltativi.

AgentsDisableOptionalParams

Parametri facoltativi.

AgentsDownloadAgentCodeOptionalParams

Parametri facoltativi.

AgentsDownloadSessionFileOptionalParams

Parametri facoltativi.

AgentsEnableOptionalParams

Parametri facoltativi.

AgentsGetOptionalParams

Parametri facoltativi.

AgentsGetSessionLogStreamOptionalParams

Parametri facoltativi.

AgentsGetSessionOptionalParams

Parametri facoltativi.

AgentsGetTelephonyBindingOptionalParams

Parametri facoltativi.

AgentsGetVersionOptionalParams

Parametri facoltativi.

AgentsListOptionalParams

Parametri facoltativi.

AgentsListSessionFilesOptionalParams

Parametri facoltativi.

AgentsListSessionsOptionalParams

Parametri facoltativi.

AgentsListTelephonyBindingsOptionalParams

Parametri facoltativi.

AgentsListTelephonyCallsOptionalParams

Parametri facoltativi.

AgentsListVersionsOptionalParams

Parametri facoltativi.

AgentsOperations

Interfaccia che rappresenta le operazioni di un agente.

AgentsStopSessionOptionalParams

Parametri facoltativi.

AgentsUpdateAgentFromManifestOptionalParams

Parametri facoltativi.

AgentsUpdateAgentObjectOptionalParams

Parametri facoltativi.

AgentsUpdateOptionalParams

Parametri facoltativi.

AgentsUpdateTelephonyBindingOptionalParams

Parametri facoltativi.

AgentsUploadSessionFileOptionalParams

Parametri facoltativi.

ApiErrorResponse

Risposta di errore per errori API.

ApiKeyCredentials

Definizione delle credenziali della chiave API

ApplyPatchToolParam

Permette all'assistente di creare, cancellare o aggiornare file usando differenze unificate.

ApproximateLocation

interfaccia modello ApprossimazionePosizione

ArtifactProfile

Profilo artefatto del modello

AutoCodeInterpreterToolParam

Configurazione per un contenitore dell'interprete di codice. Facoltativamente, specificare gli ID dei file in cui eseguire il codice.

AzureAIAgentTarget

Rappresenta un target che specifica un agente AI Azure.

AzureAIModelTarget

Rappresenta un target che specifica un modello Azure AI per operazioni che richiedono la selezione del modello.

AzureAISearchIndex

definizione dell'indice Azure AI Search

AzureAISearchTool

Le informazioni di definizione di input per uno strumento di ricerca Azure AI come usate per configurare un agente.

AzureAISearchToolResource

Set di risorse di indice usate dallo strumento azure_ai_search.

AzureAISearchToolboxTool

Uno strumento Azure AI Search memorizzato in una cassetta degli attrezzi.

AzureAgentConfig

Opzioni di configurazione per l'endpoint agente del metodo getOpenAIClient. Principalmente usato per agenti ospiti.

AzureFunctionBinding

Struttura per mantenere storage nome della coda e URI.

AzureFunctionDefinition

La definizione di funzione Azure.

AzureFunctionStorageQueue

Struttura per mantenere storage nome della coda e URI.

AzureFunctionTool

Le informazioni di definizione in input per uno strumento di funzione Azure, come usato per configurare un Agente.

AzureOpenAIModelConfiguration

Azure configurazione del modello OpenAI. La versione dell'API verrebbe selezionata dal servizio per l'esecuzione di query sul modello.

BaseCredentials

Una classe di base per le credenziali di connessione

BetaAgentInsightMonitorsCancelRunOptionalParams

Parametri facoltativi.

BetaAgentInsightMonitorsCreateOptionalParams

Parametri facoltativi.

BetaAgentInsightMonitorsCreateRunOptionalParams

Parametri facoltativi.

BetaAgentInsightMonitorsDeleteOptionalParams

Parametri facoltativi.

BetaAgentInsightMonitorsGetInsightOptionalParams

Parametri facoltativi.

BetaAgentInsightMonitorsGetOptionalParams

Parametri facoltativi.

BetaAgentInsightMonitorsGetRunOptionalParams

Parametri facoltativi.

BetaAgentInsightMonitorsListInsightsOptionalParams

Parametri facoltativi.

BetaAgentInsightMonitorsListOptionalParams

Parametri facoltativi.

BetaAgentInsightMonitorsListRunsOptionalParams

Parametri facoltativi.

BetaAgentInsightMonitorsOperations

Interfaccia che rappresenta un'operazione BetaAgentInsightMonitors.

BetaAgentInsightMonitorsResetOptionalParams

Parametri facoltativi.

BetaAgentInsightMonitorsUpdateInsightOptionalParams

Parametri facoltativi.

BetaAgentInsightMonitorsUpdateOptionalParams

Parametri facoltativi.

BetaAgentsCancelOptimizationJobOptionalParams

Parametri facoltativi.

BetaAgentsCreateFromPromptOptionalParams

Parametri facoltativi.

BetaAgentsCreateOptimizationJobOptionalParams

Parametri facoltativi.

BetaAgentsDeleteOptimizationJobOptionalParams

Parametri facoltativi.

BetaAgentsGetOptimizationJobOptionalParams

Parametri facoltativi.

BetaAgentsListOptimizationJobsOptionalParams

Parametri facoltativi.

BetaAgentsOperations

Operazioni per agenti di management.

BetaDatasetsCancelGenerationJobOptionalParams

Parametri facoltativi.

BetaDatasetsCreateGenerationJobOptionalParams

Parametri facoltativi.

BetaDatasetsDeleteGenerationJobOptionalParams

Parametri facoltativi.

BetaDatasetsGetGenerationJobOptionalParams

Parametri facoltativi.

BetaDatasetsListGenerationJobsOptionalParams

Parametri facoltativi.

BetaDatasetsOperations

Interfaccia che rappresenta le operazioni di un BetaDataset.

BetaEvaluationTaxonomiesCreateOptionalParams

Parametri facoltativi.

BetaEvaluationTaxonomiesDeleteOptionalParams

Parametri facoltativi.

BetaEvaluationTaxonomiesGetOptionalParams

Parametri facoltativi.

BetaEvaluationTaxonomiesListOptionalParams

Parametri facoltativi.

BetaEvaluationTaxonomiesOperations

Interfaccia che rappresenta un'operazione di BetaEvaluationTaxonomies.

BetaEvaluationTaxonomiesUpdateOptionalParams

Parametri facoltativi.

BetaEvaluatorsCancelGenerationJobOptionalParams

Parametri facoltativi.

BetaEvaluatorsCreateGenerationJobOptionalParams

Parametri facoltativi.

BetaEvaluatorsCreateVersionOptionalParams

Parametri facoltativi.

BetaEvaluatorsDeleteGenerationJobOptionalParams

Parametri facoltativi.

BetaEvaluatorsDeleteVersionOptionalParams

Parametri facoltativi.

BetaEvaluatorsGetCredentialsOptionalParams

Parametri facoltativi.

BetaEvaluatorsGetGenerationJobOptionalParams

Parametri facoltativi.

BetaEvaluatorsGetVersionOptionalParams

Parametri facoltativi.

BetaEvaluatorsListGenerationJobsOptionalParams

Parametri facoltativi.

BetaEvaluatorsListOptionalParams

Parametri facoltativi.

BetaEvaluatorsListVersionsOptionalParams

Parametri facoltativi.

BetaEvaluatorsOperations

Interfaccia che rappresenta le operazioni di un BetaEvaluators.

BetaEvaluatorsPendingUploadOptionalParams

Parametri facoltativi.

BetaEvaluatorsUpdateVersionOptionalParams

Parametri facoltativi.

BetaInsightsGenerateOptionalParams

Parametri facoltativi.

BetaInsightsGetOptionalParams

Parametri facoltativi.

BetaInsightsListOptionalParams

Parametri facoltativi.

BetaInsightsOperations

Interfaccia che rappresenta un'operazione BetaInsights.

BetaMemoryStoresCreateMemoryOptionalParams

Parametri facoltativi.

BetaMemoryStoresCreateOptionalParams

Parametri facoltativi.

BetaMemoryStoresDeleteMemoryOptionalParams

Parametri facoltativi.

BetaMemoryStoresDeleteOptionalParams

Parametri facoltativi.

BetaMemoryStoresDeleteScopeOptionalParams

Parametri facoltativi.

BetaMemoryStoresGetMemoryOptionalParams

Parametri facoltativi.

BetaMemoryStoresGetOptionalParams

Parametri facoltativi.

BetaMemoryStoresGetUpdateResultOptionalParams

Parametri facoltativi.

BetaMemoryStoresListMemoriesOptionalParams

Parametri facoltativi.

BetaMemoryStoresListOptionalParams

Parametri facoltativi.

BetaMemoryStoresOperations

Interfaccia che rappresenta un'operazione BetaMemoryStores.

BetaMemoryStoresSearchMemoriesOptionalParams

Parametri facoltativi.

BetaMemoryStoresUpdateMemoriesOptionalParams

Parametri facoltativi.

BetaMemoryStoresUpdateMemoryOptionalParams

Parametri facoltativi.

BetaMemoryStoresUpdateOptionalParams

Parametri facoltativi.

BetaModelsCreateOptions

Opzioni per il metodo create che carica i file locali e registra una versione del modello.

BetaModelsDeleteOptionalParams

Parametri facoltativi.

BetaModelsGetCredentialsOptionalParams

Parametri facoltativi.

BetaModelsGetOptionalParams

Parametri facoltativi.

BetaModelsListOptionalParams

Parametri facoltativi.

BetaModelsListVersionsOptionalParams

Parametri facoltativi.

BetaModelsOperations

Interfaccia che rappresenta un'operazione di BetaModel.

BetaModelsPendingCreateVersionOptionalParams

Parametri facoltativi.

BetaModelsPendingUploadOptionalParams

Parametri facoltativi.

BetaModelsUpdateOptionalParams

Parametri facoltativi.

BetaOperations

Interfaccia che rappresenta un'operazione Beta.

BetaRedTeamsCreateOptionalParams

Parametri facoltativi.

BetaRedTeamsGetOptionalParams

Parametri facoltativi.

BetaRedTeamsListOptionalParams

Parametri facoltativi.

BetaRedTeamsOperations

Interfaccia che rappresenta un'operazione di BetaRedTeams.

BetaRoutinesCreateOrUpdateOptionalParams

Parametri facoltativi.

BetaRoutinesDeleteOptionalParams

Parametri facoltativi.

BetaRoutinesDisableOptionalParams

Parametri facoltativi.

BetaRoutinesDispatchOptionalParams

Parametri facoltativi.

BetaRoutinesEnableOptionalParams

Parametri facoltativi.

BetaRoutinesGetOptionalParams

Parametri facoltativi.

BetaRoutinesListOptionalParams

Parametri facoltativi.

BetaRoutinesListRunsOptionalParams

Parametri facoltativi.

BetaRoutinesOperations

Interfaccia che rappresenta un'operazione BetaRoutines.

BetaSchedulesCreateOrUpdateOptionalParams

Parametri facoltativi.

BetaSchedulesDeleteOptionalParams

Parametri facoltativi.

BetaSchedulesGetOptionalParams

Parametri facoltativi.

BetaSchedulesGetRunOptionalParams

Parametri facoltativi.

BetaSchedulesListOptionalParams

Parametri facoltativi.

BetaSchedulesListRunsOptionalParams

Parametri facoltativi.

BetaSchedulesOperations

Interfaccia che rappresenta un'operazione BetaSchedules.

BetaSkillsCreateOptionalParams

Parametri facoltativi.

BetaSkillsCreateVersionFromFilesOptionalParams

Parametri facoltativi.

BetaSkillsDeleteOptionalParams

Parametri facoltativi.

BetaSkillsDeleteVersionOptionalParams

Parametri facoltativi.

BetaSkillsDownloadOptionalParams

Parametri facoltativi.

BetaSkillsDownloadVersionOptionalParams

Parametri facoltativi.

BetaSkillsGetOptionalParams

Parametri facoltativi.

BetaSkillsGetVersionOptionalParams

Parametri facoltativi.

BetaSkillsListOptionalParams

Parametri facoltativi.

BetaSkillsListVersionsOptionalParams

Parametri facoltativi.

BetaSkillsOperations

Interfaccia che rappresenta un'operazione BetaSkills.

BetaSkillsUpdateOptionalParams

Parametri facoltativi.

BetaVoiceAgentsConversationsDeleteOptionalParams

Parametri facoltativi.

BetaVoiceAgentsConversationsDownloadAudioItemOptionalParams

Parametri facoltativi.

BetaVoiceAgentsConversationsDownloadAudioOptionalParams

Parametri facoltativi.

BetaVoiceAgentsConversationsDownloadGeneratedAudioItemOptionalParams

Parametri facoltativi.

BetaVoiceAgentsConversationsGetAudioItemOptionalParams

Parametri facoltativi.

BetaVoiceAgentsConversationsGetAudioOptionalParams

Parametri facoltativi.

BetaVoiceAgentsConversationsGetGeneratedAudioItemOptionalParams

Parametri facoltativi.

BetaVoiceAgentsConversationsGetItemOptionalParams

Parametri facoltativi.

BetaVoiceAgentsConversationsGetOptionalParams

Parametri facoltativi.

BetaVoiceAgentsConversationsGetResponseOptionalParams

Parametri facoltativi.

BetaVoiceAgentsConversationsListItemsOptionalParams

Parametri facoltativi.

BetaVoiceAgentsConversationsListOptionalParams

Parametri facoltativi.

BetaVoiceAgentsConversationsListResponseItemsOptionalParams

Parametri facoltativi.

BetaVoiceAgentsConversationsListResponsesOptionalParams

Parametri facoltativi.

BetaVoiceAgentsConversationsOperations

Operazioni per la gestione delle conversazioni degli agenti vocali.

BetaVoiceAgentsOperations

Operazioni per la gestione delle conversazioni degli operatori vocali e della telefonia.

BetaVoiceAgentsTelephonyCancelCallJobOptionalParams

Parametri facoltativi.

BetaVoiceAgentsTelephonyCreateBindingOptionalParams

Parametri facoltativi.

BetaVoiceAgentsTelephonyCreateCallJobOptionalParams

Parametri facoltativi.

BetaVoiceAgentsTelephonyDeleteBindingOptionalParams

Parametri facoltativi.

BetaVoiceAgentsTelephonyEndCallOptionalParams

Parametri facoltativi.

BetaVoiceAgentsTelephonyGetBindingOptionalParams

Parametri facoltativi.

BetaVoiceAgentsTelephonyGetCallJobOptionalParams

Parametri facoltativi.

BetaVoiceAgentsTelephonyGetCallOptionalParams

Parametri facoltativi.

BetaVoiceAgentsTelephonyGetTransferTargetsOptionalParams

Parametri facoltativi.

BetaVoiceAgentsTelephonyListBindingsOptionalParams

Parametri facoltativi.

BetaVoiceAgentsTelephonyListCallsOptionalParams

Parametri facoltativi.

BetaVoiceAgentsTelephonyOperations

Operazioni per la gestione della telefonia degli agenti vocali.

BetaVoiceAgentsTelephonyReplaceTransferTargetsOptionalParams

Parametri facoltativi.

BetaVoiceAgentsTelephonyTransferCallOptionalParams

Parametri facoltativi.

BetaVoiceAgentsTelephonyUpdateBindingOptionalParams

Parametri facoltativi.

BingCustomSearchConfiguration

Una bing configurazione di ricerca personalizzata.

BingCustomSearchPreviewTool

Informazioni sulla definizione di input per un Bing strumento di ricerca personalizzato usato per configurare un agente.

BingCustomSearchToolParameters

Il bing parametri dello strumento di ricerca personalizzato.

BingGroundingSearchConfiguration

Configurazione di ricerca per Bing grounding

BingGroundingSearchToolParameters

Parametri dello strumento di ricerca a terra bing.

BingGroundingTool

Informazioni sulla definizione di input per un bing strumento di ricerca a terra usato per configurare un agente.

BlobReference

Dettagli di riferimento BLOB.

BotServiceAuthorizationScheme

interfaccia modello BotServiceAuthorizationScheme

BotServiceRbacAuthorizationScheme

interfaccia modello BotServiceRbacAuthorizationScheme

BotServiceTenantAuthorizationScheme

interfaccia modello BotServiceTenantAuthorizationScheme

BrowserAutomationPreviewTool

Le informazioni di input della definizione per uno strumento di automazione del browser, utilizzate per configurare un agente.

BrowserAutomationPreviewToolboxTool

Uno strumento di automazione del browser archiviato in una cassetta degli attrezzi.

BrowserAutomationToolConnectionParameters

Definizione dei parametri di input per la connessione utilizzata dal Browser Automation Tool.

BrowserAutomationToolParameters

Definizione dei parametri di input per il Browser Automation Tool.

CaptureStructuredOutputsTool

Uno strumento per l'acquisizione di output strutturati

ChartCoordinate

Coordinate per il grafico di analisi.

ChatSummaryMemoryItem

Un elemento di memoria contenente un riepilogo estratto dalle conversazioni.

ClusterInsightResult

Approfondimenti dall'analisi dei cluster.

ClusterTokenUsage

Utilizzo dei token per l'analisi dei cluster

CodeBasedEvaluatorDefinition

Definizione dell'analizzatore basata su codice utilizzando il codice Python

CodeConfiguration

Configurazione di distribuzione basata su codice per un agente ospitato.

CodeInterpreterTool

Uno strumento che esegue codice Python per aiutare a generare una risposta a un prompt.

CodeInterpreterToolboxTool

Uno strumento di interpretazione di codice memorizzato in una cassetta degli attrezzi.

ComparisonFilter

Filtro utilizzato per confrontare una chiave di attributo specificata con un determinato valore usando un'operazione di confronto definita.

CompoundFilter

Combinare più filtri usando and o or.

ComputerTool

Strumento che controlla un computer virtuale. Scopri di più sullo strumento informatico.

ComputerUsePreviewTool

Strumento che controlla un computer virtuale. Scopri di più sullo strumento informatico.

Connection

Risposta dall'elenco e operazioni di get connections

ConnectionsGetOptionalParams

Parametri facoltativi.

ConnectionsGetWithCredentialsOptionalParams

Parametri facoltativi.

ConnectionsListOptionalParams

Parametri facoltativi.

ConnectionsOperations

Interfaccia che rappresenta un'operazione di connessione.

ContainerAutoParam

interfaccia modello ContainerAutoParam

ContainerConfiguration

Configurazione di distribuzione basata su container per un agente ospitato.

ContainerNetworkPolicyAllowlistParam

interfaccia modello ContainerNetworkPolicyAllowlistParam

ContainerNetworkPolicyDisabledParam

interfaccia modello ContainerNetworkPolicyDisabledParam

ContainerNetworkPolicyDomainSecretParam

interfaccia modello ContainerNetworkPolicyDomainSecretParam

ContainerNetworkPolicyParam

Politica di accesso alla rete per il container.

ContainerSkill

interfaccia modello ContainerSkill

ContinuousEvaluationRuleAction

Azione della regola di valutazione per la valutazione continua.

CosmosDBIndex

Definizione dell'indice dell'archivio vettoriale CosmosDB

CreateAgentVersionFromCodeContent

Corpo di richiesta multiparte per l'aggiornamento o la versionizzazione di un agente basato su codice (POST /agents/{name} e POST /agents/{name}/versioni).

CreateAgentVersionFromCodeMetadata

Metadati JSON per operazioni di agente basate su codice (crea, aggiorna, crea versione). Il nome dell'agente deriva dal parametro del percorso URL o dall'intestare x-ms-agent-name , quindi non è incluso in questo modello. L'hash del contenuto (SHA-256 dello zip) è contenuto nell'intestazione x-ms-code-zip-sha256 (header).

CreateSkillVersionFromFilesBody

Multipart richiede corpo per creare una versione di skill dai file. Accetta un singolo file zip o più file di abilità individuali (caricamento della directory). Per i caricamenti zip, il server estrae e valida i contenuti. Per il caricamento delle directory, i file sono validati as-is.

CreateTeamsPhoneExtensionTelephonyBindingRequest

La richiesta di creare un binding Telefono di Microsoft Teams Extension.

CreateTelephonyBindingRequest

La richiesta di creare un collegamento telefonico.

CreateTelephonyCallJobRequest

Una richiesta per creare un unico lavoro di chiamata diretta in uscita duraturo.

CreateTranscriptionResponseJsonUsage

Statistiche di utilizzo dei token per la richiesta.

CreateTwilioTelephonyBindingRequest

La richiesta di creare una rilegatura Twilio.

CronTrigger

Grilletto basato su Cron.

CustomCredential

Definizione delle credenziali personalizzate

CustomGrammarFormatParam

Una grammatica definita dall'utente.

CustomRoutineTrigger

Un trigger personalizzato per la routine degli eventi.

CustomTextFormatParam

Testo libero e senza vincoli.

CustomToolParam

Uno strumento personalizzato che elabora l'input usando un formato specificato. Scopri di più su custom tools

CustomToolParamFormat

Il formato di input per lo strumento personalizzato. Il predefinito è testo senza vincoli.

DailyRecurrenceSchedule

Pianificazione giornaliera delle ricorrenze.

DataGenerationJob

Risorsa per il lavoro per la generazione dati.

DataGenerationJobInputs

Input forniti dal chiamante per un lavoro di generazione dati.

DataGenerationJobOptions

Opzioni per gestire i lavori di generazione dati.

DataGenerationJobOutput

Genera informazioni per un lavoro di generazione dati.

DataGenerationJobOutputOptions

Opzioni di output per il lavoro di generazione dati.

DataGenerationJobResult

Risultato prodotto da un lavoro di generazione dati riuscito.

DataGenerationJobSource

Il modello base per i lavori di generazione dati.

DataGenerationModelOptions

Opzioni di modello LLM per lavori di generazione dati.

DataGenerationTokenUsage

Informazioni sull'utilizzo dei token per un lavoro di generazione dati.

DatasetCredential

Rappresenta un riferimento a un BLOB per l'utilizzo

DatasetDataGenerationJobOutput

Output dataset per un lavoro di generazione dati.

DatasetEvaluatorGenerationJobSource

Sorgente di dataset per lavori di generazione valutatori — riferimento a un dataset.

DatasetReference

Riferimento a un dataset versionato di Foundry.

DatasetVersion

Definizione di DatasetVersion

DatasetsCreateOrUpdateOptionalParams

Parametri facoltativi.

DatasetsDeleteOptionalParams

Parametri facoltativi.

DatasetsGetCredentialsOptionalParams

Parametri facoltativi.

DatasetsGetOptionalParams

Parametri facoltativi.

DatasetsListOptionalParams

Parametri facoltativi.

DatasetsListVersionsOptionalParams

Parametri facoltativi.

DatasetsOperations

Interfaccia che rappresenta un'operazione di set di dati.

DatasetsPendingUploadOptionalParams

Parametri facoltativi.

DeleteAgentResponse

Un oggetto agente eliminato

DeleteAgentVersionResponse

Un oggetto versione dell'agente eliminato

DeleteMemoryResponse

Risposta per la cancellazione di un elemento di memoria da un archivio di memoria.

DeleteMemoryStoreResponse

interfaccia del modello DeleteMemoryStoreResponse

DeleteSkillResponse

Un'abilità cancellata.

DeleteSkillVersionResponse

Una versione eliminata con abilità.

Deployment

Definizione della distribuzione del modello

DeploymentsGetOptionalParams

Parametri facoltativi.

DeploymentsListOptionalParams

Parametri facoltativi.

DeploymentsOperations

Interfaccia che rappresenta le operazioni di distribuzione.

Dimension

Una singola dimensione — una dimensione di qualità indipendente e misurabile all'interno del piano di valutazione di un valutatore di rubrica.

DispatchRoutineResponse

Gli identificatori sono stati restituiti dopo che una spedizione di routine è stata messa in coda.

EmbeddingConfiguration

Incorporamento della classe di configurazione

EmptyModelParam

interfaccia modello EmptyModelParam

EndpointBasedEvaluatorDefinition

Definizione di valutatore basata sull'endpoint. Il cliente possiede e ospita un endpoint HTTP che implementa il contratto di valutazione. Il valutatore fa riferimento a una Project Connection per nome; la connessione memorizza l'URL e le credenziali dell'endpoint (API Key o Entra ID). Al momento dell'esecuzione, il servizio risolve la connessione per ottenere l'URL dell'endpoint e i dettagli dell'autenticazione, quindi chiama l'endpoint per ogni riga di valutazione.

EntraAuthorizationScheme

interfaccia modello EntraAuthorizationScheme

EntraIDCredentials

Entra ID definizione di credenziali

ErrorModel

interfaccia modello ErrorModel

EvalResult

Risultato della valutazione.

EvalRunResultCompareItem

Confronto metrico per un trattamento rispetto al basale.

EvalRunResultComparison

I risultati del confronto per il trattamento vengono eseguiti rispetto al basale.

EvalRunResultSummary

Statistiche di riepilogo di una metrica in un'esecuzione di valutazione.

EvaluationComparisonInsightRequest

Richiesta di confronto della valutazione

EvaluationComparisonInsightResult

Approfondimenti dal confronto delle valutazioni.

EvaluationResultSample

Un campione del risultato della valutazione.

EvaluationRule

Modello di regole di valutazione.

EvaluationRuleAction

Modello di azione di valutazione.

EvaluationRuleFilter

Modello di filtro di valutazione.

EvaluationRulesCreateOrUpdateOptionalParams

Parametri facoltativi.

EvaluationRulesDeleteOptionalParams

Parametri facoltativi.

EvaluationRulesGetOptionalParams

Parametri facoltativi.

EvaluationRulesListOptionalParams

Parametri facoltativi.

EvaluationRulesOperations

Interfaccia che rappresenta un'operazione EvaluationRules.

EvaluationRunClusterInsightRequest

Approfondimenti sull'insieme dei risultati della valutazione

EvaluationRunClusterInsightResult

Le informazioni dettagliate della valutazione eseguono l'analisi dei cluster.

EvaluationScheduleTask

Attività di valutazione per la pianificazione.

EvaluationTarget

Classe base per bersagli con supporto per discriminatore.

EvaluationTaxonomy

Definizione della tassonomia di valutazione

EvaluationTaxonomyInput

Configurazione di input per la tassonomia di valutazione.

EvaluatorCredentialRequest

Organismo di richiesta per ottenere le credenziali del valutatore

EvaluatorDefinition

Configurazione dell'analizzatore di base con discriminatore

EvaluatorGenerationArtifacts

Artefatti di provenienza gestiti dal servizio prodotti da un lavoro di generazione di valutatore. Presente solo sulle risorse EvaluatorVersion create tramite la pipeline di generazione. Il dataset combinato JSONL Foundry è di sola lettura e si risolve in un dataset versionato in uno spazio di nomi riservato ai servizi.

EvaluatorGenerationInputs

Input forniti dal chiamante per un lavoro di generazione di valutatore.

EvaluatorGenerationJob

Risorsa di Generazione Job per Valutatori — un lavoro di lunga durata che genera definizioni di valutatori basate su rubriche a partire dai materiali di origine. Al successo, il risultato è la persistente EvaluatorVersion.

EvaluatorGenerationJobSource

Il modello base per la generazione di lavori da valutatore. Polimorfo su type.

EvaluatorGenerationTokenUsage

Sommario del consumo dei token per un lavoro di generazione di valutatori. Viene popolata quando il lavoro raggiunge uno stato terminale.

EvaluatorMetric

Metrica del valutatore

EvaluatorVersion

Definizione del valutatore

ExternalAgentDefinition

La definizione dell'agente esterno. Rappresenta un agente di terze parti ospitato fuori da Foundry (ad esempio, su GCP o AWS). La registrazione è solo a base di metadati: Foundry registra la definizione dell'agente per illuminare le esperienze di osservabilità (tracce, valutazioni) sui dati OpenTelemetry emessi dal cliente.

FabricDataAgentToolParameters

Parametri dello strumento agente dati fabric.

FabricIQPreviewTool

Uno strumento FabricIQ lato server.

FabricIQPreviewToolboxTool

Uno strumento FabricIQ conservato in una cassetta degli attrezzi.

FieldMapping

Classe di configurazione del mapping dei campi

FileDataGenerationJobOutput

Output file Azure OpenAI per un lavoro di generazione dati.

FileDataGenerationJobSource

Sorgente file per lavori di generazione dati — input file Azure OpenAI.

FileDatasetVersion

Definizione di FileDatasetVersion

FileSearchTool

Strumento che cerca il contenuto pertinente dai file caricati. Scopri di più sullo strumento di ricerca dei file.

FileSearchToolboxTool

Uno strumento di ricerca file archiviato in una cassetta degli attrezzi.

FixedRatioVersionSelectionRule

interfaccia modello Regola FissoRapportoVersioneSelezione

FolderDatasetVersion

Definizione di FileDatasetVersion

FoundryModelWarning

Un avviso associato a un modello.

FunctionShellToolParam

Uno strumento che permette al modello di eseguire comandi shell.

FunctionShellToolParamEnvironment

Interfaccia modello FunzioneShellToolParamAmbiente

FunctionShellToolParamEnvironmentContainerReferenceParam

Funzione interfaccia modelloShellToolParamAmbienteContainerReferenceParam

FunctionShellToolParamEnvironmentLocalEnvironmentParam

Funzione interfaccia modelloShellToolParamAmbienteLocaleAmbienteParam

FunctionTool

Definisce una funzione nel tuo codice che il modello può chiamare. Altre informazioni sulla chiamata alle funzioni.

FunctionToolParam

interfaccia modello FunctionToolParam

GenAITracingOptions

Opzioni per configurare il tracciamento GenAI su una specifica istanza AIProjectClient.

Passa questi dati sotto la tracingOptions chiave AIProjectClientOptionalParams per abilitare il tracciamento GenAI quando il client viene istanziato. Ogni istanza client mantiene una propria configurazione di tracciamento indipendente.

GenerateVoiceAgentRequest

Gli input per generare un agente vocale. Solo kind e name sono sempre necessari. Il servizio di authoring espande questi input in un completo e modificabile VoiceAgentDefinition, che viene poi creato tramite POST /agents. Le impostazioni generate instructions e audio/voce sono memorizzate come campi separati nella definizione risultante dell'agente, così il chiamante può modificarle o sovrascrivere una qualsiasi di esse successivamente tramite il versioning standard dell'agente.

GetMicrosoft365PackageOptionalParams

Parametri facoltativi.

GetMicrosoft365PublishDefaultsOptionalParams

Parametri facoltativi.

GitHubCopilotHarness

(Anteprima) Il sistema gestito da GitHub Copilot per gli agenti prompt.

GitHubCopilotToolsetConfig

Un override di abilitazione per uno strumento integrato di GitHub Copilot.

GitHubCopilotToolsetDefaultConfig

L'impostazione predefinita di abilitazione per gli strumenti integrati di GitHub Copilot.

GitHubCopilotToolsetPreview

(Anteprima) Override di configurazione per gli strumenti integrati di GitHub Copilot.

GitHubIssueRoutineTrigger

Un trigger di routine di problema su GitHub.

HeaderTelemetryEndpointAuth

Autenticazione segreta basata su header per un endpoint di telemetria. Il valore segreto risolto viene iniettato come intestazione HTTP.

HostedAgentDefinition

Definizione dell'agente ospitato.

HourlyRecurrenceSchedule

Pianificazione di ricorrenza oraria.

HumanEvaluationPreviewRuleAction

Azione della regola di valutazione per la valutazione umana.

HybridSearchOptions

interfaccia modello HybridSearchOptions

ImageGenTool

Uno strumento che genera immagini utilizzando i modelli immagine GPT.

ImageGenToolInputImageMask

interfaccia modello ImageGenToolInputImageImage Mask

IndexesCreateOrUpdateOptionalParams

Parametri facoltativi.

IndexesDeleteOptionalParams

Parametri facoltativi.

IndexesGetOptionalParams

Parametri facoltativi.

IndexesListOptionalParams

Parametri facoltativi.

IndexesListVersionsOptionalParams

Parametri facoltativi.

IndexesOperations

Interfaccia che rappresenta un'operazione sugli indici.

InlineSkillParam

interfaccia modello InlineSkillParam

InlineSkillSourceParam

Carico utile per abilità in linea

Insight

Corpo della risposta per le informazioni dettagliate del cluster.

InsightCluster

Un cluster di campioni di analisi.

InsightGenerationRequest

L'organismo di richiesta per generare un insight.

InsightModelConfiguration

Configurazione del modello utilizzato nella generazione dell'insight.

InsightRequest

La richiesta del report di approfondimento.

InsightResult

Il risultato degli approfondimenti.

InsightSample

Un campione dell'analisi.

InsightScheduleTask

Attività di approfondimento per la pianificazione.

InsightSummary

Riepilogo dell'analisi dei cluster di errori.

InsightsMetadata

Metadati relativi alle informazioni dettagliate.

InvocationsProtocolConfiguration

Configurazione specifica del protocollo di invocazione.

InvocationsWsProtocolConfiguration

Configurazione specifica per il protocollo di invocazioni basato su WebSocket.

InvokeAgentInvocationsApiDispatchPayload

Un payload manuale usato per testare la dispatch di routine di un'API di invocazioni.

InvokeAgentInvocationsApiRoutineAction

Invia una routine tramite l'API delle invocazioni grezze. Esattamente uno dei agent_name o agent_endpoint_id deve essere fornito.

InvokeAgentResponsesApiDispatchPayload

Un payload manuale usato per testare una dispatch di routine API di risposte.

InvokeAgentResponsesApiRoutineAction

Invia una routine tramite l'API di risposte. Esattamente uno dei agent_name o agent_endpoint_id deve essere fornito.

JobOperationState

Stato operativo per un'operazione di lunga durata che crea una risorsa di lavoro.

PERSONALIZZAZIONE: MIGLIORAMENTO SDK: i poller emessi si risolvono al payload terminale result del lavoro, che non porta identificatore; jobId mantiene il lavoro creato raggiungibile.

LocalShellToolParam

Strumento che consente al modello di eseguire comandi della shell in un ambiente locale.

LocalSkillParam

interfaccia modello LocalSkillParam

LogProbProperties

Un oggetto logaritmicum.

LoraConfig

Metadati specifici per adattatori per i modelli LoRA. Serve la configurazione del motore al momento del deployment.

MCPListToolsTool

Strumento disponibile in un server MCP.

MCPListToolsToolAnnotations

Interfaccia modello MCPListToolsToolAnnotations

MCPListToolsToolInputSchema

interfaccia modello MCPListToolsToolInputSchema

MCPTool

Concedere al modello l'accesso a strumenti aggiuntivi tramite server MCP (Model Context Protocol) remoti. Scopri di più su MCP.

MCPToolFilter

Un oggetto filtro per specificare quali strumenti sono consentiti.

MCPToolRequireApproval

interfaccia modello MCPToolRequireApproval

MCPToolboxTool

Uno strumento MCP conservato in una cassetta degli attrezzi.

ManagedAgentIdentityBlueprintReference

interfaccia modello ManagedAgentIdentityBlueprintReference

ManagedAzureAISearchIndex

Definizione di indice Azure AI Search gestita

McpProtocolConfiguration

Configurazione specifica per il protocollo MCP.

MemoryItem

Un singolo elemento di memoria memorizzato nell'archivio di memoria, contenente contenuto e metadati.

MemoryOperation

Rappresenta una singola operazione di memoria (creazione, aggiornamento o eliminazione) eseguita su un elemento di memoria.

MemorySearchItem

Elemento di memoria recuperato dalla ricerca in memoria.

MemorySearchOptions

Opzioni di ricerca in memoria.

MemorySearchPreviewTool

Uno strumento per integrare i ricordi nell'agente.

MemoryStore

Un archivio di memoria in grado di memorizzare e recuperare le memorie degli utenti.

MemoryStoreDefaultDefinition

Implementazione dell'archivio di memoria predefinito.

MemoryStoreDefaultOptions

Configurazioni predefinite dell'archivio di memoria.

MemoryStoreDefinition

Definizione di base per le configurazioni dell'archivio di memoria.

MemoryStoreDeleteScopeResponse

Risposta per l'eliminazione di ricordi da un oscilloscopio.

MemoryStoreOperationUsage

Statistiche di utilizzo di un'operazione di archiviazione della memoria.

MemoryStoreSearchResponse

Risposta di ricerca in memoria.

MemoryStoreUpdateCompletedResult

Risultato dell'aggiornamento della memoria.

MemoryStoreUpdateResponse

Fornisce lo stato di un'operazione di aggiornamento dell'archivio di memoria.

Metadata

Set di 16 coppie chiave-valore che possono essere collegate a un oggetto. Ciò può essere utile per archiviare informazioni aggiuntive sull'oggetto in un formato strutturato ed eseguire query sugli oggetti tramite API o il dashboard. Le chiavi sono stringhe con una lunghezza massima di 64 caratteri. I valori sono stringhe con una lunghezza massima di 512 caratteri.

Microsoft365PermissionScopes

Un insieme di ambiti di permessi delegati richiesti a un'unica applicazione di risorsa.

Microsoft365PublishDefaults

Valori predefiniti e precedentemente pubblicati usati per precompilare una richiesta di pubblicazione Microsoft 365 per un agente Foundry.

Microsoft365PublishResponse

Risposta dalla pubblicazione di un agente su Microsoft 365 / Microsoft Teams.

MicrosoftFabricPreviewTool

Le informazioni di definizione di input per uno strumento Microsoft Fabric come utilizzate per configurare un agente.

MisalignmentErrorDetailsResource

I dettagli di un'azione sono bloccati perché potrebbero non essere in linea con l'intento dell'utente.

MisalignmentSteer

Un'istruzione pubblica per continuare dopo un'azione è bloccata.

ModelCredentialRequest

Richiedi di ottenere le credenziali di un asset modello.

ModelDeployment

Definizione della distribuzione del modello

ModelDeploymentSku

Informazioni sullo SKU

ModelPendingUploadRequest

Rappresenta una richiesta di caricamento in attesa di una versione del modello.

ModelPendingUploadResponse

Rappresenta la risposta per una richiesta di upload in attesa di modello.

ModelSamplingParams

Rappresenta un set di parametri utilizzati per controllare il comportamento di campionamento di un modello linguistico durante la generazione di testo.

ModelSourceData

Informazioni di sorgente per il modello

ModelVersion

Definizione della versione del modello

MonthlyRecurrenceSchedule

Pianificazione della ricorrenza mensile.

NamespaceToolParam

Raggruppa la funzione/strumenti personalizzati sotto uno spazio di nomi condiviso.

NoAuthenticationCredentials

Credenziali che non richiedono l'autenticazione

OneTimeTrigger

Attivazione una tantum.

OpenAIClientOptionsWithAzureAgent

Opzioni client OpenAI estese per includere la configurazione degli endpoint Azure Agent.

OpenApiAnonymousAuthDetails

Dettagli di sicurezza per l'autenticazione anonima OpenApi

OpenApiAuthDetails

dettagli di autenticazione per OpenApiFunctionDefinition

OpenApiFunctionDefinition

Informazioni sulla definizione di input per una funzione openapi.

OpenApiManagedAuthDetails

Dettagli di sicurezza per l'autenticazione managed_identity OpenApi

OpenApiManagedSecurityScheme

Schema di sicurezza per l'autenticazione managed_identity OpenApi

OpenApiProjectConnectionAuthDetails

Dettagli di sicurezza per l'autenticazione della connessione project OpenApi

OpenApiProjectConnectionSecurityScheme

Schema di sicurezza per l'autenticazione managed_identity OpenApi

OpenApiTool

Informazioni sulla definizione di input per uno strumento OpenAPI usato per configurare un agente.

OpenApiToolboxTool

Uno strumento OpenAPI memorizzato in una cassetta degli attrezzi.

OptimizedAgentIdentifier

Identifica l'agente Foundry registrato da ottimizzare (solo richiesta). Competenze, strumenti e system_prompt sono specificati in options.optimization_config.

OtlpTelemetryEndpoint

Un endpoint di esportazione di telemetria OTLP (OpenTelemetry Protocol).

PageSettings

Interfaccia che tiene traccia delle impostazioni per l'iterazione di paging

PagedAsyncIterableIterator

Interfaccia che consente l'iterazione iterabile asincrona sia al completamento che alla pagina.

PendingUploadRequest

Rappresenta una richiesta di caricamento in sospeso.

PendingUploadResponse

Rappresenta la risposta per una richiesta di caricamento in sospeso

PickPropertiesVoiceAgentAudioConfig

Il modello per scegliere le proprietà.

ProceduralMemoryItem

Un elemento di memoria contenente una procedura estratta dalle conversazioni.

ProgrammaticToolCallingParam

interfaccia modello ProgrammaticToolCallingParam

PromotionInfo

Metadati promozionali registrati quando un candidato viene distribuito a un agente Foundry.

PromptAgentDefinition

Definizione dell'agente di richiesta

PromptAgentDefinitionTextOptions

Opzioni di configurazione per una risposta di testo dal modello. Può essere un testo normale o dati JSON strutturati.

PromptBasedEvaluatorDefinition

Analizzatore basato su prompt

PromptDataGenerationJobSource

Sorgente prompt per lavori di generazione dati — testo in linea fornito dall'utente.

PromptEvaluatorGenerationJobSource

Sorgente di prompt per lavori di generazione di valutatori — testo inline fornito dall'utente.

ProtocolConfiguration

Configurazione per protocollo per l'endpoint agente.

ProtocolVersionRecord

Mapping di record per un singolo protocollo e la relativa versione.

PstnTelephonyTransferDestination

Una destinazione PSTN per un target di trasferimento telefonico.

PublishToMicrosoft365OptionalParams

Parametri facoltativi.

RaiConfig

Configurazione per il filtraggio dei contenuti e le funzioni di sicurezza RAI (Responsible AI).

RaiInvocationModeration

Dichiara dove si trova il testo di richiesta/risposta così che le barriere di sicurezza dei contenuti possano estrarlo.

RaiSseTextSelector

Un tipo di evento SSE in selettore di campo di testo per l'output di invocazioni in streaming.

RankingOptions

interfaccia modello Opzioni di classificazione

RealtimeAudioFormats

interfaccia modello RealtimeAudioFormats

RealtimeAudioFormatsAudioPcm

interfaccia modello RealtimeAudioFormatiAudioPcm

RealtimeAudioFormatsAudioPcma

interfaccia modello RealtimeAudioFormatsAudioPcma

RealtimeAudioFormatsAudioPcmu

interfaccia modello RealtimeAudioFormatsAudioPcmu

RealtimeClientEvent

Un evento cliente in tempo reale.

RealtimeClientEventConversationItemCreate

Aggiungi un nuovo elemento al contesto della Conversazione, inclusi messaggi, chiamate di funzione e risposte alle chiamate di funzione. Questo evento può essere usato sia per popolare una "cronologia" della conversazione sia per aggiungere nuovi elementi a metà scena, ma ha la limitazione attuale che non può popolare i messaggi audio dell'assistente. Se ha successo, il server risponderà con un conversation.item.created evento, altrimenti un error evento verrà inviato.

RealtimeClientEventConversationItemDelete

Invia questo evento quando vuoi rimuovere qualsiasi elemento dalla cronologia delle conversazioni. Il server risponderà con un conversation.item.deleted evento, a meno che l'elemento non sia presente nella cronologia delle conversazioni, nel qual caso il server risponderà con un errore.

RealtimeClientEventConversationItemRetrieve

Invia questo evento quando vuoi recuperare la rappresentazione del server di un elemento specifico nella cronologia delle conversazioni. Questo è utile, ad esempio, per ispezionare l'audio dell'utente dopo la cancellazione del rumore e il VAD. Il server risponderà con un conversation.item.retrieved evento, a meno che l'elemento non sia presente nella cronologia delle conversazioni, nel qual caso il server risponderà con un errore.

RealtimeClientEventConversationItemTruncate

Invia questo evento per troncare l'audio di un precedente messaggio dell'assistente. Il server produce audio più velocemente del tempo reale, quindi questo evento è utile quando l'utente interrompe per troncare audio già inviato al client ma non ancora riprodotto. Questo sincronizzerà la comprensione dell'audio da parte del server con la riproduzione del client. Troncare l'audio eliminerà la trascrizione del testo lato server per assicurarsi che non ci sia testo nel contesto che non sia stato percepito dall'utente. Se ha successo, il server risponderà con un conversation.item.truncated evento.

RealtimeClientEventInputAudioBufferAppend

Invia questo evento per aggiungere byte audio al buffer audio di ingresso. Il buffer audio è una memoria temporanea in cui è possibile scrivere e successivamente effettuare il commit. Un "commit" creerà un nuovo elemento di messaggio utente nella cronologia delle conversazioni dal contenuto del buffer e cancellerà il buffer. La trascrizione audio in input (se abilitata) verrà generata quando il buffer viene commesso. Se il VAD è abilitato, il buffer audio viene utilizzato per rilevare il parlato e il server deciderà quando effettuare il commit. Quando il server VAD è disabilitato, devi effettuare manualmente il commit del buffer audio. La riduzione del rumore dell'audio in ingresso agisce sulle operazioni di scrittura nel buffer audio. Il client può scegliere quanta quantità di audio inserire in ogni evento fino a un massimo di 15 MiB; ad esempio, trasmettere blocchi più piccoli dal client può permettere al VAD di essere più reattivo. A differenza della maggior parte degli altri eventi client, il server non invierà una risposta di conferma a questo evento.

RealtimeClientEventInputAudioBufferClear

Invia questo evento per cancellare i byte audio nel buffer. Il server risponderà con un input_audio_buffer.cleared evento.

RealtimeClientEventInputAudioBufferCommit

Invia questo evento per fare commit al buffer audio input dell'utente, che creerà un nuovo elemento del messaggio utente nella conversazione. Questo evento produrrà un errore se il buffer audio di ingresso è vuoto. Quando è in modalità Server VAD, il client non deve inviare questo evento, il server effettuerà automaticamente il commit del buffer audio. Effettuare il commit del buffer audio di input attiverà la trascrizione audio in input (se abilitata nella configurazione della sessione), ma non creerà una risposta dal modello. Il server risponderà con un input_audio_buffer.committed evento.

RealtimeClientEventOutputAudioBufferClear

Solo WebRTC/SIP: Emetti per interrompere la risposta audio corrente. Questo farà sì che il server smetta di generare audio ed emetta un output_audio_buffer.cleared evento. Questo evento deve essere preceduto da un response.cancel evento client per arrestare la generazione della risposta corrente. Scopri di più.

RealtimeClientEventResponseCancel

Invia questo evento per annullare una risposta in corso. Il server risponderà con un response.done evento con stato response.status=cancelled. Se non c'è risposta per cancellare, il server risponderà con un errore. È sicuro chiamare response.cancel , anche se non c'è risposta in corso, un errore verrà restituito e la sessione rimarrà intatta.

RealtimeClientEventResponseCreate

Questo evento istruisce il server a creare una Risposta, il che significa attivare l'inferenza del modello. Quando si è in modalità Server VAD, il server crea automaticamente le Risposte. Una Risposta includerà almeno un Item, e può averne due, nel qual caso il secondo sarà una chiamata di funzione. Questi Elementi saranno aggiunti alla cronologia delle conversazioni di default. Il server risponderà con un response.created evento, eventi per Oggetti e contenuti creati, e infine un response.done evento per indicare che la Risposta è completata. L'evento response.create include la configurazione di inferenza come instructions e tools. Se questi sono impostati, sovrascriveranno la configurazione della Sessione solo per questa Risposta. Le risposte possono essere create fuori banda rispetto alla Conversazione predefinita, il che significa che possono avere input arbitrari, ed è possibile disabilitare la scrittura dell'output nella Conversazione. Solo una Risposta può scrivere alla volta nella Conversazione predefinita, ma altrimenti possono essere create più Risposte in parallelo. Il metadata campo è un buon modo per disambiguare più Risposte simultanee. I client possono impostare conversation la none creazione di una Risposta che non scriva nella Conversazione predefinita. Input arbitrario può essere fornito con il input campo, che è un array che accetta Elementi grezzi e riferimenti a Elementi esistenti.

RealtimeConversationItem

Un singolo elemento all'interno di una conversazione in tempo reale.

RealtimeConversationItemFunctionCall

Un elemento di chiamata di funzione in una conversazione in tempo reale.

RealtimeConversationItemFunctionCallOutput

Un elemento di output di una chiamata di funzione in una conversazione in tempo reale.

RealtimeConversationItemMessage

interfaccia modello: RealtimeConversationItemMessage

RealtimeConversationItemMessageAssistant

Un messaggio di assistente in una conversazione in tempo reale.

RealtimeConversationItemMessageAssistantContent

Interfaccia modello Tempo realeConversazioneItemMessaggioAssistente Contenuto

RealtimeConversationItemMessageSystem

Un messaggio di sistema in una conversazione in tempo reale può essere utilizzato per fornire contesto aggiuntivo o istruzioni al modello. Questo è simile ma distinto dal prompt di istruzioni fornito all'inizio di una conversazione, poiché i messaggi di sistema possono essere aggiunti in qualsiasi momento della conversazione. Per cambiamenti importanti nel comportamento della conversazione, usa le istruzioni, ma per aggiornamenti minori (ad esempio "l'utente ora chiede di un altro argomento"), usa i messaggi di sistema.

RealtimeConversationItemMessageSystemContent

Interfaccia modello Tempo realeConversazioneItemMessaggioSystemContenuto

RealtimeConversationItemMessageUser

Un elemento di messaggio utente in una conversazione in tempo reale.

RealtimeConversationItemMessageUserContent

interfaccia modello Tempo realeConversazioneMessaggioUserContent

RealtimeFunctionTool

Interfaccia modello RealtimeFunctionTool

RealtimeMCPApprovalRequest

Un oggetto in tempo reale che richiede l'approvazione umana di un'invocazione di uno strumento.

RealtimeMCPApprovalResponse

Un elemento Realtime che risponde a una richiesta di approvazione MCP.

RealtimeMCPError

interfaccia modello RealtimeMCPError

RealtimeMCPHttpError

interfaccia modello RealtimeMCPHttpError

RealtimeMCPListTools

Un Realtime per strumenti di elenco degli oggetti disponibili su un server MCP.

RealtimeMCPProtocolError

interfaccia modello RealtimeMCPProtocolError

RealtimeMCPToolCall

Un elemento in tempo reale che rappresenta l'invocazione di uno strumento su un server MCP.

RealtimeMCPToolExecutionError

interfaccia modello RealtimeMCPToolExecutionError

RealtimeReasoning

Configurazione per modelli Realtime con capacità di ragionamento come gpt-realtime-2.

RealtimeResponseStatusDetails

interfaccia modello RealtimeResponseStatusDetails

RealtimeResponseStatusDetailsError

interfaccia modello Tempo realeRispostaStatoDettagliErrore

RealtimeResponseUsage

interfaccia modello RealtimeResponseUsage

RealtimeResponseUsageInputTokenDetails

Interfaccia modello Tempo realeRispostaUsoInputTokenDettagli

RealtimeResponseUsageInputTokenDetailsCachedTokensDetails

interfaccia modello RealtimeRispostaUsoInputTokenDettagliCachedTokensDettagli

RealtimeResponseUsageOutputTokenDetails

interfaccia modello RealtimeRispostaUsoOutputTokenDettagli

RealtimeServerEvent

Un evento server in tempo reale.

RealtimeServerEventConversationItemAdded

Inviato dal server quando un Elemento viene aggiunto alla Conversazione predefinita. Questo può accadere in diversi casi:

  • Quando il cliente invia un conversation.item.create evento.
  • Quando il buffer audio di ingresso viene commesso. In questo caso l'elemento sarà un messaggio utente contenente l'audio del buffer.
  • Quando il modello genera una Risposta. In questo caso l'evento conversation.item.added verrà inviato quando il modello inizierà a generare un Item specifico, e quindi non avrà ancora alcun contenuto (e status sarà in_progress). L'evento includerà il contenuto completo dell'Item (tranne quando il modello genera una Risposta), ad eccezione dei dati audio, che possono essere recuperati separatamente con un conversation.item.retrieve evento se necessario.
RealtimeServerEventConversationItemCreated

Restituito quando viene creato un elemento di conversazione. Esistono diversi scenari che producono questo evento:

  • Il server genera una Risposta che, se riuscita, produrrà uno o due Elementi, che saranno di tipo message (ruolo assistant) o function_calldi tipo .
  • Il buffer audio di ingresso è stato confermato, sia dal client che dal server (in server_vad modalità). Il server prenderà il contenuto del buffer audio di input e lo aggiungerà a un nuovo messaggio utente Item.
  • Il client ha inviato un conversation.item.create evento per aggiungere un nuovo elemento alla conversazione.
RealtimeServerEventConversationItemDeleted

Restituito quando un elemento nella conversazione viene eliminato dal cliente con un conversation.item.delete evento. Questo evento viene usato per sincronizzare la comprensione della cronologia delle conversazioni del server con la visualizzazione del client.

RealtimeServerEventConversationItemDone

Restituito quando un punto di conversazione è finalizzato. L'evento includerà il contenuto completo dell'Item ad eccezione dei dati audio, che potranno essere recuperati separatamente con un conversation.item.retrieve evento se necessario.

RealtimeServerEventConversationItemInputAudioTranscriptionCompleted

Questo evento è l'output della trascrizione audio per l'audio utente scritto nel buffer audio utente. La trascrizione inizia quando viene eseguito il commit del buffer audio di input dal client o dal server (quando VAD è abilitato). La trascrizione viene eseguita in modo asincrono con la creazione della Risposta, quindi questo evento può avvenire prima o dopo gli eventi della Risposta. I modelli API in tempo reale accettano l'audio nativamente, e quindi la trascrizione degli input è un processo separato eseguito su un modello ASR (Riconoscimento Vocale Automatico) separato. La trascrizione può divergere un po' dall'interpretazione del modello e dovrebbe essere trattata come una guida approssimativa.

RealtimeServerEventConversationItemInputAudioTranscriptionDelta

Restituito quando il valore testuale di una parte di trascrizione audio in input viene aggiornato con risultati incrementali della trascrizione.

RealtimeServerEventConversationItemInputAudioTranscriptionFailed

Viene restituito quando la trascrizione audio in input è configurata e una richiesta di trascrizione per un messaggio utente è fallita. Questi eventi sono separati dagli altri error eventi in modo che il cliente possa identificare l'Item correlato.

RealtimeServerEventConversationItemInputAudioTranscriptionFailedError

Interfaccia modello RealtimeServerEventoConversazioneItemInputAudioTranscriptionFailedErrore

RealtimeServerEventConversationItemInputAudioTranscriptionSegment

Restituito quando viene identificato un segmento di trascrizione audio in input per un elemento.

RealtimeServerEventConversationItemRetrieved

Restituito quando un elemento di conversazione viene recuperato con conversation.item.retrieve. Questo viene fornito come modo per recuperare la rappresentazione del server di un elemento, ad esempio per accedere ai dati audio post-elaborati dopo la cancellazione del rumore e il VAD. Include il contenuto completo dell'Item, inclusi i dati audio.

RealtimeServerEventConversationItemTruncated

Restituito quando un precedente messaggio audio dell'assistente viene troncato dal cliente con un conversation.item.truncate evento. Questo evento viene utilizzato per sincronizzare la comprensione audio del server con la riproduzione del client. Questa azione troncherà l'audio e rimuoverà la trascrizione del testo lato server per assicurarsi che non ci sia testo nel contesto che non sia stato ascoltato dall'utente.

RealtimeServerEventError

Restituito quando si verifica un errore, che può essere un problema del client o del server. La maggior parte degli errori è recuperabile e la sessione rimarrà aperta; raccomandiamo agli implementatori di monitorare e registrare i messaggi di errore di default.

RealtimeServerEventErrorError

interfaccia modello RealtimeServerEventErrorError

RealtimeServerEventInputAudioBufferCleared

Restituito quando il buffer audio di ingresso viene cancellato dal client con un input_audio_buffer.clear evento.

RealtimeServerEventInputAudioBufferCommitted

Restituito quando viene commesso un buffer audio di input, sia dal client che automaticamente in modalità server VAD. La item_id proprietà è l'ID dell'elemento del messaggio utente che verrà creato, quindi conversation.item.created un evento verrà inviato anche al client.

RealtimeServerEventInputAudioBufferSpeechStarted

Inviato dal server quando è in server_vad modalità per indicare che il parlato è stato rilevato nel buffer audio. Questo può accadere ogni volta che l'audio viene aggiunto al buffer (a meno che il parlato non sia già rilevato). Il client potrebbe voler utilizzare questo evento per interrompere la riproduzione audio o fornire un feedback visivo all'utente. Il cliente dovrebbe aspettarsi di ricevere un input_audio_buffer.speech_stopped evento quando il discorso si interrompe. La item_id proprietà è l'ID dell'elemento del messaggio utente che verrà creato quando il parlato si interrompe e sarà anch'esso incluso nell'evento input_audio_buffer.speech_stopped (a meno che il client non effettui manualmente il commit del buffer audio durante l'attivazione del VAD).

RealtimeServerEventInputAudioBufferSpeechStopped

Ritorna in server_vad modalità quando il server rileva la fine del parlato nel buffer audio. Il server invierà anche un conversation.item.created evento con l'elemento messaggio utente creato dal buffer audio.

RealtimeServerEventInputAudioBufferTimeoutTriggered

Restituito quando viene attivato il timeout del VAD del server per il buffer audio di ingresso. Questo è configurato idle_timeout_ms nelle turn_detection impostazioni della sessione, e indica che non è stato rilevato alcun intervento vocale per la durata configurata. I campi audio_start_ms e audio_end_ms indicano il segmento di audio dopo l'ultima risposta del modello fino al tempo di attivazione, come offset dall'inizio dell'audio scritto nel buffer di ingresso audio. Questo significa che delimita il segmento audio che era silenzioso e la differenza tra i valori di inizio e fine corrisponderà approssimativamente al timeout configurato. L'audio vuoto verrà confermato alla conversazione come input_audio elemento (ci sarà un input_audio_buffer.committed evento) e verrà generata una risposta modello. Potrebbe esserci un discorso che non ha attivato il VAD ma viene comunque rilevato dal modello, quindi il modello potrebbe rispondere con qualcosa di rilevante per la conversazione o con un prompt per continuare a parlare.

RealtimeServerEventMCPListToolsCompleted

Restituito quando l'elenco degli strumenti MCP è stato completato per un articolo.

RealtimeServerEventMCPListToolsFailed

Restituito quando si hanno messo in vendita gli strumenti MCP per un articolo.

RealtimeServerEventMCPListToolsInProgress

Restituito quando l'elenco degli strumenti MCP è in corso per un elemento.

RealtimeServerEventOutputAudioBufferCleared

Solo WebRTC/SIP: Emessa quando il buffer audio di uscita viene cancellato. Ciò si verifica in modalità VAD quando l'utente ha interrotto (input_audio_buffer.speech_started) o quando il client ha emesso l'evento output_audio_buffer.clear per tagliare manualmente la risposta audio corrente. Scopri di più.

RealtimeServerEventRateLimitsUpdated

Emesso all'inizio di una Risposta per indicare i limiti di velocità aggiornati. Quando viene creata una Risposta, alcuni token vengono "riservati" per i token di output; i limiti di velocità qui mostrati riflettono quella riserva, che viene poi adeguata di conseguenza una volta completata la Risposta.

RealtimeServerEventRateLimitsUpdatedRateLimits

interfaccia modello RealtimeServerEventRateLimitsUpdatedRateLimits

RealtimeServerEventResponseAudioDelta

Restituito quando l'audio generato dal modello viene aggiornato.

RealtimeServerEventResponseAudioDone

Restituito quando l'audio generato dal modello è terminato. Viene inoltre emessa quando una Risposta viene interrotta, incompleta o cancellata.

RealtimeServerEventResponseAudioTranscriptDelta

Restituito quando viene aggiornata la trascrizione generata dal modello dell'uscita audio.

RealtimeServerEventResponseAudioTranscriptDone

Restituito quando la trascrizione generata dal modello dell'uscita audio è terminata in streaming. Viene inoltre emessa quando una Risposta viene interrotta, incompleta o cancellata.

RealtimeServerEventResponseContentPartAdded

Restituito quando una nuova parte di contenuto viene aggiunta a un elemento di messaggio assistente durante la generazione della risposta.

RealtimeServerEventResponseContentPartAddedPart

interfaccia modello RealtimeServerEventResponseContentPartAddedPart

RealtimeServerEventResponseContentPartDone

Viene restituito quando una parte di contenuto viene trasmessa in un elemento di messaggio assistente. Viene inoltre emessa quando una Risposta viene interrotta, incompleta o cancellata.

RealtimeServerEventResponseContentPartDonePart

interfaccia modello: RealtimeServerEventResponseContentPartDonePart

RealtimeServerEventResponseCreated

Restituito quando viene creata una nuova Risposta. Il primo evento di creazione della risposta, dove la risposta si trova in uno stato iniziale di in_progress.

RealtimeServerEventResponseDone

Restituito quando una Risposta ha finito di essere trasmessa. Sempre emisso, indipendentemente dallo stato finale. L'oggetto Risposta incluso nell'evento response.done includerà tutti gli elementi in uscita nella Risposta ma ometterà i dati audio grezzi. I clienti dovrebbero controllare il status campo della Risposta per determinare se è stata positiva (completed) o se c'è stato un altro risultato: cancelled, failed, o incomplete. Una risposta conterrà tutti gli elementi in uscita generati durante la risposta, escludendo qualsiasi contenuto audio.

RealtimeServerEventResponseFunctionCallArgumentsDelta

Restituito quando gli argomenti delle chiamate di funzione generati dal modello vengono aggiornati.

RealtimeServerEventResponseFunctionCallArgumentsDone

Restituito quando gli argomenti delle chiamate di funzione generati dal modello hanno terminato di essere trasmessi. Viene inoltre emessa quando una Risposta viene interrotta, incompleta o cancellata.

RealtimeServerEventResponseMCPCallArgumentsDelta

Restituiti quando gli argomenti delle chiamate dello strumento MCP vengono aggiornati durante la generazione della risposta.

RealtimeServerEventResponseMCPCallArgumentsDone

Restituito quando gli argomenti delle chiamate di strumenti MCP vengono finalizzati durante la generazione della risposta.

RealtimeServerEventResponseMCPCallCompleted

Restituito quando una chiamata con uno strumento MCP è completata con successo.

RealtimeServerEventResponseMCPCallFailed

Restituito quando una chiamata allo strumento MCP è fallita.

RealtimeServerEventResponseMCPCallInProgress

Restituito quando una chiamata con uno strumento MCP è iniziata ed è in corso.

RealtimeServerEventResponseOutputItemAdded

Restituito quando viene creato un nuovo Oggetto durante la generazione della Risposta.

RealtimeServerEventResponseOutputItemDone

Restituito quando un oggetto ha finito di essere trasmesso. Viene inoltre emessa quando una Risposta viene interrotta, incompleta o cancellata.

RealtimeServerEventResponseTextDelta

Restituito quando il valore di testo di una parte di contenuto "output_text" viene aggiornato.

RealtimeServerEventResponseTextDone

Restituito quando il valore di testo di una parte di contenuto "output_text" termina di essere trasmesso. Viene inoltre emessa quando una Risposta viene interrotta, incompleta o cancellata.

RealtimeServerEventSessionCreated

Restituito quando viene creata una Sessione. Emessa automaticamente quando viene stabilita una nuova connessione come primo evento server. Questo evento conterrà la configurazione predefinita della sessione.

RealtimeServerEventSessionUpdated

Viene restituito quando una sessione viene aggiornata con un session.update evento, a meno che non ci sia un errore.

Reasoning

Solo modelli GPT-5 e O-Series Opzioni di configurazione per i modelli di ragionamento.

RecurrenceSchedule

Modello di pianificazione delle ricorrenze.

RecurrenceTrigger

Trigger basato sulla ricorrenza.

RedTeam

Dettagli della squadra rossa.

RedTeamTargetConfig

Classe astratta per la configurazione del target.

ReminderPreviewToolboxTool

Uno strumento promemoria conservato in una cassetta degli attrezzi.

ResponseUsageInputTokensDetails

interfaccia modello RispostaUtilizzoInputTokenDettagli

ResponseUsageOutputTokensDetails

interfaccia modello RispostaUtilizzoTokenOutputDettagli

ResponsesProtocolConfiguration

Configurazione specifica del protocollo di risposte.

Routine

Una definizione di routine restituita dal servizio.

RoutineAction

Modello base per un'azione di routine.

RoutineAuthorization

Configurazione di autorizzazione opzionale per una dispatch di routine.

RoutineDispatchPayload

Modello base per un carico utile di dispatch manuale.

RoutineRun

Una singola esecuzione di routine è tornata dall'API della cronologia delle esecuzioni.

RoutineTrigger

Modello base per un trigger di routine.

RubricBasedEvaluatorDefinition

Definizione del valutatore basata su rubrica — memorizza le dimensioni prodotte dall'API generat. Utilizzato sia per valutatori di qualità che di sicurezza.

RubricGenerationInputQualityWarning

Un avviso non fatale prodotto durante la generazione del valutatore di rubrica quando gli input risolti sono tecnicamente validi ma probabilmente troppo deboli per produrre una rubrica di alta qualità. Sola lettura; generati dal servizio. È continuato con il terminale EvaluatorGenerationJob.

RunOperationState

Stato operativo per un'operazione di lunga durata che crea una risorsa di run.

PERSONALIZZAZIONE: MIGLIORAMENTO SDK: il poller emesso si risolve al payload terminale result della run, che non porta identificatore; runId mantiene la run creata raggiungibile.

SASTokenCredentials

Definizione delle credenziali di firma di accesso condiviso

SasCredential

Definizione delle credenziali di firma di accesso condiviso

Schedule

Modello di pianificazione.

ScheduleRoutineTrigger

Un trigger ricorrente basato su cron.

ScheduleRun

Pianificare il modello di esecuzione.

ScheduleTask

Modello di attività di pianificazione.

SessionConfiguration

I valori predefiniti della sessione si applicano alle sessioni create per una versione dell'agente ospitata.

SessionDirectoryEntry

Una singola voce in un elenco di directory.

SessionDirectoryListResponse

Risposta alla lista di una directory in un sandbox di sessione.

SessionFileWriteResponse

Risposta al caricamento di un file in un sandbox di sessione.

SessionLogEvent

Un singolo Server-Sent frame di evento emesso dal flusso di log della sessione dell'agente ospitato.

Ogni frame contiene un event campo che identifica il tipo di evento e un data campo che contiene il payload come testo semplice. Sebbene il payload attuale data sia formattato in JSON, il suo schema non è contrattuale — possono apparire chiavi aggiuntive e il formato può cambiare nel tempo. I clienti dovrebbero considerare data una stringa opaca e opzionalmente tentare l'analisi parsing JSON.

In futuro potrebbero essere aggiunti nuovi tipi di evento. I clienti dovrebbero ignorare con grazia i tipi di eventi non riconosciuti.

Formato del filo:

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

Parametri dello strumento di messa a terra di SharePoint.

SharepointPreviewTool

Informazioni sulla definizione di input per uno strumento di SharePoint usato per configurare un agente.

ShellToolboxTool

Uno strumento da guscio conservato in una cassetta degli attrezzi. Questo modello è additivo alla configurazione della toolbox e non modifica il contratto degli strumenti OpenAI né le definizioni esistenti dello toolbox.

SimpleQnADataGenerationJobOptions

Le opzioni per un lavoro di generazione dati con il tipo SimpleQnA.

SimulationSeedDataGenerationJobOptions

Le opzioni per un lavoro di generazione dati seed di simulazione. Da usare con scenari di valutazione multiturn e con fonti di prompt, file o agent. Le righe di dataset generate includono campi come id, category, test_case_description, e desired_num_turns.

SipTelephonyTransferDestination

Una destinazione SIP per un target di trasferimento telefonico.

Skill

Una risorsa di abilità.

SkillInlineContent

Contenuti inline per definire una semplice abilità senza caricare file. Segue la specifica agentskills.io SKILL.md.

SkillReference

(Anteprima) Un riferimento a una competenza versionata della Foundry.

SkillReferenceParam

interfaccia modello SkillReferenceParam

SkillVersion

Una versione specifica di un'abilità.

SpecificApplyPatchParam

Forza il modello a chiamare lo strumento apply_patch durante l'esecuzione di una chiamata allo strumento.

SpecificFunctionShellParam

Forza il modello a chiamare lo strumento shell quando è necessaria una chiamata allo strumento.

SpecificProgrammaticToolCallingParam

interfaccia modello SpecificaProgrammaticToolCallingParam

StructuredInputDefinition

Input strutturato che può partecipare alle sostituzioni di modelli di prompt e all'associazione di argomenti dello strumento.

StructuredOutputDefinition

Output strutturato che può essere prodotto dall'agente.

TaskGenerationDataGenerationJobOptions

Opzioni per il lavoro legacy di generazione dei compiti, incluso il numero massimo di campioni generati.

TaxonomyCategory

Definizione della categoria di tassonomia.

TaxonomySubCategory

Definizione della sottocategoria della tassonomia.

TeamsPhoneExtensionTelephonyBinding

Un binding Telefono di Microsoft Teams Extension di proprietà di un agente vocale.

TeamsPhoneExtensionTelephonyBindingListItem

Un binding Telefono di Microsoft Teams Extension è stato restituito in un elenco, incluso il tag entity.

TeamsTelephonyTransferDestination

Una destinazione Microsoft Teams per un target di trasferimento telefonico.

TelemetryConfig

Configurazione di telemetria fornita dal cliente per l'esportazione di log, tracce e metriche dei container.

TelemetryEndpoint

Una configurazione di endpoint per l'esportazione di telemetria.

TelemetryEndpointAuth

Configurazione dell'autenticazione per un endpoint di telemetria.

TelemetryOperations

Interfaccia che rappresenta le operazioni di telemetria

TelephonyBinding

Un vincolo telefonico di proprietà di un operatore vocale.

TelephonyBindingListItem

Un collegamento telefonico restituito in una lista, incluso il tag dell'entità.

TelephonyCallJob

Un'intento di chiamata in uscita diretto o creato dalla campagna duratura.

TelephonyCallJobCancellation

Una richiesta di cancellazione registrata per una chiamata in uscita.

TelephonyCallJobSchedule

La finestra di esecuzione opzionale per una chiamata diretta in uscita.

TelephonyCallLifecycleEvent

Un'osservazione limitata e duratura nel ciclo di vita di una chiamata telefonica.

TelephonyCallRecord

Diagnostica dettagliata per una chiamata in entrata duratura a un agente vocale.

TelephonyCallSummary

Un riassunto di una chiamata in entrata duratura a un operatore vocale.

TelephonyCallTiming

Tempistica dettagliata rispetto al provider neutrale per una chiamata telefonica in entrata.

TelephonyCallTrace

Correlazione da un record di chiamata telefonica duratura alla traccia Foundry rivolta al cliente.

TelephonyOutboundDestination

La destinazione di una chiamata in uscita.

TelephonyOutboundFixedIntervalRetryPolicy

Una politica di ritenti con un intervallo fisso tra i tentativi di chiamata in uscita.

TelephonyOutboundRetryPolicy

La politica di ritentazione per un'intento di chiamata in uscita duratura. max_attempts include il primo tentativo. Le impostazioni specifiche per strategia sono definite dalla politica derivata.

TelephonyTransferDestination

Una destinazione per un obiettivo di trasferimento telefonico.

TelephonyTransferTarget

Una destinazione nominata a cui l'operatore vocale può trasferire una chiamata.

TelephonyTransferTargets

I target di trasferimento telefonico configurati per un unico agente vocale.

TextResponseFormat

Oggetto che specifica il formato che il modello deve restituire. La configurazione { "type": "json_schema" } abilita gli output strutturati, che garantisce che il modello corrisponda allo schema JSON fornito. Per altre informazioni, vedere la Guida agli output strutturati. Il formato predefinito è { "type": "text" } senza opzioni aggiuntive. Non consigliato per gpt-4o e modelli più recenti:* Impostando per { "type": "json_object" } abilitare la vecchia modalità JSON, che garantisce che il messaggio generato dal modello sia JSON valido. L'uso json_schema è preferibile per i modelli che lo supportano.

TextResponseFormatConfiguration

Configurazione base per il formato delle risposte testuali generate.

TextResponseFormatConfigurationResponseFormatJsonObject

Configura le risposte generate per utilizzare il formato oggetto JSON.

TextResponseFormatConfigurationResponseFormatText

Configura le risposte generate per utilizzare il testo semplice.

TextResponseFormatJsonObject

Formato della risposta dell'oggetto JSON. Metodo precedente di generazione di risposte JSON. Si consiglia di utilizzare json_schema per i modelli che lo supportano. Si noti che il modello non genererà JSON senza un messaggio di sistema o utente che lo istruisca a farlo.

TextResponseFormatJsonSchema

Formato di risposta dello schema JSON. Usato per generare risposte JSON strutturate. Scopri di più sugli output strutturati.

TextResponseFormatText

Formato di risposta predefinito. Usato per generare risposte di testo.

TimerRoutineTrigger

Un trigger di routine a timer one-shot.

Tool

Strumento che può essere usato per generare una risposta.

ToolChoiceAllowed

Vincola gli strumenti disponibili al modello a un set predefinito.

ToolChoiceCodeInterpreter

Indica che il modello deve usare uno strumento predefinito per generare una risposta. Scopri di più sugli strumenti integrati.

ToolChoiceComputer

Indica che il modello deve usare uno strumento predefinito per generare una risposta. Scopri di più sugli strumenti integrati.

ToolChoiceComputerUse

Indica che il modello deve usare uno strumento predefinito per generare una risposta. Scopri di più sugli strumenti integrati.

ToolChoiceComputerUsePreview

Indica che il modello deve usare uno strumento predefinito per generare una risposta. Scopri di più sugli strumenti integrati.

ToolChoiceCustom

Usare questa opzione per forzare il modello a chiamare uno strumento personalizzato specifico.

ToolChoiceFileSearch

Indica che il modello deve usare uno strumento predefinito per generare una risposta. Scopri di più sugli strumenti integrati.

ToolChoiceFunction

Usare questa opzione per forzare il modello a chiamare una funzione specifica.

ToolChoiceImageGeneration

Indica che il modello deve usare uno strumento predefinito per generare una risposta. Scopri di più sugli strumenti integrati.

ToolChoiceMCP

Usare questa opzione per forzare il modello a chiamare uno strumento specifico in un server MCP remoto.

ToolChoiceParam

Come il modello deve selezionare quale strumento (o strumenti) usare durante la generazione di una risposta. Vedere il tools parametro per informazioni su come specificare gli strumenti che il modello può chiamare.

ToolChoiceWebSearchPreview

Indica che il modello deve usare uno strumento predefinito per generare una risposta. Scopri di più sugli strumenti integrati.

ToolChoiceWebSearchPreview20250311

Indica che il modello deve usare uno strumento predefinito per generare una risposta. Scopri di più sugli strumenti integrati.

ToolConfig

Configurazione per strumento che controlla la visibilità degli strumenti e il comportamento di ricerca.

ToolDescription

Descrizione di uno strumento che può essere utilizzato da un agente.

ToolProjectConnection

Una risorsa di connessione project.

ToolSearchToolParam

Configurazione di ricerca di strumenti ospitati o BYOT per strumenti differiti.

ToolSearchToolboxTool

Uno strumento di ricerca per cassette degli attrezzi archiviato in una cassetta degli attrezzi.

ToolUseFineTuningDataGenerationJobOptions

Le opzioni per un lavoro di generazione dati con tipo ToolUse. Usato solo per la messa a punto di scenari fini.

ToolboxObject

Una cassetta degli attrezzi che memorizza definizioni di strumenti riutilizzabili per agenti.

ToolboxPolicies

Configurazione delle policy per una cassetta degli attrezzi, inclusa la sicurezza dei contenuti e altre impostazioni di governance.

ToolboxSearchPreviewToolboxTool

Uno strumento di ricerca per cassette degli attrezzi archiviato in una cassetta degli attrezzi.

ToolboxShellContainerAutoEnvironment

Un ambiente container automaticamente provisionato per uno strumento shell archiviato in una cassetta degli attrezzi.

ToolboxShellContainerReferenceEnvironment

Un ambiente container esistente per uno strumento shell conservato in una cassetta degli attrezzi.

ToolboxShellEnvironment

Un ambiente di esecuzione per uno strumento shell memorizzato in una cassetta degli attrezzi. Questo modello di ambiente è orientato alla configurazione della toolbox e non modifica il contratto di ambiente OpenAI shell.

ToolboxShellNetworkPolicy

Politica di accesso alla rete per un container shell toolbox provisionato automaticamente.

ToolboxShellNetworkPolicyDisabled

Una policy di rete che disabilita l'accesso in uscita da un container shell toolbox.

ToolboxSkill

Una fonte di abilità inclusa in una cassetta degli attrezzi.

ToolboxSkillReference

Un riferimento a una competenza esistente da includere in una cassetta degli attrezzi.

ToolboxTool

Una rappresentazione astratta di uno strumento memorizzato in una cassetta degli attrezzi.

ToolboxVersionObject

Una versione specifica di una cassetta degli attrezzi.

ToolboxVersions

Le versioni associate a una cassetta degli attrezzi.

ToolboxesCreateVersionOptionalParams

Parametri facoltativi.

ToolboxesDeleteOptionalParams

Parametri facoltativi.

ToolboxesDeleteVersionOptionalParams

Parametri facoltativi.

ToolboxesGetOptionalParams

Parametri facoltativi.

ToolboxesGetVersionOptionalParams

Parametri facoltativi.

ToolboxesInvokeLatestToolboxMcpOptionalParams

Parametri facoltativi.

ToolboxesListOptionalParams

Parametri facoltativi.

ToolboxesListVersionsOptionalParams

Parametri facoltativi.

ToolboxesOperations

Interfaccia che rappresenta le operazioni di Toolbox.

ToolboxesUpdateOptionalParams

Parametri facoltativi.

TracesDataGenerationJobOptions

Le opzioni per un lavoro di generazione dati con il tipo Traces.

TracesDataGenerationJobSource

Tracce per i lavori di generazione dati — tracce di conversazione da Application Insights.

TracesEvaluatorGenerationJobSource

Traces source per lavori di generazione di valutatori — tracce di conversazione da Application Insights.

TranscriptTextUsageDuration

Statistiche di utilizzo per i modelli fatturate in base alla durata dell'ingresso audio.

TranscriptTextUsageTokens

Statistiche di utilizzo per i modelli fatturati tramite l'uso dei token.

TranscriptTextUsageTokensInputTokenDetails

Interfaccia modello TrascrizioneTestoUtilizzoTokenInputTokenDettagli

TranscriptionLanguage

Una lingua rilevata nell'audio trascritto.

Trigger

Modello base per il Trigger del programma.

TwilioTelephonyBinding

Un binding Twilio di proprietà di un agente vocale.

TwilioTelephonyBindingListItem

Un binding Twilio restituito in un elenco, incluso il suo tag entity.

UpdateModelVersionRequest

Richiedi l'aggiornamento di una versione del modello. Solo la descrizione e i tag possono essere modificati.

UpdateTelephonyBindingRequest

La richiesta di aggiornare un vincolaggio telefonico esistente. Ogni proprietà è opzionale e il fornitore del vincolante è immutabile.

UpdateToolboxRequest

interfaccia modello UpdateToolboxRequest

UserProfileMemoryItem

Un elemento di memoria contenente specificamente le informazioni del profilo utente estratte dalle conversazioni, come preferenze, interessi e dettagli personali.

VersionIndicator

Indicatore di versione che determina quale versione agente fa il backup della sessione.

VersionRefIndicator

Indicatore di versione che fa riferimento a una versione specifica dell'agente per nome.

VersionSelectionRule

interfaccia modello VersionSelectionRule

VersionSelector

Interfaccia modello VersionSelector

VoiceAgentAnimationConfig

Impostazioni di animazione per una sessione di voice-agent.

VoiceAgentAudioConfig

La configurazione audio per un agente vocale. Questi valori sono valori predefiniti della sessione e possono essere sovrascritti durante la connessione.

VoiceAgentAudioInputConfig

Input audio configurazione per un agente vocale.

VoiceAgentAudioOutputConfig

Configurazione audio in uscita per un agente vocale. I campi specifici del fornitore sono selezionati da:voice_type

  • openai: voice e speed.
  • azure-standard: , , , , , custom_lexicon_url, custom_text_normalization_url, prefer_localesstyle, pitch, e volume. voice_temperaturespeedvoice_localevoice
  • azure-custom: tutti azure-standard i campi tranne style, più custom_voice_endpoint_id.
  • azure-personal: tutti azure-standard i campi tranne style, più personal_voice_model.
  • avatar-voice-sync: tutti azure-standard i campi tranne voice e style, più personal_voice_model; il nome della voce deriva dall'avatar.
  • azure-realtime-native: voice e speed. format e output_audio_timestamp_types applica ogni tipo di voce.
VoiceAgentAvatarConfig

Configurazione dell'avatar per un agente vocale. Questi valori sono valori predefiniti della sessione e possono essere sovrascritti durante la connessione.

VoiceAgentAvatarIceServer

Un server ICE usato per la negoziazione di WebRTC con avatar.

VoiceAgentAvatarScene

Posizionamento dell'avatar e impostazioni di movimento.

VoiceAgentAvatarVideoBackground

Lo sfondo del video avatar.

VoiceAgentAvatarVideoCrop

Il ritaglio rettangolare applicato al video avatar.

VoiceAgentAvatarVideoParams

Codificatore video Avatar e impostazioni di presentazione.

VoiceAgentAvatarVideoResolution

La risoluzione del video avatar.

VoiceAgentAzureSemanticVadEnTurnDetection

Rilevamento dell'attività vocale semantica di Azure ottimizzato per l'inglese.

VoiceAgentAzureSemanticVadMultilingualTurnDetection

Rilevamento dell'attività vocale semantica multilingue di Azure.

VoiceAgentAzureSemanticVadTurnDetection

Rilevamento dell'attività vocale semantica Azure.

VoiceAgentCancelResponseOptions

Opzioni per annullare una risposta.

VoiceAgentClientEventRtcCallSdpCreate

L'evento rtc.call.sdp.create cliente: inizia la segnalazione WebRTC con un'offerta SDP.

VoiceAgentClientEventSessionAvatarConnect

L'evento session.avatar.connect con il cliente.

VoiceAgentClientEventSessionUpdate

L'evento session.update con il cliente.

VoiceAgentCloseResult

Risultato fornito quando una connessione vocale-agente si interrompe.

VoiceAgentConnection

Un flusso audio connesso e bidirezionale.

Supporta esattamente un'iterazione for await sugli eventi del server; un secondo tentativo si lancia. Uscire dal loop in anticipo (break, return, o un errore non rilevato nel corpo del loop) chiude la connessione come effetto collaterale. I tipi di eventi server non riconosciuti vengono forniti come VoiceAgentUnknownEvent senza interrompere lo stream. Gli eventi malformati falliscono comunque l'iterazione con un errore di protocollo.

VoiceAgentDefinition

La definizione dell'agente vocale. La sua configurazione (modello, istruzioni, audio, strumenti e avatar opzionale) genera un'esperienza di voce vocale gestita. Stabilisci sessioni vocali in tempo reale tramite GET /agents/{agent_name}/endpoint/protocols/voice. Ogni creazione o aggiornamento produce una nuova versione immutabile.

VoiceAgentEchoCancellation

Impostazioni di cancellazione eco lato server per l'audio in ingresso.

VoiceAgentEndConversationSystemTool

Un controllo gestito dal servizio che conclude la conversazione attiva.

VoiceAgentEndOfUtteranceDetection

Configurazione semantica di rilevamento di fine enunciata.

VoiceAgentEventOptions

Opzioni condivise dalle operazioni che costruiscono un evento protocollo per conto del chiamante.

VoiceAgentFunctionTool

Uno strumento funzionale nativo eseguito dal client.

VoiceAgentGreetingConfig

Configurazione di saluto session-start per un agente vocale.

VoiceAgentInputTranscription

Configurazione asincrona di input-trascrizione audio. Amplia le opzioni di trascrizione in tempo reale di OpenAI con i modelli di trascrizione Azure e MAI, modelli di voce personalizzati e suggerimenti per frasi.

VoiceAgentInterimResponseConfig

Campi condivisi dalle configurazioni di risposta intermedia.

VoiceAgentLlmGeneratedGreetingConfig

Un saluto scritto dal modello di sessione a partire da un prompt di apertura con scopo.

VoiceAgentLlmInterimResponseConfig

Una risposta intermedia generata da un modello linguistico.

VoiceAgentMcpTool

Uno strumento MCP disponibile per un agente vocale.

VoiceAgentNoiseReduction

Configurazione di riduzione del rumore audio in ingresso.

VoiceAgentRealtimeClientConnectOptions

Opzioni per collegare il client in tempo reale a un agente vocale.

VoiceAgentRealtimeClientOptions

Opzioni per il client in tempo reale degli agenti vocali.

VoiceAgentRealtimeResponse

Una risposta in tempo reale in diretta restituita dal servizio di voice-agent sia negli response.createdresponse.done eventi.

VoiceAgentRealtimeResponseBase

Proprietà condivise tramite risposte in tempo reale restituite dal servizio voice-agent.

VoiceAgentResponseCreateParams

Parametri accettati da un evento voice-agent response.create .

VoiceAgentResponseOptions

Opzioni per creare una risposta.

VoiceAgentRtcCallErrorDetails

Dettagli di un errore di segnalazione WebRTC.

VoiceAgentSemanticVadTurnDetection

Impostazioni semantiche di rilevamento delle virate VAD di OpenAI.

VoiceAgentSendItemOptions

Opzioni condivise dalle operazioni che aggiungono un elemento di conversazione e, di default, richiedono una risposta.

VoiceAgentSendOptions

Opzioni condivise dalle operazioni di invio in tempo reale.

VoiceAgentSendTextOptions

Opzioni per inviare input di testo.

VoiceAgentSendToolOutputOptions

Opzioni per restituire un risultato di funzione.

VoiceAgentServerEventResponseAnimationBlendshapesDelta

L'evento response.animation_blendshapes.delta del server.

VoiceAgentServerEventResponseAnimationBlendshapesDone

L'evento response.animation_blendshapes.done del server.

VoiceAgentServerEventResponseAnimationVisemeDelta

L'evento response.animation_viseme.delta del server.

VoiceAgentServerEventResponseAnimationVisemeDone

L'evento response.animation_viseme.done del server.

VoiceAgentServerEventResponseAudioTimestampDelta

L'evento response.audio_timestamp.delta del server.

VoiceAgentServerEventResponseAudioTimestampDone

L'evento response.audio_timestamp.done del server.

VoiceAgentServerEventResponseVideoDelta

L'evento response.video.delta del server.

VoiceAgentServerEventRtcCallError

L'evento rtc.call.error del server: un guasto della segnalazione WebRTC.

VoiceAgentServerEventRtcCallSdpCreated

L'evento rtc.call.sdp.created server: la risposta SDP che completa la negoziazione WebRTC.

VoiceAgentServerEventSessionAvatarConnecting

L'evento session.avatar.connecting del server.

VoiceAgentServerEventSessionAvatarSwitchToIdle

L'evento session.avatar.switch_to_idle del server.

VoiceAgentServerEventSessionAvatarSwitchToSpeaking

L'evento session.avatar.switch_to_speaking del server.

VoiceAgentServerEventSessionSubagentAborted

L'evento session.subagent.aborted del server.

VoiceAgentServerEventSessionSubagentCompleted

L'evento session.subagent.completed del server.

VoiceAgentServerEventSessionSubagentStarted

L'evento session.subagent.started del server.

VoiceAgentServerEventWarning

L'evento warning del server.

VoiceAgentServerEventWarningDetails

Dettagli di un avviso non fatale.

VoiceAgentServerVadTurnDetection

Rilevamento dell'attività vocale lato server.

VoiceAgentSessionAvatarConfig

Impostazioni di Avatar accettate dal contratto stabile di voice-agent WebSocket.

VoiceAgentSessionResponseConfig

Le impostazioni stabili della sessione in tempo reale sono state restituite dal servizio voice-agent.

VoiceAgentSessionUpdateConfig

Le impostazioni stabili della sessione in tempo reale sono accettate in un session.update evento client.

VoiceAgentSessionUpdateOptions

Opzioni per aggiornare la sessione live.

VoiceAgentStaticInterimResponseConfig

Una risposta intermedia statica selezionata dal testo configurato.

VoiceAgentSubagent

Un agente di testo Foundry fratello che un operatore vocale può consultare come specialista di background.

VoiceAgentSubagentConfig

Configurazione per gli agenti di testo Foundry fratelli che un agente vocale può consultare.

VoiceAgentSubagentResponsePolicy

Politica per fornire risposte mentre un operatore vocale aspetta un subagente.

VoiceAgentSystemTool

Un controllo gestionato dal servizio che agisce sulla sessione vocale attiva senza codice cliente o autenticazione esterna.

VoiceAgentTemplateGreetingConfig

Un saluto deterministico reso con gli input strutturati dell'agente vocale e sintetizzato senza generazione creata dal modello.

VoiceAgentTool

Uno strumento utilizzabile da un agente vocale.

VoiceAgentToolboxTool

Un riferimento a una toolbox Foundry, che è un bundle versionato di strumenti eseguiti tramite il suo endpoint MCP.

VoiceAgentTranscriptionPhrase

Una frase trascritta con informazioni di tempismo.

VoiceAgentTranscriptionWord

Una parola con data e ora in una trascrizione audio-input.

VoiceAgentTurnDetectionConfig

Configurazione di rilevamento delle curve per un agente vocale.

VoiceAgentUnknownEvent

Un evento server il cui tipo di filo non è riconosciuto da questa versione dell'SDK.

L'SDK consegna questi eventi senza chiudere la connessione o applicare validazione o normalizzazione di eventi noti. Ispeziona e valida i campi grezzi prima di usarli.

VoiceAgentWebSocketConnectOptions

Le opzioni sono passate a VoiceAgentWebSocketTransport.connect.

VoiceAgentWebSocketFactory

Crea istanze di VoiceAgentWebSocketTransport per VoiceAgentRealtimeClient.

VoiceAgentWebSocketHandlers

Richiami invocati da un VoiceAgentWebSocketTransport quando si verificano eventi di connessione.

VoiceAgentWebSocketTransport

Un trasporto WebSocket collegabile utilizzato da VoiceAgentRealtimeClient. Implementa questa interfaccia per personalizzare come viene stabilita la connessione in tempo reale, ad esempio per instradarla attraverso un relè autenticato.

VoiceAudioItem

Metadati per il segmento audio di un singolo elemento di conversazione. Per il bring-your-own-storage (BYOS), la risposta include blob_uri, un URI di archiviazione diretta del cliente senza token SAS, che il cliente accede con le proprie credenziali. Per lo storage gestito da Foundry, blob_uri è assente e i byte vengono trasmessi attraverso la rotta dell'elemento /audio/content .

VoiceConversation

Una conversazione insistente a voce. La busta di Foundry che possiede la trascrizione memorizzata di un agente vocale, le risposte, le metriche per turno e l'audio. È il confine genitore, di ritenzione e di eliminazione: eliminarla si propaga a cascata alle sue risposte, elementi, metriche e audio. Quando la finalizzazione fallisce, eventuali risposte parziali persistenti, elementi e audio degli elementi rimangono leggibili.

VoiceConversationEngine

Un motore che possiede la gestione delle conversazioni per un agente vocale.

VoiceGeneratedAudioItem

Metadati dell'audio generato da un elemento di conversazione. Per il bring-your-own-storage (BYOS), la risposta include blob_uri, un URI di archiviazione diretta del cliente senza token SAS, che il cliente accede con le proprie credenziali. Per lo storage gestito da Foundry, blob_uri è assente e i byte vengono trasmessi attraverso la rotta dell'elemento /audio/generated/content .

VoiceHostedAgentConversationEngine

Un riferimento chiuso all'agente di testo ospitato che si occupa della gestione delle conversazioni per un agente vocale. L'agente ospitato viene risolto all'interno dello stesso progetto e deve supportare il invocations_ws protocollo, la compatibilità con Voice Live e il Bridge Protocol 1.0.

VoiceRecording

Metadati per la registrazione stereo unita e completa della chiamata di una conversazione vocale (audio utente sul canale sinistro, audio agente a destra). Costruito una volta dai segmenti per turno dopo la fine della sessione e memorizzato duraturamente nella cache. I metadati comuni (formato, frequenza di campionamento, canali, disposizione del canale, durata) vengono restituiti sia per le registrazioni gestite da Foundry sia per quelle con apporto a tuo proprio storage (BYOS). Per BYOS la risposta include blob_urianche , l'URI della registrazione nello storage del cliente (nessun token SAS), che il cliente scarica utilizzando le proprie credenziali di archiviazione. Per Foundry, lo storage blob_uri gestito da Foundry è assente e i byte vengono trasmessi tramite il /audio/content percorso tramite streaming.

VoiceRecordingChannelLayout

Il ruolo assegnato a ciascun canale di una registrazione vocale stereo fusa.

VoiceResponse

Una risposta vocale persistente che rappresenta un turno di inferenza del modello all'interno di una conversazione. Nei risultati delle liste la output proiezione può essere omessi; recuperare la risposta completa (GET .../responses/{response_id}) o la rotta degli elementi di risposta paginati (GET .../responses/{response_id}/items) per i suoi elementi di output. created_at / completed_at sono estensioni di ordinazione durevoli Foundry.

VoiceResponseAudio

Configurazione audio per una risposta. Segue la forma dell'oggetto OpenAI Realtime GA audio .

VoiceResponseAudioOutput

La proiezione audio a risposta piatta, con opzionali voice, voice_type, voice_locale, e format campi.

VoiceResponseBase

Proprietà condivise da risposte vocali persistenti.

WebIQPreviewTool

Uno strumento WebIQ lato server.

WebIQPreviewToolboxTool

Uno strumento WebIQ conservato in una cassetta degli attrezzi.

WebSearchApproximateLocation

La posizione approssimativa dell'utente.

WebSearchConfiguration

Configurazione di ricerca Web per bing ricerca personalizzata

WebSearchPreviewTool

Questo strumento cerca sul web risultati rilevanti da utilizzare in una risposta. Altre informazioni sullo strumento di ricerca web.

WebSearchTool

Cerca su Internet fonti relative al prompt. Altre informazioni sullo strumento di ricerca web.

WebSearchToolFilters

interfaccia modello WebSearchToolFilters

WebSearchToolboxTool

Uno strumento di ricerca web conservato in una cassetta degli attrezzi.

WeeklyRecurrenceSchedule

Pianificazione della ricorrenza settimanale.

WorkIQPreviewTool

Uno strumento WorkIQ lato server.

WorkIQPreviewToolboxTool

Uno strumento WorkIQ conservato in una cassetta degli attrezzi.

WorkflowAgentDefinition

Definizione dell'agente del flusso di lavoro.

Alias tipo

A2AProtocolVersion

Versioni supportate per il protocollo A2A.

ActivityProtocolAccessBoundary

Un confine di accesso per il protocollo di attività.

AgentBlueprintReferenceType

Tipo di AgentTipoRiferimentoSchema

AgentBlueprintReferenceUnion

Alias per AgentBlueprintReferenceUnion

AgentDefinitionOptInKeys

Chiavi di opt-in per le funzionalità di definizione degli agenti che supportano funzionalità di anteprima condizionale.

AgentDefinitionUnion

Tipo di unione per tutti i tipi di definizione dell'agente. Supporta workflow, hosted, container app, prompt e agenti esterni.

AgentEndpoint

Configurazione per il routing, i protocolli e l'autorizzazione presso un endpoint agente.

AgentEndpointAuthorizationSchemeType

Tipo di AgenteEndpointAuthorizationSchemeType

AgentEndpointAuthorizationSchemeUnion

Alias per AgentEndpointAuthorizationSchemeUnion

AgentHarnessUnion

Alias per AgentHarnessUnion

AgentIdentityStatus

Lo stato di un'identità di agente, applicabile sia all'identità dell'istanza dell'agente sia al blueprint dell'agente.

AgentInsightJsonValue

Un valore JSON utilizzato nei payload di Agent Insights.

AgentInsightOverviewSource

Identifica da dove proviene una panoramica di Agent Insights.

AgentInsightPromptSurface

La superficie Prompt è stata modificata da una soluzione proposta.

AgentInsightProposedFixKind

Il tipo di soluzione proposta da un agente che può renderizzare il cliente.

AgentInsightRunTrigger

Il trigger che ha dato inizio a una run di insight agente.

AgentInsightSeverity

La gravità di un'analisi di un agente.

AgentInsightStatus

Lo stato del ciclo di vita di un insight di un agente.

AgentKind

Definisce il tipo/tipo di agente. Determina la struttura di definizione dell'agente utilizzata.

AgentOptimizationDatasetInputType

Valori discriminatori per l'unione di input del dataset.

AgentOptimizationDatasetInputUnion

Alias per AgentOptimizationDatasetInputUnion

AgentProtocol

Tipo di AgentProtocol

AgentSessionStatus

Lo stato di una sessione con agenti.

AgentState

Lo stato operativo di un agente.

AgentStateSource

Indica la fonte dello stato operativo di un agente. Vuoto quando lo stato non deriva da una fonte specifica.

AgentType

Tipo di agentType

AgentVersionStatus

Lo stato di provisioning di una versione agente.

AgentsDownloadAgentCodeResponse

L'archivio ZIP scaricato contenente il codice agente ospitato, esposto come un Blob del browser o Node.js flusso leggibile.

AgentsDownloadSessionFileResponse

Il file di sessione dell'agente scaricato, esposto come un Blob del browser o Node.js flusso leggibile.

AgentsPatchAgentObjectOptionalParams

Parametri facoltativi.

AttackStrategy

Strategie per gli attacchi.

AzureAISearchQueryType

Tipi di query disponibili per lo strumento Azure AI Search.

BaseCredentialsUnion

Alias per BaseCredentialsUnion

BetaSkillsDownloadResponse

L'archivio ZIP per la versione predefinita di una competenza, esposto come un Blob del browser o Node.js flusso leggibile.

BetaVoiceAgentsConversationsDownloadAudioItemResponse

L'audio WAV di un elemento di conversazione, esposto come un Blob del browser o Node.js flusso leggibile.

BetaVoiceAgentsConversationsDownloadAudioResponse

La registrazione WAV stereo unita di una conversazione vocale, esposta come un Blob del browser o Node.js flusso leggibile.

BetaVoiceAgentsConversationsDownloadGeneratedAudioItemResponse

L'audio WAV generato per un elemento di conversazione interrotto, esposto come un Blob del browser o Node.js flusso leggibile.

CallableToolAllowedCaller

Tipo di chiamante chiamabileToolAllowedCaller

CodeDependencyResolution

Come vengono risolte le dipendenze di pacchetti al momento della distribuzione per un agente ospitato basato su codice.

ComparisonFilterValueItems

Alias per ComparisonFilterValueItems

ComputerEnvironment

Tipo di Ambiente ComputerT

ConnectionType

Tipo (o categoria) della connessione

ContainerMemoryLimit

Tipo di ContainerMemoryLimit

ContainerNetworkPolicyParamType

Tipo di ContainerNetworkPolicyParamType

ContainerNetworkPolicyParamUnion

Alias per ContainerNetworkPolicyParamUnion

ContainerSkillType

Tipo di ContainerSkillType

ContainerSkillUnion

Alias per ContainerSkillUnion

ContinuablePage

Interfaccia che descrive una pagina di risultati.

CreateTelephonyBindingRequestUnion

Alias per CreateTelephonyBindingRequestUnion

CreateTranscriptionResponseJsonUsageType

Tipo di CreateTranscriptionResponseJsonUsageType

CreateTranscriptionResponseJsonUsageUnion

Alias per CreateTranscriptionResponseJsonUsageUnion

CredentialType

Tipo di credenziale utilizzato dalla connessione

CustomToolParamFormatType

Tipo di CustomToolParamFormatType

CustomToolParamFormatUnion

Alias for CustomToolParamFormatUnion

DataGenerationJobOptionsUnion

Alias per DataGenerationJobOptionsUnion

DataGenerationJobOutputType

I tipi di file di output supportati per un lavoro di generazione dati.

DataGenerationJobOutputUnion

Alias per DataGenerationJobOutputUnion

DataGenerationJobOutputWriteMode

Le modalità di scrittura supportate per i lavori di generazione dati.

DataGenerationJobScenario

Gli scenari supportati per un lavoro di generazione dati.

DataGenerationJobSourceType

I tipi di sorgente supportati per i lavori di generazione dati.

DataGenerationJobSourceUnion

Alias per DataGenerationJobSourceUnion

DataGenerationJobType

I tipi di lavoro supportati per la generazione dei dati.

DatasetType

Enumerazione per determinare il tipo di dati.

DatasetVersionUnion

Alias per DatasetVersionUnion

DayOfWeek

Giorni della settimana per la pianificazione della ricorrenza.

DeploymentType

Tipo di DeploymentType

DeploymentUnion

Alias per DeploymentUnion

DigitalWorkerType

Il tipo di lavoratore digitale.

DownloadVersionResponse

L'archivio ZIP per una specifica versione di abilità, esposto come un Blob del browser o Node.js flusso leggibile.

EvaluationLevel

Il livello a cui viene eseguita la valutazione.

EvaluationRuleActionType

Tipo di azione di valutazione.

EvaluationRuleActionUnion

Alias per la valutazioneRegolaAzioneUnione

EvaluationRuleEventType

Tipo di evento della regola di valutazione.

EvaluationTargetUnion

Alias per EvaluationTargetUnion

EvaluationTaxonomyInputType

Tipo di input della tassonomia di valutazione.

EvaluationTaxonomyInputUnion

Alias per ValutazioneTassonomiaInputUnione

EvaluatorCategory

La categoria del valutatore

EvaluatorDefinitionType

Il tipo di definizione del valutatore

EvaluatorDefinitionUnion

Alias per EvaluatorDefinitionUnion

EvaluatorGenerationJobSourceType

I tipi di sorgente supportati per i lavori di generazione dei valutatori.

EvaluatorGenerationJobSourceUnion

Alias per ValutatoreGenerazioneLavoroSorgenteSindacato

EvaluatorMetricDirection

La direzione della metrica che indica se un valore più alto è migliore, un valore più basso è migliore o neutro

EvaluatorMetricType

Il tipo di valutatore

EvaluatorType

Il tipo di valutatore

FileContents

Valori validi per il contenuto di un file binario.

Filters

Alias per filtri

FoundryFeaturesOptInKeys

Tipo di FoundryCaratteristiche OptInKeys

FoundryModelArtifactProfileCategory

La categoria profilo di artefatti.

FoundryModelArtifactProfileSignal

Segnali rilevati nell'artefatto del modello.

FoundryModelSourceType

Il tipo di sorgente del modello.

FoundryModelWarningCode

Codice di avviso per artefatti di modello.

FoundryModelWeightType

Il tipo di peso del modello.

FunctionShellToolParamEnvironmentType

Tipo di FunzioneShellToolParamAmbienteType

FunctionShellToolParamEnvironmentUnion

Alias per FunctionShellToolParamEnvironmentUnion

GenerateAgentRequest

Gli input specifici per tipo per generare e creare un agente.

GenerationWarningType

La categoria di un avviso è emersa in una versione generata dal valutatore. Estensibile in modo che nuove categorie di avvertimento (ad esempio, sicurezza, qualità di output) possano essere introdotte senza cambiare di interruzione.

GetMicrosoft365PackageResponse

Il pacchetto binario dell'app Microsoft 365 generato per un agente Foundry.

GitHubCopilotBuiltInTool

Uno strumento integrato di GitHub Copilot configurabile dal cliente.

GitHubIssueEvent

Eventi noti su GitHub che possono attivare una routine.

GrammarSyntax

Tipo di GrammaticSintassi

ImageGenAction

Tipo di ImageGenAction

IndexType

Tipo di IndexType

IndexUnion

Alias per IndexUnion

InputFidelity

Controllare quanto sforzo il modello eserciterà per corrispondere allo stile e alle caratteristiche, in particolare quelle facciali, delle immagini di ingresso. Questo parametro è supportato solo per gpt-image-1 e gpt-image-1.5 e modelli successivi, non supportati per gpt-image-1-mini. Supporta high e low. Il valore predefinito è low.

InsightRequestUnion

Alias per InsightRequestUnion

InsightResultUnion

Alias per InsightResultUnion

InsightSampleUnion

Alias per InsightSampleUnion

InsightType

La richiesta degli approfondimenti.

JobPoller

Un sondaggiatore per un'operazione di lunga durata che crea una risorsa di posti di lavoro.

JobStatus

Valori di status estensibili condivisi dai lavori di Foundry.

MemoryItemKind

Tipo di elemento di memoria.

MemoryItemUnion

Alias per MemoryItemUnion

MemoryOperationKind

Tipo di operazione di memoria.

MemoryStoreDefinitionUnion

Alias per MemoryStoreDefinitionUnion

MemoryStoreKind

Tipo di implementazione dell'archivio memoria da utilizzare.

MemoryStoreType

Tipo di MemoryStoreType

MemoryStoreUpdateStatus

Stato di un'operazione di aggiornamento dell'archivio di memoria.

Microsoft365PublishScope

L'ambito di pubblicazione per l'app Microsoft Teams generata.

MisalignmentErrorType

Una classificazione di un'azione che potrebbe non essere in linea con l'intento dell'utente. Possono essere restituiti valori aggiuntivi.

NodeReadableStream

Digita alias per Node.js ReadableStream. Sui Node target questo si risolve nel tipo effettivo di NodeJS.ReadableStream. Sui target browser/react-native la variante platform si risolve in never, che cade naturalmente dai tipi di unione.

OpenApiAuthDetailsUnion

Alias per OpenApiAuthDetailsUnion

OpenApiAuthType

Tipo di autenticazione per l'endpoint OpenApi. I tipi consentiti sono:

  • Anonimo (non è richiesta l'autenticazione)
  • Project Connessione (richiede project_connection_id per raggiungere l'endpoint, come configurato in AI Foundry)
  • Managed_Identity (richiede un pubblico per l'autenticazione basata sull'identità)
OperationState

Enumerazione che descrive gli stati di funzionamento consentiti.

OptimizationAgentIdentifier

Identifica l'agente Foundry registrato e la versione opzionale da ottimizzare.

OptimizationCandidate

Le modifiche di configurazione e i risultati aggregati della valutazione per un candidato all'ottimizzazione dell'agente.

OptimizationDatasetCriterion

Un'istruzione di valutazione nominata usata per punteggiare un elemento di dataset di ottimizzazione.

OptimizationDatasetInput

La descrizione di base di un dataset inline o registrato fornito a un lavoro di ottimizzazione per agenti.

OptimizationDatasetInputType

Le forme supportate per l'input di ottimizzazione del dataset: elementi inline o un riferimento registrato al dataset.

OptimizationDatasetInputUnion

Un dataset di ottimizzazione fornito come elementi inline o riferimento a un dataset registrato Foundry.

OptimizationDatasetItem

Un elemento di dataset di ottimizzazione inline contenente una query, una risposta attesa e criteri di valutazione.

OptimizationEvaluatorRef

Un riferimento a un valutatore per nome e versione opzionale per un lavoro di ottimizzazione agente.

OptimizationInlineDatasetInput

Elementi del dataset di ottimizzazione forniti direttamente nel corpo della richiesta.

OptimizationJob

Un lavoro di ottimizzazione per agenti che monitora input, progressi, stato e risultati di valutazione dei candidati.

OptimizationJobInputs

L'agente, i dataset, i valutatori e le opzioni forniti a un lavoro di ottimizzazione dell'agente.

OptimizationJobListItem

Un riassunto di un lavoro di ottimizzazione per agenti restituito da un'operazione di lista.

OptimizationJobProgress

Un istantaneo di progresso contenente i conteggi dei candidati completati, il punteggio migliore e il tempo di esecuzione trascorso.

OptimizationJobResult

I candidati valutati e gli identificatori della base e del miglior candidato da un lavoro di ottimizzazione.

OptimizationOptions

Impostazioni che controllano la generazione dei candidati, la selezione del modello e la valutazione per un lavoro di ottimizzazione agente.

OptimizationReferenceDatasetInput

Un riferimento a un dataset Foundry registrato per nome e versione opzionale per l'ottimizzazione degli agenti.

PageOrder

Tipo di Ordine di Pagina

PendingUploadType

Il tipo di caricamento in sospeso.

PublishApprovalStatus

Lo stato di revisione della Certificazione Microsoft Agent del titolo dello store Microsoft 365 pubblicato per un agente.

RaiInvocationContentType

Come viene analizzato il corpo di una richiesta/risposta di invocazione per trovare il testo per la moderazione della sicurezza dei contenuti.

RaiInvocationMode

Forma di risposta dichiarata dall'autore per il protocollo di invocazione.

RankerVersionType

Tipo di RankerVersionType

RealtimeAudioFormatsType

Tipo di RealtimeAudioFormatsType

RealtimeAudioFormatsUnion

Alias per RealtimeAudioFormatsUnion

RealtimeClientEventType

Tipo di RealtimeClientEventType

RealtimeClientEventUnion

Alias per RealtimeClientEventUnion

RealtimeConversationItemMessageType

Tipo di RealtimeConversationItemTypeMessage

RealtimeConversationItemMessageUnion

Alias per RealtimeConversationItemMessageUnion

RealtimeConversationItemType

Tipo di RealtimeConversationItemType

RealtimeConversationItemUnion

Alias per RealtimeConversationItemUnion

RealtimeFunctionToolParameters

interfaccia modello RealtimeFunctionToolParameters

RealtimeMCPErrorType

Tipo di RealtimeMCPErrorType

RealtimeMCPErrorUnion

Alias per RealtimeMCPErrorUnion

RealtimeReasoningEffort

Limita lo sforzo nel ragionamento per modelli in tempo reale con capacità di ragionamento come gpt-realtime-2.

RealtimeServerEventType

Tipo di RealtimeServerEventType

RealtimeServerEventUnion

Alias per RealtimeServerEventUnion

ReasoningEffort

Limita lo sforzo di ragionamento per modelli di ragionamento. I valori attualmente supportati sono none, minimal, low, medium, high, e xhigh. La riduzione del lavoro di ragionamento può tradursi in risposte più veloci e in un minor numero di token usati per il ragionamento in una risposta.

  • gpt-5.1 di default è none, che non esegue il ragionamento. I valori di ragionamento supportati per gpt-5.1 sono none, low, medium, e high. Le chiamate agli strumenti sono supportate per tutti i valori di ragionamento in gpt-5.1.
  • Tutti i modelli precedenti gpt-5.1 predefinito allo medium sforzo di ragionamento e non supportano none.
  • Il gpt-5-pro modello si basa di default (e supporta solo) high lo sforzo di ragionamento.
  • xhigh è supportata per tutti i modelli dopo gpt-5.1-codex-max.
ReasoningModeEnum

Alias per ReasoningModeEnum

RecurrenceScheduleUnion

Alias per RecurrenceScheduleUnion

RecurrenceType

Tipo di ricorrenza.

RedTeamTargetConfigUnion

Alias per RedTeamTargetConfigUnion

RiskCategory

Categoria di rischio per l'obiettivo dell'attacco.

RoutineActionType

I valori del discriminatore supportati per azioni di routine.

RoutineActionUnion

Alias per RoutineActionUnion

RoutineAttemptSource

Sentieri sorgente noti che possono produrre una run di routine.

RoutineDispatchIdentity

Le identità supportate per l'autorizzazione di dispatch di routine.

RoutineDispatchPayloadType

I valori del discriminatore supportati per i payload di dispatch manuale di routine.

RoutineDispatchPayloadUnion

Alias per RoutineDispatchPayloadUnion

RoutineRunPhase

Fasi note del ciclo di vita registrate per una corsa di routine.

RoutineRunStatus

Lo stato di una corsa di routine.

RoutineTriggerType

I valori del discriminatore supportati per i trigger di routine.

RoutineTriggerUnion

Alias per RoutineTriggerUnion

RubricGenerationInputQualityWarningCode

Codice di avviso stabile e ricercabile e leggibile da macchina per un avviso di qualità di input generata da rubrica. I valori sono snake_case; i client devono tollerare identificatori aggiuntivi definiti dal servizio.

RubricGenerationInputQualityWarningSeverity

Severità di avviso per un avviso sulla qualità degli input generati dalla rubrica. Set di valori iniziali: warning.

RubricGenerationInputQualityWarningSource

Attribuzione della fonte dell'avviso per un avviso sulla qualità degli input generati da una rubrica. I valori per sorgente (prompt, agent, dataset) corrispondono alla categoria sorgente visibile al runtime di generazione. aggregate è un valore sintetico usato solo per avvisi calcolati tra sorgenti risolte con successo. traces non viene esposto perché le fonti di traccia si risolvono in contenuti del dataset a monte.

RunPoller

Un poller per un'operazione di lunga durata che crea una risorsa di run.

SampleType

Il tipo di campione utilizzato nell'analisi.

ScheduleProvisioningStatus

Pianificare lo stato del provisioning.

ScheduleTaskType

Tipo dell'attività.

ScheduleTaskUnion

Alias per ScheduleTaskUnion

SearchContentType

Tipo di SearchContentType

SearchContextSize

Tipo di RicercaContestoDimensione

SessionLogEventType

Tipi di eventi SSE noti emetti dal flusso di log di sessione dell'agente ospite. Ulteriori tipi di eventi potrebbero essere introdotti nelle versioni future.

SimpleQnAFineTuningQuestionType

I tipi di domanda supportati per i lavori di generazione dati SimpleQnA utilizzati per la messa a punto di scenari.

TelemetryDataKind

Il tipo di dati di telemetria da esportare.

TelemetryEndpointAuthType

Il tipo di autenticazione per un endpoint di telemetria.

TelemetryEndpointAuthUnion

Alias per TelemetryEndpointAuthUnion

TelemetryEndpointKind

Quel tipo di endpoint di esportazione di telemetria.

TelemetryEndpointUnion

Alias for TelemetryEndpointUnion

TelemetryTransportProtocol

Il protocollo di trasporto per l'esportazione di telemetria.

TelephonyBindingListItemUnion

Alias for TelephonyBindingListItemUnion

TelephonyBindingStatus

Lo stato del ciclo di vita di un collegamento telefonico.

TelephonyBindingUnion

Alias per TelephonyBindingUnion

TelephonyCallDurationBasis

Il timestamp utilizzato come base per la durata della chiamata.

TelephonyCallEndReason

Motivi noti generati dal servizio per cui una chiamata telefonica è terminata, piuttosto che motivi per una chiamata in uscita complessiva. Possono essere restituiti codici stringa aggiuntivi.

TelephonyCallJobStatus

Lo stato del ciclo di vita di un lavoro di chiamata outbound duraturo.

TelephonyCallJobTerminalReason

Motivi terminali noti per un lavoro complessivo di chiamata in uscita, che può coprire più tentativi di fornitore. Questi sono distinti dalle ragioni del ciclo di vita delle singole chiamate. Possono essere restituiti codici stringa aggiuntivi.

TelephonyCallLifecycleEventName

Un nome di evento di ciclo di vita neutrale rispetto al fornitore. I valori noti sono stabili; possono essere aggiunti valori aggiuntivi nel tempo.

TelephonyCallLifecycleEventOutcome

L'esito di un'osservazione del ciclo di vita della telefonia.

TelephonyCallLifecycleEventReason

Motivi noti generati dal servizio per un evento del ciclo di vita della telefonia. Una ragione dell'evento non descrive necessariamente l'esito finale della chiamata. Possono essere restituiti codici stringa aggiuntivi.

TelephonyCallLifecycleEventSource

Il componente che forniva l'osservazione del ciclo di vita della telefonia.

TelephonyCallPhase

La fase provider neutrale raggiungibile tramite una chiamata telefonica in ingresso.

TelephonyCallStatus

Lo stato del ciclo di vita di una chiamata telefonica in entrata.

TelephonyCallTimestampSource

La fonte di un timestamp del ciclo di vita della telefonia.

TelephonyCallTraceMode

La modalità utilizzata per esporre una chiamata telefonica come traccia Foundry rivolta al cliente.

TelephonyCallTraceStatus

Lo stato di disponibilità di un tracciamento di chiamata telefonica rivolto al cliente.

TelephonyOutboundDestinationType

Il tipo di destinazione per una chiamata in uscita.

TelephonyOutboundRetryPolicyType

La strategia di ritentazione per una chiamata in uscita.

TelephonyOutboundRetryPolicyUnion

Alias per TelefoniaOutboundRetryPolicyUnion

TelephonyProvider

Un operatore telefonico supportato da un agente vincolatore. I valori noti sono stabili; possono essere aggiunti valori aggiuntivi nel tempo.

TelephonyTransferDestinationKind

Il tipo di destinazione per il trasferimento telefonico. I valori noti sono stabili; possono essere aggiunti valori aggiuntivi nel tempo.

TelephonyTransferDestinationUnion

Alias per TelephonyTransferDestinationUnion

TextResponseFormatConfigurationType

Tipo di TestoRispostaFormatoConfigurazioneTipo

TextResponseFormatConfigurationUnion

Supporta configurazioni per testo semplice e risposte JSON strutturate.

TextResponseFormatUnion

Alias per TextResponseFormatUnion

ToolChoiceOptions

Controlla quale strumento (se presente) viene chiamato dal modello. none indica che il modello non chiamerà alcuno strumento e genera invece un messaggio. auto indica che il modello può scegliere tra la generazione di un messaggio o la chiamata di uno o più strumenti. required significa che il modello deve chiamare uno o più strumenti.

ToolChoiceParamType

Tipo di ToolChoiceParamType

ToolChoiceParamUnion

Alias per ToolChoiceParamUnion

ToolSearchExecutionType

Tipo di ToolSearchExecutionType

ToolType

Tipo di Tipo di Strumento

ToolUnion

Alias per ToolUnion

ToolboxShellEnvironmentUnion

Alias per ToolboxShellEnvironmentUnion

ToolboxShellNetworkPolicyUnion

Alias per ToolboxShellNetworkPolicyUnion

ToolboxSkillUnion

Alias per ToolboxSkillUnion

ToolboxToolType

Tipi di strumenti supportati per gli strumenti conservati in una cassetta degli attrezzi.

ToolboxToolUnion

Alias per ToolboxToolUnion

ToolboxesInvokeLatestToolboxMcpResponse

La risposta è stata restituita dall'ultimo endpoint MCP del toolbox.

TreatmentEffectType

Tipo di effetto del trattamento.

TriggerType

Tipo di trigger.

TriggerUnion

Alias per TriggerUnion

VersionIndicatorType

Il tipo di indicatore di versione utilizzato per determinare la versione dell'agente che supporta una sessione.

VersionIndicatorUnion

Alias per VersionIndicatorUnion

VersionSelectionRuleType

Tipo di VersionSelectionRuleType

VersionSelectionRuleUnion

Alias per VersionSelectionRuleUnion

VoiceAgentAnimationOutputType

Un output di animazione prodotto da una sessione di voice-agent.

VoiceAgentAudioTimestampType

Un tipo di timestamp audio in uscita supportato da un agente vocale.

VoiceAgentAvatarOutputProtocol

Il trasporto usato per consegnare lo stream video dell'avatar.

VoiceAgentAvatarType

Il tipo avatar.

VoiceAgentClientEvent

Un messaggio v1 stabile inviato da un client tramite un WebSocket con agente vocale.

VoiceAgentConnectionState

Condizioni di connessione riportate da una connessione in tempo reale tra un agente vocale.

VoiceAgentConnectionStateChangedHandler

Chiamato quando una connessione vocale-agente cambia stato.

VoiceAgentEchoCancellationReferenceSource

La sorgente dell'audio di riferimento utilizzata per la cancellazione dell'eco.

VoiceAgentEndOfUtteranceDetectionModel

Il modello semantico di rilevamento della fine dell'enunciazione.

VoiceAgentEndOfUtteranceThresholdLevel

La soglia di sensibilità per il rilevamento semantico di fine enunciata.

VoiceAgentGreetingConfigUnion

Alias per VoiceAgentGreetingConfigUnion

VoiceAgentInputTranscriptionModel

L'identificatore del modello di trascrizione audio-input. Questo è un nome di modello, non un nome di distribuzione Foundry. Rispecchia i modelli di trascrizione supportati dal backend vocale gestito, coprendo i modelli di trascrizione OpenAI Realtime oltre ai modelli Azure e MAI. È possibile aggiungere valori aggiuntivi nel tempo.

VoiceAgentInterimResponseConfigUnion

Alias per VoiceAgentInterimResponseConfigUnion

VoiceAgentInterimResponseTrigger

Una condizione che potrebbe scatenare una risposta temporanea.

VoiceAgentMaxOutputTokens

Il conteggio massimo dei token di output o il letterale inf.

VoiceAgentNoiseReductionType

La modalità di riduzione del rumore audio in ingresso.

VoiceAgentRealtimeErrorCode

Codici di errore generati dal client in tempo reale degli agenti vocali.

VoiceAgentRealtimeEvent

Un evento ricevuto da una connessione in tempo reale con un agente vocale.

Gli eventi noti mantengono i loro tipi generati e la normalizzazione. I tipi di filo non riconosciuti sono avvolti in VoiceAgentUnknownEvent. Passa type a eventi noti ristretti, oppure escludi type === "unknown" prima di passare un evento a un gestore di eventi noti.

VoiceAgentServerEvent

Un messaggio v1 stabile inviato dal servizio tramite un WebSocket voice-agent.

VoiceAgentSessionIncludeOption

Campi aggiuntivi che una sessione di voice-agent può includere nelle uscite del servizio.

VoiceAgentSessionResponse

La configurazione effettiva della sessione è tornata negli eventi del ciclo di vita della sessione con agente vocale.

VoiceAgentSessionUpdate

La configurazione della sessione è accettata da un evento di aggiornamento sessione per agente vocale.

VoiceAgentSubagentAbortReason

Il motivo per cui una consulenza con un subagente è stata interrotta.

VoiceAgentSystemToolName

Un'azione di controllo di sessione vocale gestita dal servizio. I valori noti sono stabili; possono essere aggiunti valori aggiuntivi nel tempo.

VoiceAgentSystemToolUnion

Alias per VoiceAgentSystemToolUnion

VoiceAgentToolChoice

Comportamento di selezione degli strumenti per un agente vocale.

VoiceAgentToolResponseScheduling

Quando una invocazione di uno strumento crea una risposta di follow-up. È possibile aggiungere valori aggiuntivi nel tempo.

VoiceAgentToolUnion

Alias per VoiceAgentToolUnion

VoiceAgentTransport

Il trasporto usato per la connessione tra voce e agente.

VoiceAgentTurnDetectionConfigUnion

Alias per VoiceAgentTurnDetectionConfigUnion

VoiceAgentTurnDetectionType

La strategia di rilevamento delle curve. È possibile aggiungere valori aggiuntivi nel tempo.

VoiceAgentWebSocketMessage

Un messaggio JSON scambiato tramite un WebSocket di un agente vocale affermato. I byte audio sono codificati in base 64 nei campi di eventi JSON.

VoiceAgentWebSocketSubprotocol

Il sottoprotocollo WebSocket supportato da una connessione voice-agent.

VoiceAudioCodec

Un codec audio. È possibile aggiungere valori aggiuntivi nel tempo.

VoiceAudioContainerFormat

Un formato contenitore audio. È possibile aggiungere valori aggiuntivi nel tempo.

VoiceAudioRole

Un ruolo di partecipante voce e audio. È possibile aggiungere valori aggiuntivi nel tempo.

VoiceConversationEngineUnion

Alias per VoiceConversationEngineUnion

VoiceConversationStatus

Lo stato del ciclo di vita di una conversazione vocale persistente:

  • in_progress: la sessione live è attiva, oppure la finalizzazione della persistenza post-sessione è in attesa.
  • completed: la finalizzazione è stata riuscita dopo la chiusura normale o del cliente, end_conversation, una chiusura a durata 1001 massima o una disconnessione del client o della rete che il servizio può ancora finalizzare.
  • failed: un guasto al servizio terminale, al ponte, allo storage o al trasporto irrecuperabile ha impedito la finalizzazione.
VoiceModelType

Come viene servito il modello che supporta un agente vocale. Questo è indipendente dall'architettura (in tempo reale o a cascata), che il servizio deriva dal modello selezionato.

VoiceOutputModality

Una modalità di output che l'agente può produrre. animation e avatar vengono usati quando un avatar è configurato.

VoiceType

L'implementazione vocale. È possibile aggiungere valori aggiuntivi nel tempo.

Enumerazioni

KnownApiVersions

Versioni API di Microsoft Foundry

Funzioni

isRestError(unknown)

Typeguard per RestError

Variabili

RestError

Tipo di errore personalizzato per le richieste di pipeline non riuscite.

KnownVoiceAgentConnectionState

Valori noti di VoiceAgentConnectionState riportati da una connessione in tempo reale tra voce e agente.

Dettagli funzione

isRestError(unknown)

Typeguard per RestError

function isRestError(e: unknown): e is RestError

Parametri

e

unknown

Un elemento rilevato da una clausola catch.

Valori restituiti

e is RestError

Dettagli delle variabili

RestError

Tipo di errore personalizzato per le richieste di pipeline non riuscite.

RestError: RestErrorConstructor

Tipo

KnownVoiceAgentConnectionState

Valori noti di VoiceAgentConnectionState riportati da una connessione in tempo reale tra voce e agente.

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

Tipo

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