qtype 0.1.11__py3-none-any.whl → 0.1.13__py3-none-any.whl

qtype/examples/legacy/data_processor.qtype.yaml

@@ -0,0 +1,48 @@
+id: data_processor
+description: Process CSV data to extract and summarize information
+
+flows:
+  - type: Flow
+    id: process_customers
+    description: Load customer data and count records
+    
+    variables:
+      - id: file_path
+        type: text
+      - id: name
+        type: text
+      - id: region
+        type: text
+      - id: purchases
+        type: int
+      - id: stats
+        type: AggregateStats
+    
+    inputs:
+      - file_path
+    
+    outputs:
+      - stats
+      - name
+      - region
+      - purchases
+
+    steps:
+      # Step 1: Read CSV file (emits many records, one per row)
+      - id: load_file
+        type: FileSource
+        path: file_path
+        inputs:
+          - file_path
+        outputs:
+          - name
+          - region
+          - purchases
+      
+      # Step 2: Count all records
+      - id: count_records
+        type: Aggregate
+        inputs:
+          - region
+        outputs:
+          - stats

qtype/examples/legacy/echo/debug_example.qtype.yaml

@@ -0,0 +1,59 @@
+id: echo-debug-example
+description: Example showing how to use Echo step for debugging flows
+
+flows:
+  - id: debug-flow
+    description: A flow that uses Echo to inspect variables at different points
+    variables:
+      - id: original_input
+        type: text
+      - id: processed_text
+        type: text
+      - id: final_output
+        type: text
+    inputs:
+      - original_input
+    outputs:
+      - final_output
+    steps:
+      # Step 1: Echo the original input for debugging
+      - id: debug_input
+        type: Echo
+        inputs:
+          - original_input
+        outputs:
+          - original_input
+      
+      # Step 2: Process the input (example: add prefix)
+      - id: process_input
+        type: PromptTemplate
+        template: "Processed: {original_input}"
+        inputs:
+          - original_input
+        outputs:
+          - processed_text
+      
+      # Step 3: Echo the processed value for debugging
+      - id: debug_processed
+        type: Echo
+        inputs:
+          - processed_text
+        outputs:
+          - processed_text
+      
+      # Step 4: Final transformation
+      - id: final_transform
+        type: PromptTemplate
+        template: "{processed_text} - DONE"
+        inputs:
+          - processed_text
+        outputs:
+          - final_output
+      
+      # Step 5: Echo the final output for debugging
+      - id: debug_output
+        type: Echo
+        inputs:
+          - final_output
+        outputs:
+          - final_output

qtype/examples/legacy/echo/prompt.qtype.yaml

@@ -0,0 +1,22 @@
+id: echo
+description: Repeats the user inputs
+flows:
+  - type: Flow
+    id: echo_flow
+    variables:
+      - id: message
+        type: text
+      - id: echo_output
+        type: text
+    inputs:
+      - message
+    outputs:
+      - echo_output
+    steps:
+      - id: echo_step
+        type: PromptTemplate
+        template: "You said {message}"
+        inputs:
+          - message
+        outputs:
+          - echo_output

qtype/examples/legacy/echo/readme.md

@@ -0,0 +1,29 @@
+# Echo Examples
+
+These examples are intended to be for testing purposes or early stage development. Output will be a replicate of the input.
+
+**Primitive types**
+```
+class PrimitiveTypeEnum(str, Enum):
+    """Represents the type of data a user or system input can accept within the DSL."""
+
+    audio = "audio"
+    boolean = "boolean"
+    bytes = "bytes"
+    citation_document = "citation_document"
+    citation_url = "citation_url"
+    date = "date"
+    datetime = "datetime"
+    int = "int"
+    file = "file"
+    float = "float"
+    image = "image"
+    text = "text"
+    time = "time"
+    video = "video"
+    thinking = "thinking"
+```
+To test out a primitive type:
+
+- Duplicate `examples/echo/video.qtype.yaml`
+- Replace all mentions of video with the primitive type you wish to test

qtype/examples/legacy/echo/test.qtype.yaml

@@ -0,0 +1,26 @@
+id: test-echo
+description: Test the Echo step for debugging
+
+flows:
+  - id: echo-test
+    description: Simple flow to test the Echo step
+    variables:
+      - id: user_input
+        type: text
+      - id: user_count
+        type: number
+    inputs:
+      - user_input
+      - user_count
+    outputs:
+      - user_input
+      - user_count
+    steps:
+      - id: echo_debug
+        type: Echo
+        inputs:
+          - user_input
+          - user_count
+        outputs:
+          - user_input
+          - user_count

qtype/examples/legacy/echo/video.qtype.yaml

@@ -0,0 +1,20 @@
+id: echo-video
+description: Test the Echo step for video
+
+flows:
+  - id: echo-video
+    description: Simple flow to test the Echo step
+    variables:
+      - id: user_input
+        type: video
+    inputs:
+      - user_input
+    outputs:
+      - user_input
+    steps:
+      - id: echo_debug
+        type: Echo
+        inputs:
+          - user_input
+        outputs:
+          - user_input

qtype/examples/legacy/field_extractor_example.qtype.yaml

@@ -0,0 +1,137 @@
+# Example demonstrating the FieldExtractor step
+# This shows how to extract fields from structured data using JSONPath
+
+id: field_extractor_demo
+description: |
+  Demonstrates the FieldExtractor step for extracting specific fields from input data.
+  Shows both single value extraction and multiple value extraction (1-to-many).
+
+types:
+  - id: Person
+    description: A person with name and age
+    properties:
+      name: text
+      age: int
+
+  - id: DataRecord
+    description: A complex data record with nested structure
+    properties:
+      timestamp: text
+      metadata: text
+      items: list[text]
+
+flows:
+  # Example 1: Extract a single field from input
+  - id: extract_single_field
+    description: Extract the name field from a Person
+    variables:
+      - id: person_data
+        type: Person
+      - id: person_name
+        type: text
+    
+    steps:
+      - type: FieldExtractor
+        id: extract_name
+        json_path: $.name
+        inputs:
+          - person_data
+        outputs:
+          - person_name
+    
+    inputs:
+      - person_data
+    outputs:
+      - person_name
+
+  # Example 2: Extract multiple items (1-to-many)
+  - id: extract_multiple_items
+    description: Extract all items from a list, yielding one output per item
+    variables:
+      - id: data_record
+        type: DataRecord
+      - id: item
+        type: text
+    
+    steps:
+      - type: FieldExtractor
+        id: extract_items
+        json_path: $.items[*]
+        inputs:
+          - data_record
+        outputs:
+          - item
+    
+    inputs:
+      - data_record
+    outputs:
+      - item
+
+  # Example 3: Extract nested fields
+  - id: extract_nested_field
+    description: Extract a field from nested data structure
+    variables:
+      - id: complex_data
+        type: text  # JSON string
+      - id: parsed_data
+        type: text
+      - id: nested_value
+        type: text
+    
+    steps:
+      # First decode the JSON string
+      - type: Decoder
+        id: decode_json
+        format: json
+        inputs:
+          - complex_data
+        outputs:
+          - parsed_data
+      
+      # Then extract a specific nested field
+      - type: FieldExtractor
+        id: extract_nested
+        json_path: $.data.value
+        inputs:
+          - parsed_data
+        outputs:
+          - nested_value
+    
+    inputs:
+      - complex_data
+    outputs:
+      - nested_value
+
+  # Example 4: Extract with filtering
+  - id: extract_filtered_items
+    description: Extract items that match a condition using JSONPath filter
+    variables:
+      - id: product_list
+        type: text  # JSON array
+      - id: products
+        type: text
+      - id: expensive_item
+        type: text
+    
+    steps:
+      - type: Decoder
+        id: decode_products
+        format: json
+        inputs:
+          - product_list
+        outputs:
+          - products
+      
+      # Extract only products with price > 100
+      - type: FieldExtractor
+        id: filter_expensive
+        json_path: $[?(@.price > 100)]
+        inputs:
+          - products
+        outputs:
+          - expensive_item
+    
+    inputs:
+      - product_list
+    outputs:
+      - expensive_item

qtype/examples/legacy/multi_flow_example.qtype.yaml

@@ -0,0 +1,125 @@
+id: multi_flow_example
+description: Multi-flow application demonstrating multiple independent flows and variable scoping
+
+models:
+  - type: Model
+    id: gpt4o-mini
+    provider: openai
+    model_id: gpt-4o-mini
+    inference_params:
+      temperature: 0.7
+
+flows:
+  # Flow 1: Clean customer names
+  - type: Flow
+    id: clean_names
+    description: Clean and standardize customer names
+    
+    variables:
+      - id: raw_name
+        type: text
+      - id: clean_prompt
+        type: text
+      - id: clean_name
+        type: text
+    
+    inputs:
+      - raw_name
+    
+    outputs:
+      - clean_name
+    
+    steps:
+      # Create prompt to clean the name
+      - id: create_clean_prompt
+        type: PromptTemplate
+        template: "Clean this name by trimming whitespace and converting to title case: {{raw_name}}. Return ONLY the cleaned name, nothing else."
+        inputs:
+          - raw_name
+        outputs:
+          - clean_prompt
+      
+      # Call LLM to clean the name
+      - id: clean_step
+        type: LLMInference
+        model: gpt4o-mini
+        inputs:
+          - clean_prompt
+        outputs:
+          - clean_name
+
+  # Flow 2: Validate names
+  - type: Flow
+    id: validate_names
+    description: Validate that a name is a valid person name
+    
+    variables:
+      - id: name_to_validate
+        type: text
+      - id: validate_prompt
+        type: text
+      - id: validation_result
+        type: text
+    
+    inputs:
+      - name_to_validate
+    
+    outputs:
+      - validation_result
+    
+    steps:
+      # Create validation prompt
+      - id: create_validate_prompt
+        type: PromptTemplate
+        template: "Is '{{name_to_validate}}' a valid person name? Reply with just 'Valid' or 'Invalid: <reason>'"
+        inputs:
+          - name_to_validate
+        outputs:
+          - validate_prompt
+      
+      # Call LLM to validate
+      - id: validate_step
+        type: LLMInference
+        model: gpt4o-mini
+        inputs:
+          - validate_prompt
+        outputs:
+          - validation_result
+
+  # Flow 3: Generate customer profile
+  - type: Flow
+    id: generate_profile
+    description: Generate a customer profile with account details
+    
+    variables:
+      - id: customer_name
+        type: text
+      - id: profile_prompt
+        type: text
+      - id: customer_profile
+        type: text
+    
+    inputs:
+      - customer_name
+    
+    outputs:
+      - customer_profile
+    
+    steps:
+      # Create profile generation prompt
+      - id: create_profile_prompt
+        type: PromptTemplate
+        template: "Generate realistic customer information for: {{customer_name}}. Include: account number, member since date, and status (Gold/Silver/Bronze). Format as a brief profile."
+        inputs:
+          - customer_name
+        outputs:
+          - profile_prompt
+      
+      # Call LLM to generate profile
+      - id: generate_step
+        type: LLMInference
+        model: gpt4o-mini
+        inputs:
+          - profile_prompt
+        outputs:
+          - customer_profile

qtype/examples/legacy/openai/hello_world_chat.qtype.yaml

@@ -0,0 +1,43 @@
+id: hello_world
+description: A simple chat flow with OpenAI
+models:
+  - type: Model
+    id: gpt4
+    provider: openai
+    model_id: gpt-4
+    inference_params:
+      temperature: 0.7
+      max_tokens: 512
+    auth: openai_auth
+auths:
+  - type: api_key
+    id: openai_auth
+    api_key: ${OPENAI_KEY}
+    host: https://api.openai.com
+memories:
+  - id: chat_memory
+    token_limit: 10000
+flows:
+  - type: Flow
+    id: chat_example
+    interface:
+      type: Conversational
+    variables:
+      - id: user_message
+        type: ChatMessage
+      - id: response
+        type: ChatMessage
+    inputs:
+      - user_message
+    outputs:
+      - response
+    steps:
+      - id: llm_inference_step
+        type: LLMInference
+        model: gpt4
+        system_message: "You are a helpful assistant."
+        memory: chat_memory
+        inputs:
+          - user_message
+        outputs:
+          - response

qtype/examples/legacy/openai/hello_world_chat_with_telemetry.qtype.yaml

@@ -0,0 +1,46 @@
+id: hello_world
+description: A simple chat flow with OpenAI and telemetry
+models:
+  - type: Model
+    id: gpt4
+    provider: openai
+    model_id: gpt-4
+    inference_params:
+      temperature: 0.7
+      max_tokens: 512
+    auth: openai_auth
+auths:
+  - type: api_key
+    id: openai_auth
+    api_key: ${OPENAI_KEY}
+    host: https://api.openai.com
+memories:
+  - id: chat_memory
+    token_limit: 10000
+flows:
+  - type: Flow
+    id: chat_example
+    interface:
+      type: Conversational
+    variables:
+      - id: user_message
+        type: ChatMessage
+      - id: response
+        type: ChatMessage
+    inputs:
+      - user_message
+    outputs:
+      - response
+    steps:
+      - id: llm_inference_step
+        type: LLMInference
+        model: gpt4
+        system_message: "You are a helpful assistant."
+        memory: chat_memory
+        inputs:
+          - user_message
+        outputs:
+          - response
+telemetry:
+  id: hello_world_telemetry
+  endpoint: http://localhost:6006/v1/traces

qtype/examples/legacy/qtype_plugin_example.py

@@ -0,0 +1,51 @@
+"""
+Example QType CLI plugin.
+
+This demonstrates how to create a third-party plugin for the QType CLI.
+To use this as a plugin, you would:
+
+1. Put this code in a separate package
+2. Add an entry point in pyproject.toml:
+   [project.entry-points."qtype.commands"]
+   example = "your_package.qtype_example:parser"
+3. Install the package
+"""
+
+import argparse
+
+
+def parser(subparsers: argparse._SubParsersAction) -> None:
+    """Register the 'example' subcommand.
+
+    Args:
+        subparsers: The subparsers object to add the command to.
+    """
+    example_parser = subparsers.add_parser(
+        "example", help="Example plugin command for QType CLI"
+    )
+    example_parser.add_argument(
+        "--message",
+        default="Hello from QType plugin!",
+        help="Message to display (default: Hello from QType plugin!)",
+    )
+    example_parser.add_argument(
+        "--count",
+        type=int,
+        default=1,
+        help="Number of times to display the message (default: 1)",
+    )
+    # Set the function to call when this command is invoked
+    example_parser.set_defaults(func=example_command)
+
+
+def example_command(args: argparse.Namespace) -> None:
+    """Handle the 'example' subcommand.
+
+    Args:
+        args: Command-line arguments containing message and count.
+    """
+    for i in range(args.count):
+        print(f"{i + 1}: {args.message}")
+
+    print("\nThis command was loaded as a plugin!")
+    print("Plugin authors can extend QType CLI functionality this way.")