Class ResponseToolSearchOutputItemParam.Builder
-
- All Implemented Interfaces:
public final class ResponseToolSearchOutputItemParam.BuilderA builder for ResponseToolSearchOutputItemParam.
-
-
Method Summary
-
-
Method Detail
-
tools
final ResponseToolSearchOutputItemParam.Builder tools(List<Tool> tools)
The loaded tool definitions returned by the tool search output.
-
tools
final ResponseToolSearchOutputItemParam.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 ResponseToolSearchOutputItemParam.Builder addTool(Tool tool)
-
addTool
final ResponseToolSearchOutputItemParam.Builder addTool(FunctionTool function)
Alias for calling addTool with
Tool.ofFunction(function).
-
addTool
final ResponseToolSearchOutputItemParam.Builder addTool(FileSearchTool fileSearch)
Alias for calling addTool with
Tool.ofFileSearch(fileSearch).
-
addTool
final ResponseToolSearchOutputItemParam.Builder addTool(ComputerTool computer)
Alias for calling addTool with
Tool.ofComputer(computer).
-
addTool
final ResponseToolSearchOutputItemParam.Builder addTool(ComputerUsePreviewTool computerUsePreview)
Alias for calling addTool with
Tool.ofComputerUsePreview(computerUsePreview).
-
addTool
final ResponseToolSearchOutputItemParam.Builder addTool(WebSearchTool webSearch)
Alias for calling addTool with
Tool.ofWebSearch(webSearch).
-
addTool
final ResponseToolSearchOutputItemParam.Builder addTool(Tool.Mcp mcp)
Alias for calling addTool with
Tool.ofMcp(mcp).
-
addTool
final ResponseToolSearchOutputItemParam.Builder addTool(Tool.CodeInterpreter codeInterpreter)
Alias for calling addTool with
Tool.ofCodeInterpreter(codeInterpreter).
-
addTool
final ResponseToolSearchOutputItemParam.Builder addTool(Tool.ImageGeneration imageGeneration)
Alias for calling addTool with
Tool.ofImageGeneration(imageGeneration).
-
addTool
final ResponseToolSearchOutputItemParam.Builder addTool(FunctionShellTool shell)
Alias for calling addTool with
Tool.ofShell(shell).
-
addTool
final ResponseToolSearchOutputItemParam.Builder addTool(CustomTool custom)
Alias for calling addTool with
Tool.ofCustom(custom).
-
addTool
final ResponseToolSearchOutputItemParam.Builder addTool(NamespaceTool namespace)
Alias for calling addTool with
Tool.ofNamespace(namespace).
-
addTool
final ResponseToolSearchOutputItemParam.Builder addTool(ToolSearchTool search)
Alias for calling addTool with
Tool.ofSearch(search).
-
addTool
final ResponseToolSearchOutputItemParam.Builder addTool(WebSearchPreviewTool webSearchPreview)
Alias for calling addTool with
Tool.ofWebSearchPreview(webSearchPreview).
-
addTool
final ResponseToolSearchOutputItemParam.Builder addTool(ApplyPatchTool applyPatch)
Alias for calling addTool with
Tool.ofApplyPatch(applyPatch).
-
addFileSearchTool
final ResponseToolSearchOutputItemParam.Builder addFileSearchTool(List<String> vectorStoreIds)
Alias for calling addTool with the following:
FileSearchTool.builder() .vectorStoreIds(vectorStoreIds) .build()
-
addMcpTool
final ResponseToolSearchOutputItemParam.Builder addMcpTool(String serverLabel)
Alias for calling addTool with the following:
Tool.Mcp.builder() .serverLabel(serverLabel) .build()
-
addCodeInterpreterTool
final ResponseToolSearchOutputItemParam.Builder addCodeInterpreterTool(Tool.CodeInterpreter.Container container)
Alias for calling addTool with the following:
Tool.CodeInterpreter.builder() .container(container) .build()
-
addCodeInterpreterTool
final ResponseToolSearchOutputItemParam.Builder addCodeInterpreterTool(String string)
Alias for calling addCodeInterpreterTool with
Tool.CodeInterpreter.Container.ofString(string).
-
addCodeInterpreterTool
final ResponseToolSearchOutputItemParam.Builder addCodeInterpreterTool(Tool.CodeInterpreter.Container.CodeInterpreterToolAuto codeInterpreterToolAuto)
Alias for calling addCodeInterpreterTool with
Tool.CodeInterpreter.Container.ofCodeInterpreterToolAuto(codeInterpreterToolAuto).
-
addToolLocalShell
final ResponseToolSearchOutputItemParam.Builder addToolLocalShell()
Alias for calling addTool with
Tool.ofLocalShell().
-
addCustomTool
final ResponseToolSearchOutputItemParam.Builder addCustomTool(String name)
Alias for calling addTool with the following:
CustomTool.builder() .name(name) .build()
-
type
final ResponseToolSearchOutputItemParam.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 ResponseToolSearchOutputItemParam.Builder id(String id)
The unique ID of this tool search output.
-
id
final ResponseToolSearchOutputItemParam.Builder id(Optional<String> id)
Alias for calling Builder.id with
id.orElse(null).
-
id
final ResponseToolSearchOutputItemParam.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 ResponseToolSearchOutputItemParam.Builder callId(String callId)
The unique ID of the tool search call generated by the model.
-
callId
final ResponseToolSearchOutputItemParam.Builder callId(Optional<String> callId)
Alias for calling Builder.callId with
callId.orElse(null).
-
callId
final ResponseToolSearchOutputItemParam.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 ResponseToolSearchOutputItemParam.Builder execution(ResponseToolSearchOutputItemParam.Execution execution)
Whether tool search was executed by the server or by the client.
-
execution
final ResponseToolSearchOutputItemParam.Builder execution(JsonField<ResponseToolSearchOutputItemParam.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 ResponseToolSearchOutputItemParam.Builder status(ResponseToolSearchOutputItemParam.Status status)
The status of the tool search output.
-
status
final ResponseToolSearchOutputItemParam.Builder status(Optional<ResponseToolSearchOutputItemParam.Status> status)
Alias for calling Builder.status with
status.orElse(null).
-
status
final ResponseToolSearchOutputItemParam.Builder status(JsonField<ResponseToolSearchOutputItemParam.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 ResponseToolSearchOutputItemParam.Builder additionalProperties(Map<String, JsonValue> additionalProperties)
-
putAdditionalProperty
final ResponseToolSearchOutputItemParam.Builder putAdditionalProperty(String key, JsonValue value)
-
putAllAdditionalProperties
final ResponseToolSearchOutputItemParam.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)
-
removeAdditionalProperty
final ResponseToolSearchOutputItemParam.Builder removeAdditionalProperty(String key)
-
removeAllAdditionalProperties
final ResponseToolSearchOutputItemParam.Builder removeAllAdditionalProperties(Set<String> keys)
-
build
final ResponseToolSearchOutputItemParam build()
Returns an immutable instance of ResponseToolSearchOutputItemParam.
Further updates to this Builder will not mutate the returned instance.
The following fields are required:
.tools()
-
-
-
-