ToolDefinition (Spring AI 1.0.0-SNAPSHOT API)

All Known Implementing Classes:: DefaultToolDefinition

public interface ToolDefinition

Definition used by the AI model to determine when and how to call the tool.

Since:: 1.0.0
Author:: Thomas Vitale

Method Summary

Modifier and Type

Method

Description

static DefaultToolDefinition.Builder

builder()

Create a default ToolDefinition builder.

String

description()

The tool description, used by the AI model to determine what the tool does.

static ToolDefinition

from(Method method)

Create a default ToolDefinition instance from a Method.

String

inputTypeSchema()

The JSON Schema of the parameters used to call the tool.

String

name()

The tool name.

Method Details
- name
  
  String name()
  
  The tool name. Unique within the tool set provided to a model.
- description
  
  String description()
  
  The tool description, used by the AI model to determine what the tool does.
- inputTypeSchema
  
  String inputTypeSchema()
  
  The JSON Schema of the parameters used to call the tool.
- builder
  
  static DefaultToolDefinition.Builder builder()
  
  Create a default ToolDefinition builder.
- from
  
  static ToolDefinition from(Method method)
  
  Create a default ToolDefinition instance from a Method.