Enum ResponseStream

#[non_exhaustive]
pub enum ResponseStream {
    Chunk(PayloadPart),
    Files(FilePart),
    ReturnControl(ReturnControlPayload),
    Trace(TracePart),
    #[non_exhaustive]
    Unknown,
}

The response from invoking the agent and associated citations and trace information.

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.

Chunk(PayloadPart)

Contains a part of an agent response and citations for it.

Files(FilePart)

Contains intermediate response for code interpreter if any files have been generated.

ReturnControl(ReturnControlPayload)

Contains the parameters and information that the agent elicited from the customer to carry out an action. This information is returned to the system and can be used in your own setup for fulfilling the action.

Trace(TracePart)

Contains information about the agent and session, alongside the agent's reasoning process and results from calling actions and querying knowledge bases and metadata about the trace. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace events.

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 ResponseStream

pub fn as_chunk(&self) -> Result<&PayloadPart, &Self>

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

pub fn is_chunk(&self) -> bool

Returns true if this is a Chunk.

pub fn as_files(&self) -> Result<&FilePart, &Self>

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

pub fn is_files(&self) -> bool

Returns true if this is a Files.

pub fn as_return_control(&self) -> Result<&ReturnControlPayload, &Self>

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

pub fn is_return_control(&self) -> bool

Returns true if this is a ReturnControl.

pub fn as_trace(&self) -> Result<&TracePart, &Self>

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

pub fn is_trace(&self) -> bool

Returns true if this is a Trace.

pub fn is_unknown(&self) -> bool

Returns true if the enum instance is the Unknown variant.

Trait Implementations

impl Clone for ResponseStream

fn clone(&self) -> ResponseStream

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ResponseStream

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

Formats the value using the given formatter.

impl PartialEq for ResponseStream

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

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

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