ragbits-chat 0.0.8.dev23005__tar.gz

ragbits_chat-0.0.8.dev23005/.gitignore

@@ -0,0 +1,116 @@
+# Directories
+.vscode/
+.idea/
+.neptune/
+.pytest_cache/
+.mypy_cache/
+venv/
+.venv/
+__pycache__/
+**.egg-info/
+.deepeval/
+
+# Local cursor rules
+.cursor/rules/local/
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# Sphinx documentation
+docs/_build/
+public/
+# autogenerated package license table
+docs/licenses_table.rst
+
+# license dump file
+licenses.txt
+
+# File formats
+*.onnx
+*.pyc
+*.pt
+*.pth
+*.pkl
+*.mar
+*.torchscript
+**/.ipynb_checkpoints
+**/dist/
+**/checkpoints/
+**/outputs/
+**/multirun/
+
+# Other env files
+.python-version
+pyvenv.cfg
+pip-selfcheck.json
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*,cover
+.hypothesis/
+
+# dotenv
+.env
+
+# coverage and pytest reports
+coverage.xml
+report.xml
+
+# CMake
+cmake-build-*/
+
+# Terraform
+**/.terraform.lock.hcl
+**/.terraform
+
+# mkdocs generated files
+site/
+
+# build artifacts
+dist/
+
+# examples
+chroma/
+qdrant/
+
+.aider*
+
+.DS_Store
+node_modules/
+
+lazygit
+
+lazygit.tar.gz
+
+# chat conversation logs
+duet_conversation.log
+worktrees/

ragbits_chat-0.0.8.dev23005/CHANGELOG.md

@@ -0,0 +1,279 @@
+# CHANGELOG
+
+## Unreleased
+
+- Feat: add response adapter system for transforming chat response streams (`ResponseAdapter` protocol, `AdapterPipeline`, `ChatResponseAdapter`, `ToolResultTextAdapter`, `FilterAdapter`, and more)
+- Refactor ragbits-client types to remove excessive use of any (#881)
+- Split params into path params, query params in API client (#871)
+- Fix bug causing conversation not to be selected when navigating to it from url(#872)
+- CI/CD for nightly npm builds, update ragbits-api-client-react deps to install latest version of the @ragbits/api-client (#873)
+- CI/CD for nightlty builds improvements (#874)
+- Add automatic topic extraction to be used as conversation title with ability to edit in the client side (#840)
+- Add todo list component to the UI, add support for todo events in API (#827)
+- Add support for confirmation requests in chat (#853)
+- customizable HeroUI theme (#841)
+- Add error response type to the chat interface with ability to display error messages to the user (#878)
+
+### Added
+
+- Add automatic topic extraction to be used as conversation title with ability to edit in the client side (#840)
+- Add todo list component to the UI, add support for todo events in API (#827)
+- Add custom response type to the chat interface with full type safety and validation (#849)
+  - New class-based response system: `TextResponse`, `ReferenceResponse`, `StateUpdateResponse`, etc.
+  - Support for custom response types by extending `ResponseContent` and `ChatResponse`
+  - Full Pydantic validation for all response content
+- customizable HeroUI theme (#841)
+
+### Deprecated
+
+- **BACKWARD COMPATIBILITY MAINTAINED**: The following APIs are deprecated and will be removed in version 2.0.0:
+  - `ChatResponseType` enum - Use `isinstance()` checks with specific response classes instead
+  - `ChatResponse.type` property - Use `isinstance()` checks instead
+  - `ChatResponse.as_text()` method - Use `isinstance(response, TextResponse)` instead
+  - `ChatResponse.as_reference()` method - Use `isinstance(response, ReferenceResponse)` instead
+  - `ChatResponse.as_state_update()` method - Use `isinstance(response, StateUpdateResponse)` instead
+  - `ChatResponse.as_conversation_id()` method - Use `isinstance(response, ConversationIdResponse)` instead
+
+All deprecated APIs emit `DeprecationWarning` when used and remain fully functional for backward compatibility.
+
+**Migration Example:**
+
+```python
+# Old (deprecated but still works):
+if response.type == ChatResponseType.TEXT:
+    print(response.as_text())
+
+# New (recommended):
+if isinstance(response, TextResponse):
+    print(response.content.text)
+```
+
+## 1.3.0 (2025-09-11)
+
+### Changed
+
+- ragbits-core updated to version v1.3.0
+
+- fix: replace authenticated_user state tracking with direct user field in ChatContext
+- Refactor chat handlers in the UI to use registry (#805)
+- Add auth token storage and automatic logout on 401 (#802)
+- Improve user settings storage when history is disabled (#799)
+- Remove redundant test for `/api/config` endpoint (#795)
+- Fix bug causing infinite initialization screen (#793)
+- Fix bug that caused messages to be sent when changing chat settings; simplify and harden history logic (#791)
+- Add `clear_message` event type allowing to reset whole message (#789)
+- Add usage component to UI with backend support (#786)
+- Add authentication handling in the UI (#763)
+- Add backend authentication (#761)
+
+- Autogenerate typescript types based on backend typing (#727)
+- Add ability to customize favicon and page title (#766)
+
+- Autogenerate typescript types based on backend typing (#727)
+- Add ability to customize favicon and page title (#766)
+
+## 1.2.2 (2025-08-08)
+
+### Changed
+
+- ragbits-core updated to version v1.2.2
+
+## 1.2.1 (2025-08-04)
+
+### Changed
+
+- ragbits-core updated to version v1.2.1
+- Fix routing error causing chat to not be displayed with disabled history (#764)
+
+## 1.2.0 (2025-08-01)
+
+### Changed
+
+- ragbits-core updated to version v1.2.0
+- Update TailwindCSS, React, Vite, tailwind config (#742)
+- Add images support in chat message, images gallery (#731)
+- Add persistent user settings (#719)
+- Send chat options under `user_settings` key (#721)
+- Add feedback indicator to messages, allow `extensions` in chat messages (#722)
+- Add unit tests for UI's core components (#717)
+- Add share functionality with informative modal (#726)
+- Add persisent chat history to the default UI using IndexedDB (#732)
+- Redesign history UI, allowed enabling of client side history using config (#744)
+- Allow parallel conversations in the UI (#749)
+- Add missing typography plugin for TailwindCSS (#750)
+- Add client routing with ability for plugins to define custom routes (#754)
+
+## 1.1.0 (2025-07-09)
+
+### Changed
+
+- ragbits-core updated to version v1.1.0
+
+- Add configurable user setting in Ragbits UI (#692)
+- Live updates support for Python api client(#683)
+- Synchronous and asynchronous Python api client (#647)
+- Live updates support markdown (#684)
+- Added custom styling for multiline and inline-code (#668)
+- Changed toggling darkmode for tailwind class selector (#668)
+- Loading indicator, delayed message buttons, integrated abort controller (#641)
+- Added Eslint, Prettier & CI/CD for Ragbits API Clients (#604)
+- Excluded API connection logic to 2 modules: ragbits-api-client and ragbits-api-client-react which implements hooks for ragbits-api-client (#582)
+- CI/CD changes for new directory structure (#582)
+- Move form definitions to JSONSchema (#616)
+- Allow UI cutomization using config endpoint (#643)
+- Add support for live updates and followup messages (#654)
+- Fix invalid context structure in requests from FE (#663)
+- Arrow Up and Arrow Down now cycle through sent messages in a terminal-like style (#667)
+- Fix followup messages not sending (#680)
+- Improve typing of TypeScript libraries (#681)
+- New metrics in for RagbitsAPI (#615)
+- Add debug panel with debug_mode field in config (#689)
+- Restore relative URL handling for UI build (#699)
+- Add integration tests for UI (#697)
+- Use external store instead of context for history (#706)
+
+## 1.0.0 (2025-06-04)
+
+### Changed
+
+- ragbits-core updated to version v1.0.0
+
+## 0.20.1 (2025-06-04)
+
+### Changed
+
+- ragbits-core updated to version v0.20.1
+
+## 0.20.0 (2025-06-03)
+
+### Changed
+
+- ragbits-core updated to version v0.20.0
+
+- remove HeroUI Pro components (#557)
+- refactor UI components to allow modifications (#579)
+- Add setup method to ChatInterface (#586)
+- Rebuild UI with new dependencies (#589)
+
+## 0.19.1 (2025-05-27)
+
+### Changed
+
+- ragbits-core updated to version v0.19.1
+
+- fix: dont import all persistence strategies in base file (#584)
+
+## 0.19.0 (2025-05-27)
+
+### Changed
+
+- ragbits-core updated to version v0.19.0
+
+- Add persistance component to save chat interactions from ragbits-chat (#556)
+- Add conversation_id parameter to chat interface context (#556)
+- Add uvicorn to dependencies (#578)
+- Remove HeroUI Pro components (#557)
+
+## 0.18.0 (2025-05-22)
+
+### Changed
+
+- ragbits-core updated to version v0.18.0
+
+- updated ui build (#553)
+- api integration improvements + history context changes (#552)
+- feedback form integration (#540)
+
+## 0.17.1 (2025-05-09)
+
+### Changed
+
+- ragbits-core updated to version v0.17.1
+
+## 0.17.0 (2025-05-06)
+
+### Changed
+
+- ragbits-core updated to version v0.17.0
+
+## 0.16.0 (2025-04-29)
+
+### Changed
+
+- ragbits-core updated to version v0.16.0
+
+## 0.15.0 (2025-04-28)
+
+### Changed
+
+- ragbits-core updated to version v0.15.0
+
+### Added
+
+- Added support for state updates in chat interfaces with automatic signature generation (#537).
+
+## 0.14.0 (2025-04-22)
+
+### Changed
+
+- ragbits-core updated to version v0.14.0
+
+## 0.13.0 (2025-04-02)
+
+### Changed
+
+- ragbits-core updated to version v0.13.0
+
+## 0.12.0 (2025-03-25)
+
+### Changed
+
+- ragbits-core updated to version v0.12.0
+
+## 0.11.0 (2025-03-25)
+
+### Changed
+
+- ragbits-core updated to version v0.11.0
+
+## 0.10.2 (2025-03-21)
+
+### Changed
+
+- ragbits-core updated to version v0.10.2
+
+## 0.10.1 (2025-03-19)
+
+### Changed
+
+- ragbits-core updated to version v0.10.1
+
+## 0.10.0 (2025-03-17)
+
+### Changed
+
+- ragbits-core updated to version v0.10.0
+
+## 0.9.0 (2025-02-25)
+
+### Changed
+
+- ragbits-core updated to version v0.9.0
+- Add support to persisting history of conversations using sqlalchemy (#354).
+
+## 0.8.0 (2025-01-29)
+
+### Changed
+
+- ragbits-core updated to version v0.8.0
+
+## 0.7.0 (2025-01-21)
+
+### Changed
+
+- ragbits-core updated to version v0.7.0
+
+### Added
+
+- Initial release of the package (#271).
+- Added last message recontextualization (#271).

ragbits_chat-0.0.8.dev23005/PKG-INFO

@@ -0,0 +1,44 @@
+Metadata-Version: 2.4
+Name: ragbits-chat
+Version: 0.0.8.dev23005
+Summary: Building blocks for rapid development of GenAI applications
+Project-URL: Homepage, https://github.com/deepsense-ai/ragbits
+Project-URL: Bug Reports, https://github.com/deepsense-ai/ragbits/issues
+Project-URL: Documentation, https://ragbits.deepsense.ai/
+Project-URL: Source, https://github.com/deepsense-ai/ragbits
+Author-email: "deepsense.ai" <ragbits@deepsense.ai>
+License-Expression: MIT
+Keywords: GenAI,Generative AI,LLMs,Large Language Models,Prompt Management,RAG,Retrieval Augmented Generation
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Requires-Dist: bcrypt>=4.2.0
+Requires-Dist: fastapi<1.0.0,>=0.115.0
+Requires-Dist: httpx<1.0.0,>=0.28.1
+Requires-Dist: python-jose[cryptography]>=3.5.0
+Requires-Dist: ragbits-core==0.0.8.dev23005
+Requires-Dist: uvicorn<1.0.0,>=0.31.0
+Provides-Extra: sql
+Requires-Dist: sqlalchemy<3.0.0,>=2.0.39; extra == 'sql'
+Description-Content-Type: text/markdown
+
+# Ragbits Chat
+
+ragbits-chat is a Python package that provides tools for building conversational AI applications.
+
+The package includes:
+- Framework for building chat experiences
+- History management for conversation tracking
+- UI components for building chat interfaces
+
+For detailed information, please refer to the [API documentation](https://ragbits.deepsense.ai/how-to/chatbots/api/).

ragbits_chat-0.0.8.dev23005/README.md

@@ -0,0 +1,10 @@
+# Ragbits Chat
+
+ragbits-chat is a Python package that provides tools for building conversational AI applications.
+
+The package includes:
+- Framework for building chat experiences
+- History management for conversation tracking
+- UI components for building chat interfaces
+
+For detailed information, please refer to the [API documentation](https://ragbits.deepsense.ai/how-to/chatbots/api/).

ragbits_chat-0.0.8.dev23005/pyproject.toml

@@ -0,0 +1,67 @@
+[project]
+name = "ragbits-chat"
+version = "0.0.8.dev23005"
+description = "Building blocks for rapid development of GenAI applications"
+readme = "README.md"
+requires-python = ">=3.10"
+license = "MIT"
+authors = [
+    { name = "deepsense.ai", email = "ragbits@deepsense.ai"}
+]
+keywords = [
+    "Retrieval Augmented Generation",
+    "RAG",
+    "Large Language Models",
+    "LLMs",
+    "Generative AI",
+    "GenAI",
+    "Prompt Management"
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Console",
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: MIT License",
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Scientific/Engineering :: Artificial Intelligence",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+dependencies = ["fastapi>=0.115.0,<1.0.0", "uvicorn>=0.31.0,<1.0.0", "httpx>=0.28.1,<1.0.0", "bcrypt>=4.2.0", "python-jose[cryptography]>=3.5.0", "ragbits-core==0.0.8.dev23005"]
+
+[project.urls]
+"Homepage" = "https://github.com/deepsense-ai/ragbits"
+"Bug Reports" = "https://github.com/deepsense-ai/ragbits/issues"
+"Documentation" = "https://ragbits.deepsense.ai/"
+"Source" = "https://github.com/deepsense-ai/ragbits"
+
+[project.optional-dependencies]
+sql = [
+    "sqlalchemy>=2.0.39,<3.0.0",
+]
+
+[tool.uv]
+dev-dependencies = [
+    "pre-commit~=3.8.0",
+    "pytest~=8.3.3",
+    "pytest-cov~=5.0.0",
+    "pytest-asyncio~=0.24.0",
+    "pip-licenses>=4.0.0,<5.0.0"
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.metadata]
+allow-direct-references = true
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/ragbits"]
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"

ragbits_chat-0.0.8.dev23005/src/ragbits/chat/__init__.py

@@ -0,0 +1,87 @@
+from ragbits.chat.auth import (
+    AuthenticationBackend,
+    AuthenticationResponse,
+    ListAuthenticationBackend,
+    User,
+    UserCredentials,
+)
+from ragbits.chat.client import (
+    RagbitsChatClient,
+    RagbitsConversation,
+    SyncRagbitsChatClient,
+    SyncRagbitsConversation,
+)
+from ragbits.chat.interface.types import (
+    ChatResponse,
+    ChatResponseType,
+    ChatResponseUnion,
+    ClearMessageContent,
+    ClearMessageResponse,
+    ConversationIdContent,
+    ConversationIdResponse,
+    ConversationSummaryContent,
+    ConversationSummaryResponse,
+    ErrorContent,
+    ErrorResponse,
+    FollowupMessagesContent,
+    FollowupMessagesResponse,
+    ImageResponse,
+    LiveUpdateResponse,
+    Message,
+    MessageIdContent,
+    MessageIdResponse,
+    MessageRole,
+    Reference,
+    ReferenceResponse,
+    ResponseContent,
+    StateUpdate,
+    StateUpdateResponse,
+    TextContent,
+    TextResponse,
+    TodoItemContent,
+    TodoItemResponse,
+    UsageContent,
+    UsageResponse,
+)
+
+__all__ = [
+    "AuthenticationBackend",
+    "AuthenticationResponse",
+    "ChatResponse",
+    "ChatResponseType",
+    "ChatResponseUnion",
+    "ClearMessageContent",
+    "ClearMessageResponse",
+    "ConversationIdContent",
+    "ConversationIdResponse",
+    "ConversationSummaryContent",
+    "ConversationSummaryResponse",
+    "ErrorContent",
+    "ErrorResponse",
+    "FollowupMessagesContent",
+    "FollowupMessagesResponse",
+    "ImageResponse",
+    "ListAuthenticationBackend",
+    "LiveUpdateResponse",
+    "Message",
+    "MessageIdContent",
+    "MessageIdResponse",
+    "MessageRole",
+    "RagbitsChatClient",
+    "RagbitsConversation",
+    "Reference",
+    "ReferenceResponse",
+    "ResponseContent",
+    "StateUpdate",
+    "StateUpdateResponse",
+    "SyncRagbitsChatClient",
+    "SyncRagbitsConversation",
+    "TextContent",
+    "TextResponse",
+    "TodoItemContent",
+    "TodoItemResponse",
+    "UsageContent",
+    "UsageResponse",
+    "User",
+    "UserCredentials",
+]

ragbits_chat-0.0.8.dev23005/src/ragbits/chat/_utils.py

@@ -0,0 +1,40 @@
+from __future__ import annotations
+
+import json
+import logging
+
+from pydantic import TypeAdapter
+
+from .interface.types import ChatResponse, ChatResponseUnion
+
+logger = logging.getLogger(__name__)
+
+
+def build_api_url(base_url: str, path: str) -> str:
+    """Join *base_url* and *path* preserving exactly one slash."""
+    base = base_url.rstrip("/")
+    if not path.startswith("/"):
+        path = f"/{path}"
+    return f"{base}{path}"
+
+
+PREFIX = "data: "
+
+
+def parse_sse_line(line: str) -> ChatResponse | None:
+    r"""Parse a single *Server-Sent-Event* line coming from RagbitsAPI.
+
+    Expected format:  ``data: {....json....}\n``
+    Returns a *ChatResponse* instance or ``None`` if the line is not a
+    data line. Parsing/validation errors are logged (and ``None`` is returned).
+    """
+    if not line.startswith(PREFIX):
+        return None
+    try:
+        json_payload = line[len(PREFIX) :].strip()
+        data = json.loads(json_payload)
+        adapter: TypeAdapter[ChatResponseUnion] = TypeAdapter(ChatResponseUnion)
+        return adapter.validate_python(data)
+    except Exception as exc:
+        logger.error("Failed to parse SSE line: %s", exc, exc_info=True)
+        return None

ragbits_chat-0.0.8.dev23005/src/ragbits/chat/adapters/__init__.py

@@ -0,0 +1,56 @@
+"""Response adapters for transforming chat response streams.
+
+This module provides a composable adapter system for transforming chat responses
+through a pipeline of adapters, each handling a specific concern.
+
+Example:
+    >>> from ragbits.chat.adapters import (
+    ...     AdapterPipeline,
+    ...     ChatResponseAdapter,
+    ...     FilterAdapter,
+    ...     ToolResultTextAdapter,
+    ... )
+    >>>
+    >>> async def render_products(tool_call):
+    ...     return f"Found {len(tool_call.result)} products"
+    >>>
+    >>> pipeline = AdapterPipeline([
+    ...     ChatResponseAdapter(),
+    ...     FilterAdapter(exclude_types=(SomeUICommand,)),
+    ...     ToolResultTextAdapter(
+    ...         renderers={"show_products": render_products},
+    ...         pass_through=True,
+    ...     ),
+    ... ])
+    >>>
+    >>> async for chunk in pipeline.process(chat_stream, context):
+    ...     print(chunk)
+"""
+
+from ragbits.chat.adapters.builtin import (
+    ChatResponseAdapter,
+    FilterAdapter,
+    TextAccumulatorAdapter,
+    ToolCallAccumulatorAdapter,
+    ToolResultTextAdapter,
+    UsageAggregatorAdapter,
+)
+from ragbits.chat.adapters.pipeline import AdapterPipeline
+from ragbits.chat.adapters.protocol import (
+    AdapterContext,
+    BaseAdapter,
+    ResponseAdapter,
+)
+
+__all__ = [
+    "AdapterContext",
+    "AdapterPipeline",
+    "BaseAdapter",
+    "ChatResponseAdapter",
+    "FilterAdapter",
+    "ResponseAdapter",
+    "TextAccumulatorAdapter",
+    "ToolCallAccumulatorAdapter",
+    "ToolResultTextAdapter",
+    "UsageAggregatorAdapter",
+]