Struct RetrievalMetadata 

#[non_exhaustive]
pub struct RetrievalMetadata {
    pub google_search_dynamic_retrieval_score: f32,
    /* private fields */
}

Available on crate feature prediction-service only.

Metadata related to retrieval in the grounding flow.

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.

google_search_dynamic_retrieval_score: f32

Optional. Score indicating how likely information from Google Search could help answer the prompt. The score is in the range [0, 1], where 0 is the least likely and 1 is the most likely. This score is only populated when Google Search grounding and dynamic retrieval is enabled. It will be compared to the threshold to determine whether to trigger Google Search.

Implementations

impl RetrievalMetadata

pub fn new() -> Self

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

Sets the value of google_search_dynamic_retrieval_score.

Example

let x = RetrievalMetadata::new().set_google_search_dynamic_retrieval_score(42.0);

Trait Implementations

impl Clone for RetrievalMetadata

fn clone(&self) -> RetrievalMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RetrievalMetadata

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

Formats the value using the given formatter.

impl Default for RetrievalMetadata

fn default() -> RetrievalMetadata

Returns the “default value” for a type.

impl Message for RetrievalMetadata

fn typename() -> &'static str

The typename of this message.

impl PartialEq for RetrievalMetadata

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