Skip to content

Update README.md #128

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jamesmalin wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Update README.md #128

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9001da2
Update README.md
jamesmalin Nov 26, 2023
a475ae6
Update README.md
jamesmalin May 11, 2024
8e32281
Merge branch 'main' into json-object-example
jamesmalin May 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -325,6 +325,31 @@ $complete = $open_ai->chat([
]);
```

For returning JSON responses from OpenAI you need to include the phrase JSON in your requests.

```php
$complete = $open_ai->chat([
'model' => 'gpt-3.5-turbo-1106',
'messages' => 'messages' => [
[
'role' => 'system',
'content' => 'You are a zoologist.'
],
[
'role' => 'system',
'content' => 'Respond with JSON. Use this structure: [{"animal":"","description":""}]'
],
[
'role' => 'user',
'content' => 'Supply a list of the most common animals you would see in a zoo.'
],
],
'temperature' => 1,
'max_tokens' => 3500,
'response_format' => [ 'type' => 'json_object' ]
]);
```

## Accessing the Element

```php
Expand Down