Struct GenerateSyntheticDataRequest 

#[non_exhaustive]
pub struct GenerateSyntheticDataRequest {
    pub location: String,
    pub count: i32,
    pub output_field_specs: Vec<OutputFieldSpec>,
    pub examples: Vec<SyntheticExample>,
    pub strategy: Option<Strategy>,
    /* private fields */
}

Available on crate feature data-foundry-service only.

Request message for DataFoundryService.GenerateSyntheticData.

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. The resource name of the Location to run the job. Format: projects/{project}/locations/{location}

count: i32

Required. The number of synthetic examples to generate. For this stateless API, the count is limited to a small number.

output_field_specs: Vec<OutputFieldSpec>

Required. The schema of the desired output, defined by a list of fields.

examples: Vec<SyntheticExample>

Optional. A list of few-shot examples to guide the model’s output style and format.

strategy: Option<Strategy>

The generation strategy to use.

Implementations

impl GenerateSyntheticDataRequest

pub fn new() -> Self

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

Sets the value of location.

Example

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

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

Sets the value of count.

Example

let x = GenerateSyntheticDataRequest::new().set_count(42);

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

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

Sets the value of output_field_specs.

Example

use google_cloud_aiplatform_v1::model::OutputFieldSpec;
let x = GenerateSyntheticDataRequest::new()
    .set_output_field_specs([
        OutputFieldSpec::default()/* use setters */,
        OutputFieldSpec::default()/* use (different) setters */,
    ]);

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

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

Sets the value of examples.

Example

use google_cloud_aiplatform_v1::model::SyntheticExample;
let x = GenerateSyntheticDataRequest::new()
    .set_examples([
        SyntheticExample::default()/* use setters */,
        SyntheticExample::default()/* use (different) setters */,
    ]);

pub fn set_strategy<T: Into<Option<Strategy>>>(self, v: T) -> Self

Sets the value of strategy.

Note that all the setters affecting strategy are mutually exclusive.

Example

use google_cloud_aiplatform_v1::model::TaskDescriptionStrategy;
let x = GenerateSyntheticDataRequest::new().set_strategy(Some(
    google_cloud_aiplatform_v1::model::generate_synthetic_data_request::Strategy::TaskDescription(TaskDescriptionStrategy::default().into())));

pub fn task_description(&self) -> Option<&Box<TaskDescriptionStrategy>>

The value of strategy if it holds a TaskDescription, None if the field is not set or holds a different branch.

pub fn set_task_description<T: Into<Box<TaskDescriptionStrategy>>>( self, v: T, ) -> Self

Sets the value of strategy to hold a TaskDescription.

Note that all the setters affecting strategy are mutually exclusive.

Example

use google_cloud_aiplatform_v1::model::TaskDescriptionStrategy;
let x = GenerateSyntheticDataRequest::new().set_task_description(TaskDescriptionStrategy::default()/* use setters */);
assert!(x.task_description().is_some());

Trait Implementations

impl Clone for GenerateSyntheticDataRequest

fn clone(&self) -> GenerateSyntheticDataRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GenerateSyntheticDataRequest

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

Formats the value using the given formatter.

impl Default for GenerateSyntheticDataRequest

fn default() -> GenerateSyntheticDataRequest

Returns the “default value” for a type.

impl Message for GenerateSyntheticDataRequest

fn typename() -> &'static str

The typename of this message.

impl PartialEq for GenerateSyntheticDataRequest

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