highlightPostTag

Closing HTML tag for highlighted attributes

The highlightPostTag parameter defines the HTML tag inserted after the matching text in highlighted attributes. It works in combination with highlightPreTag, which marks the beginning 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

C#

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

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

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

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

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

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

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

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

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

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

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

Legacy API clients

C#

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

index.SetSettings(settings);

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

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

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

val settings = settings {
    highlightPostTag = ""
}

index.setSettings(settings)

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

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

index.set_settings(
  {
    highlightPostTag: ""
  }
)

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

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

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

Change default tag for the current search

Current API clients

C#

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

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

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

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

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

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

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

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

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

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

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

Legacy API clients

C#

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

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

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

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

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

index.search(query)

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

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

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

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

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

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