generated from mintlify/starter
-
Notifications
You must be signed in to change notification settings - Fork 64
feat: restructure and add desk #377
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
...velopers/adk/concepts/workflows/steps.mdx → adk/concepts/workflows/steps.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| <Panel> | ||
| <ResponseExample> | ||
| ```ts Basic agent | ||
| import { Conversation } from "@botpress/runtime"; | ||
|
|
||
| export default new Conversation({ | ||
| channel: "*", | ||
| handler: async ({ execute, message }) => { | ||
| await execute({ | ||
| instructions: "You are a helpful assistant.", | ||
| }); | ||
| }, | ||
| }); | ||
| ``` | ||
|
|
||
| ```ts Agent with knowledge | ||
| import { Conversation } from "@botpress/runtime"; | ||
| import { WebsiteKB } from "../knowledge/docs"; | ||
|
|
||
| export default new Conversation({ | ||
| channel: "*", | ||
| handler: async ({ execute, message }) => { | ||
| await execute({ | ||
| instructions: "You are a helpful assistant.", | ||
| knowledge: [WebsiteKB] | ||
| }); | ||
| }, | ||
| }); | ||
| ``` | ||
| </ResponseExample> | ||
| </Panel> | ||
|
|
||
| The Agent Development Kit (ADK) is a **CLI tool and development framework for building AI agents** on Botpress. | ||
|
|
||
| It provides a streamlined development experience with TypeScript support, hot reloading, and type-safe APIs for creating conversational AI applications. | ||
|
|
||
| ## Get started | ||
|
|
||
| <CardGroup> | ||
| <Card | ||
| title="Quickstart" | ||
| icon="download" | ||
| href="/adk/quickstart" | ||
| cta="Install the CLI" | ||
| horizontal | ||
| > | ||
| Build your first agent in minutes | ||
| </Card> | ||
| <Card title="Project structure" horizontal icon="folder" href="/adk/project-structure"> | ||
| Learn how an ADK project is organized | ||
| </Card> | ||
| </CardGroup> | ||
|
|
||
| ## What is the ADK? | ||
|
|
||
| The ADK is a framework that allows developers to build Botpress agents from code. It provides: | ||
|
|
||
| - **Project scaffolding**: Quickly initialize new agent projects with templates | ||
| - **Type-safe development**: Automatic TypeScript type generation for integrations, interfaces, and more | ||
| - **Development workflow**: Hot reloading development server with live updates | ||
adkah marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - **Build and deploy**: Compile and deploy agents to Botpress Cloud | ||
| - **Integration management**: Add, update, and manage integrations from the Botpress Hub | ||
|
|
||
| ## When to use the ADK | ||
|
|
||
| The ADK is ideal for: | ||
|
|
||
| - Developers who prefer code-based workflows | ||
adkah marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - Teams using version control and CI/CD pipelines | ||
| - Projects requiring custom logic and integrations | ||
| - Developers who need TypeScript type safety | ||
|
|
||
| <Tip> | ||
| For most users, we recommend Botpress Studio. The ADK is best suited for developers who need more control or integration with development workflows. | ||
| </Tip> | ||
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.