Skip to main content

SystemLanguageModel

Struct SystemLanguageModel 

Source
pub struct SystemLanguageModel;
Expand description

The on-device system language model namespace.

Implementations§

Source§

impl SystemLanguageModel

Source

pub fn is_available() -> bool

Convenience: availability() == Availability::Available.

Source

pub fn availability() -> Availability

Detailed availability state of the default model.

Source

pub fn default_model() -> Option<ConfiguredSystemLanguageModel>

Borrow the SDK’s shared default model as a configured handle.

Source

pub fn with_use_case( use_case: UseCase, guardrails: Guardrails, ) -> Result<ConfiguredSystemLanguageModel, FMError>

Build a configured system model for the supplied use case and guardrails.

§Errors

Returns an FMError if the current OS does not expose FoundationModels.

Source

pub fn with_adapter( adapter: &Adapter, guardrails: Guardrails, ) -> Result<ConfiguredSystemLanguageModel, FMError>

Build a configured system model backed by an adapter.

§Errors

Returns an FMError if the adapter is invalid or the current OS does not expose FoundationModels.

Source

pub fn supported_languages() -> Vec<String>

Languages supported by the default system model.

Source

pub fn supports_locale(locale_identifier: &str) -> bool

Whether the default model supports a locale.

Source

pub async fn token_count(prompt: &str) -> Result<usize, FMError>

Available on crate feature async only.

Count how many tokens the default system model would consume for a prompt.

§Errors

Returns an FMError if the prompt is invalid or the SDK rejects the request.

Trait Implementations§

Source§

impl Clone for SystemLanguageModel

Source§

fn clone(&self) -> SystemLanguageModel

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 Copy for SystemLanguageModel

Source§

impl Debug for SystemLanguageModel

Source§

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

Formats the value using the given formatter. Read more

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> 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> 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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.