kind_openai::endpoints::chat

Struct ChatCompletionBuilder

Source
pub struct ChatCompletionBuilder<'a, S: State = Empty> { /* private fields */ }
Expand description

Use builder syntax to set the inputs and finish with unstructured().

Implementations§

Source§

impl<'a, S: State> ChatCompletionBuilder<'a, S>

Source

pub fn unstructured(self) -> ChatCompletion<'a>
where S: IsComplete,

Finish building and return the requested object

Source

pub fn messages( self, value: Vec<Message<'a>>, ) -> ChatCompletionBuilder<'a, SetMessages<S>>
where S::Messages: IsUnset,

Required.

Source

pub fn temperature( self, value: f32, ) -> ChatCompletionBuilder<'a, SetTemperature<S>>
where S::Temperature: IsUnset,

Optional (Some / Option setters).

Source

pub fn maybe_temperature( self, value: Option<f32>, ) -> ChatCompletionBuilder<'a, SetTemperature<S>>
where S::Temperature: IsUnset,

Optional (Some / Option setters).

Source

pub fn top_p(self, value: f32) -> ChatCompletionBuilder<'a, SetTopP<S>>
where S::TopP: IsUnset,

Optional (Some / Option setters).

Source

pub fn maybe_top_p( self, value: Option<f32>, ) -> ChatCompletionBuilder<'a, SetTopP<S>>
where S::TopP: IsUnset,

Optional (Some / Option setters).

Source§

impl<'a, S> ChatCompletionBuilder<'a, S>
where S: IsComplete,

Source

pub fn structured<SS>(self) -> StructuredChatCompletion<'a, SS>
where SS: OpenAISchema,

Upgrades a chat completion request to a structured chat completion request. Unless the return type can be inferred, you probably want to call this like so: .structured::<MySchemadType>();

Auto Trait Implementations§

§

impl<'a, S> Freeze for ChatCompletionBuilder<'a, S>

§

impl<'a, S> RefUnwindSafe for ChatCompletionBuilder<'a, S>

§

impl<'a, S> Send for ChatCompletionBuilder<'a, S>

§

impl<'a, S> Sync for ChatCompletionBuilder<'a, S>

§

impl<'a, S> Unpin for ChatCompletionBuilder<'a, S>

§

impl<'a, S> UnwindSafe for ChatCompletionBuilder<'a, S>

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