highlightPreTag

The highlightPreTag parameter defines the HTML tag inserted before the matching text in highlighted attributes. It works in combination with highlightPostTag, which marks the end of the highlighted portion.

Usage

Set an empty string ("") to fallback to the default tag.
To turn off highlighting, remove the searchable attribute with the attributesToHighlight parameter.

Examples

Set default tag

Current API clients

var response = await client.SetSettingsAsync(
  "INDEX_NAME",
  new IndexSettings { HighlightPreTag = "<em>" }
);

final response = await client.setSettings(
  indexName: "INDEX_NAME",
  indexSettings: IndexSettings(
    highlightPreTag: "<em>",
  ),
);

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

UpdatedAtResponse response = client.setSettings("INDEX_NAME", new IndexSettings().setHighlightPreTag("<em>"));

const response = await client.setSettings({ indexName: 'theIndexName', indexSettings: { highlightPreTag: '<em>' } });

var response =
  client.setSettings(
    indexName = "INDEX_NAME",
    indexSettings = IndexSettings(highlightPreTag = "<em>"),
  )

$response = $client->setSettings(
    'INDEX_NAME',
    ['highlightPreTag' => '<em>',
    ],
);

response = client.set_settings(
    index_name="INDEX_NAME",
    index_settings={
        "highlightPreTag": "<em>",
    },
)

response = client.set_settings("INDEX_NAME", Algolia::Search::IndexSettings.new(highlight_pre_tag: "<em>"))

val response = Await.result(
  client.setSettings(
    indexName = "INDEX_NAME",
    indexSettings = IndexSettings(
      highlightPreTag = Some("<em>")
    )
  ),
  Duration(100, "sec")
)

let response = try await client.setSettings(
    indexName: "INDEX_NAME",
    indexSettings: IndexSettings(highlightPreTag: "<em>")
)

Legacy API clients

IndexSettings settings = new IndexSettings()
settings.HighlightPreTag = "";

index.SetSettings(settings);

res, err := index.SetSettings(search.Settings{
	HighlightPreTag: opt.HighlightPreTag(""),
})

index.setSettings(
  new IndexSettings()
    .setHighlightPreTag("")
);

index
  .setSettings({
    highlightPreTag: "",
  })
  .then(() => {
    // done
  });

val settings = settings {
    highlightPreTag = ""
}

index.setSettings(settings)

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

index.set_settings({"highlightPreTag": ""})

index.set_settings(
  {
    highlightPreTag: ""
  }
)

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

let settings = Settings()
  .set(\.highlightPreTag, to: "")

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

Change tag for the current search

Current API clients

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

final response = await client.searchSingleIndex(
  indexName: "INDEX_NAME",
  searchParams: SearchParamsObject(
    query: "query",
    highlightPreTag: "<strong>",
  ),
);

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

SearchResponse response = client.searchSingleIndex(
  "INDEX_NAME",
  new SearchParamsObject().setQuery("query").setHighlightPreTag("<strong>"),
  Hit.class
);

const response = await client.searchSingleIndex({
  indexName: 'indexName',
  searchParams: { query: 'query', highlightPreTag: '<strong>' },
});

var response =
  client.searchSingleIndex(
    indexName = "INDEX_NAME",
    searchParams = SearchParamsObject(query = "query", highlightPreTag = "<strong>"),
  )

$response = $client->searchSingleIndex(
    'INDEX_NAME',
    ['query' => 'query',
        'highlightPreTag' => '<strong>',
    ],
);

response = client.search_single_index(
    index_name="INDEX_NAME",
    search_params={
        "query": "query",
        "highlightPreTag": "<strong>",
    },
)

response = client.search_single_index(
  "INDEX_NAME",
  Algolia::Search::SearchParamsObject.new(query: "query", highlight_pre_tag: "<strong>")
)

val response = Await.result(
  client.searchSingleIndex(
    indexName = "INDEX_NAME",
    searchParams = Some(
      SearchParamsObject(
        query = Some("query"),
        highlightPreTag = Some("<strong>")
      )
    )
  ),
  Duration(100, "sec")
)

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

Legacy API clients

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

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

index.search(
  new Query("query")
    .setHighlightPreTag("")
);

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

val query = query("query") {
    highlightPreTag = ""
}

index.search(query)

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

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

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

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

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

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

Search API endpoints

Index settings/API parameters

highlightPreTag

Usage

Examples

Set default tag

Change tag for the current search

​Usage

​Examples

​Set default tag

​Change tag for the current search

Usage

Examples

Set default tag

Change tag for the current search