Skip to main content

ThreadSettingsUpdateParams

Struct ThreadSettingsUpdateParams 

Source
pub struct ThreadSettingsUpdateParams {
Show 13 fields pub approval_policy: Option<AskForApproval>, pub approvals_reviewer: Option<ApprovalsReviewer>, pub collaboration_mode: Option<CollaborationMode>, pub cwd: Option<String>, pub effort: Option<ReasoningEffort>, pub model: Option<String>, pub multi_agent_mode: Option<MultiAgentMode>, pub permissions: Option<String>, pub personality: Option<Personality>, pub sandbox_policy: Option<SandboxPolicy>, pub service_tier: Option<String>, pub summary: Option<ReasoningSummary>, pub thread_id: String,
}
Expand description

ThreadSettingsUpdateParams

JSON schema
{
 "title": "ThreadSettingsUpdateParams",
 "type": "object",
 "required": [
   "threadId"
 ],
 "properties": {
   "approvalPolicy": {
     "description": "Override the approval policy for subsequent turns.",
     "anyOf": [
       {
         "$ref": "#/definitions/AskForApproval"
       },
       {
         "type": "null"
       }
     ]
   },
   "approvalsReviewer": {
     "description": "Override where approval requests are routed for subsequent turns.",
     "anyOf": [
       {
         "$ref": "#/definitions/ApprovalsReviewer"
       },
       {
         "type": "null"
       }
     ]
   },
   "collaborationMode": {
     "description": "EXPERIMENTAL - Set a pre-set collaboration mode for subsequent turns.\n\nFor `collaboration_mode.settings.developer_instructions`, `null` means \"use the built-in instructions for the selected mode\".",
     "anyOf": [
       {
         "$ref": "#/definitions/CollaborationMode"
       },
       {
         "type": "null"
       }
     ]
   },
   "cwd": {
     "description": "Override the working directory for subsequent turns.",
     "type": [
       "string",
       "null"
     ]
   },
   "effort": {
     "description": "Override the reasoning effort for subsequent turns.",
     "anyOf": [
       {
         "$ref": "#/definitions/ReasoningEffort"
       },
       {
         "type": "null"
       }
     ]
   },
   "model": {
     "description": "Override the model for subsequent turns.",
     "type": [
       "string",
       "null"
     ]
   },
   "multiAgentMode": {
     "description": "@deprecated Ignored. Use `effort: \"ultra\"` for proactive multi-agent behavior.",
     "anyOf": [
       {
         "$ref": "#/definitions/MultiAgentMode"
       },
       {
         "type": "null"
       }
     ]
   },
   "permissions": {
     "description": "Select a named permissions profile id for subsequent turns. Cannot be combined with `sandboxPolicy`.",
     "type": [
       "string",
       "null"
     ]
   },
   "personality": {
     "description": "Override the personality for subsequent turns.",
     "anyOf": [
       {
         "$ref": "#/definitions/Personality"
       },
       {
         "type": "null"
       }
     ]
   },
   "sandboxPolicy": {
     "description": "Override the sandbox policy for subsequent turns.",
     "anyOf": [
       {
         "$ref": "#/definitions/SandboxPolicy"
       },
       {
         "type": "null"
       }
     ]
   },
   "serviceTier": {
     "description": "Override the service tier for subsequent turns. `null` clears the current service tier; omission leaves it unchanged.",
     "type": [
       "string",
       "null"
     ]
   },
   "summary": {
     "description": "Override the reasoning summary for subsequent turns.",
     "anyOf": [
       {
         "$ref": "#/definitions/ReasoningSummary"
       },
       {
         "type": "null"
       }
     ]
   },
   "threadId": {
     "type": "string"
   }
 },
 "$schema": "http://json-schema.org/draft-07/schema#"
}

Fields§

§approval_policy: Option<AskForApproval>

Override the approval policy for subsequent turns.

§approvals_reviewer: Option<ApprovalsReviewer>

Override where approval requests are routed for subsequent turns.

§collaboration_mode: Option<CollaborationMode>

EXPERIMENTAL - Set a pre-set collaboration mode for subsequent turns.

For collaboration_mode.settings.developer_instructions, null means “use the built-in instructions for the selected mode”.

§cwd: Option<String>

Override the working directory for subsequent turns.

§effort: Option<ReasoningEffort>

Override the reasoning effort for subsequent turns.

§model: Option<String>

Override the model for subsequent turns.

§multi_agent_mode: Option<MultiAgentMode>

@deprecated Ignored. Use effort: "ultra" for proactive multi-agent behavior.

§permissions: Option<String>

Select a named permissions profile id for subsequent turns. Cannot be combined with sandboxPolicy.

§personality: Option<Personality>

Override the personality for subsequent turns.

§sandbox_policy: Option<SandboxPolicy>

Override the sandbox policy for subsequent turns.

§service_tier: Option<String>

Override the service tier for subsequent turns. null clears the current service tier; omission leaves it unchanged.

§summary: Option<ReasoningSummary>

Override the reasoning summary for subsequent turns.

§thread_id: String

Trait Implementations§

Source§

impl Clone for ThreadSettingsUpdateParams

Source§

fn clone(&self) -> ThreadSettingsUpdateParams

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ThreadSettingsUpdateParams

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for ThreadSettingsUpdateParams

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for ThreadSettingsUpdateParams

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FromRef<T> for T
where T: Clone,

§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,