Condividi tramite


@azure/openai-assistants package

Classi

AssistantsClient

Operazioni relative all'assistente alla gestione del cliente.

AzureKeyCredential

Credenziali basate su chiavi statiche che supportano l'aggiornamento del valore della chiave sottostante.

OpenAIKeyCredential

La classe OpenAIKeyCredential rappresenta una chiave API OpenAI e viene utilizzata per l'autenticazione in un client Assistants per un endpoint OpenAI.

Interfacce

Assistant

Rappresenta un assistente in grado di chiamare il modello e utilizzare gli strumenti.

AssistantCreationOptions

I dettagli della richiesta da utilizzare durante la creazione di un nuovo assistente.

AssistantDeletionStatus

Stato di un'operazione di eliminazione dell'assistente.

AssistantFile

Informazioni su un file allegato a un assistente, utilizzato dagli strumenti in grado di leggere i file.

AssistantFileDeletionStatus

Stato di un'operazione di eliminazione di un file dell'assistente.

AssistantThread

Informazioni su un singolo thread associato a un assistente.

AssistantThreadCreationOptions

I dettagli utilizzati per creare un nuovo thread dell'assistente.

AssistantsClientOptions

Dettagli usati per creare un client assistente *

CancelRunOptions

I dettagli utilizzati per annullare un'esecuzione.

CodeInterpreterImageOutput

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.

CodeInterpreterImageReference

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

CodeInterpreterLogOutput

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.

CodeInterpreterToolCall

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.

CodeInterpreterToolCallDetails

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

CodeInterpreterToolDefinition

Informazioni di definizione di input per uno strumento di interpretazione del codice utilizzato per configurare un assistente.

CreateAndRunThreadOptions

I dettagli utilizzati durante la creazione e l'esecuzione immediata di un nuovo thread dell'assistente.

CreateAssistantFileOptions

Dettagli utilizzati per creare un file dell'assistente.

CreateAssistantOptions

I dettagli utilizzati per creare un assistente.

CreateMessageOptions

I dettagli utilizzati per creare un messaggio.

CreateRunOptions

I dettagli utilizzati durante la creazione di una nuova esecuzione di un thread dell'assistente.

CreateRunRequestOptions

Dettagli utilizzati per creare una richiesta di esecuzione.

CreateThreadAndRunOptions

Dettagli utilizzati per creare ed eseguire un thread.

CreateThreadOptions

Dettagli utilizzati per creare un thread.

DeleteAssistantFileOptions

I dettagli utilizzati per eliminare un file dell'assistente.

DeleteAssistantOptions

I dettagli utilizzati per eliminare un assistente.

DeleteFileOptions

I dettagli utilizzati per eliminare i file.

DeleteThreadOptions

I dettagli utilizzati per eliminare un thread.

DeletionStatus

Una rappresentazione astratta dello stato del risultato di un'operazione di eliminazione OpenAI.

FileDeletionStatus

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

FileListResponse

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

FunctionDefinition

Informazioni sulla definizione di input per una funzione.

FunctionToolCall

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.

FunctionToolCallDetails

Informazioni dettagliate sulla funzione chiamata dal modello.

FunctionToolDefinition

Le informazioni di definizione di input per uno strumento funzionale utilizzato per configurare un assistente.

GetAssistantFileOptions

I dettagli utilizzati per ottenere un file dell'assistente.

GetAssistantOptions

I dettagli utilizzati per ottenere un assistente.

GetFileOptions

I dettagli utilizzati per ottenere i file.

GetMessageFileOptions

I dettagli utilizzati per ottenere un file di messaggio.

GetMessageOptions

I dettagli utilizzati per ricevere un messaggio.

GetRunOptions

I dettagli utilizzati per ottenere una corsa.

GetRunStepOptions

I dettagli utilizzati per ottenere un passaggio di esecuzione.

GetThreadOptions

I dettagli utilizzati per ottenere un thread.

InputFile

Rappresenta un assistente in grado di chiamare il modello e utilizzare gli strumenti.

ListAssistantFilesOptions

Dettagli utilizzati per elencare i file dell'assistente.

ListAssistantsOptions

I dettagli utilizzati per elencare gli assistenti.

ListFilesOptions

I dettagli utilizzati per elencare i file.

ListMessageFilesOptions

Dettagli utilizzati per elencare i file dei messaggi.

ListMessagesOptions

I dettagli utilizzati per elencare i messaggi.

ListResponseOf

Dati di risposta per un elenco di elementi richiesto.

ListRunStepsOptions

I dettagli utilizzati per elencare i passaggi di esecuzione.

ListRunsOptions

I dettagli utilizzati per elencare le esecuzioni.

MessageFile

Informazioni su un file allegato a un messaggio del thread dell'assistente.

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.

MessageTextContent

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

MessageTextDetails

Il testo e le annotazioni associate per un singolo elemento del contenuto del messaggio del thread dell'assistente.

MessageTextFileCitationAnnotation

Citazione all'interno del messaggio che punta a una citazione specifica da un file specifico associato all'assistente o al messaggio. Generato quando l'assistente utilizza lo strumento di "recupero" 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.

RequiredAction

Rappresentazione astratta di un'azione necessaria per la continuazione dell'esecuzione di un thread dell'assistente.

RequiredFunctionToolCall

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

RetrievalToolCall

Record di una chiamata a uno strumento di recupero, emesso dal modello nella valutazione di uno strumento definito, che rappresenta le azioni di recupero eseguite.

RetrievalToolDefinition

Le informazioni di definizione di input per uno strumento di recupero utilizzato per configurare un assistente.

RunError

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

RunStep

Informazioni dettagliate su un singolo passaggio di un'esecuzione di thread assistente.

RunStepError

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

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.

RunStepToolCallDetails

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

SubmitToolOutputsDetails

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

SubmitToolOutputsToRunOptions

Dettagli utilizzati per inviare gli output dello strumento a un'esecuzione.

ThreadDeletionStatus

Stato di un'operazione di eliminazione del thread.

ThreadMessage

Un singolo messaggio esistente all'interno di un thread dell'assistente.

ThreadRun

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

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.

UpdateAssistantOptions

I dettagli della richiesta da utilizzare quando si modifica un assistente esistente.

UpdateAssistantRequestOptions

I dettagli utilizzati per aggiornare un assistente.

UpdateMessageOptions

I dettagli utilizzati per aggiornare un messaggio.

UpdateRunOptions

I dettagli utilizzati per aggiornare un'esecuzione.

UpdateThreadOptions

I dettagli utilizzati per aggiornare un thread.

UploadFileOptions

I dettagli utilizzati per caricare i file.

Alias tipo

CodeInterpreterToolCallOutput

Alias per CodeInterpreterToolCallOutput

FilePurpose

"messa a punto", "risultati della messa a punto", "assistenti", "assistants_output"

ListSortOrder

"asc", "desc"

MessageContent

Alias per MessageContent

MessageRole

"utente", "assistente"

MessageTextAnnotation

Alias per MessageTextAnnotation

RequiredToolCall

Alias per RequiredToolCall

RunStatus

"in coda", "in_progress", "requires_action", "annullamento", "annullato", "non riuscito", "completato", "scaduto"

RunStepDetails

Alias per RunStepDetails

RunStepErrorCode

"server_error", "rate_limit_exceeded"

RunStepStatus

"in_progress", "annullato", "non riuscito", "completato", "scaduto"

RunStepType

"message_creation", "tool_calls"

ToolCall

Alias per ToolCall

ToolDefinition

Una rappresentazione astratta di una definizione di strumento di input che può essere utilizzata da un assistente.