Docs /Templates/ sinapsis-chatbots-base

QueryContextualizeFromFile

sinapsis-chatbots-baseChatbotschatbotscontextqueryquery_contextualization

Python template · sinapsis_chatbots_base.templates.query_contextualize_from_file

Overview

Contextualize conversation packets from file-derived data in `generic_data`.

This template reads file-derived entries from `container.generic_data`, matches them against configured keywords, and appends normalized `LLMContextItem` objects to `LLMConversationPacket.contexts` using the `document` category.

Capabilities

Capabilities: not set

Installation

Install the published package using pip or uv.

Terminalbash
pip install sinapsis-chatbots-base==1.0.0
uv pip install sinapsis-chatbots-base==1.0.0
uv add sinapsis-chatbots-base==1.0.0

Configuration

Effective fields from the inspector schema, including nested Pydantic model fields.

keywordsRequired

Keywords used to trigger contextualization.

list[str]
Required
Default: null
metadata
sinapsis_core.template_base.base_models.TemplateMetadata | None
Optional
Default: null
generic_keysRequired

Keys searched in `container.generic_data`.

list[str]
Required
Default: null

Configuration example

Example from the Python docstring:

yaml
agent:
  name: my_test_agent
templates:
  - template_name: InputTemplate
    class_name: InputTemplate
    attributes: {}
  - template_name: QueryContextualizeFromFile
    class_name: QueryContextualizeFromFile
    template_input: InputTemplate
    attributes:
      keywords:
        - "pricing"
        - "refund"
      generic_keys:
        - "refund_policy_pdf"
        - "pricing_guide_pdf"
Show schema-based configuration skeleton
yaml
templates:
  - template_name: "QueryContextualizeFromFile"
    class_name: "QueryContextualizeFromFile"
    attributes:
      keywords: "<required>"
      generic_keys: "<required>"

Inheritance

Immediate parent: sinapsis_chatbots_base.templates.query_contextualize.QueryContextualize

Environment variables

Environment definitions belong to their canonical Python modules.

No directly related environment variables listed.