Piplines Install & Run (Guide)

[rootcli]

I created this little guide to help newbies Run pipelines, as it was a challenge for me to install and run pipelines. Hope it helps.

Pipelines Usage

Quick Start with Docker

Pipelines Repository Quick Guide

What to do Next?

1. Run the Pipelines container:

2. Login to Open WebUI:

   • Navigate to the Settings > Connections > OpenAI API section in Open WebUI.
   • Set the API URL to http://localhost:9099 and the API key to 0p3n-w3bu!. Your pipelines should now be active. IF localhost doesn't work use host.docker.internal

3. You can Download the examples folder (or individual files, as you wish) from the Pipelines repository:

`To Download the Examples Folder:

git clone https://github.com/open-webui/pipelines.git examples

Here we will perform an example on one file which is called wikipedia_pipeline.py you can direct download it to linux from the link below

curl -O https://raw.githubusercontent.com/open-webui/pipelines/c9766d630ab69549b06e994b39fb173a61bb82e8/examples/pipelines/integrations/wikipedia_pipeline.py

4. Place The downloaded file wikipedia_pipeline.py in pipelines Root Folder.

5. In the open webui interface Go to Admin Panel > Gear Icon in top right ⚙ > pipelines

   you should see Pipelines Valves click on the pulldown menu and select wikipedia_pipeline

3. Go to New Chat > From the Models pulldown Menu select ``

4. Now type a topic you wish to search from `wikipedia

done

[santosh0787]

I really like this feature. Can you please add some documentation on how to add tools functions? I added examples/filters/function_calling_filter_pipeline.py but it is added as filters. Can you tell how invoke these functions?
All I get is query is going to Wiki pipeline.

[c9482]

When I only select "Wikipedia Pipeline", I get nothing. I have to add another model to the chat to get a response and the response does not come from "Wikipedia Pipeline". I was expecting to get the latest entries from wikipedia. Perhaps I am still missing how this is supposed to work? See below.

[rootcli]

"no information found" means the piplines model didn't find information.
try "Sun" or "Moon" in the prompt

[c9482]

Thanks, I get the point.

[delfireinoso]

Place The downloaded file wikipedia_pipeline.py in pipelines Root Folder.

I have the file wikipedia_pipeline.py
Where I find the Piplelines Root Folder?

[c9482]

It's easiest to install to install from Github URL. For manual installation, there's an empty "pipelines" folder in the repo. Or if you're using docker, mount a volume for /app/pipelines.

[delfireinoso]

I use Docker as it's easy on a Mac

To mount a volume I think that I need to modify the Docker install command for Pipelines

This should come on the install documentation

[delfireinoso]

I see that the Docker default install has a Pipelines Volume, I'll tried the url approch and it's fine and working

[c9482]

Still couple of unanswered questions about function calling filter pipeline:

1. How does it get activated? For example, function_calling_filter_pipeline example has get_current_time tool. I can't get it to fire. Is there a specific prompt that I need to use?
2. Are the changes to pipeline automatically detected and the pipeline is reloaded? Or do I have to restart the pipelines server?

Many thanks in advance for some clues.

[c9482]

This is great information, thanks! One other question: how are package dependencies resolved? It seems that only the Python file gets deployed. I am not a Python programmer so this is a bit of a mystery to me.

[atgehrhardt]

So I haven't built anything with external dependencies yet but I can test later. Looking through the pipelines code I'm not seeing a way to install dependencies or an automatic mechanism, so may not be implemented yet. You could dial into the docker and install them, but I think that may be problematic as conflicting packages would be an issue since it looks like pipelines aren't running in venvs.

I can't be sure, may be worth opening a discussion on the Pipelines github

[atgehrhardt]

Looks like this is addressed here: #65 (comment)

[justinh-rahb]

@atgehrhardt you can add a header to a pipeline such as this, that specifies the dependencies to install:

"""
title: MLX Pipeline
author: justinh-rahb
date: 2024-05-27
version: 1.1
license: MIT
description: A pipeline for generating text using Apple MLX Framework.
requirements: requests, mlx-lm, huggingface-hub
environment_variables: MLX_HOST, MLX_PORT, MLX_MODEL, MLX_STOP, MLX_SUBPROCESS, HUGGINGFACE_TOKEN
"""

from typing import List, Union, Generator, Iterator
from schemas import OpenAIChatMessage
import requests
import os
import subprocess
import logging
from huggingface_hub import login

...

[atgehrhardt]

Oh that's fantastic, thank you for the clarification!

[musicheardworldwide]

If you create tools or functions you want to be triggered, you have to create the filter as well. This took me until today to figure out, but your pipe is in the data, the filter is how it gets to where its going and how. Keep building up your tool pipelines or just tools, and make sure you have the python function filter up and accurate, it should just trigger whenever you say the right thing. also, dont forget every tool you make needs to have a call, so once you get that locked in it should be smooth...

i just had my model message me on icloud via tools. There's a LOT of potential with this

[santosh0787]

Can you provide a simple example of how to use pipelines and filters? I've looked at the examples in the repository, but they're scattered among other examples and I'm having trouble understanding how to apply them. Could you provide a clear and concise example to help me get started?

[eladrave]

I installed the https://github.com/open-webui/pipelines/blob/main/examples/filters/function_calling_filter_pipeline.py

However, I can never get the weather part work.
I tried "weather in new york" , but it didn't use it.

I tested my access to openweathermap, and it worked fine:
curl -G "http://api.openweathermap.org/data/2.5/weather"
--data-urlencode "q=New York"
--data-urlencode "appid=MY_KEY"
--data-urlencode "units=imperial"

[PlebeiusGaragicus]

I cannot wait until more documentation and examples come out!!!

Right now I'm thinking I need a filter to track user token usage. When the user has used all their allotted tokens I need the AI model to respond with a payment request LNURL. I made my own webui scratch to do this, but now that Open WebUI includes this AWESOME custom extension ability I'm going to pivot towards this.

This could be THE feature I've been looking for in the ecosystem to build this out. Self-hosted, micropayment-enabled, custom LangGraph AI constructs for the rest of us...