[GH-ISSUE #437] DOC: Add diagram(s) showing components relationships (specialization, usage, dependency...)? #16

Closed
opened 2026-02-17 17:19:00 -05:00 by yindo · 4 comments
Owner

Originally created by @fterrani on GitHub (Jan 31, 2025).
Original GitHub issue: https://github.com/langchain-ai/docs/issues/437

URL

https://python.langchain.com/docs/integrations/components/

Checklist

  • I added a very descriptive title to this issue.
  • I included a link to the documentation page I am referring to (if applicable).

Issue with current documentation:

I'm reading the LangChain docs and trying to understand how components work together. So far, I couldn't find any diagram showing how components are related. Information does exist but seems scattered in several pages that I very quickly get lost among.

I know it's possible to get the information I need with the current documentation, but I don't think it is efficient at all. I'm certain there are several people in the project who do have the necessary knowledge, could spend a handful of hours on diagrams that could collectively save LangChain users god knows how many hours.

Idea or request for content:

I'm not asking for a pristine code-accurate UML, but at least something informal yet useful, showing for example:

  • that a chat model simply wraps an LLM (I guess?)
  • that an LLM can call tools and tools can be grouped in toolkits
  • that a vector store can be seen as a retriever (I guess?)
  • that an embedding model takes text as input and produces a vector as an output, which can then be added to a vector store (I guess?)
  • ...

Ideally, everything listed under the Components section could be represented. Most specific parts can be represented very simply while the main component types (those not under the Other category) should be given more space & attention. One could also separate that in simpler cases, e.g.:

  • A diagram for text, embedding model, vector and vector store
  • A diagram for query, retriever and documents
  • ...
Originally created by @fterrani on GitHub (Jan 31, 2025). Original GitHub issue: https://github.com/langchain-ai/docs/issues/437 ### URL https://python.langchain.com/docs/integrations/components/ ### Checklist - [x] I added a very descriptive title to this issue. - [x] I included a link to the documentation page I am referring to (if applicable). ### Issue with current documentation: I'm reading the LangChain docs and trying to understand how components work together. So far, I couldn't find any diagram showing how components are related. Information does exist but seems scattered in several pages that I very quickly get lost among. I know it's possible to get the information I need with the current documentation, but I don't think it is efficient at all. I'm certain there are several people in the project who do have the necessary knowledge, could spend a handful of hours on diagrams that could collectively save LangChain users god knows how many hours. ### Idea or request for content: I'm not asking for a pristine code-accurate UML, but at least something informal yet useful, showing for example: - that a chat model simply wraps an LLM (I guess?) - that an LLM can call tools and tools can be grouped in toolkits - that a vector store can be seen as a retriever (I guess?) - that an embedding model takes text as input and produces a vector as an output, which can then be added to a vector store (I guess?) - ... Ideally, everything listed under the ***Components*** section could be represented. Most specific parts can be represented very simply while the main component types (those not under the *Other* category) should be given more space & attention. One could also separate that in simpler cases, e.g.: - A diagram for text, embedding model, vector and vector store - A diagram for query, retriever and documents - ...
yindo added the langchain label 2026-02-17 17:19:00 -05:00
yindo closed this issue 2026-02-17 17:19:00 -05:00
Author
Owner

@dosubot[bot] commented on GitHub (May 2, 2025):

Hi, @fterrani. I'm Dosu, and I'm helping the LangChain team manage their backlog. I'm marking this issue as stale.

Issue Summary:

  • Proposed enhancement to LangChain documentation.
  • Suggestion to add diagrams illustrating component relationships.
  • Aim to improve user understanding and efficiency.
  • No further comments or developments on the issue.

Next Steps:

  • Please let me know if this issue is still relevant to the latest version of LangChain by commenting here.
  • If there is no response, the issue will be automatically closed in 7 days.

Thank you for your understanding and contribution!

@dosubot[bot] commented on GitHub (May 2, 2025): Hi, @fterrani. I'm [Dosu](https://dosu.dev), and I'm helping the LangChain team manage their backlog. I'm marking this issue as stale. **Issue Summary:** - Proposed enhancement to LangChain documentation. - Suggestion to add diagrams illustrating component relationships. - Aim to improve user understanding and efficiency. - No further comments or developments on the issue. **Next Steps:** - Please let me know if this issue is still relevant to the latest version of LangChain by commenting here. - If there is no response, the issue will be automatically closed in 7 days. Thank you for your understanding and contribution!
Author
Owner

@fterrani commented on GitHub (May 3, 2025):

Still relevant I would say? Human opinion needed here ;)

@fterrani commented on GitHub (May 3, 2025): Still relevant I would say? Human opinion needed here ;)
Author
Owner

@dosubot[bot] commented on GitHub (May 3, 2025):

@eyurtsev, the user @fterrani has indicated that this issue regarding enhancing LangChain documentation with diagrams is still relevant. Could you please assist them with this?

@dosubot[bot] commented on GitHub (May 3, 2025): @eyurtsev, the user @fterrani has indicated that this issue regarding enhancing LangChain documentation with diagrams is still relevant. Could you please assist them with this?
Author
Owner

@mdrxy commented on GitHub (Oct 17, 2025):

Inheritance diagrams are a feature that we're considering adding to the reference docs

@mdrxy commented on GitHub (Oct 17, 2025): Inheritance diagrams are a feature that we're considering adding to the reference docs
yindo changed title from DOC: Add diagram(s) showing components relationships (specialization, usage, dependency...)? to [GH-ISSUE #437] DOC: Add diagram(s) showing components relationships (specialization, usage, dependency...)? 2026-06-05 17:24:35 -04:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: langchain-ai/docs#16