modelflow-ai / anthropic
Client for Anthropic AI API.
Requires
- php: ^8.2
- modelflow-ai/api-client: ^0.2
- webmozart/assert: ^1.11
Requires (Dev)
- asapo/remove-vendor-plugin: ^0.1
- jangregor/phpstan-prophecy: ^1.0
- php-cs-fixer/shim: ^3.15
- phpspec/prophecy-phpunit: ^2.1@stable
- phpstan/extension-installer: ^1.2
- phpstan/phpstan: ^1.10, <1.10.55
- phpstan/phpstan-phpunit: ^1.3@stable
- phpunit/phpunit: ^10.3
- rector/rector: ^0.18.1
- symfony/dotenv: ^6.4 || ^7.0
This package is auto-updated.
Last update: 2024-10-25 19:09:50 UTC
README
Modelflow AI
Anthropic
The Anthropic package is a comprehensive API client for the Anthropic AI model. It provides a simple and intuitive interface to interact with the Anthropic AI model, allowing you to create chat conversations.
Note: This is part of the
modelflow-ai
project create issues in the main repository.
Note: This project is heavily under development and any feedback is greatly appreciated.
Installation
To install the Anthropic package, you need to have PHP 8.2 or higher and Composer installed on your machine. Then, you can add the package to your project by running the following command:
composer require modelflow-ai/anthropic
Examples
Here are some examples of how you can use the Anthropic in your PHP applications. You can find more detailed examples in the examples directory.
Usage
Creating a Client
First, you need to create a client. The client is the main entry point to interact with the Anthropic AI model. You can
create a client using the Anthropic
class:
use ModelflowAi\Anthropic\Anthropic; $client = Anthropic::client('your-api-key');
Using the Chat Resource
The Chat resource allows you to create chat conversations and get chat completions.
use ModelflowAi\Anthropic\Model; $chat = $client->chat(); // Create a chat conversation $parameters = [ 'model' => Model::CLAUDE_3_OPUS->value, 'messages' => [ [ 'role' => 'system', 'content' => 'You are a helpful assistant.' ], [ 'role' => 'user', 'content' => 'Who won the world series in 2020?' ] ] ]; $response = $chat->create($parameters); // The response is an instance of CreateResponse echo $response->content[0]->text;
API Documentation
For more detailed information about the Anthropic API, please refer to the official API documentation.
Open Points
Streaming Tools
Streaming of tools are not yet available in the Anthropic API. As soon as they are available, we will provide a the stream option with the tools.
Text completions
The Text Completions resource is not yet in this package.
Embeddings
The Embeddings resource is not yet in the Anthropic API. As soon as it is available, we will provide a resource to generate and manipulate embeddings for your data.
Testing
To run the tests, use PHPUnit:
composer test
Contributing
Contributions are welcome. Please open an issue or submit a pull request in the main repository at https://github.com/modelflow-ai/.github.
License
This project is licensed under the MIT License. For the full copyright and license information, please view the LICENSE file that was distributed with this source code.