#25 Javaで学ぶAI API(ChatGPT等)の呼び出し方の基本

はじめに

ChatGPTのようなAI(人工知能)は、実は「API(エーピーアイ)」という仕組みを通じて、自分のプログラムから呼び出すことができます。APIとは「Application Programming Interface」の略で、あるサービスの機能を外部のプログラムから利用できるようにする「窓口」のようなものです。Javaは企業システムなどでよく使われる言語ですが、AI APIを呼び出す仕組みは意外とシンプルです。この記事では、JavaからAI APIを呼び出す基本の流れを、初めての人にもわかるように解説します。

AI APIを使う前に知っておきたいこと

APIキーとは何か

多くのAIサービスは、誰でも自由に使えるわけではなく「APIキー」と呼ばれる文字列を発行しています。これは利用者を識別するための合言葉のようなもので、リクエスト(サービスへの依頼)に添えることで「誰がどれだけ利用したか」をサービス側が把握できる仕組みです。APIキーは家の鍵と同じくらい大切な情報です。コードに直接書いてGitHubなどに公開してしまうと、第三者に無断で使われてしまう恐れがあるため、環境変数(プログラムの外側で値を管理し、実行時に読み込む仕組み)などを使って管理するのが基本です。

JavaはHTTP通信の準備が少し多め

PythonやJavaScriptでは、外部ライブラリなしでも比較的簡単にWeb通信ができる場合があります。一方Javaは「型(データの種類)」をきっちり指定する言語なので、通信内容やJSON(データをやり取りするための文字列形式)の扱いに一手間かかる印象があります。ただしJava11以降ではjava.net.http.HttpClientという通信用の機能が標準ライブラリに追加され、以前より簡潔にHTTP通信を書けるようになりました。今回はこの標準機能だけを使い、追加のライブラリなしでAI APIを呼び出す方法を紹介します。

HttpClientを使った呼び出し方の基本

HttpClientは、Webサービスにリクエストを送り、返ってきたレスポンス(応答)を受け取るためのJava標準の仕組みです。基本の書き方は次のようになります。

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class AiApiSample {
    public static void main(String[] args) throws Exception {
        String apiKey = System.getenv("AI_API_KEY"); // 環境変数からキーを読み込む

        String requestBody = """
            {"messages": [{"role": "user", "content": "こんにちは"}]}
            """;

        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://api.example.com/v1/chat"))
                .header("Content-Type", "application/json")
                .header("Authorization", "Bearer " + apiKey)
                .POST(HttpRequest.BodyPublishers.ofString(requestBody))
                .build();

        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

System.getenv("AI_API_KEY")は、環境変数からAPIキーを読み込む書き方です。APIキーをコードに直接書かずに済むため、先ほど触れた「キーを人目に触れさせない」ための代表的な方法です。また、コード中の"""で囲まれた部分は「テキストブロック」と呼ばれるJava15以降の書き方です。複数行の文字列を改行そのままで書けるので、JSONのような文字列を扱うときに読みやすくなります。

JSONの扱いに一手間かける

上のサンプルではリクエストの本文(送るデータ)を文字列として直接書きました。しかし実際のプログラムでは質問の内容が毎回変わるため、文字列を手作業で組み立てるとエラーの原因になりやすいです。JavaにはJSONを標準で組み立てる機能がありません。そのため実務ではJacksonやGsonといった外部ライブラリを使い、Javaのオブジェクト(データと処理をまとめたもの)をJSON文字列に変換するのが一般的です。まずは今回のように文字列を直接扱う方法で仕組みを理解し、必要になったタイミングでライブラリの導入を検討するとよいでしょう。

レスポンスについても同様で、response.body()で受け取れる文字列はJSON形式のままです。そこから欲しい情報だけを取り出すには、JSONを解析する処理が必要になります。慣れてくるまでは、まずSystem.out.printlnで内容を表示してみて、どんな形のデータが返ってきているかを確認しましょう。その習慣をつけておくと、後の処理がスムーズになります。

エラー時に気をつけたいこと

API呼び出しは必ず成功するとは限りません。APIキーが間違っている、通信が不安定、利用回数の上限に達しているなど、さまざまな理由でエラーが返ることがあります。こうした場合に備えて、tryとcatchという「エラーが起きても処理を止めずに対応する」ための構文を使うと安心です。

try {
    HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
    if (response.statusCode() != 200) {
        System.out.println("通信エラー: " + response.statusCode());
    } else {
        System.out.println(response.body());
    }
} catch (Exception e) {
    System.out.println("エラーが発生しました: " + e.getMessage());
}

response.statusCode()は、通信の結果を表す番号(ステータスコード)を確認できるメソッド(処理のまとまり)です。200番台であれば基本的に成功、400番台や500番台であれば何らかの問題が起きているサインです。エラーの内容には原因のヒントが含まれていることが多いので、まずは落ち着いてメッセージを確認してみましょう。

まとめ

JavaからAI APIを呼び出す基本の流れは、次の3ステップです。

  1. APIキーは環境変数などで管理し、コードに直接書かない
  2. 標準ライブラリのHttpClientを使い、JSON形式でリクエストを送る
  3. try/catchとステータスコードの確認でエラーに備える

Javaは型がきっちりしているぶん、他の言語より書く量がやや多く感じるかもしれません。しかしJava11以降はHttpClientが標準で使えるようになり、追加のライブラリなしでもAI APIを試せる環境が整っています。まずは今回のサンプルを動かしてみて、AIとのやり取りの感覚をつかんでみましょう。

関連記事

コメント

コメントを投稿

このブログの人気の投稿

#11 Rustで学ぶエラーハンドリングの基本

Rustのエラーハンドリングは、他の言語のような「例外」という仕組みを持たず、`Result`という型を使った独自の考え方が中心になります。この記事では、Rustにおけるエラーハンドリングの基本を解説します。 Result型という考え方 失敗する可能性がある処理は、`Result`という「成功か失敗かを表す型」を返します。 fn divide(a: i32, b: i32) -> Result<i32, String> { if b == 0 { return Err(String::from("0では割れません")); } Ok(a / b) } 成功時は`Ok`、失敗時は`Err`という形で結果を包んで返します。 matchで結果を扱う match divide(10, 0) { Ok(result) => println!("結果: {}", result), Err(message) => println!("エラー: {}", message), } ?という便利な記号 Rustには、`Result`がエラーだった場合に、その場で関数の呼び出し元にエラーを伝えて処理を中断できる`?`という記号があります。 fn calculate() -> Result<i32, String> { let result = divide(10, 0)?; Ok(result) } Rustならではの注意点 他の言語の「エラーが起きても気づかずに進んでしまう」という問題を防ぐため、Rustは`Result`の中身を確認しない限り、警告を出す仕組みになっています。エラーの可能性を無視できない設計こそが、Rustの安全性を支えています。 まとめ Rustのエラーハンドリングは`Result`型が中心で、`match`や`?`を使って結果を扱います。エラーの可能性を無視できない設計に慣れていきましょう。 本ページはプロモーションを含みます。 参考書籍(PR) Rustをもっと学びたい方には「 実践Rust入門[言語仕様から開発手法まで] 」がおすすめです。...
続きを読む

#16 TypeScriptで学ぶ辞書型(マップ)の基本

TypeScriptの辞書に相当する仕組みは、JavaScriptと同じですが、キーと値の型をあらかじめ決めておけるのが特徴です。この記事では、TypeScriptにおける辞書の扱い方を解説します。 型付きのオブジェクト interface Person { name: string; age: number; } const person: Person = { name: "太郎", age: 20 }; キーの型が決まっていない辞書 キーの名前が事前に決まっていない辞書のような使い方をしたい場合は、次のように書きます。 const scores: { [key: string]: number } = {}; scores["太郎"] = 90; Mapを使う場合 const person = new Map<string, string>(); person.set("name", "太郎"); `Map<string, string>`のように、キーと値それぞれの型を指定できます。 TypeScriptならではの注意点 型付きのオブジェクト(`interface`)を使うと、存在しないキーにアクセスしようとした際に、実行前の段階でエラーとして教えてもらえます。データの形が決まっている場合は、キーが自由な辞書よりも`interface`を使うほうが安全です。 まとめ TypeScriptの辞書は、形が決まっているなら`interface`、自由なキーを扱うなら`{ [key: string]: 型 }`や`Map`を使います。用途に応じて型の付け方を選びましょう。 本ページはプロモーションを含みます。 参考書籍(PR) TypeScriptをもっと学びたい方には「 プロを目指す人のためのTypeScript入門 」がおすすめです。
続きを読む

#19 Goで学ぶテスト(単体テスト)の基本

Goはシンプルな文法が魅力ですが、書いたコードが正しく動くかどうかは別問題です。この記事では、Goで書いたコードを自動でチェックする「テスト」の基本を解説します。 なぜテストを書くのか コードを修正するたびに、関連する機能が壊れていないかを手作業で確認するのは大変です。テストを用意しておけば、コマンド一つで動作確認ができ、安心してコードを直せるようになります。 Go標準のテスト機能 Goには追加のライブラリを入れなくても使える testing パッケージが標準で備わっています。テスト対象のファイルと同じディレクトリに、名前の末尾が _test.go のファイルを作ります。 // add.go package main func add(a int, b int) int { return a + b } // add_test.go package main import "testing" func TestAdd(t *testing.T) { result := add(2, 3) if result != 5 { t.Errorf("add(2, 3) = %d; want 5", result) } } テスト関数の名前は Test から始める決まりです。ターミナルで go test と実行すると、 _test.go 内の Test から始まる関数がすべて自動で実行されます。 複数パターンをまとめてテストする Goでは、複数の入力パターンをスライス(配列のようなもの)にまとめて、まとめてテストする書き方(テーブル駆動テスト)がよく使われます。 func TestAddCases(t *testing.T) { cases := []struct{ a, b, want int }{ {2, 3, 5}, {0, 0, 0}, {-1, 1, 0}, } for _, c := range cases { if got := add(c.a, c.b); got != c.want { t.Errorf("add(%d,...
続きを読む