openaiRtools (version 0.2.2)

ResponsesClient: Responses Client

Description

The Responses API is OpenAI's next-generation API that simplifies multi-turn conversations (via previous_response_id), supports web search, file search, and computer use as built-in tools, and provides a cleaner interface than Chat Completions for complex agentic applications.

Methods

Public methods

• ResponsesClient$new()

• ResponsesClient$create()

• ResponsesClient$retrieve()

• ResponsesClient$delete()

• ResponsesClient$cancel()

• ResponsesClient$list_input_items()

• ResponsesClient$clone()

---

Method new()

Usage

ResponsesClient$new(parent)

---

Method create()

Usage

ResponsesClient$create(
  model,
  input,
  instructions = NULL,
  previous_response_id = NULL,
  tools = NULL,
  tool_choice = NULL,
  parallel_tool_calls = NULL,
  max_output_tokens = NULL,
  max_completion_tokens = NULL,
  temperature = NULL,
  top_p = NULL,
  truncation = NULL,
  metadata = NULL,
  reasoning = NULL,
  service_tier = NULL,
  prompt_cache_key = NULL,
  prompt_cache_retention = NULL,
  include = NULL,
  store = NULL,
  stream = NULL,
  callback = NULL
)

---

Method retrieve()

Usage

ResponsesClient$retrieve(response_id)

---

Method delete()

Usage

ResponsesClient$delete(response_id)

---

Method cancel()

Usage

ResponsesClient$cancel(response_id)

---

Method list_input_items()

Usage

ResponsesClient$list_input_items(response_id, after = NULL, limit = NULL)

---

Method clone()

The objects of this class are cloneable with this method.

Usage

ResponsesClient$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Details

Client for the OpenAI Responses API — a new, unified API for generating text responses, managing multi-turn conversations, and using built-in tools. Access via client$responses.