Struct Chunk 

#[non_exhaustive]
pub struct Chunk {
    pub name: String,
    pub id: String,
    pub content: String,
    pub relevance_score: Option<f64>,
    pub document_metadata: Option<DocumentMetadata>,
    pub derived_struct_data: Option<Struct>,
    pub page_span: Option<PageSpan>,
    pub chunk_metadata: Option<Box<ChunkMetadata>>,
    pub data_urls: Vec<String>,
    pub annotation_contents: Vec<String>,
    pub annotation_metadata: Vec<AnnotationMetadata>,
    /* private fields */
}

Available on crate features conversational-search-service or search-service only.

Chunk captures all raw metadata information of items to be recommended or searched in the chunk mode.

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.

name: String

The full resource name of the chunk. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}.

This field must be a UTF-8 encoded string with a length limit of 1024 characters.

id: String

Unique chunk ID of the current chunk.

content: String

Content is a string from a document (parsed content).

relevance_score: Option<f64>

Output only. Represents the relevance score based on similarity. Higher score indicates higher chunk relevance. The score is in range [-1.0, 1.0]. Only populated on SearchResponse.

document_metadata: Option<DocumentMetadata>

Metadata of the document from the current chunk.

derived_struct_data: Option<Struct>

Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.

page_span: Option<PageSpan>

Page span of the chunk.

chunk_metadata: Option<Box<ChunkMetadata>>

Output only. Metadata of the current chunk.

data_urls: Vec<String>

Output only. Image Data URLs if the current chunk contains images. Data URLs are composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:[<mediatype>][;base64],<data>

annotation_contents: Vec<String>

Output only. Annotation contents if the current chunk contains annotations.

annotation_metadata: Vec<AnnotationMetadata>

Output only. The annotation metadata includes structured content in the current chunk.

Implementations

impl Chunk

pub fn new() -> Self

Creates a new default instance.

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

Sets the value of name.

Example

let x = Chunk::new().set_name(format!("projects/{project_id}/locations/{location_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}/chunks/{chunk_id}"));

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

Sets the value of id.

Example

let x = Chunk::new().set_id("example");

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

Sets the value of content.

Example

let x = Chunk::new().set_content("example");

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

where T: Into<f64>,

Sets the value of relevance_score.

Example

let x = Chunk::new().set_relevance_score(42.0);

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

where T: Into<f64>,

Sets or clears the value of relevance_score.

Example

let x = Chunk::new().set_or_clear_relevance_score(Some(42.0));
let x = Chunk::new().set_or_clear_relevance_score(None::<f32>);

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

where T: Into<DocumentMetadata>,

Sets the value of document_metadata.

Example

use google_cloud_discoveryengine_v1::model::chunk::DocumentMetadata;
let x = Chunk::new().set_document_metadata(DocumentMetadata::default()/* use setters */);

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

where T: Into<DocumentMetadata>,

Sets or clears the value of document_metadata.

Example

use google_cloud_discoveryengine_v1::model::chunk::DocumentMetadata;
let x = Chunk::new().set_or_clear_document_metadata(Some(DocumentMetadata::default()/* use setters */));
let x = Chunk::new().set_or_clear_document_metadata(None::<DocumentMetadata>);

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

where T: Into<Struct>,

Sets the value of derived_struct_data.

Example

use wkt::Struct;
let x = Chunk::new().set_derived_struct_data(Struct::default()/* use setters */);

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

where T: Into<Struct>,

Sets or clears the value of derived_struct_data.

Example

use wkt::Struct;
let x = Chunk::new().set_or_clear_derived_struct_data(Some(Struct::default()/* use setters */));
let x = Chunk::new().set_or_clear_derived_struct_data(None::<Struct>);

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

where T: Into<PageSpan>,

Sets the value of page_span.

Example

use google_cloud_discoveryengine_v1::model::chunk::PageSpan;
let x = Chunk::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_discoveryengine_v1::model::chunk::PageSpan;
let x = Chunk::new().set_or_clear_page_span(Some(PageSpan::default()/* use setters */));
let x = Chunk::new().set_or_clear_page_span(None::<PageSpan>);

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

where T: Into<ChunkMetadata>,

Sets the value of chunk_metadata.

Example

use google_cloud_discoveryengine_v1::model::chunk::ChunkMetadata;
let x = Chunk::new().set_chunk_metadata(ChunkMetadata::default()/* use setters */);

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

where T: Into<ChunkMetadata>,

Sets or clears the value of chunk_metadata.

Example

use google_cloud_discoveryengine_v1::model::chunk::ChunkMetadata;
let x = Chunk::new().set_or_clear_chunk_metadata(Some(ChunkMetadata::default()/* use setters */));
let x = Chunk::new().set_or_clear_chunk_metadata(None::<ChunkMetadata>);

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

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

Sets the value of data_urls.

Example

let x = Chunk::new().set_data_urls(["a", "b", "c"]);

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

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

Sets the value of annotation_contents.

Example

let x = Chunk::new().set_annotation_contents(["a", "b", "c"]);

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

where T: IntoIterator<Item = V>, V: Into<AnnotationMetadata>,

Sets the value of annotation_metadata.

Example

use google_cloud_discoveryengine_v1::model::chunk::AnnotationMetadata;
let x = Chunk::new()
    .set_annotation_metadata([
        AnnotationMetadata::default()/* use setters */,
        AnnotationMetadata::default()/* use (different) setters */,
    ]);

Trait Implementations

impl Clone for Chunk

fn clone(&self) -> Chunk

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Chunk

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

Formats the value using the given formatter.

impl Default for Chunk

fn default() -> Chunk

Returns the “default value” for a type.

impl Message for Chunk

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Chunk

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

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Chunk