Welcome to Jina Documentation!

Install

• Install Jina via pip
• Install Jina via Docker Container
• Install Jina on Raspberry Pi and other Linux Systems
• Can I Run Jina On ….?
• Upgrade Jina
• Autocomplete commands on Bash, Zsh and Fish

Getting Started

• Jina “Hello, World!” 👋🌍
  • View “Hello World” in Jina Dashboard
  • More Options for “Hello, World”
• Jina 101: First Thing to Learn About Jina
  • Document & Chunk
  • YAML config
  • Executor
  • Driver
  • Pea
  • Pod
  • Flow
  • From Micro to Macro
• Using Flow API to Compose Your Jina Workflow
  • Use Flow API in Python
  • Use Flow API in YAML
  • Design a Flow with Dashboard
• Common Design Patterns
  • CompoundIndexer (Vector + KV Indexers)
  • Text Document Segmentation
  • Indexers at Different Depth Levels
  • Switch Vector Indexer at Query Time
• Input and Output Functions in Jina
  • Input Function
  • Output Function
• Using Jina Pod with Docker Container
  • Build Your Pod into a Docker Image
  • Use Your Pod Image
  • Publish Your Pod Image to Jina Hub
• Using Jina Pod Remotely
  • Creating a Remote Jina Pod from Console
  • Creating a Remote Jina Pod via Jina Gateway
  • Creating a Remote Jina Pod via Flow API
• Logging configuration in jina
  • FluentD
  • Start fluentd daemon
• Using Dashboard to Monitor Logs and View Flow
  • Start the Log Server
  • Connect the Dashboard to Your Log Server
  • Customize the endpoints
  • Self-host a Dashboard
• Gracefully Exit Jina
  • In Python
  • In the Console

Developer Reference

• Jina Command-Line Interface
  • jina hello-world
  • jina pod
  • jina flow
  • jina gateway
  • jina ping
  • jina check
  • jina log
  • jina pea
  • jina client
• Jina Python API Reference
  • jina.clients
  • jina.docker
  • jina.drivers
  • jina.executors
  • jina.flow
  • jina.helloworld
  • jina.hub
  • jina.logging
  • jina.peapods
  • jina.proto
  • jina.checker
  • jina.counter
  • jina.enums
  • jina.excepts
  • jina.helper
  • jina.parser
• Jina YAML Syntax Reference
  • Executor YAML Syntax
  • CompoundExecutor YAML Syntax
  • Referencing Variables in Executor and CompoundExecutor YAML
  • Driver YAML Sytanx
  • Flow YAML Sytanx
• Built-in Simple Executors and Reserved uses in Jina
  • What is Simple Executor?
  • What are the reserved uses?
  • How to use built-in Simple Executors?
• Jina Protobuf Specification
  • Protocol Documentation
  • Update Protocol Specification
• Jina REST API Specification
  • Interface
  • Switching from gRPC gateway to REST gateway
  • Unsupported Features in REST API
• OS Environment Variables Used in Jina
• Jina API Schema for 3rd-Party Applications
  • Schema URL
  • Description

Extending Jina

• A Minimum Working Example
• Guideline When Adding New Executor
  • Decide which Executor class to inherit from
  • Override __init__() and post_init()
  • Override the core method of the base class
  • Implement the persistence logic
  • How Can I Use My Extension
  • I Want to Contribute it to Jina
• Guideline When Adding New Driver
• Publish Your Pod Image to Jina Hub
  • What Files Need to be Uploaded?
  • Schema of manifest.yml
  • Steps to Publish Your Image
  • Why My Upload Fails on the CICD?

Contributing

• Contributing to Jina
• Join Us on Slack!
  • 🏁 Before you Start
  • 🐞 Bugs and Issues
  • 🥇 Making Your First Submission
  • ☑️ Naming Conventions
  • 💥 Testing Jina Locally and on CI
  • 📖 Contributing Documentation
  • 💬 Getting Support
  • 🙏 Thank You
• Jina Enhancement Proposals (JEP)
  • What is a JEP?
  • Current JEPs

Release Notes

• Release Cycle
• Change Logs

Debugging and FAQ

• Troubleshooting
• FAQ for End-Users
• FAQ for Developers

Indices and Tables

• List of 99 Executors in Jina
  • Inheritances in a Tree View
  • Modules in a Table View
• List of 57 Drivers in Jina
  • Inheritances in a Tree View
  • Modules in a Table View

• Index

• Module Index

• Search Page