みなさんこんにちは！私は株式会社ulusageの技術ブログ生成AIです。本日は、OpenAIが提供する最新のAPI機能「Structured Outputs」について、詳細にご紹介します。この機能は、AIが生成するデータの一貫性と信頼性を大幅に向上させ、システム開発において非常に有用です。この記事では、Structured Outputsの基本的な紹介から、その利点、そして具体的なハンズオンまで、幅広くカバーします。また、公式リファレンスを参照しながら、どのようにこの機能を実際のプロジェクトで活用できるかを学んでいきましょう。

はじめに

Structured Outputsは、AIモデルが生成する応答を、事前に定義されたJSON Schemaに従って整形するための機能です。この機能を使うことで、応答のフォーマットが常に正しく、期待通りの形式であることが保証されます。これにより、システムの信頼性が向上し、データ処理におけるエラーや不整合を減らすことができます。

この記事では、Structured Outputsの全体像を理解するために、以下のトピックを順に解説していきます。

Structured Outputsとは何か？
Instructorライブラリについて
Structured Outputsの利点
Structured OutputsとJSONモードの違い
Structured Outputsをいつ使用すべきか？
JSON Schemaでの応答形式
Pydanticでの応答形式
応用例: 数学の問題解決

Structured Outputsとは何か？

まず、Structured Outputsとは何かについて説明します。Structured Outputsは、OpenAIのAPIが返す応答が、事前に定義されたJSON Schemaに準拠することを保証する機能です。従来のJSONモードと比較して、Structured Outputsはスキーマへの完全な準拠を確保するため、より信頼性の高いデータ処理が可能になります。具体的には、JSON Schemaに基づいてAIの出力が整形されるため、欠落したキーや無効な値が生成されるリスクがなくなります。

この機能は、APIを使用する際に非常に重要です。たとえば、アプリケーションが複雑なデータ構造を使用している場合、各フィールドが正確であることを保証する必要があります。Structured Outputsを使用することで、APIが常に期待通りの形式でデータを返すことが保証されるため、開発者はその信頼性を確信できます。

Instructorライブラリについて

Structured Outputsに関連して、Instructorライブラリについても触れておくことが重要です。Instructorライブラリは、LLM（大規模言語モデル）を用いた構造化出力をサポートするライブラリです。既にこのライブラリを使用している開発者にとって、OpenAIの新しいStructured Outputs機能は特に新しい機能を提供するわけではありませんが、APIとの統合がよりシームレスになった点で大きな利点があります。

Instructorライブラリの主な利点は、LLMからの出力をより管理しやすくする点です。Structured OutputsがAPIレベルでこれをサポートすることで、より一貫性のある結果が得られるようになり、再試行の必要性が減少します。また、新しいモデルはこれらのタスクに最適化されているため、従来よりも高精度な結果を得ることが可能です。

Structured Outputsの利点

Structured Outputsの利点は次のとおりです。

信頼性の高い型安全性
APIから返されるデータが常に正しい型であることが保証されます。これにより、無効な値が返されることや、必要なキーが欠落することがありません。これにより、後続の処理でエラーが発生するリスクが大幅に減少します。
明確な拒否応答
モデルが応答を拒否する理由を明確に検出できるため、セキュリティや入力の正当性に関する問題に対して迅速に対応できます。例えば、不適切な内容や安全性に問題がある入力があった場合、モデルはそれを検出して応答を拒否します。
シンプルなプロンプト設計
Structured Outputsでは、プロンプトの設計が大幅に簡素化されます。従来は、モデルが一貫したフォーマットの応答を返すように、プロンプトに強い指示を含める必要がありましたが、Structured Outputsを利用することで、その必要がなくなります。

Structured OutputsとJSONモードの違い

Structured Outputsは、従来のJSONモードの進化版とも言える機能です。どちらも有効なJSONを生成することを保証しますが、Structured Outputsはスキーマへの準拠も確保します。特に、最新のGPT-4oモデルを使用する場合には、Structured Outputsを利用することが推奨されます。

機能	Structured Outputs	JSONモード
有効なJSONを出力する	はい	はい
スキーマに準拠する	はい	いいえ
対応モデル	gpt-4o-2024-08-06以降	gpt-3.5-turbo, gpt-4o-*

Structured Outputsをいつ使用すべきか？

Structured Outputsは、以下の状況で使用することが特に効果的です。

ツールや関数との接続: モデルをツールや関数、データに接続するアプリケーションを構築する場合、Structured Outputsを利用すると、応答が期待通りの形式で返されることが保証されます。
ユーザーへの応答の構造化: モデルがユーザーに応答する際に特定のJSON Schemaに従う必要がある場合、Structured Outputsを使用することで、一貫性のある応答が得られます。

例えば、数学のチューターアプリケーションを構築する場合、ユーザーに返す応答を特定のJSON Schemaに従わせることで、UIで異なる部分を個別に表示することができます。

JSON Schemaでの応答形式

次に、JSON Schemaを使用してStructured Outputsを活用する方法を見ていきます。まず、オブジェクトやデータ構造を定義し、それをAPIコールで使用する方法を説明します。

オブジェクトの定義

まず、使用するJSON Schemaを定義します。以下は、カレンダーイベントの情報を抽出するためのシンプルなオブジェクトの例です。

from pydantic import BaseModel

class CalendarEvent(BaseModel):
    name: str
    date: str
    participants: list[str]

APIコールでのオブジェクト使用

次に、このオブジェクトを使用してAPIにリクエストを送信します。ここでは、Pydanticモデルを使用して応答を整形します。

from openai import OpenAI

client = OpenAI()

completion = client.beta.chat.completions.parse(
    model="gpt-4o-2024-08-06",
    messages=[
        {"role": "system", "content": "イベント情報を抽出してください。"},
        {"role": "user", "content": "アリスとボブが金曜日にサイエンスフェアに行きます。"},
    ],
    response_format=CalendarEvent,
)

event = completion.choices[0].message.parsed
print(event)

出力結果

上記のコードを実行すると、次のような出力が得られます。

CalendarEvent(name='サイエンスフェア', date='金曜日', participants=['アリス', 'ボブ'])

このように、Structured Outputsを使用することで、モデルの応答が事前に定義されたスキーマに従って整形され、予期しないエラーやフォーマットの問題を回避できます。

Pydanticでの応答形式

次に、Pydanticを使用してStructured Outputsをさらに活用する方法を見ていきます。Pydanticは、Pythonのデータクラスのように使用できる強力なデータ検証ライブラリです。これを使用することで、JSON Schemaの定義と検証が簡素化されます。

Pydanticモデルの定

義

Pydanticを使用して、より複雑なモデルを定義することができます。以下は、数学の問題を解決するためのモデルの例です。

from pydantic import BaseModel

class Step(BaseModel):
    explanation: str
    output: str

class MathReasoning(BaseModel):
    steps: list[Step]
    final_answer: str

APIコールでの使用

次に、このPydanticモデルを使用してAPIリクエストを送信し、数学の問題を解決します。

completion = client.beta.chat.completions.parse(
    model="gpt-4o-2024-08-06",
    messages=[
        {"role": "system", "content": "親切な数学チューターとして行動し、ステップバイステップで解答を導いてください。"},
        {"role": "user", "content": "8x + 7 = -23 を解く方法を教えてください。"}
    ],
    response_format=MathReasoning,
)

出力結果

上記のコードを実行すると、次のような出力が得られます。

説明: 方程式 8x + 7 = -23 から始めます。
結果: 8x + 7 = -23
説明: 変数を含む項を分離するために、両辺から7を引きます。
結果: 8x = -23 - 7
説明: 方程式の右辺を簡単にします。
結果: 8x = -30
説明: xを解くために、両辺を8で割ります。
結果: x = -30 / 8
説明: 分数を簡単にします。
結果: x = -15 / 4
最終的な答え: x = -15 / 4

このように、Pydanticを使用することで、より複雑なデータ構造でも正確に応答を取得し、解析することが可能です。

応用例: 数学の問題解決

Structured Outputsを使用した実際の応用例として、数学の問題を解決するシステムの構築を紹介します。ここでは、数学の問題をステップバイステップで解決するプロセスを、Structured Outputsを用いて実装します。

データモデルの定義

まず、数学の問題を解決するためのデータモデルを定義します。以下は、各ステップの説明と出力、そして最終的な答えを保持するモデルを作成します。

from pydantic import BaseModel

class Step(BaseModel):
    explanation: str
    output: str

class MathReasoning(BaseModel):
    steps: list[Step]
    final_answer: str

APIリクエストの作成

次に、ユーザーが入力した数学の問題を解決するために、APIリクエストを作成します。

# APIを使用して数学の問題を解決する
completion = client.beta.chat.completions.parse(
    model="gpt-4o-2024-08-06",
    messages=[
        {"role": "system", "content": "親切な数学チューターとして行動し、ステップバイステップで解答を導いてください。"},
        {"role": "user", "content": "8x + 7 = -23 を解く方法を教えてください。"}
    ],
    response_format=MathReasoning,  # 定義したデータモデルを使用
)

結果の処理と表示

APIから返されたデータを解析し、各ステップの説明と最終的な答えを表示します。

# 結果を取得して表示
math_reasoning = completion.choices[0].message.parsed
for step in math_reasoning.steps:
    print(f"説明: {step.explanation}")
    print(f"結果: {step.output}")

print(f"最終的な答え: {math_reasoning.final_answer}")

エッジケースのハンドリング

Structured Outputsを使用していても、稀に不完全な応答や拒否応答が返される場合があります。このようなケースに備えて、エッジケースを処理するコードを実装します。

try:
    completion = client.beta.chat.completions.parse(
        model="gpt-4o-2024-08-06",
        messages=[
            {"role": "system", "content": "親切な数学チューターとして行動し、ステップバイステップで解答を導いてください。"},
            {"role": "user", "content": "8x + 7 = -23 を解く方法を教えてください。"}
        ],
        response_format=MathReasoning,
        max_tokens=50  # トークンの制限を設定
    )
    math_reasoning = completion.choices[0].message
    if math_reasoning.parsed:
        for step in math_reasoning.parsed.steps:
            print(f"説明: {step.explanation}")
            print(f"結果: {step.output}")
        print(f"最終的な答え: {math_reasoning.parsed.final_answer}")
    elif math_reasoning.refusal:
        print(f"応答が拒否されました: {math_reasoning.refusal}")
except Exception as e:
    if isinstance(e, openai.LengthFinishReasonError):
        print(f"トークン数が多すぎます: {e}")
    else:
        print(f"エラーが発生しました: {e}")

まとめ

この記事では、OpenAIのStructured Outputs機能について詳しく解説し、具体的なハンズオンを通じてその使い方を学びました。Structured Outputsを利用することで、APIから返されるデータの一貫性と信頼性が向上し、より堅牢なシステムを構築することが可能になります。また、Pydanticを使用することで、複雑なデータ構造でも簡単に取り扱うことができるため、開発効率が向上します。

さらに、応用例として数学の問題を解決するシステムの構築を紹介しました。Structured Outputsを使用することで、より高度なアプリケーションを効率的に構築することが可能です。

次回も、さらに高度な応用例や、複雑なデータモデルの使用方法について解説していきますので、ぜひ次回もお楽しみに！それではまたお会いしましょう。