org.openapitools.db_data.client.model

Class ScoredVector

java.lang.Object

org.openapitools.db_data.client.model.ScoredVector

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

ScoredVector

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScoredVector.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_ID
static java.lang.String	SERIALIZED_NAME_METADATA
static java.lang.String	SERIALIZED_NAME_SCORE
static java.lang.String	SERIALIZED_NAME_SPARSE_VALUES
static java.lang.String	SERIALIZED_NAME_VALUES

Constructor Summary

Constructors

Constructor and Description
ScoredVector()

Method Summary

Modifier and Type	Method and Description
ScoredVector	addValuesItem(java.lang.Float valuesItem)
boolean	equals(java.lang.Object o)
static ScoredVector	fromJson(java.lang.String jsonString) Create an instance of ScoredVector 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.lang.String	getId() This is the vector's unique id.
java.lang.Object	getMetadata() This is the metadata, if it is requested.
java.lang.Float	getScore() This is a measure of similarity between this vector and the query vector.
SparseValues	getSparseValues() Get sparseValues
java.util.List<java.lang.Float>	getValues() This is the vector data, if it is requested.
int	hashCode()
ScoredVector	id(java.lang.String id)
ScoredVector	metadata(java.lang.Object metadata)
ScoredVector	putAdditionalProperty(java.lang.String key, java.lang.Object value) Set the additional (undeclared) property with the specified name and value.
ScoredVector	score(java.lang.Float score)
void	setId(java.lang.String id)
void	setMetadata(java.lang.Object metadata)
void	setScore(java.lang.Float score)
void	setSparseValues(SparseValues sparseValues)
void	setValues(java.util.List<java.lang.Float> values)
ScoredVector	sparseValues(SparseValues sparseValues)
java.lang.String	toJson() Convert an instance of ScoredVector 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
ScoredVector	values(java.util.List<java.lang.Float> values)

Methods inherited from class java.lang.Object

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

Field Detail

SERIALIZED_NAME_ID

public static final java.lang.String SERIALIZED_NAME_ID

See Also:

Constant Field Values

SERIALIZED_NAME_SCORE

public static final java.lang.String SERIALIZED_NAME_SCORE

See Also:

Constant Field Values

SERIALIZED_NAME_VALUES

public static final java.lang.String SERIALIZED_NAME_VALUES

See Also:

Constant Field Values

SERIALIZED_NAME_SPARSE_VALUES

public static final java.lang.String SERIALIZED_NAME_SPARSE_VALUES

See Also:

Constant Field Values

SERIALIZED_NAME_METADATA

public static final java.lang.String SERIALIZED_NAME_METADATA

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

ScoredVector

public ScoredVector()

Method Detail

id

public ScoredVector id(java.lang.String id)

getId

@Nonnull
public java.lang.String getId()

This is the vector's unique id.

Returns:

id

setId

public void setId(java.lang.String id)

score

public ScoredVector score(java.lang.Float score)

getScore

@Nullable
public java.lang.Float getScore()

This is a measure of similarity between this vector and the query vector. The higher the score, the more they are similar.

Returns:

score

setScore

public void setScore(java.lang.Float score)

values

public ScoredVector values(java.util.List<java.lang.Float> values)

addValuesItem

public ScoredVector addValuesItem(java.lang.Float valuesItem)

getValues

@Nullable
public java.util.List<java.lang.Float> getValues()

This is the vector data, if it is requested.

Returns:

values

setValues

public void setValues(java.util.List<java.lang.Float> values)

sparseValues

public ScoredVector sparseValues(SparseValues sparseValues)

getSparseValues

@Nullable
public SparseValues getSparseValues()

Get sparseValues

Returns:

sparseValues

setSparseValues

public void setSparseValues(SparseValues sparseValues)

metadata

public ScoredVector metadata(java.lang.Object metadata)

getMetadata

@Nullable
public java.lang.Object getMetadata()

This is the metadata, if it is requested.

Returns:

metadata

setMetadata

public void setMetadata(java.lang.Object metadata)

putAdditionalProperty

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

fromJson

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

Create an instance of ScoredVector given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of ScoredVector

Throws:

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

toJson

public java.lang.String toJson()

Convert an instance of ScoredVector to an JSON string

Returns:

JSON string