Enum ResponseItem 

pub enum ResponseItem {
    AdditionalTools {
        id: Option<ResponseItemId>,
        role: String,
        tools: Vec<Value>,
    },
    Message {
        id: Option<ResponseItemId>,
        role: String,
        content: Vec<ContentItem>,
        phase: Option<MessagePhase>,
        internal_chat_message_metadata_passthrough: Option<InternalChatMessageMetadataPassthrough>,
    },
    AgentMessage {
        id: Option<ResponseItemId>,
        author: String,
        recipient: String,
        content: Vec<AgentMessageInputContent>,
        internal_chat_message_metadata_passthrough: Option<InternalChatMessageMetadataPassthrough>,
    },
    Reasoning {
        id: Option<ResponseItemId>,
        summary: Vec<ReasoningItemReasoningSummary>,
        content: Option<Vec<ReasoningItemContent>>,
        encrypted_content: Option<String>,
        internal_chat_message_metadata_passthrough: Option<InternalChatMessageMetadataPassthrough>,
    },
    LocalShellCall {
        id: Option<ResponseItemId>,
        call_id: Option<String>,
        status: LocalShellStatus,
        action: LocalShellAction,
        internal_chat_message_metadata_passthrough: Option<InternalChatMessageMetadataPassthrough>,
    },
    FunctionCall {
        id: Option<ResponseItemId>,
        name: String,
        namespace: Option<String>,
        arguments: String,
        call_id: String,
        internal_chat_message_metadata_passthrough: Option<InternalChatMessageMetadataPassthrough>,
    },
    ToolSearchCall {
        id: Option<ResponseItemId>,
        call_id: Option<String>,
        status: Option<String>,
        execution: String,
        arguments: Value,
        internal_chat_message_metadata_passthrough: Option<InternalChatMessageMetadataPassthrough>,
    },
    FunctionCallOutput {
        id: Option<ResponseItemId>,
        call_id: String,
        output: FunctionCallOutputPayload,
        internal_chat_message_metadata_passthrough: Option<InternalChatMessageMetadataPassthrough>,
    },
    CustomToolCall {
        id: Option<ResponseItemId>,
        status: Option<String>,
        call_id: String,
        name: String,
        namespace: Option<String>,
        input: String,
        internal_chat_message_metadata_passthrough: Option<InternalChatMessageMetadataPassthrough>,
    },
    CustomToolCallOutput {
        id: Option<ResponseItemId>,
        call_id: String,
        name: Option<String>,
        output: FunctionCallOutputPayload,
        internal_chat_message_metadata_passthrough: Option<InternalChatMessageMetadataPassthrough>,
    },
    ToolSearchOutput {
        id: Option<ResponseItemId>,
        call_id: Option<String>,
        status: String,
        execution: String,
        tools: Vec<Value>,
        internal_chat_message_metadata_passthrough: Option<InternalChatMessageMetadataPassthrough>,
    },
    WebSearchCall {
        id: Option<ResponseItemId>,
        status: Option<String>,
        action: Option<WebSearchAction>,
        internal_chat_message_metadata_passthrough: Option<InternalChatMessageMetadataPassthrough>,
    },
    ImageGenerationCall {
        id: Option<ResponseItemId>,
        status: String,
        revised_prompt: Option<String>,
        result: String,
        internal_chat_message_metadata_passthrough: Option<InternalChatMessageMetadataPassthrough>,
    },
    Compaction {
        id: Option<ResponseItemId>,
        encrypted_content: String,
        internal_chat_message_metadata_passthrough: Option<InternalChatMessageMetadataPassthrough>,
    },
    CompactionTrigger {},
    ContextCompaction {
        id: Option<ResponseItemId>,
        encrypted_content: Option<String>,
        internal_chat_message_metadata_passthrough: Option<InternalChatMessageMetadataPassthrough>,
    },
    Other,
}

Variants

AdditionalTools

Fields

id: Option<ResponseItemId>

role: String

tools: Vec<Value>

Message

Fields

id: Option<ResponseItemId>

role: String

content: Vec<ContentItem>

phase: Option<MessagePhase>

internal_chat_message_metadata_passthrough: Option<InternalChatMessageMetadataPassthrough>

AgentMessage

Fields

id: Option<ResponseItemId>

author: String

recipient: String

content: Vec<AgentMessageInputContent>

internal_chat_message_metadata_passthrough: Option<InternalChatMessageMetadataPassthrough>

Reasoning

Fields

id: Option<ResponseItemId>

summary: Vec<ReasoningItemReasoningSummary>

content: Option<Vec<ReasoningItemContent>>

encrypted_content: Option<String>

internal_chat_message_metadata_passthrough: Option<InternalChatMessageMetadataPassthrough>

LocalShellCall

Fields

id: Option<ResponseItemId>

Legacy id field retained for compatibility with older payloads.

call_id: Option<String>

Set when using the Responses API.

status: LocalShellStatus

action: LocalShellAction

internal_chat_message_metadata_passthrough: Option<InternalChatMessageMetadataPassthrough>

FunctionCall

Fields

id: Option<ResponseItemId>

name: String

namespace: Option<String>

arguments: String

call_id: String

internal_chat_message_metadata_passthrough: Option<InternalChatMessageMetadataPassthrough>

ToolSearchCall

Fields

id: Option<ResponseItemId>

call_id: Option<String>

status: Option<String>

execution: String

arguments: Value

internal_chat_message_metadata_passthrough: Option<InternalChatMessageMetadataPassthrough>

FunctionCallOutput

Fields

id: Option<ResponseItemId>

call_id: String

output: FunctionCallOutputPayload

internal_chat_message_metadata_passthrough: Option<InternalChatMessageMetadataPassthrough>

CustomToolCall

Fields

id: Option<ResponseItemId>

status: Option<String>

call_id: String

name: String

namespace: Option<String>

input: String

internal_chat_message_metadata_passthrough: Option<InternalChatMessageMetadataPassthrough>

CustomToolCallOutput

Fields

id: Option<ResponseItemId>

call_id: String

name: Option<String>

output: FunctionCallOutputPayload

internal_chat_message_metadata_passthrough: Option<InternalChatMessageMetadataPassthrough>

ToolSearchOutput

Fields

id: Option<ResponseItemId>

call_id: Option<String>

status: String

execution: String

tools: Vec<Value>

internal_chat_message_metadata_passthrough: Option<InternalChatMessageMetadataPassthrough>

WebSearchCall

Fields

id: Option<ResponseItemId>

status: Option<String>

action: Option<WebSearchAction>

internal_chat_message_metadata_passthrough: Option<InternalChatMessageMetadataPassthrough>

ImageGenerationCall

Fields

id: Option<ResponseItemId>

status: String

revised_prompt: Option<String>

result: String

internal_chat_message_metadata_passthrough: Option<InternalChatMessageMetadataPassthrough>

Compaction

Fields

id: Option<ResponseItemId>

encrypted_content: String

internal_chat_message_metadata_passthrough: Option<InternalChatMessageMetadataPassthrough>

CompactionTrigger

ContextCompaction

Fields

id: Option<ResponseItemId>

encrypted_content: Option<String>

internal_chat_message_metadata_passthrough: Option<InternalChatMessageMetadataPassthrough>

Other

Implementations

impl ResponseItem

pub fn is_user_message(&self) -> bool

Returns whether this item is an ordinary user-role message.

pub fn id(&self) -> Option<&ResponseItemId>

Returns the Responses API item ID, if present.

pub fn set_id(&mut self, new_id: Option<ResponseItemId>)

Sets or clears the Responses API item ID for variants that carry one.

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

Returns the Responses API item ID prefix for variants that carry an ID.

pub fn turn_id(&self) -> Option<&str>

Returns the non-empty turn ID stamped onto this item, if present.

pub fn set_turn_id_if_missing(&mut self, turn_id: &str)

Stamps the item with turn_id unless it already has a non-empty turn ID.

pub fn clear_internal_chat_message_metadata_passthrough(&mut self)

Removes internal chat message metadata passthrough before sending to a provider that does not accept it.

Trait Implementations

impl Clone for ResponseItem

fn clone(&self) -> ResponseItem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ResponseItem

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ResponseItem

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<CompactedItem> for ResponseItem

fn from(value: CompactedItem) -> Self

Converts to this type from the input type.

impl From<ResponseInputItem> for ResponseItem

fn from(item: ResponseInputItem) -> Self

Converts to this type from the input type.

impl JsonSchema for ResponseItem

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 ResponseItem

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ResponseItem

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 ResponseItem

impl TS for ResponseItem

type WithoutGenerics = ResponseItem

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

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.