restrictHighlightAndSnippetArrays

Restrict highlighting and snippeting to items that matched the query.

Options

true

Only items that at least partialy matched are highlighted and snippeted.

false

All items are highlighted and snippeted.

Examples

Set default value

Current API clients

C#

var response = await client.SetSettingsAsync(
  "INDEX_NAME",
  new IndexSettings { RestrictHighlightAndSnippetArrays = true }
);

final response = await client.setSettings(
  indexName: "INDEX_NAME",
  indexSettings: IndexSettings(
    restrictHighlightAndSnippetArrays: true,
  ),
);

response, err := client.SetSettings(client.NewApiSetSettingsRequest(
  "INDEX_NAME",
  search.NewEmptyIndexSettings().SetRestrictHighlightAndSnippetArrays(true)))
if err != nil {
  // handle the eventual error
  panic(err)
}

UpdatedAtResponse response = client.setSettings("INDEX_NAME", new IndexSettings().setRestrictHighlightAndSnippetArrays(true));

const response = await client.setSettings({
  indexName: 'theIndexName',
  indexSettings: { restrictHighlightAndSnippetArrays: true },
});

var response =
  client.setSettings(
    indexName = "INDEX_NAME",
    indexSettings = IndexSettings(restrictHighlightAndSnippetArrays = true),
  )

$response = $client->setSettings(
    'INDEX_NAME',
    ['restrictHighlightAndSnippetArrays' => true,
    ],
);

response = client.set_settings(
    index_name="INDEX_NAME",
    index_settings={
        "restrictHighlightAndSnippetArrays": True,
    },
)

response = client.set_settings(
  "INDEX_NAME",
  Algolia::Search::IndexSettings.new(restrict_highlight_and_snippet_arrays: true)
)

val response = Await.result(
  client.setSettings(
    indexName = "INDEX_NAME",
    indexSettings = IndexSettings(
      restrictHighlightAndSnippetArrays = Some(true)
    )
  ),
  Duration(100, "sec")
)

let response = try await client.setSettings(
    indexName: "INDEX_NAME",
    indexSettings: IndexSettings(restrictHighlightAndSnippetArrays: true)
)

Legacy API clients

C#

IndexSettings settings = new IndexSettings()
settings.RestrictHighlightAndSnippetArrays = true;

index.SetSettings(settings);

res, err := index.SetSettings(search.Settings{
	opt.RestrictHighlightAndSnippetArrays(true),
})

index.setSettings(
  new IndexSettings()
    .setRestrictHighlightAndSnippetArrays(true)
);

index
  .setSettings({
    restrictHighlightAndSnippetArrays: true,
  })
  .then(() => {
    // done
  });

val settings = settings {
    restrictHighlightAndSnippetArrays = true
}

index.setSettings(settings)

$index->setSettings([
  'restrictHighlightAndSnippetArrays' => true
]);

index.set_settings({"restrictHighlightAndSnippetArrays": True})

index.set_settings(
  {
    restrictHighlightAndSnippetArrays: true
  }
)

client.execute {
  setSettings of "myIndex" `with` IndexSettings(
    restrictHighlightAndSnippetArrays = Some(true)
  )
}

let settings = Settings()
  .set(\.restrictHighlightAndSnippetArrays, to: true)

index.setSettings(settings) { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}

Override for the current search

Current API clients

C#

var response = await client.SearchSingleIndexAsync<Hit>(
  "INDEX_NAME",
  new SearchParams(
    new SearchParamsObject { Query = "query", RestrictHighlightAndSnippetArrays = false }
  )
);

final response = await client.searchSingleIndex(
  indexName: "INDEX_NAME",
  searchParams: SearchParamsObject(
    query: "query",
    restrictHighlightAndSnippetArrays: false,
  ),
);

response, err := client.SearchSingleIndex(client.NewApiSearchSingleIndexRequest(
  "INDEX_NAME").WithSearchParams(search.SearchParamsObjectAsSearchParams(
  search.NewEmptySearchParamsObject().SetQuery("query").SetRestrictHighlightAndSnippetArrays(false))))
if err != nil {
  // handle the eventual error
  panic(err)
}

SearchResponse response = client.searchSingleIndex(
  "INDEX_NAME",
  new SearchParamsObject().setQuery("query").setRestrictHighlightAndSnippetArrays(false),
  Hit.class
);

const response = await client.searchSingleIndex({
  indexName: 'indexName',
  searchParams: { query: 'query', restrictHighlightAndSnippetArrays: false },
});

var response =
  client.searchSingleIndex(
    indexName = "INDEX_NAME",
    searchParams =
      SearchParamsObject(query = "query", restrictHighlightAndSnippetArrays = false),
  )

$response = $client->searchSingleIndex(
    'INDEX_NAME',
    ['query' => 'query',
        'restrictHighlightAndSnippetArrays' => false,
    ],
);

response = client.search_single_index(
    index_name="INDEX_NAME",
    search_params={
        "query": "query",
        "restrictHighlightAndSnippetArrays": False,
    },
)

response = client.search_single_index(
  "INDEX_NAME",
  Algolia::Search::SearchParamsObject.new(query: "query", restrict_highlight_and_snippet_arrays: false)
)

val response = Await.result(
  client.searchSingleIndex(
    indexName = "INDEX_NAME",
    searchParams = Some(
      SearchParamsObject(
        query = Some("query"),
        restrictHighlightAndSnippetArrays = Some(false)
      )
    )
  ),
  Duration(100, "sec")
)

let response: SearchResponse<Hit> = try await client.searchSingleIndex(
    indexName: "INDEX_NAME",
    searchParams: SearchSearchParams.searchSearchParamsObject(SearchSearchParamsObject(
        query: "query",
        restrictHighlightAndSnippetArrays: false
    ))
)

Legacy API clients

C#

index.Search(new Query("query")
{
    RestrictHighlightAndSnippetArrays = false
});

res, err := index.Search(
	"query",
	opt.RestrictHighlightAndSnippetArrays(false),
)

index.search(
  new Query("query")
    .setRestrictHighlightAndSnippetArrays(false)
);

index
  .search("query", {
    restrictHighlightAndSnippetArrays: false,
  })
  .then(({ hits }) => {
    console.log(hits);
  });

val query = query("query") {
    restrictHighlightAndSnippetArrays = true
}

index.search(query)

$results = $index->search('query', [
  'restrictHighlightAndSnippetArrays' => false
]);

results = index.search("query", {"restrictHighlightAndSnippetArrays": False})

results = index.search(
  "query",
  {
    restrictHighlightAndSnippetArrays: false
  }
)

client.execute {
  search into "myIndex" query Query(
    query = Some("query"),
    restrictHighlightAndSnippetArrays = Some(false)
  )
}

let query = Query("query")
  .set(\.restrictHighlightAndSnippetArrays, to: false)

index.search(query: query) { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}