com.oracle.bmc.generativeaiinference.model

Class RerankTextResult

java.lang.Object

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

com.oracle.bmc.generativeaiinference.model.RerankTextResult

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

The rerank response to return to the caller.
Note: Objects should always be created or deserialized using the RerankTextResult.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 RerankTextResult.Builder, which maintain a set of all explicitly set fields called RerankTextResult.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 and Description
static class	RerankTextResult.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 and Description
RerankTextResult(String id, String modelId, String modelVersion, List<DocumentRank> documentRanks) Deprecated.

Method Summary

Modifier and Type	Method and Description
static RerankTextResult.Builder	builder() Create a new builder.
boolean	equals(Object o)
List<DocumentRank>	getDocumentRanks() Top n documents with their index and relevance score.
String	getId() A unique identifier for this RerankResult.
String	getModelId() The OCID of the model used in the rerank request.
String	getModelVersion() The version of the model.
int	hashCode()
RerankTextResult.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

RerankTextResult

@Deprecated
 @ConstructorProperties(value={"id","modelId","modelVersion","documentRanks"})
public RerankTextResult(String id,
                                                                                                                   String modelId,
                                                                                                                   String modelVersion,
                                                                                                                   List<DocumentRank> documentRanks)

Deprecated.

Method Detail

builder

public static RerankTextResult.Builder builder()

Create a new builder.

toBuilder

public RerankTextResult.Builder toBuilder()

getId

public String getId()

A unique identifier for this RerankResult.

Returns:

the value

getModelId

public String getModelId()

The OCID of the model used in the rerank request.

Returns:

the value

getModelVersion

public String getModelVersion()

The version of the model.

Returns:

the value

getDocumentRanks

public List<DocumentRank> getDocumentRanks()

Top n documents with their index and relevance score.

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