Class FunctionalTranslator

A class that extends BaseTranslator to translate structured queries into functional filters.

Example

const functionalTranslator = new FunctionalTranslator();
const relevantDocuments = await functionalTranslator.getRelevantDocuments(
  "Which movies are rated higher than 8.5?",
);

Hierarchy

BaseTranslator
- FunctionalTranslator

Index

Constructors

constructor

new FunctionalTranslator(): FunctionalTranslator
Returns FunctionalTranslator

Inherited from BaseTranslator.constructor

Properties

VisitComparisonOutput

VisitComparisonOutput: FunctionFilter

VisitOperationOutput

VisitOperationOutput: FunctionFilter

VisitStructuredQueryOutput

VisitStructuredQueryOutput: {
filter: FunctionFilter;
} | {
[k: string]: never;
}

Type declaration

filter: FunctionFilter

Type declaration

[k: string]: never

allowedComparators

allowedComparators: Comparator[] = ...

allowedOperators

allowedOperators: Operator[] = ...

Methods

formatFunction

formatFunction(): string
Formats a given function (either an operator or a comparator) into a string.

Returns string
Formatted string representation of the function.
Overrides BaseTranslator.formatFunction
- Defined in langchain/src/retrievers/self_query/functional.ts:65

getComparatorFunction

getComparatorFunction<C>(comparator): ((a, b) => boolean)
Returns a function that performs a comparison based on the provided comparator.
Type Parameters
- C extends Comparator
Parameters
- comparator: Comparator
  
  The comparator to base the comparison function on.
Returns ((a, b) => boolean)
A function that takes two arguments and returns a boolean based on the comparison.
- - (a, b): boolean
  - Returns a function that performs a comparison based on the provided comparator.
    Parameters
    - a: string | number
    - b: ValueType[C]
    Returns boolean
    A function that takes two arguments and returns a boolean based on the comparison.
- Defined in langchain/src/retrievers/self_query/functional.ts:75

getOperatorFunction

getOperatorFunction(operator): ((a, b) => boolean)
Returns a function that performs an operation based on the provided operator.
Parameters
- operator: Operator
  
  The operator to base the operation function on.
Returns ((a, b) => boolean)
A function that takes two boolean arguments and returns a boolean based on the operation.
- - (a, b): boolean
  - Returns a function that performs an operation based on the provided operator.
    Parameters
    - a: boolean
    - b: boolean
    Returns boolean
    A function that takes two boolean arguments and returns a boolean based on the operation.
- Defined in langchain/src/retrievers/self_query/functional.ts:109

mergeFilters

mergeFilters(defaultFilter, generatedFilter, mergeType?): undefined | FunctionFilter
Merges two filters into one, based on the specified merge type.
Parameters
- defaultFilter: FunctionFilter
  
  The default filter function.
- generatedFilter: FunctionFilter
  
  The generated filter function.
- mergeType: string = "and"
  
  The type of merge to perform. Can be 'and', 'or', or 'replace'. Default is 'and'.
Returns undefined | FunctionFilter
A function that takes a Document as an argument and returns a boolean based on the merged filters, or undefined if both filters are empty.
Overrides BaseTranslator.mergeFilters
- Defined in langchain/src/retrievers/self_query/functional.ts:203

visitComparison

visitComparison(comparison): FunctionFilter
Visits the comparison part of a structured query and translates it into a functional filter.
Parameters
- comparison: Comparison
  
  The comparison part of a structured query.
Returns FunctionFilter
A function that takes a Document as an argument and returns a boolean based on the comparison.
Overrides BaseTranslator.visitComparison
- Defined in langchain/src/retrievers/self_query/functional.ts:158

visitOperation

visitOperation(operation): FunctionFilter
Visits the operation part of a structured query and translates it into a functional filter.
Parameters
- operation: Operation
  
  The operation part of a structured query.
Returns FunctionFilter
A function that takes a Document as an argument and returns a boolean based on the operation.
Overrides BaseTranslator.visitOperation
- Defined in langchain/src/retrievers/self_query/functional.ts:129

visitStructuredQuery

visitStructuredQuery(query): {
filter: FunctionFilter;
} | {
[k: string]: never;
}
Visits a structured query and translates it into a functional filter.
Parameters
- query: StructuredQuery
  
  The structured query to translate.
Returns {
filter: FunctionFilter;
} | {
[k: string]: never;
}
An object containing a filter property, which is a function that takes a Document as an argument and returns a boolean based on the structured query.
Overrides BaseTranslator.visitStructuredQuery
- Defined in langchain/src/retrievers/self_query/functional.ts:183

Class FunctionalTranslator

Example

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns FunctionalTranslator

Properties

VisitComparisonOutput

VisitOperationOutput

VisitStructuredQueryOutput

Type declaration

filter: FunctionFilter

Type declaration

[k: string]: never

allowedComparators

allowedOperators

Methods

formatFunction

Returns string

getComparatorFunction

Type Parameters

C extends Comparator

Parameters

comparator: Comparator

Returns ((a, b) => boolean)

Parameters

a: string | number

b: ValueType[C]

Returns boolean

getOperatorFunction

Parameters

operator: Operator

Returns ((a, b) => boolean)

Parameters

a: boolean

b: boolean

Returns boolean

mergeFilters

Parameters

defaultFilter: FunctionFilter

generatedFilter: FunctionFilter

mergeType: string = "and"

Returns undefined | FunctionFilter

visitComparison

Parameters

comparison: Comparison

Returns FunctionFilter

visitOperation

Parameters

operation: Operation

Returns FunctionFilter

visitStructuredQuery

Parameters

query: StructuredQuery

Returns { filter: FunctionFilter; } | { [k: string]: never; }

Settings

Member Visibility

Theme

On This Page

Returns {
filter: FunctionFilter;
} | {
[k: string]: never;
}