Struct Client 

pub struct Client { /* private fields */ }

Top-level LLM client. Cheap to clone.

Implementations

impl Client

pub fn new(provider: Arc<dyn LLMProvider>) -> Self

Wrap any LLMProvider.

pub fn builder() -> ClientBuilder

Fluent builder.

pub fn from_env() -> Result<Self>

Build from env vars. Provider-namespaced with fallback: COGNIS_OPENAI_API_KEY overrides COGNIS_API_KEY.

pub async fn invoke(&self, messages: Vec<Message>) -> Result<Message>

One-shot chat completion (no tools).

pub async fn stream( &self, messages: Vec<Message>, ) -> Result<RunnableStream<StreamChunk>>

Streaming chat completion.

pub async fn invoke_with_tools( &self, messages: Vec<Message>, tools: &[Arc<dyn Tool>], ) -> Result<Message>

Chat completion with tool definitions.

pub async fn chat( &self, messages: Vec<Message>, opts: ChatOptions, ) -> Result<ChatResponse>

Provider-level full chat completion (with all options).

pub fn provider(&self) -> &Arc<dyn LLMProvider>

Underlying provider.

impl Client

pub fn with_structured_output<T>(self) -> StructuredClient<T>

where T: JsonSchema + DeserializeOwned + Send + 'static,

Coerce this client’s output to a typed value T.

T must derive JsonSchema (for prompt construction) and Deserialize (for parsing). The returned value is itself a Runnable<Vec<Message>, T>, so it composes with .pipe().

Trait Implementations

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 Debug for Client

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

Formats the value using the given formatter.

impl Runnable<Vec<Message>, Message> for Client

fn invoke<'life0, 'async_trait>( &'life0 self, input: Vec<Message>, __arg2: RunnableConfig, ) -> Pin<Box<dyn Future<Output = Result<Message>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

One-shot invocation. The hot path.

fn name(&self) -> &str

Friendly name for telemetry / introspection.

fn batch<'life0, 'async_trait>( &'life0 self, inputs: Vec<I>, config: RunnableConfig, ) -> Pin<Box<dyn Future<Output = Result<Vec<O>, CognisError>> + Send + 'async_trait>>

where 'life0: 'async_trait, I: 'static, O: 'static, Self: Sized + Sync + 'async_trait,

Run multiple inputs in parallel. Defaults to buffer_unordered honouring config.max_concurrency.

fn stream<'life0, 'async_trait>( &'life0 self, input: I, config: RunnableConfig, ) -> Pin<Box<dyn Future<Output = Result<RunnableStream<O>, CognisError>> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: Sized + Sync + 'async_trait,

Stream the final output (chunks of O). Default emits one item via invoke — non-streaming runnables are correct without override.

fn stream_events<'life0, 'async_trait>( &'life0 self, input: I, config: RunnableConfig, ) -> Pin<Box<dyn Future<Output = Result<EventStream, CognisError>> + Send + 'async_trait>>

where 'life0: 'async_trait, I: Serialize, O: Serialize, Self: Sized + Sync + 'async_trait,

Stream structured events. Default emits OnStart + OnEnd around an invoke call. Graph engines override to surface per-node events.

fn input_schema(&self) -> Option<Value>

JSON Schema for the input type, if known.

fn output_schema(&self) -> Option<Value>

JSON Schema for the output type, if known.