Struct google_api_proto::google::cloud::dialogflow::cx::v3beta1::Example

pub struct Example {
    pub name: String,
    pub playbook_input: Option<PlaybookInput>,
    pub playbook_output: Option<PlaybookOutput>,
    pub actions: Vec<Action>,
    pub display_name: String,
    pub description: String,
    pub token_count: i64,
    pub create_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
    pub conversation_state: i32,
    pub language_code: String,
}

Example represents a sample execution of the playbook in the conversation.

An example consists of a list of ordered actions performed by end user or Dialogflow agent according the playbook instructions to fulfill the task.

Fields

name: String

The unique identifier of the playbook example. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/playbooks/<Playbook ID>/examples/<Example ID>.

playbook_input: Option<PlaybookInput>

Optional. The input to the playbook in the example.

playbook_output: Option<PlaybookOutput>

Optional. The output of the playbook in the example.

actions: Vec<Action>

Required. The ordered list of actions performed by the end user and the Dialogflow agent.

display_name: String

Required. The display name of the example.

description: String

Optional. The high level concise description of the example. The max number of characters is 200.

token_count: i64

Output only. Estimated number of tokes current example takes when sent to the LLM.

create_time: Option<Timestamp>

Output only. The timestamp of initial example creation.

update_time: Option<Timestamp>

Output only. Last time the example was updated.

conversation_state: i32

Required. Example’s output state.

language_code: String

Optional. The language code of the example. If not specified, the agent’s default language is used. Note: languages must be enabled in the agent before they can be used.

Implementations

impl Example

pub fn conversation_state(&self) -> OutputState

Returns the enum value of conversation_state, or the default if the field is set to an invalid enum value.

pub fn set_conversation_state(&mut self, value: OutputState)

Sets conversation_state to the provided enum value.

Trait Implementations

impl Clone for Example

fn clone(&self) -> Example

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Example

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

Formats the value using the given formatter.

impl Default for Example

fn default() -> Self

Returns the “default value” for a type.

impl Message for Example

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Example

fn eq(&self, other: &Example) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Example