Skip to main content

Client

Struct Client 

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

Cloneable, pooled HTTP/1 client with verified TLS. No redirects, automatic retries or environment proxies. DNS hostnames must be ASCII (use punycode for IDN). A Tokio runtime is required for requests.

Implementations§

Source§

impl Client

Source

pub async fn upload_file( &self, filename: &str, data: &[u8], options: FileUploadOptions, ) -> Result<FileObject, Error>

Upload caller-owned JSONL bytes (at most 200 MB); memory includes a multipart copy of the input. No file paths or URLs are opened. Expiry fields precede the file part.

Source

pub async fn list_files( &self, options: BatchListOptions<'_>, purpose: Option<&str>, ) -> Result<BatchPage<FileObject>, Error>

Read one page of files; optional purpose is batch or batch_output.

Source

pub async fn get_file(&self, id: &str) -> Result<FileObject, Error>

Retrieve file metadata.

Source

pub async fn delete_file(&self, id: &str) -> Result<DeletedFile, Error>

Delete a file (the server may retain physical bytes until guarded cleanup).

Source

pub async fn download_file(&self, id: &str) -> Result<Vec<u8>, Error>

Download exact JSONL bytes, bounded by ClientOptions::max_response_bytes (default 8 MiB). Increase that explicit cap when downloading larger files. Dropping the future cancels I/O.

Source

pub async fn create_batch( &self, request: &CreateBatchRequest, idempotency_key: Option<&str>, ) -> Result<Batch, Error>

Create a batch; an optional owner-scoped idempotency key is 1–128 visible ASCII bytes. Retrying is the caller’s decision; reuse the same key only with the same request.

Source

pub async fn list_batches( &self, options: BatchListOptions<'_>, ) -> Result<BatchPage<Batch>, Error>

Read one page of batches.

Source

pub async fn get_batch(&self, id: &str) -> Result<Batch, Error>

Retrieve a batch without polling.

Source

pub async fn cancel_batch(&self, id: &str) -> Result<Batch, Error>

Request cancellation; partial result files may be published later.

Source

pub async fn batch_health(&self) -> Result<Value, Error>

Read Batch health. The server exposes this route without authentication.

Source§

impl Client

Source

pub fn files(&self) -> Files<'_>

Files resource with create, retrieve, list, delete and content operations.

Source

pub fn batches(&self) -> Batches<'_>

Batches resource with both create paths, retrieval and opt-in workflow helpers.

Source§

impl Client

Source

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

Connect to a server root with the default timeout and no authentication.

Source

pub fn with_options(options: ClientOptions<'_>) -> Result<Self, Error>

Validate configuration and build a connection pool. TLS uses an explicit per-client ring provider and the platform’s certificate verifier; no process-global crypto provider is installed.

Source

pub async fn decide<Q: QuestionSet>( &self, state: impl Into<Value>, questions: &Q, ) -> Result<TypedDecisionResponse<Q::Schema>, Error>

Decide from a JSON state and typed question builder.

Source

pub async fn decide_with_options<Q: QuestionSet>( &self, state: impl Into<Value>, questions: &Q, options: DecisionOptions<'_>, ) -> Result<TypedDecisionResponse<Q::Schema>, Error>

Typed decision with explicit model/facts options.

Source

pub async fn decide_request( &self, request: &DecisionRequest, ) -> Result<DecisionResponse, Error>

POST /v1/basal. Request fields and capability limits are validated by the server.

Source

pub async fn models(&self) -> Result<ModelsResponse, Error>

GET /v1/models.

Trait Implementations§

Source§

impl Clone for Client

Source§

fn clone(&self) -> Self

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

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> 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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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