Entity
type Entity = { data?: Record<string, string>; group?: string; icon?: string; id: string; interactive?: boolean; title: string;};
A structured object representing a referenceable item such as a person, document, or internal business object.
Properties
Section titled “Properties”optional data: Record<string, string>;
Optional metadata that will be proxied to the server if this entity is part of a submitted user message (e.g. in tags) or for client entity callbacks (e.g. for click or preview). This is not directly used in ChatKit.js and can contain arbitrary metadata.
group?
Section titled “group?”optional group: string;
Optional human-readable group name to group entities by. e.g. “People”, “Documents”
optional icon: string;
Optional icon to show when rendering the entity.
id: string;
interactive?
Section titled “interactive?”optional interactive: boolean;
Whether the entity is interactive can be clicked or previewed.
title: string;
Human-readable name shown in tags, sources, previews, etc. e.g. “Harry Potter”, “Claim #A-1023”, “Q2 Planning Doc”