光环标志
光环基地文档
文档›JavaScript SDK reference›AI reference

JavaScript SDK:AI 参考

AI 服务和会话的每个方法都有其签名。

6分钟 读取·级别 参考·修改于 2026年10月12日
该英文文本是根据法文原文自动生成的,尚未经过审查。
该页面已自动翻译。英文版具有权威性。
#
班级

人工智能服务

方法描述
session(): Promise<AiSession>创建一个临时工单 AI 会话 (POST /v1/ai/{project_id}/session) 并为 chat/chatStream/embed返回现成的 AiSession 。
chat(messages: ChatMessage[], options?: { model?: string; temperature?: number; max_tokens?: number; system?: string; provider?: string; }): Promise<AuraResponse<ChatResponse>>发送聊天完成请求。
chatStream(messages: ChatMessage[], options?: { model?: string; temperature?: number; max_tokens?: number; signal?: AbortSignal; }): AsyncGenerator<ChatStreamChunk>流式聊天完成 (SSE)。
embed(req: EmbedRequest): Promise<AuraResponse<EmbedResponse>>为给定的输入生成嵌入。
rag(req: RagRequest): Promise<AuraResponse<RagResponse>>检索增强生成:查询集合并获得答案。
ragIngest(req: RagIngestRequest): Promise<AuraResponse<RagIngestResponse>>将文档摄取到 RAG 命名空间中。
listNamespaces(): Promise<AuraResponse<RagNamespace[]>>列出项目的 RAG 命名空间。
deleteNamespace(namespace: string): Promise<AuraResponse<RagDeleteResponse>>删除 RAG 命名空间(及其语料库)。
reindexNamespace(namespace: string): Promise<AuraResponse<RagReindexResponse>>使用当前嵌入模型重新索引 RAG 命名空间(模型/维度更改后的修复)。
semanticSearch(query: string, namespace: string, options?: { top_k?: number; threshold?: number; }): Promise<AuraResponse<SemanticSearchResult[]>>对嵌入命名空间的语义搜索。
nl2sql(question: string, options?: { dialect?: 'postgresql' | 'postgres'; examples?: Array<{ question: string; sql: string; }>; limit?: number; }): Promise<AuraResponse<Nl2SqlResult>>将问题翻译成 SQL。
#
班级

爱会话

临时票据 AI 会话:创建一个短暂的功能(POST /v1/ai/{project_id}/session,经典 apikey auth),然后将其用于 chat/chatStream/embed (Authorization: Bearer <ticket> ALONE — 从不 apikey)。

财产描述
get budgetRemaining(): number剩余代币预算,在最后一次调用时已知(如果尚未进行调用,则在铸造时已知)。
方法描述
static create(client: AuraClientLike): Promise<AiSession>创建一个新的 AI 会话。
chat(messages: ChatMessage[], options?: AiSessionChatOptions): Promise<AiSessionChatResult>此会话中未传输聊天内容。
chatStream(messages: ChatMessage[], options?: AiSessionChatStreamOptions): AsyncGenerator<ChatStreamChunk>此会话的流式聊天 (SSE)。
embed(input: string): Promise<AiSessionEmbedResult>嵌入此会话({input} → {embedding, budget_remaining})。
生成的页面

该页面是根据 SDK 的类型声明和注释生成的,因此它不会偏离已发布的代码。有关工作示例,请阅读指南。

最后更新· 2026年10月12日