Package com.oracle.bmc.generativeaiinference.model

Class RerankTextDetails.Builder

java.lang.Object

com.oracle.bmc.generativeaiinference.model.RerankTextDetails.Builder

Enclosing class:

RerankTextDetails

public static class RerankTextDetails.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RerankTextDetails	build()
RerankTextDetails.Builder	compartmentId(String compartmentId)	The OCID of the compartment to call into the Generative AI service LLMs.
RerankTextDetails.Builder	copy(RerankTextDetails model)
RerankTextDetails.Builder	documents(List<String> documents)	A list of document strings to rerank based on the query asked.
RerankTextDetails.Builder	input(String input)	Input query for search in the documents.
RerankTextDetails.Builder	isEcho(Boolean isEcho)	Whether or not to return the documents in the response.
RerankTextDetails.Builder	maxChunksPerDocument(Integer maxChunksPerDocument)	The maximum number of chunks to produce internally from a document.
RerankTextDetails.Builder	maxTokensPerDocument(Integer maxTokensPerDocument)	Used to truncate the long documents with the specified no of tokens.
RerankTextDetails.Builder	servingMode(ServingMode servingMode)
RerankTextDetails.Builder	topN(Integer topN)	The number of most relevant documents or indices to return.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

input

public RerankTextDetails.Builder input(String input)

Input query for search in the documents.

Parameters:

input - the value to set

Returns:

this builder

compartmentId

public RerankTextDetails.Builder compartmentId(String compartmentId)

The OCID of the compartment to call into the Generative AI service LLMs.

Parameters:

compartmentId - the value to set

Returns:

this builder

servingMode

public RerankTextDetails.Builder servingMode(ServingMode servingMode)

documents

public RerankTextDetails.Builder documents(List<String> documents)

A list of document strings to rerank based on the query asked.

Parameters:

documents - the value to set

Returns:

this builder

topN

public RerankTextDetails.Builder topN(Integer topN)

The number of most relevant documents or indices to return.

Defaults to the length of the documents.

Parameters:

topN - the value to set

Returns:

this builder

isEcho

public RerankTextDetails.Builder isEcho(Boolean isEcho)

Whether or not to return the documents in the response.

Parameters:

isEcho - the value to set

Returns:

this builder

maxChunksPerDocument

public RerankTextDetails.Builder maxChunksPerDocument(Integer maxChunksPerDocument)

The maximum number of chunks to produce internally from a document.

Parameters:

maxChunksPerDocument - the value to set

Returns:

this builder

maxTokensPerDocument

public RerankTextDetails.Builder maxTokensPerDocument(Integer maxTokensPerDocument)

Used to truncate the long documents with the specified no of tokens.

Parameters:

maxTokensPerDocument - the value to set

Returns:

this builder

build

public RerankTextDetails build()

copy

public RerankTextDetails.Builder copy(RerankTextDetails model)