SDK JavaScript: referência de IA
Cada método do serviço de IA e de sessões, com sua assinatura.
6 min lido·Nível referência·Revisado em 12 de out. de 2026
Este texto em inglês foi gerado automaticamente a partir do original em francês e ainda não foi revisado.
Esta página foi traduzida automaticamente. A versão em inglês é oficial.
#
Classe
AiService
| Método | Descrição |
|---|---|
session(): Promise<AiSession> | Cria uma sessão efêmera de AI de ticket (POST /v1/ai/{project_id}/session) e retorna um AiSession pronto para chat/chatStream/embed. |
chat(messages: ChatMessage[], options?: { model?: string; temperature?: number; max_tokens?: number; system?: string; provider?: string; }): Promise<AuraResponse<ChatResponse>> | Envie uma solicitação de conclusão do chat. |
chatStream(messages: ChatMessage[], options?: { model?: string; temperature?: number; max_tokens?: number; signal?: AbortSignal; }): AsyncGenerator<ChatStreamChunk> | Conclusão do chat transmitido (SSE). |
embed(req: EmbedRequest): Promise<AuraResponse<EmbedResponse>> | Gere embeddings para as entradas fornecidas. |
rag(req: RagRequest): Promise<AuraResponse<RagResponse>> | Geração aumentada de recuperação: consulte uma coleção e obtenha uma resposta. |
ragIngest(req: RagIngestRequest): Promise<AuraResponse<RagIngestResponse>> | Ingerir um documento em um namespace RAG. |
listNamespaces(): Promise<AuraResponse<RagNamespace[]>> | Lista os namespaces RAG do projeto. |
deleteNamespace(namespace: string): Promise<AuraResponse<RagDeleteResponse>> | Exclui um namespace RAG (e seu corpus). |
reindexNamespace(namespace: string): Promise<AuraResponse<RagReindexResponse>> | Reindexa um namespace RAG com o modelo de incorporação atual (correção após uma alteração de modelo/dimensão). |
semanticSearch(query: string, namespace: string, options?: { top_k?: number; threshold?: number; }): Promise<AuraResponse<SemanticSearchResult[]>> | Pesquisa semântica em um namespace incorporado. |
nl2sql(question: string, options?: { dialect?: 'postgresql' | 'postgres'; examples?: Array<{ question: string; sql: string; }>; limit?: number; }): Promise<AuraResponse<Nl2SqlResult>> | Traduz uma pergunta em SQL. |
#
Classe
AiSessão
Sessão efêmera de IA de ticket: crie um recurso de curta duração (POST /v1/ai/{project_id}/session, autenticação clássica apikey) e use-o para chat/chatStream/embed (Authorization: Bearer <ticket> SOZINHO — nunca apikey).
| Propriedade | Descrição |
|---|---|
get budgetRemaining(): number | Orçamento de token restante, conhecido na última chamada (ou na casa da moeda, se nenhuma chamada ainda tiver sido feita). |
| Método | Descrição |
|---|---|
static create(client: AuraClientLike): Promise<AiSession> | Crie uma nova sessão de IA. |
chat(messages: ChatMessage[], options?: AiSessionChatOptions): Promise<AiSessionChatResult> | Bate-papo não transmitido nesta sessão. |
chatStream(messages: ChatMessage[], options?: AiSessionChatStreamOptions): AsyncGenerator<ChatStreamChunk> | Bate-papo transmitido (SSE) nesta sessão. |
embed(input: string): Promise<AiSessionEmbedResult> | Incorporando nesta sessão ({input} → {embedding, budget_remaining}). |
Página gerada
Esta página é gerada a partir das declarações de tipo e comentários do SDK, portanto, não pode desviar do código publicado. Para exemplos resolvidos, leia os guias.
Última atualização · 12 de out. de 2026