Package ai.vectros.resources.inference.requests

Class DocumentAskRequest.Builder

java.lang.Object

ai.vectros.resources.inference.requests.DocumentAskRequest.Builder

All Implemented Interfaces:

DocumentAskRequest._FinalStage, DocumentAskRequest.PromptStage

Enclosing class:

DocumentAskRequest

public static final class DocumentAskRequest.Builder
extends Object
implements DocumentAskRequest.PromptStage, DocumentAskRequest._FinalStage

Method Summary

Modifier and Type	Method	Description
DocumentAskRequest.Builder	additionalProperties(Map<String,Object> additionalProperties)
DocumentAskRequest.Builder	additionalProperty(String key, Object value)
DocumentAskRequest._FinalStage	allowGlobalRegion(Boolean allowGlobalRegion)	Opt this request into global (non-US) region serving for lower cost.
DocumentAskRequest._FinalStage	allowGlobalRegion(Optional<Boolean> allowGlobalRegion)	Opt this request into global (non-US) region serving for lower cost.
DocumentAskRequest	build()
DocumentAskRequest.Builder	from(DocumentAskRequest other)
DocumentAskRequest._FinalStage	instructions(String instructions)	Optional system prompt that overrides the default.
DocumentAskRequest._FinalStage	instructions(Optional<String> instructions)	Optional system prompt that overrides the default.
DocumentAskRequest._FinalStage	maxTokens(Integer maxTokens)	Maximum number of tokens to generate.
DocumentAskRequest._FinalStage	maxTokens(Optional<Integer> maxTokens)	Maximum number of tokens to generate.
DocumentAskRequest._FinalStage	model(String model)	Model alias to use, from the list returned by GET /v1/models.
DocumentAskRequest._FinalStage	model(Optional<String> model)	Model alias to use, from the list returned by GET /v1/models.
DocumentAskRequest._FinalStage	prompt(@NotNull String prompt)	The question or instruction to answer about the document.
DocumentAskRequest._FinalStage	temperature(Float temperature)	Sampling temperature.
DocumentAskRequest._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 DocumentAskRequest.Builder from(DocumentAskRequest other)

Specified by:

from in interface DocumentAskRequest.PromptStage

prompt

public DocumentAskRequest._FinalStage prompt(@NotNull
 @NotNull String prompt)

The question or instruction to answer about the document.

The question or instruction to answer about the document.

Specified by:

prompt in interface DocumentAskRequest.PromptStage

Returns:

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

allowGlobalRegion

public DocumentAskRequest._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 DocumentAskRequest._FinalStage

Returns:

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

allowGlobalRegion

public DocumentAskRequest._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 DocumentAskRequest._FinalStage

temperature

public DocumentAskRequest._FinalStage temperature(Float temperature)

Sampling temperature. Defaults to 0.2.

Specified by:

temperature in interface DocumentAskRequest._FinalStage

Returns:

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

temperature

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

Sampling temperature. Defaults to 0.2.

Specified by:

temperature in interface DocumentAskRequest._FinalStage

maxTokens

public DocumentAskRequest._FinalStage maxTokens(Integer maxTokens)

Maximum number of tokens to generate. Defaults to 2048; the maximum is 8192.

Specified by:

maxTokens in interface DocumentAskRequest._FinalStage

Returns:

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

maxTokens

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

Maximum number of tokens to generate. Defaults to 2048; the maximum is 8192.

Specified by:

maxTokens in interface DocumentAskRequest._FinalStage

model

public DocumentAskRequest._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 DocumentAskRequest._FinalStage

Returns:

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

model

public DocumentAskRequest._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 DocumentAskRequest._FinalStage

instructions

public DocumentAskRequest._FinalStage instructions(String instructions)

Optional system prompt that overrides the default. Defaults to a generic instruction to act as a helpful document analyst.

Specified by:

instructions in interface DocumentAskRequest._FinalStage

Returns:

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

instructions

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

Optional system prompt that overrides the default. Defaults to a generic instruction to act as a helpful document analyst.

Specified by:

instructions in interface DocumentAskRequest._FinalStage

build

public DocumentAskRequest build()

Specified by:

build in interface DocumentAskRequest._FinalStage

additionalProperty

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

Specified by:

additionalProperty in interface DocumentAskRequest._FinalStage

additionalProperties

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

Specified by:

additionalProperties in interface DocumentAskRequest._FinalStage