langroid 0.1.85__py3-none-any.whl → 0.1.219__py3-none-any.whl

{langroid-0.1.85.dist-info → langroid-0.1.219.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: langroid
-Version: 0.1.85
+Version: 0.1.219
 Summary: Harness LLMs with Multi-Agent Programming
 License: MIT
 Author: Prasad Chalasani
@@ -10,74 +10,101 @@ Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Provides-Extra: chainlit
+Provides-Extra: chromadb
 Provides-Extra: hf-embeddings
+Provides-Extra: litellm
+Provides-Extra: metaphor
+Provides-Extra: mkdocs
 Provides-Extra: mysql
+Provides-Extra: neo4j
 Provides-Extra: postgres
+Provides-Extra: sciphi
+Provides-Extra: transformers
+Provides-Extra: unstructured
+Requires-Dist: agent-search (>=0.0.7,<0.0.8) ; extra == "sciphi"
+Requires-Dist: aiohttp (>=3.9.1,<4.0.0)
+Requires-Dist: async-generator (>=1.10,<2.0)
 Requires-Dist: autopep8 (>=2.0.2,<3.0.0)
-Requires-Dist: black[jupyter] (>=23.3.0,<24.0.0)
+Requires-Dist: black[jupyter] (>=24.3.0,<25.0.0)
 Requires-Dist: bs4 (>=0.0.1,<0.0.2)
-Requires-Dist: chromadb (>=0.3.21,<0.4.0)
+Requires-Dist: chainlit (>=1.0.400,<2.0.0) ; extra == "chainlit"
+Requires-Dist: chromadb (>=0.4.21,<=0.4.23) ; extra == "chromadb"
 Requires-Dist: colorlog (>=6.7.0,<7.0.0)
 Requires-Dist: docstring-parser (>=0.15,<0.16)
+Requires-Dist: duckduckgo-search (>=4.4,<5.0)
 Requires-Dist: faker (>=18.9.0,<19.0.0)
 Requires-Dist: fakeredis (>=2.12.1,<3.0.0)
-Requires-Dist: farm-haystack[file-conversion,ocr,pdf,preprocessing] (>=1.21.1,<2.0.0)
 Requires-Dist: fire (>=0.5.0,<0.6.0)
 Requires-Dist: flake8 (>=6.0.0,<7.0.0)
 Requires-Dist: google-api-python-client (>=2.95.0,<3.0.0)
+Requires-Dist: grpcio (>=1.62.1,<2.0.0)
 Requires-Dist: halo (>=0.0.31,<0.0.32)
+Requires-Dist: huggingface-hub (>=0.21.2,<0.22.0) ; extra == "transformers"
 Requires-Dist: jinja2 (>=3.1.2,<4.0.0)
-Requires-Dist: litellm (>=0.1.821,<0.2.0)
+Requires-Dist: lancedb (>=0.6.2,<0.7.0)
+Requires-Dist: litellm (>=1.30.1,<2.0.0) ; extra == "litellm"
 Requires-Dist: lxml (>=4.9.3,<5.0.0)
 Requires-Dist: meilisearch (>=0.28.3,<0.29.0)
-Requires-Dist: meilisearch-python-sdk (>=2.0.1,<3.0.0)
-Requires-Dist: mkdocs (>=1.4.2,<2.0.0)
-Requires-Dist: mkdocs-awesome-pages-plugin (>=2.8.0,<3.0.0)
-Requires-Dist: mkdocs-gen-files (>=0.4.0,<0.5.0)
-Requires-Dist: mkdocs-jupyter (>=0.24.1,<0.25.0)
-Requires-Dist: mkdocs-literate-nav (>=0.6.0,<0.7.0)
-Requires-Dist: mkdocs-material (>=9.1.5,<10.0.0)
-Requires-Dist: mkdocs-rss-plugin (>=1.8.0,<2.0.0)
-Requires-Dist: mkdocs-section-index (>=0.3.5,<0.4.0)
-Requires-Dist: mkdocstrings[python] (>=0.21.2,<0.22.0)
-Requires-Dist: momento (>=1.7.0,<2.0.0)
-Requires-Dist: mypy (>=1.2.0,<2.0.0)
+Requires-Dist: meilisearch-python-sdk (>=2.2.3,<3.0.0)
+Requires-Dist: metaphor-python (>=0.1.23,<0.2.0) ; extra == "metaphor"
+Requires-Dist: mkdocs (>=1.4.2,<2.0.0) ; extra == "mkdocs"
+Requires-Dist: mkdocs-awesome-pages-plugin (>=2.8.0,<3.0.0) ; extra == "mkdocs"
+Requires-Dist: mkdocs-gen-files (>=0.4.0,<0.5.0) ; extra == "mkdocs"
+Requires-Dist: mkdocs-jupyter (>=0.24.1,<0.25.0) ; extra == "mkdocs"
+Requires-Dist: mkdocs-literate-nav (>=0.6.0,<0.7.0) ; extra == "mkdocs"
+Requires-Dist: mkdocs-material (>=9.1.5,<10.0.0) ; extra == "mkdocs"
+Requires-Dist: mkdocs-rss-plugin (>=1.8.0,<2.0.0) ; extra == "mkdocs"
+Requires-Dist: mkdocs-section-index (>=0.3.5,<0.4.0) ; extra == "mkdocs"
+Requires-Dist: mkdocstrings[python] (>=0.21.2,<0.22.0) ; extra == "mkdocs"
+Requires-Dist: momento (>=1.10.2,<2.0.0)
+Requires-Dist: mypy (>=1.7.0,<2.0.0)
+Requires-Dist: neo4j (>=5.14.1,<6.0.0) ; extra == "neo4j"
 Requires-Dist: nltk (>=3.8.1,<4.0.0)
-Requires-Dist: openai (>=0.27.5,<0.28.0)
+Requires-Dist: onnxruntime (==1.16.1)
+Requires-Dist: openai (>=1.14.0,<2.0.0)
 Requires-Dist: pandas (>=2.0.3,<3.0.0)
+Requires-Dist: pdf2image (>=1.17.0,<2.0.0)
 Requires-Dist: pdfplumber (>=0.10.2,<0.11.0)
 Requires-Dist: pre-commit (>=3.3.2,<4.0.0)
 Requires-Dist: prettytable (>=3.8.0,<4.0.0)
 Requires-Dist: psycopg2 (>=2.9.7,<3.0.0) ; extra == "postgres"
-Requires-Dist: pydantic (==1.10.11)
+Requires-Dist: pyarrow (==15.0.0)
+Requires-Dist: pydantic (==1.10.13)
 Requires-Dist: pygithub (>=1.58.1,<2.0.0)
 Requires-Dist: pygments (>=2.15.1,<3.0.0)
 Requires-Dist: pymupdf (>=1.23.3,<2.0.0)
 Requires-Dist: pymysql (>=1.1.0,<2.0.0) ; extra == "mysql"
 Requires-Dist: pyparsing (>=3.0.9,<4.0.0)
 Requires-Dist: pypdf (>=3.12.2,<4.0.0)
+Requires-Dist: pytesseract (>=0.3.10,<0.4.0)
 Requires-Dist: pytest-asyncio (>=0.21.1,<0.22.0)
 Requires-Dist: pytest-mysql (>=2.4.2,<3.0.0) ; extra == "mysql"
 Requires-Dist: pytest-postgresql (>=5.0.0,<6.0.0) ; extra == "postgres"
+Requires-Dist: pytest-redis (>=3.0.2,<4.0.0)
+Requires-Dist: python-docx (>=1.1.0,<2.0.0)
 Requires-Dist: python-dotenv (>=1.0.0,<2.0.0)
-Requires-Dist: qdrant-client (>=1.3.1,<2.0.0)
+Requires-Dist: python-socketio (>=5.11.0,<6.0.0) ; extra == "chainlit"
+Requires-Dist: qdrant-client (>=1.8.0,<2.0.0)
 Requires-Dist: rank-bm25 (>=0.2.2,<0.3.0)
-Requires-Dist: redis (>=4.5.5,<5.0.0)
+Requires-Dist: redis (>=5.0.1,<6.0.0)
 Requires-Dist: requests (>=2.31.0,<3.0.0)
 Requires-Dist: requests-oauthlib (>=1.3.1,<2.0.0)
 Requires-Dist: rich (>=13.3.4,<14.0.0)
-Requires-Dist: ruff (>=0.0.270,<0.0.271)
+Requires-Dist: ruff (>=0.2.2,<0.3.0)
 Requires-Dist: scrapy (>=2.11.0,<3.0.0)
 Requires-Dist: sentence-transformers (==2.2.2) ; extra == "hf-embeddings"
 Requires-Dist: sqlalchemy (>=2.0.19,<3.0.0)
+Requires-Dist: tantivy (>=0.21.0,<0.22.0)
 Requires-Dist: thefuzz (>=0.20.0,<0.21.0)
 Requires-Dist: tiktoken (>=0.5.1,<0.6.0)
 Requires-Dist: torch (==2.0.0) ; extra == "hf-embeddings"
 Requires-Dist: trafilatura (>=1.5.0,<2.0.0)
 Requires-Dist: typer (>=0.9.0,<0.10.0)
+Requires-Dist: types-pyyaml (>=6.0.12.20240311,<7.0.0.0)
 Requires-Dist: types-redis (>=4.5.5.2,<5.0.0.0)
 Requires-Dist: types-requests (>=2.31.0.1,<3.0.0.0)
-Requires-Dist: unstructured[docx,pdf,pptx] (>=0.10.16,<0.10.18)
+Requires-Dist: unstructured[docx,pdf,pptx] (>=0.10.16,<0.10.18) ; extra == "unstructured"
 Requires-Dist: wget (>=3.2,<4.0)
 Description-Content-Type: text/markdown
 
@@ -91,25 +118,12 @@ Description-Content-Type: text/markdown
 [![PyPI - Version](https://img.shields.io/pypi/v/langroid)](https://pypi.org/project/langroid/)
 [![Pytest](https://github.com/langroid/langroid/actions/workflows/pytest.yml/badge.svg)](https://github.com/langroid/langroid/actions/workflows/pytest.yml)
 [![codecov](https://codecov.io/gh/langroid/langroid/branch/main/graph/badge.svg?token=H94BX5F0TE)](https://codecov.io/gh/langroid/langroid)
-[![Lint](https://github.com/langroid/langroid/actions/workflows/validate.yml/badge.svg)](https://github.com/langroid/langroid/actions/workflows/validate.yml)
-[![Docs](https://github.com/langroid/langroid/actions/workflows/mkdocs-deploy.yml/badge.svg)](https://github.com/langroid/langroid/actions/workflows/mkdocs-deploy.yml)
-
-[![Static Badge](https://img.shields.io/badge/Documentation-blue?link=https%3A%2F%2Flangroid.github.io%2Flangroid%2F&link=https%3A%2F%2Flangroid.github.io%2Flangroid%2F)](https://langroid.github.io/langroid)
-[![Discord](https://img.shields.io/badge/Discord-%235865F2.svg?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/ZU36McDgDs)
-[![Open in Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/langroid/langroid/blob/main/examples/langroid_quick_examples.ipynb)
-
-[![Docker Pulls](https://img.shields.io/docker/pulls/langroid/langroid.svg)](https://hub.docker.com/r/langroid/langroid)
-![Docker Image Size (tag)](https://img.shields.io/docker/image-size/langroid/langroid/latest)
 [![Multi-Architecture DockerHub](https://github.com/langroid/langroid/actions/workflows/docker-publish.yml/badge.svg)](https://github.com/langroid/langroid/actions/workflows/docker-publish.yml)
 
-[![Substack](https://img.shields.io/badge/Substack-%23006f5c.svg?style=for-the-badge&logo=substack&logoColor=FF6719)](https://langroid.substack.com/p/langroid-harness-llms-with-multi-agent-programming)
-
-[![Share on Hacker News](https://img.shields.io/badge/-Share%20on%20Hacker%20News-orange)](https://news.ycombinator.com/submitlink?u=https%3A%2F%2Fgithub.com%2Flangroid%2Flangroid&t=Harness%20LLMs%20with%20Multi-Agent%20Programming)
-[![Share on Reddit](https://img.shields.io/badge/Reddit-FF4500?style=for-the-badge&logo=reddit&logoColor=white)](https://www.reddit.com/submit?url=https%3A%2F%2Fgithub.com%2Flangroid%2Flangroid&title=Harness%20LLMs%20with%20Multi-Agent%20Programming)
-[![Share on Twitter](https://img.shields.io/twitter/url?style=social&url=https://github.com/langroid/langroid)](https://twitter.com/intent/tweet?text=Langroid%20is%20a%20powerful,%20elegant%20new%20framework%20to%20easily%20build%20%23LLM%20applications.%20You%20set%20up%20LLM-powered%20Agents%20with%20vector-stores,%20assign%20tasks,%20and%20have%20them%20collaboratively%20solve%20problems%20via%20message-transformations.%20https://github.com/langroid/langroid)
-[![LinkedIn](https://img.shields.io/badge/linkedin-%230077B5.svg?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/shareArticle?mini=true&url=https://github.com/langroid/langroid&title=Langroid:%20A%20Powerful,%20Elegant%20Framework&summary=Langroid%20is%20a%20powerful,%20elegant%20new%20framework%20to%20easily%20build%20%23LLM%20applications.%20You%20set%20up%20LLM-powered%20Agents%20with%20vector-stores,%20assign%20tasks,%20and%20have%20them%20collaboratively%20solve%20problems%20via%20message-transformations.)
-
-
+[![Static Badge](https://img.shields.io/badge/Documentation-blue?link=https%3A%2F%2Flangroid.github.io%2Flangroid%2F&link=https%3A%2F%2Flangroid.github.io%2Flangroid%2F)](https://langroid.github.io/langroid)
+[![Open in Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/langroid/langroid/blob/main/examples/Langroid_quick_start.ipynb)
+[![Discord](https://img.shields.io/badge/Discord-%235865F2.svg?style=flat&logo=discord&logoColor=white)](https://discord.gg/ZU36McDgDs)
+[![Substack](https://img.shields.io/badge/Substack-%23006f5c.svg?style=flat&logo=substack&logoColor=FF6719)](https://langroid.substack.com/p/langroid-harness-llms-with-multi-agent-programming)
 </div>
 
 <h3 align="center">
@@ -130,9 +144,9 @@ Description-Content-Type: text/markdown
 </h3>
 
 `Langroid` is an intuitive, lightweight, extensible and principled
-Python framework to easily build LLM-powered applications. 
+Python framework to easily build LLM-powered applications, from ex-CMU and UW-Madison researchers. 
 You set up Agents, equip them with optional components (LLM, 
-vector-store and methods), assign them tasks, and have them 
+vector-store and tools/functions), assign them tasks, and have them 
 collaboratively solve a problem by exchanging messages. 
 This Multi-Agent paradigm is inspired by the
 [Actor Framework](https://en.wikipedia.org/wiki/Actor_model)
@@ -141,15 +155,179 @@ This Multi-Agent paradigm is inspired by the
 `Langroid` is a fresh take on LLM app-development, where considerable thought has gone 
 into simplifying the developer experience; it does not use `Langchain`.
 
+:fire: See this [Intro to Langroid](https://lancedb.substack.com/p/langoid-multi-agent-programming-framework)
+blog post from the LanceDB team
+
+
 We welcome contributions -- See the [contributions](./CONTRIBUTING.md) document
 for ideas on what to contribute.
 
+Are you building LLM Applications, or want help with Langroid for your company, 
+or want to prioritize Langroid features for your company use-cases? 
+[Prasad Chalasani](https://www.linkedin.com/in/pchalasani/) is available for consulting
+(advisory/development): pchalasani at gmail dot com.
+
+Sponsorship is also accepted via [GitHub Sponsors](https://github.com/sponsors/langroid)
+
 **Questions, Feedback, Ideas? Join us on [Discord](https://discord.gg/ZU36McDgDs)!**
 
-<details>
-<summary> <b>:fire: Updates/Releases</b></summary>
+# Quick glimpse of coding with Langroid
+This is just a teaser; there's much more, like function-calling/tools, 
+Multi-Agent Collaboration, Structured Information Extraction, DocChatAgent 
+(RAG), SQLChatAgent, non-OpenAI local/remote LLMs, etc. Scroll down or see docs for more.
+See the Langroid Quick-Start [Colab](https://colab.research.google.com/github/langroid/langroid/blob/main/examples/Langroid_quick_start.ipynb)
+that builds up to a 2-agent information-extraction example using the OpenAI ChatCompletion API. 
+See also this [version](https://colab.research.google.com/drive/190Tk7t4AdY1P9F_NlZ33-YEoGnHweQQ0) that uses the OpenAI Assistants API instead.
 
+:fire: just released! [Example](https://github.com/langroid/langroid-examples/blob/main/examples/docqa/chat-multi-extract-local.py) 
+script showing how you can use Langroid multi-agents and tools
+to extract structured information from a document using **only a local LLM**
+(Mistral-7b-instruct-v0.2).
+
+```python
+import langroid as lr
+import langroid.language_models as lm
+
+# set up LLM
+llm_cfg = lm.OpenAIGPTConfig( # or OpenAIAssistant to use Assistant API 
+  # any model served via an OpenAI-compatible API
+  chat_model=lm.OpenAIChatModel.GPT4_TURBO, # or, e.g., "ollama/mistral"
+)
+# use LLM directly
+mdl = lm.OpenAIGPT(llm_cfg)
+response = mdl.chat("What is the capital of Ontario?", max_tokens=10)
+
+# use LLM in an Agent
+agent_cfg = lr.ChatAgentConfig(llm=llm_cfg)
+agent = lr.ChatAgent(agent_cfg)
+agent.llm_response("What is the capital of China?") 
+response = agent.llm_response("And India?") # maintains conversation state 
+
+# wrap Agent in a Task to run interactive loop with user (or other agents)
+task = lr.Task(agent, name="Bot", system_message="You are a helpful assistant")
+task.run("Hello") # kick off with user saying "Hello"
+
+# 2-Agent chat loop: Teacher Agent asks questions to Student Agent
+teacher_agent = lr.ChatAgent(agent_cfg)
+teacher_task = lr.Task(
+  teacher_agent, name="Teacher",
+  system_message="""
+    Ask your student concise numbers questions, and give feedback. 
+    Start with a question.
+    """
+)
+student_agent = lr.ChatAgent(agent_cfg)
+student_task = lr.Task(
+  student_agent, name="Student",
+  system_message="Concisely answer the teacher's questions.",
+  single_round=True,
+)
+
+teacher_task.add_sub_task(student_task)
+teacher_task.run()
+```
+
+# :fire: Updates/Releases
+
+<details>
+<summary> <b>Click to expand</b></summary>
+
+- **Mar 2024:**
+  - **0.1.216:** Improvements to allow concurrent runs of `DocChatAgent`, see the
+    [`test_doc_chat_agent.py`](https://github.com/langroid/langroid/blob/main/tests/main/test_doc_chat_agent.py)
+    in particular the `test_doc_chat_batch()`;
+    New task run utility: [`run_batch_task_gen`](https://github.com/langroid/langroid/blob/main/langroid/agent/batch.py) 
+    where a task generator can be specified, to generate one task per input. 
+  - **0.1.212:** ImagePdfParser: support for extracting text from image-based PDFs.
+    (this means `DocChatAgent` will now work with image-pdfs).
+  - **0.1.194 - 0.1.211:** Misc fixes, improvements, and features:
+    - Big enhancement in RAG performance (mainly, recall) due to a [fix in Relevance 
+      Extractor](https://github.com/langroid/langroid/releases/tag/0.1.209)
+    - `DocChatAgent` [context-window fixes](https://github.com/langroid/langroid/releases/tag/0.1.208)
+    - Anthropic/Claude3 support via Litellm
+    - `URLLoader`: detect file time from header when URL doesn't end with a 
+      recognizable suffix like `.pdf`, `.docx`, etc.
+    - Misc lancedb integration fixes
+    - Auto-select embedding config based on whether `sentence_transformer` module is available.
+    - Slim down dependencies, make some heavy ones optional, e.g. `unstructured`, 
+      `haystack`, `chromadb`, `mkdocs`, `huggingface-hub`, `sentence-transformers`.
+    - Easier top-level imports from `import langroid as lr`
+    - Improve JSON detection, esp from weak LLMs
+- **Feb 2024:** 
+  - **0.1.193:** Support local LLMs using Ollama's new OpenAI-Compatible server: 
+     simply specify `chat_model="ollama/mistral"`. See [release notes](https://github.com/langroid/langroid/releases/tag/0.1.193).
+  - **0.1.183:** Added Chainlit support via [callbacks](https://github.com/langroid/langroid/blob/main/langroid/agent/callbacks/chainlit.py). 
+   See [examples](https://github.com/langroid/langroid/tree/main/examples/chainlit).
+- **Jan 2024:**
+  - **0.1.175** 
+    - [Neo4jChatAgent](https://github.com/langroid/langroid/tree/main/langroid/agent/special/neo4j) to chat with a neo4j knowledge-graph.
+      (Thanks to [Mohannad](https://github.com/Mohannadcse)!). The agent uses tools to query the Neo4j schema and translate user queries to Cypher queries,
+      and the tool handler executes these queries, returning them to the LLM to compose
+      a natural language response (analogous to how `SQLChatAgent` works).
+      See example [script](https://github.com/langroid/langroid/tree/main/examples/kg-chat) using this Agent to answer questions about Python pkg dependencies.
+    - Support for `.doc` file parsing (in addition to `.docx`)
+    - Specify optional [`formatter` param](https://github.com/langroid/langroid/releases/tag/0.1.171) 
+      in `OpenAIGPTConfig` to ensure accurate chat formatting for local LLMs. 
+  - **[0.1.157](https://github.com/langroid/langroid/releases/tag/0.1.157):** `DocChatAgentConfig` 
+     has a new param: `add_fields_to_content`, to specify additional document fields to insert into 
+     the main `content` field, to help improve retrieval.
+  - **[0.1.156](https://github.com/langroid/langroid/releases/tag/0.1.156):** New Task control signals
+     PASS_TO, SEND_TO; VectorStore: Compute Pandas expression on documents; LanceRAGTaskCreator creates 3-agent RAG system with Query Planner, Critic and RAG Agent.
+- **Dec 2023:**
+  - **0.1.154:** (For details see release notes of [0.1.149](https://github.com/langroid/langroid/releases/tag/0.1.149)
+      and [0.1.154](https://github.com/langroid/langroid/releases/tag/0.1.154)). 
+    - `DocChatAgent`: Ingest Pandas dataframes and filtering.
+    - `LanceDocChatAgent` leverages `LanceDB` vector-db for efficient vector search
+     and full-text search and filtering.
+    - Improved task and multi-agent control mechanisms
+    - `LanceRAGTaskCreator` to create a 2-agent system consisting of a `LanceFilterAgent` that
+      decides a filter and rephrase query to send to a RAG agent.
+  - **[0.1.141](https://github.com/langroid/langroid/releases/tag/0.1.141):**
+    API Simplifications to reduce boilerplate:
+    auto-select an available OpenAI model (preferring gpt-4-turbo), simplifies defaults.
+    Simpler `Task` initialization with default `ChatAgent`.
+- **Nov 2023:**
+  - **[0.1.126](https://github.com/langroid/langroid/releases/tag/0.1.126):**
+     OpenAIAssistant agent: Caching Support. 
+  - **0.1.117:** Support for OpenAI Assistant API tools: Function-calling, 
+    Code-intepreter, and Retriever (RAG), file uploads. These work seamlessly 
+    with Langroid's task-orchestration.
+    Until docs are ready, it's best to see these usage examples:
+    
+    - **Tests:**
+      - [test_openai_assistant.py](https://github.com/langroid/langroid/blob/main/tests/main/test_openai_assistant.py)
+      - [test_openai_assistant_async.py](https://github.com/langroid/langroid/blob/main/tests/main/test_openai_assistant_async.py)
+
+    - **Example scripts:**
+      - [The most basic chat app](https://github.com/langroid/langroid/blob/main/examples/basic/oai-asst-chat.py)
+      - [Chat with code interpreter](https://github.com/langroid/langroid/blob/main/examples/basic/oai-code-chat.py)
+      - [Chat with retrieval (RAG)](https://github.com/langroid/langroid/blob/main/examples/docqa/oai-retrieval-assistant.py)
+      - [2-agent RAG chat](https://github.com/langroid/langroid/blob/main/examples/docqa/oai-retrieval-2.py)
+  - **0.1.112:** [`OpenAIAssistant`](https://github.com/langroid/langroid/blob/main/langroid/agent/openai_assistant.py) is a subclass of `ChatAgent` that 
+    leverages the new OpenAI Assistant API. It can be used as a drop-in 
+    replacement for `ChatAgent`, and relies on the Assistant API to
+    maintain conversation state, and leverages persistent threads and 
+    assistants to reconnect to them if needed. Examples: 
+    [`test_openai_assistant.py`](https://github.com/langroid/langroid/blob/main/tests/main/test_openai_assistant.py),
+    [`test_openai_assistant_async.py`](https://github.com/langroid/langroid/blob/main/tests/main/test_openai_assistant_async.py)
+  - **0.1.111:** Support latest OpenAI model: `GPT4_TURBO`
+(see [test_llm.py](tests/main/test_llm.py) for example usage)
+  - **0.1.110:** Upgrade from OpenAI v0.x to v1.1.1 (in preparation for 
+    Assistants API and more); (`litellm` temporarily disabled due to OpenAI 
+    version conflict).
 - **Oct 2023:**
+  - **0.1.107:** `DocChatAgent` re-rankers: `rank_with_diversity`, `rank_to_periphery` (lost in middle).
+  - **0.1.102:** `DocChatAgentConfig.n_neighbor_chunks > 0` allows returning context chunks around match.
+  - **0.1.101:** `DocChatAgent` uses `RelevanceExtractorAgent` to have 
+    the LLM extract relevant portions of a chunk using 
+    sentence-numbering, resulting in huge speed up and cost reduction 
+    compared to the naive "sentence-parroting" approach (writing out full 
+    sentences out relevant whole sentences) which `LangChain` uses in their 
+    `LLMChainExtractor`.
+  - **0.1.100:** API update: all of Langroid is accessible with a single import, i.e. `import langroid as lr`. See the [documentation]("https://langroid.github.io/langroid/") for usage.
+  - **0.1.99:** Convenience batch functions to run tasks, agent methods on a list of inputs concurrently in async mode. See examples in [test_batch.py](https://github.com/langroid/langroid/blob/main/tests/main/test_batch.py).
+  - **0.1.95:** Added support for [Momento Serverless Vector Index](https://docs.momentohq.com/vector-index)
+  - **0.1.94:** Added support for [LanceDB](https://lancedb.github.io/lancedb/) vector-store -- allows vector, Full-text, SQL search.
   - **0.1.84:** Added [LiteLLM](https://docs.litellm.ai/docs/providers), so now Langroid can be used with over 100 LLM providers (remote or local)! 
      See guide [here](https://langroid.github.io/langroid/tutorials/non-openai-llms/).
 - **Sep 2023:**
@@ -172,7 +350,7 @@ See [this test](tests/main/test_recipient_tool.py) for example usage.
   - **Example:** [Answer questions](examples/docqa/chat-search.py) using Google Search + vecdb-retrieval from URL contents. 
   - **0.1.39:** [`GoogleSearchTool`](langroid/agent/tools/google_search_tool.py) to enable Agents (their LLM) to do Google searches via function-calling/tools.
     See [this chat example](examples/basic/chat-search.py) for how easy it is to add this tool to an agent.
-  - **Colab notebook** to try the quick-start examples: [![Open in Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/langroid/langroid/blob/main/examples/langroid_quick_examples.ipynb) 
+  - **Colab notebook** to try the quick-start examples: [![Open in Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/langroid/langroid/blob/main/examples/Langroid_quick_start.ipynb) 
   - **0.1.37:** Added [`SQLChatAgent`](langroid/agent/special/sql_chat_agent.py) -- thanks to our latest contributor [Rithwik Babu](https://github.com/rithwikbabu)!
   - Multi-agent Example: [Autocorrect chat](examples/basic/autocorrect.py)
 - **July 2023:** 
@@ -191,6 +369,8 @@ See [this test](tests/main/test_recipient_tool.py) for example usage.
 Suppose you want to extract structured information about the key terms 
 of a commercial lease document. You can easily do this with Langroid using a two-agent system,
 as we show in the [langroid-examples](https://github.com/langroid/langroid-examples/blob/main/examples/docqa/chat_multi_extract.py) repo.
+(See [this script](https://github.com/langroid/langroid-examples/blob/main/examples/docqa/chat-multi-extract-local.py)
+for a version with the same functionality using a local Mistral-7b model.)
 The demo showcases just a few of the many features of Langroid, such as:
 - Multi-agent collaboration: `LeaseExtractor` is in charge of the task, and its LLM (GPT4) generates questions 
 to be answered by the `DocAgent`.
@@ -207,7 +387,9 @@ Here is what it looks like in action
 
 
 # :zap: Highlights
-
+(For a more up-to-date list see the 
+[release](https://github.com/langroid/langroid?tab=readme-ov-file#fire-updatesreleases) 
+section above)
 - **Agents as first-class citizens:** The [Agent](https://langroid.github.io/langroid/reference/agent/base/#langroid.agent.base.Agent) class encapsulates LLM conversation state,
   and optionally a vector-store and tools. Agents are a core abstraction in Langroid;
   Agents act as _message transformers_, and by default provide 3 _responder_ methods, one corresponding to each entity: LLM, Agent, User.
@@ -221,11 +403,12 @@ Here is what it looks like in action
   after the agent's own responders.
 - **Modularity, Reusabilily, Loose coupling:** The `Agent` and `Task` abstractions allow users to design
   Agents with specific skills, wrap them in Tasks, and combine tasks in a flexible way.
-- **LLM Support**: Langroid supports OpenAI LLMs including GPT-3.5-Turbo,
-  GPT-4.
+- **LLM Support**: Langroid supports OpenAI LLMs as well as LLMs from hundreds of 
+providers (local/open or remote/commercial) via proxy libraries and local model servers
+such as [LiteLLM](https://docs.litellm.ai/docs/providers) that in effect mimic the OpenAI API. 
 - **Caching of LLM responses:** Langroid supports [Redis](https://redis.com/try-free/) and 
   [Momento](https://www.gomomento.com/) to cache LLM responses.
-- **Vector-stores**: [Qdrant](https://qdrant.tech/) and [Chroma](https://www.trychroma.com/) are currently supported.
+- **Vector-stores**: [LanceDB](https://github.com/lancedb/lancedb), [Qdrant](https://qdrant.tech/), [Chroma](https://www.trychroma.com/) are currently supported.
   Vector stores allow for Retrieval-Augmented-Generation (RAG).
 - **Grounding and source-citation:** Access to external documents via vector-stores 
    allows for grounding and source-citation.
@@ -260,6 +443,15 @@ install Langroid like this:
 ```bash
 pip install langroid[hf-embeddings]
 ```
+If using `zsh` (or similar shells), you may need to escape the square brackets, e.g.:
+```
+pip install langroid\[hf-embeddings\]
+```
+or use quotes:
+```
+pip install "langroid[hf-embeddings]"
+```
+
 
 <details>
 <summary><b>Optional Installs for using SQL Chat with a PostgreSQL DB </b></summary>
@@ -288,9 +480,11 @@ In the root of the repo, copy the `.env-template` file to a new file `.env`:
 cp .env-template .env
 ```
 Then insert your OpenAI API Key. 
-Your `.env` file should look like this:
+Your `.env` file should look like this (the organization is optional 
+but may be required in some scenarios).
 ```bash
 OPENAI_API_KEY=your-key-here-without-quotes
+OPENAI_ORGANIZATION=optionally-your-organization-id
 ````
 
 Alternatively, you can set this as an environment variable in your shell
@@ -307,11 +501,10 @@ All of the following environment variable settings are optional, and some are on
 to use specific features (as noted below).
 
 - **Qdrant** Vector Store API Key, URL. This is only required if you want to use Qdrant cloud.
-  You can sign up for a free 1GB account at [Qdrant cloud](https://cloud.qdrant.io).
-  If you skip setting up these, Langroid will use Qdrant in local-storage mode.
+  The default vector store in our RAG agent (`DocChatAgent`) is LanceDB which uses file storage,
+  and you do not need to set up any environment variables for that.
   Alternatively [Chroma](https://docs.trychroma.com/) is also currently supported. 
   We use the local-storage version of Chroma, so there is no need for an API key.
-  Langroid uses Qdrant by default.
 - **Redis** Password, host, port: This is optional, and only needed to cache LLM API responses
   using Redis Cloud. Redis [offers](https://redis.com/try-free/) a free 30MB Redis account
   which is more than sufficient to try out Langroid and even beyond.
@@ -362,12 +555,12 @@ When using Azure OpenAI, additional environment variables are required in the
 This page [Microsoft Azure OpenAI](https://learn.microsoft.com/en-us/azure/ai-services/openai/chatgpt-quickstart?tabs=command-line&pivots=programming-language-python#environment-variables)
 provides more information, and you can set each environment variable as follows:
 
-- `AZURE_API_KEY`, from the value of `API_KEY`
+- `AZURE_OPENAI_API_KEY`, from the value of `API_KEY`
 - `AZURE_OPENAI_API_BASE` from the value of `ENDPOINT`, typically looks like `https://your.domain.azure.com`.
 - For `AZURE_OPENAI_API_VERSION`, you can use the default value in `.env-template`, and latest version can be found [here](https://learn.microsoft.com/en-us/azure/ai-services/openai/whats-new#azure-openai-chat-completion-general-availability-ga)
 - `AZURE_OPENAI_DEPLOYMENT_NAME` is the name of the deployed model, which is defined by the user during the model setup 
-- `AZURE_GPT_MODEL_NAME` GPT-3.5-Turbo or GPT-4 model names that you chose when you setup your Azure OpenAI account.
-
+- `AZURE_OPENAI_MODEL_NAME` Azure OpenAI allows specific model names when you select the model for your deployment. You need to put precisly the exact model name that was selected. For example, GPT-3.5 (should be `gpt-35-turbo-16k` or `gpt-35-turbo`) or GPT-4 (should be `gpt-4-32k` or `gpt-4`).
+- `AZURE_OPENAI_MODEL_VERSION` is required if `AZURE_OPENAI_MODEL_NAME = gpt=4`, which will assist Langroid to determine the cost of the model  
 </details>
 
 ---
@@ -381,14 +574,13 @@ Please follow these steps to setup the container:
 
 ```bash
 # get the .env file template from `langroid` repo
-wget https://github.com/langroid/langroid/blob/main/.env-template .env
+wget -O .env https://raw.githubusercontent.com/langroid/langroid/main/.env-template
 
-# Edit the .env file with your favorite editor (here nano), 
-# and add API keys as explained above
+# Edit the .env file with your favorite editor (here nano), and remove any un-used settings. E.g. there are "dummy" values like "your-redis-port" etc -- if you are not using them, you MUST remove them.
 nano .env
 
 # launch the container
-docker run -it  -v ./.env:/.env langroid/langroid
+docker run -it --rm  -v ./.env:/langroid/.env langroid/langroid
 
 # Use this command to run any of the scripts in the `examples` directory
 python examples/<Path/To/Example.py> 
@@ -421,49 +613,70 @@ for a detailed tutorial.
 
 Click to expand any of the code examples below.
 All of these can be run in a Colab notebook:
-[![Open in Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/langroid/langroid/blob/main/examples/langroid_quick_examples.ipynb)
+[![Open in Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/langroid/langroid/blob/main/examples/Langroid_quick_start.ipynb)
 
 <details>
 <summary> <b> Direct interaction with OpenAI LLM </b> </summary>
 
 ```python
-from langroid.language_models.openai_gpt import ( 
-        OpenAIGPTConfig, OpenAIChatModel, OpenAIGPT,
-)
-from langroid.language_models.base import LLMMessage, Role
-
-cfg = OpenAIGPTConfig(chat_model=OpenAIChatModel.GPT4)
+import langroid.language_models as lm
 
-mdl = OpenAIGPT(cfg)
+mdl = lm.OpenAIGPT()
 
 messages = [
-  LLMMessage(content="You are a helpful assistant",  role=Role.SYSTEM), 
-  LLMMessage(content="What is the capital of Ontario?",  role=Role.USER),
+  lm.LLMMessage(content="You are a helpful assistant",  role=lm.Role.SYSTEM), 
+  lm.LLMMessage(content="What is the capital of Ontario?",  role=lm.Role.USER),
 ]
+
 response = mdl.chat(messages, max_tokens=200)
 print(response.message)
 ```
 </details>
 
 <details>
-<summary> <b> Define an agent, set up a task, and run it </b> </summary>
+<summary> <b> Interaction with non-OpenAI LLM (local or remote) </b> </summary>
+Local model: if model is served at `http://localhost:8000`:
 
 ```python
-from langroid.agent.chat_agent import ChatAgent, ChatAgentConfig
-from langroid.agent.task import Task
-from langroid.language_models.openai_gpt import OpenAIChatModel, OpenAIGPTConfig
-
-config = ChatAgentConfig(
-    llm = OpenAIGPTConfig(
-        chat_model=OpenAIChatModel.GPT4,
-    ),
-    vecdb=None, # no vector store
+cfg = lm.OpenAIGPTConfig(
+  chat_model="local/localhost:8000", 
+  chat_context_length=4096
 )
-agent = ChatAgent(config)
+mdl = lm.OpenAIGPT(cfg)
+# now interact with it as above, or create an Agent + Task as shown below.
+```
+
+If the model is [supported by `liteLLM`](https://docs.litellm.ai/docs/providers), 
+then no need to launch the proxy server.
+Just set the `chat_model` param above to `litellm/[provider]/[model]`, e.g. 
+`litellm/anthropic/claude-instant-1` and use the config object as above.
+Note that to use `litellm` you need to install langroid with the `litellm` extra:
+`poetry install -E litellm` or `pip install langroid[litellm]`.
+For remote models, you will typically need to set API Keys etc as environment variables.
+You can set those based on the LiteLLM docs. 
+If any required environment variables are missing, Langroid gives a helpful error
+message indicating which ones are needed.
+Note that to use `langroid` with `litellm` you need to install the `litellm` 
+extra, i.e. either `pip install langroid[litellm]` in your virtual env,
+or if you are developing within the `langroid` repo, 
+`poetry install -E litellm`.
+```bash
+pip install langroid[litellm]
+```
+</details>
+
+<details>
+<summary> <b> Define an agent, set up a task, and run it </b> </summary>
+
+```python
+import langroid as lr
+
+agent = lr.ChatAgent()
+
 # get response from agent's LLM, and put this in an interactive loop...
 # answer = agent.llm_response("What is the capital of Ontario?")
   # ... OR instead, set up a task (which has a built-in loop) and run it
-task = Task(agent, name="Bot") 
+task = lr.Task(agent, name="Bot") 
 task.run() # ... a loop seeking response from LLM or User at each turn
 ```
 </details>
@@ -472,26 +685,17 @@ task.run() # ... a loop seeking response from LLM or User at each turn
 <summary><b> Three communicating agents </b></summary>
 
 A toy numbers game, where when given a number `n`:
-- `repeater_agent`'s LLM simply returns `n`,
-- `even_agent`'s LLM returns `n/2` if `n` is even, else says "DO-NOT-KNOW"
-- `odd_agent`'s LLM returns `3*n+1` if `n` is odd, else says "DO-NOT-KNOW"
+- `repeater_task`'s LLM simply returns `n`,
+- `even_task`'s LLM returns `n/2` if `n` is even, else says "DO-NOT-KNOW"
+- `odd_task`'s LLM returns `3*n+1` if `n` is odd, else says "DO-NOT-KNOW"
 
-First define the 3 agents, and set up their tasks with instructions:
+Each of these `Task`s automatically configures a default `ChatAgent`.
 
 ```python
+import langroid as lr
 from langroid.utils.constants import NO_ANSWER
-from langroid.agent.chat_agent import ChatAgent, ChatAgentConfig
-from langroid.agent.task import Task
-from langroid.language_models.openai_gpt import OpenAIChatModel, OpenAIGPTConfig
-config = ChatAgentConfig(
-    llm = OpenAIGPTConfig(
-        chat_model=OpenAIChatModel.GPT4,
-    ),
-    vecdb = None,
-)
-repeater_agent = ChatAgent(config)
-repeater_task = Task(
-    repeater_agent,
+
+repeater_task = lr.Task(
     name = "Repeater",
     system_message="""
     Your job is to repeat whatever number you receive.
@@ -499,9 +703,8 @@ repeater_task = Task(
     llm_delegate=True, # LLM takes charge of task
     single_round=False, 
 )
-even_agent = ChatAgent(config)
-even_task = Task(
-    even_agent,
+
+even_task = lr.Task(
     name = "EvenHandler",
     system_message=f"""
     You will be given a number. 
@@ -511,9 +714,7 @@ even_task = Task(
     single_round=True,  # task done after 1 step() with valid response
 )
 
-odd_agent = ChatAgent(config)
-odd_task = Task(
-    odd_agent,
+odd_task = lr.Task(
     name = "OddHandler",
     system_message=f"""
     You will be given a number n. 
@@ -539,7 +740,7 @@ Langroid leverages Pydantic to support OpenAI's
 [Function-calling API](https://platform.openai.com/docs/guides/gpt/function-calling)
 as well as its own native tools. The benefits are that you don't have to write
 any JSON to specify the schema, and also if the LLM hallucinates a malformed
-tool syntax, Langroid sends the Pydantic validation error (suitiably sanitized) 
+tool syntax, Langroid sends the Pydantic validation error (suitably sanitized) 
 to the LLM so it can fix it!
 
 Simple example: Say the agent has a secret list of numbers, 
@@ -552,8 +753,9 @@ First define the tool using Langroid's `ToolMessage` class:
 
 
 ```python
-from langroid.agent.tool_message import ToolMessage
-class ProbeTool(ToolMessage):
+import langroid as lr
+
+class ProbeTool(lr.agent.ToolMessage):
   request: str = "probe" # specifies which agent method handles this tool
   purpose: str = """
         To find how many numbers in my list are less than or equal to  
@@ -566,9 +768,8 @@ Then define a `SpyGameAgent` as a subclass of `ChatAgent`,
 with a method `probe` that handles this tool:
 
 ```python
-from langroid.agent.chat_agent import ChatAgent, ChatAgentConfig
-class SpyGameAgent(ChatAgent):
-  def __init__(self, config: ChatAgentConfig):
+class SpyGameAgent(lr.ChatAgent):
+  def __init__(self, config: lr.ChatAgentConfig):
     super().__init__(config)
     self.numbers = [3, 4, 8, 11, 15, 25, 40, 80, 90]
 
@@ -580,13 +781,9 @@ class SpyGameAgent(ChatAgent):
 We then instantiate the agent and enable it to use and respond to the tool:
 
 ```python
-from langroid.language_models.openai_gpt import OpenAIChatModel, OpenAIGPTConfig
 spy_game_agent = SpyGameAgent(
-    ChatAgentConfig(
+    lr.ChatAgentConfig(
         name="Spy",
-        llm = OpenAIGPTConfig(
-            chat_model=OpenAIChatModel.GPT4,
-        ),
         vecdb=None,
         use_tools=False, #  don't use Langroid native tool
         use_functions_api=True, # use OpenAI function-call API
@@ -628,7 +825,9 @@ Then define the `LeaseMessage` tool as a subclass of Langroid's `ToolMessage`.
 Note the tool has a required argument `terms` of type `Lease`:
 
 ```python
-class LeaseMessage(ToolMessage):
+import langroid as lr
+
+class LeaseMessage(lr.agent.ToolMessage):
     request: str = "lease_info"
     purpose: str = """
         Collect information about a Commercial Lease.
@@ -640,7 +839,7 @@ Then define a `LeaseExtractorAgent` with a method `lease_info` that handles this
 instantiate the agent, and enable it to use and respond to this tool:
 
 ```python
-class LeaseExtractorAgent(ChatAgent):
+class LeaseExtractorAgent(lr.ChatAgent):
     def lease_info(self, message: LeaseMessage) -> str:
         print(
             f"""
@@ -650,13 +849,7 @@ class LeaseExtractorAgent(ChatAgent):
         )
         return json.dumps(message.terms.dict())
     
-lease_extractor_agent = LeaseExtractorAgent(
-  ChatAgentConfig(
-    llm=OpenAIGPTConfig(),
-    use_functions_api=False,
-    use_tools=True,
-  )
-)
+lease_extractor_agent = LeaseExtractorAgent()
 lease_extractor_agent.enable_message(LeaseMessage)
 ```
 
@@ -675,18 +868,16 @@ First create a `DocChatAgentConfig` instance, with a
 `doc_paths` field that specifies the documents to chat with.
 
 ```python
-from langroid.agent.doc_chat_agent import DocChatAgentConfig
-from langroid.vector_store.qdrantdb import QdrantDBConfig
+import langroid as lr
+from langroid.agent.special import DocChatAgentConfig, DocChatAgent
+
 config = DocChatAgentConfig(
   doc_paths = [
     "https://en.wikipedia.org/wiki/Language_model",
     "https://en.wikipedia.org/wiki/N-gram_language_model",
     "/path/to/my/notes-on-language-models.txt",
-  ]
-  llm = OpenAIGPTConfig(
-    chat_model=OpenAIChatModel.GPT4,
-  ),
-  vecdb=QdrantDBConfig()
+  ],
+  vecdb=lr.vector_store.LanceDBConfig(),
 )
 ```
 
@@ -697,12 +888,11 @@ agent = DocChatAgent(config)
 ```
 Then we can either ask the agent one-off questions,
 ```python
-agent.chat("What is a language model?")
+agent.llm_response("What is a language model?")
 ```
 or wrap it in a `Task` and run an interactive loop with the user:
 ```python
-from langroid.task import Task
-task = Task(agent)
+task = lr.Task(agent)
 task.run()
 ```
 
@@ -722,9 +912,8 @@ executes the code and returns the answer.
 Here is how you can do this:
 
 ```python
-from langroid.agent.special.table_chat_agent import TableChatAgent, TableChatAgentConfig
-from langroid.agent.task import Task
-from langroid.language_models.openai_gpt import OpenAIChatModel, OpenAIGPTConfig
+import langroid as lr
+from langroid.agent.special import TableChatAgent, TableChatAgentConfig
 ```
 
 Set up a `TableChatAgent` for a data file, URL or dataframe
@@ -735,17 +924,14 @@ dataset =  "https://archive.ics.uci.edu/ml/machine-learning-databases/wine-quali
 # or dataset = pd.read_csv("/path/to/my/data.csv")
 agent = TableChatAgent(
     config=TableChatAgentConfig(
-        data=dataset,  
-        llm=OpenAIGPTConfig(
-            chat_model=OpenAIChatModel.GPT4,
-        ),
+        data=dataset,
     )
 )
 ```
 Set up a task, and ask one-off questions like this: 
 
 ```python
-task = Task(
+task = lr.Task(
   agent, 
   name = "DataAssistant",
   default_human_response="", # to avoid waiting for user input
@@ -759,7 +945,7 @@ print(result.content)
 Or alternatively, set up a task and run it in an interactive loop with the user:
 
 ```python
-task = Task(agent, name="DataAssistant")
+task = lr.Task(agent, name="DataAssistant")
 task.run()
 ``` 
 
@@ -781,14 +967,8 @@ If you like this project, please give it a star ⭐ and 📢 spread the word in
 [![Share on Hacker News](https://img.shields.io/badge/-Share%20on%20Hacker%20News-orange)](https://news.ycombinator.com/submitlink?u=https%3A%2F%2Fgithub.com%2Flangroid%2Flangroid&t=Harness%20LLMs%20with%20Multi-Agent%20Programming)
 [![Share on Reddit](https://img.shields.io/badge/-Share%20on%20Reddit-blue)](https://www.reddit.com/submit?url=https%3A%2F%2Fgithub.com%2Flangroid%2Flangroid&title=Harness%20LLMs%20with%20Multi-Agent%20Programming)
 
-
-
-
 Your support will help build Langroid's momentum and community.
 
-
-
-
 # Langroid Co-Founders
 
 - [Prasad Chalasani](https://www.linkedin.com/in/pchalasani/) (IIT BTech/CS, CMU PhD/ML; Independent ML Consultant)