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

• inputTokens

   abstract InputTokenService inputTokens()

• create

   BetaResponse 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 BetaResponse create(ResponseCreateParams params, RequestOptions requestOptions)

• create

   BetaResponse create(ResponseCreateParams params)

• create

   BetaResponse create(RequestOptions requestOptions)

• createStreaming

  @MustBeClosed() StreamResponse<BetaResponseStreamEvent> 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<BetaResponseStreamEvent> createStreaming(ResponseCreateParams params, RequestOptions requestOptions)

• createStreaming

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

• createStreaming

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

• retrieve

   BetaResponse retrieve(String responseId)

  Retrieves a model response with the given ID.

• retrieve

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

• retrieve

   BetaResponse retrieve(String responseId, ResponseRetrieveParams params)

• retrieve

   abstract BetaResponse retrieve(ResponseRetrieveParams params, RequestOptions requestOptions)

• retrieve

   BetaResponse retrieve(ResponseRetrieveParams params)

• retrieve

   BetaResponse retrieve(String responseId, RequestOptions requestOptions)

• retrieveStreaming

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

  Retrieves a model response with the given ID.

• retrieveStreaming

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

• retrieveStreaming

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

• retrieveStreaming

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

• retrieveStreaming

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

• retrieveStreaming

  @MustBeClosed() StreamResponse<BetaResponseStreamEvent> 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

   BetaResponse 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

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

• cancel

   BetaResponse cancel(String responseId, ResponseCancelParams params)

• cancel

   abstract BetaResponse cancel(ResponseCancelParams params, RequestOptions requestOptions)

• cancel

   BetaResponse cancel(ResponseCancelParams params)

• cancel

   BetaResponse cancel(String responseId, RequestOptions requestOptions)

• compact

   BetaCompactedResponse compact(ResponseCompactParams params)

  Compact a conversation. Returns a compacted response object.

  Learn when and how to compact long-running conversations in the conversation state guide. For ZDR-compatible compaction details, see Compaction (advanced).

• compact

   abstract BetaCompactedResponse compact(ResponseCompactParams params, RequestOptions requestOptions)