Package ai.vectros.types

Class RagSearchResult.Builder

java.lang.Object

ai.vectros.types.RagSearchResult.Builder

All Implemented Interfaces:

RagSearchResult._FinalStage, RagSearchResult.DocumentIdStage, RagSearchResult.ScoreStage

Enclosing class:

RagSearchResult

public static final class RagSearchResult.Builder
extends Object
implements RagSearchResult.DocumentIdStage, RagSearchResult.ScoreStage, RagSearchResult._FinalStage

Method Summary

Modifier and Type	Method	Description
RagSearchResult.Builder	additionalProperties(Map<String,Object> additionalProperties)
RagSearchResult.Builder	additionalProperty(String key, Object value)
RagSearchResult	build()
RagSearchResult._FinalStage	chunkText(String chunkText)	The specific chunk of text that matched the query — the narrowest snippet, useful for citation.
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)	The wider surrounding passage supplied to the model as context — broader than chunkText to better ground the answer.
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)	The result's creation timestamp, as an ISO-8601 UTC timestamp.
RagSearchResult._FinalStage	createdAt(Optional<OffsetDateTime> createdAt)	The result's creation timestamp, as an ISO-8601 UTC timestamp.
RagSearchResult.ScoreStage	documentId(@NotNull String documentId)	The stable identifier of the matched result (a document or a record).
RagSearchResult.Builder	from(RagSearchResult other)
RagSearchResult._FinalStage	metadata(Map<String,Object> metadata)	Metadata you supplied on the source document, such as its title, folder id, or custom tags.
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	score(double score)	The combined relevance score from hybrid ranking.
RagSearchResult._FinalStage	semanticScore(Double semanticScore)	The cosine-similarity score from semantic (vector) search, from 0 to 1.
RagSearchResult._FinalStage	semanticScore(Optional<Double> semanticScore)	The cosine-similarity score from semantic (vector) search, from 0 to 1.
RagSearchResult._FinalStage	snippet(String snippet)	A display-ready snippet with the matched query terms emphasized — suitable for search-result UIs.
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)	The keyword (BM25) relevance score, from 0 to 1.
RagSearchResult._FinalStage	textScore(Optional<Double> textScore)	The keyword (BM25) relevance score, from 0 to 1.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

from

public RagSearchResult.Builder from(RagSearchResult other)

Specified by:

from in interface RagSearchResult.DocumentIdStage

documentId

public RagSearchResult.ScoreStage documentId(@NotNull
 @NotNull String documentId)

The stable identifier of the matched result (a document or a record).

The stable identifier of the matched result (a document or a record).

Specified by:

documentId in interface RagSearchResult.DocumentIdStage

Returns:

Reference to this so that method calls can be chained together.

score

public RagSearchResult._FinalStage score(double score)

The combined relevance score from hybrid ranking. Higher is more relevant.

The combined relevance score from hybrid ranking. Higher is more relevant.

Specified by:

score in interface RagSearchResult.ScoreStage

Returns:

Reference to this so that method calls can be chained together.

createdAt

public RagSearchResult._FinalStage createdAt(OffsetDateTime createdAt)

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

Specified by:

createdAt in interface RagSearchResult._FinalStage

Returns:

Reference to this so that method calls can be chained together.

createdAt

public RagSearchResult._FinalStage createdAt(Optional<OffsetDateTime> createdAt)

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

Specified by:

createdAt in interface RagSearchResult._FinalStage

metadata

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

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

Specified by:

metadata in interface RagSearchResult._FinalStage

Returns:

Reference to this so that method calls can be chained together.

metadata

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

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

Specified by:

metadata in interface RagSearchResult._FinalStage

snippet

public RagSearchResult._FinalStage snippet(String snippet)

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

Specified by:

snippet in interface RagSearchResult._FinalStage

Returns:

Reference to this so that method calls can be chained together.

snippet

public RagSearchResult._FinalStage snippet(Optional<String> snippet)

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

Specified by:

snippet in interface RagSearchResult._FinalStage

contextText

public RagSearchResult._FinalStage contextText(String contextText)

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

Specified by:

contextText in interface RagSearchResult._FinalStage

Returns:

Reference to this so that method calls can be chained together.

contextText

public RagSearchResult._FinalStage contextText(Optional<String> contextText)

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

Specified by:

contextText in interface RagSearchResult._FinalStage

chunkText

public RagSearchResult._FinalStage chunkText(String chunkText)

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

Specified by:

chunkText in interface RagSearchResult._FinalStage

Returns:

Reference to this so that method calls can be chained together.

chunkText

public RagSearchResult._FinalStage chunkText(Optional<String> chunkText)

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

Specified by:

chunkText in interface RagSearchResult._FinalStage

semanticScore

public RagSearchResult._FinalStage semanticScore(Double semanticScore)

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

Specified by:

semanticScore in interface RagSearchResult._FinalStage

Returns:

Reference to this so that method calls can be chained together.

semanticScore

public RagSearchResult._FinalStage semanticScore(Optional<Double> semanticScore)

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

Specified by:

semanticScore in interface RagSearchResult._FinalStage

textScore

public RagSearchResult._FinalStage textScore(Double textScore)

The keyword (BM25) relevance score, from 0 to 1. Null when this match came from semantic search only.

Specified by:

textScore in interface RagSearchResult._FinalStage

Returns:

Reference to this so that method calls can be chained together.

textScore

public RagSearchResult._FinalStage textScore(Optional<Double> textScore)

The keyword (BM25) relevance score, from 0 to 1. Null when this match came from semantic search only.

Specified by:

textScore in interface RagSearchResult._FinalStage

build

public RagSearchResult build()

Specified by:

build in interface RagSearchResult._FinalStage

additionalProperty

public RagSearchResult.Builder additionalProperty(String key,
 Object value)

Specified by:

additionalProperty in interface RagSearchResult._FinalStage

additionalProperties

public RagSearchResult.Builder additionalProperties(Map<String,Object> additionalProperties)

Specified by:

additionalProperties in interface RagSearchResult._FinalStage