Bagatur/chain of note template(#13470)

docs/docs/integrations/llms/huggingface_hub.ipynb

@@ -101,8 +101,8 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from langchain.prompts import PromptTemplate\n",
-    "from langchain.chains import LLMChain"
+    "from langchain.chains import LLMChain\n",
+    "from langchain.prompts import PromptTemplate"
    ]
   },
   {

templates/chain-of-note-wiki/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 LangChain, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

templates/chain-of-note-wiki/README.md

@@ -0,0 +1,71 @@
+# Chain-of-Note (Wikipedia)
+
+Implements Chain-of-Note as described in https://arxiv.org/pdf/2311.09210.pdf by Yu, et al. Uses Wikipedia for retrieval.
+
+Check out the prompt being use here https://smith.langchain.com/hub/bagatur/chain-of-note-wiki.
+
+## Environment Setup
+
+Uses Anthropic claude-2 chat model. Set Anthropic API key:
+```bash
+export ANTHROPIC_API_KEY="..."
+```
+
+## Usage
+
+To use this package, you should first have the LangChain CLI installed:
+
+```shell
+pip install -U "langchain-cli[serve]"
+```
+
+To create a new LangChain project and install this as the only package, you can do:
+
+```shell
+langchain app new my-app --package chain-of-note-wiki
+```
+
+If you want to add this to an existing project, you can just run:
+
+```shell
+langchain app add chain-of-note-wiki
+```
+
+And add the following code to your `server.py` file:
+```python
+from chain_of_note_wiki import chain as chain_of_note_wiki_chain
+
+add_routes(app, chain_of_note_wiki_chain, path="/chain-of-note-wiki")
+```
+
+(Optional) Let's now configure LangSmith. 
+LangSmith will help us trace, monitor and debug LangChain applications. 
+LangSmith is currently in private beta, you can sign up [here](https://smith.langchain.com/). 
+If you don't have access, you can skip this section
+
+
+```shell
+export LANGCHAIN_TRACING_V2=true
+export LANGCHAIN_API_KEY=<your-api-key>
+export LANGCHAIN_PROJECT=<your-project>  # if not specified, defaults to "default"
+```
+
+If you are inside this directory, then you can spin up a LangServe instance directly by:
+
+```shell
+langchain serve
+```
+
+This will start the FastAPI app with a server is running locally at 
+[http://localhost:8000](http://localhost:8000)
+
+We can see all templates at [http://127.0.0.1:8000/docs](http://127.0.0.1:8000/docs)
+We can access the playground at [http://127.0.0.1:8000/chain-of-note-wiki/playground](http://127.0.0.1:8000/chain-of-note-wiki/playground)  
+
+We can access the template from code with:
+
+```python
+from langserve.client import RemoteRunnable
+
+runnable = RemoteRunnable("http://localhost:8000/chain-of-note-wiki")
+```

templates/chain-of-note-wiki/chain_of_note_wiki/__init__.py

@@ -0,0 +1,3 @@
+from chain_of_note_wiki.chain import chain
+
+__all__ = ["chain"]

templates/chain-of-note-wiki/chain_of_note_wiki/chain.py

@@ -0,0 +1,33 @@
+from langchain import hub
+from langchain.chat_models import ChatAnthropic
+from langchain.pydantic_v1 import BaseModel
+from langchain.schema import StrOutputParser
+from langchain.schema.runnable import RunnableLambda, RunnablePassthrough
+from langchain.utilities import WikipediaAPIWrapper
+
+
+class Question(BaseModel):
+    __root__: str
+
+
+wiki = WikipediaAPIWrapper(top_k_results=5)
+prompt = hub.pull("bagatur/chain-of-note-wiki")
+
+llm = ChatAnthropic(model="claude-2")
+
+
+def format_docs(docs):
+    return "\n\n".join(
+        f"Wikipedia {i+1}:\n{doc.page_content}" for i, doc in enumerate(docs)
+    )
+
+
+chain = (
+    {
+        "passages": RunnableLambda(wiki.load) | format_docs,
+        "question": RunnablePassthrough(),
+    }
+    | prompt
+    | llm
+    | StrOutputParser()
+).with_types(input_type=Question)

templates/chain-of-note-wiki/pyproject.toml

@@ -0,0 +1,26 @@
+[tool.poetry]
+name = "chain-of-note-wiki"
+version = "0.0.1"
+description = ""
+authors = []
+readme = "README.md"
+
+[tool.poetry.dependencies]
+python = ">=3.8.1,<4.0"
+langchain = ">=0.0.313, <0.1"
+anthropic = "^0.7.0"
+wikipedia = "^1.4.0"
+langchainhub = "^0.1.14"
+
+[tool.poetry.group.dev.dependencies]
+langchain-cli = ">=0.0.4"
+fastapi = "^0.104.0"
+sse-starlette = "^1.6.5"
+
+[tool.langserve]
+export_module = "chain_of_note_wiki"
+export_attr = "chain"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"