CLI、SDK、ライブラリクライアントSDK

PHP SDK

バリューオブジェクトとビルダーパターンを使用してAnthropic PHP SDKをインストールおよび設定する

Anthropic PHPライブラリは、PHP 8.1.0以降のアプリケーションからAnthropic REST APIへの便利なアクセスを提供します。

PHP SDKは現在ベータ版です。バージョン間でAPIが変更される可能性があります。

コード例を含むAPI機能のドキュメントについては、APIリファレンスを参照してください。このページでは、PHP固有のSDK機能と設定について説明します。

インストール

このSDKはHTTPにPSR-18を使用し、インストールされているPSR-18クライアントを自動的に検出します。SDKが追加設定なしでストリーミング用に構成するため、Guzzleの使用を推奨します。

composer require "anthropic-ai/sdk" "guzzlehttp/guzzle:^7"

要件

PHP 8.1.0以上。

使用方法

このライブラリは、オプション引数を指定するために名前付きパラメータを使用します。デフォルト値を持つパラメータは名前で設定する必要があります。

$client = new Client();

$message = $client->messages->create(
  maxTokens: 1024,
  messages: [['role' => 'user', 'content' => 'Hello, Claude']],
  model: 'claude-opus-4-8',
);

echo $message->content[0]->text;

Workload Identity Federationを含む認証オプションについては、認証を参照してください。

バリューオブジェクト

バリューオブジェクトを初期化するには、静的なwithコンストラクタBase64ImageSource::with(data: "U3RhaW5sZXNzIHJvY2tz", ...)と名前付きパラメータを使用することを推奨します。

ただし、ビルダー(new Base64ImageSource)->withData("U3RhaW5sZXNzIHJvY2tz")も提供されています。

ストリーミング

このSDKは、「Server-Sent Events」（サーバー送信イベント）、すなわちSSEを使用したストリーミングレスポンスをサポートしています。

$client = new Client();

$stream = $client->messages->createStream(
  maxTokens: 1024,
  messages: [['role' => 'user', 'content' => 'Hello, Claude']],
  model: 'claude-opus-4-8',
);

foreach ($stream as $event) {
  echo $event->type . PHP_EOL;
}

ストリーミングには、レスポンスボディを段階的に返すHTTPクライアントが必要です。検出されたPSR-18クライアントがGuzzleの場合、SDKは自動的にストリーミング用に構成します。バッファリングするクライアントを使用すると、foreachループはレスポンス完了時にすべてのイベントを一度に生成し、段階的には生成しません。この症状が見られる場合は、Guzzleをインストールするか、streamingTransporterリクエストオプションを通じてストリーミング対応のPSR-18クライアントを指定してください。

$client = new Anthropic\Client(
  requestOptions: Anthropic\RequestOptions::with(streamingTransporter: $myStreamingClient),
);

エラー処理

ライブラリがAPIに接続できない場合、またはAPIが非成功ステータスコード（つまり4xxまたは5xxレスポンス）を返す場合、Anthropic\Core\Exceptions\APIExceptionのサブクラスがスローされます。

<?php
// ...
use Anthropic\Core\Exceptions\APIConnectionException;
use Anthropic\Core\Exceptions\APIStatusException;
use Anthropic\Core\Exceptions\RateLimitException;
// ...
try {
  $message = $client->messages->create(
    maxTokens: 1024,
    messages: [['role' => 'user', 'content' => 'Hello, Claude']],
    model: 'claude-opus-4-8',
  );
} catch (APIConnectionException $e) {
  echo "The server could not be reached", PHP_EOL;
  echo $e->getPrevious()?->getMessage(), PHP_EOL;
} catch (RateLimitException $_) {
  echo "A 429 status code was received; we should back off a bit.", PHP_EOL;
} catch (APIStatusException $e) {
  echo "Another non-200-range status code was received", PHP_EOL;
  echo $e->getMessage();
}

エラーコードは以下のとおりです。

原因	エラータイプ
HTTP 400	`BadRequestException`
HTTP 401	`AuthenticationException`
HTTP 403	`PermissionDeniedException`
HTTP 404	`NotFoundException`
HTTP 409	`ConflictException`
HTTP 422	`UnprocessableEntityException`
HTTP 429	`RateLimitException`
HTTP >= 500	`InternalServerException`
その他のHTTPエラー	`APIStatusException`
タイムアウト	`APITimeoutException`
ネットワークエラー	`APIConnectionException`

リトライ

特定のエラーは、デフォルトで短い指数バックオフを使用して自動的に2回リトライされます。

接続エラー（ネットワーク接続の問題などによる）、408 Request Timeout、409 Conflict、429 Rate Limit、500以上の内部エラー、およびタイムアウトは、すべてデフォルトでリトライされます。

maxRetriesオプションを使用して、これを設定または無効化できます。

use Anthropic\RequestOptions;
// ...
// すべてのリクエストのデフォルトを設定：
$client = new Client(requestOptions: RequestOptions::with(maxRetries: 0));

// または、リクエストごとに設定：
$result = $client->messages->create(
  maxTokens: 1024,
  messages: [['role' => 'user', 'content' => 'Hello, Claude']],
  model: 'claude-opus-4-8',
  requestOptions: RequestOptions::with(maxRetries: 5),
);

ページネーション

Claude APIのリストメソッドはページネーションされています。

このライブラリは各リストレスポンスに自動ページネーションイテレータを提供するため、後続のページを手動でリクエストする必要はありません。

$client = new Client();

$page = $client->beta->messages->batches->list(limit: 20);

// 現在のページからアイテムを取得
foreach ($page->getItems() as $item) {
  echo $item->id, PHP_EOL;
}
// 現在のページ以降のすべてのページからアイテムを取得するために追加のネットワークリクエストを実行
foreach ($page->pagingEachItem() as $item) {
  echo $item->id, PHP_EOL;
}

高度な使用方法

ドキュメント化されていないプロパティ

以下のように、任意のエンドポイントにドキュメント化されていないパラメータを送信し、ドキュメント化されていないレスポンスプロパティを読み取ることができます。

同じ名前のextra*パラメータは、ドキュメント化されているパラメータを上書きします。

<?php
// ...
use Anthropic\RequestOptions;
// ...
$message = $client->messages->create(
  maxTokens: 1024,
  messages: [['role' => 'user', 'content' => 'Hello, Claude']],
  model: 'claude-opus-4-8',
  requestOptions: RequestOptions::with(
    extraQueryParams: ['my_query_parameter' => 'value'],
    extraBodyParams: ['my_body_parameter' => 'value'],
    extraHeaders: ['my-header' => 'value'],
  ),
);

ドキュメント化されていないリクエストパラメータ

追加のパラメータを明示的に送信したい場合は、前述の例のように、リクエスト時にRequestOptions::with()の下にあるextraQueryParams、extraBodyParams、およびextraHeadersオプションを使用できます。

ドキュメント化されていないエンドポイント

認証、リトライ、その他のクライアント機能の利点を維持しながら、ドキュメント化されていないエンドポイントにリクエストを送信するには、以下のようにclient->requestを使用してリクエストを行うことができます。

$client = new Client();

$response = $client->request(
  method: "post",
  path: '/undocumented/endpoint',
  query: ['dog' => 'woof'],
  headers: ['useful-header' => 'interesting-value'],
  body: ['hello' => 'world']
);

プラットフォーム統合

コード例を含む詳細なプラットフォームセットアップガイドについては、以下を参照してください。

PHP SDKは以下のプラットフォームをサポートしています。

Bedrock： Anthropic\Bedrock\MantleClient。new MantleClient(awsRegion: ...)を使用します。
Bedrock（レガシー）： Anthropic\Bedrock\Client。::fromEnvironment()または::withCredentials()を使用します。
Vertex AI： Anthropic\Vertex\Client。::fromEnvironment()を使用します。
Foundry： Anthropic\Foundry\Client。::withCredentials()を使用します。
Claude Platform on AWS： Anthropic\Aws\Client（ソフト依存関係としてaws/aws-sdk-phpが必要）。new Anthropic\Aws\Client(workspaceId: ...)を使用するか、ANTHROPIC_AWS_WORKSPACE_IDを設定します。ベータ版で利用可能です。

新規プロジェクトにはMantleClientを使用してください。Anthropic\Bedrock\Clientは、BedrockのInvokeModel APIを使用している既存のアプリケーション向けに引き続き提供されます。

セマンティックバージョニング

このパッケージはSemVerの規約に従っています。ライブラリは初期開発段階にあり、メジャーバージョンが0であるため、APIはいつでも変更される可能性があります。

このパッケージでは、（実行時以外の）PHPDoc型定義の改善は破壊的変更とはみなしません。

追加リソース

Was this page helpful?

CLI、SDK、ライブラリクライアントSDK

PHP SDK

バリューオブジェクトとビルダーパターンを使用してAnthropic PHP SDKをインストールおよび設定する

Anthropic PHPライブラリは、PHP 8.1.0以降のアプリケーションからAnthropic REST APIへの便利なアクセスを提供します。

PHP SDKは現在ベータ版です。バージョン間でAPIが変更される可能性があります。

インストール

composer require "anthropic-ai/sdk" "guzzlehttp/guzzle:^7"

要件

PHP 8.1.0以上。

使用方法

$client = new Client();

$message = $client->messages->create(
  maxTokens: 1024,
  messages: [['role' => 'user', 'content' => 'Hello, Claude']],
  model: 'claude-opus-4-8',
);

echo $message->content[0]->text;

Workload Identity Federationを含む認証オプションについては、認証を参照してください。

バリューオブジェクト

ただし、ビルダー(new Base64ImageSource)->withData("U3RhaW5sZXNzIHJvY2tz")も提供されています。

ストリーミング

このSDKは、「Server-Sent Events」（サーバー送信イベント）、すなわちSSEを使用したストリーミングレスポンスをサポートしています。

$client = new Client();

$stream = $client->messages->createStream(
  maxTokens: 1024,
  messages: [['role' => 'user', 'content' => 'Hello, Claude']],
  model: 'claude-opus-4-8',
);

foreach ($stream as $event) {
  echo $event->type . PHP_EOL;
}

$client = new Anthropic\Client(
  requestOptions: Anthropic\RequestOptions::with(streamingTransporter: $myStreamingClient),
);

エラー処理

<?php
// ...
use Anthropic\Core\Exceptions\APIConnectionException;
use Anthropic\Core\Exceptions\APIStatusException;
use Anthropic\Core\Exceptions\RateLimitException;
// ...
try {
  $message = $client->messages->create(
    maxTokens: 1024,
    messages: [['role' => 'user', 'content' => 'Hello, Claude']],
    model: 'claude-opus-4-8',
  );
} catch (APIConnectionException $e) {
  echo "The server could not be reached", PHP_EOL;
  echo $e->getPrevious()?->getMessage(), PHP_EOL;
} catch (RateLimitException $_) {
  echo "A 429 status code was received; we should back off a bit.", PHP_EOL;
} catch (APIStatusException $e) {
  echo "Another non-200-range status code was received", PHP_EOL;
  echo $e->getMessage();
}

エラーコードは以下のとおりです。

原因	エラータイプ
HTTP 400	`BadRequestException`
HTTP 401	`AuthenticationException`
HTTP 403	`PermissionDeniedException`
HTTP 404	`NotFoundException`
HTTP 409	`ConflictException`
HTTP 422	`UnprocessableEntityException`
HTTP 429	`RateLimitException`
HTTP >= 500	`InternalServerException`
その他のHTTPエラー	`APIStatusException`
タイムアウト	`APITimeoutException`
ネットワークエラー	`APIConnectionException`

リトライ

特定のエラーは、デフォルトで短い指数バックオフを使用して自動的に2回リトライされます。

maxRetriesオプションを使用して、これを設定または無効化できます。

use Anthropic\RequestOptions;
// ...
// すべてのリクエストのデフォルトを設定：
$client = new Client(requestOptions: RequestOptions::with(maxRetries: 0));

// または、リクエストごとに設定：
$result = $client->messages->create(
  maxTokens: 1024,
  messages: [['role' => 'user', 'content' => 'Hello, Claude']],
  model: 'claude-opus-4-8',
  requestOptions: RequestOptions::with(maxRetries: 5),
);

ページネーション

Claude APIのリストメソッドはページネーションされています。

$client = new Client();

$page = $client->beta->messages->batches->list(limit: 20);

// 現在のページからアイテムを取得
foreach ($page->getItems() as $item) {
  echo $item->id, PHP_EOL;
}
// 現在のページ以降のすべてのページからアイテムを取得するために追加のネットワークリクエストを実行
foreach ($page->pagingEachItem() as $item) {
  echo $item->id, PHP_EOL;
}

高度な使用方法

ドキュメント化されていないプロパティ

同じ名前のextra*パラメータは、ドキュメント化されているパラメータを上書きします。

<?php
// ...
use Anthropic\RequestOptions;
// ...
$message = $client->messages->create(
  maxTokens: 1024,
  messages: [['role' => 'user', 'content' => 'Hello, Claude']],
  model: 'claude-opus-4-8',
  requestOptions: RequestOptions::with(
    extraQueryParams: ['my_query_parameter' => 'value'],
    extraBodyParams: ['my_body_parameter' => 'value'],
    extraHeaders: ['my-header' => 'value'],
  ),
);

ドキュメント化されていないリクエストパラメータ

ドキュメント化されていないエンドポイント

$client = new Client();

$response = $client->request(
  method: "post",
  path: '/undocumented/endpoint',
  query: ['dog' => 'woof'],
  headers: ['useful-header' => 'interesting-value'],
  body: ['hello' => 'world']
);

プラットフォーム統合

コード例を含む詳細なプラットフォームセットアップガイドについては、以下を参照してください。

PHP SDKは以下のプラットフォームをサポートしています。

Bedrock： Anthropic\Bedrock\MantleClient。new MantleClient(awsRegion: ...)を使用します。
Bedrock（レガシー）： Anthropic\Bedrock\Client。::fromEnvironment()または::withCredentials()を使用します。
Vertex AI： Anthropic\Vertex\Client。::fromEnvironment()を使用します。
Foundry： Anthropic\Foundry\Client。::withCredentials()を使用します。
Claude Platform on AWS： Anthropic\Aws\Client（ソフト依存関係としてaws/aws-sdk-phpが必要）。new Anthropic\Aws\Client(workspaceId: ...)を使用するか、ANTHROPIC_AWS_WORKSPACE_IDを設定します。ベータ版で利用可能です。

セマンティックバージョニング

このパッケージでは、（実行時以外の）PHPDoc型定義の改善は破壊的変更とはみなしません。

追加リソース

Was this page helpful?