Metadata-Version: 2.1
Name: streamlit-jina
Version: 0.1.3
Summary: Streamlit component for Jina neural search
Home-page: https://github.com/jina-ai/streamlit-jina
Author: Alex Cureton-Griffiths
Author-email: alex.cg@jina.ai
License: Apache 2.0
Download-URL: https://github.com/jina-ai/streamlit-jina/tags
Description: # streamlit-jina
        
        <!--
        ![Python package](https://github.com/randyzwitch/streamlit-jina/workflows/Python%20package/badge.svg)
        
        [![Open in Streamlit](https://static.streamlit.io/badges/streamlit_badge_black_white.svg)](https://share.streamlit.io/randyzwitch/streamlit-jina/examples/streamlit_app.py)
        -->
        
        streamlit-jina lets you search text or images in your Streamlit app, using [Jina's neural search framework](https://github.com/jina-ai/jina/).
        
        ## Installation
        
        streamlit-jina is distributed via [PyPI](https://pypi.org/project/streamlit-jina/):
        
        ```python
        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:
        
        ```python
        import streamlit as st
        from streamlit_jina import jina
        ```
        
        And then choose your search type and plug in your endpoint:
        
        ### Text ([example](examples/jina_text.py))
        
        ```python
        jina.text_search(endpoint="http://0.0.0.0:45678/api/search")
        ```
        
        <!-- ![](./github/.images/text.png) -->
        
        ### Images ([example](examples/jina_image.py))
        
        ```python
        jina.image_search(endpoint="http://3.140.167.7:34567/api/search")
        ```
        
        <!-- ![](./github/.images/image.png) -->
        
        ### 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
        
Keywords: jina cloud-native neural-search query search index elastic neural-network encoding embedding serving docker container image video audio deep-learning streamlit frontend
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Unix Shell
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Database :: Database Engines/Servers
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Internet :: WWW/HTTP :: Indexing/Search
Classifier: Topic :: Scientific/Engineering :: Image Recognition
Classifier: Topic :: Multimedia :: Video
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >3.7
Description-Content-Type: text/markdown
