Package ai.vectros.types
Interface RagSearchResult._FinalStage
- All Known Implementing Classes:
RagSearchResult.Builder
- Enclosing class:
RagSearchResult
public static interface RagSearchResult._FinalStage
-
Method Summary
Modifier and TypeMethodDescriptionadditionalProperties(Map<String, Object> additionalProperties) additionalProperty(String key, Object value) build()The specific chunk of text that matched the query — the narrowest snippet, useful for citation.contextText(String contextText) contextText(Optional<String> contextText) The wider surrounding passage supplied to the model as context — broader thanchunkTextto better ground the answer.createdAt(OffsetDateTime createdAt) createdAt(Optional<OffsetDateTime> createdAt) The result's creation timestamp, as an ISO-8601 UTC timestamp.Metadata you supplied on the source document, such as its title, folder id, or custom tags.semanticScore(Double semanticScore) semanticScore(Optional<Double> semanticScore) The cosine-similarity score from semantic (vector) search, from 0 to 1.A display-ready snippet with the matched query terms emphasized — suitable for search-result UIs.The keyword (BM25) relevance score, from 0 to 1.
-
Method Details
-
build
RagSearchResult build() -
additionalProperty
-
additionalProperties
-
textScore
The keyword (BM25) relevance score, from 0 to 1. Null when this match came from semantic search only.
-
textScore
-
semanticScore
The cosine-similarity score from semantic (vector) search, from 0 to 1. Null when this match came from keyword search only.
-
semanticScore
-
chunkText
The specific chunk of text that matched the query — the narrowest snippet, useful for citation.
-
chunkText
-
contextText
The wider surrounding passage supplied to the model as context — broader than
chunkTextto better ground the answer. -
contextText
-
snippet
A display-ready snippet with the matched query terms emphasized — suitable for search-result UIs.
-
snippet
-
metadata
Metadata you supplied on the source document, such as its title, folder id, or custom tags.
-
metadata
-
createdAt
The result's creation timestamp, as an ISO-8601 UTC timestamp.
-
createdAt
-