feat: response api stream event

Author: szl97

api/pom.xml

@@ -6,7 +6,7 @@
     <parent>
         <groupId>top.bella</groupId>
         <artifactId>openai-java</artifactId>
-        <version>0.23.47</version>
+        <version>0.23.48</version>
     </parent>
     <packaging>jar</packaging>
     <artifactId>openai-api</artifactId>

api/src/main/java/com/theokanning/openai/response/stream/BaseStreamEvent.java

@@ -26,8 +26,12 @@
         @JsonSubTypes.Type(value = OutputItemAddedEvent.class, name = "response.output_item.added"),
         @JsonSubTypes.Type(value = OutputItemDoneEvent.class, name = "response.output_item.done"),
         @JsonSubTypes.Type(value = ContentPartAddedEvent.class, name = "response.content_part.added"),
+        @JsonSubTypes.Type(value = ContentPartDoneEvent.class, name = "response.content_part.done"),
         @JsonSubTypes.Type(value = OutputTextDeltaEvent.class, name = "response.output_text.delta"),
         @JsonSubTypes.Type(value = OutputTextDoneEvent.class, name = "response.output_text.done"),
+        @JsonSubTypes.Type(value = OutputTextAnnotationAddedEvent.class, name = "response.output_text.annotation.added"),
+        @JsonSubTypes.Type(value = RefusalDeltaEvent.class, name = "response.refusal.delta"),
+        @JsonSubTypes.Type(value = RefusalDoneEvent.class, name = "response.refusal.done"),
         @JsonSubTypes.Type(value = FunctionCallArgumentsDeltaEvent.class, name = "response.function_call_arguments.delta"),
         @JsonSubTypes.Type(value = FunctionCallArgumentsDoneEvent.class, name = "response.function_call_arguments.done"),
         @JsonSubTypes.Type(value = FileSearchInProgressEvent.class, name = "response.file_search_call.in_progress"),
@@ -42,7 +46,25 @@
         @JsonSubTypes.Type(value = CodeInterpreterCodeDeltaEvent.class, name = "response.code_interpreter_call_code.delta"),
         @JsonSubTypes.Type(value = CodeInterpreterCodeDoneEvent.class, name = "response.code_interpreter_call_code.done"),
         @JsonSubTypes.Type(value = ReasoningTextDeltaEvent.class, name = "response.reasoning_text.delta"),
+        @JsonSubTypes.Type(value = ReasoningTextDoneEvent.class, name = "response.reasoning_text.done"),
+        @JsonSubTypes.Type(value = ReasoningSummaryPartAddedEvent.class, name = "response.reasoning_summary_part.added"),
+        @JsonSubTypes.Type(value = ReasoningSummaryPartDoneEvent.class, name = "response.reasoning_summary_part.done"),
         @JsonSubTypes.Type(value = ReasoningSummaryTextDeltaEvent.class, name = "response.reasoning_summary_text.delta"),
+        @JsonSubTypes.Type(value = ReasoningSummaryTextDoneEvent.class, name = "response.reasoning_summary_text.done"),
+        @JsonSubTypes.Type(value = ImageGenerationInProgressEvent.class, name = "response.image_generation_call.in_progress"),
+        @JsonSubTypes.Type(value = ImageGenerationGeneratingEvent.class, name = "response.image_generation_call.generating"),
+        @JsonSubTypes.Type(value = ImageGenerationCompletedEvent.class, name = "response.image_generation_call.completed"),
+        @JsonSubTypes.Type(value = ImageGenerationPartialImageEvent.class, name = "response.image_generation_call.partial_image"),
+        @JsonSubTypes.Type(value = McpCallArgumentsDeltaEvent.class, name = "response.mcp_call_arguments.delta"),
+        @JsonSubTypes.Type(value = McpCallArgumentsDoneEvent.class, name = "response.mcp_call_arguments.done"),
+        @JsonSubTypes.Type(value = McpCallInProgressEvent.class, name = "response.mcp_call.in_progress"),
+        @JsonSubTypes.Type(value = McpCallCompletedEvent.class, name = "response.mcp_call.completed"),
+        @JsonSubTypes.Type(value = McpCallFailedEvent.class, name = "response.mcp_call.failed"),
+        @JsonSubTypes.Type(value = McpListToolsInProgressEvent.class, name = "response.mcp_list_tools.in_progress"),
+        @JsonSubTypes.Type(value = McpListToolsCompletedEvent.class, name = "response.mcp_list_tools.completed"),
+        @JsonSubTypes.Type(value = McpListToolsFailedEvent.class, name = "response.mcp_list_tools.failed"),
+        @JsonSubTypes.Type(value = CustomToolCallInputDeltaEvent.class, name = "response.custom_tool_call_input.delta"),
+        @JsonSubTypes.Type(value = CustomToolCallInputDoneEvent.class, name = "response.custom_tool_call_input.done"),
         @JsonSubTypes.Type(value = ErrorEvent.class, name = "error")
 })
 public abstract class BaseStreamEvent {

api/src/main/java/com/theokanning/openai/response/stream/ContentPartDoneEvent.java

@@ -0,0 +1,41 @@
+package com.theokanning.openai.response.stream;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+
+/**
+ * Event emitted when a content part is done.
+ */
+@Data
+@EqualsAndHashCode(callSuper = true)
+public class ContentPartDoneEvent extends BaseStreamEvent {
+
+    /**
+     * The index of the content part that is done.
+     */
+    @JsonProperty("content_index")
+    private Integer contentIndex;
+
+    /**
+     * The ID of the output item that the content part was added to.
+     */
+    @JsonProperty("item_id")
+    private String itemId;
+
+    /**
+     * The index of the output item that the content part was added to.
+     */
+    @JsonProperty("output_index")
+    private Integer outputIndex;
+
+    /**
+     * The content part that is done.
+     */
+    private Object part;
+
+    @Override
+    public String getType() {
+        return "response.content_part.done";
+    }
+}

api/src/main/java/com/theokanning/openai/response/stream/CustomToolCallInputDeltaEvent.java

@@ -0,0 +1,35 @@
+package com.theokanning.openai.response.stream;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+
+/**
+ * Event representing a delta (partial update) to the input of a custom tool call.
+ */
+@Data
+@EqualsAndHashCode(callSuper = true)
+public class CustomToolCallInputDeltaEvent extends BaseStreamEvent {
+
+    /**
+     * The incremental input data (delta) for the custom tool call.
+     */
+    private String delta;
+
+    /**
+     * Unique identifier for the API item associated with this event.
+     */
+    @JsonProperty("item_id")
+    private String itemId;
+
+    /**
+     * The index of the output this delta applies to.
+     */
+    @JsonProperty("output_index")
+    private Integer outputIndex;
+
+    @Override
+    public String getType() {
+        return "response.custom_tool_call_input.delta";
+    }
+}

api/src/main/java/com/theokanning/openai/response/stream/CustomToolCallInputDoneEvent.java

@@ -0,0 +1,35 @@
+package com.theokanning.openai.response.stream;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+
+/**
+ * Event indicating that input for a custom tool call is complete.
+ */
+@Data
+@EqualsAndHashCode(callSuper = true)
+public class CustomToolCallInputDoneEvent extends BaseStreamEvent {
+
+    /**
+     * The complete input data for the custom tool call.
+     */
+    private String input;
+
+    /**
+     * Unique identifier for the API item associated with this event.
+     */
+    @JsonProperty("item_id")
+    private String itemId;
+
+    /**
+     * The index of the output this event applies to.
+     */
+    @JsonProperty("output_index")
+    private Integer outputIndex;
+
+    @Override
+    public String getType() {
+        return "response.custom_tool_call_input.done";
+    }
+}

api/src/main/java/com/theokanning/openai/response/stream/ImageGenerationCompletedEvent.java

@@ -0,0 +1,30 @@
+package com.theokanning.openai.response.stream;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+
+/**
+ * Event emitted when an image generation tool call has completed and the final image is available.
+ */
+@Data
+@EqualsAndHashCode(callSuper = true)
+public class ImageGenerationCompletedEvent extends BaseStreamEvent {
+
+    /**
+     * The unique identifier of the image generation item being processed.
+     */
+    @JsonProperty("item_id")
+    private String itemId;
+
+    /**
+     * The index of the output item in the response's output array.
+     */
+    @JsonProperty("output_index")
+    private Integer outputIndex;
+
+    @Override
+    public String getType() {
+        return "response.image_generation_call.completed";
+    }
+}

api/src/main/java/com/theokanning/openai/response/stream/ImageGenerationGeneratingEvent.java

@@ -0,0 +1,30 @@
+package com.theokanning.openai.response.stream;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+
+/**
+ * Event emitted when an image generation tool call is actively generating an image (intermediate state).
+ */
+@Data
+@EqualsAndHashCode(callSuper = true)
+public class ImageGenerationGeneratingEvent extends BaseStreamEvent {
+
+    /**
+     * The unique identifier of the image generation item being processed.
+     */
+    @JsonProperty("item_id")
+    private String itemId;
+
+    /**
+     * The index of the output item in the response's output array.
+     */
+    @JsonProperty("output_index")
+    private Integer outputIndex;
+
+    @Override
+    public String getType() {
+        return "response.image_generation_call.generating";
+    }
+}

api/src/main/java/com/theokanning/openai/response/stream/ImageGenerationInProgressEvent.java

@@ -0,0 +1,30 @@
+package com.theokanning.openai.response.stream;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+
+/**
+ * Event emitted when an image generation tool call is in progress.
+ */
+@Data
+@EqualsAndHashCode(callSuper = true)
+public class ImageGenerationInProgressEvent extends BaseStreamEvent {
+
+    /**
+     * The unique identifier of the image generation item being processed.
+     */
+    @JsonProperty("item_id")
+    private String itemId;
+
+    /**
+     * The index of the output item in the response's output array.
+     */
+    @JsonProperty("output_index")
+    private Integer outputIndex;
+
+    @Override
+    public String getType() {
+        return "response.image_generation_call.in_progress";
+    }
+}

api/src/main/java/com/theokanning/openai/response/stream/ImageGenerationPartialImageEvent.java

@@ -0,0 +1,42 @@
+package com.theokanning.openai.response.stream;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+
+/**
+ * Event emitted when a partial image is available during image generation streaming.
+ */
+@Data
+@EqualsAndHashCode(callSuper = true)
+public class ImageGenerationPartialImageEvent extends BaseStreamEvent {
+
+    /**
+     * The unique identifier of the image generation item being processed.
+     */
+    @JsonProperty("item_id")
+    private String itemId;
+
+    /**
+     * The index of the output item in the response's output array.
+     */
+    @JsonProperty("output_index")
+    private Integer outputIndex;
+
+    /**
+     * Base64-encoded partial image data, suitable for rendering as an image.
+     */
+    @JsonProperty("partial_image_b64")
+    private String partialImageB64;
+
+    /**
+     * 0-based index for the partial image (backend is 1-based, but this is 0-based for the user).
+     */
+    @JsonProperty("partial_image_index")
+    private Integer partialImageIndex;
+
+    @Override
+    public String getType() {
+        return "response.image_generation_call.partial_image";
+    }
+}

api/src/main/java/com/theokanning/openai/response/stream/McpCallArgumentsDeltaEvent.java

@@ -0,0 +1,35 @@
+package com.theokanning.openai.response.stream;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+
+/**
+ * Event emitted when there is a delta (partial update) to the arguments of an MCP tool call.
+ */
+@Data
+@EqualsAndHashCode(callSuper = true)
+public class McpCallArgumentsDeltaEvent extends BaseStreamEvent {
+
+    /**
+     * A JSON string containing the partial update to the arguments for the MCP tool call.
+     */
+    private String delta;
+
+    /**
+     * The unique identifier of the MCP tool call item being processed.
+     */
+    @JsonProperty("item_id")
+    private String itemId;
+
+    /**
+     * The index of the output item in the response's output array.
+     */
+    @JsonProperty("output_index")
+    private Integer outputIndex;
+
+    @Override
+    public String getType() {
+        return "response.mcp_call_arguments.delta";
+    }
+}