===================================================================== # GenericFeatureVector Last tag used: 23

Attributes

• classLabel (type: String.t, default: nil) - The class label of this datapoint. This should be populated if ScaM is being used for nearest-neighbor-based classification.
• crowding (type: GoogleApi.ContentWarehouse.V1.Model.ResearchScamGenericFeatureVectorCrowding.t, default: nil) -
• dataIdStr (type: String.t, default: nil) - Optional point id that can contain an arbitrary (unrestricted in content) value except when the data is provided via SSTable (sharded or not). In the case of SSTable the dataid_str must be set for _all points in all shards or the SSTable keys will be used as the values for the data_id_str of the respective points. In either SSTable case--data_id_str provided explicitly or via the key--the values must be unique across all shards.
• expirationTimestamp (type: DateTime.t, default: nil) - A timestamp after which this datapoint is considered no longer valid and is eligible for deletion. The exact meaning varies with application/configuration.
• featureDim (type: String.t, default: nil) - - Optionally explicitly specifies the dimensionality of this vector. For dense vectors, this is ignored and, dimensionality is inferred from the number of values specified, and must be identical to this, or unspecified. For sparse vectors, the default value is correct for most users, and allows use of 64-bit hash values for feature indices. If you're using sparse vectors with a limited range of dimension indices and want to do K-Means clustering with them, you may want to specify this explicitly.
• featureIndex (type: list(String.t), default: nil) - - for SPARSE vectors, specifies indices of the nonzero dimensions whose values are specified by the , , or field. This field is not used when specifying dense vectors.
• featureType (type: String.t, default: nil) - Describes the type of feature values.
• featureValueDouble (type: list(float()), default: nil) -
• featureValueFloat (type: list(number()), default: nil) - Actual feature vector. Only one of the following should be populated. This list has to be kept in sync with FeatureType enum. NOTES: Binary features are stored as ones or zeroes in feature_value_int64. Floating point values (feature_value_float, feature_value_double) may not be NaN.
• featureValueInt64 (type: list(String.t), default: nil) -
• featureValueString (type: String.t, default: nil) -
• fixedPointMetadata (type: GoogleApi.ContentWarehouse.V1.Model.ResearchScamGenericFeatureVectorFixedPointMetadata.t, default: nil) -
• internalOnlyIsSecondaryPartition (type: boolean(), default: nil) - copybara:strip_begin INTERNAL USE ONLY! The ScaM Team reserves the right to remove this field and reuse its proto tag without notice. DO NOT USE outside of build_shards_pipeline! This field is used inside build_shards_pipeline to indicate whether this GFV is residing in its secondary (vs. primary) partition. copybara:strip_end
• normType (type: String.t, default: nil) - Describes if data has been normalized and the type.
• queryMetadata (type: GoogleApi.ContentWarehouse.V1.Model.ResearchScamQueryMetadata.t, default: nil) - copybara:strip_begin A field that contains metadata information when the datapoint is acting as a query. copybara:strip_end
• restrictTokens (type: GoogleApi.ContentWarehouse.V1.Model.ResearchScamGenericFeatureVectorRestrictTokens.t, default: nil) - copybara:strip_end_and_replace reserved 15;
• tokens (type: list(integer()), default: nil) -
• userinfo (type: String.t, default: nil) - This field allows application-specific metadata to be stored in a GFV. This information may be used by custom binaries or in pre- or postprocessing outside of ScaM. Use cases include but are not limited to: Dataset IDs, if multiple datasets are multiplexed into one physical file or network location. An alternative, possibly more human-readable representation of the data represented by this GFV, for e.g. debugging purposes. * Outputting the contents of this field verbatim to the metadata field of the NearestNeighbors.Neighbor proto.
• weight (type: number(), default: nil) - DEPRECATED fields. Ignored by ScaM binaries. Do not use.