Package com.hw.langchain.chat.models.openai

Class ChatOpenAI

java.lang.Object

com.hw.langchain.chat.models.base.BaseChatModel

com.hw.langchain.chat.models.openai.ChatOpenAI

All Implemented Interfaces:

BaseLanguageModel

public class ChatOpenAI
extends BaseChatModel

Wrapper around OpenAI Chat large language models.

Author:

HamaWhite

Field Summary

Fields

Modifier and Type	Field	Description
protected OpenAiClient	client
protected int	maxRetries	Maximum number of retries to make when generating.
protected Integer	maxTokens	Maximum number of tokens to generate.
protected String	model	Model name to use.
protected Map<String,Object>	modelKwargs	Holds any model parameters valid for `create` call not explicitly specified.
protected int	n	Number of chat completions to generate for each prompt.
protected String	openaiApiBase
protected String	openaiApiKey	Base URL path for API requests, leave blank if not using a proxy or service emulator.
protected OpenaiApiType	openaiApiType
protected String	openaiApiVersion
protected String	openaiOrganization
protected String	openaiProxy	To support explicit proxy for OpenAI.
protected long	requestTimeout	Timeout for requests to OpenAI completion API.
protected boolean	stream	Whether to stream the results or not.
protected float	temperature	What sampling temperature to use.

Constructor Summary

Constructors

Constructor	Description
ChatOpenAI()

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	combineLlmOutputs(List<Map<String,Object>> llmOutputs)
List<ChatMessage>	convertMessages(List<BaseMessage> messages)
ChatResult	createChatResult(ChatCompletionResp response)
ChatOpenAI	init()	Validate parameters and init client
ChatResult	innerGenerate(List<BaseMessage> messages, List<String> stop)	Top Level call
String	llmType()	Return type of chat model.

Methods inherited from class com.hw.langchain.chat.models.base.BaseChatModel

call, call, generate, generate, generatePrompt, predict, predictMessages

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.hw.langchain.base.language.BaseLanguageModel

asyncGeneratePrompt, asyncGeneratePrompt, asyncPredict, asyncPredict, asyncPredictMessages, predict, predictMessages

Field Details

client

protected OpenAiClient client

model

protected String model

Model name to use.

temperature

protected float temperature

What sampling temperature to use.

modelKwargs

protected Map<String,Object> modelKwargs

Holds any model parameters valid for `create` call not explicitly specified.

openaiApiKey

protected String openaiApiKey

Base URL path for API requests, leave blank if not using a proxy or service emulator.

openaiApiBase

protected String openaiApiBase

openaiApiType

protected OpenaiApiType openaiApiType

openaiApiVersion

protected String openaiApiVersion

openaiOrganization

protected String openaiOrganization

openaiProxy

protected String openaiProxy

To support explicit proxy for OpenAI.

requestTimeout

protected long requestTimeout

Timeout for requests to OpenAI completion API. Default is 16 seconds.

maxRetries

protected int maxRetries

Maximum number of retries to make when generating.

stream

protected boolean stream

Whether to stream the results or not.

n

protected int n

Number of chat completions to generate for each prompt.

maxTokens

protected Integer maxTokens

Maximum number of tokens to generate.

Constructor Details

ChatOpenAI

public ChatOpenAI()

Method Details

init

public ChatOpenAI init()

Validate parameters and init client

combineLlmOutputs

public Map<String,Object> combineLlmOutputs(List<Map<String,Object>> llmOutputs)

Overrides:

combineLlmOutputs in class BaseChatModel

innerGenerate

public ChatResult innerGenerate(List<BaseMessage> messages,
 List<String> stop)

Description copied from class: BaseChatModel

Top Level call

Specified by:

innerGenerate in class BaseChatModel

convertMessages

public List<ChatMessage> convertMessages(List<BaseMessage> messages)

createChatResult

public ChatResult createChatResult(ChatCompletionResp response)

llmType

public String llmType()

Description copied from class: BaseChatModel

Return type of chat model.

Specified by:

llmType in class BaseChatModel