Class swarmauri_standard.tools.GunningFogTool.GunningFogTool
swarmauri_standard.tools.GunningFogTool.GunningFogTool
Bases: ToolBase
A tool for calculating the Gunning-Fog readability score.
ATTRIBUTE | DESCRIPTION |
---|---|
version |
The version of the tool.
TYPE:
|
name |
The name of the tool.
TYPE:
|
type |
The type of the tool.
TYPE:
|
description |
A brief description of what the tool does.
TYPE:
|
parameters |
The parameters for configuring the tool.
TYPE:
|
version
class-attribute
instance-attribute
version = '0.1.dev1'
name
class-attribute
instance-attribute
name = 'GunningFogTool'
type
class-attribute
instance-attribute
type = 'GunningFogTool'
description
class-attribute
instance-attribute
description = (
"Calculates the Gunning-Fog score for a given text."
)
parameters
class-attribute
instance-attribute
parameters = [
Parameter(
name="input_text",
input_type="string",
description="The input text for which to calculate the Gunning-Fog score.",
required=True,
)
]
model_config
class-attribute
instance-attribute
model_config = ConfigDict(
extra="allow", arbitrary_types_allowed=True
)
id
class-attribute
instance-attribute
id = Field(default_factory=generate_id)
members
class-attribute
instance-attribute
members = None
owners
class-attribute
instance-attribute
owners = None
host
class-attribute
instance-attribute
host = None
default_logger
class-attribute
default_logger = None
logger
class-attribute
instance-attribute
logger = None
count_sentences
count_sentences(text)
Counts the number of sentences in the text.
PARAMETER | DESCRIPTION |
---|---|
text
|
The input text.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
int
|
The number of sentences in the text.
TYPE:
|
Source code in swarmauri_standard/tools/GunningFogTool.py
66 67 68 69 70 71 72 73 74 75 76 77 |
|
count_words
count_words(text)
Counts the number of words in the text.
PARAMETER | DESCRIPTION |
---|---|
text
|
The input text.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
int
|
The number of words in the text.
TYPE:
|
Source code in swarmauri_standard/tools/GunningFogTool.py
79 80 81 82 83 84 85 86 87 88 89 90 |
|
count_complex_words
count_complex_words(text)
Counts the number of complex words (3 or more syllables) in the text.
PARAMETER | DESCRIPTION |
---|---|
text
|
The input text.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
int
|
The number of complex words in the text.
TYPE:
|
Source code in swarmauri_standard/tools/GunningFogTool.py
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 |
|
is_complex_word
is_complex_word(word)
Determines if a word is complex (3 or more syllables).
PARAMETER | DESCRIPTION |
---|---|
word
|
The input word.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
bool
|
True if the word is complex, False otherwise.
TYPE:
|
Source code in swarmauri_standard/tools/GunningFogTool.py
109 110 111 112 113 114 115 116 117 118 119 120 |
|
count_syllables_in_word
count_syllables_in_word(word)
Counts the number of syllables in a word.
PARAMETER | DESCRIPTION |
---|---|
word
|
The word to count syllables in.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
int
|
The number of syllables in the word.
TYPE:
|
Source code in swarmauri_standard/tools/GunningFogTool.py
122 123 124 125 126 127 128 129 130 131 132 133 134 |
|
validate_input
validate_input(data)
Validates the input data to ensure it contains the required 'input_text' key.
PARAMETER | DESCRIPTION |
---|---|
data
|
The input data to validate.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
bool
|
True if the input is valid, False otherwise.
TYPE:
|
Source code in swarmauri_standard/tools/GunningFogTool.py
136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 |
|
register_model
classmethod
register_model()
Decorator to register a base model in the unified registry.
RETURNS | DESCRIPTION |
---|---|
Callable
|
A decorator function that registers the model class.
TYPE:
|
Source code in swarmauri_base/DynamicBase.py
562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 |
|
register_type
classmethod
register_type(resource_type=None, type_name=None)
Decorator to register a subtype under one or more base models in the unified registry.
PARAMETER | DESCRIPTION |
---|---|
resource_type
|
The base model(s) under which to register the subtype. If None, all direct base classes (except DynamicBase) are used.
TYPE:
|
type_name
|
An optional custom type name for the subtype.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
Callable
|
A decorator function that registers the subtype.
TYPE:
|
Source code in swarmauri_base/DynamicBase.py
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 |
|
model_validate_toml
classmethod
model_validate_toml(toml_data)
Validate a model from a TOML string.
Source code in swarmauri_base/TomlMixin.py
12 13 14 15 16 17 18 19 20 21 22 23 24 |
|
model_dump_toml
model_dump_toml(
fields_to_exclude=None, api_key_placeholder=None
)
Return a TOML representation of the model.
Source code in swarmauri_base/TomlMixin.py
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 |
|
model_validate_yaml
classmethod
model_validate_yaml(yaml_data)
Validate a model from a YAML string.
Source code in swarmauri_base/YamlMixin.py
11 12 13 14 15 16 17 18 19 20 21 22 23 |
|
model_dump_yaml
model_dump_yaml(
fields_to_exclude=None, api_key_placeholder=None
)
Return a YAML representation of the model.
Source code in swarmauri_base/YamlMixin.py
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 |
|
model_post_init
model_post_init(logger=None)
Assign a logger instance after model initialization.
Source code in swarmauri_base/LoggerMixin.py
23 24 25 26 27 28 |
|
call
call(*args, **kwargs)
File: ToolBase.py Class: ToolBase Method: call
Alias for call to conform to ITool interface.
Source code in swarmauri_base/tools/ToolBase.py
28 29 30 31 32 33 34 35 36 |
|
batch
batch(inputs, *args, **kwargs)
File: ToolBase.py Class: ToolBase Method: batch
Default batch implementation: calls call on each item in inputs
.
Subclasses can override for optimized bulk behavior.
Source code in swarmauri_base/tools/ToolBase.py
49 50 51 52 53 54 55 56 57 58 59 60 61 |
|