Struct FactChunk 

#[non_exhaustive]
pub struct FactChunk {
    pub chunk_text: String,
    pub source: String,
    pub index: i32,
    pub source_metadata: HashMap<String, String>,
    pub uri: String,
    pub title: String,
    pub domain: String,
    /* private fields */
}

Available on crate feature grounded-generation-service only.

Fact Chunk.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

chunk_text: String

Text content of the fact chunk. Can be at most 10K characters long.

source: String

Source from which this fact chunk was retrieved. If it was retrieved from the GroundingFacts provided in the request then this field will contain the index of the specific fact from which this chunk was retrieved.

index: i32

The index of this chunk. Currently, only used for the streaming mode.

source_metadata: HashMap<String, String>

More fine-grained information for the source reference.

uri: String

The URI of the source.

title: String

The title of the source.

domain: String

The domain of the source.

Implementations

impl FactChunk

pub fn new() -> Self

pub fn set_chunk_text<T: Into<String>>(self, v: T) -> Self

Sets the value of chunk_text.

Example

let x = FactChunk::new().set_chunk_text("example");

pub fn set_source<T: Into<String>>(self, v: T) -> Self

Sets the value of source.

Example

let x = FactChunk::new().set_source("example");

pub fn set_index<T: Into<i32>>(self, v: T) -> Self

Sets the value of index.

Example

let x = FactChunk::new().set_index(42);

pub fn set_source_metadata<T, K, V>(self, v: T) -> Self

where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Sets the value of source_metadata.

Example

let x = FactChunk::new().set_source_metadata([
    ("key0", "abc"),
    ("key1", "xyz"),
]);

pub fn set_uri<T: Into<String>>(self, v: T) -> Self

Sets the value of uri.

Example

let x = FactChunk::new().set_uri("example");

pub fn set_title<T: Into<String>>(self, v: T) -> Self

Sets the value of title.

Example

let x = FactChunk::new().set_title("example");

pub fn set_domain<T: Into<String>>(self, v: T) -> Self

Sets the value of domain.

Example

let x = FactChunk::new().set_domain("example");

Trait Implementations

impl Clone for FactChunk

fn clone(&self) -> FactChunk

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FactChunk

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

Formats the value using the given formatter.

impl Default for FactChunk

fn default() -> FactChunk

Returns the “default value” for a type.

impl Message for FactChunk

fn typename() -> &'static str

The typename of this message.

impl PartialEq for FactChunk

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