Class BetaResponseWebSearchCallInProgressEvent
-
- All Implemented Interfaces:
public final class BetaResponseWebSearchCallInProgressEventEmitted when a web search call is initiated.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classBetaResponseWebSearchCallInProgressEvent.BuilderA builder for BetaResponseWebSearchCallInProgressEvent.
public final classBetaResponseWebSearchCallInProgressEvent.AgentThe agent that owns this multi-agent streaming event.
-
Method Summary
Modifier and Type Method Description final StringitemId()Unique ID for the output item associated with the web search call. final LongoutputIndex()The index of the output item that the web search call is associated with. final LongsequenceNumber()The sequence number of the web search call being processed. final JsonValue_type()The type of the event. final Optional<BetaResponseWebSearchCallInProgressEvent.Agent>agent()The agent that owns this multi-agent streaming 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 JsonField<BetaResponseWebSearchCallInProgressEvent.Agent>_agent()Returns the raw JSON value of agent. final Map<String, JsonValue>_additionalProperties()final BetaResponseWebSearchCallInProgressEvent.BuildertoBuilder()final BetaResponseWebSearchCallInProgressEventvalidate()Validates that the types of all values in this object match their expected types recursively. final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static BetaResponseWebSearchCallInProgressEvent.Builderbuilder()Returns a mutable builder for constructing an instance of BetaResponseWebSearchCallInProgressEvent. -
-
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.in_progress.Expected to always return the following:
JsonValue.from("response.web_search_call.in_progress")However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
-
agent
final Optional<BetaResponseWebSearchCallInProgressEvent.Agent> agent()
The agent that owns this multi-agent streaming event.
-
_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.
-
_agent
final JsonField<BetaResponseWebSearchCallInProgressEvent.Agent> _agent()
Returns the raw JSON value of agent.
Unlike agent, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final BetaResponseWebSearchCallInProgressEvent.Builder toBuilder()
-
validate
final BetaResponseWebSearchCallInProgressEvent validate()
Validates that the types of all values in this object match their expected types recursively.
This method is not forwards compatible with new types from the API for existing fields.
-
builder
final static BetaResponseWebSearchCallInProgressEvent.Builder builder()
Returns a mutable builder for constructing an instance of BetaResponseWebSearchCallInProgressEvent.
The following fields are required:
.itemId() .outputIndex() .sequenceNumber()
-
-
-
-