Skip to content

Commit 40455a6

Browse files
committed
add moderations api
1 parent 78c003a commit 40455a6

File tree

2 files changed

+24
-3
lines changed

2 files changed

+24
-3
lines changed

README.md

+13-3
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ echo $result['choices'][0]['text']; // an open-source, widely-used, server-side
4646
- [x] Embeddings
4747
- [x] Files
4848
- [x] FineTunes
49-
- [ ] Moderations
49+
- [x] Moderations
5050
- [ ] Classifications
5151

5252
## Usage
@@ -98,14 +98,14 @@ $client->edits()->create(); // ['choices' => [...], ...]
9898
```
9999

100100
### `Embeddings` Resource
101-
101+
````
102102
#### `create`
103103
104104
Creates an embedding vector representing the input text.
105105
106106
```php
107107
$client->embeddings()->create(); // ['data' => [...], ...]
108-
```
108+
```````
109109
110110
### `Files` Resource
111111
@@ -194,6 +194,16 @@ Get fine-grained status updates for a fine-tune job.
194194
$client->fineTunes()->listEvents($fineTuneId); // ['data' => [...], ...]
195195
```
196196
197+
### `Moderations` Resource
198+
199+
#### `create`
200+
201+
Classifies if text violates OpenAI's Content Policy.
202+
203+
```php
204+
$client->moderations()->create($parameters); // ['id' => 'modr-5MWoLO', ...]
205+
```
206+
197207
198208
---
199209

src/Client.php

+11
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
use OpenAI\Resources\Files;
1212
use OpenAI\Resources\FineTunes;
1313
use OpenAI\Resources\Models;
14+
use OpenAI\Resources\Moderations;
1415

1516
final class Client
1617
{
@@ -82,4 +83,14 @@ public function fineTunes(): FineTunes
8283
{
8384
return new FineTunes($this->transporter);
8485
}
86+
87+
/**
88+
* Given a input text, outputs if the model classifies it as violating OpenAI's content policy.
89+
*
90+
* @see https://beta.openai.com/docs/api-reference/moderations/create
91+
*/
92+
public function moderations(): Moderations
93+
{
94+
return new Moderations($this->transporter);
95+
}
8596
}

0 commit comments

Comments
 (0)