markdown-flow 0.2.16__py3-none-any.whl → 0.2.17__py3-none-any.whl

markdown_flow/llm.py

@@ -5,7 +5,7 @@ Provides LLM provider interfaces and related data models, supporting multiple pr
 """
 
 from abc import ABC, abstractmethod
-from collections.abc import Generator
+from collections.abc import AsyncGenerator
 from dataclasses import dataclass
 from enum import Enum
 from typing import Any
@@ -29,7 +29,6 @@ class LLMResult:
     prompt: str | None = None  # Used prompt
     variables: dict[str, str | list[str]] | None = None  # Extracted variables
     metadata: dict[str, Any] | None = None  # Metadata
-    transformed_to_interaction: bool = False  # Whether content block was transformed to interaction block
 
     def __bool__(self):
         """Support boolean evaluation."""
@@ -40,23 +39,22 @@ class LLMProvider(ABC):
     """Abstract LLM provider interface."""
 
     @abstractmethod
-    def complete(self, messages: list[dict[str, str]], tools: list[dict[str, Any]] | None = None) -> LLMResult:
+    async def complete(self, messages: list[dict[str, str]]) -> str:
         """
-        Non-streaming LLM call with optional function calling support.
+        Non-streaming LLM call.
 
         Args:
             messages: Message list in format [{"role": "system/user/assistant", "content": "..."}]
-            tools: Optional tools/functions for LLM to call
 
         Returns:
-            LLMResult: Structured result with content and metadata
+            str: LLM response content
 
         Raises:
             ValueError: When LLM call fails
         """
 
     @abstractmethod
-    def stream(self, messages: list[dict[str, str]]) -> Generator[str, None, None]:
+    async def stream(self, messages: list[dict[str, str]]) -> AsyncGenerator[str, None]:
         """
         Streaming LLM call.
 
@@ -74,8 +72,8 @@ class LLMProvider(ABC):
 class NoLLMProvider(LLMProvider):
     """Empty LLM provider for prompt-only scenarios."""
 
-    def complete(self, messages: list[dict[str, str]], tools: list[dict[str, Any]] | None = None) -> LLMResult:
+    async def complete(self, messages: list[dict[str, str]]) -> str:
         raise NotImplementedError(NO_LLM_PROVIDER_ERROR)
 
-    def stream(self, messages: list[dict[str, str]]) -> Generator[str, None, None]:
+    async def stream(self, messages: list[dict[str, str]]) -> AsyncGenerator[str, None]:
         raise NotImplementedError(NO_LLM_PROVIDER_ERROR)

markdown_flow/utils.py

@@ -23,7 +23,6 @@ from .constants import (
     CONTEXT_QUESTION_MARKER,
     CONTEXT_QUESTION_TEMPLATE,
     JSON_PARSE_ERROR,
-    OUTPUT_INSTRUCTION_EXPLANATION,
     OUTPUT_INSTRUCTION_PREFIX,
     OUTPUT_INSTRUCTION_SUFFIX,
     SMART_VALIDATION_TEMPLATE,
@@ -559,7 +558,7 @@ def parse_json_response(response_text: str) -> dict[str, Any]:
         raise ValueError(JSON_PARSE_ERROR)
 
 
-def process_output_instructions(content: str) -> str:
+def process_output_instructions(content: str) -> tuple[str, bool]:
     """
     Process output instruction markers, converting !=== format to [output] format.
 
@@ -569,7 +568,9 @@ def process_output_instructions(content: str) -> str:
         content: Raw content containing output instructions
 
     Returns:
-        Processed content with === and !=== markers converted to [output] format
+        Tuple of (processed_content, has_preserved_content):
+        - processed_content: Content with === and !=== markers converted to XML format
+        - has_preserved_content: True if content contained preserved markers
     """
     lines = content.split("\n")
     result_lines = []
@@ -650,11 +651,8 @@ def process_output_instructions(content: str) -> str:
     # Assemble final content
     processed_content = "\n".join(result_lines)
 
-    # Add explanation prefix (if has output instructions)
-    if has_output_instruction:
-        processed_content = OUTPUT_INSTRUCTION_EXPLANATION + processed_content
-
-    return processed_content
+    # Return both processed content and whether it contains preserved content
+    return processed_content, has_output_instruction
 
 
 def extract_preserved_content(content: str) -> str:

{markdown_flow-0.2.16.dist-info → markdown_flow-0.2.17.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: markdown-flow
-Version: 0.2.16
+Version: 0.2.17
 Summary: An agent library designed to parse and process MarkdownFlow documents
 Project-URL: Homepage, https://github.com/ai-shifu/markdown-flow-agent-py
 Project-URL: Bug Tracker, https://github.com/ai-shifu/markdown-flow-agent-py/issues
@@ -73,7 +73,7 @@ llm_provider = YourLLMProvider(api_key="your-key")
 mf = MarkdownFlow(document, llm_provider=llm_provider)
 
 # Process with different modes
-result = mf.process(
+result = await mf.process(
     block_index=0,
     mode=ProcessMode.COMPLETE,
     variables={'name': 'Alice', 'level': 'Intermediate'}
@@ -84,7 +84,7 @@ result = mf.process(
 
 ```python
 # Stream processing for real-time responses
-for chunk in mf.process(
+async for chunk in mf.process(
     block_index=0,
     mode=ProcessMode.STREAM,
     variables={'name': 'Bob'}
@@ -92,36 +92,6 @@ for chunk in mf.process(
     print(chunk.content, end='')
 ```
 
-### Dynamic Interaction Generation ✨
-
-Transform natural language content into interactive elements automatically:
-
-```python
-from markdown_flow import MarkdownFlow, ProcessMode
-
-# Dynamic interaction generation works automatically
-mf = MarkdownFlow(
-    document="询问用户的菜品偏好，并记录到变量{{菜品选择}}",
-    llm_provider=llm_provider,
-    document_prompt="你是中餐厅服务员，提供川菜、粤菜、鲁菜等选项"
-)
-
-# Process with Function Calling
-result = mf.process(0, ProcessMode.COMPLETE)
-
-if result.transformed_to_interaction:
-    print(f"Generated interaction: {result.content}")
-    # Output: ?[%{{菜品选择}} 宫保鸡丁||麻婆豆腐||水煮鱼||...其他菜品]
-
-# Continue with user input
-user_result = mf.process(
-    block_index=0,
-    mode=ProcessMode.COMPLETE,
-    user_input={"菜品选择": ["宫保鸡丁", "麻婆豆腐"]},
-    dynamic_interaction_format=result.content
-)
-```
-
 ### Interactive Elements
 
 ```python
@@ -152,66 +122,13 @@ user_input = {
     'skills': ['Python', 'JavaScript', 'Go']  # Multi-selection
 }
 
-result = mf.process(
+result = await mf.process(
     block_index=1,  # Process skills interaction
     user_input=user_input,
     mode=ProcessMode.COMPLETE
 )
 ```
 
-## ✨ Key Features
-
-### 🏗️ Three-Layer Architecture
-
-- **Document Level**: Parse `---` separators and `?[]` interaction patterns
-- **Block Level**: Categorize as CONTENT, INTERACTION, or PRESERVED_CONTENT
-- **Interaction Level**: Handle 6 different interaction types with smart validation
-
-### 🔄 Dynamic Interaction Generation
-
-- **Natural Language Input**: Write content in plain language
-- **AI-Powered Conversion**: LLM automatically detects interaction needs using Function Calling
-- **Structured Data Generation**: LLM returns structured data, core builds MarkdownFlow format
-- **Language Agnostic**: Support for any language with proper document prompts
-- **Context Awareness**: Both original and resolved variable contexts provided to LLM
-
-### 🤖 Unified LLM Integration
-
-- **Single Interface**: One `complete()` method for both regular and Function Calling modes
-- **Automatic Detection**: Tools parameter determines processing mode automatically
-- **Consistent Returns**: Always returns `LLMResult` with structured metadata
-- **Error Handling**: Automatic fallback from Function Calling to regular completion
-- **Provider Agnostic**: Abstract interface supports any LLM service
-
-### 📝 Variable System
-
-- **Replaceable Variables**: `{{variable}}` for content personalization
-- **Preserved Variables**: `%{{variable}}` for LLM understanding in interactions
-- **Multi-Value Support**: Handle both single values and arrays
-- **Smart Extraction**: Automatic detection from document content
-
-### 🎯 Interaction Types
-
-- **Text Input**: `?[%{{var}}...question]` - Free text entry
-- **Single Select**: `?[%{{var}} A|B|C]` - Choose one option
-- **Multi Select**: `?[%{{var}} A||B||C]` - Choose multiple options
-- **Mixed Mode**: `?[%{{var}} A||B||...custom]` - Predefined + custom input
-- **Display Buttons**: `?[Continue|Cancel]` - Action buttons without assignment
-- **Value Separation**: `?[%{{var}} Display//value|...]` - Different display/stored values
-
-### 🔒 Content Preservation
-
-- **Multiline Format**: `!===content!===` blocks output exactly as written
-- **Inline Format**: `===content===` for single-line preserved content
-- **Variable Support**: Preserved content can contain variables for substitution
-
-### ⚡ Performance Optimized
-
-- **Pre-compiled Regex**: All patterns compiled once for maximum performance
-- **Synchronous Interface**: Clean synchronous operations with optional streaming
-- **Stream Processing**: Real-time streaming responses supported
-- **Memory Efficient**: Lazy evaluation and generator patterns
-
 ## 📖 API Reference
 
 ### Core Classes
@@ -231,7 +148,7 @@ class MarkdownFlow:
     def get_all_blocks(self) -> List[Block]: ...
     def extract_variables(self) -> Set[str]: ...
 
-    def process(
+    async def process(
         self,
         block_index: int,
         mode: ProcessMode = ProcessMode.COMPLETE,
@@ -276,15 +193,15 @@ class ProcessMode(Enum):
 
 ```python
 # Generate prompt only
-prompt_result = mf.process(0, ProcessMode.PROMPT_ONLY)
+prompt_result = await mf.process(0, ProcessMode.PROMPT_ONLY)
 print(prompt_result.content)  # Raw prompt text
 
 # Complete response
-complete_result = mf.process(0, ProcessMode.COMPLETE)
+complete_result = await mf.process(0, ProcessMode.COMPLETE)
 print(complete_result.content)  # Full LLM response
 
 # Streaming response
-for chunk in mf.process(0, ProcessMode.STREAM):
+async for chunk in mf.process(0, ProcessMode.STREAM):
     print(chunk.content, end='')
 ```
 
@@ -294,14 +211,14 @@ Abstract base class for implementing LLM providers.
 
 ```python
 from abc import ABC, abstractmethod
-from typing import Generator
+from typing import AsyncGenerator
 
 class LLMProvider(ABC):
     @abstractmethod
-    def complete(self, prompt: str) -> LLMResult: ...
+    async def complete(self, prompt: str) -> LLMResult: ...
 
     @abstractmethod
-    def stream(self, prompt: str) -> Generator[str, None, None]: ...
+    async def stream(self, prompt: str) -> AsyncGenerator[str, None]: ...
 ```
 
 **Custom Implementation:**
@@ -309,23 +226,23 @@ class LLMProvider(ABC):
 ```python
 class OpenAIProvider(LLMProvider):
     def __init__(self, api_key: str):
-        self.client = openai.OpenAI(api_key=api_key)
+        self.client = openai.AsyncOpenAI(api_key=api_key)
 
-    def complete(self, prompt: str) -> LLMResult:
-        response = self.client.completions.create(
+    async def complete(self, prompt: str) -> LLMResult:
+        response = await self.client.completions.create(
             model="gpt-3.5-turbo",
             prompt=prompt,
             max_tokens=500
         )
         return LLMResult(content=response.choices[0].text.strip())
 
-    def stream(self, prompt: str):
-        stream = self.client.completions.create(
+    async def stream(self, prompt: str):
+        stream = await self.client.completions.create(
             model="gpt-3.5-turbo",
             prompt=prompt,
             stream=True
         )
-        for chunk in stream:
+        async for chunk in stream:
             if chunk.choices[0].text:
                 yield chunk.choices[0].text
 ```
@@ -485,7 +402,7 @@ The new version introduces multi-select interaction support with improvements to
 user_input = "Python"
 
 # Process interaction
-result = mf.process(
+result = await mf.process(
     block_index=1,
     user_input=user_input,
     mode=ProcessMode.COMPLETE
@@ -502,7 +419,7 @@ user_input = {
 }
 
 # Process interaction
-result = mf.process(
+result = await mf.process(
     block_index=1,
     user_input=user_input,
     mode=ProcessMode.COMPLETE
@@ -545,10 +462,10 @@ class CustomAPIProvider(LLMProvider):
     def __init__(self, base_url: str, api_key: str):
         self.base_url = base_url
         self.api_key = api_key
-        self.client = httpx.Client()
+        self.client = httpx.AsyncClient()
 
-    def complete(self, prompt: str) -> LLMResult:
-        response = self.client.post(
+    async def complete(self, prompt: str) -> LLMResult:
+        response = await self.client.post(
             f"{self.base_url}/complete",
             headers={"Authorization": f"Bearer {self.api_key}"},
             json={"prompt": prompt, "max_tokens": 1000}
@@ -556,14 +473,14 @@ class CustomAPIProvider(LLMProvider):
         data = response.json()
         return LLMResult(content=data["text"])
 
-    def stream(self, prompt: str):
-        with self.client.stream(
+    async def stream(self, prompt: str):
+        async with self.client.stream(
             "POST",
             f"{self.base_url}/stream",
             headers={"Authorization": f"Bearer {self.api_key}"},
             json={"prompt": prompt}
         ) as response:
-            for chunk in response.iter_text():
+            async for chunk in response.aiter_text():
                 if chunk.strip():
                     yield chunk
 
@@ -575,7 +492,7 @@ mf = MarkdownFlow(document, llm_provider=provider)
 ### Multi-Block Document Processing
 
 ```python
-def process_conversation():
+async def process_conversation():
     conversation = """
 # AI Assistant
 
@@ -612,7 +529,7 @@ Would you like to start with the basics?
     for i, block in enumerate(blocks):
         if block.block_type == BlockType.CONTENT:
             print(f"\n--- Processing Block {i} ---")
-            result = mf.process(
+            result = await mf.process(
                 block_index=i,
                 mode=ProcessMode.COMPLETE,
                 variables=variables
@@ -627,8 +544,9 @@ Would you like to start with the basics?
 
 ```python
 from markdown_flow import MarkdownFlow, ProcessMode
+import asyncio
 
-def stream_with_progress():
+async def stream_with_progress():
     document = """
 Generate a comprehensive Python tutorial for {{user_name}}
 focusing on {{topic}} with practical examples.
@@ -642,7 +560,7 @@ Include code samples, explanations, and practice exercises.
     content = ""
     chunk_count = 0
 
-    for chunk in mf.process(
+    async for chunk in mf.process(
         block_index=0,
         mode=ProcessMode.STREAM,
         variables={
@@ -681,13 +599,13 @@ class InteractiveDocumentBuilder:
         self.user_responses = {}
         self.current_block = 0
 
-    def start_interaction(self):
+    async def start_interaction(self):
         blocks = self.mf.get_all_blocks()
 
         for i, block in enumerate(blocks):
             if block.block_type == BlockType.CONTENT:
                 # Process content block with current variables
-                result = self.mf.process(
+                result = await self.mf.process(
                     block_index=i,
                     mode=ProcessMode.COMPLETE,
                     variables=self.user_responses
@@ -696,11 +614,11 @@ class InteractiveDocumentBuilder:
 
             elif block.block_type == BlockType.INTERACTION:
                 # Handle user interaction
-                response = self.handle_interaction(block.content)
+                response = await self.handle_interaction(block.content)
                 if response:
                     self.user_responses.update(response)
 
-    def handle_interaction(self, interaction_content: str):
+    async def handle_interaction(self, interaction_content: str):
         from markdown_flow.utils import InteractionParser
 
         interaction = InteractionParser.parse(interaction_content)
@@ -717,7 +635,7 @@ class InteractiveDocumentBuilder:
                 return {interaction.variable: selected}
             except (ValueError, IndexError):
                 print("Invalid choice")
-                return self.handle_interaction(interaction_content)
+                return await self.handle_interaction(interaction_content)
 
         elif interaction.name == "TEXT_ONLY":
             response = input(f"{interaction.question}: ")
@@ -739,7 +657,7 @@ Great choice, {{name}}! {{subject}} is an excellent field to study.
 """
 
 builder = InteractiveDocumentBuilder(template, your_llm_provider)
-builder.start_interaction()
+await builder.start_interaction()
 ```
 
 ### Variable System Deep Dive

markdown_flow-0.2.17.dist-info/RECORD

@@ -0,0 +1,13 @@
+markdown_flow/__init__.py,sha256=B7yG1jRkkbsS-V73sqUUl7T_ogzCjDCavOqKXFtJeaI,2875
+markdown_flow/constants.py,sha256=HI061nHbGG9BeN-n9dMX17GlAT7fmYmsRZ6Cr8OSbXY,8809
+markdown_flow/core.py,sha256=hTqq4bss9519SzhOPl5OHAJK_2YgB7hpwZlmC4HgsVo,32921
+markdown_flow/enums.py,sha256=Wr41zt0Ce5b3fyLtOTE2erEVp1n92g9OVaBF_BZg_l8,820
+markdown_flow/exceptions.py,sha256=9sUZ-Jd3CPLdSRqG8Pw7eMm7cv_S3VZM6jmjUU8OhIc,976
+markdown_flow/llm.py,sha256=ERCOsdywh0wyWAa1lN54BbfNQNNwES8F6hzoYxtfAXc,2225
+markdown_flow/models.py,sha256=ENcvXMVXwpFN-RzbeVHhXTjBN0bbmRpJ96K-XS2rizI,2893
+markdown_flow/utils.py,sha256=rJOalKxCGuXYiAJzI3WfD-loLc-7BHQGpac934_uC4c,28504
+markdown_flow-0.2.17.dist-info/licenses/LICENSE,sha256=qz3BziejhHPd1xa5eVtYEU5Qp6L2pn4otuj194uGxmc,1069
+markdown_flow-0.2.17.dist-info/METADATA,sha256=6hz7PDbT1LrfF4n_IjqnX-p42IkED_V-fS4cQczwRlQ,21010
+markdown_flow-0.2.17.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+markdown_flow-0.2.17.dist-info/top_level.txt,sha256=DpigGvQuIt2L0TTLnDU5sylhiTGiZS7MmAMa2hi-AJs,14
+markdown_flow-0.2.17.dist-info/RECORD,,

markdown_flow-0.2.16.dist-info/RECORD

@@ -1,13 +0,0 @@
-markdown_flow/__init__.py,sha256=IOL89FC4C8kH6qU5bjNsmuumPk3YDEHKHEjnJFFzQRU,2875
-markdown_flow/constants.py,sha256=Wq10-gvskBT6CpI3WiNfZpDIfl-lnAMaHVvjGvYpGG0,8006
-markdown_flow/core.py,sha256=INQ5vIJOFOCYHkBszqCbgn0BGVQ0WXMONtQ6AJmRXkM,51237
-markdown_flow/enums.py,sha256=Wr41zt0Ce5b3fyLtOTE2erEVp1n92g9OVaBF_BZg_l8,820
-markdown_flow/exceptions.py,sha256=9sUZ-Jd3CPLdSRqG8Pw7eMm7cv_S3VZM6jmjUU8OhIc,976
-markdown_flow/llm.py,sha256=MhllCwqzrN_RtIG-whfdkNk6e0WQ2H6RJVCRv3lNM_0,2531
-markdown_flow/models.py,sha256=ENcvXMVXwpFN-RzbeVHhXTjBN0bbmRpJ96K-XS2rizI,2893
-markdown_flow/utils.py,sha256=cVi0zDRK_rCMAr3EDhgITmx6Po5fSvYjqrprYaitYE0,28450
-markdown_flow-0.2.16.dist-info/licenses/LICENSE,sha256=qz3BziejhHPd1xa5eVtYEU5Qp6L2pn4otuj194uGxmc,1069
-markdown_flow-0.2.16.dist-info/METADATA,sha256=0uwa1wYOmt5MjukW6x2MTlUxYO-zn9Q4hkKu_NSiKOc,24287
-markdown_flow-0.2.16.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-markdown_flow-0.2.16.dist-info/top_level.txt,sha256=DpigGvQuIt2L0TTLnDU5sylhiTGiZS7MmAMa2hi-AJs,14
-markdown_flow-0.2.16.dist-info/RECORD,,