lance_namespace_reqwest_client/models/
query_table_request.rs

1/*
2 * Lance Namespace Specification
3 *
4 * This OpenAPI specification is a part of the Lance namespace specification. It contains 2 parts:  The `components/schemas`, `components/responses`, `components/examples`, `tags` sections define the request and response shape for each operation in a Lance Namespace across all implementations. See https://lance.org/format/namespace/operations for more details.  The `servers`, `security`, `paths`, `components/parameters` sections are for the  Lance REST Namespace implementation, which defines a complete REST server that can work with Lance datasets. See https://lance.org/format/namespace/rest for more details. 
5 *
6 * The version of the OpenAPI document: 1.0.0
7 * 
8 * Generated by: https://openapi-generator.tech
9 */
10
11use crate::models;
12use serde::{Deserialize, Serialize};
13
14#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
15pub struct QueryTableRequest {
16    #[serde(rename = "identity", skip_serializing_if = "Option::is_none")]
17    pub identity: Option<Box<models::Identity>>,
18    /// 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`. 
19    #[serde(rename = "context", skip_serializing_if = "Option::is_none")]
20    pub context: Option<std::collections::HashMap<String, String>>,
21    #[serde(rename = "id", skip_serializing_if = "Option::is_none")]
22    pub id: Option<Vec<String>>,
23    /// Whether to bypass vector index
24    #[serde(rename = "bypass_vector_index", skip_serializing_if = "Option::is_none")]
25    pub bypass_vector_index: Option<bool>,
26    #[serde(rename = "columns", skip_serializing_if = "Option::is_none")]
27    pub columns: Option<Box<models::QueryTableRequestColumns>>,
28    /// Distance metric to use
29    #[serde(rename = "distance_type", skip_serializing_if = "Option::is_none")]
30    pub distance_type: Option<String>,
31    /// Search effort parameter for HNSW index
32    #[serde(rename = "ef", skip_serializing_if = "Option::is_none")]
33    pub ef: Option<i32>,
34    /// Whether to use fast search
35    #[serde(rename = "fast_search", skip_serializing_if = "Option::is_none")]
36    pub fast_search: Option<bool>,
37    /// Optional SQL filter expression
38    #[serde(rename = "filter", skip_serializing_if = "Option::is_none")]
39    pub filter: Option<String>,
40    #[serde(rename = "full_text_query", skip_serializing_if = "Option::is_none")]
41    pub full_text_query: Option<Box<models::QueryTableRequestFullTextQuery>>,
42    /// Number of results to return
43    #[serde(rename = "k")]
44    pub k: i32,
45    /// Lower bound for search
46    #[serde(rename = "lower_bound", skip_serializing_if = "Option::is_none")]
47    pub lower_bound: Option<f32>,
48    /// Number of probes for IVF index
49    #[serde(rename = "nprobes", skip_serializing_if = "Option::is_none")]
50    pub nprobes: Option<i32>,
51    /// Number of results to skip
52    #[serde(rename = "offset", skip_serializing_if = "Option::is_none")]
53    pub offset: Option<i32>,
54    /// Whether to apply filtering before vector search
55    #[serde(rename = "prefilter", skip_serializing_if = "Option::is_none")]
56    pub prefilter: Option<bool>,
57    /// Refine factor for search
58    #[serde(rename = "refine_factor", skip_serializing_if = "Option::is_none")]
59    pub refine_factor: Option<i32>,
60    /// Upper bound for search
61    #[serde(rename = "upper_bound", skip_serializing_if = "Option::is_none")]
62    pub upper_bound: Option<f32>,
63    #[serde(rename = "vector")]
64    pub vector: Box<models::QueryTableRequestVector>,
65    /// Name of the vector column to search
66    #[serde(rename = "vector_column", skip_serializing_if = "Option::is_none")]
67    pub vector_column: Option<String>,
68    /// Table version to query
69    #[serde(rename = "version", skip_serializing_if = "Option::is_none")]
70    pub version: Option<i64>,
71    /// If true, return the row id as a column called `_rowid`
72    #[serde(rename = "with_row_id", skip_serializing_if = "Option::is_none")]
73    pub with_row_id: Option<bool>,
74}
75
76impl QueryTableRequest {
77    pub fn new(k: i32, vector: models::QueryTableRequestVector) -> QueryTableRequest {
78        QueryTableRequest {
79            identity: None,
80            context: None,
81            id: None,
82            bypass_vector_index: None,
83            columns: None,
84            distance_type: None,
85            ef: None,
86            fast_search: None,
87            filter: None,
88            full_text_query: None,
89            k,
90            lower_bound: None,
91            nprobes: None,
92            offset: None,
93            prefilter: None,
94            refine_factor: None,
95            upper_bound: None,
96            vector: Box::new(vector),
97            vector_column: None,
98            version: None,
99            with_row_id: None,
100        }
101    }
102}
103
lance_namespace_reqwest_client/models/query_table_request.rs

lance_namespace_reqwest_client/models/
query_table_request.rs
