Enum AgenticRetrieveStreamResponseOutput 

#[non_exhaustive]
pub enum AgenticRetrieveStreamResponseOutput {
    ResponseEvent(AgenticRetrieveResponseEvent),
    Result(AgenticRetrieveResultEvent),
    TraceEvent(AgenticRetrieveTraceEvent),
    #[non_exhaustive]
    Unknown,
}

The streaming output for agentic retrieval, containing results, traces, and errors.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

ResponseEvent(AgenticRetrieveResponseEvent)

A chunk of the generated answer. Emitted only when generateResponse is true.

Result(AgenticRetrieveResultEvent)

A retrieval result event containing the retrieved items.

TraceEvent(AgenticRetrieveTraceEvent)

A trace event providing visibility into the retrieval process.

#[non_exhaustive]

Unknown

The Unknown variant represents cases where new union variant was received. Consider upgrading the SDK to the latest available version. An unknown enum variant

Note: If you encounter this error, consider upgrading your SDK to the latest version. The Unknown variant represents cases where the server sent a value that wasn’t recognized by the client. This can happen when the server adds new functionality, but the client has not been updated. To investigate this, consider turning on debug logging to print the raw HTTP response.

Implementations

impl AgenticRetrieveStreamResponseOutput

pub fn as_response_event(&self) -> Result<&AgenticRetrieveResponseEvent, &Self>

Tries to convert the enum instance into ResponseEvent, extracting the inner AgenticRetrieveResponseEvent. Returns Err(&Self) if it can’t be converted.

pub fn is_response_event(&self) -> bool

Returns true if this is a ResponseEvent.

pub fn as_result(&self) -> Result<&AgenticRetrieveResultEvent, &Self>

Tries to convert the enum instance into Result, extracting the inner AgenticRetrieveResultEvent. Returns Err(&Self) if it can’t be converted.

pub fn is_result(&self) -> bool

Returns true if this is a Result.

pub fn as_trace_event(&self) -> Result<&AgenticRetrieveTraceEvent, &Self>

Tries to convert the enum instance into TraceEvent, extracting the inner AgenticRetrieveTraceEvent. Returns Err(&Self) if it can’t be converted.

pub fn is_trace_event(&self) -> bool

Returns true if this is a TraceEvent.

pub fn is_unknown(&self) -> bool

Returns true if the enum instance is the Unknown variant.

Trait Implementations

impl Clone for AgenticRetrieveStreamResponseOutput

fn clone(&self) -> AgenticRetrieveStreamResponseOutput

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AgenticRetrieveStreamResponseOutput

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

Formats the value using the given formatter.

impl PartialEq for AgenticRetrieveStreamResponseOutput

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for AgenticRetrieveStreamResponseOutput