Skip to content
This repository has been archived by the owner on Nov 24, 2021. It is now read-only.

jina-ai/streamlit-jina

Repository files navigation

Deprecation notice

Since every search engine use case and data set is different, we recommend building your front-end from scratch rather than using this repo. Please check the front-end in the meme search engine repo as a reference implementation.


streamlit-jina

streamlit-jina lets you search text or images in your Streamlit app, using Jina's neural search framework.

Installation

streamlit-jina is distributed via PyPI:

pip install streamlit-jina

Examples

Using streamlit-jina is as simple as setting an endpoint and what type of thing you want to search for:

import streamlit as st
from streamlit_jina import jina

And then choose your search type and plug in your endpoint:

Text (example)

jina.text_search(endpoint="http://0.0.0.0:45678/api/search")

Images (example)

jina.image_search(endpoint="http://0.0.0.0:45678/api/search")

Parameters

You can pass several parameters to the component:

Parameter Type Details
endpoint str Endpoint of your Jina instance Required
top_k int How many results you want returned Optional
hidden list Widgets you want hidden from user (endpoint, top_k) Optional

Todo

  • Canvas drawing as input
  • Audio/video file upload input
  • Audio/video recording input
  • Audio/video output widgets