Package dev.langchain4j.model.azure

Class AzureOpenAiStreamingLanguageModel

java.lang.Object

dev.langchain4j.model.azure.AzureOpenAiStreamingLanguageModel

All Implemented Interfaces:

StreamingLanguageModel, TokenCountEstimator

public class AzureOpenAiStreamingLanguageModel
extends Object
implements StreamingLanguageModel, TokenCountEstimator

Represents an OpenAI language model, hosted on Azure, such as gpt-3.5-turbo-instruct. The LLM's response is streamed token by token and should be handled with StreamingResponseHandler.

Mandatory parameters for initialization are: endpoint and apikey (or an alternate authentication method, see below for more information). Optionally you can set serviceVersion (if not, the latest version is used) and deploymentName (if not, a default name is used). You can also provide your own OpenAIClient instance, if you need more flexibility.

There are 3 authentication methods:

1. Azure OpenAI API Key Authentication: this is the most common method, using an Azure OpenAI API key. You need to provide the OpenAI API Key as a parameter, using the apiKey() method in the Builder, or the apiKey parameter in the constructor: For example, you would use `builder.apiKey("{key}")`.

2. non-Azure OpenAI API Key Authentication: this method allows to use the OpenAI service, instead of Azure OpenAI. You can use the nonAzureApiKey() method in the Builder, which will also automatically set the endpoint to "https://api.openai.com/v1". For example, you would use `builder.nonAzureApiKey("{key}")`. The constructor requires a KeyCredential instance, which can be created using `new AzureKeyCredential("{key}")`, and doesn't set up the endpoint.

3. Azure OpenAI client with Microsoft Entra ID (formerly Azure Active Directory) credentials. - This requires to add the `com.azure:azure-identity` dependency to your project, which is an optional dependency to this library. - You need to provide a TokenCredential instance, using the tokenCredential() method in the Builder, or the tokenCredential parameter in the constructor. As an example, DefaultAzureCredential can be used to authenticate the client: Set the values of the client ID, tenant ID, and client secret of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET. Then, provide the DefaultAzureCredential instance to the builder: `builder.tokenCredential(new DefaultAzureCredentialBuilder().build())`.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AzureOpenAiStreamingLanguageModel.Builder

Constructor Summary

Constructors

Constructor	Description
AzureOpenAiStreamingLanguageModel(com.azure.ai.openai.OpenAIClient client, String deploymentName, Tokenizer tokenizer, Integer maxTokens, Double temperature, Double topP, Map<String,Integer> logitBias, String user, Integer n, Integer logprobs, Boolean echo, List<String> stop, Double presencePenalty, Double frequencyPenalty)
AzureOpenAiStreamingLanguageModel(String endpoint, String serviceVersion, com.azure.core.credential.KeyCredential keyCredential, String deploymentName, Tokenizer tokenizer, Integer maxTokens, Double temperature, Double topP, Map<String,Integer> logitBias, String user, Integer n, Integer logprobs, Boolean echo, List<String> stop, Double presencePenalty, Double frequencyPenalty, Duration timeout, Integer maxRetries, com.azure.core.http.ProxyOptions proxyOptions, boolean logRequestsAndResponses, String userAgentSuffix)
AzureOpenAiStreamingLanguageModel(String endpoint, String serviceVersion, com.azure.core.credential.TokenCredential tokenCredential, String deploymentName, Tokenizer tokenizer, Integer maxTokens, Double temperature, Double topP, Map<String,Integer> logitBias, String user, Integer n, Integer logprobs, Boolean echo, List<String> stop, Double presencePenalty, Double frequencyPenalty, Duration timeout, Integer maxRetries, com.azure.core.http.ProxyOptions proxyOptions, boolean logRequestsAndResponses, String userAgentSuffix)
AzureOpenAiStreamingLanguageModel(String endpoint, String serviceVersion, String apiKey, String deploymentName, Tokenizer tokenizer, Integer maxTokens, Double temperature, Double topP, Map<String,Integer> logitBias, String user, Integer n, Integer logprobs, Boolean echo, List<String> stop, Double presencePenalty, Double frequencyPenalty, Duration timeout, Integer maxRetries, com.azure.core.http.ProxyOptions proxyOptions, boolean logRequestsAndResponses, String userAgentSuffix)

Method Summary

Modifier and Type	Method	Description
static AzureOpenAiStreamingLanguageModel.Builder	builder()
int	estimateTokenCount(String prompt)	Estimates the count of tokens in the given text.
void	generate(String prompt, StreamingResponseHandler<String> handler)	Generates a response from the model based on a 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.StreamingLanguageModel

generate

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

estimateTokenCount, estimateTokenCount

Constructor Details

AzureOpenAiStreamingLanguageModel

public AzureOpenAiStreamingLanguageModel(com.azure.ai.openai.OpenAIClient client,
 String deploymentName,
 Tokenizer tokenizer,
 Integer maxTokens,
 Double temperature,
 Double topP,
 Map<String,Integer> logitBias,
 String user,
 Integer n,
 Integer logprobs,
 Boolean echo,
 List<String> stop,
 Double presencePenalty,
 Double frequencyPenalty)

AzureOpenAiStreamingLanguageModel

public AzureOpenAiStreamingLanguageModel(String endpoint,
 String serviceVersion,
 String apiKey,
 String deploymentName,
 Tokenizer tokenizer,
 Integer maxTokens,
 Double temperature,
 Double topP,
 Map<String,Integer> logitBias,
 String user,
 Integer n,
 Integer logprobs,
 Boolean echo,
 List<String> stop,
 Double presencePenalty,
 Double frequencyPenalty,
 Duration timeout,
 Integer maxRetries,
 com.azure.core.http.ProxyOptions proxyOptions,
 boolean logRequestsAndResponses,
 String userAgentSuffix)

AzureOpenAiStreamingLanguageModel

public AzureOpenAiStreamingLanguageModel(String endpoint,
 String serviceVersion,
 com.azure.core.credential.KeyCredential keyCredential,
 String deploymentName,
 Tokenizer tokenizer,
 Integer maxTokens,
 Double temperature,
 Double topP,
 Map<String,Integer> logitBias,
 String user,
 Integer n,
 Integer logprobs,
 Boolean echo,
 List<String> stop,
 Double presencePenalty,
 Double frequencyPenalty,
 Duration timeout,
 Integer maxRetries,
 com.azure.core.http.ProxyOptions proxyOptions,
 boolean logRequestsAndResponses,
 String userAgentSuffix)

AzureOpenAiStreamingLanguageModel

public AzureOpenAiStreamingLanguageModel(String endpoint,
 String serviceVersion,
 com.azure.core.credential.TokenCredential tokenCredential,
 String deploymentName,
 Tokenizer tokenizer,
 Integer maxTokens,
 Double temperature,
 Double topP,
 Map<String,Integer> logitBias,
 String user,
 Integer n,
 Integer logprobs,
 Boolean echo,
 List<String> stop,
 Double presencePenalty,
 Double frequencyPenalty,
 Duration timeout,
 Integer maxRetries,
 com.azure.core.http.ProxyOptions proxyOptions,
 boolean logRequestsAndResponses,
 String userAgentSuffix)

Method Details

generate

public void generate(String prompt,
 StreamingResponseHandler<String> handler)

Description copied from interface: StreamingLanguageModel

Generates a response from the model based on a prompt.

Specified by:

generate in interface StreamingLanguageModel

Parameters:

prompt - The prompt.

handler - The handler for streaming the response.

estimateTokenCount

public int estimateTokenCount(String prompt)

Description copied from interface: TokenCountEstimator

Estimates the count of tokens in the given text.

Specified by:

estimateTokenCount in interface TokenCountEstimator

Parameters:

prompt - the text.

Returns:

the estimated count of tokens.

builder

public static AzureOpenAiStreamingLanguageModel.Builder builder()