Class PineconeTranslator<T>

Specialized translator class that extends the BasicTranslator. It is designed to work with PineconeStore, a type of vector store in LangChain. The class is initialized with a set of allowed operators and comparators, which are used in the translation process to construct queries and compare results.

Example

const selfQueryRetriever = await SelfQueryRetriever.fromLLM({
  llm: new ChatOpenAI(),
  vectorStore: new PineconeStore(),
  documentContents: "Brief summary of a movie",
  attributeInfo: [],
  structuredQueryTranslator: new PineconeTranslator(),
});

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

Type Parameters

T extends PineconeStore

Hierarchy

BasicTranslator<T>
- PineconeTranslator

Index

Constructors

constructor

new PineconeTranslator<T>(): PineconeTranslator<T>
Type Parameters
- T extends PineconeStore
Returns PineconeTranslator<T>
Overrides BasicTranslator.constructor
- Defined in docs/api_refs/langchain/src/retrievers/self_query/pinecone.ts:29

Properties

VisitComparisonOutput

VisitComparisonOutput: VisitorComparisonResult

VisitOperationOutput

VisitOperationOutput: VisitorOperationResult

VisitStructuredQueryOutput

VisitStructuredQueryOutput: VisitorStructuredQueryResult

allowedComparators

allowedComparators: Comparator[]

allowedOperators

allowedOperators: Operator[]

Methods

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.
Inherited from BasicTranslator.formatFunction
- Defined in docs/api_refs/langchain/src/retrievers/self_query/base.ts:96

mergeFilters

mergeFilters(defaultFilter, generatedFilter, mergeType?, forceDefaultFilter?): undefined | VisitorOperationResult | VisitorComparisonResult
Merges two filters into one, using a specified merge type.
Parameters
- defaultFilter: undefined | VisitorOperationResult | VisitorComparisonResult
  
  The default filter.
- generatedFilter: undefined | VisitorOperationResult | VisitorComparisonResult
  
  The generated filter.
- mergeType: string = "and"
  
  The type of merge to perform. Can be 'and', 'or', or 'replace'.
- forceDefaultFilter: boolean = false
  
  If true, the default filter will be used even if the generated filter is not empty.
Returns undefined | VisitorOperationResult | VisitorComparisonResult
The merged filter, or undefined if both filters are empty.
Inherited from BasicTranslator.mergeFilters
- Defined in docs/api_refs/langchain/src/retrievers/self_query/base.ts:171

visitComparison

visitComparison(comparison): VisitorComparisonResult
Visits a comparison and returns a result.
Parameters
- comparison: Comparison
  
  The comparison to visit.
Returns VisitorComparisonResult
The result of visiting the comparison.
Inherited from BasicTranslator.visitComparison
- Defined in docs/api_refs/langchain/src/retrievers/self_query/base.ts:144

visitOperation

visitOperation(operation): VisitorOperationResult
Visits an operation and returns a result.
Parameters
- operation: Operation
  
  The operation to visit.
Returns VisitorOperationResult
The result of visiting the operation.
Inherited from BasicTranslator.visitOperation
- Defined in docs/api_refs/langchain/src/retrievers/self_query/base.ts:130

visitStructuredQuery

visitStructuredQuery(query): VisitorStructuredQueryResult
Visits a structured query and returns a result.
Parameters
- query: StructuredQuery
  
  The structured query to visit.
Returns VisitorStructuredQueryResult
The result of visiting the structured query.
Inherited from BasicTranslator.visitStructuredQuery
- Defined in docs/api_refs/langchain/src/retrievers/self_query/base.ts:159

Class PineconeTranslator<T>

Example

Type Parameters

T extends PineconeStore

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

T extends PineconeStore

Returns PineconeTranslator<T>

Properties

VisitComparisonOutput

VisitOperationOutput

VisitStructuredQueryOutput

allowedComparators

allowedOperators

Methods

formatFunction

Parameters

func: Operator | Comparator

Returns string

mergeFilters

Parameters

defaultFilter: undefined | VisitorOperationResult | VisitorComparisonResult

generatedFilter: undefined | VisitorOperationResult | VisitorComparisonResult

mergeType: string = "and"

forceDefaultFilter: boolean = false

Returns undefined | VisitorOperationResult | VisitorComparisonResult

visitComparison

Parameters

comparison: Comparison

Returns VisitorComparisonResult

visitOperation

Parameters

operation: Operation

Returns VisitorOperationResult

visitStructuredQuery

Parameters

query: StructuredQuery

Returns VisitorStructuredQueryResult

Settings

Member Visibility

Theme

On This Page