Class OpenAiOfficialStreamingChatModel

java.lang.Object

dev.langchain4j.model.openaiofficial.OpenAiOfficialStreamingChatModel

All Implemented Interfaces:

StreamingChatModel

public class OpenAiOfficialStreamingChatModel
extends Object
implements StreamingChatModel

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OpenAiOfficialStreamingChatModel.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 String	modelName
protected ModelProvider	modelProvider
protected String	responseFormat
protected Boolean	strictJsonSchema
protected Boolean	strictTools
protected Set<Capability>	supportedCapabilities
protected TokenCountEstimator	tokenCountEstimator

Constructor Summary

Constructors

Constructor	Description
OpenAiOfficialStreamingChatModel(OpenAiOfficialStreamingChatModel.Builder builder)

Method Summary

Modifier and Type	Method	Description
static OpenAiOfficialStreamingChatModel.Builder	builder()
OpenAiOfficialChatRequestParameters	defaultRequestParameters()
void	doChat(ChatRequest chatRequest, StreamingChatResponseHandler handler)
void	init(String baseUrl, String apiKey, com.openai.credential.Credential credential, String azureDeploymentName, com.openai.azure.AzureOpenAIServiceVersion azureOpenAIServiceVersion, String organizationId, boolean isAzure, boolean isGitHubModels, 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 StreamingChatModel

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

Field Details

client

protected com.openai.client.OpenAIClient client

asyncClient

protected com.openai.client.OpenAIClientAsync asyncClient

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

modelProvider

protected ModelProvider modelProvider

Constructor Details

OpenAiOfficialStreamingChatModel

public OpenAiOfficialStreamingChatModel(OpenAiOfficialStreamingChatModel.Builder builder)

Method Details

doChat

public void doChat(ChatRequest chatRequest,
 StreamingChatResponseHandler handler)

Specified by:

doChat in interface StreamingChatModel

builder

public static OpenAiOfficialStreamingChatModel.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,
 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()