Struct RagChunk 

#[non_exhaustive]
pub struct RagChunk {
    pub text: String,
    pub page_span: Option<PageSpan>,
    /* private fields */
}

Available on crate features prediction-service or vertex-rag-service only.

A RagChunk includes the content of a chunk of a RagFile, and associated metadata.

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.

text: String

The content of the chunk.

page_span: Option<PageSpan>

If populated, represents where the chunk starts and ends in the document.

Implementations

impl RagChunk

pub fn new() -> Self

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

Sets the value of text.

Example

let x = RagChunk::new().set_text("example");

pub fn set_page_span<T>(self, v: T) -> Self

where T: Into<PageSpan>,

Sets the value of page_span.

Example

use google_cloud_aiplatform_v1::model::rag_chunk::PageSpan;
let x = RagChunk::new().set_page_span(PageSpan::default()/* use setters */);

pub fn set_or_clear_page_span<T>(self, v: Option<T>) -> Self

where T: Into<PageSpan>,

Sets or clears the value of page_span.

Example

use google_cloud_aiplatform_v1::model::rag_chunk::PageSpan;
let x = RagChunk::new().set_or_clear_page_span(Some(PageSpan::default()/* use setters */));
let x = RagChunk::new().set_or_clear_page_span(None::<PageSpan>);

Trait Implementations

impl Clone for RagChunk

fn clone(&self) -> RagChunk

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RagChunk

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

Formats the value using the given formatter.

impl Default for RagChunk

fn default() -> RagChunk

Returns the “default value” for a type.

impl Message for RagChunk

fn typename() -> &'static str

The typename of this message.

impl PartialEq for RagChunk

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