Class ResponseIncludable
-
- All Implemented Interfaces:
-
com.openai.core.Enum
public final class ResponseIncludable implements Enum
Specify additional output data to include in the model response. Currently supported values are:
file_search_call.results
: Include the search results of the file search tool call.message.input_image.image_url
: Include image urls from the input message.computer_call_output.output.image_url
: Include image urls from the computer call output.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public enum
ResponseIncludable.Known
An enum containing ResponseIncludable's known values.
public enum
ResponseIncludable.Value
An enum containing ResponseIncludable's known values, as well as an _UNKNOWN member.
An instance of ResponseIncludable can contain an unknown value in a couple of cases:
It was deserialized from data that doesn't match any known member. For example, if the SDK is on an older version than the API, then the API may respond with new members that the SDK is unaware of.
It was constructed with an arbitrary value using the of method.
-
Field Summary
Fields Modifier and Type Field Description public final static ResponseIncludable
FILE_SEARCH_CALL_RESULTS
public final static ResponseIncludable
MESSAGE_INPUT_IMAGE_IMAGE_URL
public final static ResponseIncludable
COMPUTER_CALL_OUTPUT_OUTPUT_IMAGE_URL
-
Method Summary
Modifier and Type Method Description final JsonField<String>
_value()
Returns this class instance's raw value. final ResponseIncludable.Value
value()
Returns an enum member corresponding to this class instance's value, or Value._UNKNOWN if the class was instantiated with an unknown value. final ResponseIncludable.Known
known()
Returns an enum member corresponding to this class instance's value. final String
asString()
Returns this class instance's primitive wire representation. final ResponseIncludable
validate()
final Boolean
isValid()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static ResponseIncludable
of(String value)
-
-
Method Detail
-
_value
final JsonField<String> _value()
Returns this class instance's raw value.
This is usually only useful if this instance was deserialized from data that doesn't match any known member, and you want to know that value. For example, if the SDK is on an older version than the API, then the API may respond with new members that the SDK is unaware of.
-
value
final ResponseIncludable.Value value()
Returns an enum member corresponding to this class instance's value, or Value._UNKNOWN if the class was instantiated with an unknown value.
Use the known method instead if you're certain the value is always known or if you want to throw for the unknown case.
-
known
final ResponseIncludable.Known known()
Returns an enum member corresponding to this class instance's value.
Use the value method instead if you're uncertain the value is always known and don't want to throw for the unknown case.
-
asString
final String asString()
Returns this class instance's primitive wire representation.
This differs from the toString method because that method is primarily for debugging and generally doesn't throw.
-
validate
final ResponseIncludable validate()
-
of
final static ResponseIncludable of(String value)
-
-
-
-