From 55b1dbc38ce006b2c56f918ceb2d62fa7d2c98da Mon Sep 17 00:00:00 2001 From: alexgarel Date: Mon, 7 Oct 2024 14:08:12 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20openfood?= =?UTF-8?q?facts/search-a-licious@a321cd251cf07b27c33e496a2ead278f04180a69?= =?UTF-8?q?=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- sitemap.xml | 36 +++++++++--------- sitemap.xml.gz | Bin 399 -> 398 bytes .../searchalicious-config-schema.html | 2 +- .../searchalicious-settings-schema.html | 2 +- 4 files changed, 20 insertions(+), 20 deletions(-) diff --git a/sitemap.xml b/sitemap.xml index 9ba84fd6..6d8f4843 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -2,74 +2,74 @@ https://openfoodfacts.github.io/search-a-licious/ - 2024-10-04 + 2024-10-07 https://openfoodfacts.github.io/search-a-licious/devs/explain-architecture/ - 2024-10-04 + 2024-10-07 https://openfoodfacts.github.io/search-a-licious/devs/explain-web-frontend/ - 2024-10-04 + 2024-10-07 https://openfoodfacts.github.io/search-a-licious/devs/how-to-debug-backend/ - 2024-10-04 + 2024-10-07 https://openfoodfacts.github.io/search-a-licious/devs/how-to-install/ - 2024-10-04 + 2024-10-07 https://openfoodfacts.github.io/search-a-licious/devs/introduction/ - 2024-10-04 + 2024-10-07 https://openfoodfacts.github.io/search-a-licious/devs/ref-python/ - 2024-10-04 + 2024-10-07 https://openfoodfacts.github.io/search-a-licious/reports/2024-06%20thoughts%20on%20scoring/ - 2024-10-04 + 2024-10-07 https://openfoodfacts.github.io/search-a-licious/users/explain-configuration/ - 2024-10-04 + 2024-10-07 https://openfoodfacts.github.io/search-a-licious/users/explain-query-language/ - 2024-10-04 + 2024-10-07 https://openfoodfacts.github.io/search-a-licious/users/how-to-install/ - 2024-10-04 + 2024-10-07 https://openfoodfacts.github.io/search-a-licious/users/how-to-update-index/ - 2024-10-04 + 2024-10-07 https://openfoodfacts.github.io/search-a-licious/users/how-to-use-scripts/ - 2024-10-04 + 2024-10-07 https://openfoodfacts.github.io/search-a-licious/users/ref-config/ - 2024-10-04 + 2024-10-07 https://openfoodfacts.github.io/search-a-licious/users/ref-openapi/ - 2024-10-04 + 2024-10-07 https://openfoodfacts.github.io/search-a-licious/users/ref-settings/ - 2024-10-04 + 2024-10-07 https://openfoodfacts.github.io/search-a-licious/users/ref-web-components/ - 2024-10-04 + 2024-10-07 https://openfoodfacts.github.io/search-a-licious/users/tutorial/ - 2024-10-04 + 2024-10-07 \ No newline at end of file diff --git a/sitemap.xml.gz b/sitemap.xml.gz index 69a7683bd7300e62fae2be331f976efff2316fd7..2a58ff6ce8df113d9ac69669ce563ac41dffe6ca 100644 GIT binary patch literal 398 zcmV;90df8xiwFpSBm-vx|8r?{Wo=<_E_iKh0L_+5Zo?oDhW9x|WT{Jx8&!QNad$mI zdjJAs8`WVbGsMa5J5HjgS+@&V@Mh-YF~3;99d_e#4~aa6O?6*4)e?e5=R?1#K0n^o zbM@9P);Wy?yp+j-Hr2o!U$vg5sV2{`Gm&acy(T+IgY>0SH}y-^E|!vJ1LxW)tw*%& zY=y)OMhG3E>x^Zpd(T7O)*dy1Np?_1joy09q}O_0_S=df-l1z(&FVqjH>!D(DVM&p zTYdHWF9Z(uq~Q=p&H3F9Vfk~uF3j*UQ(O+GRegElM4ISh(InwOa9 si(-<$7mJFOb$9b0!{RPtfKbr0;>;rX<`434D&)x9A7cq_XC4ax0RDu&U;qFB literal 399 zcmV;A0dW2wiwFn+F#l!(|8r?{Wo=<_E_iKh0L_+5PQx$|hWDJJip0`!T2%;8o9;LP z9Kf|FiACx$o^jLOo=IC(u!e=b@Y^$=AM?wb-RUqcj*!S>*jCHBsTL3{Iv@IN_3{3u zo~vE^u*qp8;Dt;Mw5NVLx8l-QXx~X5P_F*AuHgK(7(q=^4 z&Q?gwV1&>iy3Sapy7xTfeeF>bm}CcK)ab3pOnRf|Wk0PL;sd&N)vVTP*{EhMQ*M1% zxBBk)UkDr=Ny90Q#s@Wz$wn>b1f{V}uvcBezz|$1Yy(b;Q90P>UhR$jERW3xVl$4V zQ2D?KUA8R2Sqf8vPQ^11MGz&3n3(j%Ve|C3Y6L9z1CvxSNJbWuXjuWQnM7sp0ctUH zzR$@Na<{+fzA~h<8cpc4>7f|B;-d5yR*udv2%Updacl&NZ1Rz*7_?bQu3=CV(!9h( tUlf!4y;xMNth<~47#0r^1B8N}6=xR7H-C_aOCd+zegi^Bv&S9_006eL!94%~ diff --git a/users/ref-config/searchalicious-config-schema.html b/users/ref-config/searchalicious-config-schema.html index cd4b1b82..5f4e5643 100644 --- a/users/ref-config/searchalicious-config-schema.html +++ b/users/ref-config/searchalicious-config-schema.html @@ -30,4 +30,4 @@

root indices IndexConfig preprocessor

Preprocessor

Default: null

root indices IndexConfig preprocessor anyOf item 0
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
root indices IndexConfig preprocessor anyOf item 1
Type: null

root indices IndexConfig result_processor

Result Processor

Default: null

root indices IndexConfig result_processor anyOf item 0
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
-
root indices IndexConfig result_processor anyOf item 1
Type: null

root indices IndexConfig scripts

Scripts

Default: null

root indices IndexConfig scripts anyOf item 0
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

root indices IndexConfig scripts anyOf item 0 ScriptConfig
Type: object

Scripts can be used to sort results of a search.

This use ElasticSearch internal capabilities

root indices IndexConfig scripts anyOf item 0 ScriptConfig lang
Type: enum (of string) Default: "expression"

The script language, as supported by Elasticsearch

Must be one of:

  • "expression"
  • "painless"

root indices IndexConfig scripts anyOf item 0 ScriptConfig source

Source

Type: string

The source of the script

root indices IndexConfig scripts anyOf item 0 ScriptConfig params

Params


root indices IndexConfig scripts anyOf item 0 ScriptConfig params anyOf item 0
Type: object

Params for the scripts. We need this to retrieve and validate parameters
root indices IndexConfig scripts anyOf item 0 ScriptConfig params anyOf item 1
Type: null

root indices IndexConfig scripts anyOf item 0 ScriptConfig static_params

Static Params


root indices IndexConfig scripts anyOf item 0 ScriptConfig static_params anyOf item 0
Type: object

Additional params for the scripts that can't be supplied by the API (constants)
root indices IndexConfig scripts anyOf item 0 ScriptConfig static_params anyOf item 1
Type: null
root indices IndexConfig scripts anyOf item 1
Type: null

root indices IndexConfig match_phrase_boost

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.

root indices IndexConfig document_denylist

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:

root indices IndexConfig document_denylist document_denylist items
Type: string

root indices IndexConfig redis_stream_name

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.

root default_index

Default Index

Type: string

the default index to use when no index is specified in the query
\ No newline at end of file +
root indices IndexConfig result_processor anyOf item 1
Type: null

root indices IndexConfig scripts

Scripts

Default: null

root indices IndexConfig scripts anyOf item 0
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

root indices IndexConfig scripts anyOf item 0 ScriptConfig
Type: object

Scripts can be used to sort results of a search.

This use ElasticSearch internal capabilities

root indices IndexConfig scripts anyOf item 0 ScriptConfig lang
Type: enum (of string) Default: "expression"

The script language, as supported by Elasticsearch

Must be one of:

  • "expression"
  • "painless"

root indices IndexConfig scripts anyOf item 0 ScriptConfig source

Source

Type: string

The source of the script

root indices IndexConfig scripts anyOf item 0 ScriptConfig params

Params


root indices IndexConfig scripts anyOf item 0 ScriptConfig params anyOf item 0
Type: object

Params for the scripts. We need this to retrieve and validate parameters
root indices IndexConfig scripts anyOf item 0 ScriptConfig params anyOf item 1
Type: null

root indices IndexConfig scripts anyOf item 0 ScriptConfig static_params

Static Params


root indices IndexConfig scripts anyOf item 0 ScriptConfig static_params anyOf item 0
Type: object

Additional params for the scripts that can't be supplied by the API (constants)
root indices IndexConfig scripts anyOf item 0 ScriptConfig static_params anyOf item 1
Type: null
root indices IndexConfig scripts anyOf item 1
Type: null

root indices IndexConfig match_phrase_boost

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.

root indices IndexConfig document_denylist

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:

root indices IndexConfig document_denylist document_denylist items
Type: string

root indices IndexConfig redis_stream_name

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.

root default_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 d4138fe2..5833dc90 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

root config_path

Config Path

Default: null

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

See Explain configuration file for more information

root config_path anyOf item 0
Type: stringFormat: path
root config_path anyOf item 1
Type: null

root elasticsearch_url

Elasticsearch Url

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

URL to the ElasticSearch instance

Bare in mind this is from inside the container.

root redis_host

Redis Host

Type: string Default: "localhost"

Host for the Redis instance containing event stream

Bare in mind this is from inside the container.

root redis_port

Redis Port

Type: integer Default: 6379

Port for the redis host instance containing event stream

root redis_reader_timeout

Redis Reader Timeout

Type: integer Default: 5

timeout in seconds to read redis event stream

root sentry_dns

Sentry Dns

Default: null

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

root sentry_dns anyOf item 0
Type: string
root sentry_dns anyOf item 1
Type: null

root log_level
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"

root taxonomy_cache_dir

Taxonomy Cache Dir

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

Directory where to store taxonomies before ingestion to ElasticSearch

root user_agent

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:

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

root taxonomy_cache_dir

Taxonomy Cache Dir

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

Directory where to store taxonomies before ingestion to ElasticSearch

root user_agent

User Agent

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

User-Agent used when fetching resources (taxonomies) or documents
\ No newline at end of file