Skip to main content
Version: 0.11.1

Tools and processors reference

This page is the single entry point for everything Lucenia can do to your data: the tools an agent can call, the ingest processors that run while documents are written, and the search processors that run while queries are served.

note

The word tool means two different things in these docs. The Ingestion tools and utilities section covers third-party data shippers (Beats, Logstash, Fluentd, OpenTelemetry), the Lucenia CLI, and migration tooling — programs that run outside the cluster. This page covers the tools and processors that ship inside the cluster.

Ask the cluster, not the docs

A running cluster is always the authoritative inventory for the version you are on.

SurfaceRequestNotes
Agent toolsGET /_plugins/_ml/toolsReturns name, type, description, and version for every registered tool type.
Ingest processorsGET /_nodes/ingest?filter_path=nodes.*.ingest.processorsComplete. Includes processors contributed by every installed module.
Search processorsGET /_nodes/search_pipelinesIncomplete — see the warning below.
warning

GET /_nodes/search_pipelines reports only request_processors and response_processors. It omits search phase results processors, which is where normalization-processor lives — the processor that makes hybrid search work. Do not treat its output as the full search processor list. The complete list is in Search processors.

Agent tools

A tool is a reusable building block an agent calls to perform one specific task — search an index, run a deployed model, call an external service. You reference a tool by its type when registering an agent. For parameters, examples, and per-tool detail, see Tools.

Tool typeWhat it does
AgentToolRuns any agent.
CatIndexToolRetrieves index information for the Lucenia cluster.
IndexMappingToolRetrieves index mapping and setting information for an index.
MLModelToolRuns machine learning models.
NeuralSparseSearchToolPerforms sparse vector retrieval.
PPLToolTranslates natural language into a Piped Processing Language (PPL) query.
RAGToolUses neural search or neural sparse search to retrieve documents and integrates a large language model to summarize the answers.
SearchAlertsToolSearches for alerts.
SearchAnomalyDetectorsToolSearches for anomaly detectors.
SearchAnomalyResultsToolSearches anomaly detection results generated by anomaly detectors.
SearchIndexToolSearches an index using a query written in query domain-specific language (DSL).
SearchMonitorsToolSearches for alerting monitors.
VectorDBToolPerforms dense vector retrieval.
VisualizationToolFinds visualizations in OpenSearch Dashboards.

Ingest processors

Ingest processors transform documents on the write path, inside an ingest pipeline. The complete table, with a link to each processor's own page, is in Ingest processors.

The processors below have dedicated pages in this version:

ProcessorWhat it does
chunkSplits text content into overlapping chunks using recursive, fixed, semantic, or topic-shift algorithms. Designed for RAG and vector search pipelines.
content_extractExtracts structured content blocks from documents in various formats (PDF, DOCX, HTML, images) via inline text, S3/HTTPS references, or base64 attachments.
embedGenerates vector embeddings from text, image, or multimodal content using Bedrock, OpenAI, or HTTP providers.
ellipseConverts an ellipse geometry (WKT or GeoJSON) into a polygon approximation and indexes it as a geo_shape or shape. Useful for directional or asymmetric coverage areas such as cellular sectors.
image_tilingSplits large images into fixed-size tiles for multimodal vector search. Supports GeoTIFF/COG with HTTP Range reads and geographic bounding box computation.
ocrPerforms optical character recognition on image blocks using LLM vision models (Claude on Bedrock). Handles charts, diagrams, tables, and handwriting.
rerank_prepareAnnotates chunks with document-level metadata and position scores for search-time reranking.

Search processors

Search processors transform requests, responses, and intermediate phase results on the read path, inside a search pipeline. The complete tables are in Search processors.

They run in three places: