To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
A single matching document returned by a vector search, with its relevance score and highlighted paragraphs. Instances are built by the vector search service from the underlying index hits and collected into a VectorSearchResult. A document may carry a list of type tags used to filter which results a caller is allowed to see, and a set of ParagraphItem highlights showing the matching passages within its content.
Implements: Serializable
Properties
| Property | Returns | Description |
|---|---|---|
| content | String | Full text content of the matching document, as it was originally indexed. |
| id | String | Unique identifier of the underlying document, as assigned by the index. |
| paragraphs | List<ParagraphItem> | Highlighted content fragments showing where the search terms matched within this document. Empty until paragraphs are added by the search service. |
| path | String | Path of the document within the website, used to link back to the original item. |
| score | Double | Relevance score assigned to this document by the search engine, higher meaning a closer match. May be null if the underlying search does not report a score. |
| title | String | Title of the matching document, as it was originally indexed. |
| type | String | Type name of the document, identifying which kind of content this item represents. |
| types | List<String> | Asset type tags recorded against the document, used to restrict which users can see it in results. May be null or empty if the document is not restricted. |
Methods
getId()
Returns: String
Unique identifier of the underlying document, as assigned by the index.
getTitle()
Returns: String
Title of the matching document, as it was originally indexed.
getContent()
Returns: String
Full text content of the matching document, as it was originally indexed.
getPath()
Returns: String
Path of the document within the website, used to link back to the original item.
getType()
Returns: String
Type name of the document, identifying which kind of content this item represents.
getTypes()
Returns: List<String>
Asset type tags recorded against the document, used to restrict which users can see it in results. May be null or empty if the document is not restricted.
getScore()
Returns: Double
Relevance score assigned to this document by the search engine, higher meaning a closer match. May be null if the underlying search does not report a score.
getParagraphs()
Returns: List<ParagraphItem>
Highlighted content fragments showing where the search terms matched within this document. Empty until paragraphs are added by the search service.
© 2025 Kademi Ltd