Aspose.Pdf.AI
Inhalt
[
Ausblenden
]Der Aspose.Pdf.AI-Namespace bietet Klassen für KI-Funktionalitäten, einschließlich API-Clients und intelligenter Assistenten.
Klassen
Klasse | Beschreibung |
---|---|
AIClientBase | Stellt den Client zum Zugriff auf die KI-API dar. |
AIClientException | Stellt eine Ausnahme dar, die spezifisch für die KI-Client-Operationen ist. |
AICopilotException | Stellt eine Ausnahme dar, die spezifisch für die Copilot-Operationen ist. |
AICopilotFactory | Fabrikklasse zum Erstellen verschiedener Arten von Copiloten. |
Annotation | Stellt den Textinhalt dar, der Teil einer Nachricht ist. |
AssistantCreateRequest | Anfrageobjekt zum Erstellen eines Assistenten. |
AssistantListQueryParameters | Stellt das Abfrageparameterobjekt zum Auflisten von Assistenten dar. |
AssistantListResponse | Stellt die Antwort dar, die eine Liste von Assistentenantworten enthält. |
AssistantModifyRequest | Anfrageobjekt zum Modifizieren eines Assistenten. |
AssistantResponse | Stellt einen Assistenten dar, der das Modell aufrufen und Werkzeuge verwenden kann. |
Attachment | Stellt eine Liste von Dateien dar, die an die Nachricht angehängt sind, und die Werkzeuge, zu denen sie hinzugefügt werden sollen. |
BaseListQueryParameters | Basisabfrageparameter zum Auflisten von Objekten. |
BaseResponse | Basis-Klasse für API-Antworten. |
CancellationTokenExtensions | Bietet Erweiterungsmethoden für CancellationToken. |
ChatMessage | Eine Chat-Vervollständigungsnachricht, die vom Modell generiert wurde. |
Choice | Stellt eine Auswahl in einer Chat-Vervollständigungsantwort dar. |
CodeInterpreter | Stellt die Ressourcen des Code-Interpreter-Werkzeugs dar. |
CompletionCreateRequest | Stellt eine Anfrage für den Endpunkt “Create Chat Completion” dar. |
CompletionFunction | Stellt das Funktionsobjekt dar. |
CompletionResponse | Stellt eine Chat-Vervollständigungsantwort dar, die vom Modell basierend auf den bereitgestellten Eingaben zurückgegeben wird. |
CreateChatCompletionChunkResponse | Stellt einen gestreamten Chunk einer Chat-Vervollständigungsantwort dar, die vom Modell basierend auf den bereitgestellten Eingaben zurückgegeben wird. |
CreateEmbeddingRequest | Stellt eine Anfrage für den Endpunkt “Create Embeddings” dar. |
CreateEmbeddingResponse | Stellt eine Antwort vom Endpunkt “Create Embeddings” dar. |
CreateFineTuningJobRequest | Stellt eine Anfrage für den Endpunkt “Create Fine-Tuning Job” dar. |
CreateFineTuningJobResponse | Stellt eine Antwort vom Endpunkt “Create Fine-Tuning Job” dar. |
DataResponse<T> | Stellt eine Datenantwort dar, die die angegebenen Daten enthält. |
DeleteStatusResponse | Stellt den Status einer Objekterstellung dar. |
DocumentCollection | Stellt eine Sammlung von Dokumenten dar, die verarbeitet werden sollen. |
Embedding | Stellt einen Einbettungsvektor dar, der vom Einbettungsendpunkt zurückgegeben wird. |
Error | Stellt einen Fehler in der API-Antwort dar. |
ExpiresAfter | Stellt die Ablaufrichtlinie für einen Vektorstore dar. |
FileCitation | Stellt die Dateizitation dar. |
FileContentResponse<T> | |
FileCounts | |
FileListResponse | Stellt eine Dateiliste-Antwort dar, die eine Liste von Dateiantworten enthält. |
FileResponse | Das FileResponse-Objekt stellt ein Dokument dar, das bei OpenAI hochgeladen wurde. |
FileSearch | Stellt die Ressourcen des Dateisuchwerkzeugs dar. |
Function | Stellt eine Funktion dar, die vom Modell aufgerufen werden kann. |
Hyperparameters | Stellt die Hyperparameter dar, die für einen Fine-Tuning-Job verwendet werden. |
ImageDescription | Stellt eine Bildbeschreibung dar. |
ImageDescriptionResult | Stellt die Antwort dar, die Bildbeschreibungen enthält. |
ImageFile | Stellt eine Bilddatei im Inhalt einer Nachricht dar. |
ImageUrl | Stellt eine Bild-URL im Inhalt einer Nachricht dar. |
IncompleteDetails | Details, warum der Lauf unvollständig ist. Wird null sein, wenn der Lauf nicht unvollständig ist. |
LastError | Der letzte Fehler, der mit diesem Lauf verbunden ist. Wird null sein, wenn keine Fehler vorliegen. |
ListDataResponse<T> | Stellt eine Listen-Datenantwort dar, die zusätzliche Informationen wie erste und letzte IDs und ob es weitere Elemente gibt, enthält. |
LlamaChatCompletionRequest | Stellt den Anfrageinhalt für die ChatGPT-API-Anfragen dar. |
LlamaChatCompletionResponse | Stellt eine Chat-Vervollständigungsantwort dar, die vom Modell basierend auf den bereitgestellten Eingaben zurückgegeben wird. |
LlamaClient | Stellt einen Client für die Interaktion mit der Llama-API dar. |
LlamaCopilotOptionsBase | Stellt die Basiseinstellungen für die Konfiguration des LlamaCopilot dar. |
LlamaModels | Enthält Konstanten, die sich auf verschiedene Llama-Modelle beziehen. |
LlamaSummaryCopilot | Bietet Funktionalität zum Abrufen von Dokumentzusammenfassungen mithilfe von KI-Modellen. Beispielverwendung zum Erstellen eines Llama-Clients, Konfigurieren von Optionen und Verwenden des Zusammenfassungs-Copiloten. Hinweis: Dieser Copilot verwendet die Vervollständigungs-API, sodass die Gesamtmenge an Text, die gesendet werden kann, durch das Kontextfenster des Modells begrenzt ist. |
LlamaSummaryCopilotOptions | Stellt die Optionen zur Konfiguration des OpenAICopilot dar. |
Logprobs | Stellt Informationen zur Log-Wahrscheinlichkeit für eine Auswahl dar. |
MessageContentBase | Der Inhalt der Nachricht in einem Array von Text und/oder Bildern. |
MessageContentRequest | Der Inhalt der Nachricht in einem Array von Text und/oder Bildern. |
MessageContentResponse | Der Inhalt der Antwortnachricht in einem Array von Text und/oder Bildern. |
MessageCreation | Stellt die Erstellung einer Nachricht mit ihrer eindeutigen Kennung dar. |
OpenAIAssistantCopilotOptionsBase | Stellt die Basiseinstellungen zur Konfiguration der OpenAICopiloten basierend auf der Assistants-API dar. |
OpenAIChatCopilot | Stellt einen Chat-Copiloten dar, um über KI-Modelle mit Dokumenten zu interagieren. Beispielverwendung zum Erstellen eines OpenAI-Clients, Konfigurieren von Optionen und Verwenden des ChatCopiloten, um mit Benutzeranfragen zu interagieren und den Gesprächskontext zu verwalten. |
OpenAIChatCopilotOptions | Stellt die Optionen zur Konfiguration des OpenAICopilot dar. |
OpenAIClient | Bietet Methoden zur Interaktion mit der OpenAI-API zur Verwaltung von Vektorstore-Dateibatches. |
OpenAIContext | Stellt die Entitäts-IDs dar, die mit einem Assistenten verbunden sind. |
OpenAICopilotOptionsBase | Stellt die Basiseinstellungen zur Konfiguration des OpenAICopilot dar. |
OpenAIImageDescriptionCopilot | Bietet Bildverarbeitungsfunktionen für die OpenAICopilot-Klasse. Beispielverwendung zum Erstellen eines OpenAI-Clients, Konfigurieren der Optionen für die Bildbeschreibung und Verwenden des Copiloten zum Generieren von Bildbeschreibungen und Hinzufügen von Beschreibungen zu angehängten Dokumenten. |
OpenAIImageDescriptionCopilotExtensions | Bietet Erweiterungsmethoden für die OpenAIImageDescriptionCopilot-Klasse. |
OpenAIImageDescriptionCopilotOptions | Stellt die Optionen zur Konfiguration des OpenAICopilot dar. |
OpenAIModels | Enthält die verfügbaren OpenAI-Modellbezeichner. |
OpenAISummaryCopilot | Bietet Funktionalität zum Abrufen von Dokumentzusammenfassungen mithilfe von KI-Modellen. Beispielverwendung zum Erstellen eines OpenAI-Clients, Konfigurieren von Optionen und Verwenden des Zusammenfassungs-Copiloten. |
OpenAISummaryCopilotOptions | Stellt die Optionen zur Konfiguration des OpenAICopilot dar. |
PdfDocument | Stellt ein PDF-Dokument mit einem Namen dar. |
RequiredAction | Details zur erforderlichen Aktion, um den Lauf fortzusetzen. Wird null sein, wenn keine Aktion erforderlich ist. |
ResponseFormat | Stellt das Format einer Antwort dar, das entweder ein Stringwert oder ein Objektwert sein kann. |
RunCreateRequest | Stellt eine Anfrage zum Erstellen eines Laufs dar. |
RunListQueryParameters | Abfrageparameterobjekt zum Auflisten von Läufen. |
RunListResponse | Stellt eine Listenantwort dar, die Laufdaten enthält. |
RunModifyRequest | Stellt eine Anfrage zum Modifizieren eines Laufs dar. |
RunResponse | Stellt einen Ausführungsrun auf einem Thread dar. |
RunStepDetails | Die Details des Laufsschrittes. |
RunStepListQueryParameters | Abfrageparameterobjekt zum Auflisten von Laufsschritten. |
RunStepListResponse | Stellt eine Listenantwort dar, die Laufsschrittdaten enthält. |
RunStepResponse | Stellt einen Schritt in der Ausführung eines Laufs dar. |
RunThreadCreateRequest | Stellt eine Anfrage zum Erstellen eines Threads und dessen Ausführung in einer Anfrage dar. |
SubmitToolOutputs | Stellt Details zu den Werkzeugausgaben dar, die benötigt werden, damit der Lauf fortgesetzt werden kann. |
TextDocument | Stellt ein Textdokument mit einem Namen und Inhalt dar. |
TextResponse | Stellt den Textinhalt dar, der Teil einer Nachricht ist. |
ThreadCreateRequest | Stellt eine Anfrage zum Erstellen eines Threads dar. |
ThreadMessageCreateRequest | Stellt eine Anfrage zum Erstellen einer Nachricht innerhalb eines Threads dar. |
ThreadMessageListQueryParameters | Abfrageparameterobjekt zum Auflisten von Threadnachrichten. |
ThreadMessageListResponse | Stellt eine Listenantwort dar, die Threadnachrichtendaten enthält. |
ThreadMessageModifyRequest | Stellt eine Anfrage zum Modifizieren einer Nachricht innerhalb eines Threads dar. |
ThreadMessageResponse | Stellt eine Nachricht innerhalb eines Threads dar. |
ThreadModifyRequest | Stellt eine Anfrage zum Modifizieren eines Threads dar. |
ThreadResponse | Stellt einen Thread dar, der Nachrichten enthält. |
Tool | Stellt ein Werkzeug dar, das vom Modell aufgerufen werden kann. |
ToolCall | Stellt einen Werkzeugaufruf innerhalb einer Nachricht dar. |
ToolChoice | Stellt die ToolChoice dar, die entweder ein Stringwert oder ein Objektwert sein kann. |
ToolResources | Stellt eine Reihe von Ressourcen dar, die von den Werkzeugen des Assistenten verwendet werden. Die Ressourcen sind spezifisch für den Typ des Werkzeugs. Zum Beispiel erfordert das Werkzeug code_interpreter eine Liste von Datei-IDs, während das Werkzeug file_search eine Liste von Vektorstore-IDs erfordert. |
TruncationStrategy | Stellt die Trunkierungsstrategie dar, die steuert, wie ein Thread vor dem Lauf gekürzt wird. |
Usage | Stellt Nutzungsstatistiken für eine Anfrage dar. |
VectorStore | Ein Helfer zum Erstellen eines Vektorstores mit file_ids und zum Anhängen an diesen Thread. Es kann maximal 1 Vektorstore an den Thread angehängt werden. |
VectorStoreCreateRequest | Anfrage zum Erstellen eines Vektorstores. |
VectorStoreFileBatchCreateRequest | Anfrage zum Erstellen eines Vektorstore-Dateibatches. |
VectorStoreFileBatchFileListQueryParameters | Abfrageparameterobjekt zum Auflisten von Vektorstore-Dateibatchdateien. |
VectorStoreFileBatchFileListResponse | Stellt eine Listenantwort dar, die Vektorstore-Dateibatchdaten enthält. |
VectorStoreFileBatchResponse | Das Antwortobjekt für den Vektorstore-Dateibatch. |
VectorStoreFileCreateRequest | Anfrage zum Erstellen einer Vektorstore-Datei. |
VectorStoreFileListQueryParameters | Abfrageparameterobjekt zum Auflisten von Vektorstore-Dateien. |
VectorStoreFileListResponse | Stellt eine Listenantwort dar, die Vektorstore-Dateidaten enthält. |
VectorStoreFileResponse | Eine Vektorstore-Dateiantwort. |
VectorStoreListQueryParameters | Abfrageparameterobjekt zum Auflisten von Vektorstores. |
VectorStoreListResponse | Stellt eine Listenantwort dar, die Vektorstore-Daten enthält. |
VectorStoreModifyRequest | Anfrage zum Modifizieren eines Vektorstores. |
VectorStoreResponse | Das Vektorstore-Objekt. |
Schnittstellen
Schnittstelle | Beschreibung |
---|---|
IAIClient | Stellt eine Schnittstelle für einen KI-Client dar. |
IAICopilot | Stellt einen Copilot für KI-Interaktionen dar. |
IChatClient<TOptions> | Stellt eine Schnittstelle für einen Chat-Client mit spezifischen Optionen dar. |
IChatCopilot | Stellt einen Chat-Copiloten dar, um über KI-Modelle mit Dokumenten zu interagieren. |
IChatCopilotOptions<TOptions> | Stellt eine Schnittstelle für Chat-Copilot-Optionen mit einem spezifischen Typ dar. |
IEntityId | Stellt eine Entität mit einer ID dar. |
IImageDescriptionClient<TOptions> | Stellt eine Schnittstelle für einen Bildbeschreibung-Client mit spezifischen Optionen dar. |
IImageDescriptionCopilot | Stellt einen Bildbeschreibung-Copiloten dar, um Bildbeschreibungen mithilfe von KI-Modellen zu extrahieren. |
IImageDescriptionCopilotOptions<TOptions> | Stellt eine Schnittstelle für Bildbeschreibung-Copilot-Optionen mit einem spezifischen Typ dar. |
ILlamaClient | Stellt eine Client-Schnittstelle für die Interaktion mit der Llama-API dar. |
IOpenAIClient | Stellt eine Client-Schnittstelle für die Interaktion mit der OpenAI-API dar, die die grundlegenden KI-Client-Funktionalitäten erweitert. |
IQueryParameters | Stellt Abfrageparameter für API-Anfragen dar. |
IStatus | Stellt den Status einer Operation dar. |
IStringOrObject<T> | Stellt ein Objekt dar, das entweder ein Stringwert oder ein Objektwert sein kann. |
ISummaryClient<TOptions> | Stellt eine Schnittstelle für einen Zusammenfassungs-Client mit spezifischen Optionen dar. |
ISummaryCopilot | Stellt einen Zusammenfassungs-Copiloten dar, um Zusammenfassungen für Dokumente mithilfe von KI-Modellen zu generieren. |
ISummaryCopilotOptions<TOptions> | Stellt eine Schnittstelle für Zusammenfassungs-Copilot-Optionen mit einem spezifischen Typ dar. |