Class OpenAiUtils

java.lang.Object

dev.langchain4j.model.openai.internal.OpenAiUtils

public class OpenAiUtils
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_OPENAI_URL
static final String	DEFAULT_USER_AGENT

Constructor Summary

Constructors

Constructor	Description
OpenAiUtils()

Method Summary

Modifier and Type	Method	Description
static AiMessage	aiMessageFrom(ChatCompletionResponse response)
static AiMessage	aiMessageFrom(ChatCompletionResponse response, boolean returnThinking)
static Response<AiMessage>	convertResponse(ChatResponse chatResponse)
static FinishReason	finishReasonFrom(String openAiFinishReason)
static ResponseFormat	fromOpenAiResponseFormat(String responseFormat)
static List<Function>	toFunctions(Collection<ToolSpecification> toolSpecifications)	Deprecated. Functions are deprecated by OpenAI, use toTools(Collection, boolean) instead
static OpenAiTokenUsage	tokenUsageFrom(Usage openAiUsage)
static ChatCompletionRequest.Builder	toOpenAiChatRequest(ChatRequest chatRequest, OpenAiChatRequestParameters parameters, boolean sendThinking, String thinkingFieldName, Boolean strictTools, Boolean strictJsonSchema)
static ChatCompletionRequest.Builder	toOpenAiChatRequest(ChatRequest chatRequest, OpenAiChatRequestParameters parameters, Boolean strictTools, Boolean strictJsonSchema)
static Message	toOpenAiMessage(ChatMessage message)
static Message	toOpenAiMessage(ChatMessage message, boolean sendThinking, String thinkingFieldName)
static List<Message>	toOpenAiMessages(List<ChatMessage> messages)
static List<Message>	toOpenAiMessages(List<ChatMessage> messages, boolean sendThinking, String thinkingFieldName)
static ToolChoiceMode	toOpenAiToolChoice(ToolChoice toolChoice)
static List<Tool>	toTools(Collection<ToolSpecification> toolSpecifications, boolean strict)
static void	validate(ChatRequestParameters parameters)

Methods inherited from class Object

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

Field Details

DEFAULT_OPENAI_URL

public static final String DEFAULT_OPENAI_URL

See Also:

• Constant Field Values

DEFAULT_USER_AGENT

public static final String DEFAULT_USER_AGENT

See Also:

• Constant Field Values

Constructor Details

OpenAiUtils

public OpenAiUtils()

Method Details

toOpenAiMessages

public static List<Message> toOpenAiMessages(List<ChatMessage> messages)

toOpenAiMessages

public static List<Message> toOpenAiMessages(List<ChatMessage> messages,
 boolean sendThinking,
 String thinkingFieldName)

toOpenAiMessage

public static Message toOpenAiMessage(ChatMessage message)

toOpenAiMessage

public static Message toOpenAiMessage(ChatMessage message,
 boolean sendThinking,
 String thinkingFieldName)

toTools

public static List<Tool> toTools(Collection<ToolSpecification> toolSpecifications,
 boolean strict)

toFunctions

@Deprecated
public static List<Function> toFunctions(Collection<ToolSpecification> toolSpecifications)

Deprecated.

Functions are deprecated by OpenAI, use toTools(Collection, boolean) instead

aiMessageFrom

public static AiMessage aiMessageFrom(ChatCompletionResponse response)

aiMessageFrom

public static AiMessage aiMessageFrom(ChatCompletionResponse response,
 boolean returnThinking)

tokenUsageFrom

public static OpenAiTokenUsage tokenUsageFrom(Usage openAiUsage)

finishReasonFrom

public static FinishReason finishReasonFrom(String openAiFinishReason)

toOpenAiToolChoice

public static ToolChoiceMode toOpenAiToolChoice(ToolChoice toolChoice)

convertResponse

public static Response<AiMessage> convertResponse(ChatResponse chatResponse)

validate

public static void validate(ChatRequestParameters parameters)

fromOpenAiResponseFormat

public static ResponseFormat fromOpenAiResponseFormat(String responseFormat)

toOpenAiChatRequest

public static ChatCompletionRequest.Builder toOpenAiChatRequest(ChatRequest chatRequest,
 OpenAiChatRequestParameters parameters,
 Boolean strictTools,
 Boolean strictJsonSchema)

toOpenAiChatRequest

public static ChatCompletionRequest.Builder toOpenAiChatRequest(ChatRequest chatRequest,
 OpenAiChatRequestParameters parameters,
 boolean sendThinking,
 String thinkingFieldName,
 Boolean strictTools,
 Boolean strictJsonSchema)