feat(DATAGO-114389): PR 1: Foundation - Data Models & Constants #706
Conversation
Adds the foundational data models and utilities required by the Prescriptive Workflows feature: - StructuredInvocationRequest/Result data parts - WorkflowExecution* data parts for visualization - Extension URI constants - Agent card schema utilities
efunneko
changed the title
alimosaed
left a comment
alimosaed
left a comment
There was a problem hiding this comment.
In addition to the above comments, I am wondering how to check the total status of a workflow? Based on these models, the workflow status is determined at the end of workflow (success, failure, cancel); however, the workflow status can be 'running'
| ) | ||
|
|
||
|
|
||
| class StructuredInvocationResult(BaseModel): |
There was a problem hiding this comment.
[Q] does it always wrap results in an artifact?
| status: Literal["success", "failure"] = Field( | ||
| ..., description="Execution result status" | ||
| ) | ||
| artifact_name: Optional[str] = Field( |
There was a problem hiding this comment.
[Q] why the ArtifactRef class is not used here to determine the artifact name and version?
| max_iterations: Optional[int] = Field( | ||
| None, description="Maximum iterations for loop nodes" | ||
| ) | ||
| loop_delay: Optional[str] = Field( |
There was a problem hiding this comment.
Is the type string to set unit? (e.g., 1d, 20m)?
| type: Literal["structured_invocation_result"] = Field( | ||
| "structured_invocation_result", description="The constant type for this data part." | ||
| ) | ||
| status: Literal["success", "failure"] = Field( |
There was a problem hiding this comment.
[Q] Is not it possible to cancel an agent? If it is, 'cancel' can be another status.
| TEXT_ARTIFACT_CONTEXT_DEFAULT_LENGTH = 100000 # default number of characters to load from a text artifact | ||
|
|
||
| # Extension URIs | ||
| EXTENSION_URI_SCHEMAS = "https://solace.com/a2a/extensions/sam/schemas" |
There was a problem hiding this comment.
These constant URLs refer to invalid pages. This PR does not show their application; however, they depend the repository to some constant webpages that needs more attention.
PR 1: Foundation - Data Models & Constants
Overview
This PR introduces the foundational data models and utilities required by the Prescriptive Workflows feature. These are shared across all workflow components and define the contract for workflow-related A2A communication.
Branch Information
pr/workflows-1-foundationfeature/prescriptive-workflowsFiles Changed
src/solace_agent_mesh/common/data_parts.pyNew Pydantic models for workflow messages:
StructuredInvocationRequestStructuredInvocationResultArtifactRefWorkflowExecutionStartDataWorkflowNodeExecutionStartDataWorkflowNodeExecutionResultDataWorkflowMapProgressDataWorkflowExecutionResultDataSwitchCaseInfosrc/solace_agent_mesh/common/constants.pyNew constants:
EXTENSION_URI_SCHEMAS- URI for schema extension in agent cardsEXTENSION_URI_AGENT_TYPE- URI for agent type extensionsrc/solace_agent_mesh/common/a2a/types.pyNew type definitions:
SchemasExtensionParams- Parameters for schema extension in agent cardssrc/solace_agent_mesh/common/a2a/__init__.pyRe-exports:
StructuredInvocationRequestStructuredInvocationResultsrc/solace_agent_mesh/common/agent_card_utils.pyNew utility:
get_schemas_from_agent_card()- Extract input/output schemas from agent card extensionsKey Concepts
Structured Invocation Pattern
The
StructuredInvocationRequestandStructuredInvocationResultmodels enable a "function call" pattern for agents:StructuredInvocationRequestwith input data and optional schemasStructuredInvocationResultwith artifact reference or errorThis pattern is used by workflows but is generic enough for any programmatic caller.
Workflow Visualization Events
The
WorkflowNode*data models provide real-time execution visibility: