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

Class AzureOpenAiChatChain

java.lang.Object

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

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

com.github.hakenadu.javalangchains.chains.llm.azure.AzureOpenAiChatChain

All Implemented Interfaces:

Chain<Map<String,String>,String>

public final class AzureOpenAiChatChain
extends OpenAiChatChain

OpenAiChatChain adopted for usage of Azure OpenAI Services

Field Summary

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

LOGGER

Constructor Summary

Constructors

Constructor	Description
AzureOpenAiChatChain(String resourceName, String deploymentName, String apiVersion, String promptTemplate, OpenAiChatParameters parameters, String apiKey)
AzureOpenAiChatChain(String resourceName, String deploymentName, String apiVersion, String promptTemplate, OpenAiChatParameters parameters, String apiKey, String systemTemplate)
AzureOpenAiChatChain(String resourceName, String deploymentName, String apiVersion, 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
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.

Methods inherited from class com.github.hakenadu.javalangchains.chains.llm.openai.OpenAiChatChain

createDefaultObjectMapper, createDefaultWebClient, getApiKey, requestToBody, run

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

AzureOpenAiChatChain

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

Parameters:

resourceName - resourceName

deploymentName - deploymentName

apiVersion - apiVersion

promptTemplate - The template which contains placeholders in the form ${myPlaceholder} that are replaced for input documents before creating a request to a LLM.

parameters - The OpenAiChatParameters allows to finetune requests to the OpenAI API

apiKey - The API-Key used for Authentication (passed using the "api-key" Header)

systemTemplate - The template for the system role which contains placeholders in the form ${myPlaceholder} that are replaced for input documents before creating a request to a LLM.

objectMapper - The ObjectMapper used for body serialization and deserialization

webClient - The WebClient used for executing requests to the OpenAI API

AzureOpenAiChatChain

public AzureOpenAiChatChain(String resourceName, String deploymentName, String apiVersion, String promptTemplate, OpenAiChatParameters parameters, String apiKey, String systemTemplate)

Parameters:

resourceName - resourceName

deploymentName - deploymentName

apiVersion - apiVersion

promptTemplate - The template which contains placeholders in the form ${myPlaceholder} that are replaced for input documents before creating a request to a LLM.

parameters - The OpenAiChatParameters allows to finetune requests to the OpenAI API

apiKey - The API-Key used for Authentication (passed using the "api-key" Header)

systemTemplate - The template for the system role which contains placeholders in the form ${myPlaceholder} that are replaced for input documents before creating a request

AzureOpenAiChatChain

public AzureOpenAiChatChain(String resourceName, String deploymentName, String apiVersion, String promptTemplate, OpenAiChatParameters parameters, String apiKey)

Parameters:

resourceName - resourceName

deploymentName - deploymentName

apiVersion - apiVersion

promptTemplate - The template which contains placeholders in the form ${myPlaceholder} that are replaced for input documents before creating a request to a LLM.

parameters - The OpenAiChatParameters allows to finetune requests to the OpenAI API

apiKey - The API-Key used for Authentication (passed using the "api-key" Header)

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)

Description copied from class: OpenAiChatChain

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

Overrides:

createResponseSpec in class OpenAiChatChain

Parameters:

request - the OpenAiChatCompletionsRequest

webClient - the WebClient to use for the request

objectMapper - the ObjectMapper used for body serialization

Returns:

the WebClient.ResponseSpec