Class ToolSearchTool
-
- All Implemented Interfaces:
public final class ToolSearchToolHosted or BYOT tool search configuration for deferred tools.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classToolSearchTool.BuilderA builder for ToolSearchTool.
public final classToolSearchTool.ExecutionWhether tool search is executed by the server or by the client.
-
Method Summary
Modifier and Type Method Description final JsonValue_type()The type of the tool. final Optional<String>description()Description shown to the model for a client-executed tool search tool. final Optional<ToolSearchTool.Execution>execution()Whether tool search is executed by the server or by the client. final JsonValue_parameters()Parameter schema for a client-executed tool search tool. final JsonField<String>_description()Returns the raw JSON value of description. final JsonField<ToolSearchTool.Execution>_execution()Returns the raw JSON value of execution. final Map<String, JsonValue>_additionalProperties()final ToolSearchTool.BuildertoBuilder()final ToolSearchToolvalidate()final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static ToolSearchTool.Builderbuilder()Returns a mutable builder for constructing an instance of ToolSearchTool. -
-
Method Detail
-
_type
final JsonValue _type()
The type of the tool. Always
tool_search.Expected to always return the following:
JsonValue.from("tool_search")However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
-
description
final Optional<String> description()
Description shown to the model for a client-executed tool search tool.
-
execution
final Optional<ToolSearchTool.Execution> execution()
Whether tool search is executed by the server or by the client.
-
_parameters
final JsonValue _parameters()
Parameter schema for a client-executed tool search tool.
This arbitrary value can be deserialized into a custom type using the
convertmethod:MyClass myObject = toolSearchTool.parameters().convert(MyClass.class);
-
_description
final JsonField<String> _description()
Returns the raw JSON value of description.
Unlike description, this method doesn't throw if the JSON field has an unexpected type.
-
_execution
final JsonField<ToolSearchTool.Execution> _execution()
Returns the raw JSON value of execution.
Unlike execution, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final ToolSearchTool.Builder toBuilder()
-
validate
final ToolSearchTool validate()
-
builder
final static ToolSearchTool.Builder builder()
Returns a mutable builder for constructing an instance of ToolSearchTool.
-
-
-
-