Skip to main content

GenericCompletionModel

Struct GenericCompletionModel 

Source
pub struct GenericCompletionModel<Ext = OpenAICompletionsExt, H = Client> {
    pub model: String,
    /* private fields */
}
Expand description

A chat-completions model over any OpenAICompatibleProvider extension. This is the advertised path for OpenAI-compatible providers; see the provider checklist in crate::providers.

Fields§

§model: String

Implementations§

Source§

impl<Ext, H> GenericCompletionModel<Ext, H>
where Client<Ext, H>: Debug + Clone + 'static, Ext: Provider + Clone + 'static,

Source

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

Source

pub fn with_strict_tools(self) -> Self

Enable strict mode for tool schemas.

When enabled, tool schemas are automatically sanitized to meet OpenAI’s strict mode requirements:

  • additionalProperties: false is added to all objects
  • All properties are marked as required
  • strict: true is set on each function definition

This allows OpenAI to guarantee that the model’s tool calls will match the schema exactly.

Source

pub fn with_tool_result_array_content(self) -> Self

Source§

impl GenericCompletionModel<OpenAICompletionsExt, Client>

Source§

impl<H> GenericCompletionModel<OpenRouterExt, H>

Source

pub fn with_prompt_caching(self) -> Self

Enable explicit prompt caching for supported OpenRouter models.

Adds cache_control: {"type": "ephemeral"} to the system-prompt block so subsequent turns that share the same system prefix can be billed at the cache-hit rate when the selected model/provider supports explicit cache breakpoints.

Trait Implementations§

Source§

impl<Ext: Clone, H: Clone> Clone for GenericCompletionModel<Ext, H>

Source§

fn clone(&self) -> GenericCompletionModel<Ext, H>

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<Ext, H> CompletionModel for GenericCompletionModel<Ext, H>

Source§

type Response = <Ext as OpenAICompatibleProvider>::Response

The raw response type returned by the underlying completion model.
Source§

type StreamingResponse = StreamingCompletionResponse<<Ext as OpenAICompatibleProvider>::StreamingUsage>

The raw response type returned by the underlying completion model when streaming.
Source§

type Client = Client<Ext, H>

Provider client type used to construct this model.
Source§

fn make(client: &Self::Client, model: impl Into<String>) -> Self

Construct a model handle from a provider client and model identifier.
Source§

fn composes_native_output_with_tools(&self) -> bool

Whether this provider’s native structured output (output_schema -> format/response_format) composes with tool calls in the same multi-turn request without suppressing them. Read more
Source§

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

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

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

Source§

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

Generates a completion request builder for the given prompt.

Auto Trait Implementations§

§

impl<Ext, H> Freeze for GenericCompletionModel<Ext, H>
where H: Freeze, Ext: Freeze,

§

impl<Ext, H> RefUnwindSafe for GenericCompletionModel<Ext, H>

§

impl<Ext, H> Send for GenericCompletionModel<Ext, H>
where H: Send, Ext: Send,

§

impl<Ext, H> Sync for GenericCompletionModel<Ext, H>
where H: Sync, Ext: Sync,

§

impl<Ext, H> Unpin for GenericCompletionModel<Ext, H>
where H: Unpin, Ext: Unpin,

§

impl<Ext, H> UnsafeUnpin for GenericCompletionModel<Ext, H>
where H: UnsafeUnpin, Ext: UnsafeUnpin,

§

impl<Ext, H> UnwindSafe for GenericCompletionModel<Ext, H>
where H: UnwindSafe, Ext: UnwindSafe,

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> CloneableStorage for T
where T: Any + Send + Sync + Clone,

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<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: 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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