Package dev.langchain4j.model.openai

Class OpenAiLanguageModel

java.lang.Object

dev.langchain4j.model.openai.OpenAiLanguageModel

All Implemented Interfaces:

LanguageModel, TokenCountEstimator

public class OpenAiLanguageModel
extends Object
implements LanguageModel, TokenCountEstimator

Represents an OpenAI language model with a completion interface, such as gpt-3.5-turbo-instruct. However, it's recommended to use OpenAiChatModel instead, as it offers more advanced features like function calling, multi-turn conversations, etc.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OpenAiLanguageModel.OpenAiLanguageModelBuilder	Builder class for constructing instances of OpenAiLanguageModel.

Constructor Summary

Constructors

Constructor	Description
OpenAiLanguageModel(String baseUrl, String apiKey, String organizationId, String modelName, Double temperature, Duration timeout, Integer maxRetries, Proxy proxy, Boolean logRequests, Boolean logResponses, Tokenizer tokenizer, Map<String,String> customHeaders)

Method Summary

Modifier and Type	Method	Description
static OpenAiLanguageModel.OpenAiLanguageModelBuilder	builder()
int	estimateTokenCount(String prompt)	Estimates the count of tokens in the given text.
Response<String>	generate(String prompt)	Generate a response to the given prompt.
String	modelName()
static OpenAiLanguageModel	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.language.LanguageModel

generate

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

estimateTokenCount, estimateTokenCount

Constructor Details

OpenAiLanguageModel

public OpenAiLanguageModel(String baseUrl,
 String apiKey,
 String organizationId,
 String modelName,
 Double temperature,
 Duration timeout,
 Integer maxRetries,
 Proxy proxy,
 Boolean logRequests,
 Boolean logResponses,
 Tokenizer tokenizer,
 Map<String,String> customHeaders)

Method Details

modelName

public String modelName()

generate

public Response<String> generate(String prompt)

Description copied from interface: LanguageModel

Generate a response to the given prompt.

Specified by:

generate in interface LanguageModel

Parameters:

prompt - the prompt.

Returns:

the response.

estimateTokenCount

public int estimateTokenCount(String prompt)

Description copied from interface: TokenCountEstimator

Estimates the count of tokens in the given text.

Specified by:

estimateTokenCount in interface TokenCountEstimator

Parameters:

prompt - the text.

Returns:

the estimated count of tokens.

withApiKey

@Deprecated(forRemoval=true)
public static OpenAiLanguageModel 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 OpenAiLanguageModel.OpenAiLanguageModelBuilder builder()