Struct UrlAnnotation

pub struct UrlAnnotation {
    pub url: Url,
    pub title: String,
    pub content: String,
    pub start: usize,
    pub end: usize,
}

URL annotation metadata.

Contains metadata about a url::Url referenced in a Message. This provides additional context about URLs mentioned in message content, such as their title, description, and position within the text.

Fields

• url - The annotated URL
• title - Human-readable title of the URL resource
• content - Description or summary of the URL content
• start - Start character index of the URL in the message content
• end - End character index of the URL in the message content

Fields

url: Url

The annotated URL.

title: String

URL title.

content: String

URL content/description.

start: usize

Start index in message content.

end: usize

End index in message content.

Implementations

impl UrlAnnotation

pub fn new( url: impl TryInto<Url, Error: Debug>, title: impl Into<String>, content: impl Into<String>, start: usize, end: usize, ) -> Self

Creates a new URL annotation.

Arguments

• url - The URL being annotated
• title - Human-readable title for the URL
• content - Description or summary of the URL content
• start - Start character index in the message content
• end - End character index in the message content

Example

use ai_types::llm::UrlAnnotation;
use url::Url;

let annotation = UrlAnnotation::new(
    "https://example.com",
    "Example Site",
    "An example website",
    0,
    10
);

Panics

Panics if the URL is invalid.

Trait Implementations

impl Clone for UrlAnnotation

fn clone(&self) -> UrlAnnotation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UrlAnnotation

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

Formats the value using the given formatter.

impl PartialEq for UrlAnnotation

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

Tests for self and other values to be equal, and is used by ==.

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

impl StructuralPartialEq for UrlAnnotation