Struct CheckGroundingRequest 

#[non_exhaustive]
pub struct CheckGroundingRequest {
    pub grounding_config: String,
    pub answer_candidate: String,
    pub facts: Vec<GroundingFact>,
    pub grounding_spec: Option<CheckGroundingSpec>,
    pub user_labels: HashMap<String, String>,
    /* private fields */
}

Available on crate feature grounded-generation-service only.

Request message for GroundedGenerationService.CheckGrounding 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.

grounding_config: String

Required. The resource name of the grounding config, such as projects/*/locations/global/groundingConfigs/default_grounding_config.

answer_candidate: String

Answer candidate to check. It can have a maximum length of 4096 tokens.

facts: Vec<GroundingFact>

List of facts for the grounding check. We support up to 200 facts.

grounding_spec: Option<CheckGroundingSpec>

Configuration of the grounding check.

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 CheckGroundingRequest

pub fn new() -> Self

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

Sets the value of grounding_config.

Example

let x = CheckGroundingRequest::new().set_grounding_config("example");

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

Sets the value of answer_candidate.

Example

let x = CheckGroundingRequest::new().set_answer_candidate("example");

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

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

Sets the value of facts.

Example

use google_cloud_discoveryengine_v1::model::GroundingFact;
let x = CheckGroundingRequest::new()
    .set_facts([
        GroundingFact::default()/* use setters */,
        GroundingFact::default()/* use (different) setters */,
    ]);

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

where T: Into<CheckGroundingSpec>,

Sets the value of grounding_spec.

Example

use google_cloud_discoveryengine_v1::model::CheckGroundingSpec;
let x = CheckGroundingRequest::new().set_grounding_spec(CheckGroundingSpec::default()/* use setters */);

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

where T: Into<CheckGroundingSpec>,

Sets or clears the value of grounding_spec.

Example

use google_cloud_discoveryengine_v1::model::CheckGroundingSpec;
let x = CheckGroundingRequest::new().set_or_clear_grounding_spec(Some(CheckGroundingSpec::default()/* use setters */));
let x = CheckGroundingRequest::new().set_or_clear_grounding_spec(None::<CheckGroundingSpec>);

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 = CheckGroundingRequest::new().set_user_labels([
    ("key0", "abc"),
    ("key1", "xyz"),
]);

Trait Implementations

impl Clone for CheckGroundingRequest

fn clone(&self) -> CheckGroundingRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CheckGroundingRequest

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

Formats the value using the given formatter.

impl Default for CheckGroundingRequest

fn default() -> CheckGroundingRequest

Returns the “default value” for a type.

impl Message for CheckGroundingRequest

fn typename() -> &'static str

The typename of this message.

impl PartialEq for CheckGroundingRequest

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