docs(views): add docs for freeform views

[micpst]

This PR adds docs for freeform views.

[github-actions]

Trivy scanning results.

[github-actions]

Code Coverage Summary

Filename                                                  Stmts    Miss  Cover    Missing
------------------------------------------------------  -------  ------  -------  ---------------------------------------------------------------------
dbally/_main.py                                              12       0  100.00%
dbally/_types.py                                              8       1  87.50%   24
dbally/collection.py                                         92       1  98.91%   144
dbally/exceptions.py                                          1       0  100.00%
dbally/assistants/base.py                                    24       0  100.00%
dbally/assistants/openai.py                                  59       2  96.61%   59-76
dbally/audit/event_span.py                                    8       0  100.00%
dbally/audit/event_tracker.py                                34       6  82.35%   35, 48, 59, 69, 86, 92
dbally/audit/event_handlers/base.py                          15       0  100.00%
dbally/audit/event_handlers/cli_event_handler.py             59      38  35.59%   13-15, 44-48, 51-59, 68-70, 82-94, 112-119, 129-133
dbally/audit/event_handlers/langsmith_event_handler.py       29      25  13.79%   6-107
dbally/data_models/audit.py                                  28       0  100.00%
dbally/data_models/execution_result.py                       14       0  100.00%
dbally/embeddings/base.py                                     5       0  100.00%
dbally/embeddings/exceptions.py                              15       6  60.00%   10-11, 20, 29-30, 39
dbally/embeddings/litellm.py                                 28      12  57.14%   7-8, 44, 68-84
dbally/gradio/gradio_interface.py                           100     100  0.00%    1-249
dbally/iql/_exceptions.py                                    25       1  96.00%   35
dbally/iql/_processor.py                                     80       7  91.25%   16, 47, 64, 70, 76, 85, 91
dbally/iql/_query.py                                         13       1  92.31%   8
dbally/iql/_type_validators.py                               39       2  94.87%   24, 28
dbally/iql/syntax.py                                         36       9  75.00%   6-9, 27, 36, 60, 63-66
dbally/iql_generator/iql_generator.py                        31       0  100.00%
dbally/iql_generator/iql_prompt_template.py                  13       1  92.31%   45
dbally/llms/base.py                                          32       1  96.88%   35
dbally/llms/litellm.py                                       24      10  58.33%   8-9, 48-54, 61, 79
dbally/llms/clients/base.py                                  24       2  91.67%   46-47
dbally/llms/clients/exceptions.py                            15       6  60.00%   10-11, 20, 29-30, 39
dbally/llms/clients/litellm.py                               44      20  54.55%   8-9, 65-71, 97-118
dbally/nl_responder/nl_responder.py                          29       4  86.21%   75-84
dbally/nl_responder/nl_responder_prompt_template.py           7       0  100.00%
dbally/nl_responder/query_explainer_prompt_template.py        7       0  100.00%
dbally/prompts/common_validation_utils.py                    16       0  100.00%
dbally/prompts/prompt_template.py                            28       2  92.86%   27, 35
dbally/similarity/chroma_store.py                            37       0  100.00%
dbally/similarity/elastic_vector_search.py                   19      16  15.79%   5-102
dbally/similarity/elasticsearch_store.py                     22      19  13.64%   5-107
dbally/similarity/faiss_store.py                             38      35  7.90%    5-103
dbally/similarity/fetcher.py                                  5       0  100.00%
dbally/similarity/index.py                                   26       0  100.00%
dbally/similarity/sqlalchemy_base.py                         44      19  56.82%   35-37, 46, 68, 77, 86-89, 99-105, 123-126
dbally/similarity/store.py                                    7       0  100.00%
dbally/view_selection/base.py                                 7       0  100.00%
dbally/view_selection/llm_view_selector.py                   20       0  100.00%
dbally/view_selection/random_view_selector.py                10      10  0.00%    1-35
dbally/view_selection/view_selector_prompt_template.py       11       2  81.82%   32-33
dbally/views/base.py                                         13       1  92.31%   51
dbally/views/decorators.py                                    6       0  100.00%
dbally/views/exposed_functions.py                            33       1  96.97%   24
dbally/views/methods_base.py                                 34       2  94.12%   75, 83
dbally/views/pandas_base.py                                  33       1  96.97%   64
dbally/views/sqlalchemy_base.py                              37       7  81.08%   48, 63-65, 83-87
dbally/views/structured.py                                   45       0  100.00%
dbally/views/freeform/text2sql/config.py                     21       1  95.24%   47
dbally/views/freeform/text2sql/exceptions.py                  7       3  57.14%   12-14
dbally/views/freeform/text2sql/view.py                       95      22  76.84%   69, 72, 75, 78, 81, 93, 163, 167-170, 173, 205, 217-218, 232, 245-250
dbally_cli/main.py                                            5       5  0.00%    1-13
dbally_cli/text2sql.py                                       96      96  0.00%    1-248
dbally_codegen/autodiscovery.py                             106      12  88.68%   193-195, 216-229, 232-235, 304-305, 401-406
dbally_codegen/generator.py                                 180       7  96.11%   81, 91, 314, 342, 360, 374, 420
TOTAL                                                      1951     516  73.55%

Diff against main

Filename      Stmts    Miss  Cover
----------  -------  ------  --------
TOTAL             0       0  +100.00%

Results for commit: 5725fda

Minimum allowed coverage is 60%

♻️ This comment has been updated with latest results