Constructor Detail

Method Detail

• tools

   final BetaResponseToolSearchOutputItemParam.Builder tools(List<BetaTool> tools)

  The loaded tool definitions returned by the tool search output.

• tools

   final BetaResponseToolSearchOutputItemParam.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 BetaResponseToolSearchOutputItemParam.Builder addTool(BetaTool tool)

  Adds a single BetaTool to tools.

• addTool

   final BetaResponseToolSearchOutputItemParam.Builder addTool(BetaFunctionTool function)

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

• addTool

   final BetaResponseToolSearchOutputItemParam.Builder addTool(BetaFileSearchTool fileSearch)

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

• addTool

   final BetaResponseToolSearchOutputItemParam.Builder addTool(BetaComputerTool computer)

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

• addTool

   final BetaResponseToolSearchOutputItemParam.Builder addTool(BetaComputerUsePreviewTool computerUsePreview)

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

• addTool

   final BetaResponseToolSearchOutputItemParam.Builder addTool(BetaWebSearchTool webSearch)

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

• addTool

   final BetaResponseToolSearchOutputItemParam.Builder addTool(BetaTool.Mcp mcp)

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

• addTool

   final BetaResponseToolSearchOutputItemParam.Builder addTool(BetaTool.CodeInterpreter codeInterpreter)

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

• addTool

   final BetaResponseToolSearchOutputItemParam.Builder addTool(BetaTool.ImageGeneration imageGeneration)

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

• addTool

   final BetaResponseToolSearchOutputItemParam.Builder addTool(BetaFunctionShellTool shell)

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

• addTool

   final BetaResponseToolSearchOutputItemParam.Builder addTool(BetaCustomTool custom)

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

• addTool

   final BetaResponseToolSearchOutputItemParam.Builder addTool(BetaNamespaceTool namespace)

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

• addTool

   final BetaResponseToolSearchOutputItemParam.Builder addTool(BetaToolSearchTool toolSearch)

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

• addTool

   final BetaResponseToolSearchOutputItemParam.Builder addTool(BetaWebSearchPreviewTool webSearchPreview)

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

• addTool

   final BetaResponseToolSearchOutputItemParam.Builder addTool(BetaApplyPatchTool applyPatch)

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

• addFileSearchTool

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

  Alias for calling addTool with the following:

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

• addMcpTool

   final BetaResponseToolSearchOutputItemParam.Builder addMcpTool(String serverLabel)

  Alias for calling addTool with the following:

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

• addCodeInterpreterTool

   final BetaResponseToolSearchOutputItemParam.Builder addCodeInterpreterTool(BetaTool.CodeInterpreter.Container container)

  Alias for calling addTool with the following:

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

• addCodeInterpreterTool

   final BetaResponseToolSearchOutputItemParam.Builder addCodeInterpreterTool(String string)

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

• addCodeInterpreterTool

   final BetaResponseToolSearchOutputItemParam.Builder addCodeInterpreterTool(BetaTool.CodeInterpreter.Container.CodeInterpreterToolAuto codeInterpreterToolAuto)

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

• addToolProgrammaticToolCalling

   final BetaResponseToolSearchOutputItemParam.Builder addToolProgrammaticToolCalling()

  Alias for calling addTool with BetaTool.ofProgrammaticToolCalling().

• addToolLocalShell

   final BetaResponseToolSearchOutputItemParam.Builder addToolLocalShell()

  Alias for calling addTool with BetaTool.ofLocalShell().

• addCustomTool

   final BetaResponseToolSearchOutputItemParam.Builder addCustomTool(String name)

  Alias for calling addTool with the following:

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

• type

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

• id

   final BetaResponseToolSearchOutputItemParam.Builder id(String id)

  The unique ID of this tool search output.

• id

   final BetaResponseToolSearchOutputItemParam.Builder id(Optional<String> id)

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

• id

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

• agent

   final BetaResponseToolSearchOutputItemParam.Builder agent(BetaResponseToolSearchOutputItemParam.Agent agent)

  The agent that produced this item.

• agent

   final BetaResponseToolSearchOutputItemParam.Builder agent(Optional<BetaResponseToolSearchOutputItemParam.Agent> agent)

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

• agent

   final BetaResponseToolSearchOutputItemParam.Builder agent(JsonField<BetaResponseToolSearchOutputItemParam.Agent> agent)

  Sets Builder.agent to an arbitrary JSON value.

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

• callId

   final BetaResponseToolSearchOutputItemParam.Builder callId(String callId)

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

• callId

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

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

• callId

   final BetaResponseToolSearchOutputItemParam.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 BetaResponseToolSearchOutputItemParam.Builder execution(BetaResponseToolSearchOutputItemParam.Execution execution)

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

• execution

   final BetaResponseToolSearchOutputItemParam.Builder execution(JsonField<BetaResponseToolSearchOutputItemParam.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 BetaResponseToolSearchOutputItemParam.Builder status(BetaResponseToolSearchOutputItemParam.Status status)

  The status of the tool search output.

• status

   final BetaResponseToolSearchOutputItemParam.Builder status(Optional<BetaResponseToolSearchOutputItemParam.Status> status)

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

• status

   final BetaResponseToolSearchOutputItemParam.Builder status(JsonField<BetaResponseToolSearchOutputItemParam.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.

• additionalProperties

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

• putAdditionalProperty

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

• putAllAdditionalProperties

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

• removeAdditionalProperty

   final BetaResponseToolSearchOutputItemParam.Builder removeAdditionalProperty(String key)

• removeAllAdditionalProperties

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

• build

   final BetaResponseToolSearchOutputItemParam build()

  Returns an immutable instance of BetaResponseToolSearchOutputItemParam.

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

  The following fields are required:

  .tools()