Package dev.langchain4j.model.openai

Class OpenAiStreamingChatModel

java.lang.Object

dev.langchain4j.model.openai.OpenAiStreamingChatModel

All Implemented Interfaces:

StreamingChatLanguageModel, TokenCountEstimator

public class OpenAiStreamingChatModel
extends Object
implements StreamingChatLanguageModel, TokenCountEstimator

Represents an OpenAI language model with a chat completion interface, such as gpt-3.5-turbo and gpt-4. The model's response is streamed token by token and should be handled with StreamingResponseHandler. You can find description of parameters here.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder

Constructor Summary

Constructors

Constructor	Description
OpenAiStreamingChatModel(OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder builder)

Method Summary

Modifier and Type	Method	Description
static OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder	builder()
OpenAiChatRequestParameters	defaultRequestParameters()
void	doChat(ChatRequest chatRequest, StreamingChatResponseHandler handler)
int	estimateTokenCount(List<ChatMessage> messages)	Estimates the count of tokens in the specified list of messages.
List<ChatModelListener>	listeners()
String	modelName()	Deprecated, for removal: This API element is subject to removal in a future version. please use defaultRequestParameters() and then ChatRequestParameters.modelName() instead
ModelProvider	provider()
static OpenAiStreamingChatModel	withApiKey(String apiKey)	Deprecated, for removal: This API element is subject to removal in a future version. Please use builder() instead, and explicitly set the model name and, if necessary, other parameters.

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.StreamingChatLanguageModel

chat, chat, chat, supportedCapabilities

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

estimateTokenCount, estimateTokenCount, estimateTokenCount, estimateTokenCount

Constructor Details

OpenAiStreamingChatModel

public OpenAiStreamingChatModel(OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder builder)

Method Details

modelName

@Deprecated(forRemoval=true)
public String modelName()

Deprecated, for removal: This API element is subject to removal in a future version.

please use defaultRequestParameters() and then ChatRequestParameters.modelName() instead

defaultRequestParameters

public OpenAiChatRequestParameters defaultRequestParameters()

Specified by:

defaultRequestParameters in interface StreamingChatLanguageModel

doChat

public void doChat(ChatRequest chatRequest,
 StreamingChatResponseHandler handler)

Specified by:

doChat in interface StreamingChatLanguageModel

listeners

public List<ChatModelListener> listeners()

Specified by:

listeners in interface StreamingChatLanguageModel

provider

public ModelProvider provider()

Specified by:

provider in interface StreamingChatLanguageModel

estimateTokenCount

public int estimateTokenCount(List<ChatMessage> messages)

Description copied from interface: TokenCountEstimator

Estimates the count of tokens in the specified list of messages.

Specified by:

estimateTokenCount in interface TokenCountEstimator

Parameters:

messages - the list of messages

Returns:

the estimated count of tokens

withApiKey

@Deprecated(forRemoval=true)
public static OpenAiStreamingChatModel withApiKey(String apiKey)

Deprecated, for removal: This API element is subject to removal in a future version.

Please use builder() instead, and explicitly set the model name and, if necessary, other parameters. The default values for the model name and temperature will be removed in future releases!

builder

public static OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder builder()