# romainneup/open-webui-utilities architecture

> Architecture diagram of the GitHub repository romainneup/open-webui-utilities, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-05). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/romainneup/open-webui-utilities
- Repository: https://github.com/romainneup/open-webui-utilities

## Overview

This repository is a set of Open WebUI tools for retrieving individual Jira issues and Confluence pages, and searching both products with RAG. The user invokes a tool with an ID or query; the tool authenticates to the relevant Atlassian API and returns content or relevant search results, with status and citation events. Search tools also support chunking and keyword/semantic retrieval, with configurable embedding backends. Search internals are only partially excerpted, so undocumented internal calls are omitted; documented capabilities are retained.

Main entry points: [`confluence_search.py`](https://github.com/romainneup/open-webui-utilities/blob/master/confluence_search.py) (Page search tool), [`jira_search.py`](https://github.com/romainneup/open-webui-utilities/blob/master/jira_search.py) (Issue search tool), [`confluence_page.py`](https://github.com/romainneup/open-webui-utilities/blob/master/confluence_page.py) (Page retrieval tool), [`jira_issue.py`](https://github.com/romainneup/open-webui-utilities/blob/master/jira_issue.py) (Issue retrieval tool)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_entry["Open WebUI tools"]
  node_confluence_page_tool["Page retrieval tool<br/>[confluence_page.py]"]
  node_confluence_search_tool["Page search tool"]
  node_jira_issue_tool["Issue retrieval tool<br/>[jira_issue.py]"]
  node_jira_search_tool["Issue search tool<br/>[jira_search.py]"]
end

subgraph group_atlassian["Atlassian access"]
  node_confluence_api["Confluence API client<br/>[confluence_page.py]"]
  node_jira_api["Jira API client<br/>[jira_issue.py]"]
  node_confluence_service{{"Confluence service"}}
  node_jira_service{{"Jira service"}}
end

subgraph group_search["RAG search"]
  node_confluence_rag["Confluence RAG"]
  node_jira_rag["Jira RAG<br/>[jira_search.py]"]
  node_chunking["Content chunking"]
  node_keyword_retrieval["Keyword retrieval"]
  node_semantic_retrieval["Semantic retrieval"]
end

subgraph group_embeddings["Embedding services"]
  node_ollama{{"Ollama embeddings"}}
  node_openai_embeddings{{"OpenAI embeddings"}}
  node_sentence_transformers{{"Sentence Transformers"}}
end

node_user(("Workspace user"))

node_user -->|"requests page"| node_confluence_page_tool
node_user -->|"searches pages"| node_confluence_search_tool
node_user -->|"requests issue"| node_jira_issue_tool
node_user -->|"searches issues"| node_jira_search_tool
node_confluence_page_tool -->|"gets page"| node_confluence_api
node_jira_issue_tool -->|"gets issue"| node_jira_api
node_confluence_api -->|"requests content"| node_confluence_service
node_jira_api -->|"requests issues"| node_jira_service
node_confluence_search_tool -->|"searches pages"| node_confluence_service
node_jira_search_tool -->|"searches issues"| node_jira_service
node_confluence_search_tool -->|"retrieves relevant content"| node_confluence_rag
node_jira_search_tool -->|"retrieves relevant content"| node_jira_rag
node_confluence_search_tool -->|"chunks content"| node_chunking
node_confluence_search_tool -->|"supports hybrid search"| node_keyword_retrieval
node_confluence_search_tool -->|"supports semantic search"| node_semantic_retrieval
node_confluence_rag -.->|"embeds with"| node_ollama
node_confluence_rag -.->|"embeds with"| node_openai_embeddings
node_confluence_rag -.->|"embeds with"| node_sentence_transformers
node_jira_rag -.->|"embeds with"| node_openai_embeddings
node_jira_rag -.->|"embeds with"| node_sentence_transformers

click node_confluence_page_tool "https://github.com/romainneup/open-webui-utilities/blob/master/confluence_page.py"
click node_confluence_search_tool "https://github.com/romainneup/open-webui-utilities/blob/master/confluence_search.py"
click node_jira_issue_tool "https://github.com/romainneup/open-webui-utilities/blob/master/jira_issue.py"
click node_jira_search_tool "https://github.com/romainneup/open-webui-utilities/blob/master/jira_search.py"
click node_confluence_api "https://github.com/romainneup/open-webui-utilities/blob/master/confluence_page.py"
click node_jira_api "https://github.com/romainneup/open-webui-utilities/blob/master/jira_issue.py"
click node_confluence_rag "https://github.com/romainneup/open-webui-utilities/blob/master/confluence_search.py"
click node_jira_rag "https://github.com/romainneup/open-webui-utilities/blob/master/jira_search.py"
click node_chunking "https://github.com/romainneup/open-webui-utilities/blob/master/confluence_search.py"
click node_keyword_retrieval "https://github.com/romainneup/open-webui-utilities/blob/master/confluence_search.py"
click node_semantic_retrieval "https://github.com/romainneup/open-webui-utilities/blob/master/confluence_search.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_confluence_page_tool,node_confluence_search_tool,node_jira_issue_tool,node_jira_search_tool,node_user toneBlue
class node_confluence_api,node_jira_api,node_confluence_service,node_jira_service toneAmber
class node_confluence_rag,node_jira_rag,node_chunking,node_keyword_retrieval,node_semantic_retrieval toneMint
class node_ollama,node_openai_embeddings,node_sentence_transformers toneRose
```

## Components

### Open WebUI tools

- [Page retrieval tool](https://github.com/romainneup/open-webui-utilities/blob/master/confluence_page.py): `confluence_page.py`
- [Page search tool](https://github.com/romainneup/open-webui-utilities/blob/master/confluence_search.py): `confluence_search.py`
- [Issue retrieval tool](https://github.com/romainneup/open-webui-utilities/blob/master/jira_issue.py): `jira_issue.py`
- [Issue search tool](https://github.com/romainneup/open-webui-utilities/blob/master/jira_search.py): `jira_search.py`

### Atlassian access

- [Confluence API client](https://github.com/romainneup/open-webui-utilities/blob/master/confluence_page.py): `confluence_page.py`
- [Jira API client](https://github.com/romainneup/open-webui-utilities/blob/master/jira_issue.py): `jira_issue.py`
- **Confluence service**
- **Jira service**

### RAG search

- [Confluence RAG](https://github.com/romainneup/open-webui-utilities/blob/master/confluence_search.py): `confluence_search.py`
- [Jira RAG](https://github.com/romainneup/open-webui-utilities/blob/master/jira_search.py): `jira_search.py`
- [Content chunking](https://github.com/romainneup/open-webui-utilities/blob/master/confluence_search.py): `confluence_search.py`
- [Keyword retrieval](https://github.com/romainneup/open-webui-utilities/blob/master/confluence_search.py): `confluence_search.py`
- [Semantic retrieval](https://github.com/romainneup/open-webui-utilities/blob/master/confluence_search.py): `confluence_search.py`

### Embedding services

- **Ollama embeddings**
- **OpenAI embeddings**
- **Sentence Transformers**

### Other components

- **Workspace user**

## Connections

- Workspace user → Page retrieval tool: requests page (evidence: `README.md`)
- Workspace user → Page search tool: searches pages (evidence: `README.md`)
- Workspace user → Issue retrieval tool: requests issue (evidence: `README.md`)
- Workspace user → Issue search tool: searches issues (evidence: `README.md`)
- Page retrieval tool → Confluence API client: gets page (evidence: `confluence_page.py`)
- Issue retrieval tool → Jira API client: gets issue (evidence: `jira_issue.py`)
- Confluence API client → Confluence service: requests content (evidence: `confluence_page.py`)
- Jira API client → Jira service: requests issues (evidence: `jira_issue.py`)
- Page search tool → Confluence service: searches pages (evidence: `README.md`)
- Issue search tool → Jira service: searches issues (evidence: `README.md`)
- Page search tool → Confluence RAG: retrieves relevant content (evidence: `README.md`)
- Issue search tool → Jira RAG: retrieves relevant content (evidence: `README.md`)
- Page search tool → Content chunking: chunks content (evidence: `confluence_search.py`)
- Page search tool → Keyword retrieval: supports hybrid search (evidence: `confluence_search.py`)
- Page search tool → Semantic retrieval: supports semantic search (evidence: `confluence_search.py`)
- Confluence RAG → Ollama embeddings: embeds with
- Confluence RAG → OpenAI embeddings: embeds with
- Confluence RAG → Sentence Transformers: embeds with
- Jira RAG → OpenAI embeddings: embeds with
- Jira RAG → Sentence Transformers: embeds with
