Constructor Detail

Method Detail

• model

   final Model model()

  The model that will complete your prompt.

  See models for additional details and options.

• _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("advisor")

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

• _type

   final JsonValue _type()

  Expected to always return the following:

  JsonValue.from("advisor_20260301")

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

• allowedCallers

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

• cacheControl

   final Optional<BetaCacheControlEphemeral> cacheControl()

  Create a cache control breakpoint at this content block.

• caching

   final Optional<BetaCacheControlEphemeral> caching()

  Caching for the advisor's own prompt. When set, each advisor call writes a cache entry at the given TTL so subsequent calls in the same conversation read the stable prefix. When omitted, the advisor prompt is not cached.

• 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.

• maxTokens

   final Optional<Long> maxTokens()

  Bounds the advisor's total output (thinking + text) per call. When the advisor hits this cap, the returned advisor_result or advisor_redacted_result block carries stop_reason='max_tokens', and a truncation note is appended to the advice text the worker model sees (inside the encrypted blob in redacted mode). When set, the server also emits a remaining-tokens budget block in the advisor's prompt so the advisor self-shapes toward the cap. When omitted, the advisor model's default output cap applies and no budget block is emitted.

• maxUses

   final Optional<Long> maxUses()

  Maximum number of times the tool can be used in the API request.

• strict

   final Optional<Boolean> strict()

  When true, guarantees schema validation on tool names and inputs

• _model

   final JsonField<Model> _model()

  Returns the raw JSON value of model.

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

• _allowedCallers

   final JsonField<List<BetaAdvisorTool20260301.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.

• _caching

   final JsonField<BetaCacheControlEphemeral> _caching()

  Returns the raw JSON value of caching.

  Unlike caching, 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.

• _maxTokens

   final JsonField<Long> _maxTokens()

  Returns the raw JSON value of maxTokens.

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

• _maxUses

   final JsonField<Long> _maxUses()

  Returns the raw JSON value of maxUses.

  Unlike maxUses, 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 BetaAdvisorTool20260301.Builder toBuilder()

• validate

   final BetaAdvisorTool20260301 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 BetaAdvisorTool20260301.Builder builder()

  Returns a mutable builder for constructing an instance of BetaAdvisorTool20260301.

  The following fields are required:

  .model()