Struct GenerateContentRequest 

#[non_exhaustive]
pub struct GenerateContentRequest {
    pub model: String,
    pub contents: Vec<Content>,
    pub system_instruction: Option<Content>,
    pub cached_content: String,
    pub tools: Vec<Tool>,
    pub tool_config: Option<ToolConfig>,
    pub labels: HashMap<String, String>,
    pub safety_settings: Vec<SafetySetting>,
    pub model_armor_config: Option<ModelArmorConfig>,
    pub generation_config: Option<GenerationConfig>,
    /* private fields */
}

Available on crate feature prediction-service only.

Request message for [PredictionService.GenerateContent].

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.

model: String

Required. The fully qualified name of the publisher model or tuned model endpoint to use.

Publisher model format: projects/{project}/locations/{location}/publishers/*/models/*

Tuned model endpoint format: projects/{project}/locations/{location}/endpoints/{endpoint}

contents: Vec<Content>

Required. The 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.

system_instruction: Option<Content>

Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph.

cached_content: String

Optional. The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: projects/{project}/locations/{location}/cachedContents/{cachedContent}

tools: Vec<Tool>

Optional. A list of Tools the model may use to generate the next response.

A Tool is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model.

tool_config: Option<ToolConfig>

Optional. Tool config. This config is shared for all tools provided in the request.

labels: HashMap<String, String>

Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only.

Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.

safety_settings: Vec<SafetySetting>

Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates.

model_armor_config: Option<ModelArmorConfig>

Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied.

generation_config: Option<GenerationConfig>

Optional. Generation config.

Implementations

impl GenerateContentRequest

pub fn new() -> Self

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

Sets the value of model.

Example

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

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

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

Sets the value of contents.

Example

use google_cloud_aiplatform_v1::model::Content;
let x = GenerateContentRequest::new()
    .set_contents([
        Content::default()/* use setters */,
        Content::default()/* use (different) setters */,
    ]);

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

where T: Into<Content>,

Sets the value of system_instruction.

Example

use google_cloud_aiplatform_v1::model::Content;
let x = GenerateContentRequest::new().set_system_instruction(Content::default()/* use setters */);

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

where T: Into<Content>,

Sets or clears the value of system_instruction.

Example

use google_cloud_aiplatform_v1::model::Content;
let x = GenerateContentRequest::new().set_or_clear_system_instruction(Some(Content::default()/* use setters */));
let x = GenerateContentRequest::new().set_or_clear_system_instruction(None::<Content>);

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

Sets the value of cached_content.

Example

let x = GenerateContentRequest::new().set_cached_content("example");

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

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

Sets the value of tools.

Example

use google_cloud_aiplatform_v1::model::Tool;
let x = GenerateContentRequest::new()
    .set_tools([
        Tool::default()/* use setters */,
        Tool::default()/* use (different) setters */,
    ]);

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

where T: Into<ToolConfig>,

Sets the value of tool_config.

Example

use google_cloud_aiplatform_v1::model::ToolConfig;
let x = GenerateContentRequest::new().set_tool_config(ToolConfig::default()/* use setters */);

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

where T: Into<ToolConfig>,

Sets or clears the value of tool_config.

Example

use google_cloud_aiplatform_v1::model::ToolConfig;
let x = GenerateContentRequest::new().set_or_clear_tool_config(Some(ToolConfig::default()/* use setters */));
let x = GenerateContentRequest::new().set_or_clear_tool_config(None::<ToolConfig>);

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

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

Sets the value of labels.

Example

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

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

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

Sets the value of safety_settings.

Example

use google_cloud_aiplatform_v1::model::SafetySetting;
let x = GenerateContentRequest::new()
    .set_safety_settings([
        SafetySetting::default()/* use setters */,
        SafetySetting::default()/* use (different) setters */,
    ]);

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

where T: Into<ModelArmorConfig>,

Sets the value of model_armor_config.

Example

use google_cloud_aiplatform_v1::model::ModelArmorConfig;
let x = GenerateContentRequest::new().set_model_armor_config(ModelArmorConfig::default()/* use setters */);

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

where T: Into<ModelArmorConfig>,

Sets or clears the value of model_armor_config.

Example

use google_cloud_aiplatform_v1::model::ModelArmorConfig;
let x = GenerateContentRequest::new().set_or_clear_model_armor_config(Some(ModelArmorConfig::default()/* use setters */));
let x = GenerateContentRequest::new().set_or_clear_model_armor_config(None::<ModelArmorConfig>);

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

where T: Into<GenerationConfig>,

Sets the value of generation_config.

Example

use google_cloud_aiplatform_v1::model::GenerationConfig;
let x = GenerateContentRequest::new().set_generation_config(GenerationConfig::default()/* use setters */);

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

where T: Into<GenerationConfig>,

Sets or clears the value of generation_config.

Example

use google_cloud_aiplatform_v1::model::GenerationConfig;
let x = GenerateContentRequest::new().set_or_clear_generation_config(Some(GenerationConfig::default()/* use setters */));
let x = GenerateContentRequest::new().set_or_clear_generation_config(None::<GenerationConfig>);

Trait Implementations

impl Clone for GenerateContentRequest

fn clone(&self) -> GenerateContentRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GenerateContentRequest

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

Formats the value using the given formatter.

impl Default for GenerateContentRequest

fn default() -> GenerateContentRequest

Returns the “default value” for a type.

impl Message for GenerateContentRequest

fn typename() -> &'static str

The typename of this message.

impl PartialEq for GenerateContentRequest

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