Struct ResponsesToolDefinition 

pub struct ResponsesToolDefinition {
    pub kind: String,
    pub name: String,
    pub parameters: Value,
    pub strict: bool,
    pub description: String,
    pub config: Map<String, Value>,
}

The definition of a tool response, repurposed for OpenAI’s Responses API.

Fields

kind: String

The type of tool.

name: String

Tool name

parameters: Value

Parameters - this should be a JSON schema. Strict function tools must use OpenAI’s supported strict schema subset.

strict: bool

Whether to use strict mode. Disabled by default; opt in with Self::with_strict or [GenericResponsesCompletionModel::with_strict_tools].

description: String

Tool description.

config: Map<String, Value>

Additional provider-specific configuration for hosted tools.

Implementations

impl ResponsesToolDefinition

pub fn function( name: impl Into<String>, description: impl Into<String>, parameters: Value, ) -> ResponsesToolDefinition

Creates a function tool definition with strict mode disabled.

pub fn strict_function( name: impl Into<String>, description: impl Into<String>, parameters: Value, ) -> ResponsesToolDefinition

Creates a strict function tool definition.

The schema is sanitized to OpenAI’s strict subset (additionalProperties: false added and every property forced into required).

pub fn with_strict(self) -> ResponsesToolDefinition

Enables strict mode for this function tool.

Function schemas are sanitized to OpenAI’s strict subset. Hosted tools are returned unchanged because strict mode only applies to function tools.

pub fn hosted(kind: impl Into<String>) -> ResponsesToolDefinition

Creates a hosted tool definition for an arbitrary hosted tool type.

pub fn web_search() -> ResponsesToolDefinition

Creates a hosted web_search tool definition.

pub fn file_search() -> ResponsesToolDefinition

Creates a hosted file_search tool definition.

pub fn computer_use() -> ResponsesToolDefinition

Creates a hosted computer_use tool definition.

pub fn with_config( self, key: impl Into<String>, value: Value, ) -> ResponsesToolDefinition

Adds hosted-tool configuration fields.

Trait Implementations

impl Clone for ResponsesToolDefinition

fn clone(&self) -> ResponsesToolDefinition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ResponsesToolDefinition

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ResponsesToolDefinition

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ToolDefinition> for ResponsesToolDefinition

fn from(value: ToolDefinition) -> ResponsesToolDefinition

Converts to this type from the input type.

impl PartialEq for ResponsesToolDefinition

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ResponsesToolDefinition

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ResponsesToolDefinition