Package org.springframework.ai.vectorstore.elasticsearch

Class ElasticsearchVectorStore.Builder

java.lang.Object

org.springframework.ai.vectorstore.AbstractVectorStoreBuilder<ElasticsearchVectorStore.Builder>

org.springframework.ai.vectorstore.elasticsearch.ElasticsearchVectorStore.Builder

All Implemented Interfaces:

VectorStore.Builder<ElasticsearchVectorStore.Builder>

Enclosing class:

ElasticsearchVectorStore

public static class ElasticsearchVectorStore.Builder
extends AbstractVectorStoreBuilder<ElasticsearchVectorStore.Builder>

Field Summary

Fields inherited from class org.springframework.ai.vectorstore.AbstractVectorStoreBuilder

batchingStrategy, customObservationConvention, embeddingModel, observationRegistry

Constructor Summary

Constructors

Constructor	Description
Builder(org.elasticsearch.client.RestClient restClient, EmbeddingModel embeddingModel)	Sets the Elasticsearch REST client.

Method Summary

Modifier and Type	Method	Description
ElasticsearchVectorStore	build()	Builds the ElasticsearchVectorStore instance.
ElasticsearchVectorStore.Builder	filterExpressionConverter(FilterExpressionConverter converter)	Sets the filter expression converter.
ElasticsearchVectorStore.Builder	initializeSchema(boolean initializeSchema)	Sets whether to initialize the schema.
ElasticsearchVectorStore.Builder	options(ElasticsearchVectorStoreOptions options)	Sets the Elasticsearch vector store options.

Methods inherited from class org.springframework.ai.vectorstore.AbstractVectorStoreBuilder

batchingStrategy, customObservationConvention, getBatchingStrategy, getCustomObservationConvention, getEmbeddingModel, getObservationRegistry, observationRegistry, self

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder(org.elasticsearch.client.RestClient restClient,
 EmbeddingModel embeddingModel)

Sets the Elasticsearch REST client.

Parameters:

restClient - the Elasticsearch REST client

embeddingModel - the Embedding Model to be used

Method Details

options

public ElasticsearchVectorStore.Builder options(ElasticsearchVectorStoreOptions options)

Sets the Elasticsearch vector store options.

Parameters:

options - the vector store options to use

Returns:

the builder instance

Throws:

IllegalArgumentException - if options is null

initializeSchema

public ElasticsearchVectorStore.Builder initializeSchema(boolean initializeSchema)

Sets whether to initialize the schema.

Parameters:

initializeSchema - true to initialize schema, false otherwise

Returns:

the builder instance

filterExpressionConverter

public ElasticsearchVectorStore.Builder filterExpressionConverter(FilterExpressionConverter converter)

Sets the filter expression converter.

Parameters:

converter - the filter expression converter to use

Returns:

the builder instance

Throws:

IllegalArgumentException - if converter is null

build

public ElasticsearchVectorStore build()

Builds the ElasticsearchVectorStore instance.

Returns:

a new ElasticsearchVectorStore instance

Throws:

IllegalStateException - if the builder is in an invalid state