You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: docs/flyte_agents/creating_an_agent.md
+9-1
Original file line number
Diff line number
Diff line change
@@ -11,6 +11,8 @@ jupytext:
11
11
12
12
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.
13
13
14
+
TK - may need to add content about async vs sync agents here (and possibly in index.md)
15
+
14
16
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.
15
17
16
18
:::{note}
@@ -21,7 +23,9 @@ While agents can be written in any programming language, we currently only suppo
21
23
22
24
## Flytekit interface specification
23
25
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.
25
29
26
30
-`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.
27
31
-`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.
For an example implementation, see the [BigQuery Agent](https://github.com/flyteorg/flytekit/blob/9977aac26242ebbede8e00d476c2fbc59ac5487a/plugins/flytekit-bigquery/flytekitplugins/bigquery/agent.py#L35).
0 commit comments