Skip to main content

ChatResponseUpdate

Struct ChatResponseUpdate 

Source
pub struct ChatResponseUpdate {
Show 13 fields pub contents: Vec<Content>, pub role: Option<Role>, pub author_name: Option<String>, pub response_id: Option<String>, pub message_id: Option<String>, pub conversation_id: Option<String>, pub model: Option<String>, pub created_at: Option<String>, pub finish_reason: Option<FinishReason>, pub continuation_token: Option<ContinuationToken>, pub operation_state: Option<OperationState>, pub additional_properties: HashMap<String, Value>, pub raw_representation: Option<Value>,
}
Expand description

A single streaming chunk from a chat client.

Fields§

§contents: Vec<Content>§role: Option<Role>§author_name: Option<String>§response_id: Option<String>§message_id: Option<String>§conversation_id: Option<String>§model: Option<String>§created_at: Option<String>§finish_reason: Option<FinishReason>§continuation_token: Option<ContinuationToken>

The handle for resuming a long-running operation, when the service issues one.

On a streamed response this used to be lost: ChatResponse has the field but the update type did not, so the token never survived aggregation and a streamed background run could not be resumed — the blocked response a policy check produces most of all, since that is the one a caller needs to pick back up. Carried on the update that knows it (in practice the last) and taken by absorb_update the way finish_reason is.

§operation_state: Option<OperationState>

Where the resumable operation this update belongs to stands, when the provider knows. See OperationState: a Terminal update clears the aggregated continuation_token.

§additional_properties: HashMap<String, Value>

Provider-specific metadata for this update. Merged onto ChatResponse::additional_properties during aggregation.

§raw_representation: Option<Value>

The raw provider payload this update was decoded from, if retained.

Implementations§

Source§

impl ChatResponseUpdate

Source

pub fn text(text: impl Into<String>) -> ChatResponseUpdate

A text-only update from the assistant.

Source

pub fn text_content(&self) -> String

The concatenated text of this update.

Empty when the update carries a refusal fragment — see ChatResponse::text for why refusals are withheld rather than surfaced as text.

Source

pub fn has_refusal(&self) -> bool

Whether this update carries a provider refusal fragment.

Source

pub fn refusal_text(&self) -> Option<String>

This update’s refusal text, or None.

Trait Implementations§

Source§

impl Clone for ChatResponseUpdate

Source§

fn clone(&self) -> ChatResponseUpdate

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 Debug for ChatResponseUpdate

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ChatResponseUpdate

Source§

fn default() -> ChatResponseUpdate

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for ChatResponseUpdate

Source§

fn deserialize<__D>( __deserializer: __D, ) -> Result<ChatResponseUpdate, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for ChatResponseUpdate

Source§

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. 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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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