LangGraph.js API Reference
    Preparing search index...

    Function createSwarm

    • Create a multi-agent swarm.

      Type Parameters

      • AnnotationRootT extends AnnotationRoot<any> = AnnotationRoot<
            {
                activeAgent: {
                    Root: <S extends StateDefinition>(sd: S) => AnnotationRoot<S>;
                    (): LastValue<string>;
                    (
                        annotation: SingleReducer<string, string>,
                    ): BinaryOperatorAggregate<string, string>;
                };
                messages: BinaryOperatorAggregate<
                    BaseMessage<MessageStructure, MessageType>[],
                    Messages,
                >;
            },
        >

      Parameters

      • params: {
            agents: CompiledStateGraph<
                StateType<
                    {
                        messages: BinaryOperatorAggregate<
                            BaseMessage<MessageStructure, MessageType>[],
                            Messages,
                        >;
                    },
                >,
                UpdateType<
                    {
                        messages: BinaryOperatorAggregate<
                            BaseMessage<MessageStructure, MessageType>[],
                            Messages,
                        >;
                    },
                >,
                string,
                {
                    messages: BinaryOperatorAggregate<
                        BaseMessage<MessageStructure, MessageType>[],
                        Messages,
                    >;
                },
                {
                    messages: BinaryOperatorAggregate<
                        BaseMessage<MessageStructure, MessageType>[],
                        Messages,
                    >;
                },
                StateDefinition,
                unknown,
                unknown,
                unknown,
            >[];
            defaultActiveAgent: string;
            stateSchema?: AnnotationRootT;
        }

        Parameters for the multi-agent swarm.

        • agents: CompiledStateGraph<
              StateType<
                  {
                      messages: BinaryOperatorAggregate<
                          BaseMessage<MessageStructure, MessageType>[],
                          Messages,
                      >;
                  },
              >,
              UpdateType<
                  {
                      messages: BinaryOperatorAggregate<
                          BaseMessage<MessageStructure, MessageType>[],
                          Messages,
                      >;
                  },
              >,
              string,
              {
                  messages: BinaryOperatorAggregate<
                      BaseMessage<MessageStructure, MessageType>[],
                      Messages,
                  >;
              },
              {
                  messages: BinaryOperatorAggregate<
                      BaseMessage<MessageStructure, MessageType>[],
                      Messages,
                  >;
              },
              StateDefinition,
              unknown,
              unknown,
              unknown,
          >[]

          List of agents to add to the swarm

        • defaultActiveAgent: string

          Name of the agent to route to by default (if no agents are currently active)

        • OptionalstateSchema?: AnnotationRootT

          State schema to use for the multi-agent graph

      Returns StateGraph<
          AnnotationRootT["spec"],
          AnnotationRootT["State"],
          AnnotationRootT["Update"],
          string,
          AnnotationRootT["spec"],
          AnnotationRootT["spec"],
      >

      A multi-agent swarm StateGraph.

    Settings

    Member Visibility