Skip to main content

CompletionModel

Struct CompletionModel 

Source
pub struct CompletionModel {
    pub model: String,
    pub prompt_caching: bool,
    pub guardrail: Option<GuardrailConfiguration>,
    /* private fields */
}

Fields§

§model: String§prompt_caching: bool

When enabled, cache checkpoints are inserted into Converse API requests to take advantage of Bedrock prompt caching. A checkpoint is placed after the system prompt and after the last message in the chat history. Disabled by default.

§guardrail: Option<GuardrailConfiguration>

Guardrail applied to every Converse request from this model, if any. Set through CompletionModel::with_guardrail.

Implementations§

Source§

impl CompletionModel

Source

pub fn new(client: Client, model: impl Into<String>) -> Self

Source

pub fn with_prompt_caching(self) -> Self

Enable Bedrock prompt caching for this model.

When enabled, CachePoint blocks are inserted after the serialized system content and after the final messages entry in each Converse API request. This allows Bedrock to cache and reuse repeated prompt prefixes, reducing both latency and input token costs.

This currently covers the system and messages request fields only. Some Bedrock models also support caching tools, but that is not wired up here yet.

Cacheability and token thresholds are model-specific. If the cached prefix is too short or the model does not support caching for a given field, Bedrock ignores the checkpoint. See the Bedrock prompt caching support table for current limits and field support.

Source

pub fn with_guardrail( self, identifier: impl Into<String>, version: impl Into<String>, trace: GuardrailTrace, ) -> Self

Apply a Bedrock guardrail to every Converse request this model issues.

identifier is the guardrail id or ARN and version its version (or DRAFT). When trace is enabled, Bedrock returns its assessment on InternalConverseOutput::trace — the only place it explains why a turn came back with StopReason::GuardrailIntervened, which the normalized response reports as a content filter and nothing more. Reach it through raw_completion.

Source§

impl CompletionModel

Source

pub async fn raw_completion( &self, completion_request: CompletionRequest, ) -> Result<AwsConverseOutput, CompletionError>

Execute a completion and return Bedrock’s own Converse output.

This is the escape hatch for fields rig does not normalize; completion::CompletionModel::completion calls it and maps the result, so there is exactly one request either way.

Source§

impl CompletionModel

Source

pub async fn raw_stream( &self, completion_request: CompletionRequest, ) -> Result<RawStreamingResult<BedrockStreamingResponse>, CompletionError>

Open a stream whose terminal record stays Bedrock’s own response type.

Trait Implementations§

Source§

impl Clone for CompletionModel

Source§

fn clone(&self) -> CompletionModel

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 CompletionModel for CompletionModel

Source§

async fn completion( &self, completion_request: CompletionRequest, ) -> Result<CompletionResponse, CompletionError>

Generates a completion response for the given completion request.
Source§

async fn stream( &self, request: CompletionRequest, ) -> Result<StreamingCompletionResponse, CompletionError>

Streams a completion response for the given completion request.
Source§

fn completion_request( &self, prompt: impl Into<Message>, ) -> CompletionRequestBuilder<Self>
where Self: Sized + Clone,

Generates a completion request builder for the given prompt.
Source§

fn capabilities(&self) -> ProviderCapabilities

Provider behavior a runtime should account for when preparing requests. 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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> 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<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + 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: Sized + 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<T> WasmCompatSend for T
where T: Send,

Source§

impl<T> WasmCompatSync for T
where T: Sync,

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> 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