Struct ToolSchema 

pub struct ToolSchema {
    pub name: String,
    pub context: Value,
    pub embedding_docs: Vec<String>,
}

Tool name, serialized context, and text descriptions for embedding-based retrieval.

Fields

name: String

context: Value

embedding_docs: Vec<String>

Implementations

impl ToolSchema

pub fn try_from<T>(tool: &T) -> Result<Self, EmbedError>

where T: PortableToolEmbedding,

Captures a tool’s name, context, and embedding descriptions. Returns an error if context serialization fails.

use rig_core::{embeddings::{ToolSchema, EmbedError}, tool::PortableToolEmbedding};

fn schema(tool: &impl PortableToolEmbedding) -> Result<ToolSchema, EmbedError> {
    ToolSchema::try_from(tool)
}

Trait Implementations

impl Clone for ToolSchema

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for ToolSchema

fn default() -> Self

Returns the “default value” for a type.

impl Embed for ToolSchema

fn embed(&self, embedder: &mut TextEmbedder) -> Result<(), EmbedError>

Append all text fragments that should be embedded for this value.

impl Eq for ToolSchema

impl PartialEq for ToolSchema

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ToolSchema

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 ToolSchema