Constructor Detail

Method Detail

• conversationId

   final ItemCreateParams.Builder conversationId(String conversationId)

• conversationId

   final ItemCreateParams.Builder conversationId(Optional<String> conversationId)

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

• include

   final ItemCreateParams.Builder include(List<ResponseIncludable> include)

  Additional fields to include in the response. See the include parameter for listing Conversation items above for more information.

• include

   final ItemCreateParams.Builder include(Optional<List<ResponseIncludable>> include)

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

• addInclude

   final ItemCreateParams.Builder addInclude(ResponseIncludable include)

  Adds a single ResponseIncludable to Builder.include.

• body

   final ItemCreateParams.Builder body(ItemCreateParams.Body body)

  Sets the entire request body.

  This is generally only useful if you are already constructing the body separately. Otherwise, it's more convenient to use the top-level setters instead:

  • items

• items

   final ItemCreateParams.Builder items(List<ResponseInputItem> items)

  The items to add to the conversation. You may add up to 20 items at a time.

• items

   final ItemCreateParams.Builder items(JsonField<List<ResponseInputItem>> items)

  Sets Builder.items to an arbitrary JSON value.

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

• addItem

   final ItemCreateParams.Builder addItem(ResponseInputItem item)

  Adds a single ResponseInputItem to items.

• addItem

   final ItemCreateParams.Builder addItem(EasyInputMessage easyInputMessage)

  Alias for calling addItem with ResponseInputItem.ofEasyInputMessage(easyInputMessage).

• addItem

   final ItemCreateParams.Builder addItem(ResponseInputItem.Message message)

  Alias for calling addItem with ResponseInputItem.ofMessage(message).

• addItem

   final ItemCreateParams.Builder addItem(ResponseOutputMessage responseOutputMessage)

  Alias for calling addItem with ResponseInputItem.ofResponseOutputMessage(responseOutputMessage).

• addItem

   final ItemCreateParams.Builder addItem(ResponseFileSearchToolCall fileSearchCall)

  Alias for calling addItem with ResponseInputItem.ofFileSearchCall(fileSearchCall).

• addItem

   final ItemCreateParams.Builder addItem(ResponseComputerToolCall computerCall)

  Alias for calling addItem with ResponseInputItem.ofComputerCall(computerCall).

• addItem

   final ItemCreateParams.Builder addItem(ResponseInputItem.ComputerCallOutput computerCallOutput)

  Alias for calling addItem with ResponseInputItem.ofComputerCallOutput(computerCallOutput).

• addItem

   final ItemCreateParams.Builder addItem(ResponseFunctionWebSearch webSearchCall)

  Alias for calling addItem with ResponseInputItem.ofWebSearchCall(webSearchCall).

• addItem

   final ItemCreateParams.Builder addItem(ResponseFunctionToolCall functionCall)

  Alias for calling addItem with ResponseInputItem.ofFunctionCall(functionCall).

• addItem

   final ItemCreateParams.Builder addItem(ResponseInputItem.FunctionCallOutput functionCallOutput)

  Alias for calling addItem with ResponseInputItem.ofFunctionCallOutput(functionCallOutput).

• addItem

   final ItemCreateParams.Builder addItem(ResponseReasoningItem reasoning)

  Alias for calling addItem with ResponseInputItem.ofReasoning(reasoning).

• addItem

   final ItemCreateParams.Builder addItem(ResponseInputItem.ImageGenerationCall imageGenerationCall)

  Alias for calling addItem with ResponseInputItem.ofImageGenerationCall(imageGenerationCall).

• addItem

   final ItemCreateParams.Builder addItem(ResponseCodeInterpreterToolCall codeInterpreterCall)

  Alias for calling addItem with ResponseInputItem.ofCodeInterpreterCall(codeInterpreterCall).

• addItem

   final ItemCreateParams.Builder addItem(ResponseInputItem.LocalShellCall localShellCall)

  Alias for calling addItem with ResponseInputItem.ofLocalShellCall(localShellCall).

• addItem

   final ItemCreateParams.Builder addItem(ResponseInputItem.LocalShellCallOutput localShellCallOutput)

  Alias for calling addItem with ResponseInputItem.ofLocalShellCallOutput(localShellCallOutput).

• addItem

   final ItemCreateParams.Builder addItem(ResponseInputItem.McpListTools mcpListTools)

  Alias for calling addItem with ResponseInputItem.ofMcpListTools(mcpListTools).

• addItem

   final ItemCreateParams.Builder addItem(ResponseInputItem.McpApprovalRequest mcpApprovalRequest)

  Alias for calling addItem with ResponseInputItem.ofMcpApprovalRequest(mcpApprovalRequest).

• addItem

   final ItemCreateParams.Builder addItem(ResponseInputItem.McpApprovalResponse mcpApprovalResponse)

  Alias for calling addItem with ResponseInputItem.ofMcpApprovalResponse(mcpApprovalResponse).

• addItem

   final ItemCreateParams.Builder addItem(ResponseInputItem.McpCall mcpCall)

  Alias for calling addItem with ResponseInputItem.ofMcpCall(mcpCall).

• addItem

   final ItemCreateParams.Builder addItem(ResponseCustomToolCallOutput customToolCallOutput)

  Alias for calling addItem with ResponseInputItem.ofCustomToolCallOutput(customToolCallOutput).

• addItem

   final ItemCreateParams.Builder addItem(ResponseCustomToolCall customToolCall)

  Alias for calling addItem with ResponseInputItem.ofCustomToolCall(customToolCall).

• addItem

   final ItemCreateParams.Builder addItem(ResponseInputItem.ItemReference itemReference)

  Alias for calling addItem with ResponseInputItem.ofItemReference(itemReference).

• addItemReferenceItem

   final ItemCreateParams.Builder addItemReferenceItem(String id)

  Alias for calling addItem with the following:

  ResponseInputItem.ItemReference.builder()
      .type(ResponseInputItem.ItemReference.Type.ITEM_REFERENCE)
      .id(id)
      .build()

• additionalBodyProperties

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

• putAdditionalBodyProperty

   final ItemCreateParams.Builder putAdditionalBodyProperty(String key, JsonValue value)

• putAllAdditionalBodyProperties

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

• removeAdditionalBodyProperty

   final ItemCreateParams.Builder removeAdditionalBodyProperty(String key)

• removeAllAdditionalBodyProperties

   final ItemCreateParams.Builder removeAllAdditionalBodyProperties(Set<String> keys)

• additionalHeaders

   final ItemCreateParams.Builder additionalHeaders(Headers additionalHeaders)

• additionalHeaders

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

• putAdditionalHeader

   final ItemCreateParams.Builder putAdditionalHeader(String name, String value)

• putAdditionalHeaders

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

• putAllAdditionalHeaders

   final ItemCreateParams.Builder putAllAdditionalHeaders(Headers additionalHeaders)

• putAllAdditionalHeaders

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

• replaceAdditionalHeaders

   final ItemCreateParams.Builder replaceAdditionalHeaders(String name, String value)

• replaceAdditionalHeaders

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

• replaceAllAdditionalHeaders

   final ItemCreateParams.Builder replaceAllAdditionalHeaders(Headers additionalHeaders)

• replaceAllAdditionalHeaders

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

• removeAdditionalHeaders

   final ItemCreateParams.Builder removeAdditionalHeaders(String name)

• removeAllAdditionalHeaders

   final ItemCreateParams.Builder removeAllAdditionalHeaders(Set<String> names)

• additionalQueryParams

   final ItemCreateParams.Builder additionalQueryParams(QueryParams additionalQueryParams)

• additionalQueryParams

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

• putAdditionalQueryParam

   final ItemCreateParams.Builder putAdditionalQueryParam(String key, String value)

• putAdditionalQueryParams

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

• putAllAdditionalQueryParams

   final ItemCreateParams.Builder putAllAdditionalQueryParams(QueryParams additionalQueryParams)

• putAllAdditionalQueryParams

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

• replaceAdditionalQueryParams

   final ItemCreateParams.Builder replaceAdditionalQueryParams(String key, String value)

• replaceAdditionalQueryParams

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

• replaceAllAdditionalQueryParams

   final ItemCreateParams.Builder replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)

• replaceAllAdditionalQueryParams

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

• removeAdditionalQueryParams

   final ItemCreateParams.Builder removeAdditionalQueryParams(String key)

• removeAllAdditionalQueryParams

   final ItemCreateParams.Builder removeAllAdditionalQueryParams(Set<String> keys)

• build

   final ItemCreateParams build()

  Returns an immutable instance of ItemCreateParams.

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

  The following fields are required:

  .items()