Nutrient Web SDK

ReferenceNutrientViewerComparisonOperation

Class 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 })

Class

Example

Create a new text comparison operation.

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

Create a new AI comparison operation.

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

Default Value

{ type: NutrientViewer.ComparisonOperationType.TEXT, options: { numberOfContextWords: 0 } }

Hierarchy

RecordComparisonOperation

Constructors

new ComparisonOperation(type, options)

  • Parameters

    type"text" | "ai"
    options
    {
    numberOfContextWords?: number;
    wordLevel?: boolean;
    [key: string]: any;
    }
    | { … }
    = {}

Properties

options

OptionalReadonly
IComparisonOperationOptions

type

Readonly
"text" | "ai"

Methods

getAIOperationType

  • Returns the AI operation type, if this is an AI comparison

    Returns

    "analyze" | "tag" | undefined

isAIComparison

  • Returns true if this operation is an AI comparison

    Returns

    boolean

isTextComparison

  • Returns true if this operation is a text comparison

    Returns

    boolean

Immutable Record API

31

displayName

Static
string

The name provided to Record(values, name) can be accessed with displayName.

[iterator]

  • Returns

    IterableIterator<
    [
    keyof { options?: IComparisonOperationOptions; type: "text"
    | "ai" },
    "text" | "ai" | IComparisonOperationOptions | undefined
    ]
    >

asImmutable

  • Returns

    this

    See Also

    • Map#asImmutable

asMutable

  • Returns

    this

    See Also

    • Map#asMutable

clear

  • Returns a new instance of this Record type with all values set to their default values.

    Returns

    this

delete

  • Returns a new instance of this Record type with the value for the specific key set to its default value.

    Type Parameters

    Kextends keyof { options?: IComparisonOperationOptions; type: "text" | "ai" }

    Parameters

    keyK

    Returns

    this

deleteIn

  • Parameters

    keyPathIterable<unknown>

    Returns

    this

equals

  • Parameters

    otherunknown

    Returns

    boolean

get

  • Returns the value associated with the provided key, which may be the default value defined when creating the Record factory function.

    If the requested key is not defined by this Record type, then notSetValue will be returned if provided. Note that this scenario would produce an error when using Flow or TypeScript.

    Type Parameters

    Kextends keyof { options?: IComparisonOperationOptions; type: "text" | "ai" }

    Parameters

    keyK
    notSetValueunknown
    Optional

    Returns

    { options?: IComparisonOperationOptions; type: "text" | "ai" }[K]

  • Type Parameters

    T

    Parameters

    keystring
    notSetValueT

    Returns

    T

getIn

  • Parameters

    keyPathIterable<unknown>

    Returns

    unknown

has

  • Parameters

    keystring

    Returns

    key is "type" | "options"

hashCode

  • Returns

    number

hasIn

  • Parameters

    keyPathIterable<unknown>

    Returns

    boolean

merge

  • Parameters

    ...collections(
    | Iterable<[string, unknown], any, any>
    | Partial<{ options?: IComparisonOperationOptions; type: "text" | "ai" }>
    )[]

    Returns

    this

mergeDeep

  • Parameters

    ...collections(
    | Iterable<[string, unknown], any, any>
    | Partial<{ options?: IComparisonOperationOptions; type: "text" | "ai" }>
    )[]

    Returns

    this

mergeDeepIn

  • Parameters

    keyPathIterable<unknown>
    ...collectionsunknown[]

    Returns

    this

mergeDeepWith

  • Parameters

    merger(oldVal: unknown, newVal: unknown, key: unknown) => unknown
    ...collections(
    | Iterable<[string, unknown], any, any>
    | Partial<{ options?: IComparisonOperationOptions; type: "text" | "ai" }>
    )[]

    Returns

    this

mergeIn

  • Parameters

    keyPathIterable<unknown>
    ...collectionsunknown[]

    Returns

    this

mergeWith

  • Parameters

    merger(
    oldVal: unknown,
    newVal: unknown,
    key: keyof { options?: IComparisonOperationOptions; type: "text" | "ai" }
    ) => unknown
    ...collections(
    | Iterable<[string, unknown], any, any>
    | Partial<{ options?: IComparisonOperationOptions; type: "text" | "ai" }>
    )[]

    Returns

    this

remove

  • Type Parameters

    Kextends keyof { options?: IComparisonOperationOptions; type: "text" | "ai" }

    Parameters

    keyK

    Returns

    this

removeIn

  • Parameters

    keyPathIterable<unknown>

    Returns

    this

set

  • Type Parameters

    Kextends keyof { options?: IComparisonOperationOptions; type: "text" | "ai" }

    Parameters

    keyK
    value{ options?: IComparisonOperationOptions; type: "text" | "ai" }[K]

    Returns

    this

setIn

  • Parameters

    keyPathIterable<unknown>
    valueunknown

    Returns

    this

toJS

  • Deeply converts this Record to equivalent native JavaScript Object.

    Note: This method may not be overridden. Objects with custom serialization to plain JS may override toJSON() instead.

    Returns

    { options?: unknown; type: "text" | "ai" }

toJSON

  • Shallowly converts this Record to equivalent native JavaScript Object.

    Returns

    { options?: IComparisonOperationOptions; type: "text" | "ai" }

toObject

  • Shallowly converts this Record to equivalent JavaScript Object.

    Returns

    { options?: IComparisonOperationOptions; type: "text" | "ai" }

toSeq

  • Returns

    Keyed<
    keyof { options?: IComparisonOperationOptions; type: "text"
    | "ai" },
    "text" | "ai" | IComparisonOperationOptions | undefined
    >

update

  • Type Parameters

    Kextends keyof { options?: IComparisonOperationOptions; type: "text" | "ai" }

    Parameters

    keyK
    updater(
    value: { options?: IComparisonOperationOptions; type: "text" | "ai" }[K]
    ) => { options?: IComparisonOperationOptions; type: "text" | "ai" }[K]

    Returns

    this

updateIn

  • Parameters

    keyPathIterable<unknown>
    updater(value: unknown) => unknown

    Returns

    this

wasAltered

  • Returns

    boolean

    See Also

    • Map#wasAltered

withMutations

  • Note: Not all methods can be used on a mutable collection or within withMutations! Only set may be used mutatively.

    Parameters

    mutator(mutable: this) => unknown

    Returns

    this

    See Also

    • Map#withMutations