Struct ExtractorBuilder 

pub struct ExtractorBuilder<M, T>
where
    M: CompletionModel,
    T: JsonSchema + for<'a> Deserialize<'a> + Serialize + WasmCompatSend + WasmCompatSync + 'static,
{ /* private fields */ }

Builder for the Extractor

Implementations

impl<M, T> ExtractorBuilder<M, T>

where M: CompletionModel, T: JsonSchema + for<'a> Deserialize<'a> + Serialize + WasmCompatSend + WasmCompatSync + 'static,

pub fn new(model: M) -> Self

pub fn preamble(self, preamble: &str) -> Self

Add additional preamble to the extractor

pub fn context(self, doc: &str) -> Self

Add a context document to the extractor

pub fn dynamic_context<I>(self, samples: usize, index: I) -> Self

where I: VectorStoreIndexDyn + 'static,

Add dynamic context retrieved from a vector store on every extraction attempt.

This delegates to AgentBuilder::dynamic_context and therefore uses the same completion-call hook lifecycle as an agent.

pub fn additional_params(self, params: Value) -> Self

pub fn max_tokens(self, max_tokens: u64) -> Self

Set the maximum number of tokens for the completion

pub fn retries(self, retries: u64) -> Self

Set the maximum number of retries for the extractor.

pub fn tool_choice(self, choice: ToolChoice) -> Self

Set the tool_choice option for the inner Agent.

pub fn add_hook<H>(self, hook: H) -> Self

where H: AgentHook + 'static,

Add a provider-independent lifecycle hook to every extraction attempt.

Completion-response hooks receive canonical Rig content, usage, prompt, and message ID fields, just like hooks attached directly to an agent.

pub fn build(self) -> Extractor<M, T>

Build the Extractor