To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
A single document to be added to a website's vector search index. Implementations supply the raw text and metadata that the vector search service embeds and indexes. Instances are normally created with an IndexItemBuilder and passed to VectorSearchManager.indexItems.
Extends: Serializable
Properties
| Property | Returns | Description |
|---|---|---|
| content | String | Full text content of the document, indexed and embedded for search matching. |
| id | String | Unique identifier for this document within its index. If blank, the search service assigns a random id. |
| path | String | Path of the document within the website, used to link back to the original item from search results. |
| title | String | Title of the document, indexed and embedded alongside the content for search matching. |
| type | String | Type name identifying what kind of content this document represents. |
| types | List<String> | Asset type tags to record against this document, used to restrict which users can see it in search results. May be null or empty if the document should not be restricted. |
Methods
getId()
Returns: String
Unique identifier for this document within its index. If blank, the search service assigns a random id.
getTitle()
Returns: String
Title of the document, indexed and embedded alongside the content for search matching.
getContent()
Returns: String
Full text content of the document, indexed and embedded for search matching.
getType()
Returns: String
Type name identifying what kind of content this document represents.
getPath()
Returns: String
Path of the document within the website, used to link back to the original item from search results.
getTypes()
Returns: List<String>
Asset type tags to record against this document, used to restrict which users can see it in search results. May be null or empty if the document should not be restricted.
asMap()
Returns: Map<String,Object>
Builds a plain map of this item's title, content, type, path and types, keyed by property name. Used by the search service to assemble the document body sent to the index, before the embedding vectors are added.
© 2025 Kademi Ltd