Class WeaviateTranslator<T>

A class that translates or converts data into a format that can be used with Weaviate, a vector search engine. It extends the BaseTranslator class and provides specific implementation for Weaviate.

Example

const selfQueryRetriever = new SelfQueryRetriever({
  llm: new ChatOpenAI(),
  vectorStore: new WeaviateStore(),
  documentContents: "Brief summary of a movie",
  attributeInfo: [],
  structuredQueryTranslator: new WeaviateTranslator(),
});

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

Type Parameters

T extends WeaviateStore

Hierarchy (view full)

BaseTranslator<T>
- WeaviateTranslator

Index

Constructors

constructor

new WeaviateTranslator<T>(): WeaviateTranslator<T>
Type Parameters
- T extends WeaviateStore
Returns WeaviateTranslator<T>
Inherited from BaseTranslator.constructor

Properties

VisitComparisonOutput

VisitComparisonOutput: WeaviateComparisonResult

VisitOperationOutput

VisitOperationOutput: WeaviateOperationResult

VisitStructuredQueryOutput

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

allowedComparators

allowedComparators: Comparator[] = ...

allowedOperators

allowedOperators: Operator[] = ...

Methods

formatFunction

formatFunction(func): string
Formats the given function into a string representation. Throws an error if the function is not a known comparator or operator, or if it is not allowed.
Parameters
- func: Operator | Comparator
  The function to format, which can be an Operator or Comparator.
Returns string
A string representation of the function.
Overrides BaseTranslator.formatFunction
- Defined in libs/langchain-weaviate/src/translator.ts:100

mergeFilters

mergeFilters(defaultFilter, generatedFilter, mergeType?): undefined | WeaviateFilter
Merges two filters into one. If both filters are empty, returns undefined. If one filter is empty or the merge type is 'replace', returns the other filter. If the merge type is 'and' or 'or', returns a new filter with the merged results. Throws an error for unknown merge types.
Parameters
- defaultFilter: undefined | WeaviateFilter
  The default filter to merge.
- generatedFilter: undefined | WeaviateFilter
  The generated filter to merge.
- mergeType: string = "and"
  The type of merge to perform. Can be 'and', 'or', or 'replace'. Defaults to 'and'.
Returns undefined | WeaviateFilter
A merged WeaviateFilter, or undefined if both filters are empty.
Overrides BaseTranslator.mergeFilters
- Defined in libs/langchain-weaviate/src/translator.ts:217

visitComparison

visitComparison(comparison): WeaviateComparisonResult
Visits a comparison and returns a WeaviateComparisonResult. The comparison's value is checked for type and the comparator is formatted. Throws an error if the value type is not supported.
Parameters
- comparison: Comparison
  The comparison to visit.
Returns WeaviateComparisonResult
A WeaviateComparisonResult.
Overrides BaseTranslator.visitComparison
- Defined in libs/langchain-weaviate/src/translator.ts:162

visitOperation

visitOperation(operation): WeaviateOperationResult
Visits an operation and returns a WeaviateOperationResult. The operation's arguments are visited and the operator is formatted.
Parameters
- operation: Operation
  The operation to visit.
Returns WeaviateOperationResult
A WeaviateOperationResult.
Overrides BaseTranslator.visitOperation
- Defined in libs/langchain-weaviate/src/translator.ts:145

visitStructuredQuery

visitStructuredQuery(query): {
filter?: T["FilterType"];
}
Visits a structured query and returns a WeaviateStructuredQueryResult. If the query has a filter, it is visited.
Parameters
- query: StructuredQuery
  The structured query to visit.
Returns {
filter?: T["FilterType"];
}
A WeaviateStructuredQueryResult.
- Optionalfilter?: T["FilterType"]
Overrides BaseTranslator.visitStructuredQuery
- Defined in libs/langchain-weaviate/src/translator.ts:194

Class WeaviateTranslator<T>

Example

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Returns WeaviateTranslator<T>

Properties

VisitComparisonOutput

VisitOperationOutput

VisitStructuredQueryOutput

allowedComparators

allowedOperators

Methods

formatFunction

Parameters

Returns string

mergeFilters

Parameters

Returns undefined | WeaviateFilter

visitComparison

Parameters

Returns WeaviateComparisonResult

visitOperation

Parameters

Returns WeaviateOperationResult

visitStructuredQuery

Parameters

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

`Optional`filter?: T["FilterType"]

Settings

On This Page

Class WeaviateTranslator<T>

Example

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Returns WeaviateTranslator<T>

Properties

VisitComparisonOutput

VisitOperationOutput

VisitStructuredQueryOutput

allowedComparators

allowedOperators

Methods

formatFunction

Parameters

Returns string

mergeFilters

Parameters

Returns undefined | WeaviateFilter

visitComparison

Parameters

Returns WeaviateComparisonResult

visitOperation

Parameters

Returns WeaviateOperationResult

visitStructuredQuery

Parameters

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

Optionalfilter?: T["FilterType"]

Settings

On This Page

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

`Optional`filter?: T["FilterType"]