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

Example

Create a new text comparison operation.

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

Example

Create a new AI comparison operation.

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

Default

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

Hierarchy

Record<IComparisonOperation, this> & Readonly<IComparisonOperation>
- ComparisonOperation

Index

Constructors

constructor

new ComparisonOperation(
    type: "text" | "ai",
    options?:
        | {
            numberOfContextWords?: number;
            wordLevel?: boolean;
            [key: string]: any;
        }
        | IAIComparisonOperationOptions,
): NutrientViewer.ComparisonOperation
Parameters
- type: "text" | "ai"
- options:
      | {
          numberOfContextWords?: number;
          wordLevel?: boolean;
          [key: string]: any;
      }
      | IAIComparisonOperationOptions = {}
Returns NutrientViewer.ComparisonOperation
Overrides ImmutableRecord(ComparisonOperationDefaults).constructor

Properties

`Optional` `Readonly`options

options?: IComparisonOperationOptions

`Readonly`type

type: "text" | "ai"

Methods

[iterator]

"[iterator]"(): IterableIterator<
    [
        keyof IComparisonOperation,
        undefined
        | "text" | "ai"
        | IComparisonOperationOptions,
    ],
>
Returns IterableIterator<
    [
        keyof IComparisonOperation,
        undefined
        | "text" | "ai"
        | IComparisonOperationOptions,
    ],
>
Inherited from ImmutableRecord(ComparisonOperationDefaults).[iterator]

asImmutable

asImmutable(): this
Returns this
See
Map#asImmutable

Inherited from ImmutableRecord(ComparisonOperationDefaults).asImmutable

asMutable

asMutable(): this
Returns this
See
Map#asMutable

Inherited from ImmutableRecord(ComparisonOperationDefaults).asMutable

clear

clear(): this
Returns a new instance of this Record type with all values set to their default values.

Returns this
Inherited from ImmutableRecord(ComparisonOperationDefaults).clear

delete

delete<K extends keyof IComparisonOperation>(key: K): this
Returns a new instance of this Record type with the value for the specific key set to its default value.
Type Parameters
- K extends keyof IComparisonOperation
Parameters
- key: K
Returns this
Alias
remove

Inherited from ImmutableRecord(ComparisonOperationDefaults).delete

deleteIn

deleteIn(keyPath: Iterable<any>): this
Parameters
- keyPath: Iterable<any>
Returns this
Alias
removeIn

Inherited from ImmutableRecord(ComparisonOperationDefaults).deleteIn

equals

equals(other: any): boolean
Parameters
- other: any
Returns boolean
Inherited from ImmutableRecord(ComparisonOperationDefaults).equals

get

get<K extends keyof IComparisonOperation>(
key: K,
notSetValue?: any,
): IComparisonOperation[K]
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
- K extends keyof IComparisonOperation
Parameters
- key: K
- OptionalnotSetValue: any
Returns IComparisonOperation[K]
Inherited from ImmutableRecord(ComparisonOperationDefaults).get
get<T>(key: string, notSetValue: T): T
Type Parameters
- T
Parameters
- key: string
- notSetValue: T
Returns T
Inherited from ImmutableRecord(ComparisonOperationDefaults).get

getAIOperationType

getAIOperationType(): undefined | IAIComparisonOperationType
Returns the AI operation type, if this is an AI comparison

Returns undefined | IAIComparisonOperationType

getIn

getIn(keyPath: Iterable<any>): any
Parameters
- keyPath: Iterable<any>
Returns any
Inherited from ImmutableRecord(ComparisonOperationDefaults).getIn

has

has(key: string): key is "type" | "options"
Parameters
- key: string
Returns key is "type" | "options"
Inherited from ImmutableRecord(ComparisonOperationDefaults).has

hashCode

hashCode(): number
Returns number
Inherited from ImmutableRecord(ComparisonOperationDefaults).hashCode

hasIn

hasIn(keyPath: Iterable<any>): boolean
Parameters
- keyPath: Iterable<any>
Returns boolean
Inherited from ImmutableRecord(ComparisonOperationDefaults).hasIn

isAIComparison

isAIComparison(): boolean
Returns true if this operation is an AI comparison

Returns boolean

isTextComparison

isTextComparison(): boolean
Returns true if this operation is a text comparison

Returns boolean

merge

merge(
    ...collections: (
        Iterable<[string, any]>
        | Partial<IComparisonOperation>
    )[],
): this
Parameters
- ...collections: (Iterable<[string, any]> | Partial<IComparisonOperation>)[]
Returns this
Inherited from ImmutableRecord(ComparisonOperationDefaults).merge

mergeDeep

mergeDeep(
    ...collections: (
        Iterable<[string, any]>
        | Partial<IComparisonOperation>
    )[],
): this
Parameters
- ...collections: (Iterable<[string, any]> | Partial<IComparisonOperation>)[]
Returns this
Inherited from ImmutableRecord(ComparisonOperationDefaults).mergeDeep

mergeDeepIn

mergeDeepIn(keyPath: Iterable<any>, ...collections: any[]): this
Parameters
- keyPath: Iterable<any>
- ...collections: any[]
Returns this
Inherited from ImmutableRecord(ComparisonOperationDefaults).mergeDeepIn

mergeDeepWith

mergeDeepWith(
merger: (oldVal: any, newVal: any, key: any) => any,
...collections: (Iterable<[string, any]> | Partial<IComparisonOperation>)[],
): this
Parameters
- merger: (oldVal: any, newVal: any, key: any) => any
- ...collections: (Iterable<[string, any]> | Partial<IComparisonOperation>)[]
Returns this
Inherited from ImmutableRecord(ComparisonOperationDefaults).mergeDeepWith

mergeIn

mergeIn(keyPath: Iterable<any>, ...collections: any[]): this
Parameters
- keyPath: Iterable<any>
- ...collections: any[]
Returns this
Inherited from ImmutableRecord(ComparisonOperationDefaults).mergeIn

mergeWith

mergeWith(
    merger: (
        oldVal: any,
        newVal: any,
        key: keyof IComparisonOperation,
    ) => any,
    ...collections: (Iterable<[string, any]> | Partial<IComparisonOperation>)[],
): this
Parameters
- merger: (oldVal: any, newVal: any, key: keyof IComparisonOperation) => any
- ...collections: (Iterable<[string, any]> | Partial<IComparisonOperation>)[]
Returns this
Inherited from ImmutableRecord(ComparisonOperationDefaults).mergeWith

remove

remove<K extends keyof IComparisonOperation>(key: K): this
Type Parameters
- K extends keyof IComparisonOperation
Parameters
- key: K
Returns this
Inherited from ImmutableRecord(ComparisonOperationDefaults).remove

removeIn

removeIn(keyPath: Iterable<any>): this
Parameters
- keyPath: Iterable<any>
Returns this
Inherited from ImmutableRecord(ComparisonOperationDefaults).removeIn

set

set<K extends keyof IComparisonOperation>(
key: K,
value: IComparisonOperation[K],
): this
Type Parameters
- K extends keyof IComparisonOperation
Parameters
- key: K
- value: IComparisonOperation[K]
Returns this
Inherited from ImmutableRecord(ComparisonOperationDefaults).set

setIn

setIn(keyPath: Iterable<any>, value: any): this
Parameters
- keyPath: Iterable<any>
- value: any
Returns this
Inherited from ImmutableRecord(ComparisonOperationDefaults).setIn

toJS

toJS(): { options?: any; type: any }
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?: any; type: any }
Inherited from ImmutableRecord(ComparisonOperationDefaults).toJS

toJSON

toJSON(): IComparisonOperation
Shallowly converts this Record to equivalent native JavaScript Object.

Returns IComparisonOperation
Inherited from ImmutableRecord(ComparisonOperationDefaults).toJSON

toObject

toObject(): IComparisonOperation
Shallowly converts this Record to equivalent JavaScript Object.

Returns IComparisonOperation
Inherited from ImmutableRecord(ComparisonOperationDefaults).toObject

toSeq

toSeq(): Keyed<
    keyof IComparisonOperation,
    undefined
    | "text" | "ai"
    | IComparisonOperationOptions,
>
Returns Keyed<
    keyof IComparisonOperation,
    undefined
    | "text" | "ai"
    | IComparisonOperationOptions,
>
Inherited from ImmutableRecord(ComparisonOperationDefaults).toSeq

update

update<K extends keyof IComparisonOperation>(
key: K,
updater: (value: IComparisonOperation[K]) => IComparisonOperation[K],
): this
Type Parameters
- K extends keyof IComparisonOperation
Parameters
- key: K
- updater: (value: IComparisonOperation[K]) => IComparisonOperation[K]
Returns this
Inherited from ImmutableRecord(ComparisonOperationDefaults).update

updateIn

updateIn(keyPath: Iterable<any>, updater: (value: any) => any): this
Parameters
- keyPath: Iterable<any>
- updater: (value: any) => any
Returns this
Inherited from ImmutableRecord(ComparisonOperationDefaults).updateIn

wasAltered

wasAltered(): boolean
Returns boolean
See
Map#wasAltered

Inherited from ImmutableRecord(ComparisonOperationDefaults).wasAltered

withMutations

withMutations(mutator: (mutable: this) => any): this
Note: Not all methods can be used on a mutable collection or within withMutations! Only set may be used mutatively.
Parameters
- mutator: (mutable: this) => any
Returns this
See
Map#withMutations

Inherited from ImmutableRecord(ComparisonOperationDefaults).withMutations

Class ComparisonOperation

Example

Example

Default

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns NutrientViewer.ComparisonOperation

Properties

Optional Readonlyoptions

Readonlytype

Methods

[iterator]

Returns IterableIterator< [ keyof IComparisonOperation, undefined | "text" | "ai" | IComparisonOperationOptions, ],>

asImmutable

Returns this

See

asMutable

Returns this

See

clear

Returns this

delete

Type Parameters

Parameters

Returns this

Alias

deleteIn

Parameters

Returns this

Alias

equals

Parameters

Returns boolean

get

Type Parameters

Parameters

Returns IComparisonOperation[K]

Type Parameters

Parameters

Returns T

getAIOperationType

Returns undefined | IAIComparisonOperationType

getIn

Parameters

Returns any

has

Parameters

Returns key is "type" | "options"

hashCode

Returns number

hasIn

Parameters

Returns boolean

isAIComparison

Returns boolean

isTextComparison

Returns boolean

merge

Parameters

Returns this

mergeDeep

Parameters

Returns this

mergeDeepIn

Parameters

Returns this

mergeDeepWith

Parameters

Returns this

mergeIn

Parameters

Returns this

mergeWith

Parameters

`Optional` `Readonly`options

`Readonly`type

Returns IterableIterator<
[
keyof IComparisonOperation,
undefined
| "text" | "ai"
| IComparisonOperationOptions,
],
>

Returns Keyed<
keyof IComparisonOperation,
undefined
| "text" | "ai"
| IComparisonOperationOptions,
>