logo
Sign In

Confluence Search

tool

This tool allows you to search for and retrieve content from Confluence. (An Atlassian tool)

romainneup
@romainneup
·
a year ago
1.6K
5
7.2K
Updated a year ago
Created Feb 12, 2025
confluence_search.py
Python · 1057 lines
"""
title: Confluence search
description: This tool allows you to search for and retrieve content from Confluence.
repository: https://github.com/RomainNeup/open-webui-utilities
author: @romainneup
author_url: https://github.com/RomainNeup
funding_url: https://github.com/sponsors/RomainNeup
requirements: markdownify, sentence-transformers, numpy, rank_bm25, scikit-learn
version: 0.4.0
changelog:
- 0.0.1 - Initial code base.
- 0.0.2 - Fix Valves variables

confluence_search.py

https://github.com/RomainNeup/open-webui-utilities
This tool searches for Confluence pages using a given query string with RAG (Retrieval Augmented Generation) capabilities.

  • Configuration:
    • Username: [email protected]
    • API Key: 1234ABCD
    • Base URL: https://example.atlassian.net/wiki
    • Ssl Verify: Default to true, disable if you have a self-signed certificate
    • Result Limit: Maximum number of pages to retrieve from Confluence API
    • RAG Settings:
      • embedding_model_save_path: Path to save embedding models
      • embedding_model_name: Name/path of the embedding model to use
      • cpu_only: Run the tool on CPU only (vs GPU)
      • chunk_size: Maximum size of each content chunk for processing
      • chunk_overlap: Overlap between consecutive chunks
      • max_results: Maximum number of relevant chunks to return
      • similarity_threshold: Minimum similarity score to include results
      • ensemble_weighting: Balance between keyword (0) and semantic (1) search
      • enable_hybrid_search: Enable combined semantic and keyword search
      • full_context: Return full document content vs just relevant chunks
      • max_page_size: Maximum size in characters for a Confluence page
      • batch_size: Number of documents to process in each batch
  • User Settings:
    • api_key_auth: Use API key authentication (true) or personal access token (false)
    • username: Override default username for authentication
    • api_key: Override default API key or personal access token
    • split_terms: Split search query into words for better search results
    • included_confluence_spaces: Comma-separated list of Confluence spaces to search in (leave empty for all). Be aware that it can conflict with the excluded_confluence_spaces setting.
    • excluded_confluence_spaces: Comma-separated list of Confluence spaces to exclude from search (leave empty for none). Be aware that it can conflict with the included_confluence_spaces setting.
  • Usage: Run the script and provide the search query as an argument. The tool will return the most relevant Confluence pages and content sections.
3