Queries

Struct Queries 

Source
pub struct Queries<'a> { /* private fields */ }
Expand description

Queries resource for searching documents

Implementations§

Source§

impl<'a> Queries<'a>

Source

pub async fn top_documents( &self, collection_name: impl Into<String>, query: impl Into<String>, k: u32, filter: Option<Filter>, include_metadata: Option<bool>, latency_mode: Option<LatencyMode>, reranker: Option<String>, ) -> Result<TopDocumentsResponse>

Search for top documents matching a query

§Arguments
  • collection_name - Name of the collection to search
  • query - Natural language query
  • k - Number of documents to return (1-2048)
  • filter - Optional metadata filter
  • include_metadata - Whether to include metadata in results
  • latency_mode - Latency/quality tradeoff
  • reranker - Optional reranker model ID
Source

pub async fn top_pages( &self, collection_name: impl Into<String>, query: impl Into<String>, k: u32, filter: Option<Filter>, include_content: Option<bool>, latency_mode: Option<LatencyMode>, ) -> Result<TopPagesResponse>

Search for top pages matching a query

§Arguments
  • collection_name - Name of the collection to search
  • query - Natural language query
  • k - Number of pages to return (1-1024)
  • filter - Optional metadata filter
  • include_content - Whether to include page content
  • latency_mode - Latency/quality tradeoff
Source

pub async fn top_snippets( &self, collection_name: impl Into<String>, query: impl Into<String>, k: u32, filter: Option<Filter>, include_document_metadata: Option<bool>, precise_responses: Option<bool>, reranker: Option<String>, ) -> Result<TopSnippetsResponse>

Search for top snippets matching a query

§Arguments
  • collection_name - Name of the collection to search
  • query - Natural language query
  • k - Number of snippets to return
  • filter - Optional metadata filter
  • include_document_metadata - Whether to include document metadata
  • precise_responses - Longer snippets (around 2000 chars vs 200 chars)
  • reranker - Optional reranker model ID

Auto Trait Implementations§

§

impl<'a> Freeze for Queries<'a>

§

impl<'a> !RefUnwindSafe for Queries<'a>

§

impl<'a> Send for Queries<'a>

§

impl<'a> Sync for Queries<'a>

§

impl<'a> Unpin for Queries<'a>

§

impl<'a> !UnwindSafe for Queries<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,