Struct ThreadStartParams 

pub struct ThreadStartParams {

    pub model: Option<String>,
    pub model_provider: Option<String>,
    pub allow_provider_model_fallback: bool,
    pub service_tier: Option<Option<String>>,
    pub cwd: Option<String>,
    pub runtime_workspace_roots: Option<Vec<AbsolutePathBuf>>,
    pub approval_policy: Option<AskForApproval>,
    pub approvals_reviewer: Option<ApprovalsReviewer>,
    pub sandbox: Option<SandboxMode>,
    pub permissions: Option<String>,
    pub config: Option<HashMap<String, Value>>,
    pub service_name: Option<String>,
    pub base_instructions: Option<String>,
    pub developer_instructions: Option<String>,
    pub personality: Option<Personality>,
    pub multi_agent_mode: Option<MultiAgentMode>,
    pub ephemeral: Option<bool>,
    pub history_mode: Option<ThreadHistoryMode>,
    pub session_start_source: Option<ThreadStartSource>,
    pub thread_source: Option<ThreadSource>,
    pub environments: Option<Vec<TurnEnvironmentParams>>,
    pub dynamic_tools: Option<Vec<DynamicToolSpec>>,
    pub selected_capability_roots: Option<Vec<SelectedCapabilityRoot>>,
    pub mock_experimental_field: Option<String>,
    pub experimental_raw_events: bool,
}

Fields

model: Option<String>

model_provider: Option<String>

allow_provider_model_fallback: bool

Allow a provider with an authoritative static model catalog to replace an unavailable requested model with its default.

service_tier: Option<Option<String>>

cwd: Option<String>

runtime_workspace_roots: Option<Vec<AbsolutePathBuf>>

Replace the thread’s runtime workspace roots. Paths must be absolute.

approval_policy: Option<AskForApproval>

approvals_reviewer: Option<ApprovalsReviewer>

Override where approval requests are routed for review on this thread and subsequent turns.

sandbox: Option<SandboxMode>

permissions: Option<String>

Named profile id for this thread. Cannot be combined with sandbox.

config: Option<HashMap<String, Value>>

service_name: Option<String>

base_instructions: Option<String>

developer_instructions: Option<String>

personality: Option<Personality>

multi_agent_mode: Option<MultiAgentMode>

@deprecated Ignored. Use Ultra reasoning effort for proactive multi-agent behavior.

ephemeral: Option<bool>

history_mode: Option<ThreadHistoryMode>

Persisted thread history contract to use for this new thread.

session_start_source: Option<ThreadStartSource>

thread_source: Option<ThreadSource>

Optional client-supplied analytics source classification for this thread.

environments: Option<Vec<TurnEnvironmentParams>>

Optional sticky environments for this thread.

Omitted selects the default environment when environment access is enabled. Empty disables environment access for turns that do not provide a turn override. Non-empty selects the first environment as the current turn environment.

dynamic_tools: Option<Vec<DynamicToolSpec>>

selected_capability_roots: Option<Vec<SelectedCapabilityRoot>>

Capability roots selected for this thread by the hosting platform.

mock_experimental_field: Option<String>

Test-only experimental field used to validate experimental gating and schema filtering behavior in a stable way.

experimental_raw_events: bool

If true, opt into emitting raw Responses API items on the event stream. This is for internal use only (e.g. Codex Cloud).

Trait Implementations

impl Clone for ThreadStartParams

fn clone(&self) -> ThreadStartParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ThreadStartParams

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

Formats the value using the given formatter.

impl Default for ThreadStartParams

fn default() -> ThreadStartParams

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ThreadStartParams

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl ExperimentalApi for ThreadStartParams

fn experimental_reason(&self) -> Option<&'static str>

Returns a short reason identifier when an experimental method or field is used, or None when the value is entirely stable.

impl JsonSchema for ThreadStartParams

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 ThreadStartParams

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ThreadStartParams

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 ThreadStartParams

impl TS for ThreadStartParams

type WithoutGenerics = ThreadStartParams

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 = ThreadStartParams

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 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 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 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.