Constructor Detail

Method Detail

• input

   final StructuredResponseCreateParams.Builder<T> input(ResponseCreateParams.Input input)

• input

   final StructuredResponseCreateParams.Builder<T> input(JsonField<ResponseCreateParams.Input> input)

• input

   final StructuredResponseCreateParams.Builder<T> input(String text)

• inputOfResponse

   final StructuredResponseCreateParams.Builder<T> inputOfResponse(List<ResponseInputItem> response)

• model

   final StructuredResponseCreateParams.Builder<T> model(ResponsesModel model)

• model

   final StructuredResponseCreateParams.Builder<T> model(JsonField<ResponsesModel> model)

• model

   final StructuredResponseCreateParams.Builder<T> model(String string)

• model

   final StructuredResponseCreateParams.Builder<T> model(ChatModel chat)

• model

   final StructuredResponseCreateParams.Builder<T> model(ResponsesModel.ResponsesOnlyModel only)

• background

   final StructuredResponseCreateParams.Builder<T> background(Boolean background)

• background

   final StructuredResponseCreateParams.Builder<T> background(Boolean background)

• background

   final StructuredResponseCreateParams.Builder<T> background(Optional<Boolean> background)

• background

   final StructuredResponseCreateParams.Builder<T> background(JsonField<Boolean> background)

• conversation

   final StructuredResponseCreateParams.Builder<T> conversation(ResponseCreateParams.Conversation conversation)

• conversation

   final StructuredResponseCreateParams.Builder<T> conversation(Optional<ResponseCreateParams.Conversation> conversation)

• conversation

   final StructuredResponseCreateParams.Builder<T> conversation(JsonField<ResponseCreateParams.Conversation> conversation)

• conversation

   final StructuredResponseCreateParams.Builder<T> conversation(String id)

• conversation

   final StructuredResponseCreateParams.Builder<T> conversation(ResponseConversationParam responseConversationParam)

• include

   final StructuredResponseCreateParams.Builder<T> include(List<ResponseIncludable> include)

• include

   final StructuredResponseCreateParams.Builder<T> include(Optional<List<ResponseIncludable>> include)

• include

   final StructuredResponseCreateParams.Builder<T> include(JsonField<List<ResponseIncludable>> include)

• addInclude

   final StructuredResponseCreateParams.Builder<T> addInclude(ResponseIncludable include)

• instructions

   final StructuredResponseCreateParams.Builder<T> instructions(String instructions)

• instructions

   final StructuredResponseCreateParams.Builder<T> instructions(Optional<String> instructions)

• instructions

   final StructuredResponseCreateParams.Builder<T> instructions(JsonField<String> instructions)

• maxOutputTokens

   final StructuredResponseCreateParams.Builder<T> maxOutputTokens(Long maxOutputTokens)

• maxOutputTokens

   final StructuredResponseCreateParams.Builder<T> maxOutputTokens(Long maxOutputTokens)

• maxOutputTokens

   final StructuredResponseCreateParams.Builder<T> maxOutputTokens(Optional<Long> maxOutputTokens)

• maxOutputTokens

   final StructuredResponseCreateParams.Builder<T> maxOutputTokens(JsonField<Long> maxOutputTokens)

• maxToolCalls

   final StructuredResponseCreateParams.Builder<T> maxToolCalls(Long maxToolCalls)

• maxToolCalls

   final StructuredResponseCreateParams.Builder<T> maxToolCalls(Long maxToolCalls)

• maxToolCalls

   final StructuredResponseCreateParams.Builder<T> maxToolCalls(Optional<Long> maxToolCalls)

• maxToolCalls

   final StructuredResponseCreateParams.Builder<T> maxToolCalls(JsonField<Long> maxToolCalls)

• metadata

   final StructuredResponseCreateParams.Builder<T> metadata(ResponseCreateParams.Metadata metadata)

• metadata

   final StructuredResponseCreateParams.Builder<T> metadata(Optional<ResponseCreateParams.Metadata> metadata)

• metadata

   final StructuredResponseCreateParams.Builder<T> metadata(JsonField<ResponseCreateParams.Metadata> metadata)

• parallelToolCalls

   final StructuredResponseCreateParams.Builder<T> parallelToolCalls(Boolean parallelToolCalls)

• parallelToolCalls

   final StructuredResponseCreateParams.Builder<T> parallelToolCalls(Boolean parallelToolCalls)

• parallelToolCalls

   final StructuredResponseCreateParams.Builder<T> parallelToolCalls(Optional<Boolean> parallelToolCalls)

• parallelToolCalls

   final StructuredResponseCreateParams.Builder<T> parallelToolCalls(JsonField<Boolean> parallelToolCalls)

• previousResponseId

   final StructuredResponseCreateParams.Builder<T> previousResponseId(String previousResponseId)

• previousResponseId

   final StructuredResponseCreateParams.Builder<T> previousResponseId(Optional<String> previousResponseId)

• previousResponseId

   final StructuredResponseCreateParams.Builder<T> previousResponseId(JsonField<String> previousResponseId)

• prompt

   final StructuredResponseCreateParams.Builder<T> prompt(ResponsePrompt prompt)

• prompt

   final StructuredResponseCreateParams.Builder<T> prompt(Optional<ResponsePrompt> prompt)

• prompt

   final StructuredResponseCreateParams.Builder<T> prompt(JsonField<ResponsePrompt> prompt)

• promptCacheKey

   final StructuredResponseCreateParams.Builder<T> promptCacheKey(String promptCacheKey)

• promptCacheKey

   final StructuredResponseCreateParams.Builder<T> promptCacheKey(JsonField<String> promptCacheKey)

• reasoning

   final StructuredResponseCreateParams.Builder<T> reasoning(Reasoning reasoning)

• reasoning

   final StructuredResponseCreateParams.Builder<T> reasoning(Optional<Reasoning> reasoning)

• reasoning

   final StructuredResponseCreateParams.Builder<T> reasoning(JsonField<Reasoning> reasoning)

• safetyIdentifier

   final StructuredResponseCreateParams.Builder<T> safetyIdentifier(String safetyIdentifier)

• safetyIdentifier

   final StructuredResponseCreateParams.Builder<T> safetyIdentifier(JsonField<String> safetyIdentifier)

• serviceTier

   final StructuredResponseCreateParams.Builder<T> serviceTier(ResponseCreateParams.ServiceTier serviceTier)

• serviceTier

   final StructuredResponseCreateParams.Builder<T> serviceTier(Optional<ResponseCreateParams.ServiceTier> serviceTier)

• serviceTier

   final StructuredResponseCreateParams.Builder<T> serviceTier(JsonField<ResponseCreateParams.ServiceTier> serviceTier)

• store

   final StructuredResponseCreateParams.Builder<T> store(Boolean store)

• store

   final StructuredResponseCreateParams.Builder<T> store(Boolean store)

• store

   final StructuredResponseCreateParams.Builder<T> store(Optional<Boolean> store)

• store

   final StructuredResponseCreateParams.Builder<T> store(JsonField<Boolean> store)

• temperature

   final StructuredResponseCreateParams.Builder<T> temperature(Double temperature)

• temperature

   final StructuredResponseCreateParams.Builder<T> temperature(Double temperature)

• temperature

   final StructuredResponseCreateParams.Builder<T> temperature(Optional<Double> temperature)

• temperature

   final StructuredResponseCreateParams.Builder<T> temperature(JsonField<Double> temperature)

• text

  @JvmOverloads() final StructuredResponseCreateParams.Builder<T> text(Class<T> responseType, JsonSchemaLocalValidation localValidation)

  Sets the text configuration's format to a JSON schema derived from the structure of the given class.

• text

  @JvmOverloads() final StructuredResponseCreateParams.Builder<T> text(Class<T> responseType)

  Sets the text configuration's format to a JSON schema derived from the structure of the given class.

• text

   final StructuredResponseCreateParams.Builder<T> text(StructuredResponseTextConfig<T> text)

  Sets the text configuration to a StructuredResponseTextConfig where the format was set to a JSON schema derived from the structure of a class.

• toolChoice

   final StructuredResponseCreateParams.Builder<T> toolChoice(ResponseCreateParams.ToolChoice toolChoice)

• toolChoice

   final StructuredResponseCreateParams.Builder<T> toolChoice(JsonField<ResponseCreateParams.ToolChoice> toolChoice)

• toolChoice

   final StructuredResponseCreateParams.Builder<T> toolChoice(ToolChoiceOptions options)

• toolChoice

   final StructuredResponseCreateParams.Builder<T> toolChoice(ToolChoiceTypes types)

• toolChoice

   final StructuredResponseCreateParams.Builder<T> toolChoice(ToolChoiceFunction function)

• toolChoice

   final StructuredResponseCreateParams.Builder<T> toolChoice(ToolChoiceMcp mcp)

• toolChoice

   final StructuredResponseCreateParams.Builder<T> toolChoice(ToolChoiceAllowed allowed)

• toolChoice

   final StructuredResponseCreateParams.Builder<T> toolChoice(ToolChoiceCustom custom)

• tools

   final StructuredResponseCreateParams.Builder<T> tools(List<Tool> tools)

• tools

   final StructuredResponseCreateParams.Builder<T> tools(JsonField<List<Tool>> tools)

• addTool

   final StructuredResponseCreateParams.Builder<T> addTool(Tool tool)

• addTool

   final StructuredResponseCreateParams.Builder<T> addTool(FunctionTool function)

• addTool

  @JvmOverloads() final StructuredResponseCreateParams.Builder<T> addTool(Class<?> functionParametersType, JsonSchemaLocalValidation localValidation)

• addTool

  @JvmOverloads() final StructuredResponseCreateParams.Builder<T> addTool(Class<?> functionParametersType)

• addTool

   final StructuredResponseCreateParams.Builder<T> addTool(FileSearchTool fileSearch)

• addTool

   final StructuredResponseCreateParams.Builder<T> addTool(WebSearchTool webSearch)

• addTool

   final StructuredResponseCreateParams.Builder<T> addTool(WebSearchPreviewTool webSearchPreview)

• addTool

   final StructuredResponseCreateParams.Builder<T> addTool(ComputerTool computerUsePreview)

• addTool

   final StructuredResponseCreateParams.Builder<T> addTool(Tool.Mcp mcp)

• addTool

   final StructuredResponseCreateParams.Builder<T> addTool(Tool.CodeInterpreter codeInterpreter)

• addTool

   final StructuredResponseCreateParams.Builder<T> addTool(Tool.ImageGeneration imageGeneration)

• addTool

   final StructuredResponseCreateParams.Builder<T> addTool(CustomTool custom)

• addFileSearchTool

   final StructuredResponseCreateParams.Builder<T> addFileSearchTool(List<String> vectorStoreIds)

• addMcpTool

   final StructuredResponseCreateParams.Builder<T> addMcpTool(String serverLabel)

• addCodeInterpreterTool

   final StructuredResponseCreateParams.Builder<T> addCodeInterpreterTool(Tool.CodeInterpreter.Container container)

• addCodeInterpreterTool

   final StructuredResponseCreateParams.Builder<T> addCodeInterpreterTool(String string)

• addCodeInterpreterTool

   final StructuredResponseCreateParams.Builder<T> addCodeInterpreterTool(Tool.CodeInterpreter.Container.CodeInterpreterToolAuto codeInterpreterToolAuto)

• addToolLocalShell

   final StructuredResponseCreateParams.Builder<T> addToolLocalShell()

• addCustomTool

   final StructuredResponseCreateParams.Builder<T> addCustomTool(String name)

• topP

   final StructuredResponseCreateParams.Builder<T> topP(Double topP)

• topP

   final StructuredResponseCreateParams.Builder<T> topP(Double topP)

• topP

   final StructuredResponseCreateParams.Builder<T> topP(Optional<Double> topP)

• topP

   final StructuredResponseCreateParams.Builder<T> topP(JsonField<Double> topP)

• topLogprobs

   final StructuredResponseCreateParams.Builder<T> topLogprobs(Long topLogprobs)

• topLogprobs

   final StructuredResponseCreateParams.Builder<T> topLogprobs(Long topLogprobs)

• topLogprobs

   final StructuredResponseCreateParams.Builder<T> topLogprobs(Optional<Long> topLogprobs)

• topLogprobs

   final StructuredResponseCreateParams.Builder<T> topLogprobs(JsonField<Long> topLogprobs)

• truncation

   final StructuredResponseCreateParams.Builder<T> truncation(ResponseCreateParams.Truncation truncation)

• truncation

   final StructuredResponseCreateParams.Builder<T> truncation(Optional<ResponseCreateParams.Truncation> truncation)

• truncation

   final StructuredResponseCreateParams.Builder<T> truncation(JsonField<ResponseCreateParams.Truncation> truncation)

• streamOptions

   final StructuredResponseCreateParams.Builder<T> streamOptions(ResponseCreateParams.StreamOptions streamOptions)

• streamOptions

   final StructuredResponseCreateParams.Builder<T> streamOptions(Optional<ResponseCreateParams.StreamOptions> streamOptions)

• streamOptions

   final StructuredResponseCreateParams.Builder<T> streamOptions(JsonField<ResponseCreateParams.StreamOptions> streamOptions)

• user

   final StructuredResponseCreateParams.Builder<T> user(String user)

• user

   final StructuredResponseCreateParams.Builder<T> user(JsonField<String> user)

• additionalBodyProperties

   final StructuredResponseCreateParams.Builder<T> additionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)

• putAdditionalBodyProperty

   final StructuredResponseCreateParams.Builder<T> putAdditionalBodyProperty(String key, JsonValue value)

• putAllAdditionalBodyProperties

   final StructuredResponseCreateParams.Builder<T> putAllAdditionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)

• removeAdditionalBodyProperty

   final StructuredResponseCreateParams.Builder<T> removeAdditionalBodyProperty(String key)

• removeAllAdditionalBodyProperties

   final StructuredResponseCreateParams.Builder<T> removeAllAdditionalBodyProperties(Set<String> keys)

• additionalHeaders

   final StructuredResponseCreateParams.Builder<T> additionalHeaders(Headers additionalHeaders)

• additionalHeaders

   final StructuredResponseCreateParams.Builder<T> additionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• putAdditionalHeader

   final StructuredResponseCreateParams.Builder<T> putAdditionalHeader(String name, String value)

• putAdditionalHeaders

   final StructuredResponseCreateParams.Builder<T> putAdditionalHeaders(String name, Iterable<String> values)

• putAllAdditionalHeaders

   final StructuredResponseCreateParams.Builder<T> putAllAdditionalHeaders(Headers additionalHeaders)

• putAllAdditionalHeaders

   final StructuredResponseCreateParams.Builder<T> putAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• replaceAdditionalHeaders

   final StructuredResponseCreateParams.Builder<T> replaceAdditionalHeaders(String name, String value)

• replaceAdditionalHeaders

   final StructuredResponseCreateParams.Builder<T> replaceAdditionalHeaders(String name, Iterable<String> values)

• replaceAllAdditionalHeaders

   final StructuredResponseCreateParams.Builder<T> replaceAllAdditionalHeaders(Headers additionalHeaders)

• replaceAllAdditionalHeaders

   final StructuredResponseCreateParams.Builder<T> replaceAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• removeAdditionalHeaders

   final StructuredResponseCreateParams.Builder<T> removeAdditionalHeaders(String name)

• removeAllAdditionalHeaders

   final StructuredResponseCreateParams.Builder<T> removeAllAdditionalHeaders(Set<String> names)

• additionalQueryParams

   final StructuredResponseCreateParams.Builder<T> additionalQueryParams(QueryParams additionalQueryParams)

• additionalQueryParams

   final StructuredResponseCreateParams.Builder<T> additionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• putAdditionalQueryParam

   final StructuredResponseCreateParams.Builder<T> putAdditionalQueryParam(String key, String value)

• putAdditionalQueryParams

   final StructuredResponseCreateParams.Builder<T> putAdditionalQueryParams(String key, Iterable<String> values)

• putAllAdditionalQueryParams

   final StructuredResponseCreateParams.Builder<T> putAllAdditionalQueryParams(QueryParams additionalQueryParams)

• putAllAdditionalQueryParams

   final StructuredResponseCreateParams.Builder<T> putAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• replaceAdditionalQueryParams

   final StructuredResponseCreateParams.Builder<T> replaceAdditionalQueryParams(String key, String value)

• replaceAdditionalQueryParams

   final StructuredResponseCreateParams.Builder<T> replaceAdditionalQueryParams(String key, Iterable<String> values)

• replaceAllAdditionalQueryParams

   final StructuredResponseCreateParams.Builder<T> replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)

• replaceAllAdditionalQueryParams

   final StructuredResponseCreateParams.Builder<T> replaceAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• removeAdditionalQueryParams

   final StructuredResponseCreateParams.Builder<T> removeAdditionalQueryParams(String key)

• removeAllAdditionalQueryParams

   final StructuredResponseCreateParams.Builder<T> removeAllAdditionalQueryParams(Set<String> keys)

• build

   final StructuredResponseCreateParams<T> build()

  Returns an immutable instance of StructuredResponseCreateParams.

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

  The following fields are required:

  .input()
  .model()
  .text()