Skip to main content

Client

Struct Client 

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

Client for Compose Inference

Canonical contract for Compose model discovery and Responses-only model execution. Payment and session primitives are owned by the Compose x402 contract.

Version: 0.8.6

Implementations§

Source§

impl Client

Source

pub fn new(baseurl: &str) -> Self

Create a new client.

baseurl is the base URL provided to the internal reqwest::Client, and should include a scheme and hostname, as well as port and a path stem if applicable.

Source

pub fn new_with_client(baseurl: &str, client: Client) -> Self

Construct a new client with an existing reqwest::Client, allowing more control over its configuration.

baseurl is the base URL provided to the internal reqwest::Client, and should include a scheme and hostname, as well as port and a path stem if applicable.

Source§

impl Client

Source

pub fn check(&self) -> Check<'_>

Sends a GET request to /health

let response = client.check()
    .send()
    .await;
Source

pub fn modality_list(&self) -> ModalityList<'_>

Sends a GET request to /v1/modalities

let response = client.modality_list()
    .send()
    .await;
Source

pub fn modality_get(&self) -> ModalityGet<'_>

Sends a GET request to /v1/modalities/{modality}

let response = client.modality_get()
    .modality(modality)
    .send()
    .await;
Source

pub fn operations_list(&self) -> OperationsList<'_>

Sends a GET request to /v1/modalities/{modality}/operations

let response = client.operations_list()
    .modality(modality)
    .send()
    .await;
Source

pub fn operation_models_list(&self) -> OperationModelsList<'_>

Sends a GET request to /v1/modalities/{modality}/operations/{operation}/models

let response = client.operation_models_list()
    .modality(modality)
    .operation(operation)
    .cursor(cursor)
    .limit(limit)
    .provider(provider)
    .q(q)
    .streaming(streaming)
    .send()
    .await;
Source

pub fn list(&self) -> List<'_>

Sends a GET request to /v1/models

let response = client.list()
    .limit(limit)
    .modality(modality)
    .provider(provider)
    .send()
    .await;
Source

pub fn list_all(&self) -> ListAll<'_>

Sends a GET request to /v1/models/all

let response = client.list_all()
    .send()
    .await;
Source

pub fn search(&self) -> Search<'_>

Sends a POST request to /v1/models/search

let response = client.search()
    .body(body)
    .send()
    .await;
Source

pub fn get(&self) -> Get<'_>

Sends a GET request to /v1/models/{model}

let response = client.get()
    .model(model)
    .provider(provider)
    .send()
    .await;
Source

pub fn params_get(&self) -> ParamsGet<'_>

Sends a GET request to /v1/models/{model}/params

let response = client.params_get()
    .model(model)
    .provider(provider)
    .send()
    .await;
Source

pub fn responses_create(&self) -> ResponsesCreate<'_>

Sends a POST request to /v1/responses

let response = client.responses_create()
    .x_chain_id(x_chain_id)
    .x_idempotency_key(x_idempotency_key)
    .x_session_user_address(x_session_user_address)
    .x_x402_max_amount_wei(x_x402_max_amount_wei)
    .body(body)
    .send()
    .await;
Source

pub fn responses_get(&self) -> ResponsesGet<'_>

Sends a GET request to /v1/responses/{responseId}

let response = client.responses_get()
    .response_id(response_id)
    .send()
    .await;
Source

pub fn responses_cancel(&self) -> ResponsesCancel<'_>

Sends a POST request to /v1/responses/{responseId}/cancel

let response = client.responses_cancel()
    .response_id(response_id)
    .send()
    .await;
Source

pub fn responses_input_items_list(&self) -> ResponsesInputItemsList<'_>

Sends a GET request to /v1/responses/{responseId}/input_items

let response = client.responses_input_items_list()
    .response_id(response_id)
    .send()
    .await;

Trait Implementations§

Source§

impl ClientHooks for &Client

Source§

async fn pre<E>( &self, request: &mut Request, info: &OperationInfo, ) -> Result<(), Error<E>>

Runs prior to the execution of the request. This may be used to modify the request before it is transmitted.
Source§

async fn post<E>( &self, result: &Result<Response, Error>, info: &OperationInfo, ) -> Result<(), Error<E>>

Runs after completion of the request.
Source§

async fn exec( &self, request: Request, info: &OperationInfo, ) -> Result<Response, Error>

Execute the request. Note that for almost any reasonable implementation this will include code equivalent to this: Read more
Source§

impl ClientInfo<()> for Client

Source§

fn api_version() -> &'static str

Get the version of this API. Read more
Source§

fn baseurl(&self) -> &str

Get the base URL to which requests are made.
Source§

fn client(&self) -> &Client

Get the internal reqwest::Client used to make requests.
Source§

fn inner(&self) -> &()

Get the inner value of type T if one is specified.
Source§

impl Clone for Client

Source§

fn clone(&self) -> Client

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Client

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: 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> 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<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