Class BaseTranslator<T>`Abstract`

Abstract class that provides a blueprint for creating specific translator classes. Defines two abstract methods: formatFunction and mergeFilters.

Type Parameters

T extends VectorStore = VectorStore

Hierarchy (View Summary)

Visitor<T>
- BaseTranslator
  - BasicTranslator
  - FunctionalTranslator

Index

Constructors

Properties

allowedComparators allowedOperators VisitComparisonOutput VisitOperationOutput VisitStructuredQueryOutput

Methods

formatFunction mergeFilters visitComparison visitOperation visitStructuredQuery

Constructors

constructor

new BaseTranslator<T extends VectorStore = VectorStore>(): BaseTranslator<T>
Type Parameters
- T extends VectorStore = VectorStore
Returns BaseTranslator<T>
Inherited from Visitor.constructor

Properties

`Abstract`allowedComparators

allowedComparators: Comparator[]

`Abstract`allowedOperators

allowedOperators: Operator[]

VisitComparisonOutput

VisitComparisonOutput: object

VisitOperationOutput

VisitOperationOutput: object

VisitStructuredQueryOutput

VisitStructuredQueryOutput: { filter?: T["FilterType"] }

Methods

`Abstract`formatFunction

formatFunction(func: Operator | Comparator): string
Formats a given function (either an operator or a comparator) into a string.
Parameters
- func: Operator | Comparator
  The function to format.
Returns string
Formatted string representation of the function.
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-core/src/structured_query/base.ts:41

`Abstract`mergeFilters

mergeFilters(
    defaultFilter: undefined | T["FilterType"],
    generatedFilter: undefined | T["FilterType"],
    mergeType?: "replace" | "and" | "or",
    forceDefaultFilter?: boolean,
): undefined | T["FilterType"]
Merges two filters into one, using a specified merge type.
Parameters
- defaultFilter: undefined | T["FilterType"]
  The default filter.
- generatedFilter: undefined | T["FilterType"]
  The generated filter.
- OptionalmergeType: "replace" | "and" | "or"
  The type of merge to perform. Can be 'and', 'or', or 'replace'.
- OptionalforceDefaultFilter: boolean
  If true, the default filter will be used even if the generated filter is not empty.
Returns undefined | T["FilterType"]
The merged filter, or undefined if both filters are empty.
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-core/src/structured_query/base.ts:51

`Abstract`visitComparison

visitComparison(comparison: Comparison): object
Parameters
- comparison: Comparison
Returns object
Inherited from Visitor.visitComparison
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-core/src/structured_query/ir.ts:113

`Abstract`visitOperation

visitOperation(operation: Operation): object
Parameters
- operation: Operation
Returns object
Inherited from Visitor.visitOperation
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-core/src/structured_query/ir.ts:111

`Abstract`visitStructuredQuery

visitStructuredQuery(
structuredQuery: StructuredQuery,
): { filter?: T["FilterType"] }
Parameters
- structuredQuery: StructuredQuery
Returns { filter?: T["FilterType"] }
Inherited from Visitor.visitStructuredQuery
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-core/src/structured_query/ir.ts:117