tool2agent API Documentation - v0.0.0
    Preparing search index...

    Type Alias ParameterValidationFailureReasons<InputType, ParamKey>

    Refusal result for a single tool call input object field. May include reasons or parameter dependencies for the refusal.

    type ParameterValidationFailureReasons<
        InputType extends Record<string, unknown>,
        ParamKey extends keyof InputType,
    > = {
        problems?: NonEmptyArray<string>;
        requiresValidParameters?: NonEmptyArray<Exclude<keyof InputType, ParamKey>>;
    }

    Type Parameters

    • InputType extends Record<string, unknown>
    • ParamKey extends keyof InputType
    Index

    Properties

    problems? requiresValidParameters?

    Properties

    problems?: NonEmptyArray<string>

    Freeform reasons for why the parameter was not considered valid.

    requiresValidParameters?: NonEmptyArray<Exclude<keyof InputType, ParamKey>>

    Sometimes it is not possible to validate a parameter without knowing the values of other parameters. In this case, the developer may specify the parameters that are required to validate this parameter, excluding the parameter itself on the type level.

    Settings

    Member Visibility

    On This Page

    Properties