Delen via


@azure/openai-assistants package

Klassen

AssistantsClient

Clientafhandeling assistent gerelateerde bewerkingen.

AzureKeyCredential

Een referentie op basis van een statische sleutel die ondersteuning biedt voor het bijwerken van de onderliggende sleutelwaarde.

OpenAIKeyCredential

De klasse OpenAIKeyCredential vertegenwoordigt een OpenAI API-sleutel en wordt gebruikt voor verificatie bij een Assistants-client voor een OpenAI-eindpunt.

Interfaces

Assistant

Vertegenwoordigt een assistent die het model kan aanroepen en hulpprogramma's kunnen gebruiken.

AssistantCreationOptions

De aanvraagdetails die moeten worden gebruikt bij het maken van een nieuwe assistent.

AssistantDeletionStatus

De status van een assistent verwijderingsbewerking.

AssistantFile

Informatie over een bestand dat is gekoppeld aan een assistent, zoals gebruikt door hulpprogramma's die bestanden kunnen lezen.

AssistantFileDeletionStatus

De status van een assistent bestandsverwijderingsbewerking.

AssistantThread

Informatie over één thread die is gekoppeld aan een assistent.

AssistantThreadCreationOptions

De details die worden gebruikt om een nieuwe assistent thread te maken.

AssistantsClientOptions

De details die worden gebruikt om een assistent-client te maken *

CancelRunOptions

De details die worden gebruikt om een uitvoering te annuleren.

CodeInterpreterImageOutput

Een weergave van een afbeeldingsuitvoer die wordt verzonden door een code-interpreter-hulpprogramma als reactie op een aanroep door het model.

CodeInterpreterImageReference

Een afbeeldingsverwijzing die wordt verzonden door een code-interpreter-hulpprogramma als reactie op een aanroep door het model.

CodeInterpreterLogOutput

Een weergave van een logboekuitvoer die wordt verzonden door een code-interpreter-hulpprogramma als reactie op een hulpprogramma-aanroep door het model.

CodeInterpreterToolCall

Een record van een aanroep van een code-interpreter-hulpprogramma, uitgegeven door het model ter evaluatie van een gedefinieerd hulpprogramma, dat de invoer en uitvoer vertegenwoordigt die worden gebruikt en verzonden door de code-interpreter.

CodeInterpreterToolCallDetails

De gedetailleerde informatie over het aanroepen van een code-interpreter door het model.

CodeInterpreterToolDefinition

De informatie over de invoerdefinitie voor een code-interpreter die wordt gebruikt voor het configureren van een assistent.

CreateAndRunThreadOptions

De details die worden gebruikt bij het maken en direct uitvoeren van een nieuwe assistent-thread.

CreateAssistantFileOptions

De details die worden gebruikt om een assistent-bestand te maken.

CreateAssistantOptions

De details die worden gebruikt om een assistent te maken.

CreateMessageOptions

De details die worden gebruikt om een bericht te maken.

CreateRunOptions

De details die worden gebruikt bij het maken van een nieuwe uitvoering van een assistent-thread.

CreateRunRequestOptions

De details die worden gebruikt om een uitvoeringsaanvraag te maken.

CreateThreadAndRunOptions

De details die worden gebruikt om een thread te maken en uit te voeren.

CreateThreadOptions

De details die worden gebruikt om een thread te maken.

DeleteAssistantFileOptions

De details die worden gebruikt om een assistent-bestand te verwijderen.

DeleteAssistantOptions

De details die worden gebruikt om een assistent te verwijderen.

DeleteFileOptions

De details die worden gebruikt om bestanden te verwijderen.

DeleteThreadOptions

De details die worden gebruikt om een thread te verwijderen.

DeletionStatus

Een abstracte weergave van de resultaatstatus van een OpenAI-verwijderingsbewerking.

FileDeletionStatus

Een statusantwoord van een bestandsverwijderingsbewerking.

FileListResponse

De antwoordgegevens van een bestandslijstbewerking.

FunctionDefinition

De informatie over de invoerdefinitie voor een functie.

FunctionToolCall

Een record van een aanroep naar een functiehulpprogramma, uitgegeven door het model ter evaluatie van een gedefinieerd hulpprogramma, dat de invoer en uitvoer vertegenwoordigt die worden verbruikt en verzonden door de opgegeven functie.

FunctionToolCallDetails

De gedetailleerde informatie over de functie die door het model wordt aangeroepen.

FunctionToolDefinition

De invoerdefinitiegegevens voor een functiehulpprogramma zoals gebruikt voor het configureren van een assistent.

GetAssistantFileOptions

De details die worden gebruikt om een assistent-bestand op te halen.

GetAssistantOptions

De details die worden gebruikt om een assistent te krijgen.

GetFileOptions

De details die worden gebruikt om bestanden op te halen.

GetMessageFileOptions

De details die worden gebruikt om een berichtbestand op te halen.

GetMessageOptions

De details die worden gebruikt om een bericht op te halen.

GetRunOptions

De details die worden gebruikt om een run te krijgen.

GetRunStepOptions

De details die worden gebruikt om een uitvoeringsstap op te halen.

GetThreadOptions

De details die worden gebruikt om een thread op te halen.

InputFile

Vertegenwoordigt een assistent die het model kan aanroepen en hulpprogramma's kunnen gebruiken.

ListAssistantFilesOptions

De details die worden gebruikt om assistent bestanden weer te geven.

ListAssistantsOptions

De details die worden gebruikt om assistenten weer te geven.

ListFilesOptions

De details die worden gebruikt om bestanden weer te geven.

ListMessageFilesOptions

De details die worden gebruikt om berichtbestanden weer te geven.

ListMessagesOptions

De details die worden gebruikt om berichten weer te geven.

ListResponseOf

De antwoordgegevens voor een aangevraagde lijst met items.

ListRunStepsOptions

De details die worden gebruikt om de uitvoeringsstappen weer te geven.

ListRunsOptions

De details die worden gebruikt om uitvoeringen weer te geven.

MessageFile

Informatie over een bestand dat is gekoppeld aan een assistent-threadbericht.

MessageImageFileContent

Een weergave van de inhoud van het afbeeldingsbestand in een threadbericht.

MessageImageFileDetails

Een afbeeldingsreferentie, zoals weergegeven in de inhoud van het threadbericht.

MessageTextContent

Een weergave van een tekstueel item van de inhoud van een threadbericht.

MessageTextDetails

De tekst en de bijbehorende aantekeningen voor één item van assistent threadberichtinhoud.

MessageTextFileCitationAnnotation

Een bronvermelding in het bericht die verwijst naar een specifiek citaat uit een specifiek bestand dat is gekoppeld aan de assistent of het bericht. Gegenereerd wanneer de assistent het hulpprogramma 'ophalen' gebruikt om bestanden te doorzoeken.

MessageTextFileCitationDetails

Een weergave van een bronvermelding op basis van een bestand, zoals gebruikt in een bestandsaantekening van de inhoud van een tekstthreadbericht.

MessageTextFilePathAnnotation

Een bronvermelding in het bericht die verwijst naar een bestand dat zich op een specifiek pad bevindt.

MessageTextFilePathDetails

Een inkapseling van een afbeeldingsbestands-id, zoals gebruikt door de inhoud van de berichtafbeelding.

RequiredAction

Een abstracte weergave van een vereiste actie voor een assistent threaduitvoering om door te gaan.

RequiredFunctionToolCall

Een weergave van een aangevraagde aanroep van een functiehulpprogramma, die het model nodig heeft om de evaluatie van een uitvoering voort te zetten.

RetrievalToolCall

Een record van een aanroep van een hulpprogramma voor het ophalen, uitgegeven door het model ter evaluatie van een gedefinieerd hulpprogramma, dat de uitgevoerde ophaalacties vertegenwoordigt.

RetrievalToolDefinition

De informatie over de invoerdefinitie voor een hulpprogramma voor ophalen, zoals gebruikt voor het configureren van een assistent.

RunError

De details van een fout die is aangetroffen door een assistent threaduitvoering.

RunStep

Gedetailleerde informatie over één stap van een assistent threaduitvoering.

RunStepError

De foutgegevens die zijn gekoppeld aan een mislukte uitvoeringsstap.

RunStepMessageCreationDetails

De gedetailleerde informatie die is gekoppeld aan de uitvoeringsstap voor het maken van een bericht.

RunStepMessageCreationReference

De details van een bericht dat is gemaakt als onderdeel van een uitvoeringsstap.

RunStepToolCallDetails

De gedetailleerde informatie die is gekoppeld aan een uitvoeringsstap die hulpprogramma's aanroept.

SubmitToolOutputsDetails

De details van de hulpprogramma's die moeten worden aangeroepen om uitvoer van hulpprogramma's te verzenden.

SubmitToolOutputsToRunOptions

De details die worden gebruikt om uitvoer van hulpprogramma's naar een uitvoering te verzenden.

ThreadDeletionStatus

De status van een threadverwijderingsbewerking.

ThreadMessage

Eén bestaand bericht in een assistent thread.

ThreadRun

Gegevens die één evaluatie-uitvoering van een assistent thread vertegenwoordigen.

ToolOutput

De gegevens die tijdens een hulpprogramma worden verstrekt, voeren de verzending uit om openstaande hulpprogramma-aanroepen op te lossen en het model door te laten gaan.

UpdateAssistantOptions

De aanvraagdetails die moeten worden gebruikt bij het wijzigen van een bestaande assistent.

UpdateAssistantRequestOptions

De details die worden gebruikt om een assistent bij te werken.

UpdateMessageOptions

De details die worden gebruikt om een bericht bij te werken.

UpdateRunOptions

De details die worden gebruikt om een uitvoering bij te werken.

UpdateThreadOptions

De details die worden gebruikt om een thread bij te werken.

UploadFileOptions

De details die worden gebruikt voor het uploaden van bestanden.

Type-aliassen

CodeInterpreterToolCallOutput

Alias voor CodeInterpreterToolCallOutput

FilePurpose

"fine-tune", "fine-tune-results", "assistants", "assistants_output"

ListSortOrder

"asc", "desc"

MessageContent

Alias voor MessageContent

MessageRole

"gebruiker", "assistent"

MessageTextAnnotation

Alias voor MessageTextAnnotation

RequiredToolCall

Alias voor RequiredToolCall

RunStatus

"in wachtrij geplaatst", "in_progress", "requires_action", "annuleren", "geannuleerd", "mislukt", "voltooid", "verlopen"

RunStepDetails

Alias voor RunStepDetails

RunStepErrorCode

"server_error", "rate_limit_exceeded"

RunStepStatus

"in_progress", "geannuleerd", "mislukt", "voltooid", "verlopen"

RunStepType

"message_creation", "tool_calls"

ToolCall

Alias voor ToolCall

ToolDefinition

Een abstracte weergave van een invoerhulpprogrammadefinitie die een assistent kan gebruiken.