Package com.oracle.bmc.generativeaiinference.model

Class RerankTextDetails

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.generativeaiinference.model.RerankTextDetails

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20231130")
public final class RerankTextDetails
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Details required for a rerank request.
Note: Objects should always be created or deserialized using the RerankTextDetails.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the RerankTextDetails.Builder, which maintain a set of all explicitly set fields called RerankTextDetails.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RerankTextDetails.Builder

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
RerankTextDetails(String input, String compartmentId, ServingMode servingMode, List<String> documents, Integer topN, Boolean isEcho, Integer maxChunksPerDocument)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static RerankTextDetails.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getCompartmentId()	The OCID of the compartment to call into the Generative AI service LLMs.
List<String>	getDocuments()	A list of document strings to rerank based on the query asked.
String	getInput()	Input query for search in the documents.
Boolean	getIsEcho()	Whether or not to return the documents in the response.
Integer	getMaxChunksPerDocument()	The maximum number of chunks to produce internally from a document.
ServingMode	getServingMode()
Integer	getTopN()	The number of most relevant documents or indices to return.
int	hashCode()
RerankTextDetails.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RerankTextDetails

@Deprecated
@ConstructorProperties({"input","compartmentId","servingMode","documents","topN","isEcho","maxChunksPerDocument"})
public RerankTextDetails(String input,
                         String compartmentId,
                         ServingMode servingMode,
                         List<String> documents,
                         Integer topN,
                         Boolean isEcho,
                         Integer maxChunksPerDocument)

Deprecated.

Method Detail

builder

public static RerankTextDetails.Builder builder()

Create a new builder.

toBuilder

public RerankTextDetails.Builder toBuilder()

getInput

public String getInput()

Input query for search in the documents.

Returns:

the value

getCompartmentId

public String getCompartmentId()

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

Returns:

the value

getServingMode

public ServingMode getServingMode()

getDocuments

public List<String> getDocuments()

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

Returns:

the value

getTopN

public Integer getTopN()

The number of most relevant documents or indices to return.

Defaults to the length of the documents.

Returns:

the value

getIsEcho

public Boolean getIsEcho()

Whether or not to return the documents in the response.

Returns:

the value

getMaxChunksPerDocument

public Integer getMaxChunksPerDocument()

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

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel