Creating Custom BlendSQL Ingredients
All the built-in LLM ingredients inherit from the base classes QAIngredient
, MapIngredient
, JoinIngredient
, and AliasIngredient
.
These are intended to be helpful abstractions, so that the user can easily implement their own functions to run within a BlendSQL script.
The processing logic for a custom ingredient should go in a run()
class function, and accept **kwargs
in their signature.
AliasIngredient
Bases: Ingredient
This ingredient performs no other function than to act as a stand-in for complex chainings of other ingredients. This allows us (or our lms) to write less verbose BlendSQL queries, while maximizing the information we embed.
The run()
function should return a tuple containing both the query text that should get subbed in,
and any ingredient classes which are dependencies for executing the aliased query.
Examples:
from textwrap import dedent
from typing import Tuple, Collection
from blendsql.ingredients import AliasIngredient, LLMQA
class FetchDefinition(AliasIngredient):
def run(self, term: str, *args, **kwargs) -> Tuple[str, Collection[Ingredient]]:
new_query = dedent(
f"""
{{{{
LLMQA(
"What does {term} mean?"
)
}}}}
""")
ingredient_dependencies = {LLMQA}
return (new_query, ingredient_dependencies)
# Now, we can use the ingredient like below
blendsql_query = """
SELECT {{FetchDefinition('delve')}} AS "Definition"
"""
Source code in blendsql/ingredients/ingredient.py
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 |
|
QAIngredient
Bases: Ingredient
Given a table subset in the form of a pd.DataFrame 'context', returns a scalar or array of scalars (in the form of a tuple).
Useful for end-to-end question answering tasks.
Examples:
import pandas as pd
import guidance
from blendsql.models import Model, LocalModel, RemoteModel
from blendsql.ingredients import QAIngredient
from blendsql._program import Program
class SummaryProgram(Program):
"""Program to call Model and return summary of the passed table.
"""
def __call__(self, model: Model, serialized_db: str):
prompt = f"Summarize the table. {serialized_db}"
if isinstance(model, LocalModel):
# Below we follow the guidance pattern for unconstrained text generation
# https://github.com/guidance-ai/guidance
response = (model.model_obj + guidance.gen(max_tokens=20, name="response"))._variables["response"]
else:
response = model.generate(
messages_list=[[{"role": "user", "content": prompt}]],
max_tokens=20
)[0]
# Finally, return (response, prompt) tuple
# Returning the prompt here allows the underlying BlendSQL classes to track token usage
return (response, prompt)
class TableSummary(QAIngredient):
def run(self, model: Model, context: pd.DataFrame, **kwargs) -> str:
result = model.predict(program=SummaryProgram, serialized_db=context.to_string())
return f"'{result}'"
if __name__ == "__main__":
from blendsql import blend
from blendsql.db import SQLite
from blendsql.utils import fetch_from_hub
from blendsql.models import LiteLLM
blendsql = """
SELECT {{
TableSummary(
context=(SELECT * FROM transactions LIMIT 10)
)
}} AS "Summary"
"""
smoothie = blend(
query=blendsql,
default_model=LiteLLM("openai/gpt-4o-mini"),
db=SQLite(fetch_from_hub("single_table.db")),
ingredients={TableSummary}
)
# Now, we can get results
print(smoothie.df)
# 'The table summarizes a series of cash flow transactions made through Zelle'
# ...and token usage
print(smoothie.meta.prompt_tokens)
print(smoothie.meta.completion_tokens)
Source code in blendsql/ingredients/ingredient.py
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 |
|
MapIngredient
Bases: Ingredient
For a given table/column pair, maps an external function to each of the given values, creating a new column.
Examples:
from typing import List
from blendsql.ingredients import MapIngredient
import requests
class GetQRCode(MapIngredient):
"""Calls API to generate QR code for a given URL.
Saves bytes to file in qr_codes/ and returns list of paths.
https://goqr.me/api/doc/create-qr-code/"""
def run(self, values: List[str], **kwargs) -> List[str]:
imgs_as_bytes = []
for value in values:
qr_code_bytes = requests.get(
"https://api.qrserver.com/v1/create-qr-code/?data=https://{}/&size=100x100".format(value)
).content
imgs_as_bytes.append(qr_code_bytes)
return imgs_as_bytes
if __name__ == "__main__":
from blendsql import BlendSQL
from blendsql.db import SQLite
from blendsql.utils import fetch_from_hub
bsql = BlendSQL(fetch_from_hub('urls.db'), ingredients={GetQRCode})
smoothie = bsql.execute("SELECT genre, url, {{GetQRCode('QR Code as Bytes:', 'w::url')}} FROM w WHERE genre = 'social'")
smoothie.df
# | genre | url | QR Code as Bytes: |
# |--------|---------------|-----------------------|
# | social | facebook.com | b'...' |
Source code in blendsql/ingredients/ingredient.py
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 |
|
JoinIngredient
Bases: Ingredient
Executes an INNER JOIN
using dict mapping.
'Join on color of food'
Examples:
from blendsql.ingredients import JoinIngredient
class do_join(JoinIngredient):
"""A very silly, overcomplicated way to do a traditional SQL join.
But useful for testing.
"""
def run(self, left_values: List[str], right_values: List[str], **kwargs) -> dict:
return {left_value: left_value for left_value in left_values}
blendsql_query = """
SELECT Account, Quantity FROM returns
JOIN {{
do_join(
left_on='account_history::Symbol',
right_on='returns::Symbol'
)
}}
"""
Source code in blendsql/ingredients/ingredient.py
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 |
|