chat_completion_to_response_converter

Code from OpenAI Agents library src/agents/models/openai_chatcompletions.py

Used to convert the OpenAI ChatCompletion stream to Response API format

FAKE_RESPONSES_ID = 'fake_responses_id'

From the OpenAI Agents library This is a placeholder ID used to fill in the id field in Responses API related objects. It’s useful when you’re creating Responses objects from non-Responses APIs, e.g. the OpenAI Chat Completions API or other LLM providers.

class StreamingState(started: 'bool' = False, text_content_index_and_output: 'tuple[int, ResponseOutputText] | None' = None, refusal_content_index_and_output: 'tuple[int, ResponseOutputRefusal] | None' = None, function_calls: 'dict[int, ResponseFunctionToolCall]' = <factory>)

Bases: object

started: bool = False

text_content_index_and_output: tuple[int, ResponseOutputText] | None = None

refusal_content_index_and_output: tuple[int, ResponseOutputRefusal] | None = None

function_calls: dict[int, ResponseFunctionToolCall]

class SequenceNumber

Bases: object

get_and_increment() → int

class ChatCompletionToResponseConverter

Bases: object

Converts OpenAI ChatCompletion streams to standardized Response API format events.

classmethod async_handle_stream(response: Response, stream: AsyncStream[ChatCompletionChunk]) → AsyncIterator[Annotated[ResponseAudioDeltaEvent | ResponseAudioDoneEvent | ResponseAudioTranscriptDeltaEvent | ResponseAudioTranscriptDoneEvent | ResponseCodeInterpreterCallCodeDeltaEvent | ResponseCodeInterpreterCallCodeDoneEvent | ResponseCodeInterpreterCallCompletedEvent | ResponseCodeInterpreterCallInProgressEvent | ResponseCodeInterpreterCallInterpretingEvent | ResponseCompletedEvent | ResponseContentPartAddedEvent | ResponseContentPartDoneEvent | ResponseCreatedEvent | ResponseErrorEvent | ResponseFileSearchCallCompletedEvent | ResponseFileSearchCallInProgressEvent | ResponseFileSearchCallSearchingEvent | ResponseFunctionCallArgumentsDeltaEvent | ResponseFunctionCallArgumentsDoneEvent | ResponseInProgressEvent | ResponseFailedEvent | ResponseIncompleteEvent | ResponseOutputItemAddedEvent | ResponseOutputItemDoneEvent | ResponseReasoningSummaryPartAddedEvent | ResponseReasoningSummaryPartDoneEvent | ResponseReasoningSummaryTextDeltaEvent | ResponseReasoningSummaryTextDoneEvent | ResponseRefusalDeltaEvent | ResponseRefusalDoneEvent | ResponseTextDeltaEvent | ResponseTextDoneEvent | ResponseWebSearchCallCompletedEvent | ResponseWebSearchCallInProgressEvent | ResponseWebSearchCallSearchingEvent | ResponseImageGenCallCompletedEvent | ResponseImageGenCallGeneratingEvent | ResponseImageGenCallInProgressEvent | ResponseImageGenCallPartialImageEvent | ResponseMcpCallArgumentsDeltaEvent | ResponseMcpCallArgumentsDoneEvent | ResponseMcpCallCompletedEvent | ResponseMcpCallFailedEvent | ResponseMcpCallInProgressEvent | ResponseMcpListToolsCompletedEvent | ResponseMcpListToolsFailedEvent | ResponseMcpListToolsInProgressEvent | ResponseOutputTextAnnotationAddedEvent | ResponseQueuedEvent | ResponseReasoningSummaryDeltaEvent | ResponseReasoningSummaryDoneEvent, PropertyInfo(alias='None', format=None, format_template='None', discriminator='type')]]

classmethod sync_handle_stream(response: Response, stream: Stream[ChatCompletionChunk]) → Iterator[Annotated[ResponseAudioDeltaEvent | ResponseAudioDoneEvent | ResponseAudioTranscriptDeltaEvent | ResponseAudioTranscriptDoneEvent | ResponseCodeInterpreterCallCodeDeltaEvent | ResponseCodeInterpreterCallCodeDoneEvent | ResponseCodeInterpreterCallCompletedEvent | ResponseCodeInterpreterCallInProgressEvent | ResponseCodeInterpreterCallInterpretingEvent | ResponseCompletedEvent | ResponseContentPartAddedEvent | ResponseContentPartDoneEvent | ResponseCreatedEvent | ResponseErrorEvent | ResponseFileSearchCallCompletedEvent | ResponseFileSearchCallInProgressEvent | ResponseFileSearchCallSearchingEvent | ResponseFunctionCallArgumentsDeltaEvent | ResponseFunctionCallArgumentsDoneEvent | ResponseInProgressEvent | ResponseFailedEvent | ResponseIncompleteEvent | ResponseOutputItemAddedEvent | ResponseOutputItemDoneEvent | ResponseReasoningSummaryPartAddedEvent | ResponseReasoningSummaryPartDoneEvent | ResponseReasoningSummaryTextDeltaEvent | ResponseReasoningSummaryTextDoneEvent | ResponseRefusalDeltaEvent | ResponseRefusalDoneEvent | ResponseTextDeltaEvent | ResponseTextDoneEvent | ResponseWebSearchCallCompletedEvent | ResponseWebSearchCallInProgressEvent | ResponseWebSearchCallSearchingEvent | ResponseImageGenCallCompletedEvent | ResponseImageGenCallGeneratingEvent | ResponseImageGenCallInProgressEvent | ResponseImageGenCallPartialImageEvent | ResponseMcpCallArgumentsDeltaEvent | ResponseMcpCallArgumentsDoneEvent | ResponseMcpCallCompletedEvent | ResponseMcpCallFailedEvent | ResponseMcpCallInProgressEvent | ResponseMcpListToolsCompletedEvent | ResponseMcpListToolsFailedEvent | ResponseMcpListToolsInProgressEvent | ResponseOutputTextAnnotationAddedEvent | ResponseQueuedEvent | ResponseReasoningSummaryDeltaEvent | ResponseReasoningSummaryDoneEvent, PropertyInfo(alias='None', format=None, format_template='None', discriminator='type')]]

classmethod get_chat_completion_content(completion: ChatCompletion) → str

Retrieve the final text from the ChatCompletion object by taking the content of the first choice