Package dev.langchain4j.image_to_diagram.actions

Class DescribeDiagramImage

java.lang.Object

dev.langchain4j.image_to_diagram.actions.DescribeDiagramImage

All Implemented Interfaces:

NodeAction<ImageToDiagram.State>

public class DescribeDiagramImage
extends Object
implements NodeAction<ImageToDiagram.State>

This class implements the `NodeAction` interface for diagram image description. It provides functionality to process the state of an image and generate a textual description based on its content using a vision model.

Constructor Summary

Constructors

Constructor	Description
DescribeDiagramImage(@NonNull dev.langchain4j.model.chat.ChatLanguageModel visionModel)	Constructs a `DescribeDiagramImage` instance with the given language model.

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	apply(ImageToDiagram.State state)	Applies the provided image to create a diagram.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DescribeDiagramImage

public DescribeDiagramImage(@NonNull
 @NonNull dev.langchain4j.model.chat.ChatLanguageModel visionModel)

Constructs a `DescribeDiagramImage` instance with the given language model.

Parameters:

visionModel - The language model used to generate descriptions.

Method Details

apply

public Map<String,Object> apply(ImageToDiagram.State state)
                         throws Exception

Applies the provided image to create a diagram.

Specified by:

apply in interface NodeAction<ImageToDiagram.State>

Parameters:

state - The current state of the image to be converted into a diagram.

Returns:

A map containing the resulting diagram and associated image data.

Throws:

Exception - if no image data is provided in the state.