Struct ResponseWebSearchCallInProgressEvent 

pub struct ResponseWebSearchCallInProgressEvent {
    pub item_id: String,
    pub output_index: i64,
    pub sequence_number: i64,
    pub type_: ResponseWebSearchCallInProgressEventType,
}

Emitted when a web search call is initiated.

JSON schema

{
 "description": "Emitted when a web search call is initiated.",
 "type": "object",
 "required": [
   "item_id",
   "output_index",
   "sequence_number",
   "type"
 ],
 "properties": {
   "item_id": {
     "description": "Unique ID for the output item associated with the web search call.\n",
     "type": "string"
   },
   "output_index": {
     "description": "The index of the output item that the web search call is associated with.\n",
     "type": "integer"
   },
   "sequence_number": {
     "description": "The sequence number of the web search call being processed.",
     "type": "integer"
   },
   "type": {
     "description": "The type of the event. Always `response.web_search_call.in_progress`.\n",
     "type": "string",
     "enum": [
       "response.web_search_call.in_progress"
     ],
     "x-stainless-const": true
   }
 },
 "x-oaiMeta": {
   "group": "responses",
   "name": "response.web_search_call.in_progress"
 }
}

Fields

item_id: String

Unique ID for the output item associated with the web search call.

output_index: i64

The index of the output item that the web search call is associated with.

sequence_number: i64

The sequence number of the web search call being processed.

type_: ResponseWebSearchCallInProgressEventType

The type of the event. Always response.web_search_call.in_progress.

Trait Implementations

impl Clone for ResponseWebSearchCallInProgressEvent

fn clone(&self) -> ResponseWebSearchCallInProgressEvent

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ResponseWebSearchCallInProgressEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ResponseWebSearchCallInProgressEvent

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ResponseWebSearchCallInProgressEvent> for ResponseStreamEvent

fn from(value: ResponseWebSearchCallInProgressEvent) -> Self

Converts to this type from the input type.

impl Serialize for ResponseWebSearchCallInProgressEvent

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

where __S: Serializer,

Serialize this value into the given Serde serializer.