Struct google_api_proto::google::cloud::discoveryengine::v1::Chunk

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<ChunkMetadata>,
}

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

Fields

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 [SearchService.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<ChunkMetadata>

Output only. Metadata of the current chunk.

Implementations

impl Chunk

pub fn relevance_score(&self) -> f64

Returns the value of relevance_score, or the default value if relevance_score is unset.

Trait Implementations

impl Clone for Chunk

fn clone(&self) -> Chunk

Returns a copy 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() -> Self

Returns the “default value” for a type.

impl Message for Chunk

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Chunk

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Chunk