blob: 5dc01c86c7627f6df172674aa0f6832924e1f865 [file]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Paimon-cpp: /home/runner/work/paimon-cpp/paimon-cpp/include/paimon/predicate/vector_search.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">Paimon-cpp
</div>
<div id="projectbrief">A high-performance C++ implementation of Apache Paimon</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_d5ce83a91c1ada980bd794a9f3314520.html">paimon</a></li><li class="navelem"><a class="el" href="dir_f621b1b7a8e367ca76a53c102fbe25fe.html">predicate</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">vector_search.h</div></div>
</div><!--header-->
<div class="contents">
<a href="vector__search_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * or more contributor license agreements. See the NOTICE file</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * distributed with this work for additional information</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * regarding copyright ownership. The ASF licenses this file</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> * to you under the Apache License, Version 2.0 (the</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> * &quot;License&quot;); you may not use this file except in compliance</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> * with the License. You may obtain a copy of the License at</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> *</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> *</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> * distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> * See the License for the specific language governing permissions and</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> * limitations under the License.</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment"> */</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> </div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#include &lt;functional&gt;</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#include &lt;map&gt;</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="preprocessor">#include &lt;memory&gt;</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor">#include &lt;optional&gt;</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#include &lt;vector&gt;</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor">#include &quot;<a class="code" href="predicate_8h.html">paimon/predicate/predicate.h</a>&quot;</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="preprocessor">#include &quot;<a class="code" href="visibility_8h.html">paimon/visibility.h</a>&quot;</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacepaimon.html">paimon</a> {</div>
<div class="foldopen" id="foldopen00032" data-start="{" data-end="};">
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"><a class="line" href="structpaimon_1_1_vector_search.html"> 32</a></span><span class="keyword">struct </span><a class="code hl_define" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">PAIMON_EXPORT</a> <a class="code hl_struct" href="structpaimon_1_1_vector_search.html">VectorSearch</a> {</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"><a class="line" href="structpaimon_1_1_vector_search.html#a294b3b66e32c02cdd139dc87b3e7bae1"> 40</a></span> <span class="keyword">using </span><a class="code hl_typedef" href="structpaimon_1_1_vector_search.html#a294b3b66e32c02cdd139dc87b3e7bae1">PreFilter</a> = std::function&lt;<a class="code hl_define" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">bool</a>(<a class="code hl_define" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">int64_t</a>)&gt;;</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> </div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"><a class="line" href="structpaimon_1_1_vector_search.html#a6f960bf74c4872082c36d26c05c95bef"> 43</a></span> <span class="keyword">enum class</span> <a class="code hl_enumeration" href="structpaimon_1_1_vector_search.html#a6f960bf74c4872082c36d26c05c95bef">DistanceType</a> { EUCLIDEAN = 1, INNER_PRODUCT = 2, COSINE = 3, <a class="code hl_enumvalue" href="namespacepaimon.html#aa6dc6701f497b96add0b6d7a5d6497f7a696b031073e74bf2cb98e5ef201d4aa3">UNKNOWN</a> = 128 };</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> </div>
<div class="foldopen" id="foldopen00045" data-start="{" data-end="}">
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"><a class="line" href="structpaimon_1_1_vector_search.html#ac60c0f481348c78b9fc8c94261302a93"> 45</a></span> <a class="code hl_function" href="structpaimon_1_1_vector_search.html#ac60c0f481348c78b9fc8c94261302a93">VectorSearch</a>(<span class="keyword">const</span> std::string&amp; <a class="code hl_define" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">_field_name</a>, <a class="code hl_define" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">int32_t</a> <a class="code hl_define" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">_limit</a>, <span class="keyword">const</span> std::vector&lt;float&gt;&amp; <a class="code hl_define" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">_query</a>,</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> <a class="code hl_typedef" href="structpaimon_1_1_vector_search.html#a294b3b66e32c02cdd139dc87b3e7bae1">PreFilter</a> <a class="code hl_define" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">_pre_filter</a>, <span class="keyword">const</span> std::shared_ptr&lt;Predicate&gt;&amp; <a class="code hl_define" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">_predicate</a>,</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <span class="keyword">const</span> std::optional&lt;DistanceType&gt;&amp; <a class="code hl_define" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">_distance_type</a>,</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> <span class="keyword">const</span> std::map&lt;std::string, std::string&gt;&amp; <a class="code hl_define" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">_options</a>)</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> : field_name(<a class="code hl_define" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">_field_name</a>),</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> limit(<a class="code hl_define" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">_limit</a>),</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> query(<a class="code hl_define" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">_query</a>),</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> pre_filter(<a class="code hl_define" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">_pre_filter</a>),</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> predicate(<a class="code hl_define" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">_predicate</a>),</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> distance_type(<a class="code hl_define" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">_distance_type</a>),</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> options(<a class="code hl_define" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">_options</a>) {}</div>
</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> </div>
<div class="foldopen" id="foldopen00057" data-start="{" data-end="}">
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"><a class="line" href="structpaimon_1_1_vector_search.html#afbf31025f628951de5c3ff5ba1eabd2a"> 57</a></span> std::shared_ptr&lt;VectorSearch&gt; <a class="code hl_function" href="structpaimon_1_1_vector_search.html#afbf31025f628951de5c3ff5ba1eabd2a">ReplacePreFilter</a>(<a class="code hl_typedef" href="structpaimon_1_1_vector_search.html#a294b3b66e32c02cdd139dc87b3e7bae1">PreFilter</a> <a class="code hl_define" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">_pre_filter</a>)<span class="keyword"> const </span>{</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> <span class="keywordflow">return</span> std::make_shared&lt;VectorSearch&gt;(field_name, limit, query, <a class="code hl_define" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">_pre_filter</a>, predicate,</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> distance_type, options);</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> }</div>
</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> </div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"><a class="line" href="structpaimon_1_1_vector_search.html#aa03f39649c522c7e757cfb8e43a7dc67"> 63</a></span> std::string <a class="code hl_variable" href="structpaimon_1_1_vector_search.html#aa03f39649c522c7e757cfb8e43a7dc67">field_name</a>;</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"><a class="line" href="structpaimon_1_1_vector_search.html#a00cdd95028fa4e3edf96e71afea26bc4"> 65</a></span> <a class="code hl_define" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">int32_t</a> <a class="code hl_variable" href="structpaimon_1_1_vector_search.html#a00cdd95028fa4e3edf96e71afea26bc4">limit</a>;</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"><a class="line" href="structpaimon_1_1_vector_search.html#ac90fea2a7e3d795ae509cd78f500ee20"> 67</a></span> std::vector&lt;float&gt; <a class="code hl_variable" href="structpaimon_1_1_vector_search.html#ac90fea2a7e3d795ae509cd78f500ee20">query</a>;</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"><a class="line" href="structpaimon_1_1_vector_search.html#a6e6dc0d2cf6b4a7791efb80b80a57589"> 69</a></span> std::function&lt;<a class="code hl_define" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">bool</a>(<a class="code hl_define" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">int64_t</a>)&gt; <a class="code hl_variable" href="structpaimon_1_1_vector_search.html#a6e6dc0d2cf6b4a7791efb80b80a57589">pre_filter</a>;</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"><a class="line" href="structpaimon_1_1_vector_search.html#a69111b7d3e96471b31f364eef152bbe8"> 83</a></span> std::shared_ptr&lt;Predicate&gt; <a class="code hl_variable" href="structpaimon_1_1_vector_search.html#a69111b7d3e96471b31f364eef152bbe8">predicate</a>;</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"><a class="line" href="structpaimon_1_1_vector_search.html#a4d9869e20b0c4fe464aa3afef46de546"> 88</a></span> std::optional&lt;DistanceType&gt; <a class="code hl_variable" href="structpaimon_1_1_vector_search.html#a4d9869e20b0c4fe464aa3afef46de546">distance_type</a>;</div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"><a class="line" href="structpaimon_1_1_vector_search.html#a75b4356198ae0c851bea1909e578611e"> 91</a></span> std::map&lt;std::string, std::string&gt; <a class="code hl_variable" href="structpaimon_1_1_vector_search.html#a75b4356198ae0c851bea1909e578611e">options</a>;</div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span>};</div>
</div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span>} <span class="comment">// namespace paimon</span></div>
<div class="ttc" id="amemory__pool_8h_html_a147ba4ba34a215b3a4f3a95c1ee11704"><div class="ttname"><a href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">PAIMON_UNIQUE_PTR</a></div><div class="ttdeci">#define PAIMON_UNIQUE_PTR</div><div class="ttdef"><b>Definition</b> memory_pool.h:220</div></div>
<div class="ttc" id="anamespacepaimon_html"><div class="ttname"><a href="namespacepaimon.html">paimon</a></div><div class="ttdoc">Top-level namespace for Paimon C++ API.</div><div class="ttdef"><b>Definition</b> api.h:47</div></div>
<div class="ttc" id="anamespacepaimon_html_aa6dc6701f497b96add0b6d7a5d6497f7a696b031073e74bf2cb98e5ef201d4aa3"><div class="ttname"><a href="namespacepaimon.html#aa6dc6701f497b96add0b6d7a5d6497f7a696b031073e74bf2cb98e5ef201d4aa3">paimon::FieldType::UNKNOWN</a></div><div class="ttdeci">@ UNKNOWN</div></div>
<div class="ttc" id="apredicate_8h_html"><div class="ttname"><a href="predicate_8h.html">predicate.h</a></div></div>
<div class="ttc" id="astructpaimon_1_1_vector_search_html"><div class="ttname"><a href="structpaimon_1_1_vector_search.html">paimon::VectorSearch</a></div><div class="ttdoc">VectorSearch to perform vector similarity search.</div><div class="ttdef"><b>Definition</b> vector_search.h:32</div></div>
<div class="ttc" id="astructpaimon_1_1_vector_search_html_a00cdd95028fa4e3edf96e71afea26bc4"><div class="ttname"><a href="structpaimon_1_1_vector_search.html#a00cdd95028fa4e3edf96e71afea26bc4">paimon::VectorSearch::limit</a></div><div class="ttdeci">int32_t limit</div><div class="ttdoc">Number of top results to return.</div><div class="ttdef"><b>Definition</b> vector_search.h:65</div></div>
<div class="ttc" id="astructpaimon_1_1_vector_search_html_a294b3b66e32c02cdd139dc87b3e7bae1"><div class="ttname"><a href="structpaimon_1_1_vector_search.html#a294b3b66e32c02cdd139dc87b3e7bae1">paimon::VectorSearch::PreFilter</a></div><div class="ttdeci">std::function&lt; bool(int64_t)&gt; PreFilter</div><div class="ttdoc">PreFilter: A lightweight pre-filtering function applied before similarity scoring.</div><div class="ttdef"><b>Definition</b> vector_search.h:40</div></div>
<div class="ttc" id="astructpaimon_1_1_vector_search_html_a4d9869e20b0c4fe464aa3afef46de546"><div class="ttname"><a href="structpaimon_1_1_vector_search.html#a4d9869e20b0c4fe464aa3afef46de546">paimon::VectorSearch::distance_type</a></div><div class="ttdeci">std::optional&lt; DistanceType &gt; distance_type</div><div class="ttdoc">The distance metric to use for this query, if explicitly specified.</div><div class="ttdef"><b>Definition</b> vector_search.h:88</div></div>
<div class="ttc" id="astructpaimon_1_1_vector_search_html_a69111b7d3e96471b31f364eef152bbe8"><div class="ttname"><a href="structpaimon_1_1_vector_search.html#a69111b7d3e96471b31f364eef152bbe8">paimon::VectorSearch::predicate</a></div><div class="ttdeci">std::shared_ptr&lt; Predicate &gt; predicate</div><div class="ttdoc">A runtime filtering condition that may involve graph traversal of structured attributes.</div><div class="ttdef"><b>Definition</b> vector_search.h:83</div></div>
<div class="ttc" id="astructpaimon_1_1_vector_search_html_a6e6dc0d2cf6b4a7791efb80b80a57589"><div class="ttname"><a href="structpaimon_1_1_vector_search.html#a6e6dc0d2cf6b4a7791efb80b80a57589">paimon::VectorSearch::pre_filter</a></div><div class="ttdeci">std::function&lt; bool(int64_t)&gt; pre_filter</div><div class="ttdoc">A pre-filter based on global row ids, implemented by leveraging other global index.</div><div class="ttdef"><b>Definition</b> vector_search.h:69</div></div>
<div class="ttc" id="astructpaimon_1_1_vector_search_html_a6f960bf74c4872082c36d26c05c95bef"><div class="ttname"><a href="structpaimon_1_1_vector_search.html#a6f960bf74c4872082c36d26c05c95bef">paimon::VectorSearch::DistanceType</a></div><div class="ttdeci">DistanceType</div><div class="ttdoc">Enumeration of distance or similarity metrics for vector comparison.</div><div class="ttdef"><b>Definition</b> vector_search.h:43</div></div>
<div class="ttc" id="astructpaimon_1_1_vector_search_html_a75b4356198ae0c851bea1909e578611e"><div class="ttname"><a href="structpaimon_1_1_vector_search.html#a75b4356198ae0c851bea1909e578611e">paimon::VectorSearch::options</a></div><div class="ttdeci">std::map&lt; std::string, std::string &gt; options</div><div class="ttdoc">A key-value map of query-specific runtime options.</div><div class="ttdef"><b>Definition</b> vector_search.h:91</div></div>
<div class="ttc" id="astructpaimon_1_1_vector_search_html_aa03f39649c522c7e757cfb8e43a7dc67"><div class="ttname"><a href="structpaimon_1_1_vector_search.html#aa03f39649c522c7e757cfb8e43a7dc67">paimon::VectorSearch::field_name</a></div><div class="ttdeci">std::string field_name</div><div class="ttdoc">Search field name.</div><div class="ttdef"><b>Definition</b> vector_search.h:63</div></div>
<div class="ttc" id="astructpaimon_1_1_vector_search_html_ac60c0f481348c78b9fc8c94261302a93"><div class="ttname"><a href="structpaimon_1_1_vector_search.html#ac60c0f481348c78b9fc8c94261302a93">paimon::VectorSearch::VectorSearch</a></div><div class="ttdeci">VectorSearch(const std::string &amp;_field_name, int32_t _limit, const std::vector&lt; float &gt; &amp;_query, PreFilter _pre_filter, const std::shared_ptr&lt; Predicate &gt; &amp;_predicate, const std::optional&lt; DistanceType &gt; &amp;_distance_type, const std::map&lt; std::string, std::string &gt; &amp;_options)</div><div class="ttdef"><b>Definition</b> vector_search.h:45</div></div>
<div class="ttc" id="astructpaimon_1_1_vector_search_html_ac90fea2a7e3d795ae509cd78f500ee20"><div class="ttname"><a href="structpaimon_1_1_vector_search.html#ac90fea2a7e3d795ae509cd78f500ee20">paimon::VectorSearch::query</a></div><div class="ttdeci">std::vector&lt; float &gt; query</div><div class="ttdoc">The query vector (must match the dimensionality of the indexed vectors).</div><div class="ttdef"><b>Definition</b> vector_search.h:67</div></div>
<div class="ttc" id="astructpaimon_1_1_vector_search_html_afbf31025f628951de5c3ff5ba1eabd2a"><div class="ttname"><a href="structpaimon_1_1_vector_search.html#afbf31025f628951de5c3ff5ba1eabd2a">paimon::VectorSearch::ReplacePreFilter</a></div><div class="ttdeci">std::shared_ptr&lt; VectorSearch &gt; ReplacePreFilter(PreFilter _pre_filter) const</div><div class="ttdef"><b>Definition</b> vector_search.h:57</div></div>
<div class="ttc" id="avisibility_8h_html"><div class="ttname"><a href="visibility_8h.html">visibility.h</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>