MARP-4232 Update readme#265
Conversation
|
|
||
| ### Exposed CALLABLE_SUB processes | ||
|
|
||
| ##### `invokeAgent(String,String,List<String>,Class)` |
There was a problem hiding this comment.
this is an internal hook for the Portal. I think we don't want to expose it to other public use-cases. Have you considered only listing tagged sub processes? IMHO only "connector" tagged sub processes should be listed.
There was a problem hiding this comment.
I suppose that the callable sub listing mentioned that only subs with "connector" tag is listed but it was not strictly followed . I would update the checking section for it.
| <dependency> | ||
| <groupId>com.axonivy.utils.ai</groupId> | ||
| <artifactId>smart-workflow-demo</artifactId> | ||
| <version>${version}</version> |
There was a problem hiding this comment.
I'd omit the version everywhere ... or are you planning to interpolate it on the website with a real latest version?
There was a problem hiding this comment.
Initially, We intended to replace it with specific version as what we did in maven tab in marketplace:
https://market.axonivy.com/smart-workflow?version=14.0.0-b4#dependency
But would you like to display version in Component tab, or we could omit it completely?
There was a problem hiding this comment.
I think we can pick whatever works best and adjust if a customer is asking for it.
For me personally omitting the version completely is fine. And keeping a dynamic version which is replaced at runtime is equally ok. So you may pick on your preference.
|  | ||
|
|
||
| ## Components | ||
|
|
There was a problem hiding this comment.
This is nice 👍
Q: Shouldn't reusable UI components be listed here as well? Are they available in Smart Workflow?
There was a problem hiding this comment.
I checked and found UI components is only provided in demos project (currently, we will not mention UI dialogs/ components from demo or test project) -> there is no info about UI Components listed in this readme.
Please help me to confirm if we need to change that logic 😅
There was a problem hiding this comment.
I confirmed, there is no UI component in Smart Workflow 😄
ntqdinh-axonivy
force-pushed
the
feature/MARP-4232-documentation-generation
branch
from
c66e896 to
b503ef4
Compare
| #### SmartWorkflowAgentData — Data Class for AI agent invocation | ||
| - **Namespace:** Portal | ||
| - **Component type:** Data Class | ||
| - **Fields:** | ||
| - `query` (String) — The user query/message to send to the AI agent | ||
| - `systemMessage` (String) — System message to define agent behavior | ||
| - `tools` (List<String>) — List of tool names available to the agent. Keep empty to use all tools | ||
| - `resultType` (Class) — Expected result type class for structured output. Keep null for String result | ||
| - `resultObject` (Object) — The AI agent response result | ||
| - **Where used:** `SmartWorkflowAgent.p.json` (invokeAgent CallSubStart) | ||
| - **Purpose:** Provides parameters and result mapping for invoking the Smart Workflow Agent from Portal processes | ||
|
|
There was a problem hiding this comment.
why should we promote our internal data? the interface of the callable sub is the only public artifact.
| Check the demo implementations provided in the `smart-workflow-demo` module, which include user-facing examples and integrations. | ||
|
|
||
| To quickly set up the demo data, start **Create data for shopping demo** from the process list. | ||
| ### Demo workflows |
There was a problem hiding this comment.
I think we aligned to start "only" with the "components" section ... but your PR still looks as if we are trying to achieve everything with a big bang solution. please reduce the scope if you are looking for feedback
5 participants
Using: