Skip to main content

Interaction

Struct Interaction 

Source
pub struct Interaction {
Show 18 fields pub id: Option<String>, pub status: InteractionStatus, pub model: Option<String>, pub agent: Option<String>, pub object: Option<String>, pub created: Option<String>, pub updated: Option<String>, pub steps: Vec<Step>, pub usage: Option<InteractionUsage>, pub system_instruction: Option<String>, pub tools: Vec<InteractionTool>, pub previous_interaction_id: Option<String>, pub environment_id: Option<String>, pub response_modalities: Option<Vec<ResponseModality>>, pub service_tier: Option<ServiceTier>, pub cached_content: Option<String>, pub agent_config: Option<AgentConfig>, pub error: Option<InteractionError>,
}
Expand description

Interaction resource — represents a complete interaction.

Fields§

§id: Option<String>§status: InteractionStatus§model: Option<String>§agent: Option<String>§object: Option<String>§created: Option<String>§updated: Option<String>§steps: Vec<Step>§usage: Option<InteractionUsage>§system_instruction: Option<String>§tools: Vec<InteractionTool>§previous_interaction_id: Option<String>§environment_id: Option<String>§response_modalities: Option<Vec<ResponseModality>>§service_tier: Option<ServiceTier>§cached_content: Option<String>§agent_config: Option<AgentConfig>§error: Option<InteractionError>

Implementations§

Source§

impl Interaction

Convenience methods on Interaction.

Source

pub fn output_text(&self) -> String

Get the concatenated final text output.

Extracts text from the last model_output step’s text content items.

Source

pub fn function_calls(&self) -> Vec<&Step>

Get all function_call steps.

Source

pub fn model_outputs(&self) -> Vec<&Step>

Get all model_output steps.

Source

pub fn thoughts(&self) -> Vec<&Step>

Get all thought steps.

Source

pub fn requires_action(&self) -> bool

Whether the interaction requires user action (e.g., function calling).

Source

pub fn is_completed(&self) -> bool

Whether the interaction is completed.

Source

pub fn output_image(&self) -> Option<&InteractionContent>

Get the output image (last model-generated image).

Source

pub fn output_audio(&self) -> Option<&InteractionContent>

Get the output audio (last model-generated audio).

Source

pub fn output_video(&self) -> Option<&InteractionContent>

Get the output video (last model-generated video).

Source

pub fn output_document(&self) -> Option<&InteractionContent>

Get the output document (last model-generated document).

Source

pub fn citations(&self) -> Vec<&Annotation>

Get all citation annotations from model outputs.

Source

pub fn total_tokens(&self) -> Option<i64>

Get the total token count.

Source

pub fn id(&self) -> Option<&str>

Get the interaction ID.

Trait Implementations§

Source§

impl Clone for Interaction

Source§

fn clone(&self) -> Interaction

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 Interaction

Source§

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

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

impl<'de> Deserialize<'de> for Interaction

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 PartialEq for Interaction

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for Interaction

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

impl StructuralPartialEq for Interaction

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