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

Class AzureOpenAiCompletionsChain

java.lang.Object

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

com.github.hakenadu.javalangchains.chains.llm.openai.OpenAiChain<OpenAiCompletionsParameters,OpenAiCompletionsRequest,OpenAiCompletionsResponse>

com.github.hakenadu.javalangchains.chains.llm.openai.completions.OpenAiCompletionsChain

com.github.hakenadu.javalangchains.chains.llm.azure.completions.AzureOpenAiCompletionsChain

All Implemented Interfaces:

Chain<Map<String,String>,String>

public final class AzureOpenAiCompletionsChain
extends OpenAiCompletionsChain

OpenAiCompletionsChain 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
AzureOpenAiCompletionsChain(String resourceName, String deploymentName, String apiVersion, String promptTemplate, OpenAiCompletionsParameters parameters, String apiKey)
AzureOpenAiCompletionsChain(String resourceName, String deploymentName, String apiVersion, String promptTemplate, OpenAiCompletionsParameters parameters, String apiKey, 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(OpenAiCompletionsRequest 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.completions.OpenAiCompletionsChain

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

AzureOpenAiCompletionsChain

public AzureOpenAiCompletionsChain(String resourceName, String deploymentName, String apiVersion, String promptTemplate, OpenAiCompletionsParameters parameters, String apiKey, 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)

objectMapper - The ObjectMapper used for body serialization and deserialization

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

AzureOpenAiCompletionsChain

public AzureOpenAiCompletionsChain(String resourceName, String deploymentName, String apiVersion, String promptTemplate, OpenAiCompletionsParameters 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(OpenAiCompletionsRequest 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<OpenAiCompletionsParameters,OpenAiCompletionsRequest,OpenAiCompletionsResponse>

Parameters:

request - the request entity

webClient - the WebClient to use for the request

objectMapper - the ObjectMapper used for body serialization

Returns:

the WebClient.ResponseSpec