dev.langchain4j.model.azure

Class AzureOpenAiLanguageModel

java.lang.Object

dev.langchain4j.model.azure.AzureOpenAiLanguageModel

All Implemented Interfaces:

dev.langchain4j.model.language.LanguageModel, dev.langchain4j.model.language.TokenCountEstimator

public class AzureOpenAiLanguageModel
extends Object
implements dev.langchain4j.model.language.LanguageModel, dev.langchain4j.model.language.TokenCountEstimator

Represents an OpenAI language model, hosted on Azure, such as text-davinci-003. However, it's recommended to use AzureOpenAiChatModel instead, as it offers more advanced features like function calling, multi-turn conversations, etc.

Mandatory parameters for initialization are: baseUrl, apiVersion and apiKey.

There are two primary authentication methods to access Azure OpenAI:

1. API Key Authentication: For this type of authentication, HTTP requests must include the API Key in the "api-key" HTTP header.

2. Azure Active Directory Authentication: For this type of authentication, HTTP requests must include the authentication/access token in the "Authorization" HTTP header.

More information

Please note, that currently, only API Key authentication is supported by this class, second authentication option will be supported later.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AzureOpenAiLanguageModel.Builder

Constructor Summary

Constructors

Constructor and Description
AzureOpenAiLanguageModel(String baseUrl, String apiVersion, String apiKey, dev.langchain4j.model.Tokenizer tokenizer, Double temperature, Duration timeout, Integer maxRetries, Proxy proxy, Boolean logRequests, Boolean logResponses)

Method Summary

Modifier and Type	Method and Description
static AzureOpenAiLanguageModel.Builder	builder()
int	estimateTokenCount(String prompt)
dev.langchain4j.model.output.Response<String>	generate(String prompt)

Methods inherited from class java.lang.Object

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

Methods inherited from interface dev.langchain4j.model.language.LanguageModel

generate

Methods inherited from interface dev.langchain4j.model.language.TokenCountEstimator

estimateTokenCount, estimateTokenCount

Constructor Detail

AzureOpenAiLanguageModel

public AzureOpenAiLanguageModel(String baseUrl,
                                String apiVersion,
                                String apiKey,
                                dev.langchain4j.model.Tokenizer tokenizer,
                                Double temperature,
                                Duration timeout,
                                Integer maxRetries,
                                Proxy proxy,
                                Boolean logRequests,
                                Boolean logResponses)

Method Detail

generate

public dev.langchain4j.model.output.Response<String> generate(String prompt)

Specified by:

generate in interface dev.langchain4j.model.language.LanguageModel

estimateTokenCount

public int estimateTokenCount(String prompt)

Specified by:

estimateTokenCount in interface dev.langchain4j.model.language.TokenCountEstimator

builder

public static AzureOpenAiLanguageModel.Builder builder()