Struct ThreadRealtimeStartParams 

pub struct ThreadRealtimeStartParams {

    pub thread_id: String,
    pub client_managed_handoffs: Option<bool>,
    pub flush_transcript_tail_on_session_end: Option<bool>,
    pub codex_responses_as_items: Option<bool>,
    pub codex_response_item_prefix: Option<String>,
    pub codex_response_handoff_mode: Option<CodexResponseHandoffMode>,
    pub model: Option<String>,
    pub output_modality: RealtimeOutputModality,
    pub include_startup_context: Option<bool>,
    pub initial_items: Option<Vec<ThreadRealtimeInitialItem>>,
    pub prompt: Option<Option<String>>,
    pub realtime_session_id: Option<String>,
    pub transport: Option<ThreadRealtimeStartTransport>,
    pub version: Option<RealtimeConversationVersion>,
    pub voice: Option<RealtimeVoice>,
}

EXPERIMENTAL - start a thread-scoped realtime session.

Fields

thread_id: String

client_managed_handoffs: Option<bool>

Leaves Codex response handoffs to the client’s explicit append calls instead of forwarding them automatically. Defaults to false.

flush_transcript_tail_on_session_end: Option<bool>

Routes any transcript tail remaining at session end through Codex. Defaults to false. TODO: Remove this rollout knob once transcript-tail flushing is always enabled.

codex_responses_as_items: Option<bool>

Sends automatic Codex responses as realtime conversation items instead of handoff appends.

codex_response_item_prefix: Option<String>

Optional prefix added to automatic Codex response items when codexResponsesAsItems is true.

codex_response_handoff_mode: Option<CodexResponseHandoffMode>

Selects how automatic Codex responses are routed in Frameless Bidi sessions. Omitted values default to thinking. Realtime V1 and V2 ignore this setting.

model: Option<String>

Overrides the configured realtime model for this session only.

output_modality: RealtimeOutputModality

Selects text or audio output for the realtime session. Transport and voice stay independent so clients can choose how they connect separately from what the model emits.

include_startup_context: Option<bool>

Set to false to start without Codex’s startup context. Omitted or null includes it.

initial_items: Option<Vec<ThreadRealtimeInitialItem>>

Adds complete role-bearing text items to the initial Frameless Bidi session history. This is only supported by realtime V3 and is sent during session startup. Requests are limited to 128 items and 8,192 estimated text tokens in total.

prompt: Option<Option<String>>

realtime_session_id: Option<String>

transport: Option<ThreadRealtimeStartTransport>

version: Option<RealtimeConversationVersion>

Overrides the configured realtime protocol version for this session only.

voice: Option<RealtimeVoice>

Trait Implementations

impl Clone for ThreadRealtimeStartParams

fn clone(&self) -> ThreadRealtimeStartParams

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ThreadRealtimeStartParams

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ThreadRealtimeStartParams

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for ThreadRealtimeStartParams

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for ThreadRealtimeStartParams

fn eq(&self, other: &ThreadRealtimeStartParams) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for ThreadRealtimeStartParams

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ThreadRealtimeStartParams

impl TS for ThreadRealtimeStartParams

type WithoutGenerics = ThreadRealtimeStartParams

If this type does not have generic parameters, then WithoutGenerics should just be Self. If the type does have generic parameters, then all generic parameters must be replaced with a dummy type, e.g ts_rs::Dummy or (). The only requirement for these dummy types is that EXPORT_TO must be None.

type OptionInnerType = ThreadRealtimeStartParams

If the implementing type is std::option::Option<T>, then this associated type is set to T. All other implementations of TS should set this type to Self instead.

fn ident() -> String

Identifier of this type, excluding generic parameters.

fn docs() -> Option<String>

JSDoc comment to describe this type in TypeScript - when TS is derived, docs are automatically read from your doc comments or #[doc = ".."] attributes

fn name() -> String

Name of this type in TypeScript, including generic parameters

fn decl_concrete() -> String

Declaration of this type using the supplied generic arguments. The resulting TypeScript definition will not be generic. For that, see TS::decl(). If this type is not generic, then this function is equivalent to TS::decl().

fn decl() -> String

Declaration of this type, e.g. type User = { user_id: number, ... }. This function will panic if the type has no declaration.

fn inline() -> String

Formats this types definition in TypeScript, e.g { user_id: number }. This function will panic if the type cannot be inlined.

fn inline_flattened() -> String

Flatten a type declaration.
This function will panic if the type cannot be flattened.

fn visit_generics(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all type parameters of this type.

fn output_path() -> Option<PathBuf>

Returns the output path to where T should be exported.
The returned path does not include the base directory from TS_RS_EXPORT_DIR.

fn visit_dependencies(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all dependency of this type.

fn dependencies() -> Vec<Dependency>

where Self: 'static,

Resolves all dependencies of this type recursively.

fn export() -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem. To export this type together with all of its dependencies, use TS::export_all.

fn export_all() -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem, together with all of its dependencies.
To export only this type, without its dependencies, use TS::export.

fn export_all_to(out_dir: impl AsRef<Path>) -> Result<(), ExportError>

where Self: 'static,

Manually export this type into the given directory, together with all of its dependencies.
To export only this type, without its dependencies, use TS::export.

fn export_to_string() -> Result<String, ExportError>

where Self: 'static,

Manually generate bindings for this type, returning a String.
This function does not format the output, even if the format feature is enabled.

fn default_output_path() -> Option<PathBuf>

Returns the output path to where T should be exported.