Package ai.vectros.types

Class SearchResponse.Builder

java.lang.Object

ai.vectros.types.SearchResponse.Builder

Enclosing class:

SearchResponse

public static final class SearchResponse.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
SearchResponse.Builder	additionalProperties(Map<String,Object> additionalProperties)
SearchResponse.Builder	additionalProperty(String key, Object value)
SearchResponse	build()
SearchResponse.Builder	degraded(Boolean degraded)
SearchResponse.Builder	degraded(Optional<Boolean> degraded)	True when one of the two search engines was unavailable and these results came from the surviving engine only (for example, keyword search fell back to semantic-only during an outage).
SearchResponse.Builder	degradedLegs(List<String> degradedLegs)
SearchResponse.Builder	degradedLegs(Optional<List<String>> degradedLegs)	Which search engines were unavailable for this response: text (keyword) and/or vector (semantic).
SearchResponse.Builder	from(SearchResponse other)
SearchResponse.Builder	hasMore(Boolean hasMore)
SearchResponse.Builder	hasMore(Optional<Boolean> hasMore)	True when more matching results are available past this page.
SearchResponse.Builder	results(List<SearchResult> results)
SearchResponse.Builder	results(Optional<List<SearchResult>> results)	The matched content chunks, ordered from most to least relevant.
SearchResponse.Builder	searchTimeMs(Long searchTimeMs)
SearchResponse.Builder	searchTimeMs(Optional<Long> searchTimeMs)	How long the search took to run, in milliseconds.
SearchResponse.Builder	totalResults(Integer totalResults)
SearchResponse.Builder	totalResults(Optional<Integer> totalResults)	The total number of items that matched the query (the size of the matching pool).

Methods inherited from class java.lang.Object

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

Method Details

from

public SearchResponse.Builder from(SearchResponse other)

results

public SearchResponse.Builder results(Optional<List<SearchResult>> results)

The matched content chunks, ordered from most to least relevant.

results

public SearchResponse.Builder results(List<SearchResult> results)

totalResults

public SearchResponse.Builder totalResults(Optional<Integer> totalResults)

The total number of items that matched the query (the size of the matching pool). This may be larger than the number of results returned in this response, which is capped by limit.

totalResults

public SearchResponse.Builder totalResults(Integer totalResults)

searchTimeMs

public SearchResponse.Builder searchTimeMs(Optional<Long> searchTimeMs)

How long the search took to run, in milliseconds.

searchTimeMs

public SearchResponse.Builder searchTimeMs(Long searchTimeMs)

degraded

public SearchResponse.Builder degraded(Optional<Boolean> degraded)

True when one of the two search engines was unavailable and these results came from the surviving engine only (for example, keyword search fell back to semantic-only during an outage). When true, the results may be less complete than a healthy hybrid search. Set requireComplete to true on your request to receive a 503 instead of partial results.

degraded

public SearchResponse.Builder degraded(Boolean degraded)

degradedLegs

public SearchResponse.Builder degradedLegs(Optional<List<String>> degradedLegs)

Which search engines were unavailable for this response: text (keyword) and/or vector (semantic). Empty when the search was not degraded.

degradedLegs

public SearchResponse.Builder degradedLegs(List<String> degradedLegs)

hasMore

public SearchResponse.Builder hasMore(Optional<Boolean> hasMore)

True when more matching results are available past this page. Raise limit or advance offset (up to its max of 200) to fetch them; false also once offset is at its max, since no further page is reachable regardless of how many results exist.

hasMore

public SearchResponse.Builder hasMore(Boolean hasMore)

build

public SearchResponse build()

additionalProperty

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

additionalProperties

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