This directory contains assets for the Knowledge Base feature. The assets are used by the Elastic AI Assistant to answer questions about content that the underlying model may not have been trained on. Initial assets are provided for the following categories:
- ES|QL
- General Documentation as from: https://github.com/elastic/elasticsearch/tree/main/docs/reference/esql
- Excluding
functions/signature/*.svg
- Excluding
- ANTLR Language Definitions as from: https://github.com/elastic/elasticsearch/tree/main/x-pack/plugin/esql/src/main/antlr
- Sample queries that represent valid (and invalid) ES|QL queries, curated manually from a variety of sources
- General Documentation as from: https://github.com/elastic/elasticsearch/tree/main/docs/reference/esql
The assets are stored in their original source format, so .asciidoc for documentation, and .g4 and .tokens for the ANTLR language definitions. File names have been updated to be snake_case to satisfy Kibana linting rules.
NOTE: When adding knowledge base assets, please ensure that the source files and directories are not excluded as part of the Kibana build process, otherwise things will work fine locally, but will fail once a distribution has been built (i.e. cloud deployments). See src/dev/build/tasks/copy_legacy_source_task.ts for details on exclusion patterns.
Once asset format and chunking strategies are finalized, we may want to either move the assets to a shared package so they can be consumed by other plugins, or potentially ship the pre-packaged ELSER embeddings as part of a Fleet Integration. For now though, the assets will be included in their source format within the plugin, and can then be processed and embedded at runtime.