Struct FaqAnswer 

#[non_exhaustive]
pub struct FaqAnswer {
    pub answer: String,
    pub confidence: f32,
    pub question: String,
    pub source: String,
    pub metadata: HashMap<String, String>,
    pub answer_record: String,
    /* private fields */
}

Available on crate features answer-records or participants only.

Represents answer from “frequently asked questions”.

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.

answer: String

The piece of text from the source knowledge base document.

confidence: f32

The system’s confidence score that this Knowledge answer is a good match for this conversational query, range from 0.0 (completely uncertain) to 1.0 (completely certain).

question: String

The corresponding FAQ question.

source: String

Indicates which Knowledge Document this answer was extracted from. Format: projects/<Project ID>/locations/<Location ID>/agent/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>.

metadata: HashMap<String, String>

A map that contains metadata about the answer and the document from which it originates.

answer_record: String

The name of answer record, in the format of “projects/<Project ID>/locations/<Location ID>/answerRecords/<Answer Record ID>”

Implementations

impl FaqAnswer

pub fn new() -> Self

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

Sets the value of answer.

Example

let x = FaqAnswer::new().set_answer("example");

pub fn set_confidence<T: Into<f32>>(self, v: T) -> Self

Sets the value of confidence.

Example

let x = FaqAnswer::new().set_confidence(42.0);

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

Sets the value of question.

Example

let x = FaqAnswer::new().set_question("example");

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

Sets the value of source.

Example

let x = FaqAnswer::new().set_source("example");

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

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

Sets the value of metadata.

Example

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

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

Sets the value of answer_record.

Example

let x = FaqAnswer::new().set_answer_record("example");

Trait Implementations

impl Clone for FaqAnswer

fn clone(&self) -> FaqAnswer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FaqAnswer

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

Formats the value using the given formatter.

impl Default for FaqAnswer

fn default() -> FaqAnswer

Returns the “default value” for a type.

impl Message for FaqAnswer

fn typename() -> &'static str

The typename of this message.

impl PartialEq for FaqAnswer

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