Merge branch 'master' of https://github.com/vector-ai/vectorai

Author: Jacky Koh

docs/_static/basic.css

@@ -764,6 +764,7 @@ div.code-block-caption code {
 }
 
 table.highlighttable td.linenos,
+span.linenos,
 div.doctest > div.highlight span.gp {  /* gp: Generic.Prompt */
     user-select: none;
 }

docs/_static/doctools.js

@@ -285,9 +285,10 @@ var Documentation = {
   initOnKeyListeners: function() {
     $(document).keydown(function(event) {
       var activeElementType = document.activeElement.tagName;
-      // don't navigate when in search box or textarea
+      // don't navigate when in search box, textarea, dropdown or button
       if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT'
-          && !event.altKey && !event.ctrlKey && !event.metaKey && !event.shiftKey) {
+          && activeElementType !== 'BUTTON' && !event.altKey && !event.ctrlKey && !event.metaKey
+          && !event.shiftKey) {
         switch (event.keyCode) {
           case 37: // left
             var prevHref = $('link[rel="prev"]').prop('href');

docs/_static/searchtools.js

@@ -59,10 +59,10 @@ var Search = {
   _pulse_status : -1,
 
   htmlToText : function(htmlString) {
-      var htmlElement = document.createElement('span');
-      htmlElement.innerHTML = htmlString;
-      $(htmlElement).find('.headerlink').remove();
-      docContent = $(htmlElement).find('[role=main]')[0];
+      var virtualDocument = document.implementation.createHTMLDocument('virtual');
+      var htmlElement = $(htmlString, virtualDocument);
+      htmlElement.find('.headerlink').remove();
+      docContent = htmlElement.find('[role=main]')[0];
       if(docContent === undefined) {
           console.warn("Content block not found. Sphinx search tries to obtain it " +
                        "via '[role=main]'. Could you check your theme or template.");

docs/client.html

@@ -900,6 +900,23 @@ <h2>Client<a class="headerlink" href="#id1" title="Permalink to this headline">
 </dl>
 </dd></dl>
 
+<dl class="py method">
+<dt id="vectorai.client.ViCollectionClient.create_filter_query">
+<code class="sig-name descname">create_filter_query</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">collection_name</span><span class="p">:</span> <span class="n">str</span></em>, <em class="sig-param"><span class="n">field</span><span class="p">:</span> <span class="n">str</span></em>, <em class="sig-param"><span class="n">filter_type</span><span class="p">:</span> <span class="n">str</span></em>, <em class="sig-param"><span class="n">filter_values</span><span class="p">:</span> <span class="n">Union<span class="p">[</span>List<span class="p">[</span>str<span class="p">]</span><span class="p">, </span>str<span class="p">]</span></span> <span class="o">=</span> <span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vectorai.client.ViCollectionClient.create_filter_query" title="Permalink to this definition">¶</a></dt>
+<dd><p>Filter type can be one of contains/exact_match/categories/exists/insert_date/numeric_range
+Filter types can be one of:
+contains: Field must contain this specific string. Not case sensitive.
+exact_match: Field must have an exact match
+categories: Matches entire field
+exists: If field exists in document
+&gt;= / &gt; / &lt; / &lt;= : Larger than or equal to / Larger than / Smaller than / Smaller than or equal to
+These, however, can only be applied on numeric/date values. Check collection_schema.</p>
+<p>Args:
+collection_name: The name of the collection
+field: The field to filter on
+filter_type: One of contains/exact_match/categories/&gt;=/&gt;/&lt;=/&lt;.</p>
+</dd></dl>
+
 <dl class="py method">
 <dt id="vectorai.client.ViCollectionClient.delete_by_id">
 <code class="sig-name descname">delete_by_id</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">collection_name</span><span class="p">:</span> <span class="n">str</span></em>, <em class="sig-param"><span class="n">document_id</span><span class="p">:</span> <span class="n">str</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vectorai.client.ViCollectionClient.delete_by_id" title="Permalink to this definition">¶</a></dt>

docs/genindex.html

@@ -349,14 +349,14 @@ <h2 id="C">C</h2>
         <li><a href="client.html#vectorai.client.ViCollectionClient.cluster_facets">(vectorai.client.ViCollectionClient method)</a>
 </li>
       </ul></li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="cluster.html#vectorai.api.cluster.ViClusterClient.clustering_job">clustering_job() (vectorai.api.cluster.ViClusterClient method)</a>
 
       <ul>
         <li><a href="client.html#vectorai.client.ViCollectionClient.clustering_job">(vectorai.client.ViCollectionClient method)</a>
 </li>
       </ul></li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="read.html#vectorai.api.read.ViReadAPIClient.collection_schema">collection_schema() (vectorai.api.read.ViReadAPIClient method)</a>
 
       <ul>
@@ -381,6 +381,12 @@ <h2 id="C">C</h2>
 
       <ul>
         <li><a href="client.html#vectorai.client.ViCollectionClient.create_collection_from_document">(vectorai.client.ViCollectionClient method)</a>
+</li>
+      </ul></li>
+      <li><a href="client.html#vectorai.client.ViCollectionClient.create_filter_query">create_filter_query() (vectorai.client.ViCollectionClient method)</a>
+
+      <ul>
+        <li><a href="read.html#vectorai.read.ViReadClient.create_filter_query">(vectorai.read.ViReadClient method)</a>
 </li>
       </ul></li>
   </ul></td>

docs/objects.inv

@@ -675,6 +675,23 @@ <h2>Read<a class="headerlink" href="#id1" title="Permalink to this headline">¶<
 </div>
 </dd></dl>
 
+<dl class="py method">
+<dt id="vectorai.read.ViReadClient.create_filter_query">
+<code class="sig-name descname">create_filter_query</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">collection_name</span><span class="p">:</span> <span class="n">str</span></em>, <em class="sig-param"><span class="n">field</span><span class="p">:</span> <span class="n">str</span></em>, <em class="sig-param"><span class="n">filter_type</span><span class="p">:</span> <span class="n">str</span></em>, <em class="sig-param"><span class="n">filter_values</span><span class="p">:</span> <span class="n">Union<span class="p">[</span>List<span class="p">[</span>str<span class="p">]</span><span class="p">, </span>str<span class="p">]</span></span> <span class="o">=</span> <span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vectorai.read.ViReadClient.create_filter_query" title="Permalink to this definition">¶</a></dt>
+<dd><p>Filter type can be one of contains/exact_match/categories/exists/insert_date/numeric_range
+Filter types can be one of:
+contains: Field must contain this specific string. Not case sensitive.
+exact_match: Field must have an exact match
+categories: Matches entire field
+exists: If field exists in document
+&gt;= / &gt; / &lt; / &lt;= : Larger than or equal to / Larger than / Smaller than / Smaller than or equal to
+These, however, can only be applied on numeric/date values. Check collection_schema.</p>
+<p>Args:
+collection_name: The name of the collection
+field: The field to filter on
+filter_type: One of contains/exact_match/categories/&gt;=/&gt;/&lt;=/&lt;.</p>
+</dd></dl>
+
 </dd></dl>
 
 </div>