Module io.helidon.integrations.langchain4j.providers.coherence

Package io.helidon.integrations.langchain4j.providers.coherence

Interface CoherenceEmbeddingStoreConfig

All Superinterfaces:

Prototype.Api

All Known Implementing Classes:

CoherenceEmbeddingStoreConfig.BuilderBase.CoherenceEmbeddingStoreConfigImpl

public interface CoherenceEmbeddingStoreConfig
extends Prototype.Api

Interface generated from definition. Please add javadoc to the definition interface.

See Also:

• builder()
• create()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	CoherenceEmbeddingStoreConfig.Builder	Fluent API builder for CoherenceEmbeddingStoreConfig.
static class	CoherenceEmbeddingStoreConfig.BuilderBase<BUILDER extends CoherenceEmbeddingStoreConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends CoherenceEmbeddingStoreConfig>	Fluent API builder base for CoherenceEmbeddingStoreConfig.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONFIG_ROOT	The root configuration key for this builder.
static final double	WEIGHT	Default weight used for model factories.

Method Summary

Modifier and Type	Method	Description
static CoherenceEmbeddingStoreConfig.Builder	builder()	Create a new fluent API builder to customize configuration.
static CoherenceEmbeddingStoreConfig.Builder	builder(CoherenceEmbeddingStoreConfig instance)	Create a new fluent API builder from an existing instance.
default dev.langchain4j.store.embedding.coherence.CoherenceEmbeddingStore.Builder	configuredBuilder()	Skipped: session - property already exist -> dev.langchain4j.store.embedding.coherence.CoherenceEmbeddingStore.Builder session(java.lang.String) index - by pattern 'index.*' build - doesn't have exactly one parameter
static CoherenceEmbeddingStoreConfig	create()	Create a new instance with default values.
static CoherenceEmbeddingStoreConfig	create(Config config)	Deprecated. use create(io.helidon.config.Config)
static CoherenceEmbeddingStoreConfig	create(Config config)	Create a new instance from configuration.
Optional<Integer>	dimension()	The number of dimensions in the embeddings.
Optional<dev.langchain4j.model.embedding.EmbeddingModel>	embeddingModel()	The embedding model to use.
boolean	enabled()	If set to false (default), CoherenceEmbeddingStore will not be available even if configured.
Optional<String>	index()	The index name to use.
Optional<String>	name()	Generated from CoherenceEmbeddingStore.Builder.name(java.lang.String)
Optional<Boolean>	normalizeEmbeddings()	Generated from CoherenceEmbeddingStore.Builder.normalizeEmbeddings(boolean)
Optional<String>	session()	Generated from CoherenceEmbeddingStore.Builder.session(java.lang.String)

Field Details

CONFIG_ROOT

static final String CONFIG_ROOT

The root configuration key for this builder.

See Also:

• Constant Field Values

WEIGHT

static final double WEIGHT

Default weight used for model factories.

See Also:

• Constant Field Values

Method Details

builder

static CoherenceEmbeddingStoreConfig.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static CoherenceEmbeddingStoreConfig.Builder builder(CoherenceEmbeddingStoreConfig instance)

Create a new fluent API builder from an existing instance.

Parameters:

instance - an existing instance used as a base for the builder

Returns:

a builder based on an instance

create

static CoherenceEmbeddingStoreConfig create(Config config)

Create a new instance from configuration.

Parameters:

config - used to configure the new instance

Returns:

a new instance configured from configuration

create

@Deprecated
static CoherenceEmbeddingStoreConfig create(Config config)

Deprecated.

use create(io.helidon.config.Config)

Create a new instance from configuration.

Parameters:

config - used to configure the new instance

Returns:

a new instance configured from configuration

create

static CoherenceEmbeddingStoreConfig create()

Create a new instance with default values.

Returns:

a new instance

enabled

boolean enabled()

If set to false (default), CoherenceEmbeddingStore will not be available even if configured.

Returns:

whether CoherenceEmbeddingStore is enabled, defaults to false

normalizeEmbeddings

Optional<Boolean> normalizeEmbeddings()

Generated from CoherenceEmbeddingStore.Builder.normalizeEmbeddings(boolean)

Returns:

boolean property

session

Optional<String> session()

Generated from CoherenceEmbeddingStore.Builder.session(java.lang.String)

Returns:

String property

name

Optional<String> name()

Generated from CoherenceEmbeddingStore.Builder.name(java.lang.String)

Returns:

String property

index

Optional<String> index()

The index name to use.

Returns:

an Optional containing index name.

dimension

Optional<Integer> dimension()

The number of dimensions in the embeddings.

If an embedding model is configured than the model's dimensions will be used instead of this configuration.

Returns:

an Optional containing number of dimensions in the embeddings.

embeddingModel

Optional<dev.langchain4j.model.embedding.EmbeddingModel> embeddingModel()

The embedding model to use.

Returns:

an Optional containing embedding model.

configuredBuilder

default dev.langchain4j.store.embedding.coherence.CoherenceEmbeddingStore.Builder configuredBuilder()

Skipped:

• session - property already exist -> dev.langchain4j.store.embedding.coherence.CoherenceEmbeddingStore.Builder session(java.lang.String)
• index - by pattern 'index.*'
• build - doesn't have exactly one parameter

Overridden:

• CoherenceLc4jProvider.index()
• CoherenceLc4jProvider.embeddingModel()
• CoherenceLc4jProvider.dimension()

Returns:

Actual Lc4j model builder configured with this blueprint.