Package dev.langchain4j.model.openai

Class OpenAiStreamingChatModel

java.lang.Object

dev.langchain4j.model.openai.OpenAiStreamingChatModel

All Implemented Interfaces:

dev.langchain4j.model.chat.StreamingChatLanguageModel, dev.langchain4j.model.chat.TokenCountEstimator

public class OpenAiStreamingChatModel
extends Object
implements dev.langchain4j.model.chat.StreamingChatLanguageModel, dev.langchain4j.model.chat.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(String baseUrl, String apiKey, String organizationId, dev.langchain4j.model.chat.request.ChatRequestParameters defaultRequestParameters, String modelName, Double temperature, Double topP, List<String> stop, Integer maxTokens, Integer maxCompletionTokens, Double presencePenalty, Double frequencyPenalty, Map<String,Integer> logitBias, String responseFormat, Boolean strictJsonSchema, Integer seed, String user, Boolean strictTools, Boolean parallelToolCalls, Boolean store, Map<String,String> metadata, String serviceTier, Duration timeout, Proxy proxy, Boolean logRequests, Boolean logResponses, dev.langchain4j.model.Tokenizer tokenizer, Map<String,String> customHeaders, List<dev.langchain4j.model.chat.listener.ChatModelListener> listeners)

Method Summary

Modifier and Type	Method	Description
static OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder	builder()
OpenAiChatRequestParameters	defaultRequestParameters()
void	doChat(dev.langchain4j.model.chat.request.ChatRequest chatRequest, dev.langchain4j.model.chat.response.StreamingChatResponseHandler handler)
int	estimateTokenCount(List<dev.langchain4j.data.message.ChatMessage> messages)
void	generate(List<dev.langchain4j.data.message.ChatMessage> messages, dev.langchain4j.agent.tool.ToolSpecification toolSpecification, dev.langchain4j.model.StreamingResponseHandler<dev.langchain4j.data.message.AiMessage> handler)
void	generate(List<dev.langchain4j.data.message.ChatMessage> messages, dev.langchain4j.model.StreamingResponseHandler<dev.langchain4j.data.message.AiMessage> handler)
void	generate(List<dev.langchain4j.data.message.ChatMessage> messages, List<dev.langchain4j.agent.tool.ToolSpecification> toolSpecifications, dev.langchain4j.model.StreamingResponseHandler<dev.langchain4j.data.message.AiMessage> handler)
List<dev.langchain4j.model.chat.listener.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
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, generate, generate, supportedCapabilities

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

estimateTokenCount, estimateTokenCount, estimateTokenCount, estimateTokenCount

Constructor Details

OpenAiStreamingChatModel

public OpenAiStreamingChatModel(String baseUrl,
 String apiKey,
 String organizationId,
 dev.langchain4j.model.chat.request.ChatRequestParameters defaultRequestParameters,
 String modelName,
 Double temperature,
 Double topP,
 List<String> stop,
 Integer maxTokens,
 Integer maxCompletionTokens,
 Double presencePenalty,
 Double frequencyPenalty,
 Map<String,Integer> logitBias,
 String responseFormat,
 Boolean strictJsonSchema,
 Integer seed,
 String user,
 Boolean strictTools,
 Boolean parallelToolCalls,
 Boolean store,
 Map<String,String> metadata,
 String serviceTier,
 Duration timeout,
 Proxy proxy,
 Boolean logRequests,
 Boolean logResponses,
 dev.langchain4j.model.Tokenizer tokenizer,
 Map<String,String> customHeaders,
 List<dev.langchain4j.model.chat.listener.ChatModelListener> listeners)

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 dev.langchain4j.model.chat.StreamingChatLanguageModel

generate

public void generate(List<dev.langchain4j.data.message.ChatMessage> messages,
 dev.langchain4j.model.StreamingResponseHandler<dev.langchain4j.data.message.AiMessage> handler)

Specified by:

generate in interface dev.langchain4j.model.chat.StreamingChatLanguageModel

generate

public void generate(List<dev.langchain4j.data.message.ChatMessage> messages,
 List<dev.langchain4j.agent.tool.ToolSpecification> toolSpecifications,
 dev.langchain4j.model.StreamingResponseHandler<dev.langchain4j.data.message.AiMessage> handler)

Specified by:

generate in interface dev.langchain4j.model.chat.StreamingChatLanguageModel

generate

public void generate(List<dev.langchain4j.data.message.ChatMessage> messages,
 dev.langchain4j.agent.tool.ToolSpecification toolSpecification,
 dev.langchain4j.model.StreamingResponseHandler<dev.langchain4j.data.message.AiMessage> handler)

Specified by:

generate in interface dev.langchain4j.model.chat.StreamingChatLanguageModel

doChat

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

Specified by:

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

listeners

public List<dev.langchain4j.model.chat.listener.ChatModelListener> listeners()

Specified by:

listeners in interface dev.langchain4j.model.chat.StreamingChatLanguageModel

estimateTokenCount

public int estimateTokenCount(List<dev.langchain4j.data.message.ChatMessage> messages)

Specified by:

estimateTokenCount in interface dev.langchain4j.model.chat.TokenCountEstimator

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()