Package dev.langchain4j.model.azure

Class AzureOpenAiEmbeddingModel.Builder

java.lang.Object

dev.langchain4j.model.azure.AzureOpenAiEmbeddingModel.Builder

Enclosing class:

AzureOpenAiEmbeddingModel

public static class AzureOpenAiEmbeddingModel.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
AzureOpenAiEmbeddingModel.Builder	apiKey(String apiKey)	Sets the Azure OpenAI API key.
AzureOpenAiEmbeddingModel	build()
AzureOpenAiEmbeddingModel.Builder	customHeaders(Map<String,String> customHeaders)
AzureOpenAiEmbeddingModel.Builder	deploymentName(String deploymentName)	Sets the deployment name in Azure OpenAI.
AzureOpenAiEmbeddingModel.Builder	dimensions(Integer dimensions)
AzureOpenAiEmbeddingModel.Builder	endpoint(String endpoint)	Sets the Azure OpenAI endpoint.
AzureOpenAiEmbeddingModel.Builder	httpClientProvider(com.azure.core.http.HttpClientProvider httpClientProvider)	Sets the HttpClientProvider to use for creating the HTTP client to communicate with the OpenAI api.
AzureOpenAiEmbeddingModel.Builder	logRequestsAndResponses(boolean logRequestsAndResponses)
AzureOpenAiEmbeddingModel.Builder	maxRetries(Integer maxRetries)
AzureOpenAiEmbeddingModel.Builder	nonAzureApiKey(String nonAzureApiKey)	Used to authenticate with the OpenAI service, instead of Azure OpenAI.
AzureOpenAiEmbeddingModel.Builder	openAIClient(com.azure.ai.openai.OpenAIClient openAIClient)	Sets the Azure OpenAI client.
AzureOpenAiEmbeddingModel.Builder	proxyOptions(com.azure.core.http.ProxyOptions proxyOptions)
AzureOpenAiEmbeddingModel.Builder	retryOptions(com.azure.core.http.policy.RetryOptions retryOptions)
AzureOpenAiEmbeddingModel.Builder	serviceVersion(String serviceVersion)	Sets the Azure OpenAI API service version.
AzureOpenAiEmbeddingModel.Builder	timeout(Duration timeout)
AzureOpenAiEmbeddingModel.Builder	tokenCredential(com.azure.core.credential.TokenCredential tokenCredential)	Used to authenticate to Azure OpenAI with Azure Active Directory credentials.
AzureOpenAiEmbeddingModel.Builder	userAgentSuffix(String userAgentSuffix)

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

endpoint

public AzureOpenAiEmbeddingModel.Builder endpoint(String endpoint)

Sets the Azure OpenAI endpoint. This is a mandatory parameter.

Parameters:

endpoint - The Azure OpenAI endpoint in the format: https://{resource}.openai.azure.com/

Returns:

builder

serviceVersion

public AzureOpenAiEmbeddingModel.Builder serviceVersion(String serviceVersion)

Sets the Azure OpenAI API service version. This is a mandatory parameter.

Parameters:

serviceVersion - The Azure OpenAI API service version in the format: 2023-05-15

Returns:

builder

apiKey

public AzureOpenAiEmbeddingModel.Builder apiKey(String apiKey)

Sets the Azure OpenAI API key.

Parameters:

apiKey - The Azure OpenAI API key.

Returns:

builder

nonAzureApiKey

public AzureOpenAiEmbeddingModel.Builder nonAzureApiKey(String nonAzureApiKey)

Used to authenticate with the OpenAI service, instead of Azure OpenAI. This automatically sets the endpoint to https://api.openai.com/v1.

Parameters:

nonAzureApiKey - The non-Azure OpenAI API key

Returns:

builder

tokenCredential

public AzureOpenAiEmbeddingModel.Builder tokenCredential(com.azure.core.credential.TokenCredential tokenCredential)

Used to authenticate to Azure OpenAI with Azure Active Directory credentials.

Parameters:

tokenCredential - the credentials to authenticate with Azure Active Directory

Returns:

builder

httpClientProvider

public AzureOpenAiEmbeddingModel.Builder httpClientProvider(com.azure.core.http.HttpClientProvider httpClientProvider)

Sets the HttpClientProvider to use for creating the HTTP client to communicate with the OpenAI api.

Parameters:

httpClientProvider - The HttpClientProvider to use

Returns:

builder

deploymentName

public AzureOpenAiEmbeddingModel.Builder deploymentName(String deploymentName)

Sets the deployment name in Azure OpenAI. This is a mandatory parameter.

Parameters:

deploymentName - The Deployment name.

Returns:

builder

timeout

public AzureOpenAiEmbeddingModel.Builder timeout(Duration timeout)

maxRetries

public AzureOpenAiEmbeddingModel.Builder maxRetries(Integer maxRetries)

retryOptions

public AzureOpenAiEmbeddingModel.Builder retryOptions(com.azure.core.http.policy.RetryOptions retryOptions)

proxyOptions

public AzureOpenAiEmbeddingModel.Builder proxyOptions(com.azure.core.http.ProxyOptions proxyOptions)

logRequestsAndResponses

public AzureOpenAiEmbeddingModel.Builder logRequestsAndResponses(boolean logRequestsAndResponses)

openAIClient

public AzureOpenAiEmbeddingModel.Builder openAIClient(com.azure.ai.openai.OpenAIClient openAIClient)

Sets the Azure OpenAI client. This is an optional parameter, if you need more flexibility than using the endpoint, serviceVersion, apiKey, deploymentName parameters.

Parameters:

openAIClient - The Azure OpenAI client.

Returns:

builder

userAgentSuffix

public AzureOpenAiEmbeddingModel.Builder userAgentSuffix(String userAgentSuffix)

dimensions

public AzureOpenAiEmbeddingModel.Builder dimensions(Integer dimensions)

customHeaders

public AzureOpenAiEmbeddingModel.Builder customHeaders(Map<String,String> customHeaders)

build

public AzureOpenAiEmbeddingModel build()