Skip to content
This repository was archived by the owner on Jan 31, 2022. It is now read-only.

Commit f14723b

Browse files
docs(README): automatic update
Update README Android [This list might not be relevant] docs: Fix `removeStopWords` query parameter - Properly document the dual type. - Improve description. docs(swift): Update supported platforms (again) My last change seems to have been overwritten… :/ [ci skip]
1 parent 9131f7b commit f14723b

File tree

1 file changed

+60
-60
lines changed

1 file changed

+60
-60
lines changed

README.md

Lines changed: 60 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -42,15 +42,15 @@ Getting started
4242

4343
Search
4444

45-
1. [Search in an index](#search-in-an-index---search)
46-
1. [Find by IDs](#find-by-ids---getobjects)
45+
1. [Search in an index](#search-in-an-index---searchasync)
46+
1. [Find by IDs](#find-by-ids---getobjectsasync)
4747

4848
Indexing
4949

50-
1. [Add objects](#add-objects---addobjects)
51-
1. [Update objects](#update-objects---saveobjects)
52-
1. [Partial update](#partial-update---partialupdateobjects)
53-
1. [Delete objects](#delete-objects---deleteobjects)
50+
1. [Add objects](#add-objects---addobjectsasync)
51+
1. [Update objects](#update-objects---saveobjectsasync)
52+
1. [Partial update](#partial-update---partialupdateobjectsasync)
53+
1. [Delete objects](#delete-objects---deleteobjectsasync)
5454

5555
Settings
5656

@@ -59,31 +59,31 @@ Settings
5959

6060
Manage Indices
6161

62-
1. [List indices](#list-indices---listindexes)
63-
1. [Delete index](#delete-index---deleteindex)
64-
1. [Clear index](#clear-index---clearindex)
65-
1. [Copy index](#copy-index---copyindex)
66-
1. [Move index](#move-index---moveindex)
62+
1. [List indices](#list-indices---listindexesasync)
63+
1. [Delete index](#delete-index---deleteindexasync)
64+
1. [Clear index](#clear-index---clearindexasync)
65+
1. [Copy index](#copy-index---copyindexasync)
66+
1. [Move index](#move-index---moveindexasync)
6767

6868
Api Keys
6969

70-
1. [Generate key](#generate-key---generatesecuredapikey)
70+
1. [Generate key](#generate-key)
7171

7272

7373

7474
Advanced
7575

76-
1. [Custom batch](#custom-batch---batch)
77-
1. [Wait for operations](#wait-for-operations---waittask)
78-
1. [Multiple queries](#multiple-queries---multiplequeries)
79-
1. [Delete by query](#delete-by-query---deletebyquery)
80-
1. [Backup / Export an index](#backup--export-an-index---browse)
81-
1. [List api keys](#list-api-keys---listapikeys)
82-
1. [Add user key](#add-user-key---adduserkey)
83-
1. [Update user key](#update-user-key---updateuserkey)
84-
1. [Delete user key](#delete-user-key---deleteuserkey)
85-
1. [Get key permissions](#get-key-permissions---getuserkeyacl)
86-
1. [Get Logs](#get-logs---getlogs)
76+
1. [Custom batch](#custom-batch---batchasync)
77+
1. [Wait for operations](#wait-for-operations---waittaskasync)
78+
1. [Multiple queries](#multiple-queries---multiplequeriesasync)
79+
1. [Delete by query](#delete-by-query---deletebyqueryasync)
80+
1. [Backup / Export an index](#backup--export-an-index---browseasync)
81+
1. [List api keys](#list-api-keys)
82+
1. [Add user key](#add-user-key)
83+
1. [Update user key](#update-user-key)
84+
1. [Delete user key](#delete-user-key)
85+
1. [Get key permissions](#get-key-permissions)
86+
1. [Get Logs](#get-logs)
8787

8888

8989

@@ -223,7 +223,7 @@ index.searchAsync(new Query("jim"), new CompletionHandler() {
223223

224224
## Search
225225

226-
### Search in an index - `search`
226+
### Search in an index - `searchAsync`
227227

228228

229229

@@ -289,7 +289,7 @@ Here is the list of parameters you can use with the search method (`search` [sco
289289
Parameters that can also be used in a setSettings also have the `indexing` [scope](#scope)
290290

291291
**Search**
292-
- [setQueryString](#setquerystring) `search`
292+
- [query](#query) `search`
293293

294294
**Attributes**
295295
- [attributesToRetrieve](#attributestoretrieve) `settings`, `search`
@@ -328,9 +328,9 @@ Parameters that can also be used in a setSettings also have the `indexing` [scop
328328
**Query Strategy**
329329
- [queryType](#querytype) `settings`, `search`
330330
- [removeWordsIfNoResults](#removewordsifnoresults) `settings`, `search`
331-
- [enableAdvancedSyntax](#enableadvancedsyntax) `settings`, `search`
331+
- [advancedSyntax](#advancedsyntax) `settings`, `search`
332332
- [optionalWords](#optionalwords) `settings`, `search`
333-
- [enableRemoveStopWords](#enableremovestopwords) `settings`, `search`
333+
- [removeStopWords](#removestopwords) `settings`, `search`
334334
- [exactOnSingleWordQuery](#exactonsinglewordquery) `settings`, `search`
335335
- [alternativesAsExact](#alternativesasexact) `settings`, `search`
336336

@@ -340,11 +340,11 @@ Parameters that can also be used in a setSettings also have the `indexing` [scop
340340
- [numericFilters (deprecated)](#numericfilters-deprecated) `search`
341341
- [tagFilters (deprecated)](#tagfilters-deprecated) `search`
342342
- [facetFilters (deprecated)](#facetfilters-deprecated) `search`
343-
- [enableAnalytics](#enableanalytics) `settings`, `search`
343+
- [analytics](#analytics) `settings`, `search`
344344

345345
<!--/PARAMETERS_LINK-->
346346

347-
### Find by IDs - `getObjects`
347+
### Find by IDs - `getObjectsAsync`
348348

349349
You can easily retrieve an object using its `objectID` and optionally specify a comma separated list of attributes you want:
350350

@@ -403,7 +403,7 @@ index.enableSearchCache(300, 20);
403403

404404
## Indexing
405405

406-
### Add objects - `addObjects`
406+
### Add objects - `addObjectsAsync`
407407

408408
Each entry in an index has a unique identifier called `objectID`. There are two ways to add an entry to the index:
409409

@@ -440,7 +440,7 @@ index.addObjectAsync(object, "myID", null);
440440
```
441441

442442

443-
### Update objects - `saveObjects`
443+
### Update objects - `saveObjectsAsync`
444444

445445
You have three options when updating an existing object:
446446

@@ -458,7 +458,7 @@ JSONObject object = new JSONObject()
458458
index.saveObjectAsync(object, "myID", null);
459459
```
460460

461-
### Partial update - `partialUpdateObjects`
461+
### Partial update - `partialUpdateObjectsAsync`
462462

463463
You have many ways to update an object's attributes:
464464

@@ -512,15 +512,15 @@ Note: Here we are decrementing the value by `42`. To decrement just by one, put
512512
`value:1`.
513513
514514
515-
### Delete objects - `deleteObjects`
515+
### Delete objects - `deleteObjectsAsync`
516516
517517
You can delete an object using its `objectID`:
518518
519519
```java
520520
index.deleteObjectAsync("myID", null);
521521
```
522522
523-
### Delete by query - `deleteByQuery`
523+
### Delete by query - `deleteByQueryAsync`
524524
525525
You can delete all objects matching a single query with the following code. Internally, the API client performs the query, deletes all matching hits, and waits until the deletions have been applied.
526526
@@ -532,7 +532,7 @@ Query query = /* [ ... ] */;
532532
index.deleteByQueryAsync(query, null);
533533
```
534534
535-
### Wait for operations - `waitTask`
535+
### Wait for operations - `waitTaskAsync`
536536
537537
All write operations in Algolia are asynchronous by design.
538538
@@ -652,9 +652,9 @@ Parameters that can be override at search time also have the `indexing` [scope](
652652
**Query Strategy**
653653
- [queryType](#querytype) `settings`, `search`
654654
- [removeWordsIfNoResults](#removewordsifnoresults) `settings`, `search`
655-
- [enableAdvancedSyntax](#enableadvancedsyntax) `settings`, `search`
655+
- [advancedSyntax](#advancedsyntax) `settings`, `search`
656656
- [optionalWords](#optionalwords) `settings`, `search`
657-
- [enableRemoveStopWords](#enableremovestopwords) `settings`, `search`
657+
- [removeStopWords](#removestopwords) `settings`, `search`
658658
- [disablePrefixOnAttributes](#disableprefixonattributes) `settings`
659659
- [disableExactOnAttributes](#disableexactonattributes) `settings`
660660
- [exactOnSingleWordQuery](#exactonsinglewordquery) `settings`, `search`
@@ -689,7 +689,7 @@ They are three scopes:
689689
#### Parameters List
690690
691691
**Search**
692-
- [setQueryString](#setquerystring) `search`
692+
- [query](#query) `search`
693693
694694
**Attributes**
695695
- [attributesForFaceting](#attributesforfaceting) `settings`
@@ -739,9 +739,9 @@ They are three scopes:
739739
**Query Strategy**
740740
- [queryType](#querytype) `settings`, `search`
741741
- [removeWordsIfNoResults](#removewordsifnoresults) `settings`, `search`
742-
- [enableAdvancedSyntax](#enableadvancedsyntax) `settings`, `search`
742+
- [advancedSyntax](#advancedsyntax) `settings`, `search`
743743
- [optionalWords](#optionalwords) `settings`, `search`
744-
- [enableRemoveStopWords](#enableremovestopwords) `settings`, `search`
744+
- [removeStopWords](#removestopwords) `settings`, `search`
745745
- [disablePrefixOnAttributes](#disableprefixonattributes) `settings`
746746
- [disableExactOnAttributes](#disableexactonattributes) `settings`
747747
- [exactOnSingleWordQuery](#exactonsinglewordquery) `settings`, `search`
@@ -756,13 +756,13 @@ They are three scopes:
756756
- [numericFilters (deprecated)](#numericfilters-deprecated) `search`
757757
- [tagFilters (deprecated)](#tagfilters-deprecated) `search`
758758
- [facetFilters (deprecated)](#facetfilters-deprecated) `search`
759-
- [enableAnalytics](#enableanalytics) `settings`, `search`
759+
- [analytics](#analytics) `settings`, `search`
760760
- [altCorrections](#altcorrections) `settings`
761761
- [placeholders](#placeholders) `settings`
762762
763763
### Search
764764
765-
#### setQueryString
765+
#### query
766766
767767
- scope: `search`
768768
- type: `string`
@@ -1301,7 +1301,7 @@ This is equivalent to transforming the AND operand between query terms to an OR
13011301
No specific processing is done when a query does not return any results (default behavior).
13021302

13031303

1304-
#### enableAdvancedSyntax
1304+
#### advancedSyntax
13051305

13061306
- scope: `settings`, `search`
13071307
- type: `boolean`
@@ -1324,23 +1324,23 @@ This syntax allow to do two things:
13241324
13251325
A string that contains the comma separated list of words that should be considered as optional when found in the query.
13261326
1327-
#### enableRemoveStopWords
1327+
#### removeStopWords
13281328
13291329
- scope: `settings`, `search`
1330-
- type: `boolean`
1330+
- type: `boolean`, `array of strings`
13311331
- default: `false`
13321332
13331333
1334-
Remove stop words from the query **before** executing it. Defaults to `false`.
1335-
Use a boolean to enable/disable all 41 supported languages and a comma separated list
1336-
of iso codes of the languages you want to use consider to enable the stopwords removal
1337-
on a subset of them (select the one you have in your records).
1334+
Remove stop words from the query **before** executing it. It can be:
1335+
1336+
- a **boolean**: enable or disable stop words for all 41 supported languages; or
1337+
- a **list of language ISO codes** (as a comma-separated string) for which stop words should be enabled.
13381338
1339-
In most use-cases, **you shouldn't need to enable this option**.
1339+
In most use-cases, **we don’t recommend enabling this option**.
13401340
1341-
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
1341+
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`.
13421342
1343-
Stop words removal is applied on query words that are not interpreted as a prefix. The behavior depends of the queryType parameter:
1343+
Stop words removal is applied on query words that are not interpreted as a prefix. The behavior depends of the `queryType` parameter:
13441344
13451345
* `queryType=prefixLast` means the last query word is a prefix and it won’t be considered for stop words removal
13461346
* `queryType=prefixNone` means no query word are prefix, stop words removal will be applied on all query words
@@ -1549,7 +1549,7 @@ You can also use a string array encoding.
15491549

15501550
For example, `[["category:Book","category:Movie"],"author:John%20Doe"]`.
15511551

1552-
#### enableAnalytics
1552+
#### analytics
15531553

15541554
- scope: `settings`, `search`
15551555
- type: `string`
@@ -1607,7 +1607,7 @@ To create an index, you need to perform any indexing operation like:
16071607
- set settings
16081608
- add object
16091609

1610-
### List indices - `listIndexes`
1610+
### List indices - `listIndexesAsync`
16111611

16121612
You can list all your indices along with their associated information (number of entries, disk size, etc.) with the `listIndexes` method:
16131613

@@ -1630,14 +1630,14 @@ client.listIndexesAsync(new CompletionHandler() {
16301630

16311631
## Advanced
16321632

1633-
### Custom batch - `batch`
1633+
### Custom batch - `batchAsync`
16341634

16351635
You may want to perform multiple operations with one API call to reduce latency.
16361636
We expose four methods to perform batch operations:
1637-
* Add objects - `addObjects`: Add an array of objects using automatic `objectID` assignment.
1638-
* Update objects - `saveObjects`: Add or update an array of objects that contains an `objectID` attribute.
1639-
* Delete objects - `deleteObjects`: Delete an array of objectIDs.
1640-
* Partial update - `partialUpdateObjects`: Partially update an array of objects that contain an `objectID` attribute (only specified attributes will be updated).
1637+
* Add objects - `addObjectsAsync`: Add an array of objects using automatic `objectID` assignment.
1638+
* Update objects - `saveObjectsAsync`: Add or update an array of objects that contains an `objectID` attribute.
1639+
* Delete objects - `deleteObjectsAsync`: Delete an array of objectIDs.
1640+
* Partial update - `partialUpdateObjectsAsync`: Partially update an array of objects that contain an `objectID` attribute (only specified attributes will be updated).
16411641

16421642
Example using automatic `objectID` assignment:
16431643
```java
@@ -1700,7 +1700,7 @@ The attribute **action** can have these values:
17001700
- partialUpdateObjectNoCreate
17011701
- deleteObject
17021702

1703-
### Backup / Export an index - `browse`
1703+
### Backup / Export an index - `browseAsync`
17041704

17051705
The `search` method cannot return more than 1,000 results. If you need to
17061706
retrieve all the content of your index (for backup, SEO purposes or for running

0 commit comments

Comments
 (0)