openai/chatkit-python

Public

v1.5.2

Find a branch or tag

HTTPS

docs/concepts/entities.md

30lines · modecode

unknown

1	`# Entities`
2
3	`Entities are structured pieces of information your system can recognize during a conversation, such as names, dates, IDs, or product-specific objects.`
4
5	`They represent meaningful objects in your app’s domain. For example:`
6
7	`- In a notes app, entities might be documents.`
8	`- In a news site, they might be articles.`
9	`- In an online store, they might be products.`
10
11	`When referenced, entities can link messages to real data and power richer actions and previews.`
12
13	`## Entity sources for assistant messages`
14
15	`Entities can be used as cited sources in assistant responses.`
16
17	`References:`
18
19	`- The [EntitySource](../api/chatkit/types.md#chatkit.types.EntitySource) Pydantic model definition`
20	`- [Add annotations in assistant messages](../guides/add-annotations.md#annotating-with-custom-entities).`
21
22	`## Entity tags as @-mentions in user messages`
23
24	`Users can tag your entities in the composer using @-mentions.`
25
26	`References:`
27
28	`- The [Entity](https://openai.github.io/chatkit-js/api/openai/chatkit-react/type-aliases/entity/) TypeScript type definition`
29	`- The [UserMessageTagContent](../api/chatkit/types.md#chatkit.types.UserMessageTagContent) Pydantic model definition`
30	`- [Accept rich user input](../guides/accept-rich-user-input.md#-mentions-tag-entities-in-user-messages).`