Class GitHubModelsChatModel.Builder

java.lang.Object

dev.langchain4j.model.github.GitHubModelsChatModel.Builder

Enclosing class:

GitHubModelsChatModel

public static class GitHubModelsChatModel.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GitHubModelsChatModel	build()
GitHubModelsChatModel.Builder	chatCompletionsClient(com.azure.ai.inference.ChatCompletionsClient chatCompletionsClient)	Sets the Azure AI Inference API client.
GitHubModelsChatModel.Builder	customHeaders(Map<String,String> customHeaders)
GitHubModelsChatModel.Builder	endpoint(String endpoint)	Sets the GitHub Models endpoint.
GitHubModelsChatModel.Builder	frequencyPenalty(Double frequencyPenalty)
GitHubModelsChatModel.Builder	gitHubToken(String gitHubToken)	Sets the GitHub token to access GitHub Models.
GitHubModelsChatModel.Builder	listeners(List<dev.langchain4j.model.chat.listener.ChatModelListener> listeners)
GitHubModelsChatModel.Builder	logRequestsAndResponses(Boolean logRequestsAndResponses)
GitHubModelsChatModel.Builder	maxRetries(Integer maxRetries)
GitHubModelsChatModel.Builder	maxTokens(Integer maxTokens)
GitHubModelsChatModel.Builder	modelName(GitHubModelsChatModelName modelName)
GitHubModelsChatModel.Builder	modelName(String modelName)	Sets the model name in Azure AI Inference API.
GitHubModelsChatModel.Builder	presencePenalty(Double presencePenalty)
GitHubModelsChatModel.Builder	proxyOptions(com.azure.core.http.ProxyOptions proxyOptions)
GitHubModelsChatModel.Builder	responseFormat(com.azure.ai.inference.models.ChatCompletionsResponseFormat responseFormat)
GitHubModelsChatModel.Builder	seed(Long seed)
GitHubModelsChatModel.Builder	serviceVersion(com.azure.ai.inference.ModelServiceVersion serviceVersion)	Sets the Azure OpenAI API service version.
GitHubModelsChatModel.Builder	stop(List<String> stop)
GitHubModelsChatModel.Builder	temperature(Double temperature)
GitHubModelsChatModel.Builder	timeout(Duration timeout)
GitHubModelsChatModel.Builder	topP(Double topP)
GitHubModelsChatModel.Builder	userAgentSuffix(String userAgentSuffix)

Methods inherited from class Object

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

Constructor Details

Builder

public Builder()

Method Details

endpoint

public GitHubModelsChatModel.Builder endpoint(String endpoint)

Sets the GitHub Models endpoint. The default endpoint will be used if this isn't set.

Parameters:

endpoint - The GitHub Models endpoint in the format: https://models.inference.ai.azure.com

Returns:

builder

serviceVersion

public GitHubModelsChatModel.Builder serviceVersion(com.azure.ai.inference.ModelServiceVersion serviceVersion)

Sets the Azure OpenAI API service version. If left blank, the latest service version will be used.

Parameters:

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

Returns:

builder

gitHubToken

public GitHubModelsChatModel.Builder gitHubToken(String gitHubToken)

Sets the GitHub token to access GitHub Models.

Parameters:

gitHubToken - The GitHub token.

Returns:

builder

modelName

public GitHubModelsChatModel.Builder modelName(String modelName)

Sets the model name in Azure AI Inference API. This is a mandatory parameter.

Parameters:

modelName - The Model name.

Returns:

builder

modelName

public GitHubModelsChatModel.Builder modelName(GitHubModelsChatModelName modelName)

maxTokens

public GitHubModelsChatModel.Builder maxTokens(Integer maxTokens)

temperature

public GitHubModelsChatModel.Builder temperature(Double temperature)

topP

public GitHubModelsChatModel.Builder topP(Double topP)

stop

public GitHubModelsChatModel.Builder stop(List<String> stop)

presencePenalty

public GitHubModelsChatModel.Builder presencePenalty(Double presencePenalty)

frequencyPenalty

public GitHubModelsChatModel.Builder frequencyPenalty(Double frequencyPenalty)

seed

public GitHubModelsChatModel.Builder seed(Long seed)

responseFormat

public GitHubModelsChatModel.Builder responseFormat(com.azure.ai.inference.models.ChatCompletionsResponseFormat responseFormat)

timeout

public GitHubModelsChatModel.Builder timeout(Duration timeout)

maxRetries

public GitHubModelsChatModel.Builder maxRetries(Integer maxRetries)

proxyOptions

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

logRequestsAndResponses

public GitHubModelsChatModel.Builder logRequestsAndResponses(Boolean logRequestsAndResponses)

userAgentSuffix

public GitHubModelsChatModel.Builder userAgentSuffix(String userAgentSuffix)

chatCompletionsClient

public GitHubModelsChatModel.Builder chatCompletionsClient(com.azure.ai.inference.ChatCompletionsClient chatCompletionsClient)

Sets the Azure AI Inference API client. This is an optional parameter, if you need more flexibility than the common parameters.

Parameters:

chatCompletionsClient - The Azure AI Inference API client.

Returns:

builder

listeners

public GitHubModelsChatModel.Builder listeners(List<dev.langchain4j.model.chat.listener.ChatModelListener> listeners)

customHeaders

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

build

public GitHubModelsChatModel build()