Class ResponseWebSearchCallCompletedEvent
-
- All Implemented Interfaces:
public final class ResponseWebSearchCallCompletedEvent
Emitted when a web search call is completed.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
ResponseWebSearchCallCompletedEvent.Builder
A builder for ResponseWebSearchCallCompletedEvent.
-
Method Summary
Modifier and Type Method Description final String
itemId()
Unique ID for the output item associated with the web search call. final Long
outputIndex()
The index of the output item that the web search call is associated with. final Long
sequenceNumber()
The sequence number of the web search call being processed. final JsonValue
_type()
The type of the event. final JsonField<String>
_itemId()
Returns the raw JSON value of itemId. final JsonField<Long>
_outputIndex()
Returns the raw JSON value of outputIndex. final JsonField<Long>
_sequenceNumber()
Returns the raw JSON value of sequenceNumber. final Map<String, JsonValue>
_additionalProperties()
final ResponseWebSearchCallCompletedEvent.Builder
toBuilder()
final ResponseWebSearchCallCompletedEvent
validate()
final Boolean
isValid()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static ResponseWebSearchCallCompletedEvent.Builder
builder()
Returns a mutable builder for constructing an instance of ResponseWebSearchCallCompletedEvent. -
-
Method Detail
-
outputIndex
final Long outputIndex()
The index of the output item that the web search call is associated with.
-
sequenceNumber
final Long sequenceNumber()
The sequence number of the web search call being processed.
-
_type
final JsonValue _type()
The type of the event. Always
response.web_search_call.completed
.Expected to always return the following:
JsonValue.from("response.web_search_call.completed")
However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
-
_itemId
final JsonField<String> _itemId()
Returns the raw JSON value of itemId.
Unlike itemId, this method doesn't throw if the JSON field has an unexpected type.
-
_outputIndex
final JsonField<Long> _outputIndex()
Returns the raw JSON value of outputIndex.
Unlike outputIndex, this method doesn't throw if the JSON field has an unexpected type.
-
_sequenceNumber
final JsonField<Long> _sequenceNumber()
Returns the raw JSON value of sequenceNumber.
Unlike sequenceNumber, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final ResponseWebSearchCallCompletedEvent.Builder toBuilder()
-
validate
final ResponseWebSearchCallCompletedEvent validate()
-
builder
final static ResponseWebSearchCallCompletedEvent.Builder builder()
Returns a mutable builder for constructing an instance of ResponseWebSearchCallCompletedEvent.
The following fields are required:
.itemId() .outputIndex() .sequenceNumber()
-
-
-
-