responseFields

Documentation Index

Fetch the complete documentation index at: https://algolia.com/llms.txt

Use this file to discover all available pages before exploring further.

​

Usage

• To reduce the size of individual records in the response, use attributesToRetrieve.
• If responseFields is an empty list, the response may return an empty response, except fields that are always included.
• If you include unknown field names, the API returns an error.

​

Fields you can exclude

• aroundLatLng
• automaticRadius
• exhaustive
• facets_stats
• facets
• hitsPerPage
• hits
• index
• length
• nbHits
• nbPages
• offset
• page
• params
• processingTimeMS
• queryAfterRemoval
• query
• serverTimeMS
• userData

​

Fields you can’t exclude

• abTestVariantID
• cursor
• message
• warning
• Fields added by getRankingInfo

​

Example

var response = await client.SetSettingsAsync(
  "INDEX_NAME",
  new IndexSettings
  {
    ResponseFields = new List<string> { "hits", "hitsPerPage", "nbPages", "page" },
  }
);

IndexSettings settings = new IndexSettings();
settings.ResponseFields = new List
{
    "hits",
    "hitsPerPage",
    "nbPages",
    "page"
};

index.SetSettings(settings);