jinabox.js is a lightweight, customizable set of components for querying and displaying results from Jina flows. You can use it for searching text, images, videos, audio or any kind of data with a Jina backend.

• Learn Jina: the fastest way to build cloud-native neural search
• Features
• Jinabox in Action
• Adding Jinabox to Your Project
• Supported MIME types
• Configuration

• <jina-searchbar></jina-searchbar>

  • perform queries and view results in a single component

• <jina-results></jina-results>

  • place results from searchbar in a separate area

• <jina-floater></jina-floater>

  • standalone floating icon to enable searches from anywhere in the application

• <jina-floater-chat></jina-floater-chat>

  • jina floater in the style of a chat application

• Easy-to-use web components for Jina search backend

• Users can drag and drop multi-modal data as search queries

• Webcam and microphone support (in progress, contributions welcome! ❤️)

• Visualize search results in a dropdown list or separate container

• Highly customizable

jinabox.js is a frontend for querying Jina flows. You will need to spin up a Jina backend to get search results. Based on what you want to search, run one of our example Jina backends:

• 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

Just go to https://jina.ai/jinabox.js/ in your browser to open up the search interface.

Based on the Docker port you are exposing (i.e. 65481 or 45678 in above Docker images), set jinabox's server endpoint to:

http://localhost:<port_number>/api/search

Important: If you are using a remote endpoint (non-localhost), make sure it is using HTTPS, not HTTP. Otherwise, JinaBox will not be able to make requests to your flow.

Drag and drop images, video, or audio, or type in text to search.

In your HTML source, include the minified script and initialize it with your endpoint:

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

Then add the jinabox web components into your application:

<jina-searchbar></jina-searchbar>

<!--or-->

<jina-floater></jina-floater>

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

Play with and preview jinabox configurations here: https://jina.ai/jinabox.js/

jinabox.js expects query responses to contain either of the following structures

{
  "search": {
    "docs": [
      {
        "topkResults": [
          {
            "matchDoc": {
              "docId": 14704,
              "weight": 1,
              "uri": "data:image/png;charset=utf,...",
              "mimeType":"image/png"
            }
          }
        ],
        "uri":"data:image/jpeg;...",
        "mimeType":"image/jpeg"
      }
    ]
  }
}

or

{
  "search": {
    "docs": [
      {
        "matches": [
          {
            "docId": 14704,
            "weight": 1,
            "uri": "data:image/png;charset=utf,...",
            "mimeType":"image/png"
          }
        ],
        "uri":"data:image/jpeg;...",
        "mimeType":"image/jpeg"
      }
    ]
  }
}

jinabox.js runs on modern browsers including Chrome, Firefox, Safari (desktop and mobile) and Opera. Certain features (like recording audio/video) are not available on all browsers and jinabox will make these features available accordingly.

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

Query your api with curl to ensure it is properly receiving, processing, and responding to requests. Ensure responses meet jinabox expected response structure.

We welcome all kinds of contributions from the open-source community, individuals and partners. We owe our success to your active involvement.

• Contributing guidelines
• Release cycles and development stages

• Code of conduct - play nicely with the Jina community
• Slack workspace - join #general on our Slack to meet the team and ask questions
• YouTube channel - subscribe to the latest video tutorials, release demos, webinars and presentations.
• LinkedIn - get to know Jina AI as a company and find job opportunities
• - follow and interact with us using hashtag #JinaSearch
• Company - know more about our company and how we are fully committed to open-source.

As part of our open governance model, we host Jina's Engineering All Hands in public. This Zoom meeting recurs monthly on the second Tuesday of each month, at 14:00-15:30 (CET). Everyone can join in via the following calendar invite.

• Add to Google Calendar
• Download .ics

The meeting will also be live-streamed and later published to our YouTube channel.

Jina is an open-source project. We are hiring full-stack developers, evangelists, and PMs to build the next neural search ecosystem in open source.

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.