Struct CodexToolCallParam 

pub struct CodexToolCallParam {
    pub prompt: String,
    pub model: Option<String>,
    pub profile: Option<String>,
    pub cwd: Option<String>,
    pub approval_policy: Option<CodexToolCallApprovalPolicy>,
    pub sandbox: Option<CodexToolCallSandboxMode>,
    pub config: Option<HashMap<String, Value>>,
    pub base_instructions: Option<String>,
    pub include_plan_tool: Option<bool>,
}

Client-supplied configuration for a codex tool-call.

Fields

prompt: String

The initial user prompt to start the Codex conversation.

model: Option<String>

Optional override for the model name (e.g. “o3”, “o4-mini”).

profile: Option<String>

Configuration profile from config.toml to specify default options.

cwd: Option<String>

Working directory for the session. If relative, it is resolved against the server process’s current working directory.

approval_policy: Option<CodexToolCallApprovalPolicy>

Approval policy for shell commands generated by the model: untrusted, on-failure, on-request, never.

sandbox: Option<CodexToolCallSandboxMode>

Sandbox mode: read-only, workspace-write, or danger-full-access.

config: Option<HashMap<String, Value>>

Individual config settings that will override what is in CODEX_HOME/config.toml.

base_instructions: Option<String>

The set of instructions to use instead of the default ones.

include_plan_tool: Option<bool>

Whether to include the plan tool in the conversation.

Implementations

impl CodexToolCallParam

pub fn into_config( self, codex_linux_sandbox_exe: Option<PathBuf>, ) -> Result<(String, Config)>

Returns the initial user prompt to start the Codex conversation and the effective Config object generated from the supplied parameters.

Trait Implementations

impl Clone for CodexToolCallParam

fn clone(&self) -> CodexToolCallParam

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CodexToolCallParam

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

Formats the value using the given formatter.

impl Default for CodexToolCallParam

fn default() -> CodexToolCallParam

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CodexToolCallParam

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for CodexToolCallParam

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

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 inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for CodexToolCallParam

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

where __S: Serializer,

Serialize this value into the given Serde serializer.