docs: add changelog (#15606)

--------- Co-authored-by: Harrison Chase <[email protected]>
langchain-ai · Jan 7, 2024 · 4759d10 · 4759d10
1 parent d1bfb70
commit 4759d10
Show file tree

Hide file tree

Showing 7 changed files with 106 additions and 79 deletions.
diff --git a/docs/docs/changelog/core.mdx b/docs/docs/changelog/core.mdx
@@ -0,0 +1,27 @@
+# langchain-core
+
+## 0.1.7 (Jan 5, 2024)
+
+#### Deleted
+
+No deletions.
+
+#### Deprecated
+
+- `BaseChatModel` methods `__call__`, `call_as_llm`, `predict`, `predict_messages`. Will be removed in 0.2.0. Use `BaseChatModel.invoke` instead.
+- `BaseChatModel` methods `apredict`, `apredict_messages`. Will be removed in 0.2.0. Use `BaseChatModel.ainvoke` instead.
+- `BaseLLM` methods `__call__, `predict`, `predict_messages`. Will be removed in 0.2.0. Use `BaseLLM.invoke` instead.
+- `BaseLLM` methods `apredict`, `apredict_messages`. Will be removed in 0.2.0. Use `BaseLLM.ainvoke` instead.
+
+#### Fixed
+
+- Restrict recursive URL scraping: [#15559](https://github.com/langchain-ai/langchain/pull/15559)
+
+#### Added
+
+No additions.
+
+#### Beta
+
+- Marked `langchain_core.load.load` and `langchain_core.load.loads` as beta.
+- Marked `langchain_core.beta.runnables.context.ContextGet` and `langchain_core.beta.runnables.context.ContextSet` as beta.
diff --git a/docs/docs/changelog/langchain.mdx b/docs/docs/changelog/langchain.mdx
@@ -0,0 +1,36 @@
+# langchain
+
+## 0.1.0 (Jan 5, 2024)
+
+#### Deleted
+
+No deletions.
+
+#### Deprecated
+
+Deprecated classes and methods will be removed in 0.2.0
+
+| Deprecated                | Alternative                       | Reason                                         |
+|---------------------------------|-----------------------------------|------------------------------------------------|
+| ChatVectorDBChain               | ConversationalRetrievalChain      | More general to all retrievers                 |
+| create_ernie_fn_chain           | create_ernie_fn_runnable          | Use LCEL under the hood                        |
+| created_structured_output_chain | create_structured_output_runnable | Use LCEL under the hood                        |
+| NatBotChain                     |                                   | Not used                                       |
+| create_openai_fn_chain          | create_openai_fn_runnable         | Use LCEL under the hood                        |
+| create_structured_output_chain  | create_structured_output_runnable | Use LCEL under the hood                        |
+| load_query_constructor_chain    | load_query_constructor_runnable   | Use LCEL under the hood                        |
+| VectorDBQA                      | RetrievalQA                       | More general to all retrievers                 |
+| Sequential Chain                | LCEL                              | Obviated by LCEL                               |
+| SimpleSequentialChain           | LCEL                              | Obviated by LCEL                               |
+| TransformChain                  | LCEL/RunnableLambda               | Obviated by LCEL                               |
+| create_tagging_chain            | create_structured_output_runnable | Use LCEL under the hood                        |
+| ChatAgent                       | create_react_agent                | Use LCEL builder over a class                  |
+| ConversationalAgent             | create_react_agent                | Use LCEL builder over a class                  |
+| ConversationalChatAgent         | create_json_chat_agent            | Use LCEL builder over a class                  |
+| initialize_agent                | Individual create agent methods   | Individual create agent methods are more clear |
+| ZeroShotAgent                   | create_react_agent                | Use LCEL builder over a class                  |
+| OpenAIFunctionsAgent            | create_openai_functions_agent     | Use LCEL builder over a class                  |
+| OpenAIMultiFunctionsAgent       | create_openai_tools_agent         | Use LCEL builder over a class                  |
+| SelfAskWithSearchAgent          | create_self_ask_with_search       | Use LCEL builder over a class                  |
+| StructuredChatAgent             | create_structured_chat_agent      | Use LCEL builder over a class                  |
+| XMLAgent                        | create_xml_agent                  | Use LCEL builder over a class                  |
diff --git a/docs/docs/community.md b/docs/docs/community.md
diff --git a/docs/docs/contributing/packages.mdx → docs/docs/packages.mdx b/docs/docs/contributing/packages.mdx → docs/docs/packages.mdx
@@ -1,38 +1,43 @@
----
-sidebar_label: Package Versioning
-sidebar_position: 4
----
-
 # 📕 Package Versioning
 
 As of now, LangChain has an ad hoc release process: releases are cut with high frequency by
-a maintainer and published to [PyPI](https://pypi.org/). 
+a maintainer and published to [PyPI](https://pypi.org/).
 The different packages are versioned slightly differently.
 
 ## `langchain-core`
 
 `langchain-core` is currently on version `0.1.x`. 
 
-As `langchain-core` contains the base abstractions and runtime for the whole LangChain ecosystem, we will communicate any breaking changes with advance notice and version bumps. The exception for this is anything in `langchain_core.beta`. The reason for `langchain_core.beta` is that given the rate of change of the field, being able to move quickly is still a priority, and this module is our attempt to do so.
+As `langchain-core` contains the base abstractions and runtime for the whole LangChain ecosystem, we will communicate any breaking changes with advance notice and version bumps. The exception for this is anything marked with the `beta` decorator (you can see this in the API reference and will see warnings when using such functionality). The reason for beta features is that given the rate of change of the field, being able to move quickly is still a priority.
 
 Minor version increases will occur for:
 
-- Breaking changes for any public interfaces NOT in `langchain_core.beta`
+- Breaking changes for any public interfaces marked as `beta`.
 
 Patch version increases will occur for:
 
 - Bug fixes
 - New features
 - Any changes to private interfaces
-- Any changes to `langchain_core.beta`
+- Any changes to `beta` features
 
 ## `langchain`
 
-`langchain` is currently on version `0.0.x`
+`langchain` is currently on version `0.1.x`
+
+Minor version increases will occur for:
 
-All changes will be accompanied by a patch version increase. Any changes to public interfaces are nearly always done in a backwards compatible way and will be communicated ahead of time when they are not backwards compatible.
+- Breaking changes for any public interfaces NOT marked as `beta`.
+
+Patch version increases will occur for:
+
+- Bug fixes
+- New features
+- Any changes to private interfaces
+- Any changes to `beta` features
 
-We are targeting January 2024 for a release of `langchain` v0.1, at which point `langchain` will adopt the same versioning policy as `langchain-core`.
+We are targeting February 2024 for a release of `langchain` v0.2, which will have some breaking changes to legacy Chains and Agents.
+Additionally, we will remove `langchain-community` as a dependency and stop re-exporting integrations that have been moved to `langchain-community`.
 
 ## `langchain-community`
 

diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js
@@ -178,39 +178,35 @@ const config = {
             position: "left",
             items: [
               {
-                type: "docSidebar",
-                sidebarId: "templates",
-                label: "Templates",
+                to: "/docs/packages",
+                label: "Versioning",
               },
               {
-                to: "/docs/community",
-                label: "Community",
+                type: "docSidebar",
+                sidebarId: "changelog",
+                label: "Changelog",
               },
               {
                 to: "/docs/contributing",
                 label: "Developer's guide",
               },
               {
-                to: "/docs/additional_resources/dependents",
-                label: "Dependents",
+                type: "docSidebar",
+                sidebarId: "templates",
+                label: "Templates",
               },
               {
-                label: "Integrations Hub",
-                href: "https://integrations.langchain.com/",
+                label: "Cookbooks",
+                href: "https://github.com/langchain-ai/langchain/blob/master/cookbook/README.md"
               },
               {
                 to: "/docs/additional_resources/tutorials",
                 label: "Tutorials"
               },
-              {
-                label: "Cookbooks",
-                href: "https://github.com/langchain-ai/langchain/blob/master/cookbook/README.md"
-              },
               {
                 to: "/docs/additional_resources/youtube",
                 label: "YouTube videos"
               },
-              { label: "Gallery", href: "https://github.com/kyrolabs/awesome-langchain" }
             ]
           },
           {

diff --git a/docs/sidebars.js b/docs/sidebars.js
@@ -142,6 +142,14 @@ module.exports = {
       link: { type: 'doc', id: "templates/index" }
     },
   ],
+  changelog: [
+    {
+      type: "category",
+      label: "Changelog",
+      items: [{ type: "autogenerated", dirName: "changelog" }],
+      link: { type: 'generated-index', slug: "changelog"}
+    },
+  ],
   contributing: [
     {type: "autogenerated", dirName: "contributing" }
   ],

diff --git a/docs/vercel.json b/docs/vercel.json
@@ -1,5 +1,13 @@
 {
   "redirects": [
+    {
+      "source": "/docs/contributing/packages",
+      "destination": "/docs/packages"
+    },
+    {
+      "source": "/docs/community",
+      "destination": "/docs/contributing"
+    },
     {
       "source": "/docs/modules/chains/(.+)",
       "destination": "/docs/modules/chains"