Struct Client

pub struct Client { /* private fields */ }

Client for interacting with the Mira API

Implementations

impl Client

pub fn new(api_key: &str) -> Result<Self, MiraError>

Create a new Mira client with the given API key

pub fn new_with_base_url( api_key: &str, base_url: impl Into<String>, ) -> Result<Self, MiraError>

Create a new Mira client with a custom base URL and API key

pub fn with_custom_client(self, client: Client) -> Self

Use your own reqwest::Client. The required headers will be automatically attached upon trying to make a request.

pub async fn list_models(&self) -> Result<Vec<String>, MiraError>

List available models

Trait Implementations

impl AsEmbeddings for Client

fn as_embeddings(&self) -> Option<Box<dyn EmbeddingsClientDyn>>

impl AsTranscription for Client

fn as_transcription(&self) -> Option<Box<dyn TranscriptionClientDyn>>

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CompletionClient for Client

fn completion_model(&self, model: &str) -> CompletionModel

Create a completion model with the given name.

type CompletionModel = CompletionModel

The type of CompletionModel used by the client.

fn agent(&self, model: &str) -> AgentBuilder<Self::CompletionModel>

Create an agent builder with the given completion model.

fn extractor<T: JsonSchema + for<'a> Deserialize<'a> + Serialize + Send + Sync>( &self, model: &str, ) -> ExtractorBuilder<T, Self::CompletionModel>

Create an extractor builder with the given completion model.

impl Debug for Client

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

Formats the value using the given formatter.

impl ProviderClient for Client

fn from_env() -> Self

Create a new Mira client from the MIRA_API_KEY environment variable. Panics if the environment variable is not set.

fn boxed(self) -> Box<dyn ProviderClient>

where Self: Sized + 'static,

A helper method to box the client.

fn from_env_boxed<'a>() -> Box<dyn ProviderClient + 'a>

where Self: Sized + 'a,

Create a boxed client from the process’s environment. Panics if an environment is improperly configured.