Struct google_api_proto::google::ai::generativelanguage::v1beta::SemanticRetrieverConfig

pub struct SemanticRetrieverConfig {
    pub source: String,
    pub query: Option<Content>,
    pub metadata_filters: Vec<MetadataFilter>,
    pub max_chunks_count: Option<i32>,
    pub minimum_relevance_score: Option<f32>,
}

Configuration for retrieving grounding content from a Corpus or Document created using the Semantic Retriever API.

Fields

source: String

Required. Name of the resource for retrieval. Example: corpora/123 or corpora/123/documents/abc.

query: Option<Content>

Required. Query to use for matching Chunks in the given resource by similarity.

metadata_filters: Vec<MetadataFilter>

Optional. Filters for selecting Documents and/or Chunks from the resource.

max_chunks_count: Option<i32>

Optional. Maximum number of relevant Chunks to retrieve.

minimum_relevance_score: Option<f32>

Optional. Minimum relevance score for retrieved relevant Chunks.

Implementations

impl SemanticRetrieverConfig

pub fn max_chunks_count(&self) -> i32

Returns the value of max_chunks_count, or the default value if max_chunks_count is unset.

pub fn minimum_relevance_score(&self) -> f32

Returns the value of minimum_relevance_score, or the default value if minimum_relevance_score is unset.

Trait Implementations

impl Clone for SemanticRetrieverConfig

fn clone(&self) -> SemanticRetrieverConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SemanticRetrieverConfig

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

Formats the value using the given formatter.

impl Default for SemanticRetrieverConfig

fn default() -> Self

Returns the “default value” for a type.

impl Message for SemanticRetrieverConfig

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 SemanticRetrieverConfig

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