Constructor Detail

Method Detail

• withRawResponse

   abstract ResponseService.WithRawResponse withRawResponse()

  Returns a view of this service that provides access to raw HTTP responses for each method.

• withOptions

   abstract ResponseService withOptions(Consumer<ClientOptions.Builder> modifier)

  Returns a view of this service with the given option modifications applied.

  The original service is not modified.

• inputItems

   abstract InputItemService inputItems()

• create

   Response create()

  Creates a model response. Provide text or image inputs to generate text or JSON outputs. Have the model call your own custom code or use built-in tools like web search or file search to use your own data as input for the model's response.

• create

   abstract Response create(ResponseCreateParams params, RequestOptions requestOptions)

• create

   Response create(ResponseCreateParams params)

• create

   Response create(RequestOptions requestOptions)

• create

   <T extends Any> StructuredResponse<T> create(StructuredResponseCreateParams<T> params)

  Creates a model response. The model's structured output in JSON form will be deserialized automatically into an instance of the class T. See the SDK documentation for more details.

• create

   <T extends Any> StructuredResponse<T> create(StructuredResponseCreateParams<T> params, RequestOptions requestOptions)

  Creates a model response. The model's structured output in JSON form will be deserialized automatically into an instance of the class T. See the SDK documentation for more details.

• createStreaming

  @MustBeClosed() StreamResponse<ResponseStreamEvent> createStreaming()

  Creates a model response. Provide text or image inputs to generate text or JSON outputs. Have the model call your own custom code or use built-in tools like web search or file search to use your own data as input for the model's response.

• createStreaming

  @MustBeClosed() abstract StreamResponse<ResponseStreamEvent> createStreaming(ResponseCreateParams params, RequestOptions requestOptions)

• createStreaming

  @MustBeClosed() StreamResponse<ResponseStreamEvent> createStreaming(ResponseCreateParams params)

• createStreaming

  @MustBeClosed() StreamResponse<ResponseStreamEvent> createStreaming(RequestOptions requestOptions)

• createStreaming

  @MustBeClosed() StreamResponse<ResponseStreamEvent> createStreaming(StructuredResponseCreateParams<?> params)

  Creates a streaming model response for the given response conversation. The input parameters can define a JSON schema derived automatically from an arbitrary class to request a structured output in JSON form. However, that structured output is split over multiple streamed events, so it will not be deserialized automatically into an instance of that class. To deserialize the output, first use a helper class to accumulate the stream of events into a single output value. See the SDK documentation for full details.

• createStreaming

  @MustBeClosed() StreamResponse<ResponseStreamEvent> createStreaming(StructuredResponseCreateParams<?> params, RequestOptions requestOptions)

• retrieve

   Response retrieve(String responseId)

  Retrieves a model response with the given ID.

• retrieve

   Response retrieve(String responseId, ResponseRetrieveParams params, RequestOptions requestOptions)

• retrieve

   Response retrieve(String responseId, ResponseRetrieveParams params)

• retrieve

   abstract Response retrieve(ResponseRetrieveParams params, RequestOptions requestOptions)

• retrieve

   Response retrieve(ResponseRetrieveParams params)

• retrieve

   Response retrieve(String responseId, RequestOptions requestOptions)

• retrieveStreaming

  @MustBeClosed() StreamResponse<ResponseStreamEvent> retrieveStreaming(String responseId)

  Retrieves a model response with the given ID.

• retrieveStreaming

  @MustBeClosed() StreamResponse<ResponseStreamEvent> retrieveStreaming(String responseId, ResponseRetrieveParams params, RequestOptions requestOptions)

• retrieveStreaming

  @MustBeClosed() StreamResponse<ResponseStreamEvent> retrieveStreaming(String responseId, ResponseRetrieveParams params)

• retrieveStreaming

  @MustBeClosed() abstract StreamResponse<ResponseStreamEvent> retrieveStreaming(ResponseRetrieveParams params, RequestOptions requestOptions)

• retrieveStreaming

  @MustBeClosed() StreamResponse<ResponseStreamEvent> retrieveStreaming(ResponseRetrieveParams params)

• retrieveStreaming

  @MustBeClosed() StreamResponse<ResponseStreamEvent> retrieveStreaming(String responseId, RequestOptions requestOptions)

• delete

   Unit delete(String responseId)

  Deletes a model response with the given ID.

• delete

   Unit delete(String responseId, ResponseDeleteParams params, RequestOptions requestOptions)

• delete

   Unit delete(String responseId, ResponseDeleteParams params)

• delete

   abstract Unit delete(ResponseDeleteParams params, RequestOptions requestOptions)

• delete

   Unit delete(ResponseDeleteParams params)

• delete

   Unit delete(String responseId, RequestOptions requestOptions)

• cancel

   Response cancel(String responseId)

  Cancels a model response with the given ID. Only responses created with the background parameter set to true can be cancelled. Learn more.

• cancel

   Response cancel(String responseId, ResponseCancelParams params, RequestOptions requestOptions)

• cancel

   Response cancel(String responseId, ResponseCancelParams params)

• cancel

   abstract Response cancel(ResponseCancelParams params, RequestOptions requestOptions)

• cancel

   Response cancel(ResponseCancelParams params)

• cancel

   Response cancel(String responseId, RequestOptions requestOptions)