shale-php/shale

A package for interacting with the Amazon Bedrock service

v0.11 2025-03-13 22:03 UTC

Requires

• php: ^8.3
• aws/aws-sdk-php: ^3.342
• laravel/framework: ^12.0

Requires (Dev)

• larastan/larastan: ^3.0
• laravel/pint: ^1.21
• orchestra/testbench: 10.x-dev
• pestphp/pest: ^3.7
• pestphp/pest-plugin-faker: 3.x-dev
• pestphp/pest-plugin-laravel: 3.x-dev
• rector/rector: dev-main

MIT

• Richard Bagshaw

README

Shale is a package to interact with AWS Bedrock, a service that provides a way to interact with LLMs (Large Language Models) in a secure and scalable way within the AWS infrastructure. You can learn more about Amazon Bedrock here.

Installation

You can install the package via composer:

composer require shale-php/shale

Next, publish the configuration file:

php artisan vendor:publish --tag=shale-config

This will auto discover the package and you can start using it straight away.

Usage

First make sure you have the following environment variables set in your Laravel application:

AWS_DEFAULT_REGION=
AWS_ACCESS_KEY_ID=
AWS_SECRET_ACCESS_KEY=

Next make sure you have requested access to the bedrock models you want to use in your region within your AWS console.

You can then use the following code to interact with the bedrock model:

$question = 'What is the capital of France?';

$claudeReply = Shale::using(Claude3::make())
    ->prompt($question)
    ->execute();

$AI21LabsReply = Shale::using(AI21LabsJamba15Mini::make())
    ->prompt($question)
    ->execute();

// The capital of France is Paris.

Authors

This library was created by Richard Bagshaw.

License

The MIT License (MIT). Please see License File for more information.