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

Commit 1cad6f5

Browse files
docs(README): automatic update
Update README Android [This list might not be relevant] fix wrong anchors Add `responseFields` search parameter (#138) [ci skip]
1 parent 25ba462 commit 1cad6f5

File tree

1 file changed

+22
-1
lines changed

1 file changed

+22
-1
lines changed

README.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -466,6 +466,7 @@ Parameters that can also be used in a setSettings also have the `indexing` [scop
466466
- [synonyms](#synonyms) `search`
467467
- [replaceSynonymsInHighlight](#replacesynonymsinhighlight) `search`, `settings`
468468
- [minProximity](#minproximity) `search`, `settings`
469+
- [responseFields](#responsefields) `search`, `settings`
469470

470471
<!--/PARAMETERS_LINK-->
471472

@@ -627,7 +628,7 @@ array.add(new JSONObject().put("firstname", "Warren").put("lastname", "Speach").
627628
index.saveObjectsAsync(new JSONArray(array), null);
628629
```
629630

630-
To update a single object, you can use the `[Update object](#update-object---saveobjectasync) method:
631+
To update a single object, you can use the `saveObjectAsync` method:
631632

632633
```java
633634
JSONObject object = new JSONObject()
@@ -990,6 +991,7 @@ They are three scopes:
990991
- [placeholders](#placeholders) `settings`
991992
- [altCorrections](#altcorrections) `settings`
992993
- [minProximity](#minproximity) `search`, `settings`
994+
- [responseFields](#responsefields) `search`, `settings`
993995

994996
### Search
995997

@@ -1968,6 +1970,25 @@ Considering the query *“javascript framework”*, if you set `minProximity=2`,
19681970

19691971
**Note:** the maximum `minProximity` that can be set is 7. Any higher value will disable the `proximity` criterion from the ranking formula.
19701972

1973+
#### responseFields
1974+
1975+
- scope: `search`, `settings`
1976+
- type: `array of strings`
1977+
- default: `*`
1978+
1979+
1980+
Choose which fields the response will contain. Applies to search and browse queries.
1981+
1982+
By default, all fields are returned. If this parameter is specified, only the fields explicitly listed will be returned, unless `*` is used, in which case all fields are returned. Specifying an empty list or unknown field names is an error.
1983+
1984+
This parameter is mainly intended to limit the response size. For example, for complex queries, echoing of request parameters in the response's `params` field can be undesirable.
1985+
1986+
Some fields cannot be filtered out:
1987+
1988+
- warning `message`
1989+
- `cursor` in browse queries
1990+
- fields triggered explicitly via [getRankingInfo](#getrankinginfo)
1991+
19711992
19721993
## Manage Indices
19731994

0 commit comments

Comments
 (0)