Skip to content

Commit 7879e26

Browse files
author
maxiloc
authored
Merge pull request #113 from algoliareadmebot/master
Update README
2 parents e1187ff + 12e951c commit 7879e26

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
@@ -488,6 +488,7 @@ Parameters that can also be used in a setSettings also have the `indexing` [scop
488488
- [synonyms](#synonyms) `search`
489489
- [replaceSynonymsInHighlight](#replacesynonymsinhighlight) `search`, `settings`
490490
- [minProximity](#minproximity) `search`, `settings`
491+
- [responseFields](#responsefields) `search`, `settings`
491492

492493
<!--/PARAMETERS_LINK-->
493494

@@ -608,7 +609,7 @@ res = index.save_objects([{"firstname": "Jimmie",
608609
"objectID": "myID2"}])
609610
```
610611

611-
To update a single object, you can use the `[Update object](#update-object---save_object) method:
612+
To update a single object, you can use the `save_object` method:
612613

613614
```python
614615
index.save_object({"firstname": "Jimmie",
@@ -949,6 +950,7 @@ They are three scopes:
949950
- [placeholders](#placeholders) `settings`
950951
- [altCorrections](#altcorrections) `settings`
951952
- [minProximity](#minproximity) `search`, `settings`
953+
- [responseFields](#responsefields) `search`, `settings`
952954

953955
### Search
954956

@@ -1927,6 +1929,25 @@ Considering the query *“javascript framework”*, if you set `minProximity=2`,
19271929

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

1932+
#### responseFields
1933+
1934+
- scope: `search`, `settings`
1935+
- type: `array of strings`
1936+
- default: `*`
1937+
1938+
1939+
Choose which fields the response will contain. Applies to search and browse queries.
1940+
1941+
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.
1942+
1943+
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.
1944+
1945+
Some fields cannot be filtered out:
1946+
1947+
- warning `message`
1948+
- `cursor` in browse queries
1949+
- fields triggered explicitly via [getRankingInfo](#getrankinginfo)
1950+
19301951

19311952
## Manage Indices
19321953

0 commit comments

Comments
 (0)