Struct ImageAnalysis 

pub struct ImageAnalysis { /* private fields */ }

Available on crate features std or alloc only.

Structured single-image VLM output. Construct via an engine’s ImageAnalysisTask::parse (the Task::parse impl) or, for tests/builders, ImageAnalysis::new followed by with_* chains. All fields are private; the accessor surface follows the rest of the crate’s scenesdetect-style getter / with_* / set_* convention.

Detection-array fields (subjects / objects / actions / mood / lighting) are Vec<SmolStr> — flat label lists, no per-detection confidence. Wrapping each label in a Detection { label, confidence } would require a confidence source the VLM can’t reliably provide — VLM self-reported confidence is poorly calibrated, and a hardcoded placeholder is a no-op for both UX and search-time ranking. If a downstream consumer needs per-detection scoring, the practical sources are search-time embedding similarity or scene-aggregation metrics, not VLM self-report.

Implementations

impl ImageAnalysis

pub fn new() -> Self

Construct an empty ImageAnalysis (all fields default).

pub fn scene(&self) -> &str

Short scene category (e.g. "office", "airport arrivals hall"). Returns the empty string when the model didn’t classify the scene (SCENE_PROMPT instructs the model to use empty strings for unknown fields). Check scene().is_empty() to test for absence.

pub fn with_scene(self, val: impl Into<SmolStr>) -> Self

Builder-style setter for scene. Pass an empty string to clear.

pub fn set_scene(&mut self, val: impl Into<SmolStr>) -> &mut Self

In-place setter for scene. Pass an empty string to clear.

pub fn description(&self) -> &str

1-2 sentence free-form scene description, or empty when the model produced no description (e.g., on a low-information frame).

pub fn with_description(self, val: impl Into<SmolStr>) -> Self

Builder-style setter for description. Pass an empty string to clear.

pub fn set_description(&mut self, val: impl Into<SmolStr>) -> &mut Self

In-place setter for description. Pass an empty string to clear.

pub fn subjects(&self) -> &[SmolStr]

Distinct people or animals visible in the scene.

pub fn with_subjects(self, val: Vec<SmolStr>) -> Self

Builder-style setter for subjects.

pub fn set_subjects(&mut self, val: Vec<SmolStr>) -> &mut Self

In-place setter for subjects.

pub fn objects(&self) -> &[SmolStr]

Notable, search-relevant objects.

pub fn with_objects(self, val: Vec<SmolStr>) -> Self

Builder-style setter for objects.

pub fn set_objects(&mut self, val: Vec<SmolStr>) -> &mut Self

In-place setter for objects.

pub fn actions(&self) -> &[SmolStr]

Visible actions.

pub fn with_actions(self, val: Vec<SmolStr>) -> Self

Builder-style setter for actions.

pub fn set_actions(&mut self, val: Vec<SmolStr>) -> &mut Self

In-place setter for actions.

pub fn mood(&self) -> &[SmolStr]

Scene-level mood terms.

pub fn with_mood(self, val: Vec<SmolStr>) -> Self

Builder-style setter for mood.

pub fn set_mood(&mut self, val: Vec<SmolStr>) -> &mut Self

In-place setter for mood.

pub fn shot_type(&self) -> &str

One short camera-shot label (e.g. "wide shot", "close-up"), or empty when the model didn’t pick one.

pub fn with_shot_type(self, val: impl Into<SmolStr>) -> Self

Builder-style setter for shot_type. Pass an empty string to clear.

pub fn set_shot_type(&mut self, val: impl Into<SmolStr>) -> &mut Self

In-place setter for shot_type. Pass an empty string to clear.

pub fn lighting(&self) -> &[SmolStr]

Lighting terms.

pub fn with_lighting(self, val: Vec<SmolStr>) -> Self

Builder-style setter for lighting.

pub fn set_lighting(&mut self, val: Vec<SmolStr>) -> &mut Self

In-place setter for lighting.

pub fn tags(&self) -> &[SmolStr]

8-12 short English search tags in lowercase.

pub fn with_tags(self, val: Vec<SmolStr>) -> Self

Builder-style setter for tags.

pub fn set_tags(&mut self, val: Vec<SmolStr>) -> &mut Self

In-place setter for tags.

Trait Implementations

impl Clone for ImageAnalysis

fn clone(&self) -> ImageAnalysis

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ImageAnalysis

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

Formats the value using the given formatter.

impl Default for ImageAnalysis

fn default() -> ImageAnalysis

Returns the “default value” for a type.

impl PartialEq for ImageAnalysis

fn eq(&self, other: &ImageAnalysis) -> 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 Eq for ImageAnalysis

impl StructuralPartialEq for ImageAnalysis