Package dev.langchain4j.model.github

Class GitHubModelsEmbeddingModel.Builder

java.lang.Object

dev.langchain4j.model.github.GitHubModelsEmbeddingModel.Builder

Enclosing class:

GitHubModelsEmbeddingModel

public static class GitHubModelsEmbeddingModel.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GitHubModelsEmbeddingModel	build()
GitHubModelsEmbeddingModel.Builder	customHeaders(Map<String,String> customHeaders)
GitHubModelsEmbeddingModel.Builder	dimensions(Integer dimensions)
GitHubModelsEmbeddingModel.Builder	embeddingsClient(com.azure.ai.inference.EmbeddingsClient embeddingsClient)	Sets the Azure AI Inference API client.
GitHubModelsEmbeddingModel.Builder	endpoint(String endpoint)	Sets the GitHub Models endpoint.
GitHubModelsEmbeddingModel.Builder	gitHubToken(String gitHubToken)	Sets the GitHub token to access GitHub Models.
GitHubModelsEmbeddingModel.Builder	logRequestsAndResponses(boolean logRequestsAndResponses)
GitHubModelsEmbeddingModel.Builder	maxRetries(Integer maxRetries)
GitHubModelsEmbeddingModel.Builder	modelName(GitHubModelsEmbeddingModelName modelName)
GitHubModelsEmbeddingModel.Builder	modelName(String modelName)	Sets the model name in Azure AI Inference API.
GitHubModelsEmbeddingModel.Builder	proxyOptions(com.azure.core.http.ProxyOptions proxyOptions)
GitHubModelsEmbeddingModel.Builder	serviceVersion(com.azure.ai.inference.ModelServiceVersion serviceVersion)	Sets the Azure OpenAI API service version.
GitHubModelsEmbeddingModel.Builder	timeout(Duration timeout)
GitHubModelsEmbeddingModel.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 GitHubModelsEmbeddingModel.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 GitHubModelsEmbeddingModel.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 GitHubModelsEmbeddingModel.Builder gitHubToken(String gitHubToken)

Sets the GitHub token to access GitHub Models.

Parameters:

gitHubToken - The GitHub token.

Returns:

builder

modelName

public GitHubModelsEmbeddingModel.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 GitHubModelsEmbeddingModel.Builder modelName(GitHubModelsEmbeddingModelName modelName)

timeout

public GitHubModelsEmbeddingModel.Builder timeout(Duration timeout)

maxRetries

public GitHubModelsEmbeddingModel.Builder maxRetries(Integer maxRetries)

proxyOptions

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

logRequestsAndResponses

public GitHubModelsEmbeddingModel.Builder logRequestsAndResponses(boolean logRequestsAndResponses)

embeddingsClient

public GitHubModelsEmbeddingModel.Builder embeddingsClient(com.azure.ai.inference.EmbeddingsClient embeddingsClient)

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

Parameters:

embeddingsClient - The Azure AI Inference API client.

Returns:

builder

userAgentSuffix

public GitHubModelsEmbeddingModel.Builder userAgentSuffix(String userAgentSuffix)

dimensions

public GitHubModelsEmbeddingModel.Builder dimensions(Integer dimensions)

customHeaders

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

build

public GitHubModelsEmbeddingModel build()