From e933be9605f6e6d913db32134a59e3162ded2b48 Mon Sep 17 00:00:00 2001 From: Davis Chase <130488702+dev2049@users.noreply.github.com> Date: Fri, 21 Apr 2023 12:21:33 -0700 Subject: [PATCH] Update docs api references (#3315) --- docs/reference.rst | 10 ++++--- docs/reference/agents.rst | 12 +++++++++ docs/reference/indexes.rst | 16 +++++++++++ docs/reference/models.rst | 12 +++++++++ docs/reference/modules/agent_toolkits.rst | 7 +++++ docs/reference/modules/chat_models.rst | 7 +++++ .../modules/document_compressors.rst | 7 +++++ docs/reference/modules/document_loaders.rst | 7 +++++ .../modules/document_transformers.rst | 7 +++++ docs/reference/modules/memory.rst | 7 +++++ docs/reference/modules/output_parsers.rst | 7 +++++ .../modules/{prompt.rst => prompts.rst} | 0 docs/reference/modules/retrievers.rst | 7 +++++ docs/reference/modules/tools.rst | 7 +++++ docs/reference/modules/utilities.rst | 7 +++++ .../{vectorstore.rst => vectorstores.rst} | 2 +- docs/reference/prompts.rst | 3 ++- docs/reference/utils.rst | 27 ------------------- 18 files changed, 119 insertions(+), 33 deletions(-) create mode 100644 docs/reference/agents.rst create mode 100644 docs/reference/indexes.rst create mode 100644 docs/reference/models.rst create mode 100644 docs/reference/modules/agent_toolkits.rst create mode 100644 docs/reference/modules/chat_models.rst create mode 100644 docs/reference/modules/document_compressors.rst create mode 100644 docs/reference/modules/document_loaders.rst create mode 100644 docs/reference/modules/document_transformers.rst create mode 100644 docs/reference/modules/memory.rst create mode 100644 docs/reference/modules/output_parsers.rst rename docs/reference/modules/{prompt.rst => prompts.rst} (100%) create mode 100644 docs/reference/modules/retrievers.rst create mode 100644 docs/reference/modules/tools.rst create mode 100644 docs/reference/modules/utilities.rst rename docs/reference/modules/{vectorstore.rst => vectorstores.rst} (72%) delete mode 100644 docs/reference/utils.rst diff --git a/docs/reference.rst b/docs/reference.rst index ae9d8f26..fc19ba72 100644 --- a/docs/reference.rst +++ b/docs/reference.rst @@ -7,8 +7,10 @@ Full documentation on all methods, classes, and APIs in LangChain. .. toctree:: :maxdepth: 1 + ./reference/models.rst ./reference/prompts.rst - LLMs<./reference/modules/llms> - ./reference/utils.rst - Chains<./reference/modules/chains> - Agents<./reference/modules/agents> + ./reference/indexes.rst + ./reference/modules/memory.rst + ./reference/modules/chains.rst + ./reference/agents.rst + ./reference/modules/utilities.rst diff --git a/docs/reference/agents.rst b/docs/reference/agents.rst new file mode 100644 index 00000000..7f08eca2 --- /dev/null +++ b/docs/reference/agents.rst @@ -0,0 +1,12 @@ +Agents +============== + +Reference guide for Agents and associated abstractions. + +.. toctree:: + :maxdepth: 1 + :glob: + + modules/agents + modules/tools + modules/agent_toolkits \ No newline at end of file diff --git a/docs/reference/indexes.rst b/docs/reference/indexes.rst new file mode 100644 index 00000000..9d6bcf96 --- /dev/null +++ b/docs/reference/indexes.rst @@ -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 diff --git a/docs/reference/models.rst b/docs/reference/models.rst new file mode 100644 index 00000000..22e3c33f --- /dev/null +++ b/docs/reference/models.rst @@ -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 diff --git a/docs/reference/modules/agent_toolkits.rst b/docs/reference/modules/agent_toolkits.rst new file mode 100644 index 00000000..d3e15a40 --- /dev/null +++ b/docs/reference/modules/agent_toolkits.rst @@ -0,0 +1,7 @@ +Agent Toolkits +=============================== + +.. automodule:: langchain.agents.agent_toolkits + :members: + :undoc-members: + diff --git a/docs/reference/modules/chat_models.rst b/docs/reference/modules/chat_models.rst new file mode 100644 index 00000000..3d2e8104 --- /dev/null +++ b/docs/reference/modules/chat_models.rst @@ -0,0 +1,7 @@ +Chat Models +=============================== + +.. automodule:: langchain.chat_models + :members: + :undoc-members: + diff --git a/docs/reference/modules/document_compressors.rst b/docs/reference/modules/document_compressors.rst new file mode 100644 index 00000000..6a2576d7 --- /dev/null +++ b/docs/reference/modules/document_compressors.rst @@ -0,0 +1,7 @@ +Document Compressors +=============================== + +.. automodule:: langchain.retrievers.document_compressors + :members: + :undoc-members: + diff --git a/docs/reference/modules/document_loaders.rst b/docs/reference/modules/document_loaders.rst new file mode 100644 index 00000000..c6abddb3 --- /dev/null +++ b/docs/reference/modules/document_loaders.rst @@ -0,0 +1,7 @@ +Document Loaders +=============================== + +.. automodule:: langchain.document_loaders + :members: + :undoc-members: + diff --git a/docs/reference/modules/document_transformers.rst b/docs/reference/modules/document_transformers.rst new file mode 100644 index 00000000..7b71f6e5 --- /dev/null +++ b/docs/reference/modules/document_transformers.rst @@ -0,0 +1,7 @@ +Document Transformers +=============================== + +.. automodule:: langchain.document_transformers + :members: + :undoc-members: + diff --git a/docs/reference/modules/memory.rst b/docs/reference/modules/memory.rst new file mode 100644 index 00000000..3a00e5d3 --- /dev/null +++ b/docs/reference/modules/memory.rst @@ -0,0 +1,7 @@ +Memory +=============================== + +.. automodule:: langchain.memory + :members: + :undoc-members: + diff --git a/docs/reference/modules/output_parsers.rst b/docs/reference/modules/output_parsers.rst new file mode 100644 index 00000000..0f368d5d --- /dev/null +++ b/docs/reference/modules/output_parsers.rst @@ -0,0 +1,7 @@ +Output Parsers +=============================== + +.. automodule:: langchain.output_parsers + :members: + :undoc-members: + diff --git a/docs/reference/modules/prompt.rst b/docs/reference/modules/prompts.rst similarity index 100% rename from docs/reference/modules/prompt.rst rename to docs/reference/modules/prompts.rst diff --git a/docs/reference/modules/retrievers.rst b/docs/reference/modules/retrievers.rst new file mode 100644 index 00000000..037b8639 --- /dev/null +++ b/docs/reference/modules/retrievers.rst @@ -0,0 +1,7 @@ +Retrievers +=============================== + +.. automodule:: langchain.retrievers + :members: + :undoc-members: + diff --git a/docs/reference/modules/tools.rst b/docs/reference/modules/tools.rst new file mode 100644 index 00000000..458d3b79 --- /dev/null +++ b/docs/reference/modules/tools.rst @@ -0,0 +1,7 @@ +Tools +=============================== + +.. automodule:: langchain.tools + :members: + :undoc-members: + diff --git a/docs/reference/modules/utilities.rst b/docs/reference/modules/utilities.rst new file mode 100644 index 00000000..40a37ce4 --- /dev/null +++ b/docs/reference/modules/utilities.rst @@ -0,0 +1,7 @@ +Utilities +=============================== + +.. automodule:: langchain.utilities + :members: + :undoc-members: + diff --git a/docs/reference/modules/vectorstore.rst b/docs/reference/modules/vectorstores.rst similarity index 72% rename from docs/reference/modules/vectorstore.rst rename to docs/reference/modules/vectorstores.rst index e5ed525b..329c18e4 100644 --- a/docs/reference/modules/vectorstore.rst +++ b/docs/reference/modules/vectorstores.rst @@ -1,4 +1,4 @@ -VectorStores +Vector Stores ============================= .. automodule:: langchain.vectorstores diff --git a/docs/reference/prompts.rst b/docs/reference/prompts.rst index ed1e28a3..64fbf0d2 100644 --- a/docs/reference/prompts.rst +++ b/docs/reference/prompts.rst @@ -7,5 +7,6 @@ The reference guides here all relate to objects for working with Prompts. :maxdepth: 1 :glob: - modules/prompt + modules/prompts modules/example_selector + modules/output_parsers diff --git a/docs/reference/utils.rst b/docs/reference/utils.rst deleted file mode 100644 index 256a3b16..00000000 --- a/docs/reference/utils.rst +++ /dev/null @@ -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