@n8n/n8n-nodes-langchain
Version:
52 lines (51 loc) • 2.51 kB
TypeScript
import { Document } from '@langchain/core/documents';
import type { EmbeddingsInterface } from '@langchain/core/embeddings';
import { VectorStore } from '@langchain/core/vectorstores';
import type { IExecuteFunctions, IHttpRequestOptions, ISupplyDataFunctions, WithRequestTarget } from 'n8n-workflow';
type ScoreBy = {
type: 'dense_vector' | 'embed';
field: string;
};
type SchemaField = Record<string, unknown>;
export interface PineconeIndexModel {
name: string;
host: string;
ready: boolean;
fields: Record<string, SchemaField>;
}
type PineconeRequest = (options: WithRequestTarget<IHttpRequestOptions>) => Promise<unknown>;
export interface PineconeConnection {
context: IExecuteFunctions | ISupplyDataFunctions;
credentialType: string;
apiKey: string;
}
export interface PineconeVectorStoreArgs {
indexName: string;
namespace?: string;
filter?: object;
textField?: string;
}
export declare function parseIndexModel(raw: unknown): PineconeIndexModel;
export declare function classifyIndexShape(model: PineconeIndexModel): 'vectors-api' | 'documents-api' | 'indeterminate';
export declare function assertPineconeIndexAcceptsVectors(connection: PineconeConnection, indexName: string): Promise<void>;
export declare function getDocumentIndexScoring(model: PineconeIndexModel): ScoreBy | undefined;
export declare class PineconeDocumentStore extends VectorStore {
private readonly request;
private readonly scoreBy;
private readonly filter?;
private readonly textField?;
FilterType: object;
private readonly vectorFields;
private readonly searchUrl;
constructor(embeddings: EmbeddingsInterface, request: PineconeRequest, scoreBy: ScoreBy, model: PineconeIndexModel, namespace?: string, filter?: object | undefined, textField?: string | undefined);
_vectorstoreType(): string;
addVectors(): Promise<void>;
addDocuments(): Promise<void>;
similaritySearch(query: string, k?: number, filter?: object): Promise<Document[]>;
similaritySearchWithScore(query: string, k?: number, filter?: object): Promise<Array<[Document, number]>>;
similaritySearchVectorWithScore(values: number[], k: number, filter?: object): Promise<Array<[Document, number]>>;
private search;
private toDocument;
}
export declare function getPineconeVectorStore(connection: PineconeConnection, embeddings: EmbeddingsInterface, { indexName, namespace, filter, textField }: PineconeVectorStoreArgs): Promise<VectorStore>;
export {};