Struct OutputFieldSpec 

#[non_exhaustive]
pub struct OutputFieldSpec {
    pub field_name: String,
    pub guidance: String,
    pub field_type: FieldType,
    /* private fields */
}

Available on crate feature data-foundry-service only.

Defines a specification for a single output field.

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.

field_name: String

Required. The name of the output field.

guidance: String

Optional. Optional, but recommended. Additional guidance specific to this field to provide targeted instructions for the LLM to generate the content of a single output field. While the LLM can sometimes infer content from the field name, providing explicit guidance is preferred.

field_type: FieldType

Optional. The data type of the field. Defaults to CONTENT if not set.

Implementations

impl OutputFieldSpec

pub fn new() -> Self

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

Sets the value of field_name.

Example

let x = OutputFieldSpec::new().set_field_name("example");

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

Sets the value of guidance.

Example

let x = OutputFieldSpec::new().set_guidance("example");

pub fn set_field_type<T: Into<FieldType>>(self, v: T) -> Self

Sets the value of field_type.

Example

use google_cloud_aiplatform_v1::model::output_field_spec::FieldType;
let x0 = OutputFieldSpec::new().set_field_type(FieldType::Content);
let x1 = OutputFieldSpec::new().set_field_type(FieldType::Text);
let x2 = OutputFieldSpec::new().set_field_type(FieldType::Image);

Trait Implementations

impl Clone for OutputFieldSpec

fn clone(&self) -> OutputFieldSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OutputFieldSpec

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

Formats the value using the given formatter.

impl Default for OutputFieldSpec

fn default() -> OutputFieldSpec

Returns the “default value” for a type.

impl Message for OutputFieldSpec

fn typename() -> &'static str

The typename of this message.

impl PartialEq for OutputFieldSpec

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