diff --git a/.release-please-manifest.json b/.release-please-manifest.json index f81bf9923..8305d4ab7 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "0.31.0" + ".": "0.31.1" } \ No newline at end of file diff --git a/.stats.yml b/.stats.yml index 9790b6efb..20144667e 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,2 +1,2 @@ configured_endpoints: 72 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai-5d30684c3118d049682ea30cdb4dbef39b97d51667da484689193dc40162af32.yml +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai-b524aed1c2c5c928aa4e2c546f5dbb364e7b4d5027daf05e42e210b05a97c3c6.yml diff --git a/CHANGELOG.md b/CHANGELOG.md index 4b49c42c5..f563704ff 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,25 @@ # Changelog +## 0.31.1 (2025-03-05) + +Full Changelog: [v0.31.0...v0.31.1](https://github.com/openai/openai-java/compare/v0.31.0...v0.31.1) + +### Bug Fixes + +* **api:** add missing file rank enum + more metadata ([#276](https://github.com/openai/openai-java/issues/276)) ([e92512f](https://github.com/openai/openai-java/commit/e92512f551df43f994ec6a29cfb7ef918e203324)) + + +### Chores + +* **client:** expose `Optional`, not nullable, from `ClientOptions` ([#274](https://github.com/openai/openai-java/issues/274)) ([c029310](https://github.com/openai/openai-java/commit/c029310f6f31d5a78767585a9f4ece4ba076fe2e)) + + +### Documentation + +* add audio transcription example ([2c6a1aa](https://github.com/openai/openai-java/commit/2c6a1aa334dec5625a771ddd40452a7ffe32439b)) +* embeddings example ([#263](https://github.com/openai/openai-java/issues/263)) ([e1b68de](https://github.com/openai/openai-java/commit/e1b68de090359c4272435b2236fd021d616331a2)) +* note required fields in `builder` javadoc ([#272](https://github.com/openai/openai-java/issues/272)) ([603b5c9](https://github.com/openai/openai-java/commit/603b5c955ad383fa3ec358c91ce034cbbf7d1446)) + ## 0.31.0 (2025-03-04) Full Changelog: [v0.30.0...v0.31.0](https://github.com/openai/openai-java/compare/v0.30.0...v0.31.0) diff --git a/README.md b/README.md index f732fcf8d..1c3926903 100644 --- a/README.md +++ b/README.md @@ -9,8 +9,8 @@ -[![Maven Central](https://img.shields.io/maven-central/v/com.openai/openai-java)](https://central.sonatype.com/artifact/com.openai/openai-java/0.31.0) -[![javadoc](https://javadoc.io/badge2/com.openai/openai-java/0.31.0/javadoc.svg)](https://javadoc.io/doc/com.openai/openai-java/0.31.0) +[![Maven Central](https://img.shields.io/maven-central/v/com.openai/openai-java)](https://central.sonatype.com/artifact/com.openai/openai-java/0.31.1) +[![javadoc](https://javadoc.io/badge2/com.openai/openai-java/0.31.1/javadoc.svg)](https://javadoc.io/doc/com.openai/openai-java/0.31.1) @@ -25,7 +25,7 @@ The REST API documentation can be found on [platform.openai.com](https://platfor ### Gradle ```kotlin -implementation("com.openai:openai-java:0.31.0") +implementation("com.openai:openai-java:0.31.1") ``` ### Maven @@ -34,7 +34,7 @@ implementation("com.openai:openai-java:0.31.0") com.openai openai-java - 0.31.0 + 0.31.1 ``` diff --git a/build.gradle.kts b/build.gradle.kts index d91f6a4a8..52be4c723 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -8,7 +8,7 @@ repositories { allprojects { group = "com.openai" - version = "0.31.0" // x-release-please-version + version = "0.31.1" // x-release-please-version } subprojects { diff --git a/openai-java-client-okhttp/src/main/kotlin/com/openai/client/okhttp/OpenAIOkHttpClient.kt b/openai-java-client-okhttp/src/main/kotlin/com/openai/client/okhttp/OpenAIOkHttpClient.kt index a0c4a83bc..439aa742b 100644 --- a/openai-java-client-okhttp/src/main/kotlin/com/openai/client/okhttp/OpenAIOkHttpClient.kt +++ b/openai-java-client-okhttp/src/main/kotlin/com/openai/client/okhttp/OpenAIOkHttpClient.kt @@ -21,6 +21,7 @@ class OpenAIOkHttpClient private constructor() { companion object { + /** Returns a mutable builder for constructing an instance of [OpenAIOkHttpClient]. */ @JvmStatic fun builder() = Builder() @JvmStatic fun fromEnv(): OpenAIClient = builder().fromEnv().build() diff --git a/openai-java-client-okhttp/src/main/kotlin/com/openai/client/okhttp/OpenAIOkHttpClientAsync.kt b/openai-java-client-okhttp/src/main/kotlin/com/openai/client/okhttp/OpenAIOkHttpClientAsync.kt index 13163b9fe..272997c1a 100644 --- a/openai-java-client-okhttp/src/main/kotlin/com/openai/client/okhttp/OpenAIOkHttpClientAsync.kt +++ b/openai-java-client-okhttp/src/main/kotlin/com/openai/client/okhttp/OpenAIOkHttpClientAsync.kt @@ -21,6 +21,7 @@ class OpenAIOkHttpClientAsync private constructor() { companion object { + /** Returns a mutable builder for constructing an instance of [OpenAIOkHttpClientAsync]. */ @JvmStatic fun builder() = Builder() @JvmStatic fun fromEnv(): OpenAIClientAsync = builder().fromEnv().build() diff --git a/openai-java-core/src/main/kotlin/com/openai/core/ClientOptions.kt b/openai-java-core/src/main/kotlin/com/openai/core/ClientOptions.kt index 744f143f9..570b4943d 100644 --- a/openai-java-core/src/main/kotlin/com/openai/core/ClientOptions.kt +++ b/openai-java-core/src/main/kotlin/com/openai/core/ClientOptions.kt @@ -33,16 +33,29 @@ private constructor( @get:JvmName("timeout") val timeout: Timeout, @get:JvmName("maxRetries") val maxRetries: Int, @get:JvmName("credential") val credential: Credential, - @get:JvmName("organization") val organization: String?, - @get:JvmName("project") val project: String?, + private val organization: String?, + private val project: String?, ) { + fun organization(): Optional = Optional.ofNullable(organization) + + fun project(): Optional = Optional.ofNullable(project) + fun toBuilder() = Builder().from(this) companion object { const val PRODUCTION_URL = "https://api.openai.com/v1" + /** + * Returns a mutable builder for constructing an instance of [ClientOptions]. + * + * The following fields are required: + * ```java + * .httpClient() + * .apiKey() + * ``` + */ @JvmStatic fun builder() = Builder() @JvmStatic fun fromEnv(): ClientOptions = builder().fromEnv().build() diff --git a/openai-java-core/src/main/kotlin/com/openai/core/Timeout.kt b/openai-java-core/src/main/kotlin/com/openai/core/Timeout.kt index a27dd55a8..c38cba17d 100644 --- a/openai-java-core/src/main/kotlin/com/openai/core/Timeout.kt +++ b/openai-java-core/src/main/kotlin/com/openai/core/Timeout.kt @@ -60,6 +60,7 @@ private constructor( @JvmStatic fun default() = builder().build() + /** Returns a mutable builder for constructing an instance of [Timeout]. */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/errors/OpenAIError.kt b/openai-java-core/src/main/kotlin/com/openai/errors/OpenAIError.kt index 343f946c8..12ce3d189 100644 --- a/openai-java-core/src/main/kotlin/com/openai/errors/OpenAIError.kt +++ b/openai-java-core/src/main/kotlin/com/openai/errors/OpenAIError.kt @@ -27,6 +27,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [OpenAIError]. */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/Assistant.kt b/openai-java-core/src/main/kotlin/com/openai/models/Assistant.kt index ce1e4c05c..e05f95a58 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/Assistant.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/Assistant.kt @@ -275,6 +275,21 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [Assistant]. + * + * The following fields are required: + * ```java + * .id() + * .createdAt() + * .description() + * .instructions() + * .metadata() + * .model() + * .name() + * .tools() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -791,6 +806,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [ToolResources]. */ @JvmStatic fun builder() = Builder() } @@ -891,6 +907,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [CodeInterpreter]. */ @JvmStatic fun builder() = Builder() } @@ -1030,6 +1047,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [FileSearch]. */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/AssistantDeleted.kt b/openai-java-core/src/main/kotlin/com/openai/models/AssistantDeleted.kt index 817d1bc66..9ac566ee1 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/AssistantDeleted.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/AssistantDeleted.kt @@ -64,6 +64,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [AssistantDeleted]. + * + * The following fields are required: + * ```java + * .id() + * .deleted() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/AssistantStreamEvent.kt b/openai-java-core/src/main/kotlin/com/openai/models/AssistantStreamEvent.kt index 19e1fc07e..dc9bb3b20 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/AssistantStreamEvent.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/AssistantStreamEvent.kt @@ -1309,6 +1309,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ThreadCreated]. + * + * The following fields are required: + * ```java + * .data() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -1446,6 +1454,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ThreadRunCreated]. + * + * The following fields are required: + * ```java + * .data() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -1574,6 +1590,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ThreadRunQueued]. + * + * The following fields are required: + * ```java + * .data() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -1702,6 +1726,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ThreadRunInProgress]. + * + * The following fields are required: + * ```java + * .data() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -1830,6 +1862,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ThreadRunRequiresAction]. + * + * The following fields are required: + * ```java + * .data() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -1957,6 +1997,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ThreadRunCompleted]. + * + * The following fields are required: + * ```java + * .data() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -2085,6 +2133,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ThreadRunIncomplete]. + * + * The following fields are required: + * ```java + * .data() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -2210,6 +2266,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ThreadRunFailed]. + * + * The following fields are required: + * ```java + * .data() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -2338,6 +2402,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ThreadRunCancelling]. + * + * The following fields are required: + * ```java + * .data() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -2465,6 +2537,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ThreadRunCancelled]. + * + * The following fields are required: + * ```java + * .data() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -2590,6 +2670,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ThreadRunExpired]. + * + * The following fields are required: + * ```java + * .data() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -2714,6 +2802,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ThreadRunStepCreated]. + * + * The following fields are required: + * ```java + * .data() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -2833,6 +2929,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ThreadRunStepInProgress]. + * + * The following fields are required: + * ```java + * .data() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -2952,6 +3056,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ThreadRunStepDelta]. + * + * The following fields are required: + * ```java + * .data() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -3075,6 +3187,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ThreadRunStepCompleted]. + * + * The following fields are required: + * ```java + * .data() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -3193,6 +3313,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ThreadRunStepFailed]. + * + * The following fields are required: + * ```java + * .data() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -3312,6 +3440,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ThreadRunStepCancelled]. + * + * The following fields are required: + * ```java + * .data() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -3430,6 +3566,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ThreadRunStepExpired]. + * + * The following fields are required: + * ```java + * .data() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -3554,6 +3698,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ThreadMessageCreated]. + * + * The following fields are required: + * ```java + * .data() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -3684,6 +3836,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ThreadMessageInProgress]. + * + * The following fields are required: + * ```java + * .data() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -3808,6 +3968,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ThreadMessageDelta]. + * + * The following fields are required: + * ```java + * .data() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -3932,6 +4100,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ThreadMessageCompleted]. + * + * The following fields are required: + * ```java + * .data() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -4062,6 +4238,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ThreadMessageIncomplete]. + * + * The following fields are required: + * ```java + * .data() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -4184,6 +4368,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ErrorEvent]. + * + * The following fields are required: + * ```java + * .data() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/AssistantToolChoice.kt b/openai-java-core/src/main/kotlin/com/openai/models/AssistantToolChoice.kt index ca27fde8e..5330120f1 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/AssistantToolChoice.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/AssistantToolChoice.kt @@ -64,6 +64,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [AssistantToolChoice]. + * + * The following fields are required: + * ```java + * .type() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/AssistantToolChoiceFunction.kt b/openai-java-core/src/main/kotlin/com/openai/models/AssistantToolChoiceFunction.kt index a19ebcf21..272c72dd0 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/AssistantToolChoiceFunction.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/AssistantToolChoiceFunction.kt @@ -49,6 +49,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [AssistantToolChoiceFunction]. + * + * The following fields are required: + * ```java + * .name() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/AudioSpeechCreateParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/AudioSpeechCreateParams.kt index 24b65ffa6..354f19b1b 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/AudioSpeechCreateParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/AudioSpeechCreateParams.kt @@ -203,6 +203,16 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [Body]. + * + * The following fields are required: + * ```java + * .input() + * .model() + * .voice() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -345,6 +355,16 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [AudioSpeechCreateParams]. + * + * The following fields are required: + * ```java + * .input() + * .model() + * .voice() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/AudioTranscriptionCreateParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/AudioTranscriptionCreateParams.kt index 48a79d021..15ab5f5c6 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/AudioTranscriptionCreateParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/AudioTranscriptionCreateParams.kt @@ -281,6 +281,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [Body]. + * + * The following fields are required: + * ```java + * .file() + * .model() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -469,6 +478,16 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of + * [AudioTranscriptionCreateParams]. + * + * The following fields are required: + * ```java + * .file() + * .model() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/AudioTranslationCreateParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/AudioTranslationCreateParams.kt index fe1ea3cfd..349aff662 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/AudioTranslationCreateParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/AudioTranslationCreateParams.kt @@ -206,6 +206,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [Body]. + * + * The following fields are required: + * ```java + * .file() + * .model() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -339,6 +348,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [AudioTranslationCreateParams]. + * + * The following fields are required: + * ```java + * .file() + * .model() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/AutoFileChunkingStrategyParam.kt b/openai-java-core/src/main/kotlin/com/openai/models/AutoFileChunkingStrategyParam.kt index 0e5d08984..2b5b2070f 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/AutoFileChunkingStrategyParam.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/AutoFileChunkingStrategyParam.kt @@ -53,6 +53,10 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of + * [AutoFileChunkingStrategyParam]. + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/Batch.kt b/openai-java-core/src/main/kotlin/com/openai/models/Batch.kt index 902e1187a..101690197 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/Batch.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/Batch.kt @@ -274,6 +274,19 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [Batch]. + * + * The following fields are required: + * ```java + * .id() + * .completionWindow() + * .createdAt() + * .endpoint() + * .inputFileId() + * .status() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -696,6 +709,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [Errors]. */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/BatchCancelParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/BatchCancelParams.kt index 7f4ab1bad..5b562a94c 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/BatchCancelParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/BatchCancelParams.kt @@ -52,6 +52,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [BatchCancelParams]. + * + * The following fields are required: + * ```java + * .batchId() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/BatchCreateParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/BatchCreateParams.kt index 1b1a6d9d0..02a9b1f0a 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/BatchCreateParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/BatchCreateParams.kt @@ -232,6 +232,16 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [Body]. + * + * The following fields are required: + * ```java + * .completionWindow() + * .endpoint() + * .inputFileId() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -393,6 +403,16 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [BatchCreateParams]. + * + * The following fields are required: + * ```java + * .completionWindow() + * .endpoint() + * .inputFileId() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/BatchError.kt b/openai-java-core/src/main/kotlin/com/openai/models/BatchError.kt index 33eee763f..e2675a67a 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/BatchError.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/BatchError.kt @@ -75,6 +75,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [BatchError]. */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/BatchListPage.kt b/openai-java-core/src/main/kotlin/com/openai/models/BatchListPage.kt index 81d3e2a70..ce3311cce 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/BatchListPage.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/BatchListPage.kt @@ -124,6 +124,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [BatchListPage]. */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/BatchListPageAsync.kt b/openai-java-core/src/main/kotlin/com/openai/models/BatchListPageAsync.kt index 1479fd04f..d8b0994df 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/BatchListPageAsync.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/BatchListPageAsync.kt @@ -127,6 +127,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [BatchListPageAsync]. */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/BatchListParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/BatchListParams.kt index 5997e0f58..0e29ecc66 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/BatchListParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/BatchListParams.kt @@ -51,6 +51,7 @@ private constructor( @JvmStatic fun none(): BatchListParams = builder().build() + /** Returns a mutable builder for constructing an instance of [BatchListParams]. */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/BatchRequestCounts.kt b/openai-java-core/src/main/kotlin/com/openai/models/BatchRequestCounts.kt index 075cf81e9..dce9e81cd 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/BatchRequestCounts.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/BatchRequestCounts.kt @@ -68,6 +68,16 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [BatchRequestCounts]. + * + * The following fields are required: + * ```java + * .completed() + * .failed() + * .total() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/BatchRetrieveParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/BatchRetrieveParams.kt index 5e70eba94..55aaf6d5f 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/BatchRetrieveParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/BatchRetrieveParams.kt @@ -38,6 +38,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [BatchRetrieveParams]. + * + * The following fields are required: + * ```java + * .batchId() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/BetaAssistantCreateParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/BetaAssistantCreateParams.kt index 24948a0ae..2be099edb 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/BetaAssistantCreateParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/BetaAssistantCreateParams.kt @@ -491,6 +491,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [Body]. + * + * The following fields are required: + * ```java + * .model() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -1018,6 +1026,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [BetaAssistantCreateParams]. + * + * The following fields are required: + * ```java + * .model() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -1738,6 +1754,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [ToolResources]. */ @JvmStatic fun builder() = Builder() } @@ -1838,6 +1855,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [CodeInterpreter]. */ @JvmStatic fun builder() = Builder() } @@ -2000,6 +2018,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [FileSearch]. */ @JvmStatic fun builder() = Builder() } @@ -2203,6 +2222,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [VectorStore]. */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/BetaAssistantDeleteParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/BetaAssistantDeleteParams.kt index 23450f021..21b8f85b7 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/BetaAssistantDeleteParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/BetaAssistantDeleteParams.kt @@ -48,6 +48,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [BetaAssistantDeleteParams]. + * + * The following fields are required: + * ```java + * .assistantId() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/BetaAssistantListPage.kt b/openai-java-core/src/main/kotlin/com/openai/models/BetaAssistantListPage.kt index 666527f50..9b18e5de1 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/BetaAssistantListPage.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/BetaAssistantListPage.kt @@ -129,6 +129,9 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [BetaAssistantListPage]. + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/BetaAssistantListPageAsync.kt b/openai-java-core/src/main/kotlin/com/openai/models/BetaAssistantListPageAsync.kt index 79a244612..82758ad1a 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/BetaAssistantListPageAsync.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/BetaAssistantListPageAsync.kt @@ -132,6 +132,10 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of + * [BetaAssistantListPageAsync]. + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/BetaAssistantListParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/BetaAssistantListParams.kt index 985ad32a4..79d2c742f 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/BetaAssistantListParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/BetaAssistantListParams.kt @@ -72,6 +72,7 @@ private constructor( @JvmStatic fun none(): BetaAssistantListParams = builder().build() + /** Returns a mutable builder for constructing an instance of [BetaAssistantListParams]. */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/BetaAssistantRetrieveParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/BetaAssistantRetrieveParams.kt index b02400141..f2cc64654 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/BetaAssistantRetrieveParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/BetaAssistantRetrieveParams.kt @@ -38,6 +38,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [BetaAssistantRetrieveParams]. + * + * The following fields are required: + * ```java + * .assistantId() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/BetaAssistantUpdateParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/BetaAssistantUpdateParams.kt index 324c5d930..27ed6efcd 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/BetaAssistantUpdateParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/BetaAssistantUpdateParams.kt @@ -501,6 +501,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [Body]. */ @JvmStatic fun builder() = Builder() } @@ -1028,6 +1029,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [BetaAssistantUpdateParams]. + * + * The following fields are required: + * ```java + * .assistantId() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -2025,6 +2034,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [ToolResources]. */ @JvmStatic fun builder() = Builder() } @@ -2125,6 +2135,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [CodeInterpreter]. */ @JvmStatic fun builder() = Builder() } @@ -2267,6 +2278,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [FileSearch]. */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadCreateAndRunParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadCreateAndRunParams.kt index 1916afbf1..ef7ba4a07 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadCreateAndRunParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadCreateAndRunParams.kt @@ -667,6 +667,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [Body]. + * + * The following fields are required: + * ```java + * .assistantId() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -1352,6 +1360,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [BetaThreadCreateAndRunParams]. + * + * The following fields are required: + * ```java + * .assistantId() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -2141,6 +2157,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [Thread]. */ @JvmStatic fun builder() = Builder() } @@ -2369,6 +2386,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [Message]. + * + * The following fields are required: + * ```java + * .content() + * .role() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -2847,6 +2873,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [Attachment]. */ @JvmStatic fun builder() = Builder() } @@ -3188,6 +3215,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [ToolResources]. */ @JvmStatic fun builder() = Builder() } @@ -3291,6 +3319,9 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [CodeInterpreter]. + */ @JvmStatic fun builder() = Builder() } @@ -3453,6 +3484,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [FileSearch]. */ @JvmStatic fun builder() = Builder() } @@ -3658,6 +3690,9 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [VectorStore]. + */ @JvmStatic fun builder() = Builder() } @@ -3935,6 +3970,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [ToolResources]. */ @JvmStatic fun builder() = Builder() } @@ -4035,6 +4071,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [CodeInterpreter]. */ @JvmStatic fun builder() = Builder() } @@ -4174,6 +4211,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [FileSearch]. */ @JvmStatic fun builder() = Builder() } @@ -4510,6 +4548,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [TruncationStrategy]. + * + * The following fields are required: + * ```java + * .type() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadCreateParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadCreateParams.kt index 5426215d4..c2ba2100c 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadCreateParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadCreateParams.kt @@ -196,6 +196,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [Body]. */ @JvmStatic fun builder() = Builder() } @@ -350,6 +351,7 @@ private constructor( @JvmStatic fun none(): BetaThreadCreateParams = builder().build() + /** Returns a mutable builder for constructing an instance of [BetaThreadCreateParams]. */ @JvmStatic fun builder() = Builder() } @@ -663,6 +665,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [Message]. + * + * The following fields are required: + * ```java + * .content() + * .role() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -1122,6 +1133,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [Attachment]. */ @JvmStatic fun builder() = Builder() } @@ -1458,6 +1470,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [ToolResources]. */ @JvmStatic fun builder() = Builder() } @@ -1558,6 +1571,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [CodeInterpreter]. */ @JvmStatic fun builder() = Builder() } @@ -1720,6 +1734,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [FileSearch]. */ @JvmStatic fun builder() = Builder() } @@ -1923,6 +1938,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [VectorStore]. */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadDeleteParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadDeleteParams.kt index 00e226e28..fcdac72c9 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadDeleteParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadDeleteParams.kt @@ -48,6 +48,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [BetaThreadDeleteParams]. + * + * The following fields are required: + * ```java + * .threadId() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadMessageCreateParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadMessageCreateParams.kt index c18f842b2..37f6b9717 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadMessageCreateParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadMessageCreateParams.kt @@ -207,6 +207,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [Body]. + * + * The following fields are required: + * ```java + * .content() + * .role() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -365,6 +374,17 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of + * [BetaThreadMessageCreateParams]. + * + * The following fields are required: + * ```java + * .threadId() + * .content() + * .role() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -913,6 +933,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [Attachment]. */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadMessageDeleteParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadMessageDeleteParams.kt index fbb24cd19..741d0d61b 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadMessageDeleteParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadMessageDeleteParams.kt @@ -52,6 +52,16 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of + * [BetaThreadMessageDeleteParams]. + * + * The following fields are required: + * ```java + * .threadId() + * .messageId() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadMessageListPage.kt b/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadMessageListPage.kt index db0cff9d5..26b0f3cf8 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadMessageListPage.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadMessageListPage.kt @@ -129,6 +129,10 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of + * [BetaThreadMessageListPage]. + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadMessageListPageAsync.kt b/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadMessageListPageAsync.kt index 5d644592b..6735f0083 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadMessageListPageAsync.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadMessageListPageAsync.kt @@ -132,6 +132,10 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of + * [BetaThreadMessageListPageAsync]. + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadMessageListParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadMessageListParams.kt index 5bd9918f2..cc8248670 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadMessageListParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadMessageListParams.kt @@ -86,6 +86,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [BetaThreadMessageListParams]. + * + * The following fields are required: + * ```java + * .threadId() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadMessageRetrieveParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadMessageRetrieveParams.kt index a5c3a7f33..c97c4045d 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadMessageRetrieveParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadMessageRetrieveParams.kt @@ -42,6 +42,16 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of + * [BetaThreadMessageRetrieveParams]. + * + * The following fields are required: + * ```java + * .threadId() + * .messageId() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadMessageUpdateParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadMessageUpdateParams.kt index 59dc51eaf..70ff64d50 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadMessageUpdateParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadMessageUpdateParams.kt @@ -124,6 +124,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [Body]. */ @JvmStatic fun builder() = Builder() } @@ -213,6 +214,16 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of + * [BetaThreadMessageUpdateParams]. + * + * The following fields are required: + * ```java + * .threadId() + * .messageId() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadRetrieveParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadRetrieveParams.kt index b35a2d18e..77836a9ec 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadRetrieveParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadRetrieveParams.kt @@ -38,6 +38,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [BetaThreadRetrieveParams]. + * + * The following fields are required: + * ```java + * .threadId() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadRunCancelParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadRunCancelParams.kt index 7cfc8c7d2..00d6b1021 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadRunCancelParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadRunCancelParams.kt @@ -52,6 +52,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [BetaThreadRunCancelParams]. + * + * The following fields are required: + * ```java + * .threadId() + * .runId() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadRunCreateParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadRunCreateParams.kt index 366e0609a..d7b74e55a 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadRunCreateParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadRunCreateParams.kt @@ -734,6 +734,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [Body]. + * + * The following fields are required: + * ```java + * .assistantId() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -1476,6 +1484,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [BetaThreadRunCreateParams]. + * + * The following fields are required: + * ```java + * .threadId() + * .assistantId() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -2358,6 +2375,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [AdditionalMessage]. + * + * The following fields are required: + * ```java + * .content() + * .role() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -2817,6 +2843,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [Attachment]. */ @JvmStatic fun builder() = Builder() } @@ -3283,6 +3310,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [TruncationStrategy]. + * + * The following fields are required: + * ```java + * .type() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadRunListPage.kt b/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadRunListPage.kt index d13456574..2addc87cb 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadRunListPage.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadRunListPage.kt @@ -126,6 +126,9 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [BetaThreadRunListPage]. + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadRunListPageAsync.kt b/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadRunListPageAsync.kt index bcd8f2ef5..1b9b77c17 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadRunListPageAsync.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadRunListPageAsync.kt @@ -129,6 +129,10 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of + * [BetaThreadRunListPageAsync]. + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadRunListParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadRunListParams.kt index 18af3ace9..e2a7795fc 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadRunListParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadRunListParams.kt @@ -81,6 +81,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [BetaThreadRunListParams]. + * + * The following fields are required: + * ```java + * .threadId() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadRunRetrieveParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadRunRetrieveParams.kt index ef89ec493..c05218e74 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadRunRetrieveParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadRunRetrieveParams.kt @@ -42,6 +42,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [BetaThreadRunRetrieveParams]. + * + * The following fields are required: + * ```java + * .threadId() + * .runId() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadRunStepListPage.kt b/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadRunStepListPage.kt index 6fb4251ed..c019d363c 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadRunStepListPage.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadRunStepListPage.kt @@ -126,6 +126,10 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of + * [BetaThreadRunStepListPage]. + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadRunStepListPageAsync.kt b/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadRunStepListPageAsync.kt index fce887960..c837421b0 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadRunStepListPageAsync.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadRunStepListPageAsync.kt @@ -132,6 +132,10 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of + * [BetaThreadRunStepListPageAsync]. + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadRunStepListParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadRunStepListParams.kt index efbf21a75..f5398bb3c 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadRunStepListParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadRunStepListParams.kt @@ -99,6 +99,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [BetaThreadRunStepListParams]. + * + * The following fields are required: + * ```java + * .threadId() + * .runId() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadRunStepRetrieveParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadRunStepRetrieveParams.kt index 83682606e..546a4f33c 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadRunStepRetrieveParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadRunStepRetrieveParams.kt @@ -65,6 +65,17 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of + * [BetaThreadRunStepRetrieveParams]. + * + * The following fields are required: + * ```java + * .threadId() + * .runId() + * .stepId() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadRunSubmitToolOutputsParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadRunSubmitToolOutputsParams.kt index a6bdea965..5e8cdc1e4 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadRunSubmitToolOutputsParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadRunSubmitToolOutputsParams.kt @@ -103,6 +103,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [Body]. + * + * The following fields are required: + * ```java + * .toolOutputs() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -182,6 +190,17 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of + * [BetaThreadRunSubmitToolOutputsParams]. + * + * The following fields are required: + * ```java + * .threadId() + * .runId() + * .toolOutputs() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -404,6 +423,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [ToolOutput]. */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadRunUpdateParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadRunUpdateParams.kt index 7e2fb233e..997f435d7 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadRunUpdateParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadRunUpdateParams.kt @@ -124,6 +124,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [Body]. */ @JvmStatic fun builder() = Builder() } @@ -213,6 +214,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [BetaThreadRunUpdateParams]. + * + * The following fields are required: + * ```java + * .threadId() + * .runId() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadUpdateParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadUpdateParams.kt index ba4e3a291..490303028 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadUpdateParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadUpdateParams.kt @@ -158,6 +158,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [Body]. */ @JvmStatic fun builder() = Builder() } @@ -277,6 +278,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [BetaThreadUpdateParams]. + * + * The following fields are required: + * ```java + * .threadId() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -537,6 +546,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [ToolResources]. */ @JvmStatic fun builder() = Builder() } @@ -637,6 +647,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [CodeInterpreter]. */ @JvmStatic fun builder() = Builder() } @@ -776,6 +787,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [FileSearch]. */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreCreateParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreCreateParams.kt index f4583b246..6d40afc09 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreCreateParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreCreateParams.kt @@ -206,6 +206,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [Body]. */ @JvmStatic fun builder() = Builder() } @@ -388,6 +389,9 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [BetaVectorStoreCreateParams]. + */ @JvmStatic fun builder() = Builder() } @@ -680,6 +684,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ExpiresAfter]. + * + * The following fields are required: + * ```java + * .days() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreDeleteParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreDeleteParams.kt index 69ee69de8..6514557cb 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreDeleteParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreDeleteParams.kt @@ -48,6 +48,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [BetaVectorStoreDeleteParams]. + * + * The following fields are required: + * ```java + * .vectorStoreId() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreFileBatchCancelParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreFileBatchCancelParams.kt index b6e8e6707..a2e6d4eed 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreFileBatchCancelParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreFileBatchCancelParams.kt @@ -55,6 +55,16 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of + * [BetaVectorStoreFileBatchCancelParams]. + * + * The following fields are required: + * ```java + * .vectorStoreId() + * .batchId() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreFileBatchCreateParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreFileBatchCreateParams.kt index d94d823cd..327c5249c 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreFileBatchCreateParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreFileBatchCreateParams.kt @@ -136,6 +136,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [Body]. + * + * The following fields are required: + * ```java + * .fileIds() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -265,6 +273,16 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of + * [BetaVectorStoreFileBatchCreateParams]. + * + * The following fields are required: + * ```java + * .vectorStoreId() + * .fileIds() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreFileBatchListFilesPage.kt b/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreFileBatchListFilesPage.kt index d3d7aeb9f..6b4753be9 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreFileBatchListFilesPage.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreFileBatchListFilesPage.kt @@ -132,6 +132,10 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of + * [BetaVectorStoreFileBatchListFilesPage]. + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreFileBatchListFilesPageAsync.kt b/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreFileBatchListFilesPageAsync.kt index 2323bd19b..71578f302 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreFileBatchListFilesPageAsync.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreFileBatchListFilesPageAsync.kt @@ -135,6 +135,10 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of + * [BetaVectorStoreFileBatchListFilesPageAsync]. + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreFileBatchListFilesParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreFileBatchListFilesParams.kt index fe134c6fa..530699fe4 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreFileBatchListFilesParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreFileBatchListFilesParams.kt @@ -90,6 +90,16 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of + * [BetaVectorStoreFileBatchListFilesParams]. + * + * The following fields are required: + * ```java + * .vectorStoreId() + * .batchId() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreFileBatchRetrieveParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreFileBatchRetrieveParams.kt index 02f6783b8..ba4e0def1 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreFileBatchRetrieveParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreFileBatchRetrieveParams.kt @@ -42,6 +42,16 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of + * [BetaVectorStoreFileBatchRetrieveParams]. + * + * The following fields are required: + * ```java + * .vectorStoreId() + * .batchId() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreFileCreateParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreFileCreateParams.kt index 0259ca411..6ab4ff49f 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreFileCreateParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreFileCreateParams.kt @@ -139,6 +139,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [Body]. + * + * The following fields are required: + * ```java + * .fileId() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -255,6 +263,16 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of + * [BetaVectorStoreFileCreateParams]. + * + * The following fields are required: + * ```java + * .vectorStoreId() + * .fileId() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreFileDeleteParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreFileDeleteParams.kt index e8e48e504..c6bde659c 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreFileDeleteParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreFileDeleteParams.kt @@ -56,6 +56,16 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of + * [BetaVectorStoreFileDeleteParams]. + * + * The following fields are required: + * ```java + * .vectorStoreId() + * .fileId() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreFileListPage.kt b/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreFileListPage.kt index 2eb33b54f..a5aa0ec79 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreFileListPage.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreFileListPage.kt @@ -129,6 +129,10 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of + * [BetaVectorStoreFileListPage]. + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreFileListPageAsync.kt b/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreFileListPageAsync.kt index 5ff6dff47..687e1a08e 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreFileListPageAsync.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreFileListPageAsync.kt @@ -132,6 +132,10 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of + * [BetaVectorStoreFileListPageAsync]. + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreFileListParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreFileListParams.kt index bf3cb9905..cfc2d454c 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreFileListParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreFileListParams.kt @@ -86,6 +86,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of + * [BetaVectorStoreFileListParams]. + * + * The following fields are required: + * ```java + * .vectorStoreId() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreFileRetrieveParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreFileRetrieveParams.kt index a3e2d9999..522085f2d 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreFileRetrieveParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreFileRetrieveParams.kt @@ -42,6 +42,16 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of + * [BetaVectorStoreFileRetrieveParams]. + * + * The following fields are required: + * ```java + * .vectorStoreId() + * .fileId() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreListPage.kt b/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreListPage.kt index 4b223a8d0..fb97552ca 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreListPage.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreListPage.kt @@ -129,6 +129,9 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [BetaVectorStoreListPage]. + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreListPageAsync.kt b/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreListPageAsync.kt index 742f3af95..fedbf7800 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreListPageAsync.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreListPageAsync.kt @@ -132,6 +132,10 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of + * [BetaVectorStoreListPageAsync]. + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreListParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreListParams.kt index 7239e2a66..2124ffa1a 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreListParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreListParams.kt @@ -72,6 +72,9 @@ private constructor( @JvmStatic fun none(): BetaVectorStoreListParams = builder().build() + /** + * Returns a mutable builder for constructing an instance of [BetaVectorStoreListParams]. + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreRetrieveParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreRetrieveParams.kt index 0894f09fc..8ab587de2 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreRetrieveParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreRetrieveParams.kt @@ -38,6 +38,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of + * [BetaVectorStoreRetrieveParams]. + * + * The following fields are required: + * ```java + * .vectorStoreId() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreUpdateParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreUpdateParams.kt index a36af703e..4fe8d1ec3 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreUpdateParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreUpdateParams.kt @@ -156,6 +156,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [Body]. */ @JvmStatic fun builder() = Builder() } @@ -272,6 +273,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [BetaVectorStoreUpdateParams]. + * + * The following fields are required: + * ```java + * .vectorStoreId() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -518,6 +527,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ExpiresAfter]. + * + * The following fields are required: + * ```java + * .days() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletion.kt b/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletion.kt index 9d6a542ba..e57c184eb 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletion.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletion.kt @@ -137,6 +137,17 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ChatCompletion]. + * + * The following fields are required: + * ```java + * .id() + * .choices() + * .created() + * .model() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -354,6 +365,17 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [Choice]. + * + * The following fields are required: + * ```java + * .finishReason() + * .index() + * .logprobs() + * .message() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -629,6 +651,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [Logprobs]. + * + * The following fields are required: + * ```java + * .content() + * .refusal() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionAssistantMessageParam.kt b/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionAssistantMessageParam.kt index 312d18902..a48f1d14b 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionAssistantMessageParam.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionAssistantMessageParam.kt @@ -153,6 +153,10 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of + * [ChatCompletionAssistantMessageParam]. + */ @JvmStatic fun builder() = Builder() } @@ -366,6 +370,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [Audio]. + * + * The following fields are required: + * ```java + * .id() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -858,6 +870,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [FunctionCall]. + * + * The following fields are required: + * ```java + * .arguments() + * .name() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionAudio.kt b/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionAudio.kt index a7bde7393..9b825b92a 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionAudio.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionAudio.kt @@ -91,6 +91,17 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ChatCompletionAudio]. + * + * The following fields are required: + * ```java + * .id() + * .data() + * .expiresAt() + * .transcript() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionAudioParam.kt b/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionAudioParam.kt index 936fc5c2e..c8a31f7af 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionAudioParam.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionAudioParam.kt @@ -77,6 +77,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ChatCompletionAudioParam]. + * + * The following fields are required: + * ```java + * .format() + * .voice() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionChunk.kt b/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionChunk.kt index f84f58828..592da1372 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionChunk.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionChunk.kt @@ -160,6 +160,17 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ChatCompletionChunk]. + * + * The following fields are required: + * ```java + * .id() + * .choices() + * .created() + * .model() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -407,6 +418,16 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [Choice]. + * + * The following fields are required: + * ```java + * .delta() + * .finishReason() + * .index() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -598,6 +619,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [Delta]. */ @JvmStatic fun builder() = Builder() } @@ -772,6 +794,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [FunctionCall]. */ @JvmStatic fun builder() = Builder() } @@ -1044,6 +1067,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ToolCall]. + * + * The following fields are required: + * ```java + * .index() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -1176,6 +1207,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [Function]. */ @JvmStatic fun builder() = Builder() } @@ -1580,6 +1612,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [Logprobs]. + * + * The following fields are required: + * ```java + * .content() + * .refusal() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionContentPartImage.kt b/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionContentPartImage.kt index 13437a3fa..7e1773147 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionContentPartImage.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionContentPartImage.kt @@ -62,6 +62,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of + * [ChatCompletionContentPartImage]. + * + * The following fields are required: + * ```java + * .imageUrl() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -164,6 +173,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ImageUrl]. + * + * The following fields are required: + * ```java + * .url() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionContentPartInputAudio.kt b/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionContentPartInputAudio.kt index fb9aad9e1..1a4e39504 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionContentPartInputAudio.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionContentPartInputAudio.kt @@ -63,6 +63,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of + * [ChatCompletionContentPartInputAudio]. + * + * The following fields are required: + * ```java + * .inputAudio() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -163,6 +172,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [InputAudio]. + * + * The following fields are required: + * ```java + * .data() + * .format() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionContentPartRefusal.kt b/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionContentPartRefusal.kt index 6ee691d89..61962dfa1 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionContentPartRefusal.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionContentPartRefusal.kt @@ -61,6 +61,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of + * [ChatCompletionContentPartRefusal]. + * + * The following fields are required: + * ```java + * .refusal() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionContentPartText.kt b/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionContentPartText.kt index c7edcedc0..034c28efb 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionContentPartText.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionContentPartText.kt @@ -60,6 +60,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of + * [ChatCompletionContentPartText]. + * + * The following fields are required: + * ```java + * .text() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionCreateParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionCreateParams.kt index 65fbe332e..fd424ae72 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionCreateParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionCreateParams.kt @@ -1263,6 +1263,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [Body]. + * + * The following fields are required: + * ```java + * .messages() + * .model() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -2527,6 +2536,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ChatCompletionCreateParams]. + * + * The following fields are required: + * ```java + * .messages() + * .model() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -4116,6 +4134,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [Function]. + * + * The following fields are required: + * ```java + * .name() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -4264,6 +4290,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [LogitBias]. */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionDeleteParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionDeleteParams.kt index edde0e348..2f43c5f27 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionDeleteParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionDeleteParams.kt @@ -51,6 +51,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ChatCompletionDeleteParams]. + * + * The following fields are required: + * ```java + * .completionId() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionDeleted.kt b/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionDeleted.kt index 74b5e3a38..885eccc5b 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionDeleted.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionDeleted.kt @@ -69,6 +69,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ChatCompletionDeleted]. + * + * The following fields are required: + * ```java + * .id() + * .deleted() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionDeveloperMessageParam.kt b/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionDeveloperMessageParam.kt index 0574c4f1e..c77ecc302 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionDeveloperMessageParam.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionDeveloperMessageParam.kt @@ -90,6 +90,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of + * [ChatCompletionDeveloperMessageParam]. + * + * The following fields are required: + * ```java + * .content() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionFunctionCallOption.kt b/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionFunctionCallOption.kt index 7ad35cf75..19993eab0 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionFunctionCallOption.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionFunctionCallOption.kt @@ -53,6 +53,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of + * [ChatCompletionFunctionCallOption]. + * + * The following fields are required: + * ```java + * .name() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionFunctionMessageParam.kt b/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionFunctionMessageParam.kt index 16bfec777..db2bf68f4 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionFunctionMessageParam.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionFunctionMessageParam.kt @@ -71,6 +71,16 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of + * [ChatCompletionFunctionMessageParam]. + * + * The following fields are required: + * ```java + * .content() + * .name() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionMessage.kt b/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionMessage.kt index d7da00c38..c69b08872 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionMessage.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionMessage.kt @@ -144,6 +144,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ChatCompletionMessage]. + * + * The following fields are required: + * ```java + * .content() + * .refusal() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -333,6 +342,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [FunctionCall]. + * + * The following fields are required: + * ```java + * .arguments() + * .name() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionMessageListPage.kt b/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionMessageListPage.kt index eafba7f08..77e350fc7 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionMessageListPage.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionMessageListPage.kt @@ -134,6 +134,10 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of + * [ChatCompletionMessageListPage]. + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionMessageListPageAsync.kt b/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionMessageListPageAsync.kt index 7417066f6..abf7d1971 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionMessageListPageAsync.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionMessageListPageAsync.kt @@ -137,6 +137,10 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of + * [ChatCompletionMessageListPageAsync]. + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionMessageListParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionMessageListParams.kt index 9931b0944..71946a486 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionMessageListParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionMessageListParams.kt @@ -68,6 +68,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of + * [ChatCompletionMessageListParams]. + * + * The following fields are required: + * ```java + * .completionId() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionMessageToolCall.kt b/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionMessageToolCall.kt index 0903cebc1..52cc157c8 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionMessageToolCall.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionMessageToolCall.kt @@ -69,6 +69,16 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of + * [ChatCompletionMessageToolCall]. + * + * The following fields are required: + * ```java + * .id() + * .function() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -188,6 +198,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [Function]. + * + * The following fields are required: + * ```java + * .arguments() + * .name() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionNamedToolChoice.kt b/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionNamedToolChoice.kt index b07dc3e34..dffafe4c7 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionNamedToolChoice.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionNamedToolChoice.kt @@ -60,6 +60,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of + * [ChatCompletionNamedToolChoice]. + * + * The following fields are required: + * ```java + * .function() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -147,6 +156,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [Function]. + * + * The following fields are required: + * ```java + * .name() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionPredictionContent.kt b/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionPredictionContent.kt index aaac9c4a3..389618939 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionPredictionContent.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionPredictionContent.kt @@ -84,6 +84,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of + * [ChatCompletionPredictionContent]. + * + * The following fields are required: + * ```java + * .content() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionRetrieveParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionRetrieveParams.kt index 02d291ba6..c063bab80 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionRetrieveParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionRetrieveParams.kt @@ -41,6 +41,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ChatCompletionRetrieveParams]. + * + * The following fields are required: + * ```java + * .completionId() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionStoreMessage.kt b/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionStoreMessage.kt index 3d2755641..51ff17e3a 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionStoreMessage.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionStoreMessage.kt @@ -142,6 +142,16 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ChatCompletionStoreMessage]. + * + * The following fields are required: + * ```java + * .content() + * .refusal() + * .id() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionStreamOptions.kt b/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionStreamOptions.kt index 13d36387c..aef1ce624 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionStreamOptions.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionStreamOptions.kt @@ -65,6 +65,9 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ChatCompletionStreamOptions]. + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionSystemMessageParam.kt b/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionSystemMessageParam.kt index 3e35f5352..f3bcd6266 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionSystemMessageParam.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionSystemMessageParam.kt @@ -90,6 +90,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of + * [ChatCompletionSystemMessageParam]. + * + * The following fields are required: + * ```java + * .content() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionTokenLogprob.kt b/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionTokenLogprob.kt index 6a43736c7..da8c6e27f 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionTokenLogprob.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionTokenLogprob.kt @@ -105,6 +105,17 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ChatCompletionTokenLogprob]. + * + * The following fields are required: + * ```java + * .token() + * .bytes() + * .logprob() + * .topLogprobs() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -307,6 +318,16 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [TopLogprob]. + * + * The following fields are required: + * ```java + * .token() + * .bytes() + * .logprob() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionTool.kt b/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionTool.kt index cdff8a435..206b02565 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionTool.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionTool.kt @@ -61,6 +61,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ChatCompletionTool]. + * + * The following fields are required: + * ```java + * .function() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionToolMessageParam.kt b/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionToolMessageParam.kt index 68639c958..d94268b7b 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionToolMessageParam.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionToolMessageParam.kt @@ -82,6 +82,16 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of + * [ChatCompletionToolMessageParam]. + * + * The following fields are required: + * ```java + * .content() + * .toolCallId() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionUpdateParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionUpdateParams.kt index 5b7243dde..72a53a9bc 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionUpdateParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionUpdateParams.kt @@ -124,6 +124,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [Body]. + * + * The following fields are required: + * ```java + * .metadata() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -214,6 +222,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ChatCompletionUpdateParams]. + * + * The following fields are required: + * ```java + * .completionId() + * .metadata() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionUserMessageParam.kt b/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionUserMessageParam.kt index 80b530033..ea43dff23 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionUserMessageParam.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/ChatCompletionUserMessageParam.kt @@ -87,6 +87,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of + * [ChatCompletionUserMessageParam]. + * + * The following fields are required: + * ```java + * .content() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/CodeInterpreterLogs.kt b/openai-java-core/src/main/kotlin/com/openai/models/CodeInterpreterLogs.kt index 3617a1fb7..e01b1dcfd 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/CodeInterpreterLogs.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/CodeInterpreterLogs.kt @@ -69,6 +69,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [CodeInterpreterLogs]. + * + * The following fields are required: + * ```java + * .index() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/CodeInterpreterOutputImage.kt b/openai-java-core/src/main/kotlin/com/openai/models/CodeInterpreterOutputImage.kt index 2a97ae236..be2927fec 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/CodeInterpreterOutputImage.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/CodeInterpreterOutputImage.kt @@ -66,6 +66,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [CodeInterpreterOutputImage]. + * + * The following fields are required: + * ```java + * .index() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -162,6 +170,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [Image]. */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/CodeInterpreterTool.kt b/openai-java-core/src/main/kotlin/com/openai/models/CodeInterpreterTool.kt index b02bafcdc..3be2fb783 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/CodeInterpreterTool.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/CodeInterpreterTool.kt @@ -49,6 +49,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [CodeInterpreterTool]. */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/CodeInterpreterToolCall.kt b/openai-java-core/src/main/kotlin/com/openai/models/CodeInterpreterToolCall.kt index ca1b5a981..449da837b 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/CodeInterpreterToolCall.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/CodeInterpreterToolCall.kt @@ -88,6 +88,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [CodeInterpreterToolCall]. + * + * The following fields are required: + * ```java + * .id() + * .codeInterpreter() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -211,6 +220,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [CodeInterpreter]. + * + * The following fields are required: + * ```java + * .input() + * .outputs() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -506,6 +524,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [LogsOutput]. + * + * The following fields are required: + * ```java + * .logs() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -625,6 +651,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ImageOutput]. + * + * The following fields are required: + * ```java + * .image() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -723,6 +757,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [Image]. + * + * The following fields are required: + * ```java + * .fileId() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/CodeInterpreterToolCallDelta.kt b/openai-java-core/src/main/kotlin/com/openai/models/CodeInterpreterToolCallDelta.kt index bd43e7fba..1c45c004a 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/CodeInterpreterToolCallDelta.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/CodeInterpreterToolCallDelta.kt @@ -97,6 +97,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [CodeInterpreterToolCallDelta]. + * + * The following fields are required: + * ```java + * .index() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -229,6 +237,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [CodeInterpreter]. */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/Completion.kt b/openai-java-core/src/main/kotlin/com/openai/models/Completion.kt index 0a1563927..e3c5bad18 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/Completion.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/Completion.kt @@ -128,6 +128,17 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [Completion]. + * + * The following fields are required: + * ```java + * .id() + * .choices() + * .created() + * .model() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/CompletionChoice.kt b/openai-java-core/src/main/kotlin/com/openai/models/CompletionChoice.kt index db481b2e8..5c764cd49 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/CompletionChoice.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/CompletionChoice.kt @@ -87,6 +87,17 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [CompletionChoice]. + * + * The following fields are required: + * ```java + * .finishReason() + * .index() + * .logprobs() + * .text() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -349,6 +360,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [Logprobs]. */ @JvmStatic fun builder() = Builder() } @@ -478,6 +490,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [TopLogprob]. */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/CompletionCreateParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/CompletionCreateParams.kt index 5e2301891..69f968564 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/CompletionCreateParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/CompletionCreateParams.kt @@ -739,6 +739,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [Body]. + * + * The following fields are required: + * ```java + * .model() + * .prompt() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -1468,6 +1477,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [CompletionCreateParams]. + * + * The following fields are required: + * ```java + * .model() + * .prompt() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -2554,6 +2572,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [LogitBias]. */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/CompletionUsage.kt b/openai-java-core/src/main/kotlin/com/openai/models/CompletionUsage.kt index 303eaff76..e48f18891 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/CompletionUsage.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/CompletionUsage.kt @@ -103,6 +103,16 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [CompletionUsage]. + * + * The following fields are required: + * ```java + * .completionTokens() + * .promptTokens() + * .totalTokens() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -289,6 +299,9 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [CompletionTokensDetails]. + */ @JvmStatic fun builder() = Builder() } @@ -459,6 +472,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [PromptTokensDetails]. */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/CreateEmbeddingResponse.kt b/openai-java-core/src/main/kotlin/com/openai/models/CreateEmbeddingResponse.kt index 9680ca910..82baad0ed 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/CreateEmbeddingResponse.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/CreateEmbeddingResponse.kt @@ -78,6 +78,16 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [CreateEmbeddingResponse]. + * + * The following fields are required: + * ```java + * .data() + * .model() + * .usage() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -210,6 +220,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [Usage]. + * + * The following fields are required: + * ```java + * .promptTokens() + * .totalTokens() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/Embedding.kt b/openai-java-core/src/main/kotlin/com/openai/models/Embedding.kt index 171317c65..6f472cb43 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/Embedding.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/Embedding.kt @@ -77,6 +77,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [Embedding]. + * + * The following fields are required: + * ```java + * .embedding() + * .index() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/EmbeddingCreateParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/EmbeddingCreateParams.kt index a990cf143..f24213c0d 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/EmbeddingCreateParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/EmbeddingCreateParams.kt @@ -253,6 +253,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [Body]. + * + * The following fields are required: + * ```java + * .input() + * .model() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -432,6 +441,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [EmbeddingCreateParams]. + * + * The following fields are required: + * ```java + * .input() + * .model() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/ErrorObject.kt b/openai-java-core/src/main/kotlin/com/openai/models/ErrorObject.kt index bdb0d735f..bb44e4b03 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/ErrorObject.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/ErrorObject.kt @@ -68,6 +68,17 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ErrorObject]. + * + * The following fields are required: + * ```java + * .code() + * .message() + * .param() + * .type() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/FileCitationAnnotation.kt b/openai-java-core/src/main/kotlin/com/openai/models/FileCitationAnnotation.kt index 330357e63..cb4521add 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/FileCitationAnnotation.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/FileCitationAnnotation.kt @@ -90,6 +90,17 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [FileCitationAnnotation]. + * + * The following fields are required: + * ```java + * .endIndex() + * .fileCitation() + * .startIndex() + * .text() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -202,6 +213,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [FileCitation]. + * + * The following fields are required: + * ```java + * .fileId() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/FileCitationDeltaAnnotation.kt b/openai-java-core/src/main/kotlin/com/openai/models/FileCitationDeltaAnnotation.kt index 18067179e..3d91c5018 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/FileCitationDeltaAnnotation.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/FileCitationDeltaAnnotation.kt @@ -100,6 +100,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [FileCitationDeltaAnnotation]. + * + * The following fields are required: + * ```java + * .index() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -231,6 +239,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [FileCitation]. */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/FileContentParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/FileContentParams.kt index a519f9505..b026eae7b 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/FileContentParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/FileContentParams.kt @@ -38,6 +38,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [FileContentParams]. + * + * The following fields are required: + * ```java + * .fileId() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/FileCreateParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/FileCreateParams.kt index 6a50b282a..02b740283 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/FileCreateParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/FileCreateParams.kt @@ -130,6 +130,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [Body]. + * + * The following fields are required: + * ```java + * .file() + * .purpose() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -199,6 +208,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [FileCreateParams]. + * + * The following fields are required: + * ```java + * .file() + * .purpose() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/FileDeleteParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/FileDeleteParams.kt index cb4b350dd..016822bb9 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/FileDeleteParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/FileDeleteParams.kt @@ -48,6 +48,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [FileDeleteParams]. + * + * The following fields are required: + * ```java + * .fileId() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/FileDeleted.kt b/openai-java-core/src/main/kotlin/com/openai/models/FileDeleted.kt index c1ec3ab03..482f86b78 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/FileDeleted.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/FileDeleted.kt @@ -64,6 +64,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [FileDeleted]. + * + * The following fields are required: + * ```java + * .id() + * .deleted() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/FileListPage.kt b/openai-java-core/src/main/kotlin/com/openai/models/FileListPage.kt index be8e03301..5b39b7bd7 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/FileListPage.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/FileListPage.kt @@ -124,6 +124,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [FileListPage]. */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/FileListPageAsync.kt b/openai-java-core/src/main/kotlin/com/openai/models/FileListPageAsync.kt index db2bb01ac..518e5ab6f 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/FileListPageAsync.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/FileListPageAsync.kt @@ -127,6 +127,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [FileListPageAsync]. */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/FileListParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/FileListParams.kt index 41bc4505e..d8d60cf7f 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/FileListParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/FileListParams.kt @@ -68,6 +68,7 @@ private constructor( @JvmStatic fun none(): FileListParams = builder().build() + /** Returns a mutable builder for constructing an instance of [FileListParams]. */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/FileObject.kt b/openai-java-core/src/main/kotlin/com/openai/models/FileObject.kt index d354428a3..1b65490a2 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/FileObject.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/FileObject.kt @@ -156,6 +156,19 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [FileObject]. + * + * The following fields are required: + * ```java + * .id() + * .bytes() + * .createdAt() + * .filename() + * .purpose() + * .status() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/FilePathAnnotation.kt b/openai-java-core/src/main/kotlin/com/openai/models/FilePathAnnotation.kt index c6f089747..8d1a6d388 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/FilePathAnnotation.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/FilePathAnnotation.kt @@ -87,6 +87,17 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [FilePathAnnotation]. + * + * The following fields are required: + * ```java + * .endIndex() + * .filePath() + * .startIndex() + * .text() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -197,6 +208,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [FilePath]. + * + * The following fields are required: + * ```java + * .fileId() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/FilePathDeltaAnnotation.kt b/openai-java-core/src/main/kotlin/com/openai/models/FilePathDeltaAnnotation.kt index b0f4797f4..6ab4e7eb4 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/FilePathDeltaAnnotation.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/FilePathDeltaAnnotation.kt @@ -96,6 +96,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [FilePathDeltaAnnotation]. + * + * The following fields are required: + * ```java + * .index() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -215,6 +223,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [FilePath]. */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/FileRetrieveParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/FileRetrieveParams.kt index 692fe646c..082562be2 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/FileRetrieveParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/FileRetrieveParams.kt @@ -38,6 +38,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [FileRetrieveParams]. + * + * The following fields are required: + * ```java + * .fileId() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/FileSearchTool.kt b/openai-java-core/src/main/kotlin/com/openai/models/FileSearchTool.kt index f3c7861be..9b37e25f5 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/FileSearchTool.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/FileSearchTool.kt @@ -66,6 +66,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [FileSearchTool]. */ @JvmStatic fun builder() = Builder() } @@ -198,6 +199,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [FileSearch]. */ @JvmStatic fun builder() = Builder() } @@ -353,6 +355,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [RankingOptions]. + * + * The following fields are required: + * ```java + * .scoreThreshold() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/FileSearchToolCall.kt b/openai-java-core/src/main/kotlin/com/openai/models/FileSearchToolCall.kt index 68ea033ee..1785f4e4a 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/FileSearchToolCall.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/FileSearchToolCall.kt @@ -76,6 +76,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [FileSearchToolCall]. + * + * The following fields are required: + * ```java + * .id() + * .fileSearch() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -191,6 +200,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [FileSearch]. */ @JvmStatic fun builder() = Builder() } @@ -267,7 +277,7 @@ private constructor( private constructor( @JsonProperty("ranker") @ExcludeMissing - private val ranker: JsonValue = JsonMissing.of(), + private val ranker: JsonField = JsonMissing.of(), @JsonProperty("score_threshold") @ExcludeMissing private val scoreThreshold: JsonField = JsonMissing.of(), @@ -275,8 +285,10 @@ private constructor( private val additionalProperties: Map = immutableEmptyMap(), ) { - /** The ranker used for the file search. */ - @JsonProperty("ranker") @ExcludeMissing fun _ranker(): JsonValue = ranker + /** + * The ranker to use for the file search. If not specified will use the `auto` ranker. + */ + fun ranker(): Ranker = ranker.getRequired("ranker") /** * The score threshold for the file search. All values must be a floating point number @@ -284,6 +296,11 @@ private constructor( */ fun scoreThreshold(): Double = scoreThreshold.getRequired("score_threshold") + /** + * The ranker to use for the file search. If not specified will use the `auto` ranker. + */ + @JsonProperty("ranker") @ExcludeMissing fun _ranker(): JsonField = ranker + /** * The score threshold for the file search. All values must be a floating point number * between 0 and 1. @@ -303,11 +320,7 @@ private constructor( return@apply } - _ranker().let { - if (it != JsonValue.from("default_2024_08_21")) { - throw OpenAIInvalidDataException("'ranker' is invalid, received $it") - } - } + ranker() scoreThreshold() validated = true } @@ -316,13 +329,22 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [RankingOptions]. + * + * The following fields are required: + * ```java + * .ranker() + * .scoreThreshold() + * ``` + */ @JvmStatic fun builder() = Builder() } /** A builder for [RankingOptions]. */ class Builder internal constructor() { - private var ranker: JsonValue = JsonValue.from("default_2024_08_21") + private var ranker: JsonField? = null private var scoreThreshold: JsonField? = null private var additionalProperties: MutableMap = mutableMapOf() @@ -333,8 +355,17 @@ private constructor( additionalProperties = rankingOptions.additionalProperties.toMutableMap() } - /** The ranker used for the file search. */ - fun ranker(ranker: JsonValue) = apply { this.ranker = ranker } + /** + * The ranker to use for the file search. If not specified will use the `auto` + * ranker. + */ + fun ranker(ranker: Ranker) = ranker(JsonField.of(ranker)) + + /** + * The ranker to use for the file search. If not specified will use the `auto` + * ranker. + */ + fun ranker(ranker: JsonField) = apply { this.ranker = ranker } /** * The score threshold for the file search. All values must be a floating point @@ -375,12 +406,119 @@ private constructor( fun build(): RankingOptions = RankingOptions( - ranker, + checkRequired("ranker", ranker), checkRequired("scoreThreshold", scoreThreshold), additionalProperties.toImmutable(), ) } + /** + * The ranker to use for the file search. If not specified will use the `auto` ranker. + */ + class Ranker @JsonCreator private constructor(private val value: JsonField) : + Enum { + + /** + * Returns this class instance's raw value. + * + * This is usually only useful if this instance was deserialized from data that + * doesn't match any known member, and you want to know that value. For example, if + * the SDK is on an older version than the API, then the API may respond with new + * members that the SDK is unaware of. + */ + @com.fasterxml.jackson.annotation.JsonValue fun _value(): JsonField = value + + companion object { + + @JvmField val AUTO = of("auto") + + @JvmField val DEFAULT_2024_08_21 = of("default_2024_08_21") + + @JvmStatic fun of(value: String) = Ranker(JsonField.of(value)) + } + + /** An enum containing [Ranker]'s known values. */ + enum class Known { + AUTO, + DEFAULT_2024_08_21, + } + + /** + * An enum containing [Ranker]'s known values, as well as an [_UNKNOWN] member. + * + * An instance of [Ranker] can contain an unknown value in a couple of cases: + * - It was deserialized from data that doesn't match any known member. For example, + * if the SDK is on an older version than the API, then the API may respond with + * new members that the SDK is unaware of. + * - It was constructed with an arbitrary value using the [of] method. + */ + enum class Value { + AUTO, + DEFAULT_2024_08_21, + /** + * An enum member indicating that [Ranker] was instantiated with an unknown + * value. + */ + _UNKNOWN, + } + + /** + * Returns an enum member corresponding to this class instance's value, or + * [Value._UNKNOWN] if the class was instantiated with an unknown value. + * + * Use the [known] method instead if you're certain the value is always known or if + * you want to throw for the unknown case. + */ + fun value(): Value = + when (this) { + AUTO -> Value.AUTO + DEFAULT_2024_08_21 -> Value.DEFAULT_2024_08_21 + else -> Value._UNKNOWN + } + + /** + * Returns an enum member corresponding to this class instance's value. + * + * Use the [value] method instead if you're uncertain the value is always known and + * don't want to throw for the unknown case. + * + * @throws OpenAIInvalidDataException if this class instance's value is a not a + * known member. + */ + fun known(): Known = + when (this) { + AUTO -> Known.AUTO + DEFAULT_2024_08_21 -> Known.DEFAULT_2024_08_21 + else -> throw OpenAIInvalidDataException("Unknown Ranker: $value") + } + + /** + * Returns this class instance's primitive wire representation. + * + * This differs from the [toString] method because that method is primarily for + * debugging and generally doesn't throw. + * + * @throws OpenAIInvalidDataException if this class instance's value does not have + * the expected primitive type. + */ + fun asString(): String = + _value().asString().orElseThrow { + OpenAIInvalidDataException("Value is not a String") + } + + override fun equals(other: Any?): Boolean { + if (this === other) { + return true + } + + return /* spotless:off */ other is Ranker && value == other.value /* spotless:on */ + } + + override fun hashCode() = value.hashCode() + + override fun toString() = value.toString() + } + override fun equals(other: Any?): Boolean { if (this === other) { return true @@ -479,6 +617,16 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [Result]. + * + * The following fields are required: + * ```java + * .fileId() + * .fileName() + * .score() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -627,6 +775,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [Content]. */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/FileSearchToolCallDelta.kt b/openai-java-core/src/main/kotlin/com/openai/models/FileSearchToolCallDelta.kt index 0455612cb..657497ce9 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/FileSearchToolCallDelta.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/FileSearchToolCallDelta.kt @@ -76,6 +76,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [FileSearchToolCallDelta]. + * + * The following fields are required: + * ```java + * .fileSearch() + * .index() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJob.kt b/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJob.kt index 5a9f47d4b..ea6750ffa 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJob.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJob.kt @@ -79,6 +79,9 @@ private constructor( @ExcludeMissing private val integrations: JsonField> = JsonMissing.of(), + @JsonProperty("metadata") + @ExcludeMissing + private val metadata: JsonField = JsonMissing.of(), @JsonProperty("method") @ExcludeMissing private val method: JsonField = JsonMissing.of(), @@ -171,6 +174,16 @@ private constructor( fun integrations(): Optional> = Optional.ofNullable(integrations.getNullable("integrations")) + /** + * Set of 16 key-value pairs that can be attached to an object. This can be useful for storing + * additional information about the object in a structured format, and querying for objects via + * API or the dashboard. + * + * Keys are strings with a maximum length of 64 characters. Values are strings with a maximum + * length of 512 characters. + */ + fun metadata(): Optional = Optional.ofNullable(metadata.getNullable("metadata")) + /** The method used for fine-tuning. */ fun method(): Optional = Optional.ofNullable(method.getNullable("method")) @@ -270,6 +283,16 @@ private constructor( @ExcludeMissing fun _integrations(): JsonField> = integrations + /** + * Set of 16 key-value pairs that can be attached to an object. This can be useful for storing + * additional information about the object in a structured format, and querying for objects via + * API or the dashboard. + * + * Keys are strings with a maximum length of 64 characters. Values are strings with a maximum + * length of 512 characters. + */ + @JsonProperty("metadata") @ExcludeMissing fun _metadata(): JsonField = metadata + /** The method used for fine-tuning. */ @JsonProperty("method") @ExcludeMissing fun _method(): JsonField = method @@ -305,6 +328,7 @@ private constructor( validationFile() estimatedFinish() integrations().ifPresent { it.forEach { it.validate() } } + metadata().ifPresent { it.validate() } method().ifPresent { it.validate() } validated = true } @@ -313,6 +337,27 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [FineTuningJob]. + * + * The following fields are required: + * ```java + * .id() + * .createdAt() + * .error() + * .fineTunedModel() + * .finishedAt() + * .hyperparameters() + * .model() + * .organizationId() + * .resultFiles() + * .seed() + * .status() + * .trainedTokens() + * .trainingFile() + * .validationFile() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -337,6 +382,7 @@ private constructor( private var estimatedFinish: JsonField = JsonMissing.of() private var integrations: JsonField>? = null + private var metadata: JsonField = JsonMissing.of() private var method: JsonField = JsonMissing.of() private var additionalProperties: MutableMap = mutableMapOf() @@ -359,6 +405,7 @@ private constructor( validationFile = fineTuningJob.validationFile estimatedFinish = fineTuningJob.estimatedFinish integrations = fineTuningJob.integrations.map { it.toMutableList() } + metadata = fineTuningJob.metadata method = fineTuningJob.method additionalProperties = fineTuningJob.additionalProperties.toMutableMap() } @@ -637,6 +684,36 @@ private constructor( fun addWandbIntegration(wandb: FineTuningJobWandbIntegration) = addIntegration(FineTuningJobWandbIntegrationObject.builder().wandb(wandb).build()) + /** + * Set of 16 key-value pairs that can be attached to an object. This can be useful for + * storing additional information about the object in a structured format, and querying for + * objects via API or the dashboard. + * + * Keys are strings with a maximum length of 64 characters. Values are strings with a + * maximum length of 512 characters. + */ + fun metadata(metadata: Metadata?) = metadata(JsonField.ofNullable(metadata)) + + /** + * Set of 16 key-value pairs that can be attached to an object. This can be useful for + * storing additional information about the object in a structured format, and querying for + * objects via API or the dashboard. + * + * Keys are strings with a maximum length of 64 characters. Values are strings with a + * maximum length of 512 characters. + */ + fun metadata(metadata: Optional) = metadata(metadata.orElse(null)) + + /** + * Set of 16 key-value pairs that can be attached to an object. This can be useful for + * storing additional information about the object in a structured format, and querying for + * objects via API or the dashboard. + * + * Keys are strings with a maximum length of 64 characters. Values are strings with a + * maximum length of 512 characters. + */ + fun metadata(metadata: JsonField) = apply { this.metadata = metadata } + /** The method used for fine-tuning. */ fun method(method: Method) = method(JsonField.of(method)) @@ -681,6 +758,7 @@ private constructor( checkRequired("validationFile", validationFile), estimatedFinish, (integrations ?: JsonMissing.of()).map { it.toImmutable() }, + metadata, method, additionalProperties.toImmutable(), ) @@ -752,6 +830,16 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [Error]. + * + * The following fields are required: + * ```java + * .code() + * .message() + * .param() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -931,6 +1019,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [Hyperparameters]. */ @JvmStatic fun builder() = Builder() } @@ -1714,6 +1803,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [Method]. */ @JvmStatic fun builder() = Builder() } @@ -1815,6 +1905,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [Dpo]. */ @JvmStatic fun builder() = Builder() } @@ -1968,6 +2059,9 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [Hyperparameters]. + */ @JvmStatic fun builder() = Builder() } @@ -2819,6 +2913,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [Supervised]. */ @JvmStatic fun builder() = Builder() } @@ -2957,6 +3052,9 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [Hyperparameters]. + */ @JvmStatic fun builder() = Builder() } @@ -3713,15 +3811,15 @@ private constructor( return true } - return /* spotless:off */ other is FineTuningJob && id == other.id && createdAt == other.createdAt && error == other.error && fineTunedModel == other.fineTunedModel && finishedAt == other.finishedAt && hyperparameters == other.hyperparameters && model == other.model && object_ == other.object_ && organizationId == other.organizationId && resultFiles == other.resultFiles && seed == other.seed && status == other.status && trainedTokens == other.trainedTokens && trainingFile == other.trainingFile && validationFile == other.validationFile && estimatedFinish == other.estimatedFinish && integrations == other.integrations && method == other.method && additionalProperties == other.additionalProperties /* spotless:on */ + return /* spotless:off */ other is FineTuningJob && id == other.id && createdAt == other.createdAt && error == other.error && fineTunedModel == other.fineTunedModel && finishedAt == other.finishedAt && hyperparameters == other.hyperparameters && model == other.model && object_ == other.object_ && organizationId == other.organizationId && resultFiles == other.resultFiles && seed == other.seed && status == other.status && trainedTokens == other.trainedTokens && trainingFile == other.trainingFile && validationFile == other.validationFile && estimatedFinish == other.estimatedFinish && integrations == other.integrations && metadata == other.metadata && method == other.method && additionalProperties == other.additionalProperties /* spotless:on */ } /* spotless:off */ - private val hashCode: Int by lazy { Objects.hash(id, createdAt, error, fineTunedModel, finishedAt, hyperparameters, model, object_, organizationId, resultFiles, seed, status, trainedTokens, trainingFile, validationFile, estimatedFinish, integrations, method, additionalProperties) } + private val hashCode: Int by lazy { Objects.hash(id, createdAt, error, fineTunedModel, finishedAt, hyperparameters, model, object_, organizationId, resultFiles, seed, status, trainedTokens, trainingFile, validationFile, estimatedFinish, integrations, metadata, method, additionalProperties) } /* spotless:on */ override fun hashCode(): Int = hashCode override fun toString() = - "FineTuningJob{id=$id, createdAt=$createdAt, error=$error, fineTunedModel=$fineTunedModel, finishedAt=$finishedAt, hyperparameters=$hyperparameters, model=$model, object_=$object_, organizationId=$organizationId, resultFiles=$resultFiles, seed=$seed, status=$status, trainedTokens=$trainedTokens, trainingFile=$trainingFile, validationFile=$validationFile, estimatedFinish=$estimatedFinish, integrations=$integrations, method=$method, additionalProperties=$additionalProperties}" + "FineTuningJob{id=$id, createdAt=$createdAt, error=$error, fineTunedModel=$fineTunedModel, finishedAt=$finishedAt, hyperparameters=$hyperparameters, model=$model, object_=$object_, organizationId=$organizationId, resultFiles=$resultFiles, seed=$seed, status=$status, trainedTokens=$trainedTokens, trainingFile=$trainingFile, validationFile=$validationFile, estimatedFinish=$estimatedFinish, integrations=$integrations, metadata=$metadata, method=$method, additionalProperties=$additionalProperties}" } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJobCancelParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJobCancelParams.kt index 06a883235..89f939c95 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJobCancelParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJobCancelParams.kt @@ -48,6 +48,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [FineTuningJobCancelParams]. + * + * The following fields are required: + * ```java + * .fineTuningJobId() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJobCheckpoint.kt b/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJobCheckpoint.kt index dad53ec5c..f780853f5 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJobCheckpoint.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJobCheckpoint.kt @@ -119,6 +119,19 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [FineTuningJobCheckpoint]. + * + * The following fields are required: + * ```java + * .id() + * .createdAt() + * .fineTunedModelCheckpoint() + * .fineTuningJobId() + * .metrics() + * .stepNumber() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -320,6 +333,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [Metrics]. */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJobCheckpointListPage.kt b/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJobCheckpointListPage.kt index 98526f03b..6125ad23f 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJobCheckpointListPage.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJobCheckpointListPage.kt @@ -133,6 +133,10 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of + * [FineTuningJobCheckpointListPage]. + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJobCheckpointListPageAsync.kt b/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJobCheckpointListPageAsync.kt index c39fcb5e8..6f897e7aa 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJobCheckpointListPageAsync.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJobCheckpointListPageAsync.kt @@ -136,6 +136,10 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of + * [FineTuningJobCheckpointListPageAsync]. + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJobCheckpointListParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJobCheckpointListParams.kt index b18e8a92d..44eedf69e 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJobCheckpointListParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJobCheckpointListParams.kt @@ -53,6 +53,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of + * [FineTuningJobCheckpointListParams]. + * + * The following fields are required: + * ```java + * .fineTuningJobId() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJobCreateParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJobCreateParams.kt index 7588bc366..d24a72cd0 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJobCreateParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJobCreateParams.kt @@ -85,6 +85,16 @@ private constructor( /** A list of integrations to enable for your fine-tuning job. */ fun integrations(): Optional> = body.integrations() + /** + * Set of 16 key-value pairs that can be attached to an object. This can be useful for storing + * additional information about the object in a structured format, and querying for objects via + * API or the dashboard. + * + * Keys are strings with a maximum length of 64 characters. Values are strings with a maximum + * length of 512 characters. + */ + fun metadata(): Optional = body.metadata() + /** The method used for fine-tuning. */ fun method(): Optional = body.method() @@ -155,6 +165,16 @@ private constructor( /** A list of integrations to enable for your fine-tuning job. */ fun _integrations(): JsonField> = body._integrations() + /** + * Set of 16 key-value pairs that can be attached to an object. This can be useful for storing + * additional information about the object in a structured format, and querying for objects via + * API or the dashboard. + * + * Keys are strings with a maximum length of 64 characters. Values are strings with a maximum + * length of 512 characters. + */ + fun _metadata(): JsonField = body._metadata() + /** The method used for fine-tuning. */ fun _method(): JsonField = body._method() @@ -216,6 +236,9 @@ private constructor( @JsonProperty("integrations") @ExcludeMissing private val integrations: JsonField> = JsonMissing.of(), + @JsonProperty("metadata") + @ExcludeMissing + private val metadata: JsonField = JsonMissing.of(), @JsonProperty("method") @ExcludeMissing private val method: JsonField = JsonMissing.of(), @@ -269,6 +292,16 @@ private constructor( fun integrations(): Optional> = Optional.ofNullable(integrations.getNullable("integrations")) + /** + * Set of 16 key-value pairs that can be attached to an object. This can be useful for + * storing additional information about the object in a structured format, and querying for + * objects via API or the dashboard. + * + * Keys are strings with a maximum length of 64 characters. Values are strings with a + * maximum length of 512 characters. + */ + fun metadata(): Optional = Optional.ofNullable(metadata.getNullable("metadata")) + /** The method used for fine-tuning. */ fun method(): Optional = Optional.ofNullable(method.getNullable("method")) @@ -346,6 +379,16 @@ private constructor( @ExcludeMissing fun _integrations(): JsonField> = integrations + /** + * Set of 16 key-value pairs that can be attached to an object. This can be useful for + * storing additional information about the object in a structured format, and querying for + * objects via API or the dashboard. + * + * Keys are strings with a maximum length of 64 characters. Values are strings with a + * maximum length of 512 characters. + */ + @JsonProperty("metadata") @ExcludeMissing fun _metadata(): JsonField = metadata + /** The method used for fine-tuning. */ @JsonProperty("method") @ExcludeMissing fun _method(): JsonField = method @@ -396,6 +439,7 @@ private constructor( trainingFile() hyperparameters().ifPresent { it.validate() } integrations().ifPresent { it.forEach { it.validate() } } + metadata().ifPresent { it.validate() } method().ifPresent { it.validate() } seed() suffix() @@ -407,6 +451,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [Body]. + * + * The following fields are required: + * ```java + * .model() + * .trainingFile() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -417,6 +470,7 @@ private constructor( private var trainingFile: JsonField? = null private var hyperparameters: JsonField = JsonMissing.of() private var integrations: JsonField>? = null + private var metadata: JsonField = JsonMissing.of() private var method: JsonField = JsonMissing.of() private var seed: JsonField = JsonMissing.of() private var suffix: JsonField = JsonMissing.of() @@ -429,6 +483,7 @@ private constructor( trainingFile = body.trainingFile hyperparameters = body.hyperparameters integrations = body.integrations.map { it.toMutableList() } + metadata = body.metadata method = body.method seed = body.seed suffix = body.suffix @@ -536,6 +591,36 @@ private constructor( } } + /** + * Set of 16 key-value pairs that can be attached to an object. This can be useful for + * storing additional information about the object in a structured format, and querying + * for objects via API or the dashboard. + * + * Keys are strings with a maximum length of 64 characters. Values are strings with a + * maximum length of 512 characters. + */ + fun metadata(metadata: Metadata?) = metadata(JsonField.ofNullable(metadata)) + + /** + * Set of 16 key-value pairs that can be attached to an object. This can be useful for + * storing additional information about the object in a structured format, and querying + * for objects via API or the dashboard. + * + * Keys are strings with a maximum length of 64 characters. Values are strings with a + * maximum length of 512 characters. + */ + fun metadata(metadata: Optional) = metadata(metadata.orElse(null)) + + /** + * Set of 16 key-value pairs that can be attached to an object. This can be useful for + * storing additional information about the object in a structured format, and querying + * for objects via API or the dashboard. + * + * Keys are strings with a maximum length of 64 characters. Values are strings with a + * maximum length of 512 characters. + */ + fun metadata(metadata: JsonField) = apply { this.metadata = metadata } + /** The method used for fine-tuning. */ fun method(method: Method) = method(JsonField.of(method)) @@ -669,6 +754,7 @@ private constructor( checkRequired("trainingFile", trainingFile), hyperparameters, (integrations ?: JsonMissing.of()).map { it.toImmutable() }, + metadata, method, seed, suffix, @@ -682,23 +768,32 @@ private constructor( return true } - return /* spotless:off */ other is Body && model == other.model && trainingFile == other.trainingFile && hyperparameters == other.hyperparameters && integrations == other.integrations && method == other.method && seed == other.seed && suffix == other.suffix && validationFile == other.validationFile && additionalProperties == other.additionalProperties /* spotless:on */ + return /* spotless:off */ other is Body && model == other.model && trainingFile == other.trainingFile && hyperparameters == other.hyperparameters && integrations == other.integrations && metadata == other.metadata && method == other.method && seed == other.seed && suffix == other.suffix && validationFile == other.validationFile && additionalProperties == other.additionalProperties /* spotless:on */ } /* spotless:off */ - private val hashCode: Int by lazy { Objects.hash(model, trainingFile, hyperparameters, integrations, method, seed, suffix, validationFile, additionalProperties) } + private val hashCode: Int by lazy { Objects.hash(model, trainingFile, hyperparameters, integrations, metadata, method, seed, suffix, validationFile, additionalProperties) } /* spotless:on */ override fun hashCode(): Int = hashCode override fun toString() = - "Body{model=$model, trainingFile=$trainingFile, hyperparameters=$hyperparameters, integrations=$integrations, method=$method, seed=$seed, suffix=$suffix, validationFile=$validationFile, additionalProperties=$additionalProperties}" + "Body{model=$model, trainingFile=$trainingFile, hyperparameters=$hyperparameters, integrations=$integrations, metadata=$metadata, method=$method, seed=$seed, suffix=$suffix, validationFile=$validationFile, additionalProperties=$additionalProperties}" } fun toBuilder() = Builder().from(this) companion object { + /** + * Returns a mutable builder for constructing an instance of [FineTuningJobCreateParams]. + * + * The following fields are required: + * ```java + * .model() + * .trainingFile() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -814,6 +909,36 @@ private constructor( /** A list of integrations to enable for your fine-tuning job. */ fun addIntegration(integration: Integration) = apply { body.addIntegration(integration) } + /** + * Set of 16 key-value pairs that can be attached to an object. This can be useful for + * storing additional information about the object in a structured format, and querying for + * objects via API or the dashboard. + * + * Keys are strings with a maximum length of 64 characters. Values are strings with a + * maximum length of 512 characters. + */ + fun metadata(metadata: Metadata?) = apply { body.metadata(metadata) } + + /** + * Set of 16 key-value pairs that can be attached to an object. This can be useful for + * storing additional information about the object in a structured format, and querying for + * objects via API or the dashboard. + * + * Keys are strings with a maximum length of 64 characters. Values are strings with a + * maximum length of 512 characters. + */ + fun metadata(metadata: Optional) = metadata(metadata.orElse(null)) + + /** + * Set of 16 key-value pairs that can be attached to an object. This can be useful for + * storing additional information about the object in a structured format, and querying for + * objects via API or the dashboard. + * + * Keys are strings with a maximum length of 64 characters. Values are strings with a + * maximum length of 512 characters. + */ + fun metadata(metadata: JsonField) = apply { body.metadata(metadata) } + /** The method used for fine-tuning. */ fun method(method: Method) = apply { body.method(method) } @@ -1245,6 +1370,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [Hyperparameters]. */ @JvmStatic fun builder() = Builder() } @@ -1904,6 +2030,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [Integration]. + * + * The following fields are required: + * ```java + * .wandb() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -2058,6 +2192,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [Wandb]. + * + * The following fields are required: + * ```java + * .project() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -2276,6 +2418,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [Method]. */ @JvmStatic fun builder() = Builder() } @@ -2377,6 +2520,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [Dpo]. */ @JvmStatic fun builder() = Builder() } @@ -2530,6 +2674,9 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [Hyperparameters]. + */ @JvmStatic fun builder() = Builder() } @@ -3381,6 +3528,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [Supervised]. */ @JvmStatic fun builder() = Builder() } @@ -3519,6 +3667,9 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [Hyperparameters]. + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJobEvent.kt b/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJobEvent.kt index f3c804a1a..fd2e1c974 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJobEvent.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJobEvent.kt @@ -102,6 +102,17 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [FineTuningJobEvent]. + * + * The following fields are required: + * ```java + * .id() + * .createdAt() + * .level() + * .message() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJobListEventsPage.kt b/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJobListEventsPage.kt index 0f96f648c..e7278879c 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJobListEventsPage.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJobListEventsPage.kt @@ -127,6 +127,10 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of + * [FineTuningJobListEventsPage]. + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJobListEventsPageAsync.kt b/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJobListEventsPageAsync.kt index 0e638b51e..a71c9b1f1 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJobListEventsPageAsync.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJobListEventsPageAsync.kt @@ -133,6 +133,10 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of + * [FineTuningJobListEventsPageAsync]. + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJobListEventsParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJobListEventsParams.kt index c97349b6a..1c7f789b8 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJobListEventsParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJobListEventsParams.kt @@ -53,6 +53,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of + * [FineTuningJobListEventsParams]. + * + * The following fields are required: + * ```java + * .fineTuningJobId() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJobListPage.kt b/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJobListPage.kt index 6b603cb40..d59dd386b 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJobListPage.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJobListPage.kt @@ -126,6 +126,9 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [FineTuningJobListPage]. + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJobListPageAsync.kt b/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJobListPageAsync.kt index 22432b881..c449d738c 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJobListPageAsync.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJobListPageAsync.kt @@ -129,6 +129,10 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of + * [FineTuningJobListPageAsync]. + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJobListParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJobListParams.kt index 14fa8e2aa..9f759fbe8 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJobListParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJobListParams.kt @@ -14,6 +14,7 @@ class FineTuningJobListParams private constructor( private val after: String?, private val limit: Long?, + private val metadata: Metadata?, private val additionalHeaders: Headers, private val additionalQueryParams: QueryParams, ) : Params { @@ -24,6 +25,12 @@ private constructor( /** Number of fine-tuning jobs to retrieve. */ fun limit(): Optional = Optional.ofNullable(limit) + /** + * Optional metadata filter. To filter, use the syntax `metadata[k]=v`. Alternatively, set + * `metadata=null` to indicate no metadata. + */ + fun metadata(): Optional = Optional.ofNullable(metadata) + fun _additionalHeaders(): Headers = additionalHeaders fun _additionalQueryParams(): QueryParams = additionalQueryParams @@ -34,6 +41,9 @@ private constructor( val queryParams = QueryParams.builder() this.after?.let { queryParams.put("after", listOf(it.toString())) } this.limit?.let { queryParams.put("limit", listOf(it.toString())) } + this.metadata?.forEachQueryParam { key, values -> + queryParams.put("metadata[$key]", values) + } queryParams.putAll(additionalQueryParams) return queryParams.build() } @@ -44,6 +54,7 @@ private constructor( @JvmStatic fun none(): FineTuningJobListParams = builder().build() + /** Returns a mutable builder for constructing an instance of [FineTuningJobListParams]. */ @JvmStatic fun builder() = Builder() } @@ -53,6 +64,7 @@ private constructor( private var after: String? = null private var limit: Long? = null + private var metadata: Metadata? = null private var additionalHeaders: Headers.Builder = Headers.builder() private var additionalQueryParams: QueryParams.Builder = QueryParams.builder() @@ -60,6 +72,7 @@ private constructor( internal fun from(fineTuningJobListParams: FineTuningJobListParams) = apply { after = fineTuningJobListParams.after limit = fineTuningJobListParams.limit + metadata = fineTuningJobListParams.metadata additionalHeaders = fineTuningJobListParams.additionalHeaders.toBuilder() additionalQueryParams = fineTuningJobListParams.additionalQueryParams.toBuilder() } @@ -80,6 +93,18 @@ private constructor( @Suppress("USELESS_CAST") // See https://youtrack.jetbrains.com/issue/KT-74228 fun limit(limit: Optional) = limit(limit.orElse(null) as Long?) + /** + * Optional metadata filter. To filter, use the syntax `metadata[k]=v`. Alternatively, set + * `metadata=null` to indicate no metadata. + */ + fun metadata(metadata: Metadata?) = apply { this.metadata = metadata } + + /** + * Optional metadata filter. To filter, use the syntax `metadata[k]=v`. Alternatively, set + * `metadata=null` to indicate no metadata. + */ + fun metadata(metadata: Optional) = metadata(metadata.orElse(null)) + fun additionalHeaders(additionalHeaders: Headers) = apply { this.additionalHeaders.clear() putAllAdditionalHeaders(additionalHeaders) @@ -182,21 +207,122 @@ private constructor( FineTuningJobListParams( after, limit, + metadata, additionalHeaders.build(), additionalQueryParams.build(), ) } + /** + * Optional metadata filter. To filter, use the syntax `metadata[k]=v`. Alternatively, set + * `metadata=null` to indicate no metadata. + */ + class Metadata private constructor(private val additionalProperties: QueryParams) { + + fun _additionalProperties(): QueryParams = additionalProperties + + @JvmSynthetic + internal fun forEachQueryParam(putParam: (String, List) -> Unit) { + additionalProperties.keys().forEach { putParam(it, additionalProperties.values(it)) } + } + + fun toBuilder() = Builder().from(this) + + companion object { + + /** Returns a mutable builder for constructing an instance of [Metadata]. */ + @JvmStatic fun builder() = Builder() + } + + /** A builder for [Metadata]. */ + class Builder internal constructor() { + + private var additionalProperties: QueryParams.Builder = QueryParams.builder() + + @JvmSynthetic + internal fun from(metadata: Metadata) = apply { + additionalProperties = metadata.additionalProperties.toBuilder() + } + + fun additionalProperties(additionalProperties: QueryParams) = apply { + this.additionalProperties.clear() + putAllAdditionalProperties(additionalProperties) + } + + fun additionalProperties(additionalProperties: Map>) = apply { + this.additionalProperties.clear() + putAllAdditionalProperties(additionalProperties) + } + + fun putAdditionalProperty(key: String, value: String) = apply { + additionalProperties.put(key, value) + } + + fun putAdditionalProperties(key: String, values: Iterable) = apply { + additionalProperties.put(key, values) + } + + fun putAllAdditionalProperties(additionalProperties: QueryParams) = apply { + this.additionalProperties.putAll(additionalProperties) + } + + fun putAllAdditionalProperties(additionalProperties: Map>) = + apply { + this.additionalProperties.putAll(additionalProperties) + } + + fun replaceAdditionalProperties(key: String, value: String) = apply { + additionalProperties.replace(key, value) + } + + fun replaceAdditionalProperties(key: String, values: Iterable) = apply { + additionalProperties.replace(key, values) + } + + fun replaceAllAdditionalProperties(additionalProperties: QueryParams) = apply { + this.additionalProperties.replaceAll(additionalProperties) + } + + fun replaceAllAdditionalProperties( + additionalProperties: Map> + ) = apply { this.additionalProperties.replaceAll(additionalProperties) } + + fun removeAdditionalProperties(key: String) = apply { additionalProperties.remove(key) } + + fun removeAllAdditionalProperties(keys: Set) = apply { + additionalProperties.removeAll(keys) + } + + fun build(): Metadata = Metadata(additionalProperties.build()) + } + + override fun equals(other: Any?): Boolean { + if (this === other) { + return true + } + + return /* spotless:off */ other is Metadata && additionalProperties == other.additionalProperties /* spotless:on */ + } + + /* spotless:off */ + private val hashCode: Int by lazy { Objects.hash(additionalProperties) } + /* spotless:on */ + + override fun hashCode(): Int = hashCode + + override fun toString() = "Metadata{additionalProperties=$additionalProperties}" + } + override fun equals(other: Any?): Boolean { if (this === other) { return true } - return /* spotless:off */ other is FineTuningJobListParams && after == other.after && limit == other.limit && additionalHeaders == other.additionalHeaders && additionalQueryParams == other.additionalQueryParams /* spotless:on */ + return /* spotless:off */ other is FineTuningJobListParams && after == other.after && limit == other.limit && metadata == other.metadata && additionalHeaders == other.additionalHeaders && additionalQueryParams == other.additionalQueryParams /* spotless:on */ } - override fun hashCode(): Int = /* spotless:off */ Objects.hash(after, limit, additionalHeaders, additionalQueryParams) /* spotless:on */ + override fun hashCode(): Int = /* spotless:off */ Objects.hash(after, limit, metadata, additionalHeaders, additionalQueryParams) /* spotless:on */ override fun toString() = - "FineTuningJobListParams{after=$after, limit=$limit, additionalHeaders=$additionalHeaders, additionalQueryParams=$additionalQueryParams}" + "FineTuningJobListParams{after=$after, limit=$limit, metadata=$metadata, additionalHeaders=$additionalHeaders, additionalQueryParams=$additionalQueryParams}" } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJobRetrieveParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJobRetrieveParams.kt index d8e5516c7..9afca4290 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJobRetrieveParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJobRetrieveParams.kt @@ -42,6 +42,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [FineTuningJobRetrieveParams]. + * + * The following fields are required: + * ```java + * .fineTuningJobId() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJobWandbIntegration.kt b/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJobWandbIntegration.kt index 2bcfa5a8b..fb275e1e2 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJobWandbIntegration.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJobWandbIntegration.kt @@ -102,6 +102,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of + * [FineTuningJobWandbIntegration]. + * + * The following fields are required: + * ```java + * .project() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJobWandbIntegrationObject.kt b/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJobWandbIntegrationObject.kt index 97ca05ee5..109fb2dd4 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJobWandbIntegrationObject.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJobWandbIntegrationObject.kt @@ -73,6 +73,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of + * [FineTuningJobWandbIntegrationObject]. + * + * The following fields are required: + * ```java + * .wandb() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/FunctionDefinition.kt b/openai-java-core/src/main/kotlin/com/openai/models/FunctionDefinition.kt index e29d0beac..0e0179323 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/FunctionDefinition.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/FunctionDefinition.kt @@ -120,6 +120,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [FunctionDefinition]. + * + * The following fields are required: + * ```java + * .name() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/FunctionParameters.kt b/openai-java-core/src/main/kotlin/com/openai/models/FunctionParameters.kt index ed2423ae1..7950dc12d 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/FunctionParameters.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/FunctionParameters.kt @@ -45,6 +45,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [FunctionParameters]. */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/FunctionTool.kt b/openai-java-core/src/main/kotlin/com/openai/models/FunctionTool.kt index 1d1e70211..f67ddd1ab 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/FunctionTool.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/FunctionTool.kt @@ -61,6 +61,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [FunctionTool]. + * + * The following fields are required: + * ```java + * .function() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/FunctionToolCall.kt b/openai-java-core/src/main/kotlin/com/openai/models/FunctionToolCall.kt index 9e0a31d77..76d067a7b 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/FunctionToolCall.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/FunctionToolCall.kt @@ -70,6 +70,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [FunctionToolCall]. + * + * The following fields are required: + * ```java + * .id() + * .function() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -197,6 +206,16 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [Function]. + * + * The following fields are required: + * ```java + * .arguments() + * .name() + * .output() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/FunctionToolCallDelta.kt b/openai-java-core/src/main/kotlin/com/openai/models/FunctionToolCallDelta.kt index f0f0cdf50..803b4057f 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/FunctionToolCallDelta.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/FunctionToolCallDelta.kt @@ -78,6 +78,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [FunctionToolCallDelta]. + * + * The following fields are required: + * ```java + * .index() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -214,6 +222,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [Function]. */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/Image.kt b/openai-java-core/src/main/kotlin/com/openai/models/Image.kt index 8cc584031..765d4abc6 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/Image.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/Image.kt @@ -73,6 +73,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [Image]. */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/ImageCreateVariationParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/ImageCreateVariationParams.kt index d848d9dc7..74cca295f 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/ImageCreateVariationParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/ImageCreateVariationParams.kt @@ -205,6 +205,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [Body]. + * + * The following fields are required: + * ```java + * .image() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -357,6 +365,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ImageCreateVariationParams]. + * + * The following fields are required: + * ```java + * .image() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/ImageEditParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/ImageEditParams.kt index 1fb4a52aa..f79a0e090 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/ImageEditParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/ImageEditParams.kt @@ -239,6 +239,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [Body]. + * + * The following fields are required: + * ```java + * .image() + * .prompt() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -416,6 +425,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ImageEditParams]. + * + * The following fields are required: + * ```java + * .image() + * .prompt() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/ImageFile.kt b/openai-java-core/src/main/kotlin/com/openai/models/ImageFile.kt index 72e097435..15dbf4270 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/ImageFile.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/ImageFile.kt @@ -78,6 +78,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ImageFile]. + * + * The following fields are required: + * ```java + * .fileId() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/ImageFileContentBlock.kt b/openai-java-core/src/main/kotlin/com/openai/models/ImageFileContentBlock.kt index ed29ab7f8..ad3019e13 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/ImageFileContentBlock.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/ImageFileContentBlock.kt @@ -63,6 +63,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ImageFileContentBlock]. + * + * The following fields are required: + * ```java + * .imageFile() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/ImageFileDelta.kt b/openai-java-core/src/main/kotlin/com/openai/models/ImageFileDelta.kt index ac8bde14b..2ffc945a1 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/ImageFileDelta.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/ImageFileDelta.kt @@ -77,6 +77,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [ImageFileDelta]. */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/ImageFileDeltaBlock.kt b/openai-java-core/src/main/kotlin/com/openai/models/ImageFileDeltaBlock.kt index e4d6cf917..5509d3afd 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/ImageFileDeltaBlock.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/ImageFileDeltaBlock.kt @@ -75,6 +75,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ImageFileDeltaBlock]. + * + * The following fields are required: + * ```java + * .index() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/ImageGenerateParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/ImageGenerateParams.kt index c5e00640d..487b39d21 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/ImageGenerateParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/ImageGenerateParams.kt @@ -293,6 +293,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [Body]. + * + * The following fields are required: + * ```java + * .prompt() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -521,6 +529,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ImageGenerateParams]. + * + * The following fields are required: + * ```java + * .prompt() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/ImageUrl.kt b/openai-java-core/src/main/kotlin/com/openai/models/ImageUrl.kt index 3f695a55d..9f6f2c943 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/ImageUrl.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/ImageUrl.kt @@ -72,6 +72,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ImageUrl]. + * + * The following fields are required: + * ```java + * .url() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/ImageUrlContentBlock.kt b/openai-java-core/src/main/kotlin/com/openai/models/ImageUrlContentBlock.kt index 433703799..60694055a 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/ImageUrlContentBlock.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/ImageUrlContentBlock.kt @@ -60,6 +60,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ImageUrlContentBlock]. + * + * The following fields are required: + * ```java + * .imageUrl() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/ImageUrlDelta.kt b/openai-java-core/src/main/kotlin/com/openai/models/ImageUrlDelta.kt index 1e5beadc4..e459400d4 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/ImageUrlDelta.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/ImageUrlDelta.kt @@ -67,6 +67,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [ImageUrlDelta]. */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/ImageUrlDeltaBlock.kt b/openai-java-core/src/main/kotlin/com/openai/models/ImageUrlDeltaBlock.kt index 2af663459..9af4655ae 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/ImageUrlDeltaBlock.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/ImageUrlDeltaBlock.kt @@ -69,6 +69,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ImageUrlDeltaBlock]. + * + * The following fields are required: + * ```java + * .index() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/ImagesResponse.kt b/openai-java-core/src/main/kotlin/com/openai/models/ImagesResponse.kt index b2157ce27..5fd5e7abc 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/ImagesResponse.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/ImagesResponse.kt @@ -58,6 +58,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ImagesResponse]. + * + * The following fields are required: + * ```java + * .created() + * .data() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/Message.kt b/openai-java-core/src/main/kotlin/com/openai/models/Message.kt index e8073562d..e5a4fdde9 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/Message.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/Message.kt @@ -245,6 +245,26 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [Message]. + * + * The following fields are required: + * ```java + * .id() + * .assistantId() + * .attachments() + * .completedAt() + * .content() + * .createdAt() + * .incompleteAt() + * .incompleteDetails() + * .metadata() + * .role() + * .runId() + * .status() + * .threadId() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -601,6 +621,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [Attachment]. */ @JvmStatic fun builder() = Builder() } @@ -902,6 +923,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [IncompleteDetails]. + * + * The following fields are required: + * ```java + * .reason() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/MessageCreationStepDetails.kt b/openai-java-core/src/main/kotlin/com/openai/models/MessageCreationStepDetails.kt index 6ba450535..3928317f2 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/MessageCreationStepDetails.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/MessageCreationStepDetails.kt @@ -62,6 +62,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [MessageCreationStepDetails]. + * + * The following fields are required: + * ```java + * .messageCreation() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -152,6 +160,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [MessageCreation]. + * + * The following fields are required: + * ```java + * .messageId() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/MessageDeleted.kt b/openai-java-core/src/main/kotlin/com/openai/models/MessageDeleted.kt index 8e91e1ce9..c4fbbc2ca 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/MessageDeleted.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/MessageDeleted.kt @@ -64,6 +64,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [MessageDeleted]. + * + * The following fields are required: + * ```java + * .id() + * .deleted() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/MessageDelta.kt b/openai-java-core/src/main/kotlin/com/openai/models/MessageDelta.kt index 9081f66eb..1177c114c 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/MessageDelta.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/MessageDelta.kt @@ -66,6 +66,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [MessageDelta]. */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/MessageDeltaEvent.kt b/openai-java-core/src/main/kotlin/com/openai/models/MessageDeltaEvent.kt index da0561711..d8ea720d4 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/MessageDeltaEvent.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/MessageDeltaEvent.kt @@ -70,6 +70,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [MessageDeltaEvent]. + * + * The following fields are required: + * ```java + * .id() + * .delta() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/MessageStreamEvent.kt b/openai-java-core/src/main/kotlin/com/openai/models/MessageStreamEvent.kt index 98a22256e..cd8490748 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/MessageStreamEvent.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/MessageStreamEvent.kt @@ -425,6 +425,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ThreadMessageCreated]. + * + * The following fields are required: + * ```java + * .data() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -555,6 +563,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ThreadMessageInProgress]. + * + * The following fields are required: + * ```java + * .data() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -679,6 +695,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ThreadMessageDelta]. + * + * The following fields are required: + * ```java + * .data() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -803,6 +827,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ThreadMessageCompleted]. + * + * The following fields are required: + * ```java + * .data() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -933,6 +965,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ThreadMessageIncomplete]. + * + * The following fields are required: + * ```java + * .data() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/Metadata.kt b/openai-java-core/src/main/kotlin/com/openai/models/Metadata.kt index 17e326d63..7da6c6074 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/Metadata.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/Metadata.kt @@ -45,6 +45,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [Metadata]. */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/Model.kt b/openai-java-core/src/main/kotlin/com/openai/models/Model.kt index 9ba4b949a..0da585fee 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/Model.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/Model.kt @@ -80,6 +80,16 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [Model]. + * + * The following fields are required: + * ```java + * .id() + * .created() + * .ownedBy() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/ModelDeleteParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/ModelDeleteParams.kt index d72931df1..e4bde785d 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/ModelDeleteParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/ModelDeleteParams.kt @@ -50,6 +50,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ModelDeleteParams]. + * + * The following fields are required: + * ```java + * .model() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/ModelDeleted.kt b/openai-java-core/src/main/kotlin/com/openai/models/ModelDeleted.kt index 272b9325f..d7296f92b 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/ModelDeleted.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/ModelDeleted.kt @@ -63,6 +63,16 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ModelDeleted]. + * + * The following fields are required: + * ```java + * .id() + * .deleted() + * .object_() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/ModelListPage.kt b/openai-java-core/src/main/kotlin/com/openai/models/ModelListPage.kt index 0cdb73e32..23b9a52cc 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/ModelListPage.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/ModelListPage.kt @@ -123,6 +123,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [ModelListPage]. */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/ModelListPageAsync.kt b/openai-java-core/src/main/kotlin/com/openai/models/ModelListPageAsync.kt index db42be93a..313cd514f 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/ModelListPageAsync.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/ModelListPageAsync.kt @@ -126,6 +126,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [ModelListPageAsync]. */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/ModelListParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/ModelListParams.kt index fda00a0ad..162dfd16c 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/ModelListParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/ModelListParams.kt @@ -32,6 +32,7 @@ private constructor( @JvmStatic fun none(): ModelListParams = builder().build() + /** Returns a mutable builder for constructing an instance of [ModelListParams]. */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/ModelRetrieveParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/ModelRetrieveParams.kt index bce4f926e..cf0168628 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/ModelRetrieveParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/ModelRetrieveParams.kt @@ -41,6 +41,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ModelRetrieveParams]. + * + * The following fields are required: + * ```java + * .model() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/Moderation.kt b/openai-java-core/src/main/kotlin/com/openai/models/Moderation.kt index 223d4f8ef..54170ed41 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/Moderation.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/Moderation.kt @@ -93,6 +93,17 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [Moderation]. + * + * The following fields are required: + * ```java + * .categories() + * .categoryAppliedInputTypes() + * .categoryScores() + * .flagged() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -405,6 +416,26 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [Categories]. + * + * The following fields are required: + * ```java + * .harassment() + * .harassmentThreatening() + * .hate() + * .hateThreatening() + * .illicit() + * .illicitViolent() + * .selfHarm() + * .selfHarmInstructions() + * .selfHarmIntent() + * .sexual() + * .sexualMinors() + * .violence() + * .violenceGraphic() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -875,6 +906,27 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of + * [CategoryAppliedInputTypes]. + * + * The following fields are required: + * ```java + * .harassment() + * .harassmentThreatening() + * .hate() + * .hateThreatening() + * .illicit() + * .illicitViolent() + * .selfHarm() + * .selfHarmInstructions() + * .selfHarmIntent() + * .sexual() + * .sexualMinors() + * .violence() + * .violenceGraphic() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -2683,6 +2735,26 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [CategoryScores]. + * + * The following fields are required: + * ```java + * .harassment() + * .harassmentThreatening() + * .hate() + * .hateThreatening() + * .illicit() + * .illicitViolent() + * .selfHarm() + * .selfHarmInstructions() + * .selfHarmIntent() + * .sexual() + * .sexualMinors() + * .violence() + * .violenceGraphic() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/ModerationCreateParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/ModerationCreateParams.kt index 9d4ac4c99..3cefb65ec 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/ModerationCreateParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/ModerationCreateParams.kt @@ -140,6 +140,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [Body]. + * + * The following fields are required: + * ```java + * .input() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -246,6 +254,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ModerationCreateParams]. + * + * The following fields are required: + * ```java + * .input() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/ModerationCreateResponse.kt b/openai-java-core/src/main/kotlin/com/openai/models/ModerationCreateResponse.kt index b8858cbbe..c3f07a42b 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/ModerationCreateResponse.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/ModerationCreateResponse.kt @@ -69,6 +69,16 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ModerationCreateResponse]. + * + * The following fields are required: + * ```java + * .id() + * .model() + * .results() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/ModerationImageUrlInput.kt b/openai-java-core/src/main/kotlin/com/openai/models/ModerationImageUrlInput.kt index 1d193c0d3..a36110f91 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/ModerationImageUrlInput.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/ModerationImageUrlInput.kt @@ -62,6 +62,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ModerationImageUrlInput]. + * + * The following fields are required: + * ```java + * .imageUrl() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -150,6 +158,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ImageUrl]. + * + * The following fields are required: + * ```java + * .url() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/ModerationTextInput.kt b/openai-java-core/src/main/kotlin/com/openai/models/ModerationTextInput.kt index 38065e6ad..c15a9361c 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/ModerationTextInput.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/ModerationTextInput.kt @@ -60,6 +60,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ModerationTextInput]. + * + * The following fields are required: + * ```java + * .text() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/OtherFileChunkingStrategyObject.kt b/openai-java-core/src/main/kotlin/com/openai/models/OtherFileChunkingStrategyObject.kt index ac7a4d1bc..2ba231702 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/OtherFileChunkingStrategyObject.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/OtherFileChunkingStrategyObject.kt @@ -53,6 +53,10 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of + * [OtherFileChunkingStrategyObject]. + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/RefusalContentBlock.kt b/openai-java-core/src/main/kotlin/com/openai/models/RefusalContentBlock.kt index 7201260b6..181ae4ab3 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/RefusalContentBlock.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/RefusalContentBlock.kt @@ -60,6 +60,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [RefusalContentBlock]. + * + * The following fields are required: + * ```java + * .refusal() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/RefusalDeltaBlock.kt b/openai-java-core/src/main/kotlin/com/openai/models/RefusalDeltaBlock.kt index ac7981f56..6ec7e3e50 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/RefusalDeltaBlock.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/RefusalDeltaBlock.kt @@ -69,6 +69,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [RefusalDeltaBlock]. + * + * The following fields are required: + * ```java + * .index() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/RequiredActionFunctionToolCall.kt b/openai-java-core/src/main/kotlin/com/openai/models/RequiredActionFunctionToolCall.kt index ce7e04d5d..62e600242 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/RequiredActionFunctionToolCall.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/RequiredActionFunctionToolCall.kt @@ -80,6 +80,16 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of + * [RequiredActionFunctionToolCall]. + * + * The following fields are required: + * ```java + * .id() + * .function() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -200,6 +210,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [Function]. + * + * The following fields are required: + * ```java + * .arguments() + * .name() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/ResponseFormatJsonObject.kt b/openai-java-core/src/main/kotlin/com/openai/models/ResponseFormatJsonObject.kt index d1cd02434..4ae7d086f 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/ResponseFormatJsonObject.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/ResponseFormatJsonObject.kt @@ -49,6 +49,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [ResponseFormatJsonObject]. */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/ResponseFormatJsonSchema.kt b/openai-java-core/src/main/kotlin/com/openai/models/ResponseFormatJsonSchema.kt index bc9353482..c02c908a4 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/ResponseFormatJsonSchema.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/ResponseFormatJsonSchema.kt @@ -62,6 +62,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ResponseFormatJsonSchema]. + * + * The following fields are required: + * ```java + * .jsonSchema() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -204,6 +212,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [JsonSchema]. + * + * The following fields are required: + * ```java + * .name() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -346,6 +362,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [Schema]. */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/ResponseFormatText.kt b/openai-java-core/src/main/kotlin/com/openai/models/ResponseFormatText.kt index e8299f53f..ae51ee1f7 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/ResponseFormatText.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/ResponseFormatText.kt @@ -49,6 +49,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [ResponseFormatText]. */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/Run.kt b/openai-java-core/src/main/kotlin/com/openai/models/Run.kt index 312d1ba97..1816eb349 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/Run.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/Run.kt @@ -474,6 +474,37 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [Run]. + * + * The following fields are required: + * ```java + * .id() + * .assistantId() + * .cancelledAt() + * .completedAt() + * .createdAt() + * .expiresAt() + * .failedAt() + * .incompleteDetails() + * .instructions() + * .lastError() + * .maxCompletionTokens() + * .maxPromptTokens() + * .metadata() + * .model() + * .parallelToolCalls() + * .requiredAction() + * .responseFormat() + * .startedAt() + * .status() + * .threadId() + * .toolChoice() + * .tools() + * .truncationStrategy() + * .usage() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -1240,6 +1271,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [IncompleteDetails]. */ @JvmStatic fun builder() = Builder() } @@ -1459,6 +1491,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [LastError]. + * + * The following fields are required: + * ```java + * .code() + * .message() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -1691,6 +1732,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [RequiredAction]. + * + * The following fields are required: + * ```java + * .submitToolOutputs() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -1788,6 +1837,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [SubmitToolOutputs]. + * + * The following fields are required: + * ```java + * .toolCalls() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -1953,6 +2010,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [TruncationStrategy]. + * + * The following fields are required: + * ```java + * .type() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -2231,6 +2296,16 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [Usage]. + * + * The following fields are required: + * ```java + * .completionTokens() + * .promptTokens() + * .totalTokens() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/RunStep.kt b/openai-java-core/src/main/kotlin/com/openai/models/RunStep.kt index 5acd9859e..c7b17f718 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/RunStep.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/RunStep.kt @@ -259,6 +259,28 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [RunStep]. + * + * The following fields are required: + * ```java + * .id() + * .assistantId() + * .cancelledAt() + * .completedAt() + * .createdAt() + * .expiredAt() + * .failedAt() + * .lastError() + * .metadata() + * .runId() + * .status() + * .stepDetails() + * .threadId() + * .type() + * .usage() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -610,6 +632,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [LastError]. + * + * The following fields are required: + * ```java + * .code() + * .message() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -1232,6 +1263,16 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [Usage]. + * + * The following fields are required: + * ```java + * .completionTokens() + * .promptTokens() + * .totalTokens() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/RunStepDelta.kt b/openai-java-core/src/main/kotlin/com/openai/models/RunStepDelta.kt index cecb05c5b..096423e71 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/RunStepDelta.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/RunStepDelta.kt @@ -67,6 +67,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [RunStepDelta]. */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/RunStepDeltaEvent.kt b/openai-java-core/src/main/kotlin/com/openai/models/RunStepDeltaEvent.kt index 862bffc24..0a5cf9e4e 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/RunStepDeltaEvent.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/RunStepDeltaEvent.kt @@ -70,6 +70,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [RunStepDeltaEvent]. + * + * The following fields are required: + * ```java + * .id() + * .delta() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/RunStepDeltaMessageDelta.kt b/openai-java-core/src/main/kotlin/com/openai/models/RunStepDeltaMessageDelta.kt index 613b30d0d..d9c9b947e 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/RunStepDeltaMessageDelta.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/RunStepDeltaMessageDelta.kt @@ -63,6 +63,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [RunStepDeltaMessageDelta]. */ @JvmStatic fun builder() = Builder() } @@ -149,6 +150,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [MessageCreation]. */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/RunStepStreamEvent.kt b/openai-java-core/src/main/kotlin/com/openai/models/RunStepStreamEvent.kt index 8bd9b8cd8..2188b48a3 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/RunStepStreamEvent.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/RunStepStreamEvent.kt @@ -525,6 +525,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ThreadRunStepCreated]. + * + * The following fields are required: + * ```java + * .data() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -644,6 +652,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ThreadRunStepInProgress]. + * + * The following fields are required: + * ```java + * .data() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -763,6 +779,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ThreadRunStepDelta]. + * + * The following fields are required: + * ```java + * .data() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -886,6 +910,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ThreadRunStepCompleted]. + * + * The following fields are required: + * ```java + * .data() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -1004,6 +1036,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ThreadRunStepFailed]. + * + * The following fields are required: + * ```java + * .data() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -1123,6 +1163,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ThreadRunStepCancelled]. + * + * The following fields are required: + * ```java + * .data() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -1241,6 +1289,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ThreadRunStepExpired]. + * + * The following fields are required: + * ```java + * .data() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/RunStreamEvent.kt b/openai-java-core/src/main/kotlin/com/openai/models/RunStreamEvent.kt index cfb6cd2de..f78a46680 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/RunStreamEvent.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/RunStreamEvent.kt @@ -601,6 +601,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ThreadRunCreated]. + * + * The following fields are required: + * ```java + * .data() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -729,6 +737,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ThreadRunQueued]. + * + * The following fields are required: + * ```java + * .data() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -857,6 +873,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ThreadRunInProgress]. + * + * The following fields are required: + * ```java + * .data() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -985,6 +1009,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ThreadRunRequiresAction]. + * + * The following fields are required: + * ```java + * .data() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -1112,6 +1144,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ThreadRunCompleted]. + * + * The following fields are required: + * ```java + * .data() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -1240,6 +1280,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ThreadRunIncomplete]. + * + * The following fields are required: + * ```java + * .data() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -1365,6 +1413,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ThreadRunFailed]. + * + * The following fields are required: + * ```java + * .data() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -1493,6 +1549,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ThreadRunCancelling]. + * + * The following fields are required: + * ```java + * .data() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -1620,6 +1684,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ThreadRunCancelled]. + * + * The following fields are required: + * ```java + * .data() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -1745,6 +1817,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ThreadRunExpired]. + * + * The following fields are required: + * ```java + * .data() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/StaticFileChunkingStrategy.kt b/openai-java-core/src/main/kotlin/com/openai/models/StaticFileChunkingStrategy.kt index ebd16f511..7c40c0a71 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/StaticFileChunkingStrategy.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/StaticFileChunkingStrategy.kt @@ -79,6 +79,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [StaticFileChunkingStrategy]. + * + * The following fields are required: + * ```java + * .chunkOverlapTokens() + * .maxChunkSizeTokens() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/StaticFileChunkingStrategyObject.kt b/openai-java-core/src/main/kotlin/com/openai/models/StaticFileChunkingStrategyObject.kt index 85c8107e4..f10b69b97 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/StaticFileChunkingStrategyObject.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/StaticFileChunkingStrategyObject.kt @@ -61,6 +61,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of + * [StaticFileChunkingStrategyObject]. + * + * The following fields are required: + * ```java + * .static_() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/StaticFileChunkingStrategyObjectParam.kt b/openai-java-core/src/main/kotlin/com/openai/models/StaticFileChunkingStrategyObjectParam.kt index e1fe6e81a..1abb53382 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/StaticFileChunkingStrategyObjectParam.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/StaticFileChunkingStrategyObjectParam.kt @@ -61,6 +61,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of + * [StaticFileChunkingStrategyObjectParam]. + * + * The following fields are required: + * ```java + * .static_() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/Text.kt b/openai-java-core/src/main/kotlin/com/openai/models/Text.kt index 27cdf243b..f4c8b03a3 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/Text.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/Text.kt @@ -60,6 +60,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [Text]. + * + * The following fields are required: + * ```java + * .annotations() + * .value() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/TextContentBlock.kt b/openai-java-core/src/main/kotlin/com/openai/models/TextContentBlock.kt index e106505bf..697fcea86 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/TextContentBlock.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/TextContentBlock.kt @@ -58,6 +58,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [TextContentBlock]. + * + * The following fields are required: + * ```java + * .text() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/TextContentBlockParam.kt b/openai-java-core/src/main/kotlin/com/openai/models/TextContentBlockParam.kt index 5b96ec999..93fa10611 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/TextContentBlockParam.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/TextContentBlockParam.kt @@ -60,6 +60,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [TextContentBlockParam]. + * + * The following fields are required: + * ```java + * .text() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/TextDelta.kt b/openai-java-core/src/main/kotlin/com/openai/models/TextDelta.kt index c75e569be..4c1ab36c0 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/TextDelta.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/TextDelta.kt @@ -61,6 +61,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [TextDelta]. */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/TextDeltaBlock.kt b/openai-java-core/src/main/kotlin/com/openai/models/TextDeltaBlock.kt index 645a3dc0f..c14832986 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/TextDeltaBlock.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/TextDeltaBlock.kt @@ -67,6 +67,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [TextDeltaBlock]. + * + * The following fields are required: + * ```java + * .index() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/Thread.kt b/openai-java-core/src/main/kotlin/com/openai/models/Thread.kt index e23d0ad26..6eb4700bb 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/Thread.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/Thread.kt @@ -120,6 +120,17 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [Thread]. + * + * The following fields are required: + * ```java + * .id() + * .createdAt() + * .metadata() + * .toolResources() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -299,6 +310,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [ToolResources]. */ @JvmStatic fun builder() = Builder() } @@ -399,6 +411,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [CodeInterpreter]. */ @JvmStatic fun builder() = Builder() } @@ -538,6 +551,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [FileSearch]. */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/ThreadDeleted.kt b/openai-java-core/src/main/kotlin/com/openai/models/ThreadDeleted.kt index 0398f91bb..0fe200463 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/ThreadDeleted.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/ThreadDeleted.kt @@ -64,6 +64,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ThreadDeleted]. + * + * The following fields are required: + * ```java + * .id() + * .deleted() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/ThreadStreamEvent.kt b/openai-java-core/src/main/kotlin/com/openai/models/ThreadStreamEvent.kt index 7df2772d2..ac316128d 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/ThreadStreamEvent.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/ThreadStreamEvent.kt @@ -79,6 +79,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ThreadStreamEvent]. + * + * The following fields are required: + * ```java + * .data() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/ToolCallDeltaObject.kt b/openai-java-core/src/main/kotlin/com/openai/models/ToolCallDeltaObject.kt index c0e57625c..964de0706 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/ToolCallDeltaObject.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/ToolCallDeltaObject.kt @@ -72,6 +72,7 @@ private constructor( companion object { + /** Returns a mutable builder for constructing an instance of [ToolCallDeltaObject]. */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/ToolCallsStepDetails.kt b/openai-java-core/src/main/kotlin/com/openai/models/ToolCallsStepDetails.kt index 474f90d86..ec705f2f4 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/ToolCallsStepDetails.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/ToolCallsStepDetails.kt @@ -71,6 +71,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ToolCallsStepDetails]. + * + * The following fields are required: + * ```java + * .toolCalls() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/Transcription.kt b/openai-java-core/src/main/kotlin/com/openai/models/Transcription.kt index 8ffc75315..21bc83296 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/Transcription.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/Transcription.kt @@ -50,6 +50,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [Transcription]. + * + * The following fields are required: + * ```java + * .text() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/TranscriptionSegment.kt b/openai-java-core/src/main/kotlin/com/openai/models/TranscriptionSegment.kt index 107ab56e6..74a7039e5 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/TranscriptionSegment.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/TranscriptionSegment.kt @@ -152,6 +152,23 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [TranscriptionSegment]. + * + * The following fields are required: + * ```java + * .id() + * .avgLogprob() + * .compressionRatio() + * .end() + * .noSpeechProb() + * .seek() + * .start() + * .temperature() + * .text() + * .tokens() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/TranscriptionVerbose.kt b/openai-java-core/src/main/kotlin/com/openai/models/TranscriptionVerbose.kt index 7259f943a..ec901c6cd 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/TranscriptionVerbose.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/TranscriptionVerbose.kt @@ -97,6 +97,16 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [TranscriptionVerbose]. + * + * The following fields are required: + * ```java + * .duration() + * .language() + * .text() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/TranscriptionWord.kt b/openai-java-core/src/main/kotlin/com/openai/models/TranscriptionWord.kt index b0f15b38c..15d49d959 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/TranscriptionWord.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/TranscriptionWord.kt @@ -65,6 +65,16 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [TranscriptionWord]. + * + * The following fields are required: + * ```java + * .end() + * .start() + * .word() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/Translation.kt b/openai-java-core/src/main/kotlin/com/openai/models/Translation.kt index b619c02a6..19aa8d98c 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/Translation.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/Translation.kt @@ -47,6 +47,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [Translation]. + * + * The following fields are required: + * ```java + * .text() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/TranslationVerbose.kt b/openai-java-core/src/main/kotlin/com/openai/models/TranslationVerbose.kt index 814627e04..a9511c697 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/TranslationVerbose.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/TranslationVerbose.kt @@ -84,6 +84,16 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [TranslationVerbose]. + * + * The following fields are required: + * ```java + * .duration() + * .language() + * .text() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/Upload.kt b/openai-java-core/src/main/kotlin/com/openai/models/Upload.kt index 1c2d91320..9906b9752 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/Upload.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/Upload.kt @@ -138,6 +138,20 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [Upload]. + * + * The following fields are required: + * ```java + * .id() + * .bytes() + * .createdAt() + * .expiresAt() + * .filename() + * .purpose() + * .status() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/UploadCancelParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/UploadCancelParams.kt index 8908ba2e2..64af63828 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/UploadCancelParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/UploadCancelParams.kt @@ -48,6 +48,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [UploadCancelParams]. + * + * The following fields are required: + * ```java + * .uploadId() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/UploadCompleteParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/UploadCompleteParams.kt index 2962ef708..c91210557 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/UploadCompleteParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/UploadCompleteParams.kt @@ -130,6 +130,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [Body]. + * + * The following fields are required: + * ```java + * .partIds() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -224,6 +232,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [UploadCompleteParams]. + * + * The following fields are required: + * ```java + * .uploadId() + * .partIds() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/UploadCreateParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/UploadCreateParams.kt index 105f54a3d..4f16a15c9 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/UploadCreateParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/UploadCreateParams.kt @@ -185,6 +185,17 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [Body]. + * + * The following fields are required: + * ```java + * .bytes() + * .filename() + * .mimeType() + * .purpose() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -301,6 +312,17 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [UploadCreateParams]. + * + * The following fields are required: + * ```java + * .bytes() + * .filename() + * .mimeType() + * .purpose() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/UploadPart.kt b/openai-java-core/src/main/kotlin/com/openai/models/UploadPart.kt index 020ff9897..16898bd24 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/UploadPart.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/UploadPart.kt @@ -80,6 +80,16 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [UploadPart]. + * + * The following fields are required: + * ```java + * .id() + * .createdAt() + * .uploadId() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/UploadPartCreateParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/UploadPartCreateParams.kt index a5a311609..70f220703 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/UploadPartCreateParams.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/UploadPartCreateParams.kt @@ -80,6 +80,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [Body]. + * + * The following fields are required: + * ```java + * .data() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -120,6 +128,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [UploadPartCreateParams]. + * + * The following fields are required: + * ```java + * .uploadId() + * .data() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/VectorStore.kt b/openai-java-core/src/main/kotlin/com/openai/models/VectorStore.kt index c223a2787..39c09f36a 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/VectorStore.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/VectorStore.kt @@ -176,6 +176,21 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [VectorStore]. + * + * The following fields are required: + * ```java + * .id() + * .createdAt() + * .fileCounts() + * .lastActiveAt() + * .metadata() + * .name() + * .status() + * .usageBytes() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -431,6 +446,18 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [FileCounts]. + * + * The following fields are required: + * ```java + * .cancelled() + * .completed() + * .failed() + * .inProgress() + * .total() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -687,6 +714,14 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [ExpiresAfter]. + * + * The following fields are required: + * ```java + * .days() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/VectorStoreDeleted.kt b/openai-java-core/src/main/kotlin/com/openai/models/VectorStoreDeleted.kt index d4e7f6bd5..a16241761 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/VectorStoreDeleted.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/VectorStoreDeleted.kt @@ -64,6 +64,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [VectorStoreDeleted]. + * + * The following fields are required: + * ```java + * .id() + * .deleted() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/VectorStoreFile.kt b/openai-java-core/src/main/kotlin/com/openai/models/VectorStoreFile.kt index e75330baf..137cdd361 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/VectorStoreFile.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/VectorStoreFile.kt @@ -153,6 +153,19 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [VectorStoreFile]. + * + * The following fields are required: + * ```java + * .id() + * .createdAt() + * .lastError() + * .status() + * .usageBytes() + * .vectorStoreId() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -361,6 +374,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [LastError]. + * + * The following fields are required: + * ```java + * .code() + * .message() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/VectorStoreFileBatch.kt b/openai-java-core/src/main/kotlin/com/openai/models/VectorStoreFileBatch.kt index a4e691495..0f53fd6a1 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/VectorStoreFileBatch.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/VectorStoreFileBatch.kt @@ -117,6 +117,18 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [VectorStoreFileBatch]. + * + * The following fields are required: + * ```java + * .id() + * .createdAt() + * .fileCounts() + * .status() + * .vectorStoreId() + * ``` + */ @JvmStatic fun builder() = Builder() } @@ -296,6 +308,18 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [FileCounts]. + * + * The following fields are required: + * ```java + * .cancelled() + * .completed() + * .failed() + * .inProgress() + * .total() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/main/kotlin/com/openai/models/VectorStoreFileDeleted.kt b/openai-java-core/src/main/kotlin/com/openai/models/VectorStoreFileDeleted.kt index 02f8b5936..4921d936b 100644 --- a/openai-java-core/src/main/kotlin/com/openai/models/VectorStoreFileDeleted.kt +++ b/openai-java-core/src/main/kotlin/com/openai/models/VectorStoreFileDeleted.kt @@ -64,6 +64,15 @@ private constructor( companion object { + /** + * Returns a mutable builder for constructing an instance of [VectorStoreFileDeleted]. + * + * The following fields are required: + * ```java + * .id() + * .deleted() + * ``` + */ @JvmStatic fun builder() = Builder() } diff --git a/openai-java-core/src/test/kotlin/com/openai/models/FileSearchToolCallTest.kt b/openai-java-core/src/test/kotlin/com/openai/models/FileSearchToolCallTest.kt index 94691b6b3..a73a2c02a 100644 --- a/openai-java-core/src/test/kotlin/com/openai/models/FileSearchToolCallTest.kt +++ b/openai-java-core/src/test/kotlin/com/openai/models/FileSearchToolCallTest.kt @@ -16,6 +16,7 @@ class FileSearchToolCallTest { FileSearchToolCall.FileSearch.builder() .rankingOptions( FileSearchToolCall.FileSearch.RankingOptions.builder() + .ranker(FileSearchToolCall.FileSearch.RankingOptions.Ranker.AUTO) .scoreThreshold(0.0) .build() ) @@ -44,6 +45,7 @@ class FileSearchToolCallTest { FileSearchToolCall.FileSearch.builder() .rankingOptions( FileSearchToolCall.FileSearch.RankingOptions.builder() + .ranker(FileSearchToolCall.FileSearch.RankingOptions.Ranker.AUTO) .scoreThreshold(0.0) .build() ) diff --git a/openai-java-core/src/test/kotlin/com/openai/models/FineTuningJobCreateParamsTest.kt b/openai-java-core/src/test/kotlin/com/openai/models/FineTuningJobCreateParamsTest.kt index f5d858b75..ff1e7b20c 100644 --- a/openai-java-core/src/test/kotlin/com/openai/models/FineTuningJobCreateParamsTest.kt +++ b/openai-java-core/src/test/kotlin/com/openai/models/FineTuningJobCreateParamsTest.kt @@ -2,6 +2,7 @@ package com.openai.models +import com.openai.core.JsonValue import kotlin.test.assertNotNull import org.assertj.core.api.Assertions.assertThat import org.junit.jupiter.api.Test @@ -32,6 +33,9 @@ class FineTuningJobCreateParamsTest { ) .build() ) + .metadata( + Metadata.builder().putAdditionalProperty("foo", JsonValue.from("string")).build() + ) .method( FineTuningJobCreateParams.Method.builder() .dpo( @@ -92,6 +96,11 @@ class FineTuningJobCreateParamsTest { ) .build() ) + .metadata( + Metadata.builder() + .putAdditionalProperty("foo", JsonValue.from("string")) + .build() + ) .method( FineTuningJobCreateParams.Method.builder() .dpo( @@ -154,6 +163,10 @@ class FineTuningJobCreateParamsTest { .build() ) ) + assertThat(body.metadata()) + .contains( + Metadata.builder().putAdditionalProperty("foo", JsonValue.from("string")).build() + ) assertThat(body.method()) .contains( FineTuningJobCreateParams.Method.builder() diff --git a/openai-java-core/src/test/kotlin/com/openai/models/FineTuningJobListParamsTest.kt b/openai-java-core/src/test/kotlin/com/openai/models/FineTuningJobListParamsTest.kt index 46b8b4d74..16e9f3c58 100644 --- a/openai-java-core/src/test/kotlin/com/openai/models/FineTuningJobListParamsTest.kt +++ b/openai-java-core/src/test/kotlin/com/openai/models/FineTuningJobListParamsTest.kt @@ -10,15 +10,36 @@ class FineTuningJobListParamsTest { @Test fun create() { - FineTuningJobListParams.builder().after("after").limit(0L).build() + FineTuningJobListParams.builder() + .after("after") + .limit(0L) + .metadata( + FineTuningJobListParams.Metadata.builder() + .putAdditionalProperty("foo", "string") + .build() + ) + .build() } @Test fun queryParams() { - val params = FineTuningJobListParams.builder().after("after").limit(0L).build() + val params = + FineTuningJobListParams.builder() + .after("after") + .limit(0L) + .metadata( + FineTuningJobListParams.Metadata.builder() + .putAdditionalProperty("foo", "string") + .build() + ) + .build() val expected = QueryParams.builder() expected.put("after", "after") expected.put("limit", "0") + FineTuningJobListParams.Metadata.builder() + .putAdditionalProperty("foo", "string") + .build() + .forEachQueryParam { key, values -> expected.put("metadata[$key]", values) } assertThat(params._queryParams()).isEqualTo(expected.build()) } diff --git a/openai-java-core/src/test/kotlin/com/openai/models/FineTuningJobTest.kt b/openai-java-core/src/test/kotlin/com/openai/models/FineTuningJobTest.kt index ab363aecc..8428a0c8c 100644 --- a/openai-java-core/src/test/kotlin/com/openai/models/FineTuningJobTest.kt +++ b/openai-java-core/src/test/kotlin/com/openai/models/FineTuningJobTest.kt @@ -2,6 +2,7 @@ package com.openai.models +import com.openai.core.JsonValue import org.assertj.core.api.Assertions.assertThat import org.junit.jupiter.api.Test @@ -50,6 +51,11 @@ class FineTuningJobTest { ) .build() ) + .metadata( + Metadata.builder() + .putAdditionalProperty("foo", JsonValue.from("string")) + .build() + ) .method( FineTuningJob.Method.builder() .dpo( @@ -118,6 +124,10 @@ class FineTuningJobTest { ) .build() ) + assertThat(fineTuningJob.metadata()) + .contains( + Metadata.builder().putAdditionalProperty("foo", JsonValue.from("string")).build() + ) assertThat(fineTuningJob.method()) .contains( FineTuningJob.Method.builder() diff --git a/openai-java-core/src/test/kotlin/com/openai/services/ErrorHandlingTest.kt b/openai-java-core/src/test/kotlin/com/openai/services/ErrorHandlingTest.kt index 4aa3e4a63..be706ae48 100644 --- a/openai-java-core/src/test/kotlin/com/openai/services/ErrorHandlingTest.kt +++ b/openai-java-core/src/test/kotlin/com/openai/services/ErrorHandlingTest.kt @@ -24,6 +24,7 @@ import com.openai.errors.UnauthorizedException import com.openai.errors.UnexpectedStatusCodeException import com.openai.errors.UnprocessableEntityException import com.openai.models.FineTuningJobCreateParams +import com.openai.models.Metadata import org.assertj.core.api.Assertions.assertThat import org.assertj.core.api.Assertions.entry import org.junit.jupiter.api.BeforeEach @@ -93,6 +94,11 @@ class ErrorHandlingTest { ) .build() ) + .metadata( + Metadata.builder() + .putAdditionalProperty("foo", JsonValue.from("string")) + .build() + ) .method( FineTuningJobCreateParams.Method.builder() .dpo( @@ -169,6 +175,11 @@ class ErrorHandlingTest { ) .build() ) + .metadata( + Metadata.builder() + .putAdditionalProperty("foo", JsonValue.from("string")) + .build() + ) .method( FineTuningJobCreateParams.Method.builder() .dpo( @@ -245,6 +256,11 @@ class ErrorHandlingTest { ) .build() ) + .metadata( + Metadata.builder() + .putAdditionalProperty("foo", JsonValue.from("string")) + .build() + ) .method( FineTuningJobCreateParams.Method.builder() .dpo( @@ -321,6 +337,11 @@ class ErrorHandlingTest { ) .build() ) + .metadata( + Metadata.builder() + .putAdditionalProperty("foo", JsonValue.from("string")) + .build() + ) .method( FineTuningJobCreateParams.Method.builder() .dpo( @@ -397,6 +418,11 @@ class ErrorHandlingTest { ) .build() ) + .metadata( + Metadata.builder() + .putAdditionalProperty("foo", JsonValue.from("string")) + .build() + ) .method( FineTuningJobCreateParams.Method.builder() .dpo( @@ -473,6 +499,11 @@ class ErrorHandlingTest { ) .build() ) + .metadata( + Metadata.builder() + .putAdditionalProperty("foo", JsonValue.from("string")) + .build() + ) .method( FineTuningJobCreateParams.Method.builder() .dpo( @@ -549,6 +580,11 @@ class ErrorHandlingTest { ) .build() ) + .metadata( + Metadata.builder() + .putAdditionalProperty("foo", JsonValue.from("string")) + .build() + ) .method( FineTuningJobCreateParams.Method.builder() .dpo( @@ -625,6 +661,11 @@ class ErrorHandlingTest { ) .build() ) + .metadata( + Metadata.builder() + .putAdditionalProperty("foo", JsonValue.from("string")) + .build() + ) .method( FineTuningJobCreateParams.Method.builder() .dpo( @@ -701,6 +742,11 @@ class ErrorHandlingTest { ) .build() ) + .metadata( + Metadata.builder() + .putAdditionalProperty("foo", JsonValue.from("string")) + .build() + ) .method( FineTuningJobCreateParams.Method.builder() .dpo( diff --git a/openai-java-core/src/test/kotlin/com/openai/services/async/fineTuning/JobServiceAsyncTest.kt b/openai-java-core/src/test/kotlin/com/openai/services/async/fineTuning/JobServiceAsyncTest.kt index c63f30234..386729ff7 100644 --- a/openai-java-core/src/test/kotlin/com/openai/services/async/fineTuning/JobServiceAsyncTest.kt +++ b/openai-java-core/src/test/kotlin/com/openai/services/async/fineTuning/JobServiceAsyncTest.kt @@ -4,10 +4,12 @@ package com.openai.services.async.fineTuning import com.openai.TestServerExtension import com.openai.client.okhttp.OpenAIOkHttpClientAsync +import com.openai.core.JsonValue import com.openai.models.FineTuningJobCancelParams import com.openai.models.FineTuningJobCreateParams import com.openai.models.FineTuningJobListEventsParams import com.openai.models.FineTuningJobRetrieveParams +import com.openai.models.Metadata import org.junit.jupiter.api.Test import org.junit.jupiter.api.extension.ExtendWith @@ -47,6 +49,11 @@ class JobServiceAsyncTest { ) .build() ) + .metadata( + Metadata.builder() + .putAdditionalProperty("foo", JsonValue.from("string")) + .build() + ) .method( FineTuningJobCreateParams.Method.builder() .dpo( diff --git a/openai-java-core/src/test/kotlin/com/openai/services/blocking/EmbeddingServiceTest.kt b/openai-java-core/src/test/kotlin/com/openai/services/blocking/EmbeddingServiceTest.kt index 0d31b863e..9d97f378f 100644 --- a/openai-java-core/src/test/kotlin/com/openai/services/blocking/EmbeddingServiceTest.kt +++ b/openai-java-core/src/test/kotlin/com/openai/services/blocking/EmbeddingServiceTest.kt @@ -25,7 +25,7 @@ class EmbeddingServiceTest { embeddingService.create( EmbeddingCreateParams.builder() .input("The quick brown fox jumped over the lazy dog") - .model(EmbeddingModel.TEXT_EMBEDDING_ADA_002) + .model(EmbeddingModel.TEXT_EMBEDDING_3_SMALL) .dimensions(1L) .encodingFormat(EmbeddingCreateParams.EncodingFormat.FLOAT) .user("user-1234") diff --git a/openai-java-core/src/test/kotlin/com/openai/services/blocking/fineTuning/JobServiceTest.kt b/openai-java-core/src/test/kotlin/com/openai/services/blocking/fineTuning/JobServiceTest.kt index 609d966b3..f689430c8 100644 --- a/openai-java-core/src/test/kotlin/com/openai/services/blocking/fineTuning/JobServiceTest.kt +++ b/openai-java-core/src/test/kotlin/com/openai/services/blocking/fineTuning/JobServiceTest.kt @@ -4,10 +4,12 @@ package com.openai.services.blocking.fineTuning import com.openai.TestServerExtension import com.openai.client.okhttp.OpenAIOkHttpClient +import com.openai.core.JsonValue import com.openai.models.FineTuningJobCancelParams import com.openai.models.FineTuningJobCreateParams import com.openai.models.FineTuningJobListEventsParams import com.openai.models.FineTuningJobRetrieveParams +import com.openai.models.Metadata import org.junit.jupiter.api.Test import org.junit.jupiter.api.extension.ExtendWith @@ -47,6 +49,11 @@ class JobServiceTest { ) .build() ) + .metadata( + Metadata.builder() + .putAdditionalProperty("foo", JsonValue.from("string")) + .build() + ) .method( FineTuningJobCreateParams.Method.builder() .dpo( diff --git a/openai-java-example/src/main/java/com/openai/example/AudioTranscriptionsAsyncExample.java b/openai-java-example/src/main/java/com/openai/example/AudioTranscriptionsAsyncExample.java new file mode 100644 index 000000000..94431ee4f --- /dev/null +++ b/openai-java-example/src/main/java/com/openai/example/AudioTranscriptionsAsyncExample.java @@ -0,0 +1,37 @@ +package com.openai.example; + +import com.openai.client.OpenAIClientAsync; +import com.openai.client.okhttp.OpenAIOkHttpClientAsync; +import com.openai.core.MultipartField; +import com.openai.models.AudioModel; +import com.openai.models.AudioTranscriptionCreateParams; +import java.io.IOException; + +public final class AudioTranscriptionsAsyncExample { + private AudioTranscriptionsAsyncExample() {} + + public static void main(String[] args) throws IOException { + // Configures using one of: + // - The `OPENAI_API_KEY` environment variable + // - The `AZURE_OPENAI_ENDPOINT` and `AZURE_OPENAI_KEY` environment variables + OpenAIClientAsync client = OpenAIOkHttpClientAsync.fromEnv(); + + ClassLoader classloader = Thread.currentThread().getContextClassLoader(); + String filename = "sports.wav"; + + AudioTranscriptionCreateParams createParams = AudioTranscriptionCreateParams.builder() + .file(MultipartField.builder() + .value(classloader.getResourceAsStream(filename).readAllBytes()) + .filename(filename) + .build()) + .model(AudioModel.WHISPER_1) + .build(); + + client.audio() + .transcriptions() + .create(createParams) + .thenAccept(response -> + System.out.println(response.asTranscription().text())) + .join(); + } +} diff --git a/openai-java-example/src/main/java/com/openai/example/AudioTranscriptionsExample.java b/openai-java-example/src/main/java/com/openai/example/AudioTranscriptionsExample.java new file mode 100644 index 000000000..e2af4967e --- /dev/null +++ b/openai-java-example/src/main/java/com/openai/example/AudioTranscriptionsExample.java @@ -0,0 +1,35 @@ +package com.openai.example; + +import com.openai.client.OpenAIClient; +import com.openai.client.okhttp.OpenAIOkHttpClient; +import com.openai.core.MultipartField; +import com.openai.models.AudioModel; +import com.openai.models.AudioTranscriptionCreateParams; +import com.openai.models.Transcription; +import java.io.IOException; + +public final class AudioTranscriptionsExample { + private AudioTranscriptionsExample() {} + + public static void main(String[] args) throws IOException { + // Configures using one of: + // - The `OPENAI_API_KEY` environment variable + // - The `AZURE_OPENAI_ENDPOINT` and `AZURE_OPENAI_KEY` environment variables + OpenAIClient client = OpenAIOkHttpClient.fromEnv(); + + ClassLoader classloader = Thread.currentThread().getContextClassLoader(); + String filename = "sports.wav"; + + AudioTranscriptionCreateParams createParams = AudioTranscriptionCreateParams.builder() + .file(MultipartField.builder() + .value(classloader.getResourceAsStream(filename).readAllBytes()) + .filename(filename) + .build()) + .model(AudioModel.WHISPER_1) + .build(); + + Transcription transcription = + client.audio().transcriptions().create(createParams).asTranscription(); + System.out.println(transcription.text()); + } +} diff --git a/openai-java-example/src/main/java/com/openai/example/EmbeddingsAsyncExample.java b/openai-java-example/src/main/java/com/openai/example/EmbeddingsAsyncExample.java new file mode 100644 index 000000000..7589738a5 --- /dev/null +++ b/openai-java-example/src/main/java/com/openai/example/EmbeddingsAsyncExample.java @@ -0,0 +1,24 @@ +package com.openai.example; + +import com.openai.client.OpenAIClientAsync; +import com.openai.client.okhttp.OpenAIOkHttpClientAsync; +import com.openai.models.EmbeddingCreateParams; +import com.openai.models.EmbeddingModel; + +public final class EmbeddingsAsyncExample { + private EmbeddingsAsyncExample() {} + + public static void main(String[] args) { + // Configures using one of: + // - The `OPENAI_API_KEY` environment variable + // - The `AZURE_OPENAI_ENDPOINT` and `AZURE_OPENAI_KEY` environment variables + OpenAIClientAsync client = OpenAIOkHttpClientAsync.fromEnv(); + + EmbeddingCreateParams createParams = EmbeddingCreateParams.builder() + .input("The quick brown fox jumped over the lazy dog") + .model(EmbeddingModel.TEXT_EMBEDDING_3_SMALL) + .build(); + + client.embeddings().create(createParams).thenAccept(System.out::println).join(); + } +} diff --git a/openai-java-example/src/main/java/com/openai/example/EmbeddingsExample.java b/openai-java-example/src/main/java/com/openai/example/EmbeddingsExample.java new file mode 100644 index 000000000..bf7a0b721 --- /dev/null +++ b/openai-java-example/src/main/java/com/openai/example/EmbeddingsExample.java @@ -0,0 +1,24 @@ +package com.openai.example; + +import com.openai.client.OpenAIClient; +import com.openai.client.okhttp.OpenAIOkHttpClient; +import com.openai.models.EmbeddingCreateParams; +import com.openai.models.EmbeddingModel; + +public final class EmbeddingsExample { + private EmbeddingsExample() {} + + public static void main(String[] args) { + // Configures using one of: + // - The `OPENAI_API_KEY` environment variable + // - The `AZURE_OPENAI_ENDPOINT` and `AZURE_OPENAI_KEY` environment variables + OpenAIClient client = OpenAIOkHttpClient.fromEnv(); + + EmbeddingCreateParams createParams = EmbeddingCreateParams.builder() + .input("The quick brown fox jumped over the lazy dog") + .model(EmbeddingModel.TEXT_EMBEDDING_3_SMALL) + .build(); + + System.out.println(client.embeddings().create(createParams)); + } +} diff --git a/openai-java-example/src/main/resources/sports.wav b/openai-java-example/src/main/resources/sports.wav new file mode 100644 index 000000000..b0a3abd1f Binary files /dev/null and b/openai-java-example/src/main/resources/sports.wav differ