Skip to main content

AsyncChatCompletion

Struct AsyncChatCompletion 

Source
pub struct AsyncChatCompletion<N, M>{ /* private fields */ }
Expand description

Builder for submitting a queued chat-completion task through a ZaiClient.

Posts to the async/chat/completions task-submission endpoint.

Implementations§

Source§

impl<N, M> AsyncChatCompletion<N, M>

Source

pub fn new(model: N, messages: M) -> Self

Create a new async chat request from a model and the first message batch.

Source

pub const fn body(&self) -> &ChatBody<N, M>

Borrow the frozen request body.

Source

pub fn add_message(self, message: M) -> Self

Append one message to the conversation.

Source

pub fn extend_messages(self, messages: impl IntoIterator<Item = M>) -> Self

Append multiple messages to the conversation.

Source

pub fn with_request_id(self, request_id: impl Into<String>) -> Self

Set the client-provided request identifier.

Source

pub fn with_do_sample(self, do_sample: bool) -> Self

Enable or disable probabilistic sampling.

Source

pub fn with_temperature(self, temperature: f64) -> Self

Set the sampling temperature.

Source

pub fn with_top_p(self, top_p: f64) -> Self

Set the nucleus-sampling probability.

Source

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

Set the maximum number of generated tokens.

Source

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

Add one tool the model may call.

Source

pub fn add_tools(self, tools: impl IntoIterator<Item = N::Tool>) -> Self
where N: ChatToolSupport,

Add multiple tools the model may call.

Source

pub fn with_tool_choice(self, tool_choice: ToolChoice) -> Self
where N: ChatToolSupport,

Set automatic tool selection.

Source

pub fn clear_tools(self) -> Self
where N: ChatToolSupport,

Remove all tools and their selection policy.

Source

pub fn with_response_format(self, format: ResponseFormat) -> Self

Set the response format for a text model.

Source

pub fn with_watermark_enabled(self, enabled: bool) -> Self
where N: WatermarkEnable,

Enable or disable audio-output watermarking.

Source

pub fn with_user_id(self, user_id: impl Into<String>) -> Self

Set the end-user identifier used for abuse monitoring.

Source

pub fn with_stop(self, stop: impl Into<String>) -> Self

Add the stop sequence for this request.

Source

pub fn with_thinking(self, thinking: ThinkingType) -> Self
where N: ThinkEnable,

Configure thinking mode for a model that supports it.

Source

pub fn with_reasoning_effort(self, effort: ReasoningEffort) -> Self

Set reasoning depth for a model that supports reasoning_effort.

Source

pub fn validate(&self) -> ZaiResult<()>

Validate field constraints for the queued endpoint.

Source

pub async fn send_via(&self, client: &ZaiClient) -> ZaiResult<AsyncResponse>
where N: Serialize, M: Serialize,

Submit via a ZaiClient and await the task-creation response.

Auto Trait Implementations§

§

impl<N, M> Freeze for AsyncChatCompletion<N, M>
where N: Freeze,

§

impl<N, M> RefUnwindSafe for AsyncChatCompletion<N, M>

§

impl<N, M> Send for AsyncChatCompletion<N, M>
where N: Send, M: Send,

§

impl<N, M> Sync for AsyncChatCompletion<N, M>
where N: Sync, M: Sync,

§

impl<N, M> Unpin for AsyncChatCompletion<N, M>
where N: Unpin, M: Unpin,

§

impl<N, M> UnsafeUnpin for AsyncChatCompletion<N, M>
where N: UnsafeUnpin,

§

impl<N, M> UnwindSafe for AsyncChatCompletion<N, M>
where N: UnwindSafe, M: 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> 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: 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, 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