Skip to main content

Claude

Struct Claude 

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

Claude chat model client for the Anthropic Messages API.

§Example

ⓘ
use aither_claude::Claude;
use aither_core::{LanguageModel, llm::oneshot};

let client = Claude::new(std::env::var("ANTHROPIC_API_KEY")?);

let response = client.respond(oneshot(
    "You are a helpful assistant.",
    "What is the capital of France?"
)).await?;

println!("{response}");

Implementations§

Source§

impl Claude

Source

pub fn new(api_key: impl Into<String>) -> Claude

Create a new client using the provided API key.

Source

pub fn builder(api_key: impl Into<String>) -> Builder

Start building a Claude client with custom configuration.

Source

pub fn with_model(self, model: impl Into<String>) -> Claude

Override the default model in-place.

Source

pub fn with_base_url(self, base_url: impl Into<String>) -> Claude

Override the base URL (useful for proxies or local deployments).

Source

pub fn with_max_tokens(self, max_tokens: u32) -> Claude

Override the default max_tokens.

Source

pub fn with_idle_timeout(self, idle_timeout: Duration) -> Claude

Override how long a response stream may stay silent before it ends with a FailureKind::Network error. Defaults to 90 seconds.

Trait Implementations§

Source§

impl Clone for Claude

Source§

fn clone(&self) -> Claude

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 Claude

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<Claude> for CloudProvider

Source§

fn from(client: Claude) -> Self

Converts to this type from the input type.
Source§

impl LanguageModel for Claude

Source§

type Error = ClaudeError

The error type returned by this language model.
Source§

fn respond( &self, request: LLMRequest, ) -> impl Stream<Item = Result<Event, <Claude as LanguageModel>::Error>> + Send

Generates a streaming response to a conversation. Read more
Source§

fn complete( &self, prefix: &str, ) -> impl Stream<Item = Result<Event, <Claude as LanguageModel>::Error>> + Send

Completes given text prefix.
Source§

fn profile( &self, ) -> impl Future<Output = Result<Profile, <Claude as LanguageModel>::Error>> + Send

Returns model profile and capabilities. Read more
Source§

fn respond_with_tools( &self, request: LLMRequestWithTools<'_>, ) -> impl Stream<Item = Result<Event, Self::Error>> + Send

Generates a streaming response with a mutable tool registry. Read more
Source§

fn generate<T>( &self, request: LLMRequest, ) -> impl Future<Output = Result<T, GenerateError<Self::Error>>> + Send
where T: JsonSchema + DeserializeOwned + 'static,

Generates structured output conforming to JSON schema. Read more
Source§

fn summarize( &self, text: &str, ) -> impl Stream<Item = Result<Event, Self::Error>> + Send

Summarizes text. Read more
Source§

fn categorize<T>( &self, text: &str, ) -> impl Future<Output = Result<T, GenerateError<Self::Error>>> + Send
where T: JsonSchema + DeserializeOwned + 'static,

Categorizes text. Read more
Source§

fn retry_policy(&self) -> RetryPolicy

How a request to this model that failed with a retryable failure is sent again. 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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> Same for T

Source§

type Output = T

Should always be Self
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