Skip to main content

Endpoint

Struct Endpoint 

Source
pub struct Endpoint {
    pub address: String,
    pub model: String,
    pub key_header: String,
    pub key: Option<Key>,
    pub silence: Duration,
}
Expand description

A provider speaking the Anthropic Messages shape.

Fields§

§address: String

The address the API lives under, such as https://api.example.com/anthropic; requests go to {address}/v1/messages.

§model: String

The model asked for.

§key_header: String

The header the key goes in: x-api-key for most, another name for some servers. For authorization the key goes in as a bearer token.

§key: Option<Key>

The key, or None for a relay on this machine that adds the key itself: QCode’s, inside a profile’s container, which the key never enters. Without one no key header is sent at all.

§silence: Duration

How long the server may send nothing in the middle of a reply before it is given up on.

Implementations§

Source§

impl Endpoint

Source

pub const SILENCE: Duration

How long a server may go quiet in the middle of a reply: generous, since a model can think a while between two pieces, and finite, since a reply that waits for ever is a stuck screen.

Source

pub fn url(&self) -> String

Where a message request goes. The key is never part of it, so it is safe to show.

Source

pub fn stream( &self, body: &Value, on_delta: &mut dyn FnMut(Delta), cancelled: &dyn Fn() -> bool, ) -> Result<Reply, ProviderError>

Sends body (a Messages request without model and stream, which are added here) and reads the streamed reply, handing each piece to on_delta as it arrives. cancelled is asked between events.

§Errors

When the server cannot be reached, refuses, or answers with something that is not a Messages reply. No error carries the key.

Trait Implementations§

Source§

impl Clone for Endpoint

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
Source§

impl Debug for Endpoint

Source§

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

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

impl Eq for Endpoint

Source§

impl PartialEq for Endpoint

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Endpoint

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. 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 = !

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.