Constructor Detail

Method Detail

• _name

   final JsonValue _name()

  Name of the tool.

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

  Expected to always return the following:

  JsonValue.from("tool_search_tool_bm25")

  However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).

• type

   final BetaToolSearchToolBm25_20251119.Type type()

• allowedCallers

   final Optional<List<BetaToolSearchToolBm25_20251119.AllowedCaller>> allowedCallers()

• cacheControl

   final Optional<BetaCacheControlEphemeral> cacheControl()

  Create a cache control breakpoint at this content block.

• deferLoading

   final Optional<Boolean> deferLoading()

  If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

• strict

   final Optional<Boolean> strict()

  When true, guarantees schema validation on tool names and inputs

• _type

   final JsonField<BetaToolSearchToolBm25_20251119.Type> _type()

  Returns the raw JSON value of type.

  Unlike type, this method doesn't throw if the JSON field has an unexpected type.

• _allowedCallers

   final JsonField<List<BetaToolSearchToolBm25_20251119.AllowedCaller>> _allowedCallers()

  Returns the raw JSON value of allowedCallers.

  Unlike allowedCallers, this method doesn't throw if the JSON field has an unexpected type.

• _cacheControl

   final JsonField<BetaCacheControlEphemeral> _cacheControl()

  Returns the raw JSON value of cacheControl.

  Unlike cacheControl, this method doesn't throw if the JSON field has an unexpected type.

• _deferLoading

   final JsonField<Boolean> _deferLoading()

  Returns the raw JSON value of deferLoading.

  Unlike deferLoading, this method doesn't throw if the JSON field has an unexpected type.

• _strict

   final JsonField<Boolean> _strict()

  Returns the raw JSON value of strict.

  Unlike strict, this method doesn't throw if the JSON field has an unexpected type.

• _additionalProperties

   final Map<String, JsonValue> _additionalProperties()

• toBuilder

   final BetaToolSearchToolBm25_20251119.Builder toBuilder()

• validate

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

• isValid

   final Boolean isValid()

• equals

   Boolean equals(Object other)

• hashCode

   Integer hashCode()

• toString

   String toString()

• builder

   final static BetaToolSearchToolBm25_20251119.Builder builder()

  Returns a mutable builder for constructing an instance of BetaToolSearchToolBm25_20251119.

  The following fields are required:

  .type()