Struct Interaction 

pub struct Interaction {

    pub id: String,
    pub model: Option<String>,
    pub agent: Option<String>,
    pub status: Option<InteractionStatus>,
    pub object: Option<String>,
    pub created: Option<String>,
    pub updated: Option<String>,
    pub role: Option<String>,
    pub steps: Vec<Step>,
    pub usage: Option<InteractionUsage>,
    pub system_instruction: Option<String>,
    pub tools: Option<Vec<Tool>>,
    pub background: Option<bool>,
    pub response_modalities: Option<Vec<ResponseModality>>,
    pub response_format: Option<Value>,
    pub response_mime_type: Option<String>,
    pub previous_interaction_id: Option<String>,
    pub input: Option<InteractionInput>,
}

Interaction response payload.

Fields

id: String

model: Option<String>

agent: Option<String>

status: Option<InteractionStatus>

object: Option<String>

created: Option<String>

updated: Option<String>

role: Option<String>

steps: Vec<Step>

usage: Option<InteractionUsage>

system_instruction: Option<String>

tools: Option<Vec<Tool>>

background: Option<bool>

response_modalities: Option<Vec<ResponseModality>>

response_format: Option<Value>

response_mime_type: Option<String>

previous_interaction_id: Option<String>

input: Option<InteractionInput>

Implementations

impl Interaction

pub fn google_search_exchanges(&self) -> Vec<GoogleSearchExchange>

Groups Google Search tool calls and results by call_id.

When a call_id is missing, results are grouped with the most recent call (identified or not) as a best-effort fallback.

pub fn google_search_call_contents(&self) -> Vec<GoogleSearchCallContent>

Collects Google Search tool call contents from the interaction outputs.

pub fn google_search_result_contents(&self) -> Vec<GoogleSearchResultContent>

Collects Google Search result contents from the interaction outputs.

pub fn google_search_queries(&self) -> Vec<String>

Collects all Google Search queries from tool calls in the outputs.

pub fn google_search_results(&self) -> Vec<GoogleSearchResult>

Collects all Google Search result entries from tool results in the outputs.

pub fn url_context_exchanges(&self) -> Vec<UrlContextExchange>

Groups URL context tool calls and results by call_id.

When a call_id is missing, results are grouped with the most recent call (identified or not) as a best-effort fallback.

pub fn url_context_call_contents(&self) -> Vec<UrlContextCallContent>

Collects URL context tool call contents from the interaction outputs.

pub fn url_context_result_contents(&self) -> Vec<UrlContextResultContent>

Collects URL context result contents from the interaction outputs.

pub fn url_context_urls(&self) -> Vec<String>

Collects all URLs from URL context tool calls in the outputs.

pub fn url_context_results(&self) -> Vec<UrlContextResult>

Collects all URL context result entries from tool results in the outputs.

pub fn code_execution_exchanges(&self) -> Vec<CodeExecutionExchange>

Groups code execution tool calls and results by call_id.

When a call_id is missing, results are grouped with the most recent call (identified or not) as a best-effort fallback.

pub fn code_execution_call_contents(&self) -> Vec<CodeExecutionCallContent>

Collects code execution tool call contents from the interaction outputs.

pub fn code_execution_result_contents(&self) -> Vec<CodeExecutionResultContent>

Collects code execution result contents from the interaction outputs.

pub fn code_execution_snippets(&self) -> Vec<String>

Collects all code snippets from code execution calls in the outputs.

pub fn code_execution_outputs(&self) -> Vec<String>

Collects all code execution outputs from tool results in the outputs.

pub fn text_with_inline_citations(&self) -> Option<String>

Returns concatenated text outputs with inline citations appended.

pub fn is_terminal(&self) -> bool

Returns true when the interaction is in a terminal state.

pub fn is_completed(&self) -> bool

Returns true when the interaction completed successfully.

Trait Implementations

impl Clone for Interaction

fn clone(&self) -> Interaction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Interaction

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

Formats the value using the given formatter.

impl Default for Interaction

fn default() -> Interaction

Returns the “default value” for a type.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl GetTokenUsage for Interaction

fn token_usage(&self) -> Usage

Returns token usage for this response. Zero-valued usage is Usage’s documented sentinel for missing provider usage metrics; response types that carry no usage return Usage::new.

impl ProviderResponseExt for Interaction

type OutputMessage = Content

Provider-native output message type.

type Usage = InteractionUsage

Provider-native usage type.

fn get_response_id(&self) -> Option<String>

Returns the provider response ID, if supplied.

fn get_response_model_name(&self) -> Option<String>

Returns the provider response model name, if supplied.

fn get_output_messages( &self, ) -> Vec<<Interaction as ProviderResponseExt>::OutputMessage>

Returns serialized output messages produced by the provider.

fn get_text_response(&self) -> Option<String>

Returns the primary text response, when available.

fn get_usage(&self) -> Option<<Interaction as ProviderResponseExt>::Usage>

Returns provider-native usage metrics, if supplied.

impl Serialize for Interaction

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<Interaction> for CompletionResponse<Interaction>

type Error = CompletionError

The type returned in the event of a conversion error.

fn try_from( response: Interaction, ) -> Result<CompletionResponse<Interaction>, <CompletionResponse<Interaction> as TryFrom<Interaction>>::Error>

Performs the conversion.