
要約 — このレッスンの要点
- OpenAI は Python と TypeScript の公式 SDK を提供。インストールは pip / npm 1 行で完了する。
- SDK は認証ヘッダー管理・リトライ・型安全なレスポンス処理を自動的に行う。生 REST を叩く必要はない。
- 中心となる API は Responses API(
client.responses.create())もしくは Chat Completions(client.chat.completions.create())。新規実装は Responses API が推奨。 - 環境変数
OPENAI_API_KEYを設定しておけば、コード内でキーを指定しなくてもよい。 - コード例は OpenAI 公式 GitHub(Python / TypeScript)を一次情報とする。
SDK とは何か
SDK(Software Development Kit)は、API を簡単に利用するためのライブラリです。 OpenAI の公式 SDK を使うと、HTTP リクエストの組み立て・認証ヘッダーの付与・ エラーハンドリング・リトライ処理を SDK が肩代わりしてくれます。
公式 SDK は Python と TypeScript / JavaScript の 2 言語が提供されており、 どちらも OpenAI がメンテナンスしています (OpenAI: Libraries 参照)。
インストール
# Python
pip install openai
# TypeScript / JavaScript (Node.js)
npm install openai
Python — 最小コード例
以下は公式ドキュメントのコード例に準拠した最小構成です (openai-python 参照)。
from openai import OpenAI
client = OpenAI() # OPENAI_API_KEY 環境変数を自動読み込み
response = client.responses.create(
model="gpt-5",
input="こんにちは、Codex!",
)
print(response.output_text)
旧来の Chat Completions スタイルを使う場合:
from openai import OpenAI
client = OpenAI()
completion = client.chat.completions.create(
model="gpt-4o",
messages=[{"role": "user", "content": "こんにちは、GPT!"}],
)
print(completion.choices[0].message.content)
TypeScript — 最小コード例
TypeScript(ES Modules)での最小構成です (openai-node 参照)。
import OpenAI from "openai";
const client = new OpenAI(); // OPENAI_API_KEY 環境変数を自動読み込み
const response = await client.responses.create({
model: "gpt-5",
input: "こんにちは、Codex!",
});
console.log(response.output_text);
レスポンスの構造
Responses API が返すオブジェクトには主に以下のフィールドがあります。
output/output_text— テキスト生成結果。output_textでまとめて取得できる。model— 使用されたモデル名。status—"completed"/"incomplete"等の生成状態。usage— 入力・出力・推論トークン数。コスト計算に使う。
必須・主要パラメータの解説
| パラメータ | 説明 |
|---|---|
model |
使用するモデル ID。例: "gpt-5"、"gpt-4o"、"o3" |
input(Responses API)/ messages(Chat Completions) |
プロンプト本文。文字列または役割付きメッセージ配列を渡す。 |
max_output_tokens |
生成する最大トークン数(モデル・API により名称が異なる)。コスト管理のため設定推奨。 |
tools |
Function Calling を使う場合に渡す関数定義(次のレッスンで詳解)。 |
詳細記事
セットアップ全体の流れと実例は 「Codex / OpenAI 関連記事一覧」 で順次解説していきます。