164 lines
19 KiB
Plaintext
164 lines
19 KiB
Plaintext
page wrnexusai {
|
|
seo {
|
|
title = "@wrnexus/ai"
|
|
description = "Server-side Anthropic client with generation and streaming."
|
|
}
|
|
|
|
view {
|
|
<div class="docs-shell">
|
|
<a href="#main" class="skip-link">Skip to content</a>
|
|
<header class="topbar">
|
|
<a class="brand" href="/"><span>W</span> WRNexusJS</a>
|
|
<nav aria-label="Primary"><a href="/getting-started">Get started</a><a href="/packages">Packages</a><a href="https://component.wrnexusjs.dev/">Components</a><a href="/language">Language</a><a href="/architecture">Architecture</a></nav>
|
|
<div class="topbar-actions"><a class="preview-pill" href="/access">Private preview · v0.8.8</a><button data-wire-theme-toggle class="theme-button" aria-label="Toggle color theme" title="Toggle color theme">◐</button></div>
|
|
</header>
|
|
<div class="mobile-doc-nav"><details><summary>Browse documentation</summary><nav><a href="/getting-started">Get started</a><a href="/packages">Packages</a><a href="https://component.wrnexusjs.dev/">Components</a><a href="/language">Language</a><a href="/architecture">Architecture</a><a href="/tutorial">Tutorial</a><a href="/guides/project-structure">Guides</a><a href="/examples">Examples</a><a href="/search">Search</a></nav></details></div>
|
|
<main id="main" class="portal-main docs-layout docs-layout--navigation"><aside class="docs-section-menu" aria-label="Documentation sections"><nav>
|
|
<section><strong>Get started</strong><a href="/getting-started">Quick start</a><a href="/tutorial">Tutorial</a><a href="/guides/full-stack-auth-demo">Auth dashboard demo</a><a href="/guides/configuration-and-profiles">Configuration</a></section>
|
|
<section><strong>Build</strong><a href="/guides/pages-and-components">Pages and components</a><a href="/guides/routing">Routing</a><a href="/guides/server-data">Server data</a><a href="/guides/forms-and-validation">Forms and validation</a><a href="/guides/database">Database</a></section>
|
|
<section><strong>Auth and security</strong><a href="/guides/authentication">Authentication</a><a href="/guides/authorization">Authorization</a><a href="/guides/security">Application security</a><a href="/security">Security policy</a></section>
|
|
<section><strong>Reference</strong><a href="/packages">Packages overview</a><a href="/packages/cli">CLI</a><a href="/language">.wrn language</a><a href="https://component.wrnexusjs.dev/">Components</a><a href="/examples">Examples</a></section>
|
|
<section class="package-menu"><strong>Packages</strong><a href="/packages/ai">@wrnexus/ai</a><a href="/packages/auth">@wrnexus/auth</a><a href="/packages/authz">@wrnexus/authz</a><a href="/packages/benchmark">@wrnexus/benchmark</a><a href="/packages/cache">@wrnexus/cache</a><a href="/packages/captcha">@wrnexus/captcha</a><a href="/packages/cli">@wrnexus/cli</a><a href="/packages/compiler">@wrnexus/compiler</a><a href="/packages/content">@wrnexus/content</a><a href="/packages/core">@wrnexus/core</a><a href="/packages/csr">@wrnexus/csr</a><a href="/packages/db">@wrnexus/db</a><a href="/packages/dev-server">@wrnexus/dev-server</a><a href="/packages/dev-toolbar">@wrnexus/dev-toolbar</a><a href="/packages/encryption">@wrnexus/encryption</a><a href="/packages/graphql">@wrnexus/graphql</a><a href="/packages/helpers">@wrnexus/helpers</a><a href="/packages/i18n">@wrnexus/i18n</a><a href="/packages/identity">@wrnexus/identity</a><a href="/packages/image">@wrnexus/image</a><a href="/packages/jwt">@wrnexus/jwt</a><a href="/packages/language-server">@wrnexus/language-server</a><a href="/packages/mcp">@wrnexus/mcp</a><a href="/packages/mobile">@wrnexus/mobile</a><a href="/packages/native">@wrnexus/native</a><a href="/packages/oauth">@wrnexus/oauth</a><a href="/packages/observability">@wrnexus/observability</a><a href="/packages/playground">@wrnexus/playground</a><a href="/packages/plugin">@wrnexus/plugin</a><a href="/packages/pubsub">@wrnexus/pubsub</a><a href="/packages/pwa">@wrnexus/pwa</a><a href="/packages/queue">@wrnexus/queue</a><a href="/packages/reactive">@wrnexus/reactive</a><a href="/packages/realtime">@wrnexus/realtime</a><a href="/packages/router">@wrnexus/router</a><a href="/packages/security">@wrnexus/security</a><a href="/packages/ssr">@wrnexus/ssr</a><a href="/packages/store">@wrnexus/store</a><a href="/packages/styles">@wrnexus/styles</a><a href="/packages/syntax">@wrnexus/syntax</a><a href="/packages/test">@wrnexus/test</a><a href="/packages/tracking">@wrnexus/tracking</a><a href="/packages/typecheck">@wrnexus/typecheck</a><a href="/packages/ui">@wrnexus/ui</a><a href="/packages/uploader">@wrnexus/uploader</a><a href="/packages/validation">@wrnexus/validation</a></section>
|
|
</nav></aside><div class="docs-reading-column">
|
|
<article class="documentation prose standalone package-document"><nav class="breadcrumbs" aria-label="Breadcrumb"><a href="/">Home</a><span>/</span><a href="/packages">Packages</a><span>/</span><span aria-current="page">@wrnexus/ai</span></nav><section class="doc-intro"><span class="eyebrow">AI · Package reference</span><h1>@wrnexus/ai</h1><p>Server-side Anthropic client with generation and streaming.</p><div class="doc-meta"><span>v0.8.8</span><span>Private registry</span><span>AI</span></div><section id="access" class="access-callout"><h2>Install the package</h2><p>After WorkRoot approves private registry access, install the release-aligned package:</p><pre><code>bun add @wrnexus/ai@0.8.8</code><button type="button" class="copy-button" aria-label="Copy installation command">Copy</button></pre><p><a href="/access">Request preview access</a>. Never put registry tokens in source control.</p></section></section><section id="guide"><p>Provider-neutral AI orchestration for OpenAI, Anthropic, Google and local OpenAI-compatible models, with streaming, structured output, tools, embeddings, vector search/RAG, conversation persistence, templates, guardrails, usage events, fallback, rate limits and evaluation reports.</p>
|
|
<blockquote>A tiny, zero-dependency Claude (Anthropic) client for WRNexusJS apps — generate and stream text with Claude from any server-side code.</blockquote>
|
|
<p>Part of the <strong>WRNexusJS</strong> framework — an SSR-first, Bun-native full-stack web framework.</p>
|
|
<h3 id="overview">Overview</h3>
|
|
<p><code>@wrnexus/ai</code> is a thin, dependency-free wrapper over the Anthropic <strong>Messages API</strong>, built on <code>fetch</code> (Bun-native, no SDK). Use it in API routes, jobs, or middleware to call Claude. It defaults to the most capable model, <strong><code>claude-opus-4-8</code></strong>, reads your key from <code>ANTHROPIC_API_KEY</code>, and supports both one-shot generation and streaming.</p>
|
|
<pre data-language="bash"><code>bun add @wrnexus/ai</code></pre>
|
|
<blockquote>Private package — the machine must be authenticated to the <code>wrnexus</code> npm org</blockquote>
|
|
<blockquote>(a read token in <code>~/.npmrc</code>). Requires <strong>Bun</strong> (Node is not supported).</blockquote>
|
|
<p>Set your key in the environment (e.g. <code>.env</code>):</p>
|
|
<pre data-language=""><code>ANTHROPIC_API_KEY=sk-ant-...</code></pre>
|
|
<h3 id="api">API</h3>
|
|
<h4 id="createai-config"><code>createAI(config?)</code></h4>
|
|
<p>Creates a client. The key is read at call time, so it's safe to create at import.</p>
|
|
<pre data-language="ts"><code>import { createAI } from "@wrnexus/ai";
|
|
const ai = createAI(); // or createAI({ apiKey, model, maxTokens, baseURL, version })</code></pre>
|
|
<p><code>AIConfig</code> fields (all optional):</p>
|
|
<div class="table-wrap"><table>
|
|
<thead><tr><th>Field</th><th>Default</th><th>Description</th></tr></thead>
|
|
<tbody><tr><td><code>apiKey</code></td><td><code>ANTHROPIC_API_KEY</code></td><td>Anthropic API key</td></tr><tr><td><code>model</code></td><td><code>"claude-opus-4-8"</code></td><td>Model id</td></tr><tr><td><code>maxTokens</code></td><td><code>4096</code></td><td>Default max output tokens</td></tr><tr><td><code>baseURL</code></td><td><code>https://api.anthropic.com</code></td><td>API base URL</td></tr><tr><td><code>version</code></td><td><code>"2023-06-01"</code></td><td><code>anthropic-version</code> header</td></tr></tbody></table></div>
|
|
<h4 id="ai-generate-prompt-opts-promise-string"><code>ai.generate(prompt, opts?): Promise<string></code></h4>
|
|
<p>One-shot text generation. <code>prompt</code> is a string or a <code>Message[]</code> history.</p>
|
|
<pre data-language="ts"><code>const text = await ai.generate("Write a haiku about Bun.");
|
|
|
|
const reply = await ai.generate(
|
|
[
|
|
{ role: "user", content: "My name is Ada." },
|
|
{ role: "assistant", content: "Hi Ada!" },
|
|
{ role: "user", content: "What's my name?" },
|
|
],
|
|
{ system: "You are concise." },
|
|
);</code></pre>
|
|
<h4 id="ai-stream-prompt-opts-asyncgenerator-string"><code>ai.stream(prompt, opts?): AsyncGenerator<string></code></h4>
|
|
<p>Yields text deltas as they arrive.</p>
|
|
<pre data-language="ts"><code>for await (const chunk of ai.stream("Tell me a story.")) {
|
|
process.stdout.write(chunk);
|
|
}</code></pre>
|
|
<h4 id="ai-streamresponse-prompt-opts-response"><code>ai.streamResponse(prompt, opts?): Response</code></h4>
|
|
<p>Returns a streaming <code>text/plain</code> <code>Response</code> — drop it straight into an API route.</p>
|
|
<pre data-language="ts"><code>// app/api/chat.ts
|
|
import { createAI } from "@wrnexus/ai";
|
|
const ai = createAI();
|
|
|
|
export const POST = async (ctx) => {
|
|
const { prompt } = await ctx.req.json();
|
|
return ai.streamResponse(prompt);
|
|
};</code></pre>
|
|
<h4 id="generateoptions"><code>GenerateOptions</code></h4>
|
|
<div class="table-wrap"><table>
|
|
<thead><tr><th>Option</th><th>Type</th><th>Description</th></tr></thead>
|
|
<tbody><tr><td><code>system</code></td><td><code>string</code></td><td>System prompt</td></tr><tr><td><code>model</code></td><td><code>string</code></td><td>Override the model for this call</td></tr><tr><td><code>maxTokens</code></td><td><code>number</code></td><td>Override max output tokens</td></tr><tr><td><code>thinking</code></td><td><code>boolean</code></td><td>Enable adaptive extended thinking (deeper reasoning)</td></tr><tr><td><code>effort</code></td><td>`"low" \</td><td>"medium" \</td><td>"high" \</td><td>"xhigh" \</td><td>"max"`</td><td>Reasoning effort / token spend</td></tr><tr><td><code>messages</code></td><td><code>Message[]</code></td><td>Full history — supersedes <code>prompt</code></td></tr><tr><td><code>signal</code></td><td><code>AbortSignal</code></td><td>Cancel the request</td></tr></tbody></table></div>
|
|
<blockquote><code>temperature</code> / <code>top_p</code> are intentionally <strong>not</strong> exposed — the current Claude</blockquote>
|
|
<blockquote>models reject them (400). Steer output with prompting instead.</blockquote>
|
|
<h4 id="aierror"><code>AIError</code></h4>
|
|
<p>Thrown on non-2xx responses or a model refusal. Carries <code>.status</code> and <code>.type</code> (e.g. <code>"authentication_error"</code>, <code>"rate_limit_error"</code>, <code>"refusal"</code>).</p>
|
|
<pre data-language="ts"><code>import { AIError } from "@wrnexus/ai";
|
|
try {
|
|
await ai.generate("...");
|
|
} catch (e) {
|
|
if (e instanceof AIError && e.type === "rate_limit_error") {
|
|
/* back off */
|
|
}
|
|
}</code></pre>
|
|
<h4 id="multi-provider-client">Multi-provider client</h4>
|
|
<p><code>createAIClient</code> adds named-provider selection and fallback, capability discovery, validated JSON output, validated tool execution, abort-aware exponential retries, and per-provider circuit breakers. Attempt events intentionally contain metadata only: prompts, credentials, and raw model responses are never passed to telemetry.</p>
|
|
<pre data-language="ts"><code>import { anthropicProvider, createAIClient } from "@wrnexus/ai";
|
|
|
|
const ai = createAIClient({
|
|
providers: [anthropicProvider()],
|
|
retry: { attempts: 3, baseDelayMs: 100, maxDelayMs: 2_000 },
|
|
circuitBreaker: { failureThreshold: 5, resetAfterMs: 30_000 },
|
|
});
|
|
|
|
const result = await ai.generateObject<{ title: string }>("Return a JSON title", {
|
|
validate: (value): value is { title: string } =>
|
|
typeof value === "object" && value !== null && "title" in value,
|
|
});</code></pre>
|
|
<p>Providers can return normalized <code>usage</code> (<code>inputTokens</code>, <code>outputTokens</code>, <code>totalTokens</code>, and <code>costUsd</code>) and <code>toolCalls</code>. Use <code>executeTools</code> with a named, validated tool registry; unknown tools and invalid arguments are rejected before application code runs. <code>deterministicAIProvider</code> supplies ordered or computed offline responses for tests and examples without API keys or network calls.</p>
|
|
<h3 id="usage">Usage</h3>
|
|
<h4 id="return-generated-json-from-an-api-route">Return generated JSON from an API route</h4>
|
|
<pre data-language="ts"><code>// app/api/summarize.ts — summarize posted text
|
|
import { createAI } from "@wrnexus/ai";
|
|
const ai = createAI();
|
|
|
|
export const POST = async (ctx) => {
|
|
const { text } = await ctx.req.json().catch(() => ({}));
|
|
if (!text) return Response.json({ error: "Provide 'text'." }, { status: 400 });
|
|
const summary = await ai.generate(`Summarize in one sentence:\n\n${text}`, {
|
|
system: "You are a precise summarizer.",
|
|
});
|
|
return Response.json({ summary });
|
|
};</code></pre>
|
|
<h4 id="stream-a-chat-response-to-the-browser">Stream a chat response to the browser</h4>
|
|
<pre data-language="ts"><code>// app/api/chat.ts
|
|
import { createAI } from "@wrnexus/ai";
|
|
|
|
const ai = createAI({ model: "claude-sonnet-5" });
|
|
|
|
export const POST = async (ctx) => {
|
|
const { messages } = await ctx.req.json();
|
|
return ai.streamResponse(messages, {
|
|
system: "Answer using concise Markdown.",
|
|
maxTokens: 1_500,
|
|
});
|
|
};</code></pre>
|
|
<h3 id="requirements-notes">Requirements / Notes</h3>
|
|
<ul>
|
|
<li><strong>Bun-only.</strong> Uses <code>fetch</code>, <code>ReadableStream</code>, <code>TextDecoder</code>/<code>TextEncoder</code>, and</li>
|
|
<p>reads <code>ANTHROPIC_API_KEY</code> from <code>Bun.env</code> (falls back to <code>process.env</code>).</p>
|
|
<li><strong>Zero dependencies</strong> — no <code>@anthropic-ai/sdk</code>; talks to the Messages API directly.</li>
|
|
<li>Defaults to <code>claude-opus-4-8</code>. Pass <code>{ model }</code> for a different model (e.g.</li>
|
|
<p><code>"claude-sonnet-5"</code> for speed/cost, <code>"claude-haiku-4-5"</code> for the fastest).</p>
|
|
</ul></section><section id="api" class="api"><h2>Complete TypeScript API</h2><p>Generated from the exact installed package declarations.</p><pre data-language="typescript"><code>export { A as AI, a as AIAttemptEvent, b as AICircuitBreakerOptions, c as AIClient, d as AIClientOptions, e as AIConfig, f as AIError, AIGuardrail, g as AIProvider, h as AIProviderCapabilities, i as AIResult, j as AIRetryOptions, k as AITool, l as AIToolCall, m as AIUsage, ConversationStore, D as DeterministicAIProviderOptions, E as Effort, EmbeddingProvider, G as GenerateOptions, HttpAIProviderOptions, M as Message, R as Role, VectorMatch, VectorRecord, VectorStore, n as aiProvider, aiRateLimiter, o as anthropicProvider, p as createAI, q as createAIClient, createRagPipeline, r as deterministicAIProvider, evaluateAI, googleAIProvider, guardedProvider, localAIProvider, maxPromptLength, memoryConversationStore, memoryVectorStore, openAIEmbeddings, openAIProvider, promptTemplate } from './platform.js';
|
|
</code></pre></section><section id="examples" class="examples"><h2>Examples</h2><p>Copy-ready examples from the installed package documentation.</p><div class="example-grid"><article class="example-card"><h3>Return generated JSON from an API route</h3><pre data-language="ts"><code>// app/api/summarize.ts — summarize posted text
|
|
import { createAI } from "@wrnexus/ai";
|
|
const ai = createAI();
|
|
|
|
export const POST = async (ctx) => {
|
|
const { text } = await ctx.req.json().catch(() => ({}));
|
|
if (!text) return Response.json({ error: "Provide 'text'." }, { status: 400 });
|
|
const summary = await ai.generate(`Summarize in one sentence:\n\n${text}`, {
|
|
system: "You are a precise summarizer.",
|
|
});
|
|
return Response.json({ summary });
|
|
};</code></pre></article><article class="example-card"><h3>Stream a chat response to the browser</h3><pre data-language="ts"><code>// app/api/chat.ts
|
|
import { createAI } from "@wrnexus/ai";
|
|
|
|
const ai = createAI({ model: "claude-sonnet-5" });
|
|
|
|
export const POST = async (ctx) => {
|
|
const { messages } = await ctx.req.json();
|
|
return ai.streamResponse(messages, {
|
|
system: "Answer using concise Markdown.",
|
|
maxTokens: 1_500,
|
|
});
|
|
};</code></pre></article></div></section></article></div>
|
|
<aside class="on-this-page"><h2>On this page</h2><nav><a class="toc-level-2" href="#guide">Guide</a><a class="toc-level-3" href="#overview">Overview</a><a class="toc-level-3" href="#api">API</a><a class="toc-level-4" href="#createai-config">createAI(config?)</a><a class="toc-level-4" href="#ai-generate-prompt-opts-promise-string">ai.generate(prompt, opts?): Promise<string></a><a class="toc-level-4" href="#ai-stream-prompt-opts-asyncgenerator-string">ai.stream(prompt, opts?): AsyncGenerator<string></a><a class="toc-level-4" href="#ai-streamresponse-prompt-opts-response">ai.streamResponse(prompt, opts?): Response</a><a class="toc-level-4" href="#generateoptions">GenerateOptions</a><a class="toc-level-4" href="#aierror">AIError</a><a class="toc-level-4" href="#multi-provider-client">Multi-provider client</a><a class="toc-level-3" href="#usage">Usage</a><a class="toc-level-4" href="#return-generated-json-from-an-api-route">Return generated JSON from an API route</a><a class="toc-level-4" href="#stream-a-chat-response-to-the-browser">Stream a chat response to the browser</a><a class="toc-level-3" href="#requirements-notes">Requirements / Notes</a><a class="toc-level-2" href="#api">Complete API</a><a class="toc-level-2" href="#examples">Examples</a></nav></aside>
|
|
</main>
|
|
<footer><div class="footer-brand"><span class="footer-mark" aria-hidden="true">W</span><p><strong>WRNexusJS 0.8.8</strong><span>Complete API documentation generated from installed package declarations.</span></p></div><nav aria-label="Footer"><a href="/packages">All packages</a><a href="/getting-started">Get started</a><a href="/security">Security</a><a href="/support">Support</a><a href="/llms.txt">AI guide</a></nav><p class="footer-meta">Private Developer Preview · Bun-native</p></footer>
|
|
</div>
|
|
}
|
|
}
|