pub struct Client { /* private fields */ }
Expand description

Sends HTTP request to the Aleph Alpha API

Implementations§

source§

impl Client

source

pub fn new(api_token: &str) -> Result<Self, Error>

A new instance of an Aleph Alpha client helping you interact with the Aleph Alpha API.

source

pub fn with_base_url(host: String, api_token: &str) -> Result<Self, Error>

In production you typically would want set this to https://api.aleph-alpha.com. Yet you may want to use a different instances for testing.

source

pub async fn execute<T: Task>( &self, model: &str, task: &T, how: &How ) -> Result<T::Output, Error>

Execute a task with the aleph alpha API and fetch its result.

use aleph_alpha_client::{Client, How, TaskCompletion, Error};
 
async fn print_completion() -> Result<(), Error> {
    // Authenticate against API. Fetches token.
    let client = Client::new("AA_API_TOKEN")?;
 
    // Name of the model we we want to use. Large models give usually better answer, but are
    // also slower and more costly.
    let model = "luminous-base";
 
    // The task we want to perform. Here we want to continue the sentence: "The most important thing
    // is ..."
    let task = TaskCompletion::from_text("An apple a day", 10);
 
    // Send the task to the client.
    let response = client.execute(model, &task, &How::default()).await?;
 
    // Print entire sentence with completion
    println!("An apple a day{}", response.completion);
    Ok(())
}

Auto Trait Implementations§

§

impl !RefUnwindSafe for Client

§

impl Send for Client

§

impl Sync for Client

§

impl Unpin for Client

§

impl !UnwindSafe for Client

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · 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 Twhere U: From<T>,

const: unstable · 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, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

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

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
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