org.openapitools.inference.client.model

Class RankedDocument

java.lang.Object

org.openapitools.inference.client.model.RankedDocument

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-10-23T20:47:14.512003Z[Etc/UTC]")
public class RankedDocument
extends java.lang.Object

A ranked document with a relevance score and an index position.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RankedDocument.CustomTypeAdapterFactory

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.HashSet<java.lang.String>	openapiFields
static java.util.HashSet<java.lang.String>	openapiRequiredFields
static java.lang.String	SERIALIZED_NAME_DOCUMENT
static java.lang.String	SERIALIZED_NAME_INDEX
static java.lang.String	SERIALIZED_NAME_SCORE

Constructor Summary

Constructors

Constructor and Description
RankedDocument()

Method Summary

Modifier and Type	Method and Description
RankedDocument	document(java.util.Map<java.lang.String,java.lang.String> document)
boolean	equals(java.lang.Object o)
static RankedDocument	fromJson(java.lang.String jsonString) Create an instance of RankedDocument given an JSON string
java.util.Map<java.lang.String,java.lang.Object>	getAdditionalProperties() Return the additional (undeclared) property.
java.lang.Object	getAdditionalProperty(java.lang.String key) Return the additional (undeclared) property with the specified name.
java.util.Map<java.lang.String,java.lang.String>	getDocument() Document for reranking
java.lang.Integer	getIndex() The index of the document
java.math.BigDecimal	getScore() The relevance score of the document normalized between 0 and 1.
int	hashCode()
RankedDocument	index(java.lang.Integer index)
RankedDocument	putAdditionalProperty(java.lang.String key, java.lang.Object value) Set the additional (undeclared) property with the specified name and value.
RankedDocument	putDocumentItem(java.lang.String key, java.lang.String documentItem)
RankedDocument	score(java.math.BigDecimal score)
void	setDocument(java.util.Map<java.lang.String,java.lang.String> document)
void	setIndex(java.lang.Integer index)
void	setScore(java.math.BigDecimal score)
java.lang.String	toJson() Convert an instance of RankedDocument to an JSON string
java.lang.String	toString()
static void	validateJsonElement(com.google.gson.JsonElement jsonElement) Validates the JSON Element and throws an exception if issues found

Methods inherited from class java.lang.Object

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

Field Detail

SERIALIZED_NAME_INDEX

public static final java.lang.String SERIALIZED_NAME_INDEX

See Also:

Constant Field Values

SERIALIZED_NAME_SCORE

public static final java.lang.String SERIALIZED_NAME_SCORE

See Also:

Constant Field Values

SERIALIZED_NAME_DOCUMENT

public static final java.lang.String SERIALIZED_NAME_DOCUMENT

See Also:

Constant Field Values

openapiFields

public static java.util.HashSet<java.lang.String> openapiFields

openapiRequiredFields

public static java.util.HashSet<java.lang.String> openapiRequiredFields

Constructor Detail

RankedDocument

public RankedDocument()

Method Detail

index

public RankedDocument index(java.lang.Integer index)

getIndex

@Nonnull
public java.lang.Integer getIndex()

The index of the document

Returns:

index

setIndex

public void setIndex(java.lang.Integer index)

score

public RankedDocument score(java.math.BigDecimal score)

getScore

@Nonnull
public java.math.BigDecimal getScore()

The relevance score of the document normalized between 0 and 1.

Returns:

score

setScore

public void setScore(java.math.BigDecimal score)

document

public RankedDocument document(java.util.Map<java.lang.String,java.lang.String> document)

putDocumentItem

public RankedDocument putDocumentItem(java.lang.String key,
                                      java.lang.String documentItem)

getDocument

@Nullable
public java.util.Map<java.lang.String,java.lang.String> getDocument()

Document for reranking

Returns:

document

setDocument

public void setDocument(java.util.Map<java.lang.String,java.lang.String> document)

putAdditionalProperty

public RankedDocument putAdditionalProperty(java.lang.String key,
                                            java.lang.Object value)

Set the additional (undeclared) property with the specified name and value. If the property does not already exist, create it otherwise replace it.

Parameters:

key - name of the property

value - value of the property

Returns:

the RankedDocument instance itself

getAdditionalProperties

public java.util.Map<java.lang.String,java.lang.Object> getAdditionalProperties()

Return the additional (undeclared) property.

Returns:

a map of objects

getAdditionalProperty

public java.lang.Object getAdditionalProperty(java.lang.String key)

Return the additional (undeclared) property with the specified name.

Parameters:

key - name of the property

Returns:

an object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

validateJsonElement

public static void validateJsonElement(com.google.gson.JsonElement jsonElement)
                                throws java.io.IOException

Validates the JSON Element and throws an exception if issues found

Parameters:

jsonElement - JSON Element

Throws:

java.io.IOException - if the JSON Element is invalid with respect to RankedDocument

fromJson

public static RankedDocument fromJson(java.lang.String jsonString)
                               throws java.io.IOException

Create an instance of RankedDocument given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of RankedDocument

Throws:

java.io.IOException - if the JSON string is invalid with respect to RankedDocument

toJson

public java.lang.String toJson()

Convert an instance of RankedDocument to an JSON string

Returns:

JSON string