Class CosineSimilarity
java.lang.Object
org.apache.avro.specific.SpecificRecordBase
com.linkedin.venice.compute.protocol.request.CosineSimilarity
- All Implemented Interfaces:
Externalizable,Serializable,Comparable<org.apache.avro.specific.SpecificRecord>,org.apache.avro.generic.GenericContainer,org.apache.avro.generic.GenericRecord,org.apache.avro.generic.IndexedRecord,org.apache.avro.specific.SpecificRecord
public class CosineSimilarity
extends org.apache.avro.specific.SpecificRecordBase
implements org.apache.avro.specific.SpecificRecord
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionThe passed feature vector, which will be used to execute cosine-similarity calculation against the field in the original value recordThe field in the original value record, which will used to execute cosine-similarity calculationThe field name used to store the calculated resultstatic final org.apache.avro.Schema -
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor.CosineSimilarity(CharSequence field, List<Float> cosSimilarityParam, CharSequence resultFieldName) All-args constructor. -
Method Summary
Modifier and TypeMethodDescriptionget(int field$) static org.apache.avro.SchemaGets the value of the 'cosSimilarityParam' field.getField()Gets the value of the 'field' field.Gets the value of the 'resultFieldName' field.org.apache.avro.Schemaorg.apache.avro.specific.SpecificDatavoidvoidvoidsetCosSimilarityParam(List<Float> value) Sets the value of the 'cosSimilarityParam' field.voidsetField(CharSequence value) Sets the value of the 'field' field.voidsetResultFieldName(CharSequence value) Sets the value of the 'resultFieldName' field.voidMethods inherited from class org.apache.avro.specific.SpecificRecordBase
compareTo, customDecode, customEncode, equals, get, getConversion, getConversion, hasCustomCoders, hashCode, put, toStringMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.avro.generic.GenericRecord
hasField
-
Field Details
-
SCHEMA$
public static final org.apache.avro.Schema SCHEMA$ -
field
The field in the original value record, which will used to execute cosine-similarity calculation -
cosSimilarityParam
The passed feature vector, which will be used to execute cosine-similarity calculation against the field in the original value record -
resultFieldName
The field name used to store the calculated result
-
-
Constructor Details
-
CosineSimilarity
public CosineSimilarity()Default constructor. Note that this does not initialize fields to their default values from the schema. If that is desired then one should usenewBuilder(). -
CosineSimilarity
public CosineSimilarity(CharSequence field, List<Float> cosSimilarityParam, CharSequence resultFieldName) All-args constructor.- Parameters:
field- The field in the original value record, which will used to execute cosine-similarity calculationcosSimilarityParam- The passed feature vector, which will be used to execute cosine-similarity calculation against the field in the original value recordresultFieldName- The field name used to store the calculated result
-
-
Method Details
-
getClassSchema
public static org.apache.avro.Schema getClassSchema() -
getSpecificData
public org.apache.avro.specific.SpecificData getSpecificData()- Overrides:
getSpecificDatain classorg.apache.avro.specific.SpecificRecordBase
-
getSchema
public org.apache.avro.Schema getSchema()- Specified by:
getSchemain interfaceorg.apache.avro.generic.GenericContainer- Specified by:
getSchemain classorg.apache.avro.specific.SpecificRecordBase
-
get
- Specified by:
getin interfaceorg.apache.avro.generic.IndexedRecord- Specified by:
getin classorg.apache.avro.specific.SpecificRecordBase
-
put
- Specified by:
putin interfaceorg.apache.avro.generic.IndexedRecord- Specified by:
putin classorg.apache.avro.specific.SpecificRecordBase
-
getField
Gets the value of the 'field' field.- Returns:
- The field in the original value record, which will used to execute cosine-similarity calculation
-
setField
Sets the value of the 'field' field. The field in the original value record, which will used to execute cosine-similarity calculation- Parameters:
value- the value to set.
-
getCosSimilarityParam
Gets the value of the 'cosSimilarityParam' field.- Returns:
- The passed feature vector, which will be used to execute cosine-similarity calculation against the field in the original value record
-
setCosSimilarityParam
Sets the value of the 'cosSimilarityParam' field. The passed feature vector, which will be used to execute cosine-similarity calculation against the field in the original value record- Parameters:
value- the value to set.
-
getResultFieldName
Gets the value of the 'resultFieldName' field.- Returns:
- The field name used to store the calculated result
-
setResultFieldName
Sets the value of the 'resultFieldName' field. The field name used to store the calculated result- Parameters:
value- the value to set.
-
writeExternal
- Specified by:
writeExternalin interfaceExternalizable- Overrides:
writeExternalin classorg.apache.avro.specific.SpecificRecordBase- Throws:
IOException
-
readExternal
- Specified by:
readExternalin interfaceExternalizable- Overrides:
readExternalin classorg.apache.avro.specific.SpecificRecordBase- Throws:
IOException
-