Constructor Detail

Method Detail

• inputSchema

   final BetaTool.Builder inputSchema(BetaTool.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 BetaTool.Builder inputSchema(JsonField<BetaTool.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 BetaTool.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 BetaTool.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.

• allowedCallers

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

• allowedCallers

   final BetaTool.Builder allowedCallers(JsonField<List<BetaTool.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 BetaTool.Builder addAllowedCaller(BetaTool.AllowedCaller allowedCaller)

  Adds a single AllowedCaller to allowedCallers.

• cacheControl

   final BetaTool.Builder cacheControl(BetaCacheControlEphemeral cacheControl)

  Create a cache control breakpoint at this content block.

• cacheControl

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

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

• cacheControl

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

• deferLoading

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

• description

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

• eagerInputStreaming

   final BetaTool.Builder eagerInputStreaming(Boolean eagerInputStreaming)

  Enable eager input streaming for this tool. When true, tool input parameters will be streamed incrementally as they are generated, and types will be inferred on-the-fly rather than buffering the full JSON output. When false, streaming is disabled for this tool even if the fine-grained-tool-streaming beta is active. When null (default), uses the default behavior based on beta headers.

• eagerInputStreaming

   final BetaTool.Builder eagerInputStreaming(Boolean eagerInputStreaming)

  Alias for Builder.eagerInputStreaming.

  This unboxed primitive overload exists for backwards compatibility.

• eagerInputStreaming

   final BetaTool.Builder eagerInputStreaming(Optional<Boolean> eagerInputStreaming)

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

• eagerInputStreaming

   final BetaTool.Builder eagerInputStreaming(JsonField<Boolean> eagerInputStreaming)

  Sets Builder.eagerInputStreaming to an arbitrary JSON value.

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

• inputExamples

   final BetaTool.Builder inputExamples(List<BetaTool.InputExample> inputExamples)

• inputExamples

   final BetaTool.Builder inputExamples(JsonField<List<BetaTool.InputExample>> inputExamples)

  Sets Builder.inputExamples to an arbitrary JSON value.

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

• addInputExample

   final BetaTool.Builder addInputExample(BetaTool.InputExample inputExample)

  Adds a single InputExample to inputExamples.

• strict

   final BetaTool.Builder strict(Boolean strict)

  When true, guarantees schema validation on tool names and inputs

• strict

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

• type

   final BetaTool.Builder type(BetaTool.Type type)

• type

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

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

• type

   final BetaTool.Builder type(JsonField<BetaTool.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 BetaTool.Builder additionalProperties(Map<String, JsonValue> additionalProperties)

• putAdditionalProperty

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

• putAllAdditionalProperties

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

• removeAdditionalProperty

   final BetaTool.Builder removeAdditionalProperty(String key)

• removeAllAdditionalProperties

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

• build

   final BetaTool build()

  Returns an immutable instance of BetaTool.

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

  The following fields are required:

  .inputSchema()
  .name()