Skip to main content

Models

Struct Models 

Source
pub struct Models<'a, E>
where E: XaiEnvironment + Send + Sync + 'static,
{ /* private fields */ }
Expand description

Model listing and details endpoints. Model listing and details endpoints. Models API accessor.

Provides methods for listing and retrieving model information.

§Examples

use api_xai::{ Client, XaiEnvironmentImpl, Secret, ClientApiAccessors };

let secret = Secret::load_with_fallbacks( "XAI_API_KEY" )?;
let env = XaiEnvironmentImpl::new( secret )?;
let client = Client::build( env )?;

let models = client.models().list().await?;
for model in models.data {
  println!( "Model : {}", model.id );
}

Implementations§

Source§

impl<'a, E> Models<'a, E>
where E: XaiEnvironment + Send + Sync + 'static,

Source

pub fn new(client: &'a Client<E>) -> Self

Creates a new Models API accessor.

Typically not called directly - use client.models() instead.

§Arguments
  • client - Reference to the client
Source

pub async fn list(&self) -> Result<ListModelsResponse>

Lists all available models.

Retrieves a list of all models accessible with the current API key.

§Errors

Returns errors for network failures or API errors.

§Examples
let response = client.models().list().await?;

println!( "Available models:" );
for model in response.data {
  println!( "  - {} (created : {})", model.id, model.created );
}
Source

pub async fn get(&self, model_id: &str) -> Result<Model>

Retrieves information about a specific model.

§Arguments
  • model_id - Model identifier (e.g., “grok-2-1212”, “grok-4”)
§Errors

Returns errors for network failures, API errors, or if the model is not found.

§Examples
let model = client.models().get( "grok-2-1212" ).await?;

println!( "Model : {}", model.id );
println!( "Owned by : {}", model.owned_by );
println!( "Created : {}", model.created );

Trait Implementations§

Source§

impl<'a, E> Debug for Models<'a, E>
where E: XaiEnvironment + Send + Sync + 'static + Debug,

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a, E> !RefUnwindSafe for Models<'a, E>

§

impl<'a, E> !UnwindSafe for Models<'a, E>

§

impl<'a, E> Freeze for Models<'a, E>

§

impl<'a, E> Send for Models<'a, E>

§

impl<'a, E> Sync for Models<'a, E>

§

impl<'a, E> Unpin for Models<'a, E>

§

impl<'a, E> UnsafeUnpin for Models<'a, E>

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<C, E> EntryToVal<C> for E
where C: Collection<Entry = E>,

Source§

type Val = <C as Collection>::Val

The type of values stored in the collection. This might be distinct from Entry in complex collections. For example, in a HashMap, while Entry might be a ( key, value ) tuple, Val might only be the value part.
Source§

fn entry_to_val(self) -> <E as EntryToVal<C>>::Val

Converts an entry into a value representation specific to the type of collection. This conversion is crucial for handling operations on entries, especially when they need to be treated or accessed as individual values, such as retrieving the value part from a key-value pair in a hash map.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. 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.
Source§

impl<C, Val> ValToEntry<C> for Val
where C: CollectionValToEntry<Val>,

Source§

fn val_to_entry(self) -> <C as CollectionValToEntry<Val>>::Entry

Invokes the val_to_entry function of the CollectionValToEntry trait to convert the value to an entry.

Source§

type Entry = <C as CollectionValToEntry<Val>>::Entry

Represents the type of entry that corresponds to the value within the collection. Type Entry is defined by the Collection trait.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more