超便利！OpenAI API型固定レスポンスをPythonで実装（サンプルコードあり）　2つの使用例を紹介

By /

OpenAI APIを使った開発では、一般的にテキスト形式のレスポンスを受け取ることが主流です。しかし、システムが求めるデータが特定の形式に従う必要がある場合、型安全なレスポンスを直接取得できれば、コードの堅牢性と効率が大幅に向上します。

本記事では、OpenAI APIとPythonを用いて型安全なレスポンスを取得する方法を紹介します。特に、Pydanticモデルを利用して、レスポンスのデータ構造を明示的に定義する実装方法について詳しく解説します。

openai icon
目次
  1. 型固定レスポンスとは？
  2. 実装例
  3. 実装ポイントの解説
  4. 利用例
  5. 型固定レスポンスの利点
  6. 活用シーン
  7. まとめ

型固定レスポンスとは？

OpenAI APIは非常に柔軟性が高く、多様なタスクに対応できますが、得られるレスポンスはデフォルトでは単なるテキストデータです。これにより、特定のデータ形式を期待する場合には以下のような課題が生じることがあります。

  • レスポンスのパースが手作業になる
  • レスポンス形式が不明確な場合、想定外のエラーが発生しやすい
  • 型チェックが不足するため、後続の処理でバグが起きやすい

型固定レスポンスを利用すると、これらの問題を回避できます。OpenAI APIに指定したフォーマットでデータを取得することで、後処理をシンプルにし、コードの信頼性を向上させることが可能です。

実装例

以下は、PythonでOpenAI APIを用いて型固定レスポンスを取得する実装例です。このコードでは、OpenAIのAPIクライアントをカスタマイズしたOpenAIConnecterクラスを定義しています。

OpenAIのAPIの初期設定方法はこちら

上の記事を元に初期設定とAPIキーの取得を行ってください。
その後以下のコードをコピペします。

from openai import OpenAI
import dotenv
dotenv.load_dotenv()
import os

class OpenAIConnecter:
    """
    OpenAI APIへの接続を管理するクラス。
    型安全なレスポンスを取得するためのメソッドを提供します。
    """
    def __init__(self, model_name="gpt-4o"):
        self.client = OpenAI()  # OpenAIクライアントを初期化
        self.model_name = model_name  # 使用するモデルを指定

    def structured_message(self, sys_prompt: str, user_content: str, response_format):
        """
        型固定レスポンスを取得するメソッド。

        :param sys_prompt: システムプロンプト
        :param user_content: ユーザーの入力内容
        :param response_format: Pydanticモデルを利用した期待するレスポンス形式
        :return: 型安全なレスポンスまたはエラーメッセージ
        """
        try:
            # OpenAI APIへリクエストを送信
            completion = self.client.beta.chat.completions.parse(
                model=self.model_name,
                messages=[
                    {"role": "system", "content": sys_prompt},
                    {"role": "user", "content": user_content},
                ],
                response_format=response_format,
            )
            # レスポンスの解析
            response = completion.choices[0].message
            if response.parsed:
                return response.parsed  # 型固定レスポンスを返却
            elif response.refusal:
                print("OpenAIがリクエストを拒否しました。")
                print(response.refusal)
                return "申し訳ありませんが、リクエストにお応えできません。"
            else:
                return "申し訳ありませんが、レスポンスを取得できませんでした。"
        except Exception as e:
            # エラーハンドリング
            print("エラーが発生しました: ", e)
            return "申し訳ありませんが、エラーが発生しました。"

実装ポイントの解説

  1. OpenAIConnecterクラス
    • OpenAI APIクライアントの初期化と管理を行います。
    • 任意のモデル（デフォルトはgpt-4o）を指定可能です。
  2. structured_messageメソッド
    • システムプロンプト、ユーザー入力、期待するレスポンス形式（Pydanticモデル）を引数として受け取ります。Pydanticの利用方法はこちら
    • 型固定レスポンスを返却するため、OpenAIのparseメソッドを利用しています。
  3. エラーハンドリング
    • OpenAI APIがエラーや拒否応答を返した場合でも、適切なログとエラーメッセージを返します。
    • 想定外のエラーに対しても適切に対応できるように設計されています。

利用例

OpenAIConnecterクラスを活用した例をご紹介します。

1. 問い合わせフォームの自動応答システム

シナリオ:
ユーザーが問い合わせフォームに記入した内容を元に、自動的に応答メールを生成するシステムを構築します。
レスポンス形式として、以下のような構造を期待します：

  • 件名: 自動生成されたメールの件名
  • 本文: ユーザーへの返信内容
  • 優先度: 問い合わせの緊急度（低・中・高）

実装例:

from pydantic import BaseModel

# Pydanticモデルを定義
class ResponseFormat(BaseModel):
    subject: str
    body: str
    priority: str

# APIを呼び出して型固定レスポンスを取得
connector = OpenAIConnecter()
response = connector.structured_message(
    sys_prompt="あなたはカスタマーサポート担当です。以下の内容に基づき応答を作成してください。",
    user_content="商品の返品方法を教えてください。",
    response_format=ResponseFormat
)

print(response)

出力例

{
    "subject": "商品の返品方法について",
    "body": "返品方法は、購入履歴ページから手続きを進めてください。詳細な手順は以下のリンクをご覧ください。",
    "priority": "Normal"
}

2. JSONデータ生成によるデータエントリの効率化

シナリオ:
チャットベースのUIで、ユーザーからの入力を受け取り、後続のシステムに送信可能なJSON形式でデータを生成します。

実装例:

from pydantic import BaseModel

# Pydanticモデルを定義
class UserProfile(BaseModel):
    name: str
    age: int
    email: str

# APIを呼び出して型固定レスポンスを取得
connector = OpenAIConnecter()
response = connector.structured_message(
    sys_prompt="以下の入力に基づきユーザープロフィールを生成してください。",
    user_content="名前: 山田太郎、年齢: 30、メール: yamada@example.com",
    response_format=UserProfile
)

print(response)

出力例:

{
    "name": "山田太郎",
    "age": 30,
    "email": "yamada@example.com"
}

型固定レスポンスの利点

1. 型安全性の向上

Pydanticモデルを使ってレスポンス形式を事前に定義するため、取得したデータが予期せぬ形式になるリスクを軽減します。

2. 後続処理の簡略化

レスポンスを手動でパースする必要がなくなり、後続の処理でエラーが発生しにくくなります。

3. 開発の効率化

型固定レスポンスを利用することで、予期しないデータ形式の確認やデバッグ作業にかかる時間を削減できます。

活用シーン

  • API駆動のアプリケーション
    OpenAI APIを用いたツールやアプリケーションで、データの一貫性を確保したい場合に有用です。
  • データ解析やレポート生成
    型固定レスポンスを利用することで、データ解析パイプラインの安定性を向上できます。
  • 大規模プロジェクトの統一的な設計
    チーム開発において、型安全性が担保されたAPI設計はコードレビューや保守性を高めます。

まとめ

OpenAI APIの柔軟性を最大限に活用するためには、型固定レスポンスを用いることが有効です。本記事で紹介したコードを参考に、Pydanticモデルを用いた型安全なデータ取得を実装してみてください。これにより、より堅牢で拡張性の高いアプリケーションを開発することが可能になります。

参考：型固定の公式ドキュメント

関連投稿

上部へスクロール