Package com.tnsai.rag

Class RetrievalRequest.Builder

java.lang.Object

com.tnsai.rag.RetrievalRequest.Builder

Enclosing class:

RetrievalRequest

public static final class RetrievalRequest.Builder
extends Object

Builder with safe defaults for unscoped, non-cancellable retrieval.

Method Summary

Modifier and Type	Method	Description
RetrievalRequest	build()
RetrievalRequest.Builder	cancellationToken(CancellationToken value)
RetrievalRequest.Builder	conversationId(String value)	Sets the opaque identity of the conversation this request serves.
RetrievalRequest.Builder	deadline(Instant value)
RetrievalRequest.Builder	metadataFilters(Map<String,String> value)
RetrievalRequest.Builder	scope(RetrievalScope value)
RetrievalRequest.Builder	sourcePaths(Map<String,Path> value)	Sets the run-time location of declared sources, by source name.
RetrievalRequest.Builder	timeout(Duration value)
RetrievalRequest.Builder	timeout(Duration value, Clock clock)
RetrievalRequest.Builder	turnMessage(String value)	Sets the raw message of the turn this request serves.

Methods inherited from class java.lang.Object

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

Method Details

scope

public RetrievalRequest.Builder scope(RetrievalScope value)

cancellationToken

public RetrievalRequest.Builder cancellationToken(CancellationToken value)

deadline

public RetrievalRequest.Builder deadline(Instant value)

timeout

public RetrievalRequest.Builder timeout(Duration value)

timeout

public RetrievalRequest.Builder timeout(Duration value,
 Clock clock)

metadataFilters

public RetrievalRequest.Builder metadataFilters(Map<String,String> value)

turnMessage

public RetrievalRequest.Builder turnMessage(String value)

Sets the raw message of the turn this request serves.

Parameters:

value - the turn message; not blank

Returns:

this builder

Since:

0.18.6

conversationId

public RetrievalRequest.Builder conversationId(String value)

Sets the opaque identity of the conversation this request serves.

Parameters:

value - the conversation identity; not blank

Returns:

this builder

Since:

0.18.6

sourcePaths

public RetrievalRequest.Builder sourcePaths(Map<String,Path> value)

Sets the run-time location of declared sources, by source name.

Parameters:

value - location by source name; copied

Returns:

this builder

Since:

0.18.6

build

public RetrievalRequest build()