Skip to main content

PublicChatChannelConfig

Struct PublicChatChannelConfig 

Source
pub struct PublicChatChannelConfig {
    pub anonymous: bool,
    pub token: Option<String>,
    pub session_expiration_seconds: u32,
    pub rate_limit_per_minute: Option<u32>,
    pub tool_visibility: AgUiToolVisibility,
    pub generic_tool_text: String,
    pub auth: Option<AppEndpointAuthConfig>,
    pub branding: PublicChatBranding,
    pub captcha: Option<PublicChatCaptchaConfig>,
}
Expand description

Typed Public Chat channel configuration.

Parsed from the channel_config JSON field on App. Public Chat reuses AG-UI’s streaming semantics and the shared App endpoint auth verifier, and adds branding and bot-mitigation tailored to a public, link-shareable chat website. See specs/public-chat.md.

Fields§

§anonymous: bool

Whether anonymous access is allowed. Anonymous-by-default mirrors AG-UI. When false, visitors must authenticate (e.g. via auth Google OIDC).

§token: Option<String>

Optional shared bearer token for simple gated access. When set, requests must include the token in a supported header. Redacted on read.

§session_expiration_seconds: u32

How long (in seconds) a visitor session can be resumed before a fresh one must be started. 0 disables expiration. Defaults to 6 hours.

§rate_limit_per_minute: Option<u32>

Optional per-IP, per-app rate limit in requests per minute. None or Some(0) disables the per-app cap (the global API limit still applies).

§tool_visibility: AgUiToolVisibility

Public tool activity visibility. Same rules as AG-UI: raw tool names, args, results, and internal IDs are never exposed on public streams.

§generic_tool_text: String

Generic public text shown when tool_visibility is generic/narrated.

§auth: Option<AppEndpointAuthConfig>

Optional inline auth config for this public endpoint (e.g. Google OIDC). When omitted, anonymous + optional token behavior applies.

§branding: PublicChatBranding

Branding shown on the public chat surface.

§captcha: Option<PublicChatCaptchaConfig>

Optional bot-mitigation / CAPTCHA configuration (Cloudflare Turnstile).

Implementations§

Source§

impl PublicChatChannelConfig

Source

pub fn ag_ui_stream_config(&self) -> AgUiChannelConfig

Project the streaming-relevant fields onto an AgUiChannelConfig so the shared AG-UI ingress/streaming core can serve Public Chat without a parallel implementation. Branding and captcha are Public-Chat-only and are handled by the Public Chat handler, not the shared core.

Source

pub fn captcha_enforced(&self) -> bool

Whether the Turnstile/CAPTCHA challenge should be enforced for an anonymous visitor. Returns false when no captcha is configured or it is explicitly disabled. Signed-in visitors (validated via auth) bypass the challenge and are handled by the caller.

Trait Implementations§

Source§

impl Clone for PublicChatChannelConfig

Source§

fn clone(&self) -> PublicChatChannelConfig

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 PublicChatChannelConfig

Source§

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

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

impl<'de> Deserialize<'de> for PublicChatChannelConfig

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for PublicChatChannelConfig

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. 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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> 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> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
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> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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 = 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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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