Skip to main content

ModelToolCapabilities

Struct ModelToolCapabilities 

Source
pub struct ModelToolCapabilities { /* private fields */ }
Expand description

Model support for tool definitions, selection, and emitted calls.

The schema profile identifies a trusted, digest-pinned document describing the provider subset accepted for tool input schemas. It is not fetched from the network at invocation time. Strict arguments guarantee provider-side schema-constrained generation only for complete tool-call items; StateKnot still validates every decoded argument locally.

Implementations§

Source§

impl ModelToolCapabilities

Source

pub fn new( schema_profile: Option<SchemaReference>, max_definitions: ExecutionCount, max_calls_per_response: ExecutionCount, choices: ModelToolChoices, strict_arguments: bool, ) -> Result<Self, ModelToolCapabilitiesError>

Constructs and cross-validates tool-call capabilities.

Absence of a schema profile represents unsupported tool calling and requires every other tool field to be empty, zero, or false.

§Errors

Returns ModelToolCapabilitiesError for an incoherent unsupported state, zero supported capacity, or missing automatic selection.

Source

pub fn unsupported() -> Self

Constructs an unsupported tool-call capability.

Source

pub const fn supports_tool_calling(&self) -> bool

Returns whether this model binding accepts tool definitions.

Source

pub const fn schema_profile(&self) -> Option<&SchemaReference>

Returns the accepted tool-schema profile when tool calling is supported.

Source

pub const fn max_definitions(&self) -> ExecutionCount

Returns the maximum tool definitions accepted in one request.

Source

pub const fn max_calls_per_response(&self) -> ExecutionCount

Returns the maximum tool calls emitted in one response.

Source

pub const fn supports_parallel_calls(&self) -> bool

Returns whether more than one tool call may appear in one response.

Source

pub const fn choices(&self) -> &ModelToolChoices

Returns supported tool-selection controls.

Source

pub const fn supports_strict_arguments(&self) -> bool

Returns whether complete tool arguments are provider-constrained to schema.

Trait Implementations§

Source§

impl Clone for ModelToolCapabilities

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ModelToolCapabilities

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for ModelToolCapabilities

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for ModelToolCapabilities

Source§

impl JsonSchema for ModelToolCapabilities

Source§

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

The name of the generated JSON Schema. Read more
Source§

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

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type. Read more
Source§

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. Read more
Source§

impl PartialEq for ModelToolCapabilities

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for ModelToolCapabilities

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for ModelToolCapabilities

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

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
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.