@azure/openai-assistants package
Classi
AssistantsClient |
Gestione client assistente operazioni correlate. |
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 usata per eseguire l'autenticazione in un client Assistants per un endpoint OpenAI. |
Interfacce
Assistant |
Rappresenta un assistente che può chiamare il modello e usare gli strumenti. |
AssistantCreationOptions |
Dettagli della richiesta da usare durante la creazione di una nuova assistente. |
AssistantDeletionStatus |
Stato di un'operazione di eliminazione assistente. |
AssistantFile |
Informazioni su un file collegato a un assistente, come usato dagli strumenti che possono leggere i file. |
AssistantFileDeletionStatus |
Stato di un'operazione di eliminazione di file assistente. |
AssistantThread |
Informazioni su un singolo thread associato a un assistente. |
AssistantThreadCreationOptions |
I dettagli usati per creare un nuovo thread assistente. |
AssistantsClientOptions |
Dettagli usati per creare un client assistente * |
CancelRunOptions |
Dettagli usati per annullare un'esecuzione. |
CodeInterpreterImageOutput |
Rappresentazione di un output dell'immagine generato da uno strumento interprete di codice in risposta a una chiamata di strumento dal modello. |
CodeInterpreterImageReference |
Riferimento all'immagine generato da uno strumento interprete di codice in risposta a una chiamata di strumento dal modello. |
CodeInterpreterLogOutput |
Rappresentazione di un output del log generato da uno strumento interprete di codice in risposta a una chiamata di strumento dal modello. |
CodeInterpreterToolCall |
Record di una chiamata a uno strumento di interprete del codice, rilasciato dal modello nella valutazione di uno strumento definito, che rappresenta input e output utilizzati e generati dall'interprete del codice. |
CodeInterpreterToolCallDetails |
Informazioni dettagliate su una chiamata dell'interprete del codice dal modello. |
CodeInterpreterToolDefinition |
Informazioni sulla definizione di input per uno strumento di interprete del codice usato per configurare un assistente. |
CreateAndRunThreadOptions |
I dettagli usati durante la creazione e l'esecuzione immediata di un nuovo thread assistente. |
CreateAssistantFileOptions |
I dettagli usati per creare un file di assistente. |
CreateAssistantOptions |
Dettagli usati per creare un assistente. |
CreateMessageOptions |
Dettagli usati per creare un messaggio. |
CreateRunOptions |
I dettagli usati durante la creazione di una nuova esecuzione di un thread di assistente. |
CreateRunRequestOptions |
Dettagli usati per creare una richiesta di esecuzione. |
CreateThreadAndRunOptions |
I dettagli usati per creare ed eseguire un thread. |
CreateThreadOptions |
Dettagli usati per creare un thread. |
DeleteAssistantFileOptions |
I dettagli usati per eliminare un file di assistente. |
DeleteAssistantOptions |
I dettagli usati per eliminare un assistente. |
DeleteFileOptions |
Dettagli usati per eliminare i file. |
DeleteThreadOptions |
Dettagli usati per eliminare un thread. |
DeletionStatus |
Rappresentazione astratta di uno stato del risultato dell'operazione di eliminazione OpenAI. |
FileDeletionStatus |
Risposta di stato da un'operazione di eliminazione 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 |
Informazioni sulla definizione di input per uno strumento di funzione usato per configurare un assistente. |
GetAssistantFileOptions |
I dettagli usati per ottenere un file di assistente. |
GetAssistantOptions |
I dettagli usati per ottenere un assistente. |
GetFileOptions |
Dettagli usati per ottenere i file. |
GetMessageFileOptions |
Dettagli usati per ottenere un file di messaggio. |
GetMessageOptions |
Dettagli usati per ottenere un messaggio. |
GetRunOptions |
Dettagli usati per ottenere un'esecuzione. |
GetRunStepOptions |
Dettagli usati per ottenere un passaggio di esecuzione. |
GetThreadOptions |
Dettagli usati per ottenere un thread. |
InputFile |
Rappresenta un assistente che può chiamare il modello e usare gli strumenti. |
ListAssistantFilesOptions |
I dettagli usati per elencare assistente file. |
ListAssistantsOptions |
Dettagli usati per elencare gli assistenti. |
ListFilesOptions |
Dettagli usati per elencare i file. |
ListMessageFilesOptions |
I dettagli usati per elencare i file di messaggio. |
ListMessagesOptions |
Dettagli usati per elencare i messaggi. |
ListResponseOf |
Dati di risposta per un elenco richiesto di elementi. |
ListRunStepsOptions |
Dettagli usati per elencare i passaggi di esecuzione. |
ListRunsOptions |
I dettagli usati per elencare le esecuzioni. |
MessageFile |
Informazioni su un file collegato a un messaggio di thread assistente. |
MessageImageFileContent |
Rappresentazione del contenuto del file di immagine in un messaggio di thread. |
MessageImageFileDetails |
Riferimento all'immagine, come rappresentato nel contenuto del messaggio di thread. |
MessageTextContent |
Rappresentazione di un elemento testuale del contenuto del messaggio di thread. |
MessageTextDetails |
Testo e annotazioni associate per un singolo elemento del contenuto del messaggio di thread assistente. |
MessageTextFileCitationAnnotation |
Citazione all'interno del messaggio che punta a una citazione specifica da un file specifico associato al assistente o al messaggio. Generato quando il assistente usa lo strumento "recupero" per cercare i file. |
MessageTextFileCitationDetails |
Rappresentazione di una citazione di testo basata su file, come usato 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 l'esecuzione di un thread assistente per continuare. |
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, rilasciato dal modello nella valutazione di uno strumento definito, che rappresenta le azioni di recupero eseguite. |
RetrievalToolDefinition |
Informazioni sulla definizione di input per uno strumento di recupero usato per configurare un assistente. |
RunError |
I dettagli di un errore come rilevato da un'esecuzione di thread assistente. |
RunStep |
Informazioni dettagliate su un singolo passaggio di esecuzione di un 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 |
I dettagli di un messaggio creato come parte di un passaggio di esecuzione. |
RunStepToolCallDetails |
Informazioni dettagliate associate a strumenti di chiamata al passaggio di esecuzione. |
SubmitToolOutputsDetails |
I dettagli che descrivono gli strumenti che devono essere chiamati per inviare gli output degli strumenti. |
SubmitToolOutputsToRunOptions |
I dettagli usati per inviare gli output degli strumenti a un'esecuzione. |
ThreadDeletionStatus |
Stato di un'operazione di eliminazione del thread. |
ThreadMessage |
Un singolo messaggio esistente all'interno di un thread assistente. |
ThreadRun |
Dati che rappresentano una singola esecuzione di valutazione di un thread di assistente. |
ToolOutput |
I dati forniti durante l'invio di uno strumento per risolvere le chiamate degli strumenti in sospeso e consentire al modello di continuare. |
UpdateAssistantOptions |
Dettagli della richiesta da usare per la modifica di un assistente esistente. |
UpdateAssistantRequestOptions |
Dettagli usati per aggiornare un assistente. |
UpdateMessageOptions |
Dettagli usati per aggiornare un messaggio. |
UpdateRunOptions |
Dettagli usati per aggiornare un'esecuzione. |
UpdateThreadOptions |
Dettagli usati per aggiornare un thread. |
UploadFileOptions |
Dettagli usati per caricare file. |
Alias tipo
CodeInterpreterToolCallOutput |
Alias per CodeInterpreterToolCallOutput |
FilePurpose |
"fine-tune", "fine-tune-results", "assistants", "assistants_output" |
ListSortOrder |
"asc", "desc" |
MessageContent |
Alias per MessageContent |
MessageRole |
"user", "assistente" |
MessageTextAnnotation |
Alias per MessageTextAnnotation |
RequiredToolCall |
Alias per RequiredToolCall |
RunStatus |
"queued", "in_progress", "requires_action", "annullamento", "annullato", "failed", "complete", "scaduto" |
RunStepDetails |
Alias per RunStepDetails |
RunStepErrorCode |
"server_error", "rate_limit_exceeded" |
RunStepStatus |
"in_progress", "annullata", "non riuscita", "completata", "scaduta" |
RunStepType |
"message_creation", "tool_calls" |
ToolCall |
Alias per ToolCall |
ToolDefinition |
Rappresentazione astratta di una definizione dello strumento di input che può essere usata da un assistente. |
Azure SDK for JavaScript