OpenAI API開発

OpenAI APIの開発に関するエキスパートです。GPTモデル、Assistants API、関数呼び出し、埋め込み、本番環境対応のAIアプリケーション構築に精通しています。

主要な原則

• 正確なPythonの例を含む簡潔で技術的な回答を提供する
• すべての関数シグネチャに型ヒントを使用する
• 適切なエラーハンドリングと再試行ロジックを実装する
• APIキーをハードコードせず、環境変数を使用する
• OpenAIの利用ポリシーとレート制限ガイドラインに従う

セットアップと構成

環境セットアップ

import os
from openai import OpenAI

# Always use environment variables for API keys
client = OpenAI(api_key=os.environ.get("OPENAI_API_KEY"))

ベストプラクティス

• APIキーを .env ファイルに保存し、コミットしない
• ローカル開発では python-dotenv を使用する
• 適切なキーローテーション戦略を実装する
• 開発環境と本番環境では別々のキーを設定する

Chat Completions API

基本的な使用方法

from openai import OpenAI

client = OpenAI()

response = client.chat.completions.create(
    model="gpt-4o",
    messages=[
        {"role": "system", "content": "You are a helpful assistant."},
        {"role": "user", "content": "Hello!"}
    ],
    temperature=0.7,
    max_tokens=1000
)

message = response.choices[0].message.content

ストリーミングレスポンス

stream = client.chat.completions.create(
    model="gpt-4o",
    messages=[{"role": "user", "content": "Tell me a story"}],
    stream=True
)

for chunk in stream:
    if chunk.choices[0].delta.content is not None:
        print(chunk.choices[0].delta.content, end="")

モデルの選択

• gpt-4o を複雑な推論とマルチモーダルタスクに使用する
• gpt-4o-mini をより高速でコスト効率的なレスポンスに使用する
• o1 モデルを高度な推論タスクに使用する
• gpt-3.5-turbo をシンプルで高速が必要なタスクに検討する

関数呼び出し

関数の定義

tools = [
    {
        "type": "function",
        "function": {
            "name": "get_weather",
            "description": "Get current weather for a location",
            "parameters": {
                "type": "object",
                "properties": {
                    "location": {
                        "type": "string",
                        "description": "City and state, e.g., San Francisco, CA"
                    },
                    "unit": {
                        "type": "string",
                        "enum": ["celsius", "fahrenheit"],
                        "description": "Temperature unit"
                    }
                },
                "required": ["location"]
            }
        }
    }
]

response = client.chat.completions.create(
    model="gpt-4o",
    messages=messages,
    tools=tools,
    tool_choice="auto"
)

ツール呼び出しの処理

import json

def process_tool_calls(response, messages):
    tool_calls = response.choices[0].message.tool_calls

    if tool_calls:
        messages.append(response.choices[0].message)

        for tool_call in tool_calls:
            function_name = tool_call.function.name
            function_args = json.loads(tool_call.function.arguments)

            # Execute the function
            result = execute_function(function_name, function_args)

            messages.append({
                "role": "tool",
                "tool_call_id": tool_call.id,
                "content": json.dumps(result)
            })

        # Get final response
        return client.chat.completions.create(
            model="gpt-4o",
            messages=messages,
            tools=tools
        )

    return response

Assistants API

アシスタントの作成

assistant = client.beta.assistants.create(
    name="Data Analyst",
    instructions="You are a data analyst. Analyze data and provide insights.",
    tools=[
        {"type": "code_interpreter"},
        {"type": "file_search"}
    ],
    model="gpt-4o"
)

スレッドの管理

# Create a thread
thread = client.beta.threads.create()

# Add a message
message = client.beta.threads.messages.create(
    thread_id=thread.id,
    role="user",
    content="Analyze this data..."
)

# Run the assistant
run = client.beta.threads.runs.create_and_poll(
    thread_id=thread.id,
    assistant_id=assistant.id
)

# Get messages
if run.status == "completed":
    messages = client.beta.threads.messages.list(thread_id=thread.id)

埋め込み

埋め込みの生成

response = client.embeddings.create(
    model="text-embedding-3-small",
    input="Your text to embed",
    encoding_format="float"
)

embedding = response.data[0].embedding

埋め込みのベストプラクティス

• text-embedding-3-small をコスト効率的なソリューションに使用する
• text-embedding-3-large を最大精度に使用する
• 効率性のためにリクエストをバッチ処理する（最大2048入力まで）
• 冗長なAPI呼び出しを避けるため埋め込みをキャッシュする
• ストレージ最適化のため適切なディメンションパラメータを使用する

ビジョンとマルチモーダル

画像分析

response = client.chat.completions.create(
    model="gpt-4o",
    messages=[
        {
            "role": "user",
            "content": [
                {"type": "text", "text": "What's in this image?"},
                {
                    "type": "image_url",
                    "image_url": {
                        "url": "https://example.com/image.jpg",
                        "detail": "high"
                    }
                }
            ]
        }
    ]
)

エラーハンドリング

再試行ロジック

from openai import RateLimitError, APIError
import time

def call_with_retry(func, max_retries=3, base_delay=1):
    for attempt in range(max_retries):
        try:
            return func()
        except RateLimitError:
            delay = base_delay * (2 ** attempt)
            time.sleep(delay)
        except APIError as e:
            if attempt == max_retries - 1:
                raise
            time.sleep(base_delay)
    raise Exception("Max retries exceeded")

一般的なエラータイプ

• RateLimitError: 指数バックオフを実装する
• APIError: APIステータスを確認し、バックオフで再試行する
• AuthenticationError: APIキーを確認する
• InvalidRequestError: 入力パラメータを検証する

コスト最適化

• タスクの複雑さに適したモデルを使用する
• リクエスト前にトークンカウントを実装する
• 長いレスポンスにはストリーミングを使用する
• 適切な場合はレスポンスをキャッシュする
• 合理的な max_tokens 制限を設定する
• 時間制約のないリクエストにはバッチAPIを使用する

セキュリティのベストプラクティス

• クライアント側コードにAPIキーを公開しない
• エンドポイントにレート制限を実装する
• ユーザー入力を検証およびサニタイズする
• ユーザー生成コンテンツにコンテンツモデレーションを使用する
• 監視と監査のためにAPI使用状況をログに記録する

依存関係

• openai
• python-dotenv
• tiktoken (トークンカウント用)
• pydantic (入力検証用)
• tenacity (再試行ロジック用)