Struct RankingRecord 

#[non_exhaustive]
pub struct RankingRecord {
    pub id: String,
    pub title: String,
    pub content: String,
    pub score: f32,
    /* private fields */
}

Available on crate feature rank-service only.

Record message for RankService.Rank method.

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.

id: String

The unique ID to represent the record.

title: String

The title of the record. Empty by default. At least one of title or content should be set otherwise an INVALID_ARGUMENT error is thrown.

content: String

The content of the record. Empty by default. At least one of title or content should be set otherwise an INVALID_ARGUMENT error is thrown.

score: f32

The score of this record based on the given query and selected model. The score will be rounded to 2 decimal places. If the score is close to 0, it will be rounded to 0.0001 to avoid returning unset.

Implementations

impl RankingRecord

pub fn new() -> Self

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

Sets the value of id.

Example

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

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

Sets the value of title.

Example

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

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

Sets the value of content.

Example

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

pub fn set_score<T: Into<f32>>(self, v: T) -> Self

Sets the value of score.

Example

let x = RankingRecord::new().set_score(42.0);

Trait Implementations

impl Clone for RankingRecord

fn clone(&self) -> RankingRecord

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RankingRecord

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

Formats the value using the given formatter.

impl Default for RankingRecord

fn default() -> RankingRecord

Returns the “default value” for a type.

impl Message for RankingRecord

fn typename() -> &'static str

The typename of this message.

impl PartialEq for RankingRecord

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