pub struct Queries<'a> { /* private fields */ }Expand description
Queries resource for searching documents
Implementations§
Source§impl<'a> Queries<'a>
impl<'a> Queries<'a>
Sourcepub 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>
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 searchquery- Natural language queryk- Number of documents to return (1-2048)filter- Optional metadata filterinclude_metadata- Whether to include metadata in resultslatency_mode- Latency/quality tradeoffreranker- Optional reranker model ID
Sourcepub 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>
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 searchquery- Natural language queryk- Number of pages to return (1-1024)filter- Optional metadata filterinclude_content- Whether to include page contentlatency_mode- Latency/quality tradeoff
Sourcepub 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>
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 searchquery- Natural language queryk- Number of snippets to returnfilter- Optional metadata filterinclude_document_metadata- Whether to include document metadataprecise_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> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more