Package com.oracle.bmc.generativeaiinference.model

Class DocumentRank

java.lang.Object

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

com.oracle.bmc.generativeaiinference.model.DocumentRank

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

An object that contains a relevance score, an index and the text for a document.
Note: Objects should always be created or deserialized using the DocumentRank.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 DocumentRank.Builder, which maintain a set of all explicitly set fields called DocumentRank.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	DocumentRank.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
DocumentRank(Integer index, Double relevanceScore, Document document)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static DocumentRank.Builder	builder()	Create a new builder.
boolean	equals(Object o)
Document	getDocument()
Integer	getIndex()	Index of the document in documents array.
Double	getRelevanceScore()	The relevance score for the document at that index.
int	hashCode()
DocumentRank.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

DocumentRank

@Deprecated
@ConstructorProperties({"index","relevanceScore","document"})
public DocumentRank(Integer index,
                    Double relevanceScore,
                    Document document)

Deprecated.

Method Detail

builder

public static DocumentRank.Builder builder()

Create a new builder.

toBuilder

public DocumentRank.Builder toBuilder()

getIndex

public Integer getIndex()

Index of the document in documents array.

Returns:

the value

getRelevanceScore

public Double getRelevanceScore()

The relevance score for the document at that index.

Returns:

the value

getDocument

public Document getDocument()

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