Knowledge
src.worksheets.knowledge
Attributes
CURRENT_DIR
module-attribute
CURRENT_DIR = dirname(realpath(__file__))
Classes
SUQLKnowledgeBase
Bases: BaseModel
Knowledge base for SUQL queries
Source code in src/worksheets/knowledge.py
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 |
|
Attributes
llm_model_name
instance-attribute
llm_model_name: str
tables_with_primary_keys
class-attribute
instance-attribute
tables_with_primary_keys: Optional[dict] = None
database_name
class-attribute
instance-attribute
database_name: Optional[str] = None
embedding_server_address
class-attribute
instance-attribute
embedding_server_address: Optional[str] = None
source_file_mapping
class-attribute
instance-attribute
source_file_mapping: Optional[dict] = None
postprocessing_fn
instance-attribute
postprocessing_fn: Callable
result_postprocessing_fn
class-attribute
instance-attribute
result_postprocessing_fn: Optional[Callable] = None
max_rows
class-attribute
instance-attribute
max_rows: int = 3
db_username
class-attribute
instance-attribute
db_username: Optional[str] = None
db_password
class-attribute
instance-attribute
db_password: Optional[str] = None
db_host
class-attribute
instance-attribute
db_host: str = '127.0.0.1'
db_port
class-attribute
instance-attribute
db_port: str = '5432'
api_base
class-attribute
instance-attribute
api_base: Optional[str] = None
api_version
class-attribute
instance-attribute
api_version: Optional[str] = None
Functions
run
run(query, *args, **kwargs)
Run the SUQL query and return the result.
Source code in src/worksheets/knowledge.py
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 |
|
BaseSUQLParser
Bases: BaseModel
Base class for SUQL parsers
Source code in src/worksheets/knowledge.py
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 |
|
Attributes
llm_model_name
instance-attribute
llm_model_name: str
Functions
parse
async
parse(dlg_history: List[CurrentDialogueTurn], query: str)
Source code in src/worksheets/knowledge.py
104 105 |
|
convert_dlg_turn_to_suql_dlg_turn
convert_dlg_turn_to_suql_dlg_turn(dlg_history, turn, db_results)
Source code in src/worksheets/knowledge.py
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 |
|
SUQLParser
Bases: BaseSUQLParser
Parser for SUQL queries
Source code in src/worksheets/knowledge.py
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 |
|
Attributes
llm_model_name
instance-attribute
llm_model_name: str
prompt_selector
class-attribute
instance-attribute
prompt_selector: Optional[Callable] = None
Functions
convert_dlg_turn_to_suql_dlg_turn
convert_dlg_turn_to_suql_dlg_turn(dlg_history, turn, db_results)
Source code in src/worksheets/knowledge.py
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 |
|
parse
async
parse(dlg_history: List[CurrentDialogueTurn], query: str, bot: GenieRuntime, db_results: List[str] | None = None)
A SUQL conversational semantic parser, with a pre-set prompt file. The function convets the List[CurrentDialogueTurn] to the expected format in SUQL (suql.agent.DialogueTurn) and calls the prompt file.
Parameters:
dlg_history
(List[CurrentDialogueTurn]): a list of past dialog turns.
query
(str): the current query to be parsed.
Returns:
parsed_output
(str): a parsed SUQL output
Source code in src/worksheets/knowledge.py
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 |
|
SUQLReActParser
Bases: BaseSUQLParser
ReAct Parser for SUQL queries
Source code in src/worksheets/knowledge.py
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 |
|
Attributes
llm_model_name
instance-attribute
llm_model_name: str
example_path
instance-attribute
example_path: str
instruction_path
instance-attribute
instruction_path: str
table_schema_path
instance-attribute
table_schema_path: str
knowledge
instance-attribute
knowledge: SUQLKnowledgeBase
examples
class-attribute
instance-attribute
examples: Optional[List[str]] = None
conversation_history
class-attribute
instance-attribute
conversation_history: List = []
instructions
class-attribute
instance-attribute
instructions: Optional[List[str]] = readlines()
table_schema
class-attribute
instance-attribute
table_schema: Optional[str] = read()
Functions
convert_dlg_turn_to_suql_dlg_turn
convert_dlg_turn_to_suql_dlg_turn(dlg_history, turn, db_results)
Source code in src/worksheets/knowledge.py
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 |
|
__init__
__init__(**kwargs)
Source code in src/worksheets/knowledge.py
221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 |
|
parse
async
parse(dlg_history: List[CurrentDialogueTurn], query: str, bot: GenieRuntime, db_results: List[str] | None = None)
Source code in src/worksheets/knowledge.py
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 |
|
anext_turn
async
anext_turn(user_input: str, update_conversation_history: bool = False, table_w_ids: dict = None, database_name: str = None, embedding_server_address: str = None, source_file_mapping: dict = None)
Source code in src/worksheets/knowledge.py
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 |
|
update_turn
update_turn(conversation_history, output, response)
Source code in src/worksheets/knowledge.py
312 313 314 315 316 317 318 319 320 |
|