LLM Caller
lean_automator.llm.caller
¶
Provides a client for interacting with Google's Gemini API.
This module defines classes and functions to facilitate communication with Google's Gemini large language models (LLMs) for both text generation and embedding creation. It includes features like asynchronous API calls, automatic retries with exponential backoff for transient errors, and integrated cost tracking based on model usage (tokens/units).
Classes¶
ModelUsageStats
dataclass
¶
Stores usage statistics for a specific model.
Attributes:
Name | Type | Description |
---|---|---|
calls |
int
|
Number of successful API calls made for the model. |
prompt_tokens |
int
|
Total number of input tokens/units processed by the model. |
completion_tokens |
int
|
Total number of output tokens/units generated by the model (often 0 for embeddings). |
Source code in lean_automator/llm/caller.py
ModelCostInfo
dataclass
¶
Stores cost per MILLION units (tokens/chars) for a specific model.
Attributes:
Name | Type | Description |
---|---|---|
input_cost_per_million_units |
float
|
The cost for processing one million input units (e.g., tokens). |
output_cost_per_million_units |
float
|
The cost for generating one million output units (e.g., tokens). |
Source code in lean_automator/llm/caller.py
GeminiCostTracker
¶
Tracks API usage and estimates costs for Google Gemini models.
This class maintains counts of API calls, input/output units (tokens), and calculates estimated costs based on predefined rates per million units. It handles both generative and embedding models, sourcing cost data from a JSON configuration.
Attributes:
Name | Type | Description |
---|---|---|
_usage_stats |
Dict[str, ModelUsageStats]
|
A dictionary mapping model names to their accumulated usage statistics. |
_model_costs |
Dict[str, ModelCostInfo]
|
A dictionary mapping model names to their cost information (per million units). |
Source code in lean_automator/llm/caller.py
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 |
|
Functions¶
__init__(model_costs_override: Optional[Dict[str, Any]] = None)
¶
Initializes the GeminiCostTracker.
Loads model cost information primarily from APP_CONFIG['costs']. An optional override dictionary can be provided. Initializes internal dictionaries to store usage and cost data.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
model_costs_override
|
Optional[Dict[str, Any]]
|
A dictionary
mapping model names (e.g., "gemini-1.5-flash-latest") to
their costs per million units, in the format
|
None
|
Source code in lean_automator/llm/caller.py
record_usage(model: str, input_units: int, output_units: int)
¶
Records usage statistics for a specific model after a successful API call.
Increments the call count and adds the input and output units (tokens) to the totals for the given model name.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
model
|
str
|
The name of the model used in the API call. |
required |
input_units
|
int
|
The number of input units (e.g., tokens) consumed. |
required |
output_units
|
int
|
The number of output units (e.g., tokens) generated. |
required |
Source code in lean_automator/llm/caller.py
get_total_cost() -> float
¶
Calculates the estimated total cost across all tracked models.
Sums the costs for each model based on its recorded usage (input/output units) and the cost information loaded during initialization (cost per million units). Issues warnings for models with recorded usage but missing cost data.
Returns:
Name | Type | Description |
---|---|---|
float |
float
|
The total estimated cost in the currency defined by the |
float
|
cost data (e.g., USD). |
Source code in lean_automator/llm/caller.py
get_summary() -> Dict[str, Any]
¶
Generates a summary report of API usage and estimated costs.
Provides a dictionary containing the overall estimated cost and a breakdown of usage (calls, input/output units) and estimated cost per model.
Returns:
Type | Description |
---|---|
Dict[str, Any]
|
Dict[str, Any]: A dictionary summarizing usage and costs, e.g.: |
Dict[str, Any]
|
``` |
Dict[str, Any]
|
{ "total_estimated_cost": 1.23, "usage_by_model": { "gemini-1.5-flash-latest": { "calls": 10, "input_units": 50000, "output_units": 10000, "estimated_cost": 0.85 }, "models/text-embedding-004": { "calls": 5, "input_units": 200000, "output_units": 0, "estimated_cost": 0.38 } } |
Dict[str, Any]
|
} |
Dict[str, Any]
|
``` |
Dict[str, Any]
|
If cost data is missing for a model, its "estimated_cost" will |
Dict[str, Any]
|
be "Unknown (cost data missing)". |
Source code in lean_automator/llm/caller.py
GeminiClient
¶
Client for Google Gemini API with retries and cost tracking.
Provides asynchronous methods (generate
, embed_content
) to interact
with Google's generative and embedding models. Includes automatic retries
on transient errors (like rate limits or server issues) with exponential
backoff. Integrates with GeminiCostTracker
to monitor API usage and
estimate costs. Configuration is loaded from environment variables or
passed arguments.
Attributes:
Name | Type | Description |
---|---|---|
api_key |
str
|
The Google AI API key being used. |
default_generation_model |
str
|
The default model used for |
default_embedding_model |
str
|
The default model used for |
max_retries |
int
|
The maximum number of retry attempts for failed API calls. |
backoff_factor |
float
|
The base factor for exponential backoff delays between retries. |
cost_tracker |
GeminiCostTracker
|
The instance used for tracking usage and costs. |
safety_settings |
Optional[list]
|
Default safety settings applied to
|
Source code in lean_automator/llm/caller.py
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 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 |
|
Functions¶
__init__(api_key: Optional[str] = None, default_generation_model: Optional[str] = None, default_embedding_model: Optional[str] = None, max_retries: Optional[int] = None, backoff_factor: Optional[float] = None, cost_tracker: Optional[GeminiCostTracker] = None, safety_settings: Optional[list] = DEFAULT_SAFETY_SETTINGS)
¶
Initializes the Gemini Client.
Configures the client using provided arguments or environment variables
as fallbacks. Sets up the API key, default models, retry parameters,
cost tracker, and safety settings. Configures the underlying
google.generativeai
library.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
api_key
|
Optional[str]
|
Google AI API key. If None, reads from
|
None
|
default_generation_model
|
Optional[str]
|
Default model name for
generation (e.g., "gemini-1.5-flash-latest"). If None, reads
from |
None
|
default_embedding_model
|
Optional[str]
|
Default model name for
embeddings (e.g., "models/text-embedding-004"). If None, reads
from |
None
|
max_retries
|
Optional[int]
|
Maximum retry attempts for API calls.
If None, reads from |
None
|
backoff_factor
|
Optional[float]
|
Base factor for exponential backoff
delay (seconds). If None, reads from |
None
|
cost_tracker
|
Optional[GeminiCostTracker]
|
An instance of
|
None
|
safety_settings
|
Optional[list]
|
Default safety settings for
generation, as a list of |
DEFAULT_SAFETY_SETTINGS
|
Raises:
Type | Description |
---|---|
RuntimeError
|
If the |
ValueError
|
If the API key or default generation model is missing (and not found in environment variables). |
Source code in lean_automator/llm/caller.py
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 |
|
generate(prompt: str, *, model: Optional[str] = None, system_prompt: Optional[str] = None, generation_config_override: Optional[Dict[str, Any]] = None, safety_settings_override: Optional[list] = None) -> str
async
¶
Generates content using a specified Gemini model with retry logic.
Constructs the request with the prompt and optional system instruction,
generation config, and safety settings. Uses the _execute_with_retry
helper to handle the API call to the generative model. Processes the
response to extract the text content and records usage statistics if a
cost tracker is configured and usage metadata is available.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
prompt
|
str
|
The main user prompt for content generation. |
required |
model
|
Optional[str]
|
The specific Gemini model name to use
(e.g., "gemini-1.5-flash-latest"). If None, uses the client's
|
None
|
system_prompt
|
Optional[str]
|
An optional system instruction to guide the model's behavior. Passed during model initialization. |
None
|
generation_config_override
|
Optional[Dict[str, Any]]
|
A dictionary
containing generation parameters (like temperature, top_p,
max_output_tokens) to override the model's defaults. See
|
None
|
safety_settings_override
|
Optional[list]
|
A list of safety setting
dictionaries to override the client's default safety settings
for this specific call. See
|
None
|
Returns:
Name | Type | Description |
---|---|---|
str |
str
|
The generated text content from the model. |
Raises:
Type | Description |
---|---|
ValueError
|
If the specified model name is invalid, if the API response indicates the content was blocked due to safety settings, or if the response structure is unexpected or lacks text content. |
Exception
|
If the API call fails after all retry attempts (reraised
from |
Source code in lean_automator/llm/caller.py
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 |
|
embed_content(contents: Union[str, List[str]], task_type: str, *, model: Optional[str] = None, title: Optional[str] = None, output_dimensionality: Optional[int] = None) -> List[List[float]]
async
¶
Generates embeddings for text content(s) using a Gemini model.
Handles both single string and batch (list of strings) embedding requests.
Uses the _execute_with_retry
helper for the API call. Processes the
response dictionary to extract the embedding vector(s). Attempts to
record usage statistics if a cost tracker is configured and usage
metadata is available in the response (though often absent for embeddings).
Parameters:
Name | Type | Description | Default |
---|---|---|---|
contents
|
Union[str, List[str]]
|
A single string or a list of strings to be embedded. |
required |
task_type
|
str
|
The intended task for the embedding, which influences its characteristics (e.g., "RETRIEVAL_DOCUMENT", "RETRIEVAL_QUERY", "SEMANTIC_SIMILARITY", "CLASSIFICATION"). Refer to Google AI documentation for valid task types. |
required |
model
|
Optional[str]
|
The specific Gemini embedding model name to use
(e.g., "models/text-embedding-004"). If None, uses the client's
|
None
|
title
|
Optional[str]
|
An optional title for the document, used only
when |
None
|
output_dimensionality
|
Optional[int]
|
An optional integer to specify the desired dimension to truncate the resulting embedding vector(s) to. If None, the model's default dimensionality is used. |
None
|
Returns:
Type | Description |
---|---|
List[List[float]]
|
List[List[float]]: A list containing the embedding vector(s). If a |
List[List[float]]
|
single string was provided as input, the outer list will contain |
List[List[float]]
|
a single vector (list of floats). If a list of strings was provided, |
List[List[float]]
|
the outer list will contain multiple vectors in the corresponding order. |
Raises:
Type | Description |
---|---|
TypeError
|
If |
ValueError
|
If the API response is missing the expected 'embedding' or 'embeddings' key, or if the embedding format is invalid. |
Exception
|
If the API call fails after all retry attempts (reraised
from |
Source code in lean_automator/llm/caller.py
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 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 |
|