Package ai.vectros.resources.inference.requests

Class RagRequest.Builder

java.lang.Object

ai.vectros.resources.inference.requests.RagRequest.Builder

All Implemented Interfaces:

RagRequest._FinalStage, RagRequest.QueryStage

Enclosing class:

RagRequest

public static final class RagRequest.Builder
extends Object
implements RagRequest.QueryStage, RagRequest._FinalStage

Method Summary

Modifier and Type	Method	Description
RagRequest.Builder	additionalProperties(Map<String,Object> additionalProperties)
RagRequest.Builder	additionalProperty(String key, Object value)
RagRequest._FinalStage	allowGlobalRegion(Boolean allowGlobalRegion)	Opt this request into global (non-US) region serving for lower cost.
RagRequest._FinalStage	allowGlobalRegion(Optional<Boolean> allowGlobalRegion)	Opt this request into global (non-US) region serving for lower cost.
RagRequest	build()
RagRequest.Builder	from(RagRequest other)
RagRequest._FinalStage	instructions(String instructions)	Optional system prompt that overrides the default.
RagRequest._FinalStage	instructions(Optional<String> instructions)	Optional system prompt that overrides the default.
RagRequest._FinalStage	maxTokens(Integer maxTokens)	Maximum number of tokens to generate.
RagRequest._FinalStage	maxTokens(Optional<Integer> maxTokens)	Maximum number of tokens to generate.
RagRequest._FinalStage	model(String model)	Model alias to use, from the list returned by GET /v1/models.
RagRequest._FinalStage	model(Optional<String> model)	Model alias to use, from the list returned by GET /v1/models.
RagRequest._FinalStage	query(@NotNull String query)	The natural-language question to answer over your indexed content.
RagRequest._FinalStage	search(RagSearch search)
RagRequest._FinalStage	search(Optional<RagSearch> search)
RagRequest._FinalStage	temperature(Float temperature)	Sampling temperature.
RagRequest._FinalStage	temperature(Optional<Float> temperature)	Sampling temperature.

Methods inherited from class java.lang.Object

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

Method Details

from

public RagRequest.Builder from(RagRequest other)

Specified by:

from in interface RagRequest.QueryStage

query

public RagRequest._FinalStage query(@NotNull
 @NotNull String query)

The natural-language question to answer over your indexed content.

The natural-language question to answer over your indexed content.

Specified by:

query in interface RagRequest.QueryStage

Returns:

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

allowGlobalRegion

public RagRequest._FinalStage allowGlobalRegion(Boolean allowGlobalRegion)

Opt this request into global (non-US) region serving for lower cost. Requires a signed global-processing waiver on your account that permits per-request override; otherwise the request is rejected with 403. When omitted, the request follows your account's default residency setting.

Specified by:

allowGlobalRegion in interface RagRequest._FinalStage

Returns:

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

allowGlobalRegion

public RagRequest._FinalStage allowGlobalRegion(Optional<Boolean> allowGlobalRegion)

Opt this request into global (non-US) region serving for lower cost. Requires a signed global-processing waiver on your account that permits per-request override; otherwise the request is rejected with 403. When omitted, the request follows your account's default residency setting.

Specified by:

allowGlobalRegion in interface RagRequest._FinalStage

temperature

public RagRequest._FinalStage temperature(Float temperature)

Sampling temperature. Defaults to 0.3, favoring more deterministic, retrieval-grounded answers.

Specified by:

temperature in interface RagRequest._FinalStage

Returns:

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

temperature

public RagRequest._FinalStage temperature(Optional<Float> temperature)

Sampling temperature. Defaults to 0.3, favoring more deterministic, retrieval-grounded answers.

Specified by:

temperature in interface RagRequest._FinalStage

maxTokens

public RagRequest._FinalStage maxTokens(Integer maxTokens)

Maximum number of tokens to generate. Defaults to 1024; the maximum is 4096.

Specified by:

maxTokens in interface RagRequest._FinalStage

Returns:

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

maxTokens

public RagRequest._FinalStage maxTokens(Optional<Integer> maxTokens)

Maximum number of tokens to generate. Defaults to 1024; the maximum is 4096.

Specified by:

maxTokens in interface RagRequest._FinalStage

search

public RagRequest._FinalStage search(RagSearch search)

Specified by:

search in interface RagRequest._FinalStage

search

public RagRequest._FinalStage search(Optional<RagSearch> search)

Specified by:

search in interface RagRequest._FinalStage

model

public RagRequest._FinalStage model(String model)

Model alias to use, from the list returned by GET /v1/models. Defaults to claude-haiku-4-5.

Specified by:

model in interface RagRequest._FinalStage

Returns:

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

model

public RagRequest._FinalStage model(Optional<String> model)

Model alias to use, from the list returned by GET /v1/models. Defaults to claude-haiku-4-5.

Specified by:

model in interface RagRequest._FinalStage

instructions

public RagRequest._FinalStage instructions(String instructions)

Optional system prompt that overrides the default. Defaults to a generic instruction to answer using only the provided context.

Specified by:

instructions in interface RagRequest._FinalStage

Returns:

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

instructions

public RagRequest._FinalStage instructions(Optional<String> instructions)

Optional system prompt that overrides the default. Defaults to a generic instruction to answer using only the provided context.

Specified by:

instructions in interface RagRequest._FinalStage

build

public RagRequest build()

Specified by:

build in interface RagRequest._FinalStage

additionalProperty

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

Specified by:

additionalProperty in interface RagRequest._FinalStage

additionalProperties

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

Specified by:

additionalProperties in interface RagRequest._FinalStage