Package ai.vectros.types

Class PartnerSearchResult.Builder

java.lang.Object

ai.vectros.types.PartnerSearchResult.Builder

Enclosing class:

PartnerSearchResult

public static final class PartnerSearchResult.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
PartnerSearchResult.Builder	additionalProperties(Map<String,Object> additionalProperties)
PartnerSearchResult.Builder	additionalProperty(String key, Object value)
PartnerSearchResult	build()
PartnerSearchResult.Builder	chunkText(String chunkText)
PartnerSearchResult.Builder	chunkText(Optional<String> chunkText)	The exact text chunk that matched the query.
PartnerSearchResult.Builder	contextText(String contextText)
PartnerSearchResult.Builder	contextText(Optional<String> contextText)	A broader passage surrounding the matched chunk.
PartnerSearchResult.Builder	createdAt(String createdAt)
PartnerSearchResult.Builder	createdAt(Optional<String> createdAt)	When the source item was created, as an ISO-8601 UTC timestamp.
PartnerSearchResult.Builder	documentId(String documentId)
PartnerSearchResult.Builder	documentId(Optional<String> documentId)	The ID of the source document or record this chunk belongs to.
PartnerSearchResult.Builder	from(PartnerSearchResult other)
PartnerSearchResult.Builder	metadata(Map<String,Object> metadata)
PartnerSearchResult.Builder	metadata(Optional<Map<String,Object>> metadata)	The metadata you supplied for this item when you ingested it, such as its title, folder ID, and any custom fields you included.
PartnerSearchResult.Builder	score(Double score)
PartnerSearchResult.Builder	score(Optional<Double> score)	The combined relevance score that fuses the text and semantic signals (reciprocal rank fusion).
PartnerSearchResult.Builder	semanticScore(Double semanticScore)
PartnerSearchResult.Builder	semanticScore(Optional<Double> semanticScore)	The semantic (vector similarity) component of the score.
PartnerSearchResult.Builder	snippet(String snippet)
PartnerSearchResult.Builder	snippet(Optional<String> snippet)	A short excerpt with the matched query terms highlighted.
PartnerSearchResult.Builder	sourceType(PartnerSearchResultSourceType sourceType)
PartnerSearchResult.Builder	sourceType(Optional<PartnerSearchResultSourceType> sourceType)	Indicates what kind of source item this result came from: PartnerDocument for documents ingested via POST /v1/documents or POST /v1/documents/upload, and GenericRecord for typed records created via POST /v1/records.
PartnerSearchResult.Builder	textScore(Double textScore)
PartnerSearchResult.Builder	textScore(Optional<Double> textScore)	The keyword (BM25) relevance component of the score.

Methods inherited from class java.lang.Object

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

Method Details

from

public PartnerSearchResult.Builder from(PartnerSearchResult other)

documentId

public PartnerSearchResult.Builder documentId(Optional<String> documentId)

The ID of the source document or record this chunk belongs to. Use it with GET /v1/documents/{id} or GET /v1/records/{id} (depending on sourceType) to retrieve the full item.

documentId

public PartnerSearchResult.Builder documentId(String documentId)

score

public PartnerSearchResult.Builder score(Optional<Double> score)

The combined relevance score that fuses the text and semantic signals (reciprocal rank fusion). This is the primary sort key — a higher value means a more relevant result.

score

public PartnerSearchResult.Builder score(Double score)

textScore

public PartnerSearchResult.Builder textScore(Optional<Double> textScore)

The keyword (BM25) relevance component of the score. It is non-zero in HYBRID mode when the keyword engine contributes to the match. It is always 0 in TEXT mode, because that path does not expose per-hit scores — in TEXT mode the order of the results array is the ranking signal, not this field.

textScore

public PartnerSearchResult.Builder textScore(Double textScore)

semanticScore

public PartnerSearchResult.Builder semanticScore(Optional<Double> semanticScore)

The semantic (vector similarity) component of the score. Non-zero when the search mode is SEMANTIC or HYBRID.

semanticScore

public PartnerSearchResult.Builder semanticScore(Double semanticScore)

chunkText

public PartnerSearchResult.Builder chunkText(Optional<String> chunkText)

The exact text chunk that matched the query. Pass this to your model as the retrieved context.

chunkText

public PartnerSearchResult.Builder chunkText(String chunkText)

contextText

public PartnerSearchResult.Builder contextText(Optional<String> contextText)

A broader passage surrounding the matched chunk. Use this instead of chunkText when you need more context — for example to avoid fragmentation when building a long-context prompt for a model.

contextText

public PartnerSearchResult.Builder contextText(String contextText)

snippet

public PartnerSearchResult.Builder snippet(Optional<String> snippet)

A short excerpt with the matched query terms highlighted. Suitable for display in a search results UI.

snippet

public PartnerSearchResult.Builder snippet(String snippet)

sourceType

public PartnerSearchResult.Builder sourceType(Optional<PartnerSearchResultSourceType> sourceType)

Indicates what kind of source item this result came from: PartnerDocument for documents ingested via POST /v1/documents or POST /v1/documents/upload, and GenericRecord for typed records created via POST /v1/records. Use this to branch when rendering a mix of documents and records from a unified search.

sourceType

public PartnerSearchResult.Builder sourceType(PartnerSearchResultSourceType sourceType)

metadata

public PartnerSearchResult.Builder metadata(Optional<Map<String,Object>> metadata)

The metadata you supplied for this item when you ingested it, such as its title, folder ID, and any custom fields you included.

metadata

public PartnerSearchResult.Builder metadata(Map<String,Object> metadata)

createdAt

public PartnerSearchResult.Builder createdAt(Optional<String> createdAt)

When the source item was created, as an ISO-8601 UTC timestamp.

createdAt

public PartnerSearchResult.Builder createdAt(String createdAt)

build

public PartnerSearchResult build()

additionalProperty

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

additionalProperties

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