ollama_manager Namespace Reference

Classes
class	SQLQuery

Functions
	setup_ollama ()
	pre_check_ollama_enabled ()
	check_ollama_enabled (func)
	get_ollama_models ()
pd.DataFrame	storage_table_to_csv (str path)
	ask_question (msg)

Variables
Annotated	ENV_PATH
	dotenv_path
tuple	is_ollama_enabled
Annotated	ollama_host
Annotated	default_model
Annotated	DATABASE_PATH
	prompt_instance
	fallback_prompt_instance
	global_Pipeline = setup_ollama()

Detailed Description

This module manages interactions with the Ollama model and the SQLite database.

It includes functions to set up the Ollama pipeline, check if the Ollama feature is enabled,
fetch Ollama models, convert the storage table to a CSV file, and ask questions to the Ollama model.

Classes:
    SQLQuery: A class to execute SQL queries on the SQLite database.

Functions:
    setup_ollama: Sets up the Ollama pipeline.
    pre_check_ollama_enabled: Checks if the Ollama feature is enabled.
    check_ollama_enabled: A decorator to check if Ollama is enabled before executing a function.
    get_ollama_models: Fetches a list of Ollama models from a specified API endpoint.
    storage_table_to_csv: Converts the 'storage' table from the SQLite database to a CSV file.
    ask_question: Asks a question to the Ollama model using a haystack pipeline.

Function Documentation

ask_question()

ollama_manager.ask_question

(

msg

)

Asks a question to the Ollama model using a haystack pipeline.

Args:
    msg (str): The question to ask the Ollama model.

Returns:
    tuple: A tuple containing the type of response ("Item" or "Fallback") and the response itself.

Definition at line 253 of file ollama_manager.py.

def ask_question(msg):
    """
    Asks a question to the Ollama model using a haystack pipeline.
 
    Args:
        msg (str): The question to ask the Ollama model.
 
    Returns:
        tuple: A tuple containing the type of response ("Item" or "Fallback") and the response itself.
    """
    table = storage_table_to_csv(DATABASE_PATH)
    columns = table.columns.tolist()
    result = global_Pipeline.run(
        {
            "prompt": {"question": msg, "columns": columns},
            "router": {"question": msg},
            "fallback_prompt": {"columns": columns},
        }
    )
 
    if "sql_querier" in result:
        result = result["sql_querier"]["results"][0]
        logger.info(
            f"llm answered with the following SQL query: {result} with type {type(result)}"
        )
        return "Item", result
    if "fallback_llm" in result:
        result = result["fallback_llm"]["replies"][0]
        logger.info(
            f"llm answered with the following fallback: {result} with type {type(result)}"
        )
        return "Fallback", result
 
 

check_ollama_enabled()

ollama_manager.check_ollama_enabled

(

func

)

Decorator to check if Ollama is enabled before executing the function.
This decorator wraps a function and checks if Ollama is enabled by calling
the `pre_check_ollama_enabled` function. If Ollama is enabled, the wrapped
function is executed. Otherwise, a log message is generated, and the function
execution is skipped.
Args:
    func (callable): The function to be wrapped by the decorator.
Returns:
    callable: The wrapped function that includes the Ollama enabled check.

Definition at line 190 of file ollama_manager.py.

def check_ollama_enabled(func):
    """
    Decorator to check if Ollama is enabled before executing the function.
    This decorator wraps a function and checks if Ollama is enabled by calling
    the `pre_check_ollama_enabled` function. If Ollama is enabled, the wrapped
    function is executed. Otherwise, a log message is generated, and the function
    execution is skipped.
    Args:
        func (callable): The function to be wrapped by the decorator.
    Returns:
        callable: The wrapped function that includes the Ollama enabled check.
    """
 
    @wraps(func)
    def wrapper(*args, **kwargs):
        if pre_check_ollama_enabled():
            return func(*args, **kwargs)
 
        logger.info(
            f"Ollama is not enabled. Execution of function {func.__name__} skipped."
        )
        return None
 
    return wrapper
 
 
@check_ollama_enabled

get_ollama_models()

ollama_manager.get_ollama_models

(

)

Fetches a list of Ollama models from a specified API endpoint.
This function sends a GET request to the API endpoint at "http://10.45.2.60:11434/api/tags",
retrieves the JSON response, and extracts the list of models from the response data.
Returns:
    list: A list of model names (strings) retrieved from the API response.

Definition at line 217 of file ollama_manager.py.

def get_ollama_models():
    """
    Fetches a list of Ollama models from a specified API endpoint.
    This function sends a GET request to the API endpoint at "http://10.45.2.60:11434/api/tags",
    retrieves the JSON response, and extracts the list of models from the response data.
    Returns:
        list: A list of model names (strings) retrieved from the API response.
    """
    url = f"{ollama_host}/api/tags"
    response = requests.get(url, timeout=10)
    data = response.json()
    models = data.get("models", [])
    model_list = []
    for model in models:
        model_list.append(model["model"])
    return model_list
 
 

pre_check_ollama_enabled()

ollama_manager.pre_check_ollama_enabled

(

)

Checks if the Ollama feature is enabled.
Returns:
    bool: True if the Ollama feature is enabled, False otherwise.

Definition at line 179 of file ollama_manager.py.

def pre_check_ollama_enabled():
    """
    Checks if the Ollama feature is enabled.
    Returns:
        bool: True if the Ollama feature is enabled, False otherwise.
    """
    if is_ollama_enabled:
        return True
    return False
 
 

setup_ollama()

ollama_manager.setup_ollama

(

)

Sets up the Ollama pipeline with the necessary components and connections.

This function initializes the SQLQuery component, defines routing conditions,
and sets up the ConditionalRouter, OllamaGenerator, and fallback components.
It then creates a Pipeline, adds the components to it, and connects them
according to the defined routes.

Returns:
    Pipeline: The configured Ollama pipeline.

Definition at line 128 of file ollama_manager.py.

def setup_ollama():
    """
    Sets up the Ollama pipeline with the necessary components and connections.
 
    This function initializes the SQLQuery component, defines routing conditions,
    and sets up the ConditionalRouter, OllamaGenerator, and fallback components.
    It then creates a Pipeline, adds the components to it, and connects them
    according to the defined routes.
 
    Returns:
        Pipeline: The configured Ollama pipeline.
    """
    sql_query = SQLQuery(DATABASE_PATH)
 
    routes = [
        {
            "condition": "{{'no_answer' not in replies[0]}}",
            "output": "{{replies}}",
            "output_name": "sql",
            "output_type": List[str],
        },
        {
            "condition": "{{'no_answer'|lower in replies[0]|lower}}",
            "output": "{{question}}",
            "output_name": "go_to_fallback",
            "output_type": str,
        },
    ]
    router = ConditionalRouter(routes)
    llm = OllamaGenerator(model=default_model, url=ollama_host)
    fallback_llm = OllamaGenerator(model=default_model, url=ollama_host)
 
    conditional_sql_pipeline = Pipeline()
    conditional_sql_pipeline.add_component("prompt", prompt_instance)
    conditional_sql_pipeline.add_component("llm", llm)
    conditional_sql_pipeline.add_component("router", router)
    conditional_sql_pipeline.add_component("fallback_prompt", fallback_prompt_instance)
    conditional_sql_pipeline.add_component("fallback_llm", fallback_llm)
    conditional_sql_pipeline.add_component("sql_querier", sql_query)
 
    conditional_sql_pipeline.connect("prompt", "llm")
    conditional_sql_pipeline.connect("llm.replies", "router.replies")
    conditional_sql_pipeline.connect("router.sql", "sql_querier.queries")
    conditional_sql_pipeline.connect(
        "router.go_to_fallback", "fallback_prompt.question"
    )
    conditional_sql_pipeline.connect("fallback_prompt", "fallback_llm")
 
    return conditional_sql_pipeline
 
 

storage_table_to_csv()

pd.DataFrame ollama_manager.storage_table_to_csv

(

str

path

)

Converts the 'storage' table from the SQLite database to a CSV file.

Args:
    path (str): The file path to the SQLite database.

Returns:
    pd.DataFrame: A DataFrame containing the data from the 'storage' table.

Definition at line 235 of file ollama_manager.py.

def storage_table_to_csv(path: str) -> pd.DataFrame:
    """
    Converts the 'storage' table from the SQLite database to a CSV file.
 
    Args:
        path (str): The file path to the SQLite database.
 
    Returns:
        pd.DataFrame: A DataFrame containing the data from the 'storage' table.
    """
    abs_path = os.path.abspath(path)
    engine = create_engine(f"sqlite:///{abs_path}")
    with engine.connect() as conn:
        table = pd.read_sql_query("SELECT * FROM storage", conn)
    return table
 
 
@check_ollama_enabled

Variable Documentation

DATABASE_PATH

Annotated ollama_manager.DATABASE_PATH

Initial value:

=  os.path.join(
    os.path.dirname(__file__), "data/storage.db"
)

Definition at line 47 of file ollama_manager.py.

default_model

Annotated ollama_manager.default_model

Initial value:

=  os.getenv(
    "DEFAULT_MODEL"
)

Definition at line 43 of file ollama_manager.py.

dotenv_path

ollama_manager.dotenv_path

Definition at line 35 of file ollama_manager.py.

ENV_PATH

Annotated ollama_manager.ENV_PATH

Initial value:

=  os.path.join(
    os.path.dirname(__file__), "data/.env"
)

Definition at line 32 of file ollama_manager.py.

fallback_prompt_instance

ollama_manager.fallback_prompt_instance

Initial value:

=  PromptBuilder(
    template=
)

Definition at line 80 of file ollama_manager.py.

global_Pipeline

ollama_manager.global_Pipeline = setup_ollama()

Definition at line 287 of file ollama_manager.py.

is_ollama_enabled

tuple ollama_manager.is_ollama_enabled

Initial value:

=  (
    os.getenv("IS_OLLAMA_ENABLED", "false").lower() == "true"
)

Definition at line 36 of file ollama_manager.py.

ollama_host

Annotated ollama_manager.ollama_host

Initial value:

=  os.getenv(
    "OLLAMA_HOST"
)

Definition at line 40 of file ollama_manager.py.

prompt_instance

ollama_manager.prompt_instance

Initial value:

=  PromptBuilder(
    template=
)

Definition at line 51 of file ollama_manager.py.