Documentation for data structures GradingResult and ProviderResponse

[efung]

For the following structures, the documentation differs from what we've tested. Happy to make a PR to update the docs, if someone can confirm the following. I'm only using Python custom assertions and providers.

GradingResult (Typescript reference)

• score documented to be a float between 0 and 1, but we've been able to return a dictionary.
• reason is allowed to be None ( I guess null in Typescript)

ProviderResponse (Typescript reference)

• The Python documentation says that output must be Optional[str]. However, the Typescript docs says it could also be a dictionary, and we confirmed that works in Python.

[typpo]

Thanks for catching these errors!

In the Typescript definition, GradingResult expects a numeric score and a non-null reason. We should treat that as the source of truth because the rest of the code depends on these types. So I would consider this a validation issue in the Python assertion (maybe javascript too).

For ProviderResponse, it does look like output can be an object. So the Python docs are wrong.