Skip to content

OpenRAG is a comprehensive, single package Retrieval-Augmented Generation platform built on Langflow, Docling, and Opensearch.

Python
2.8 KB
Raw Blame
"""
Public API v1 Settings endpoint.

Provides access to configuration settings.
Uses API key authentication.
"""

from fastapi import Depends
from fastapi.responses import JSONResponse
from pydantic import BaseModel

from api.settings import SettingsUpdateBody
from config.settings import get_openrag_config
from dependencies import (
    get_models_service,
    get_rbac_service,
    get_session_manager,
    require_api_key_permission,
)
from session_manager import User
from utils.logging_config import get_logger

logger = get_logger(__name__)


class AgentSettings(BaseModel):
    llm_provider: str | None = None
    llm_model: str | None = None
    system_prompt: str | None = None


class KnowledgeSettings(BaseModel):
    embedding_provider: str | None = None
    embedding_model: str | None = None
    chunk_size: int | None = None
    chunk_overlap: int | None = None
    table_structure: bool | None = None
    ocr: bool | None = None
    picture_descriptions: bool | None = None


class SettingsResponse(BaseModel):
    agent: AgentSettings
    knowledge: KnowledgeSettings


async def get_settings_endpoint(
    user: User = Depends(require_api_key_permission("providers:read")),
) -> SettingsResponse:
    """Get current OpenRAG configuration (read-only). GET /v1/settings"""
    try:
        config = get_openrag_config()
        return SettingsResponse(
            agent=AgentSettings(
                llm_provider=config.agent.llm_provider,
                llm_model=config.agent.llm_model,
                system_prompt=config.agent.system_prompt,
            ),
            knowledge=KnowledgeSettings(
                embedding_provider=config.knowledge.embedding_provider,
                embedding_model=config.knowledge.embedding_model,
                chunk_size=config.knowledge.chunk_size,
                chunk_overlap=config.knowledge.chunk_overlap,
                table_structure=config.knowledge.table_structure,
                ocr=config.knowledge.ocr,
                picture_descriptions=config.knowledge.picture_descriptions,
            ),
        )
    except Exception as e:
        logger.error("Failed to get settings", error=str(e))
        return JSONResponse({"error": "Failed to get settings"}, status_code=500)


async def update_settings_endpoint(
    body: SettingsUpdateBody,
    session_manager=Depends(get_session_manager),
    user: User = Depends(require_api_key_permission("config:write")),
    models_service=Depends(get_models_service),
    rbac=Depends(get_rbac_service),
):
    """Update OpenRAG configuration settings. POST /v1/settings"""
    from api.settings import update_settings

    return await update_settings(
        body=body,
        session_manager=session_manager,
        user=user,
        models_service=models_service,
        rbac=rbac,
    )