agentbyte 0.20.2__tar.gz → 0.20.4__tar.gz

{agentbyte-0.20.2 → agentbyte-0.20.4}/.github/skills/agentbyte-agent/SKILL.md

@@ -444,7 +444,7 @@ def build_contract_agent(*, model_client) -> Agent:
         required_tools=["think"],
         max_iterations=6,
         example_tasks=[
-            "Who signed CW347209 from Novartis?",
+            "Who signed CW347209 from XYZ?",
             "List all contracts expiring in Q3 2025.",
         ],
     )
@@ -481,6 +481,7 @@ async def run_with_filters(
 ```python
 from agentbyte.agents import EmbeddingAgent
 from agentbyte.llm.openai import OpenAIEmbeddingClient
+from agentbyte.llm.types import EmbeddingResult
 from agentbyte.middleware import OTelMiddleware
 
 client = OpenAIEmbeddingClient.from_api_key(model="text-embedding-3-small")
@@ -510,6 +511,7 @@ print(f"Cost: ${result.usage.cost_estimate:.4f}, tokens: {result.usage.tokens_in
 
 ```python
 from agentbyte.agents import EmbeddingBatchProgressEvent
+from agentbyte.llm.types import EmbeddingResult
 
 async for event in agent.run_stream(texts=chunks):
     if isinstance(event, EmbeddingBatchProgressEvent):

{agentbyte-0.20.2 → agentbyte-0.20.4}/.github/skills/agentbyte-workflow/SKILL.md

@@ -101,6 +101,38 @@ FunctionStep(
 )
 ```
 
+Design guidance:
+
+- `input_type` and `output_type` should be concrete Pydantic model classes that represent the real data crossing the step boundary.
+- Prefer step outputs as the primary transport for business data that flows from one step to the next.
+- Use `WorkflowContext` for cross-cutting concerns such as progress, flags, lightweight shared metadata, and values that are needed outside the direct step-to-step path.
+
+Preferred pattern:
+
+```python
+from pydantic import BaseModel
+
+
+class ParsedInput(BaseModel):
+    record_id: str
+    file_name: str
+
+
+class EnrichedOutput(ParsedInput):
+    content_hash: str
+
+
+async def enrich(input_data: ParsedInput, context) -> EnrichedOutput:
+    context.set("started_enrichment", True)
+    return EnrichedOutput(
+        record_id=input_data.record_id,
+        file_name=input_data.file_name,
+        content_hash="abc123",
+    )
+```
+
+Avoid using placeholder or pass-through output types while putting the real business payload only into `WorkflowContext.state`. That pattern weakens validation, makes step contracts less clear, and pushes too much logic into string-keyed shared state.
+
 ### TransformStep
 
 Maps fields from one schema to another without custom code. Use `"static:<value>"` for literal values, or a field name string to copy from input.
@@ -341,6 +373,13 @@ async def step_b(input_data: MyOutput, context: WorkflowContext) -> MyOutput:
     return MyOutput(value=f"Got: {shared}")
 ```
 
+Use `WorkflowContext` intentionally:
+
+- Put primary business data in step outputs when that data is part of the direct step-to-step contract.
+- Put small shared values in `WorkflowContext` when they are cross-cutting, optional, or orthogonal to the main output shape.
+- For simple linear enrichment pipelines, a good default is typed outputs for the main payload plus a small amount of primitive state for bookkeeping.
+- Avoid making `WorkflowContext.state` the only source of truth for the workflow's main data flow unless the workflow genuinely needs loose coupling between many steps.
+
 `WorkflowContext` API:
 
 | Method | Purpose |
@@ -447,6 +486,14 @@ resumed_execution = await runner.run(
 
 The runner validates the checkpoint's structure hash against the live workflow graph on resume. If steps were added/removed, `can_resume=False` is set on the `CheckpointValidationResult`.
 
+State size guidance:
+
+- Workflow state is retained for the lifetime of the run.
+- When checkpointing is enabled, that state is serialized into checkpoints.
+- Prefer storing IDs, keys, counters, flags, and other small primitives in shared state.
+- Avoid storing large domain objects, open clients, or heavyweight in-memory payloads in `WorkflowContext.state` unless they are truly required for resume semantics.
+- If a step can reconstruct a full object from a lightweight identifier, prefer storing the identifier and reconstructing on demand.
+
 ---
 
 ## 11. Suspend / resume — human-in-the-loop
@@ -556,6 +603,9 @@ if not validation.is_valid:
 ## Guardrails
 
 - Use `chain()` for linear flows; use `add_step()` + `add_edge()` only when branching or fan-out is required.
+- Design `FunctionStep` input and output types as real Pydantic contracts for the data flowing between steps; do not use placeholder output models when the actual payload lives only in workflow state.
+- Use step outputs for primary business data flow, and reserve `WorkflowContext.state` for compact shared metadata, flags, and bookkeeping.
+- Keep workflow state small and checkpoint-friendly; prefer IDs and lightweight values over large domain objects.
 - A fan-in join step with ≥ 2 upstream `always` edges receives `{"branch_outputs": {...}, "failed_branches": [...]}` — its input model must declare these fields, not the upstream output shape.
 - Always pass a workflow factory (callable) to `SubWorkflowStep`, not a live instance — the runner calls it to get a fresh copy per execution.
 - Do not pass `initial_input` and `responses` together — they are mutually exclusive.

{agentbyte-0.20.2 → agentbyte-0.20.4}/CHANGELOG.md

@@ -4,6 +4,23 @@ All notable changes to Agentbyte are documented in this file.
 
 The format follows Keep a Changelog principles and semantic versioning.
 
+## [0.20.4] - 2026-05-18
+
+### Fixed
+
+- Fixed `structured_content` always being `None` on `AssistantMessage` when `output_format` is used; agent now correctly reads `completion_result.structured_output` instead of `completion_result.message.structured_content`.
+- Fixed `_make_schema_compatible` in OpenAI and Azure chat clients to include all object properties in the `required` array, satisfying OpenAI structured outputs strict mode for models with optional (`str | None`) fields.
+
+---
+
+## [0.20.3] - 2026-05-11
+
+### Fixed
+
+- Removed internal file links from README; logo image and doc file references no longer appear in the published package page.
+
+---
+
 ## [0.20.2] - 2026-05-11
 
 ### Fixed

{agentbyte-0.20.2 → agentbyte-0.20.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: agentbyte
-Version: 0.20.2
+Version: 0.20.4
 Summary: A toolkit for designing multiagent systems
 Author-email: MrDataPsycho <mr.data.psycho@gmail.com>
 License-Expression: LicenseRef-Proprietary
@@ -72,15 +72,11 @@ Requires-Dist: fastapi>=0.135.2; extra == 'webui'
 Requires-Dist: uvicorn[standard]>=0.44.0; extra == 'webui'
 Description-Content-Type: text/markdown
 
-<p align="center">
-  <img src="logo/agent-byte-avatar-low.png" alt="Agentbyte" width="200"/>
-</p>
-
 # Agentbyte
 
 Agentbyte is an observability-first agentic AI framework for building and studying multiagent systems with a learning-first, implementation-oriented workflow.
 
-Current release: **0.20.2** — see [CHANGELOG.md](CHANGELOG.md) for the full release history.
+Current release: **0.20.4**
 
 ## Current Capabilities
 
@@ -116,8 +112,7 @@ Per-call span attributes emitted by `OTelMiddleware`:
 - `gen_ai.request.model`
 - `gen_ai.tool.name`, `gen_ai.tool.success`
 
-## Degugging Traces without UI
-details can be found in the [OTel spans guide](docs/study/topic_otel_spans.md#debugging-traces-without-ui).
+## Debugging Traces without UI
 
 Practical interpretation:
 

{agentbyte-0.20.2 → agentbyte-0.20.4}/README.md

@@ -1,12 +1,8 @@
-<p align="center">
-  <img src="logo/agent-byte-avatar-low.png" alt="Agentbyte" width="200"/>
-</p>
-
 # Agentbyte
 
 Agentbyte is an observability-first agentic AI framework for building and studying multiagent systems with a learning-first, implementation-oriented workflow.
 
-Current release: **0.20.2** — see [CHANGELOG.md](CHANGELOG.md) for the full release history.
+Current release: **0.20.4**
 
 ## Current Capabilities
 
@@ -42,8 +38,7 @@ Per-call span attributes emitted by `OTelMiddleware`:
 - `gen_ai.request.model`
 - `gen_ai.tool.name`, `gen_ai.tool.success`
 
-## Degugging Traces without UI
-details can be found in the [OTel spans guide](docs/study/topic_otel_spans.md#debugging-traces-without-ui).
+## Debugging Traces without UI
 
 Practical interpretation:
 

agentbyte-0.20.4/src/agentbyte/__about__.py

@@ -0,0 +1,2 @@
+__version__ = "0.20.4"
+VERSION = __version__

{agentbyte-0.20.2 → agentbyte-0.20.4}/src/agentbyte/agents/agent.py

@@ -601,7 +601,7 @@ class Agent(BaseAgent):
                     content=completion_result.message.content,
                     source=self.name,
                     tool_calls=completion_result.message.tool_calls,
-                    structured_content=completion_result.message.structured_content,
+                    structured_content=completion_result.structured_output,
                     usage=completion_result.usage,
                 )
 

{agentbyte-0.20.2 → agentbyte-0.20.4}/src/agentbyte/llm/azure/chat.py

@@ -616,6 +616,10 @@ class AzureOpenAIChatCompletionClient(
 
         if compatible_schema.get("type") == "object":
             compatible_schema["additionalProperties"] = False
+            if "properties" in compatible_schema:
+                all_keys = list(compatible_schema["properties"].keys())
+                existing = compatible_schema.get("required", [])
+                compatible_schema["required"] = list(dict.fromkeys(existing + all_keys))
 
         return compatible_schema
 

{agentbyte-0.20.2 → agentbyte-0.20.4}/src/agentbyte/llm/openai/chat.py

@@ -394,6 +394,10 @@ class OpenAIChatCompletionClient(
 
         if compatible_schema.get("type") == "object":
             compatible_schema["additionalProperties"] = False
+            if "properties" in compatible_schema:
+                all_keys = list(compatible_schema["properties"].keys())
+                existing = compatible_schema.get("required", [])
+                compatible_schema["required"] = list(dict.fromkeys(existing + all_keys))
 
         return compatible_schema
 

agentbyte-0.20.2/src/agentbyte/__about__.py

@@ -1,2 +0,0 @@
-__version__ = "0.20.2"
-VERSION = __version__