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. Tools should additionally ensure an “additionalParameters” field has been added with the value set to false, as this is required if using OpenAI’s strict mode (enabled by default).

strict: bool

Whether to use strict mode. Enabled by default as it allows for improved efficiency.

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

Creates a function tool definition.

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

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

pub fn web_search() -> Self

Creates a hosted web_search tool definition.

pub fn file_search() -> Self

Creates a hosted file_search tool definition.

pub fn computer_use() -> Self

Creates a hosted computer_use tool definition.

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

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

Formats the value using the given formatter.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ToolDefinition> for ResponsesToolDefinition

fn from(value: ToolDefinition) -> Self

Converts to this type from the input type.

impl PartialEq for ResponsesToolDefinition

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

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

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 ResponsesToolDefinition

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 ResponsesToolDefinition