Tool

async_openai_compat::types::responses

Enum Tool

pub enum Tool {
    Function(FunctionTool),
    FileSearch(FileSearchTool),
    ComputerUsePreview(ComputerUsePreviewTool),
    WebSearch(WebSearchTool),
    WebSearch20250826(WebSearchTool),
    Mcp(MCPTool),
    CodeInterpreter(CodeInterpreterTool),
    ImageGeneration(ImageGenTool),
    LocalShell,
    Custom(CustomToolParam),
    WebSearchPreview(WebSearchTool),
    WebSearchPreview20250311(WebSearchTool),
}

Expand description

Definitions for model-callable tools.

Variants§

Function(FunctionTool)

Defines a function in your own code the model can choose to call. Learn more about function calling.

FileSearch(FileSearchTool)

A tool that searches for relevant content from uploaded files. Learn more about the file search tool.

ComputerUsePreview(ComputerUsePreviewTool)

A tool that controls a virtual computer. Learn more about the computer use tool.

WebSearch(WebSearchTool)

Search the Internet for sources related to the prompt. Learn more about the web search tool.

WebSearch20250826(WebSearchTool)

type: web_search_2025_08_26

Mcp(MCPTool)

Give the model access to additional tools via remote Model Context Protocol (MCP) servers. Learn more about MCP.

CodeInterpreter(CodeInterpreterTool)

A tool that runs Python code to help generate a response to a prompt.

ImageGeneration(ImageGenTool)

A tool that generates images using a model like gpt-image-1.

LocalShell

A tool that allows the model to execute shell commands in a local environment.

Custom(CustomToolParam)

A custom tool that processes input using a specified format. Learn more about custom tools

WebSearchPreview(WebSearchTool)

This tool searches the web for relevant results to use in a response. Learn more about the web search tool.

WebSearchPreview20250311(WebSearchTool)

type: web_search_preview_2025_03_11

Trait Implementations§

impl Clone for Tool

fn clone(&self) -> Tool

Returns a duplicate of the value. Read more

1.0.0§

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

Performs copy-assignment from source. Read more

impl Debug for Tool

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for Tool

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

Deserialize this value from the given Serde deserializer. Read more

impl PartialEq for Tool

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

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

1.0.0§

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 Tool

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 Tool

Auto Trait Implementations§

impl Freeze for Tool

impl RefUnwindSafe for Tool

impl Send for Tool

impl Sync for Tool

impl Unpin for Tool

impl UnwindSafe for Tool

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