docs: update documantation

bsorrentino · May 20, 2024 · e70f2cc · e70f2cc
1 parent bd61ecb
commit e70f2cc
Show file tree

Hide file tree

Showing 6 changed files with 48 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -101,7 +101,7 @@ var agentRunnable = Agent.builder()
                         .tools( toolSpecifications )
                         .build();
 
-var workflow = new GraphState<>(State::new);
+var workflow = new StateGraph<>(State::new);
 
 workflow.setEntryPoint("agent");
 
@@ -133,8 +133,8 @@ return  app.stream( inputs );
 ```
 ## Samples
 
-* [Agent Executor](agents-jdk8/src/main/java/dev/langchain4j/agentexecutor)
-* [Image To PlantUML Diagram](agents-jdk8/src/main/java/dev/langchain4j/image_to_diagram)
+* [Agent Executor](agents-jdk8/README.md)
+* [Image To PlantUML Diagram](agents-jdk8/README.md)
 
 # References
 

diff --git a/agents-jdk8/README.md b/agents-jdk8/README.md
@@ -0,0 +1,45 @@
+# Langgraph4j Samples
+
+
+## Agent Executor
+
+The "<u>Agent Executor</u>" flow involves a sequence of steps where the agent receives a query, decides on necessary actions, invokes tools, processes responses, iteratively performs tasks if needed, and finally returns a synthesized response to the user. 
+
+This flow ensures that the agent can handle complex tasks efficiently by leveraging the capabilities of various integrated tools and the decision-making power of the language model.
+
+
+![diagram][agentexecutor]
+
+> Go to [code](src/main/java/dev/langchain4j/agentexecutor)
+
+
+## Generate PlantUML diagram from Image
+
+The "<u>Generate PlantUML diagram from Image</u>" flow  involves a meticulously structured sequence of steps. Initially, an agent receives an image and is responsible for analyzing and describing its content. This description is then passed to a specialized agent equipped with the skills to translate the description into PlantUML code. To ensure precision in diagram generation, the type of diagram identified within the image dictates the selection of the appropriately skilled agent for the translation task. This ensures that each diagram type is handled by an agent with specific expertise relevant to that diagram. 
+
+![diagram][image_to_diagram]
+
+### Handle translation errors
+
+In the case that there are errors in result of PlantUML code we have established a supplementary flow that provided a correction process consisting of iteration between both verification and rewrite steps as shown below
+
+![diagram][correction_process]
+
+### Merge All
+
+Finally we can put all together having a complete flow that include also a refinement process over result.
+
+![diagram][image_to_diagram_correction]
+
+---- 
+> Go to [code](src/main/java/dev/langchain4j/image_to_diagram)
+
+
+
+[agentexecutor]: agentexecutor.puml.png
+[image_to_diagram]: image_to_diagram.puml.png
+[image_to_diagram_correction]: image_to_diagram_with_correction.puml.png
+[correction_process]: correction_process.puml.png
+
+
+
diff --git a/agents-jdk8/agentexecutor.puml.png b/agents-jdk8/agentexecutor.puml.png
diff --git a/agents-jdk8/correction_process.puml.png b/agents-jdk8/correction_process.puml.png
diff --git a/agents-jdk8/image_to_diagram.puml.png b/agents-jdk8/image_to_diagram.puml.png
diff --git a/agents-jdk8/image_to_diagram_with_correction.puml.png b/agents-jdk8/image_to_diagram_with_correction.puml.png