Package com.github.hakenadu.javalangchains.chains.llm.openai

Class OpenAiChatChain

java.lang.Object

com.github.hakenadu.javalangchains.chains.llm.LargeLanguageModelChain

com.github.hakenadu.javalangchains.chains.llm.openai.OpenAiChatChain

All Implemented Interfaces:

Chain<Map<String,String>,String>

Direct Known Subclasses:

AzureOpenAiChatChain

public class OpenAiChatChain
extends LargeLanguageModelChain

LargeLanguageModelChain for usage with the OpenAI API

Field Summary

Fields inherited from interface com.github.hakenadu.javalangchains.chains.Chain

LOGGER

Constructor Summary

Constructors

Constructor	Description
OpenAiChatChain(String promptTemplate, OpenAiChatParameters parameters, String apiKey)
OpenAiChatChain(String promptTemplate, OpenAiChatParameters parameters, String apiKey, String systemTemplate)
OpenAiChatChain(String promptTemplate, OpenAiChatParameters parameters, String apiKey, String systemTemplate, com.fasterxml.jackson.databind.ObjectMapper objectMapper, org.springframework.web.reactive.function.client.WebClient webClient)

Method Summary

Modifier and Type	Method	Description
static com.fasterxml.jackson.databind.ObjectMapper	createDefaultObjectMapper()
static org.springframework.web.reactive.function.client.WebClient	createDefaultWebClient()
protected org.springframework.web.reactive.function.client.WebClient.ResponseSpec	createResponseSpec(OpenAiChatCompletionsRequest request, org.springframework.web.reactive.function.client.WebClient webClient, com.fasterxml.jackson.databind.ObjectMapper objectMapper)	executes the request to the OpenAI API.
protected String	getApiKey()
protected String	requestToBody(OpenAiChatCompletionsRequest request, com.fasterxml.jackson.databind.ObjectMapper objectMapper)	Serializes the OpenAiChatCompletionsRequest
String	run(Map<String,String> input)	Execute this Chain

Methods inherited from class com.github.hakenadu.javalangchains.chains.llm.LargeLanguageModelChain

getPromptTemplate

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.hakenadu.javalangchains.chains.Chain

chain

Constructor Details

OpenAiChatChain

public OpenAiChatChain(String promptTemplate, OpenAiChatParameters parameters, String apiKey, String systemTemplate, com.fasterxml.jackson.databind.ObjectMapper objectMapper, org.springframework.web.reactive.function.client.WebClient webClient)

Parameters:

promptTemplate - LargeLanguageModelChain.getPromptTemplate()

parameters - parametersr

apiKey - apiKey

systemTemplate - systemTemplate

objectMapper - objectMapper

webClient - webClient

OpenAiChatChain

public OpenAiChatChain(String promptTemplate, OpenAiChatParameters parameters, String apiKey, String systemTemplate)

Parameters:

promptTemplate - LargeLanguageModelChain.getPromptTemplate()

parameters - parameters

apiKey - apiKey

systemTemplate - systemTemplates

OpenAiChatChain

public OpenAiChatChain(String promptTemplate, OpenAiChatParameters parameters, String apiKey)

Parameters:

promptTemplate - LargeLanguageModelChain.getPromptTemplate()

parameters - parameters

apiKey - apiKey

Method Details

createResponseSpec

protected org.springframework.web.reactive.function.client.WebClient.ResponseSpec createResponseSpec(OpenAiChatCompletionsRequest request, org.springframework.web.reactive.function.client.WebClient webClient, com.fasterxml.jackson.databind.ObjectMapper objectMapper)

executes the request to the OpenAI API. Protected so that it may be overridden for other OpenAI API Providers.

Parameters:

request - the OpenAiChatCompletionsRequest

webClient - the WebClient to use for the request

objectMapper - the ObjectMapper used for body serialization

Returns:

the WebClient.ResponseSpec

run

public String run(Map<String,String> input)

Description copied from interface: Chain

Execute this Chain

Parameters:

input - this chain's input

Returns:

this chain's output

requestToBody

protected String requestToBody(OpenAiChatCompletionsRequest request, com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Serializes the OpenAiChatCompletionsRequest

Parameters:

request - OpenAiChatCompletionsRequest to serialize

objectMapper - ObjectMapper used for serialization

Returns:

serialized OpenAiChatCompletionsRequest

getApiKey

protected final String getApiKey()

Returns:

apiKeyp

createDefaultObjectMapper

public static com.fasterxml.jackson.databind.ObjectMapper createDefaultObjectMapper()

Returns:

a default configured ObjectMapper

createDefaultWebClient

public static org.springframework.web.reactive.function.client.WebClient createDefaultWebClient()

Returns:

a default configured WebClient