API リファレンス
vue-llm
コンポーザブル
| エクスポート | 説明 |
|---|---|
useChat(options) | ストリーミング対応のマルチターンチャット |
useCompletion(options) | ストリーミング対応のシングルターン補完 |
useObject(options) | 構造化された JSON 出力のストリーミング |
usePrompt(template, variables) | リアクティブなプロンプトのレンダリング |
チャット UI（ヘッドレス）
| エクスポート | 説明 |
|---|---|
usePromptInput(chat, options?) | Enter で送信、IME 対応、自動で伸びるテキストエリア、ファイル選択・ペースト・ドロップによる添付 |
useAutoScroll(options?) | ストリーミング中は最下部に固定し、ユーザーが上にスクロールすると固定を解除 |
ミドルウェア
| エクスポート | 説明 |
|---|---|
wrapProvider(provider, middlewares) | プロバイダーにミドルウェアを適用する |
loggingMiddleware(label?) | コンソールへのログ出力 |
headerMiddleware(headers) | 追加の HTTP ヘッダー |
retryMiddleware(options?) | 指数バックオフによるリトライ |
rateLimitMiddleware(options) | クライアントサイドのリクエストキュー |
isRetryableError(error) | デフォルトのリトライポリシー |
ユーティリティ
| エクスポート | 説明 |
|---|---|
createPrompt(template, options?) | 型付きプロンプトテンプレート |
createChatPrompt(messages, options?) | 複数メッセージのテンプレート |
renderTemplate(template, variables) | 型なしの単発レンダリング |
createWebStorage(options?) | localStorage/sessionStorage アダプター |
createMemoryStorage() | インメモリーアダプター |
fileToDataURL(blob) | Blob を data URL として読み込む |
convertFilesToParts(files) | ファイル → FilePart[] |
LLMAPIError | HTTP エラークラス |
defineTool(tool) | execute を任意で持てる型付きツール |
parsePartialJSON(text) | ストリーミング中の不完全な JSON をパースする |
型
UIMessage, UIMessagePart, TextPart, ReasoningPart, ToolCallPart, FilePart, SourcePart, ToolDefinition, ChatTool, ToolCallState, ToolExecutionContext, ToolComponentProps, DeepPartial, ChatStatus, FinishReason, Usage, LLMProvider, ChatRequest, ChatMessage, ContentPart, ChatStreamResult, ChatStreamChunk, ChatResponse, Middleware, ChatHandler, RetryOptions, RateLimitOptions, ChatStorage, WebStorageOptions, FileInput, SendMessageInput, PromptTemplate, ChatPromptTemplate, ChatPromptMessage, PromptOptions, PromptInput, PromptValue, PromptVariables, PromptVariableNames、さらに各コンポーザブルの Use*Options / Use*Return。
vue-llm/providers
createOpenAI, createAnthropic, createGoogle, createOllama, createSSEProvider, createWebLLM, isWebGPUSupported.
vue-llm/server
createLLMHandler（サーバーツール を含む）、createProxyProvider、streamToSSE。
vue-llm/devtools
LLMDevtools：Vue DevTools プラグイン（@vue/devtools-api が必要）。
vue-llm/style.css
コンポーネント用のスタイル。
vue-llm/nuxt
vue-llm/components
MessageParts, StreamMarkdown, renderMarkdown, renderInline, escapeHTML.