Constructor Detail

Method Detail

• type

   final BetaResponsesClientEvent.ResponseCreate.Builder type(JsonValue type)

  Sets the field to an arbitrary JSON value.

  It is usually unnecessary to call this method because the field defaults to the following:

  JsonValue.from("response.create")

  This method is primarily for setting the field to an undocumented or not yet supported value.

• background

   final BetaResponsesClientEvent.ResponseCreate.Builder background(Boolean background)

  Whether to run the model response in the background. Learn more.

• background

   final BetaResponsesClientEvent.ResponseCreate.Builder background(Boolean background)

  Alias for Builder.background.

  This unboxed primitive overload exists for backwards compatibility.

• background

   final BetaResponsesClientEvent.ResponseCreate.Builder background(Optional<Boolean> background)

  Alias for calling Builder.background with background.orElse(null).

• background

   final BetaResponsesClientEvent.ResponseCreate.Builder background(JsonField<Boolean> background)

  Sets Builder.background to an arbitrary JSON value.

  You should usually call Builder.background with a well-typed Boolean value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• contextManagement

   final BetaResponsesClientEvent.ResponseCreate.Builder contextManagement(List<BetaResponsesClientEvent.ResponseCreate.ContextManagement> contextManagement)

  Context management configuration for this request.

• contextManagement

   final BetaResponsesClientEvent.ResponseCreate.Builder contextManagement(Optional<List<BetaResponsesClientEvent.ResponseCreate.ContextManagement>> contextManagement)

  Alias for calling Builder.contextManagement with contextManagement.orElse(null).

• contextManagement

   final BetaResponsesClientEvent.ResponseCreate.Builder contextManagement(JsonField<List<BetaResponsesClientEvent.ResponseCreate.ContextManagement>> contextManagement)

  Sets Builder.contextManagement to an arbitrary JSON value.

  You should usually call Builder.contextManagement with a well-typed List<ContextManagement> value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• addContextManagement

   final BetaResponsesClientEvent.ResponseCreate.Builder addContextManagement(BetaResponsesClientEvent.ResponseCreate.ContextManagement contextManagement)

  Adds a single ContextManagement to Builder.contextManagement.

• conversation

   final BetaResponsesClientEvent.ResponseCreate.Builder conversation(BetaResponsesClientEvent.ResponseCreate.Conversation conversation)

  The conversation that this response belongs to. Items from this conversation are prepended to input_items for this response request. Input items and output items from this response are automatically added to this conversation after this response completes.

• conversation

   final BetaResponsesClientEvent.ResponseCreate.Builder conversation(Optional<BetaResponsesClientEvent.ResponseCreate.Conversation> conversation)

  Alias for calling Builder.conversation with conversation.orElse(null).

• conversation

   final BetaResponsesClientEvent.ResponseCreate.Builder conversation(JsonField<BetaResponsesClientEvent.ResponseCreate.Conversation> conversation)

  Sets Builder.conversation to an arbitrary JSON value.

  You should usually call Builder.conversation with a well-typed Conversation value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• conversation

   final BetaResponsesClientEvent.ResponseCreate.Builder conversation(String id)

  Alias for calling conversation with Conversation.ofId(id).

• conversation

   final BetaResponsesClientEvent.ResponseCreate.Builder conversation(BetaResponseConversationParam betaResponseConversationParam)

  Alias for calling conversation with Conversation.ofBetaResponseConversationParam(betaResponseConversationParam).

• include

   final BetaResponsesClientEvent.ResponseCreate.Builder include(List<BetaResponseIncludable> include)

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

• include

   final BetaResponsesClientEvent.ResponseCreate.Builder include(Optional<List<BetaResponseIncludable>> include)

  Alias for calling Builder.include with include.orElse(null).

• include

   final BetaResponsesClientEvent.ResponseCreate.Builder include(JsonField<List<BetaResponseIncludable>> include)

  Sets Builder.include to an arbitrary JSON value.

  You should usually call Builder.include with a well-typed List<BetaResponseIncludable> value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• addInclude

   final BetaResponsesClientEvent.ResponseCreate.Builder addInclude(BetaResponseIncludable include)

  Adds a single BetaResponseIncludable to Builder.include.

• input

   final BetaResponsesClientEvent.ResponseCreate.Builder input(BetaResponsesClientEvent.ResponseCreate.Input input)

  Text, image, or file inputs to the model, used to generate a response.

  Learn more:

  • Text inputs and outputs

  • Image inputs

  • File inputs

  • Conversation state

  • Function calling

• input

   final BetaResponsesClientEvent.ResponseCreate.Builder input(JsonField<BetaResponsesClientEvent.ResponseCreate.Input> input)

  Sets Builder.input to an arbitrary JSON value.

  You should usually call Builder.input with a well-typed Input value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• input

   final BetaResponsesClientEvent.ResponseCreate.Builder input(String text)

  Alias for calling input with Input.ofText(text).

• inputOfBetaResponse

   final BetaResponsesClientEvent.ResponseCreate.Builder inputOfBetaResponse(List<BetaResponseInputItem> betaResponse)

  Alias for calling input with Input.ofBetaResponse(betaResponse).

• instructions

   final BetaResponsesClientEvent.ResponseCreate.Builder instructions(String instructions)

  A system (or developer) message inserted into the model's context.

  When using along with previous_response_id, the instructions from a previous response will not be carried over to the next response. This makes it simple to swap out system (or developer) messages in new responses.

• instructions

   final BetaResponsesClientEvent.ResponseCreate.Builder instructions(Optional<String> instructions)

  Alias for calling Builder.instructions with instructions.orElse(null).

• instructions

   final BetaResponsesClientEvent.ResponseCreate.Builder instructions(JsonField<String> instructions)

  Sets Builder.instructions to an arbitrary JSON value.

  You should usually call Builder.instructions with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• maxOutputTokens

   final BetaResponsesClientEvent.ResponseCreate.Builder maxOutputTokens(Long maxOutputTokens)

  An upper bound for the number of tokens that can be generated for a response, including visible output tokens and reasoning tokens.

• maxOutputTokens

   final BetaResponsesClientEvent.ResponseCreate.Builder maxOutputTokens(Long maxOutputTokens)

  Alias for Builder.maxOutputTokens.

  This unboxed primitive overload exists for backwards compatibility.

• maxOutputTokens

   final BetaResponsesClientEvent.ResponseCreate.Builder maxOutputTokens(Optional<Long> maxOutputTokens)

  Alias for calling Builder.maxOutputTokens with maxOutputTokens.orElse(null).

• maxOutputTokens

   final BetaResponsesClientEvent.ResponseCreate.Builder maxOutputTokens(JsonField<Long> maxOutputTokens)

  Sets Builder.maxOutputTokens to an arbitrary JSON value.

  You should usually call Builder.maxOutputTokens with a well-typed Long value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• maxToolCalls

   final BetaResponsesClientEvent.ResponseCreate.Builder maxToolCalls(Long maxToolCalls)

  The maximum number of total calls to built-in tools that can be processed in a response. This maximum number applies across all built-in tool calls, not per individual tool. Any further attempts to call a tool by the model will be ignored.

• maxToolCalls

   final BetaResponsesClientEvent.ResponseCreate.Builder maxToolCalls(Long maxToolCalls)

  Alias for Builder.maxToolCalls.

  This unboxed primitive overload exists for backwards compatibility.

• maxToolCalls

   final BetaResponsesClientEvent.ResponseCreate.Builder maxToolCalls(Optional<Long> maxToolCalls)

  Alias for calling Builder.maxToolCalls with maxToolCalls.orElse(null).

• maxToolCalls

   final BetaResponsesClientEvent.ResponseCreate.Builder maxToolCalls(JsonField<Long> maxToolCalls)

  Sets Builder.maxToolCalls to an arbitrary JSON value.

  You should usually call Builder.maxToolCalls with a well-typed Long value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• metadata

   final BetaResponsesClientEvent.ResponseCreate.Builder metadata(BetaResponsesClientEvent.ResponseCreate.Metadata metadata)

  Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.

  Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.

• metadata

   final BetaResponsesClientEvent.ResponseCreate.Builder metadata(Optional<BetaResponsesClientEvent.ResponseCreate.Metadata> metadata)

  Alias for calling Builder.metadata with metadata.orElse(null).

• metadata

   final BetaResponsesClientEvent.ResponseCreate.Builder metadata(JsonField<BetaResponsesClientEvent.ResponseCreate.Metadata> metadata)

  Sets Builder.metadata to an arbitrary JSON value.

  You should usually call Builder.metadata with a well-typed Metadata value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• model

   final BetaResponsesClientEvent.ResponseCreate.Builder model(BetaResponsesClientEvent.ResponseCreate.Model model)

  Model ID used to generate the response, like gpt-4o or o3. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the model guide to browse and compare available models.

• model

   final BetaResponsesClientEvent.ResponseCreate.Builder model(JsonField<BetaResponsesClientEvent.ResponseCreate.Model> model)

  Sets Builder.model to an arbitrary JSON value.

  You should usually call Builder.model with a well-typed Model value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• model

   final BetaResponsesClientEvent.ResponseCreate.Builder model(String value)

  Sets model to an arbitrary String.

  You should usually call model with a well-typed Model constant instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• moderation

   final BetaResponsesClientEvent.ResponseCreate.Builder moderation(BetaResponsesClientEvent.ResponseCreate.Moderation moderation)

  Configuration for running moderation on the input and output of this response.

• moderation

   final BetaResponsesClientEvent.ResponseCreate.Builder moderation(Optional<BetaResponsesClientEvent.ResponseCreate.Moderation> moderation)

  Alias for calling Builder.moderation with moderation.orElse(null).

• moderation

   final BetaResponsesClientEvent.ResponseCreate.Builder moderation(JsonField<BetaResponsesClientEvent.ResponseCreate.Moderation> moderation)

  Sets Builder.moderation to an arbitrary JSON value.

  You should usually call Builder.moderation with a well-typed Moderation value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• multiAgent

   final BetaResponsesClientEvent.ResponseCreate.Builder multiAgent(BetaResponsesClientEvent.ResponseCreate.MultiAgent multiAgent)

  Configuration for server-hosted multi-agent execution.

• multiAgent

   final BetaResponsesClientEvent.ResponseCreate.Builder multiAgent(Optional<BetaResponsesClientEvent.ResponseCreate.MultiAgent> multiAgent)

  Alias for calling Builder.multiAgent with multiAgent.orElse(null).

• multiAgent

   final BetaResponsesClientEvent.ResponseCreate.Builder multiAgent(JsonField<BetaResponsesClientEvent.ResponseCreate.MultiAgent> multiAgent)

  Sets Builder.multiAgent to an arbitrary JSON value.

  You should usually call Builder.multiAgent with a well-typed MultiAgent value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• parallelToolCalls

   final BetaResponsesClientEvent.ResponseCreate.Builder parallelToolCalls(Boolean parallelToolCalls)

  Whether to allow the model to run tool calls in parallel.

• parallelToolCalls

   final BetaResponsesClientEvent.ResponseCreate.Builder parallelToolCalls(Boolean parallelToolCalls)

  Alias for Builder.parallelToolCalls.

  This unboxed primitive overload exists for backwards compatibility.

• parallelToolCalls

   final BetaResponsesClientEvent.ResponseCreate.Builder parallelToolCalls(Optional<Boolean> parallelToolCalls)

  Alias for calling Builder.parallelToolCalls with parallelToolCalls.orElse(null).

• parallelToolCalls

   final BetaResponsesClientEvent.ResponseCreate.Builder parallelToolCalls(JsonField<Boolean> parallelToolCalls)

  Sets Builder.parallelToolCalls to an arbitrary JSON value.

  You should usually call Builder.parallelToolCalls with a well-typed Boolean value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• previousResponseId

   final BetaResponsesClientEvent.ResponseCreate.Builder previousResponseId(String previousResponseId)

  The unique ID of the previous response to the model. Use this to create multi-turn conversations. Learn more about conversation state. Cannot be used in conjunction with conversation.

• previousResponseId

   final BetaResponsesClientEvent.ResponseCreate.Builder previousResponseId(Optional<String> previousResponseId)

  Alias for calling Builder.previousResponseId with previousResponseId.orElse(null).

• previousResponseId

   final BetaResponsesClientEvent.ResponseCreate.Builder previousResponseId(JsonField<String> previousResponseId)

  Sets Builder.previousResponseId to an arbitrary JSON value.

  You should usually call Builder.previousResponseId with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• prompt

   final BetaResponsesClientEvent.ResponseCreate.Builder prompt(BetaResponsePrompt prompt)

  Reference to a prompt template and its variables. Learn more.

• prompt

   final BetaResponsesClientEvent.ResponseCreate.Builder prompt(Optional<BetaResponsePrompt> prompt)

  Alias for calling Builder.prompt with prompt.orElse(null).

• prompt

   final BetaResponsesClientEvent.ResponseCreate.Builder prompt(JsonField<BetaResponsePrompt> prompt)

  Sets Builder.prompt to an arbitrary JSON value.

  You should usually call Builder.prompt with a well-typed BetaResponsePrompt value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• promptCacheKey

   final BetaResponsesClientEvent.ResponseCreate.Builder promptCacheKey(String promptCacheKey)

  Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the user field. Learn more.

• promptCacheKey

   final BetaResponsesClientEvent.ResponseCreate.Builder promptCacheKey(JsonField<String> promptCacheKey)

  Sets Builder.promptCacheKey to an arbitrary JSON value.

  You should usually call Builder.promptCacheKey with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• promptCacheOptions

   final BetaResponsesClientEvent.ResponseCreate.Builder promptCacheOptions(BetaResponsesClientEvent.ResponseCreate.PromptCacheOptions promptCacheOptions)

  Options for prompt caching. Supported for gpt-5.6 and later models. By default, OpenAI automatically chooses one implicit cache breakpoint. You can add explicit breakpoints to content blocks with prompt_cache_breakpoint. Each request can write up to four breakpoints. For cache matching, OpenAI considers up to the latest 80 breakpoints in the conversation, without a content-block lookback limit. Set mode to explicit to disable the implicit breakpoint. The ttl defaults to 30m, which is currently the only supported value. See the prompt caching guide for current details.

• promptCacheOptions

   final BetaResponsesClientEvent.ResponseCreate.Builder promptCacheOptions(JsonField<BetaResponsesClientEvent.ResponseCreate.PromptCacheOptions> promptCacheOptions)

  Sets Builder.promptCacheOptions to an arbitrary JSON value.

  You should usually call Builder.promptCacheOptions with a well-typed PromptCacheOptions value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• promptCacheRetention

  @Deprecated(message = "deprecated") final BetaResponsesClientEvent.ResponseCreate.Builder promptCacheRetention(BetaResponsesClientEvent.ResponseCreate.PromptCacheRetention promptCacheRetention)

  Deprecated. Use prompt_cache_options.ttl instead.

  The retention policy for the prompt cache. Set to 24h to enable extended prompt caching, which keeps cached prefixes active for longer, up to a maximum of 24 hours. Learn more. This field expresses a maximum retention policy, while prompt_cache_options.ttl expresses a minimum cache lifetime. The two fields are independent and do not interact. For gpt-5.5, gpt-5.5-pro, and future models, only 24h is supported.

  For older models that support both in_memory and 24h, the default depends on your organization's data retention policy:

  • Organizations without ZDR enabled default to 24h.

  • Organizations with ZDR enabled default to in_memory when prompt_cache_retention is not specified.

• promptCacheRetention

  @Deprecated(message = "deprecated") final BetaResponsesClientEvent.ResponseCreate.Builder promptCacheRetention(Optional<BetaResponsesClientEvent.ResponseCreate.PromptCacheRetention> promptCacheRetention)

  Alias for calling Builder.promptCacheRetention with promptCacheRetention.orElse(null).

• promptCacheRetention

  @Deprecated(message = "deprecated") final BetaResponsesClientEvent.ResponseCreate.Builder promptCacheRetention(JsonField<BetaResponsesClientEvent.ResponseCreate.PromptCacheRetention> promptCacheRetention)

  Sets Builder.promptCacheRetention to an arbitrary JSON value.

  You should usually call Builder.promptCacheRetention with a well-typed PromptCacheRetention value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• reasoning

   final BetaResponsesClientEvent.ResponseCreate.Builder reasoning(BetaResponsesClientEvent.ResponseCreate.Reasoning reasoning)

  gpt-5 and o-series models only

  Configuration options for reasoning models.

• reasoning

   final BetaResponsesClientEvent.ResponseCreate.Builder reasoning(Optional<BetaResponsesClientEvent.ResponseCreate.Reasoning> reasoning)

  Alias for calling Builder.reasoning with reasoning.orElse(null).

• reasoning

   final BetaResponsesClientEvent.ResponseCreate.Builder reasoning(JsonField<BetaResponsesClientEvent.ResponseCreate.Reasoning> reasoning)

  Sets Builder.reasoning to an arbitrary JSON value.

  You should usually call Builder.reasoning with a well-typed Reasoning value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• safetyIdentifier

   final BetaResponsesClientEvent.ResponseCreate.Builder safetyIdentifier(String safetyIdentifier)

  A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies. The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. Learn more.

• safetyIdentifier

   final BetaResponsesClientEvent.ResponseCreate.Builder safetyIdentifier(JsonField<String> safetyIdentifier)

  Sets Builder.safetyIdentifier to an arbitrary JSON value.

  You should usually call Builder.safetyIdentifier with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• serviceTier

   final BetaResponsesClientEvent.ResponseCreate.Builder serviceTier(BetaResponsesClientEvent.ResponseCreate.ServiceTier serviceTier)

  Specifies the processing type used for serving the request.

  • If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'.

  • If set to 'default', then the request will be processed with the standard pricing and performance for the selected model.

  • If set to 'flex' or 'priority', then the request will be processed with the corresponding service tier.

  • When not set, the default behavior is 'auto'.

  When the service_tier parameter is set, the response body will include the service_tier value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter.

• serviceTier

   final BetaResponsesClientEvent.ResponseCreate.Builder serviceTier(Optional<BetaResponsesClientEvent.ResponseCreate.ServiceTier> serviceTier)

  Alias for calling Builder.serviceTier with serviceTier.orElse(null).

• serviceTier

   final BetaResponsesClientEvent.ResponseCreate.Builder serviceTier(JsonField<BetaResponsesClientEvent.ResponseCreate.ServiceTier> serviceTier)

  Sets Builder.serviceTier to an arbitrary JSON value.

  You should usually call Builder.serviceTier with a well-typed ServiceTier value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• store

   final BetaResponsesClientEvent.ResponseCreate.Builder store(Boolean store)

  Whether to store the generated model response for later retrieval via API.

• store

   final BetaResponsesClientEvent.ResponseCreate.Builder store(Boolean store)

  Alias for Builder.store.

  This unboxed primitive overload exists for backwards compatibility.

• store

   final BetaResponsesClientEvent.ResponseCreate.Builder store(Optional<Boolean> store)

  Alias for calling Builder.store with store.orElse(null).

• store

   final BetaResponsesClientEvent.ResponseCreate.Builder store(JsonField<Boolean> store)

  Sets Builder.store to an arbitrary JSON value.

  You should usually call Builder.store with a well-typed Boolean value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• stream

   final BetaResponsesClientEvent.ResponseCreate.Builder stream(Boolean stream)

  If set to true, the model response data will be streamed to the client as it is generated using server-sent events. See the Streaming section below for more information.

• stream

   final BetaResponsesClientEvent.ResponseCreate.Builder stream(Boolean stream)

  Alias for Builder.stream.

  This unboxed primitive overload exists for backwards compatibility.

• stream

   final BetaResponsesClientEvent.ResponseCreate.Builder stream(Optional<Boolean> stream)

  Alias for calling Builder.stream with stream.orElse(null).

• stream

   final BetaResponsesClientEvent.ResponseCreate.Builder stream(JsonField<Boolean> stream)

  Sets Builder.stream to an arbitrary JSON value.

  You should usually call Builder.stream with a well-typed Boolean value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• streamOptions

   final BetaResponsesClientEvent.ResponseCreate.Builder streamOptions(BetaResponsesClientEvent.ResponseCreate.StreamOptions streamOptions)

  Options for streaming responses. Only set this when you set stream: true.

• streamOptions

   final BetaResponsesClientEvent.ResponseCreate.Builder streamOptions(Optional<BetaResponsesClientEvent.ResponseCreate.StreamOptions> streamOptions)

  Alias for calling Builder.streamOptions with streamOptions.orElse(null).

• streamOptions

   final BetaResponsesClientEvent.ResponseCreate.Builder streamOptions(JsonField<BetaResponsesClientEvent.ResponseCreate.StreamOptions> streamOptions)

  Sets Builder.streamOptions to an arbitrary JSON value.

  You should usually call Builder.streamOptions with a well-typed StreamOptions value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• temperature

   final BetaResponsesClientEvent.ResponseCreate.Builder temperature(Double temperature)

  What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or top_p but not both.

• temperature

   final BetaResponsesClientEvent.ResponseCreate.Builder temperature(Double temperature)

  Alias for Builder.temperature.

  This unboxed primitive overload exists for backwards compatibility.

• temperature

   final BetaResponsesClientEvent.ResponseCreate.Builder temperature(Optional<Double> temperature)

  Alias for calling Builder.temperature with temperature.orElse(null).

• temperature

   final BetaResponsesClientEvent.ResponseCreate.Builder temperature(JsonField<Double> temperature)

  Sets Builder.temperature to an arbitrary JSON value.

  You should usually call Builder.temperature with a well-typed Double value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• text

   final BetaResponsesClientEvent.ResponseCreate.Builder text(BetaResponseTextConfig text)

  Configuration options for a text response from the model. Can be plain text or structured JSON data. Learn more:

  • Text inputs and outputs

  • Structured Outputs

• text

   final BetaResponsesClientEvent.ResponseCreate.Builder text(JsonField<BetaResponseTextConfig> text)

  Sets Builder.text to an arbitrary JSON value.

  You should usually call Builder.text with a well-typed BetaResponseTextConfig value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• toolChoice

   final BetaResponsesClientEvent.ResponseCreate.Builder toolChoice(BetaResponsesClientEvent.ResponseCreate.ToolChoice toolChoice)

  How the model should select which tool (or tools) to use when generating a response. See the tools parameter to see how to specify which tools the model can call.

• toolChoice

   final BetaResponsesClientEvent.ResponseCreate.Builder toolChoice(JsonField<BetaResponsesClientEvent.ResponseCreate.ToolChoice> toolChoice)

  Sets Builder.toolChoice to an arbitrary JSON value.

  You should usually call Builder.toolChoice with a well-typed ToolChoice value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• toolChoice

   final BetaResponsesClientEvent.ResponseCreate.Builder toolChoice(BetaToolChoiceOptions betaToolChoiceOptions)

  Alias for calling toolChoice with ToolChoice.ofBetaToolChoiceOptions(betaToolChoiceOptions).

• toolChoice

   final BetaResponsesClientEvent.ResponseCreate.Builder toolChoice(BetaToolChoiceAllowed betaToolChoiceAllowed)

  Alias for calling toolChoice with ToolChoice.ofBetaToolChoiceAllowed(betaToolChoiceAllowed).

• toolChoice

   final BetaResponsesClientEvent.ResponseCreate.Builder toolChoice(BetaToolChoiceTypes betaToolChoiceTypes)

  Alias for calling toolChoice with ToolChoice.ofBetaToolChoiceTypes(betaToolChoiceTypes).

• toolChoice

   final BetaResponsesClientEvent.ResponseCreate.Builder toolChoice(BetaToolChoiceFunction betaToolChoiceFunction)

  Alias for calling toolChoice with ToolChoice.ofBetaToolChoiceFunction(betaToolChoiceFunction).

• toolChoice

   final BetaResponsesClientEvent.ResponseCreate.Builder toolChoice(BetaToolChoiceMcp betaToolChoiceMcp)

  Alias for calling toolChoice with ToolChoice.ofBetaToolChoiceMcp(betaToolChoiceMcp).

• toolChoice

   final BetaResponsesClientEvent.ResponseCreate.Builder toolChoice(BetaToolChoiceCustom betaToolChoiceCustom)

  Alias for calling toolChoice with ToolChoice.ofBetaToolChoiceCustom(betaToolChoiceCustom).

• toolChoice

   final BetaResponsesClientEvent.ResponseCreate.Builder toolChoice(BetaToolChoiceApplyPatch betaToolChoiceApplyPatch)

  Alias for calling toolChoice with ToolChoice.ofBetaToolChoiceApplyPatch(betaToolChoiceApplyPatch).

• toolChoice

   final BetaResponsesClientEvent.ResponseCreate.Builder toolChoice(BetaToolChoiceShell betaToolChoiceShell)

  Alias for calling toolChoice with ToolChoice.ofBetaToolChoiceShell(betaToolChoiceShell).

• toolChoiceBetaSpecificProgrammaticToolCallingParam

   final BetaResponsesClientEvent.ResponseCreate.Builder toolChoiceBetaSpecificProgrammaticToolCallingParam()

  Alias for calling toolChoice with ToolChoice.ofBetaSpecificProgrammaticToolCallingParam().

• tools

   final BetaResponsesClientEvent.ResponseCreate.Builder tools(List<BetaTool> tools)

  An array of tools the model may call while generating a response. You can specify which tool to use by setting the tool_choice parameter.

  We support the following categories of tools:

  • Built-in tools: Tools that are provided by OpenAI that extend the model's capabilities, like web search or file search. Learn more about built-in tools.

  • MCP Tools: Integrations with third-party systems via custom MCP servers or predefined connectors such as Google Drive and SharePoint. Learn more about MCP Tools.

  • Function calls (custom tools): Functions that are defined by you, enabling the model to call your own code with strongly typed arguments and outputs. Learn more about function calling. You can also use custom tools to call your own code.

• tools

   final BetaResponsesClientEvent.ResponseCreate.Builder tools(JsonField<List<BetaTool>> tools)

  Sets Builder.tools to an arbitrary JSON value.

  You should usually call Builder.tools with a well-typed List<BetaTool> value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• addTool

   final BetaResponsesClientEvent.ResponseCreate.Builder addTool(BetaTool tool)

  Adds a single BetaTool to tools.

• addTool

   final BetaResponsesClientEvent.ResponseCreate.Builder addTool(BetaFunctionTool function)

  Alias for calling addTool with BetaTool.ofFunction(function).

• addTool

   final BetaResponsesClientEvent.ResponseCreate.Builder addTool(BetaFileSearchTool fileSearch)

  Alias for calling addTool with BetaTool.ofFileSearch(fileSearch).

• addTool

   final BetaResponsesClientEvent.ResponseCreate.Builder addTool(BetaComputerTool computer)

  Alias for calling addTool with BetaTool.ofComputer(computer).

• addTool

   final BetaResponsesClientEvent.ResponseCreate.Builder addTool(BetaComputerUsePreviewTool computerUsePreview)

  Alias for calling addTool with BetaTool.ofComputerUsePreview(computerUsePreview).

• addTool

   final BetaResponsesClientEvent.ResponseCreate.Builder addTool(BetaWebSearchTool webSearch)

  Alias for calling addTool with BetaTool.ofWebSearch(webSearch).

• addTool

   final BetaResponsesClientEvent.ResponseCreate.Builder addTool(BetaTool.Mcp mcp)

  Alias for calling addTool with BetaTool.ofMcp(mcp).

• addTool

   final BetaResponsesClientEvent.ResponseCreate.Builder addTool(BetaTool.CodeInterpreter codeInterpreter)

  Alias for calling addTool with BetaTool.ofCodeInterpreter(codeInterpreter).

• addTool

   final BetaResponsesClientEvent.ResponseCreate.Builder addTool(BetaTool.ImageGeneration imageGeneration)

  Alias for calling addTool with BetaTool.ofImageGeneration(imageGeneration).

• addTool

   final BetaResponsesClientEvent.ResponseCreate.Builder addTool(BetaFunctionShellTool shell)

  Alias for calling addTool with BetaTool.ofShell(shell).

• addTool

   final BetaResponsesClientEvent.ResponseCreate.Builder addTool(BetaCustomTool custom)

  Alias for calling addTool with BetaTool.ofCustom(custom).

• addTool

   final BetaResponsesClientEvent.ResponseCreate.Builder addTool(BetaNamespaceTool namespace)

  Alias for calling addTool with BetaTool.ofNamespace(namespace).

• addTool

   final BetaResponsesClientEvent.ResponseCreate.Builder addTool(BetaToolSearchTool toolSearch)

  Alias for calling addTool with BetaTool.ofToolSearch(toolSearch).

• addTool

   final BetaResponsesClientEvent.ResponseCreate.Builder addTool(BetaWebSearchPreviewTool webSearchPreview)

  Alias for calling addTool with BetaTool.ofWebSearchPreview(webSearchPreview).

• addTool

   final BetaResponsesClientEvent.ResponseCreate.Builder addTool(BetaApplyPatchTool applyPatch)

  Alias for calling addTool with BetaTool.ofApplyPatch(applyPatch).

• addFileSearchTool

   final BetaResponsesClientEvent.ResponseCreate.Builder addFileSearchTool(List<String> vectorStoreIds)

  Alias for calling addTool with the following:

  BetaFileSearchTool.builder()
      .vectorStoreIds(vectorStoreIds)
      .build()

• addMcpTool

   final BetaResponsesClientEvent.ResponseCreate.Builder addMcpTool(String serverLabel)

  Alias for calling addTool with the following:

  BetaTool.Mcp.builder()
      .serverLabel(serverLabel)
      .build()

• addCodeInterpreterTool

   final BetaResponsesClientEvent.ResponseCreate.Builder addCodeInterpreterTool(BetaTool.CodeInterpreter.Container container)

  Alias for calling addTool with the following:

  BetaTool.CodeInterpreter.builder()
      .container(container)
      .build()

• addCodeInterpreterTool

   final BetaResponsesClientEvent.ResponseCreate.Builder addCodeInterpreterTool(String string)

  Alias for calling addCodeInterpreterTool with BetaTool.CodeInterpreter.Container.ofString(string).

• addCodeInterpreterTool

   final BetaResponsesClientEvent.ResponseCreate.Builder addCodeInterpreterTool(BetaTool.CodeInterpreter.Container.CodeInterpreterToolAuto codeInterpreterToolAuto)

  Alias for calling addCodeInterpreterTool with BetaTool.CodeInterpreter.Container.ofCodeInterpreterToolAuto(codeInterpreterToolAuto).

• addToolProgrammaticToolCalling

   final BetaResponsesClientEvent.ResponseCreate.Builder addToolProgrammaticToolCalling()

  Alias for calling addTool with BetaTool.ofProgrammaticToolCalling().

• addToolLocalShell

   final BetaResponsesClientEvent.ResponseCreate.Builder addToolLocalShell()

  Alias for calling addTool with BetaTool.ofLocalShell().

• addCustomTool

   final BetaResponsesClientEvent.ResponseCreate.Builder addCustomTool(String name)

  Alias for calling addTool with the following:

  BetaCustomTool.builder()
      .name(name)
      .build()

• topLogprobs

   final BetaResponsesClientEvent.ResponseCreate.Builder topLogprobs(Long topLogprobs)

  An integer between 0 and 20 specifying the maximum number of most likely tokens to return at each token position, each with an associated log probability. In some cases, the number of returned tokens may be fewer than requested.

• topLogprobs

   final BetaResponsesClientEvent.ResponseCreate.Builder topLogprobs(Long topLogprobs)

  Alias for Builder.topLogprobs.

  This unboxed primitive overload exists for backwards compatibility.

• topLogprobs

   final BetaResponsesClientEvent.ResponseCreate.Builder topLogprobs(Optional<Long> topLogprobs)

  Alias for calling Builder.topLogprobs with topLogprobs.orElse(null).

• topLogprobs

   final BetaResponsesClientEvent.ResponseCreate.Builder topLogprobs(JsonField<Long> topLogprobs)

  Sets Builder.topLogprobs to an arbitrary JSON value.

  You should usually call Builder.topLogprobs with a well-typed Long value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• topP

   final BetaResponsesClientEvent.ResponseCreate.Builder topP(Double topP)

  An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.

  We generally recommend altering this or temperature but not both.

• topP

   final BetaResponsesClientEvent.ResponseCreate.Builder topP(Double topP)

  Alias for Builder.topP.

  This unboxed primitive overload exists for backwards compatibility.

• topP

   final BetaResponsesClientEvent.ResponseCreate.Builder topP(Optional<Double> topP)

  Alias for calling Builder.topP with topP.orElse(null).

• topP

   final BetaResponsesClientEvent.ResponseCreate.Builder topP(JsonField<Double> topP)

  Sets Builder.topP to an arbitrary JSON value.

  You should usually call Builder.topP with a well-typed Double value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• truncation

  @Deprecated(message = "deprecated") final BetaResponsesClientEvent.ResponseCreate.Builder truncation(BetaResponsesClientEvent.ResponseCreate.Truncation truncation)

  The truncation strategy to use for the model response.

  • auto: If the input to this Response exceeds the model's context window size, the model will truncate the response to fit the context window by dropping items from the beginning of the conversation.

  • disabled (default): If the input size will exceed the context window size for a model, the request will fail with a 400 error.

• truncation

  @Deprecated(message = "deprecated") final BetaResponsesClientEvent.ResponseCreate.Builder truncation(Optional<BetaResponsesClientEvent.ResponseCreate.Truncation> truncation)

  Alias for calling Builder.truncation with truncation.orElse(null).

• truncation

  @Deprecated(message = "deprecated") final BetaResponsesClientEvent.ResponseCreate.Builder truncation(JsonField<BetaResponsesClientEvent.ResponseCreate.Truncation> truncation)

  Sets Builder.truncation to an arbitrary JSON value.

  You should usually call Builder.truncation with a well-typed Truncation value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• user

  @Deprecated(message = "deprecated") final BetaResponsesClientEvent.ResponseCreate.Builder user(String user)

  This field is being replaced by safety_identifier and prompt_cache_key. Use prompt_cache_key instead to maintain caching optimizations. A stable identifier for your end-users. Used to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. Learn more.

• user

  @Deprecated(message = "deprecated") final BetaResponsesClientEvent.ResponseCreate.Builder user(JsonField<String> user)

  Sets Builder.user to an arbitrary JSON value.

  You should usually call Builder.user with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• additionalProperties

   final BetaResponsesClientEvent.ResponseCreate.Builder additionalProperties(Map<String, JsonValue> additionalProperties)

• putAdditionalProperty

   final BetaResponsesClientEvent.ResponseCreate.Builder putAdditionalProperty(String key, JsonValue value)

• putAllAdditionalProperties

   final BetaResponsesClientEvent.ResponseCreate.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)

• removeAdditionalProperty

   final BetaResponsesClientEvent.ResponseCreate.Builder removeAdditionalProperty(String key)

• removeAllAdditionalProperties

   final BetaResponsesClientEvent.ResponseCreate.Builder removeAllAdditionalProperties(Set<String> keys)

• build

   final BetaResponsesClientEvent.ResponseCreate build()

  Returns an immutable instance of ResponseCreate.

  Further updates to this Builder will not mutate the returned instance.