Type to search.

Jina Reader connector

Serverless Preview

Elastic Cloud Serverless projects are autoscaled environments, fully managed by Elastic and available on Elastic Cloud.

Availability

  • Preview

    This functionality is in technical preview and is ready for evaluation. Use with caution in production; it is not recommended for mission-critical workloads. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. Specific Support terms apply.

Serverless interfaces and procedures might differ from classic Elastic Stack deployments.

Stack Preview 9.4+

The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats.

Availability

  • Preview since 9.4

    This functionality is in technical preview and is ready for evaluation. Use with caution in production; it is not recommended for mission-critical workloads. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. Specific Support terms apply.

Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments.

This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

The Jina Reader connector communicates with the Jina API to turn web pages into markdown from their URL, and provide web search for better LLM grounding.

You can create connectors in Stack Management > Connectors.

Jina Reader connectors have the following configuration properties:

API Key
The Jina API key for authentication.
Browse URL
The base URL for Jina Reader Browse feature. Default is https://r.jina.ai.
Search URL
The base URL for Jina Reader Search feature. Default is https://s.jina.ai.

You can test connectors as you're creating or editing the connector in Kibana.

The Jina Reader connector has the following actions:

Browse URL

Turn any URL to markdown using Jina Reader Browse API.

  • URL (required): The URL to browse and convert to markdown.
  • Return Format (optional): The format of the content to return.
  • Additional Options (optional): Additional advanced options.

Refer to the API reference for details on the available parameters and values.

Web Search

Search the web using Jina Reader Search API.

  • Query (required): The search query string.
  • Return Format (optional): The format of the content to return.
  • Additional Options (optional): Additional advanced options.

Refer to the API reference for details on the available parameters and values.

File to Markdown

Convert a base64-encoded file string to markdown using Jina Reader Browse API.

  • File Content (Base64) (required): The base64-encoded file content to convert to markdown.
  • File Name (optional): The name of the file including extension.
  • Additional Options (optional): Additional advanced options.

Refer to the API reference for details on the available parameters and values.

File to Rendered Image

Convert a base64-encoded file string to image using Jina Reader Browse API.

  • File Content (Base64) (required): The base64-encoded file content to convert to image.
  • File Name (optional): The name of the file including extension.
  • Page Number (optional): The page number to render as an image.
  • Additional Options (optional): Additional advanced options.

Refer to the API reference for details on the available parameters and values.

Use the Action configuration settings to customize connector networking configurations, such as proxies, certificates, or TLS settings. You can set configurations that apply to all your connectors or use xpack.actions.customHostSettings to set per-host configurations.

To use the Jina Reader connector, you need an API key:

  1. Go to Jina AI's website.
  2. Scroll to the API section, and go to the API Key & Billing tab.
  3. A free key may be generated for you upon visiting the page.
  4. Optionally, sign up for an account or log in.
  5. Navigate to the Key Manager page.
  6. Generate or copy your API key.
  7. Use the API key to configure the connector in Kibana.