Skip to content
Merged
Show file tree
Hide file tree
Changes from all 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
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-js-cloud@0.15/dist/embed.js"
defer
></script>
```
Expand Down
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-js-cloud@0.15/dist/embed.js"
defer
></script>
```
Expand Down
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-js-cloud@0.15/dist/embed.js"
defer

> </script>
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-js-cloud@0.15/dist/embed.js"
defer

> </script>
Expand Down
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 Down
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
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 Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,15 @@ The InkeepSidebarChat component provides a slide-out panel for conversing with 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 @@ -43,10 +43,10 @@ pnpm add @inkeep/agents-ui

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

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

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

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

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

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

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

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

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

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

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@ The chat button component is a simple way to trigger the Inkeep chat bubble.

<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 @@ -31,7 +31,7 @@ pnpm add @inkeep/agents-ui
Use an API key for secure authentication in production:

```tsx
import { InkeepChatButton, type InkeepChatButtonProps } from "@inkeep/agents-ui";
import { InkeepChatButton, type InkeepChatButtonProps } from "@inkeep/agents-ui-cloud";

const buttonProps: InkeepChatButtonProps = {
aiChatSettings: {
Expand Down Expand Up @@ -61,7 +61,7 @@ pnpm add @inkeep/agents-ui
import {
InkeepChatButton,
type InkeepChatButtonProps,
} from "@inkeep/agents-ui";
} from "@inkeep/agents-ui-cloud";

const buttonProps: InkeepChatButtonProps = {
aiChatSettings: {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,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 @@ -34,7 +34,7 @@ pnpm add @inkeep/agents-ui

```tsx
import { useState } from "react";
import { InkeepModalChat, type InkeepModalChatProps } from "@inkeep/agents-ui";
import { InkeepModalChat, type InkeepModalChatProps } from "@inkeep/agents-ui-cloud";

function App() {
const [isModalOpen, setIsModalOpen] = useState(false);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@ The InkeepEmbeddedChat component provides a fully embedded chat interface that 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 @@ -31,7 +31,7 @@ pnpm add @inkeep/agents-ui
Use an API key for secure authentication in production:

```tsx
import { InkeepEmbeddedChat, type InkeepEmbeddedChatProps } from "@inkeep/agents-ui";
import { InkeepEmbeddedChat, type InkeepEmbeddedChatProps } from "@inkeep/agents-ui-cloud";

export default function App() {
const embeddedChatProps: InkeepEmbeddedChatProps = {
Expand Down Expand Up @@ -61,7 +61,7 @@ pnpm add @inkeep/agents-ui
import {
InkeepEmbeddedChat,
type InkeepEmbeddedChatProps,
} from "@inkeep/agents-ui";
} from "@inkeep/agents-ui-cloud";

export default function App() {
const embeddedChatProps: InkeepEmbeddedChatProps = {
Expand Down
Loading
Loading