@k8ordo/ui

生成UI

LLMに@k8ordo/uiのコンポーネントだけでUIを組み立てさせます。json-renderとOpenUIのどちらでも、プロンプトの生成から描画までをこのライブラリのアダプタで行えます。

インストール

json-renderとOpenUIのうち、使うほうのパッケージをzodと一緒に入れます。

json-render

bash
npm install @json-render/core @json-render/react zod

OpenUI

bash
npm install @openuidev/react-lang @openuidev/lang-core zod

対応するバージョンはjson-renderが0.22.x、OpenUIが1.xです。json-renderは0.x系なので、マイナーバージョンが上がると互換性が変わります。

警告

落とし穴

アダプタはjson-renderやOpenUIが持つReactのコンテキストを読みます。アプリと@k8ordo/uiがそれぞれ別のバージョンを解決しても、型とビルドは通ります。それでも描画のときに、フォームのコンポーネントがエラーになります。OpenUIならuseOpenUI must be used within a <Renderer /> component.、json-renderならuseStateStore must be used within a StateProviderです。バージョンはアプリの中で1つにそろえます。

プロンプトの生成

system-prompt.ts
import { catalog, uiRules } from '@k8ordo/ui/json-render';

const systemPrompt = catalog.prompt({ customRules: [...uiRules] });

@k8ordo/ui/json-renderはサーバーで読み込めます。Server Componentやサーバーの処理からcatalog.prompt()を呼べます。

uiRulesは、表の各行にセルを列の数だけ置くといった、LLMが破りやすい約束事の一覧です。customRulesに渡すと、プロンプトに書き足されます。

system-prompt.ts
const systemPrompt = catalog.prompt({
  customRules: [...uiRules, 'Write all UI text in Japanese.'],
UIの文の言語を決める約束事
});

アダプタがLLMに渡す説明は、アプリのロケールに関係なくすべて英語です。UIに書かれる文の言語を決めたいときは、約束事を自分で足します。

ブラウザでの描画

gen-ui.tsx
'use client';
import type { UISpec } from '@k8ordo/ui/json-render';
import { JsonRenderUI } from '@k8ordo/ui/json-render/registry';

export function GenUi({ spec }: { spec: UISpec }) {
  return (
    <JsonRenderUI
      spec={spec}
      onStateChange={(changes) => console.log(changes)}
    />
  );
}

JsonRenderUIはjson-renderのプロバイダ、レンダラー、コンポーネントの登録を1つにまとめたコンポーネントです。specを渡すだけで描けます。

フォームの値を集めるときはonStateChangeを渡します。変わったpathとvalueの配列を受け取ります。

出力の検証

ts
import { validateGeneratedSpec } from '@k8ordo/ui/json-render';

async function toSpec(
  output: string,
  ask: (prompt: string) => Promise<string>,
) {
  const result = validateGeneratedSpec(JSON.parse(output));
  if (result.ok) return result.spec;
  const retried = validateGeneratedSpec(
    JSON.parse(await ask(result.repairPrompt)),
  );
  return retried.ok ? retried.spec : null;
}

validateGeneratedSpecは、機械的に直せる誤りを直してから、specの構造とコンポーネントごとのpropsを確かめます。通ればspecを返します。

通らなければ、見つけた誤りの一覧issuesと、それをもとに作ったrepairPromptを返します。repairPromptはLLMにそのまま送り返せる文章です。

specの型

tsx
import type { UISpec } from '@k8ordo/ui/json-render';

const spec = {
  root: 'root',
  elements: {
    root: { type: 'Stack', props: { direction: 'column' }, children: ['ok'] },
    ok: { type: 'Button', props: { label: 'OK' } },
  },
} satisfies UISpec;

自分でspecを書くときは、satisfies UISpecを付けます。コンポーネントの名前やpropsを打ち間違えると、型エラーになります。

OpenUI

gen-ui.tsx
'use client';
import { library } from '@k8ordo/ui/openui';
import { Renderer } from '@openuidev/react-lang';

export function GenUi({ response }: { response: string }) {
  return <Renderer library={library} response={response} />;
}

OpenUIは、LLMが書いた文字列をlibraryで描きます。描画はClient Componentで行います。

system-prompt.ts
import { prompt } from '@k8ordo/ui/openui/prompt';

const systemPrompt = prompt();

プロンプトは@k8ordo/ui/openui/promptのprompt()で作ります。この入口はReactに依存しないので、サーバーで呼べます。UIの文の言語を決める約束事はadditionalRulesに渡します。

k8ordo

Baselineに入った機能を、制限なく使うReactのライブラリ群。