-
Notifications
You must be signed in to change notification settings - Fork 784
Edit and divide the Creating Your First Agent guide #11209
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
+908
−750
Merged
Changes from all commits
Commits
Show all changes
26 commits
Select commit
Hold shift + click to select a range
549825d
Separate approaches into different docs
dbreseman 3583246
Proofread
dbreseman b9d15d2
Fix cross-references
dbreseman f01d874
Break off shared setup steps from index page
dbreseman 93cd41d
Merge branch 'development' into db-create-first-agent
dbreseman 03c889e
Standardize introductions
dbreseman a3accc6
Streamline prereqs for starter apps
dbreseman d876123
Merge branch 'development' into db-create-first-agent
dbreseman 2104b1e
Edit and add visuals
dbreseman 8136f79
Update title
dbreseman b33f1b5
Edit
dbreseman 4e40dff
Add security instruction and links
dbreseman 251093f
Review and update Agent Commons guide
dbreseman cf8a452
Language edit
dbreseman c7ebeea
Merge branch 'development' into db-create-first-agent
dbreseman 6a83ec8
Merge branch 'development' into db-create-first-agent
dbreseman 571218c
Apply feedback from review
dbreseman 840809c
Apply feedback
dbreseman cd1a593
Merge branch 'development' into db-create-first-agent
dbreseman 323f6b0
Apply feedback
dbreseman 2b5bc45
Apply feedback
dbreseman 3f79be7
Correct heading capitalization
dbreseman 9e79a74
end user -> end-user
dbreseman f6f0101
Add text area conversion instruction
dbreseman d6b649a
Add note about alternative connectors
dbreseman 195fa6d
Update link
dbreseman 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
739 changes: 0 additions & 739 deletions
739
content/en/docs/marketplace/genai/how-to/create-single-agent.md
This file was deleted.
Oops, something went wrong.
47 changes: 47 additions & 0 deletions
47
content/en/docs/marketplace/genai/how-to/creating-agents/_index.md
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,47 @@ | ||
| --- | ||
| title: "Creating Your First Agent" | ||
| url: /appstore/modules/genai/how-to/creating-agents/ | ||
| linktitle: "Creating Your First Agent" | ||
| weight: 60 | ||
| description: "Introduces an example agent use case and describes three approaches for implementing it with Agents Kit using knowledge base retrieval and function calling." | ||
| aliases: | ||
| - /appstore/modules/genai/how-to/howto-single-agent/ | ||
| --- | ||
|
|
||
| ## Introduction | ||
|
|
||
| This guide explains how to create an agent in your Mendix app that combines [knowledge base retrieval (RAG)](/appstore/modules/genai/rag/) and [function calling](/appstore/modules/genai/function-calling/) capabilities from Mendix Agents Kit. | ||
|
|
||
| ## Agent Use Case | ||
|
|
||
| {{< figure src="/attachments/appstore/platform-supported-content/modules/genai/genai-howto-singleagent/structure_singleagent.svg" alt="Agent use case structure showing integration of LLM, knowledge base, and function calling" >}} | ||
|
|
||
| For this agent, you will set up logic that calls LLMs available via Mendix Cloud GenAI calls to dynamically determine which in-app and external information is needed based on user input. The system retrieves the necessary information, uses it to reason about the actions to perform, and handles execution while keeping you informed and involved where needed. | ||
|
|
||
| The end result is an example agent in a Mendix app. In this use case, you can ask IT-related questions to the model, which assists in solving problems. The model has access to a knowledge base containing historical, resolved tickets that can help identify suitable solutions. Additionally, function microflows are available to enrich the context with relevant ticket information, such as the number of currently open tickets or the status of a specific ticket. | ||
|
|
||
| This agent is a task agent, which means that: | ||
|
|
||
| * It is a single-turn interaction (one request-response pair for the UI). | ||
| * No conversation or memory is applicable. | ||
| * It focuses on specific task completion. | ||
| * It uses a knowledge base and function calling to retrieve data or perform actions. | ||
|
|
||
| ## Implementation Approaches {#implementation-approach} | ||
|
|
||
| You can define an agent for your Mendix app using any of the following approaches, all of which use Agents Kit: | ||
|
|
||
| * Use [Agent Editor in Studio Pro](/appstore/modules/genai/how-to/create-agent-with-agent-editor/) for creating and iterating on agent definitions as part of the app model. This is the recommended approach for most use cases because it uses existing development capabilities of the platform to define, manage, and deploy agents as part of a Mendix app. | ||
| * Use the [Agent Builder UI to define agents](/appstore/modules/genai/how-to/create-agent-with-agent-commons/) at runtime based on the principles of Agent Commons. It enables versioning, development iteration, and refinement at runtime, separate from the traditional app logic development cycle. | ||
| * Use the building blocks of GenAI Commons to [define the agent programmatically](/appstore/modules/genai/how-to/create-agent-programmatically/). This is useful for very specific use cases, especially when the agent needs to be part of the code repository of the app. | ||
|
|
||
| ## Getting Started | ||
|
|
||
| All three approaches require the same foundational setup. Start with the [Set Up Your App for Agent Creation](/appstore/modules/genai/how-to/creating-agents/shared-setup/) guide to do the following: | ||
|
|
||
| * Set up your app with the required modules and configuration | ||
| * Generate ticket data and ingest historical information into a knowledge base | ||
| * Create the domain model and user interface for agent interaction | ||
| * Build function microflows that the agent can call to retrieve data | ||
|
|
||
| After completing the shared setup, continue with your chosen implementation approach. | ||
Oops, something went wrong.
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.