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

{docs → qtype/docs}/How To/Invoke Models/reuse_prompts_with_templates.md

@@ -34,6 +34,5 @@ steps:
 ## See Also
 
 - [PromptTemplate Reference](../../components/PromptTemplate.md)
-- [How-To: Include Raw Text from Other Files](../../How%20To/Language%20Features/include_raw_text.md)
-- [How-To: Invoke LLMs with System Messages](invoke_llms_with_system_messages.md)
-- [Tutorial: Your First QType Application](../../Tutorials/your_first_qtype_application.md)
+- [Include Raw Text from Other Files](../Language%20Features/include_raw_text_from_other_files.md)
+- [Call Large Language Models](call_large_language_models.md)

{docs → qtype/docs}/How To/Language Features/include_raw_text_from_other_files.md

@@ -44,4 +44,5 @@ qtype run include_raw.qtype.yaml -i '{"theme":"a robot learning to paint","tone"
 ## See Also
 
 - [PromptTemplate Reference](../../components/PromptTemplate.md)
-- [Reference Entities by ID](../../How%20To/Language%20Features/reference_entities_by_id.md)
+- [Include QType YAML](include_qtype_yaml.md)
+- [Reuse Prompts with Templates](../Invoke%20Models/reuse_prompts_with_templates.md)

{docs → qtype/docs}/How To/Language Features/reference_entities_by_id.md

@@ -46,6 +46,6 @@ flows:
 
 ## See Also
 
+- [Include QType YAML](include_qtype_yaml.md)
 - [Tutorial: Your First QType Application](../../Tutorials/01-first-qtype-application.md)
-- [Model Reference](../../components/Model.md)
-- [APIKeyAuthProvider Reference](../../components/APIKeyAuthProvider.md)
+- [Application Reference](../../components/Application.md)

qtype/docs/How To/Language Features/use_agent_skills.md

@@ -0,0 +1,29 @@
+# Use QType Agent Skills
+
+Enhance GitHub Copilot or Claude Code with domain-specific QType expertise by loading pre-built agent skills that help you architect your vision faster.
+
+**Requires:** Active `qtype-mcp` MCP server
+
+### Generate Skills
+
+Simply:
+```
+qtype generate skills
+```
+
+and the skills will be written `.claude` for you.
+
+## Available QType Skills
+
+### QType Architect
+
+Expert assistant for designing and building AI applications using QType's declarative YAML language.
+
+**Capabilities:**
+- Designs flows from requirements to implementation
+- Generates architecture visualizations in VSCode
+
+## See Also
+
+- [Use QType MCP](use_qtype_mcp.md)
+- [Invoke Other Flows](../Data%20Processing/invoke_other_flows.md)

{docs → qtype/docs}/How To/Language Features/use_environment_variables.md

@@ -43,5 +43,6 @@ qtype run app.qtype.yaml
 
 ## See Also
 
+- [Use API Key Authentication](../Authentication/use_api_key_authentication.md)
+- [Configure AWS Authentication](../Authentication/configure_aws_authentication.md)
 - [Tutorial: Your First QType Application](../../Tutorials/01-first-qtype-application.md)
-- [APIKeyAuthProvider Reference](../../components/APIKeyAuthProvider.md)

qtype/docs/How To/Language Features/use_optional_variables.md

@@ -0,0 +1,42 @@
+# Use Optional Variables
+
+Mark variables as optional to handle cases where data may be missing or unset, allowing your flow to continue gracefully instead of failing.
+
+### QType YAML
+
+```yaml
+variables:
+  - id: email
+    type: text?           # Optional text variable
+```
+
+### Explanation
+
+- **`?` suffix**: Shorthand syntax to mark a variable as optional
+- **Optional variables**: Can be `None` or set to a value
+- **FieldExtractor**: Returns `None` for optional output variables when JSONPath finds no matches, instead of raising an error. If you make the variable non-optional, it will raise an error.
+
+## Complete Example
+
+```yaml
+--8<-- "../examples/language_features/optional_variables.qtype.yaml"
+```
+
+**Run it:**
+```bash
+# When email field exists
+qtype run examples/language_features/optional_variables.qtype.yaml -i '{"user_profile": {"email":"hello@domain.com"}}'
+# Results:                                                                                          
+# email: hello@domain.com
+
+# When email field is missing
+qtype run examples/language_features/optional_variables.qtype.yaml -i '{"user_profile": "just text"}'
+# Results:                                                                                          
+# email: None  
+```
+
+## See Also
+
+- [Variable Reference](../../components/Variable.md)
+- [FieldExtractor Reference](../../components/FieldExtractor.md)
+- [Tutorial: Structured Data](../../Tutorials/03-structured-data.md)

{docs → qtype/docs}/How To/Language Features/use_qtype_mcp.md

@@ -41,7 +41,7 @@ Add the QType MCP server to your workspace's `.vscode/mcp.json`:
 ```json
 {
   "servers": {
-    "qtype": {
+    "qtype-mcp": {
       "type": "stdio",
       "command": "qtype",
       "cwd": "${workspaceFolder}",
@@ -54,6 +54,6 @@ Add the QType MCP server to your workspace's `.vscode/mcp.json`:
 
 ## See Also
 
-- [MCP Server Implementation](../../components/MCP.md)
-- [GitHub Copilot Documentation](https://code.visualstudio.com/docs/copilot/copilot-chat)
-- [Model Context Protocol](https://modelcontextprotocol.io/)
+- [Use QType Agent Skills](use_agent_skills.md)
+- [Validate QType YAML](../Observability%20%26%20Debugging/validate_qtype_yaml.md)
+- [Visualize Application Architecture](../Observability%20%26%20Debugging/visualize_application_architecture.md)

{docs → qtype/docs}/How To/Observability & Debugging/trace_calls_with_open_telemetry.md

@@ -46,4 +46,4 @@ Then open `http://localhost:6006` in your browser to see the traced execution.
 
 - [Application Reference](../../components/Application.md)
 - [Validate QType YAML](validate_qtype_yaml.md)
-- [Visualize Application Architecture](visualize_application_architecture.md)
+- [CLI Reference](../../Reference/cli.md)

{docs → qtype/docs}/How To/Observability & Debugging/validate_qtype_yaml.md

@@ -31,5 +31,6 @@ qtype validate path/to/app.qtype.yaml --print
 
 ## See Also
 
-- [Application Reference](../../components/Application.md)
-- [Semantic Validation Rules](../../Concepts/semantic_validation_rules.md)
+- [CLI Reference](../../Reference/cli.md)
+- [Semantic Validation Rules](../../Reference/semantic-validation-rules.md)
+- [Visualize Application Architecture](visualize_application_architecture.md)

{docs → qtype/docs}/How To/Observability & Debugging/visualize_application_architecture.md

@@ -57,5 +57,5 @@ npm install -g @mermaid-js/mermaid-cli
 ## See Also
 
 - [Validate QType YAML](validate_qtype_yaml.md)
-- [Application Reference](../../components/Application.md)
+- [CLI Reference](../../Reference/cli.md)
 - [Flow Reference](../../components/Flow.md)

{docs → qtype/docs}/How To/Qtype Server/serve_flows_as_apis.md

@@ -35,6 +35,6 @@ Each flow endpoint accepts JSON input matching the flow's input schema and retur
 
 ## See Also
 
-- [Application Reference](../../components/Application.md)
-- [Flow Reference](../../components/Flow.md)
-- [FlowInterface Reference](../../components/FlowInterface.md)
+- [Serve Flows as UI](serve_flows_as_ui.md)
+- [CLI Reference](../../Reference/cli.md)
+- [Serve with Auto-Reload](../Command%20Line%20Usage/serve_with_auto_reload.md)

{docs → qtype/docs}/How To/Qtype Server/serve_flows_as_ui.md

@@ -37,6 +37,5 @@ The UI automatically generates:
 ## See Also
 
 - [Serve Flows as APIs](serve_flows_as_apis.md)
-- [Flow Reference](../../components/Flow.md)
-- [FlowInterface Reference](../../components/FlowInterface.md)
-- [Tutorial: Build a Conversational Chatbot](../../Tutorials/02-conversational-chatbot.md)
+- [Use Conversational Interfaces](use_conversational_interfaces.md)
+- [Tutorial: Conversational Chatbot](../../Tutorials/02-conversational-chatbot.md)

{docs → qtype/docs}/How To/Qtype Server/use_conversational_interfaces.md

@@ -52,8 +52,5 @@ Visit [http://localhost:8000/ui](http://localhost:8000/ui) to interact with the
 ## See Also
 
 - [Serve Flows as UI](serve_flows_as_ui.md)
-- [Tutorial: Build a Conversational Chatbot](../../Tutorials/02-conversational-chatbot.md)
-- [Flow Reference](../../components/Flow.md)
-- [FlowInterface Reference](../../components/FlowInterface.md)
+- [Tutorial: Conversational Chatbot](../../Tutorials/02-conversational-chatbot.md)
 - [ChatMessage Reference](../../components/ChatMessage.md)
-- [Memory Concept](../../Concepts/Core/memory.md)

{docs → qtype/docs}/How To/Qtype Server/use_variables_with_ui_hints.md

@@ -43,5 +43,6 @@ flows:
 
 ## See Also
 
-- [Serve Flows as UI](../../How%20To/Qtype%20Server/serve_flows_as_ui.md)
-- [Flow Reference](../../components/Flow.md)
+- [Serve Flows as UI](serve_flows_as_ui.md)
+- [Variable Reference](../../components/Variable.md)
+- [Use Optional Variables](../Language%20Features/use_optional_variables.md)

{docs → qtype/docs}/How To/Tools & Integration/bind_tool_inputs_and_outputs.md

@@ -42,7 +42,6 @@ steps:
 
 ## See Also
 
-- [Tutorial: Adding Tools to Your Application](../../Tutorials/04-tools-and-function-calling.md)
+- [Tutorial: Tools and Function Calling](../../Tutorials/04-tools-and-function-calling.md)
 - [InvokeTool Reference](../../components/InvokeTool.md)
 - [Create Tools from Python Modules](create_tools_from_python_modules.md)
-- [Create Tools from OpenAPI Specifications](create_tools_from_openapi_specifications.md)

{docs → qtype/docs}/How To/Tools & Integration/create_tools_from_openapi_specifications.md

@@ -31,20 +31,17 @@ tools:
     method: GET
     endpoint: /api/v3/pet/{petId}
     auth: swagger-petstore---openapi-30_api_key_api_key
-    parameters:
-      petId:
+    inputs:
+      - id: petId
         type: int
-        optional: false
     outputs:
-      id:
-        type: int
-        optional: true
-      name:
-        type: text
-        optional: false
-      status:
+      - id: id
+        type: int?
+      - id: name
         type: text
-        optional: true
+      - id: status
+        type: text?
+    parameters: []
 ```
 
 ### Explanation
@@ -83,7 +80,6 @@ See [Tutorial: Adding Tools to Your Application](../../Tutorials/04-tools-and-fu
 
 ## See Also
 
-- [Tutorial: Adding Tools to Your Application](../../Tutorials/04-tools-and-function-calling.md)
-- [How-To: Create Tools from Python Modules](create_tools_from_python_modules.md)
-- [InvokeTool Reference](../../components/InvokeTool.md)
+- [Tutorial: Tools and Function Calling](../../Tutorials/04-tools-and-function-calling.md)
+- [Create Tools from Python Modules](create_tools_from_python_modules.md)
 - [APITool Reference](../../components/APITool.md)

{docs → qtype/docs}/How To/Tools & Integration/create_tools_from_python_modules.md

@@ -42,16 +42,13 @@ tools:
     module_path: myapp.utils
     name: calculate_age
     inputs:
-      birth_date:
+      - id: birth_date
         type: datetime
-        optional: false
-      reference_date:
+      - id: reference_date
         type: datetime
-        optional: false
     outputs:
-      result:
+      - id: calculate_age_result
         type: int
-        optional: false
 ```
 
 ### Explanation
@@ -85,6 +82,6 @@ flows:
 
 ## See Also
 
-- [Tutorial: Adding Tools to Your Application](../../Tutorials/04-tools-and-function-calling.md)
-- [InvokeTool Reference](../../components/InvokeTool.md)
+- [Tutorial: Tools and Function Calling](../../Tutorials/04-tools-and-function-calling.md)
+- [Create Tools from OpenAPI Specifications](create_tools_from_openapi_specifications.md)
 - [PythonFunctionTool Reference](../../components/PythonFunctionTool.md)

{docs → qtype/docs}/Reference/cli.md

@@ -63,8 +63,8 @@ qtype run app.qtype.yaml --input-file inputs.csv --output results.parquet
 
 #### See Also
 
-- [How To: Pass Inputs On The CLI](../How%20To/Command%20Line%20Usage/pass_inputs_on_the_cli.md)
-- [How To: Load Multiple Inputs from Files](../How%20To/Command%20Line%20Usage/load_multiple_inputs_from_files.md)
+- [Pass Inputs On The CLI](../How%20To/Command%20Line%20Usage/pass_inputs_on_the_cli.md)
+- [Load Multiple Inputs from Files](../How%20To/Command%20Line%20Usage/load_multiple_inputs_from_files.md)
 - [Tutorial: Your First QType Application](../Tutorials/01-first-qtype-application.md)
 
 ---
@@ -99,8 +99,8 @@ qtype validate app.qtype.yaml --print
 
 #### See Also
 
-- [How To: Validate QType YAML](../How%20To/Observability%20&%20Debugging/validate_qtype_yaml.md)
-- [Reference: Semantic Validation Rules](semantic-validation-rules.md)
+- [Validate QType YAML](../How%20To/Observability%20%26%20Debugging/validate_qtype_yaml.md)
+- [Semantic Validation Rules](semantic-validation-rules.md)
 
 ---
 
@@ -141,11 +141,9 @@ qtype serve app.qtype.yaml --reload
 
 #### See Also
 
-- [How To: Serve Flows as APIs](../How%20To/Qtype%20Server/serve_flows_as_apis.md)
-- [How To: Serve Flows as UI](../How%20To/Qtype%20Server/serve_flows_as_ui.md)
-- [How To: Use Conversational Interfaces](../How%20To/Qtype%20Server/use_conversational_interfaces.md)
-- [How To: Serve Applications with Auto-Reload](../How%20To/Qtype%20Server/serve_applications_with_auto_reload.md)
-- [Tutorial: Building a Stateful Chatbot](../Tutorials/02-conversational-chatbot.md)
+- [Serve Flows as APIs](../How%20To/Qtype%20Server/serve_flows_as_apis.md)
+- [Serve Flows as UI](../How%20To/Qtype%20Server/serve_flows_as_ui.md)
+- [Tutorial: Conversational Chatbot](../Tutorials/02-conversational-chatbot.md)
 
 ---
 
@@ -230,7 +228,7 @@ qtype visualize app.qtype.yaml --output architecture.mmd
 
 #### See Also
 
-- [How To: Visualize Application Architecture](../How%20To/Observability%20&%20Debugging/visualize_application_architecture.md)
+- [Visualize Application Architecture](../How%20To/Observability%20%26%20Debugging/visualize_application_architecture.md)
 
 ---
 
@@ -274,8 +272,8 @@ qtype convert module myapp.utils
 
 **See Also:**
 
-- [How To: Create Tools from Python Modules](../How%20To/Tools%20&%20Integration/create_tools_from_python_modules.md)
-- [Tutorial: Adding Tools to Your Application](../Tutorials/04-tools-and-function-calling.md)
+- [Create Tools from Python Modules](../How%20To/Tools%20%26%20Integration/create_tools_from_python_modules.md)
+- [Tutorial: Tools and Function Calling](../Tutorials/04-tools-and-function-calling.md)
 
 ##### convert api
 
@@ -307,8 +305,8 @@ qtype convert api https://petstore3.swagger.io/api/v3/openapi.json --output pets
 
 **See Also:**
 
-- [How To: Create Tools from OpenAPI Specifications](../How%20To/Tools%20&%20Integration/create_tools_from_openapi_specifications.md)
-- [Tutorial: Adding Tools to Your Application](../Tutorials/04-tools-and-function-calling.md)
+- [Create Tools from OpenAPI Specifications](../How%20To/Tools%20%26%20Integration/create_tools_from_openapi_specifications.md)
+- [Tutorial: Tools and Function Calling](../Tutorials/04-tools-and-function-calling.md)
 
 ---
 
@@ -327,7 +325,7 @@ This command is primarily used for QType development and maintenance.
 - **`commons`** - Generates the commons library tools from `tools.py`
 - **`schema`** - Generates the JSON schema for the QType DSL from `model.py`
 - **`dsl-docs`** - Generates markdown documentation for the QType DSL classes from `model.py`
-- **`semantic-model`** - Generates the semantic model from QType DSL (See [Contributing](../Contributing/))
+- **`semantic-model`** - Generates the semantic model from QType DSL (See [Contributing](../Contributing/index.md))
 
 ---
 

{docs → qtype/docs}/Reference/plugins.md

@@ -93,3 +93,7 @@ my-qtype-plugin/
 └── tests/
     └── test_plugin.py
 ```
+
+## See Also
+
+- [CLI Reference](cli.md)

{docs → qtype/docs}/Reference/semantic-validation-rules.md

@@ -176,4 +176,9 @@ This document lists all semantic validation rules enforced by QType. These rules
 ## VectorSearch
 
 - Must have exactly 1 input of type `text`
-- Must have exactly 1 output of type `list[RAGSearchResult]`
+- Must have exactly 1 output of type `list[RAGSearchResult]`
+
+## See Also
+
+- [Validate QType YAML](../How%20To/Observability%20%26%20Debugging/validate_qtype_yaml.md)
+- [CLI Reference](cli.md)

qtype/docs/Tutorials/.pages

@@ -0,0 +1 @@
+title: Tutorials

{docs → qtype/docs}/Tutorials/01-first-qtype-application.md

@@ -231,8 +231,9 @@ Congratulations! You've learned:
 
 **Learn more:**
 
-- [Application Concept](../Concepts/Core/application.md) - Full specification
-- [All Step Types](../Concepts/Steps/index.md) - What else can you build?
+- [Tutorial: Conversational Chatbot](02-conversational-chatbot.md)
+- [Tutorial: Structured Data](03-structured-data.md)
+- [Call Large Language Models](../How%20To/Invoke%20Models/call_large_language_models.md)
 
 ---
 

{docs → qtype/docs}/Tutorials/02-conversational-chatbot.md

@@ -303,9 +303,9 @@ Congratulations! You've mastered:
 
 **Learn more:**
 
-- [Memory Concept](../Concepts/Core/memory.md) - Advanced memory strategies
-- [ChatMessage Reference](../How-To%20Guides/Data%20Types/domain-types.md) - Full type specification
-- [Flow Interfaces](../Concepts/Core/flow.md) - Complete vs Conversational
+- [Tutorial: Structured Data](03-structured-data.md)
+- [ChatMessage Reference](../components/ChatMessage.md)
+- [Use Conversational Interfaces](../How%20To/Qtype%20Server/use_conversational_interfaces.md)
 
 ---
 

{docs → qtype/docs}/Tutorials/03-structured-data.md

@@ -264,7 +264,7 @@ Final step - convert individual fields into your custom type:
       - id: build_result
         type: Construct
         output_type: ReviewSentiment
-        field_mapping:
+        field_bindings:
           sentiment: sentiment
           confidence: confidence
           key_points: key_points
@@ -282,15 +282,15 @@ Final step - convert individual fields into your custom type:
 
 **`output_type: ReviewSentiment`** - Specifies which custom type to build
 
-**`field_mapping:`** - Maps input variables to type properties:
+**`field_bindings:`** - Maps type field names to input variables:
 ```yaml
-field_mapping:
+field_bindings:
   <property_name>: <variable_name>
 ```
 
 In this case, names match (`sentiment: sentiment`), but you could use different names:
 ```yaml
-field_mapping:
+field_bindings:
   sentiment: analyzed_sentiment  # Maps analyzed_sentiment variable to sentiment property
 ```
 
@@ -432,7 +432,7 @@ Congratulations! You've mastered:
 ✅ **List types** - Working with `list[text]` and other collections  
 ✅ **Decoder step** - Parsing JSON into individual typed fields  
 ✅ **Construct step** - Building validated custom type instances  
-✅ **Field mapping** - Connecting variables to type properties  
+✅ **Field Bindings** - Connecting variables to type properties  
 ✅ **Type safety** - Catching errors early with validation  
 
 ---
@@ -445,10 +445,9 @@ Congratulations! You've mastered:
 
 **Learn more:**
 
-- [CustomType Reference](../components/CustomType.md) - Complete type system
-- [Decoder Step](../Concepts/Steps/decoder.md) - Advanced parsing options
-- [Construct Step](../components/Construct.md) - Field mapping patterns
-- [Type System](../Concepts/Core/types.md) - Primitives, domain types, and custom types
+- [Tutorial: Tools and Function Calling](04-tools-and-function-calling.md)
+- [CustomType Reference](../components/CustomType.md)
+- [Decoder Reference](../components/Decoder.md)
 
 ---
 
@@ -478,4 +477,4 @@ A: Not directly. Decoder maps JSON fields to individual outputs. If you need the
 A: Use **Decoder** when you have a JSON/XML string to parse. Use **FieldExtractor** when you already have structured data and need to extract specific fields using JSONPath (covered in advanced tutorials).
 
 **Q: Can I make properties optional?**  
-A: Currently all properties are required. For optional fields, you can define them in your flow logic but not include them in the Construct step.
+A: Yes! Mark variables as optional using the `?` suffix (e.g., `type: text?`). Optional variables can be unset, `None`, or have a value. This is useful when extracting fields that may not always be present. See [Use Optional Variables](../How%20To/Language%20Features/use_optional_variables.md).

{docs → qtype/docs}/Tutorials/04-tools-and-function-calling.md

@@ -74,7 +74,7 @@ Add a `references:` section before `flows:`:
 ```yaml
 # Import pre-built tools from the commons library
 references:
-  - !include https://raw.githubusercontent.com/bazaarvoice/qtype/refs/tags/v0.1.11/common/tools.qtype.yaml
+  - !include ../../common/tools.qtype.yaml
 ```
 
 **What this means:**
@@ -258,13 +258,12 @@ In this case:
 The `timedelta` tool definition (from commons library) looks like:
 ```yaml
 inputs:
-  timestamp:
+  - id: timestamp
     type: datetime
-  days:
-    type: int
-  hours:
-    type: int
-    optional: true
+  - id: days
+    type: int?
+  - id: hours
+    type: int?
   # ... more optional parameters
 ```
 
@@ -445,20 +444,14 @@ Congratulations! You've mastered:
 
 **Reference the complete example:**
 
-- [`04_tools_and_function_calling.qtype.yaml`](https://github.com/bazaarvoice/qtype/blob/main/examples/tutorials/04_tools_and_function_calling.qtype.yaml) - Full working example
-- [Commons Library](https://github.com/bazaarvoice/qtype/blob/main/common/tools.qtype.yaml) - Browse all available tools
-- [Commons Library Source](https://github.com/bazaarvoice/qtype/blob/v0.1.11/qtype/application/commons/tools.py) - Browse the source of tools.
-<!-- 
-**Learn more:**
-
-- [PythonFunctionTool Reference](../components/PythonFunctionTool.md) - Complete specification
-- [APITool Reference](../components/APITool.md) - External service integration
-- [InvokeTool Step](../components/InvokeTool.md) - Advanced binding patterns
-- [Generate Tools](../How-To%20Guides/Tools/generate-tools.md) - Create your own tools -->
+- [`04_tools_and_function_calling.qtype.yaml`](https://github.com/bazaarvoice/qtype/blob/main/examples/tutorials/04_tools_and_function_calling.qtype.yaml)
+- [Commons Library Tools](https://github.com/bazaarvoice/qtype/blob/main/common/tools.qtype.yaml)
 
-<!-- **Next tutorial:**
+**Learn more:**
 
-- Tutorial 5: Building an AI Agent - Use tools with autonomous LLM decision-making -->
+- [Create Tools from Python Modules](../How%20To/Tools%20%26%20Integration/create_tools_from_python_modules.md)
+- [Create Tools from OpenAPI Specifications](../How%20To/Tools%20%26%20Integration/create_tools_from_openapi_specifications.md)
+- [Bind Tool Inputs and Outputs](../How%20To/Tools%20%26%20Integration/bind_tool_inputs_and_outputs.md)
 
 ---
 

{docs → qtype/docs}/components/APITool.md

@@ -7,4 +7,4 @@ Tool that invokes an API endpoint.
 - **method** (`str`): HTTP method to use (GET, POST, PUT, DELETE, etc.).
 - **auth** (`Reference[AuthProviderType] | str | None`): Optional AuthorizationProvider for API authentication.
 - **headers** (`dict[str, str]`): Optional HTTP headers to include in the request.
-- **parameters** (`dict[str, ToolParameter]`): Output parameters produced by this tool.
+- **parameters** (`list[Variable]`): Path and query parameters for the API call.

qtype/docs/components/Aggregate.md

@@ -0,0 +1,7 @@
+### Aggregate
+
+A step that, after all messages have been processed,
+returns a single message containing the counts of successful and failed
+messages. Other messages are passed through unchanged.
+
+- **type** (`Literal`): (No documentation available.)

qtype/docs/components/Collect.md

@@ -0,0 +1,6 @@
+### Collect
+
+A step that collects all inputs and creates a single list to return.
+
+- **type** (`Literal`): (No documentation available.)
+- **batch_config** (`BatchConfig`): Configuration for processing the input stream in batches. If omitted, the step processes items one by one.

qtype/docs/components/Construct.md

@@ -0,0 +1,6 @@
+### Construct
+
+A step that converts variables into an instance of a Custom or Domain Type
+
+- **type** (`Literal`): (No documentation available.)
+- **field_bindings** (`dict[str, Reference[Variable] | str]`): Mapping from type field names to flow variable names.

{docs → qtype/docs}/components/DocumentEmbedder.md

@@ -3,5 +3,4 @@
 Embeds document chunks using a specified embedding model.
 
 - **type** (`Literal`): (No documentation available.)
-- **cardinality** (`Literal`): Consumes one chunk and emits one embedded chunk.
 - **model** (`Reference[EmbeddingModel] | str`): Embedding model to use for vectorization.

{docs → qtype/docs}/components/DocumentSplitter.md

@@ -3,7 +3,6 @@
 Configuration for chunking/splitting documents into embeddable nodes/chunks.
 
 - **type** (`Literal`): (No documentation available.)
-- **cardinality** (`Literal`): Consumes one document and emits 0...N nodes/chunks.
 - **splitter_name** (`str`): Name of the LlamaIndex TextSplitter class.
 - **chunk_size** (`int`): Size of each chunk.
 - **chunk_overlap** (`int`): Overlap between consecutive chunks.

qtype/docs/components/Explode.md

@@ -0,0 +1,5 @@
+### Explode
+
+A step that takes a list input and produces multiple outputs, one per item in the list.
+
+- **type** (`Literal`): (No documentation available.)

{docs → qtype/docs}/components/FieldExtractor.md

@@ -10,6 +10,8 @@ messages (1-to-many cardinality). If it matches a single value, it yields
 one output message. If it matches nothing, it raises an error.
 The extracted data is used to construct the output variable by passing it
 as keyword arguments to the output type's constructor.
+If there is no match and the output variable is optional, it is set to None.
+If there is no match and the output variable is required, an error is raised.
 Example JSONPath expressions:
 - `$.field_name` - Extract a single field
 - `$.items[*]` - Extract all items from a list
@@ -17,4 +19,3 @@ Example JSONPath expressions:
 
 - **type** (`Literal`): (No documentation available.)
 - **json_path** (`str`): JSONPath expression to extract data from the input. Uses jsonpath-ng syntax.
-- **fail_on_missing** (`bool`): Whether to raise an error if the JSONPath matches no data. If False, returns None.

qtype/docs/components/InvokeFlow.md

@@ -0,0 +1,8 @@
+### InvokeFlow
+
+Invokes a flow with input and output bindings.
+
+- **type** (`Literal`): (No documentation available.)
+- **flow** (`Reference[Flow] | str`): Flow to invoke.
+- **input_bindings** (`dict[str, Reference[Variable] | str]`): Mapping from flow input variable IDs to step variable names.
+- **output_bindings** (`dict[str, Reference[Variable] | str]`): Mapping from flow output variable IDs to step variable names.

qtype/docs/components/InvokeTool.md

@@ -0,0 +1,8 @@
+### InvokeTool
+
+Invokes a tool with input and output bindings.
+
+- **type** (`Literal`): (No documentation available.)
+- **tool** (`Reference[ToolType] | str`): Tool to invoke.
+- **input_bindings** (`dict[str, Reference[Variable] | str]`): Mapping from tool parameter names to flow variable names.
+- **output_bindings** (`dict[str, Reference[Variable] | str]`): Mapping from tool output names to flow variable names.

{docs → qtype/docs}/components/PrimitiveTypeEnum.md

@@ -15,7 +15,6 @@ Represents the type of data a user or system input can accept within the DSL.
 - **int**: Represents the type of data a user or system input can accept within the DSL.
 - **name**: The name of the Enum member.
 - **text**: Represents the type of data a user or system input can accept within the DSL.
-- **thinking**: Represents the type of data a user or system input can accept within the DSL.
 - **time**: Represents the type of data a user or system input can accept within the DSL.
 - **value**: The value of the Enum member.
 - **video**: Represents the type of data a user or system input can accept within the DSL.

{docs → qtype/docs}/components/Source.md

@@ -3,4 +3,3 @@
 Base class for data sources
 
 - **id** (`str`): Unique ID of the data source.
-- **cardinality** (`Literal`): Sources always emit 0...N instances of the outputs.

{docs → qtype/docs}/components/Step.md

@@ -4,6 +4,5 @@ Base class for components that take inputs and produce outputs.
 
 - **id** (`str`): Unique ID of this component.
 - **type** (`str`): Type of the step component.
-- **cardinality** (`StepCardinality`): Does this step emit 1 (one) or 0...N (many) instances of the outputs?
 - **inputs** (`list[Reference[Variable] | str]`): References to the variables required by this step.
 - **outputs** (`list[Reference[Variable] | str]`): References to the variables where output is stored.