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

Class AzureOpenAiChatCompletionsChain

java.lang.Object

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

com.github.hakenadu.javalangchains.chains.llm.openai.OpenAiChain<OpenAiChatCompletionsParameters,OpenAiChatCompletionsRequest,OpenAiChatCompletionsResponse>

com.github.hakenadu.javalangchains.chains.llm.openai.chat.OpenAiChatCompletionsChain

com.github.hakenadu.javalangchains.chains.llm.azure.chat.AzureOpenAiChatCompletionsChain

All Implemented Interfaces:

Chain<Map<String,String>,String>

public final class AzureOpenAiChatCompletionsChain
extends OpenAiChatCompletionsChain

OpenAiChatCompletionsChain 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
AzureOpenAiChatCompletionsChain(String resourceName, String deploymentName, String apiVersion, String promptTemplate, OpenAiChatCompletionsParameters parameters, String apiKey)
AzureOpenAiChatCompletionsChain(String resourceName, String deploymentName, String apiVersion, String promptTemplate, OpenAiChatCompletionsParameters parameters, String apiKey, String systemTemplate)
AzureOpenAiChatCompletionsChain(String resourceName, String deploymentName, String apiVersion, String promptTemplate, OpenAiChatCompletionsParameters 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.chat.OpenAiChatCompletionsChain

createOutput, createRequest

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

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

AzureOpenAiChatCompletionsChain

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

Parameters:

resourceName - Name of the azure resource

deploymentName - Name of the azure openai service deployment

apiVersion - The target API Version

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 OpenAiChatCompletionsParameters 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

AzureOpenAiChatCompletionsChain

public AzureOpenAiChatCompletionsChain(String resourceName, String deploymentName, String apiVersion, String promptTemplate, OpenAiChatCompletionsParameters parameters, String apiKey, String systemTemplate)

Parameters:

resourceName - Name of the azure resource

deploymentName - Name of the azure openai service deployment

apiVersion - The target API Version

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 OpenAiChatCompletionsParameters 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

AzureOpenAiChatCompletionsChain

public AzureOpenAiChatCompletionsChain(String resourceName, String deploymentName, String apiVersion, String promptTemplate, OpenAiChatCompletionsParameters parameters, String apiKey)

Parameters:

resourceName - Name of the azure resource

deploymentName - Name of the azure openai service deployment

apiVersion - The target API Version

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 OpenAiChatCompletionsParameters 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: OpenAiChain

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

Overrides:

createResponseSpec in class OpenAiChain<OpenAiChatCompletionsParameters,OpenAiChatCompletionsRequest,OpenAiChatCompletionsResponse>

Parameters:

request - the request entity

webClient - the WebClient to use for the request

objectMapper - the ObjectMapper used for body serialization

Returns:

the WebClient.ResponseSpec