dev.langchain4j.model.azure

Class AzureOpenAiStreamingLanguageModel

java.lang.Object

dev.langchain4j.model.azure.AzureOpenAiStreamingLanguageModel

All Implemented Interfaces:

dev.langchain4j.model.language.StreamingLanguageModel, dev.langchain4j.model.language.TokenCountEstimator

public class AzureOpenAiStreamingLanguageModel
extends Object
implements dev.langchain4j.model.language.StreamingLanguageModel, dev.langchain4j.model.language.TokenCountEstimator

Represents an OpenAI language model, hosted on Azure, such as text-davinci-003. The LLM's response is streamed token by token and should be handled with StreamingResponseHandler. However, it's recommended to use OpenAiStreamingChatModel 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	AzureOpenAiStreamingLanguageModel.Builder

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static AzureOpenAiStreamingLanguageModel.Builder	builder()
int	estimateTokenCount(String prompt)
void	generate(String prompt, dev.langchain4j.model.StreamingResponseHandler<String> handler)

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 Detail

AzureOpenAiStreamingLanguageModel

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

Method Detail

generate

public void generate(String prompt,
                     dev.langchain4j.model.StreamingResponseHandler<String> handler)

Specified by:

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

estimateTokenCount

public int estimateTokenCount(String prompt)

Specified by:

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

builder

public static AzureOpenAiStreamingLanguageModel.Builder builder()