JSON schema tool parameters

[K4sku]

Hello! Thank you for the gem!

I'm exploring this gem by rewriting a small llm agent in a Rails app. And I got to a point where I'm rewriting tools.
In original implementation I'm using an enum parameter. And I do not know how to implement it here.

So far I have squished it into a description:
"The current unit of the temperature value. Must be one of: 'celsius', 'fahrenheit'."

While looking for an solution I found this example: https://rubyllm.com/guides/tools#advanced-tool-parameters

class DataAnalysis < RubyLLM::Tool
  description "Analyzes numerical data"

  param :data,
    type: :array,
    desc: "Array of numbers to analyze"

  param :operations,
    type: :object,
    desc: "Analysis operations to perform",
    required: false

  def execute(data:, operations: {mean: true, median: false})
    result = {}

    result[:mean] = data.sum.to_f / data.size if operations[:mean]
    result[:median] = calculate_median(data) if operations[:median]

    result
  end

(...)
end

I do not understand how llm would know that operations cloud be mean and median, and that it should be a hash at all. I'm discussing it with an LLM (ironic, isn't it?) , and it says the example would not work.
To make it work the description should be much more specific:
"Specifies which analysis to perform. Should be an object with optional boolean keys: 'mean' and 'median'. For example: {'mean': true, 'median': false}. If omitted, both mean and median might be calculated.".

I saw the issue #11 about Structured output and I think structured input would be nice to have too.
What do you think about including this?

I have no ideas on implementation or API for these yet, but I can try working on it.

[crmne]

Thanks for catching this! You're right, we don't actually support complex parameter types like objects and arrays yet because support is inconsistent across providers. I've updated the docs to remove the misleading example in 0a73d74

I think that just asking users to flattening params might be simpler to implement than full complex tool parameters. However, if you're interested in contributing to this feature, I'd be happy to discuss approaches.

[K4sku]

I have been thinking about how to handle this.

I think the solution to defining tools with JSON schema params should be parallel to eventual solution used in Structured output parser. At least on the public API level.

The other issue is support for providers that do not have this feature that you raised.

Easiest solution is to just parse everything into description string.

Other possible solution is to do some parsing.
For example enum could be parsed as Must be one of: array.join(", "). That might give better results, but then some option to override it would be nice to have.

Another idea, using provider that does not support "advanced tool parameter" with such tool could at least leave some warning in log (with an option to suppress these logs).

[jayelkaake]

Just posting here for visibility but this is solved by my PR @ #124