@n8n/n8n-nodes-langchain

Version:
63 lines (58 loc) • 2.25 kB
text/typescript
/**
 * Chroma Vector Store Node - Version 1.1
 * Discriminator: mode=insert
 */


interface Credentials {
  chromaSelfHostedApi: CredentialReference;
  chromaCloudApi: CredentialReference;
}

/** Insert documents into vector store */
export type LcVectorStoreChromaDBV11InsertParams = {
  /**
   * Sits on the main flow — pipe the documents you want to embed into this node. Declare with `vectorStore({...})`. Required subnodes: `embedding` and `documentLoader`. If the goal is letting an LLM query the store, use `mode: 'retrieve-as-tool'` instead.
   * <patterns>
   * <pattern title="insert mode — upsert documents (generic, works for any vectorStore* node)">
   * // Substitute the type literal and provider-specific parameters (e.g. pineconeIndex,
   * // qdrantCollection, supabaseTableName) — see the rest of this file for the exact shape.
   * const store = vectorStore({
   *   type: '@n8n/n8n-nodes-langchain.vectorStoreXxx',
   *   config: {
   *     name: 'Knowledge Base',
   *     parameters: {
   *       mode: 'insert',
   *       // ...provider-specific parameters
   *     },
   *     subnodes: { embedding: embeddingsOpenAi, documentLoader: defaultDataLoader }
   *   }
   * });
   * </pattern>
   * </patterns>
   */
  mode: 'insert';
  authentication?: 'chromaSelfHostedApi' | 'chromaCloudApi' | Expression<string>;
  chromaCollection?: { __rl: true; mode: 'list' | 'id'; value: string; cachedResultName?: string };
/**
 * Number of documents to embed in a single batch
 * @default 200
 */
    embeddingBatchSize?: number | Expression<number>;
/**
 * Options
 * @default {}
 */
    options?: {
    /** Whether to clear the collection before inserting new data
     * @default false
     */
    clearCollection?: boolean | Expression<boolean>;
  };
};

export interface LcVectorStoreChromaDBV11InsertSubnodeConfig {
  embedding: EmbeddingInstance | EmbeddingInstance[];
  documentLoader: DocumentLoaderInstance | DocumentLoaderInstance[];
}

export type LcVectorStoreChromaDBV11InsertNode = {
  type: '@n8n/n8n-nodes-langchain.vectorStoreChromaDB';
  version: 1.1;
  config: NodeConfig<LcVectorStoreChromaDBV11InsertParams> & { credentials?: Credentials } & { subnodes: LcVectorStoreChromaDBV11InsertSubnodeConfig };
};