Struct FewShotExample 

#[non_exhaustive]
pub struct FewShotExample {
    pub conversation_context: Option<ConversationContext>,
    pub extra_info: HashMap<String, String>,
    pub output: Option<GeneratorSuggestion>,
    pub instruction_list: Option<InstructionList>,
    /* private fields */
}

Available on crate features conversations or generator-evaluations or generators only.

Providing examples in the generator (i.e. building a few-shot generator) helps convey the desired format of the LLM response.

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.

conversation_context: Option<ConversationContext>

Optional. Conversation transcripts.

extra_info: HashMap<String, String>

Optional. Key is the placeholder field name in input, value is the value of the placeholder. E.g. instruction contains “@price”, and ingested data has <“price”, “10”>

output: Option<GeneratorSuggestion>

Required. Example output of the model.

instruction_list: Option<InstructionList>

Instruction list of this few_shot example.

Implementations

impl FewShotExample

pub fn new() -> Self

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

where T: Into<ConversationContext>,

Sets the value of conversation_context.

Example

use google_cloud_dialogflow_v2::model::ConversationContext;
let x = FewShotExample::new().set_conversation_context(ConversationContext::default()/* use setters */);

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

where T: Into<ConversationContext>,

Sets or clears the value of conversation_context.

Example

use google_cloud_dialogflow_v2::model::ConversationContext;
let x = FewShotExample::new().set_or_clear_conversation_context(Some(ConversationContext::default()/* use setters */));
let x = FewShotExample::new().set_or_clear_conversation_context(None::<ConversationContext>);

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

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

Sets the value of extra_info.

Example

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

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

where T: Into<GeneratorSuggestion>,

Sets the value of output.

Example

use google_cloud_dialogflow_v2::model::GeneratorSuggestion;
let x = FewShotExample::new().set_output(GeneratorSuggestion::default()/* use setters */);

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

where T: Into<GeneratorSuggestion>,

Sets or clears the value of output.

Example

use google_cloud_dialogflow_v2::model::GeneratorSuggestion;
let x = FewShotExample::new().set_or_clear_output(Some(GeneratorSuggestion::default()/* use setters */));
let x = FewShotExample::new().set_or_clear_output(None::<GeneratorSuggestion>);

pub fn set_instruction_list<T: Into<Option<InstructionList>>>( self, v: T, ) -> Self

Sets the value of instruction_list.

Note that all the setters affecting instruction_list are mutually exclusive.

Example

use google_cloud_dialogflow_v2::model::SummarizationSectionList;
let x = FewShotExample::new().set_instruction_list(Some(
    google_cloud_dialogflow_v2::model::few_shot_example::InstructionList::SummarizationSectionList(SummarizationSectionList::default().into())));

pub fn summarization_section_list( &self, ) -> Option<&Box<SummarizationSectionList>>

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

pub fn set_summarization_section_list<T: Into<Box<SummarizationSectionList>>>( self, v: T, ) -> Self

Sets the value of instruction_list to hold a SummarizationSectionList.

Note that all the setters affecting instruction_list are mutually exclusive.

Example

use google_cloud_dialogflow_v2::model::SummarizationSectionList;
let x = FewShotExample::new().set_summarization_section_list(SummarizationSectionList::default()/* use setters */);
assert!(x.summarization_section_list().is_some());

Trait Implementations

impl Clone for FewShotExample

fn clone(&self) -> FewShotExample

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FewShotExample

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

Formats the value using the given formatter.

impl Default for FewShotExample

fn default() -> FewShotExample

Returns the “default value” for a type.

impl Message for FewShotExample

fn typename() -> &'static str

The typename of this message.

impl PartialEq for FewShotExample

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