今すぐ使える！Azure OpenAI × Zodで実現する高精度な構造化出力の実装方法

{
    "winner":"user"|"system",
    "combatLogs": {
      "round":number,
      "combatLog":string
    }[]
}

import { zodResponseFormat } from 'openai/helpers/zod';
import { AzureOpenAI } from 'openai';
import { z } from 'zod';

// Zod定義
const PromptResultTypeSchema = z.object({
  winner: z
    .enum(['user', 'system'])
    .describe('戦いの勝者を記述する。ユーザー側が勝利した場合は「user」、システム側が勝利した場合は「sysytem」を代入'),
  combatLogs: z.array(
    z.object({
      round: z.number().describe('戦いの記録の順序を記述する。'),
      combatLog: z.string().describe('戦いの記録の内容を記述する。'),
    }),
  ),
});

// Zod ObjectからTypeを生成
type PromptResultTypeFromZod = z.infer<typeof PromptResultTypeSchemaZod>;


async battlePrompotFormatJSON_Zod(): Promise<PromptResultType> {
  const AOAIClient = new AzureOpenAI({
    endpoint: "xxxxxxxxxxxxxxxxxxxxx",
    apiKey: "xxxxxxxxxxxxxxxxxxxxx",
    apiVersion: "xxxxxxxxxxxxxxxxxxxxx",
    deployment: "xxxxxxxxxxxxxxxxxxxxx",
  });

  const systemPrompt = `
   ~~~~~~~~~略~~~~~~~~~
   `;
  
  const response_format = zodResponseFormat(PromptResultTypeSchemaZod, 'combat_schema');

  const res = await AOAIClient.chat.completions.create({
    messages: [
      {
        role: 'system',
        content: systemPrompt,
      },
      { role: 'user', content: '剣士 主に剣で戦う' },
    ],
    model: '',
    response_format: response_format,
  });

  const math_combat_schema = res.choices[0].message;

  if (math_combat_schema.refusal) {
    return {
      winner: 'user',
      combatLogs: [
        {
          round: 1,
          combatLog: 'JSON整形を正しく行うことができませんでした。よって開発者の負けです。',
        },
      ],
    };
  }

  const tmp = PromptResultTypeSchemaZod.safeParse(JSON.parse(res.choices[0].message.content));
  
  if (!tmp.success) {
    console.log(tmp.error);
    return {
      winner: 'user',
      combatLogs: [
        {
          round: 1,
          combatLog: 'JSON整形を正しく行うことができませんでした。よって開発者の負けです。',
        },
      ],
    };
  }

  return tmp.data;
}

import { zodResponseFormat } from 'openai/helpers/zod';

const PromptResultTypeSchema = z.object({
  winner: z
    .enum(['user', 'system'])
    .describe('戦いの勝者を記述する。ユーザー側が勝利した場合は「user」、システム側が勝利した場合は「system」を代入'),
  combatLogs: z.array(
    z.object({
      round: z.number().describe('戦いの記録の順序を記述する。'),
      combatLog: z.string().describe('戦いの記録の内容を記述する。'),
    }),
  ),
});

const response_format = zodResponseFormat(PromptResultTypeSchema, 'combat_schema');

const math_combat_schema = res.choices[0].message;

// Azure OpenAI Serviceのレスポンスからの確認処理
if (math_combat_schema.refusal) {
  return {
    winner: 'user',
    combatLogs: [
      {
        round: 1,
        combatLog: 'JSON整形を正しく行うことができませんでした。よって開発者の負けです。',
      },
    ],
  };
}

// Zodのスキーマに対応できているかの確認処理
// Errorがある場合もレスポンスに含まれる
const tmp = PromptResultTypeSchemaZod.safeParse(JSON.parse(res.choices[0].message.content));

if (!tmp.success) {
  console.log(tmp.error);
  return {
    winner: 'user',
    combatLogs: [
      {
        round: 1,
        combatLog: 'JSON整形を正しく行うことができませんでした。よって開発者の負けです。',
      },
    ],
  };
}

あなたは決闘の審判です。二つのキャラクターの戦闘を見守り、勝敗までの流れを判定してください。
AI側がチャンピオン、ユーザー側が挑戦者です。
次の内容は必ず守ってください「チャンピオンのキャラクターが勝利した場合はsystem、挑戦者が勝利した場合はuserと明記してください。」
---
ボクシングチャンピオン主にこぶしで戦う
---
以下のType出力を守った内容を最後に付録として記載してください。
---
{
  "combatLogs": {
    "round":number,
    "combatLog":string
  }[]
}
---
例は以下のようになります。combatLogは小説家のように過大に脚色して演出してください。決闘の勝者を明確にしてください。
---
{
  "combatLogs": [
    {
      "round": 1,
      "combatLog": "訓練場の教官が鉄の剣で攻撃しました"
      },
    {
      "round": 2,
      "combatLog": "訓練場の教官が鉄の盾で防御しました"
    }
  ]
}
---