Package dev.langchain4j.model.voyageai

Class VoyageAiScoringModel.Builder

java.lang.Object

dev.langchain4j.model.voyageai.VoyageAiScoringModel.Builder

Enclosing class:

VoyageAiScoringModel

public static class VoyageAiScoringModel.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
VoyageAiScoringModel.Builder	apiKey(String apiKey)
VoyageAiScoringModel.Builder	baseUrl(String baseUrl)
VoyageAiScoringModel	build()
VoyageAiScoringModel.Builder	logRequests(Boolean logRequests)
VoyageAiScoringModel.Builder	logResponses(Boolean logResponses)
VoyageAiScoringModel.Builder	maxRetries(Integer maxRetries)
VoyageAiScoringModel.Builder	modelName(VoyageAiScoringModelName modelName)	Name of the model.
VoyageAiScoringModel.Builder	modelName(String modelName)	Name of the model.
VoyageAiScoringModel.Builder	timeout(Duration timeout)
VoyageAiScoringModel.Builder	topK(Integer topK)	The number of most relevant documents to return.
VoyageAiScoringModel.Builder	truncation(Boolean truncation)	Whether to truncate the input to satisfy the "context length limit" on the query and the documents.

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

baseUrl

public VoyageAiScoringModel.Builder baseUrl(String baseUrl)

timeout

public VoyageAiScoringModel.Builder timeout(Duration timeout)

maxRetries

public VoyageAiScoringModel.Builder maxRetries(Integer maxRetries)

apiKey

public VoyageAiScoringModel.Builder apiKey(String apiKey)

modelName

public VoyageAiScoringModel.Builder modelName(VoyageAiScoringModelName modelName)

Name of the model.

Parameters:

modelName - Name of the model.

See Also:

• VoyageAiScoringModelName

modelName

public VoyageAiScoringModel.Builder modelName(String modelName)

Name of the model.

Parameters:

modelName - Name of the model.

See Also:

• VoyageAiScoringModelName

topK

public VoyageAiScoringModel.Builder topK(Integer topK)

The number of most relevant documents to return. If not specified, the reranking results of all documents will be returned.

Parameters:

topK - the number of most relevant documents to return.

truncation

public VoyageAiScoringModel.Builder truncation(Boolean truncation)

Whether to truncate the input to satisfy the "context length limit" on the query and the documents. Defaults to true.

• If true, the query and documents will be truncated to fit within the context length limit, before processed by the reranker model.
• If false, an error will be raised when the query exceeds 1000 tokens for rerank-lite-1 and 2000 tokens for rerank-1, or the sum of the number of tokens in the query and the number of tokens in any single document exceeds 4000 for rerank-lite-1 and 8000 for rerank-1.

Parameters:

truncation - Whether to truncate the input to satisfy the "context length limit" on the query and the documents.

logRequests

public VoyageAiScoringModel.Builder logRequests(Boolean logRequests)

logResponses

public VoyageAiScoringModel.Builder logResponses(Boolean logResponses)

build

public VoyageAiScoringModel build()