Reference
Class Task¶
Variables¶
Variable |
Data Type | Default | Description |
|---|---|---|---|
id |
UUID | uuid.uuid4() | Stores task id as an identifier. |
name |
Optional[str] | None | Stores a task name (Inherited as node identifier if the task is dependent) |
description |
str | None | Required field to store a concise task description |
response_schema |
Optional[Type[BaseModel] | List[ResponseField]] | None | Response schema for structured output. |
tools |
Optional[List[Any]] | None | Tools, tool sets, or RAG tools |
can_use_agent_tools |
bool | True | Whether to use the agent tools |
tool_res_as_final |
bool | False | Whether to make a tool output as a final response from the agent |
is_multimodal |
bool | False | Whether to handle multimodals as main task - audio/image/video |
image |
Optional[str] | None | Absolute file path or URL to the image file (either for prompt context or main task) |
file |
Optional[str] | None | Absolute file path or URL to the file |
audio |
Optional[str] | None | Absolute file path or URL to the audio file |
should_test_run |
bool | False | Whether to turn on auto-feedback learning |
human |
bool | False | Whether to ask human input during the task execution |
execution_type |
TaskExecutionType | TaskExecutionType.SYNC | Sync or async execution |
allow_delegation |
bool | False | Whether to allow the agent to delegate the task to another agent |
callback |
Optional[Callable] | None | Callback function to be executed after LLM calling |
callback_kwargs |
Optional[Dict[str, Any]] | dict() | Args for the callback function (if any) |
should_evaluate |
bool | False | Whether to evaluate the task output using eval criteria |
eval_criteria |
Optional[List[str]] | list() | Evaluation criteria given by the human client |
fsls |
Optional[List[str]] | None | Examples of competitive and/or weak responses |
processed_agents |
Set[str] | set() | Stores keys of agents that executed the task |
output |
Optional[TaskOutput] | None | Stores TaskOutput object after the execution |
Class Methods¶
Method |
Params |
Returns | Description |
|---|---|---|---|
execute |
type: TaskExecutionType = None |
InstanceOf[TaskOutput] or None (error) |
A main method to handle task execution. Auto-build an agent when the agent is not given. |
Properties¶
Property |
Data_Type | Description |
|---|---|---|
key |
str | Returns task key based on its description and output format. |
summary |
str | Returns a summary of the task based on its id, description and tools. |
Class ResponseField¶
Variables¶
Variable |
Data Type | Default | Description |
|---|---|---|---|
title |
str | None | Stores a field title. |
data_type |
Type | None | Stores data type of the response. |
items |
Type | None | Stores data type of items in the list. None when data_type is not list. |
properties |
List[ResponseField] |
None | Stores properties in a list of ResponseFormat objects when the data_type is dict. |
nullable |
bool | False | If the field is nullable. |
config |
Dict[str, Any] | None | Stores other configs passed to response schema. |
Class TaskOutput¶
Variables¶
Variable |
Data Type | Default | Description |
|---|---|---|---|
task_id |
UUID | uuid.uuid4() | Stores task id as an identifier. |
raw |
str | None | Stores response in plane text format. None or "" when the model returned errors. |
json_dict |
Dict[str, Any] | None | Stores response in JSON serializable dictionary. |
pydantic |
Type[BaseModel] |
None | Populates the given response schema in pydantic class |
tool_output |
Optional[Any] | None | Stores results from the tools of the task or agents when tool_res_as_final == True |
callback_output |
Optional[Any] | None | Stores results from callback functions if any. |
annotations |
Optional[Dict[str, Any]] | None | Stores annotations given by the model. |
evaluation |
Optional[InstanceOf[Evaluation]] |
None | Stores overall evaluations and usage of the task output. |
usage |
Optional[InstanceOf[UsageMetrics]] |
None | Usage related values. |
Class Methods¶
Method |
Params | Returns | Description |
|---|---|---|---|
evaluate |
task: InstanceOf[Task] |
InstanceOf[Evaluation] |
Evaluates task output based on the criteria |
Properties¶
Property |
Data_Type | Description |
|---|---|---|
final |
Any | Returns the final output of the task |
aggregate_score |
float | Calucurates weighted average eval scores of the task output. |
json_string |
str | Returns json_dict in string format. |
Class Evaluation¶
Variables¶
Variable |
Data Type | Default | Description |
|---|---|---|---|
items |
List[InstanceOf[EvaluationItem]] | list() | Stores evaluation items. |
eval_by |
Optional[InstanceOf[Agent]] | None | Stores an agent assigned to evaluate the output. |
Properties¶
Property |
Data_Type | Description |
|---|---|---|
aggregate_score |
float | Calucurates weighted average eval scores of the task output. |
suggestion_summary |
str | Returns summary of the suggestions. |
Sub-class EvaluationItem¶
Variables¶
Variable |
Data Type | Default | Description |
|---|---|---|---|
criteria |
str | None | Stores evaluation criteria given by the client. |
suggestion |
str | None | Stores suggestion on improvement from the evaluator agent. |
score |
float | None | Stores the score on a 0 to 1 scale. |
weight |
int | None | Stores the weight (importance of the criteria) at any scale. |