Struct GenerateGroundedContentRequest 

#[non_exhaustive]
pub struct GenerateGroundedContentRequest {
    pub location: String,
    pub system_instruction: Option<GroundedGenerationContent>,
    pub contents: Vec<GroundedGenerationContent>,
    pub generation_spec: Option<GenerationSpec>,
    pub grounding_spec: Option<GroundingSpec>,
    pub user_labels: HashMap<String, String>,
    /* private fields */
}

Available on crate feature grounded-generation-service only.

Top-level message sent by the client for the GenerateGroundedContent 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.

location: String

Required. Location resource.

Format: projects/{project}/locations/{location}.

system_instruction: Option<GroundedGenerationContent>

Content of the system instruction for the current API.

These instructions will take priority over any other prompt instructions if the selected model is supporting them.

contents: Vec<GroundedGenerationContent>

Content of the current conversation with the model.

For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request.

generation_spec: Option<GenerationSpec>

Content generation specification.

grounding_spec: Option<GroundingSpec>

Grounding specification.

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 GenerateGroundedContentRequest

pub fn new() -> Self

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

Sets the value of location.

Example

let x = GenerateGroundedContentRequest::new().set_location("example");

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

where T: Into<GroundedGenerationContent>,

Sets the value of system_instruction.

Example

use google_cloud_discoveryengine_v1::model::GroundedGenerationContent;
let x = GenerateGroundedContentRequest::new().set_system_instruction(GroundedGenerationContent::default()/* use setters */);

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

where T: Into<GroundedGenerationContent>,

Sets or clears the value of system_instruction.

Example

use google_cloud_discoveryengine_v1::model::GroundedGenerationContent;
let x = GenerateGroundedContentRequest::new().set_or_clear_system_instruction(Some(GroundedGenerationContent::default()/* use setters */));
let x = GenerateGroundedContentRequest::new().set_or_clear_system_instruction(None::<GroundedGenerationContent>);

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

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

Sets the value of contents.

Example

use google_cloud_discoveryengine_v1::model::GroundedGenerationContent;
let x = GenerateGroundedContentRequest::new()
    .set_contents([
        GroundedGenerationContent::default()/* use setters */,
        GroundedGenerationContent::default()/* use (different) setters */,
    ]);

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

where T: Into<GenerationSpec>,

Sets the value of generation_spec.

Example

use google_cloud_discoveryengine_v1::model::generate_grounded_content_request::GenerationSpec;
let x = GenerateGroundedContentRequest::new().set_generation_spec(GenerationSpec::default()/* use setters */);

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

where T: Into<GenerationSpec>,

Sets or clears the value of generation_spec.

Example

use google_cloud_discoveryengine_v1::model::generate_grounded_content_request::GenerationSpec;
let x = GenerateGroundedContentRequest::new().set_or_clear_generation_spec(Some(GenerationSpec::default()/* use setters */));
let x = GenerateGroundedContentRequest::new().set_or_clear_generation_spec(None::<GenerationSpec>);

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

where T: Into<GroundingSpec>,

Sets the value of grounding_spec.

Example

use google_cloud_discoveryengine_v1::model::generate_grounded_content_request::GroundingSpec;
let x = GenerateGroundedContentRequest::new().set_grounding_spec(GroundingSpec::default()/* use setters */);

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

where T: Into<GroundingSpec>,

Sets or clears the value of grounding_spec.

Example

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

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

Trait Implementations

impl Clone for GenerateGroundedContentRequest

fn clone(&self) -> GenerateGroundedContentRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GenerateGroundedContentRequest

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

Formats the value using the given formatter.

impl Default for GenerateGroundedContentRequest

fn default() -> GenerateGroundedContentRequest

Returns the “default value” for a type.

impl Message for GenerateGroundedContentRequest

fn typename() -> &'static str

The typename of this message.

impl PartialEq for GenerateGroundedContentRequest

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