Update docs api references (#3315)

This commit is contained in:
Davis Chase 2023-04-21 12:21:33 -07:00 committed by GitHub
parent aa9d5707e0
commit e933be9605
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
18 changed files with 119 additions and 33 deletions

View File

@ -7,8 +7,10 @@ Full documentation on all methods, classes, and APIs in LangChain.
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
./reference/models.rst
./reference/prompts.rst ./reference/prompts.rst
LLMs<./reference/modules/llms> ./reference/indexes.rst
./reference/utils.rst ./reference/modules/memory.rst
Chains<./reference/modules/chains> ./reference/modules/chains.rst
Agents<./reference/modules/agents> ./reference/agents.rst
./reference/modules/utilities.rst

12
docs/reference/agents.rst Normal file
View File

@ -0,0 +1,12 @@
Agents
==============
Reference guide for Agents and associated abstractions.
.. toctree::
:maxdepth: 1
:glob:
modules/agents
modules/tools
modules/agent_toolkits

View File

@ -0,0 +1,16 @@
Indexes
==============
Indexes refer to ways to structure documents so that LLMs can best interact with them.
LangChain has a number of modules that help you load, structure, store, and retrieve documents.
.. toctree::
:maxdepth: 1
:glob:
modules/docstore
modules/text_splitter
modules/document_loaders
modules/vectorstores
modules/retrievers
modules/document_compressors
modules/document_transformers

12
docs/reference/models.rst Normal file
View File

@ -0,0 +1,12 @@
Models
==============
LangChain provides interfaces and integrations for a number of different types of models.
.. toctree::
:maxdepth: 1
:glob:
modules/llms
modules/chat_models
modules/embeddings

View File

@ -0,0 +1,7 @@
Agent Toolkits
===============================
.. automodule:: langchain.agents.agent_toolkits
:members:
:undoc-members:

View File

@ -0,0 +1,7 @@
Chat Models
===============================
.. automodule:: langchain.chat_models
:members:
:undoc-members:

View File

@ -0,0 +1,7 @@
Document Compressors
===============================
.. automodule:: langchain.retrievers.document_compressors
:members:
:undoc-members:

View File

@ -0,0 +1,7 @@
Document Loaders
===============================
.. automodule:: langchain.document_loaders
:members:
:undoc-members:

View File

@ -0,0 +1,7 @@
Document Transformers
===============================
.. automodule:: langchain.document_transformers
:members:
:undoc-members:

View File

@ -0,0 +1,7 @@
Memory
===============================
.. automodule:: langchain.memory
:members:
:undoc-members:

View File

@ -0,0 +1,7 @@
Output Parsers
===============================
.. automodule:: langchain.output_parsers
:members:
:undoc-members:

View File

@ -0,0 +1,7 @@
Retrievers
===============================
.. automodule:: langchain.retrievers
:members:
:undoc-members:

View File

@ -0,0 +1,7 @@
Tools
===============================
.. automodule:: langchain.tools
:members:
:undoc-members:

View File

@ -0,0 +1,7 @@
Utilities
===============================
.. automodule:: langchain.utilities
:members:
:undoc-members:

View File

@ -1,4 +1,4 @@
VectorStores Vector Stores
============================= =============================
.. automodule:: langchain.vectorstores .. automodule:: langchain.vectorstores

View File

@ -7,5 +7,6 @@ The reference guides here all relate to objects for working with Prompts.
:maxdepth: 1 :maxdepth: 1
:glob: :glob:
modules/prompt modules/prompts
modules/example_selector modules/example_selector
modules/output_parsers

View File

@ -1,27 +0,0 @@
Utilities
==============
There are a lot of different utilities that LangChain provides integrations for
These guides go over how to use them.
These can largely be grouped into two categories: generic utilities, and then utilities for working with larger text documents.
.. toctree::
:maxdepth: 1
:glob:
:caption: Generic Utilities
modules/python
modules/serpapi
modules/searx_search
.. toctree::
:maxdepth: 1
:glob:
:caption: Utilities for working with Documents
modules/docstore
modules/text_splitter
modules/embeddings
modules/vectorstore