基本

構造化レスポンス

スキーマ (JSON または zod) を .respond() メソッドに渡すことで、LLMからの特定のレスポンス形式を強制できます。これにより、モデルの出力が提供されたスキーマに準拠することが保証されます。

Zodスキーマを使用した強制

指定されたスキーマを満たすJSONをモデルに生成させたい場合は、zod を使用してスキーマを提供することをお勧めします。zod スキーマが提供されると、予測結果には追加フィールド parsed が含まれ、解析、検証、型付けされた結果が格納されます。

zod スキーマを定義する

import { z } from "zod";

// A zod schema for a book
const bookSchema = z.object({
  title: z.string(),
  author: z.string(),
  year: z.number().int(),
});

構造化レスポンスを生成する

const result = await model.respond("Tell me about The Hobbit.",
  { structured: bookSchema },
  maxTokens: 100, // Recommended to avoid getting stuck
);

const book = result.parsed;
console.info(book);
//           ^
// Note that `book` is now correctly typed as { title: string, author: string, year: number }

JSONスキーマを使用した強制

JSONスキーマを使用して構造化レスポンスを強制することもできます。

JSONスキーマを定義する

// A JSON schema for a book
const schema = {
  type: "object",
  properties: {
    title: { type: "string" },
    author: { type: "string" },
    year: { type: "integer" },
  },
  required: ["title", "author", "year"],
};

構造化レスポンスを生成する

const result = await model.respond("Tell me about The Hobbit.", {
  structured: {
    type: "json",
    jsonSchema: schema,
  },
  maxTokens: 100, // Recommended to avoid getting stuck
});

const book = JSON.parse(result.content);
console.info(book);