JavaScript SDK: KI-Referenz
Jede Methode des KI-Dienstes und der Sitzungen mit ihrer Signatur.
6 Min. gelesen·Ebene Referenz·Überarbeitet am 12.10.2026
Dieser englische Text wurde automatisch aus dem französischen Original generiert und wurde noch nicht überprüft.
Diese Seite wurde automatisch übersetzt. Maßgeblich ist die englische Version.
#
Klasse
AiService
| Methode | Beschreibung |
|---|---|
session(): Promise<AiSession> | Prägt eine kurzlebige Ticket-KI-Sitzung (POST /v1/ai/{project_id}/session) und gibt ein fertiges AiSession für chat/chatStream/embed zurück. |
chat(messages: ChatMessage[], options?: { model?: string; temperature?: number; max_tokens?: number; system?: string; provider?: string; }): Promise<AuraResponse<ChatResponse>> | Senden Sie eine Anfrage zum Abschluss des Chats. |
chatStream(messages: ChatMessage[], options?: { model?: string; temperature?: number; max_tokens?: number; signal?: AbortSignal; }): AsyncGenerator<ChatStreamChunk> | Gestreamter Chat-Abschluss (SSE). |
embed(req: EmbedRequest): Promise<AuraResponse<EmbedResponse>> | Generieren Sie Einbettungen für die angegebenen Eingaben. |
rag(req: RagRequest): Promise<AuraResponse<RagResponse>> | Retrieval-Augmented Generation: Fragen Sie eine Sammlung ab und erhalten Sie eine Antwort. |
ragIngest(req: RagIngestRequest): Promise<AuraResponse<RagIngestResponse>> | Nehmen Sie ein Dokument in einen RAG-Namespace auf. |
listNamespaces(): Promise<AuraResponse<RagNamespace[]>> | Listet die RAG-Namespaces des Projekts auf. |
deleteNamespace(namespace: string): Promise<AuraResponse<RagDeleteResponse>> | Löscht einen RAG-Namespace (und seinen Korpus). |
reindexNamespace(namespace: string): Promise<AuraResponse<RagReindexResponse>> | Indiziert einen RAG-Namespace mit dem aktuellen Einbettungsmodell neu (Behebung nach einer Modell-/Dimensionsänderung). |
semanticSearch(query: string, namespace: string, options?: { top_k?: number; threshold?: number; }): Promise<AuraResponse<SemanticSearchResult[]>> | Semantische Suche über einen einbettenden Namespace. |
nl2sql(question: string, options?: { dialect?: 'postgresql' | 'postgres'; examples?: Array<{ question: string; sql: string; }>; limit?: number; }): Promise<AuraResponse<Nl2SqlResult>> | Übersetzt eine Frage in SQL. |
#
Klasse
AiSession
Kurzlebige Ticket-KI-Sitzung: Erstellen Sie eine kurzlebige Funktion (POST /v1/ai/{project_id}/session, klassische apikey-Authentifizierung) und verwenden Sie sie dann für chat/chatStream/embed (Authorization: Bearer <ticket> ALLEIN – niemals apikey).
| Eigentum | Beschreibung |
|---|---|
get budgetRemaining(): number | Verbleibendes Token-Budget, bekannt beim letzten Anruf (oder bei Mint, wenn noch kein Anruf getätigt wurde). |
| Methode | Beschreibung |
|---|---|
static create(client: AuraClientLike): Promise<AiSession> | Erstellen Sie eine neue KI-Sitzung. |
chat(messages: ChatMessage[], options?: AiSessionChatOptions): Promise<AiSessionChatResult> | Der Chat wurde in dieser Sitzung nicht gestreamt. |
chatStream(messages: ChatMessage[], options?: AiSessionChatStreamOptions): AsyncGenerator<ChatStreamChunk> | Gestreamter Chat (SSE) zu dieser Sitzung. |
embed(input: string): Promise<AiSessionEmbedResult> | Einbettung in diese Sitzung ({input} → {embedding, budget_remaining}). |
Generierte Seite
Diese Seite wird aus den Typdeklarationen und Kommentaren des SDK generiert, sodass sie nicht vom veröffentlichten Code abweichen kann. Ausgearbeitete Beispiele finden Sie in den Leitfäden.
Zuletzt aktualisiert · 12.10.2026