Python OpenAI

openai は、OpenAI の一連のモデルやサービスと対話するための強力な Python ライブラリです。

openai はすべての RESTful API 呼び出しをカプセル化しており、開発者は自分の Python アプリケーションに自然言語処理、画像生成、音声認識などの強力な AI 機能を簡単に統合できます。

主な機能：

• テキスト生成：GPT-4 や GPT-5 などのモデルを使用して、記事、コード、要約、会話などを生成します。
• 画像生成：DALL-E モデルを使用して、テキストの説明に基づいて画像を作成します。
• 埋め込み（Embeddings）：テキストをベクトル表現に変換し、セマンティック検索、テキスト分類、クラスタリングなどのタスクに一般的に使用されます。
• 音声からテキストへ：Whisper モデルを使用して音声ファイルをテキストに書き起こします。
• 微調整（Fine-tuning）：独自のデータセットを提供して、より特化したモデルをトレーニングします。
• アシスタント（Assistants）API：コンテキストを理解し、ツールを呼び出し、長期的な対話ができる複雑なアプリケーションを構築します。

openai オープンソースアドレス：https://github.com/openai/openai-python

使い方は？

環境要件：

• Python バージョン：3.9 以上。
• 依存ライブラリ：httpx（デフォルト）、aiohttp（オプション）、websockets（Realtime API に必要）。

まず、pip で openai ライブラリをインストールする必要があります：

pip install openai

或

pip3 install openai

次に、OpenAI 公式サイトにアクセスしてhttps://platform.openai.com/ アカウントを登録し、API キーページで API Key を生成します。

インストールバージョン確認：

import openai
print(openai.__version__)  # 输出当前 SDK 版本

パラメータの説明：

サードパーティモデル

中国国内から現在 OpenAI にアクセスするのは少し面倒ですが、国内の多くも OpenAI に対応しています。例えば DeepSeek、千问、GLM などです。

DeepSeek

DeepSeek API は OpenAI の API 形式と完全に互換性があり、わずかな設定を変更するだけで、OpenAI SDK または互換ツールを使用して DeepSeek API に直接アクセスできます。

使用方法

次に、OpenAI SDK を使用して百炼サービス上の通义千问モデルにアクセスします。

非ストリーミング呼び出しの例

コードを実行すると、以下の結果が得られます：

私は通義千問（Qwen）です。阿里巴巴グループ傘下の通義実験室が独自に開発した超大規模言語モデルです。質問への回答や文章作成のお手伝いができます。例えば、物語や公文書、メール、脚本の執筆、論理推論、プログラミングなどが可能で、意見を述べたり、ゲームを楽しんだりすることもできます。何か質問やお困りごとがあれば、いつでもお気軽にお知らせください！

ストリーミング呼び出しの例

コードを実行すると、以下の結果が得られます：

私は通義千問（Qwen）です。阿里巴巴グループ傘下の通義実験室が独自に開発した超大規模言語モデルです。質問への回答や文章作成のお手伝いができます。例えば、物語や公文書、メール、脚本の執筆、論理推論、プログラミングなどが可能で、意見を述べたり、ゲームを楽しんだりすることもできます。何か質問やお困りごとがあれば、いつでもお気軽にお知らせください！

特徴的な機能

ビジョン（Vision）機能

画像入力（URL または Base64 エンコード）に対応し、マルチモーダル対話を実現します。

画像 URL 入力：

Base64 エンコード画像入力：

非同期使用（Async usage）

OpenAI を AsyncOpenAI に置き換え、await を使用して API を呼び出します：

基本的な非同期の例：

非同期シナリオの最適化（aiohttp バックエンド）のための拡張バージョンのインストール：

pip install openai[aiohttp]

aiohttp バックエンドの最適化：

ストリーミング応答（Streaming responses）

Server Side Events（SSE）に基づいて応答をリアルタイムに取得します。同期/非同期インターフェースは同じです。

同期ストリーミングの例：

非同期ストリーミングの例：

リアルタイム API（Realtime API）

低遅延のマルチモーダル対話（テキスト/音声）。WebSocket ベースで実装され、websockets ライブラリに依存します。

基本的なテキストの例：

リアルタイム API のエラー処理：

リファレンスマニュアル

以下の表の内容は次の通りです：

• 核心初始化：同步用 → コア初期化：同期用OpenAI、非同期用AsyncOpenAI、Azure 用 → 、Azure 用AzureOpenAI，推荐通过环境变量配置 API Key。→ 、API Keyは環境変数で設定することを推奨します。
• テキスト生成：新版では優先のにresponses.create()，经典场景用 → 、クラシックなシナリオではchat.completions.create()，流式输出需设置 → 、ストリーミング出力には設定が必要stream=True。
• 高级能力：支持多模态（图片输入）、实时 API、文件上传/微调，错误处理需捕获 → 高度な機能：マルチモーダル（画像入力）、リアルタイムAPI、ファイルアップロード/ファインチューニングに対応、エラー処理ではAPIError子类，超时/重试可灵活配置。→ サブクラスをキャッチし、タイムアウト/リトライを柔軟に設定できます。

インストールとインポート

安装官方 SDK：→ 公式SDKをインストール：

pip install --upgrade openai

导入核心类：→ コアクラスをインポート：

from openai import OpenAI, AsyncOpenAI, AzureOpenAI

クライアントの作成

创建标准 OpenAI 客户端：→ 標準のOpenAIクライアントを作成：

from openai import OpenAI

client = OpenAI(api_key="YOUR_API_KEY")

通过环境变量创建客户端：→ 環境変数でクライアントを作成：

import os
from openai import OpenAI

os.environ["OPENAI_API_KEY"] = "YOUR_API_KEY"
client = OpenAI()

リクエストのタイムアウトとリトライ回数を設定：

client = OpenAI(
    timeout=30,
    max_retries=2
)

テキスト生成（Responses API）

最も基本的なテキスト生成リクエスト：

response = client.responses.create(
    model="gpt-5.2",
    input="用一句话解释什么是 Python"
)

print(response.output_text)

instructions でモデルの動作を制約：

response = client.responses.create(
    model="gpt-5.2",
    instructions="你是一个严谨的 Python 教程作者",
    input="解释什么是列表推导式"
)

print(response.output_text)

マルチターン対話

input 配列を使用してコンテキスト付き対話を構築：

response = client.responses.create(
    model="gpt-5.2",
    input=[
        {"role": "user", "content": "Python 是什么？"},
        {"role": "assistant", "content": "Python 是一门高级编程语言。"},
        {"role": "user", "content": "它适合做什么？"}
    ]
)

print(response.output_text)

構造化出力（JSON Schema）

モデルにSchema準拠のJSONデータを返すよう要求：

response = client.responses.create(
    model="gpt-5.2",
    response_format={
        "type": "json_schema",
        "json_schema": {
            "name": "tech_summary",
            "schema": {
                "type": "object",
                "properties": {
                    "title": {"type": "string"},
                    "summary": {"type": "string"}
                },
                "required": ["title", "summary"]
            }
        }
    },
    input="介绍 asyncio"
)

print(response.output_parsed)

ツール呼び出し（Function Calling）

ツールを定義し、モデルに呼び出しを自動判断させる：→ ツールを定義し、モデルに呼び出しを自動判断させる：

tools = [
    {
        "type": "function",
        "function": {
            "name": "get_weather",
            "description": "获取城市天气",
            "parameters": {
                "type": "object",
                "properties": {
                    "city": {"type": "string"}
                },
                "required": ["city"]
            }
        }
    }
]

response = client.responses.create(
    model="gpt-5.2",
    tools=tools,
    input="北京今天天气怎么样？"
)

print(response.output)

ストリーミング出力（Streaming）

同步流式输出：→ 同期ストリーミング出力：

with client.responses.stream(
    model="gpt-5.2",
    input="写一段 Python 示例代码"
) as stream:
    for event in stream:
        if event.type == "response.output_text.delta":
            print(event.delta, end="")

异步流式输出：→ 非同期ストリーミング出力：

stream = await client.responses.create(
    model="gpt-5.2",
    input="解释什么是生成式 AI",
    stream=True
)

async for event in stream:
    print(event)

非同期呼び出し（AsyncOpenAI）

asyncio で非同期クライアントを使用：→ asyncio で非同期クライアントを使用：

import asyncio
from openai import AsyncOpenAI

client = AsyncOpenAI()

async def main():
    response = await client.responses.create(
        model="gpt-5.2",
        input="解释什么是事件循环"
    )
    print(response.output_text)

asyncio.run(main())

リアルタイム API（Realtime）

WebSocket を使用した低遅延のリアルタイム対話：

async with client.realtime.connect(model="gpt-realtime") as conn:
    await conn.session.update(
        session={"type": "realtime", "output_modalities": ["text"]}
    )

    await conn.conversation.item.create(
        item={
            "type": "message",
            "role": "user",
            "content": [{"type": "input_text", "text": "你好"}]
        }
    )

    async for event in conn:
        print(event)

画像生成

根据文本生成图片：→ テキストから画像を生成：

image = client.images.generate(
    model="gpt-image-1",
    prompt="一只在写代码的猫",
    size="1024x1024"
)

print(image.data[0].url)

埋め込み生成（Embeddings）

生成文本向量嵌入：→ テキストのベクトル埋め込みを生成：

embedding = client.embeddings.create(
    model="text-embedding-3-small",
    input="Hello world"
)

print(embedding.data[0].embedding)

音声からテキストへの変換（Speech to Text）

音声ファイルをテキストに変換：

audio_file = open("speech.mp3", "rb")

transcript = client.audio.transcriptions.create(
    model="whisper-1",
    file=audio_file
)

print(transcript.text)

テキストから音声への変換（Text to Speech）

テキストを音声ファイルに変換：

speech = client.audio.speech.create(
    model="gpt-4o-mini-tts",
    voice="alloy",
    input="你好，欢迎使用 OpenAI"
)

with open("output.mp3", "wb") as f:
    f.write(speech)

ファイル管理（Files API）

上传文件：→ ファイルをアップロード：

from pathlib import Path

client.files.create(
    file=Path("data.jsonl"),
    purpose="fine-tune"
)

列出文件：→ ファイルを一覧表示：

files = client.files.list()
for f in files:
    print(f.id, f.filename)

删除文件：→ ファイルを削除：

client.files.delete(file_id="file-xxx")

モデル微調整（Fine-tuning Jobs）

创建微调任务：→ ファインチューニングジョブを作成：

job = client.fine_tuning.jobs.create(
    training_file="file-xxx",
    model="gpt-3.5-turbo"
)

print(job.id, job.status)

Webhook 検証

验证并解析 Webhook 请求：→ Webhook リクエストを検証して解析：

event = client.webhooks.unwrap(request_body, request_headers)

仅验证签名：→ 署名のみを検証：

client.webhooks.verify_signature(request_body, request_headers)

エラー処理

SDK がスローする例外をキャッチ：

import openai

try:
    client.responses.create(
        model="gpt-5.2",
        input="test"
    )
except openai.RateLimitError as e:
    print("触发速率限制：", e)
except openai.APIConnectionError as e:
    print("连接失败：", e)

失敗したリクエストのリクエストIDを取得：

try:
    client.responses.create(model="gpt-5.2", input="test")
except openai.APIStatusError as exc:
    print(exc.request_id)

Azure OpenAI 互換

初始化 Azure OpenAI 客户端：→ Azure OpenAI クライアントを初期化：

from openai import AzureOpenAI

client = AzureOpenAI(
    api_version="2023-07-01-preview",
    azure_endpoint="https://xxx.openai.azure.com"
)

バージョンとログ

查看 SDK 版本：→ SDK のバージョンを確認：

import openai
print(openai.__version__)

开启 SDK 调试日志：→ SDK のデバッグログを有効化：

export OPENAI_LOG=debug

更多 API 参考：→ 詳細な API リファレンス：https://github.com/openai/openai-python/blob/main/api.md