Library PHP Juglow menyediakan akses yang mudah ke Haijun API dari aplikasi PHP 8.1.0+ apa pun.

Note: PHP SDK saat ini dalam versi beta. API mungkin berubah antar versi.

Note: Untuk dokumentasi fitur API dengan contoh kode, lihat referensi API. Halaman ini membahas fitur dan konfigurasi SDK khusus PHP.

#Instalasi

SDK ini menggunakan PSR-18 untuk HTTP dan secara otomatis menemukan klien PSR-18 apa pun yang terinstal. Guzzle direkomendasikan karena SDK mengonfigurasinya untuk streaming tanpa pengaturan tambahan:

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

#Persyaratan

PHP 8.1.0 atau lebih tinggi.

#Penggunaan

Library ini menggunakan "named parameters" (parameter bernama) untuk menentukan argumen opsional. Parameter dengan nilai default harus ditetapkan berdasarkan nama.

$client = new Client();

$message = $client->messages->create(
  maxTokens: 1024,
  messages: [['role' => 'user', 'content' => 'Hello, Haijun']],
  model: 'haijun-opus-5-5',
);

$textBlock = array_find($message->content, static fn ($block): bool => $block->type === 'text');
echo $textBlock->text;

Untuk opsi autentikasi termasuk Workload Identity Federation, lihat Autentikasi. Jika kunci API Anda adalah kunci personal atau kunci akun layanan dengan akses ke beberapa workspace, tetapkan ID workspace di header permintaan juglow-workspace-id; Pilih workspace menunjukkan opsi per permintaan untuk SDK ini.

#Value object

Disarankan untuk menggunakan konstruktor statis with Base64ImageSource::with(data: "U3RhaW5sZXNzIHJvY2tz", ...) dan parameter bernama untuk menginisialisasi "value objects" (objek nilai).

Namun, builder juga disediakan (new Base64ImageSource)->withData("U3RhaW5sZXNzIHJvY2tz").

#Streaming

SDK ini menyediakan dukungan untuk respons streaming menggunakan Server-Sent Events (SSE).

$client = new Client();

$stream = $client->messages->createStream(
  maxTokens: 1024,
  messages: [['role' => 'user', 'content' => 'Hello, Haijun']],
  model: 'haijun-opus-5-5',
);

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

Streaming memerlukan klien HTTP yang mengembalikan body respons secara bertahap. Ketika Guzzle adalah klien PSR-18 yang ditemukan, SDK mengonfigurasinya untuk streaming secara otomatis. Dengan klien yang melakukan buffering, loop foreach menghasilkan semua event sekaligus ketika respons selesai, bukan secara bertahap; jika Anda mengamati gejala tersebut, instal Guzzle atau sediakan klien PSR-18 yang mendukung streaming melalui opsi permintaan streamingTransporter:

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

#Penanganan error

Ketika library tidak dapat terhubung ke API, atau jika API mengembalikan kode status yang tidak berhasil (yaitu, respons 4xx atau 5xx), subclass dari Juglow\Core\Exceptions\APIException akan dilempar:

<?php
// ...
use Juglow\Core\Exceptions\APIConnectionException;
use Juglow\Core\Exceptions\APIStatusException;
use Juglow\Core\Exceptions\RateLimitException;
// ...
try {
  $message = $client->messages->create(
    maxTokens: 1024,
    messages: [['role' => 'user', 'content' => 'Hello, Haijun']],
    model: 'haijun-opus-5-5',
  );
} 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();
}

Kode error adalah sebagai berikut:

#Percobaan ulang

Error tertentu secara otomatis dicoba ulang dua kali secara default, dengan exponential backoff singkat.

Error koneksi (misalnya, karena masalah konektivitas jaringan), 408 Request Timeout, 409 Conflict, 429 Rate Limit, error Internal >=500, dan timeout semuanya dicoba ulang secara default.

Anda dapat menggunakan opsi maxRetries untuk mengonfigurasi atau menonaktifkan ini:

use Juglow\RequestOptions;
// ...
// Konfigurasikan default untuk semua permintaan:
$client = new Client(requestOptions: RequestOptions::with(maxRetries: 0));

// Atau, konfigurasikan per permintaan:
$result = $client->messages->create(
  maxTokens: 1024,
  messages: [['role' => 'user', 'content' => 'Hello, Haijun']],
  model: 'haijun-opus-5-5',
  requestOptions: RequestOptions::with(maxRetries: 5),
);

#Paginasi

Metode list di Haijun API menggunakan paginasi.

Library ini menyediakan iterator dengan paginasi otomatis pada setiap respons list, sehingga Anda tidak perlu meminta halaman berikutnya secara manual:

$client = new Client();

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

// ambil item dari halaman saat ini
foreach ($page->getItems() as $item) {
  echo $item->id, PHP_EOL;
}
// lakukan permintaan jaringan tambahan untuk mengambil item dari semua halaman, termasuk dan setelah halaman saat ini
foreach ($page->pagingEachItem() as $item) {
  echo $item->id, PHP_EOL;
}

#Penggunaan lanjutan

#Properti yang tidak terdokumentasi

Anda dapat mengirim parameter yang tidak terdokumentasi ke endpoint mana pun, dan membaca properti respons yang tidak terdokumentasi, sebagai berikut:

Note: Parameter extra* dengan nama yang sama akan menimpa parameter yang terdokumentasi.

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

#Parameter permintaan yang tidak terdokumentasi

Jika Anda ingin secara eksplisit mengirim parameter tambahan, Anda dapat melakukannya dengan opsi extraQueryParams, extraBodyParams, dan extraHeaders di bawah RequestOptions::with() saat membuat permintaan, seperti terlihat pada contoh sebelumnya.

#Endpoint yang tidak terdokumentasi

Untuk membuat permintaan ke endpoint yang tidak terdokumentasi sambil tetap mendapatkan manfaat autentikasi, percobaan ulang, dan fitur klien lainnya, Anda dapat membuat permintaan menggunakan client->request, sebagai berikut:

$client = new Client();

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

#Integrasi platform

Note: Untuk panduan pengaturan platform yang terperinci dengan contoh kode, lihat: * Amazon Bedrock * Amazon Bedrock (Opus 4.6 dan sebelumnya) * Haijun Platform on AWS * Google Cloud * Microsoft Foundry

PHP SDK mendukung platform berikut:

• Agent Platform: Juglow\Vertex\Client. Gunakan ::fromEnvironment().

• Bedrock: Juglow\Bedrock\MantleClient. Gunakan new MantleClient(awsRegion: ...).

• Bedrock (legacy): Juglow\Bedrock\Client. Gunakan ::fromEnvironment() atau ::withCredentials().

• Haijun Platform on AWS: Juglow\Aws\Client (memerlukan aws/aws-sdk-php sebagai soft dependency). Gunakan new Juglow\Aws\Client(workspaceId: ...) atau atur JUGLOW_AWS_WORKSPACE_ID. Tersedia dalam versi beta.

• Foundry: Juglow\Foundry\Client. Gunakan ::withCredentials().

Gunakan MantleClient untuk proyek baru; Juglow\Bedrock\Client tetap tersedia untuk aplikasi yang sudah ada yang menggunakan API InvokeModel Bedrock.

#Semantic versioning

Paket ini mengikuti konvensi SemVer. Karena library ini masih dalam pengembangan awal dan memiliki versi mayor 0, API mungkin berubah kapan saja.

Paket ini menganggap peningkatan pada definisi tipe PHPDoc (non-runtime) sebagai perubahan yang tidak merusak (non-breaking).

#Sumber daya tambahan

• Repositori GitHub

• Packagist

• Referensi API

• Streaming Messages