Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sgraaf/chatgpt-php
A convenient PHP wrapper for the OpenAI ChatGPT API
https://github.com/sgraaf/chatgpt-php
Last synced: 15 days ago
JSON representation
A convenient PHP wrapper for the OpenAI ChatGPT API
- Host: GitHub
- URL: https://github.com/sgraaf/chatgpt-php
- Owner: sgraaf
- License: mit
- Created: 2023-03-07T10:42:50.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-06-03T22:50:51.000Z (5 months ago)
- Last Synced: 2024-08-09T03:07:56.864Z (3 months ago)
- Language: PHP
- Size: 14.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ChatGPT PHP
[](https://packagist.org/packages/sgraaf/chatgpt-php)
[](https://img.shields.io/packagist/dependency-v/sgraaf/chatgpt-php/php)
[](https://results.pre-commit.ci/latest/github/sgraaf/chatgpt-php/main)
[](./LICENSE)
A convenient PHP wrapper for the OpenAI ChatGPT API.
## Installation
You can install ChatGPT PHP via [Composer](https://getcomposer.org/):
```bash
composer require sgraaf/chatgpt-php
```
## Usage
### Initialize the client
```php
// initialize the client
$client = new ChatGPT\Client('YOUR_OPENAI_API_KEY');
```
#### Use a custom _system message_
```php
// initialize the client
$client = new ChatGPT\Client('YOUR_OPENAI_API_KEY', system_message: 'You are a helpful assistant that translates English to French.');
```
### Start a conversation
```php
// provide an instruction
$message = $client->chat('Who won the world series in 2020?');
var_dump($message);
// string(53) "The Los Angeles Dodgers won the World Series in 2020."
// continue the conversation
$message = $client->chat('Where was it played?');
var_dump($message);
// string(116) "The 2020 World Series was played in Arlington, Texas at the Globe Life Field, the home stadium of the Texas Rangers."
```
### View the conversation history
```php
var_dump($client->messages);
// array(5) {
// [0]=>
// array(2) {
// ["role"]=>
// string(6) "system"
// ["content"]=>
// string(28) "You are a helpful assistant."
// }
// [1]=>
// array(2) {
// ["role"]=>
// string(4) "user"
// ["content"]=>
// string(33) "Who won the world series in 2020?"
// }
// [2]=>
// array(2) {
// ["role"]=>
// string(9) "assistant"
// ["content"]=>
// string(53) "The Los Angeles Dodgers won the World Series in 2020."
// }
// [3]=>
// array(2) {
// ["role"]=>
// string(4) "user"
// ["content"]=>
// string(20) "Where was it played?"
// }
// [4]=>
// array(2) {
// ["role"]=>
// string(9) "assistant"
// ["content"]=>
// string(116) "The 2020 World Series was played in Arlington, Texas at the Globe Life Field, the home stadium of the Texas Rangers."
// }
// }
```
### Clear the conversation history
```php
// clear the conversation history
$client->clear();
var_dump($client->messages);
// array(1) {
// [0]=>
// array(2) {
// ["role"]=>
// string(6) "system"
// ["content"]=>
// string(28) "You are a helpful assistant."
// }
// }
```