Class: OpenAI::Helpers::Streaming::ResponseStreamState

Inherits:
Object
  • Object
show all
Defined in:
lib/openai/helpers/streaming/response_stream.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(text_format:) ⇒ ResponseStreamState

Returns a new instance of ResponseStreamState.



79
80
81
82
83
 
# File 'lib/openai/helpers/streaming/response_stream.rb', line 79

def initialize(text_format:)
  @current_snapshot = nil
  @completed_response = nil
  @text_format = text_format
end

Instance Attribute Details

#completed_response ⇒ void (readonly)

Returns the value of attribute completed_response.



77
78
79
 
# File 'lib/openai/helpers/streaming/response_stream.rb', line 77

def completed_response
  @completed_response
end

Instance Method Details

#accumulate_event(event:, current_snapshot:) ⇒ void 



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/openai/helpers/streaming/response_stream.rb', line 158

def accumulate_event(event:, current_snapshot:)
  if current_snapshot.nil?
    unless event.is_a?(OpenAI::Models::Responses::ResponseCreatedEvent)
      raise "Expected first event to be response.created"
    end

    # Use the converter to create a new, isolated copy of the response object.
    # This ensures proper type validation and prevents shared object references.
    return OpenAI::Internal::Type::Converter.coerce(
      OpenAI::Models::Responses::Response,
      event.response
    )
  end

  case event
  when OpenAI::Models::Responses::ResponseOutputItemAddedEvent
    current_snapshot.output.push(event.item)

  when OpenAI::Models::Responses::ResponseContentPartAddedEvent
    output = current_snapshot.output[event.output_index]
    if output && output.type == :message
      output.content.push(event.part)
      current_snapshot.output[event.output_index] = output
    end

  when OpenAI::Models::Responses::ResponseTextDeltaEvent
    output = current_snapshot.output[event.output_index]
    if output && output.type == :message
      content = output.content[event.content_index]
      if content && content.type == :output_text
        content.text += event.delta
        output.content[event.content_index] = content
        current_snapshot.output[event.output_index] = output
      end
    end

  when OpenAI::Models::Responses::ResponseFunctionCallArgumentsDeltaEvent
    output = current_snapshot.output[event.output_index]
    if output && output.type == :function_call
      output.arguments = (output.arguments || "") + event.delta
      current_snapshot.output[event.output_index] = output
    end

  when OpenAI::Models::Responses::ResponseCompletedEvent
    @completed_response = event.response
  end

  current_snapshot
end

#handle_event(event) ⇒ void 



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/openai/helpers/streaming/response_stream.rb', line 85

def handle_event(event)
  @current_snapshot = accumulate_event(
    event: event,
    current_snapshot: @current_snapshot
  )

  events_to_yield = []

  case event
  when OpenAI::Models::Responses::ResponseTextDeltaEvent
    output = @current_snapshot.output[event.output_index]
    assert_type(output, :message)

    content = output.content[event.content_index]
    assert_type(content, :output_text)

    events_to_yield << OpenAI::Streaming::ResponseTextDeltaEvent.new(
      content_index: event.content_index,
      delta: event.delta,
      item_id: event.item_id,
      output_index: event.output_index,
      sequence_number: event.sequence_number,
      type: event.type,
      snapshot: content.text
    )

  when OpenAI::Models::Responses::ResponseTextDoneEvent
    output = @current_snapshot.output[event.output_index]
    assert_type(output, :message)

    content = output.content[event.content_index]
    assert_type(content, :output_text)

    parsed = parse_structured_text(content.text)

    events_to_yield << OpenAI::Streaming::ResponseTextDoneEvent.new(
      content_index: event.content_index,
      item_id: event.item_id,
      output_index: event.output_index,
      sequence_number: event.sequence_number,
      text: event.text,
      type: event.type,
      parsed: parsed
    )

  when OpenAI::Models::Responses::ResponseFunctionCallArgumentsDeltaEvent
    output = @current_snapshot.output[event.output_index]
    assert_type(output, :function_call)

    events_to_yield << OpenAI::Streaming::ResponseFunctionCallArgumentsDeltaEvent.new(
      delta: event.delta,
      item_id: event.item_id,
      output_index: event.output_index,
      sequence_number: event.sequence_number,
      type: event.type,
      snapshot: output.arguments
    )

  when OpenAI::Models::Responses::ResponseCompletedEvent
    events_to_yield << OpenAI::Streaming::ResponseCompletedEvent.new(
      sequence_number: event.sequence_number,
      type: event.type,
      response: event.response
    )

  else
    # Pass through other events unchanged.
    events_to_yield << event
  end

  events_to_yield
end