pub struct InteractionRequest {Show 14 fields
pub model: Option<String>,
pub agent: Option<String>,
pub agent_config: Option<AgentConfig>,
pub input: InteractionInput,
pub previous_interaction_id: Option<String>,
pub tools: Option<Vec<Tool>>,
pub response_modalities: Option<Vec<String>>,
pub response_format: Option<Value>,
pub response_mime_type: Option<String>,
pub generation_config: Option<GenerationConfig>,
pub stream: Option<bool>,
pub background: Option<bool>,
pub store: Option<bool>,
pub system_instruction: Option<InteractionInput>,
}Expand description
Request body for the Interactions API endpoint.
This type represents a fully-constructed interaction request that can be
cloned, serialized, and executed via Client::execute().
§Creating Requests
Use InteractionBuilder::build() to create requests:
let client = Client::new("api_key".to_string());
let request = client.interaction()
.with_model("gemini-3-flash-preview")
.with_text("Hello!")
.build()?;
// Request can be cloned, serialized, inspected
let backup = request.clone();
println!("{}", serde_json::to_string_pretty(&request)?);§Executing Requests
let response = client.execute(request).await?;§Retrying Requests
Since InteractionRequest is Clone, you can retry failed requests:
let response = loop {
match client.execute(request.clone()).await {
Ok(r) => break r,
Err(e) if e.is_retryable() => continue,
Err(e) => return Err(e.into()),
}
};Fields§
§model: Option<String>Model name (e.g., “gemini-3-flash-preview”) - mutually exclusive with agent
agent: Option<String>Agent name (e.g., “deep-research-pro-preview-12-2025”) - mutually exclusive with model
agent_config: Option<AgentConfig>Agent-specific configuration (e.g., Deep Research thinking summaries)
input: InteractionInputThe input for this interaction
previous_interaction_id: Option<String>Reference to a previous interaction for stateful conversations
tools: Option<Vec<Tool>>Tools available for function calling
response_modalities: Option<Vec<String>>Response modalities (e.g., [“IMAGE”])
response_format: Option<Value>JSON schema for structured output
response_mime_type: Option<String>Response MIME type for structured output.
Required when using response_format with a JSON schema.
Typically “application/json”.
generation_config: Option<GenerationConfig>Model configuration
stream: Option<bool>Enable streaming responses
background: Option<bool>Background execution mode (agents only)
store: Option<bool>Persist interaction data (default: true)
system_instruction: Option<InteractionInput>System instruction for the model
Trait Implementations§
Source§impl Clone for InteractionRequest
impl Clone for InteractionRequest
Source§fn clone(&self) -> InteractionRequest
fn clone(&self) -> InteractionRequest
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for InteractionRequest
impl Debug for InteractionRequest
Source§impl<'de> Deserialize<'de> for InteractionRequest
impl<'de> Deserialize<'de> for InteractionRequest
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Auto Trait Implementations§
impl Freeze for InteractionRequest
impl RefUnwindSafe for InteractionRequest
impl Send for InteractionRequest
impl Sync for InteractionRequest
impl Unpin for InteractionRequest
impl UnwindSafe for InteractionRequest
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);