AppSearchSchema.EmbeddingPropertyConfig

@RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = Features.SCHEMA_EMBEDDING_PROPERTY_CONFIG)
class AppSearchSchema.EmbeddingPropertyConfig : AppSearchSchema.PropertyConfig

kotlin.Any
   ↳ androidx.appsearch.app.AppSearchSchema.PropertyConfig
     ↳ androidx.appsearch.app.AppSearchSchema.EmbeddingPropertyConfig

Configuration for a property of type EmbeddingVector in a Document.

Summary

Nested types

Builder for EmbeddingPropertyConfig.

Constants
const Int

Content in this property will not be indexed.
const Int

Embedding vectors in this property will be indexed.

Public functions
Int

Returns how the property is indexed.

Inherited Constants
From androidx.appsearch.app.AppSearchSchema.PropertyConfig
const Int

Zero or one value [0,1].
const Int

Any number of items (including zero) [0...*].
const Int

Exactly one value [1].

Inherited functions
From androidx.appsearch.app.AppSearchSchema.PropertyConfig
Boolean
equals(other: Any?)
Int

Returns the cardinality of the property (whether it is optional, required or repeated).
String

Returns a natural language description of this property.
String

Returns the name of this property.
Int
String

Constants

INDEXING_TYPE_NONE

Added in 1.1.0-alpha06
const val INDEXING_TYPE_NONE = 0: Int

Content in this property will not be indexed.

INDEXING_TYPE_SIMILARITY

Added in 1.1.0-alpha06
const val INDEXING_TYPE_SIMILARITY = 1: Int

Embedding vectors in this property will be indexed.

The index offers 100% accuracy, but has linear time complexity based on the number of embedding vectors within the index.

Public functions

getIndexingType

Added in 1.1.0-alpha06
fun getIndexingType(): Int

Returns how the property is indexed.