Package dev.langchain4j.model.openai

Class OpenAiChatModel

java.lang.Object

dev.langchain4j.model.openai.OpenAiChatModel

All Implemented Interfaces:

ChatLanguageModel, TokenCountEstimator

public class OpenAiChatModel
extends Object
implements ChatLanguageModel, 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(String baseUrl, String apiKey, String organizationId, String modelName, Double temperature, Double topP, List<String> stop, Integer maxTokens, Double presencePenalty, Double frequencyPenalty, Map<String,Integer> logitBias, String responseFormat, Integer seed, String user, Duration timeout, Integer maxRetries, Proxy proxy, Boolean logRequests, Boolean logResponses, Tokenizer tokenizer)

Method Summary

Modifier and Type	Method	Description
static OpenAiChatModel.OpenAiChatModelBuilder	builder()
int	estimateTokenCount(List<ChatMessage> messages)
Response<AiMessage>	generate(List<ChatMessage> messages)
Response<AiMessage>	generate(List<ChatMessage> messages, ToolSpecification toolSpecification)
Response<AiMessage>	generate(List<ChatMessage> messages, List<ToolSpecification> toolSpecifications)
static OpenAiChatModel	withApiKey(String apiKey)

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

generate, generate

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

estimateTokenCount, estimateTokenCount, estimateTokenCount, estimateTokenCount

Constructor Details

OpenAiChatModel

public OpenAiChatModel(String baseUrl,
 String apiKey,
 String organizationId,
 String modelName,
 Double temperature,
 Double topP,
 List<String> stop,
 Integer maxTokens,
 Double presencePenalty,
 Double frequencyPenalty,
 Map<String,Integer> logitBias,
 String responseFormat,
 Integer seed,
 String user,
 Duration timeout,
 Integer maxRetries,
 Proxy proxy,
 Boolean logRequests,
 Boolean logResponses,
 Tokenizer tokenizer)

Method Details

generate

public Response<AiMessage> generate(List<ChatMessage> messages)

Specified by:

generate in interface ChatLanguageModel

generate

public Response<AiMessage> generate(List<ChatMessage> messages,
 List<ToolSpecification> toolSpecifications)

Specified by:

generate in interface ChatLanguageModel

generate

public Response<AiMessage> generate(List<ChatMessage> messages,
 ToolSpecification toolSpecification)

Specified by:

generate in interface ChatLanguageModel

estimateTokenCount

public int estimateTokenCount(List<ChatMessage> messages)

Specified by:

estimateTokenCount in interface TokenCountEstimator

withApiKey

public static OpenAiChatModel withApiKey(String apiKey)

builder

public static OpenAiChatModel.OpenAiChatModelBuilder builder()