Documentation
    Preparing search index...

    Interface IJsonSchemaTransformError

    Error information from JSON schema transformation.

    IJsonSchemaTransformError represents an error that occurred during transformation or iteration of OpenApi.IJsonSchema types. This error type is primarily generated when converting OpenAPI schemas to LLM-compatible formats via ILlmSchema.

    Common transformation failures include:

    • Missing references: $ref pointing to non-existent schema definitions
    • Unsupported tuple types: All LLM providers reject tuple schemas
    • Unsupported union types: Gemini does not support oneOf schemas
    • Unsupported dynamic objects: ChatGPT and Gemini reject additionalProperties

    The reasons array provides detailed information about each failure, including the problematic schema, its location path, and a human-readable error message. Use this information to diagnose and fix schema compatibility issues.

    Jeongho Nam - https://github.com/samchon

    interface IJsonSchemaTransformError {
        message: string;
        method: string;
        reasons: IReason[];
    }
    Index

    Properties

    message method reasons

    Properties

    message: string

    Summary error message.

    A human-readable description of the overall error. For detailed information about specific failures, examine the reasons array.

    method: string

    Name of the method that caused the error.

    Identifies which transformation function failed, such as "HttpLlm.application" or "LlmSchemaConverter.schema".

    reasons: IReason[]

    Detailed list of transformation failures.

    Each entry describes a specific schema that failed transformation, including its location and the reason for failure. Multiple failures can occur in a single transformation when processing complex schemas.

    Settings

    Member Visibility

    On This Page

    Properties