【TypeScript】OpenAI APIとの型安全な統合ガイド - TypeScriptでAPIを安全に活用

OpenAI APIとは

OpenAI APIは、OpenAIが提供するAIサービスへのアクセスを可能にするAPIです。GPT-4やDALL-Eといった生成モデルを利用するためのインターフェースを提供し、テキスト生成や画像生成など多様なAIアプリケーションを開発するために利用されています。APIは一般的なREST APIとして提供されているため、HTTPリクエストを用いてさまざまなプログラミング言語から利用可能です。 TypeScriptを使用してこのAPIと統合することで、型安全性を確保しながら、予期せぬエラーを防ぎ、効率的で保守性の高いコードを実現できます。

TypeScriptでOpenAI APIを統合するメリット

TypeScriptを使ってAPIを利用すると、以下のようなメリットがあります。

• 型安全性の確保: リクエストとレスポンスに型定義を適用することで、データの不整合やエラーを防ぐことができます。
• コード補完の向上: 型定義に基づいたコード補完により、プロパティやメソッドの入力が自動補完され、開発効率が向上します。
• 保守性の向上: 型定義が明確にされることで、コードの可読性が向上し、他の開発者にもわかりやすいコードを提供できます。

OpenAI APIの型定義

TypeScriptでは、APIのリクエストとレスポンスに対して型定義を行うことで、より安全な開発が可能です。以下に、OpenAI APIの一般的なリクエストおよびレスポンスの型定義の例を示します。

リクエストパラメータの型定義

以下は、ChatGPT APIを呼び出す際のリクエストパラメータの型定義です。ChatCompletionRequestインターフェースを定義して、APIに送信するデータの構造を明確にします。

interface ChatCompletionRequest {
    model: string;
    messages: Array<{ role: "user" | "system" | "assistant"; content: string }>;
    max_tokens?: number;
    temperature?: number;
    top_p?: number;
}

modelやmessagesプロパティの型が明確になることで、誤ったデータ構造を送信するリスクが減り、リクエストの安全性が向上します。

レスポンスデータの型定義

レスポンスデータも型定義することで、APIから返されるデータを安全に処理することができます。以下の例は、ChatGPT APIのレスポンスの型定義です。

interface ChatCompletionResponse {
    id: string;
    object: string;
    created: number;
    choices: Array<{
        message: {
            role: "assistant";
            content: string;
        };
        finish_reason: string;
    }>;
    usage?: {
        prompt_tokens: number;
        completion_tokens: number;
        total_tokens: number;
    };
}

これにより、APIレスポンスのプロパティが明確に定義され、間違ったプロパティアクセスなどを防止できます。

OpenAI APIを呼び出すコードの実装

OpenAI APIを呼び出すには、fetchやaxiosといったHTTPクライアントを使用します。以下に、TypeScriptでAPIを呼び出し、リクエストとレスポンスの型定義を活用する例を示します。

fetchを使ったAPI呼び出し例

まずは、標準のfetch関数を用いた実装例です。

async function callOpenAIAPI(request: ChatCompletionRequest): Promise<ChatCompletionResponse> {
    const response = await fetch("https://api.openai.com/v1/chat/completions", {
        method: "POST",
        headers: {
            "Content-Type": "application/json",
            "Authorization": `Bearer ${process.env.OPENAI_API_KEY}`
        },
        body: JSON.stringify(request)
    });
    if (!response.ok) {
        throw new Error(`APIエラー: ${response.statusText}`);
    }
    return response.json() as Promise<ChatCompletionResponse>;
}

この例では、ChatCompletionRequest型のリクエストを受け取り、ChatCompletionResponse型のレスポンスを返す関数を定義しています。response.json()で型アサーションを行い、レスポンスが期待するデータ構造であることを保証します。

axiosを使ったAPI呼び出し例

axiosは、fetchよりも使いやすく、追加機能が豊富なHTTPクライアントです。以下は、axiosを用いたOpenAI API呼び出しの例です。

import axios from "axios";
async function callOpenAIAPIWithAxios(request: ChatCompletionRequest): Promise<ChatCompletionResponse> {
    const response = await axios.post<ChatCompletionResponse>(
        "https://api.openai.com/v1/chat/completions",
        request,
        {
            headers: {
                "Content-Type": "application/json",
                "Authorization": `Bearer ${process.env.OPENAI_API_KEY}`
            }
        }
    );
    return response.data;
}

この例では、axios.postに型を指定することで、response.dataの型も自動的にChatCompletionResponseになります。

エラーハンドリングと型安全性の強化

OpenAI APIを呼び出す際には、ネットワークエラーやAPIエラーが発生する可能性があります。これらのエラーに対応するために、エラーハンドリングを追加することが重要です。

エラーハンドリングの例

以下の例では、エラーハンドリングを追加して、エラーメッセージを適切に処理しています。

async function safeCallOpenAIAPI(request: ChatCompletionRequest): Promise<ChatCompletionResponse | null> {
    try {
        const response = await callOpenAIAPI(request);
        return response;
    } catch (error) {
        if (axios.isAxiosError(error)) {
            console.error("API呼び出しエラー:", error.response?.data);
        } else {
            console.error("予期しないエラー:", error);
        }
        return null;
    }
}

エラーが発生した場合にはログを出力し、nullを返すようにして、エラーが発生しても安全にアプリケーションが動作するようにします。

TypeScriptとOpenAI APIの活用例

OpenAI APIとTypeScriptを使って、具体的なユースケースを見てみましょう。例えば、ユーザーが入力した質問に対してAIが回答を生成するチャットボットを実装する場合、以下のようなコードで実現できます。

async function getChatbotResponse(userInput: string): Promise<string | null> {
    const request: ChatCompletionRequest = {
        model: "gpt-4",
        messages: [{ role: "user", content: userInput }],
        max_tokens: 100
    };
    const response = await safeCallOpenAIAPI(request);
    if (response) {
        return response
.choices[0].message.content;
    }
    return null;
}

この例では、ユーザーの入力を受け取ってAPIに送信し、AIの応答メッセージを取得します。TypeScriptの型定義を活用することで、ユーザーの入力からAIの応答までを型安全に処理することが可能です。

まとめ

TypeScriptを用いたOpenAI APIの統合により、リクエストとレスポンスの型定義を活用し、安全で保守性の高いコードを実現できます。APIの型定義やエラーハンドリングを正確に行うことで、実行時エラーを防ぎ、コード補完や読みやすさの向上も期待できます。OpenAI APIの機能をTypeScriptと組み合わせて、より信頼性の高いAIアプリケーションを構築してみてください。