Skip to content

Commit 6bb0f75

Browse files
stainless-app[bot]stainless-app[bot]
committed
feat(client)!: improve naming of some variants (#89)
1 parent 4df9f9a commit 6bb0f75

File tree

5 files changed

+47
-46
lines changed

5 files changed

+47
-46
lines changed

‎.stats.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
configured_endpoints: 68
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai-8729aaa35436531ab453224af10e67f89677db8f350f0346bb3537489edea649.yml
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai-f9320ebf347140052c7f8b0bc5c7db24f5e367c368c8cb34c3606af4e2b6591b.yml

‎chatcompletion.go‎

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1558,7 +1558,7 @@ func (r ChatCompletionToolType) IsKnown() bool {
15581558
// `none` is the default when no tools are present. `auto` is the default if tools
15591559
// are present.
15601560
//
1561-
// Satisfied by [ChatCompletionToolChoiceOptionString],
1561+
// Satisfied by [ChatCompletionToolChoiceOptionBehavior],
15621562
// [ChatCompletionNamedToolChoiceParam].
15631563
type ChatCompletionToolChoiceOptionUnionParam interface {
15641564
implementsChatCompletionToolChoiceOptionUnionParam()
@@ -1567,23 +1567,24 @@ type ChatCompletionToolChoiceOptionUnionParam interface {
15671567
// `none` means the model will not call any tool and instead generates a message.
15681568
// `auto` means the model can pick between generating a message or calling one or
15691569
// more tools. `required` means the model must call one or more tools.
1570-
type ChatCompletionToolChoiceOptionString string
1570+
type ChatCompletionToolChoiceOptionBehavior string
15711571

15721572
const (
1573-
ChatCompletionToolChoiceOptionStringNone ChatCompletionToolChoiceOptionString = "none"
1574-
ChatCompletionToolChoiceOptionStringAuto ChatCompletionToolChoiceOptionString = "auto"
1575-
ChatCompletionToolChoiceOptionStringRequired ChatCompletionToolChoiceOptionString = "required"
1573+
ChatCompletionToolChoiceOptionBehaviorNone ChatCompletionToolChoiceOptionBehavior = "none"
1574+
ChatCompletionToolChoiceOptionBehaviorAuto ChatCompletionToolChoiceOptionBehavior = "auto"
1575+
ChatCompletionToolChoiceOptionBehaviorRequired ChatCompletionToolChoiceOptionBehavior = "required"
15761576
)
15771577

1578-
func (r ChatCompletionToolChoiceOptionString) IsKnown() bool {
1578+
func (r ChatCompletionToolChoiceOptionBehavior) IsKnown() bool {
15791579
switch r {
1580-
case ChatCompletionToolChoiceOptionStringNone, ChatCompletionToolChoiceOptionStringAuto, ChatCompletionToolChoiceOptionStringRequired:
1580+
case ChatCompletionToolChoiceOptionBehaviorNone, ChatCompletionToolChoiceOptionBehaviorAuto, ChatCompletionToolChoiceOptionBehaviorRequired:
15811581
return true
15821582
}
15831583
return false
15841584
}
15851585

1586-
func (r ChatCompletionToolChoiceOptionString) implementsChatCompletionToolChoiceOptionUnionParam() {}
1586+
func (r ChatCompletionToolChoiceOptionBehavior) implementsChatCompletionToolChoiceOptionUnionParam() {
1587+
}
15871588

15881589
type ChatCompletionToolMessageParam struct {
15891590
// The contents of the tool message.
@@ -1838,7 +1839,7 @@ func (r ChatCompletionNewParams) MarshalJSON() (data []byte, err error) {
18381839
// `none` is the default when no functions are present. `auto` is the default if
18391840
// functions are present.
18401841
//
1841-
// Satisfied by [ChatCompletionNewParamsFunctionCallString],
1842+
// Satisfied by [ChatCompletionNewParamsFunctionCallBehavior],
18421843
// [ChatCompletionFunctionCallOptionParam].
18431844
type ChatCompletionNewParamsFunctionCallUnion interface {
18441845
implementsChatCompletionNewParamsFunctionCallUnion()
@@ -1847,22 +1848,22 @@ type ChatCompletionNewParamsFunctionCallUnion interface {
18471848
// `none` means the model will not call a function and instead generates a message.
18481849
// `auto` means the model can pick between generating a message or calling a
18491850
// function.
1850-
type ChatCompletionNewParamsFunctionCallString string
1851+
type ChatCompletionNewParamsFunctionCallBehavior string
18511852

18521853
const (
1853-
ChatCompletionNewParamsFunctionCallStringNone ChatCompletionNewParamsFunctionCallString = "none"
1854-
ChatCompletionNewParamsFunctionCallStringAuto ChatCompletionNewParamsFunctionCallString = "auto"
1854+
ChatCompletionNewParamsFunctionCallBehaviorNone ChatCompletionNewParamsFunctionCallBehavior = "none"
1855+
ChatCompletionNewParamsFunctionCallBehaviorAuto ChatCompletionNewParamsFunctionCallBehavior = "auto"
18551856
)
18561857

1857-
func (r ChatCompletionNewParamsFunctionCallString) IsKnown() bool {
1858+
func (r ChatCompletionNewParamsFunctionCallBehavior) IsKnown() bool {
18581859
switch r {
1859-
case ChatCompletionNewParamsFunctionCallStringNone, ChatCompletionNewParamsFunctionCallStringAuto:
1860+
case ChatCompletionNewParamsFunctionCallBehaviorNone, ChatCompletionNewParamsFunctionCallBehaviorAuto:
18601861
return true
18611862
}
18621863
return false
18631864
}
18641865

1865-
func (r ChatCompletionNewParamsFunctionCallString) implementsChatCompletionNewParamsFunctionCallUnion() {
1866+
func (r ChatCompletionNewParamsFunctionCallBehavior) implementsChatCompletionNewParamsFunctionCallUnion() {
18661867
}
18671868

18681869
type ChatCompletionNewParamsFunction struct {

‎chatcompletion_test.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ func TestChatCompletionNewWithOptionalParams(t *testing.T) {
3838
Voice: openai.F(openai.ChatCompletionAudioParamVoiceAlloy),
3939
}),
4040
FrequencyPenalty: openai.F(-2.000000),
41-
FunctionCall: openai.F[openai.ChatCompletionNewParamsFunctionCallUnion](openai.ChatCompletionNewParamsFunctionCallString(openai.ChatCompletionNewParamsFunctionCallStringNone)),
41+
FunctionCall: openai.F[openai.ChatCompletionNewParamsFunctionCallUnion](openai.ChatCompletionNewParamsFunctionCallBehavior(openai.ChatCompletionNewParamsFunctionCallBehaviorNone)),
4242
Functions: openai.F([]openai.ChatCompletionNewParamsFunction{{
4343
Name: openai.F("name"),
4444
Description: openai.F("description"),
@@ -70,7 +70,7 @@ func TestChatCompletionNewWithOptionalParams(t *testing.T) {
7070
IncludeUsage: openai.F(true),
7171
}),
7272
Temperature: openai.F(1.000000),
73-
ToolChoice: openai.F[openai.ChatCompletionToolChoiceOptionUnionParam](openai.ChatCompletionToolChoiceOptionString(openai.ChatCompletionToolChoiceOptionStringNone)),
73+
ToolChoice: openai.F[openai.ChatCompletionToolChoiceOptionUnionParam](openai.ChatCompletionToolChoiceOptionBehavior(openai.ChatCompletionToolChoiceOptionBehaviorNone)),
7474
Tools: openai.F([]openai.ChatCompletionToolParam{{
7575
Function: openai.F(shared.FunctionDefinitionParam{
7676
Name: openai.F("name"),

‎finetuningjob.go‎

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -279,7 +279,7 @@ func (r fineTuningJobHyperparametersJSON) RawJSON() string {
279279
// on the size of the dataset. If setting the number manually, we support any
280280
// number between 1 and 50 epochs.
281281
//
282-
// Union satisfied by [FineTuningJobHyperparametersNEpochsString] or
282+
// Union satisfied by [FineTuningJobHyperparametersNEpochsBehavior] or
283283
// [shared.UnionInt].
284284
type FineTuningJobHyperparametersNEpochsUnion interface {
285285
ImplementsFineTuningJobHyperparametersNEpochsUnion()
@@ -291,7 +291,7 @@ func init() {
291291
"",
292292
apijson.UnionVariant{
293293
TypeFilter: gjson.String,
294-
Type: reflect.TypeOf(FineTuningJobHyperparametersNEpochsString("")),
294+
Type: reflect.TypeOf(FineTuningJobHyperparametersNEpochsBehavior("")),
295295
},
296296
apijson.UnionVariant{
297297
TypeFilter: gjson.Number,
@@ -300,21 +300,21 @@ func init() {
300300
)
301301
}
302302

303-
type FineTuningJobHyperparametersNEpochsString string
303+
type FineTuningJobHyperparametersNEpochsBehavior string
304304

305305
const (
306-
FineTuningJobHyperparametersNEpochsStringAuto FineTuningJobHyperparametersNEpochsString = "auto"
306+
FineTuningJobHyperparametersNEpochsBehaviorAuto FineTuningJobHyperparametersNEpochsBehavior = "auto"
307307
)
308308

309-
func (r FineTuningJobHyperparametersNEpochsString) IsKnown() bool {
309+
func (r FineTuningJobHyperparametersNEpochsBehavior) IsKnown() bool {
310310
switch r {
311-
case FineTuningJobHyperparametersNEpochsStringAuto:
311+
case FineTuningJobHyperparametersNEpochsBehaviorAuto:
312312
return true
313313
}
314314
return false
315315
}
316316

317-
func (r FineTuningJobHyperparametersNEpochsString) ImplementsFineTuningJobHyperparametersNEpochsUnion() {
317+
func (r FineTuningJobHyperparametersNEpochsBehavior) ImplementsFineTuningJobHyperparametersNEpochsUnion() {
318318
}
319319

320320
// The object type, which is always "fine_tuning.job".
@@ -586,80 +586,80 @@ func (r FineTuningJobNewParamsHyperparameters) MarshalJSON() (data []byte, err e
586586
// Number of examples in each batch. A larger batch size means that model
587587
// parameters are updated less frequently, but with lower variance.
588588
//
589-
// Satisfied by [FineTuningJobNewParamsHyperparametersBatchSizeString],
589+
// Satisfied by [FineTuningJobNewParamsHyperparametersBatchSizeBehavior],
590590
// [shared.UnionInt].
591591
type FineTuningJobNewParamsHyperparametersBatchSizeUnion interface {
592592
ImplementsFineTuningJobNewParamsHyperparametersBatchSizeUnion()
593593
}
594594

595-
type FineTuningJobNewParamsHyperparametersBatchSizeString string
595+
type FineTuningJobNewParamsHyperparametersBatchSizeBehavior string
596596

597597
const (
598-
FineTuningJobNewParamsHyperparametersBatchSizeStringAuto FineTuningJobNewParamsHyperparametersBatchSizeString = "auto"
598+
FineTuningJobNewParamsHyperparametersBatchSizeBehaviorAuto FineTuningJobNewParamsHyperparametersBatchSizeBehavior = "auto"
599599
)
600600

601-
func (r FineTuningJobNewParamsHyperparametersBatchSizeString) IsKnown() bool {
601+
func (r FineTuningJobNewParamsHyperparametersBatchSizeBehavior) IsKnown() bool {
602602
switch r {
603-
case FineTuningJobNewParamsHyperparametersBatchSizeStringAuto:
603+
case FineTuningJobNewParamsHyperparametersBatchSizeBehaviorAuto:
604604
return true
605605
}
606606
return false
607607
}
608608

609-
func (r FineTuningJobNewParamsHyperparametersBatchSizeString) ImplementsFineTuningJobNewParamsHyperparametersBatchSizeUnion() {
609+
func (r FineTuningJobNewParamsHyperparametersBatchSizeBehavior) ImplementsFineTuningJobNewParamsHyperparametersBatchSizeUnion() {
610610
}
611611

612612
// Scaling factor for the learning rate. A smaller learning rate may be useful to
613613
// avoid overfitting.
614614
//
615615
// Satisfied by
616-
// [FineTuningJobNewParamsHyperparametersLearningRateMultiplierString],
616+
// [FineTuningJobNewParamsHyperparametersLearningRateMultiplierBehavior],
617617
// [shared.UnionFloat].
618618
type FineTuningJobNewParamsHyperparametersLearningRateMultiplierUnion interface {
619619
ImplementsFineTuningJobNewParamsHyperparametersLearningRateMultiplierUnion()
620620
}
621621

622-
type FineTuningJobNewParamsHyperparametersLearningRateMultiplierString string
622+
type FineTuningJobNewParamsHyperparametersLearningRateMultiplierBehavior string
623623

624624
const (
625-
FineTuningJobNewParamsHyperparametersLearningRateMultiplierStringAuto FineTuningJobNewParamsHyperparametersLearningRateMultiplierString = "auto"
625+
FineTuningJobNewParamsHyperparametersLearningRateMultiplierBehaviorAuto FineTuningJobNewParamsHyperparametersLearningRateMultiplierBehavior = "auto"
626626
)
627627

628-
func (r FineTuningJobNewParamsHyperparametersLearningRateMultiplierString) IsKnown() bool {
628+
func (r FineTuningJobNewParamsHyperparametersLearningRateMultiplierBehavior) IsKnown() bool {
629629
switch r {
630-
case FineTuningJobNewParamsHyperparametersLearningRateMultiplierStringAuto:
630+
case FineTuningJobNewParamsHyperparametersLearningRateMultiplierBehaviorAuto:
631631
return true
632632
}
633633
return false
634634
}
635635

636-
func (r FineTuningJobNewParamsHyperparametersLearningRateMultiplierString) ImplementsFineTuningJobNewParamsHyperparametersLearningRateMultiplierUnion() {
636+
func (r FineTuningJobNewParamsHyperparametersLearningRateMultiplierBehavior) ImplementsFineTuningJobNewParamsHyperparametersLearningRateMultiplierUnion() {
637637
}
638638

639639
// The number of epochs to train the model for. An epoch refers to one full cycle
640640
// through the training dataset.
641641
//
642-
// Satisfied by [FineTuningJobNewParamsHyperparametersNEpochsString],
642+
// Satisfied by [FineTuningJobNewParamsHyperparametersNEpochsBehavior],
643643
// [shared.UnionInt].
644644
type FineTuningJobNewParamsHyperparametersNEpochsUnion interface {
645645
ImplementsFineTuningJobNewParamsHyperparametersNEpochsUnion()
646646
}
647647

648-
type FineTuningJobNewParamsHyperparametersNEpochsString string
648+
type FineTuningJobNewParamsHyperparametersNEpochsBehavior string
649649

650650
const (
651-
FineTuningJobNewParamsHyperparametersNEpochsStringAuto FineTuningJobNewParamsHyperparametersNEpochsString = "auto"
651+
FineTuningJobNewParamsHyperparametersNEpochsBehaviorAuto FineTuningJobNewParamsHyperparametersNEpochsBehavior = "auto"
652652
)
653653

654-
func (r FineTuningJobNewParamsHyperparametersNEpochsString) IsKnown() bool {
654+
func (r FineTuningJobNewParamsHyperparametersNEpochsBehavior) IsKnown() bool {
655655
switch r {
656-
case FineTuningJobNewParamsHyperparametersNEpochsStringAuto:
656+
case FineTuningJobNewParamsHyperparametersNEpochsBehaviorAuto:
657657
return true
658658
}
659659
return false
660660
}
661661

662-
func (r FineTuningJobNewParamsHyperparametersNEpochsString) ImplementsFineTuningJobNewParamsHyperparametersNEpochsUnion() {
662+
func (r FineTuningJobNewParamsHyperparametersNEpochsBehavior) ImplementsFineTuningJobNewParamsHyperparametersNEpochsUnion() {
663663
}
664664

665665
type FineTuningJobNewParamsIntegration struct {

‎finetuningjob_test.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,9 @@ func TestFineTuningJobNewWithOptionalParams(t *testing.T) {
2929
Model: openai.F(openai.FineTuningJobNewParamsModelBabbage002),
3030
TrainingFile: openai.F("file-abc123"),
3131
Hyperparameters: openai.F(openai.FineTuningJobNewParamsHyperparameters{
32-
BatchSize: openai.F[openai.FineTuningJobNewParamsHyperparametersBatchSizeUnion](openai.FineTuningJobNewParamsHyperparametersBatchSizeString(openai.FineTuningJobNewParamsHyperparametersBatchSizeStringAuto)),
33-
LearningRateMultiplier: openai.F[openai.FineTuningJobNewParamsHyperparametersLearningRateMultiplierUnion](openai.FineTuningJobNewParamsHyperparametersLearningRateMultiplierString(openai.FineTuningJobNewParamsHyperparametersLearningRateMultiplierStringAuto)),
34-
NEpochs: openai.F[openai.FineTuningJobNewParamsHyperparametersNEpochsUnion](openai.FineTuningJobNewParamsHyperparametersNEpochsString(openai.FineTuningJobNewParamsHyperparametersNEpochsStringAuto)),
32+
BatchSize: openai.F[openai.FineTuningJobNewParamsHyperparametersBatchSizeUnion](openai.FineTuningJobNewParamsHyperparametersBatchSizeBehavior(openai.FineTuningJobNewParamsHyperparametersBatchSizeBehaviorAuto)),
33+
LearningRateMultiplier: openai.F[openai.FineTuningJobNewParamsHyperparametersLearningRateMultiplierUnion](openai.FineTuningJobNewParamsHyperparametersLearningRateMultiplierBehavior(openai.FineTuningJobNewParamsHyperparametersLearningRateMultiplierBehaviorAuto)),
34+
NEpochs: openai.F[openai.FineTuningJobNewParamsHyperparametersNEpochsUnion](openai.FineTuningJobNewParamsHyperparametersNEpochsBehavior(openai.FineTuningJobNewParamsHyperparametersNEpochsBehaviorAuto)),
3535
}),
3636
Integrations: openai.F([]openai.FineTuningJobNewParamsIntegration{{
3737
Type: openai.F(openai.FineTuningJobNewParamsIntegrationsTypeWandb),

0 commit comments

Comments
 (0)