langchain 0.3.26__py3-none-any.whl → 0.4.0.dev0__py3-none-any.whl

langchain/chains/qa_generation/prompt.py

@@ -1,5 +1,3 @@
-# flake8: noqa
-from langchain.chains.prompt_selector import ConditionalPromptSelector, is_chat_model
 from langchain_core.prompts.chat import (
     ChatPromptTemplate,
     HumanMessagePromptTemplate,
@@ -7,6 +5,8 @@ from langchain_core.prompts.chat import (
 )
 from langchain_core.prompts.prompt import PromptTemplate
 
+from langchain.chains.prompt_selector import ConditionalPromptSelector, is_chat_model
+
 templ1 = """You are a smart assistant designed to help high school teachers come up with reading comprehension questions.
 Given a piece of text, you must come up with a question and answer pair that can be used to test a student's reading comprehension abilities.
 When coming up with this question/answer pair, you must respond in the following format:
@@ -18,10 +18,10 @@ When coming up with this question/answer pair, you must respond in the following
 ```
 
 Everything between the ``` must be valid json.
-"""
+"""  # noqa: E501
 templ2 = """Please come up with a question/answer pair, in the specified JSON format, for the following text:
 ----------------
-{text}"""
+{text}"""  # noqa: E501
 CHAT_PROMPT = ChatPromptTemplate.from_messages(
     [
         SystemMessagePromptTemplate.from_template(templ1),
@@ -42,7 +42,7 @@ Everything between the ``` must be valid json.
 
 Please come up with a question/answer pair, in the specified JSON format, for the following text:
 ----------------
-{text}"""
+{text}"""  # noqa: E501
 PROMPT = PromptTemplate.from_template(templ)
 
 PROMPT_SELECTOR = ConditionalPromptSelector(

langchain/chains/qa_with_sources/base.py

@@ -16,6 +16,7 @@ from langchain_core.documents import Document
 from langchain_core.language_models import BaseLanguageModel
 from langchain_core.prompts import BasePromptTemplate
 from pydantic import ConfigDict, model_validator
+from typing_extensions import override
 
 from langchain.chains import ReduceDocumentsChain
 from langchain.chains.base import Chain
@@ -70,7 +71,7 @@ class BaseQAWithSourcesChain(Chain, ABC):
             document_variable_name="summaries",
         )
         reduce_documents_chain = ReduceDocumentsChain(
-            combine_documents_chain=combine_results_chain
+            combine_documents_chain=combine_results_chain,
         )
         combine_documents_chain = MapReduceDocumentsChain(
             llm_chain=llm_question_chain,
@@ -93,7 +94,9 @@ class BaseQAWithSourcesChain(Chain, ABC):
         """Load chain from chain type."""
         _chain_kwargs = chain_type_kwargs or {}
         combine_documents_chain = load_qa_with_sources_chain(
-            llm, chain_type=chain_type, **_chain_kwargs
+            llm,
+            chain_type=chain_type,
+            **_chain_kwargs,
         )
         return cls(combine_documents_chain=combine_documents_chain, **kwargs)
 
@@ -118,7 +121,7 @@ class BaseQAWithSourcesChain(Chain, ABC):
         """
         _output_keys = [self.answer_key, self.sources_answer_key]
         if self.return_source_documents:
-            _output_keys = _output_keys + ["source_documents"]
+            _output_keys = [*_output_keys, "source_documents"]
         return _output_keys
 
     @model_validator(mode="before")
@@ -133,7 +136,9 @@ class BaseQAWithSourcesChain(Chain, ABC):
         """Split sources from answer."""
         if re.search(r"SOURCES?:", answer, re.IGNORECASE):
             answer, sources = re.split(
-                r"SOURCES?:|QUESTION:\s", answer, flags=re.IGNORECASE
+                r"SOURCES?:|QUESTION:\s",
+                answer,
+                flags=re.IGNORECASE,
             )[:2]
             sources = re.split(r"\n", sources)[0].strip()
         else:
@@ -164,7 +169,9 @@ class BaseQAWithSourcesChain(Chain, ABC):
             docs = self._get_docs(inputs)  # type: ignore[call-arg]
 
         answer = self.combine_documents_chain.run(
-            input_documents=docs, callbacks=_run_manager.get_child(), **inputs
+            input_documents=docs,
+            callbacks=_run_manager.get_child(),
+            **inputs,
         )
         answer, sources = self._split_sources(answer)
         result: dict[str, Any] = {
@@ -198,7 +205,9 @@ class BaseQAWithSourcesChain(Chain, ABC):
         else:
             docs = await self._aget_docs(inputs)  # type: ignore[call-arg]
         answer = await self.combine_documents_chain.arun(
-            input_documents=docs, callbacks=_run_manager.get_child(), **inputs
+            input_documents=docs,
+            callbacks=_run_manager.get_child(),
+            **inputs,
         )
         answer, sources = self._split_sources(answer)
         result: dict[str, Any] = {
@@ -232,6 +241,7 @@ class QAWithSourcesChain(BaseQAWithSourcesChain):
         """
         return [self.input_docs_key, self.question_key]
 
+    @override
     def _get_docs(
         self,
         inputs: dict[str, Any],
@@ -241,6 +251,7 @@ class QAWithSourcesChain(BaseQAWithSourcesChain):
         """Get docs to run questioning over."""
         return inputs.pop(self.input_docs_key)
 
+    @override
     async def _aget_docs(
         self,
         inputs: dict[str, Any],

langchain/chains/qa_with_sources/loading.py

@@ -30,13 +30,16 @@ class LoadingCallable(Protocol):
     """Interface for loading the combine documents chain."""
 
     def __call__(
-        self, llm: BaseLanguageModel, **kwargs: Any
+        self,
+        llm: BaseLanguageModel,
+        **kwargs: Any,
     ) -> BaseCombineDocumentsChain:
         """Callable to load the combine documents chain."""
 
 
 def _load_map_rerank_chain(
     llm: BaseLanguageModel,
+    *,
     prompt: BasePromptTemplate = MAP_RERANK_PROMPT,
     verbose: bool = False,
     document_variable_name: str = "context",
@@ -56,6 +59,7 @@ def _load_map_rerank_chain(
 
 def _load_stuff_chain(
     llm: BaseLanguageModel,
+    *,
     prompt: BasePromptTemplate = stuff_prompt.PROMPT,
     document_prompt: BasePromptTemplate = stuff_prompt.EXAMPLE_PROMPT,
     document_variable_name: str = "summaries",
@@ -74,6 +78,7 @@ def _load_stuff_chain(
 
 def _load_map_reduce_chain(
     llm: BaseLanguageModel,
+    *,
     question_prompt: BasePromptTemplate = map_reduce_prompt.QUESTION_PROMPT,
     combine_prompt: BasePromptTemplate = map_reduce_prompt.COMBINE_PROMPT,
     document_prompt: BasePromptTemplate = map_reduce_prompt.EXAMPLE_PROMPT,
@@ -98,10 +103,11 @@ def _load_map_reduce_chain(
     if collapse_prompt is None:
         collapse_chain = None
         if collapse_llm is not None:
-            raise ValueError(
+            msg = (
                 "collapse_llm provided, but collapse_prompt was not: please "
                 "provide one or stop providing collapse_llm."
             )
+            raise ValueError(msg)
     else:
         _collapse_llm = collapse_llm or llm
         collapse_chain = StuffDocumentsChain(
@@ -130,6 +136,7 @@ def _load_map_reduce_chain(
 
 def _load_refine_chain(
     llm: BaseLanguageModel,
+    *,
     question_prompt: BasePromptTemplate = refine_prompts.DEFAULT_TEXT_QA_PROMPT,
     refine_prompt: BasePromptTemplate = refine_prompts.DEFAULT_REFINE_PROMPT,
     document_prompt: BasePromptTemplate = refine_prompts.EXAMPLE_PROMPT,
@@ -162,16 +169,16 @@ def _load_refine_chain(
         "https://python.langchain.com/docs/how_to/qa_sources/"
         "\nSee also the following migration guides for replacements "
         "based on `chain_type`:\n"
-        "stuff: https://python.langchain.com/docs/versions/migrating_chains/stuff_docs_chain\n"  # noqa: E501
-        "map_reduce: https://python.langchain.com/docs/versions/migrating_chains/map_reduce_chain\n"  # noqa: E501
-        "refine: https://python.langchain.com/docs/versions/migrating_chains/refine_chain\n"  # noqa: E501
-        "map_rerank: https://python.langchain.com/docs/versions/migrating_chains/map_rerank_docs_chain\n"  # noqa: E501
+        "stuff: https://python.langchain.com/docs/versions/migrating_chains/stuff_docs_chain\n"
+        "map_reduce: https://python.langchain.com/docs/versions/migrating_chains/map_reduce_chain\n"
+        "refine: https://python.langchain.com/docs/versions/migrating_chains/refine_chain\n"
+        "map_rerank: https://python.langchain.com/docs/versions/migrating_chains/map_rerank_docs_chain\n"
     ),
 )
 def load_qa_with_sources_chain(
     llm: BaseLanguageModel,
     chain_type: str = "stuff",
-    verbose: Optional[bool] = None,
+    verbose: Optional[bool] = None,  # noqa: FBT001
     **kwargs: Any,
 ) -> BaseCombineDocumentsChain:
     """Load a question answering with sources chain.
@@ -193,9 +200,10 @@ def load_qa_with_sources_chain(
         "map_rerank": _load_map_rerank_chain,
     }
     if chain_type not in loader_mapping:
-        raise ValueError(
+        msg = (
             f"Got unsupported chain type: {chain_type}. "
             f"Should be one of {loader_mapping.keys()}"
         )
+        raise ValueError(msg)
     _func: LoadingCallable = loader_mapping[chain_type]
     return _func(llm, verbose=verbose, **kwargs)

langchain/chains/qa_with_sources/map_reduce_prompt.py

@@ -1,16 +1,15 @@
-# flake8: noqa
 from langchain_core.prompts import PromptTemplate
 
-question_prompt_template = """Use the following portion of a long document to see if any of the text is relevant to answer the question. 
+question_prompt_template = """Use the following portion of a long document to see if any of the text is relevant to answer the question.
 Return any relevant text verbatim.
 {context}
 Question: {question}
-Relevant text, if any:"""
+Relevant text, if any:"""  # noqa: E501
 QUESTION_PROMPT = PromptTemplate(
     template=question_prompt_template, input_variables=["context", "question"]
 )
 
-combine_prompt_template = """Given the following extracted parts of a long document and a question, create a final answer with references ("SOURCES"). 
+combine_prompt_template = """Given the following extracted parts of a long document and a question, create a final answer with references ("SOURCES").
 If you don't know the answer, just say that you don't know. Don't try to make up an answer.
 ALWAYS return a "SOURCES" part in your answer.
 
@@ -28,13 +27,13 @@ SOURCES: 28-pl
 
 QUESTION: What did the president say about Michael Jackson?
 =========
-Content: Madam Speaker, Madam Vice President, our First Lady and Second Gentleman. Members of Congress and the Cabinet. Justices of the Supreme Court. My fellow Americans.  \n\nLast year COVID-19 kept us apart. This year we are finally together again. \n\nTonight, we meet as Democrats Republicans and Independents. But most importantly as Americans. \n\nWith a duty to one another to the American people to the Constitution. \n\nAnd with an unwavering resolve that freedom will always triumph over tyranny. \n\nSix days ago, Russia’s Vladimir Putin sought to shake the foundations of the free world thinking he could make it bend to his menacing ways. But he badly miscalculated. \n\nHe thought he could roll into Ukraine and the world would roll over. Instead he met a wall of strength he never imagined. \n\nHe met the Ukrainian people. \n\nFrom President Zelenskyy to every Ukrainian, their fearlessness, their courage, their determination, inspires the world. \n\nGroups of citizens blocking tanks with their bodies. Everyone from students to retirees teachers turned soldiers defending their homeland.
+Content: Madam Speaker, Madam Vice President, our First Lady and Second Gentleman. Members of Congress and the Cabinet. Justices of the Supreme Court. My fellow Americans.  \n\nLast year COVID-19 kept us apart. This year we are finally together again. \n\nTonight, we meet as Democrats Republicans and Independents. But most importantly as Americans. \n\nWith a duty to one another to the American people to the Constitution. \n\nAnd with an unwavering resolve that freedom will always triumph over tyranny. \n\nSix days ago, Russia's Vladimir Putin sought to shake the foundations of the free world thinking he could make it bend to his menacing ways. But he badly miscalculated. \n\nHe thought he could roll into Ukraine and the world would roll over. Instead he met a wall of strength he never imagined. \n\nHe met the Ukrainian people. \n\nFrom President Zelenskyy to every Ukrainian, their fearlessness, their courage, their determination, inspires the world. \n\nGroups of citizens blocking tanks with their bodies. Everyone from students to retirees teachers turned soldiers defending their homeland.
 Source: 0-pl
-Content: And we won’t stop. \n\nWe have lost so much to COVID-19. Time with one another. And worst of all, so much loss of life. \n\nLet’s use this moment to reset. Let’s stop looking at COVID-19 as a partisan dividing line and see it for what it is: A God-awful disease.  \n\nLet’s stop seeing each other as enemies, and start seeing each other for who we really are: Fellow Americans.  \n\nWe can’t change how divided we’ve been. But we can change how we move forward—on COVID-19 and other issues we must face together. \n\nI recently visited the New York City Police Department days after the funerals of Officer Wilbert Mora and his partner, Officer Jason Rivera. \n\nThey were responding to a 9-1-1 call when a man shot and killed them with a stolen gun. \n\nOfficer Mora was 27 years old. \n\nOfficer Rivera was 22. \n\nBoth Dominican Americans who’d grown up on the same streets they later chose to patrol as police officers. \n\nI spoke with their families and told them that we are forever in debt for their sacrifice, and we will carry on their mission to restore the trust and safety every community deserves.
+Content: And we won't stop. \n\nWe have lost so much to COVID-19. Time with one another. And worst of all, so much loss of life. \n\nLet's use this moment to reset. Let's stop looking at COVID-19 as a partisan dividing line and see it for what it is: A God-awful disease.  \n\nLet's stop seeing each other as enemies, and start seeing each other for who we really are: Fellow Americans.  \n\nWe can't change how divided we've been. But we can change how we move forward—on COVID-19 and other issues we must face together. \n\nI recently visited the New York City Police Department days after the funerals of Officer Wilbert Mora and his partner, Officer Jason Rivera. \n\nThey were responding to a 9-1-1 call when a man shot and killed them with a stolen gun. \n\nOfficer Mora was 27 years old. \n\nOfficer Rivera was 22. \n\nBoth Dominican Americans who'd grown up on the same streets they later chose to patrol as police officers. \n\nI spoke with their families and told them that we are forever in debt for their sacrifice, and we will carry on their mission to restore the trust and safety every community deserves.
 Source: 24-pl
-Content: And a proud Ukrainian people, who have known 30 years  of independence, have repeatedly shown that they will not tolerate anyone who tries to take their country backwards.  \n\nTo all Americans, I will be honest with you, as I’ve always promised. A Russian dictator, invading a foreign country, has costs around the world. \n\nAnd I’m taking robust action to make sure the pain of our sanctions  is targeted at Russia’s economy. And I will use every tool at our disposal to protect American businesses and consumers. \n\nTonight, I can announce that the United States has worked with 30 other countries to release 60 Million barrels of oil from reserves around the world.  \n\nAmerica will lead that effort, releasing 30 Million barrels from our own Strategic Petroleum Reserve. And we stand ready to do more if necessary, unified with our allies.  \n\nThese steps will help blunt gas prices here at home. And I know the news about what’s happening can seem alarming. \n\nBut I want you to know that we are going to be okay.
+Content: And a proud Ukrainian people, who have known 30 years  of independence, have repeatedly shown that they will not tolerate anyone who tries to take their country backwards.  \n\nTo all Americans, I will be honest with you, as I've always promised. A Russian dictator, invading a foreign country, has costs around the world. \n\nAnd I'm taking robust action to make sure the pain of our sanctions  is targeted at Russia's economy. And I will use every tool at our disposal to protect American businesses and consumers. \n\nTonight, I can announce that the United States has worked with 30 other countries to release 60 Million barrels of oil from reserves around the world.  \n\nAmerica will lead that effort, releasing 30 Million barrels from our own Strategic Petroleum Reserve. And we stand ready to do more if necessary, unified with our allies.  \n\nThese steps will help blunt gas prices here at home. And I know the news about what's happening can seem alarming. \n\nBut I want you to know that we are going to be okay.
 Source: 5-pl
-Content: More support for patients and families. \n\nTo get there, I call on Congress to fund ARPA-H, the Advanced Research Projects Agency for Health. \n\nIt’s based on DARPA—the Defense Department project that led to the Internet, GPS, and so much more.  \n\nARPA-H will have a singular purpose—to drive breakthroughs in cancer, Alzheimer’s, diabetes, and more. \n\nA unity agenda for the nation. \n\nWe can do this. \n\nMy fellow Americans—tonight , we have gathered in a sacred space—the citadel of our democracy. \n\nIn this Capitol, generation after generation, Americans have debated great questions amid great strife, and have done great things. \n\nWe have fought for freedom, expanded liberty, defeated totalitarianism and terror. \n\nAnd built the strongest, freest, and most prosperous nation the world has ever known. \n\nNow is the hour. \n\nOur moment of responsibility. \n\nOur test of resolve and conscience, of history itself. \n\nIt is in this moment that our character is formed. Our purpose is found. Our future is forged. \n\nWell I know this nation.
+Content: More support for patients and families. \n\nTo get there, I call on Congress to fund ARPA-H, the Advanced Research Projects Agency for Health. \n\nIt's based on DARPA—the Defense Department project that led to the Internet, GPS, and so much more.  \n\nARPA-H will have a singular purpose—to drive breakthroughs in cancer, Alzheimer's, diabetes, and more. \n\nA unity agenda for the nation. \n\nWe can do this. \n\nMy fellow Americans—tonight , we have gathered in a sacred space—the citadel of our democracy. \n\nIn this Capitol, generation after generation, Americans have debated great questions amid great strife, and have done great things. \n\nWe have fought for freedom, expanded liberty, defeated totalitarianism and terror. \n\nAnd built the strongest, freest, and most prosperous nation the world has ever known. \n\nNow is the hour. \n\nOur moment of responsibility. \n\nOur test of resolve and conscience, of history itself. \n\nIt is in this moment that our character is formed. Our purpose is found. Our future is forged. \n\nWell I know this nation.
 Source: 34-pl
 =========
 FINAL ANSWER: The president did not mention Michael Jackson.
@@ -44,7 +43,7 @@ QUESTION: {question}
 =========
 {summaries}
 =========
-FINAL ANSWER:"""
+FINAL ANSWER:"""  # noqa: E501
 COMBINE_PROMPT = PromptTemplate(
     template=combine_prompt_template, input_variables=["summaries", "question"]
 )

langchain/chains/qa_with_sources/refine_prompts.py

@@ -1,4 +1,3 @@
-# flake8: noqa
 from langchain_core.prompts import PromptTemplate
 
 DEFAULT_REFINE_PROMPT_TMPL = (

langchain/chains/qa_with_sources/retrieval.py

@@ -29,10 +29,11 @@ class RetrievalQAWithSourcesChain(BaseQAWithSourcesChain):
         num_docs = len(docs)
 
         if self.reduce_k_below_max_tokens and isinstance(
-            self.combine_documents_chain, StuffDocumentsChain
+            self.combine_documents_chain,
+            StuffDocumentsChain,
         ):
             tokens = [
-                self.combine_documents_chain.llm_chain._get_num_tokens(doc.page_content)
+                self.combine_documents_chain.llm_chain._get_num_tokens(doc.page_content)  # noqa: SLF001
                 for doc in docs
             ]
             token_count = sum(tokens[:num_docs])
@@ -43,20 +44,28 @@ class RetrievalQAWithSourcesChain(BaseQAWithSourcesChain):
         return docs[:num_docs]
 
     def _get_docs(
-        self, inputs: dict[str, Any], *, run_manager: CallbackManagerForChainRun
+        self,
+        inputs: dict[str, Any],
+        *,
+        run_manager: CallbackManagerForChainRun,
     ) -> list[Document]:
         question = inputs[self.question_key]
         docs = self.retriever.invoke(
-            question, config={"callbacks": run_manager.get_child()}
+            question,
+            config={"callbacks": run_manager.get_child()},
         )
         return self._reduce_tokens_below_limit(docs)
 
     async def _aget_docs(
-        self, inputs: dict[str, Any], *, run_manager: AsyncCallbackManagerForChainRun
+        self,
+        inputs: dict[str, Any],
+        *,
+        run_manager: AsyncCallbackManagerForChainRun,
     ) -> list[Document]:
         question = inputs[self.question_key]
         docs = await self.retriever.ainvoke(
-            question, config={"callbacks": run_manager.get_child()}
+            question,
+            config={"callbacks": run_manager.get_child()},
         )
         return self._reduce_tokens_below_limit(docs)
 

langchain/chains/qa_with_sources/stuff_prompt.py

@@ -1,7 +1,6 @@
-# flake8: noqa
 from langchain_core.prompts import PromptTemplate
 
-template = """Given the following extracted parts of a long document and a question, create a final answer with references ("SOURCES"). 
+template = """Given the following extracted parts of a long document and a question, create a final answer with references ("SOURCES").
 If you don't know the answer, just say that you don't know. Don't try to make up an answer.
 ALWAYS return a "SOURCES" part in your answer.
 
@@ -19,13 +18,13 @@ SOURCES: 28-pl
 
 QUESTION: What did the president say about Michael Jackson?
 =========
-Content: Madam Speaker, Madam Vice President, our First Lady and Second Gentleman. Members of Congress and the Cabinet. Justices of the Supreme Court. My fellow Americans.  \n\nLast year COVID-19 kept us apart. This year we are finally together again. \n\nTonight, we meet as Democrats Republicans and Independents. But most importantly as Americans. \n\nWith a duty to one another to the American people to the Constitution. \n\nAnd with an unwavering resolve that freedom will always triumph over tyranny. \n\nSix days ago, Russia’s Vladimir Putin sought to shake the foundations of the free world thinking he could make it bend to his menacing ways. But he badly miscalculated. \n\nHe thought he could roll into Ukraine and the world would roll over. Instead he met a wall of strength he never imagined. \n\nHe met the Ukrainian people. \n\nFrom President Zelenskyy to every Ukrainian, their fearlessness, their courage, their determination, inspires the world. \n\nGroups of citizens blocking tanks with their bodies. Everyone from students to retirees teachers turned soldiers defending their homeland.
+Content: Madam Speaker, Madam Vice President, our First Lady and Second Gentleman. Members of Congress and the Cabinet. Justices of the Supreme Court. My fellow Americans.  \n\nLast year COVID-19 kept us apart. This year we are finally together again. \n\nTonight, we meet as Democrats Republicans and Independents. But most importantly as Americans. \n\nWith a duty to one another to the American people to the Constitution. \n\nAnd with an unwavering resolve that freedom will always triumph over tyranny. \n\nSix days ago, Russia's Vladimir Putin sought to shake the foundations of the free world thinking he could make it bend to his menacing ways. But he badly miscalculated. \n\nHe thought he could roll into Ukraine and the world would roll over. Instead he met a wall of strength he never imagined. \n\nHe met the Ukrainian people. \n\nFrom President Zelenskyy to every Ukrainian, their fearlessness, their courage, their determination, inspires the world. \n\nGroups of citizens blocking tanks with their bodies. Everyone from students to retirees teachers turned soldiers defending their homeland.
 Source: 0-pl
-Content: And we won’t stop. \n\nWe have lost so much to COVID-19. Time with one another. And worst of all, so much loss of life. \n\nLet’s use this moment to reset. Let’s stop looking at COVID-19 as a partisan dividing line and see it for what it is: A God-awful disease.  \n\nLet’s stop seeing each other as enemies, and start seeing each other for who we really are: Fellow Americans.  \n\nWe can’t change how divided we’ve been. But we can change how we move forward—on COVID-19 and other issues we must face together. \n\nI recently visited the New York City Police Department days after the funerals of Officer Wilbert Mora and his partner, Officer Jason Rivera. \n\nThey were responding to a 9-1-1 call when a man shot and killed them with a stolen gun. \n\nOfficer Mora was 27 years old. \n\nOfficer Rivera was 22. \n\nBoth Dominican Americans who’d grown up on the same streets they later chose to patrol as police officers. \n\nI spoke with their families and told them that we are forever in debt for their sacrifice, and we will carry on their mission to restore the trust and safety every community deserves.
+Content: And we won't stop. \n\nWe have lost so much to COVID-19. Time with one another. And worst of all, so much loss of life. \n\nLet's use this moment to reset. Let's stop looking at COVID-19 as a partisan dividing line and see it for what it is: A God-awful disease.  \n\nLet's stop seeing each other as enemies, and start seeing each other for who we really are: Fellow Americans.  \n\nWe can't change how divided we've been. But we can change how we move forward—on COVID-19 and other issues we must face together. \n\nI recently visited the New York City Police Department days after the funerals of Officer Wilbert Mora and his partner, Officer Jason Rivera. \n\nThey were responding to a 9-1-1 call when a man shot and killed them with a stolen gun. \n\nOfficer Mora was 27 years old. \n\nOfficer Rivera was 22. \n\nBoth Dominican Americans who'd grown up on the same streets they later chose to patrol as police officers. \n\nI spoke with their families and told them that we are forever in debt for their sacrifice, and we will carry on their mission to restore the trust and safety every community deserves.
 Source: 24-pl
-Content: And a proud Ukrainian people, who have known 30 years  of independence, have repeatedly shown that they will not tolerate anyone who tries to take their country backwards.  \n\nTo all Americans, I will be honest with you, as I’ve always promised. A Russian dictator, invading a foreign country, has costs around the world. \n\nAnd I’m taking robust action to make sure the pain of our sanctions  is targeted at Russia’s economy. And I will use every tool at our disposal to protect American businesses and consumers. \n\nTonight, I can announce that the United States has worked with 30 other countries to release 60 Million barrels of oil from reserves around the world.  \n\nAmerica will lead that effort, releasing 30 Million barrels from our own Strategic Petroleum Reserve. And we stand ready to do more if necessary, unified with our allies.  \n\nThese steps will help blunt gas prices here at home. And I know the news about what’s happening can seem alarming. \n\nBut I want you to know that we are going to be okay.
+Content: And a proud Ukrainian people, who have known 30 years  of independence, have repeatedly shown that they will not tolerate anyone who tries to take their country backwards.  \n\nTo all Americans, I will be honest with you, as I've always promised. A Russian dictator, invading a foreign country, has costs around the world. \n\nAnd I'm taking robust action to make sure the pain of our sanctions  is targeted at Russia's economy. And I will use every tool at our disposal to protect American businesses and consumers. \n\nTonight, I can announce that the United States has worked with 30 other countries to release 60 Million barrels of oil from reserves around the world.  \n\nAmerica will lead that effort, releasing 30 Million barrels from our own Strategic Petroleum Reserve. And we stand ready to do more if necessary, unified with our allies.  \n\nThese steps will help blunt gas prices here at home. And I know the news about what's happening can seem alarming. \n\nBut I want you to know that we are going to be okay.
 Source: 5-pl
-Content: More support for patients and families. \n\nTo get there, I call on Congress to fund ARPA-H, the Advanced Research Projects Agency for Health. \n\nIt’s based on DARPA—the Defense Department project that led to the Internet, GPS, and so much more.  \n\nARPA-H will have a singular purpose—to drive breakthroughs in cancer, Alzheimer’s, diabetes, and more. \n\nA unity agenda for the nation. \n\nWe can do this. \n\nMy fellow Americans—tonight , we have gathered in a sacred space—the citadel of our democracy. \n\nIn this Capitol, generation after generation, Americans have debated great questions amid great strife, and have done great things. \n\nWe have fought for freedom, expanded liberty, defeated totalitarianism and terror. \n\nAnd built the strongest, freest, and most prosperous nation the world has ever known. \n\nNow is the hour. \n\nOur moment of responsibility. \n\nOur test of resolve and conscience, of history itself. \n\nIt is in this moment that our character is formed. Our purpose is found. Our future is forged. \n\nWell I know this nation.
+Content: More support for patients and families. \n\nTo get there, I call on Congress to fund ARPA-H, the Advanced Research Projects Agency for Health. \n\nIt's based on DARPA—the Defense Department project that led to the Internet, GPS, and so much more.  \n\nARPA-H will have a singular purpose—to drive breakthroughs in cancer, Alzheimer's, diabetes, and more. \n\nA unity agenda for the nation. \n\nWe can do this. \n\nMy fellow Americans—tonight , we have gathered in a sacred space—the citadel of our democracy. \n\nIn this Capitol, generation after generation, Americans have debated great questions amid great strife, and have done great things. \n\nWe have fought for freedom, expanded liberty, defeated totalitarianism and terror. \n\nAnd built the strongest, freest, and most prosperous nation the world has ever known. \n\nNow is the hour. \n\nOur moment of responsibility. \n\nOur test of resolve and conscience, of history itself. \n\nIt is in this moment that our character is formed. Our purpose is found. Our future is forged. \n\nWell I know this nation.
 Source: 34-pl
 =========
 FINAL ANSWER: The president did not mention Michael Jackson.
@@ -35,7 +34,7 @@ QUESTION: {question}
 =========
 {summaries}
 =========
-FINAL ANSWER:"""
+FINAL ANSWER:"""  # noqa: E501
 PROMPT = PromptTemplate(template=template, input_variables=["summaries", "question"])
 
 EXAMPLE_PROMPT = PromptTemplate(

langchain/chains/qa_with_sources/vector_db.py

@@ -10,6 +10,7 @@ from langchain_core.callbacks import (
 from langchain_core.documents import Document
 from langchain_core.vectorstores import VectorStore
 from pydantic import Field, model_validator
+from typing_extensions import override
 
 from langchain.chains.combine_documents.stuff import StuffDocumentsChain
 from langchain.chains.qa_with_sources.base import BaseQAWithSourcesChain
@@ -34,10 +35,11 @@ class VectorDBQAWithSourcesChain(BaseQAWithSourcesChain):
         num_docs = len(docs)
 
         if self.reduce_k_below_max_tokens and isinstance(
-            self.combine_documents_chain, StuffDocumentsChain
+            self.combine_documents_chain,
+            StuffDocumentsChain,
         ):
             tokens = [
-                self.combine_documents_chain.llm_chain._get_num_tokens(doc.page_content)
+                self.combine_documents_chain.llm_chain._get_num_tokens(doc.page_content)  # noqa: SLF001
                 for doc in docs
             ]
             token_count = sum(tokens[:num_docs])
@@ -47,26 +49,37 @@ class VectorDBQAWithSourcesChain(BaseQAWithSourcesChain):
 
         return docs[:num_docs]
 
+    @override
     def _get_docs(
-        self, inputs: dict[str, Any], *, run_manager: CallbackManagerForChainRun
+        self,
+        inputs: dict[str, Any],
+        *,
+        run_manager: CallbackManagerForChainRun,
     ) -> list[Document]:
         question = inputs[self.question_key]
         docs = self.vectorstore.similarity_search(
-            question, k=self.k, **self.search_kwargs
+            question,
+            k=self.k,
+            **self.search_kwargs,
         )
         return self._reduce_tokens_below_limit(docs)
 
     async def _aget_docs(
-        self, inputs: dict[str, Any], *, run_manager: AsyncCallbackManagerForChainRun
+        self,
+        inputs: dict[str, Any],
+        *,
+        run_manager: AsyncCallbackManagerForChainRun,
     ) -> list[Document]:
-        raise NotImplementedError("VectorDBQAWithSourcesChain does not support async")
+        msg = "VectorDBQAWithSourcesChain does not support async"
+        raise NotImplementedError(msg)
 
     @model_validator(mode="before")
     @classmethod
-    def raise_deprecation(cls, values: dict) -> Any:
+    def _raise_deprecation(cls, values: dict) -> Any:
         warnings.warn(
             "`VectorDBQAWithSourcesChain` is deprecated - "
-            "please use `from langchain.chains import RetrievalQAWithSourcesChain`"
+            "please use `from langchain.chains import RetrievalQAWithSourcesChain`",
+            stacklevel=5,
         )
         return values
 

langchain/chains/query_constructor/base.py

@@ -22,6 +22,7 @@ from langchain_core.structured_query import (
     Operator,
     StructuredQuery,
 )
+from typing_extensions import override
 
 from langchain.chains.llm import LLMChain
 from langchain.chains.query_constructor.parser import get_parser
@@ -46,6 +47,7 @@ class StructuredQueryOutputParser(BaseOutputParser[StructuredQuery]):
     ast_parse: Callable
     """Callable that parses dict into internal representation of query language."""
 
+    @override
     def parse(self, text: str) -> StructuredQuery:
         try:
             expected_keys = ["query", "filter"]
@@ -60,12 +62,11 @@ class StructuredQueryOutputParser(BaseOutputParser[StructuredQuery]):
             if not parsed.get("limit"):
                 parsed.pop("limit", None)
             return StructuredQuery(
-                **{k: v for k, v in parsed.items() if k in allowed_keys}
+                **{k: v for k, v in parsed.items() if k in allowed_keys},
             )
         except Exception as e:
-            raise OutputParserException(
-                f"Parsing text\n{text}\n raised following error:\n{e}"
-            )
+            msg = f"Parsing text\n{text}\n raised following error:\n{e}"
+            raise OutputParserException(msg) from e
 
     @classmethod
     def from_components(
@@ -73,7 +74,7 @@ class StructuredQueryOutputParser(BaseOutputParser[StructuredQuery]):
         allowed_comparators: Optional[Sequence[Comparator]] = None,
         allowed_operators: Optional[Sequence[Operator]] = None,
         allowed_attributes: Optional[Sequence[str]] = None,
-        fix_invalid: bool = False,
+        fix_invalid: bool = False,  # noqa: FBT001,FBT002
     ) -> StructuredQueryOutputParser:
         """
         Create a structured query output parser from components.
@@ -89,14 +90,16 @@ class StructuredQueryOutputParser(BaseOutputParser[StructuredQuery]):
         if fix_invalid:
 
             def ast_parse(raw_filter: str) -> Optional[FilterDirective]:
-                filter = cast(Optional[FilterDirective], get_parser().parse(raw_filter))
-                fixed = fix_filter_directive(
-                    filter,
+                filter_directive = cast(
+                    "Optional[FilterDirective]",
+                    get_parser().parse(raw_filter),
+                )
+                return fix_filter_directive(
+                    filter_directive,
                     allowed_comparators=allowed_comparators,
                     allowed_operators=allowed_operators,
                     allowed_attributes=allowed_attributes,
                 )
-                return fixed
 
         else:
             ast_parse = get_parser(
@@ -108,7 +111,7 @@ class StructuredQueryOutputParser(BaseOutputParser[StructuredQuery]):
 
 
 def fix_filter_directive(
-    filter: Optional[FilterDirective],
+    filter: Optional[FilterDirective],  # noqa: A002
     *,
     allowed_comparators: Optional[Sequence[Comparator]] = None,
     allowed_operators: Optional[Sequence[Operator]] = None,
@@ -130,18 +133,18 @@ def fix_filter_directive(
     ) or not filter:
         return filter
 
-    elif isinstance(filter, Comparison):
+    if isinstance(filter, Comparison):
         if allowed_comparators and filter.comparator not in allowed_comparators:
             return None
         if allowed_attributes and filter.attribute not in allowed_attributes:
             return None
         return filter
-    elif isinstance(filter, Operation):
+    if isinstance(filter, Operation):
         if allowed_operators and filter.operator not in allowed_operators:
             return None
         args = [
             cast(
-                FilterDirective,
+                "FilterDirective",
                 fix_filter_directive(
                     arg,
                     allowed_comparators=allowed_comparators,
@@ -154,15 +157,13 @@ def fix_filter_directive(
         ]
         if not args:
             return None
-        elif len(args) == 1 and filter.operator in (Operator.AND, Operator.OR):
+        if len(args) == 1 and filter.operator in (Operator.AND, Operator.OR):
             return args[0]
-        else:
-            return Operation(
-                operator=filter.operator,
-                arguments=args,
-            )
-    else:
-        return filter
+        return Operation(
+            operator=filter.operator,
+            arguments=args,
+        )
+    return filter
 
 
 def _format_attribute_info(info: Sequence[Union[AttributeInfo, dict]]) -> str:
@@ -237,7 +238,9 @@ def get_query_constructor_prompt(
         examples = construct_examples(examples)
         example_prompt = USER_SPECIFIED_EXAMPLE_PROMPT
         prefix = PREFIX_WITH_DATA_SOURCE.format(
-            schema=schema, content=document_contents, attributes=attribute_str
+            schema=schema,
+            content=document_contents,
+            attributes=attribute_str,
         )
         suffix = SUFFIX_WITHOUT_DATA_SOURCE.format(i=len(examples) + 1)
     else:
@@ -247,7 +250,9 @@ def get_query_constructor_prompt(
         example_prompt = EXAMPLE_PROMPT
         prefix = DEFAULT_PREFIX.format(schema=schema)
         suffix = DEFAULT_SUFFIX.format(
-            i=len(examples) + 1, content=document_contents, attributes=attribute_str
+            i=len(examples) + 1,
+            content=document_contents,
+            attributes=attribute_str,
         )
     return FewShotPromptTemplate(
         examples=list(examples),
@@ -271,7 +276,7 @@ def load_query_constructor_chain(
     examples: Optional[list] = None,
     allowed_comparators: Sequence[Comparator] = tuple(Comparator),
     allowed_operators: Sequence[Operator] = tuple(Operator),
-    enable_limit: bool = False,
+    enable_limit: bool = False,  # noqa: FBT001,FBT002
     schema_prompt: Optional[BasePromptTemplate] = None,
     **kwargs: Any,
 ) -> LLMChain:
@@ -302,11 +307,10 @@ def load_query_constructor_chain(
         enable_limit=enable_limit,
         schema_prompt=schema_prompt,
     )
-    allowed_attributes = []
-    for ainfo in attribute_info:
-        allowed_attributes.append(
-            ainfo.name if isinstance(ainfo, AttributeInfo) else ainfo["name"]
-        )
+    allowed_attributes = [
+        ainfo.name if isinstance(ainfo, AttributeInfo) else ainfo["name"]
+        for ainfo in attribute_info
+    ]
     output_parser = StructuredQueryOutputParser.from_components(
         allowed_comparators=allowed_comparators,
         allowed_operators=allowed_operators,
@@ -361,11 +365,10 @@ def load_query_constructor_runnable(
         schema_prompt=schema_prompt,
         **kwargs,
     )
-    allowed_attributes = []
-    for ainfo in attribute_info:
-        allowed_attributes.append(
-            ainfo.name if isinstance(ainfo, AttributeInfo) else ainfo["name"]
-        )
+    allowed_attributes = [
+        ainfo.name if isinstance(ainfo, AttributeInfo) else ainfo["name"]
+        for ainfo in attribute_info
+    ]
     output_parser = StructuredQueryOutputParser.from_components(
         allowed_comparators=allowed_comparators,
         allowed_operators=allowed_operators,

langchain/chains/query_constructor/ir.py

@@ -12,12 +12,12 @@ from langchain_core.structured_query import (
 )
 
 __all__ = [
-    "Visitor",
-    "Expr",
-    "Operator",
     "Comparator",
-    "FilterDirective",
     "Comparison",
+    "Expr",
+    "FilterDirective",
     "Operation",
+    "Operator",
     "StructuredQuery",
+    "Visitor",
 ]