ReferenceAIDocumentComparisonResult

Type Alias AIDocumentComparisonResult

Result returned by AI-powered document comparison operations. This union type represents the response from NutrientViewer.Instance#compareDocuments when using NutrientViewer.ComparisonOperationType.AI.

The result type depends on the AI operation performed:

Analysis Operation (NutrientViewer.AIComparisonOperationType.ANALYZE): Returns AIADocumentChangesAnalysisResponse containing:
summary: AI-generated summary describing the overall nature of changes
categories: Array of AI-detected change types (e.g., "Formatting", "Content Addition")
changes: Standard DocumentComparison.DocumentComparisonResult with detailed differences
Tagging Operation (NutrientViewer.AIComparisonOperationType.TAG): Returns AIADocumentChangesTaggingResponse containing:
references: Array where each item corresponds to a change with assigned category tags
changes: Standard DocumentComparison.DocumentComparisonResult with detailed differences

Use the provided type guards to determine which specific result type you received:

NutrientViewer.isAIDocumentAnalysisResult - Check for analysis results
NutrientViewer.isAIDocumentTaggingResult - Check for tagging results
NutrientViewer.isAIDocumentComparisonResult - Check for any AI result

Type Alias

Type Signature

type AIDocumentComparisonResult = AIADocumentChangesAnalysisResponse | AIADocumentChangesTaggingResponse

Example

const analyzeOperation = new NutrientViewer.ComparisonOperation(
  NutrientViewer.ComparisonOperationType.AI,
  { operationType: NutrientViewer.AIComparisonOperationType.ANALYZE }
);

instance.compareDocuments(documents, analyzeOperation)
  .then((result) => {
    if (NutrientViewer.isAIDocumentAnalysisResult(result)) {
      console.log('Summary:', result.summary);
      console.log('Categories:', result.categories);
    }
  });

Type Alias AIDocumentComparisonResult

Example

See Also