Nutrient Web SDK
    Preparing search index...

    Interface AIComparisonData

    Data structure for AI comparison results

    interface AIComparisonData {
        aiEnhancedChanges?: NutrientViewer.Immutable.List<
            {
                aiId?: string;
                aiProcessed?: boolean;
                categories?: string[];
                deletedText: string;
                deletionAnnotations: NutrientViewer.Immutable.List<
                    NutrientViewer.Annotations.HighlightAnnotation,
                >;
                deletionCount: number;
                insertedText: string;
                insertionAnnotations: NutrientViewer.Immutable.List<
                    NutrientViewer.Annotations.HighlightAnnotation,
                >;
                insertionCount: number;
                operationType: TextComparisonOperationTypes;
                pages: NutrientViewer.Immutable.Set<number>;
            },
        >;
        categories: string[];
        changes: DocumentComparisonResult;
        error: null
        | AIComparisonError;
        phase: IAIComparisonPhase;
        summary: string;
        taggedChanges?: AIADocumentChangeTaggingItem[];
        transformedChanges?: AIADocumentChangePayload[];
    }
    Index

    Properties

    aiEnhancedChanges? categories changes error phase summary taggedChanges? transformedChanges?

    Properties

    aiEnhancedChanges?: NutrientViewer.Immutable.List<
        {
            aiId?: string;
            aiProcessed?: boolean;
            categories?: string[];
            deletedText: string;
            deletionAnnotations: NutrientViewer.Immutable.List<
                NutrientViewer.Annotations.HighlightAnnotation,
            >;
            deletionCount: number;
            insertedText: string;
            insertionAnnotations: NutrientViewer.Immutable.List<
                NutrientViewer.Annotations.HighlightAnnotation,
            >;
            insertionCount: number;
            operationType: TextComparisonOperationTypes;
            pages: NutrientViewer.Immutable.Set<number>;
        },
    >

    Enhanced changes with AI properties (optional)

    categories: string[]

    Array of AI-detected change categories

    changes: DocumentComparisonResult

    Standard document comparison result

    error: null | AIComparisonError

    Error information if comparison failed

    phase: IAIComparisonPhase

    Current phase of the AI comparison process

    summary: string

    AI-generated summary of document changes

    taggedChanges?: AIADocumentChangeTaggingItem[]

    Changes tagged with categories (optional)

    transformedChanges?: AIADocumentChangePayload[]

    Transformed changes for AI processing (optional)

    Settings

    Member Visibility

    On This Page

    Properties