pub struct Select {
pub keys: HashSet<Key>,
}Expand description
Field selection for search results.
Specifies which fields to include in the results. IDs are always included.
§Fields
keys- Set of keys to include in results
§Available Keys
Key::Document- Document text contentKey::Embedding- Vector embeddingsKey::Metadata- All metadata fieldsKey::Score- Search scoresKey::field("name")- Specific metadata field
§Performance
Selecting fewer fields improves performance by reducing data transfer:
- Minimal: IDs only (default, fastest)
- Moderate: Scores + specific metadata fields
- Heavy: Documents + embeddings (larger payloads)
§Examples
use chroma_types::operator::{Select, Key};
use std::collections::HashSet;
// Select predefined fields
let select = Select {
keys: [Key::Document, Key::Score].into_iter().collect(),
};
// Select specific metadata fields
let select = Select {
keys: [
Key::field("title"),
Key::field("author"),
Key::Score,
].into_iter().collect(),
};
// Select everything
let select = Select {
keys: [
Key::Document,
Key::Embedding,
Key::Metadata,
Key::Score,
].into_iter().collect(),
};Fields§
§keys: HashSet<Key>Trait Implementations§
Source§impl<'de> Deserialize<'de> for Select
impl<'de> Deserialize<'de> for Select
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
Source§impl TryFrom<Select> for SelectOperator
impl TryFrom<Select> for SelectOperator
Source§impl TryFrom<SelectOperator> for Select
impl TryFrom<SelectOperator> for Select
Source§type Error = QueryConversionError
type Error = QueryConversionError
The type returned in the event of a conversion error.
Auto Trait Implementations§
impl Freeze for Select
impl RefUnwindSafe for Select
impl Send for Select
impl Sync for Select
impl Unpin for Select
impl UnwindSafe for Select
Blanket Implementations§
§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§unsafe fn clone_to_uninit(&self, dest: *mut u8)
unsafe fn clone_to_uninit(&self, dest: *mut u8)
🔬This is a nightly-only experimental API. (
clone_to_uninit)Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
Source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
Wrap the input message
T in a tonic::RequestSource§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if
self is actually part of its subset T (and can be converted to it).Source§unsafe fn to_subset_unchecked(&self) -> SS
unsafe fn to_subset_unchecked(&self) -> SS
Use with care! Same as
self.to_subset but without any property checks. Always succeeds.Source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.