Struct RecommendResponse 

#[non_exhaustive]
pub struct RecommendResponse {
    pub results: Vec<RecommendationResult>,
    pub attribution_token: String,
    pub missing_ids: Vec<String>,
    pub validate_only: bool,
    /* private fields */
}

Available on crate feature recommendation-service only.

Response message for Recommend 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.

results: Vec<RecommendationResult>

A list of recommended Documents. The order represents the ranking (from the most relevant Document to the least).

attribution_token: String

A unique attribution token. This should be included in the UserEvent logs resulting from this recommendation, which enables accurate attribution of recommendation model performance.

missing_ids: Vec<String>

IDs of documents in the request that were missing from the default Branch associated with the requested ServingConfig.

validate_only: bool

True if RecommendRequest.validate_only was set.

Implementations

impl RecommendResponse

pub fn new() -> Self

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

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

Sets the value of results.

Example

use google_cloud_discoveryengine_v1::model::recommend_response::RecommendationResult;
let x = RecommendResponse::new()
    .set_results([
        RecommendationResult::default()/* use setters */,
        RecommendationResult::default()/* use (different) setters */,
    ]);

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

Sets the value of attribution_token.

Example

let x = RecommendResponse::new().set_attribution_token("example");

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

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

Sets the value of missing_ids.

Example

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

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

Sets the value of validate_only.

Example

let x = RecommendResponse::new().set_validate_only(true);

Trait Implementations

impl Clone for RecommendResponse

fn clone(&self) -> RecommendResponse

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RecommendResponse

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

Formats the value using the given formatter.

impl Default for RecommendResponse

fn default() -> RecommendResponse

Returns the “default value” for a type.

impl Message for RecommendResponse

fn typename() -> &'static str

The typename of this message.

impl PartialEq for RecommendResponse

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