Class: ComparisonOperation

PSPDFKit.ComparisonOperation

ComparisonOperation is a class that provides methods to describe a comparison operation. It encapsulates the type and optional settings for the comparison.

It is an Immutable.Record and thus can be updated using set(key, value), for example: scale.set("options", { numberOfContextWords: 4 })

Constructor

new PSPDFKit.ComparisonOperation()

The descriptor for a comparison operation.

Default Value:
  • { type: PSPDFKit.ComparisonOperationType.TEXT, options: { numberOfContextWords: 0 } }
Examples

Create a new text comparison operation

const operation = new ComparisonOperation(PSPDFKit.ComparisonOperationType.TEXT, { numberOfContextWords: 2 });

Create a new AI comparison operation

const aiOperation = new ComparisonOperation(
  PSPDFKit.ComparisonOperationType.AI,
  { operationType: PSPDFKit.AIComparisonOperationType.ANALYZE, model: 'gpt4o' }
);

Extends

  • Immutable.Record