Package dev.langchain4j.model.openai

Class OpenAiChatModel

java.lang.Object

dev.langchain4j.model.openai.OpenAiChatModel

All Implemented Interfaces:

dev.langchain4j.model.chat.ChatLanguageModel, dev.langchain4j.model.chat.TokenCountEstimator

public class OpenAiChatModel
extends Object
implements dev.langchain4j.model.chat.ChatLanguageModel, dev.langchain4j.model.chat.TokenCountEstimator

Represents an OpenAI language model with a chat completion interface, such as gpt-3.5-turbo and gpt-4. You can find description of parameters here.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OpenAiChatModel.OpenAiChatModelBuilder

Constructor Summary

Constructors

Constructor	Description
OpenAiChatModel(OpenAiChatModel.OpenAiChatModelBuilder builder)

Method Summary

Modifier and Type	Method	Description
static OpenAiChatModel.OpenAiChatModelBuilder	builder()
OpenAiChatRequestParameters	defaultRequestParameters()
dev.langchain4j.model.chat.response.ChatResponse	doChat(dev.langchain4j.model.chat.request.ChatRequest chatRequest)
int	estimateTokenCount(List<dev.langchain4j.data.message.ChatMessage> messages)
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
dev.langchain4j.model.ModelProvider	provider()
Set<dev.langchain4j.model.chat.Capability>	supportedCapabilities()
static OpenAiChatModel	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.ChatLanguageModel

chat, chat, chat, chat

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

estimateTokenCount, estimateTokenCount, estimateTokenCount, estimateTokenCount

Constructor Details

OpenAiChatModel

public OpenAiChatModel(OpenAiChatModel.OpenAiChatModelBuilder 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 dev.langchain4j.model.chat.ChatLanguageModel

supportedCapabilities

public Set<dev.langchain4j.model.chat.Capability> supportedCapabilities()

Specified by:

supportedCapabilities in interface dev.langchain4j.model.chat.ChatLanguageModel

doChat

public dev.langchain4j.model.chat.response.ChatResponse doChat(dev.langchain4j.model.chat.request.ChatRequest chatRequest)

Specified by:

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

listeners

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

Specified by:

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

provider

public dev.langchain4j.model.ModelProvider provider()

Specified by:

provider in interface dev.langchain4j.model.chat.ChatLanguageModel

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 OpenAiChatModel 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 OpenAiChatModel.OpenAiChatModelBuilder builder()