Constructor Detail

Method Detail

• id

   final ResponseOutputItem.AdditionalTools.Builder id(String id)

  The unique ID of the additional tools item.

• id

   final ResponseOutputItem.AdditionalTools.Builder id(JsonField<String> id)

  Sets Builder.id to an arbitrary JSON value.

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

• role

   final ResponseOutputItem.AdditionalTools.Builder role(ResponseOutputItem.AdditionalTools.Role role)

  The role that provided the additional tools.

• role

   final ResponseOutputItem.AdditionalTools.Builder role(JsonField<ResponseOutputItem.AdditionalTools.Role> role)

  Sets Builder.role to an arbitrary JSON value.

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

• tools

   final ResponseOutputItem.AdditionalTools.Builder tools(List<Tool> tools)

  The additional tool definitions made available at this item.

• tools

   final ResponseOutputItem.AdditionalTools.Builder tools(JsonField<List<Tool>> tools)

  Sets Builder.tools to an arbitrary JSON value.

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

• addTool

   final ResponseOutputItem.AdditionalTools.Builder addTool(Tool tool)

  Adds a single Tool to tools.

• addTool

   final ResponseOutputItem.AdditionalTools.Builder addTool(FunctionTool function)

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

• addTool

   final ResponseOutputItem.AdditionalTools.Builder addTool(FileSearchTool fileSearch)

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

• addTool

   final ResponseOutputItem.AdditionalTools.Builder addTool(ComputerTool computer)

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

• addTool

   final ResponseOutputItem.AdditionalTools.Builder addTool(ComputerUsePreviewTool computerUsePreview)

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

• addTool

   final ResponseOutputItem.AdditionalTools.Builder addTool(WebSearchTool webSearch)

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

• addTool

   final ResponseOutputItem.AdditionalTools.Builder addTool(Tool.Mcp mcp)

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

• addTool

   final ResponseOutputItem.AdditionalTools.Builder addTool(Tool.CodeInterpreter codeInterpreter)

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

• addTool

   final ResponseOutputItem.AdditionalTools.Builder addTool(Tool.ImageGeneration imageGeneration)

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

• addTool

   final ResponseOutputItem.AdditionalTools.Builder addTool(FunctionShellTool shell)

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

• addTool

   final ResponseOutputItem.AdditionalTools.Builder addTool(CustomTool custom)

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

• addTool

   final ResponseOutputItem.AdditionalTools.Builder addTool(NamespaceTool namespace)

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

• addTool

   final ResponseOutputItem.AdditionalTools.Builder addTool(ToolSearchTool search)

  Alias for calling addTool with Tool.ofSearch(search).

• addTool

   final ResponseOutputItem.AdditionalTools.Builder addTool(WebSearchPreviewTool webSearchPreview)

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

• addTool

   final ResponseOutputItem.AdditionalTools.Builder addTool(ApplyPatchTool applyPatch)

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

• addFileSearchTool

   final ResponseOutputItem.AdditionalTools.Builder addFileSearchTool(List<String> vectorStoreIds)

  Alias for calling addTool with the following:

  FileSearchTool.builder()
      .vectorStoreIds(vectorStoreIds)
      .build()

• addMcpTool

   final ResponseOutputItem.AdditionalTools.Builder addMcpTool(String serverLabel)

  Alias for calling addTool with the following:

  Tool.Mcp.builder()
      .serverLabel(serverLabel)
      .build()

• addCodeInterpreterTool

   final ResponseOutputItem.AdditionalTools.Builder addCodeInterpreterTool(Tool.CodeInterpreter.Container container)

  Alias for calling addTool with the following:

  Tool.CodeInterpreter.builder()
      .container(container)
      .build()

• addCodeInterpreterTool

   final ResponseOutputItem.AdditionalTools.Builder addCodeInterpreterTool(String string)

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

• addCodeInterpreterTool

   final ResponseOutputItem.AdditionalTools.Builder addCodeInterpreterTool(Tool.CodeInterpreter.Container.CodeInterpreterToolAuto codeInterpreterToolAuto)

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

• addToolLocalShell

   final ResponseOutputItem.AdditionalTools.Builder addToolLocalShell()

  Alias for calling addTool with Tool.ofLocalShell().

• addCustomTool

   final ResponseOutputItem.AdditionalTools.Builder addCustomTool(String name)

  Alias for calling addTool with the following:

  CustomTool.builder()
      .name(name)
      .build()

• type

   final ResponseOutputItem.AdditionalTools.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("additional_tools")

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

• additionalProperties

   final ResponseOutputItem.AdditionalTools.Builder additionalProperties(Map<String, JsonValue> additionalProperties)

• putAdditionalProperty

   final ResponseOutputItem.AdditionalTools.Builder putAdditionalProperty(String key, JsonValue value)

• putAllAdditionalProperties

   final ResponseOutputItem.AdditionalTools.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)

• removeAdditionalProperty

   final ResponseOutputItem.AdditionalTools.Builder removeAdditionalProperty(String key)

• removeAllAdditionalProperties

   final ResponseOutputItem.AdditionalTools.Builder removeAllAdditionalProperties(Set<String> keys)

• build

   final ResponseOutputItem.AdditionalTools build()

  Returns an immutable instance of AdditionalTools.

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

  The following fields are required:

  .id()
  .role()
  .tools()