Module io.helidon.integrations.langchain4j.providers.mock

Package io.helidon.integrations.langchain4j.providers.mock

Class MockStreamingChatModel

java.lang.Object

io.helidon.integrations.langchain4j.providers.mock.MockStreamingChatModel

All Implemented Interfaces:

dev.langchain4j.model.chat.StreamingChatModel, RuntimeType.Api<MockStreamingChatModelConfig>

public class MockStreamingChatModel
extends Object
implements RuntimeType.Api<MockStreamingChatModelConfig>, dev.langchain4j.model.chat.StreamingChatModel

A mock implementation of a streaming chat model for testing and development.

This model evaluates incoming chat requests against a set of MockChatRules and streams the corresponding mock responses. If no rule matches, a default mock response is used.

Rules are initialized from the provided MockStreamingChatModelConfig and can be inspected and modified at runtime using activeRules() and resetRules().

Method Summary

Modifier and Type	Method	Description
List<MockChatRule>	activeRules()	Returns the list of MockChatRules currently used by this model.
static MockStreamingChatModelConfig.Builder	builder()	Returns a new MockStreamingChatModelConfig.Builder instance for building a configuration.
static MockStreamingChatModel	create(MockStreamingChatModelConfig config)	Creates a new MockStreamingChatModel instance using the provided configuration.
static MockStreamingChatModel	create(Consumer<MockStreamingChatModelConfig.Builder> consumer)	Creates a new MockStreamingChatModel instance using a builder consumer to configure the model.
void	doChat(dev.langchain4j.model.chat.request.ChatRequest chatRequest, dev.langchain4j.model.chat.response.StreamingChatResponseHandler handler)	Processes a chat request and streams the mock response to the provided handler.
MockStreamingChatModelConfig	prototype()	Returns the configuration prototype of this mock chat model.
void	resetRules()	Resets the active mock chat rules to the original set defined by the initial configuration.

Methods inherited from class java.lang.Object

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

Methods inherited from interface dev.langchain4j.model.chat.StreamingChatModel

chat, chat, chat, defaultRequestParameters, listeners, provider, supportedCapabilities

Method Details

create

public static MockStreamingChatModel create(MockStreamingChatModelConfig config)

Creates a new MockStreamingChatModel instance using the provided configuration.

Parameters:

config - the mock chat model configuration

Returns:

a new MockStreamingChatModel

create

public static MockStreamingChatModel create(Consumer<MockStreamingChatModelConfig.Builder> consumer)

Creates a new MockStreamingChatModel instance using a builder consumer to configure the model.

Parameters:

consumer - a consumer that modifies the MockStreamingChatModelConfig.Builder

Returns:

a new MockStreamingChatModel

builder

public static MockStreamingChatModelConfig.Builder builder()

Returns a new MockStreamingChatModelConfig.Builder instance for building a configuration.

Returns:

a builder for MockStreamingChatModelConfig

doChat

public void doChat(dev.langchain4j.model.chat.request.ChatRequest chatRequest,
 dev.langchain4j.model.chat.response.StreamingChatResponseHandler handler)

Processes a chat request and streams the mock response to the provided handler.

The request is evaluated against the configured MockChatRules in order; the first matching rule is used to produce and stream the response. If no rule matches, the default rule is applied.

Specified by:

doChat in interface dev.langchain4j.model.chat.StreamingChatModel

Parameters:

chatRequest - the incoming chat request to evaluate

handler - the response handler that receives streamed response chunks and completion events

activeRules

public List<MockChatRule> activeRules()

Returns the list of MockChatRules currently used by this model.

The returned list is the live internal list; modifications to it will affect the model's behavior. Use resetRules() to restore the original configuration.

Returns:

mutable list of mock chat rules

resetRules

public void resetRules()

Resets the active mock chat rules to the original set defined by the initial configuration.

This method clears any modifications made to the activeRules() list and restores the rules from the initial MockStreamingChatModelConfig.

prototype

public MockStreamingChatModelConfig prototype()

Returns the configuration prototype of this mock chat model.

Specified by:

prototype in interface RuntimeType.Api<MockStreamingChatModelConfig>

Returns:

the MockStreamingChatModelConfig used by this model