Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions agents-docs/_snippets/chat-components/ai-chat-settings.mdx
Original file line number Diff line number Diff line change
@@ -1,31 +1,31 @@
### InkeepAIChatSettings

<AutoTypeTable name="default" type="export { InkeepAIChatSettings as default } from '@inkeep/agents-ui/types'" />
<AutoTypeTable name="default" type="export { InkeepAIChatSettings as default } from '@inkeep/agents-ui-cloud/types'" />

#### AIChatFunctions

<AutoTypeTable name="default" type="export { AIChatFunctions as default } from '@inkeep/agents-ui/types'" />
<AutoTypeTable name="default" type="export { AIChatFunctions as default } from '@inkeep/agents-ui-cloud/types'" />

#### AIChatDisclaimerSettings

<AutoTypeTable name="default" type="export { AIChatDisclaimerSettings as default } from '@inkeep/agents-ui/types'" />
<AutoTypeTable name="default" type="export { AIChatDisclaimerSettings as default } from '@inkeep/agents-ui-cloud/types'" />

#### GetHelpOption

<AutoTypeTable name="default" type="export { GetHelpOption as default } from '@inkeep/agents-ui/types'" />
<AutoTypeTable name="default" type="export { GetHelpOption as default } from '@inkeep/agents-ui-cloud/types'" />

#### CustomMessageAction

<AutoTypeTable name="default" type="export { CustomMessageAction as default } from '@inkeep/agents-ui/types'" />
<AutoTypeTable name="default" type="export { CustomMessageAction as default } from '@inkeep/agents-ui-cloud/types'" />

#### AIChatToolbarButtonLabels

<AutoTypeTable name="default" type="export { AIChatToolbarButtonLabels as default } from '@inkeep/agents-ui/types'" />
<AutoTypeTable name="default" type="export { AIChatToolbarButtonLabels as default } from '@inkeep/agents-ui-cloud/types'" />

#### SearchAndChatFilters

<AutoTypeTable name="default" type="export { SearchAndChatFilters as default } from '@inkeep/agents-ui/types'" />
<AutoTypeTable name="default" type="export { SearchAndChatFilters as default } from '@inkeep/agents-ui-cloud/types'" />

#### ComponentsConfig

<AutoTypeTable name="default" type="export { ComponentsConfig as default } from '@inkeep/agents-ui/types'" />
<AutoTypeTable name="default" type="export { ComponentsConfig as default } from '@inkeep/agents-ui-cloud/types'" />
6 changes: 3 additions & 3 deletions agents-docs/_snippets/chat-components/base-settings.mdx
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
### InkeepBaseSettings

<AutoTypeTable name="default" type="export { InkeepBaseSettings as default } from '@inkeep/agents-ui/types'" />
<AutoTypeTable name="default" type="export { InkeepBaseSettings as default } from '@inkeep/agents-ui-cloud/types'" />

#### ColorModeConfig

<AutoTypeTable name="default" type="export { ColorModeConfig as default } from '@inkeep/agents-ui/types'" />
<AutoTypeTable name="default" type="export { ColorModeConfig as default } from '@inkeep/agents-ui-cloud/types'" />

#### UserProperties

<AutoTypeTable name="default" type="export { UserProperties as default } from '@inkeep/agents-ui/types'" />
<AutoTypeTable name="default" type="export { UserProperties as default } from '@inkeep/agents-ui-cloud/types'" />
2 changes: 1 addition & 1 deletion agents-docs/content/guides/upgrading.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The Inkeep Agent Framework is composed of several npm packages:
- [`@inkeep/agents-core`](https://www.npmjs.com/package/@inkeep/agents-core): The core shared functionality of the agent framework.
- [`@inkeep/agents-sdk`](https://www.npmjs.com/package/@inkeep/agents-sdk): The TypeScript SDK for building multi-agent systems.
- [`@inkeep/agents-cli`](https://www.npmjs.com/package/@inkeep/agents-cli): The CLI for managing and interacting with the agent framework.
- [`@inkeep/agents-ui`](https://www.npmjs.com/package/@inkeep/agents-ui): The UI library containing chat widget components.
- [`@inkeep/agents-ui-cloud`](https://www.npmjs.com/package/@inkeep/agents-ui-cloud): The UI library containing chat widget components.

## Upgrading the quickstart template

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,15 @@ The Inkeep chat components provide pre-built UI elements to quickly integrate co

<CodeGroup>
```bash title="npm"
npm install @inkeep/agents-ui
npm install @inkeep/agents-ui-cloud
```

```bash title="yarn"
yarn add @inkeep/agents-ui
yarn add @inkeep/agents-ui-cloud
```

```bash title="pnpm"
pnpm add @inkeep/agents-ui
pnpm add @inkeep/agents-ui-cloud
```

</CodeGroup>
Expand Down Expand Up @@ -108,8 +108,8 @@ The user is currently viewing {{headers.x-current-url}}.

<CodeGroup>
```tsx title="React"
import { InkeepChatButton } from '@inkeep/agents-ui'
import type { InkeepAIChatSettings } from '@inkeep/agents-ui/types'
import { InkeepChatButton } from '@inkeep/agents-ui-cloud'
import type { InkeepAIChatSettings } from '@inkeep/agents-ui-cloud/types'
import { useState, useEffect } from 'react'

export default function ChatButton() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The chat button component is a simple way to trigger the Inkeep chat bubble in y
```html
<script
type="module"
src="https://cdn.jsdelivr.net/npm/@inkeep/agents-ui-js@0.15/dist/embed.js"
src="https://cdn.jsdelivr.net/npm/@inkeep/agents-ui-cloud-js@0.15/dist/embed.js"
defer
></script>
```
Expand All @@ -41,7 +41,7 @@ The chat button component is a simple way to trigger the Inkeep chat bubble in y

<AutoTypeTable
name="default"
type="export { InkeepChatButtonProps as default } from '@inkeep/agents-ui'"
type="export { InkeepChatButtonProps as default } from '@inkeep/agents-ui-cloud'"
/>

<Snippet file="chat-components/base-settings.mdx" />
Expand All @@ -50,7 +50,7 @@ The chat button component is a simple way to trigger the Inkeep chat bubble in y

<AutoTypeTable
name="default"
type="export { OpenSettingsChatButton as default } from '@inkeep/agents-ui/types'"
type="export { OpenSettingsChatButton as default } from '@inkeep/agents-ui-cloud/types'"
/>

<Snippet file="chat-components/ai-chat-settings.mdx" />
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Custom triggers give you complete control over how users open Inkeep modals in y
```html
<script
type="module"
src="https://cdn.jsdelivr.net/npm/@inkeep/agents-ui-js@0.15/dist/embed.js"
src="https://cdn.jsdelivr.net/npm/@inkeep/agents-ui-cloud-js@0.15/dist/embed.js"
defer
></script>
```
Expand Down Expand Up @@ -62,7 +62,7 @@ Custom triggers give you complete control over how users open Inkeep modals in y

<AutoTypeTable
name="default"
type="export { InkeepModalChatProps as default } from '@inkeep/agents-ui'"
type="export { InkeepModalChatProps as default } from '@inkeep/agents-ui-cloud'"
/>

<Snippet file="chat-components/base-settings.mdx" />
Expand All @@ -73,5 +73,5 @@ Custom triggers give you complete control over how users open Inkeep modals in y

<AutoTypeTable
name="default"
type="export { OpenSettingsModal as default } from '@inkeep/agents-ui/types'"
type="export { OpenSettingsModal as default } from '@inkeep/agents-ui-cloud/types'"
/>
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The EmbeddedChat widget provides a fully embedded chat interface that you can in
```html
<script
type="module"
src="https://cdn.jsdelivr.net/npm/@inkeep/agents-ui-js@0.15/dist/embed.js"
src="https://cdn.jsdelivr.net/npm/@inkeep/agents-ui-cloud-js@0.15/dist/embed.js"
defer

> </script>
Expand Down Expand Up @@ -60,7 +60,7 @@ The EmbeddedChat widget provides a fully embedded chat interface that you can in

<AutoTypeTable
name="default"
type="export { InkeepEmbeddedChatProps as default } from '@inkeep/agents-ui'"
type="export { InkeepEmbeddedChatProps as default } from '@inkeep/agents-ui-cloud'"
/>

<Snippet file="chat-components/base-settings.mdx" />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The SidebarChat widget provides a slide-out panel interface for conversing with
```html
<script
type="module"
src="https://cdn.jsdelivr.net/npm/@inkeep/agents-ui-js@0.15/dist/embed.js"
src="https://cdn.jsdelivr.net/npm/@inkeep/agents-ui-cloud-js@0.15/dist/embed.js"
defer

> </script>
Expand Down Expand Up @@ -77,7 +77,7 @@ The SidebarChat widget provides a slide-out panel interface for conversing with

<AutoTypeTable
name="default"
type="export { InkeepEmbeddedChatProps as default } from '@inkeep/agents-ui'"
type="export { InkeepEmbeddedChatProps as default } from '@inkeep/agents-ui-cloud'"
/>

<Snippet file="chat-components/base-settings.mdx" />
Expand All @@ -88,5 +88,5 @@ The SidebarChat widget provides a slide-out panel interface for conversing with

<AutoTypeTable
name="default"
type="export { OpenSettingsSidebar as default } from '@inkeep/agents-ui/types'"
type="export { OpenSettingsSidebar as default } from '@inkeep/agents-ui-cloud/types'"
/>
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,15 @@ The chat button component is a simple way to trigger the Inkeep chat bubble. In

<CodeGroup>
```bash title="npm"
npm install @inkeep/agents-ui
npm install @inkeep/agents-ui-cloud
```

```bash title="yarn"
yarn add @inkeep/agents-ui
yarn add @inkeep/agents-ui-cloud
```

```bash title="pnpm"
pnpm add @inkeep/agents-ui
pnpm add @inkeep/agents-ui-cloud
```

</CodeGroup>
Expand All @@ -40,10 +40,10 @@ pnpm add @inkeep/agents-ui
'use client';

import dynamic from 'next/dynamic';
import type { InkeepChatButtonProps } from '@inkeep/agents-ui';
import type { InkeepChatButtonProps } from '@inkeep/agents-ui-cloud';

const InkeepChatButton = dynamic(
() => import('@inkeep/agents-ui').then((mod) => mod.InkeepChatButton),
() => import('@inkeep/agents-ui-cloud').then((mod) => mod.InkeepChatButton),
{ ssr: false },
);

Expand Down Expand Up @@ -75,10 +75,10 @@ pnpm add @inkeep/agents-ui
'use client';

import dynamic from 'next/dynamic';
import type { InkeepChatButtonProps } from '@inkeep/agents-ui';
import type { InkeepChatButtonProps } from '@inkeep/agents-ui-cloud';

const InkeepChatButton = dynamic(
() => import('@inkeep/agents-ui').then((mod) => mod.InkeepChatButton),
() => import('@inkeep/agents-ui-cloud').then((mod) => mod.InkeepChatButton),
{ ssr: false },
);

Expand All @@ -103,7 +103,7 @@ pnpm add @inkeep/agents-ui

<AutoTypeTable
name="default"
type="export { InkeepChatButtonProps as default } from '@inkeep/agents-ui'"
type="export { InkeepChatButtonProps as default } from '@inkeep/agents-ui-cloud'"
/>

<Snippet file="chat-components/base-settings.mdx" />
Expand All @@ -112,7 +112,7 @@ pnpm add @inkeep/agents-ui

<AutoTypeTable
name="default"
type="export { OpenSettingsChatButton as default } from '@inkeep/agents-ui/types'"
type="export { OpenSettingsChatButton as default } from '@inkeep/agents-ui-cloud/types'"
/>

<Snippet file="chat-components/ai-chat-settings.mdx" />
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,15 @@ Custom triggers give you complete control over how users open Inkeep modals in y

<CodeGroup>
```bash title="npm"
npm install @inkeep/agents-ui
npm install @inkeep/agents-ui-cloud
```

```bash title="yarn"
yarn add @inkeep/agents-ui
yarn add @inkeep/agents-ui-cloud
```

```bash title="pnpm"
pnpm add @inkeep/agents-ui
pnpm add @inkeep/agents-ui-cloud
```

</CodeGroup>
Expand All @@ -41,10 +41,10 @@ pnpm add @inkeep/agents-ui

import { useState } from 'react';
import dynamic from 'next/dynamic';
import type { InkeepModalChatProps } from '@inkeep/agents-ui';
import type { InkeepModalChatProps } from '@inkeep/agents-ui-cloud';

const InkeepModalChat = dynamic(
() => import('@inkeep/agents-ui').then((mod) => mod.InkeepModalChat),
() => import('@inkeep/agents-ui-cloud').then((mod) => mod.InkeepModalChat),
{ ssr: false },
);

Expand Down Expand Up @@ -90,10 +90,10 @@ pnpm add @inkeep/agents-ui

import { useState } from 'react';
import dynamic from 'next/dynamic';
import type { InkeepModalChatProps } from '@inkeep/agents-ui';
import type { InkeepModalChatProps } from '@inkeep/agents-ui-cloud';

const InkeepModalChat = dynamic(
() => import('@inkeep/agents-ui').then((mod) => mod.InkeepModalChat),
() => import('@inkeep/agents-ui-cloud').then((mod) => mod.InkeepModalChat),
{ ssr: false },
);

Expand Down Expand Up @@ -131,7 +131,7 @@ pnpm add @inkeep/agents-ui

<AutoTypeTable
name="default"
type="export { InkeepModalChatProps as default } from '@inkeep/agents-ui'"
type="export { InkeepModalChatProps as default } from '@inkeep/agents-ui-cloud'"
/>

<Snippet file="chat-components/base-settings.mdx" />
Expand All @@ -142,5 +142,5 @@ pnpm add @inkeep/agents-ui

<AutoTypeTable
name="default"
type="export { OpenSettingsModal as default } from '@inkeep/agents-ui/types'"
type="export { OpenSettingsModal as default } from '@inkeep/agents-ui-cloud/types'"
/>
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,15 @@ The InkeepEmbeddedChat component provides a fully embedded chat interface. In Ne

<CodeGroup>
```bash title="npm"
npm install @inkeep/agents-ui
npm install @inkeep/agents-ui-cloud
```

```bash title="yarn"
yarn add @inkeep/agents-ui
yarn add @inkeep/agents-ui-cloud
```

```bash title="pnpm"
pnpm add @inkeep/agents-ui
pnpm add @inkeep/agents-ui-cloud
```

</CodeGroup>
Expand All @@ -40,10 +40,10 @@ pnpm add @inkeep/agents-ui
'use client';

import dynamic from 'next/dynamic';
import type { InkeepEmbeddedChatProps } from '@inkeep/agents-ui';
import type { InkeepEmbeddedChatProps } from '@inkeep/agents-ui-cloud';

const InkeepEmbeddedChat = dynamic(
() => import('@inkeep/agents-ui').then((mod) => mod.InkeepEmbeddedChat),
() => import('@inkeep/agents-ui-cloud').then((mod) => mod.InkeepEmbeddedChat),
{ ssr: false },
);

Expand Down Expand Up @@ -75,10 +75,10 @@ pnpm add @inkeep/agents-ui
'use client';

import dynamic from 'next/dynamic';
import type { InkeepEmbeddedChatProps } from '@inkeep/agents-ui';
import type { InkeepEmbeddedChatProps } from '@inkeep/agents-ui-cloud';

const InkeepEmbeddedChat = dynamic(
() => import('@inkeep/agents-ui').then((mod) => mod.InkeepEmbeddedChat),
() => import('@inkeep/agents-ui-cloud').then((mod) => mod.InkeepEmbeddedChat),
{ ssr: false },
);

Expand All @@ -103,7 +103,7 @@ pnpm add @inkeep/agents-ui

<AutoTypeTable
name="default"
type="export { InkeepEmbeddedChatProps as default } from '@inkeep/agents-ui'"
type="export { InkeepEmbeddedChatProps as default } from '@inkeep/agents-ui-cloud'"
/>

<Snippet file="chat-components/base-settings.mdx" />
Expand Down
Loading
Loading