Constructor Detail

Method Detail

• model

   final BetaAdvisorTool20260301.Builder model(Model model)

  The model that will complete your prompt.

  See models for additional details and options.

• model

   final BetaAdvisorTool20260301.Builder model(JsonField<Model> model)

  Sets Builder.model to an arbitrary JSON value.

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

• model

   final BetaAdvisorTool20260301.Builder model(String value)

  Sets model to an arbitrary String.

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

• name

   final BetaAdvisorTool20260301.Builder name(JsonValue name)

  Sets the field to an arbitrary JSON value.

  It is usually unnecessary to call this method because the field defaults to the following:

  JsonValue.from("advisor")

  This method is primarily for setting the field to an undocumented or not yet supported value.

• type

   final BetaAdvisorTool20260301.Builder type(JsonValue type)

  Sets the field to an arbitrary JSON value.

  It is usually unnecessary to call this method because the field defaults to the following:

  JsonValue.from("advisor_20260301")

  This method is primarily for setting the field to an undocumented or not yet supported value.

• allowedCallers

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

• allowedCallers

   final BetaAdvisorTool20260301.Builder allowedCallers(JsonField<List<BetaAdvisorTool20260301.AllowedCaller>> allowedCallers)

  Sets Builder.allowedCallers to an arbitrary JSON value.

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

• addAllowedCaller

   final BetaAdvisorTool20260301.Builder addAllowedCaller(BetaAdvisorTool20260301.AllowedCaller allowedCaller)

  Adds a single AllowedCaller to allowedCallers.

• cacheControl

   final BetaAdvisorTool20260301.Builder cacheControl(BetaCacheControlEphemeral cacheControl)

  Create a cache control breakpoint at this content block.

• cacheControl

   final BetaAdvisorTool20260301.Builder cacheControl(Optional<BetaCacheControlEphemeral> cacheControl)

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

• cacheControl

   final BetaAdvisorTool20260301.Builder cacheControl(JsonField<BetaCacheControlEphemeral> cacheControl)

  Sets Builder.cacheControl to an arbitrary JSON value.

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

• caching

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

• caching

   final BetaAdvisorTool20260301.Builder caching(Optional<BetaCacheControlEphemeral> caching)

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

• caching

   final BetaAdvisorTool20260301.Builder caching(JsonField<BetaCacheControlEphemeral> caching)

  Sets Builder.caching to an arbitrary JSON value.

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

• deferLoading

   final BetaAdvisorTool20260301.Builder deferLoading(Boolean deferLoading)

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

• deferLoading

   final BetaAdvisorTool20260301.Builder deferLoading(JsonField<Boolean> deferLoading)

  Sets Builder.deferLoading to an arbitrary JSON value.

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

• maxTokens

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

• maxTokens

   final BetaAdvisorTool20260301.Builder maxTokens(Long maxTokens)

  Alias for Builder.maxTokens.

  This unboxed primitive overload exists for backwards compatibility.

• maxTokens

   final BetaAdvisorTool20260301.Builder maxTokens(Optional<Long> maxTokens)

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

• maxTokens

   final BetaAdvisorTool20260301.Builder maxTokens(JsonField<Long> maxTokens)

  Sets Builder.maxTokens to an arbitrary JSON value.

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

• maxUses

   final BetaAdvisorTool20260301.Builder maxUses(Long maxUses)

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

• maxUses

   final BetaAdvisorTool20260301.Builder maxUses(Long maxUses)

  Alias for Builder.maxUses.

  This unboxed primitive overload exists for backwards compatibility.

• maxUses

   final BetaAdvisorTool20260301.Builder maxUses(Optional<Long> maxUses)

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

• maxUses

   final BetaAdvisorTool20260301.Builder maxUses(JsonField<Long> maxUses)

  Sets Builder.maxUses to an arbitrary JSON value.

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

• strict

   final BetaAdvisorTool20260301.Builder strict(Boolean strict)

  When true, guarantees schema validation on tool names and inputs

• strict

   final BetaAdvisorTool20260301.Builder strict(JsonField<Boolean> strict)

  Sets Builder.strict to an arbitrary JSON value.

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

• additionalProperties

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

• putAdditionalProperty

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

• putAllAdditionalProperties

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

• removeAdditionalProperty

   final BetaAdvisorTool20260301.Builder removeAdditionalProperty(String key)

• removeAllAdditionalProperties

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

• build

   final BetaAdvisorTool20260301 build()

  Returns an immutable instance of BetaAdvisorTool20260301.

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

  The following fields are required:

  .model()