Base
Agent
Bases: Node
Base class for an AI Agent that interacts with a Language Model and tools.
Source code in dynamiq/nodes/agents/base.py
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 |
|
file_description: str
property
Returns a description of the files available to the agent.
tool_by_names: dict[str, Node]
property
Returns a dictionary mapping tool names to their corresponding Node objects.
tool_description: str
property
Returns a description of the tools available to the agent.
tool_names: str
property
Returns a comma-separated list of tool names available to the agent.
execute(input_data, input_message=None, config=None, **kwargs)
Executes the agent with the given input data.
Source code in dynamiq/nodes/agents/base.py
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 |
|
generate_prompt(block_names=None, **kwargs)
Generates the prompt using specified blocks and variables.
Source code in dynamiq/nodes/agents/base.py
899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 |
|
get_context_for_input_schema()
Provides context for input schema that is required for proper validation.
Source code in dynamiq/nodes/agents/base.py
390 391 392 |
|
init_components(connection_manager=None)
Initialize components for the manager and agents.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
connection_manager |
ConnectionManager
|
The connection manager. Defaults to ConnectionManager. |
None
|
Source code in dynamiq/nodes/agents/base.py
419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 |
|
reset_run_state()
Resets the agent's run state.
Source code in dynamiq/nodes/agents/base.py
894 895 896 897 |
|
retrieve_conversation_history(user_query=None, user_id=None, session_id=None, limit=None, strategy=MemoryRetrievalStrategy.ALL)
Retrieves conversation history for the agent using the specified strategy.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
user_query |
str
|
Current user input to find relevant context (for RELEVANT/HYBRID strategies) |
None
|
user_id |
str
|
Optional user identifier |
None
|
session_id |
str
|
Optional session identifier |
None
|
limit |
int
|
Maximum number of messages to return (defaults to memory_limit) |
None
|
strategy |
MemoryRetrievalStrategy
|
Which retrieval strategy to use (ALL, RELEVANT, or HYBRID) |
ALL
|
Returns:
Type | Description |
---|---|
list[Message]
|
List of messages forming a valid conversation context |
Source code in dynamiq/nodes/agents/base.py
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 |
|
sanitize_tool_name(s)
Sanitize tool name to follow [^a-zA-Z0-9_-].
Source code in dynamiq/nodes/agents/base.py
436 437 438 439 440 |
|
set_block(block_name, content)
Adds or updates a prompt block.
Source code in dynamiq/nodes/agents/base.py
456 457 458 |
|
set_prompt_variable(variable_name, value)
Sets or updates a prompt variable.
Source code in dynamiq/nodes/agents/base.py
460 461 462 |
|
stream_by_tokens(content, source, step, config=None, **kwargs)
Streams the input content to the callbacks.
Source code in dynamiq/nodes/agents/base.py
701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 |
|
stream_content(content, source, step, config=None, by_tokens=None, **kwargs)
Streams data.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
content |
str | dict
|
Data that will be streamed. |
required |
source |
str
|
Source of the content. |
required |
step |
str
|
Description of the step. |
required |
by_tokens |
Optional[bool]
|
Determines whether to stream content by tokens or not. If None it is determined based on StreamingConfig. Defaults to None. |
None
|
config |
Optional[RunnableConfig]
|
Configuration for the runnable. |
None
|
**kwargs |
Additional keyword arguments. |
{}
|
Returns:
Type | Description |
---|---|
str | dict
|
str | dict: Streamed data. |
Source code in dynamiq/nodes/agents/base.py
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 |
|
to_dict(**kwargs)
Converts the instance to a dictionary.
Source code in dynamiq/nodes/agents/base.py
404 405 406 407 408 409 410 411 412 413 414 415 416 417 |
|
AgentManager
Bases: Agent
Manager class that extends the Agent class to include specific actions.
Source code in dynamiq/nodes/agents/base.py
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 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 |
|
add_action(name, action)
Adds a custom action to the manager.
Source code in dynamiq/nodes/agents/base.py
978 979 980 |
|
execute(input_data, config=None, **kwargs)
Executes the manager agent with the given input data and action.
Source code in dynamiq/nodes/agents/base.py
986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 |
|
get_context_for_input_schema()
Provides context for input schema that is required for proper validation.
Source code in dynamiq/nodes/agents/base.py
982 983 984 |
|
to_dict(**kwargs)
Converts the instance to a dictionary.
Source code in dynamiq/nodes/agents/base.py
960 961 962 963 964 965 966 967 |
|
AgentStatus
Bases: str
, Enum
Represents the status of an agent's execution.
Source code in dynamiq/nodes/agents/base.py
207 208 209 210 211 |
|
StreamChunk
Bases: BaseModel
Model for streaming chunks with choices containing delta updates.
Source code in dynamiq/nodes/agents/base.py
201 202 203 204 |
|
StreamChunkChoice
Bases: BaseModel
Stream chunk choice model.
Source code in dynamiq/nodes/agents/base.py
195 196 197 198 |
|
StreamChunkChoiceDelta
Bases: BaseModel
Delta model for content chunks.
Source code in dynamiq/nodes/agents/base.py
180 181 182 183 184 185 186 187 188 189 190 191 192 |
|
validate_source(v)
classmethod
Ensure source is always a string.
Source code in dynamiq/nodes/agents/base.py
186 187 188 189 190 191 192 |
|