langroid 0.1.249__py3-none-any.whl → 0.1.250__py3-none-any.whl

langroid/agent/special/doc_chat_agent.py

@@ -14,7 +14,6 @@ pip install "langroid[hf-embeddings]"
 """
 
 import logging
-import re
 from functools import cache
 from typing import Any, Dict, List, Optional, Set, Tuple, no_type_check
 
@@ -31,6 +30,7 @@ from langroid.agent.special.relevance_extractor_agent import (
     RelevanceExtractorAgentConfig,
 )
 from langroid.agent.task import Task
+from langroid.agent.tools.retrieval_tool import RetrievalTool
 from langroid.embedding_models.models import OpenAIEmbeddingsConfig
 from langroid.language_models.base import StreamingIfAllowed
 from langroid.language_models.openai_gpt import OpenAIChatModel, OpenAIGPTConfig
@@ -82,21 +82,47 @@ except ImportError:
     pass
 
 
-def extract_citations(text: str) -> List[int]:
-    # Find all patterns that match [[<numbers>]]
-    matches = re.findall(r"\[\[([\d,]+)\]\]", text)
+def extract_markdown_references(md_string: str) -> list[int]:
+    """
+    Extracts markdown references (e.g., [^1], [^2]) from a string and returns
+    them as a sorted list of integers.
+
+    Args:
+        md_string (str): The markdown string containing references.
+
+    Returns:
+        list[int]: A sorted list of unique integers from the markdown references.
+    """
+    import re
+
+    # Regex to find all occurrences of [^<number>]
+    matches = re.findall(r"\[\^(\d+)\]", md_string)
+    # Convert matches to integers, remove duplicates with set, and sort
+    return sorted(set(int(match) for match in matches))
 
-    # Initialize a set to hold distinct citation numbers
-    citations: Set[int] = set()
 
-    # Process each match
-    for match in matches:
-        # Split numbers by comma and convert to integers
-        numbers = match.split(",")
-        citations.update(int(number) for number in numbers)
+def format_footnote_text(content: str, width: int = 80) -> str:
+    """
+    Formats the content part of a footnote (i.e. not the first line that
+    appears right after the reference [^4])
+    It wraps the text so that no line is longer than the specified width and indents
+    lines as necessary for markdown footnotes.
+
+    Args:
+        content (str): The text of the footnote to be formatted.
+        width (int): Maximum width of the text lines.
 
-    # Return a sorted list of unique citations
-    return sorted(citations)
+    Returns:
+        str: Properly formatted markdown footnote text.
+    """
+    import textwrap
+
+    # Wrap the text to the specified width
+    wrapped_lines = textwrap.wrap(content, width)
+    if len(wrapped_lines) == 0:
+        return ""
+    indent = "    "  # Indentation for markdown footnotes
+    return indent + ("\n" + indent).join(wrapped_lines)
 
 
 class DocChatAgentConfig(ChatAgentConfig):
@@ -438,6 +464,13 @@ class DocChatAgent(ChatAgent):
         self.setup_documents(docs, filter=self.config.filter)
         return len(docs)
 
+    def retrieval_tool(self, msg: RetrievalTool) -> str:
+        """Handle the RetrievalTool message"""
+        self.config.retrieve_only = True
+        self.config.parsing.n_similar_docs = msg.num_results
+        content_doc = self.answer_from_docs(msg.query)
+        return content_doc.content
+
     @staticmethod
     def document_compatible_dataframe(
         df: pd.DataFrame,
@@ -808,14 +841,15 @@ class DocChatAgent(ChatAgent):
         final_answer = answer_doc.content.strip()
         show_if_debug(final_answer, "SUMMARIZE_RESPONSE= ")
 
-        citations = extract_citations(final_answer)
+        citations = extract_markdown_references(final_answer)
 
         citations_str = ""
         if len(citations) > 0:
             # append [i] source, content for each citation
             citations_str = "\n".join(
                 [
-                    f"[{c}] {passages[c-1].metadata.source}\n{passages[c-1].content}"
+                    f"[^{c}] {passages[c-1].metadata.source}"
+                    f"\n{format_footnote_text(passages[c-1].content)}"
                     for c in citations
                 ]
             )

langroid/agent/tools/retrieval_tool.py

@@ -0,0 +1,29 @@
+from typing import List
+
+from langroid.agent.tool_message import ToolMessage
+
+
+class RetrievalTool(ToolMessage):
+    """Retrieval tool, only to be used by a DocChatAgent."""
+
+    request: str = "retrieval_tool"
+    purpose: str = """
+            To retrieve up to <num_results> passages from a document-set, that are 
+            relevant to a <query>, which could be a question or simply a topic or 
+            search phrase. 
+            """
+    query: str
+    num_results: int
+
+    @classmethod
+    def examples(cls) -> List["ToolMessage"]:
+        return [
+            cls(
+                query="What are the eligibility criteria for the scholarship?",
+                num_results=3,
+            ),
+            cls(
+                query="Self-Attention mechanism in RNNs",
+                num_results=5,
+            ),
+        ]

langroid/prompts/templates.py

@@ -55,13 +55,14 @@ SUMMARY_ANSWER_PROMPT_GPT4 = f"""
         information in these extracts, even if your answer is factually incorrect, 
         and even if the answer contradicts other parts of the document. The only 
         important thing is that your answer is consistent with and supported by the 
-        extracts. Compose your complete answer, inserting CITATIONS 
-        in the format [[i,j,...]] where i,j,... are the extract NUMBERS you are citing.
+        extracts. Compose your complete answer, inserting CITATIONS in MARKDOWN format
+        [^i][^j] where i,j,... are the extract NUMBERS you are 
+        citing.
         For example your answer might look like this (NOTE HOW multiple citations
-        are grouped as [[2,5]]):
+        are grouped as [^2][^5]):
         
-        Beethoven composed the 9th symphony in 1824. [[1]] After that he became deaf
-        and could not hear his own music. [[2,5]] He was a prolific composer and
+        Beethoven composed the 9th symphony in 1824.[^1] After that he became deaf
+        and could not hear his own music. [^2][^5]. He was a prolific composer and
         wrote many famous pieces.
         
         NUMBERED EXTRACTS:

{langroid-0.1.249.dist-info → langroid-0.1.250.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: langroid
-Version: 0.1.249
+Version: 0.1.250
 Summary: Harness LLMs with Multi-Agent Programming
 License: MIT
 Author: Prasad Chalasani
@@ -237,6 +237,8 @@ teacher_task.run()
 <summary> <b>Click to expand</b></summary>
 
 - **May 2024:** 
+  - [Much-Improved Citation](https://github.com/langroid/langroid/issues/477) 
+    generation and display when using `DocChatAgent`.
   - `gpt-4o` is now the default LLM throughout; Update tests and examples to work 
     with this LLM; use tokenizer corresponding to the LLM.
   - `gemini 1.5 pro` support via `litellm`

{langroid-0.1.249.dist-info → langroid-0.1.250.dist-info}/RECORD

@@ -10,7 +10,7 @@ langroid/agent/helpers.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 langroid/agent/junk,sha256=LxfuuW7Cijsg0szAzT81OjWWv1PMNI-6w_-DspVIO2s,339
 langroid/agent/openai_assistant.py,sha256=kIVDI4r-xGvplLU5s0nShPVHs6Jq-wOsfWE0kcMhAdQ,33056
 langroid/agent/special/__init__.py,sha256=NG0JkB5y4K0bgnd9Q9UIvFExun3uTfVOWEVLVymff1M,1207
-langroid/agent/special/doc_chat_agent.py,sha256=SBatLDoa2_Ju_Gk_El8FmlMekgHmgpBU1ihx26yFIvc,54008
+langroid/agent/special/doc_chat_agent.py,sha256=MTUrUyCZ7_wksTo11AwSTHMOKZf1WX-cAJowi_sfT2o,55320
 langroid/agent/special/lance_doc_chat_agent.py,sha256=USp0U3eTaJzwF_3bdqE7CedSLbaqAi2tm-VzygcyLaA,10175
 langroid/agent/special/lance_rag/__init__.py,sha256=QTbs0IVE2ZgDg8JJy1zN97rUUg4uEPH7SLGctFNumk4,174
 langroid/agent/special/lance_rag/critic_agent.py,sha256=OsOcpcU_AmU2MagpZ5X5yxFeXyteKN9QJMzJGqIITig,6871
@@ -41,6 +41,7 @@ langroid/agent/tools/generator_tool.py,sha256=y0fB0ZObjA0b3L0uSTtrqRCKHDUR95arBf
 langroid/agent/tools/google_search_tool.py,sha256=cQxcNtb8XCNpOo_yCeYRwG_y-OATjPgkbr01kea9qWE,1421
 langroid/agent/tools/metaphor_search_tool.py,sha256=NKHss-AkI942_XhfMgUctAwHjIHpqp5NfYIebKV4UcE,2454
 langroid/agent/tools/recipient_tool.py,sha256=61vdKv06qgVdtnE3gxjzV8RvUEy8JhbC9eWa0J0BPdw,9171
+langroid/agent/tools/retrieval_tool.py,sha256=6uvRNg-kG_ItPa3sF9NWkthQ5frHn8bkB1Z3GSd3Oas,836
 langroid/agent/tools/run_python_code.py,sha256=V3mHdHQYn0M0PAtyoHxjNvk6KvWWcQ4ugo0TOKc8HyI,1752
 langroid/agent/tools/segment_extract_tool.py,sha256=W39poS7Av2EuJ34tGKhLhzgj3zEyZnBplpSt2goRAp4,1285
 langroid/agent_config.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -93,7 +94,7 @@ langroid/prompts/__init__.py,sha256=B0vpJzIJlMR3mFRtoQwyALsFzBHvLp9f92acD8xJA_0,
 langroid/prompts/chat-gpt4-system-prompt.md,sha256=Q3uLCJTPQvmUkZN2XDnkBC7M2K3X0F3C3GIQBaFvYvw,5329
 langroid/prompts/dialog.py,sha256=SpfiSyofSgy2pwD1YboHR_yHO3LEEMbv6j2sm874jKo,331
 langroid/prompts/prompts_config.py,sha256=XRQHzod7KBnoKn3B_V878jZiqBA7rcn-CtGPkuAe_yM,131
-langroid/prompts/templates.py,sha256=NxMyPIhDjmL3pNXBaNLrIsebETPQHr6VG5NWO_93NeA,6303
+langroid/prompts/templates.py,sha256=kz0rPiM6iLGhhpDonF3Y87OznSe9FRI6A0pHU0wgW4Q,6314
 langroid/prompts/transforms.py,sha256=GsQo1klGxUy0fACh6j0lTblk6XEl2erRnhRWlN2M4-c,2706
 langroid/utils/__init__.py,sha256=ARx5To4Hsv1K5QAzK4uUqdEoB_iq5HK797vae1AcMBI,300
 langroid/utils/algorithms/__init__.py,sha256=WylYoZymA0fnzpB4vrsH_0n7WsoLhmuZq8qxsOCjUpM,41
@@ -121,7 +122,7 @@ langroid/vector_store/meilisearch.py,sha256=d2huA9P-NoYRuAQ9ZeXJmMKr7ry8u90RUSR2
 langroid/vector_store/momento.py,sha256=9cui31TTrILid2KIzUpBkN2Ey3g_CZWOQVdaFsA4Ors,10045
 langroid/vector_store/qdrant_cloud.py,sha256=3im4Mip0QXLkR6wiqVsjV1QvhSElfxdFSuDKddBDQ-4,188
 langroid/vector_store/qdrantdb.py,sha256=sk5Qb2ZNbooi0rorsMuqIMokF7WADw6PJ0D6goM2XBw,16802
-langroid-0.1.249.dist-info/LICENSE,sha256=EgVbvA6VSYgUlvC3RvPKehSg7MFaxWDsFuzLOsPPfJg,1065
-langroid-0.1.249.dist-info/METADATA,sha256=1md_MzQhAHs9J7_OEEOfiL8C4N8GlWj5BBQGK4HrkGw,49426
-langroid-0.1.249.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
-langroid-0.1.249.dist-info/RECORD,,
+langroid-0.1.250.dist-info/LICENSE,sha256=EgVbvA6VSYgUlvC3RvPKehSg7MFaxWDsFuzLOsPPfJg,1065
+langroid-0.1.250.dist-info/METADATA,sha256=FOv0qbbaZxR3TJWncDj2NvvslRp7RXOI0Xahb4yBT3I,49559
+langroid-0.1.250.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
+langroid-0.1.250.dist-info/RECORD,,