Skip to content

Commit 261249a

Browse files
docs: add params class javadocs (#90)
1 parent a761f1d commit 261249a

File tree

60 files changed

+138
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

60 files changed

+138
-0
lines changed

openai-java-core/src/main/kotlin/com/openai/models/BatchCancelParams.kt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,11 @@ import com.openai.core.toImmutable
1010
import java.util.Objects
1111
import java.util.Optional
1212

13+
/**
14+
* Cancels an in-progress batch. The batch will be in status `cancelling` for up to 10 minutes,
15+
* before changing to `cancelled`, where it will have partial results (if any) available in the
16+
* output file.
17+
*/
1318
class BatchCancelParams
1419
constructor(
1520
private val batchId: String,

openai-java-core/src/main/kotlin/com/openai/models/BatchCreateParams.kt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ import com.openai.errors.OpenAIInvalidDataException
1919
import java.util.Objects
2020
import java.util.Optional
2121

22+
/** Creates and executes a batch from an uploaded file of requests */
2223
class BatchCreateParams
2324
constructor(
2425
private val body: BatchCreateBody,

openai-java-core/src/main/kotlin/com/openai/models/BatchListParams.kt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ import com.openai.core.http.QueryParams
88
import java.util.Objects
99
import java.util.Optional
1010

11+
/** List your organization's batches. */
1112
class BatchListParams
1213
constructor(
1314
private val after: String?,

openai-java-core/src/main/kotlin/com/openai/models/BatchRetrieveParams.kt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ import com.openai.core.http.Headers
77
import com.openai.core.http.QueryParams
88
import java.util.Objects
99

10+
/** Retrieves a batch. */
1011
class BatchRetrieveParams
1112
constructor(
1213
private val batchId: String,

openai-java-core/src/main/kotlin/com/openai/models/BetaAssistantCreateParams.kt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ import com.openai.core.toImmutable
1616
import java.util.Objects
1717
import java.util.Optional
1818

19+
/** Create an assistant with a model and instructions. */
1920
class BetaAssistantCreateParams
2021
constructor(
2122
private val body: BetaAssistantCreateBody,

openai-java-core/src/main/kotlin/com/openai/models/BetaAssistantDeleteParams.kt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ import com.openai.core.toImmutable
1010
import java.util.Objects
1111
import java.util.Optional
1212

13+
/** Delete an assistant. */
1314
class BetaAssistantDeleteParams
1415
constructor(
1516
private val assistantId: String,

openai-java-core/src/main/kotlin/com/openai/models/BetaAssistantListParams.kt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ import com.openai.errors.OpenAIInvalidDataException
1212
import java.util.Objects
1313
import java.util.Optional
1414

15+
/** Returns a list of assistants. */
1516
class BetaAssistantListParams
1617
constructor(
1718
private val after: String?,

openai-java-core/src/main/kotlin/com/openai/models/BetaAssistantRetrieveParams.kt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ import com.openai.core.http.Headers
77
import com.openai.core.http.QueryParams
88
import java.util.Objects
99

10+
/** Retrieves an assistant. */
1011
class BetaAssistantRetrieveParams
1112
constructor(
1213
private val assistantId: String,

openai-java-core/src/main/kotlin/com/openai/models/BetaAssistantUpdateParams.kt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ import com.openai.core.toImmutable
1616
import java.util.Objects
1717
import java.util.Optional
1818

19+
/** Modifies an assistant. */
1920
class BetaAssistantUpdateParams
2021
constructor(
2122
private val assistantId: String,

openai-java-core/src/main/kotlin/com/openai/models/BetaThreadCreateAndRunParams.kt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ import java.util.Objects
3030
import java.util.Optional
3131
import kotlin.jvm.optionals.getOrNull
3232

33+
/** Create a thread and run it in one request. */
3334
class BetaThreadCreateAndRunParams
3435
constructor(
3536
private val body: BetaThreadCreateAndRunBody,

0 commit comments

Comments
 (0)