@azure/openai-assistants package
Klassen
| AssistantsClient |
Assistent-gerelateerde operaties voor klantafhandeling. |
| AzureKeyCredential |
Een referentie op basis van statische sleutels die ondersteuning biedt voor het bijwerken van de onderliggende sleutelwaarde. |
| OpenAIKeyCredential |
De klasse OpenAIKeyCredential vertegenwoordigt een OpenAI API-sleutel en wordt gebruikt om te verifiëren in een Assistants-client voor een OpenAI-eindpunt. |
Interfaces
| Assistant |
Vertegenwoordigt een assistent die het model kan aanroepen en tools kan gebruiken. |
| AssistantCreationOptions |
De aanvraaggegevens die moeten worden gebruikt bij het maken van een nieuwe assistent. |
| AssistantDeletionStatus |
De status van een verwijderingsbewerking voor een assistent. |
| AssistantFile |
Informatie over een bestand dat is gekoppeld aan een assistent, zoals gebruikt door tools die bestanden kunnen lezen. |
| AssistantFileDeletionStatus |
De status van een assistent-bewerking voor het verwijderen van bestanden. |
| AssistantThread |
Informatie over een enkele 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 assistentclient te maken * |
| CancelRunOptions |
De gegevens die worden gebruikt om een run te annuleren. |
| CodeInterpreterImageOutput |
Een weergave van een afbeeldingsuitvoer die wordt verzonden door een code-interpreter-hulpprogramma als reactie op een door het model aanroep van een hulpprogramma. |
| CodeInterpreterImageReference |
Een afbeeldingsverwijzing die wordt verzonden door een code-interpreter-hulpprogramma als reactie op een aanroep van het hulpprogramma door het model. |
| CodeInterpreterLogOutput |
Een weergave van een logboekuitvoer die wordt verzonden door een code-interpreter-hulpprogramma als reactie op een door het model aanroep van een hulpprogramma. |
| CodeInterpreterToolCall |
Een record van een aanroep naar een code-interpreter-hulpprogramma dat is uitgegeven door het model tijdens de evaluatie van een gedefinieerd hulpprogramma, dat invoer en uitvoer vertegenwoordigt die worden verbruikt en verzonden door de code-interpreter. |
| CodeInterpreterToolCallDetails |
De gedetailleerde informatie over het aanroepen van een code-interpreter door het model. |
| CodeInterpreterToolDefinition |
De invoerdefinitie-informatie voor een code-interpreter-tool zoals gebruikt om een assistent te configureren. |
| CreateAndRunThreadOptions |
De gegevens die worden gebruikt bij het maken en onmiddellijk uitvoeren van een nieuwe assistent-thread. |
| CreateAssistantFileOptions |
De gegevens die worden gebruikt om een assistent-bestand te maken. |
| CreateAssistantOptions |
De gegevens die worden gebruikt om een assistent aan te maken. |
| CreateMessageOptions |
De gegevens 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 gegevens 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 gegevens die worden gebruikt om een assistent-bestand te verwijderen. |
| DeleteAssistantOptions |
De gegevens die worden gebruikt om een assistent te verwijderen. |
| DeleteFileOptions |
De gegevens die worden gebruikt om bestanden te verwijderen. |
| DeleteThreadOptions |
De gegevens die worden gebruikt om een thread te verwijderen. |
| DeletionStatus |
Een abstracte weergave van de resultaatstatus van een OpenAI-verwijderingsbewerking. |
| FileDeletionStatus |
Een statusreactie 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 in evaluatie van een gedefinieerd hulpprogramma, dat de verbruikte invoer en uitvoer vertegenwoordigt en die door de opgegeven functie wordt verzonden. |
| FunctionToolCallDetails |
De gedetailleerde informatie over de functie die door het model wordt aangeroepen. |
| FunctionToolDefinition |
De invoer van definitie-informatie voor een functiehulpmiddel zoals gebruikt om een assistent te configureren. |
| GetAssistantFileOptions |
De gegevens die worden gebruikt om een assistent-bestand te krijgen. |
| GetAssistantOptions |
De gegevens die worden gebruikt om een assistent te krijgen. |
| GetFileOptions |
De gegevens die worden gebruikt om bestanden op te halen. |
| GetMessageFileOptions |
De gegevens die worden gebruikt om een berichtbestand te krijgen. |
| GetMessageOptions |
De gegevens die worden gebruikt om een bericht te krijgen. |
| GetRunOptions |
De details die worden gebruikt om een run te krijgen. |
| GetRunStepOptions |
De details die worden gebruikt om een run-stap te krijgen. |
| GetThreadOptions |
De details gebruikt om een draad te krijgen. |
| InputFile |
Vertegenwoordigt een assistent die het model kan aanroepen en tools kan gebruiken. |
| ListAssistantFilesOptions |
De details die worden gebruikt om assistent-bestanden weer te geven. |
| ListAssistantsOptions |
De gegevens die worden gebruikt om assistenten op te sommen. |
| 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 stappen van de uitvoering weer te geven. |
| ListRunsOptions |
De details die worden gebruikt om runs weer te geven. |
| MessageFile |
Informatie over een bestand dat is gekoppeld aan een assistent-threadbericht. |
| MessageImageFileContent |
Een weergave van inhoud van afbeeldingsbestanden in een threadbericht. |
| MessageImageFileDetails |
Een afbeeldingsreferentie, zoals aangegeven in threadberichtinhoud. |
| MessageTextContent |
Een weergave van een tekstueel item van threadberichtinhoud. |
| MessageTextDetails |
De tekst en bijbehorende annotaties voor één item van de inhoud van een assistent-thread. |
| 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 de tool 'ophalen' gebruikt om bestanden te doorzoeken. |
| MessageTextFileCitationDetails |
Een weergave van een tekstvermelding op basis van bestanden, zoals wordt gebruikt in een op bestanden gebaseerde aantekening van inhoud van tekstthreadberichten. |
| MessageTextFilePathAnnotation |
Een bronvermelding in het bericht dat verwijst naar een bestand dat zich op een specifiek pad bevindt. |
| MessageTextFilePathDetails |
Een inkapseling van een afbeeldingsbestands-id, zoals wordt gebruikt door inhoud van berichtafbeelding. |
| RequiredAction |
Een abstracte weergave van een vereiste actie om een assistent-thread door te laten gaan. |
| RequiredFunctionToolCall |
Een weergave van een aangevraagde aanroep naar een functiehulpprogramma, dat nodig is voor het model om de evaluatie van een uitvoering voort te zetten. |
| RetrievalToolCall |
Een record van een aanroep naar een ophaaltool, uitgegeven door het model ter evaluatie van een gedefinieerd tool, dat uitgevoerde ophaalacties vertegenwoordigt. |
| RetrievalToolDefinition |
De invoer van definitie-informatie voor een ophaaltool zoals gebruikt om een assistent te configureren. |
| RunError |
De details van een fout die wordt aangetroffen door een assistent-thread, worden uitgevoerd. |
| RunStep |
Gedetailleerde informatie over een enkele stap van een assistent-threadrun. |
| RunStepError |
De foutinformatie die is gekoppeld aan een mislukte uitvoeringsstap. |
| RunStepMessageCreationDetails |
De gedetailleerde informatie die is gekoppeld aan een stap 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 hulpprogramma voor het aanroepen van een uitvoeringsstap. |
| SubmitToolOutputsDetails |
De details over hulpprogramma's die moeten worden aangeroepen om uitvoer van hulpprogramma's te verzenden. |
| SubmitToolOutputsToRunOptions |
De gegevens die worden gebruikt om de uitvoer van het hulpprogramma naar een uitvoering te verzenden. |
| ThreadDeletionStatus |
De status van een threadverwijderingsbewerking. |
| ThreadMessage |
Eén bestaand bericht in een assistent-thread. |
| ThreadRun |
Gegevens die een enkele evaluatierun van een assistent-thread vertegenwoordigen. |
| ToolOutput |
De gegevens die tijdens een hulpprogramma worden verstrekt, verzenden om openstaande hulpprogramma-aanroepen op te lossen en het model door te laten gaan. |
| UpdateAssistantOptions |
De aanvraaggegevens die moeten worden gebruikt bij het wijzigen van een bestaande assistent. |
| UpdateAssistantRequestOptions |
De gegevens die worden gebruikt om een assistent op de hoogte te houden. |
| UpdateMessageOptions |
De gegevens die worden gebruikt om een bericht bij te werken. |
| UpdateRunOptions |
De gegevens die worden gebruikt om een run bij te werken. |
| UpdateThreadOptions |
De gegevens die worden gebruikt om een thread bij te werken. |
| UploadFileOptions |
De gegevens die worden gebruikt om bestanden te uploaden. |
Type-aliassen
| CodeInterpreterToolCallOutput |
Alias voor CodeInterpreterToolCallOutput |
| FilePurpose |
"Fine-tune", "Fine-tune-resultaten", "Assistenten", "assistants_output" |
| ListSortOrder |
"asc", "desc" |
| MessageContent |
Alias voor MessageContent |
| MessageRole |
"gebruiker", "assistent" |
| MessageTextAnnotation |
Alias voor MessageTextAnnotation |
| RequiredToolCall |
Alias voor RequiredToolCall |
| RunStatus |
"In de wachtrij", "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 definitie van een invoertool die een assistent kan gebruiken. |
