Package ai.vectros.types

Class SearchResultsEvent.Builder

java.lang.Object

ai.vectros.types.SearchResultsEvent.Builder

All Implemented Interfaces:

SearchResultsEvent._FinalStage, SearchResultsEvent.EventStage, SearchResultsEvent.SearchTimeMsStage, SearchResultsEvent.TotalResultsStage

Enclosing class:

SearchResultsEvent

public static final class SearchResultsEvent.Builder
extends Object
implements SearchResultsEvent.EventStage, SearchResultsEvent.TotalResultsStage, SearchResultsEvent.SearchTimeMsStage, SearchResultsEvent._FinalStage

Method Summary

Modifier and Type	Method	Description
SearchResultsEvent._FinalStage	addAllResults(List<RagSearchResult> results)	The ranked results used to ground the model's answer.
SearchResultsEvent.Builder	additionalProperties(Map<String,Object> additionalProperties)
SearchResultsEvent.Builder	additionalProperty(String key, Object value)
SearchResultsEvent._FinalStage	addResults(RagSearchResult results)	The ranked results used to ground the model's answer.
SearchResultsEvent	build()
SearchResultsEvent._FinalStage	degraded(Boolean degraded)	True when one search backend was unavailable and these results came from the remaining engine only (for example, keyword search degraded to semantic-only during an outage).
SearchResultsEvent._FinalStage	degraded(Optional<Boolean> degraded)	True when one search backend was unavailable and these results came from the remaining engine only (for example, keyword search degraded to semantic-only during an outage).
SearchResultsEvent._FinalStage	degradedLegs(List<String> degradedLegs)	Which retrieval legs were unavailable: text (keyword) and/or vector (semantic).
SearchResultsEvent._FinalStage	degradedLegs(Optional<List<String>> degradedLegs)	Which retrieval legs were unavailable: text (keyword) and/or vector (semantic).
SearchResultsEvent.TotalResultsStage	event(@NotNull SearchResultsEventEvent event)	Backward-compatible alias of type.
SearchResultsEvent.Builder	from(SearchResultsEvent other)
SearchResultsEvent._FinalStage	results(List<RagSearchResult> results)	The ranked results used to ground the model's answer.
SearchResultsEvent._FinalStage	searchTimeMs(long searchTimeMs)	Wall-clock duration of the retrieval step, in milliseconds.
SearchResultsEvent.SearchTimeMsStage	totalResults(int totalResults)	The total number of matches found, which may exceed the number of results returned when a result limit is applied.

Methods inherited from class java.lang.Object

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

Method Details

from

public SearchResultsEvent.Builder from(SearchResultsEvent other)

Specified by:

from in interface SearchResultsEvent.EventStage

event

public SearchResultsEvent.TotalResultsStage event(@NotNull
 @NotNull SearchResultsEventEvent event)

Backward-compatible alias of type. Always search_results.

Backward-compatible alias of type. Always search_results.

Specified by:

event in interface SearchResultsEvent.EventStage

Returns:

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

totalResults

public SearchResultsEvent.SearchTimeMsStage totalResults(int totalResults)

The total number of matches found, which may exceed the number of results returned when a result limit is applied.

The total number of matches found, which may exceed the number of results returned when a result limit is applied.

Specified by:

totalResults in interface SearchResultsEvent.TotalResultsStage

Returns:

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

searchTimeMs

public SearchResultsEvent._FinalStage searchTimeMs(long searchTimeMs)

Wall-clock duration of the retrieval step, in milliseconds.

Wall-clock duration of the retrieval step, in milliseconds.

Specified by:

searchTimeMs in interface SearchResultsEvent.SearchTimeMsStage

Returns:

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

degradedLegs

public SearchResultsEvent._FinalStage degradedLegs(List<String> degradedLegs)

Which retrieval legs were unavailable: text (keyword) and/or vector (semantic). Empty when retrieval was not degraded.

Specified by:

degradedLegs in interface SearchResultsEvent._FinalStage

Returns:

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

degradedLegs

public SearchResultsEvent._FinalStage degradedLegs(Optional<List<String>> degradedLegs)

Which retrieval legs were unavailable: text (keyword) and/or vector (semantic). Empty when retrieval was not degraded.

Specified by:

degradedLegs in interface SearchResultsEvent._FinalStage

degraded

public SearchResultsEvent._FinalStage degraded(Boolean degraded)

True when one search backend was unavailable and these results came from the remaining engine only (for example, keyword search degraded to semantic-only during an outage). The grounding context may be less complete in this case.

Specified by:

degraded in interface SearchResultsEvent._FinalStage

Returns:

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

degraded

public SearchResultsEvent._FinalStage degraded(Optional<Boolean> degraded)

True when one search backend was unavailable and these results came from the remaining engine only (for example, keyword search degraded to semantic-only during an outage). The grounding context may be less complete in this case.

Specified by:

degraded in interface SearchResultsEvent._FinalStage

addAllResults

public SearchResultsEvent._FinalStage addAllResults(List<RagSearchResult> results)

The ranked results used to ground the model's answer. An empty array means nothing matched.

Specified by:

addAllResults in interface SearchResultsEvent._FinalStage

Returns:

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

addResults

public SearchResultsEvent._FinalStage addResults(RagSearchResult results)

The ranked results used to ground the model's answer. An empty array means nothing matched.

Specified by:

addResults in interface SearchResultsEvent._FinalStage

Returns:

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

results

public SearchResultsEvent._FinalStage results(List<RagSearchResult> results)

The ranked results used to ground the model's answer. An empty array means nothing matched.

Specified by:

results in interface SearchResultsEvent._FinalStage

build

public SearchResultsEvent build()

Specified by:

build in interface SearchResultsEvent._FinalStage

additionalProperty

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

Specified by:

additionalProperty in interface SearchResultsEvent._FinalStage

additionalProperties

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

Specified by:

additionalProperties in interface SearchResultsEvent._FinalStage