add run steps

Author: CJCrafter

examples/src/main/java/chat/StreamChatCompletionFunction.java

@@ -101,7 +101,7 @@ public static ChatMessage handleToolCall(ToolCall call, List<Tool> validTools) {
             if (call.getType() != Tool.Type.FUNCTION)
                 throw new HallucinationException("Unknown tool call type: " + call.getType());
 
-            FunctionCall function = call.getFunction();
+            FunctionCall function = ((FunctionToolCall) call).getFunction();
             Map<String, JsonNode> arguments = function.tryParseArguments(validTools); // You can pass null here for less strict parsing
             String equation = arguments.get("equation").asText();
             double result = solveEquation(equation);

examples/src/main/kotlin/assistant/Thread.kt

@@ -1,8 +1,16 @@
 package assistant
 
+import com.cjcrafter.openai.chat.tool.CodeInterpreterToolCall
+import com.cjcrafter.openai.chat.tool.FunctionToolCall
+import com.cjcrafter.openai.chat.tool.RetrievalToolCall
+import com.cjcrafter.openai.chat.tool.Tool
 import com.cjcrafter.openai.openAI
 import com.cjcrafter.openai.threads.create
+import com.cjcrafter.openai.threads.message.ImageContent
+import com.cjcrafter.openai.threads.message.TextContent
 import com.cjcrafter.openai.threads.message.ThreadUser
+import com.cjcrafter.openai.threads.runs.MessageCreationDetails
+import com.cjcrafter.openai.threads.runs.ToolCallsDetails
 import io.github.cdimascio.dotenv.dotenv
 
 fun main() {
@@ -46,6 +54,47 @@ fun main() {
             Thread.sleep(2500)
             run = openai.threads.runs(thread).retrieve(run)
         }
-    }
 
+        // Once the run stops, we want to retrieve the steps of the run. This
+        // includes message outputs, function calls, code interpreters, etc.
+        val steps = openai.threads.runs(thread).steps(run).list()
+        steps.data.forEach { step ->
+            when (val details = step.stepDetails) {
+                is MessageCreationDetails -> {
+                    val messageId = details.messageCreation.messageId
+                    val message = openai.threads.messages(thread).retrieve(messageId)
+                    for (content in message.content) {
+
+                        when (content) {
+                            is TextContent -> println(content.text.value)
+                            is ImageContent -> println(content.imageFile.fileId)
+                            else -> println("Unhandled content type: $content")
+                        }
+
+                    }
+                }
+
+                is ToolCallsDetails -> {
+                    for (toolCall in details.toolCalls) {
+                        when (toolCall) {
+                            is FunctionToolCall -> {
+
+                            }
+                            is RetrievalToolCall -> {
+
+                            }
+                            is CodeInterpreterToolCall -> {
+                            }
+                        }
+                        println(toolCall)
+                    }
+                }
+
+                else -> {
+                    println("Unhandled step type: ${step.stepDetails.type}")
+                }
+            }
+            println("Step: $step")
+        }
+    }
 }

examples/src/main/kotlin/chat/StreamChatCompletionFunction.kt

@@ -3,6 +3,7 @@ package chat
 import com.cjcrafter.openai.chat.*
 import com.cjcrafter.openai.chat.ChatMessage.Companion.toSystemMessage
 import com.cjcrafter.openai.chat.ChatMessage.Companion.toUserMessage
+import com.cjcrafter.openai.chat.tool.FunctionToolCall
 import com.cjcrafter.openai.chat.tool.Tool
 import com.cjcrafter.openai.chat.tool.ToolCall
 import com.cjcrafter.openai.exception.HallucinationException
@@ -87,7 +88,7 @@ fun handleToolCall(call: ToolCall, validTools: List<Tool>?): ChatMessage {
         if (call.type !== Tool.Type.FUNCTION)
             throw HallucinationException("Unknown tool call type: " + call.type)
 
-        val function = call.function
+        val function = (call as FunctionToolCall).function
         val arguments = function.tryParseArguments(validTools) // You can pass null here for less strict parsing
         val equation = arguments["equation"]!!.asText()
         val result = solveEquation(equation)

src/main/kotlin/com/cjcrafter/openai/chat/tool/CodeInterpreter.kt

@@ -55,7 +55,7 @@ data class CodeInterpreter(
      * @property text The text output
      */
     data class LogOutput(
-        val text: String,
+        @JsonProperty(required = true) val logs: String,
     ) : Output() {
         override val type: Type = Type.LOGS
     }

src/main/kotlin/com/cjcrafter/openai/threads/message/ImageContent.kt

@@ -6,6 +6,8 @@ data class ImageContent(
     @JsonProperty("image_file", required = true) val imageFile: ImageFile,
 ): ThreadMessageContent() {
 
+    override val type = Type.IMAGE_FILE
+
     data class ImageFile(
         @JsonProperty("file_id", required = true) val fileId: String,
     )

src/main/kotlin/com/cjcrafter/openai/threads/message/TextContent.kt

@@ -4,6 +4,8 @@ data class TextContent(
     val text: Text
 ) : ThreadMessageContent() {
 
+    override val type = Type.TEXT
+
     data class Text(
         val value: String,
         val annotations: List<TextAnnotation>

src/main/kotlin/com/cjcrafter/openai/threads/message/ThreadMessageContent.kt

@@ -3,9 +3,35 @@ package com.cjcrafter.openai.threads.message
 import com.fasterxml.jackson.annotation.JsonSubTypes
 import com.fasterxml.jackson.annotation.JsonTypeInfo
 
+/**
+ * A sealed class which represents a message in a thread.
+ */
 @JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.PROPERTY, property = "type")
 @JsonSubTypes(
     JsonSubTypes.Type(TextContent::class, name = "text"),
     JsonSubTypes.Type(ImageContent::class, name = "image_file"),
 )
-abstract class ThreadMessageContent
+sealed class ThreadMessageContent {
+
+    /**
+     * The type of content.
+     */
+    abstract val type: Type
+
+    enum class Type {
+
+        /**
+         * A message containing text, usually as a markdown string.
+         *
+         * @see TextContent
+         */
+        TEXT,
+
+        /**
+         * A message containing an image, stored as a file id.
+         *
+         * @see ImageContent
+         */
+        IMAGE_FILE,
+    }
+}

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

@@ -1,4 +1,18 @@
 package com.cjcrafter.openai.threads.runs
 
-class ListRunStepsResponse {
-}
+import com.fasterxml.jackson.annotation.JsonProperty
+
+/**
+ * A data class which represents a response from the OpenAI API containing a list of [RunStep]s.
+ *
+ * @property data The list of [RunStep]s
+ * @property firstId The ID of the first [RunStep] in the list
+ * @property lastId The ID of the last [RunStep] in the list
+ * @property hasMore Whether there are more [RunStep]s to retrieve from the API
+ */
+data class ListRunStepsResponse(
+    @JsonProperty(required = true) val data: List<RunStep>,
+    @JsonProperty("first_id", required = true) val firstId: String,
+    @JsonProperty("last_id", required = true) val lastId: String,
+    @JsonProperty("has_more", required = true) val hasMore: Boolean,
+)

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

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

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

@@ -36,4 +36,11 @@ class RunHandlerImpl(
         val httpRequest = requestHelper.buildRequestNoBody("$endpoint/$id/cancel").addHeader("OpenAI-Beta", "assistants=v1").method("POST", null).build()
         return requestHelper.executeRequest(httpRequest, Run::class.java)
     }
+
+    private val stepHandlers = mutableMapOf<String, RunStepHandler>()
+    override fun steps(id: String): RunStepHandler {
+        return stepHandlers.getOrPut(id) {
+            RunStepHandlerImpl(requestHelper, "$endpoint/$id/steps", threadId, id)
+        }
+    }
 }