docs

Author: CJCrafter

src/main/kotlin/com/cjcrafter/openai/threads/ModifyThreadRequest.kt

@@ -36,6 +36,10 @@ data class ModifyThreadRequest(
     }
 
     companion object {
+
+        /**
+         * Creates a new [ModifyThreadRequest] builder.
+         */
         @JvmStatic
         fun builder() = Builder()
     }

src/main/kotlin/com/cjcrafter/openai/threads/runs/Run.kt

@@ -3,6 +3,29 @@ package com.cjcrafter.openai.threads.runs
 import com.cjcrafter.openai.chat.tool.Tool
 import com.fasterxml.jackson.annotation.JsonProperty
 
+/**
+ * Represents a run object returned by the OpenAI API. The run object itself
+ * isn't highly useful for most applications, but it is used to retrieve the
+ * messages from the run via [RunStep]s.
+ *
+ * @property id The unique id of the run, used for retrieving the run
+ * @property createdAt The unix timestamp of when the run was created
+ * @property threadId The id of the thread that the run belongs to
+ * @property assistantId The id of the assistant which is handling the run
+ * @property status The current status of the run
+ * @property requiredAction The required action for the run, if any
+ * @property lastError The last error associated with the run, if any
+ * @property expiresAt The unix timestamp of when the run will expire
+ * @property startedAt The unix timestamp of when the run started
+ * @property cancelledAt The unix timestamp of when the run was cancelled
+ * @property failedAt The unix timestamp of when the run failed
+ * @property completedAt The unix timestamp of when the run completed
+ * @property model The model used for the run
+ * @property instructions The instructions used for the run
+ * @property tools The tools used for the run
+ * @property fileIds The file ids used for the run
+ * @property metadata The metadata associated with the run
+ */
 data class Run(
     @JsonProperty(required = true) val id: String,
     @JsonProperty("created_at", required = true) val createdAt: Int,

src/main/kotlin/com/cjcrafter/openai/threads/runs/RunHandler.kt

@@ -78,10 +78,7 @@ interface RunHandler {
     fun steps(run: Run): RunStepHandler = steps(run.id)
 
     /**
-     *
-     *
-     * @param id
-     * @return
+     * Gets the steps handler for the run with the given id.
      */
     fun steps(id: String): RunStepHandler
 }

src/main/kotlin/com/cjcrafter/openai/threads/runs/SubmitToolOutputs.kt

@@ -1,8 +1,13 @@
 package com.cjcrafter.openai.threads.runs
 
+import com.cjcrafter.openai.assistants.Assistant
 import com.cjcrafter.openai.util.OpenAIDslMarker
 import com.fasterxml.jackson.annotation.JsonProperty
 
+/**
+ * A data class holding your tool's outputs. Used after an [Assistant] makes
+ * a tool call.
+ */
 data class SubmitToolOutputs(
     @JsonProperty("tool_outputs") var toolOutputs: MutableList<ToolCallOutputs>,
 ) {
@@ -23,6 +28,10 @@ data class SubmitToolOutputs(
     }
 
     companion object {
+
+        /**
+         * Creates a new [SubmitToolOutputs] builder.
+         */
         @JvmStatic
         fun builder() = Builder()
     }