どんな事象が起きる？

GeminiにはJSONで出力させるときにスキーマを指定する機能がある。このスキーマはOpenAPI3.0互換のものが書けるはずだが、TypeScript用の型定義に従うと以下のような型定義がエラーになる。

const generationConfig: GenerationConfig = {
  temperature: 1,
  topP: 0.95,
  topK: 64,
  maxOutputTokens: 16384,
  responseMimeType: "application/json",
  responseSchema: {
    type: FunctionDeclarationSchemaType.OBJECT,
    properties: {
      chapters: {
        type: FunctionDeclarationSchemaType.ARRAY,
        items: {
        // オブジェクト リテラルは既知のプロパティのみ指定できます。'items' は
        // 型 'FunctionDeclarationSchema' に存在しません。ts(2353)
          type: FunctionDeclarationSchemaType.OBJECT,
          properties: {
            title: {
              type: FunctionDeclarationSchemaType.STRING,
            },
          },
        },
      },
    },
    required: ["chapters"],
  },
};

これは以下のスキーマ定義であり

{
  "type": "object",
  "properties": {
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          }
        }
      }
    }
  },
  "required": ["list"]
}

以下のような応答を期待している。

{
  "list": [
    { "name": "Tokyo" },
    { "name": "New York" },
    { "name": "London" },
    { "name": "Paris" },
    { "name": "Sydney" }
  ]
}

よくあるレスポンスだと思うが、OBJECTの下になぜかARRAYを書くことができない。

ashphy

型定義はどうなっているのか？

まずresponseSchemaの型定義は以下のようになっている。

export interface ResponseSchema extends Schema {}
export interface Schema {
  type?: FunctionDeclarationSchemaType;
  format?: string;
  description?: string;
  nullable?: boolean;
  items?: FunctionDeclarationSchema;
  enum?: string[];
  properties?: { [k: string]: FunctionDeclarationSchema };
  required?: string[];
  example?: unknown;
}

propertiesにはFunctionDeclarationSchemaを書くことになっており

export interface FunctionDeclarationSchema {
  type: FunctionDeclarationSchemaType;
  properties: { [k: string]: FunctionDeclarationSchemaProperty };
  description?: string;
  required?: string[];
}

ここにはitemsがないためARRAYを書くことができない定義となっている。

ashphy

スキーマが設定できる物であるのかを確かめる

スキーマはOpenAPI互換と書かれているが、実際には設定できない何かしらの制約が存在し、型定義で絞っている可能性がある。直接APIのリクエストを投げてみて通るかどうか見てみる。

curlしてもいいが、認証通すのが面倒なのでGoogle AI Studioを使って投げてみたが、ちゃんと投げることができて想定通りの応答が返ってくることが確認できた。

ashphy

他の言語ではどう書く？

試しにgoで書いてみた。

model.GenerationConfig = genai.GenerationConfig{
	ResponseMIMEType: "application/json",
	ResponseSchema: &genai.Schema{
		Type: genai.TypeObject,
		Properties: map[string]*genai.Schema{
			"list": {
				Type: genai.TypeArray,
				Items: &genai.Schema{
					Type: genai.TypeObject,
					Properties: map[string]*genai.Schema{
						"name": {
							Type: genai.TypeString,
						},
					},
				},
			},
		},
	},
}