Skip to content

Commit b28858c

Browse files
stainless-app[bot]stainless-app[bot]
committed
chore: update example values in tests and docs (#33)
1 parent 5a6eb17 commit b28858c

17 files changed

+266
-55
lines changed

‎README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,10 +92,10 @@ import java.util.List;
9292

9393
ChatCompletionCreateParams params = ChatCompletionCreateParams.builder()
9494
.message(List.of(ChatCompletionMessageParam.ofChatCompletionUserMessageParam(ChatCompletionUserMessageParam.builder()
95+
.role(ChatCompletionUserMessageParam.Role.USER)
9596
.content(ChatCompletionUserMessageParam.Content.ofTextContent("Say this is a test"))
96-
.role(ChatCompletionUserMessageParam.Role.user)
9797
.build())))
98-
.model("gpt-4o")
98+
.model(ChatModel.O1_PREVIEW)
9999
.build();
100100
ChatCompletion chatCompletion = client.chat().completions().create(params);
101101
```

‎openai-java-core/src/test/kotlin/com/openai/models/BatchCreateParamsTest.kt

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
package com.openai.models
44

5+
import com.openai.core.JsonValue
56
import com.openai.models.*
67
import org.assertj.core.api.Assertions.assertThat
78
import org.junit.jupiter.api.Test
@@ -14,7 +15,11 @@ class BatchCreateParamsTest {
1415
.completionWindow(BatchCreateParams.CompletionWindow._24H)
1516
.endpoint(BatchCreateParams.Endpoint.V1_CHAT_COMPLETIONS)
1617
.inputFileId("input_file_id")
17-
.metadata(BatchCreateParams.Metadata.builder().build())
18+
.metadata(
19+
BatchCreateParams.Metadata.builder()
20+
.putAdditionalProperty("foo", JsonValue.from("string"))
21+
.build()
22+
)
1823
.build()
1924
}
2025

@@ -25,14 +30,23 @@ class BatchCreateParamsTest {
2530
.completionWindow(BatchCreateParams.CompletionWindow._24H)
2631
.endpoint(BatchCreateParams.Endpoint.V1_CHAT_COMPLETIONS)
2732
.inputFileId("input_file_id")
28-
.metadata(BatchCreateParams.Metadata.builder().build())
33+
.metadata(
34+
BatchCreateParams.Metadata.builder()
35+
.putAdditionalProperty("foo", JsonValue.from("string"))
36+
.build()
37+
)
2938
.build()
3039
val body = params.getBody()
3140
assertThat(body).isNotNull
3241
assertThat(body.completionWindow()).isEqualTo(BatchCreateParams.CompletionWindow._24H)
3342
assertThat(body.endpoint()).isEqualTo(BatchCreateParams.Endpoint.V1_CHAT_COMPLETIONS)
3443
assertThat(body.inputFileId()).isEqualTo("input_file_id")
35-
assertThat(body.metadata()).isEqualTo(BatchCreateParams.Metadata.builder().build())
44+
assertThat(body.metadata())
45+
.isEqualTo(
46+
BatchCreateParams.Metadata.builder()
47+
.putAdditionalProperty("foo", JsonValue.from("string"))
48+
.build()
49+
)
3650
}
3751

3852
@Test

‎openai-java-core/src/test/kotlin/com/openai/models/BatchTest.kt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
package com.openai.models
44

5-
import com.openai.core.JsonNull
5+
import com.openai.core.JsonValue
66
import org.assertj.core.api.Assertions.assertThat
77
import org.junit.jupiter.api.Test
88

@@ -43,7 +43,7 @@ class BatchTest {
4343
.failedAt(0L)
4444
.finalizingAt(0L)
4545
.inProgressAt(0L)
46-
.metadata(JsonNull.of())
46+
.metadata(JsonValue.from(mapOf<String, Any>()))
4747
.outputFileId("output_file_id")
4848
.requestCounts(
4949
BatchRequestCounts.builder().completed(0L).failed(0L).total(0L).build()
@@ -82,7 +82,7 @@ class BatchTest {
8282
assertThat(batch.failedAt()).contains(0L)
8383
assertThat(batch.finalizingAt()).contains(0L)
8484
assertThat(batch.inProgressAt()).contains(0L)
85-
assertThat(batch._metadata()).isEqualTo(JsonNull.of())
85+
assertThat(batch._metadata()).isEqualTo(JsonValue.from(mapOf<String, Any>()))
8686
assertThat(batch.outputFileId()).contains("output_file_id")
8787
assertThat(batch.requestCounts())
8888
.contains(BatchRequestCounts.builder().completed(0L).failed(0L).total(0L).build())

‎openai-java-core/src/test/kotlin/com/openai/models/ChatCompletionCreateParamsTest.kt

Lines changed: 62 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
package com.openai.models
44

5+
import com.openai.core.JsonValue
56
import com.openai.models.*
67
import org.assertj.core.api.Assertions.assertThat
78
import org.junit.jupiter.api.Test
@@ -42,15 +43,27 @@ class ChatCompletionCreateParamsTest {
4243
ChatCompletionCreateParams.Function.builder()
4344
.name("name")
4445
.description("description")
45-
.parameters(FunctionParameters.builder().build())
46+
.parameters(
47+
FunctionParameters.builder()
48+
.putAdditionalProperty("foo", JsonValue.from("bar"))
49+
.build()
50+
)
4651
.build()
4752
)
4853
)
49-
.logitBias(ChatCompletionCreateParams.LogitBias.builder().build())
54+
.logitBias(
55+
ChatCompletionCreateParams.LogitBias.builder()
56+
.putAdditionalProperty("foo", JsonValue.from(0))
57+
.build()
58+
)
5059
.logprobs(true)
5160
.maxCompletionTokens(0L)
5261
.maxTokens(0L)
53-
.metadata(ChatCompletionCreateParams.Metadata.builder().build())
62+
.metadata(
63+
ChatCompletionCreateParams.Metadata.builder()
64+
.putAdditionalProperty("foo", JsonValue.from("string"))
65+
.build()
66+
)
5467
.modalities(listOf(ChatCompletionModality.TEXT))
5568
.n(1L)
5669
.parallelToolCalls(true)
@@ -84,7 +97,11 @@ class ChatCompletionCreateParamsTest {
8497
FunctionDefinition.builder()
8598
.name("name")
8699
.description("description")
87-
.parameters(FunctionParameters.builder().build())
100+
.parameters(
101+
FunctionParameters.builder()
102+
.putAdditionalProperty("foo", JsonValue.from("bar"))
103+
.build()
104+
)
88105
.strict(true)
89106
.build()
90107
)
@@ -133,15 +150,27 @@ class ChatCompletionCreateParamsTest {
133150
ChatCompletionCreateParams.Function.builder()
134151
.name("name")
135152
.description("description")
136-
.parameters(FunctionParameters.builder().build())
153+
.parameters(
154+
FunctionParameters.builder()
155+
.putAdditionalProperty("foo", JsonValue.from("bar"))
156+
.build()
157+
)
137158
.build()
138159
)
139160
)
140-
.logitBias(ChatCompletionCreateParams.LogitBias.builder().build())
161+
.logitBias(
162+
ChatCompletionCreateParams.LogitBias.builder()
163+
.putAdditionalProperty("foo", JsonValue.from(0))
164+
.build()
165+
)
141166
.logprobs(true)
142167
.maxCompletionTokens(0L)
143168
.maxTokens(0L)
144-
.metadata(ChatCompletionCreateParams.Metadata.builder().build())
169+
.metadata(
170+
ChatCompletionCreateParams.Metadata.builder()
171+
.putAdditionalProperty("foo", JsonValue.from("string"))
172+
.build()
173+
)
145174
.modalities(listOf(ChatCompletionModality.TEXT))
146175
.n(1L)
147176
.parallelToolCalls(true)
@@ -175,7 +204,11 @@ class ChatCompletionCreateParamsTest {
175204
FunctionDefinition.builder()
176205
.name("name")
177206
.description("description")
178-
.parameters(FunctionParameters.builder().build())
207+
.parameters(
208+
FunctionParameters.builder()
209+
.putAdditionalProperty("foo", JsonValue.from("bar"))
210+
.build()
211+
)
179212
.strict(true)
180213
.build()
181214
)
@@ -224,16 +257,29 @@ class ChatCompletionCreateParamsTest {
224257
ChatCompletionCreateParams.Function.builder()
225258
.name("name")
226259
.description("description")
227-
.parameters(FunctionParameters.builder().build())
260+
.parameters(
261+
FunctionParameters.builder()
262+
.putAdditionalProperty("foo", JsonValue.from("bar"))
263+
.build()
264+
)
228265
.build()
229266
)
230267
)
231268
assertThat(body.logitBias())
232-
.isEqualTo(ChatCompletionCreateParams.LogitBias.builder().build())
269+
.isEqualTo(
270+
ChatCompletionCreateParams.LogitBias.builder()
271+
.putAdditionalProperty("foo", JsonValue.from(0))
272+
.build()
273+
)
233274
assertThat(body.logprobs()).isEqualTo(true)
234275
assertThat(body.maxCompletionTokens()).isEqualTo(0L)
235276
assertThat(body.maxTokens()).isEqualTo(0L)
236-
assertThat(body.metadata()).isEqualTo(ChatCompletionCreateParams.Metadata.builder().build())
277+
assertThat(body.metadata())
278+
.isEqualTo(
279+
ChatCompletionCreateParams.Metadata.builder()
280+
.putAdditionalProperty("foo", JsonValue.from("string"))
281+
.build()
282+
)
237283
assertThat(body.modalities()).isEqualTo(listOf(ChatCompletionModality.TEXT))
238284
assertThat(body.n()).isEqualTo(1L)
239285
assertThat(body.parallelToolCalls()).isEqualTo(true)
@@ -272,7 +318,11 @@ class ChatCompletionCreateParamsTest {
272318
FunctionDefinition.builder()
273319
.name("name")
274320
.description("description")
275-
.parameters(FunctionParameters.builder().build())
321+
.parameters(
322+
FunctionParameters.builder()
323+
.putAdditionalProperty("foo", JsonValue.from("bar"))
324+
.build()
325+
)
276326
.strict(true)
277327
.build()
278328
)

‎openai-java-core/src/test/kotlin/com/openai/models/ChatCompletionToolTest.kt

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
package com.openai.models
44

5+
import com.openai.core.JsonValue
56
import org.assertj.core.api.Assertions.assertThat
67
import org.junit.jupiter.api.Test
78

@@ -15,7 +16,11 @@ class ChatCompletionToolTest {
1516
FunctionDefinition.builder()
1617
.name("name")
1718
.description("description")
18-
.parameters(FunctionParameters.builder().build())
19+
.parameters(
20+
FunctionParameters.builder()
21+
.putAdditionalProperty("foo", JsonValue.from("bar"))
22+
.build()
23+
)
1924
.strict(true)
2025
.build()
2126
)
@@ -27,7 +32,11 @@ class ChatCompletionToolTest {
2732
FunctionDefinition.builder()
2833
.name("name")
2934
.description("description")
30-
.parameters(FunctionParameters.builder().build())
35+
.parameters(
36+
FunctionParameters.builder()
37+
.putAdditionalProperty("foo", JsonValue.from("bar"))
38+
.build()
39+
)
3140
.strict(true)
3241
.build()
3342
)

‎openai-java-core/src/test/kotlin/com/openai/models/CompletionChoiceTest.kt

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
package com.openai.models
44

5+
import com.openai.core.JsonValue
56
import org.assertj.core.api.Assertions.assertThat
67
import org.junit.jupiter.api.Test
78

@@ -18,7 +19,13 @@ class CompletionChoiceTest {
1819
.textOffset(listOf(0L))
1920
.tokenLogprobs(listOf(0.0))
2021
.tokens(listOf("string"))
21-
.topLogprobs(listOf(CompletionChoice.Logprobs.TopLogprob.builder().build()))
22+
.topLogprobs(
23+
listOf(
24+
CompletionChoice.Logprobs.TopLogprob.builder()
25+
.putAdditionalProperty("foo", JsonValue.from(0))
26+
.build()
27+
)
28+
)
2229
.build()
2330
)
2431
.text("text")
@@ -32,7 +39,13 @@ class CompletionChoiceTest {
3239
.textOffset(listOf(0L))
3340
.tokenLogprobs(listOf(0.0))
3441
.tokens(listOf("string"))
35-
.topLogprobs(listOf(CompletionChoice.Logprobs.TopLogprob.builder().build()))
42+
.topLogprobs(
43+
listOf(
44+
CompletionChoice.Logprobs.TopLogprob.builder()
45+
.putAdditionalProperty("foo", JsonValue.from(0))
46+
.build()
47+
)
48+
)
3649
.build()
3750
)
3851
assertThat(completionChoice.text()).isEqualTo("text")

‎openai-java-core/src/test/kotlin/com/openai/models/CompletionCreateParamsTest.kt

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
package com.openai.models
44

5+
import com.openai.core.JsonValue
56
import com.openai.models.*
67
import org.assertj.core.api.Assertions.assertThat
78
import org.junit.jupiter.api.Test
@@ -16,7 +17,11 @@ class CompletionCreateParamsTest {
1617
.bestOf(0L)
1718
.echo(true)
1819
.frequencyPenalty(-2.0)
19-
.logitBias(CompletionCreateParams.LogitBias.builder().build())
20+
.logitBias(
21+
CompletionCreateParams.LogitBias.builder()
22+
.putAdditionalProperty("foo", JsonValue.from(0))
23+
.build()
24+
)
2025
.logprobs(0L)
2126
.maxTokens(16L)
2227
.n(1L)
@@ -40,7 +45,11 @@ class CompletionCreateParamsTest {
4045
.bestOf(0L)
4146
.echo(true)
4247
.frequencyPenalty(-2.0)
43-
.logitBias(CompletionCreateParams.LogitBias.builder().build())
48+
.logitBias(
49+
CompletionCreateParams.LogitBias.builder()
50+
.putAdditionalProperty("foo", JsonValue.from(0))
51+
.build()
52+
)
4453
.logprobs(0L)
4554
.maxTokens(16L)
4655
.n(1L)
@@ -61,7 +70,12 @@ class CompletionCreateParamsTest {
6170
assertThat(body.bestOf()).isEqualTo(0L)
6271
assertThat(body.echo()).isEqualTo(true)
6372
assertThat(body.frequencyPenalty()).isEqualTo(-2.0)
64-
assertThat(body.logitBias()).isEqualTo(CompletionCreateParams.LogitBias.builder().build())
73+
assertThat(body.logitBias())
74+
.isEqualTo(
75+
CompletionCreateParams.LogitBias.builder()
76+
.putAdditionalProperty("foo", JsonValue.from(0))
77+
.build()
78+
)
6579
assertThat(body.logprobs()).isEqualTo(0L)
6680
assertThat(body.maxTokens()).isEqualTo(16L)
6781
assertThat(body.n()).isEqualTo(1L)

‎openai-java-core/src/test/kotlin/com/openai/models/CompletionTest.kt

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
package com.openai.models
44

5+
import com.openai.core.JsonValue
56
import org.assertj.core.api.Assertions.assertThat
67
import org.junit.jupiter.api.Test
78

@@ -24,7 +25,9 @@ class CompletionTest {
2425
.tokens(listOf("string"))
2526
.topLogprobs(
2627
listOf(
27-
CompletionChoice.Logprobs.TopLogprob.builder().build()
28+
CompletionChoice.Logprobs.TopLogprob.builder()
29+
.putAdditionalProperty("foo", JsonValue.from(0))
30+
.build()
2831
)
2932
)
3033
.build()
@@ -72,7 +75,11 @@ class CompletionTest {
7275
.tokenLogprobs(listOf(0.0))
7376
.tokens(listOf("string"))
7477
.topLogprobs(
75-
listOf(CompletionChoice.Logprobs.TopLogprob.builder().build())
78+
listOf(
79+
CompletionChoice.Logprobs.TopLogprob.builder()
80+
.putAdditionalProperty("foo", JsonValue.from(0))
81+
.build()
82+
)
7683
)
7784
.build()
7885
)

0 commit comments

Comments
 (0)