You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Update README Swift
[This list might not be relevant]
Merge pull request #81 from algolia/june2016-newparameters
added documentation for the new removeStopWords + exactOnSingleWordQu…
Wording & spelling review
Merge pull request #74 from algolia/remove-dead-link
Remove deadlink
added documentation for the new removeStopWords + exactOnSingleWordQuery + alternativesAsExact
Mention async client in python client README
Remove deadlink
Deadlink found by a customer to a missing "Examples" page. As I couldn't find
the missing page, I simply removed the link. See HelpScout conversation:
https://secure.helpscout.net/conversation/213111682/11426/?folderId=535884 [ci skip]
Copy file name to clipboardExpand all lines: README.md
+117-3Lines changed: 117 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -613,7 +613,65 @@ You can use the following optional arguments:
613
613
</div>
614
614
</td>
615
615
<td class='client-readme-param-content'>
616
-
<p>Remove the stop words from query before executing it. Defaults to false. Contains a list of stop words from 41 languages (Arabic, Armenian, Basque, Bengali, Brazilian, Bulgarian, Catalan, Chinese, Czech, Danish, Dutch, English, Finnish, French, Galician, German, Greek, Hindi, Hungarian, Indonesian, Irish, Italian, Japanese, Korean, Kurdish, Latvian, Lithuanian, Marathi, Norwegian, Persian, Polish, Portugese, Romanian, Russian, Slovak, Spanish, Swedish, Thai, Turkish, Ukranian, Urdu). In most use-cases, we don't recommend enabling this option.</p>
616
+
<p>Remove stop words from the query <strong>before</strong> executing it. Defaults to <code>false</code>. Use a boolean to enable/disable all 41 supported languages and a comma separated list of iso codes of the languages you want to use consider to enable the stopwords removal on a subset of them (select the one you have in your records). In most use-cases, you shouldn't need to enable this option.</p>
617
+
618
+
<p>List of 41 supported languages with their associated iso code: Arabic=ar, Armenian=hy, Basque=eu, Bengali=bn, Brazilian=pt-br, Bulgarian=bg, Catalan=ca, Chinese=zh, Czech=cs, Danish=da, Dutch=nl, English=en, Finnish=fi, French=fr, Galician=gl, German=de, Greek=el, Hindi=hi, Hungarian=hu, Indonesian=id, Irish=ga, Italian=it, Japanese=ja, Korean=ko, Kurdish=ku, Latvian=lv, Lithuanian=lt, Marathi=mr, Norwegian=no, Persian (Farsi)=fa, Polish=pl, Portugese=pt, Romanian=ro, Russian=ru, Slovak=sk, Spanish=es, Swedish=sv, Thai=th, Turkish=tr, Ukranian=uk, Urdu=ur</p>
619
+
620
+
<p>Stop words removal is applied on query words that are not interpreted as a prefix. The behavior depends of the queryType parameter:</p>
621
+
622
+
<ul>
623
+
<li><p><code>queryType=prefixLast</code> means the last query word is a prefix and it won’t be considered for stop words removal</p></li>
624
+
<li><p><code>queryType=prefixNone</code> means no query word are prefix, stop words removal will be applied on all query words</p></li>
625
+
<li><p><code>queryType=prefixAll</code> means all query terms are prefix, stop words won’t be removed</p></li>
626
+
</ul>
627
+
628
+
<p>This parameter is useful when you have a query in natural language like “what is a record?”. In this case, before executing the query, we will remove “what”, “is” and “a” in order to just search for “record”. This removal will remove false positive because of stop words, especially when combined with optional words. For most use cases, it is better to not use this feature as people search by keywords on search engines.</p>
<p>This parameter control how the <code>exact</code> ranking criterion is computed when the query contains one word. There is three different values:</p>
646
+
647
+
<ul>
648
+
<li><p><code>false</code>: no exact on single word query</p></li>
649
+
<li><p><code>word</code>: exact set to 1 if the query word is found in the record. The query word needs to have at least 3 chars and not be part of our stop words dictionary</p></li>
650
+
<li><p><code>attribute</code> (default): exact set to 1 if there is an attribute containing a string equals to the query</p></li>
<div class="client-readme-param-meta"><div><em>Type:<strong>boolean or string array</strong></em></div><div><em>Default:<strong>false</strong></em></div></div>
1974
+
</div>
1975
+
</div>
1976
+
</td>
1977
+
<td class='client-readme-param-content'>
1978
+
<p>Remove stop words from the query <strong>before</strong> executing it. Defaults to <code>false</code>. Use a boolean to enable/disable all 41 supported languages and an array of string listing the iso codes of the languages you want to use consider to enable the stop words removal on a subset of them (select the one you have in your records).</p>
<p>Stop words removal is applied on query words that are not interpreted as a prefix. The behavior depends of the queryType setting:</p>
1983
+
1984
+
<ul>
1985
+
<li><p><code>queryType=prefixLast</code> means the last query word is a prefix and it won’t be considered for stop words removal</p></li>
1986
+
<li><p><code>queryType=prefixNone</code> means no query word are prefix, stop words removal will be applied on all query words</p></li>
1987
+
<li><p><code>queryType=prefixAll</code> means all query terms are prefix, stop words won’t be removed</p></li>
1988
+
</ul>
1989
+
1990
+
<p>This index setting is useful when you have queries in natural language like “what is a record?”. In this case, before executing the query, we will remove “what”, “is” and “a” in order to just search for “record”. This removal will remove false positive because of stop words. For most use cases, it is better to not use this feature as people search by keywords on search engines.</p>
<p>Remove stop words from query before executing it. Defaults to false. Contains stop words for41languages (Arabic, Armenian, Basque, Bengali, Brazilian, Bulgarian, Catalan, Chinese, Czech, Danish, Dutch, English, Finnish, French, Galician, German, Greek, Hindi, Hungarian, Indonesian, Irish, Italian, Japanese, Korean, Kurdish, Latvian, Lithuanian, Marathi, Norwegian, Persian, Polish, Portugese, Romanian, Russian, Slovak, Spanish, Swedish, Thai, Turkish, Ukranian, Urdu)</p>
2006
+
<p>This parameter controls how the <code>exact</code> ranking criterion is computed when the query contains one word. There is three different values:</p>
2007
+
2008
+
<ul>
2009
+
<li><p><code>false</code>: no <code>exact</code> on single word query</p></li>
2010
+
<li><p><code>word</code>:<code>exact</code>set to 1if the query word is found in the record. The query word needs to have at least 3 chars and not be part of our stop words dictionary</p></li>
2011
+
<li><p><code>attribute</code> (default): exact set to 1if there is an attribute containing a string equals to the query</p></li>
0 commit comments