Class SupabaseTranslator<T>

A specialized translator designed to work with Supabase, extending the BaseTranslator class. It translates structured queries into a format that can be understood by the Supabase database.

Example

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

const queryResult = await selfQueryRetriever.getRelevantDocuments(
  "Which movies are directed by Greta Gerwig?",
);

Type Parameters

T extends SupabaseVectorStore

Hierarchy

BaseTranslator<T>
- SupabaseTranslator

Index

Constructors

constructor

new SupabaseTranslator<T>(): SupabaseTranslator<T>
Type Parameters
- T extends SupabaseVectorStore
Returns SupabaseTranslator<T>

Inherited from BaseTranslator.constructor

Properties

VisitComparisonOutput

VisitComparisonOutput: SupabaseFilterRPCCall

VisitOperationOutput

VisitOperationOutput: SupabaseFilterRPCCall

VisitStructuredQueryOutput

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

Type declaration

Optional filter?: T["FilterType"]

allowedComparators

allowedComparators: Comparator[] = ...

allowedOperators

allowedOperators: Operator[] = ...

Methods

buildColumnName

buildColumnName(attr, value, includeType?): string
Builds a column name based on the attribute and value provided. The column name is used in filtering data in a Supabase database.
Parameters
- attr: string
  
  The attribute to be used in the column name.
- value: string | number
  
  The value to be used in the column name.
- includeType: boolean = true
  
  Whether to include the data type in the column name.
Returns string
The built column name.
- Defined in docs/api_refs/langchain/src/retrievers/self_query/supabase.ts:125

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 docs/api_refs/langchain/src/retrievers/self_query/supabase.ts:72

getComparatorFunction

getComparatorFunction<C>(comparator): ((attr, value) => SupabaseFilterRPCCall)
Returns a function that applies the appropriate comparator operation on the attribute and value provided. The function returned is used to filter data in a Supabase database.
Type Parameters
- C extends Comparator
Parameters
- comparator: Comparator
  
  The comparator to be used in the operation.
Returns ((attr, value) => SupabaseFilterRPCCall)
A function that applies the comparator operation on the attribute and value provided.
- - (attr, value): SupabaseFilterRPCCall
  - Returns a function that applies the appropriate comparator operation on the attribute and value provided. The function returned is used to filter data in a Supabase database.
    Parameters
    - attr: string
    - value: ValueType[C]
    Returns SupabaseFilterRPCCall
    A function that applies the comparator operation on the attribute and value provided.
- Defined in docs/api_refs/langchain/src/retrievers/self_query/supabase.ts:83

mergeFilters

mergeFilters(defaultFilter, generatedFilter, mergeType?): undefined | SupabaseFilterRPCCall | SupabaseMetadata
Merges two filters into one. The merged filter can be used to filter data in a Supabase database.
Parameters
- defaultFilter: undefined | SupabaseFilterRPCCall | SupabaseMetadata
  
  The default filter to be merged.
- generatedFilter: undefined | SupabaseFilterRPCCall
  
  The generated filter to be merged.
- mergeType: string = "and"
  
  The type of merge to be performed. It can be 'and', 'or', or 'replace'.
Returns undefined | SupabaseFilterRPCCall | SupabaseMetadata
The merged filter.
Overrides BaseTranslator.mergeFilters
- Defined in docs/api_refs/langchain/src/retrievers/self_query/supabase.ts:270

visitComparison

visitComparison(comparison): SupabaseFilterRPCCall
Visits a comparison and returns a function that applies the comparison on a Supabase database. This is used in translating a structured query into a format that can be understood by Supabase.
Parameters
- comparison: Comparison
  
  The comparison to be visited.
Returns SupabaseFilterRPCCall
A function that applies the comparison on a Supabase database.
Overrides BaseTranslator.visitComparison
- Defined in docs/api_refs/langchain/src/retrievers/self_query/supabase.ts:233

visitComparisonAsString

visitComparisonAsString(comparison): string
Visits a comparison and returns a string representation of it. This is used in translating a structured query into a format that can be understood by Supabase.
Parameters
- comparison: Comparison
  
  The comparison to be visited.
Returns string
A string representation of the comparison.
- Defined in docs/api_refs/langchain/src/retrievers/self_query/supabase.ts:204

visitOperation

visitOperation(operation): SupabaseFilterRPCCall
Visits an operation and returns a function that applies the operation on a Supabase database. This is used in translating a structured query into a format that can be understood by Supabase.
Parameters
- operation: Operation
  
  The operation to be visited.
Returns SupabaseFilterRPCCall
A function that applies the operation on a Supabase database.
Overrides BaseTranslator.visitOperation
- Defined in docs/api_refs/langchain/src/retrievers/self_query/supabase.ts:174

visitOperationAsString

visitOperationAsString(operation): string
Visits an operation and returns a string representation of it. This is used in translating a structured query into a format that can be understood by Supabase.
Parameters
- operation: Operation
  
  The operation to be visited.
Returns string
A string representation of the operation.
- Defined in docs/api_refs/langchain/src/retrievers/self_query/supabase.ts:147

visitStructuredQuery

visitStructuredQuery(query): {
filter?: T["FilterType"];
}
Visits a structured query and returns a function that applies the query on a Supabase database. This is used in translating a structured query into a format that can be understood by Supabase.
Parameters
- query: StructuredQuery
  
  The structured query to be visited.
Returns {
filter?: T["FilterType"];
}
A function that applies the query on a Supabase database.
- Optional filter?: T["FilterType"]
Overrides BaseTranslator.visitStructuredQuery
- Defined in docs/api_refs/langchain/src/retrievers/self_query/supabase.ts:252

Class SupabaseTranslator<T>

Example

Type Parameters

T extends SupabaseVectorStore

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

T extends SupabaseVectorStore

Returns SupabaseTranslator<T>

Properties

VisitComparisonOutput

VisitOperationOutput

VisitStructuredQueryOutput

Type declaration

Optional filter?: T["FilterType"]

allowedComparators

allowedOperators

Methods

buildColumnName

Parameters

attr: string

value: string | number

includeType: boolean = true

Returns string

formatFunction

Returns string

getComparatorFunction

Type Parameters

C extends Comparator

Parameters

comparator: Comparator

Returns ((attr, value) => SupabaseFilterRPCCall)

Parameters

attr: string

value: ValueType[C]

Returns SupabaseFilterRPCCall

mergeFilters

Parameters

defaultFilter: undefined | SupabaseFilterRPCCall | SupabaseMetadata

generatedFilter: undefined | SupabaseFilterRPCCall

mergeType: string = "and"

Returns undefined | SupabaseFilterRPCCall | SupabaseMetadata

visitComparison

Parameters

comparison: Comparison

Returns SupabaseFilterRPCCall

visitComparisonAsString

Parameters

comparison: Comparison

Returns string

visitOperation

Parameters

operation: Operation

Returns SupabaseFilterRPCCall

visitOperationAsString

Parameters

operation: Operation

Returns string

visitStructuredQuery

Parameters

query: StructuredQuery

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

Optional filter?: T["FilterType"]

Settings

Member Visibility

Theme

On This Page

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

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

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