getFormat

open fun getFormat(): String

Returns a format description string, augmented with few-shot examples.

The example(s) are generated using DummyInstanceCreator, which creates a mock instance of outputClass.

If ifPossible is true, the example is wrapped in a structure (presumably MaybeReturn) that shows both 'success' and 'failure' cases. This is helpful when the output type can be a success or an error.

If ifPossible is false, only a single example output is shown (not wrapped).

The underlying converter's format is always appended after the examples.

Return

a string describing the output format, including examples