Skip to content

Commit 677c38a

Browse files
committed
docs(OpenAI): remove nested resp->conversation docs
1 parent 45baebe commit 677c38a

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -312,14 +312,14 @@ $response->hasMore; // false
312312
$response->toArray(); // ['object' => 'list', 'data' => [...], ...]
313313
```
314314

315-
### `Responses Conversations` Resource
315+
### `Conversations` Resource
316316

317317
#### `create`
318318

319319
Create a conversation.
320320

321321
```php
322-
$response = $client->responses()->conversations()->create([
322+
$response = $client->conversations()->create([
323323
'metadata' => ['topic' => 'demo'],
324324
'items' => [
325325
[
@@ -343,7 +343,7 @@ $response->toArray(); // ['id' => 'conv_123', 'object' => 'conversation', ...]
343343
Retrieve a conversation by ID.
344344

345345
```php
346-
$response = $client->responses()->conversations()->retrieve('conv_123');
346+
$response = $client->conversations()->retrieve('conv_123');
347347

348348
$response->id; // 'conv_123'
349349
$response->object; // 'conversation'
@@ -357,7 +357,7 @@ $response->toArray(); // ['id' => 'conv_123', 'object' => 'conversation', ...]
357357
Update a conversation by ID.
358358

359359
```php
360-
$response = $client->responses()->conversations()->update('conv_123', [
360+
$response = $client->conversations()->update('conv_123', [
361361
'metadata' => ['foo' => 'bar'],
362362
]);
363363

@@ -370,7 +370,7 @@ $response->metadata; // ['foo' => 'bar']
370370
Delete a conversation by ID.
371371

372372
```php
373-
$response = $client->responses()->conversations()->delete('conv_123');
373+
$response = $client->conversations()->delete('conv_123');
374374

375375
$response->id; // 'conv_123'
376376
$response->object; // 'conversation.deleted'
@@ -386,7 +386,7 @@ $response->toArray(); // ['id' => 'conv_123', 'object' => 'conversation.deleted'
386386
Create items for a conversation.
387387

388388
```php
389-
$response = $client->responses()->conversations()->items()->create('conv_123', [
389+
$response = $client->conversations()->items()->create('conv_123', [
390390
'items' => [
391391
[
392392
'type' => 'message',
@@ -422,7 +422,7 @@ $response->toArray(); // ['object' => 'list', 'data' => [...], ...]
422422
List items for a conversation.
423423

424424
```php
425-
$response = $client->responses()->conversations()->items()->list('conv_123', [
425+
$response = $client->conversations()->items()->list('conv_123', [
426426
'limit' => 10,
427427
]);
428428

@@ -434,7 +434,7 @@ $response->object; // 'list'
434434
Retrieve a specific item from a conversation.
435435

436436
```php
437-
$response = $client->responses()->conversations()->items()->retrieve('conv_123', 'msg_abc', [
437+
$response = $client->conversations()->items()->retrieve('conv_123', 'msg_abc', [
438438
'include' => ['step_details'],
439439
]);
440440

@@ -448,7 +448,7 @@ $response->status; // 'completed'
448448
Delete a specific item from a conversation. Returns the updated conversation.
449449

450450
```php
451-
$response = $client->responses()->conversations()->items()->delete('conv_123', 'msg_abc');
451+
$response = $client->conversations()->items()->delete('conv_123', 'msg_abc');
452452

453453
$response->id; // 'conv_123'
454454
$response->object; // 'conversation'

0 commit comments

Comments
 (0)