diff --git a/users/ref-config/searchalicious-config-schema.html b/users/ref-config/searchalicious-config-schema.html index 5f4e5643..c6391272 100644 --- a/users/ref-config/searchalicious-config-schema.html +++ b/users/ref-config/searchalicious-config-schema.html @@ -30,4 +30,4 @@

Preprocessor

Default: null

Type: string

The full qualified reference to the preprocessor
to use before data import.

This class must inherit app.indexing.BaseDocumentPreprocessor
and specialize the preprocess method.

This is used to adapt the data schema
or to add search-a-licious specific fields
for example.


Example:

app.openfoodfacts.DocumentPreprocessor
 

Result Processor

Default: null

Type: string

The full qualified reference to the elasticsearch result processor
to use after search query to Elasticsearch.

) This class must inherit app.postprocessing.BaseResultProcessor
and specialize the process_after

                This is can be used to add custom fields computed from index content.
 

Example:

app.openfoodfacts.ResultProcessor
-

Scripts

Default: null

Type: object

You can add scripts that can be used for sorting results.

Each key is a script name, with it's configuration.

Each additional property must conform to the following schema

Type: object

Scripts can be used to sort results of a search.

This use ElasticSearch internal capabilities

Type: enum (of string) Default: "expression"

The script language, as supported by Elasticsearch

Must be one of:

  • "expression"
  • "painless"

Source

Type: string

The source of the script

Params


Type: object

Params for the scripts. We need this to retrieve and validate parameters

Static Params


Type: object

Additional params for the scripts that can't be supplied by the API (constants)

Match Phrase Boost

Type: number Default: 2.0

How much we boost exact matches on individual fields

This only makes sense when using "best match" order.

Document Denylist

Type: array of string

list of documents IDs to ignore.

Use this to skip some documents at indexing time.

All items must be unique

No Additional Items

Each item of this array must be:

Redis Stream Name

Default: null

Name of the Redis stream to read from when listening to document updates.

If not provided, document updates won't be listened to for this index.

Default Index

Type: string

the default index to use when no index is specified in the query

\ No newline at end of file +
Type: null

Scripts

Default: null

Type: object

You can add scripts that can be used for sorting results.

Each key is a script name, with it's configuration.

Each additional property must conform to the following schema

Type: object

Scripts can be used to sort results of a search.

This use ElasticSearch internal capabilities

Type: enum (of string) Default: "expression"

The script language, as supported by Elasticsearch

Must be one of:

  • "expression"
  • "painless"

Source

Type: string

The source of the script

Params


Type: object

Params for the scripts. We need this to retrieve and validate parameters

Static Params


Type: object

Additional params for the scripts that can't be supplied by the API (constants)

Match Phrase Boost

Type: number Default: 2.0

How much we boost exact matches on individual fields

This only makes sense when using "best match" order.

Document Denylist

Type: array of string

list of documents IDs to ignore.

Use this to skip some documents at indexing time.

All items must be unique

No Additional Items

Each item of this array must be:

Redis Stream Name

Default: null

Name of the Redis stream to read from when listening to document updates.

If not provided, document updates won't be listened to for this index.

Default Index

Type: string

the default index to use when no index is specified in the query

\ No newline at end of file diff --git a/users/ref-settings/searchalicious-settings-schema.html b/users/ref-settings/searchalicious-settings-schema.html index 5833dc90..ca34056f 100644 --- a/users/ref-settings/searchalicious-settings-schema.html +++ b/users/ref-settings/searchalicious-settings-schema.html @@ -1,4 +1,4 @@ JSON schema for search-a-licious settings

JSON schema for search-a-licious settings

Type: object

Settings for Search-a-licious

The most important settings is config_path.

Those settings can be overridden through environment
by using the name in capital letters.
If you use docker compose, a good way to do that
is to modify those values in your .env file.

No Additional Properties

Config Path

Default: null

Path to the search-a-licious yaml configuration file.

See Explain configuration file for more information

Type: stringFormat: path
Type: null

Elasticsearch Url

Type: string Default: "http://localhost:9200"

URL to the ElasticSearch instance

Bare in mind this is from inside the container.

Redis Host

Type: string Default: "localhost"

Host for the Redis instance containing event stream

Bare in mind this is from inside the container.

Redis Port

Type: integer Default: 6379

Port for the redis host instance containing event stream

Redis Reader Timeout

Type: integer Default: 5

timeout in seconds to read redis event stream

Sentry Dns

Default: null

Sentry DNS to report incident, if None no incident is reported

Type: string
Type: null

Type: enum (of string) Default: "INFO"

Log level. Accepted logging levels

* NOTSET - means no los
 * DEBUG / INFO / WARNING / ERROR / CRITICAL
   - match standard Python logging levels
-

Must be one of:

  • "NOTSET"
  • "DEBUG"
  • "INFO"
  • "WARNING"
  • "ERROR"
  • "CRITICAL"

Taxonomy Cache Dir

Type: stringFormat: path Default: "data/taxonomies"

Directory where to store taxonomies before ingestion to ElasticSearch

User Agent

Type: string Default: "search-a-licious"

User-Agent used when fetching resources (taxonomies) or documents

\ No newline at end of file +

Must be one of:

Taxonomy Cache Dir

Type: stringFormat: path Default: "data/taxonomies"

Directory where to store taxonomies before ingestion to ElasticSearch

User Agent

Type: string Default: "search-a-licious"

User-Agent used when fetching resources (taxonomies) or documents

\ No newline at end of file