Class OpenAiOfficialChatModel

java.lang.Object

dev.langchain4j.model.openaiofficial.OpenAiOfficialChatModel

All Implemented Interfaces:

ChatModel

public class OpenAiOfficialChatModel
extends Object
implements ChatModel

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OpenAiOfficialChatModel.Builder

Field Summary

Fields

Modifier and Type	Field	Description
protected com.openai.client.OpenAIClientAsync	asyncClient
protected com.openai.client.OpenAIClient	client
protected OpenAiOfficialChatRequestParameters	defaultRequestParameters
protected List<ChatModelListener>	listeners
protected dev.langchain4j.model.openaiofficial.InternalOpenAiOfficialHelper.ModelHost	modelHost
protected String	modelName
protected String	responseFormat
protected Boolean	strictJsonSchema
protected Boolean	strictTools
protected Set<Capability>	supportedCapabilities
protected TokenCountEstimator	tokenCountEstimator

Constructor Summary

Constructors

Constructor	Description
OpenAiOfficialChatModel(OpenAiOfficialChatModel.Builder builder)

Method Summary

Modifier and Type	Method	Description
static OpenAiOfficialChatModel.Builder	builder()
OpenAiOfficialChatRequestParameters	defaultRequestParameters()
ChatResponse	doChat(ChatRequest chatRequest)
void	init(String baseUrl, String apiKey, com.openai.credential.Credential credential, String azureDeploymentName, com.openai.azure.AzureOpenAIServiceVersion azureOpenAIServiceVersion, String organizationId, boolean isAzure, boolean isGitHubModels, com.openai.client.OpenAIClient openAIClient, com.openai.client.OpenAIClientAsync openAIClientAsync, ChatRequestParameters defaultRequestParameters, String modelName, Double temperature, Double topP, List<String> stop, 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, Integer maxRetries, Proxy proxy, TokenCountEstimator tokenCountEstimator, Map<String,String> customHeaders, List<ChatModelListener> listeners, Set<Capability> capabilities, boolean isAsync)
List<ChatModelListener>	listeners()
ModelProvider	provider()
Set<Capability>	supportedCapabilities()

Methods inherited from class Object

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

Methods inherited from interface ChatModel

chat, chat, chat, chat, defaultRequestParameters, listeners, provider, supportedCapabilities

Field Details

client

protected com.openai.client.OpenAIClient client

asyncClient

protected com.openai.client.OpenAIClientAsync asyncClient

modelHost

protected dev.langchain4j.model.openaiofficial.InternalOpenAiOfficialHelper.ModelHost modelHost

modelName

protected String modelName

defaultRequestParameters

protected OpenAiOfficialChatRequestParameters defaultRequestParameters

responseFormat

protected String responseFormat

strictJsonSchema

protected Boolean strictJsonSchema

strictTools

protected Boolean strictTools

tokenCountEstimator

protected TokenCountEstimator tokenCountEstimator

listeners

protected List<ChatModelListener> listeners

supportedCapabilities

protected Set<Capability> supportedCapabilities

Constructor Details

OpenAiOfficialChatModel

public OpenAiOfficialChatModel(OpenAiOfficialChatModel.Builder builder)

Method Details

doChat

public ChatResponse doChat(ChatRequest chatRequest)

Specified by:

doChat in interface ChatModel

builder

public static OpenAiOfficialChatModel.Builder builder()

init

public void init(String baseUrl,
 String apiKey,
 com.openai.credential.Credential credential,
 String azureDeploymentName,
 com.openai.azure.AzureOpenAIServiceVersion azureOpenAIServiceVersion,
 String organizationId,
 boolean isAzure,
 boolean isGitHubModels,
 com.openai.client.OpenAIClient openAIClient,
 com.openai.client.OpenAIClientAsync openAIClientAsync,
 ChatRequestParameters defaultRequestParameters,
 String modelName,
 Double temperature,
 Double topP,
 List<String> stop,
 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,
 Integer maxRetries,
 Proxy proxy,
 TokenCountEstimator tokenCountEstimator,
 Map<String,String> customHeaders,
 List<ChatModelListener> listeners,
 Set<Capability> capabilities,
 boolean isAsync)

defaultRequestParameters

public OpenAiOfficialChatRequestParameters defaultRequestParameters()

supportedCapabilities

public Set<Capability> supportedCapabilities()

listeners

public List<ChatModelListener> listeners()

provider

public ModelProvider provider()