Struct RankRequest 

#[non_exhaustive]
pub struct RankRequest {
    pub ranking_config: String,
    pub model: String,
    pub top_n: i32,
    pub query: String,
    pub records: Vec<RankingRecord>,
    pub ignore_record_details_in_response: bool,
    pub user_labels: HashMap<String, String>,
    /* private fields */
}

Available on crate feature rank-service only.

Request 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.

ranking_config: String

Required. The resource name of the rank service config, such as projects/{project_num}/locations/{location}/rankingConfigs/default_ranking_config.

model: String

The identifier of the model to use. It is one of:

• semantic-ranker-512@latest: Semantic ranking model with maximum input token size 512.

It is set to semantic-ranker-512@latest by default if unspecified.

top_n: i32

The number of results to return. If this is unset or no bigger than zero, returns all results.

query: String

The query to use.

records: Vec<RankingRecord>

Required. A list of records to rank. At most 200 records to rank.

ignore_record_details_in_response: bool

If true, the response will contain only record ID and score. By default, it is false, the response will contain record details.

user_labels: HashMap<String, String>

The user labels applied to a resource must meet the following requirements:

• Each resource can have multiple labels, up to a maximum of 64.
• Each label must be a key-value pair.
• Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters.
• Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed.
• The key portion of a label must be unique. However, you can use the same key with multiple resources.
• Keys must start with a lowercase letter or international character.

See Google Cloud Document for more details.

Implementations

impl RankRequest

pub fn new() -> Self

Creates a new default instance.

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

Sets the value of ranking_config.

Example

let x = RankRequest::new().set_ranking_config("example");

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

Sets the value of model.

Example

let x = RankRequest::new().set_model("example");

pub fn set_top_n<T: Into<i32>>(self, v: T) -> Self

Sets the value of top_n.

Example

let x = RankRequest::new().set_top_n(42);

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

Sets the value of query.

Example

let x = RankRequest::new().set_query("example");

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

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

Sets the value of records.

Example

use google_cloud_discoveryengine_v1::model::RankingRecord;
let x = RankRequest::new()
    .set_records([
        RankingRecord::default()/* use setters */,
        RankingRecord::default()/* use (different) setters */,
    ]);

pub fn set_ignore_record_details_in_response<T: Into<bool>>(self, v: T) -> Self

Sets the value of ignore_record_details_in_response.

Example

let x = RankRequest::new().set_ignore_record_details_in_response(true);

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

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

Sets the value of user_labels.

Example

let x = RankRequest::new().set_user_labels([
    ("key0", "abc"),
    ("key1", "xyz"),
]);

Trait Implementations

impl Clone for RankRequest

fn clone(&self) -> RankRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RankRequest

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

Formats the value using the given formatter.

impl Default for RankRequest

fn default() -> RankRequest

Returns the “default value” for a type.

impl Message for RankRequest

fn typename() -> &'static str

The typename of this message.

impl PartialEq for RankRequest

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for RankRequest