Condividi tramite


@azure/ai-agents package

Classi

AgentsClient
ToolSet

Rappresenta un set di strumenti con le relative definizioni e risorse.

ToolUtility

Classe di utilità per la creazione di vari strumenti.

Interfacce

AISearchIndexResource

Una risorsa dell'indice di ricerca AI.

Agent

Rappresenta un agente che può chiamare il modello e usare gli strumenti.

AgentDeletionStatus

Stato di un'operazione di eliminazione dell'agente.

AgentErrorDetail

Descrive le informazioni sull'errore restituite dall'API degli agenti.

AgentEventMessage

Ogni evento in un flusso di eventi inviati dal server ha una proprietà event e data: * *

Esempio

  • evento: thread.created
  • dati: {"id": "thread_123", "object": "thread", ...}
  • Vengono generati eventi ogni volta che viene creato un nuovo oggetto, passa a un nuovo stato o viene
  • trasmessi in parti (delta). Ad esempio, viene generato thread.run.created quando viene eseguita una nuova esecuzione
  • viene creato, thread.run.completed al termine di un'esecuzione e così via. Quando un agente sceglie
  • per creare un messaggio durante un'esecuzione, viene generato un thread.message.created event,
  • thread.message.in_progress evento, molti eventi thread.message.delta e infine un
  • thread.message.completed evento.
  • È possibile aggiungere altri eventi nel tempo, pertanto è consigliabile gestire correttamente gli eventi sconosciuti
  • nel codice.
AgentEventMessageStream

Rappresenta un flusso di messaggi di evento dell'agente.

AgentThread

Informazioni su un singolo thread associato a un agente.

AgentThreadCreationOptions

Dettagli usati per creare un nuovo thread dell'agente.

AgentV1Error

Payload di errore restituito dall'API degli agenti.

AgentsClientOptionalParams

Parametri facoltativi per il client.

AgentsNamedToolChoice

Specifica uno strumento che il modello deve usare. Usare per costringere il modello a chiamare uno strumento specifico.

AgentsResponseFormat

Oggetto che descrive l'output previsto del modello. Se json_object solo function tipo tools possono essere passati all'esecuzione. Se text il modello può restituire testo o qualsiasi valore necessario.

AzureAISearchToolDefinition

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.

AzureFunctionToolDefinition

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

BingGroundingSearchConfiguration

Configurazione di ricerca per l'incaglio di Bing

BingGroundingSearchToolParameters

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

BingGroundingToolDefinition

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

CodeInterpreterToolDefinition

Informazioni sulla definizione di input per uno strumento dell'interprete di codice usato per configurare un agente.

CodeInterpreterToolResource

Set di risorse usate dallo strumento code_interpreter.

ConnectedAgentDetails

Informazioni per collegare un agente a un altro come strumento

ConnectedAgentToolDefinition

Informazioni di definizione di input per uno strumento agente connesso che definisce un subagente specifico del dominio

CreateAgentOptionalParams

Parametri facoltativi.

CreateThreadAndRunOptionalParams

Parametri facoltativi.

DeleteAgentOptionalParams

Parametri facoltativi.

FileDeletionStatus

Risposta di stato da un'operazione di eliminazione di file.

FileInfo

Rappresenta un agente che può chiamare il modello e usare gli strumenti.

FileListResponse

Dati di risposta da un'operazione di elenco di file.

FileSearchRankingOptions

Opzioni di classificazione per la ricerca di file.

FileSearchToolCallContent

Oggetto contenuto dei risultati della ricerca file.

FileSearchToolDefinition

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

FileSearchToolDefinitionDetails

Le opzioni sostituiscono lo strumento di ricerca file.

FileSearchToolResource

Set di risorse usate dallo strumento file_search.

FilesDeleteFileOptionalParams

Parametri facoltativi.

FilesGetFileContentOptionalParams

Parametri facoltativi.

FilesGetFileOptionalParams

Parametri facoltativi.

FilesListFilesOptionalParams

Parametri facoltativi.

FilesOperations

Interfaccia che rappresenta un'operazione Files.

FilesUploadFileOptionalParams

Parametri facoltativi.

FunctionDefinition

Informazioni sulla definizione di input per una funzione.

FunctionName

Nome della funzione che verrà usato, se si usa lo strumento di function

FunctionToolDefinition

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

GetAgentOptionalParams

Parametri facoltativi.

IncompleteRunDetails

Dettagli sul motivo per cui l'esecuzione è incompleta. Se l'esecuzione non è incompleta, verrà null.

ListAgentsOptionalParams

Parametri facoltativi.

MessageAttachment

Viene descritto a quali strumenti è stato allegato un file.

MessageContent

Rappresentazione astratta di un singolo elemento del contenuto del messaggio del thread.

MessageDelta

Rappresenta il payload 'delta' tipizzato all'interno di un blocco delta del messaggio di streaming.

MessageDeltaChunk

Rappresenta un delta del messaggio, ad esempio i campi modificati in un messaggio durante lo streaming.

MessageDeltaContent

Rappresentazione di base astratta di un payload di contenuto del messaggio con flusso parziale.

MessageDeltaImageFileContent

Rappresenta una parte del contenuto del file di immagine in streaming all'interno di un blocco delta del messaggio di streaming.

MessageDeltaImageFileContentObject

Rappresenta il payload "image_file" all'interno del contenuto del file di immagine di streaming.

MessageDeltaTextAnnotation

Rappresentazione di base astratta di un'annotazione di testo di una parte di contenuto di testo trasmessa.

MessageDeltaTextContent

Rappresenta una parte del contenuto di testo trasmesso all'interno di un blocco delta del messaggio di streaming.

MessageDeltaTextContentObject

Rappresenta i dati di una parte contenuto di testo trasmesso all'interno di un blocco delta del messaggio di streaming.

MessageDeltaTextFileCitationAnnotation

Rappresenta una citazione di file in streaming applicata a una parte del contenuto di testo in streaming.

MessageDeltaTextFileCitationAnnotationObject

Rappresenta i dati di una citazione di file trasmessi applicata a una parte del contenuto di testo in streaming.

MessageDeltaTextFilePathAnnotation

Rappresenta un'annotazione del percorso del file trasmessa applicata a una parte del contenuto di testo in streaming.

MessageDeltaTextFilePathAnnotationObject

Rappresenta i dati di un'annotazione del percorso di file trasmesso applicata a una parte del contenuto di testo in streaming.

MessageDeltaTextUrlCitationAnnotation

Una citazione all'interno del messaggio che punta a un URL specifico associato al messaggio. Generato quando l'agente utilizza strumenti come "bing_grounding" per effettuare ricerche in Internet.

MessageDeltaTextUrlCitationDetails

Rappresentazione di una citazione URL, utilizzata nel contenuto dei messaggi di thread di testo.

MessageImageFileContent

Rappresentazione del contenuto del file di immagine in un messaggio di thread.

MessageImageFileDetails

Riferimento all'immagine, come rappresentato nel contenuto del messaggio del thread.

MessageImageFileParam

Definisce il modo in cui viene fatto riferimento a un file immagine caricato internamente durante la creazione di un blocco di file immagine.

MessageImageUrlParam

Definisce il modo in cui viene fatto riferimento all'URL di un'immagine esterna durante la creazione di un blocco URL immagine.

MessageIncompleteDetails

Informazioni che forniscono dettagli aggiuntivi su un messaggio che immette uno stato incompleto.

MessageInputContentBlock

Definisce un singolo blocco di contenuto durante la creazione di un messaggio. Il campo 'type' determina se si tratta di testo, di un file di immagine o di un URL di immagine esterno e così via.

MessageInputImageFileBlock

Un blocco di file immagine in un nuovo messaggio, che fa riferimento a un'immagine caricata internamente in base all'ID file.

MessageInputImageUrlBlock

Un blocco dell'URL di un'immagine in un nuovo messaggio, che fa riferimento a un'immagine esterna tramite URL.

MessageInputTextBlock

Blocco di testo in un nuovo messaggio, contenente contenuto di testo normale.

MessageTextAnnotation

Rappresentazione astratta di un'annotazione al contenuto del messaggio di thread di testo.

MessageTextContent

Rappresentazione di un elemento testuale del contenuto del messaggio del thread.

MessageTextDetails

Testo e annotazioni associate per un singolo elemento del contenuto del messaggio del thread dell'agente.

MessageTextFileCitationAnnotation

Citazione all'interno del messaggio che punta a una citazione specifica da un file specifico associato all'agente o al messaggio. Generato quando l'agente usa lo strumento "file_search" per cercare i file.

MessageTextFileCitationDetails

Rappresentazione di una citazione di testo basata su file, utilizzata in un'annotazione basata su file del contenuto del messaggio di thread di testo.

MessageTextFilePathAnnotation

Citazione all'interno del messaggio che punta a un file che si trova in un percorso specifico.

MessageTextFilePathDetails

Incapsulamento di un ID file di immagine, usato dal contenuto dell'immagine del messaggio.

MessageTextUrlCitationAnnotation

Una citazione all'interno del messaggio che punta a un URL specifico associato al messaggio. Generato quando l'agente utilizza strumenti come "bing_grounding" per effettuare ricerche in Internet.

MessageTextUrlCitationDetails

Rappresentazione di una citazione URL, utilizzata nel contenuto dei messaggi di thread di testo.

MessagesCreateMessageOptionalParams

Parametri facoltativi.

MessagesGetMessageOptionalParams

Parametri facoltativi.

MessagesListMessagesOptionalParams

Parametri facoltativi.

MessagesOperations

Interfaccia che rappresenta un'operazione Messaggi.

MessagesUpdateMessageOptionalParams

Parametri facoltativi.

OpenApiAnonymousAuthDetails

Dettagli di sicurezza per l'autenticazione anonima OpenApi

OpenApiAuthDetails

dettagli di autenticazione per OpenApiFunctionDefinition

OpenApiConnectionAuthDetails

Dettagli di sicurezza per l'autenticazione della connessione OpenApi

OpenApiConnectionSecurityScheme

Schema di sicurezza per l'autenticazione managed_identity OpenApi

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

OpenApiToolDefinition

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

PageSettings

Opzioni per il metodo byPage

PagedAsyncIterableIterator

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

PollingOptions

Opzioni per la configurazione del comportamento di polling.

PollingOptionsParams

Parametri facoltativi che configurano il comportamento di polling.

RequiredAction

Rappresentazione astratta di un'azione necessaria per l'esecuzione di un thread dell'agente.

RequiredFunctionToolCall

Rappresentazione di una chiamata richiesta a uno strumento di funzione, necessaria dal modello per continuare la valutazione di un'esecuzione.

RequiredFunctionToolCallDetails

Informazioni dettagliate per una chiamata di funzione, come fornito da un'azione richiesta che richiama uno strumento funzione, che include il nome di e gli argomenti alla funzione.

RequiredToolCall

Rappresentazione astratta di una chiamata dello strumento necessaria al modello per continuare un'esecuzione.

ResponseFormatJsonSchema

Descrizione del formato di risposta, utilizzato dal modello per determinare come rispondere.

ResponseFormatJsonSchemaType

Tipo di formato di risposta definito: json_schema

RunCompletionUsage

Statistiche di utilizzo relative all’esecuzione. Questo valore verrà null se l'esecuzione non si trova in uno stato terminale ,ad esempio in_progress, queuede così via.

RunError

I dettagli di un errore rilevato da un thread dell'agente vengono eseguiti.

RunStep

Informazioni dettagliate su un singolo passaggio di esecuzione di un thread dell'agente.

RunStepAzureAISearchToolCall

Record di una chiamata a uno strumento di Ricerca di intelligenza artificiale di Azure, rilasciato dal modello per la valutazione di uno strumento definito, che rappresenta la ricerca di Intelligenza artificiale di Azure eseguita.

RunStepBingGroundingToolCall

Record di una chiamata a uno strumento di base Bing, rilasciato dal modello per la valutazione di uno strumento definito, che rappresenta la ricerca eseguita con il suolo Bing.

RunStepCodeInterpreterImageOutput

Rappresentazione di un output di immagine generato da uno strumento dell'interprete di codice in risposta a una chiamata dello strumento da parte del modello.

RunStepCodeInterpreterImageReference

Riferimento all'immagine generato da uno strumento dell'interprete di codice in risposta a una chiamata dello strumento dal modello.

RunStepCodeInterpreterLogOutput

Rappresentazione di un output del log generato da uno strumento di interprete del codice in risposta a una chiamata dello strumento da parte del modello.

RunStepCodeInterpreterToolCall

Record di una chiamata a uno strumento dell'interprete di codice, rilasciato dal modello per la valutazione di uno strumento definito, che rappresenta gli input e gli output utilizzati e generati dall'interprete di codice.

RunStepCodeInterpreterToolCallDetails

Informazioni dettagliate su una chiamata dell'interprete di codice da parte del modello.

RunStepCodeInterpreterToolCallOutput

Rappresentazione astratta di un output generato da uno strumento dell'interprete di codice.

RunStepCompletionUsage

Statistiche di utilizzo relative al passaggio dell’esecuzione.

RunStepDelta

Rappresenta il payload differenziale in un blocco delta del passaggio di esecuzione del flusso.

RunStepDeltaChunk

Rappresenta un delta del messaggio, ad esempio i campi modificati in un passaggio dell’esecuzione durante lo streaming.

RunStepDeltaCodeInterpreterDetailItemObject

Rappresenta i dati delle chiamate dello strumento Interprete di codice nelle chiamate degli strumenti di un passaggio di esecuzione di streaming.

RunStepDeltaCodeInterpreterImageOutput

Rappresenta un output di immagine come prodotto dallo strumento Dell'interprete del codice e come rappresentato nella raccolta di chiamate allo strumento delta di un passaggio di esecuzione di streaming.

RunStepDeltaCodeInterpreterImageOutputObject

Rappresenta i dati per l'output dell'immagine di chiamata dell'immagine dello strumento Code Interpreter di un passaggio di streaming.

RunStepDeltaCodeInterpreterLogOutput

Rappresenta un output del log prodotto dallo strumento Interprete di codice e come rappresentato nella raccolta di chiamate delta di un passaggio di esecuzione di streaming.

RunStepDeltaCodeInterpreterOutput

Rappresentazione di base astratta di un output dello strumento di esecuzione del flusso dell'interprete del codice.

RunStepDeltaCodeInterpreterToolCall

Rappresenta una chiamata dello strumento Interprete di codice all'interno dei dettagli delle chiamate dello strumento del passaggio di esecuzione di streaming.

RunStepDeltaDetail

Rappresenta un singolo elemento di dettaglio del passaggio di esecuzione nel payload differenziale di un passaggio di esecuzione di streaming.

RunStepDeltaFileSearchToolCall

Rappresenta una chiamata dello strumento di ricerca file all'interno dei dettagli delle chiamate dello strumento del passaggio di esecuzione di streaming.

RunStepDeltaFunction

Rappresenta i dati della funzione in una chiamata allo strumento funzione del delta del passaggio di esecuzione del flusso.

RunStepDeltaFunctionToolCall

Rappresenta una chiamata dello strumento di funzione all'interno dei dettagli delle chiamate dello strumento di un passaggio di esecuzione di streaming.

RunStepDeltaMessageCreation

Rappresenta una creazione di messaggi all'interno di un delta del passaggio di esecuzione del flusso.

RunStepDeltaMessageCreationObject

Rappresenta i dati all'interno di un oggetto risposta di creazione del messaggio del passaggio di esecuzione del flusso.

RunStepDeltaToolCall

Rappresentazione di base astratta di una singola chiamata allo strumento all'interno dei dettagli delle chiamate delta di un passaggio di esecuzione di streaming.

RunStepDeltaToolCallObject

Rappresenta una chiamata delle chiamate degli strumenti come parte di un passaggio di esecuzione del flusso.

RunStepDetails

Rappresentazione astratta dei dettagli per un passaggio di esecuzione.

RunStepError

Informazioni sull'errore associate a un passaggio di esecuzione non riuscito.

RunStepFileSearchToolCall

Record di una chiamata a uno strumento di ricerca di file, rilasciato dal modello per la valutazione di uno strumento definito, che rappresenta la ricerca di file eseguita.

RunStepFileSearchToolCallResult

Risultato della chiamata dello strumento di ricerca file.

RunStepFileSearchToolCallResults

Risultati della ricerca file.

RunStepFunctionToolCall

Record di una chiamata a uno strumento di funzione, rilasciato dal modello nella valutazione di uno strumento definito, che rappresenta gli input e l'output utilizzati e generati dalla funzione specificata.

RunStepFunctionToolCallDetails

Informazioni dettagliate sulla funzione chiamata dal modello.

RunStepMessageCreationDetails

Informazioni dettagliate associate a un passaggio di esecuzione della creazione di messaggi.

RunStepMessageCreationReference

Dettagli di un messaggio creato come parte di un passaggio di esecuzione.

RunStepOpenAPIToolCall

Record di una chiamata a uno strumento OpenAPI, emessa dal modello nella valutazione di uno strumento definito, che rappresenta le operazioni OpenAPI eseguite.

RunStepToolCall

Rappresentazione astratta di una chiamata dettagliata dello strumento registrata all'interno di un passaggio di esecuzione per un'esecuzione esistente.

RunStepToolCallDetails

Informazioni dettagliate associate agli strumenti di chiamata di un passaggio di esecuzione.

RunStepsGetRunStepOptionalParams

Parametri facoltativi.

RunStepsListRunStepsOptionalParams

Parametri facoltativi.

RunStepsOperations

Interfaccia che rappresenta un'operazione RunSteps.

RunsCancelRunOptionalParams

Parametri facoltativi.

RunsCreateRunOptionalParams

Parametri facoltativi.

RunsGetRunOptionalParams

Parametri facoltativi.

RunsListRunsOptionalParams

Parametri facoltativi.

RunsOperations

Interfaccia che rappresenta un'operazione di esecuzione.

RunsSubmitToolOutputsToRunOptionalParams

Parametri facoltativi.

RunsUpdateRunOptionalParams

Parametri facoltativi.

SubmitToolOutputsAction

Dettagli per le chiamate di strumenti necessarie che devono essere inviate per l'esecuzione di un thread dell'agente per continuare.

SubmitToolOutputsDetails

Dettagli che descrivono gli strumenti che devono essere chiamati per inviare gli output degli strumenti.

ThreadDeletionStatus

Stato di un'operazione di eliminazione del thread.

ThreadMessage

Singolo messaggio esistente all'interno di un thread dell'agente.

ThreadMessageOptions

Un singolo messaggio all'interno di un thread dell'agente, come specificato durante la creazione del thread per il relativo stato iniziale.

ThreadRun

Dati che rappresentano una singola esecuzione di valutazione di un thread dell'agente.

ThreadsCreateThreadOptionalParams

Parametri facoltativi.

ThreadsDeleteThreadOptionalParams

Parametri facoltativi.

ThreadsGetThreadOptionalParams

Parametri facoltativi.

ThreadsListThreadsOptionalParams

Parametri facoltativi.

ThreadsOperations

Interfaccia che rappresenta un'operazione Threads.

ThreadsUpdateThreadOptionalParams

Parametri facoltativi.

ToolDefinition

Rappresentazione astratta di una definizione di uno strumento di input che un agente può usare.

ToolOutput

I dati forniti durante l'invio di uno strumento vengono inviati per risolvere le chiamate degli strumenti in sospeso e consentire al modello di continuare.

ToolResources

Set di risorse usate dagli strumenti dell'agente. Le risorse sono specifiche del tipo di strumento. Ad esempio, lo strumento code_interpreter richiede un elenco di ID di file, mentre lo strumento file_search richiede un elenco di ID archivio vettoriali.

TruncationObject

Controlla come un thread verrà troncato prima dell'esecuzione. Usare questa opzione per controllare la finestra di contesto iniziale dell'esecuzione.

UpdateAgentOptionalParams

Parametri facoltativi.

VectorStore

Un archivio vettoriale è una raccolta di file elaborati che può essere usato dallo strumento file_search.

VectorStoreAutoChunkingStrategyRequest

Strategia predefinita. Questa strategia usa attualmente un max_chunk_size_tokens di 800 e chunk_overlap_tokens di 400.

VectorStoreAutoChunkingStrategyResponse

Viene restituito quando la strategia di suddivisione in blocchi è sconosciuta. In genere, ciò è dovuto al fatto che il file è stato indicizzato prima dell'introduzione del concetto di chunking_strategy nell'API.

VectorStoreChunkingStrategyRequest

Rappresentazione astratta di una configurazione della strategia di suddivisione in blocchi dell'archivio vettoriale.

VectorStoreChunkingStrategyResponse

Rappresentazione astratta di una configurazione della strategia di suddivisione in blocchi dell'archivio vettoriale.

VectorStoreConfiguration

La configurazione dell'archiviazione vettoriale è l'elenco delle origini dati, usate quando è possibile usare più file per la ricerca di file aziendali.

VectorStoreConfigurations

Struttura contenente l'elenco delle configurazioni di archiviazione vettoriali, ad esempio l'elenco di ID asset di Azure.

VectorStoreDataSource

Struttura contenente il percorso dell'URI dell'asset di Azure e il tipo di asset del file usato come origine dati per la ricerca di file dell'organizzazione.

VectorStoreDeletionStatus

Oggetto risposta per l'eliminazione di un archivio vettoriale.

VectorStoreExpirationPolicy

I criteri di scadenza per un archivio vettoriale.

VectorStoreFile

Descrizione di un file collegato a un archivio vettoriale.

VectorStoreFileBatch

Una batch di file collegati a un archivio vettoriale.

VectorStoreFileBatchesCancelVectorStoreFileBatchOptionalParams

Parametri facoltativi.

VectorStoreFileBatchesCreateVectorStoreFileBatchOptionalParams

Parametri facoltativi.

VectorStoreFileBatchesGetVectorStoreFileBatchOptionalParams

Parametri facoltativi.

VectorStoreFileBatchesListVectorStoreFileBatchFilesOptionalParams

Parametri facoltativi.

VectorStoreFileBatchesOperations

Interfaccia che rappresenta un'operazione VectorStoreFileBatches.

VectorStoreFileCount

Conteggi dei file elaborati o elaborati da questo archivio vettoriale raggruppato per stato.

VectorStoreFileDeletionStatus

Oggetto risposta per l'eliminazione di una relazione di file dell'archivio vettoriale.

VectorStoreFileError

Dettagli sull'errore che potrebbe essersi verificato durante l'elaborazione di un file per questo archivio vettoriale

VectorStoreFilesCreateVectorStoreFileOptionalParams

Parametri facoltativi.

VectorStoreFilesDeleteVectorStoreFileOptionalParams

Parametri facoltativi.

VectorStoreFilesGetVectorStoreFileOptionalParams

Parametri facoltativi.

VectorStoreFilesListVectorStoreFilesOptionalParams

Parametri facoltativi.

VectorStoreFilesOperations

Interfaccia che rappresenta un'operazione VectorStoreFiles.

VectorStoreStaticChunkingStrategyOptions

Opzioni per configurare una strategia di suddivisione in blocchi statici dell'archivio vettoriale.

VectorStoreStaticChunkingStrategyRequest

Strategia di suddivisione in blocchi configurata in modo statico.

VectorStoreStaticChunkingStrategyResponse

Strategia di suddivisione in blocchi configurata in modo statico.

VectorStoresCreateVectorStoreOptionalParams

Parametri facoltativi.

VectorStoresDeleteVectorStoreOptionalParams

Parametri facoltativi.

VectorStoresGetVectorStoreOptionalParams

Parametri facoltativi.

VectorStoresListVectorStoresOptionalParams

Parametri facoltativi.

VectorStoresModifyVectorStoreOptionalParams

Parametri facoltativi.

VectorStoresOperations

Interfaccia che rappresenta un'operazione VectorStores.

Alias tipo

AgentEventStreamData

Rappresenta i dati di un evento di flusso nell'agente.

AgentRunResponse

Agent esegue la risposta con supporto per lo streaming.

AgentStreamEvent

Alias per AgentStreamEvent

AgentsNamedToolChoiceType

Tipi di strumenti disponibili per gli agenti denominati tools.

AgentsResponseFormatMode

Rappresenta la modalità in cui il modello gestirà il formato restituito di una chiamata utensile.

AgentsResponseFormatOption

Alias per AgentsResponseFormatOption

AgentsToolChoiceOption

Alias per AgentsToolChoiceOption

AgentsToolChoiceOptionMode

Specifica la modalità di utilizzo dell'utensile scelto

AzureAISearchQueryType

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

ContinuablePage

Interfaccia che descrive una pagina di risultati.

FileContents

Valori validi per il contenuto di un file binario.

FilePurpose

I valori possibili che indicano l'utilizzo previsto di un file.

FileState

Stato del file.

ImageDetailLevel

Specifica il livello di dettaglio di un'immagine. Può essere "auto", "basso", "alto" o un valore futuro sconosciuto.

IncompleteDetailsReason

Motivo per cui l'esecuzione è incompleta. Farà riferimento al limite di token specifico raggiunto nel corso dell'esecuzione.

ListSortOrder

Le opzioni di ordinamento disponibili quando si richiede un elenco di oggetti di risposta.

MessageAttachmentToolDefinition

Alias per MessageAttachmentToolDefinition

MessageBlockType

Specifica il tipo di blocco di contenuto all'interno di un messaggio. Potrebbe essere un testo, un file immagine, un URL di immagine esterno o un tipo futuro sconosciuto.

MessageContentUnion

Alias per MessageContentUnion

MessageDeltaContentUnion

Alias per MessageDeltaContentUnion

MessageDeltaTextAnnotationUnion

Alias per MessageDeltaTextAnnotationUnion

MessageIncompleteDetailsReason

Insieme di motivi che descrivono il motivo per cui un messaggio viene contrassegnato come incompleto.

MessageInputContent

Alias per MessageInputContent

MessageInputContentBlockUnion

Alias per MessageInputContentBlockUnion

MessageRole

I valori possibili per i ruoli attribuiti ai messaggi in un thread.

MessageStatus

I valori possibili dello stato di esecuzione per un messaggio di thread.

MessageTextAnnotationUnion

Alias per MessageTextAnnotationUnion

OpenApiAuthDetailsUnion

Alias per OpenApiAuthDetailsUnion

OpenApiAuthType

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

  • Anonimo (non è richiesta l'autenticazione)
  • Connessione (richiede connection_id all'endpoint, come configurato in AI Foundry)
  • Managed_Identity (richiede un pubblico per l'autenticazione basata sull'identità)
RequiredActionUnion

Alias per RequiredActionUnion

RequiredToolCallUnion

Alias per RequiredToolCallUnion

ResponseFormat

Possibili formati di risposta API.

RunAdditionalFieldList

Elenco di campi aggiuntivi da includere nella risposta.

RunStatus

Valori possibili per lo stato di esecuzione di un thread dell'agente.

RunStepCodeInterpreterToolCallOutputUnion

Alias per RunStepCodeInterpreterToolCallOutputUnion

RunStepDeltaCodeInterpreterOutputUnion

Alias per RunStepDeltaCodeInterpreterOutputUnion

RunStepDeltaDetailUnion

Alias per RunStepDeltaDetailUnion

RunStepDeltaToolCallUnion

Alias per RunStepDeltaToolCallUnion

RunStepDetailsUnion

Alias per RunStepDetailsUnion

RunStepErrorCode

Possibili valori del codice di errore attribuibili a un passaggio di esecuzione non riuscito.

RunStepStatus

Valori possibili per lo stato di un passaggio di esecuzione.

RunStepToolCallUnion

Alias per RunStepToolCallUnion

RunStepType

I possibili tipi di passaggi di esecuzione.

ToolDefinitionUnion

Alias per ToolDefinitionUnion

TruncationStrategy

Possibili strategie di troncamento per il thread.

VectorStoreChunkingStrategyRequestType

Tipo di strategia di suddivisione in blocchi

VectorStoreChunkingStrategyRequestUnion

Alias per VectorStoreChunkingStrategyRequestUnion

VectorStoreChunkingStrategyResponseType

Tipo di strategia di suddivisione in blocchi

VectorStoreChunkingStrategyResponseUnion

Alias per VectorStoreChunkingStrategyResponseUnion

VectorStoreExpirationPolicyAnchor

Descrive la relazione tra i giorni e la scadenza di questo archivio vettoriale

VectorStoreFileBatchStatus

Stato del batch di file dell'archivio vettoriale.

VectorStoreFileErrorCode

Varianti di codice di errore per l'elaborazione dei file dell'archivio vettoriale

VectorStoreFileStatus

Stato del file dell'archivio vettoriale

VectorStoreFileStatusFilter

Filtro dei parametri di query per l'endpoint di recupero dei file dell'archivio vettoriale

VectorStoreStatus

Stato possibile dell'archivio vettoriale

Enumerazioni

DoneEvent

Evento terminale che indica la fine corretta di un flusso.

ErrorEvent

Evento terminale che indica un errore sul lato server durante lo streaming.

KnownVersions

Versioni dell'API degli agenti di intelligenza artificiale di Azure

MessageStreamEvent

Eventi di streaming correlati all'operazione di messaggio

RunStepStreamEvent

Eseguire eventi di streaming correlati all'operazione di passaggio

RunStreamEvent

Eseguire eventi di streaming correlati all'operazione

ThreadStreamEvent

Eventi di streaming correlati alle operazioni di thread

VectorStoreDataSourceAssetType

Tipo di risorsa di archiviazione vettoriale. Il tipo di asset può essere un uri_asset, in questo caso deve contenere l'ID URI dell'asset, nel caso di id_asset deve contenere l'ID dei dati.

connectionToolType

Tipi di strumenti di connessione usati per configurare un agente

Funzioni

isOutputOfType<T>(ToolDefinitionUnion | RequiredAction | RequiredToolCall, string)

Determina se l'output specificato è del tipo specificato.

Dettagli funzione

isOutputOfType<T>(ToolDefinitionUnion | RequiredAction | RequiredToolCall, string)

Determina se l'output specificato è del tipo specificato.

function isOutputOfType<T>(output: ToolDefinitionUnion | RequiredAction | RequiredToolCall, type: string): output

Parametri

output

ToolDefinitionUnion | RequiredAction | RequiredToolCall

Azione da controllare, che può essere di tipo RequiredAction, RequiredToolCallo ToolDefinitionUnion.

type

string

Tipo in cui controllare l'azione.

Restituisce

output

Valore booleano che indica se l'azione è del tipo specificato.