Skip to content

Commit e7e7267

Browse files
authored
Merge pull request #167 from openai-php/readme-responses
docs: migrate readme to responses api
2 parents 0af3c78 + 8d6dedd commit e7e7267

File tree

1 file changed

+11
-13
lines changed

1 file changed

+11
-13
lines changed

README.md

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -46,14 +46,12 @@ Finally, you may use the `OpenAI` facade to access the OpenAI API:
4646
```php
4747
use OpenAI\Laravel\Facades\OpenAI;
4848

49-
$result = OpenAI::chat()->create([
50-
'model' => 'gpt-4o-mini',
51-
'messages' => [
52-
['role' => 'user', 'content' => 'Hello!'],
53-
],
49+
$result = OpenAI::responses()->create([
50+
'model' => 'gpt-5',
51+
'input' => 'Hello!',
5452
]);
5553

56-
echo $result->choices[0]->message->content; // Hello! How can I assist you today?
54+
echo $response->outputText; // Hello! How can I assist you today?
5755
```
5856

5957
## Configuration
@@ -111,7 +109,7 @@ All responses are having a `fake()` method that allows you to easily create a re
111109

112110
```php
113111
use OpenAI\Laravel\Facades\OpenAI;
114-
use OpenAI\Responses\Completions\CreateResponse;
112+
use OpenAI\Responses\Responses\CreateResponse;
115113

116114
OpenAI::fake([
117115
CreateResponse::fake([
@@ -123,21 +121,21 @@ OpenAI::fake([
123121
]),
124122
]);
125123

126-
$completion = OpenAI::completions()->create([
127-
'model' => 'gpt-4o-mini',
128-
'prompt' => 'PHP is ',
124+
$response = OpenAI::responses()->create([
125+
'model' => 'gpt-5',
126+
'input' => 'PHP is ',
129127
]);
130128

131-
expect($completion['choices'][0]['text'])->toBe('awesome!');
129+
expect($response->outputText)->toBe('awesome!');
132130
```
133131

134132
After the requests have been sent there are various methods to ensure that the expected requests were sent:
135133

136134
```php
137135
// assert completion create request was sent
138-
OpenAI::assertSent(Completions::class, function (string $method, array $parameters): bool {
136+
OpenAI::assertSent(Responses::class, function (string $method, array $parameters): bool {
139137
return $method === 'create' &&
140-
$parameters['model'] === 'gpt-4o-mini' &&
138+
$parameters['model'] === 'gpt-5' &&
141139
$parameters['prompt'] === 'PHP is ';
142140
});
143141
```

0 commit comments

Comments
 (0)