Enum UserContent 

pub enum UserContent {
    Text(String),
    Parts(Vec<InputContent>),
}

The body of a user message: either a bare string or an ordered list of multimodal parts.

Variants

Text(String)

Plain text.

Parts(Vec<InputContent>)

Multimodal parts.

Implementations

impl UserContent

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

The text, when the content is a plain string.

None for multimodal content, even when every part of it happens to be text: this borrows, and joining parts cannot. Reach for UserContent::to_text when any text will do.

pub fn to_text(&self) -> String

Every text part, in order, joined with newlines.

Non-text parts are dropped rather than described: an agent that does not handle images wants the caption, not a placeholder it has to strip.

use ag_ui::{InputContent, InputContentSource, MediaInputContent, UserContent};

let plain = UserContent::from("what is the weather?");
assert_eq!(plain.as_text(), Some("what is the weather?"));
assert_eq!(plain.to_text(), "what is the weather?");

let image = MediaInputContent::new(InputContentSource::Url {
    value: "https://example.com/cat.png".into(),
    mime_type: None,
});
let mixed = UserContent::from(vec![
    InputContent::text("what is this?"),
    InputContent::Image(image),
    InputContent::text("be brief"),
]);
assert_eq!(mixed.as_text(), None);
assert_eq!(mixed.to_text(), "what is this?\nbe brief");

Trait Implementations

impl Clone for UserContent

fn clone(&self) -> UserContent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComposeSchema for UserContent

fn compose(generics: Vec<RefOr<Schema>>) -> RefOr<Schema>

impl Debug for UserContent

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

Formats the value using the given formatter.

impl Default for UserContent

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for UserContent

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&str> for UserContent

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<String> for UserContent

fn from(value: String) -> Self

Converts to this type from the input type.

impl From<Vec<InputContent>> for UserContent

fn from(value: Vec<InputContent>) -> Self

Converts to this type from the input type.

impl JsonSchema for UserContent

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for UserContent

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for UserContent

impl ToSchema for UserContent

fn name() -> Cow<'static, str>

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference [utoipa::openapi::schema::Schema]s for this type.