Constructor Detail

Method Detail

• inputSchema

   final Tool.Builder inputSchema(Tool.InputSchema inputSchema)

  JSON schema for this tool's input.

  This defines the shape of the input that your tool accepts and that the model will produce.

• inputSchema

   final Tool.Builder inputSchema(JsonField<Tool.InputSchema> inputSchema)

  Sets Builder.inputSchema to an arbitrary JSON value.

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

• name

   final Tool.Builder name(String name)

  Name of the tool.

  This is how the tool will be called by the model and in tool_use blocks.

• name

   final Tool.Builder name(JsonField<String> name)

  Sets Builder.name to an arbitrary JSON value.

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

• cacheControl

   final Tool.Builder cacheControl(CacheControlEphemeral cacheControl)

  Create a cache control breakpoint at this content block.

• cacheControl

   final Tool.Builder cacheControl(Optional<CacheControlEphemeral> cacheControl)

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

• cacheControl

   final Tool.Builder cacheControl(JsonField<CacheControlEphemeral> cacheControl)

  Sets Builder.cacheControl to an arbitrary JSON value.

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

• description

   final Tool.Builder description(String description)

  Description of what this tool does.

  Tool descriptions should be as detailed as possible. The more information that the model has about what the tool is and how to use it, the better it will perform. You can use natural language descriptions to reinforce important aspects of the tool input JSON schema.

• description

   final Tool.Builder description(JsonField<String> description)

  Sets Builder.description to an arbitrary JSON value.

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

• type

   final Tool.Builder type(Tool.Type type)

• type

   final Tool.Builder type(Optional<Tool.Type> type)

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

• type

   final Tool.Builder type(JsonField<Tool.Type> type)

  Sets Builder.type to an arbitrary JSON value.

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

• additionalProperties

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

• putAdditionalProperty

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

• putAllAdditionalProperties

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

• removeAdditionalProperty

   final Tool.Builder removeAdditionalProperty(String key)

• removeAllAdditionalProperties

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

• build

   final Tool build()

  Returns an immutable instance of Tool.

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

  The following fields are required:

  .inputSchema()
  .name()