Class ElasticsearchConfigurationScript

java.lang.Object

dev.langchain4j.store.embedding.elasticsearch.ElasticsearchConfigurationScript

All Implemented Interfaces:

ElasticsearchConfiguration

public class ElasticsearchConfigurationScript
extends Object
implements ElasticsearchConfiguration

Represents an Elasticsearch index as an embedding store. Current implementation assumes the index uses the cosine distance metric.
Supports storing Metadata and filtering by it using Filter (provided inside EmbeddingSearchRequest).

Documents without a vector value are excluded before scoring. This allows text-only documents to coexist with embedded documents in the same index while remaining available to ElasticsearchConfigurationFullText.

See Also:

• vector-functions-cosine

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ElasticsearchConfigurationScript.Builder

Field Summary

Fields inherited from interface ElasticsearchConfiguration

TEXT_FIELD, VECTOR_FIELD

Method Summary

Modifier and Type	Method	Description
static ElasticsearchConfigurationScript.Builder	builder()
boolean	isIncludeVectorResponse()	Temporary method which returns if we should return the Vector in the response
co.elastic.clients.elasticsearch.core.SearchResponse<Document>	vectorSearch(co.elastic.clients.elasticsearch.ElasticsearchClient client, String indexName, EmbeddingSearchRequest embeddingSearchRequest)	Used for vector search

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ElasticsearchConfiguration

fullTextSearch, fullTextSearch, hybridSearch

Method Details

builder

public static ElasticsearchConfigurationScript.Builder builder()

isIncludeVectorResponse

public boolean isIncludeVectorResponse()

Description copied from interface: ElasticsearchConfiguration

Temporary method which returns if we should return the Vector in the response

Specified by:

isIncludeVectorResponse in interface ElasticsearchConfiguration

Returns:

true or false

vectorSearch

public co.elastic.clients.elasticsearch.core.SearchResponse<Document> vectorSearch(co.elastic.clients.elasticsearch.ElasticsearchClient client,
 String indexName,
 EmbeddingSearchRequest embeddingSearchRequest)
                                                                            throws co.elastic.clients.elasticsearch._types.ElasticsearchException,
IOException

Description copied from interface: ElasticsearchConfiguration

Used for vector search

Specified by:

vectorSearch in interface ElasticsearchConfiguration

Parameters:

client - The Elasticsearch client

indexName - The index name

embeddingSearchRequest - The embedding search request

Returns:

The search response

Throws:

co.elastic.clients.elasticsearch._types.ElasticsearchException - if an error occurs during the search

IOException - if an I/O error occurs