Class ResponseFileSearchCallCompletedEvent
-
- All Implemented Interfaces:
public final class ResponseFileSearchCallCompletedEvent
Emitted when a file search call is completed (results found).
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
ResponseFileSearchCallCompletedEvent.Builder
A builder for ResponseFileSearchCallCompletedEvent.
-
Method Summary
Modifier and Type Method Description final String
itemId()
The ID of the output item that the file search call is initiated. final Long
outputIndex()
The index of the output item that the file search call is initiated. 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 Map<String, JsonValue>
_additionalProperties()
final ResponseFileSearchCallCompletedEvent.Builder
toBuilder()
final ResponseFileSearchCallCompletedEvent
validate()
final Boolean
isValid()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static ResponseFileSearchCallCompletedEvent.Builder
builder()
Returns a mutable builder for constructing an instance of ResponseFileSearchCallCompletedEvent. -
-
Method Detail
-
outputIndex
final Long outputIndex()
The index of the output item that the file search call is initiated.
-
_type
final JsonValue _type()
The type of the event. Always
response.file_search_call.completed
.Expected to always return the following:
JsonValue.from("response.file_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.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final ResponseFileSearchCallCompletedEvent.Builder toBuilder()
-
validate
final ResponseFileSearchCallCompletedEvent validate()
-
builder
final static ResponseFileSearchCallCompletedEvent.Builder builder()
Returns a mutable builder for constructing an instance of ResponseFileSearchCallCompletedEvent.
The following fields are required:
.itemId() .outputIndex()
-
-
-
-