langroid 0.39.2__py3-none-any.whl → 0.39.4__py3-none-any.whl

langroid/agent/special/doc_chat_agent.py

@@ -58,7 +58,7 @@ from langroid.utils.object_registry import ObjectRegistry
 from langroid.utils.output import show_if_debug, status
 from langroid.utils.output.citations import (
     extract_markdown_references,
-    format_footnote_text,
+    format_cited_references,
 )
 from langroid.utils.pydantic_utils import dataframe_to_documents, extract_fields
 from langroid.vector_store.base import VectorStore, VectorStoreConfig
@@ -859,18 +859,10 @@ class DocChatAgent(ChatAgent):
         final_answer = answer_doc.content.strip()
         show_if_debug(final_answer, "SUMMARIZE_RESPONSE= ")
 
+        # extract references like [^2], [^3], etc. from the 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}"
-                    f"\n{format_footnote_text(passages[c-1].content)}"
-                    for c in citations
-                ]
-            )
+        # format the cited references as a string suitable for markdown footnote
+        citations_str = format_cited_references(citations, passages)
 
         return ChatDocument(
             content=final_answer,  # does not contain citations

langroid/language_models/model_info.py

@@ -54,6 +54,7 @@ class DeepSeekModel(ModelName):
 
     DEEPSEEK = "deepseek/deepseek-chat"
     DEEPSEEK_R1 = "deepseek/deepseek-reasoner"
+    OPENROUTER_DEEPSEEK_R1 = "openrouter/deepseek/deepseek-r1"
 
 
 class GeminiModel(ModelName):
@@ -66,6 +67,23 @@ class GeminiModel(ModelName):
     GEMINI_2_FLASH_THINKING = "gemini/gemini-2.0-flash-thinking-exp"
 
 
+class OpenAI_API_ParamInfo(BaseModel):
+    """
+    Parameters exclusive to some models, when using OpenAI API
+    """
+
+    params: Dict[str, List[str]] = dict(
+        reasoning_effort=[
+            OpenAIChatModel.O3_MINI.value,
+        ],
+    )
+    extra_parameters: Dict[str, List[str]] = dict(
+        include_reasoning=[
+            DeepSeekModel.OPENROUTER_DEEPSEEK_R1.value,
+        ]
+    )
+
+
 class ModelInfo(BaseModel):
     """
     Consolidated information about LLM, related to capacity, cost and API

langroid/language_models/openai_gpt.py

@@ -49,6 +49,7 @@ from langroid.language_models.config import HFPromptFormatterConfig
 from langroid.language_models.model_info import (
     DeepSeekModel,
     GeminiModel,
+    OpenAI_API_ParamInfo,
     get_model_info,
 )
 from langroid.language_models.model_info import (
@@ -203,6 +204,7 @@ class OpenAICallParams(BaseModel):
     stop: str | List[str] | None = None  # (list of) stop sequence(s)
     seed: int | None = 42
     user: str | None = None  # user id for tracking
+    extra_body: Dict[str, Any] | None = None  # additional params for API request body
 
     def to_dict_exclude_none(self) -> Dict[str, Any]:
         return {k: v for k, v in self.dict().items() if v is not None}
@@ -642,7 +644,15 @@ class OpenAIGPT(LanguageModel):
         """
         List of params that are not supported by the current model
         """
-        return get_model_info(self.config.chat_model).unsupported_params
+        model_info = get_model_info(self.config.chat_model)
+        unsupported = set(model_info.unsupported_params)
+        for param, model_list in OpenAI_API_ParamInfo().params.items():
+            if (
+                self.config.chat_model not in model_list
+                and self.chat_model_orig not in model_list
+            ):
+                unsupported.add(param)
+        return list(unsupported)
 
     def rename_params(self) -> Dict[str, str]:
         """
@@ -739,7 +749,10 @@ class OpenAIGPT(LanguageModel):
             delta = choices[0].get("delta", {})
             # capture both content and reasoning_content
             event_text = delta.get("content", "")
-            event_reasoning = delta.get("reasoning_content", "")
+            event_reasoning = delta.get(
+                "reasoning_content",
+                delta.get("reasoning", ""),
+            )
             if "function_call" in delta and delta["function_call"] is not None:
                 if "name" in delta["function_call"]:
                     event_fn_name = delta["function_call"]["name"]
@@ -861,7 +874,10 @@ class OpenAIGPT(LanguageModel):
         if chat:
             delta = choices[0].get("delta", {})
             event_text = delta.get("content", "")
-            event_reasoning = delta.get("reasoning_content", "")
+            event_reasoning = delta.get(
+                "reasoning_content",
+                delta.get("reasoning", ""),
+            )
             if "function_call" in delta and delta["function_call"] is not None:
                 if "name" in delta["function_call"]:
                     event_fn_name = delta["function_call"]["name"]
@@ -1757,6 +1773,18 @@ class OpenAIGPT(LanguageModel):
         for old_param, new_param in param_rename_map.items():
             if old_param in args:
                 args[new_param] = args.pop(old_param)
+
+        # finally, get rid of extra_body params exclusive to certain models
+        extra_params = args.get("extra_body", {})
+        if extra_params:
+            for param, model_list in OpenAI_API_ParamInfo().extra_parameters.items():
+                if (
+                    self.config.chat_model not in model_list
+                    and self.chat_model_orig not in model_list
+                ):
+                    extra_params.pop(param, None)
+            if extra_params:
+                args["extra_body"] = extra_params
         return args
 
     def _process_chat_completion_response(

langroid/parsing/urls.py

@@ -221,10 +221,15 @@ def find_urls(
         response = requests.get(url, timeout=5)
         response.raise_for_status()
         soup = BeautifulSoup(response.text, "html.parser")
-        links = [urljoin(url, a["href"]) for a in soup.find_all("a", href=True)]
+        links = [
+            urljoin(url, a["href"])  # type: ignore
+            for a in soup.find_all("a", href=True)
+        ]
 
         # Defrag links: discard links that are to portions of same page
-        defragged_links = list(set(urldefrag(link).url for link in links))
+        defragged_links = list(
+            set(urldefrag(link).url for link in links)  # type: ignore
+        )
 
         # Filter links based on domain matching requirement
         domain_matching_links = [

langroid/utils/output/citations.py

@@ -1,4 +1,9 @@
-def extract_markdown_references(md_string: str) -> list[int]:
+from typing import List
+
+from langroid.mytypes import Document
+
+
+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.
@@ -59,3 +64,28 @@ def format_footnote_text(content: str, width: int = 0) -> str:
 
     # Join them with newline so we preserve the paragraph/blank line structure
     return "\n".join(output_lines)
+
+
+def format_cited_references(citations: List[int], passages: list[Document]) -> str:
+    """
+    Given a list of (integer) citations, and a list of passages, return a string
+    that can be added as a footer to the main text, to show sources cited.
+
+    Args:
+        citations (list[int]): list of citations, presumably from main text
+        passages (list[Document]): list of passages (Document objects)
+
+    Returns:
+        str: formatted string of citations for footnote in markdown
+    """
+    citations_str = ""
+    if len(citations) > 0:
+        # append [i] source, content for each citation
+        citations_str = "\n".join(
+            [
+                f"[^{c}] {passages[c-1].metadata.source}"
+                f"\n{format_footnote_text(passages[c-1].content)}"
+                for c in citations
+            ]
+        )
+    return citations_str

langroid/utils/system.py

@@ -14,11 +14,7 @@ from typing import Any, Literal
 
 logger = logging.getLogger(__name__)
 
-DELETION_ALLOWED_PATHS = [
-    ".qdrant",
-    ".chroma",
-    ".lancedb",
-]
+DELETION_ALLOWED_PATHS = [".qdrant", ".chroma", ".lancedb", ".weaviate"]
 
 
 def pydantic_major_version() -> int:

langroid/vector_store/weaviatedb.py

@@ -32,6 +32,8 @@ class WeaviateDBConfig(VectorStoreConfig):
     collection_name: str | None = "temp"
     embedding: EmbeddingModelsConfig = OpenAIEmbeddingsConfig()
     distance: str = VectorDistances.COSINE
+    cloud: bool = False
+    storage_path: str = ".weaviate_embedded/data"
 
 
 class WeaviateDB(VectorStore):
@@ -39,19 +41,25 @@ class WeaviateDB(VectorStore):
         super().__init__(config)
         self.config: WeaviateDBConfig = config
         load_dotenv()
-        key = os.getenv("WEAVIATE_API_KEY")
-        url = os.getenv("WEAVIATE_API_URL")
-        if url is None or key is None:
-            raise ValueError(
-                """WEAVIATE_API_KEY, WEAVIATE_API_URL env variable must be set to use
-                WeaviateDB in cloud mode. Please set these values
-                in your .env file.
-                """
+        if not self.config.cloud:
+            self.client = weaviate.connect_to_embedded(
+                version="latest", persistence_data_path=self.config.storage_path
             )
-        self.client = weaviate.connect_to_weaviate_cloud(
-            cluster_url=url,
-            auth_credentials=Auth.api_key(key),
-        )
+        else:  # Cloud mode
+            key = os.getenv("WEAVIATE_API_KEY")
+            url = os.getenv("WEAVIATE_API_URL")
+            if url is None or key is None:
+                raise ValueError(
+                    """WEAVIATE_API_KEY, WEAVIATE_API_URL env variables must be set to 
+                    use WeaviateDB in cloud mode. Please set these values
+                    in your .env file.
+                    """
+                )
+            self.client = weaviate.connect_to_weaviate_cloud(
+                cluster_url=url,
+                auth_credentials=Auth.api_key(key),
+            )
+
         if config.collection_name is not None:
             WeaviateDB.validate_and_format_collection_name(config.collection_name)
 
@@ -267,3 +275,8 @@ class WeaviateDB(VectorStore):
             )
 
         return formatted_name
+
+    def __del__(self) -> None:
+        # Gracefully close the connection with local client
+        if not self.config.cloud:
+            self.client.close()

{langroid-0.39.2.dist-info → langroid-0.39.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: langroid
-Version: 0.39.2
+Version: 0.39.4
 Summary: Harness LLMs with Multi-Agent Programming
 Author-email: Prasad Chalasani <pchalasani@gmail.com>
 License: MIT
@@ -30,7 +30,7 @@ Requires-Dist: lxml<5.0.0,>=4.9.3
 Requires-Dist: nest-asyncio<2.0.0,>=1.6.0
 Requires-Dist: nltk<4.0.0,>=3.8.2
 Requires-Dist: onnxruntime<2.0.0,>=1.16.1
-Requires-Dist: openai<2.0.0,>=1.45.0
+Requires-Dist: openai<2.0.0,>=1.61.1
 Requires-Dist: pandas<3.0.0,>=2.0.3
 Requires-Dist: prettytable<4.0.0,>=3.8.0
 Requires-Dist: pydantic<3.0.0,>=1

{langroid-0.39.2.dist-info → langroid-0.39.4.dist-info}/RECORD

@@ -14,7 +14,7 @@ langroid/agent/xml_tool_message.py,sha256=6SshYZJKIfi4mkE-gIoSwjkEYekQ8GwcSiCv7a
 langroid/agent/callbacks/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 langroid/agent/callbacks/chainlit.py,sha256=RH8qUXaZE5o2WQz3WJQ1SdFtASGlxWCA6_HYz_3meDQ,20822
 langroid/agent/special/__init__.py,sha256=gik_Xtm_zV7U9s30Mn8UX3Gyuy4jTjQe9zjiE3HWmEo,1273
-langroid/agent/special/doc_chat_agent.py,sha256=tMx-3cBEIHJM14P20cYvIzAc9z-skSnHOPVJ0eegxzc,64692
+langroid/agent/special/doc_chat_agent.py,sha256=Q16HOg6MXa26szTO29OOIv1kv8QfuUjxLlLOP3eqZvA,64539
 langroid/agent/special/lance_doc_chat_agent.py,sha256=s8xoRs0gGaFtDYFUSIRchsgDVbS5Q3C2b2mr3V1Fd-Q,10419
 langroid/agent/special/lance_tools.py,sha256=qS8x4wi8mrqfbYV2ztFzrcxyhHQ0ZWOc-zkYiH7awj0,2105
 langroid/agent/special/relevance_extractor_agent.py,sha256=zIx8GUdVo1aGW6ASla0NPQjYYIpmriK_TYMijqAx3F8,4796
@@ -69,8 +69,8 @@ langroid/language_models/azure_openai.py,sha256=zNQzzsERxNestq-hFfQZbvTzK43G2vjR
 langroid/language_models/base.py,sha256=mN6HAjLgF2xpHObz5uPZ3JDID7jdTiRLEkoGgGrqLM8,25177
 langroid/language_models/config.py,sha256=9Q8wk5a7RQr8LGMT_0WkpjY8S4ywK06SalVRjXlfCiI,378
 langroid/language_models/mock_lm.py,sha256=5BgHKDVRWFbUwDT_PFgTZXz9-k8wJSA2e3PZmyDgQ1k,4022
-langroid/language_models/model_info.py,sha256=n60j5DrAlxCsHa8pl7PWNBPP7pSAEVMi2mUQ4JOqo7Q,10648
-langroid/language_models/openai_gpt.py,sha256=Vuxz3tZThUN_9MF16KW0HJe0k0qk1tv58PZ0qqwpGdg,76754
+langroid/language_models/model_info.py,sha256=6B8Cey0eX8vR6wAc8-Cb1Gj7pazN01A-FjWTYpG0QFg,11111
+langroid/language_models/openai_gpt.py,sha256=3_kC1o4eY-VnCPAgP8JoIm-fOUnCzHEATymV8WG_ecw,77876
 langroid/language_models/utils.py,sha256=L4_CbihDMTGcsg0TOG1Yd5JFEto46--h7CX_14m89sQ,5016
 langroid/language_models/prompt_formatter/__init__.py,sha256=2-5cdE24XoFDhifOLl8yiscohil1ogbP1ECkYdBlBsk,372
 langroid/language_models/prompt_formatter/base.py,sha256=eDS1sgRNZVnoajwV_ZIha6cba5Dt8xjgzdRbPITwx3Q,1221
@@ -90,7 +90,7 @@ langroid/parsing/search.py,sha256=M1swZfZEMEsalmTwVCkql3DzBNBemky7pWt0PrcwGdQ,97
 langroid/parsing/spider.py,sha256=hAVM6wxh1pQ0EN4tI5wMBtAjIk0T-xnpi-ZUzWybhos,3258
 langroid/parsing/table_loader.py,sha256=qNM4obT_0Y4tjrxNBCNUYjKQ9oETCZ7FbolKBTcz-GM,3410
 langroid/parsing/url_loader.py,sha256=JK48KktLRDBfjrt4nsUfy92M6yGdEeicAqOum2MdULM,4656
-langroid/parsing/urls.py,sha256=XjpaV5onG7gKQ5iQeFTzHSw5P08Aqw0g-rMUu61lR6s,7988
+langroid/parsing/urls.py,sha256=86omykgxo4hg2jyF10Ef-FJa9n6MgXdSXy2mImqgo5c,8076
 langroid/parsing/utils.py,sha256=YrV2GNL4EOBGknA4AClPGdJ4S5B31radrt-Ou8OAKoU,12749
 langroid/parsing/web_search.py,sha256=8rW8EI3tyHITaB2l9MT_6yLMeQfo8y-Ih-8N2v2uMpk,4931
 langroid/prompts/__init__.py,sha256=RW11vK6jiLPuaUh4GpeFvstti73gkm8_rDMtrbo2YsU,142
@@ -108,12 +108,12 @@ langroid/utils/logging.py,sha256=mwxHimq1wtVQ64PvDyfJJ7Upj-rjHLNHgx8EC2wClvo,402
 langroid/utils/object_registry.py,sha256=iPz9GHzvmCeVoidB3JdAMEKcxJEqTdUr0otQEexDZ5s,2100
 langroid/utils/pandas_utils.py,sha256=UctS986Jtl_MvU5rA7-GfrjEHXP7MNu8ePhepv0bTn0,755
 langroid/utils/pydantic_utils.py,sha256=R7Ps8VP56-eSo-LYHWllFo-SJ2zDmdItuuYpUq2gGJ8,20854
-langroid/utils/system.py,sha256=AiEehQy0K9c9qHdKsZRCscRrazDzuh5Tv3GRQsA0Cxg,8455
+langroid/utils/system.py,sha256=cJqDgOf9mM82l1GyUeQQdEYAwepYXQwtpJU8Xrz0-MA,8453
 langroid/utils/types.py,sha256=4GrOnU3HLWh-UwaUPp7LlB3V413q3K5OSzc0ggDoQ6A,2510
 langroid/utils/algorithms/__init__.py,sha256=WylYoZymA0fnzpB4vrsH_0n7WsoLhmuZq8qxsOCjUpM,41
 langroid/utils/algorithms/graph.py,sha256=JbdpPnUOhw4-D6O7ou101JLA3xPCD0Lr3qaPoFCaRfo,2866
 langroid/utils/output/__init__.py,sha256=7P0f--4IZneNsTxXY5fd6d6iW-CeVe-KSsl-87sbBPc,340
-langroid/utils/output/citations.py,sha256=mQhRXVN-uhmKd2z32UZQBE0adZGEaQJ7cVXLfkrcZJI,2221
+langroid/utils/output/citations.py,sha256=9T69O_N6mxPQjQ-qC1vKS8_kyg1z5hDQXMhBsA45xkk,3147
 langroid/utils/output/printing.py,sha256=yzPJZN-8_jyOJmI9N_oLwEDfjMwVgk3IDiwnZ4eK_AE,2962
 langroid/utils/output/status.py,sha256=rzbE7mDJcgNNvdtylCseQcPGCGghtJvVq3lB-OPJ49E,1049
 langroid/vector_store/__init__.py,sha256=BcoOm1tG3y0EqjkIGmMOHkY9iTUhDHgyruknWDKgqIg,1214
@@ -123,8 +123,8 @@ langroid/vector_store/lancedb.py,sha256=Qd20gKjWozPWfW5-D66J6U8dSrJo1yl-maj6s1lb
 langroid/vector_store/meilisearch.py,sha256=6frB7GFWeWmeKzRfLZIvzRjllniZ1cYj3HmhHQICXLs,11663
 langroid/vector_store/momento.py,sha256=xOaU7Hlyyn_5ihb0ARS5JHtmrKrTCt2IdRA-ioMM5ek,10307
 langroid/vector_store/qdrantdb.py,sha256=v7TAsIoj_vxeKDYS9tpwJLBZA8fuTweTYxHo0X_uawM,17949
-langroid/vector_store/weaviatedb.py,sha256=FOzgvqLqvdN5jJebVtJ-8tu2CeBzBfSP3ih4_ODEOOw,10605
-langroid-0.39.2.dist-info/METADATA,sha256=wFY32Hc5yDfZqfFRrz9AKIM17w42GxzYY13pBQX2shg,60634
-langroid-0.39.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-langroid-0.39.2.dist-info/licenses/LICENSE,sha256=EgVbvA6VSYgUlvC3RvPKehSg7MFaxWDsFuzLOsPPfJg,1065
-langroid-0.39.2.dist-info/RECORD,,
+langroid/vector_store/weaviatedb.py,sha256=cMg9kqJXlD1WURs6QivHvwausCyLYGr4mOK2v9uYkhw,11105
+langroid-0.39.4.dist-info/METADATA,sha256=kmZh0J5DvAdv2oNUiCAa3e1SfQ7Le0-egld9zjhVMAw,60634
+langroid-0.39.4.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+langroid-0.39.4.dist-info/licenses/LICENSE,sha256=EgVbvA6VSYgUlvC3RvPKehSg7MFaxWDsFuzLOsPPfJg,1065
+langroid-0.39.4.dist-info/RECORD,,