Skip to main content

GenerateRequest

Struct GenerateRequest 

Source
pub struct GenerateRequest {
    pub prompt: String,
    pub model: Option<String>,
    pub params: GenerateParams,
    pub context: Option<String>,
    pub tools: Option<Vec<Value>>,
    pub images: Option<Vec<ContentBlock>>,
    pub messages: Option<Vec<Message>>,
    pub cache_control: bool,
    pub response_format: Option<ResponseFormat>,
    pub intent: Option<IntentHint>,
}
Expand description

A text generation request.

Default is derived so call sites can mutate just the fields they care about: GenerateRequest { prompt: "...".into(), ..Default::default() }. The default prompt = "" is useless on its own — callers always override it — but the ..Default::default() shorthand stops the per-call-site mechanical churn every time a new optional field lands (closes #109).

Fields§

§prompt: String

The prompt to complete (first user message for single-turn).

§model: Option<String>

Optional model override.

§params: GenerateParams

Generation parameters.

§context: Option<String>

Optional memory context to prepend to the prompt. When provided, this is injected as a system-level context block before the user prompt, grounding the model’s response.

§tools: Option<Vec<Value>>

Optional tool definitions for structured tool_use. When provided, the model may return tool_calls instead of text. Each tool is a JSON object with: name, description, parameters (JSON Schema).

§images: Option<Vec<ContentBlock>>

Optional images for vision models. When provided with a single-turn prompt, these are included as image content blocks in the user message. For multi-turn with messages, use UserMultimodal variants instead.

§messages: Option<Vec<Message>>

Optional multi-turn conversation history. When provided, the backend builds a proper multi-turn message array instead of a single user message. The prompt field is ignored when messages are present.

§cache_control: bool

Enable prompt caching for Anthropic API. When true, system prompt and tools are marked with cache_control breakpoints, enabling cache reuse across parent/child agent calls sharing the same prefix.

§response_format: Option<ResponseFormat>

Constrain output to JSON (optionally schema-validated). See ResponseFormat for the per-provider mapping. Defaults to None — free-form text.

§intent: Option<IntentHint>

Caller-supplied routing intent. None preserves the existing adaptive vs. pinned-model behavior. When Some, the adaptive router uses the hint to filter candidates (hard require), override task selection, and bias the score profile (prefer_local). See crate::intent::IntentHint.

Trait Implementations§

Source§

impl Clone for GenerateRequest

Source§

fn clone(&self) -> GenerateRequest

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for GenerateRequest

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for GenerateRequest

Source§

fn default() -> GenerateRequest

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for GenerateRequest

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for GenerateRequest

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> ErasedDestructor for T
where T: 'static,