OpenRAG is a comprehensive, single package Retrieval-Augmented Generation platform built on Langflow, Docling, and Opensearch.
Python
"""Pydantic request and response models for the settings/onboarding endpoints.
Lifted verbatim from the original `src/api/settings.py` (lines 49–223). No
shape changes — every external caller sees the same fields and validators
they did before. See `src/api/settings/__init__.py` for re-exports.
"""
from typing import Any
from pydantic import BaseModel, Field, field_validator
from services.docling_service import DoclingConfig
# OCR languages grouped by the recognition model that serves them. English is
# universal and therefore absent: it combines with every family. Mirrors
# frontend/lib/ocr-languages.ts.
OCR_LANGUAGE_FAMILIES = {
"fr": "latin",
"de": "latin",
"es": "latin",
"it": "latin",
"pt": "latin",
"vi": "latin",
"ru": "cyrillic",
"uk": "cyrillic",
"ar": "arabic",
"ja": "japanese",
"ko": "korean",
"zh-Hans": "chinese_simplified",
"zh-Hant": "chinese_traditional",
"th": "thai",
}
class SettingsUpdateBody(BaseModel):
llm_model: str | None = Field(None, min_length=1)
llm_provider: str | None = Field(None, min_length=1)
system_prompt: str | None = None
chunk_size: int | None = Field(None, gt=0)
chunk_overlap: int | None = Field(None, ge=0)
table_structure: bool | None = None
ocr: bool | None = None
ocr_languages: list[str] | None = None
picture_descriptions: bool | None = None
disable_ingest_with_langflow: bool | None = None
vlm_enabled: bool | None = None
# Providers are configurable — `config/model_providers.yaml` plus the custom
# entries an operator adds — so this cannot be a closed list. The old enum
# rejected every provider introduced after it (`azure_ai` first among them)
# and 422'd the entire ingest-settings save, not just the VLM fields. Check
# the shape of a provider key here; whether it is *configured* is checked in
# `update_settings`, where the provider config is in hand.
vlm_provider: str | None = Field(None, pattern=r"^[A-Za-z0-9][A-Za-z0-9_.-]*$")
vlm_model: str | None = Field(None, min_length=1)
vlm_prompt: str | None = None
vlm_response_format: str | None = Field(None, pattern="^(markdown|doctags|html)$")
vlm_max_tokens: int | None = Field(None, gt=0)
vlm_concurrency: int | None = Field(None, gt=0)
vlm_timeout: int | None = Field(None, gt=0)
vlm_watsonx_api_version: str | None = Field(None, min_length=1)
embedding_model: str | None = Field(None, min_length=1)
embedding_provider: str | None = Field(None, min_length=1)
index_name: str | None = Field(None, min_length=1)
openai_api_key: str | None = Field(None, min_length=1)
anthropic_api_key: str | None = Field(None, min_length=1)
watsonx_api_key: str | None = Field(None, min_length=1)
watsonx_endpoint: str | None = Field(None, min_length=1)
watsonx_project_id: str | None = Field(None, min_length=1)
ollama_endpoint: str | None = Field(None, min_length=1)
remove_ollama_config: bool | None = None
remove_openai_config: bool | None = None
remove_anthropic_config: bool | None = None
remove_watsonx_config: bool | None = None
provider_credentials: dict[str, dict[str, str]] | None = None
provider_credential_removals: dict[str, list[str]] | None = None
provider_auth_methods: dict[str, str] | None = None
remove_provider_config: str | None = None
# Explicit confirmation that the caller accepts removing a provider whose
# embedding models are still in use by indexed documents. Without this,
# the backend returns 409 and the frontend prompts the user.
force_remove: bool | None = False
@field_validator("ocr_languages")
@classmethod
def _validate_ocr_languages(cls, value: list[str] | None) -> list[str] | None:
"""Reject blank entries and combinations no OCR engine can serve.
An empty list is accepted and clears the override: no ocr_lang is sent
to docling, so the engine default applies.
Mirrors the picker's rules (frontend/lib/ocr-languages.ts) so the API
cannot be driven into a state the UI prevents. Duplicated on purpose:
the two run in different languages and are tested independently.
"""
if value is None:
return None
if not value:
return []
cleaned = [language.strip() for language in value]
if any(not language for language in cleaned):
raise ValueError("ocr_languages must not contain blank entries")
# easyocr loads a single recognition model per job and rejects anything
# outside it. Unknown codes are the operator's pass-through escape
# hatch and are deliberately not constrained.
families = {
OCR_LANGUAGE_FAMILIES[language]
for language in cleaned
if language in OCR_LANGUAGE_FAMILIES
}
if len(families) > 1:
raise ValueError(
"ocr_languages mixes scripts that no single OCR model can serve "
f"({', '.join(sorted(families))}); combine one script with English"
)
# Keep English last in the persisted list, matching OCR priority on macOS.
return [language for language in cleaned if language != "en"] + (
["en"] if "en" in cleaned else []
)
class OnboardingBody(BaseModel):
llm_provider: str | None = Field(None, min_length=1)
llm_model: str | None = Field(None, min_length=1)
embedding_provider: str | None = Field(None, min_length=1)
embedding_model: str | None = Field(None, min_length=1)
openai_api_key: str | None = Field(None, min_length=1)
anthropic_api_key: str | None = Field(None, min_length=1)
watsonx_api_key: str | None = Field(None, min_length=1)
watsonx_endpoint: str | None = Field(None, min_length=1)
watsonx_project_id: str | None = Field(None, min_length=1)
ollama_endpoint: str | None = Field(None, min_length=1)
provider_credentials: dict[str, dict[str, str]] | None = None
provider_credential_removals: dict[str, list[str]] | None = None
provider_auth_methods: dict[str, str] | None = None
class CitationDisplayData(BaseModel):
file_path: str | None = None
page: int | str | None = None
score: float | str | None = None
text: str | None = None
embedding_model: str | None = None
parser: str | None = None
chunk_size: int | float | str | None = None
chunk_overlap: int | float | str | None = None
metadata: dict[str, Any] | None = None
class CitationDisplayResult(BaseModel):
data: CitationDisplayData | None = None
chunk_id: str | None = None
id: str | None = None
filename: str | None = None
page: int | str | None = None
score: float | str | None = None
text: str | None = None
embedding_model: str | None = None
parser: str | None = None
chunk_size: int | float | str | None = None
chunk_overlap: int | float | str | None = None
source_url: str | None = None
metadata: dict[str, Any] | None = None
class CitationDisplayResultGroup(BaseModel):
results: list[CitationDisplayResult]
class OnboardingFunctionCall(BaseModel):
name: str
status: str
result: list[CitationDisplayResultGroup | CitationDisplayResult] | None = None
@field_validator("result", mode="before")
@classmethod
def ignore_non_list_result(cls, value: Any) -> Any:
if value is None or isinstance(value, list):
return value
return None
class AssistantMessage(BaseModel):
role: str
content: str
timestamp: str
functionCalls: list[OnboardingFunctionCall] | None = None
class OnboardingStateBody(BaseModel):
current_step: int | None = None
assistant_message: AssistantMessage | None = None
selected_nudge: str | None = None
card_steps: dict[str, Any] | None = None
upload_steps: dict[str, Any] | None = None
openrag_docs_filter_id: str | None = None
user_doc_filter_id: str | None = None
openrag_docs_ingested_version: str | None = None
openrag_docs_remote_signature: str | None = None
class DoclingPresetBody(BaseModel):
preset: str | None = None
table_structure: bool | None = None
ocr: bool | None = None
picture_descriptions: bool | None = None
class OnboardingStateConfig(BaseModel):
current_step: int | None
assistant_message: AssistantMessage | None
selected_nudge: str | None
card_steps: dict[str, Any] | None
upload_steps: dict[str, Any] | None
openrag_docs_filter_id: str | None
user_doc_filter_id: str | None
openrag_docs_ingested_version: str | None
openrag_docs_remote_signature: str | None
class OpenAIProviderConfig(BaseModel):
has_api_key: bool
configured: bool
class AnthropicProviderConfig(BaseModel):
has_api_key: bool
configured: bool
class WatsonXProviderConfig(BaseModel):
has_api_key: bool
endpoint: str | None
project_id: str | None
configured: bool
class OllamaProviderConfig(BaseModel):
endpoint: str | None
configured: bool
class GenericProviderConfig(BaseModel):
configured: bool
auth_method: str | None = None
credential_values: dict[str, str] = Field(default_factory=dict)
secret_fields: list[str] = Field(default_factory=list)
class ProvidersConfig(BaseModel):
openai: OpenAIProviderConfig
anthropic: AnthropicProviderConfig
watsonx: WatsonXProviderConfig
ollama: OllamaProviderConfig
custom: dict[str, GenericProviderConfig] = Field(default_factory=dict)
class KnowledgeConfig(BaseModel):
embedding_model: str | None
embedding_provider: str | None
chunk_size: int | None
chunk_overlap: int | None
table_structure: bool | None
ocr: bool | None
ocr_languages: list[str] | None = None
picture_descriptions: bool | None
index_name: str | None
disable_ingest_with_langflow: bool | None
vlm_enabled: bool | None = None
vlm_provider: str | None = None
vlm_model: str | None = None
vlm_prompt: str | None = None
vlm_response_format: str | None = None
vlm_max_tokens: int | None = None
vlm_concurrency: int | None = None
vlm_timeout: int | None = None
vlm_watsonx_api_version: str | None = None
class AgentConfig(BaseModel):
llm_model: str | None
llm_provider: str | None
system_prompt: str | None
default_system_prompt: str | None = None
class IngestionDefaultsConfig(BaseModel):
chunkSize: int | None
chunkOverlap: int | None
separator: str | None
embeddingModel: str | None
class SettingsResponse(BaseModel):
langflow_url: str
flow_id: str | None
ingest_flow_id: str | None
langflow_public_url: str | None
edited: bool
onboarding: OnboardingStateConfig
# None when the caller lacks `providers:read` (RBAC redaction for non-admins).
providers: ProvidersConfig | None = None
knowledge: KnowledgeConfig
agent: AgentConfig
localhost_url: str
langflow_edit_url: str | None = None
langflow_ingest_edit_url: str | None = None
ingestion_defaults: IngestionDefaultsConfig | None = None
ingest_via_chat: bool = False
show_provider_ingest_settings: bool = False
show_vlm_settings: bool = True
local_vlm_models: list[str] = Field(default_factory=list)
show_shared_upload_toggle: bool = False
show_url_connector: bool = False
show_workspace_oauth_overrides: bool = False
segment_write_key: str | None = None
environment: str | None = None
langflow_port: str | None = None
class OnboardingResponse(BaseModel):
message: str
edited: bool
sample_data_ingested: bool
openrag_docs_filter_id: str | None = None
task_id: str | None = None
chunk_size_adjusted_to: int | None = None
class RefreshOpenRAGDocsResponse(BaseModel):
message: str
refreshed: bool
class DoclingPresetResponse(BaseModel):
message: str
settings: dict
preset_config: DoclingConfig
class OnboardingStateResponse(BaseModel):
message: str
updated_fields: list[str]
class SettingsUpdateResponse(BaseModel):
message: str
class RollbackResponse(BaseModel):
message: str
cancelled_tasks: int
deleted_files: int
reset_flows: int
deleted_conversations: int
class RollbackBody(BaseModel):
embedding_only: bool = False