Skip to main content

AiConfig

Struct AiConfig 

Source
pub struct AiConfig {
    pub provider: String,
    pub endpoint: String,
    pub model: String,
    pub api_key: String,
    pub system: String,
    pub max_tokens: u32,
    pub temperature: f32,
    pub thinking: Option<bool>,
    pub reasoning_format: String,
    pub access: String,
    pub timeout_secs: u64,
}
Expand description

An AI chat assistant: which service answers, and what to say to it.

Off by default (provider = "none"). Turning it on connects one client and mounts <base>/ai/chat, which takes a list of messages and streams the reply back token by token — and gives every function a chat call over the same provider.

The three providers differ only in wire format. custom is the one that matters most in practice: anything speaking the OpenAI chat-completions shape — llama.cpp, vLLM, Ollama, LM Studio, a gateway of your own — is reached by pointing endpoint at it, with no key at all if it wants none.

Fields§

§provider: String

none (default), openai, anthropic or custom.

§endpoint: String

Where to send the request.

Empty uses the provider’s own API (https://api.openai.com, https://api.anthropic.com) and is required for custom. A bare origin or a base path (http://localhost:8080, .../v1) gets the provider’s standard path appended; a URL that already names the full path (…/v1/chat/completions, …/v1/messages) is used exactly as written, for a gateway that mounts it somewhere of its own.

§model: String

Model to ask for when a request doesn’t name one, e.g. gpt-4o-mini. Some local servers serve a single model and ignore this.

§api_key: String

The provider’s API key. Optional: a local model behind provider = "custom" usually wants no credential, and sending an empty one is different from sending none — so an empty key means the request carries no authorization header at all.

§system: String

Prepended to every conversation as the system prompt, unless the request carries its own. Empty = none.

§max_tokens: u32

Cap on the tokens generated per reply. Anthropic requires one, so this is sent to every provider rather than being special-cased.

§temperature: f32

Sampling temperature sent when a request doesn’t name one. Negative (the default) sends nothing and lets the provider choose.

§thinking: Option<bool>

Whether to ask the provider to think, using its own switch for it.

This is the only reasoning switch there is. Whatever thinking comes back is surfaced: reasoning stream events, kept on the stored message, and revealed by the Show reasoning toggle. A reply with no thinking in it has no toggle. Paying a model to think and then throwing the trace away was never worth a configuration key of its own.

None (the default) sends nothing and leaves the model on whatever its template does. Some(false) turns thinking off, Some(true) turns it on. Worth setting: thinking is billed against max_tokens like any other output, so a thinking model on a small budget can spend the whole thing reasoning and answer with nothing at all.

How it is sent depends on the provider: Anthropic has a thinking parameter, and OpenAI-compatible local servers (llama.cpp, vLLM, SGLang, Ollama) take chat_template_kwargs.enable_thinking, which is what the Qwen-family templates read. OpenAI’s own reasoning models expose only reasoning_effort and cannot be switched off, so this is not sent to them.

§reasoning_format: String

How the provider hands back the model’s thinking, when it is not already in a field of its own.

A reasoning model emits its thinking in one of three shapes, and which one you get is decided by the server’s template and flags, not by the model:

valuemeaning
auto (default)native fields if present, otherwise read the tags out of the text — including a template that opened the block for the model, so the answer arrives with a closing tag and no opening one
nativethe server always fills reasoning_content (llama.cpp --reasoning-format deepseek, vLLM --reasoning-parser); text is never scanned
tagsthinking arrives inline as a matched <think>…</think> pair in the content
implicitthe chat template pre-opens the block, so every reply starts inside the thinking and the first </think> ends it (Qwen3 and DeepSeek-R1 on a server with no reasoning parser)

auto is right almost always. The one case it cannot settle on its own is a streamed pre-opened block: while the tokens are arriving there is nothing yet to say whether they are thinking or an answer, so auto treats them as thinking only when thinking is true — the app having said the model will think. Set implicit when the template thinks by default and you are leaving thinking unset.

§access: String

Who may call <base>/ai/chat, in the grammar a resource’s [permissions] uses: public, authenticated (the default), member, role:<name>.

Defaulting to authenticated is deliberate. The endpoint spends money (or a GPU) on behalf of whoever calls it, and a public one is an open proxy to your provider account — which is a decision an app should have to write down.

§timeout_secs: u64

How long one completion may take before it is abandoned. Generous by default: a long answer from a local model is slow, not broken.

Implementations§

Source§

impl AiConfig

Source

pub fn enabled(&self) -> bool

Whether a provider is configured at all. none and the empty string both mean “this app has no assistant”.

Source

pub fn default_temperature(&self) -> Option<f32>

The sampling temperature to send, or None to let the provider decide.

Trait Implementations§

Source§

impl Clone for AiConfig

Source§

fn clone(&self) -> AiConfig

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 AiConfig

Source§

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

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

impl Default for AiConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for AiConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. 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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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