Skip to main content

OutputItem

async_openai::types::responses

Enum OutputItem

pub enum OutputItem {
Show 23 variants
    Message(OutputMessage),
    FileSearchCall(FileSearchToolCall),
    FunctionCall(FunctionToolCall),
    FunctionCallOutput(FunctionToolCallOutputResource),
    WebSearchCall(WebSearchToolCall),
    ComputerCall(ComputerToolCall),
    ComputerCallOutput(ComputerToolCallOutputResource),
    Reasoning(ReasoningItem),
    Compaction(CompactionBody),
    ImageGenerationCall(ImageGenToolCall),
    CodeInterpreterCall(CodeInterpreterToolCall),
    LocalShellCall(LocalShellToolCall),
    ShellCall(FunctionShellCall),
    ShellCallOutput(FunctionShellCallOutput),
    ApplyPatchCall(ApplyPatchToolCall),
    ApplyPatchCallOutput(ApplyPatchToolCallOutput),
    McpCall(MCPToolCall),
    McpListTools(MCPListTools),
    McpApprovalRequest(MCPApprovalRequest),
    CustomToolCall(CustomToolCall),
    CustomToolCallOutput(CustomToolCallOutputResource),
    ToolSearchCall(ToolSearchCall),
    ToolSearchOutput(ToolSearchOutput),
}

Available on crate feature response-types only.

Expand description

Output item

Variants§

Message(OutputMessage)

An output message from the model.

FileSearchCall(FileSearchToolCall)

The results of a file search tool call. See the file search guide for more information.

FunctionCall(FunctionToolCall)

A tool call to run a function. See the function calling guide for more information.

FunctionCallOutput(FunctionToolCallOutputResource)

The output of a function tool call.

WebSearchCall(WebSearchToolCall)

The results of a web search tool call. See the web search guide for more information.

ComputerCall(ComputerToolCall)

A tool call to a computer use tool. See the computer use guide for more information.

ComputerCallOutput(ComputerToolCallOutputResource)

The output of a computer tool call.

Reasoning(ReasoningItem)

A description of the chain of thought used by a reasoning model while generating a response. Be sure to include these items in your input to the Responses API for subsequent turns of a conversation if you are manually managing context.

Compaction(CompactionBody)

A compaction item generated by the v1/responses/compact API.

ImageGenerationCall(ImageGenToolCall)

An image generation request made by the model.

CodeInterpreterCall(CodeInterpreterToolCall)

A tool call to run code.

LocalShellCall(LocalShellToolCall)

A tool call to run a command on the local shell.

ShellCall(FunctionShellCall)

A tool call that executes one or more shell commands in a managed environment.

ShellCallOutput(FunctionShellCallOutput)

The output of a shell tool call.

ApplyPatchCall(ApplyPatchToolCall)

A tool call that applies file diffs by creating, deleting, or updating files.

ApplyPatchCallOutput(ApplyPatchToolCallOutput)

The output emitted by an apply patch tool call.

McpCall(MCPToolCall)

An invocation of a tool on an MCP server.

McpListTools(MCPListTools)

A list of tools available on an MCP server.

McpApprovalRequest(MCPApprovalRequest)

A request for human approval of a tool invocation.

CustomToolCall(CustomToolCall)

A call to a custom tool created by the model.

CustomToolCallOutput(CustomToolCallOutputResource)

The output of a custom tool call.

ToolSearchCall(ToolSearchCall)

A tool search call.

ToolSearchOutput(ToolSearchOutput)

A tool search output.

Trait Implementations§

impl Clone for OutputItem

fn clone(&self) -> OutputItem

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

impl Debug for OutputItem

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for OutputItem

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

Deserialize this value from the given Serde deserializer. Read more

impl From<OutputItem> for InputItem

fn from(item: OutputItem) -> Self

Converts to this type from the input type.

impl From<OutputItem> for Item

fn from(item: OutputItem) -> Self

Converts to this type from the input type.

impl PartialEq for OutputItem

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

Tests for self and other values to be equal, and is used by ==.

1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for OutputItem

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

Serialize this value into the given Serde serializer. Read more

impl StructuralPartialEq for OutputItem

Auto Trait Implementations§

impl Freeze for OutputItem

impl RefUnwindSafe for OutputItem

impl Send for OutputItem

impl Sync for OutputItem

impl Unpin for OutputItem

impl UnsafeUnpin for OutputItem

impl UnwindSafe for OutputItem

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

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

fn into(self) -> U

Calls U::from(self).

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

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

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more

impl<T> Same for T

type Output = T

Should always be Self

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

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

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

impl<T> MiddlewareInput for T
where T: Send + Sync + 'static,