Class BetaManagedAgentsCustomToolParams
-
- All Implemented Interfaces:
public final class BetaManagedAgentsCustomToolParamsA custom tool that is executed by the API client rather than the agent. When the agent calls this tool, an
agent.custom_tool_useevent is emitted and the session goes idle, waiting for the client to provide the result via auser.custom_tool_resultevent.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classBetaManagedAgentsCustomToolParams.BuilderA builder for BetaManagedAgentsCustomToolParams.
public final classBetaManagedAgentsCustomToolParams.Type
-
Method Summary
Modifier and Type Method Description final Stringdescription()Description of what the tool does, shown to the agent to help it decide when to use the tool. final BetaManagedAgentsCustomToolInputSchemainputSchema()JSON Schema for custom tool input parameters. final Stringname()Unique name for the tool. final BetaManagedAgentsCustomToolParams.Typetype()final JsonField<String>_description()Returns the raw JSON value of description. final JsonField<BetaManagedAgentsCustomToolInputSchema>_inputSchema()Returns the raw JSON value of inputSchema. final JsonField<String>_name()Returns the raw JSON value of name. final JsonField<BetaManagedAgentsCustomToolParams.Type>_type()Returns the raw JSON value of type. final Map<String, JsonValue>_additionalProperties()final BetaManagedAgentsCustomToolParams.BuildertoBuilder()final BetaManagedAgentsCustomToolParamsvalidate()Validates that the types of all values in this object match their expected types recursively. final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static BetaManagedAgentsCustomToolParams.Builderbuilder()Returns a mutable builder for constructing an instance of BetaManagedAgentsCustomToolParams. -
-
Method Detail
-
description
final String description()
Description of what the tool does, shown to the agent to help it decide when to use the tool. 1-1024 characters.
-
inputSchema
final BetaManagedAgentsCustomToolInputSchema inputSchema()
JSON Schema for custom tool input parameters.
-
name
final String name()
Unique name for the tool. 1-128 characters; letters, digits, underscores, and hyphens.
-
type
final BetaManagedAgentsCustomToolParams.Type type()
-
_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.
-
_inputSchema
final JsonField<BetaManagedAgentsCustomToolInputSchema> _inputSchema()
Returns the raw JSON value of inputSchema.
Unlike inputSchema, this method doesn't throw if the JSON field has an unexpected type.
-
_name
final JsonField<String> _name()
Returns the raw JSON value of name.
Unlike name, this method doesn't throw if the JSON field has an unexpected type.
-
_type
final JsonField<BetaManagedAgentsCustomToolParams.Type> _type()
Returns the raw JSON value of type.
Unlike type, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final BetaManagedAgentsCustomToolParams.Builder toBuilder()
-
validate
final BetaManagedAgentsCustomToolParams validate()
Validates that the types of all values in this object match their expected types recursively.
This method is not forwards compatible with new types from the API for existing fields.
-
builder
final static BetaManagedAgentsCustomToolParams.Builder builder()
Returns a mutable builder for constructing an instance of BetaManagedAgentsCustomToolParams.
The following fields are required:
.description() .inputSchema() .name() .type()
-
-
-
-