Lucenia

https://docs.lucenia.io
Admin
Lucenia is a fast, scalable full-text search engine with enterprise-grade security, hybrid cloud...
Tokens:830,612
Snippets:7,567
Trust Score:7.5
Update:2 months ago
Show doc for...
Tokens:
Raw
### Start Lucenia with Demo Security

Source: https://docs.lucenia.io/install-and-configure/install-lucenia/tar

Execute the installation script to start the Lucenia service with default security settings.

```bash
./lucenia-tar-install.sh  
```

--------------------------------

### CAT plugins response format

Source: https://docs.lucenia.io/api-reference/cat/cat-plugins

Example output showing the name, component, and version of installed plugins.

```text
name       component                       version  
odfe-node2 opendistro-alerting             1.13.1.0  
odfe-node2 opendistro-anomaly-detection    1.13.0.0  
odfe-node2 opendistro-asynchronous-search  1.13.0.1  
odfe-node2 opendistro-index-management     1.13.2.0  
odfe-node2 opendistro-job-scheduler        1.13.0.0  
odfe-node2 opendistro-knn                  1.13.0.0  
odfe-node2 opendistro-performance-analyzer 1.13.0.0  
odfe-node2 opendistro-reports-scheduler    1.13.0.0  
odfe-node2 opendistro-sql                  1.13.2.0  
odfe-node2 opendistro_security             1.13.1.0  
odfe-node1 opendistro-alerting             1.13.1.0  
odfe-node1 opendistro-anomaly-detection    1.13.0.0  
odfe-node1 opendistro-asynchronous-search  1.13.0.1  
odfe-node1 opendistro-index-management     1.13.2.0  
odfe-node1 opendistro-job-scheduler        1.13.0.0  
odfe-node1 opendistro-knn                  1.13.0.0  
odfe-node1 opendistro-performance-analyzer 1.13.0.0  
odfe-node1 opendistro-reports-scheduler    1.13.0.0  
odfe-node1 opendistro-sql                  1.13.2.0  
odfe-node1 opendistro_security             1.13.1.0
```

--------------------------------

### Install a plugin by name

Source: https://docs.lucenia.io/install-and-configure/plugins

Use the plugin name to install from the official repository.

```bash
bin/lucenia-plugin install <plugin-name>
```

```bash
$ sudo ./lucenia-plugin install repository-gcs  
-> Installing repository-gcs  
-> Downloading repository-gcs from lucenia  
[=================================================] 100%     
-> Installed repository-gcs with folder name repository-gcs
```

--------------------------------

### Index Documents for Boosting Example

Source: https://docs.lucenia.io/query-dsl/compound/boosting

Setup two documents in the testindex to demonstrate relevance scoring.

```json
PUT testindex/_doc/1  
{  
  "article_name": "The greatest pitcher in baseball history"  
}  
```

```json
PUT testindex/_doc/2  
{  
  "article_name": "The making of a glass pitcher"  
}  
```

--------------------------------

### Install multiple plugins

Source: https://docs.lucenia.io/install-and-configure/plugins

Install several plugins simultaneously by listing their names in a single command.

```bash
bin/lucenia-plugin install <plugin-name> <plugin-name> ... <plugin-name>
```

```bash
$ sudo $ ./lucenia-plugin install analysis-nori repository-s3
```

--------------------------------

### Get model example response

Source: https://docs.lucenia.io/ml-commons-plugin/api/model-apis/get-model

A sample JSON response containing model metadata and configuration details.

```json
{
  "name" : "all-MiniLM-L6-v2_onnx",
  "algorithm" : "TEXT_EMBEDDING",
  "version" : "1",
  "model_format" : "TORCH_SCRIPT",
  "model_state" : "LOADED",
  "model_content_size_in_bytes" : 83408741,
  "model_content_hash_value" : "9376c2ebd7c83f99ec2526323786c348d2382e6d86576f750c89ea544d6bbb14",
  "model_config" : {
      "model_type" : "bert",
      "embedding_dimension" : 384,
      "framework_type" : "SENTENCE_TRANSFORMERS",
      "all_config" : """{"_name_or_path":"nreimers/MiniLM-L6-H384-uncased","architectures":["BertModel"],"attention_probs_dropout_prob":0.1,"gradient_checkpointing":false,"hidden_act":"gelu","hidden_dropout_prob":0.1,"hidden_size":384,"initializer_range":0.02,"intermediate_size":1536,"layer_norm_eps":1e-12,"max_position_embeddings":512,"model_type":"bert","num_attention_heads":12,"num_hidden_layers":6,"pad_token_id":0,"position_embedding_type":"absolute","transformers_version":"4.8.2","type_vocab_size":2,"use_cache":true,"vocab_size":30522}"""
  },
  "created_time" : 1665961344044,
  "last_uploaded_time" : 1665961373000,
  "last_loaded_time" : 1665961815959,
  "total_chunks" : 9
}
```

--------------------------------

### Index Document Setup

Source: https://docs.lucenia.io/query-dsl/minimum-should-match

Initial setup of documents in the testindex for query testing.

```json
PUT testindex/_doc/1  
{  
  "text": "one Lucenia"  
}  
```

```json
PUT testindex/_doc/2  
{  
  "text": "one two Lucenia"  
}  
```

```json
PUT testindex/_doc/3  
{  
  "text": "one two three Lucenia"  
}  
```

```json
PUT testindex/_doc/4  
{  
  "text": "one two three four Lucenia"  
}  
```

```json
PUT testindex/_doc/5  
{  
  "text": "Lucenia"  
}  
```

--------------------------------

### Start Lucenia

Source: https://docs.lucenia.io/upgrade-to/upgrade-to

Starts the Lucenia service on the node.

```bash
./bin/lucenia -d.  
```

--------------------------------

### Install Plugin Command

Source: https://docs.lucenia.io/ai-search-and-retrieval/extensibility

Command-line instruction to install a packaged plugin ZIP file.

```bash
bin/lucenia-plugin install file:///path/to/my-lucenia-plugin-1.0.0.zip  
```

--------------------------------

### Install Lucenia Python client

Source: https://docs.lucenia.io/clients/python

Use pip to install the package from PyPI.

```bash
pip install lucenia-py
```

--------------------------------

### Install AWS Neuron Tools

Source: https://docs.lucenia.io/ml-commons-plugin/gpu-acceleration

Installs the necessary AWS Neuron tools on the system.

```bash
sudo apt-get install aws-neuronx-tools -y
```

--------------------------------

### Create Snapshot Request Examples

Source: https://docs.lucenia.io/api-reference/snapshots/create-snapshot

Examples of creating a snapshot with and without a request body.

```http
POST _snapshot/my-s3-repository/my-first-snapshot  
```

```json
PUT _snapshot/my-s3-repository/2  
{  
  "indices": "opensearch-dashboards*,my-index*,-my-index-2016",  
  "ignore_unavailable": true,  
  "include_global_state": false,  
  "partial": false  
}  
```

--------------------------------

### Install and configure the CLI

Source: https://docs.lucenia.io/tools/cli

Steps to make the binary executable, add it to the system path, and verify the installation.

```bash
chmod +x ./lucenia-cli  
```

```bash
export PATH=$PATH:$(pwd)  
```

```bash
lucenia-cli --version  
```

--------------------------------

### Get connector request example

Source: https://docs.lucenia.io/ml-commons-plugin/api/connector-apis/get-connector

An example of a GET request targeting a specific connector ID.

```http
GET /_plugins/_ml/connectors/N8AE1osB0jLkkocYjz7D
```

--------------------------------

### Get model example request

Source: https://docs.lucenia.io/ml-commons-plugin/api/model-apis/get-model

An example request to retrieve a model by its ID.

```http
GET /_plugins/_ml/models/N8AE1osB0jLkkocYjz7D
```

--------------------------------

### Create a new keystore

Source: https://docs.lucenia.io/security/configuration/lucenia-keystore

Initializes a new keystore file in the configuration directory.

```bash
./bin/lucenia-keystore create
```

```text
Created lucenia keystore in $LUCENIA_HOME/config/lucenia.keystore
```

--------------------------------

### Search-as-you-type response example

Source: https://docs.lucenia.io/search-plugins/searching-data/autocomplete

Example JSON response showing documents that match a prefix search.

```json
{
  "took" : 1,
  "timed_out" : false,
  "_shards" : {
    "total" : 1,
    "successful" : 1,
    "skipped" : 0,
    "failed" : 0
  },
  "hits" : {
    "total" : {
      "value" : 6,
      "relation" : "eq"
    },
    "max_score" : 16.37664,
    "hits" : [
      {
        "_index" : "shakespeare",
        "_id" : "2817",
        "_score" : 16.37664,
        "_source" : {
          "type" : "line",
          "line_id" : 2818,
          "play_name" : "Henry IV",
          "speech_number" : 5,
          "line_number" : "5.2.31",
          "speaker" : "HOTSPUR",
          "text_entry" : "Uncle, what news?"
        }
      },
      {
        "_index" : "shakespeare",
        "_id" : "6789",
        "_score" : 16.37664,
        "_source" : {
          "type" : "line",
          "line_id" : 6790,
          "play_name" : "Henry VI Part 2",
          "speech_number" : 60,
          "line_number" : "1.3.202",
          "speaker" : "KING HENRY VI",
          "text_entry" : "Uncle, what shall we say to this in law?"
        }
      },
      {
        "_index" : "shakespeare",
        "_id" : "7877",
        "_score" : 16.37664,
        "_source" : {
          "type" : "line",
          "line_id" : 7878,
          "play_name" : "Henry VI Part 2",
          "speech_number" : 13,
          "line_number" : "3.2.28",
          "speaker" : "KING HENRY VI",
          "text_entry" : "Where is our uncle? whats the matter, Suffolk?"
        }
      }
    ]
  }
}
```

--------------------------------

### Example request for an agent

Source: https://docs.lucenia.io/ml-commons-plugin/api/agent-apis/get-agent

An example of a GET request to retrieve a specific agent by its ID.

```http
GET /_plugins/_ml/agents/N8AE1osB0jLkkocYjz7D
```

--------------------------------

### Create a sample index

Source: https://docs.lucenia.io/api-reference/document-apis/index-document

Command to initialize a new index named sample-index.

```text
PUT /sample-index  
```

--------------------------------

### Start Services

Source: https://docs.lucenia.io/dashboards/quickstart

Command to initialize the defined Docker services.

```bash
docker compose up  

```

--------------------------------

### Get Task Example Request

Source: https://docs.lucenia.io/ml-commons-plugin/api/tasks-apis/get-task

An example request to retrieve information for a specific task ID.

```http
GET /_plugins/_ml/tasks/MsBi1YsB0jLkkocYjD5f
```

--------------------------------

### Explain API Example Request

Source: https://docs.lucenia.io/tuning-your-cluster/availability-and-recovery/snapshots/sm-api

Example request using a wildcard pattern to retrieve information for all policies starting with 'daily'.

```http
GET _plugins/_sm/policies/daily*/_explain
```

--------------------------------

### Example response

Source: https://docs.lucenia.io/api-reference/cat/cat-allocation

Sample output showing shard counts and disk usage metrics for two nodes.

```text
shards | disk.indices | disk.used | disk.avail | disk.total | disk.percent host | ip          | node  
  8    |   989.4kb    |   25.9gb  |   32.4gb   |   58.4gb   |   44 172.18.0.4   | 172.18.0.4  | odfe-node1  
  8    |   962.4kb    |   25.9gb  |   32.4gb   |   58.4gb   |   44 172.18.0.3   | 172.18.0.3  | odfe-node2  
```

--------------------------------

### Audit API Responses

Source: https://docs.lucenia.io/security/access-control/api

Example responses for GET, PUT, and PATCH operations.

```json
{  
  "_readonly" : [  
    "/audit/exclude_sensitive_headers",  
    "/compliance/internal_config",  
    "/compliance/external_config"  
  ],  
  "config" : {  
    "compliance" : {  
      "enabled" : true,  
      "write_log_diffs" : false,  
      "read_watched_fields" : { },  
      "read_ignore_users" : [ ],  
      "write_watched_indices" : [ ],  
      "write_ignore_users" : [ ],  
      "read_metadata_only" : true,  
      "write_metadata_only" : true,  
      "external_config" : false,  
      "internal_config" : true  
    },  
    "enabled" : true,  
    "audit" : {  
      "ignore_users" : [ ],  
      "ignore_requests" : [ ],  
      "disabled_rest_categories" : [  
        "AUTHENTICATED",  
        "GRANTED_PRIVILEGES"  
      ],  
      "disabled_transport_categories" : [  
        "AUTHENTICATED",  
        "GRANTED_PRIVILEGES"  
      ],  
      "log_request_body" : true,  
      "resolve_indices" : true,  
      "resolve_bulk_requests" : true,  
      "exclude_sensitive_headers" : true,  
      "enable_transport" : true,  
      "enable_rest" : true  
    }  
  }  
}  
```

```json
{  
  "status" : "OK",  
  "message" : "'config' updated."  
}  
```

```http
HTTP/1.1 200 OK  
content-type: application/json; charset=UTF-8  
content-length: 45  
```

--------------------------------

### Get memory response

Source: https://docs.lucenia.io/ml-commons-plugin/api/memory-apis/get-memory

Example JSON response containing memory metadata.

```json
{
  "memory_id": "gW8Aa40BfUsSoeNTvOKI",
  "create_time": "2024-02-02T18:07:06.887061463Z",
  "updated_time": "2024-02-02T19:01:32.121444968Z",
  "name": "Conversation for a RAG pipeline",
  "user": "admin"
}
```

--------------------------------

### Get Index Request

Source: https://docs.lucenia.io/api-reference/index-apis/get-index

Example request to retrieve information for a specific index.

```http
GET /sample-index
```

--------------------------------

### Search pipeline response

Source: https://docs.lucenia.io/search-plugins/search-pipelines/creating-search-pipeline

Example response from a GET request showing the pipeline version.

```json
{
  "my_pipeline": {
    "version": 1234,
    "request_processors": [
      {
        "script": {
          "source": """
           if (ctx._source['size'] > 100) {
             ctx._source['explain'] = false;
           }
         """
        }
      }
    ]
  }
}
```

--------------------------------

### Initiate k-NN Model Training

Source: https://docs.lucenia.io/search-plugins/knn/api

Examples showing how to trigger the training process for a k-NN model with specific configuration parameters.

```json
POST /_plugins/_knn/models/{model_id}/_train?preference={node_id}  
{  
    "training_index": "train-index-name",  
    "training_field": "train-field-name",  
    "dimension": 16,  
    "max_training_vector_count": 1200,  
    "search_size": 100,  
    "description": "My model",  
    "method": {  
        "name":"ivf",  
        "engine":"faiss",  
        "space_type": "l2",  
        "parameters":{  
            "nlist":128,  
            "encoder":{  
                "name":"pq",  
                "parameters":{  
                    "code_size":8  
                }  
            }  
        }  
    }  
}  
  
{  
    "model_id": "model_x"  
}
```

```json
POST /_plugins/_knn/models/_train?preference={node_id}  
{  
    "training_index": "train-index-name",  
    "training_field": "train-field-name",  
    "dimension": 16,  
    "max_training_vector_count": 1200,  
    "search_size": 100,  
    "description": "My model",  
    "method": {  
        "name":"ivf",  
        "engine":"faiss",  
        "space_type": "l2",  
        "parameters":{  
            "nlist":128,  
            "encoder":{  
                "name":"pq",  
                "parameters":{  
                    "code_size":8  
                }  
            }  
        }  
    }  
}  
  
{  
    "model_id": "dcdwscddscsad"  
}
```

--------------------------------

### Get all memories response

Source: https://docs.lucenia.io/ml-commons-plugin/api/memory-apis/get-memory

Example JSON response containing a list of memory objects.

```json
{
  "memories": [
    {
      "memory_id": "gW8Aa40BfUsSoeNTvOKI",
      "create_time": "2024-02-02T18:07:06.887061463Z",
      "updated_time": "2024-02-02T19:01:32.121444968Z",
      "name": "Conversation for a RAG pipeline",
      "user": "admin"
    }
  ]
}
```

--------------------------------

### Index sample documents

Source: https://docs.lucenia.io/query-dsl/full-text/simple-query-string

Setup documents in the customers index for testing query behavior.

```json
PUT /customers/_doc/1  
{  
  "first_name":"Amber",  
  "last_name":"Duke",  
  "address":"880 Holmes Lane"  
}  

```

```json
PUT /customers/_doc/2  
{  
  "first_name":"Hattie",  
  "last_name":"Bond",  
  "address":"671 Bristol Street"  
}  

```

```json
PUT /customers/_doc/3  
{  
  "first_name":"Nanette",  
  "last_name":"Bates",  
  "address":"789 Madison St"  
}  

```

```json
PUT /customers/_doc/4  
{  
  "first_name":"Dale",  
  "last_name":"Amber",  
  "address":"467 Hutchinson Court"  
}  

```

--------------------------------

### Install a plugin from a ZIP file

Source: https://docs.lucenia.io/install-and-configure/plugins

Install plugins via HTTP/HTTPS URLs or local file paths using the file: prefix.

```bash
bin/lucenia-plugin install <zip-file>
```

```bash
# Zip file hosted on the Lucenia artifacts repository.  
$ sudo ./lucenia-plugin install https://artifacts.lucenia.io/releases/lucenia/0.12.0/plugins/analysis-icu-0.12.0.zip  
-> Installing https://artifacts.lucenia.io/releases/lucenia/0.12.0/plugins/analysis-icu-0.12.0.zip  
-> Downloading https://artifacts.lucenia.io/releases/lucenia/0.12.0/plugins/analysis-icu-0.12.0.zip  
[=================================================] 100%  
-> Installed analysis-icu with folder name analysis-icu  
  
# Zip file in a local directory.  
$ sudo ./lucenia-plugin install file:/home/user/analysis-icu-0.12.0.zip  
-> Installing file:/home/user/analysis-icu-0.12.0.zip  
-> Downloading file:/home/user/analysis-icu-0.12.0.zip  
[=================================================] 100%  
-> Installed analysis-icu with folder name analysis-icu
```

--------------------------------

### GET _cat/plugins

Source: https://docs.lucenia.io/api-reference/cat/cat-plugins

Retrieves a list of installed plugins, including their names, components, and versions.

```APIDOC
## GET _cat/plugins

### Description
Returns information about the installed plugins, including the node name, component name, and version.

### Method
GET

### Endpoint
_cat/plugins

### Parameters
#### Query Parameters
- **local** (Boolean) - Optional - Whether to return information from the local node only instead of from the cluster_manager node. Default is false.
- **cluster_manager_timeout** (Time) - Optional - The amount of time to wait for a connection to the cluster_manager node. Default is 30 seconds.

### Request Example
GET _cat/plugins?v

### Response
#### Success Response (200)
- **name** (String) - The name of the node.
- **component** (String) - The name of the installed plugin component.
- **version** (String) - The version of the installed plugin.
```

--------------------------------

### Get all action groups response

Source: https://docs.lucenia.io/security/access-control/api

Example JSON response containing multiple action groups.

```json
{
  "read": {
    "reserved": true,
    "hidden": false,
    "allowed_actions": [
      "indices:data/read*",
      "indices:admin/mappings/fields/get*",
      "indices:admin/resolve/index"
    ],
    "type": "index",
    "description": "Allow all read operations",
    "static": true
  },
  "cluster_all": {
    "reserved": true,
    "hidden": false,
    "allowed_actions": [
      "cluster:*"
    ],
    "type": "cluster",
    "description": "Allow everything on cluster level",
    "static": true
  },
  ...
}
```

--------------------------------

### Start Lucenia binary

Source: https://docs.lucenia.io/install-and-configure/configuring-lucenia/experimental

Execute the Lucenia binary after configuring options.

```bash
./bin/lucenia  
```

--------------------------------

### Get action group response

Source: https://docs.lucenia.io/security/access-control/api

Example JSON response for a single action group retrieval.

```json
{
  "custom_action_group": {
    "reserved": false,
    "hidden": false,
    "allowed_actions": [
      "kibana_all_read",
      "indices:admin/aliases/get",
      "indices:admin/aliases/exists"
    ],
    "description": "My custom action group",
    "static": false
  }
}
```

--------------------------------

### Example roles.yml configuration

Source: https://docs.lucenia.io/search-plugins/cross-cluster-search

A sample configuration for roles.yml defining cluster and index permissions for cross-cluster search.

```yaml
humanresources:  
  cluster:  
    - CLUSTER_COMPOSITE_OPS_RO  
  indices:  
    'humanresources':  
      '*':  
        - READ  
        - indices:admin/shards/search_shards # needed when the search request includes parameter setting 'ccs_minimize_roundtrips=false'.  
```

--------------------------------

### Navigate to Demo Directory

Source: https://docs.lucenia.io/security/authentication-backends/saml

Change the current working directory to the demo folder within the downloaded repository.

```bash
$ cd <path-to-demos-folder>/demo  
```

--------------------------------

### Get all messages requests

Source: https://docs.lucenia.io/ml-commons-plugin/api/memory-apis/get-message

Examples of retrieving messages via memory ID or search query.

```http
GET /_plugins/_ml/memory/gW8Aa40BfUsSoeNTvOKI/messages
```

```http
POST /_plugins/_ml/message/_search
{
  "query": {
    "match_all": {}
  },
  "size": 1000
}
```

--------------------------------

### Example response

Source: https://docs.lucenia.io/api-reference/cat/cat-nodes

A sample output showing node metrics such as IP, heap percentage, and roles.

```text
ip       |   heap.percent | ram.percent | cpu load_1m | load_5m | load_15m | node.role | node.roles |     cluster_manager |  name  
10.11.1.225  |         31   |    32  | 0  |  0.00  |  0.00   | di  | data,ingest,ml  | - |  data-e5b89ad7
```

--------------------------------

### Get message by ID request

Source: https://docs.lucenia.io/ml-commons-plugin/api/memory-apis/get-message

Example request to retrieve a message using its unique identifier.

```http
GET /_plugins/_ml/memory/message/0m8ya40BfUsSoeNTj-pU
```

--------------------------------

### Create a controller

Source: https://docs.lucenia.io/ml-commons-plugin/api/controller-apis/create-controller

Example request to initialize a controller with rate limits for multiple users.

```json
POST _plugins/_ml/controllers/mtw-ZI0B_1JGmyB068C0  
{  
  "user_rate_limiter": {  
    "user1": {  
      "limit": 4,  
      "unit": "MINUTES"  
    },  
    "user2": {  
      "limit": 4,  
      "unit": "MINUTES"  
    }  
  }  
}
```

```json
{
  "model_id": "mtw-ZI0B_1JGmyB068C0",
  "status": "CREATED"
}
```

--------------------------------

### Get document response

Source: https://docs.lucenia.io/api-reference/document-apis/get-documents

Example JSON response body returned when a document is successfully retrieved.

```json
{
  "_index": "sample-index1",
  "_id": "1",
  "_version": 1,
  "_seq_no": 0,
  "_primary_term": 9,
  "found": true,
  "_source": {
    "text": "This is just some sample text."
  }
}
```

--------------------------------

### List keystore settings

Source: https://docs.lucenia.io/security/configuration/lucenia-keystore

Displays all settings currently stored in the keystore.

```bash
./bin/lucenia-keystore list
```

```text
keystore.seed
plugins.security.ssl.http.pemkey_password_secure
```

--------------------------------

### Sample pipeline configuration

Source: https://docs.lucenia.io/tools/logstash/ship-to-lucenia

A complete pipeline configuration example that accepts stdin JSON input and outputs to Lucenia.

```text
input {  
  stdin {  
    codec => json  
  }  
}  
  
output {  
  opensearch {  
    hosts       => "https://localhost:9200"  
    user        => "admin"  
    password    => "admin"  
    index       => "logstash-logs-%{+YYYY.MM.dd}"  
    ssl_certificate_verification => false  
  }  
}  
```

--------------------------------

### Install Elasticsearch OSS Package

Source: https://docs.lucenia.io/upgrade-to/upgrade-to

Example command for upgrading the Elasticsearch OSS package via yum.

```bash
sudo yum install elasticsearch-oss-7.10.2 --enablerepo=elasticsearch  
```

--------------------------------

### Initialize Go module

Source: https://docs.lucenia.io/clients/go

Initialize a new Go module for your project.

```bash
go mod init example.com/myapp  

```

--------------------------------

### Perform a case-sensitive wildcard search

Source: https://docs.lucenia.io/query-dsl/term/wildcard

Example of a wildcard query searching for terms starting with 'H' and ending with 'Y'.

```json
GET shakespeare/_search  
{  
  "query": {  
    "wildcard": {  
      "speaker": {  
        "value": "H*Y",  
        "case_insensitive": false  
      }  
    }  
  }  
}  
```

--------------------------------

### Start Docker Containers

Source: https://docs.lucenia.io/security/authentication-backends/saml

Launch the defined services using Docker Compose.

```bash
$ docker-compose up.  
```

--------------------------------

### Initial mapping for dynamic field demonstration

Source: https://docs.lucenia.io/field-types/supported-field-types/object

Sets up an initial mapping with a single field to demonstrate dynamic field addition.

```json
PUT testindex1/_mappings  
{  
    "properties": {  
      "patient": {   
        "properties" :  
          {  
            "name" : {  
              "type" : "text"  
            }  
          }     
      }  
    }  
}  
```

--------------------------------

### GET /testindex/_search

Source: https://docs.lucenia.io/query-dsl/full-text/query-string

An example of using the query_string query to search for an expression containing a reserved character by escaping it.

```APIDOC
## GET /testindex/_search

### Description
Performs a search operation using the query_string query type. This example demonstrates how to escape reserved characters like the asterisk (*) using a double backslash within a JSON request body.

### Method
GET

### Endpoint
/testindex/_search

### Request Body
- **query** (object) - Required - The query definition containing the query_string configuration.

### Request Example
{
  "query": {
    "query_string": {
      "query": "title: 2\\*3"
    }
  }
}
```

--------------------------------

### GET /_search

Source: https://docs.lucenia.io/query-dsl

Executes a search query against an index. The example demonstrates a match_all query which retrieves all documents.

```APIDOC
## GET {index}/_search

### Description
Executes a search query against the specified index.

### Method
GET

### Endpoint
{index}/_search

### Request Body
- **query** (object) - Required - The query definition using Query DSL.

### Request Example
{
  "query": {
    "match_all": {}
  }
}
```

--------------------------------

### Setup Student Index

Source: https://docs.lucenia.io/query-dsl/term/terms

Create an index with a keyword mapping for student IDs.

```json
PUT students  
{  
  "mappings": {  
    "properties": {  
      "student_id": { "type": "keyword" }  
    }  
  }  
}  
```

--------------------------------

### Run Upgrade Tool

Source: https://docs.lucenia.io/upgrade-to/upgrade-to

Executes the upgrade utility from the distribution bin directory.

```bash
./bin/lucenia-upgrade  
```

--------------------------------

### Install Lucenia Go client

Source: https://docs.lucenia.io/clients/go

Download the Lucenia Go client package.

```bash
go get github.com/lucenia/lucenia-go  

```

--------------------------------

### GET /_search (diversified_sampler)

Source: https://docs.lucenia.io/aggregations/bucket/diversified-sampler

Example of using the diversified_sampler aggregation to collect a diverse sample of documents from an index.

```APIDOC
## GET /_search

### Description
Performs a search with a diversified_sampler aggregation to deduplicate documents based on a field.

### Method
GET

### Endpoint
/{index}/_search

### Request Body
- **aggs** (object) - Required - The aggregations to perform.
- **diversified_sampler** (object) - Required - The aggregation configuration.
- **shard_size** (integer) - Optional - Maximum number of documents collected on any one shard.
- **field** (string) - Required - The field to use for deduplication.
- **max_docs_per_value** (integer) - Optional - Maximum number of documents returned per field value (default: 1).

### Request Example
{
  "size": 0,
  "aggs": {
    "sample": {
      "diversified_sampler": {
        "shard_size": 1000,
        "field": "response.keyword"
      },
      "aggs": {
        "terms": {
          "terms": {
            "field": "agent.keyword"
          }
        }
      }
    }
  }
}

### Response
#### Success Response (200)
- **aggregations** (object) - The resulting aggregation data.
```

--------------------------------

### Create Index for Score Context

Source: https://docs.lucenia.io/api-reference/script-apis/exec-script

Setup an index with specific mappings required for the score context example.

```json
PUT /testindex1  
{  
  "mappings": {  
    "properties": {  
      "gpa_4_0": {  
        "type": "float"  
      }  
    }  
  }  
}
```

--------------------------------

### Start OpenSearch Container

Source: https://docs.lucenia.io/tools/logstash

Launch the OpenSearch container within the created network.

```bash
docker run -p 9200:9200 -p 9600:9600 --name opensearch --net test -e "discovery.type=single-node" opensearchproject/opensearch:1.2.0  
```

--------------------------------

### Create Index for Filter Context

Source: https://docs.lucenia.io/api-reference/script-apis/exec-script

Setup an index with specific mappings required for the filter context example.

```json
PUT /testindex1  
{  
  "mappings": {  
    "properties": {  
      "grad": {  
        "type": "boolean"  
      },  
      "gpa": {  
        "type": "float"  
      }  
    }  
  }  
}
```

--------------------------------

### Install via ZIP on Windows

Source: https://docs.lucenia.io/security/configuration/demo-configuration

Commands for executing the demo configuration and setting the admin password for Windows ZIP distributions.

```batch
> .\lucenia-windows-install.bat  
```

```batch
> set LUCENIA_INITIAL_ADMIN_PASSWORD=<custom-admin-password>  
```

--------------------------------

### GET /_search (Phrase Suggester)

Source: https://docs.lucenia.io/search-plugins/searching-data/did-you-mean

Example of configuring a direct generator within a phrase suggester search request.

```APIDOC
## GET /_search

### Description
Performs a search with a phrase suggester configured with a direct generator to provide spelling corrections.

### Method
GET

### Endpoint
/_search

### Request Body
- **suggest** (object) - Required - The suggest configuration block.
- **text** (string) - Required - The input text to generate suggestions for.
- **phrase-check** (object) - Required - The name of the suggestion.
- **phrase** (object) - Required - Configuration for the phrase suggester.
- **field** (string) - Required - The field to source suggestions from.
- **direct_generator** (array) - Required - List of direct generator configurations.

### Request Example
{
  "suggest": {
    "text": "design paterns",
    "phrase-check": {
      "phrase": {
        "field": "title.trigram",
        "size": 1,
        "direct_generator": [
          {
            "field": "title.trigram",
            "suggest_mode": "always",
            "min_word_length": 3
          }
        ]
      }
    }
  }
}
```

--------------------------------

### Example response

Source: https://docs.lucenia.io/api-reference/cat/cat-cluster_manager

A sample output showing the node ID, host, IP address, and node name.

```text
id                     |   host     |     ip     |   node  
ZaIkkUd4TEiAihqJGkp5CA | 172.18.0.3 | 172.18.0.3 | skylite-node2
```

--------------------------------

### Get Single Tool cURL Request

Source: https://docs.lucenia.io/ml-commons-plugin/api/mcp-server-apis/list-mcp-tools

Example of using cURL to fetch tool details with basic authentication.

```bash
curl -X GET "https://localhost:9200/_plugins/_ml/mcp/tools/tool-abc123" \
  -H "Authorization: Basic $(echo -n 'username:password' | base64)"
```

--------------------------------

### Get connector response example

Source: https://docs.lucenia.io/ml-commons-plugin/api/connector-apis/get-connector

The JSON response body containing connector configuration, parameters, and defined actions.

```json
{
  "name" : "BedRock Claude-Instant v1",
  "version" : "1",
  "description" : "Bedrock connector for Claude Instant testing",
  "protocol" : "aws_sigv4",
  "parameters" : {
    "endpoint" : "bedrock.us-east-1.amazonaws.com",
    "content_type" : "application/json",
    "auth" : "Sig_V4",
    "service_name" : "bedrock",
    "region" : "us-east-1",
    "anthropic_version" : "bedrock-2023-05-31"
  },
  "actions" : [
    {
      "action_type" : "PREDICT",
      "method" : "POST",
      "url" : "https://bedrock-runtime.us-east-1.amazonaws.com/model/anthropic.claude-instant-v1/invoke",
      "headers" : {
        "x-amz-content-sha256" : "required",
        "content-type" : "application/json"
      },
      "request_body" : "{\"prompt\":\"${parameters.prompt}\", \"max_tokens_to_sample\":${parameters.max_tokens_to_sample}, \"temperature\":${parameters.temperature},  \"anthropic_version\":\"${parameters.anthropic_version}\" }"
    }
  ]
}
```

--------------------------------

### Install via TAR on Linux

Source: https://docs.lucenia.io/security/configuration/demo-configuration

Commands for executing the demo configuration and setting the admin password for TAR distributions.

```bash
./lucenia-tar-install.sh  
```

```bash
export LUCENIA_INITIAL_ADMIN_PASSWORD=<custom-admin-password>  
```

--------------------------------

### Execute securityadmin.sh with keystore and truststore

Source: https://docs.lucenia.io/security/configuration/security-admin

Use this command to initialize security settings by providing paths and passwords for your JKS keystore and truststore files.

```bash
./securityadmin.sh -cd ../../../config/lucenia-security -icl -nhnv  
  -ts <path/to/truststore> -tspass <truststore password>  
  -ks <path/to/keystore> -kspass <keystore password>  
```

--------------------------------

### Get ISM Policy Response

Source: https://docs.lucenia.io/im-plugin/ism/api

Example JSON response containing the policy schema, states, and transition rules.

```json
{
  "_id": "policy_1",
  "_version": 2,
  "_seq_no": 10,
  "_primary_term": 1,
  "policy": {
    "policy_id": "policy_1",
    "description": "ingesting logs",
    "last_updated_time": 1577990934044,
    "schema_version": 1,
    "error_notification": null,
    "default_state": "ingest",
    "states": [
      {
        "name": "ingest",
        "actions": [
          {
            "rollover": {
              "min_doc_count": 5
            }
          }
        ],
        "transitions": [
          {
            "state_name": "search"
          }
        ]
      },
      {
        "name": "search",
        "actions": [],
        "transitions": [
          {
            "state_name": "delete",
            "conditions": {
              "min_index_age": "5m"
            }
          }
        ]
      },
      {
        "name": "delete",
        "actions": [
          {
            "delete": {}
          }
        ],
        "transitions": []
      }
    ]
  }
}
```

--------------------------------

### Configure Admin Password and Run Install Script

Source: https://docs.lucenia.io/install-and-configure/install-lucenia/windows

Set the initial admin password environment variable and execute the Windows installation batch script.

```batch
> set LUCENIA_INITIAL_ADMIN_PASSWORD=<custom-admin-password>  
```

```batch
.\lucenia-windows-install.bat  
```

--------------------------------

### GET /_search (2nd Order Derivative)

Source: https://docs.lucenia.io/aggregations/pipeline-agg

Example of chaining derivative aggregations to calculate a 2nd order derivative.

```APIDOC
## GET /_search

### Description
Calculates the 2nd order derivative by chaining a derivative aggregation on top of another derivative aggregation.

### Method
GET

### Endpoint
/{index}/_search

### Request Example
{
  "size": 0,
  "aggs": {
    "sales_per_month": {
      "date_histogram": {
        "field": "@timestamp",
        "calendar_interval": "month"
      },
      "aggs": {
        "number_of_bytes": { "sum": { "field": "bytes" } },
        "bytes_deriv": { "derivative": { "buckets_path": "number_of_bytes" } },
        "bytes_2nd_deriv": { "derivative": { "buckets_path": "bytes_deriv" } }
      }
    }
  }
}
```

--------------------------------

### Execute rank_eval request

Source: https://docs.lucenia.io/api-reference/rank-eval

Example of a GET request to evaluate search queries against specific document relevance ratings.

```json
GET shakespeare/_rank_eval  
{  
  "requests": [  
    {  
      "id": "books_query",                          
      "request": {                                                
          "query": { "match": { "text": "thou" } }  
      },  
      "ratings": [                                                
        { "_index": "shakespeare", "_id": "80", "rating": 0 },  
        { "_index": "shakespeare", "_id": "115", "rating": 1 },  
        { "_index": "shakespeare", "_id": "117", "rating": 2 }  
      ]  
    },  
    {  
      "id": "words_query",  
      "request": {  
        "query": { "match": { "text": "art" } }  
      },  
      "ratings": [  
        { "_index": "shakespeare", "_id": "115", "rating": 2 }  
      ]  
    }  
  ]  
}
```

--------------------------------

### Create an index with Go

Source: https://docs.lucenia.io/clients/go

Define custom settings and mappings using the Indices.Create method.

```go
import "strings"  
  
ctx := context.Background()  
indexName := "my-index"  
  
createResp, err := client.Indices.Create(  
    ctx,  
    luceniaapi.IndicesCreateReq{  
        Index: indexName,  
        Body: strings.NewReader(`{  
            "settings": {  
                "index": {  
                    "number_of_shards": 1,  
                    "number_of_replicas": 0  
                }  
            },  
            "mappings": {  
                "properties": {  
                    "title": { "type": "text" },  
                    "text":  { "type": "text" },  
                    "year":  { "type": "integer" }  
                }  
            }  
        }`),  
    },  
)  
if err != nil {  
    return err  
}  
fmt.Printf("Index created: %t\n", createResp.Acknowledged)
```

--------------------------------

### GET /_search (Prefix Query)

Source: https://docs.lucenia.io/query-dsl/term/prefix

Performs a search using the prefix query to match terms starting with a specific value.

```APIDOC
## GET /_search

### Description
Searches for documents where a specified field contains a term that starts with a given prefix.

### Method
GET

### Endpoint
/_search

### Parameters
#### Request Body
- **query.prefix.<field>.value** (String) - Required - The term to search for in the field.
- **query.prefix.<field>.boost** (Floating-point) - Optional - Weight of this field toward the relevance score. Default is 1.0.
- **query.prefix.<field>.case_insensitive** (Boolean) - Optional - Allows case-insensitive matching. Default is false.
- **query.prefix.<field>.rewrite** (String) - Optional - Determines how the query is rewritten and scored. Default is constant_score.

### Request Example
{
  "query": {
    "prefix": {
      "speaker": {
        "value": "KING H",
        "boost": 1.0,
        "case_insensitive": false
      }
    }
  }
}
```

--------------------------------

### Basic lucenia-keystore command syntax

Source: https://docs.lucenia.io/security/configuration/lucenia-keystore

General syntax for executing the keystore utility script.

```bash
lucenia-keystore [command] [options]
```

--------------------------------

### Display securityadmin.sh help

Source: https://docs.lucenia.io/security/configuration/security-admin

Run the script without arguments to list all available command-line options.

```bash
./plugins/lucenia-security/tools/securityadmin.sh  
```

--------------------------------

### GET /shakespeare/_search

Source: https://docs.lucenia.io/query-dsl/minimum-should-match

An example of using the minimum_should_match parameter to require a document to match at least two out of three search terms.

```APIDOC
## GET /shakespeare/_search

### Description
Performs a full-text search on the specified index where the document must match a minimum number of terms defined by the minimum_should_match parameter.

### Method
GET

### Endpoint
/shakespeare/_search

### Request Body
- **query** (object) - Required - The query object containing the match criteria.
- **match** (object) - Required - The field to search against.
- **minimum_should_match** (string/integer) - Optional - Specifies the minimum number of terms a document must match. Valid values include non-negative integers, negative integers, percentages, and complex combinations like '2<75%'.
```
Tokens:
Raw