react-instantsearch
Version:
⚡ Lightning-fast search for React, by Algolia
16 lines (15 loc) • 812 B
TypeScript
import type { ComparisonTableTranslations, UserClientSideTool } from 'instantsearch-ui-components';
/**
* Grounded comparison-table tool (prototype).
*
* Renders a v2 `markdownTable` display block whose every cell is hydrated from
* the real `algolia_search_index` hits by objectID — the agent supplies only the
* objectIDs and the attribute keys, never the values. See
* `instantsearch-ui-components` `ComparisonTableTool` for the contract.
*
* Register under the display-results tool key (or a dedicated key) in
* `createDefaultTools` to have comparison answers rendered as a grounded table
* instead of the model-authored markdown table.
*/
declare function createComparisonTableTool(translations?: Partial<ComparisonTableTranslations>): UserClientSideTool;
export { createComparisonTableTool };