Skip to main content

SyncXaiClient

Struct SyncXaiClient 

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

Blocking/sync facade for the xAI SDK.

Implementations§

Source§

impl SyncXaiClient

Source

pub fn new(api_key: impl Into<String>) -> Result<Self>

Create a blocking client from an API key.

Source

pub fn from_env() -> Result<Self>

Create a blocking client from the XAI_API_KEY environment variable.

Source

pub fn with_async_client(client: XaiClient) -> Result<Self>

Create a blocking facade from an existing async client.

Source

pub fn as_async_client(&self) -> &XaiClient

Get the wrapped async client.

Source

pub fn base_url(&self) -> &str

Get the configured API base URL.

Source

pub fn responses(&self) -> SyncResponsesApi

Access blocking Responses API helpers.

Source

pub fn auth(&self) -> SyncAuthApi

Access blocking Auth API helpers.

Source

pub fn models(&self) -> SyncModelsApi

Access blocking Models API helpers.

Source

pub fn chat(&self) -> SyncChatApi

Access blocking legacy Chat Completions API helpers.

Source

pub fn images(&self) -> SyncImagesApi

Access blocking Images API helpers.

Source

pub fn videos(&self) -> SyncVideosApi

Access blocking Videos API helpers.

Source

pub fn batch(&self) -> SyncBatchApi

Access blocking Batch API helpers.

Source

pub fn collections(&self) -> SyncCollectionsApi

Access blocking Collections API helpers.

Source

pub fn files(&self) -> SyncFilesApi

Access blocking Files API helpers.

Source

pub fn tokenizer(&self) -> SyncTokenizerApi

Access blocking Tokenizer API helpers.

Source

pub fn run<T, F>(&self, future: F) -> Result<T>
where F: Future<Output = Result<T>>,

Run an SDK future to completion on the internal runtime.

This can be used for endpoints that do not yet have dedicated blocking wrappers.

Trait Implementations§

Source§

impl Clone for SyncXaiClient

Source§

fn clone(&self) -> SyncXaiClient

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SyncXaiClient

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> 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: 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: 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> 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 = 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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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