Skip to content

Commit 543a44e

Browse files
author
nikki everett
committed
stub out async vs sync agents content
Signed-off-by: nikki everett <[email protected]>
1 parent f2de03e commit 543a44e

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

docs/flyte_agents/creating_an_agent.md

+9-1
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ jupytext:
1111

1212
The Flyte agent framework enables rapid agent development, since agents are decoupled from the core FlytePropeller engine. Agents can be written in Python, easing development for data scientists. Agents can be tested independently and deployed privately, making maintenance easier and giving you more flexibility and control over development.
1313

14+
TK - may need to add content about async vs sync agents here (and possibly in index.md)
15+
1416
If you need to create a new type of task, we recommend creating a new agent to run it rather than running the task in a pod. After testing the new agent, you can update your FlytePropeller configMap to specify the type of task that the agent should run.
1517

1618
:::{note}
@@ -21,7 +23,9 @@ While agents can be written in any programming language, we currently only suppo
2123

2224
## Flytekit interface specification
2325

24-
To create a new agent, extend the `AgentBase` class in the `flytekit.backend` module and implement `create`, `get`, and `delete` methods. All calls must be idempotent.
26+
### Async agent interface
27+
28+
To create a new async agent, extend the `AgentBase` class in the `flytekit.backend` module and implement `create`, `get`, and `delete` methods. All calls must be idempotent.
2529

2630
- `create`: This method is used to initiate a new task. Users have the flexibility to use gRPC, REST, or an SDK to create a task.
2731
- `get`: This method allows retrieving the job Resource (jobID or output literal) associated with the task, such as a BigQuery Job ID or Databricks task ID.
@@ -87,3 +91,7 @@ AgentRegistry.register(CustomAgent())
8791
```
8892

8993
For an example implementation, see the [BigQuery Agent](https://github.com/flyteorg/flytekit/blob/9977aac26242ebbede8e00d476c2fbc59ac5487a/plugins/flytekit-bigquery/flytekitplugins/bigquery/agent.py#L35).
94+
95+
### Sync agent interface
96+
97+
TK - just need to implement `execute()` method

0 commit comments

Comments
 (0)