Class ResponseRetrieveParams
-
- All Implemented Interfaces:
-
com.openai.core.Params
public final class ResponseRetrieveParams implements Params
Retrieves a model response with the given ID.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
ResponseRetrieveParams.Builder
A builder for ResponseRetrieveParams.
-
Method Summary
Modifier and Type Method Description final Optional<String>
responseId()
final Optional<List<ResponseIncludable>>
include()
Additional fields to include in the response. final Optional<Boolean>
includeObfuscation()
When true, stream obfuscation will be enabled. final Optional<Long>
startingAfter()
The sequence number of the event after which to start streaming. final Headers
_additionalHeaders()
Additional headers to send with the request. final QueryParams
_additionalQueryParams()
Additional query param to send with the request. final ResponseRetrieveParams.Builder
toBuilder()
final String
_pathParam(Integer index)
Headers
_headers()
The full set of headers in the parameters, including both fixed and additional headers. QueryParams
_queryParams()
The full set of query params in the parameters, including both fixed and additional query params. Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static ResponseRetrieveParams
none()
final static ResponseRetrieveParams.Builder
builder()
Returns a mutable builder for constructing an instance of ResponseRetrieveParams. -
-
Method Detail
-
responseId
final Optional<String> responseId()
-
include
final Optional<List<ResponseIncludable>> include()
Additional fields to include in the response. See the
include
parameter for Response creation above for more information.
-
includeObfuscation
final Optional<Boolean> includeObfuscation()
When true, stream obfuscation will be enabled. Stream obfuscation adds random characters to an
obfuscation
field on streaming delta events to normalize payload sizes as a mitigation to certain side-channel attacks. These obfuscation fields are included by default, but add a small amount of overhead to the data stream. You can setinclude_obfuscation
to false to optimize for bandwidth if you trust the network links between your application and the OpenAI API.
-
startingAfter
final Optional<Long> startingAfter()
The sequence number of the event after which to start streaming.
-
_additionalHeaders
final Headers _additionalHeaders()
Additional headers to send with the request.
-
_additionalQueryParams
final QueryParams _additionalQueryParams()
Additional query param to send with the request.
-
toBuilder
final ResponseRetrieveParams.Builder toBuilder()
-
_pathParam
final String _pathParam(Integer index)
-
_headers
Headers _headers()
The full set of headers in the parameters, including both fixed and additional headers.
-
_queryParams
QueryParams _queryParams()
The full set of query params in the parameters, including both fixed and additional query params.
-
none
final static ResponseRetrieveParams none()
-
builder
final static ResponseRetrieveParams.Builder builder()
Returns a mutable builder for constructing an instance of ResponseRetrieveParams.
-
-
-
-