Struct ToolDefinition 

pub struct ToolDefinition {
    pub name: String,
    pub description: String,
    pub parameters: Value,
    pub examples: Option<String>,
    pub output_schema: Option<Value>,
    pub prompt: Option<String>,
}

Fields

name: String

description: String

parameters: Value

examples: Option<String>

output_schema: Option<Value>

prompt: Option<String>

Detailed usage instructions injected into the system prompt. Tells the LLM HOW to use this tool (behavioral guidelines, not just schema).

Trait Implementations

impl Clone for ToolDefinition

fn clone(&self) -> ToolDefinition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComposeSchema for ToolDefinition

fn compose(generics: Vec<RefOr<Schema>>) -> RefOr<Schema>

impl Debug for ToolDefinition

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToolDefinition

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 ChatCompletionTools

fn from(definition: ToolDefinition) -> Self

Converts to this type from the input type.

impl JsonSchema for ToolDefinition

fn schema_name() -> Cow<'static, str>

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 inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for ToolDefinition

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToSchema for ToolDefinition

fn name() -> Cow<'static, str>

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference utoipa::openapi::schema::Schemas for this type.