Skip to main content

ResponseFunctionCallArgumentsDeltaEvent

agentsdk_openai::api::types

Struct ResponseFunctionCallArgumentsDeltaEvent

pub struct ResponseFunctionCallArgumentsDeltaEvent {
    pub delta: String,
    pub item_id: String,
    pub output_index: i64,
    pub sequence_number: i64,
    pub type_: ResponseFunctionCallArgumentsDeltaEventType,
}

Expand description

Emitted when there is a partial function-call arguments delta.

JSON schema

{
 "description": "Emitted when there is a partial function-call arguments delta.",
 "type": "object",
 "required": [
   "delta",
   "item_id",
   "output_index",
   "sequence_number",
   "type"
 ],
 "properties": {
   "delta": {
     "description": "The function-call arguments delta that is added.\n",
     "type": "string"
   },
   "item_id": {
     "description": "The ID of the output item that the function-call arguments delta is added to.\n",
     "type": "string"
   },
   "output_index": {
     "description": "The index of the output item that the function-call arguments delta is added to.\n",
     "type": "integer"
   },
   "sequence_number": {
     "description": "The sequence number of this event.",
     "type": "integer"
   },
   "type": {
     "description": "The type of the event. Always `response.function_call_arguments.delta`.\n",
     "type": "string",
     "enum": [
       "response.function_call_arguments.delta"
     ],
     "x-stainless-const": true
   }
 },
 "x-oaiMeta": {
   "group": "responses",
   "name": "response.function_call_arguments.delta"
 }
}

Fields§

§delta: String

The function-call arguments delta that is added.

§item_id: String

The ID of the output item that the function-call arguments delta is added to.

§output_index: i64

The index of the output item that the function-call arguments delta is added to.

§sequence_number: i64

The sequence number of this event.

§type_: ResponseFunctionCallArgumentsDeltaEventType

The type of the event. Always response.function_call_arguments.delta.

Trait Implementations§

impl Clone for ResponseFunctionCallArgumentsDeltaEvent

fn clone(&self) -> ResponseFunctionCallArgumentsDeltaEvent

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

impl Debug for ResponseFunctionCallArgumentsDeltaEvent

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for ResponseFunctionCallArgumentsDeltaEvent

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl From<ResponseFunctionCallArgumentsDeltaEvent> for ResponseStreamEvent

fn from(value: ResponseFunctionCallArgumentsDeltaEvent) -> Self

Converts to this type from the input type.

impl Serialize for ResponseFunctionCallArgumentsDeltaEvent

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

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

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.