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 Type	Method	Description
RagSearchResult._FinalStage	additionalProperties(Map<String,Object> additionalProperties)
RagSearchResult._FinalStage	additionalProperty(String key, Object value)
RagSearchResult	build()
RagSearchResult._FinalStage	chunkText(String chunkText)
RagSearchResult._FinalStage	chunkText(Optional<String> chunkText)	The specific chunk of text that matched the query — the narrowest snippet, useful for citation.
RagSearchResult._FinalStage	contextText(String contextText)
RagSearchResult._FinalStage	contextText(Optional<String> contextText)	The wider surrounding passage supplied to the model as context — broader than chunkText to better ground the answer.
RagSearchResult._FinalStage	createdAt(OffsetDateTime createdAt)
RagSearchResult._FinalStage	createdAt(Optional<OffsetDateTime> createdAt)	The result's creation timestamp, as an ISO-8601 UTC timestamp.
RagSearchResult._FinalStage	externalId(String externalId)
RagSearchResult._FinalStage	externalId(Optional<String> externalId)	The externalId you supplied for the source item at ingestion, if any.
RagSearchResult._FinalStage	metadata(Map<String,Object> metadata)
RagSearchResult._FinalStage	metadata(Optional<Map<String,Object>> metadata)	Metadata you supplied on the source document, such as its title, folder id, or custom tags.
RagSearchResult._FinalStage	semanticScore(Double semanticScore)
RagSearchResult._FinalStage	semanticScore(Optional<Double> semanticScore)	The cosine-similarity score from semantic (vector) search, from 0 to 1. 0 (not null) when this match came from keyword search only.
RagSearchResult._FinalStage	snippet(String snippet)
RagSearchResult._FinalStage	snippet(Optional<String> snippet)	A display-ready snippet with the matched query terms emphasized — suitable for search-result UIs.
RagSearchResult._FinalStage	textScore(Double textScore)
RagSearchResult._FinalStage	textScore(Optional<Double> textScore)	The keyword relevance component of the score.

Method Details

build

RagSearchResult build()

additionalProperty

RagSearchResult._FinalStage additionalProperty(String key,
 Object value)

additionalProperties

RagSearchResult._FinalStage additionalProperties(Map<String,Object> additionalProperties)

externalId

RagSearchResult._FinalStage externalId(Optional<String> externalId)

The externalId you supplied for the source item at ingestion, if any. Null when the item was ingested without one, or when it was indexed before this field existed and hasn't been updated or reindexed since.

externalId

RagSearchResult._FinalStage externalId(String externalId)

textScore

RagSearchResult._FinalStage textScore(Optional<Double> textScore)

The keyword relevance component of the score. Non-zero in HYBRID mode when the keyword engine contributes to the match, and in TEXT mode. In TEXT mode this is a rank-derived value reflecting the result's relative position, not a normalized BM25 magnitude — meaningful for ordering within this response, not comparable across requests or against HYBRID/SEMANTIC scores. 0 (not null) when this match came from semantic search only.

textScore

RagSearchResult._FinalStage textScore(Double textScore)

semanticScore

RagSearchResult._FinalStage semanticScore(Optional<Double> semanticScore)

The cosine-similarity score from semantic (vector) search, from 0 to 1. 0 (not null) when this match came from keyword search only.

semanticScore

RagSearchResult._FinalStage semanticScore(Double semanticScore)

chunkText

RagSearchResult._FinalStage chunkText(Optional<String> chunkText)

The specific chunk of text that matched the query — the narrowest snippet, useful for citation.

chunkText

RagSearchResult._FinalStage chunkText(String chunkText)

contextText

RagSearchResult._FinalStage contextText(Optional<String> contextText)

The wider surrounding passage supplied to the model as context — broader than chunkText to better ground the answer.

contextText

RagSearchResult._FinalStage contextText(String contextText)

snippet

RagSearchResult._FinalStage snippet(Optional<String> snippet)

A display-ready snippet with the matched query terms emphasized — suitable for search-result UIs.

snippet

RagSearchResult._FinalStage snippet(String snippet)

metadata

RagSearchResult._FinalStage metadata(Optional<Map<String,Object>> metadata)

Metadata you supplied on the source document, such as its title, folder id, or custom tags.

metadata

RagSearchResult._FinalStage metadata(Map<String,Object> metadata)

createdAt

RagSearchResult._FinalStage createdAt(Optional<OffsetDateTime> createdAt)

The result's creation timestamp, as an ISO-8601 UTC timestamp.

createdAt

RagSearchResult._FinalStage createdAt(OffsetDateTime createdAt)