Annotation Interface ParallelMultiInstanceAgent

@Retention(RUNTIME) @Target(METHOD) public @interface ParallelMultiInstanceAgent
Marks a method as a definition of a parallel multi-instance agent, used to orchestrate the agentic workflow by creating multiple instances of the same sub-agent, one for each item in a collection read from the agentic scope.

Example: 


    public interface BatchProcessorAgent {

        @ParallelMultiInstanceAgent( outputKey = "results",
                subAgent = ItemProcessor.class,
                inputKey = "items" )
        List<Result> process(@V("items") List<Item> items);
    }

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    itemsProvider
    Key referencing a collection in the agentic scope.
    Class<?>
    subAgent
    The sub-agent class that will be instantiated for each item in the collection.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    description
    Description of the agent.
    String
    name
    Name of the agent.
    String
    outputKey
    Key of the output variable that will be used to store the result of the agent's invocation.
    Class<? extends TypedKey<?>>
    typedOutputKey
    Strongly typed key of the output variable that will be used to store the result of the agent's invocation.

  • Element Details

    • name

      String name
      Name of the agent. If not provided, method name will be used.
      Returns:
      name of the agent.
      Default:
      ""

    • description

      String description
      Description of the agent. It should be clear and descriptive to allow language model to understand the agent's purpose and its intended use.
      Returns:
      description of the agent.
      Default:
      ""

    • outputKey

      String outputKey
      Key of the output variable that will be used to store the result of the agent's invocation.
      Returns:
      name of the output variable.
      Default:
      ""

    • typedOutputKey

      Class<? extends TypedKey<?>> typedOutputKey
      Strongly typed key of the output variable that will be used to store the result of the agent's invocation. It enforces type safety when retrieving the output from the agent's state and can be used in alternative to the outputKey() attribute. Note that only one of those two attributes can be used at a time.
      Returns:
      class representing the typed output variable.
      Default:
      dev.langchain4j.agentic.Agent.NoTypedKey.class

    • subAgent

      Class<?> subAgent
      The sub-agent class that will be instantiated for each item in the collection.
      Returns:
      the sub-agent class.

    • itemsProvider

      String itemsProvider
      Key referencing a collection in the agentic scope. For each item in this collection, an instance of the sub-agent will be created and executed in parallel.
      Returns:
      the key of the input collection.