Skip to content

Commit 80debc8

Browse files
chore(docs): doc improvements (#350)
1 parent 605e303 commit 80debc8

File tree

4 files changed

+31
-1
lines changed

4 files changed

+31
-1
lines changed

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ To set up the repository, run:
44

55
```sh
66
$ ./scripts/bootstrap
7-
$ ./scripts/build
7+
$ ./scripts/lint
88
```
99

1010
This will install all the required dependencies and build the SDK.

audiotranscription.go

+2
Original file line numberDiff line numberDiff line change
@@ -352,6 +352,8 @@ type AudioTranscriptionNewParams struct {
352352
// Either or both of these options are supported: `word`, or `segment`. Note: There
353353
// is no additional latency for segment timestamps, but generating word timestamps
354354
// incurs additional latency.
355+
//
356+
// Any of "word", "segment".
355357
TimestampGranularities []string `json:"timestamp_granularities,omitzero"`
356358
paramObj
357359
}

chatcompletion.go

+2
Original file line numberDiff line numberDiff line change
@@ -2288,6 +2288,8 @@ type ChatCompletionNewParams struct {
22882288
// this model generate both text and audio responses, you can use:
22892289
//
22902290
// `["text", "audio"]`
2291+
//
2292+
// Any of "text", "audio".
22912293
Modalities []string `json:"modalities,omitzero"`
22922294
// **o-series models only**
22932295
//

moderation.go

+26
Original file line numberDiff line numberDiff line change
@@ -146,30 +146,56 @@ func (r *ModerationCategories) UnmarshalJSON(data []byte) error {
146146
// A list of the categories along with the input type(s) that the score applies to.
147147
type ModerationCategoryAppliedInputTypes struct {
148148
// The applied input type(s) for the category 'harassment'.
149+
//
150+
// Any of "text".
149151
Harassment []string `json:"harassment,required"`
150152
// The applied input type(s) for the category 'harassment/threatening'.
153+
//
154+
// Any of "text".
151155
HarassmentThreatening []string `json:"harassment/threatening,required"`
152156
// The applied input type(s) for the category 'hate'.
157+
//
158+
// Any of "text".
153159
Hate []string `json:"hate,required"`
154160
// The applied input type(s) for the category 'hate/threatening'.
161+
//
162+
// Any of "text".
155163
HateThreatening []string `json:"hate/threatening,required"`
156164
// The applied input type(s) for the category 'illicit'.
165+
//
166+
// Any of "text".
157167
Illicit []string `json:"illicit,required"`
158168
// The applied input type(s) for the category 'illicit/violent'.
169+
//
170+
// Any of "text".
159171
IllicitViolent []string `json:"illicit/violent,required"`
160172
// The applied input type(s) for the category 'self-harm'.
173+
//
174+
// Any of "text", "image".
161175
SelfHarm []string `json:"self-harm,required"`
162176
// The applied input type(s) for the category 'self-harm/instructions'.
177+
//
178+
// Any of "text", "image".
163179
SelfHarmInstructions []string `json:"self-harm/instructions,required"`
164180
// The applied input type(s) for the category 'self-harm/intent'.
181+
//
182+
// Any of "text", "image".
165183
SelfHarmIntent []string `json:"self-harm/intent,required"`
166184
// The applied input type(s) for the category 'sexual'.
185+
//
186+
// Any of "text", "image".
167187
Sexual []string `json:"sexual,required"`
168188
// The applied input type(s) for the category 'sexual/minors'.
189+
//
190+
// Any of "text".
169191
SexualMinors []string `json:"sexual/minors,required"`
170192
// The applied input type(s) for the category 'violence'.
193+
//
194+
// Any of "text", "image".
171195
Violence []string `json:"violence,required"`
172196
// The applied input type(s) for the category 'violence/graphic'.
197+
//
198+
// Any of "text", "image".
173199
ViolenceGraphic []string `json:"violence/graphic,required"`
174200
// Metadata for the response, check the presence of optional fields with the
175201
// [resp.Field.IsPresent] method.

0 commit comments

Comments
 (0)