open_ai_realtime_adapter

OpenAI Realtime LLM adapter for Pipecat.

class pipecat.adapters.services.open_ai_realtime_adapter.OpenAIRealtimeLLMInvocationParams

Bases: TypedDict

Context-based parameters for invoking OpenAI Realtime API.

This is a placeholder until support for universal LLMContext machinery is added for OpenAI Realtime.

system_instruction: str | None

messages: list[ConversationItem]

tools: list[dict[str, Any]]

class pipecat.adapters.services.open_ai_realtime_adapter.OpenAIRealtimeLLMAdapter

Bases: BaseLLMAdapter

LLM adapter for OpenAI Realtime API function calling.

Converts Pipecat’s tool schemas into the specific format required by OpenAI’s Realtime API for function calling capabilities.

property id_for_llm_specific_messages: str

Get the identifier used in LLMSpecificMessage instances for OpenAI Realtime.

get_llm_invocation_params(context: LLMContext, *, system_instruction: str | None = None) → OpenAIRealtimeLLMInvocationParams

Get OpenAI Realtime-specific LLM invocation parameters from a universal LLM context.

Parameters:

• context – The LLM context containing messages, tools, etc.

• system_instruction – Optional system instruction from service settings.

Returns:

Dictionary of parameters for invoking OpenAI Realtime’s API.

get_messages_for_logging(context) → list[dict[str, Any]]

Get messages from a universal LLM context in a format ready for logging about OpenAI Realtime.

Binary data (images, audio) is replaced with short placeholders.

This is a placeholder until support for universal LLMContext machinery is added for OpenAI Realtime.

Parameters:

context – The LLM context containing messages.

Returns:

List of messages in a format ready for logging about OpenAI Realtime.

class ConvertedMessages(messages: list[ConversationItem], system_instruction: str | None = None)

Bases: object

Container for OpenAI-formatted messages converted from universal context.

messages: list[ConversationItem]

system_instruction: str | None = None

to_provider_tools_format(tools_schema: ToolsSchema) → list[dict[str, Any]]

Convert tool schemas to OpenAI Realtime function-calling format.

Parameters:

tools_schema – The tools schema containing functions to convert.

Returns:

List of function definitions in OpenAI Realtime format.