Constructor Detail

Method Detail

• id

   final ResponseToolSearchOutputItem.Builder id(String id)

  The unique ID of the tool search output item.

• id

   final ResponseToolSearchOutputItem.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.

• callId

   final ResponseToolSearchOutputItem.Builder callId(String callId)

  The unique ID of the tool search call generated by the model.

• callId

   final ResponseToolSearchOutputItem.Builder callId(Optional<String> callId)

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

• callId

   final ResponseToolSearchOutputItem.Builder callId(JsonField<String> callId)

  Sets Builder.callId to an arbitrary JSON value.

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

• execution

   final ResponseToolSearchOutputItem.Builder execution(ResponseToolSearchOutputItem.Execution execution)

  Whether tool search was executed by the server or by the client.

• execution

   final ResponseToolSearchOutputItem.Builder execution(JsonField<ResponseToolSearchOutputItem.Execution> execution)

  Sets Builder.execution to an arbitrary JSON value.

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

• status

   final ResponseToolSearchOutputItem.Builder status(ResponseToolSearchOutputItem.Status status)

  The status of the tool search output item that was recorded.

• status

   final ResponseToolSearchOutputItem.Builder status(JsonField<ResponseToolSearchOutputItem.Status> status)

  Sets Builder.status to an arbitrary JSON value.

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

• tools

   final ResponseToolSearchOutputItem.Builder tools(List<Tool> tools)

  The loaded tool definitions returned by tool search.

• tools

   final ResponseToolSearchOutputItem.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 ResponseToolSearchOutputItem.Builder addTool(Tool tool)

  Adds a single Tool to tools.

• addTool

   final ResponseToolSearchOutputItem.Builder addTool(FunctionTool function)

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

• addTool

   final ResponseToolSearchOutputItem.Builder addTool(FileSearchTool fileSearch)

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

• addTool

   final ResponseToolSearchOutputItem.Builder addTool(ComputerTool computer)

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

• addTool

   final ResponseToolSearchOutputItem.Builder addTool(ComputerUsePreviewTool computerUsePreview)

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

• addTool

   final ResponseToolSearchOutputItem.Builder addTool(WebSearchTool webSearch)

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

• addTool

   final ResponseToolSearchOutputItem.Builder addTool(Tool.Mcp mcp)

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

• addTool

   final ResponseToolSearchOutputItem.Builder addTool(Tool.CodeInterpreter codeInterpreter)

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

• addTool

   final ResponseToolSearchOutputItem.Builder addTool(Tool.ImageGeneration imageGeneration)

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

• addTool

   final ResponseToolSearchOutputItem.Builder addTool(FunctionShellTool shell)

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

• addTool

   final ResponseToolSearchOutputItem.Builder addTool(CustomTool custom)

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

• addTool

   final ResponseToolSearchOutputItem.Builder addTool(NamespaceTool namespace)

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

• addTool

   final ResponseToolSearchOutputItem.Builder addTool(ToolSearchTool search)

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

• addTool

   final ResponseToolSearchOutputItem.Builder addTool(WebSearchPreviewTool webSearchPreview)

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

• addTool

   final ResponseToolSearchOutputItem.Builder addTool(ApplyPatchTool applyPatch)

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

• addFileSearchTool

   final ResponseToolSearchOutputItem.Builder addFileSearchTool(List<String> vectorStoreIds)

  Alias for calling addTool with the following:

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

• addMcpTool

   final ResponseToolSearchOutputItem.Builder addMcpTool(String serverLabel)

  Alias for calling addTool with the following:

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

• addCodeInterpreterTool

   final ResponseToolSearchOutputItem.Builder addCodeInterpreterTool(Tool.CodeInterpreter.Container container)

  Alias for calling addTool with the following:

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

• addCodeInterpreterTool

   final ResponseToolSearchOutputItem.Builder addCodeInterpreterTool(String string)

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

• addCodeInterpreterTool

   final ResponseToolSearchOutputItem.Builder addCodeInterpreterTool(Tool.CodeInterpreter.Container.CodeInterpreterToolAuto codeInterpreterToolAuto)

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

• addToolLocalShell

   final ResponseToolSearchOutputItem.Builder addToolLocalShell()

  Alias for calling addTool with Tool.ofLocalShell().

• addCustomTool

   final ResponseToolSearchOutputItem.Builder addCustomTool(String name)

  Alias for calling addTool with the following:

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

• type

   final ResponseToolSearchOutputItem.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("tool_search_output")

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

• createdBy

   final ResponseToolSearchOutputItem.Builder createdBy(String createdBy)

  The identifier of the actor that created the item.

• createdBy

   final ResponseToolSearchOutputItem.Builder createdBy(JsonField<String> createdBy)

  Sets Builder.createdBy to an arbitrary JSON value.

  You should usually call Builder.createdBy 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 ResponseToolSearchOutputItem.Builder additionalProperties(Map<String, JsonValue> additionalProperties)

• putAdditionalProperty

   final ResponseToolSearchOutputItem.Builder putAdditionalProperty(String key, JsonValue value)

• putAllAdditionalProperties

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

• removeAdditionalProperty

   final ResponseToolSearchOutputItem.Builder removeAdditionalProperty(String key)

• removeAllAdditionalProperties

   final ResponseToolSearchOutputItem.Builder removeAllAdditionalProperties(Set<String> keys)

• build

   final ResponseToolSearchOutputItem build()

  Returns an immutable instance of ResponseToolSearchOutputItem.

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

  The following fields are required:

  .id()
  .callId()
  .execution()
  .status()
  .tools()