Skip to main content

ApiRequest

Struct ApiRequest 

Source
pub struct ApiRequest { /* private fields */ }
Expand description

A safe, chainable request builder that wraps ChatCompletionRequest.

Use with_model to set an arbitrary model string, or the convenience constructors deepseek_chat and deepseek_reasoner for the standard DeepSeek models.

Implementations§

Source§

impl ApiRequest

Source

pub fn builder() -> Self

Start a new builder with default values.

Source

pub fn with_model(self, name: impl Into<String>) -> Self

Set the model by string (builder-style).

Accepts any model identifier — a named DeepSeek model or any OpenAI-compatible model string:

use ds_api::ApiRequest;

let req = ApiRequest::builder().with_model("deepseek-chat");
let req = ApiRequest::builder().with_model("gpt-4o");
Source

pub fn deepseek_chat(messages: Vec<Message>) -> Self

Convenience constructor: deepseek-chat + messages

Source

pub fn deepseek_reasoner(messages: Vec<Message>) -> Self

Convenience constructor: deepseek-reasoner + messages

Source

pub fn add_message(self, msg: Message) -> Self

Add a message to the request.

Source

pub fn messages(self, msgs: Vec<Message>) -> Self

Replace messages.

Source

pub fn json(self) -> Self

Request response as JSON object.

Source

pub fn text(self) -> Self

Request response as plain text.

Source

pub fn temperature(self, t: f32) -> Self

Set temperature.

Source

pub fn max_tokens(self, n: u32) -> Self

Set max tokens.

Source

pub fn add_tool(self, tool: Tool) -> Self

Add a raw tool definition (from crate::raw::Tool).

Source

pub fn tool_choice_auto(self) -> Self

Set tool choice to Auto.

Source

pub fn stream(self, enabled: bool) -> Self

Enable/disable streaming (stream: true).

Trait Implementations§

Source§

impl Debug for ApiRequest

Source§

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

Formats the value using the given formatter. 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> 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> 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, 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> 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