org.openapitools.inference.client.model

Class RerankRequest

java.lang.Object

org.openapitools.inference.client.model.RerankRequest

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

RerankRequest

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RerankRequest.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_DOCUMENTS
static java.lang.String	SERIALIZED_NAME_MODEL
static java.lang.String	SERIALIZED_NAME_PARAMETERS
static java.lang.String	SERIALIZED_NAME_QUERY
static java.lang.String	SERIALIZED_NAME_RANK_FIELDS
static java.lang.String	SERIALIZED_NAME_RETURN_DOCUMENTS
static java.lang.String	SERIALIZED_NAME_TOP_N

Constructor Summary

Constructors

Constructor and Description
RerankRequest()

Method Summary

Modifier and Type	Method and Description
RerankRequest	addDocumentsItem(java.util.Map<java.lang.String,java.lang.String> documentsItem)
RerankRequest	addRankFieldsItem(java.lang.String rankFieldsItem)
RerankRequest	documents(java.util.List<java.util.Map<java.lang.String,java.lang.String>> documents)
boolean	equals(java.lang.Object o)
static RerankRequest	fromJson(java.lang.String jsonString) Create an instance of RerankRequest 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<java.util.Map<java.lang.String,java.lang.String>>	getDocuments() The documents to rerank.
java.lang.String	getModel() The [model](https://docs.pinecone.io/guides/inference/understanding-inference#models) to use for reranking.
java.util.Map<java.lang.String,java.lang.String>	getParameters() Additional model-specific parameters for the reranker.
java.lang.String	getQuery() The query to rerank documents against.
java.util.List<java.lang.String>	getRankFields() The fields to rank the documents by.
java.lang.Boolean	getReturnDocuments() Whether to return the documents in the response.
java.lang.Integer	getTopN() The number of results to return sorted by relevance.
int	hashCode()
RerankRequest	model(java.lang.String model)
RerankRequest	parameters(java.util.Map<java.lang.String,java.lang.String> parameters)
RerankRequest	putAdditionalProperty(java.lang.String key, java.lang.Object value) Set the additional (undeclared) property with the specified name and value.
RerankRequest	putParametersItem(java.lang.String key, java.lang.String parametersItem)
RerankRequest	query(java.lang.String query)
RerankRequest	rankFields(java.util.List<java.lang.String> rankFields)
RerankRequest	returnDocuments(java.lang.Boolean returnDocuments)
void	setDocuments(java.util.List<java.util.Map<java.lang.String,java.lang.String>> documents)
void	setModel(java.lang.String model)
void	setParameters(java.util.Map<java.lang.String,java.lang.String> parameters)
void	setQuery(java.lang.String query)
void	setRankFields(java.util.List<java.lang.String> rankFields)
void	setReturnDocuments(java.lang.Boolean returnDocuments)
void	setTopN(java.lang.Integer topN)
java.lang.String	toJson() Convert an instance of RerankRequest to an JSON string
RerankRequest	topN(java.lang.Integer topN)
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_MODEL

public static final java.lang.String SERIALIZED_NAME_MODEL

See Also:

Constant Field Values

SERIALIZED_NAME_QUERY

public static final java.lang.String SERIALIZED_NAME_QUERY

See Also:

Constant Field Values

SERIALIZED_NAME_TOP_N

public static final java.lang.String SERIALIZED_NAME_TOP_N

See Also:

Constant Field Values

SERIALIZED_NAME_RETURN_DOCUMENTS

public static final java.lang.String SERIALIZED_NAME_RETURN_DOCUMENTS

See Also:

Constant Field Values

SERIALIZED_NAME_RANK_FIELDS

public static final java.lang.String SERIALIZED_NAME_RANK_FIELDS

See Also:

Constant Field Values

SERIALIZED_NAME_DOCUMENTS

public static final java.lang.String SERIALIZED_NAME_DOCUMENTS

See Also:

Constant Field Values

SERIALIZED_NAME_PARAMETERS

public static final java.lang.String SERIALIZED_NAME_PARAMETERS

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

RerankRequest

public RerankRequest()

Method Detail

model

public RerankRequest model(java.lang.String model)

getModel

@Nonnull
public java.lang.String getModel()

The [model](https://docs.pinecone.io/guides/inference/understanding-inference#models) to use for reranking.

Returns:

model

setModel

public void setModel(java.lang.String model)

query

public RerankRequest query(java.lang.String query)

getQuery

@Nonnull
public java.lang.String getQuery()

The query to rerank documents against.

Returns:

query

setQuery

public void setQuery(java.lang.String query)

topN

public RerankRequest topN(java.lang.Integer topN)

getTopN

@Nullable
public java.lang.Integer getTopN()

The number of results to return sorted by relevance. Defaults to the number of inputs.

Returns:

topN

setTopN

public void setTopN(java.lang.Integer topN)

returnDocuments

public RerankRequest returnDocuments(java.lang.Boolean returnDocuments)

getReturnDocuments

@Nullable
public java.lang.Boolean getReturnDocuments()

Whether to return the documents in the response.

Returns:

returnDocuments

setReturnDocuments

public void setReturnDocuments(java.lang.Boolean returnDocuments)

rankFields

public RerankRequest rankFields(java.util.List<java.lang.String> rankFields)

addRankFieldsItem

public RerankRequest addRankFieldsItem(java.lang.String rankFieldsItem)

getRankFields

@Nullable
public java.util.List<java.lang.String> getRankFields()

The fields to rank the documents by. If not provided, the default is `\"text\"`.

Returns:

rankFields

setRankFields

public void setRankFields(java.util.List<java.lang.String> rankFields)

documents

public RerankRequest documents(java.util.List<java.util.Map<java.lang.String,java.lang.String>> documents)

addDocumentsItem

public RerankRequest addDocumentsItem(java.util.Map<java.lang.String,java.lang.String> documentsItem)

getDocuments

@Nonnull
public java.util.List<java.util.Map<java.lang.String,java.lang.String>> getDocuments()

The documents to rerank.

Returns:

documents

setDocuments

public void setDocuments(java.util.List<java.util.Map<java.lang.String,java.lang.String>> documents)

parameters

public RerankRequest parameters(java.util.Map<java.lang.String,java.lang.String> parameters)

putParametersItem

public RerankRequest putParametersItem(java.lang.String key,
                                       java.lang.String parametersItem)

getParameters

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

Additional model-specific parameters for the reranker.

Returns:

parameters

setParameters

public void setParameters(java.util.Map<java.lang.String,java.lang.String> parameters)

putAdditionalProperty

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

fromJson

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

Create an instance of RerankRequest given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of RerankRequest

Throws:

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

toJson

public java.lang.String toJson()

Convert an instance of RerankRequest to an JSON string

Returns:

JSON string