freeskyg / jinabox.js Goto Github PK

jinabox.js is a lightweight, customizable omnibox. You can use it for searching text, images, videos, audios or all kinds of data with a Jina backend.

• Demo page
• Learn Jina: the fastest way to build cloud-native neural search
• Quick Start
• Features
• Supported MIME types
• Configuration

In HTML, include the minified script:

<script src="https://unpkg.com/jinabox"></script>
<script>
    jb = window.JinaBox
    jb.init('http://0.0.0.0:65481/api/search');  // http://0.0.0.0:65481/api/search is the endpoint of the REST gateway of a Jina backend.
</script>

Then, create a container where the searchbar/floater is to appear:

<jina-searchbar/>

<!--or-->

<jina-floater/>

Run one of those prebuilt backend:

• Pokedex (real image data): docker run -p 65481:65481 -e "JINA_PORT=65481" jinaai/hub.app.bitsearch-pokedex search
• Southpark (real text data): docker run -p 45678:45678 jinaai/hub.app.distilbert-southpark
• MP4 mock (placeholder video data): docker run -p 65481:65481 -e "JINA_PORT=65481" jinaai/hub.app.iomock.mp4 search
• Wav mock (placeholder audio data): docker run -p 65481:65481 -e "JINA_PORT=65481" jinaai/hub.app.iomock.sound search

Now you can drag anything from anywhere (local/browser/webpage) to it and conduct the search.

Ready to learn Jina? Read our 101 tutorials.

npm install jinabox
# or
yarn add jinabox

• an easy-to-use web component for Jina search backend;
• allow user to drag-and-drop multi-modal data as queries to search;
• webcam and mic support (in progress, contribution welcome! ❤️);
• visualize the search results in a dropdown list or a separate container;
• highly customizable.

jinabox.js runs on modern browsers supporting Web Audio, including Firefox, Chrome, Safari (desktop and mobile) and Opera.

Try http://localhost:65481/api/search, make sure to use http and localhost, instead of 0.0.0.0.

Copyright (c) 2020 Jina AI Limited. All rights reserved.

Jina is licensed under the Apache License, Version 2.0. See LICENSE for the full license text.