Administering Augmented Search

November 14, 2023

Editing the configuration file

This section presents how to configure the index, so the search results do return the expected pages or content. Consult the Search relevance and boosting page to learn how the search experience can be fine-tuned to better address your needs and dataset.

The index configuration is done in the org.jahia.modules.augmentedsearch.cfg configuration file.

You will need to re-index your environment after each modification of the index configuration, so your changes can be taken into account for the existing content. Some changes, like boost configuration, do not require a re-indexing.

Using the OSGi console

The properties used to configure the Augmented Search index can be edited from the OSGi console:

  1. In Jahia Tools, navigate to Administration and Guidance>OSGi console.
  2. Select OSGI>Configuration
  3. Search for the org.jahia.modules.augmentedsearch module, and click on it
  4. A modal is then displayed, allowing you to edit the Augmented Search configuration properties:
    jahia-tools-as.png
  5. Click Save at the bottom of the modal

Using the GraphQL API

You can change the value of any property using the following GraphQL query, replacing PROPERTY_NAME and PROPERTY_VALUE with the desired values:

mutation {
  admin {
    jahia {
      configuration(
        pid: "org.jahia.modules.augmentedsearch"
        identifier: "default"
      ) {
        value(name: "PROPERTY_NAME", value:"PROPERTY_VALUE" )
      }
    }
  }
}

The following example specifies that pdf, docx and doc file content shall be indexed:

mutation {
  admin {
    jahia {
      configuration(
        pid: "org.jahia.modules.augmentedsearch"
        identifier: "default"
      ) {
        value(name: "org.jahia.modules.augmentedsearch.content.indexedFileExtensions", value:"pdf, docx, doc" )
      }
    }
  }
}

By editing the file on the file system

This method cannot be used on Jahia Cloud

The file is actually located under digital-factory-data/karaf/etc/ and can be directly updated from there.

 

Other configurations

Other parameters are available in the configuration files to customize Augmented Search behavior even further:

  • Language analyzer
    Defines the analyzer used for a specific language
  • Buffering configuration
    Defines the strategy and timing to use when Jahia checks for the Elasticsearch connection after Elasticsearch has become unreachable
  • Reindexing requests batch size
    Sets the number of requests sent at a time while reindexing
  • and more (see comments in the configuration file itself)