Skip to content

Commit 309966c

Browse files
committed
remove entities doc from customization; fix stale link
1 parent 2631491 commit 309966c

File tree

2 files changed

+2
-60
lines changed

2 files changed

+2
-60
lines changed

packages/chatkit/types/index.d.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ export type StartScreenOption = {
164164
export type WidgetsOption = {
165165
/**
166166
* Called when a widget action is triggered.
167-
* See https://openai.github.io/chatkit/guides/widget-actions/ for details.
167+
* See https://openai.github.io/chatkit-js/guides/widget-actions/ for details.
168168
*/
169169
onAction?: (
170170
action: { type: string; payload?: Record<string, unknown> },
@@ -791,7 +791,7 @@ export interface OpenAIChatKit extends HTMLElement {
791791

792792
/**
793793
* Sends a custom application-defined action to your backend.
794-
* See https://openai.github.io/chatkit/guides/widget-actions/ for more details.
794+
* See https://openai.github.io/chatkit-js/guides/widget-actions/ for more details.
795795
*/
796796
sendCustomAction(
797797
action: { type: string; payload?: Record<string, unknown> },

packages/docs/src/content/docs/guides/theming-customization.mdx

Lines changed: 0 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -217,64 +217,6 @@ const options: Partial<ChatKitOptions> = {
217217
}
218218
```
219219

220-
### Enable @mentions in the composer with entity tags
221-
222-
Let users tag custom “entities” with @-mentions. This enables richer conversation context and interactivity.
223-
224-
- Use `onTagSearch` to return a list of entities based on the input query.
225-
- Use `onClick` to handle the click event of an entity.
226-
227-
```jsx
228-
const options: Partial<ChatKitOptions> = {
229-
entities: {
230-
async onTagSearch(query) {
231-
return [
232-
{
233-
id: "user_123",
234-
title: "Jane Doe",
235-
group: "People",
236-
interactive: true,
237-
},
238-
{
239-
id: "document_123",
240-
title: "Quarterly Plan",
241-
group: "Documents",
242-
interactive: true,
243-
},
244-
]
245-
},
246-
onClick: (entity) => {
247-
navigateToEntity(entity.id);
248-
},
249-
},
250-
};
251-
```
252-
253-
254-
### Customize how entity tags appear
255-
256-
You can customize the appearance of entity tags on mouseover using widgets. Show rich previews such as a business card, document summary, or image when the user hovers over an entity tag.
257-
258-
Something about using widget studio should go here.
259-
260-
```jsx
261-
const options: Partial<ChatKitOptions> = {
262-
entities: {
263-
async onTagSearch() { /* ... */ },
264-
onRequestPreview: async (entity) => ({
265-
preview: {
266-
type: "Card",
267-
children: [
268-
{ type: "Text", value: `Profile: ${entity.title}` },
269-
{ type: "Text", value: "Role: Developer" },
270-
],
271-
},
272-
}),
273-
},
274-
};
275-
```
276-
277-
278220
## Add custom tools to the composer
279221

280222
Enhance productivity by letting users trigger app-specific actions from the composer bar. The selected tool

0 commit comments

Comments
 (0)