[Docs][flyteagent] Added description of exception deletion cases. (#6039

) * [Fix] Add logger for compiler and marshal while comparing union (#6034) * feat: fix Union type with dataclass ambiguous error Signed-off-by: mao3267 <[email protected]> * fix: direct json comparison for superset Signed-off-by: mao3267 <[email protected]> * fix: go.mod missing entry for error Signed-off-by: mao3267 <[email protected]> * fix: update go module and sum Signed-off-by: mao3267 <[email protected]> * refactor: gci format Signed-off-by: mao3267 <[email protected]> * test: add dataset casting tests for same (one/two levels) and superset (one level) dataclass Signed-off-by: mao3267 <[email protected]> * fix: support Pydantic BaseModel comparison Signed-off-by: mao3267 <[email protected]> * fix: handle nested pydantic basemodel Signed-off-by: mao3267 <[email protected]> * Reviews from Eduardo Signed-off-by: Future-Outlier <[email protected]> * fix: support strict subset match Signed-off-by: mao3267 <[email protected]> * test: update strict subset match test Signed-off-by: mao3267 <[email protected]> * fix: missing go mod entry Signed-off-by: mao3267 <[email protected]> * fix: missing go mod entry Signed-off-by: mao3267 <[email protected]> * fix: go mod entry Signed-off-by: mao3267 <[email protected]> * make go-tidy Signed-off-by: Future-Outlier <[email protected]> * comments Signed-off-by: Future-Outlier <[email protected]> * fix: strict subset match with draft 2020-12 mashumaro Signed-off-by: mao3267 <[email protected]> * refactor: make go-tidy Signed-off-by: mao3267 <[email protected]> * fix: support strict subset match with ambiguity Signed-off-by: mao3267 <[email protected]> * fix: change test name and fix err Signed-off-by: mao3267 <[email protected]> * Add comments Signed-off-by: Future-Outlier <[email protected]> * nit Signed-off-by: Future-Outlier <[email protected]> * add flytectl go-tidy in makefile Signed-off-by: Future-Outlier <[email protected]> * nit Signed-off-by: Future-Outlier <[email protected]> * fix: add comment for error checking Signed-off-by: mao3267 <[email protected]> * test: basemodel castable test, two level dataclass and ParentToChild failure Signed-off-by: mao3267 <[email protected]> * fix: add logger for jsonschema compiler Signed-off-by: mao3267 <[email protected]> * fix: add logger for marshal and compiler Signed-off-by: mao3267 <[email protected]> * better error msg format Signed-off-by: Future-Outlier <[email protected]> --------- Signed-off-by: mao3267 <[email protected]> Signed-off-by: Future-Outlier <[email protected]> Co-authored-by: Future-Outlier <[email protected]> Signed-off-by: SZL741023 <[email protected]> * [Docs] Add Async agent create job process and exception delete cas. Signed-off-by: SZL741023 <[email protected]> * update Signed-off-by: Future-Outlier <[email protected]> * grammar update Signed-off-by: Future-Outlier <[email protected]> --------- Signed-off-by: mao3267 <[email protected]> Signed-off-by: Future-Outlier <[email protected]> Signed-off-by: SZL741023 <[email protected]> Co-authored-by: Vincent Chen <[email protected]> Co-authored-by: Future-Outlier <[email protected]>
flyteorg · Nov 28, 2024 · b2759fc · b2759fc
1 parent 1dcc8bf
commit b2759fc
Showing 1 changed file with 41 additions and 28 deletions.
diff --git a/docs/user_guide/flyte_agents/developing_agents.md b/docs/user_guide/flyte_agents/developing_agents.md
@@ -7,6 +7,7 @@ jupytext:
 ---
 
 (developing_agents)=
+
 # Developing agents
 
 The Flyte agent framework enables rapid agent development, since agents are decoupled from the core FlytePropeller engine. Rather than building a complete gRPC service from scratch, you can implement an agent as a Python class, easing development. Agents can be tested independently and deployed privately, making maintenance easier and giving you more flexibility and control over development.
@@ -20,8 +21,9 @@ We strongly encourage you to contribute your agent to the Flyte community. To do
 ```
 
 There are two types of agents: **async** and **sync**.
-* **Async agents** enable long-running jobs that execute on an external platform over time. They communicate with external services that have asynchronous APIs that support `create`, `get`, and `delete` operations. The vast majority of agents are async agents.
-* **Sync agents** enable request/response services that return immediate outputs (e.g. calling an internal API to fetch data or communicating with the OpenAI API).
+
+- **Async agents** enable long-running jobs that execute on an external platform over time. They communicate with external services that have asynchronous APIs that support `create`, `get`, and `delete` operations. The vast majority of agents are async agents.
+- **Sync agents** enable request/response services that return immediate outputs (e.g. calling an internal API to fetch data or communicating with the OpenAI API).
 
 ```{note}
 
@@ -41,6 +43,17 @@ To create a new async agent, extend the [`AsyncAgentBase`](https://github.com/fl
 - `get`: This method retrieves the job resource (jobID or output literal) associated with the task, such as a BigQuery job ID or Databricks task ID.
 - `delete`: Invoking this method will send a request to delete the corresponding job.
 
+```{note}
+
+When users use the `create` method to create a new job, with its job ID, they can use the `get` method with job ID to 
+check the execution state is succeeded or not.
+
+Exceptional `delete` case:
+If users interrupt a task while it is running, FlytePropeller will invoke the `delete` method to the corresponding 
+job.
+
+```
+
 ```python
 from typing import Optional
 from dataclasses import dataclass
@@ -113,6 +126,7 @@ AgentRegistry.register(OpenAIAgent())
 ```
 
 #### Sensor interface specification
+
 With the agent framework, you can easily build a custom sensor in Flyte to watch certain events or monitor the bucket in your workflow.
 
 To create a new sensor, extend the `[BaseSensor](https://github.com/flyteorg/flytekit/blob/master/flytekit/sensor/base_sensor.py#L43)` class and implement the `poke` method, which checks whether a specific condition is met.
@@ -130,7 +144,6 @@ class FileSensor(BaseSensor):
         return fs.exists(path)
 ```
 
-
 ### 2. Test the agent
 
 You can test your agent in a {ref}`local Python environment <testing_agents_locally>` or in a {ref}`local development cluster <testing_agents_in_a_local_development_cluster>`.
@@ -181,29 +194,29 @@ By default, all agent requests will be sent to the default agent service. Howeve
 you can route particular task requests to designated agent services by adjusting the FlytePropeller configuration.
 
 ```yaml
- plugins:
-   agent-service:
-     # By default, all requests will be sent to the default agent.
-     defaultAgent:
-       endpoint: "dns:///flyteagent.flyte.svc.cluster.local:8000"
-       insecure: true
-       timeouts:
-         # CreateTask, GetTask and DeleteTask are for async agents.
-         # ExecuteTaskSync is for sync agents.
-         CreateTask: 5s
-         GetTask: 5s
-         DeleteTask: 5s
-         ExecuteTaskSync: 10s
-       defaultTimeout: 10s
-     agents:
-       custom_agent:
-         endpoint: "dns:///custom-flyteagent.flyte.svc.cluster.local:8000"
-         insecure: false
-         defaultServiceConfig: '{"loadBalancingConfig": [{"round_robin":{}}]}'
-         timeouts:
-           GetTask: 5s
-         defaultTimeout: 10s
-     agentForTaskTypes:
-       # It will override the default agent for custom_task, which means propeller will send the request to this agent.
-       - custom_task: custom_agent
+plugins:
+  agent-service:
+    # By default, all requests will be sent to the default agent.
+    defaultAgent:
+      endpoint: "dns:///flyteagent.flyte.svc.cluster.local:8000"
+      insecure: true
+      timeouts:
+        # CreateTask, GetTask and DeleteTask are for async agents.
+        # ExecuteTaskSync is for sync agents.
+        CreateTask: 5s
+        GetTask: 5s
+        DeleteTask: 5s
+        ExecuteTaskSync: 10s
+      defaultTimeout: 10s
+    agents:
+      custom_agent:
+        endpoint: "dns:///custom-flyteagent.flyte.svc.cluster.local:8000"
+        insecure: false
+        defaultServiceConfig: '{"loadBalancingConfig": [{"round_robin":{}}]}'
+        timeouts:
+          GetTask: 5s
+        defaultTimeout: 10s
+    agentForTaskTypes:
+      # It will override the default agent for custom_task, which means propeller will send the request to this agent.
+      - custom_task: custom_agent
 ```