Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.elkar.co/llms.txt

Use this file to discover all available pages before exploring further.

To simplify task management, Elkar provides a TaskModifier class with five core methods. These methods handle interactions with the store and queue, allowing you to focus on task logic directly.
  1. Get Task
Retrieves a task, either from the store or via the method. 
await task_modifier.get_task(
	from_store=False # Set to True to fetch from the store 
)
  1. Get Task Send Params
Fetches the parameters needed to send a task. 
await task_modifier.get_task_send_params()
  1. Status Update
Describes the state of the task and the agent’s progress. Messages in the status are appended to the task’s history. 
await task_modifier.set_status(
    TaskStatus(
        state=TaskState.COMPLETED,
        message=Message(parts=[TextPart(text="I've finished the task!")])
    )
)
  1. Artifact Update
Artifacts represent the result of the task. Indices are used to identify artifacts within a task. Updates append to existing artifacts if the index matches and the chunk is not the last one. 
await task_modifier.upsert_artifact(
    Artifact(parts=[TextPart(text="I've finished the task!")], index=0)
)
  1. Append Messages to History
Stores relevant information, such as thoughts or past communications, related to the task. 
await task_modifier.add_messages_to_history(
    [Message(parts=[TextPart(text="I'm working on the task...")])]
)