Documentation

Query Configuration

You can access this dialog via Search UX and by adding an Apache Solr instance as search engine.

1. Document index name: this is the name of the document index.

2. Principal index name: this is the name of the principal index. The principal index is where the connector stored user-group relationships and which is used to construct the ACL entries for the user.

3. Solr base URL: this is the FQDN, with port and protocol which points to the /solr endpoint of the Solr installation.

4. Use basic authentication: if you configured basic authentication for securing direct access to the Solr instance, check this box.

   1. Username: is the username for basic auth.

   2. Password: is the according password.

5. Public keys for SSL certificates: this configuration is needed, if you run the environment with self-signed certificates, or certificates which are not known to the Java key store.
   We use a straight-forward approach to validate SSL certificates. In order to render a certificate valid, add the modulus of the public key into this text field. You can access this modulus by viewing the certificate within the browser.

5. Response timeout: determines the timeout when waiting for Solr responses in milliseconds.

6. Connection timeout: determines the timeout when waiting for connections to Solr in milliseconds.

7. Socket timeout: determines the timeout when waiting for connections to Solr in milliseconds.

8. Df parameter: here you can add the default fields to search through
   Please make sure that these fields also exist in the search schema. Otherwise, validation will fail.

9. Qf parameter: here you can add the fields, Solr should search through including weights.

   Please make sure that these fields also exist in the search schema. Otherwise, validation will fail.

10. Highlighted fields: Here you can add the fields which should be used for hit-highlighting
    Please make sure that these fields also exist in the search schema. Otherwise, validation will fail.

11. MM: this determines the minimum should match for the query. Where 100% means that all search terms should be in the search result.

12. Body field: this is the name of the field, which the search interface should interpret as the main text field.

13. Vector field for title. This is the first field, which will be used for vector search, if a vectorized content is found (see the query pipeline documentation at Query Transformers .

14. Vector field for body. This is the second field, which will be used for vector search, if a vectorized content is found (see the query pipeline documentation at Query Transformers .

15. Top k parameter for vector search: this parameter is relevant for vector search and defines how many results will be returned when having a vector search.

16. Filters (aka refiners aka aggregations)

    1. Within this dialog you can add and remove filters. This does not mean that filters will be shown in the search interface right away, but it is needed to tell the search engine to return calculated filters.

    2. Filter type: defines if this is a term filter (such as for file types), range filters (such as for prices) or date filters.

    3. Fieldname: is the name of the field which the filter should be computed for.

    4. Number of values to show: for term filters this defines how many values should be returned.

    5. Sorting: defines if the filter buckets should be sorted based on the document frequency (number of results) or lexicographically

    6. Sort direction: if sorting should be descending or ascending (based on the ordering type in e.)

When finished with setting these fields, click on validate and save. If you observe any issues, then the validator will let you know or you can find more insights in the log files.

Vector Search Dimensions

When using vector search, you need to make sure that the embeddings you use in the query, as well as in the content transformation pipeline have exactly the same dimension as the index fields vector body and vector title. Otherwise indexing or querying the index will fail.