pub struct Models<'a, E>{ /* 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>
impl<'a, E> Models<'a, E>
Sourcepub fn new(client: &'a Client<E>) -> Self
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
Sourcepub async fn list(&self) -> Result<ListModelsResponse>
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 );
}Sourcepub async fn get(&self, model_id: &str) -> Result<Model>
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§
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> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<C, E> EntryToVal<C> for Ewhere
C: Collection<Entry = E>,
impl<C, E> EntryToVal<C> for Ewhere
C: Collection<Entry = E>,
Source§type Val = <C as Collection>::Val
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
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> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
Source§impl<C, Val> ValToEntry<C> for Valwhere
C: CollectionValToEntry<Val>,
impl<C, Val> ValToEntry<C> for Valwhere
C: CollectionValToEntry<Val>,
Source§fn val_to_entry(self) -> <C as CollectionValToEntry<Val>>::Entry
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
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.