Module io.helidon.integrations.langchain4j.providers.lc4jinprocess

Package io.helidon.integrations.langchain4j.providers.lc4jinprocess

Interface InProcessEmbeddingModelConfig

All Superinterfaces:

Prototype.Api

All Known Implementing Classes:

InProcessEmbeddingModelConfig.BuilderBase.InProcessEmbeddingModelConfigImpl

public interface InProcessEmbeddingModelConfig
extends Prototype.Api

Configuration blueprint for LangChain4j in-process models.

See Also:

• builder()

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static InProcessEmbeddingModelConfig.Builder	builder()	Create a new fluent API builder to customize configuration.
static InProcessEmbeddingModelConfig.Builder	builder(InProcessEmbeddingModelConfig instance)	Create a new fluent API builder from an existing instance.
static InProcessEmbeddingModelConfig	create(Config config)	Deprecated. use create(io.helidon.config.Config)
static InProcessEmbeddingModelConfig	create(Config config)	Create a new instance from configuration.
boolean	enabled()	Whether the embedding model is enabled.
Optional<ThreadPoolConfig>	executor()	Executor configuration used by the embedding model.
Optional<Path>	pathToModel()	The path to the modelPath file (e.g., "/path/to/model.onnx").
Optional<Path>	pathToTokenizer()	The path to the tokenizer file (e.g., "/path/to/tokenizer.json").
Optional<dev.langchain4j.model.embedding.onnx.PoolingMode>	poolingMode()	The pooling model to use.
InProcessModelType	type()	Which in-process ONNX model variant should be used.

Method Details

builder

static InProcessEmbeddingModelConfig.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static InProcessEmbeddingModelConfig.Builder builder(InProcessEmbeddingModelConfig 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 InProcessEmbeddingModelConfig 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 InProcessEmbeddingModelConfig 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

enabled

boolean enabled()

Whether the embedding model is enabled. If set to false, the model will not be available even if configured.

Returns:

whether the embedding model is enabled, defaults to true

executor

Optional<ThreadPoolConfig> executor()

Executor configuration used by the embedding model.

Returns:

optional executor configuration

type

InProcessModelType type()

Which in-process ONNX model variant should be used.

Returns:

in-process ONNX model provided type

pathToModel

Optional<Path> pathToModel()

The path to the modelPath file (e.g., "/path/to/model.onnx").

Returns:

an Optional containing the configured model path, or an empty Optional if not set

pathToTokenizer

Optional<Path> pathToTokenizer()

The path to the tokenizer file (e.g., "/path/to/tokenizer.json").

Returns:

an Optional containing the configured tokenizer path, or an empty Optional if not set

poolingMode

Optional<dev.langchain4j.model.embedding.onnx.PoolingMode> poolingMode()

The pooling model to use. Can be found in the ".../1_Pooling/config.json" file on HuggingFace. Here is an example. "pooling_mode_mean_tokens": true means that PoolingMode.MEAN should be used.

Returns:

an Optional containing the configured PoolingMode, or an empty Optional if no pooling mode is explicitly configured