xintongsong commented on code in PR #236:
URL: https://github.com/apache/flink-agents/pull/236#discussion_r2390495116
##########
docs/content/docs/development/react_agent.md:
##########
@@ -24,12 +24,92 @@ under the License.
## Overview
-{{< hint warning >}}
-**TODO**: What is ReAct agent. When to use it.
-{{< /hint >}}
+ReAct Agent is a general paradigm that combines reasoning and action
capabilities to solve complex tasks. Leveraging this paradigm, the user only
needs to specify the goal with prompt and provide available tools, and the LLM
will decide how to achieve the goal and take actions autonomously
## ReAct Agent Example
-{{< hint warning >}}
-**TODO**: Add the quickstart example code here. And briefly explain the code
component by component. Link to the detailed documentation for each component,
such as ChatModel, Prompt, Tool, etc.
-{{< /hint >}}
+```python
+review_analysis_react_agent = ReActAgent(
+ chat_model=chat_model_descriptor,
+ prompt=my_prompt,
+ output_schema=MyBaseModelDataType,
+)
+```
+## Initialize Arguments
+### Chat Model
+User should specify the chat model used in the ReAct Agent.
+
+We use `ResourceDescriptor` to describe the chat model, includes chat model
type and chat model arguments. See [Chat Model]({{< ref
"docs/development/chat_with_llm#chatmodel" >}}) for more details.
+```python
+chat_model = ResourceDescriptor(
Review Comment:
```suggestion
chat_model_descriptor = ResourceDescriptor(
```
##########
docs/content/docs/development/react_agent.md:
##########
@@ -24,12 +24,92 @@ under the License.
## Overview
-{{< hint warning >}}
-**TODO**: What is ReAct agent. When to use it.
-{{< /hint >}}
+ReAct Agent is a general paradigm that combines reasoning and action
capabilities to solve complex tasks. Leveraging this paradigm, the user only
needs to specify the goal with prompt and provide available tools, and the LLM
will decide how to achieve the goal and take actions autonomously
## ReAct Agent Example
-{{< hint warning >}}
-**TODO**: Add the quickstart example code here. And briefly explain the code
component by component. Link to the detailed documentation for each component,
such as ChatModel, Prompt, Tool, etc.
-{{< /hint >}}
+```python
+review_analysis_react_agent = ReActAgent(
+ chat_model=chat_model_descriptor,
+ prompt=my_prompt,
+ output_schema=MyBaseModelDataType,
Review Comment:
```suggestion
output_schema=MyBaseModelDataType, # or output_schema=my_row_type_info
```
##########
docs/content/docs/development/react_agent.md:
##########
@@ -24,12 +24,92 @@ under the License.
## Overview
-{{< hint warning >}}
-**TODO**: What is ReAct agent. When to use it.
-{{< /hint >}}
+ReAct Agent is a general paradigm that combines reasoning and action
capabilities to solve complex tasks. Leveraging this paradigm, the user only
needs to specify the goal with prompt and provide available tools, and the LLM
will decide how to achieve the goal and take actions autonomously
## ReAct Agent Example
-{{< hint warning >}}
-**TODO**: Add the quickstart example code here. And briefly explain the code
component by component. Link to the detailed documentation for each component,
such as ChatModel, Prompt, Tool, etc.
-{{< /hint >}}
+```python
+review_analysis_react_agent = ReActAgent(
Review Comment:
It's still called `review_analysis_react_agent`
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
