langchain-ai/langgraphjs
1
0
Fork 0
mirror of https://github.com/langchain-ai/langgraphjs.git synced 2026-07-21 16:45:24 -04:00
Code Issues 108 Packages Projects Releases 20 Wiki Activity

Discrepancy in docs between Python and JS #141

New Issue
Closed
opened 2026-02-15 17:16:13 -05:00 by yindo · 1 comment
yindo commented 2026-02-15 17:16:13 -05:00
Owner
Copy Link
Copy Source

Originally created by @mme on GitHub (Nov 28, 2024).

In LangGraph Python, the recommended way to set up state is to either use MessagesState or to manually set it up. For example the Python quick start describes setting up state like this:

class State(TypedDict):
    # Messages have the type "list". The `add_messages` function
    # in the annotation defines how this state key should be updated
    # (in this case, it appends messages to the list, rather than overwriting them)
    messages: Annotated[list, add_messages]

This is how the JS quickstart recommends to set up state:

// Define the graph state
// See here for more info: https://langchain-ai.github.io/langgraphjs/how-tos/define-state/
const StateAnnotation = Annotation.Root({
  messages: Annotation<BaseMessage[]>({
    reducer: (x, y) => x.concat(y),
  })
})

These two methods behave fundamentally different, i.e.:

# pseudo code
def some_node(state):
   state["messages"].append(AIMessages("D"))
   return state

If state.messages was [A,B,C] it would be [A,B,C,D] in Python and [A,B,C,A,B,C,D] in Javascript.

In addition, the "Define State" docs do not mention MessagesAnnotation and this method to get the equivalent of the Python behavior:

export const SomeState = Annotation.Root({
  aProperty: Annotation<string>,
  ...MessagesAnnotation.spec,
});

To make it easier for users and to make LangGraph work more alike on Python and JS, I suggest these changes:

  • In the docs, recommend to set up state via ...MessagesAnnotation.spec instead of reducer: (x, y) => x.concat(y)
  • In the "Define State" section, mention MessagesAnnotation
Originally created by @mme on GitHub (Nov 28, 2024). In LangGraph Python, the recommended way to set up state is to either use `MessagesState` or to manually set it up. For example the [Python quick start ](https://langchain-ai.github.io/langgraph/tutorials/introduction/#setup) describes setting up state like this: ```python class State(TypedDict): # Messages have the type "list". The `add_messages` function # in the annotation defines how this state key should be updated # (in this case, it appends messages to the list, rather than overwriting them) messages: Annotated[list, add_messages] ``` This is how the [JS quickstart](https://langchain-ai.github.io/langgraphjs/#example) recommends to set up state: ```js // Define the graph state // See here for more info: https://langchain-ai.github.io/langgraphjs/how-tos/define-state/ const StateAnnotation = Annotation.Root({ messages: Annotation<BaseMessage[]>({ reducer: (x, y) => x.concat(y), }) }) ``` These two methods behave fundamentally different, i.e.: ```python # pseudo code def some_node(state): state["messages"].append(AIMessages("D")) return state ``` If `state.messages` was `[A,B,C]` it would be `[A,B,C,D]` in Python and `[A,B,C,A,B,C,D]` in Javascript. In addition, the ["Define State"](https://langchain-ai.github.io/langgraphjs/how-tos/define-state/) docs do not mention `MessagesAnnotation` and this method to get the equivalent of the Python behavior: ```javascript export const SomeState = Annotation.Root({ aProperty: Annotation<string>, ...MessagesAnnotation.spec, }); ``` To make it easier for users and to make LangGraph work more alike on Python and JS, I suggest these changes: - In the docs, recommend to set up state via `...MessagesAnnotation.spec` instead of `reducer: (x, y) => x.concat(y)` - In the "Define State" section, mention `MessagesAnnotation`
yindo closed this issue 2026-02-15 17:16:13 -05:00
yindo commented 2026-02-15 17:16:14 -05:00
Author
Owner
Copy Link
Copy Source

@nick-w-nick commented on GitHub (Jan 31, 2025):

@mme Does the PR linked by @dqbd (#696) satisfy the request described in your issue? If so, would you mind closing it when you get a chance?

@nick-w-nick commented on GitHub (Jan 31, 2025): @mme Does the PR linked by @dqbd (#696) satisfy the request described in your issue? If so, would you mind closing it when you get a chance?
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
bug
checkpointer
docs-needed
documentation
enhancement
good first issue
good writeup
help wanted
invalid
langgraph-supervisor
open-swe-auto
platform
prebuilt
pull-request
Mirrored from GitHub Pull Request
 question
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
yindo
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: langchain-ai/langgraphjs#141
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?