Merge branch 'main' (which includes a large refactor by Michal) into jc/issue-54-request-context

Author: ds-jakub-cierocki

.coveragerc

@@ -12,4 +12,5 @@ omit =
 exclude_lines =
     pragma: no cover
     if __name__ == .__main__.
+    \.\.\.
 show_missing = True

.github/ISSUE_TEMPLATE/01_feature_request.yml

@@ -1,7 +1,7 @@
 name: 🚀 Feature Request
 description: Submit a proposal/request for a new db-ally feature.
 title: "feat: "
-labels: ["enhancement"]
+labels: ["feature"]
 body:
   - type: markdown
     attributes:

README.md

@@ -1,4 +1,4 @@
-# <h1 align="center">db-ally</h1>
+# <h1 align="center">🦮 db-ally</h1>
 
 <p align="center">
     <em>Efficient, consistent and secure library for querying structured data with natural language</em>

benchmark/dbally_benchmark/e2e_benchmark.py

@@ -23,9 +23,9 @@
 import dbally
 from dbally.collection import Collection
 from dbally.collection.exceptions import NoViewFoundError
-from dbally.iql_generator.iql_prompt_template import UnsupportedQueryError, default_iql_template
+from dbally.iql_generator.prompt import IQL_GENERATION_TEMPLATE, UnsupportedQueryError
 from dbally.llms.litellm import LiteLLM
-from dbally.view_selection.view_selector_prompt_template import default_view_selector_template
+from dbally.view_selection.prompt import VIEW_SELECTION_TEMPLATE
 
 
 async def _run_dbally_for_single_example(example: BIRDExample, collection: Collection) -> Text2SQLResult:
@@ -126,9 +126,9 @@ async def evaluate(cfg: DictConfig) -> Any:
     logger.info(f"db-ally predictions saved under directory: {output_dir}")
 
     if run:
-        run["config/iql_prompt_template"] = stringify_unsupported(default_iql_template.chat)
-        run["config/view_selection_prompt_template"] = stringify_unsupported(default_view_selector_template.chat)
-        run["config/iql_prompt_template"] = stringify_unsupported(default_iql_template)
+        run["config/iql_prompt_template"] = stringify_unsupported(IQL_GENERATION_TEMPLATE.chat)
+        run["config/view_selection_prompt_template"] = stringify_unsupported(VIEW_SELECTION_TEMPLATE.chat)
+        run["config/iql_prompt_template"] = stringify_unsupported(IQL_GENERATION_TEMPLATE)
         run[f"evaluation/{metrics_file_name}"].upload((output_dir / metrics_file_name).as_posix())
         run[f"evaluation/{results_file_name}"].upload((output_dir / results_file_name).as_posix())
         run["evaluation/metrics"] = stringify_unsupported(metrics)

benchmark/dbally_benchmark/iql_benchmark.py

@@ -21,7 +21,7 @@
 
 from dbally.audit.event_tracker import EventTracker
 from dbally.iql_generator.iql_generator import IQLGenerator
-from dbally.iql_generator.iql_prompt_template import UnsupportedQueryError, default_iql_template
+from dbally.iql_generator.prompt import IQL_GENERATION_TEMPLATE, UnsupportedQueryError
 from dbally.llms.litellm import LiteLLM
 from dbally.views.structured import BaseStructuredView
 
@@ -33,13 +33,15 @@ async def _run_iql_for_single_example(
     event_tracker = EventTracker()
 
     try:
-        iql_filters, _ = await iql_generator.generate_iql(
-            question=example.question, filters=filter_list, event_tracker=event_tracker
+        iql_filters = await iql_generator.generate_iql(
+            question=example.question,
+            filters=filter_list,
+            event_tracker=event_tracker,
         )
     except UnsupportedQueryError:
         return IQLResult(question=example.question, iql_filters="UNSUPPORTED_QUERY", exception_raised=True)
 
-    return IQLResult(question=example.question, iql_filters=iql_filters, exception_raised=False)
+    return IQLResult(question=example.question, iql_filters=str(iql_filters), exception_raised=False)
 
 
 async def run_iql_for_dataset(
@@ -139,7 +141,7 @@ async def evaluate(cfg: DictConfig) -> Any:
     logger.info(f"IQL predictions saved under directory: {output_dir}")
 
     if run:
-        run["config/iql_prompt_template"] = stringify_unsupported(default_iql_template.chat)
+        run["config/iql_prompt_template"] = stringify_unsupported(IQL_GENERATION_TEMPLATE.chat)
         run[f"evaluation/{metrics_file_name}"].upload((output_dir / metrics_file_name).as_posix())
         run[f"evaluation/{results_file_name}"].upload((output_dir / results_file_name).as_posix())
         run["evaluation/metrics"] = stringify_unsupported(metrics)

benchmark/dbally_benchmark/text2sql/prompt_template.py

@@ -1,4 +1,4 @@
-from dbally.prompts import PromptTemplate
+from dbally.prompt import PromptTemplate
 
 TEXT2SQL_PROMPT_TEMPLATE = PromptTemplate(
     (

docs/about/roadmap.md

@@ -10,14 +10,13 @@ Below you can find a list of planned features and integrations.
 ## Planned Features
 
 - [ ] **Support analytical queries**: support for exposing operations beyond filtering.
-- [ ] **Few-shot prompting configuration**: allow users to configure the few-shot prompting in View definition to
+- [x] **Few-shot prompting configuration**: allow users to configure the few-shot prompting in View definition to
     improve IQL generation accuracy.
 - [ ] **Request contextualization**: allow to provide extra context for db-ally runs, such as user asking the question.
 - [X] **OpenAI Assistants API adapter**: allow to embed db-ally into OpenAI's Assistants API to easily extend the
     capabilities of the assistant.
 - [ ] **Langchain adapter**: allow to embed db-ally into Langchain applications.
 
-
 ## Integrations
 
 Being agnostic to the underlying technology is one of the main goals of db-ally.

docs/assets/guide_dog_lg.png

@@ -10,8 +10,7 @@ In this guide we will implement a simple [Event Handler](../reference/event_hand
 First, we need to create a new class that inherits from `EventHandler` and implements the all abstract methods.
 
 ```python
-from dbally.audit import EventHandler
-from dbally.data_models.audit import RequestStart, RequestEnd
+from dbally.audit import EventHandler, RequestStart, RequestEnd
 
 class FileEventHandler(EventHandler):