Struct ChunkInfo 

#[non_exhaustive]
pub struct ChunkInfo {
    pub chunk: String,
    pub content: String,
    pub relevance_score: Option<f32>,
    pub document_metadata: Option<DocumentMetadata>,
    /* private fields */
}

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

Chunk information.

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: String

Chunk resource name.

content: String

Chunk textual content.

relevance_score: Option<f32>

The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation.

document_metadata: Option<DocumentMetadata>

Document metadata.

Implementations

impl ChunkInfo

pub fn new() -> Self

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

Sets the value of chunk.

Example

let x = ChunkInfo::new().set_chunk("example");

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

Sets the value of content.

Example

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

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

where T: Into<f32>,

Sets the value of relevance_score.

Example

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

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

where T: Into<f32>,

Sets or clears the value of relevance_score.

Example

let x = ChunkInfo::new().set_or_clear_relevance_score(Some(42.0));
let x = ChunkInfo::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::answer::reference::chunk_info::DocumentMetadata;
let x = ChunkInfo::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::answer::reference::chunk_info::DocumentMetadata;
let x = ChunkInfo::new().set_or_clear_document_metadata(Some(DocumentMetadata::default()/* use setters */));
let x = ChunkInfo::new().set_or_clear_document_metadata(None::<DocumentMetadata>);

Trait Implementations

impl Clone for ChunkInfo

fn clone(&self) -> ChunkInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChunkInfo

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

Formats the value using the given formatter.

impl Default for ChunkInfo

fn default() -> ChunkInfo

Returns the “default value” for a type.

impl Message for ChunkInfo

fn typename() -> &'static str

The typename of this message.

impl PartialEq for ChunkInfo

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