This version is still in development and is not considered stable yet. For the latest snapshot version, please use Spring AI 1.0.0-SNAPSHOT! |
For spring-boot versions pre 3.3.0 it’s necessary to explicitly add the elasticsearch-java dependency with version > 8.13.3, otherwise the older version used will be incompatible with the queries performed: |
Refer to the Dependency Management section to add the Spring AI BOM to your build file. |
Refer to the Repositories section to add Milestone and/or Snapshot Repositories to your build file. |
this is a breaking change! In earlier versions of Spring AI, this schema initialization happened by default. |
If you choose to create a shell script for ease in future work, be sure to run it prior to starting your application by "sourcing" the file, i.e. source <your_script_name>.sh .
|
Property | Description | Default Value |
---|---|---|
|
Connection timeout used when communicating with Elasticsearch. |
|
|
Password for authentication with Elasticsearch. |
- |
|
Username for authentication with Elasticsearch. |
- |
|
Comma-separated list of the Elasticsearch instances to use. |
|
|
Prefix added to the path of every request sent to Elasticsearch. |
- |
|
Delay of a sniff execution scheduled after a failure. |
|
|
Interval between consecutive ordinary sniff executions. |
|
|
SSL bundle name. |
- |
|
Whether to enable socket keep alive between client and Elasticsearch. |
|
|
Socket timeout used when communicating with Elasticsearch. |
|
Property | Description | Default Value |
---|---|---|
|
Whether to initialize the required schema |
|
|
The name of the index to store the vectors. |
spring-ai-document-index |
|
The number of dimensions in the vector. |
1536 |
|
The similarity function to use. |
|
|
whether to initialize the required schema |
|
Those (portable) filter expressions get automatically converted into the proprietary Elasticsearch Query string query. |