Struct AnalyzeTableQueryPlanRequest 

pub struct AnalyzeTableQueryPlanRequest {

    pub identity: Option<Box<Identity>>,
    pub context: Option<HashMap<String, String>>,
    pub id: Option<Vec<String>>,
    pub bypass_vector_index: Option<bool>,
    pub columns: Option<Box<QueryTableRequestColumns>>,
    pub distance_type: Option<String>,
    pub ef: Option<i32>,
    pub fast_search: Option<bool>,
    pub filter: Option<String>,
    pub full_text_query: Option<Box<QueryTableRequestFullTextQuery>>,
    pub k: i32,
    pub lower_bound: Option<f32>,
    pub nprobes: Option<i32>,
    pub offset: Option<i32>,
    pub prefilter: Option<bool>,
    pub refine_factor: Option<i32>,
    pub upper_bound: Option<f32>,
    pub vector: Box<QueryTableRequestVector>,
    pub vector_column: Option<String>,
    pub version: Option<i64>,
    pub with_row_id: Option<bool>,
}

Fields

identity: Option<Box<Identity>>

context: Option<HashMap<String, String>>

Arbitrary context for a request as key-value pairs. How to use the context is custom to the specific implementation. REST NAMESPACE ONLY Context entries are passed via HTTP headers using the naming convention x-lance-ctx-<key>: <value>. For example, a context entry {\"trace_id\": \"abc123\"} would be sent as the header x-lance-ctx-trace_id: abc123.

id: Option<Vec<String>>

bypass_vector_index: Option<bool>

Whether to bypass vector index

columns: Option<Box<QueryTableRequestColumns>>

distance_type: Option<String>

Distance metric to use

ef: Option<i32>

Search effort parameter for HNSW index

fast_search: Option<bool>

Whether to use fast search

filter: Option<String>

Optional SQL filter expression

full_text_query: Option<Box<QueryTableRequestFullTextQuery>>

k: i32

Number of results to return

lower_bound: Option<f32>

Lower bound for search

nprobes: Option<i32>

Number of probes for IVF index

offset: Option<i32>

Number of results to skip

prefilter: Option<bool>

Whether to apply filtering before vector search

refine_factor: Option<i32>

Refine factor for search

upper_bound: Option<f32>

Upper bound for search

vector: Box<QueryTableRequestVector>

vector_column: Option<String>

Name of the vector column to search

version: Option<i64>

Table version to query

with_row_id: Option<bool>

If true, return the row id as a column called _rowid

Implementations

impl AnalyzeTableQueryPlanRequest

pub fn new( k: i32, vector: QueryTableRequestVector, ) -> AnalyzeTableQueryPlanRequest

Trait Implementations

impl Clone for AnalyzeTableQueryPlanRequest

fn clone(&self) -> AnalyzeTableQueryPlanRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AnalyzeTableQueryPlanRequest

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

Formats the value using the given formatter.

impl Default for AnalyzeTableQueryPlanRequest

fn default() -> AnalyzeTableQueryPlanRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AnalyzeTableQueryPlanRequest

fn deserialize<__D>( __deserializer: __D, ) -> Result<AnalyzeTableQueryPlanRequest, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for AnalyzeTableQueryPlanRequest

fn eq(&self, other: &AnalyzeTableQueryPlanRequest) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for AnalyzeTableQueryPlanRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for AnalyzeTableQueryPlanRequest