Struct SimilarQuery 

pub struct SimilarQuery<'a, Http: HttpClient> {
    pub id: &'a str,
    pub embedder: &'a str,
    pub offset: Option<usize>,
    pub limit: Option<usize>,
    pub filter: Option<Filter<'a>>,
    pub attributes_to_retrieve: Option<Selectors<&'a [&'a str]>>,
    pub show_ranking_score: Option<bool>,
    pub show_ranking_score_details: Option<bool>,
    pub ranking_score_threshold: Option<f64>,
    pub retrieve_vectors: Option<bool>,
    /* private fields */
}

A struct representing a query.

You can add similar parameters using the builder syntax.

See this page for the official list and description of all parameters.

Examples

let mut res = index.similar_search("100", "default")
    .execute::<Movie>()
    .await
    .unwrap();

Fields

id: &'a str

Identifier of the target document

embedder: &'a str

Embedder to use when computing recommendations

offset: Option<usize>

Number of documents to skip

limit: Option<usize>

Maximum number of documents returned

filter: Option<Filter<'a>>

Filter queries by an attribute’s value

Read the dedicated guide to learn the syntax.

attributes_to_retrieve: Option<Selectors<&'a [&'a str]>>

Attributes to display in the returned documents.

Can be set to a wildcard value that will select all existing attributes.

Default: all attributes found in the documents.

show_ranking_score: Option<bool>

Defines whether to display the global ranking score of a document

Default: false

show_ranking_score_details: Option<bool>

Defines whether to display the detailed ranking score information

Default: false

ranking_score_threshold: Option<f64>

Defines whether to exclude results with low ranking scores

Default: None

retrieve_vectors: Option<bool>

Defines whether to return document vector data

Default: false

Implementations

impl<'a, Http: HttpClient> SimilarQuery<'a, Http>

pub fn new( index: &'a Index<Http>, id: &'a str, embedder: &'a str, ) -> SimilarQuery<'a, Http>

pub fn with_offset<'b>( &'b mut self, offset: usize, ) -> &'b mut SimilarQuery<'a, Http>

pub fn with_limit<'b>( &'b mut self, limit: usize, ) -> &'b mut SimilarQuery<'a, Http>

pub fn with_filter<'b>( &'b mut self, filter: &'a str, ) -> &'b mut SimilarQuery<'a, Http>

pub fn with_array_filter<'b>( &'b mut self, filter: Vec<&'a str>, ) -> &'b mut SimilarQuery<'a, Http>

pub fn with_attributes_to_retrieve<'b>( &'b mut self, attributes_to_retrieve: Selectors<&'a [&'a str]>, ) -> &'b mut SimilarQuery<'a, Http>

pub fn with_show_ranking_score<'b>( &'b mut self, show_ranking_score: bool, ) -> &'b mut SimilarQuery<'a, Http>

pub fn with_show_ranking_score_details<'b>( &'b mut self, show_ranking_score_details: bool, ) -> &'b mut SimilarQuery<'a, Http>

pub fn with_ranking_score_threshold<'b>( &'b mut self, ranking_score_threshold: f64, ) -> &'b mut SimilarQuery<'a, Http>

pub fn with_retrieve_vectors<'b>( &'b mut self, retrieve_vectors: bool, ) -> &'b mut SimilarQuery<'a, Http>

pub async fn execute<T: 'static + DeserializeOwned + Send + Sync>( &'a self, ) -> Result<SimilarResults<T>, Error>

Execute the query and fetch the results.

Trait Implementations

impl<'a, Http: Clone + HttpClient> Clone for SimilarQuery<'a, Http>

fn clone(&self) -> SimilarQuery<'a, Http>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a, Http: Debug + HttpClient> Debug for SimilarQuery<'a, Http>

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

Formats the value using the given formatter.

impl<'a, Http: HttpClient> Serialize for SimilarQuery<'a, Http>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.