Package dev.langchain4j.model.azure

Class AzureOpenAiAudioTranscriptionModel.Builder

java.lang.Object

dev.langchain4j.model.azure.AzureOpenAiAudioTranscriptionModel.Builder

Enclosing class:

AzureOpenAiAudioTranscriptionModel

public static class AzureOpenAiAudioTranscriptionModel.Builder
extends Object

Builder for AzureOpenAiAudioTranscriptionModel.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
AzureOpenAiAudioTranscriptionModel.Builder	apiKey(String apiKey)	Sets the Azure OpenAI API key.
AzureOpenAiAudioTranscriptionModel	build()	Builds a new instance of AzureOpenAiAudioTranscriptionModel.
AzureOpenAiAudioTranscriptionModel.Builder	customHeaders(Map<String,String> customHeaders)
AzureOpenAiAudioTranscriptionModel.Builder	deploymentName(String deploymentName)	Sets the deployment name in Azure OpenAI.
AzureOpenAiAudioTranscriptionModel.Builder	endpoint(String endpoint)	Sets the Azure OpenAI endpoint.
AzureOpenAiAudioTranscriptionModel.Builder	httpClientProvider(com.azure.core.http.HttpClientProvider httpClientProvider)	Sets the HttpClientProvider to use for creating the HTTP client to communicate with the OpenAI api.
AzureOpenAiAudioTranscriptionModel.Builder	logRequestsAndResponses(Boolean logRequestsAndResponses)
AzureOpenAiAudioTranscriptionModel.Builder	maxRetries(Integer maxRetries)
AzureOpenAiAudioTranscriptionModel.Builder	nonAzureApiKey(String nonAzureApiKey)	Used to authenticate with the OpenAI service, instead of Azure OpenAI.
AzureOpenAiAudioTranscriptionModel.Builder	openAIClient(com.azure.ai.openai.OpenAIClient openAIClient)
AzureOpenAiAudioTranscriptionModel.Builder	proxyOptions(com.azure.core.http.ProxyOptions proxyOptions)
AzureOpenAiAudioTranscriptionModel.Builder	responseFormat(com.azure.ai.openai.models.AudioTranscriptionFormat format)	Sets the response format for the transcription.
AzureOpenAiAudioTranscriptionModel.Builder	retryOptions(com.azure.core.http.policy.RetryOptions retryOptions)
AzureOpenAiAudioTranscriptionModel.Builder	serviceVersion(String serviceVersion)	Sets the Azure OpenAI API service version.
AzureOpenAiAudioTranscriptionModel.Builder	timeout(Duration timeout)
AzureOpenAiAudioTranscriptionModel.Builder	tokenCredential(com.azure.core.credential.TokenCredential tokenCredential)	Used to authenticate to Azure OpenAI with Azure Active Directory credentials.
AzureOpenAiAudioTranscriptionModel.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 AzureOpenAiAudioTranscriptionModel.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

httpClientProvider

public AzureOpenAiAudioTranscriptionModel.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

serviceVersion

public AzureOpenAiAudioTranscriptionModel.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 AzureOpenAiAudioTranscriptionModel.Builder apiKey(String apiKey)

Sets the Azure OpenAI API key.

Parameters:

apiKey - The Azure OpenAI API key.

Returns:

builder

nonAzureApiKey

public AzureOpenAiAudioTranscriptionModel.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 AzureOpenAiAudioTranscriptionModel.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

deploymentName

public AzureOpenAiAudioTranscriptionModel.Builder deploymentName(String deploymentName)

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

Parameters:

deploymentName - The Deployment name.

Returns:

builder

responseFormat

public AzureOpenAiAudioTranscriptionModel.Builder responseFormat(com.azure.ai.openai.models.AudioTranscriptionFormat format)

Sets the response format for the transcription.

Parameters:

format - The response format

Returns:

builder

timeout

public AzureOpenAiAudioTranscriptionModel.Builder timeout(Duration timeout)

maxRetries

public AzureOpenAiAudioTranscriptionModel.Builder maxRetries(Integer maxRetries)

See Also:

• retryOptions(RetryOptions)

retryOptions

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

proxyOptions

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

logRequestsAndResponses

public AzureOpenAiAudioTranscriptionModel.Builder logRequestsAndResponses(Boolean logRequestsAndResponses)

openAIClient

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

userAgentSuffix

public AzureOpenAiAudioTranscriptionModel.Builder userAgentSuffix(String userAgentSuffix)

customHeaders

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

build

public AzureOpenAiAudioTranscriptionModel build()

Builds a new instance of AzureOpenAiAudioTranscriptionModel.

Returns:

A new model instance