Package org.openapitools.client.model

Class RecommendChunksRequest

java.lang.Object

org.openapitools.client.model.RecommendChunksRequest

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-03-29T12:34:27.506198300-05:00[America/Chicago]",
           comments="Generator version: 7.4.0")
public class RecommendChunksRequest
extends Object

RecommendChunksRequest

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RecommendChunksRequest.CustomTypeAdapterFactory

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static String	SERIALIZED_NAME_FILTERS
static String	SERIALIZED_NAME_LIMIT
static String	SERIALIZED_NAME_NEGATIVE_CHUNK_IDS
static String	SERIALIZED_NAME_NEGATIVE_TRACKING_IDS
static String	SERIALIZED_NAME_POSITIVE_CHUNK_IDS
static String	SERIALIZED_NAME_POSITIVE_TRACKING_IDS

Constructor Summary

Constructors

Constructor	Description
RecommendChunksRequest()

Method Summary

Modifier and Type	Method	Description
RecommendChunksRequest	addNegativeChunkIdsItem(UUID negativeChunkIdsItem)
RecommendChunksRequest	addNegativeTrackingIdsItem(String negativeTrackingIdsItem)
RecommendChunksRequest	addPositiveChunkIdsItem(UUID positiveChunkIdsItem)
RecommendChunksRequest	addPositiveTrackingIdsItem(String positiveTrackingIdsItem)
boolean	equals(Object o)
RecommendChunksRequest	filters(ChunkFilter filters)
static RecommendChunksRequest	fromJson(String jsonString)	Create an instance of RecommendChunksRequest given an JSON string
@Valid ChunkFilter	getFilters()	Get filters
@Min(0L) Long	getLimit()	The number of chunks to return.
@Valid List<UUID>	getNegativeChunkIds()	The ids of the chunks to be used as negative examples for the recommendation.
List<String>	getNegativeTrackingIds()	The tracking_ids of the chunks to be used as negative examples for the recommendation.
@Valid List<UUID>	getPositiveChunkIds()	The ids of the chunks to be used as positive examples for the recommendation.
List<String>	getPositiveTrackingIds()	The tracking_ids of the chunks to be used as positive examples for the recommendation.
int	hashCode()
RecommendChunksRequest	limit(Long limit)
RecommendChunksRequest	negativeChunkIds(List<UUID> negativeChunkIds)
RecommendChunksRequest	negativeTrackingIds(List<String> negativeTrackingIds)
RecommendChunksRequest	positiveChunkIds(List<UUID> positiveChunkIds)
RecommendChunksRequest	positiveTrackingIds(List<String> positiveTrackingIds)
void	setFilters(ChunkFilter filters)
void	setLimit(Long limit)
void	setNegativeChunkIds(List<UUID> negativeChunkIds)
void	setNegativeTrackingIds(List<String> negativeTrackingIds)
void	setPositiveChunkIds(List<UUID> positiveChunkIds)
void	setPositiveTrackingIds(List<String> positiveTrackingIds)
String	toJson()	Convert an instance of RecommendChunksRequest to an JSON string
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_FILTERS

public static final String SERIALIZED_NAME_FILTERS

See Also:

Constant Field Values

SERIALIZED_NAME_LIMIT

public static final String SERIALIZED_NAME_LIMIT

See Also:

Constant Field Values

SERIALIZED_NAME_NEGATIVE_CHUNK_IDS

public static final String SERIALIZED_NAME_NEGATIVE_CHUNK_IDS

See Also:

Constant Field Values

SERIALIZED_NAME_NEGATIVE_TRACKING_IDS

public static final String SERIALIZED_NAME_NEGATIVE_TRACKING_IDS

See Also:

Constant Field Values

SERIALIZED_NAME_POSITIVE_CHUNK_IDS

public static final String SERIALIZED_NAME_POSITIVE_CHUNK_IDS

See Also:

Constant Field Values

SERIALIZED_NAME_POSITIVE_TRACKING_IDS

public static final String SERIALIZED_NAME_POSITIVE_TRACKING_IDS

See Also:

Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Detail

RecommendChunksRequest

public RecommendChunksRequest()

Method Detail

filters

public RecommendChunksRequest filters(ChunkFilter filters)

getFilters

@Nullable
@Valid
public @Valid ChunkFilter getFilters()

Get filters

Returns:

filters

setFilters

public void setFilters(ChunkFilter filters)

limit

public RecommendChunksRequest limit(Long limit)

getLimit

@Nullable
@Min(0L)
public @Min(0L) Long getLimit()

The number of chunks to return. This is the number of chunks which will be returned in the response. The default is 10. minimum: 0

Returns:

limit

setLimit

public void setLimit(Long limit)

negativeChunkIds

public RecommendChunksRequest negativeChunkIds(List<UUID> negativeChunkIds)

addNegativeChunkIdsItem

public RecommendChunksRequest addNegativeChunkIdsItem(UUID negativeChunkIdsItem)

getNegativeChunkIds

@Nullable
@Valid
public @Valid List<UUID> getNegativeChunkIds()

The ids of the chunks to be used as negative examples for the recommendation. The chunks in this array will be used to filter out similar chunks.

Returns:

negativeChunkIds

setNegativeChunkIds

public void setNegativeChunkIds(List<UUID> negativeChunkIds)

negativeTrackingIds

public RecommendChunksRequest negativeTrackingIds(List<String> negativeTrackingIds)

addNegativeTrackingIdsItem

public RecommendChunksRequest addNegativeTrackingIdsItem(String negativeTrackingIdsItem)

getNegativeTrackingIds

@Nullable
public List<String> getNegativeTrackingIds()

The tracking_ids of the chunks to be used as negative examples for the recommendation. The chunks in this array will be used to filter out similar chunks.

Returns:

negativeTrackingIds

setNegativeTrackingIds

public void setNegativeTrackingIds(List<String> negativeTrackingIds)

positiveChunkIds

public RecommendChunksRequest positiveChunkIds(List<UUID> positiveChunkIds)

addPositiveChunkIdsItem

public RecommendChunksRequest addPositiveChunkIdsItem(UUID positiveChunkIdsItem)

getPositiveChunkIds

@Nullable
@Valid
public @Valid List<UUID> getPositiveChunkIds()

The ids of the chunks to be used as positive examples for the recommendation. The chunks in this array will be used to find similar chunks.

Returns:

positiveChunkIds

setPositiveChunkIds

public void setPositiveChunkIds(List<UUID> positiveChunkIds)

positiveTrackingIds

public RecommendChunksRequest positiveTrackingIds(List<String> positiveTrackingIds)

addPositiveTrackingIdsItem

public RecommendChunksRequest addPositiveTrackingIdsItem(String positiveTrackingIdsItem)

getPositiveTrackingIds

@Nullable
public List<String> getPositiveTrackingIds()

The tracking_ids of the chunks to be used as positive examples for the recommendation. The chunks in this array will be used to find similar chunks.

Returns:

positiveTrackingIds

setPositiveTrackingIds

public void setPositiveTrackingIds(List<String> positiveTrackingIds)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

validateJsonElement

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

Validates the JSON Element and throws an exception if issues found

Parameters:

jsonElement - JSON Element

Throws:

IOException - if the JSON Element is invalid with respect to RecommendChunksRequest

fromJson

public static RecommendChunksRequest fromJson(String jsonString)
                                       throws IOException

Create an instance of RecommendChunksRequest given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of RecommendChunksRequest

Throws:

IOException - if the JSON string is invalid with respect to RecommendChunksRequest

toJson

public String toJson()

Convert an instance of RecommendChunksRequest to an JSON string

Returns:

JSON string