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

Visitor<T>
- BaseTranslator

Index

Constructors

Properties

VisitComparisonOutput VisitOperationOutput VisitStructuredQueryOutput allowedComparators allowedOperators

Methods

formatFunction mergeFilters visitComparison visitOperation visitStructuredQuery

Constructors

constructor

new BaseTranslator<T>(): BaseTranslator<T>
Type Parameters
- T extends VectorStore<T> = VectorStore
Returns BaseTranslator<T>

Inherited from Visitor.constructor

Properties

VisitComparisonOutput

VisitComparisonOutput: object

VisitOperationOutput

VisitOperationOutput: object

VisitStructuredQueryOutput

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

Type declaration

Optional filter?: T["FilterType"]

`Abstract` allowedComparators

allowedComparators: Comparator[]

`Abstract` allowedOperators

allowedOperators: Operator[]

Methods

`Abstract` formatFunction

formatFunction(func): 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 docs/api_refs/langchain/src/retrievers/self_query/base.ts:41

`Abstract` mergeFilters

mergeFilters(defaultFilter, generatedFilter, mergeType?, forceDefaultFilter?): 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.
- Optional mergeType: "replace" | "and" | "or"
  
  The type of merge to perform. Can be 'and', 'or', or 'replace'.
- Optional forceDefaultFilter: 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 docs/api_refs/langchain/src/retrievers/self_query/base.ts:51

`Abstract` visitComparison

visitComparison(comparison): object
Parameters
- comparison: Comparison
Returns object
Inherited from Visitor.visitComparison
- Defined in docs/api_refs/langchain/src/chains/query_constructor/ir.ts:113

`Abstract` visitOperation

visitOperation(operation): object
Parameters
- operation: Operation
Returns object
Inherited from Visitor.visitOperation
- Defined in docs/api_refs/langchain/src/chains/query_constructor/ir.ts:111

`Abstract` visitStructuredQuery

visitStructuredQuery(structuredQuery): {
filter?: T["FilterType"];
}
Parameters
- structuredQuery: StructuredQuery
Returns {
filter?: T["FilterType"];
}
- Optional filter?: T["FilterType"]
Inherited from Visitor.visitStructuredQuery
- Defined in docs/api_refs/langchain/src/chains/query_constructor/ir.ts:117

Generated using TypeDoc