org.openapitools.inference.client.model

Class RerankResult

java.lang.Object

org.openapitools.inference.client.model.RerankResult

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

The result of a reranking request.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RerankResult.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_DATA
static java.lang.String	SERIALIZED_NAME_MODEL
static java.lang.String	SERIALIZED_NAME_USAGE

Constructor Summary

Constructors

Constructor and Description
RerankResult()

Method Summary

Modifier and Type	Method and Description
RerankResult	addDataItem(RankedDocument dataItem)
RerankResult	data(java.util.List<RankedDocument> data)
boolean	equals(java.lang.Object o)
static RerankResult	fromJson(java.lang.String jsonString) Create an instance of RerankResult 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.List<RankedDocument>	getData() The reranked documents.
java.lang.String	getModel() The model used to rerank documents.
RerankResultUsage	getUsage() Get usage
int	hashCode()
RerankResult	model(java.lang.String model)
RerankResult	putAdditionalProperty(java.lang.String key, java.lang.Object value) Set the additional (undeclared) property with the specified name and value.
void	setData(java.util.List<RankedDocument> data)
void	setModel(java.lang.String model)
void	setUsage(RerankResultUsage usage)
java.lang.String	toJson() Convert an instance of RerankResult to an JSON string
java.lang.String	toString()
RerankResult	usage(RerankResultUsage usage)
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_MODEL

public static final java.lang.String SERIALIZED_NAME_MODEL

See Also:

Constant Field Values

SERIALIZED_NAME_DATA

public static final java.lang.String SERIALIZED_NAME_DATA

See Also:

Constant Field Values

SERIALIZED_NAME_USAGE

public static final java.lang.String SERIALIZED_NAME_USAGE

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

RerankResult

public RerankResult()

Method Detail

model

public RerankResult model(java.lang.String model)

getModel

@Nonnull
public java.lang.String getModel()

The model used to rerank documents.

Returns:

model

setModel

public void setModel(java.lang.String model)

data

public RerankResult data(java.util.List<RankedDocument> data)

addDataItem

public RerankResult addDataItem(RankedDocument dataItem)

getData

@Nonnull
public java.util.List<RankedDocument> getData()

The reranked documents.

Returns:

data

setData

public void setData(java.util.List<RankedDocument> data)

usage

public RerankResult usage(RerankResultUsage usage)

getUsage

@Nonnull
public RerankResultUsage getUsage()

Get usage

Returns:

usage

setUsage

public void setUsage(RerankResultUsage usage)

putAdditionalProperty

public RerankResult 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 RerankResult 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 RerankResult

fromJson

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

Create an instance of RerankResult given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of RerankResult

Throws:

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

toJson

public java.lang.String toJson()

Convert an instance of RerankResult to an JSON string

Returns:

JSON string