Annotation Interface Tool.ToolAnnotations

Enclosing class:
Tool
@Retention(RUNTIME) @Target(ANNOTATION_TYPE) public static @interface Tool.ToolAnnotations
Additional hints for clients. Tool Annotations

  • Element Details

    • title

      String title
      Returns:
      A human-readable title for the tool.
      Default:
      ""

    • readOnlyHint

      boolean readOnlyHint
      Returns:
      If true, the tool does not modify its environment.
      Default:
      false

    • destructiveHint

      boolean destructiveHint
      Returns:
      If true, the tool may perform destructive updates to its environment. If false, the tool performs only additive updates.
      Default:
      true

    • idempotentHint

      boolean idempotentHint
      Returns:
      If true, calling the tool repeatedly with the same arguments will have no additional effect on the its environment.
      Default:
      false

    • openWorldHint

      boolean openWorldHint
      Returns:
      If true, this tool may interact with an "open world" of external entities. If false, the tool's domain of interaction is closed.
      Default:
      true

    • returnDirect

      boolean returnDirect
      Returns:
      It tells the client/agent whether the tool's result can be surfaced to the end user immediately (as the assistant reply) without another model turn.
      Default:
      false