Anthropic Java SDKは、Javaで書かれたアプリケーションからAnthropic REST APIへの便利なアクセスを提供します。リクエストの作成にはビルダーパターンを使用し、同期操作と非同期操作の両方をサポートしています。
コード例を含むAPI機能のドキュメントについては、APIリファレンスを参照してください。このページではJava固有のSDK機能と設定について説明します。
implementation("com.anthropic:anthropic-java:2.52.0")このライブラリにはJava 8以降が必要です。
SDKはJava 8以降をサポートしています。このドキュメントのコード例はJDK 25コンパクトソースファイルとして書かれており、素のvoid main()エントリポイントと出力用のIO.println()を使用しています。API呼び出し自体はサポートされているすべてのJDKで同一です。以前のバージョンで例をコンパイルするには、IO.println(...)をSystem.out.println(...)に置き換え、本体をクラス内のpublic static void main(String[] args)の中に配置してください。
import com.anthropic.client.AnthropicClient;
import com.anthropic.client.okhttp.AnthropicOkHttpClient;
import com.anthropic.models.messages.Message;
import com.anthropic.models.messages.MessageCreateParams;
import com.anthropic.models.messages.Model;
// システムプロパティ `anthropic.apiKey`、`anthropic.authToken`、`anthropic.baseUrl` を使用して設定します
// または環境変数 `ANTHROPIC_API_KEY`、`ANTHROPIC_AUTH_TOKEN`、`ANTHROPIC_BASE_URL` を使用して設定します
AnthropicClient client = AnthropicOkHttpClient.fromEnv();
MessageCreateParams params = MessageCreateParams.builder()
.maxTokens(1024L)
.addUserMessage("Hello, Claude")
.model(Model.CLAUDE_OPUS_5)
.build();
Message message = client.messages().create(params);システムプロパティまたは環境変数を使用してクライアントを設定します。
import com.anthropic.client.AnthropicClient;
import com.anthropic.client.okhttp.AnthropicOkHttpClient;
// システムプロパティ `anthropic.apiKey`、`anthropic.authToken`、`anthropic.baseUrl` を使用して設定します
// または環境変数 `ANTHROPIC_API_KEY`、`ANTHROPIC_AUTH_TOKEN`、`ANTHROPIC_BASE_URL` を使用して設定します
AnthropicClient client = AnthropicOkHttpClient.fromEnv();または手動で設定します。
import com.anthropic.client.AnthropicClient;
import com.anthropic.client.okhttp.AnthropicOkHttpClient;
AnthropicClient client = AnthropicOkHttpClient.builder()
.apiKey("my-anthropic-api-key")
.build();または両方のアプローチを組み合わせて使用します。
import com.anthropic.client.AnthropicClient;
import com.anthropic.client.okhttp.AnthropicOkHttpClient;
AnthropicClient client = AnthropicOkHttpClient.builder()
// システムプロパティまたは環境変数を使用して設定します
.fromEnv()
.apiKey("my-anthropic-api-key")
.build();Workload Identity Federationを含む認証オプションについては、認証を参照してください。
| セッター | システムプロパティ | 環境変数 | 必須 | デフォルト値 |
|---|---|---|---|---|
apiKey | anthropic.apiKey | ANTHROPIC_API_KEY | false | - |
authToken | anthropic.authToken | ANTHROPIC_AUTH_TOKEN | false | - |
baseUrl | anthropic.baseUrl | ANTHROPIC_BASE_URL | true | "https://api.anthropic.com" |
システムプロパティは環境変数よりも優先されます。
同じアプリケーション内で複数のクライアントを作成しないでください。各クライアントはコネクションプールとスレッドプールを持っており、リクエスト間で共有する方が効率的です。
同じコネクションプールとスレッドプールを再利用しながら、変更されたクライアント設定を一時的に使用するには、任意のクライアントまたはサービスでwithOptions()を呼び出します。
import com.anthropic.client.AnthropicClient;
AnthropicClient clientWithOptions = client.withOptions(optionsBuilder -> {
optionsBuilder.baseUrl("https://example.com");
optionsBuilder.maxRetries(42);
});withOptions()メソッドは、元のクライアントやサービスには影響しません。
デフォルトのクライアントは同期的です。非同期実行に切り替えるには、async()メソッドを呼び出します。
import com.anthropic.client.AnthropicClient;
import com.anthropic.client.okhttp.AnthropicOkHttpClient;
import com.anthropic.models.messages.Message;
import com.anthropic.models.messages.MessageCreateParams;
import com.anthropic.models.messages.Model;
AnthropicClient client = AnthropicOkHttpClient.fromEnv();
MessageCreateParams params = MessageCreateParams.builder()
.maxTokens(1024L)
.addUserMessage("Hello, Claude")
.model(Model.CLAUDE_OPUS_5)
.build();
CompletableFuture<Message> message = client.async().messages().create(params);または最初から非同期クライアントを作成します。
import com.anthropic.client.AnthropicClientAsync;
import com.anthropic.client.okhttp.AnthropicOkHttpClientAsync;
import com.anthropic.models.messages.Message;
import com.anthropic.models.messages.MessageCreateParams;
import com.anthropic.models.messages.Model;
AnthropicClientAsync client = AnthropicOkHttpClientAsync.fromEnv();
MessageCreateParams params = MessageCreateParams.builder()
.maxTokens(1024L)
.addUserMessage("Hello, Claude")
.model(Model.CLAUDE_OPUS_5)
.build();
CompletableFuture<Message> message = client.messages().create(params);非同期クライアントは同期クライアントと同じオプションをサポートしていますが、ほとんどのメソッドはCompletableFutureを返します。
SDKは、レスポンスの「チャンク」ストリームを返すメソッドを定義しています。各チャンクは、完全なレスポンスを待つのではなく、到着次第個別に処理できます。
これらのストリーミングメソッドは、同期クライアントではStreamResponseを返します。
import com.anthropic.core.http.StreamResponse;
import com.anthropic.models.messages.RawMessageStreamEvent;
try (StreamResponse<RawMessageStreamEvent> streamResponse = client.messages().createStreaming(params)) {
streamResponse.stream().forEach(chunk -> {
IO.println(chunk);
});
IO.println("No more chunks!");
}非同期クライアントの場合、メソッドはAsyncStreamResponseを返します。
import com.anthropic.core.http.AsyncStreamResponse;
import com.anthropic.models.messages.RawMessageStreamEvent;
client.async().messages().createStreaming(params).subscribe(chunk -> {
IO.println(chunk);
});
// ストリームのエラーや完了を処理する必要がある場合
client.async().messages().createStreaming(params).subscribe(new AsyncStreamResponse.Handler<>() {
@Override
public void onNext(RawMessageStreamEvent chunk) {
IO.println(chunk);
}
@Override
public void onComplete(Optional<Throwable> error) {
if (error.isPresent()) {
IO.println("Something went wrong!");
throw new RuntimeException(error.get());
} else {
IO.println("No more chunks!");
}
}
});
// またはfuturesを使用
client.async().messages().createStreaming(params)
.subscribe(chunk -> {
IO.println(chunk);
})
.onCompleteFuture()
.whenComplete((unused, error) -> {
if (error != null) {
IO.println("Something went wrong!");
throw new RuntimeException(error);
} else {
IO.println("No more chunks!");
}
});非同期ストリーミングは、現在のスレッドをブロックせずにストリーミングするために、クライアントごとの専用キャッシュスレッドプールExecutorを使用します。別のExecutorを使用するには、次のようにします。
Executor executor = Executors.newFixedThreadPool(4);
client.async().messages().createStreaming(params).subscribe(
chunk -> IO.println(chunk), executor
);またはstreamHandlerExecutorメソッドを使用してクライアントをグローバルに設定します。
import com.anthropic.client.AnthropicClient;
import com.anthropic.client.okhttp.AnthropicOkHttpClient;
AnthropicClient client = AnthropicOkHttpClient.builder()
.fromEnv()
.streamHandlerExecutor(Executors.newFixedThreadPool(4))
.build();MessageAccumulatorは、レスポンス内のイベントストリームを処理されるたびに記録し、非ストリーミングAPIが返すものと同様のMessageオブジェクトを蓄積できます。
同期レスポンスの場合、ストリームパイプラインにStream.peek()呼び出しを追加して各イベントを蓄積します。
import com.anthropic.core.http.StreamResponse;
import com.anthropic.helpers.MessageAccumulator;
import com.anthropic.models.messages.Message;
import com.anthropic.models.messages.RawMessageStreamEvent;
MessageAccumulator messageAccumulator = MessageAccumulator.create();
try (StreamResponse<RawMessageStreamEvent> streamResponse =
client.messages().createStreaming(createParams)) {
streamResponse.stream()
.peek(messageAccumulator::accumulate)
.flatMap(event -> event.contentBlockDelta().stream())
.flatMap(deltaEvent -> deltaEvent.delta().text().stream())
.forEach(textDelta -> IO.print(textDelta.text()));
}
Message message = messageAccumulator.message();非同期レスポンスの場合、subscribe()呼び出しにMessageAccumulatorを追加します。
import com.anthropic.helpers.MessageAccumulator;
import com.anthropic.models.messages.Message;
MessageAccumulator messageAccumulator = MessageAccumulator.create();
client.async().messages()
.createStreaming(createParams)
.subscribe(event -> messageAccumulator.accumulate(event).contentBlockDelta().stream()
.flatMap(deltaEvent -> deltaEvent.delta().text().stream())
.forEach(textDelta -> IO.print(textDelta.text())))
.onCompleteFuture()
.join();
Message message = messageAccumulator.message();BetaMessageオブジェクトの蓄積にはBetaMessageAccumulatorも利用できます。これはMessageAccumulatorと同じ方法で使用します。
Javaの例を含む構造化出力の完全なドキュメントについては、構造化出力を参照してください。
Claudeでのツール使用を使用すると、外部ツールや関数をAIモデルのレスポンスに直接統合できます。プレーンテキストを生成する代わりに、モデルは適切な場合にツールや関数を呼び出すための指示(パラメータ付き)を出力できます。ツールのJSONスキーマを定義すると、モデルはそのスキーマを使用して、これらのツールをいつどのように使用するかを判断します。
ツール使用機能は、AIモデルからのJSON出力が入力パラメータで提供したJSONスキーマに準拠することを保証する「strict」モードをサポートしています。
SDKは、任意のJavaクラスの構造からツールとそのパラメータを自動的に導出できます。クラス名(スネークケースに変換されたもの)がツール名となり、クラスのフィールドがツールのパラメータを定義します。
ツールクラスはトップレベルクラスまたはstaticネストクラスとして宣言してください。この要件は、SDKがツール入力をクラスインスタンスにデシリアライズするために使用するJackson Databindライブラリ(com.fasterxml.jackson.databind)に由来するもので、このライブラリは非staticな内部クラスをインスタンス化できません。
import com.fasterxml.jackson.annotation.JsonClassDescription;
import com.fasterxml.jackson.annotation.JsonPropertyDescription;
enum Unit {
CELSIUS,
FAHRENHEIT;
public String toString() {
return switch (this) {
case CELSIUS -> "C";
case FAHRENHEIT -> "F";
};
}
public double fromKelvin(double temperatureK) {
return switch (this) {
case CELSIUS -> temperatureK - 273.15;
case FAHRENHEIT -> (temperatureK - 273.15) * 1.8 + 32.0;
};
}
}
@JsonClassDescription("Get the weather in a given location")
static class GetWeather {
@JsonPropertyDescription("The city and state, e.g. San Francisco, CA")
public String location;
@JsonPropertyDescription("The unit of temperature")
public Unit unit;
public Weather execute() {
double temperatureK = switch (location) {
case "San Francisco, CA" -> 300.0;
case "New York, NY" -> 310.0;
case "Dallas, TX" -> 305.0;
default -> 295;
};
return new Weather(String.format("%.0f%s", unit.fromKelvin(temperatureK), unit));
}
}
static class Weather {
public String temperature;
public Weather(String temperature) {
this.temperature = temperature;
}
}ツールクラスを定義したら、MessageCreateParams.Builder.addTool(Class<T>)を使用してメッセージパラメータに追加し、AIモデルのレスポンスで要求された場合にそれらを呼び出します。BetaToolUseBlock.input(Class<T>)を使用すると、JSON形式のツールパラメータをツール定義クラスのインスタンスにパースできます。
ツールを呼び出した後、BetaToolResultBlockParam.Builder.contentAsJson(Object)を使用してツールの結果をAIモデルに返します。
import com.anthropic.client.AnthropicClient;
import com.anthropic.client.okhttp.AnthropicOkHttpClient;
import com.anthropic.models.beta.messages.*;
import com.anthropic.models.messages.Model;
AnthropicClient client = AnthropicOkHttpClient.fromEnv();
MessageCreateParams.Builder createParamsBuilder = MessageCreateParams.builder()
.model(Model.CLAUDE_OPUS_5)
.maxTokens(2048)
.addTool(GetWeather.class)
.addUserMessage("What's the temperature in New York?");
client.beta().messages().create(createParamsBuilder.build()).content().stream()
.flatMap(contentBlock -> contentBlock.toolUse().stream())
.forEach(toolUseBlock -> createParamsBuilder
// ツール使用がリクエストされたことを示すメッセージを追加します。
.addAssistantMessageOfBetaContentBlockParams(
List.of(BetaContentBlockParam.ofToolUse(BetaToolUseBlockParam.builder()
.name(toolUseBlock.name())
.id(toolUseBlock.id())
.input(toolUseBlock._input())
.build())))
// リクエストされたツール使用の結果を含むメッセージを追加します。
.addUserMessageOfBetaContentBlockParams(
List.of(BetaContentBlockParam.ofToolResult(BetaToolResultBlockParam.builder()
.toolUseId(toolUseBlock.id())
.contentAsJson(callTool(toolUseBlock))
.build()))));
client.beta().messages().create(createParamsBuilder.build()).content().stream()
.flatMap(contentBlock -> contentBlock.text().stream())
.forEach(textBlock -> IO.println(textBlock.text()));
private static Object callTool(BetaToolUseBlock toolUseBlock) {
if (!"get_weather".equals(toolUseBlock.name())) {
throw new IllegalArgumentException("Unknown tool: " + toolUseBlock.name());
}
GetWeather tool = toolUseBlock.input(GetWeather.class);
return tool != null ? tool.execute() : new Weather("unknown");
}ツール名はキャメルケースのツールクラス名(例:GetWeather)から導出され、スネークケース(例:get_weather)に変換されます。単語の境界は、現在の文字が最初の文字ではなく、大文字であり、かつ前の文字が小文字であるか、次の文字が小文字である場合に始まります。たとえば、MyJSONParserはmy_json_parserになり、ParseJSONはparse_jsonになります。この変換は@JsonTypeNameアノテーションを使用して上書きできます。
ツールクラスから導出されたJSONスキーマがAnthropicの制限に準拠しているかどうかをローカルで検証できます。ローカル検証はデフォルトで有効になっていますが、無効にすることもできます。
MessageCreateParams.Builder createParamsBuilder = MessageCreateParams.builder()
.model(Model.CLAUDE_OPUS_5)
.maxTokens(2048)
.addTool(GetWeather.class, JsonSchemaLocalValidation.NO)
.addUserMessage("What's the temperature in New York?");アノテーションを使用して、ツールに関する追加情報をJSONスキーマに追加できます。
@JsonClassDescription - ツールクラスに、そのツールをいつどのように使用するかを詳述する説明を追加します。@JsonTypeName - ツール名を、クラスの単純名をスネークケースに変換したもの以外に設定します。@JsonPropertyDescription - ツールパラメータに詳細な説明を追加します。@JsonIgnore - publicフィールドまたはゲッターメソッドを、ツールのパラメータ用に生成されるJSONスキーマから除外します。@JsonProperty - 非publicフィールドまたはゲッターメソッドを、ツールのパラメータ用に生成されるJSONスキーマに含めます。SDKは、client.messages().batches()名前空間の下でバッチ処理のサポートを提供します。バッチの一覧表示とページネーションの方法については、ページネーションを参照してください。
SDKは、MultipartFieldクラスを通じてファイルを受け取るメソッドを定義しています。
import com.anthropic.core.MultipartField;
import com.anthropic.models.beta.files.FileMetadata;
import com.anthropic.models.beta.files.FileUploadParams;
FileUploadParams params = FileUploadParams.builder()
.file(
MultipartField.<InputStream>builder()
.value(Files.newInputStream(Paths.get("/path/to/file.pdf")))
.contentType("application/pdf")
.build()
)
.build();
FileMetadata fileMetadata = client.beta().files().upload(params);またはInputStreamから:
import com.anthropic.core.MultipartField;
import com.anthropic.models.beta.files.FileMetadata;
import com.anthropic.models.beta.files.FileUploadParams;
FileUploadParams params = FileUploadParams.builder()
.file(
MultipartField.<InputStream>builder()
.value(URI.create("https://example.com/path/to/file").toURL().openStream())
.filename("document.pdf")
.contentType("application/pdf")
.build()
)
.build();
FileMetadata fileMetadata = client.beta().files().upload(params);またはメモリ内のバイトから:
import com.anthropic.core.MultipartField;
import com.anthropic.models.beta.files.FileMetadata;
import com.anthropic.models.beta.files.FileUploadParams;
FileUploadParams params = FileUploadParams.builder()
.file(
MultipartField.<InputStream>builder()
.value(new ByteArrayInputStream("content".getBytes()))
.filename("document.txt")
.contentType("text/plain")
.build()
)
.build();
FileMetadata fileMetadata = client.beta().files().upload(params);SDKは、必ずしもJSONとしてパースされないAPIレスポンスに対して、バイナリレスポンスを返すメソッドを定義しています。
import com.anthropic.core.http.HttpResponse;
HttpResponse response = client.beta().files().download("file_abc123");レスポンスの内容をファイルに保存するには:
import com.anthropic.core.http.HttpResponse;
try (HttpResponse response = client.beta().files().download(params)) {
Files.copy(
response.body(),
Paths.get(path),
StandardCopyOption.REPLACE_EXISTING
);
} catch (Exception e) {
IO.println("Something went wrong!");
throw new RuntimeException(e);
}またはレスポンスの内容を任意のOutputStreamに転送するには:
import com.anthropic.core.http.HttpResponse;
try (HttpResponse response = client.beta().files().download(params)) {
response.body().transferTo(Files.newOutputStream(Paths.get(path)));
} catch (Exception e) {
IO.println("Something went wrong!");
throw new RuntimeException(e);
}SDKはカスタムの非チェック例外型をスローします。
AnthropicServiceException - HTTPエラーの基底クラス。AnthropicIoException - I/Oネットワークエラー。AnthropicRetryableException - リトライ可能な失敗を示す汎用エラー。AnthropicInvalidDataException - 正常にパースされたデータの解釈に失敗した場合(たとえば、必須であるはずのプロパティにアクセスしたが、APIが予期せずそれを省略していた場合)。AnthropicException - すべての例外の基底クラス。| ステータス | 例外 |
|---|---|
| 400 | BadRequestException |
| 401 | UnauthorizedException |
| 403 | PermissionDeniedException |
| 404 | NotFoundException |
| 422 | UnprocessableEntityException |
| 429 | RateLimitException |
| 5xx | InternalServerException |
| その他 | UnexpectedStatusCodeException |
SseExceptionは、最初のHTTPレスポンスが成功した後のSSEストリーミング中に発生したエラーに対してスローされます。
import com.anthropic.errors.*;
try {
Message message = client.messages().create(params);
} catch (RateLimitException e) {
IO.println("Rate limited, retry after: " + e.headers());
} catch (UnauthorizedException e) {
IO.println("Invalid API key");
} catch (AnthropicServiceException e) {
IO.println("API error: " + e.statusCode());
} catch (AnthropicIoException e) {
IO.println("Network error: " + e.getMessage());
}生のレスポンスを使用する場合、requestId()メソッドを使用してrequest-idレスポンスヘッダーにアクセスできます。
import com.anthropic.core.http.HttpResponseFor;
import com.anthropic.models.messages.Message;
HttpResponseFor<Message> message = client.messages().withRawResponse().create(params);
Optional<String> requestId = message.requestId();これを使用して、失敗したリクエストを迅速にログに記録し、Anthropicに報告できます。リクエストのデバッグの詳細については、リクエストIDを参照してください。
SDKはデフォルトで2回自動的にリトライし、リクエスト間には短い指数バックオフが適用されます。
以下のエラータイプのみがリトライされます。
APIは、リクエストをリトライするかしないかをSDKに明示的に指示することもあります。
カスタムのリトライ回数を設定するには、maxRetriesメソッドを使用してクライアントを設定します。
import com.anthropic.client.AnthropicClient;
import com.anthropic.client.okhttp.AnthropicOkHttpClient;
AnthropicClient client = AnthropicOkHttpClient.builder().fromEnv().maxRetries(4).build();リクエストはデフォルトで10分後にタイムアウトします。
ただし、maxTokensを受け取るメソッドでは、大きなmaxTokens値を指定してストリーミングしている場合、デフォルトのタイムアウトは次の式を使用して動的に計算されます。
Duration.ofSeconds(
Math.min(
60 * 60, // 1 hour max
Math.max(
10 * 60, // 10 minute minimum
60 * 60 * maxTokens / 128_000
)
)
)これにより、上書きされない限り、maxTokensパラメータに応じてスケーリングされた最大60分のタイムアウトになります。
非ストリーミングリクエストの場合、動的タイムアウトはmaxTokensに基づいて最小30秒から最大10分までスケーリングされます。
リクエストごとにカスタムタイムアウトを設定するには:
import com.anthropic.models.messages.Message;
Message message = client
.messages()
.create(params, RequestOptions.builder().timeout(Duration.ofSeconds(30)).build());またはクライアントレベルですべてのメソッド呼び出しのデフォルトを設定するには:
import com.anthropic.client.AnthropicClient;
import com.anthropic.client.okhttp.AnthropicOkHttpClient;
AnthropicClient client = AnthropicOkHttpClient.builder()
.fromEnv()
.timeout(Duration.ofSeconds(30))
.build();実行時間の長いリクエストにはストリーミングの使用を検討してください。
ストリーミングを使用せずに大きなmaxTokens値を設定することは避けてください。一部のネットワークは一定時間後にアイドル接続を切断することがあり、Anthropicからレスポンスを受け取ることなくリクエストが失敗したりタイムアウトしたりする可能性があります。SDKは接続を維持し、これらのネットワークの影響を軽減するために、定期的にAPIにpingを送信します。
非ストリーミングリクエストが10分以上かかると予想される場合、SDKはエラーをスローします。ストリーミングメソッドを使用するか、クライアントまたはリクエストレベルでタイムアウトを上書きすると、このエラーは無効になります。
SDKは、ページネーションされた結果に、1ページずつ、またはすべてのページにわたってアイテムごとにアクセスする便利な方法を提供します。
すべてのページにわたるすべての結果を反復処理するには、必要に応じて自動的に追加ページを取得するautoPager()メソッドを使用します。
import com.anthropic.models.messages.batches.BatchListPage;
import com.anthropic.models.messages.batches.MessageBatch;
BatchListPage page = client.messages().batches().list();
// Iterableとして処理
for (MessageBatch batch : page.autoPager()) {
IO.println(batch);
}
// Streamとして処理
page.autoPager()
.stream()
.limit(50)
.forEach(batch -> IO.println(batch));非同期クライアントを使用する場合、メソッドはAsyncStreamResponseを返します。
import com.anthropic.core.http.AsyncStreamResponse;
import com.anthropic.models.messages.batches.BatchListPageAsync;
import com.anthropic.models.messages.batches.MessageBatch;
CompletableFuture<BatchListPageAsync> pageFuture = client.async().messages().batches().list();
pageFuture.thenAccept(page -> page.autoPager().subscribe(batch -> {
IO.println(batch);
}));
// ストリームのエラーや完了を処理する必要がある場合
pageFuture.thenAccept(page -> page.autoPager().subscribe(new AsyncStreamResponse.Handler<>() {
@Override
public void onNext(MessageBatch batch) {
IO.println(batch);
}
@Override
public void onComplete(Optional<Throwable> error) {
if (error.isPresent()) {
IO.println("Something went wrong!");
throw new RuntimeException(error.get());
} else {
IO.println("No more!");
}
}
}));
// またはfuturesを使用
pageFuture.thenAccept(page -> page.autoPager()
.subscribe(batch -> {
IO.println(batch);
})
.onCompleteFuture()
.whenComplete((unused, error) -> {
if (error != null) {
IO.println("Something went wrong!");
throw new RuntimeException(error);
} else {
IO.println("No more!");
}
}));個々のページアイテムにアクセスし、手動で次のページをリクエストするには:
import com.anthropic.models.messages.batches.BatchListPage;
import com.anthropic.models.messages.batches.MessageBatch;
BatchListPage page = client.messages().batches().list();
while (true) {
for (MessageBatch batch : page.items()) {
IO.println(batch);
}
if (!page.hasNextPage()) {
break;
}
page = page.nextPage();
}SDKの各クラスには、それを構築するための関連ビルダーがあります。各クラスは一度構築されると不変です。クラスに関連ビルダーがある場合、toBuilder()メソッドがあり、これを使用してビルダーに戻して変更されたコピーを作成できます。
MessageCreateParams params = MessageCreateParams.builder()
.maxTokens(1024L)
.addUserMessage("Hello, Claude")
.model(Model.CLAUDE_OPUS_5)
.build();
// toBuilder()を使用して変更したコピーを作成
MessageCreateParams modified = params.toBuilder().maxTokens(2048L).build();各クラスは不変であるため、ビルダーの変更がすでに構築されたクラスインスタンスに影響することはありません。
Claude APIにリクエストを送信するには、何らかのParamsクラスのインスタンスを構築し、対応するクライアントメソッドに渡します。レスポンスを受信すると、Javaクラスのインスタンスにデシリアライズされます。
たとえば、client.messages().create(...)はMessageCreateParamsのインスタンスを渡して呼び出す必要があり、Messageのインスタンスを返します。
非公開パラメータを設定するには、任意のParamsクラスでputAdditionalHeader、putAdditionalQueryParam、またはputAdditionalBodyPropertyメソッドを呼び出します。
import com.anthropic.core.JsonValue;
import com.anthropic.models.messages.MessageCreateParams;
MessageCreateParams params = MessageCreateParams.builder()
.putAdditionalHeader("Secret-Header", "42")
.putAdditionalQueryParam("secret_query_param", "42")
.putAdditionalBodyProperty("secretProperty", JsonValue.from("42"))
.build();これらは、後で構築されたオブジェクトに対して_additionalHeaders()、_additionalQueryParams()、_additionalBodyProperties()メソッドを使用してアクセスできます。
これらのメソッドに渡された値は、以前のメソッドに渡された値を上書きします。セキュリティ上の理由から、これらのメソッドは信頼できる入力データでのみ使用してください。
ネストされたヘッダー、クエリパラメータ、またはボディクラスに非公開パラメータを設定するには:
import com.anthropic.core.JsonValue;
import com.anthropic.models.messages.MessageCreateParams;
import com.anthropic.models.messages.Metadata;
MessageCreateParams params = MessageCreateParams.builder()
.metadata(
Metadata.builder().putAdditionalProperty("secretProperty", JsonValue.from("42")).build()
)
.build();これらのプロパティは、後でネストされた構築済みオブジェクトに対して_additionalProperties()メソッドを使用してアクセスできます。
公開されているパラメータまたはプロパティに、非公開またはまだサポートされていない値を設定するには、そのセッターにJsonValueオブジェクトを渡します。
import com.anthropic.core.JsonValue;
import com.anthropic.models.messages.MessageCreateParams;
import com.anthropic.models.messages.Model;
MessageCreateParams params = MessageCreateParams.builder()
.maxTokens(JsonValue.from(3.14))
.addUserMessage("Hello, Claude")
.model(Model.CLAUDE_OPUS_5)
.build();JsonValueを作成する最も簡単な方法は、そのfrom(...)メソッドを使用することです。
import com.anthropic.core.JsonValue;
// プリミティブなJSON値を作成する
JsonValue nullValue = JsonValue.from(null);
JsonValue booleanValue = JsonValue.from(true);
JsonValue numberValue = JsonValue.from(42);
JsonValue stringValue = JsonValue.from("Hello World!");
// `["Hello", "World"]`と同等のJSON配列値を作成する
JsonValue arrayValue = JsonValue.from(List.of("Hello", "World"));
// `{ "a": 1, "b": 2 }`と同等のJSONオブジェクト値を作成する
JsonValue objectValue = JsonValue.from(Map.of("a", 1, "b", 2));
// 以下と同等の任意にネストされたJSONを作成する:
// { "a": [1, 2], "b": [3, 4] }
JsonValue complexValue = JsonValue.from(Map.of("a", List.of(1, 2), "b", List.of(3, 4)));通常、Builderクラスのbuildメソッドは、必須パラメータまたはプロパティが未設定の場合にIllegalStateExceptionをスローします。必須パラメータまたはプロパティを強制的に省略するには、JsonMissingを渡します。
import com.anthropic.core.JsonMissing;
import com.anthropic.models.messages.MessageCreateParams;
import com.anthropic.models.messages.Model;
MessageCreateParams params = MessageCreateParams.builder()
.addUserMessage("Hello, world")
.model(Model.CLAUDE_OPUS_5)
.maxTokens(JsonMissing.of())
.build();非公開のレスポンスプロパティにアクセスするには、_additionalProperties()メソッドを呼び出します。
import com.anthropic.core.JsonValue;
Map<String, JsonValue> additionalProperties = client
.messages()
.create(params)
._additionalProperties();
JsonValue secretPropertyValue = additionalProperties.get("secretProperty");
String result = secretPropertyValue.accept(new JsonValue.Visitor<>() {
@Override
public String visitNull() {
return "It's null!";
}
@Override
public String visitBoolean(boolean value) {
return "It's a boolean!";
}
@Override
public String visitNumber(Number value) {
return "It's a number!";
}
// 他のメソッドには `visitMissing`、`visitString`、`visitArray`、`visitObject` があります
// 未実装の各メソッドのデフォルト実装は `visitDefault` に委譲します。
// `visitDefault` はデフォルトでは例外をスローしますが、オーバーライドすることも可能です
});プロパティの生のJSON値にアクセスするには、_プレフィックス付きのメソッドを呼び出します。
import com.anthropic.core.JsonField;
import com.anthropic.models.messages.StopReason;
JsonField<StopReason> stopReason = client.messages().create(params)._stopReason();
if (stopReason.isMissing()) {
// プロパティがJSONレスポンスに存在しない
} else if (stopReason.isNull()) {
// プロパティが明示的にnullに設定されていた
} else {
// 値が文字列として提供されたかどうかを確認する
// 他にも`asNumber()`、`asBoolean()`などのメソッドがあります
Optional<String> jsonString = stopReason.asString();
// カスタム型へのデシリアライズを試みる
MyClass myObject = stopReason.asUnknown().orElseThrow().convert(MyClass.class);
}デフォルトでは、APIが期待される型と一致しないレスポンスを返しても、SDKは例外をスローしません。プロパティに直接アクセスした場合にのみAnthropicInvalidDataExceptionをスローします。
レスポンスが完全に正しく型付けされていることを事前に確認するには、validate()を呼び出します。
import com.anthropic.models.messages.Message;
Message message = client.messages().create(params).validate();またはリクエストごとに設定するには:
import com.anthropic.models.messages.Message;
Message message = client
.messages()
.create(params, RequestOptions.builder().responseValidation(true).build());またはクライアントレベルですべてのメソッド呼び出しのデフォルトを設定するには:
import com.anthropic.client.AnthropicClient;
import com.anthropic.client.okhttp.AnthropicOkHttpClient;
AnthropicClient client = AnthropicOkHttpClient.builder()
.fromEnv()
.responseValidation(true)
.build();import com.anthropic.client.AnthropicClient;
import com.anthropic.client.okhttp.AnthropicOkHttpClient;
import java.net.Proxy;
AnthropicClient client = AnthropicOkHttpClient.builder()
.fromEnv()
.proxy(new Proxy(Proxy.Type.HTTP, new InetSocketAddress("https://example.com", 8080)))
.build();ほとんどのアプリケーションはこれらのメソッドを呼び出すべきではなく、代わりにシステムのデフォルトを使用してください。デフォルトには、実装を変更すると失われる可能性のある特別な最適化が含まれています。
import com.anthropic.client.AnthropicClient;
import com.anthropic.client.okhttp.AnthropicOkHttpClient;
AnthropicClient client = AnthropicOkHttpClient.builder()
.fromEnv()
.sslSocketFactory(yourSSLSocketFactory)
.trustManager(yourTrustManager)
.hostnameVerifier(yourHostnameVerifier)
.build();SDKは3つのアーティファクトで構成されています。
anthropic-java-core - コアSDKロジックを含み、OkHttpに依存しません。AnthropicClient、AnthropicClientAsync、およびそれらの実装クラスを公開しており、これらはすべて任意のHTTPクライアントで動作します。anthropic-java-client-okhttp - OkHttpに依存します。AnthropicOkHttpClientとAnthropicOkHttpClientAsyncを公開します。anthropic-java - anthropic-java-coreとanthropic-java-client-okhttpの両方に依存し、それらのAPIを公開します。独自のロジックは持ちません。この構造により、不要な依存関係を取り込むことなく、SDKのデフォルトHTTPクライアントを置き換えることができます。
デフォルトのクライアントを置き換える前に、利用可能なネットワークオプションを試してください。
カスタマイズされたOkHttpClientを使用するには:
anthropic-java依存関係をanthropic-java-coreに置き換えます。anthropic-java-client-okhttpのOkHttpClientクラスをコードにコピーしてカスタマイズします。AnthropicClientImplまたはAnthropicClientAsyncImplを構築します。完全にカスタムなHTTPクライアントを使用するには:
anthropic-java依存関係をanthropic-java-coreに置き換えます。HttpClientインターフェースを実装するクラスを作成します。AnthropicClientImplまたはAnthropicClientAsyncImplを構築します。コード例を含む詳細なプラットフォームセットアップガイドについては、以下を参照してください。
Java SDKは、プラットフォーム固有のBackend実装を提供する個別の依存関係を通じて、以下のプラットフォームをサポートしています。
com.anthropic:anthropic-java-vertex: VertexBackend.fromEnv()またはVertexBackend.builder()を使用します。com.anthropic:anthropic-java-bedrock: Messages-API BedrockエンドポイントにはBedrockMantleBackend.fromEnv()またはBedrockMantleBackend.builder()を使用し、bedrock-runtimeパスにはBedrockBackend.fromEnv() / BedrockBackend.builder()を使用します。com.anthropic:anthropic-java-aws: AwsBackend.fromEnv()(ANTHROPIC_AWS_WORKSPACE_IDとAWSのデフォルトリージョン/認証情報チェーンを読み取ります)またはAwsBackend.builder()を使用します。ベータ版で利用可能です。com.anthropic:anthropic-java-foundry: FoundryBackend.fromEnv()またはFoundryBackend.builder()を使用します。新しいプロジェクトにはBedrockMantleBackendを使用してください。BedrockBackendは、BedrockのInvokeModel APIを使用する既存のアプリケーション向けに残されています。
各Backend実装は、AnthropicOkHttpClient.builder()の.backend()でクライアントに渡されます。各クラウドバックエンドは、それぞれのクラウドプラットフォームSDKクラスを推移的依存関係として取り込みます。
HTTPヘッダー、ステータスコード、生のレスポンスボディにアクセスするには、任意のHTTPメソッド呼び出しの前にwithRawResponse()を付けます。
import com.anthropic.core.http.Headers;
import com.anthropic.core.http.HttpResponseFor;
import com.anthropic.models.messages.Message;
import com.anthropic.models.messages.MessageCreateParams;
import com.anthropic.models.messages.Model;
MessageCreateParams params = MessageCreateParams.builder()
.maxTokens(1024L)
.addUserMessage("Hello, Claude")
.model(Model.CLAUDE_OPUS_5)
.build();
HttpResponseFor<Message> message = client.messages().withRawResponse().create(params);
int statusCode = message.statusCode();
Headers headers = message.headers();必要に応じて、レスポンスをJavaクラスのインスタンスにデシリアライズすることもできます。
import com.anthropic.models.messages.Message;
Message parsedMessage = message.parse();SDKは標準のOkHttpロギングインターセプターを使用します。
ANTHROPIC_LOG環境変数をinfoに設定してロギングを有効にします。
export ANTHROPIC_LOG=infoまたはより詳細なロギングのためにdebugに設定します。
export ANTHROPIC_LOG=debugSDKは、公開されているAPIを便利に使用できるように型付けされています。ただし、APIの非公開またはまだサポートされていない部分を扱うこともサポートしています。
非公開のリクエストパラメータを設定するには、非公開パラメータで説明されているように、putAdditionalHeader、putAdditionalQueryParam、またはputAdditionalBodyPropertyメソッドを使用します。
非公開のレスポンスプロパティにアクセスするには、レスポンスプロパティで説明されているように、_additionalProperties()メソッドを使用します。
SDK内のModelやAnthropicBetaなどのenumライクなクラスは、閉じたJavaのenum型ではありません。それぞれが任意の文字列を受け取るof(String)ファクトリメソッドを提供しているため、SDKのバージョンより後にリリースされたモデルやベータヘッダーなど、まだSDKに追加されていない値を使用できます。
import com.anthropic.models.beta.AnthropicBeta;
import com.anthropic.models.messages.Model;
Model model = Model.of("some-new-model");
AnthropicBeta beta = AnthropicBeta.of("some-new-beta-2026-01-01");これらの型を受け取るビルダーメソッドは、多くの場合、of(...)を代わりに呼び出すStringオーバーロードも提供しています。
import com.anthropic.models.messages.MessageCreateParams;
MessageCreateParams params = MessageCreateParams.builder()
.model("some-new-model") // same as .model(Model.of("some-new-model"))
.maxTokens(1024L)
.addUserMessage("Hello, Claude")
.build();オートコンプリートと非推奨警告が得られるように、適切に型付けされた定数(たとえば、Model.CLAUDE_OPUS_5)を優先してください。Stringオーバーロードとof(...)は、主に、それを含むSDKリリースを待つ間に、フィールドを非公開またはまだサポートされていない値に設定するためのものです。
ベータ機能は、早期のフィードバックを得て新機能をテストするために、一般リリース前に利用可能になります。Claudeのすべての機能とツールの利用可能状況は、Claudeで構築する概要で確認できます。
ほとんどのベータAPI機能には、クライアントのbeta()メソッドを通じてアクセスできます。特定のベータ機能を有効にするには、メッセージパラメータを構築する際に.addBeta()で適切なベータヘッダーを追加します。
たとえば、Files APIを使用するには:
import com.anthropic.models.beta.AnthropicBeta;
import com.anthropic.models.beta.messages.BetaContentBlockParam;
import com.anthropic.models.beta.messages.BetaMessage;
import com.anthropic.models.beta.messages.BetaRequestDocumentBlock;
import com.anthropic.models.beta.messages.BetaTextBlockParam;
import com.anthropic.models.beta.messages.MessageCreateParams;
void main() {
AnthropicClient client = AnthropicOkHttpClient.fromEnv();
BetaMessage message = client.beta().messages().create(
MessageCreateParams.builder()
.model(Model.CLAUDE_OPUS_5)
.maxTokens(1024L)
.addBeta(AnthropicBeta.FILES_API_2025_04_14)
.addUserMessageOfBetaContentBlockParams(List.of(
BetaContentBlockParam.ofText(
BetaTextBlockParam.builder()
.text("Please summarize this document for me.")
.build()),
BetaContentBlockParam.ofDocument(
BetaRequestDocumentBlock.builder()
.fileSource("file_abc123")
.build())))
.build());
}このパッケージは概ねSemVerの規約に従っていますが、特定の後方互換性のない変更がマイナーバージョンとしてリリースされる場合があります。
Was this page helpful?