forked from vanna-ai/vanna
-
Notifications
You must be signed in to change notification settings - Fork 0
/
base.py
947 lines (785 loc) · 31.7 KB
/
base.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
import json
import os
import re
import sqlite3
import traceback
from abc import ABC, abstractmethod
from typing import List, Tuple, Union
from urllib.parse import urlparse
import pandas as pd
import plotly
import plotly.express as px
import plotly.graph_objects as go
import requests
from ..exceptions import DependencyError, ImproperlyConfigured, ValidationError
from ..types import TrainingPlan, TrainingPlanItem
from ..utils import validate_config_path
class VannaBase(ABC):
def __init__(self, config=None):
self.config = config
self.run_sql_is_set = False
def log(self, message: str):
print(message)
def generate_sql(self, question: str, **kwargs) -> str:
question_sql_list = self.get_similar_question_sql(question, **kwargs)
ddl_list = self.get_related_ddl(question, **kwargs)
doc_list = self.get_related_documentation(question, **kwargs)
prompt = self.get_sql_prompt(
question=question,
question_sql_list=question_sql_list,
ddl_list=ddl_list,
doc_list=doc_list,
**kwargs,
)
llm_response = self.submit_prompt(prompt, **kwargs)
return self.extract_sql(llm_response)
def extract_sql(self, llm_response: str) -> str:
# If the llm_response contains a markdown code block, with or without the sql tag, extract the sql from it
sql = re.search(r"```sql\n(.*)```", llm_response, re.DOTALL)
if sql:
self.log(f"Output from LLM: {llm_response} \nExtracted SQL: {sql.group(1)}")
return sql.group(1)
sql = re.search(r"```(.*)```", llm_response, re.DOTALL)
if sql:
self.log(f"Output from LLM: {llm_response} \nExtracted SQL: {sql.group(1)}")
return sql.group(1)
return llm_response
def is_sql_valid(self, sql: str) -> bool:
# This is a check to see the SQL is valid and should be run
# This simple function just checks if the SQL contains a SELECT statement
if "SELECT" in sql.upper():
return True
else:
return False
def generate_followup_questions(self, question: str, **kwargs) -> str:
question_sql_list = self.get_similar_question_sql(question, **kwargs)
ddl_list = self.get_related_ddl(question, **kwargs)
doc_list = self.get_related_documentation(question, **kwargs)
prompt = self.get_followup_questions_prompt(
question=question,
question_sql_list=question_sql_list,
ddl_list=ddl_list,
doc_list=doc_list,
**kwargs,
)
llm_response = self.submit_prompt(prompt, **kwargs)
numbers_removed = re.sub(r"^\d+\.\s*", "", llm_response, flags=re.MULTILINE)
return numbers_removed.split("\n")
def generate_questions(self, **kwargs) -> list[str]:
"""
**Example:**
```python
vn.generate_questions()
```
Generate a list of questions that you can ask Vanna.AI.
"""
question_sql = self.get_similar_question_sql(question="", **kwargs)
return [q["question"] for q in question_sql]
# ----------------- Use Any Embeddings API ----------------- #
@abstractmethod
def generate_embedding(self, data: str, **kwargs) -> list[float]:
pass
# ----------------- Use Any Database to Store and Retrieve Context ----------------- #
@abstractmethod
def get_similar_question_sql(self, question: str, **kwargs) -> list:
pass
@abstractmethod
def get_related_ddl(self, question: str, **kwargs) -> list:
pass
@abstractmethod
def get_related_documentation(self, question: str, **kwargs) -> list:
pass
@abstractmethod
def add_question_sql(self, question: str, sql: str, **kwargs) -> str:
pass
@abstractmethod
def add_ddl(self, ddl: str, **kwargs) -> str:
pass
@abstractmethod
def add_documentation(self, documentation: str, **kwargs) -> str:
pass
@abstractmethod
def get_training_data(self, **kwargs) -> pd.DataFrame:
pass
@abstractmethod
def remove_training_data(id: str, **kwargs) -> bool:
pass
# ----------------- Use Any Language Model API ----------------- #
@abstractmethod
def get_sql_prompt(
self,
question: str,
question_sql_list: list,
ddl_list: list,
doc_list: list,
**kwargs,
):
pass
@abstractmethod
def get_followup_questions_prompt(
self,
question: str,
question_sql_list: list,
ddl_list: list,
doc_list: list,
**kwargs,
):
pass
@abstractmethod
def submit_prompt(self, prompt, **kwargs) -> str:
pass
@abstractmethod
def generate_question(self, sql: str, **kwargs) -> str:
pass
@abstractmethod
def generate_plotly_code(
self, question: str = None, sql: str = None, df_metadata: str = None, **kwargs
) -> str:
pass
# ----------------- Connect to Any Database to run the Generated SQL ----------------- #
def connect_to_snowflake(
self,
account: str,
username: str,
password: str,
database: str,
role: Union[str, None] = None,
warehouse: Union[str, None] = None,
):
try:
snowflake = __import__("snowflake.connector")
except ImportError:
raise DependencyError(
"You need to install required dependencies to execute this method, run command:"
" \npip install vanna[snowflake]"
)
if username == "my-username":
username_env = os.getenv("SNOWFLAKE_USERNAME")
if username_env is not None:
username = username_env
else:
raise ImproperlyConfigured("Please set your Snowflake username.")
if password == "my-password":
password_env = os.getenv("SNOWFLAKE_PASSWORD")
if password_env is not None:
password = password_env
else:
raise ImproperlyConfigured("Please set your Snowflake password.")
if account == "my-account":
account_env = os.getenv("SNOWFLAKE_ACCOUNT")
if account_env is not None:
account = account_env
else:
raise ImproperlyConfigured("Please set your Snowflake account.")
if database == "my-database":
database_env = os.getenv("SNOWFLAKE_DATABASE")
if database_env is not None:
database = database_env
else:
raise ImproperlyConfigured("Please set your Snowflake database.")
conn = snowflake.connector.connect(
user=username,
password=password,
account=account,
database=database,
)
def run_sql_snowflake(sql: str) -> pd.DataFrame:
cs = conn.cursor()
if role is not None:
cs.execute(f"USE ROLE {role}")
if warehouse is not None:
cs.execute(f"USE WAREHOUSE {warehouse}")
cs.execute(f"USE DATABASE {database}")
cur = cs.execute(sql)
results = cur.fetchall()
# Create a pandas dataframe from the results
df = pd.DataFrame(results, columns=[desc[0] for desc in cur.description])
return df
self.run_sql = run_sql_snowflake
self.run_sql_is_set = True
def connect_to_sqlite(self, url: str):
"""
Connect to a SQLite database. This is just a helper function to set [`vn.run_sql`][vanna.run_sql]
Args:
url (str): The URL of the database to connect to.
Returns:
None
"""
# URL of the database to download
# Path to save the downloaded database
path = os.path.basename(urlparse(url).path)
# Download the database if it doesn't exist
if not os.path.exists(url):
response = requests.get(url)
response.raise_for_status() # Check that the request was successful
with open(path, "wb") as f:
f.write(response.content)
url = path
# Connect to the database
conn = sqlite3.connect(url, check_same_thread=False)
def run_sql_sqlite(sql: str):
return pd.read_sql_query(sql, conn)
self.run_sql = run_sql_sqlite
self.run_sql_is_set = True
def connect_to_postgres(
self,
host: str = None,
dbname: str = None,
user: str = None,
password: str = None,
port: int = None,
):
"""
Connect to postgres using the psycopg2 connector. This is just a helper function to set [`vn.run_sql`][vanna.run_sql]
**Example:**
```python
vn.connect_to_postgres(
host="myhost",
dbname="mydatabase",
user="myuser",
password="mypassword",
port=5432
)
```
Args:
host (str): The postgres host.
dbname (str): The postgres database name.
user (str): The postgres user.
password (str): The postgres password.
port (int): The postgres Port.
"""
try:
import psycopg2
import psycopg2.extras
except ImportError:
raise DependencyError(
"You need to install required dependencies to execute this method,"
" run command: \npip install vanna[postgres]"
)
if not host:
host = os.getenv("HOST")
if not host:
raise ImproperlyConfigured("Please set your postgres host")
if not dbname:
dbname = os.getenv("DATABASE")
if not dbname:
raise ImproperlyConfigured("Please set your postgres database")
if not user:
user = os.getenv("PG_USER")
if not user:
raise ImproperlyConfigured("Please set your postgres user")
if not password:
password = os.getenv("PASSWORD")
if not password:
raise ImproperlyConfigured("Please set your postgres password")
if not port:
port = os.getenv("PORT")
if not port:
raise ImproperlyConfigured("Please set your postgres port")
conn = None
try:
conn = psycopg2.connect(
host=host,
dbname=dbname,
user=user,
password=password,
port=port,
)
except psycopg2.Error as e:
raise ValidationError(e)
def run_sql_postgres(sql: str) -> Union[pd.DataFrame, None]:
if conn:
try:
cs = conn.cursor()
cs.execute(sql)
results = cs.fetchall()
# Create a pandas dataframe from the results
df = pd.DataFrame(
results, columns=[desc[0] for desc in cs.description]
)
return df
except psycopg2.Error as e:
conn.rollback()
raise ValidationError(e)
self.run_sql_is_set = True
self.run_sql = run_sql_postgres
def connect_to_bigquery(self, cred_file_path: str = None, project_id: str = None):
"""
Connect to gcs using the bigquery connector. This is just a helper function to set [`vn.run_sql`][vanna.run_sql]
**Example:**
```python
vn.connect_to_bigquery(
project_id="myprojectid",
cred_file_path="path/to/credentials.json",
)
```
Args:
project_id (str): The gcs project id.
cred_file_path (str): The gcs credential file path
"""
try:
from google.api_core.exceptions import GoogleAPIError
from google.cloud import bigquery
from google.oauth2 import service_account
except ImportError:
raise DependencyError(
"You need to install required dependencies to execute this method, run command:"
" \npip install vanna[bigquery]"
)
if not project_id:
project_id = os.getenv("PROJECT_ID")
if not project_id:
raise ImproperlyConfigured("Please set your Google Cloud Project ID.")
import sys
if "google.colab" in sys.modules:
try:
from google.colab import auth
auth.authenticate_user()
except Exception as e:
raise ImproperlyConfigured(e)
else:
print("Not using Google Colab.")
conn = None
try:
conn = bigquery.Client(project=project_id)
except:
print("Could not found any google cloud implicit credentials")
if cred_file_path:
# Validate file path and pemissions
validate_config_path(cred_file_path)
else:
if not conn:
raise ValidationError(
"Pleae provide a service account credentials json file"
)
if not conn:
with open(cred_file_path, "r") as f:
credentials = service_account.Credentials.from_service_account_info(
json.loads(f.read()),
scopes=["https://www.googleapis.com/auth/cloud-platform"],
)
try:
conn = bigquery.Client(project=project_id, credentials=credentials)
except:
raise ImproperlyConfigured(
"Could not connect to bigquery please correct credentials"
)
def run_sql_bigquery(sql: str) -> Union[pd.DataFrame, None]:
if conn:
try:
job = conn.query(sql)
df = job.result().to_dataframe()
return df
except GoogleAPIError as error:
errors = []
for error in error.errors:
errors.append(error["message"])
raise errors
return None
self.run_sql_is_set = True
self.run_sql = run_sql_bigquery
def run_sql(sql: str, **kwargs) -> pd.DataFrame:
raise NotImplementedError(
"You need to connect_to_snowflake or other database first."
)
def ask(
self,
question: Union[str, None] = None,
print_results: bool = True,
auto_train: bool = True,
) -> Union[
Tuple[
Union[str, None],
Union[pd.DataFrame, None],
Union[plotly.graph_objs.Figure, None],
],
None,
]:
if question is None:
question = input("Enter a question: ")
try:
sql = self.generate_sql(question=question)
except Exception as e:
print(e)
return None, None, None
if print_results:
try:
Code = __import__("IPython.display", fromlist=["Code"]).Code
display(Code(sql))
except Exception as e:
print(sql)
if self.run_sql_is_set is False:
print(
"If you want to run the SQL query, connect to a database first. See here: https://vanna.ai/docs/databases.html"
)
if print_results:
return None
else:
return sql, None, None
try:
if self.is_sql_valid(sql) is False:
print("SQL is not valid, please try again.")
if print_results:
return None
else:
return sql, None, None
df = self.run_sql(sql)
if print_results:
try:
display = __import__(
"IPython.display", fromlist=["display"]
).display
display(df)
except Exception as e:
print(df)
if len(df) > 0 and auto_train:
self.add_question_sql(question=question, sql=sql)
try:
plotly_code = self.generate_plotly_code(
question=question,
sql=sql,
df_metadata=f"Running df.dtypes gives:\n {df.dtypes}",
)
fig = self.get_plotly_figure(plotly_code=plotly_code, df=df)
if print_results:
try:
display = __import__(
"IPython.display", fromlist=["display"]
).display
Image = __import__("IPython.display", fromlist=["Image"]).Image
img_bytes = fig.to_image(format="png", scale=2)
display(Image(img_bytes))
except Exception as e:
fig.show()
except Exception as e:
# Print stack trace
traceback.print_exc()
print("Couldn't run plotly code: ", e)
if print_results:
return None
else:
return sql, df, None
except Exception as e:
print("Couldn't run sql: ", e)
if print_results:
return None
else:
return sql, None, None
def train(
self,
question: str = None,
sql: str = None,
ddl: str = None,
documentation: str = None,
plan: TrainingPlan = None,
) -> str:
"""
**Example:**
```python
vn.train()
```
Train Vanna.AI on a question and its corresponding SQL query.
If you call it with no arguments, it will check if you connected to a database and it will attempt to train on the metadata of that database.
If you call it with the sql argument, it's equivalent to [`add_sql()`][vanna.add_sql].
If you call it with the ddl argument, it's equivalent to [`add_ddl()`][vanna.add_ddl].
If you call it with the documentation argument, it's equivalent to [`add_documentation()`][vanna.add_documentation].
Additionally, you can pass a [`TrainingPlan`][vanna.TrainingPlan] object. Get a training plan with [`vn.get_training_plan_experimental()`][vanna.get_training_plan_experimental].
Args:
question (str): The question to train on.
sql (str): The SQL query to train on.
ddl (str): The DDL statement.
documentation (str): The documentation to train on.
plan (TrainingPlan): The training plan to train on.
"""
if question and not sql:
raise ValidationError(f"Please also provide a SQL query")
if documentation:
print("Adding documentation....")
return self.add_documentation(documentation)
if sql:
if question is None:
question = self.generate_question(sql)
print("Question generated with sql:", question, "\nAdding SQL...")
return self.add_question_sql(question=question, sql=sql)
if ddl:
print("Adding ddl:", ddl)
return self.add_ddl(ddl)
if plan:
for item in plan._plan:
if item.item_type == TrainingPlanItem.ITEM_TYPE_DDL:
self.add_ddl(item.item_value)
elif item.item_type == TrainingPlanItem.ITEM_TYPE_IS:
self.add_documentation(item.item_value)
elif item.item_type == TrainingPlanItem.ITEM_TYPE_SQL:
self.add_question_sql(question=item.item_name, sql=item.item_value)
def _get_databases(self) -> List[str]:
try:
print("Trying INFORMATION_SCHEMA.DATABASES")
df_databases = self.run_sql("SELECT * FROM INFORMATION_SCHEMA.DATABASES")
except Exception as e:
print(e)
try:
print("Trying SHOW DATABASES")
df_databases = self.run_sql("SHOW DATABASES")
except Exception as e:
print(e)
return []
return df_databases["DATABASE_NAME"].unique().tolist()
def _get_information_schema_tables(self, database: str) -> pd.DataFrame:
df_tables = self.run_sql(f"SELECT * FROM {database}.INFORMATION_SCHEMA.TABLES")
return df_tables
def get_training_plan_generic(self, df) -> TrainingPlan:
# For each of the following, we look at the df columns to see if there's a match:
database_column = df.columns[
df.columns.str.lower().str.contains("database")
| df.columns.str.lower().str.contains("table_catalog")
].to_list()[0]
schema_column = df.columns[
df.columns.str.lower().str.contains("table_schema")
].to_list()[0]
table_column = df.columns[
df.columns.str.lower().str.contains("table_name")
].to_list()[0]
column_column = df.columns[
df.columns.str.lower().str.contains("column_name")
].to_list()[0]
data_type_column = df.columns[
df.columns.str.lower().str.contains("data_type")
].to_list()[0]
plan = TrainingPlan([])
for database in df[database_column].unique().tolist():
for schema in (
df.query(f'{database_column} == "{database}"')[schema_column]
.unique()
.tolist()
):
for table in (
df.query(
f'{database_column} == "{database}" and {schema_column} == "{schema}"'
)[table_column]
.unique()
.tolist()
):
df_columns_filtered_to_table = df.query(
f'{database_column} == "{database}" and {schema_column} == "{schema}" and {table_column} == "{table}"'
)
doc = f"The following columns are in the {table} table in the {database} database:\n\n"
doc += df_columns_filtered_to_table[
[
database_column,
schema_column,
table_column,
column_column,
data_type_column,
]
].to_markdown()
plan._plan.append(
TrainingPlanItem(
item_type=TrainingPlanItem.ITEM_TYPE_IS,
item_group=f"{database}.{schema}",
item_name=table,
item_value=doc,
)
)
return plan
def get_training_plan_snowflake(
self,
filter_databases: Union[List[str], None] = None,
filter_schemas: Union[List[str], None] = None,
include_information_schema: bool = False,
use_historical_queries: bool = True,
) -> TrainingPlan:
plan = TrainingPlan([])
if self.run_sql_is_set is False:
raise ImproperlyConfigured("Please connect to a database first.")
if use_historical_queries:
try:
print("Trying query history")
df_history = self.run_sql(
""" select * from table(information_schema.query_history(result_limit => 5000)) order by start_time"""
)
df_history_filtered = df_history.query("ROWS_PRODUCED > 1")
if filter_databases is not None:
mask = (
df_history_filtered["QUERY_TEXT"]
.str.lower()
.apply(
lambda x: any(
s in x for s in [s.lower() for s in filter_databases]
)
)
)
df_history_filtered = df_history_filtered[mask]
if filter_schemas is not None:
mask = (
df_history_filtered["QUERY_TEXT"]
.str.lower()
.apply(
lambda x: any(
s in x for s in [s.lower() for s in filter_schemas]
)
)
)
df_history_filtered = df_history_filtered[mask]
if len(df_history_filtered) > 10:
df_history_filtered = df_history_filtered.sample(10)
for query in df_history_filtered["QUERY_TEXT"].unique().tolist():
plan._plan.append(
TrainingPlanItem(
item_type=TrainingPlanItem.ITEM_TYPE_SQL,
item_group="",
item_name=self.generate_question(query),
item_value=query,
)
)
except Exception as e:
print(e)
databases = self._get_databases()
for database in databases:
if filter_databases is not None and database not in filter_databases:
continue
try:
df_tables = self._get_information_schema_tables(database=database)
print(f"Trying INFORMATION_SCHEMA.COLUMNS for {database}")
df_columns = self.run_sql(
f"SELECT * FROM {database}.INFORMATION_SCHEMA.COLUMNS"
)
for schema in df_tables["TABLE_SCHEMA"].unique().tolist():
if filter_schemas is not None and schema not in filter_schemas:
continue
if (
not include_information_schema
and schema == "INFORMATION_SCHEMA"
):
continue
df_columns_filtered_to_schema = df_columns.query(
f"TABLE_SCHEMA == '{schema}'"
)
try:
tables = (
df_columns_filtered_to_schema["TABLE_NAME"]
.unique()
.tolist()
)
for table in tables:
df_columns_filtered_to_table = (
df_columns_filtered_to_schema.query(
f"TABLE_NAME == '{table}'"
)
)
doc = f"The following columns are in the {table} table in the {database} database:\n\n"
doc += df_columns_filtered_to_table[
[
"TABLE_CATALOG",
"TABLE_SCHEMA",
"TABLE_NAME",
"COLUMN_NAME",
"DATA_TYPE",
"COMMENT",
]
].to_markdown()
plan._plan.append(
TrainingPlanItem(
item_type=TrainingPlanItem.ITEM_TYPE_IS,
item_group=f"{database}.{schema}",
item_name=table,
item_value=doc,
)
)
except Exception as e:
print(e)
pass
except Exception as e:
print(e)
return plan
def get_plotly_figure(
self, plotly_code: str, df: pd.DataFrame, dark_mode: bool = True
) -> plotly.graph_objs.Figure:
"""
**Example:**
```python
fig = vn.get_plotly_figure(
plotly_code="fig = px.bar(df, x='name', y='salary')",
df=df
)
fig.show()
```
Get a Plotly figure from a dataframe and Plotly code.
Args:
df (pd.DataFrame): The dataframe to use.
plotly_code (str): The Plotly code to use.
Returns:
plotly.graph_objs.Figure: The Plotly figure.
"""
ldict = {"df": df, "px": px, "go": go}
try:
exec(plotly_code, globals(), ldict)
fig = ldict.get("fig", None)
except Exception as e:
# Inspect data types
numeric_cols = df.select_dtypes(include=["number"]).columns.tolist()
categorical_cols = df.select_dtypes(
include=["object", "category"]
).columns.tolist()
# Decision-making for plot type
if len(numeric_cols) >= 2:
# Use the first two numeric columns for a scatter plot
fig = px.scatter(df, x=numeric_cols[0], y=numeric_cols[1])
elif len(numeric_cols) == 1 and len(categorical_cols) >= 1:
# Use a bar plot if there's one numeric and one categorical column
fig = px.bar(df, x=categorical_cols[0], y=numeric_cols[0])
elif len(categorical_cols) >= 1 and df[categorical_cols[0]].nunique() < 10:
# Use a pie chart for categorical data with fewer unique values
fig = px.pie(df, names=categorical_cols[0])
else:
# Default to a simple line plot if above conditions are not met
fig = px.line(df)
if fig is None:
return None
if dark_mode:
fig.update_layout(template="plotly_dark")
return fig
class SplitStorage(VannaBase):
def __init__(self, config=None):
VannaBase.__init__(self, config=config)
def get_similar_question_sql(self, embedding: str, **kwargs) -> list:
question_sql_ids = self.get_similar_question_sql_ids(embedding, **kwargs)
question_sql_list = self.get_question_sql(question_sql_ids, **kwargs)
return question_sql_list
def get_related_ddl(self, embedding: str, **kwargs) -> list:
ddl_ids = self.get_related_ddl_ids(embedding, **kwargs)
ddl_list = self.get_ddl(ddl_ids, **kwargs)
return ddl_list
def get_related_documentation(self, embedding: str, **kwargs) -> list:
doc_ids = self.get_related_documentation_ids(embedding, **kwargs)
doc_list = self.get_documentation(doc_ids, **kwargs)
return doc_list
# ----------------- Use Any Vector Database to Store and Lookup Embedding Similarity ----------------- #
@abstractmethod
def store_question_sql_embedding(self, embedding: str, **kwargs) -> str:
pass
@abstractmethod
def store_ddl_embedding(self, embedding: str, **kwargs) -> str:
pass
@abstractmethod
def store_documentation_embedding(self, embedding: str, **kwargs) -> str:
pass
@abstractmethod
def get_similar_question_sql_ids(self, embedding: str, **kwargs) -> list:
pass
@abstractmethod
def get_related_ddl_ids(self, embedding: str, **kwargs) -> list:
pass
@abstractmethod
def get_related_documentation_ids(self, embedding: str, **kwargs) -> list:
pass
# ----------------- Use Database to Retrieve the Documents from ID Lists ----------------- #
@abstractmethod
def get_question_sql(self, question_sql_ids: list, **kwargs) -> list:
pass
@abstractmethod
def get_documentation(self, doc_ids: list, **kwargs) -> list:
pass
@abstractmethod
def get_ddl(self, ddl_ids: list, **kwargs) -> list:
pass