@azure/ai-projects package

Classi

AIProjectClient

ottiene il client OpenAI con opzioni opzionali per il client OpenAI

Interfacce

@azure/ai-projects.Index
A2APreviewTool

Un agente che implementa il protocollo A2A.

AIProjectClientOptionalParams

Parametri facoltativi per il client.

AISearchIndexResource

Una risorsa dell'indice di ricerca AI.

Agent

Agente dell'interfaccia modello

AgentClusterInsightRequest

Informazioni dettagliate sul set di risultati della valutazione dell'agente

AgentClusterInsightResult

Informazioni dettagliate dall'analisi del cluster di agenti.

AgentDefinition

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

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.

AgentsCreateVersionOptionalParams

Parametri facoltativi.

AgentsDeleteOptionalParams

Parametri facoltativi.

AgentsDeleteVersionOptionalParams

Parametri facoltativi.

AgentsGetOptionalParams

Parametri facoltativi.

AgentsGetVersionOptionalParams

Parametri facoltativi.

AgentsListOptionalParams

Parametri facoltativi.

AgentsListVersionsOptionalParams

Parametri facoltativi.

AgentsOperations

Interfaccia che rappresenta le operazioni di un agente.

AgentsUpdateAgentFromManifestOptionalParams

Parametri facoltativi.

AgentsUpdateOptionalParams

Parametri facoltativi.

Annotation

Annotazione applicabile a un intervallo di testo di output.

ApiErrorResponse

Risposta di errore per errori API.

ApiKeyCredentials

Definizione delle credenziali della chiave API

ApplyPatchCreateFileOperationParam

Istruzioni per creare un nuovo file tramite lo strumento apply_patch.

ApplyPatchDeleteFileOperationParam

Istruzioni per eliminare un file esistente tramite lo strumento apply_patch.

ApplyPatchOperationParam

Una delle operazioni create_file, delete_file o update_file fornite allo strumento apply_patch.

ApplyPatchToolParam

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

ApplyPatchUpdateFileOperationParam

Istruzione per aggiornare un file esistente tramite lo strumento apply_patch.

ApproximateLocation

interfaccia modello ApprossimazionePosizione

AzureAIAgentTarget

Rappresenta una destinazione che specifica un agente di intelligenza artificiale di Azure.

AzureAIModelTarget

Rappresenta una destinazione che specifica un modello di intelligenza artificiale di Azure per le operazioni che richiedono la selezione del modello.

AzureAISearchIndex

Definizione dell'indice di ricerca di Azure per intelligenza artificiale

AzureAISearchTool

Informazioni sulla definizione di input per uno strumento di ricerca di intelligenza artificiale di Azure usato per configurare un agente.

AzureAISearchToolResource

Set di risorse di indice usate dallo strumento azure_ai_search.

AzureFunctionBinding

Struttura per mantenere il nome e l'URI della coda di archiviazione.

AzureFunctionDefinition

Definizione della funzione di Azure.

AzureFunctionStorageQueue

Struttura per mantenere il nome e l'URI della coda di archiviazione.

AzureFunctionTool

Informazioni sulla definizione di input per uno strumento per le funzioni di Azure, usate per configurare un agente.

AzureOpenAIModelConfiguration

Configurazione del modello Azure 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

BetaEvaluationTaxonomiesCreateOptionalParams

Parametri facoltativi.

BetaEvaluationTaxonomiesDeleteOptionalParams

Parametri facoltativi.

BetaEvaluationTaxonomiesGetOptionalParams

Parametri facoltativi.

BetaEvaluationTaxonomiesListOptionalParams

Parametri facoltativi.

BetaEvaluationTaxonomiesOperations

Interfaccia che rappresenta un'operazione di BetaEvaluationTaxonomies.

BetaEvaluationTaxonomiesUpdateOptionalParams

Parametri facoltativi.

BetaEvaluatorsCreateVersionOptionalParams

Parametri facoltativi.

BetaEvaluatorsDeleteVersionOptionalParams

Parametri facoltativi.

BetaEvaluatorsGetVersionOptionalParams

Parametri facoltativi.

BetaEvaluatorsListLatestVersionsOptionalParams

Parametri facoltativi.

BetaEvaluatorsListVersionsOptionalParams

Parametri facoltativi.

BetaEvaluatorsOperations

Interfaccia che rappresenta le operazioni di un BetaEvaluators.

BetaEvaluatorsUpdateVersionOptionalParams

Parametri facoltativi.

BetaInsightsGenerateOptionalParams

Parametri facoltativi.

BetaInsightsGetOptionalParams

Parametri facoltativi.

BetaInsightsListOptionalParams

Parametri facoltativi.

BetaInsightsOperations

Interfaccia che rappresenta un'operazione BetaInsights.

BetaMemoryStoresCreateOptionalParams

Parametri facoltativi.

BetaMemoryStoresDeleteOptionalParams

Parametri facoltativi.

BetaMemoryStoresDeleteScopeOptionalParams

Parametri facoltativi.

BetaMemoryStoresGetOptionalParams

Parametri facoltativi.

BetaMemoryStoresGetUpdateResultOptionalParams

Parametri facoltativi.

BetaMemoryStoresListOptionalParams

Parametri facoltativi.

BetaMemoryStoresOperations

Interfaccia che rappresenta un'operazione BetaMemoryStores.

BetaMemoryStoresSearchMemoriesOptionalParams

Parametri facoltativi.

BetaMemoryStoresUpdateMemoriesOptionalParams

Parametri facoltativi.

BetaMemoryStoresUpdateOptionalParams

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.

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.

BingCustomSearchConfiguration

Una configurazione di ricerca personalizzata di Bing.

BingCustomSearchPreviewTool

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

BingCustomSearchToolParameters

I parametri dello strumento di ricerca personalizzata di Bing.

BingGroundingSearchConfiguration

Configurazione di ricerca per l'incaglio di Bing

BingGroundingSearchToolParameters

I parametri dello strumento di ricerca per la messa a terra di bing.

BingGroundingTool

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

BlobReference

Dettagli di riferimento BLOB.

BrowserAutomationPreviewTool

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

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.

ClickParam

Azione di fare clic.

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

CodeInterpreterContainerAuto

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

CodeInterpreterOutputImage

Output dell'immagine dall'interprete di codice.

CodeInterpreterOutputLogs

Output dei log dall'interprete del codice.

CodeInterpreterTool

Strumento che esegue codice Python per generare una risposta a un prompt.

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.

ComputerAction

interfaccia del modello ComputerAction

ComputerCallSafetyCheckParam

Controllo di sicurezza in sospeso per la chiamata computer.

ComputerScreenshotImage

Immagine di uno screenshot del computer usata con lo strumento per l'uso del computer.

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.

ContainerAppAgentDefinition

Definizione dell'agente dell'app contenitore.

ContainerFileCitationBody

Una citazione per un file container utilizzato per generare una risposta al modello.

ContinuousEvaluationRuleAction

Azione della regola di valutazione per la valutazione continua.

CosmosDBIndex

Definizione dell'indice dell'archivio vettoriale CosmosDB

CronTrigger

Grilletto basato su Cron.

CustomCredential

Definizione delle credenziali personalizzate

CustomGrammarFormatParam

Una grammatica definita dall'utente.

CustomTextFormatParam

Testo libero e senza vincoli.

CustomToolParam

Uno strumento personalizzato che elabora l'input usando un formato specificato. Scopri di più sugli strumenti personalizzati

CustomToolParamFormat

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

DailyRecurrenceSchedule

Pianificazione giornaliera delle ricorrenze.

DatasetCredential

Rappresenta un riferimento a un BLOB per l'utilizzo

DatasetUploadOptions

Opzioni per il caricamento dei set di dati

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

DeleteMemoryStoreResponse

interfaccia del modello DeleteMemoryStoreResponse

Deployment

Definizione della distribuzione del modello

DeploymentsGetOptionalParams

Parametri facoltativi.

DeploymentsListOptionalParams

Parametri facoltativi.

DeploymentsOperations

Interfaccia che rappresenta le operazioni di distribuzione.

DoubleClickAction

Azione con doppio clic.

Drag

Azione di trascinamento.

DragPoint

Coppia di coordinate x/y, ad esempio { x: 100, y: 200 }.

EasyInputMessage

Messaggio di input al modello con un ruolo che indica la gerarchia di esecuzione delle istruzioni. Le istruzioni fornite con il ruolo developer o system hanno la precedenza sulle istruzioni fornite con il ruolo user. Si presuppone che i messaggi con il assistant ruolo siano stati generati dal modello nelle interazioni precedenti.

EmbeddingConfiguration

Incorporamento della classe di configurazione

EntraIDCredentials

Definizione delle credenziali dell'ID Entra

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.

EvaluationTaxonomy

Definizione della tassonomia di valutazione

EvaluationTaxonomyInput

Configurazione di input per la tassonomia di valutazione.

EvaluatorDefinition

Configurazione dell'analizzatore di base con discriminatore

EvaluatorMetric

Metrica del valutatore

EvaluatorVersion

Definizione del valutatore

FabricDataAgentToolParameters

Parametri dello strumento agente dati fabric.

FieldMapping

Classe di configurazione del mapping dei campi

FileCitationBody

Citazione in un file.

FileDatasetVersion

Definizione di FileDatasetVersion

FilePath

Percorso di un file.

FileSearchTool

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

FileSearchToolCallResults

interfaccia modello FileCercaStrumentoChiamataRisultati

FolderDatasetVersion

Definizione di FileDatasetVersion

FunctionAndCustomToolCallOutput

Funzione dell'interfaccia modello Funzione e ChiamataStrumento Personalizzato

FunctionAndCustomToolCallOutputInputFileContent

Un file di input per il modello.

FunctionAndCustomToolCallOutputInputImageContent

Un'immagine come input per il modello. Scopri di più sugli input delle immagini.

FunctionAndCustomToolCallOutputInputTextContent

Input di testo per il modello.

FunctionShellActionParam

Comandi e limiti che descrivono come eseguire la chiamata dello strumento shell.

FunctionShellCallOutputContentParam

Ho catturato stdout e stderr per una parte dell'output di una chiamata di uno strumento shell.

FunctionShellCallOutputExitOutcomeParam

Indica che i comandi shell sono terminati e hanno restituito un codice di uscita.

FunctionShellCallOutputOutcomeParam

L'uscita o il timeout associato a questa chiamata di shell.

FunctionShellCallOutputTimeoutOutcomeParam

Indica che la chiamata alla shell ha superato il limite di tempo configurato.

FunctionShellToolParam

Uno strumento che permette al modello di eseguire comandi shell.

FunctionTool

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

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.

InputContent

interfaccia modello InputContent

InputContentInputFileContent

Un file di input per il modello.

InputContentInputImageContent

Un'immagine come input per il modello. Scopri di più sugli input delle immagini.

InputContentInputTextContent

Input di testo per il modello.

InputFileContentParam

Un file di input per il modello.

InputImageContentParamAutoParam

Un'immagine come input per il modello. Scopri gli input delle immagini

InputItem

Elemento che rappresenta parte del contesto per la risposta da generare dal modello. Può contenere input di testo, immagini e audio, nonché risposte assistente precedenti e output delle chiamate degli strumenti.

InputItemApplyPatchToolCallItemParam

Una chiamata di strumento che rappresenta una richiesta per creare, eliminare o aggiornare file utilizzando patch diff.

InputItemApplyPatchToolCallOutputItemParam

L'output streamicato emesso da una chiamata allo strumento applicare la patch.

InputItemCodeInterpreterToolCall

Chiamata dello strumento per eseguire il codice.

InputItemCompactionSummaryItemParam

Un elemento di compattazione generato dall'APIv1/responses/compact.

InputItemComputerCallOutputItemParam

Output di una chiamata allo strumento del computer.

InputItemComputerToolCall

Chiamata di uno strumento a uno strumento per l'uso del computer. Per ulteriori informazioni, consultare la guida all'uso del computer .

InputItemCustomToolCall

Una chiamata a uno strumento personalizzato creato dal modello.

InputItemCustomToolCallOutput

L'output di una chiamata a uno strumento personalizzato dal tuo codice, inviato indietro al modello.

InputItemFileSearchToolCall

Risultati di una chiamata allo strumento di ricerca file. Per ulteriori informazioni, consulta la guida alla ricerca dei file .

InputItemFunctionCallOutputItemParam

Output di una chiamata dello strumento di funzione.

InputItemFunctionShellCallItemParam

Uno strumento che rappresenta una richiesta per eseguire uno o più comandi shell.

InputItemFunctionShellCallOutputItemParam

Gli elementi di output in streaming emessi da uno strumento shell chiamano.

InputItemFunctionToolCall

Chiamata di uno strumento per eseguire una funzione. Per altre informazioni, vedere la guida alla chiamata di funzione .

InputItemImageGenToolCall

Richiesta di generazione di immagini effettuata dal modello.

InputItemLocalShellToolCall

Chiamata allo strumento per eseguire un comando nella shell locale.

InputItemLocalShellToolCallOutput

Output di una chiamata allo strumento shell locale.

InputItemMcpApprovalRequest

Richiesta di approvazione umana di una chiamata a uno strumento.

InputItemMcpApprovalResponse

Risposta a una richiesta di approvazione MCP.

InputItemMcpListTools

Elenco di strumenti disponibili in un server MCP.

InputItemMcpToolCall

Chiamata di uno strumento in un server MCP.

InputItemOutputMessage

Messaggio di output del modello.

InputItemReasoningItem

Descrizione della catena di pensiero usata da un modello di ragionamento durante la generazione di una risposta. Assicurati di includere questi elementi nell'API input Risposte per i turni successivi di una conversazione se gestisci manualmente il contesto.

InputItemWebSearchToolCall

I risultati di una chiamata a uno strumento di ricerca Web. Per ulteriori informazioni, consulta la guida alla ricerca sul Web .

InputTextContentParam

Input di testo per il modello.

Insight

Corpo della risposta per le informazioni dettagliate del cluster.

InsightCluster

Un cluster di campioni di analisi.

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.

ItemReferenceParam

Identificatore interno di un elemento a cui fare riferimento.

KeyPressAction

Una raccolta di pressioni di tasti che il modello desidera eseguire.

LocalShellExecAction

Eseguire un comando della shell nel server.

LocalShellToolParam

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

LogProb

Probabilità di log di un token.

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

ManagedAzureAISearchIndex

Definizione dell'indice di ricerca di Azure per intelligenza artificiale gestita

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.

MicrosoftFabricPreviewTool

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

ModelDeployment

Definizione della distribuzione del modello

ModelDeploymentSku

Informazioni sullo SKU

ModelSamplingParams

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

MonthlyRecurrenceSchedule

Pianificazione della ricorrenza mensile.

Move

Azione di spostamento del mouse.

NoAuthenticationCredentials

Credenziali che non richiedono l'autenticazione

OneTimeTrigger

Attivazione una tantum.

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 al progetto 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.

OutputMessageContent

interfaccia modello OutputMessageContent

OutputMessageContentOutputTextContent

Output di testo del modello.

OutputMessageContentRefusalContent

Rifiuto da parte del modello.

PageSettings

Opzioni per il metodo byPage

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

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

ProtocolVersionRecord

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

RaiConfig

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

RankingOptions

interfaccia modello Opzioni di classificazione

Reasoning

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

ReasoningTextContent

Testo di ragionamento dal modello.

RecurrenceSchedule

Modello di pianificazione delle ricorrenze.

RecurrenceTrigger

Trigger basato sulla ricorrenza.

RedTeam

Dettagli della squadra rossa.

ResponseUsageInputTokensDetails

interfaccia modello RispostaUtilizzoInputTokenDettagli

ResponseUsageOutputTokensDetails

interfaccia modello RispostaUtilizzoTokenOutputDettagli

RestorePollerOptions
SASTokenCredentials

Definizione delle credenziali di firma di accesso condiviso

SasCredential

Definizione delle credenziali di firma di accesso condiviso

Schedule

Modello di pianificazione.

ScheduleRun

Pianificare il modello di esecuzione.

ScheduleTask

Modello di attività di pianificazione.

Screenshot

Azione screenshot.

Scroll

Azione di scorrimento.

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.

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.

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.

Summary

Un testo riassuntivo dal modello.

Target

Classe base per bersagli con supporto per discriminatore.

TargetConfig

Classe astratta per la configurazione del target.

TaxonomyCategory

Definizione della categoria di tassonomia.

TaxonomySubCategory

Definizione della sottocategoria della tassonomia.

TelemetryOperations

Interfaccia che rappresenta le operazioni di telemetria

TextResponseFormatConfiguration

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.

TextResponseFormatConfigurationResponseFormatJsonObject

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.

TextResponseFormatConfigurationResponseFormatText

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

TextResponseFormatJsonSchema

Formato di risposta dello schema JSON. Usato per generare risposte JSON strutturate. Altre informazioni sugli output strutturati.

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. Altre informazioni sugli strumenti predefiniti.

ToolChoiceComputerUsePreview

Indica che il modello deve usare uno strumento predefinito per generare una risposta. Altre informazioni sugli strumenti predefiniti.

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. Altre informazioni sugli strumenti predefiniti.

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. Altre informazioni sugli strumenti predefiniti.

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. Altre informazioni sugli strumenti predefiniti.

ToolChoiceWebSearchPreview20250311

Indica che il modello deve usare uno strumento predefinito per generare una risposta. Altre informazioni sugli strumenti predefiniti.

ToolDescription

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

ToolProjectConnection

Una risorsa di connessione al progetto.

TopLogProb

Probabilità di log superiore di un token.

Trigger

Modello base per il Trigger del programma.

Type

Azione per digitare del testo.

UrlCitationBody

Citazione per una risorsa Web usata per generare una risposta del modello.

UserProfileMemoryItem

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

VectorStoreFileAttributes

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, valori booleani o numeri.

Wait

Azione di attesa.

WebSearchActionFind

Tipo di azione "find": cerca un criterio all'interno di una pagina caricata.

WebSearchActionOpenPage

Tipo di azione "open_page" - Apre un URL specifico dai risultati della ricerca.

WebSearchActionSearch

Tipo di azione "search" - Esegue una query di ricerca Web.

WebSearchActionSearchSources

interfaccia del modello WebSearchActionSearchSources

WebSearchApproximateLocation

La posizione approssimativa dell'utente.

WebSearchConfiguration

Una configurazione di ricerca web per la ricerca personalizzata di Bing

WebSearchPreviewTool

Questo strumento cerca sul web risultati rilevanti da utilizzare in una risposta. Scopri di più sullo strumento di ricerca web.

WebSearchTool

Cerca su Internet fonti relative al prompt. Scopri di più sullo strumento di ricerca web.

WebSearchToolFilters

interfaccia modello WebSearchToolFilters

WeeklyRecurrenceSchedule

Pianificazione della ricorrenza settimanale.

WorkflowAgentDefinition

Definizione dell'agente del flusso di lavoro.

Alias tipo

AgentDefinitionUnion

Tipo di unione per tutti i tipi di definizione dell'agente. Supporta il flusso di lavoro, l'hosted, l'app contenitore e gli agenti di prompt.

AgentKind

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

AgentProtocol

Tipo di AgentProtocol

AgentType

Tipo di agentType

AnnotationType

Tipo di AnnotationType

AnnotationUnion

Alias per AnnotationUnion

ApplyPatchCallOutputStatusParam

Valori di risultato riportati per apply_patch output delle chiamate dello strumento.

ApplyPatchCallStatusParam

Valori di stato riportati per apply_patch chiamate di strumento.

ApplyPatchOperationParamType

Tipo di ApplyPatchOperationParamType

ApplyPatchOperationParamUnion

Alias per ApplyPatchOperationParamUnion

AttackStrategy

Strategie per gli attacchi.

AzureAISearchQueryType

Tipi di query disponibili per lo strumento di ricerca di intelligenza artificiale di Azure.

BaseCredentialsUnion

Alias per BaseCredentialsUnion

ClickButtonType

Tipo di ClickButtonType

ComparisonFilterValueItems

Alias per ComparisonFilterValueItems

ComputerActionType

Tipo di computerActionType

ComputerActionUnion

Alias per ComputerActionUnion

ComputerEnvironment

Tipo di Ambiente ComputerT

ConnectionType

Tipo (o categoria) della connessione

ContainerMemoryLimit

Tipo di ContainerMemoryLimit

ContinuablePage

Interfaccia che descrive una pagina di risultati.

CredentialType

Tipo di credenziale utilizzato dalla connessione

CustomToolParamFormatType

Tipo di CustomToolParamFormatType

CustomToolParamFormatUnion

Alias for CustomToolParamFormatUnion

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

DetailEnum

Tipo di DetailEnum

EvaluationRuleActionType

Tipo di azione di valutazione.

EvaluationRuleActionUnion

Alias per la valutazioneRegolaAzioneUnione

EvaluationRuleEventType

Tipo di evento della regola di valutazione.

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

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

Filters

Alias per filtri

FoundryFeaturesOptInKeys

Tipo di FoundryCaratteristiche OptInKeys

FunctionAndCustomToolCallOutputType

Tipo di FunzioneEToolChiamataTipoOutputT

FunctionAndCustomToolCallOutputUnion

Alias per FunctionandCustomToolCallOutputUnion

FunctionCallItemStatus

Tipo di FunzioneChiamataStatoElemento

FunctionShellCallItemStatus

Valori di stato riportati per le chiamate agli strumenti shell.

FunctionShellCallOutputOutcomeParamType

Tipo di FunzioneShellChiamataOutputOutcomeParamType

FunctionShellCallOutputOutcomeParamUnion

Alias per FunctionShellCallOutputOutcomeParamUnion

GrammarSyntax1

Tipo di GrammarSyntax1

ImageDetail

Tipo di ImageDetail

IndexType

Tipo di IndexType

IndexUnion

Alias per IndexUnion

InputContentType

Tipo di InputContentType

InputContentUnion

Alias per InputContentUnion

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. Non supportato per gpt-image-1-mini. Supporta high e low. Il valore predefinito è low.

InputItemType

Tipo di InputItemType

InputItemUnion

Alias per InputItemUnion

InsightRequestUnion

Alias per InsightRequestUnion

InsightResultUnion

Alias per InsightResultUnion

InsightSampleUnion

Alias per InsightSampleUnion

InsightType

La richiesta degli approfondimenti.

MCPToolCallStatus

Tipo di MCPToolCallStatus

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.

OpenApiAuthDetailsUnion

Alias per OpenApiAuthDetailsUnion

OpenApiAuthType

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

  • Anonimo (non è richiesta l'autenticazione)
  • Project Connection (richiede project_connection_id all'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.

OutputMessageContentType

Tipo di OutputMessageContentType

OutputMessageContentUnion

Alias per OutputMessageContentUnion

PageOrder

Tipo di Ordine di Pagina

PendingUploadType

Il tipo di caricamento in sospeso.

RankerVersionType

Tipo di RankerVersionType

ReasoningEffort

Vincola lo sforzo sul ragionamento per i 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.
RecurrenceScheduleUnion

Alias per RecurrenceScheduleUnion

RecurrenceType

Tipo di ricorrenza.

RiskCategory

Categoria di rischio per l'obiettivo dell'attacco.

SampleType

Il tipo di campione utilizzato nell'analisi.

ScheduleProvisioningStatus

Pianificare lo stato del provisioning.

ScheduleTaskType

Tipo dell'attività.

ScheduleTaskUnion

Alias per ScheduleTaskUnion

SearchContextSize

Tipo di RicercaContestoDimensione

TargetConfigUnion

Alias per TargetConfigUnion

TargetUnion

Alias per TargetUnion

TextResponseFormatConfigurationType

Tipo di TestoRispostaFormatoConfigurazioneTipo

TextResponseFormatConfigurationUnion

Alias per TextResponseFormatConfigurationUnion

ToolChoiceParamType

Tipo di ToolChoiceParamType

ToolChoiceParamUnion

Alias per ToolChoiceParamUnion

ToolType

Tipo di Tipo di Strumento

ToolUnion

Alias per ToolUnion

TreatmentEffectType

Tipo di effetto del trattamento.

TriggerType

Tipo di trigger.

TriggerUnion

Alias per TriggerUnion

Enumerazioni

KnownApiVersions

Versioni dell'API Microsoft Foundry

Funzioni

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

Crea un poller dallo stato serializzato di un altro poller. Questo può essere utile quando si desidera creare poller in un host diverso o un poller deve essere costruito dopo che quello originale non è nell'ambito.

Dettagli funzione

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

Crea un poller dallo stato serializzato di un altro poller. Questo può essere utile quando si desidera creare poller in un host diverso o un poller deve essere costruito dopo che quello originale non è nell'ambito.

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

Parametri

serializedState

string

sourceOperation

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

Restituisce

PollerLike<OperationState<TResult>, TResult>