Skip to main content

RagStreamEvent

Enum RagStreamEvent 

Source
pub enum RagStreamEvent {
    RetrievalStarted {
        channel_count: usize,
    },
    ChannelDone {
        channel: String,
        hits: usize,
        latency_ms: u64,
    },
    GenerationStarted {
        context_chunks: usize,
        context_tokens: usize,
    },
    ContentDelta {
        delta: String,
    },
    Citation {
        chunk_id: String,
        index: usize,
    },
    Done {
        total_latency_ms: u64,
        citations: Vec<Citation>,
        usage: RagTokenUsage,
    },
}
Expand description

Events emitted during a streaming RAG operation.

Variants§

§

RetrievalStarted

Retrieval phase has started.

Fields

§channel_count: usize

Number of channels being queried.

§

ChannelDone

A single channel has completed retrieval.

Fields

§channel: String

Channel identifier.

§hits: usize

Number of hits from this channel.

§latency_ms: u64

Latency for this channel in milliseconds.

§

GenerationStarted

Generation phase has started with the assembled context.

Fields

§context_chunks: usize

Number of chunks included in the context.

§context_tokens: usize

Tokens consumed by the context.

§

ContentDelta

A delta of generated content.

Fields

§delta: String

Text delta chunk.

§

Citation

A citation has been identified in the generated content.

Fields

§chunk_id: String

Referenced chunk ID.

§index: usize

Citation index.

§

Done

Generation is complete.

Fields

§total_latency_ms: u64

Total latency in milliseconds.

§citations: Vec<Citation>

Full list of citations.

§usage: RagTokenUsage

Token usage statistics.

Trait Implementations§

Source§

impl Clone for RagStreamEvent

Source§

fn clone(&self) -> RagStreamEvent

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 RagStreamEvent

Source§

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

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

impl<'de> Deserialize<'de> for RagStreamEvent

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 RagStreamEvent

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