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:
- web_search_call.action.sources: Include the sources of the web search tool call.
- code_interpreter_call.outputs: Includes the outputs of python code execution in code interpreter tool call items.
- computer_call_output.output.image_url: Include image urls from the computer call output.
- 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.
- message.output_text.logprobs: Include logprobs with assistant messages.
- reasoning.encrypted_content: Includes an encrypted version of reasoning tokens in reasoning item outputs. This enables reasoning items to be used in multi-turn conversations when using the Responses API statelessly (like when the store parameter is set to false, or when an organization is enrolled in the zero data retention program).

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`	`CODE_INTERPRETER_CALL_OUTPUTS`
`public final static ResponseIncludable`	`COMPUTER_CALL_OUTPUT_OUTPUT_IMAGE_URL`
`public final static ResponseIncludable`	`FILE_SEARCH_CALL_RESULTS`
`public final static ResponseIncludable`	`MESSAGE_INPUT_IMAGE_IMAGE_URL`
`public final static ResponseIncludable`	`MESSAGE_OUTPUT_TEXT_LOGPROBS`
`public final static ResponseIncludable`	`REASONING_ENCRYPTED_CONTENT`

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

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)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- 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()
```
  - isValid
```
 final Boolean isValid()
```
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - of
```
 final static ResponseIncludable of(String value)
```

Class ResponseIncludable

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

_value

value

known

asString

validate

isValid

equals

hashCode

toString

of