/**
 * Milvus Vector Store Node - Version 1.2
 * Discriminator: mode=retrieve-as-tool
 */


interface Credentials {
  milvusApi: CredentialReference;
}

/** Retrieve documents from vector store to be used as tool with AI nodes */
export type LcVectorStoreMilvusV12RetrieveAsToolParams = {
  /**
   * Canonical RAG mode — declare with the `tool({...})` factory (NOT `vectorStore`) and plug into an AI Agent's `subnodes.tools`. Required subnodes: `embedding`. Set `toolDescription` so the agent knows when to call it.
   * <patterns>
   * <pattern title="retrieve-as-tool mode — RAG via AI Agent (generic, works for any vectorStore* node)">
   * // Substitute the type literal and provider-specific parameters — see the rest of this file
   * // for the exact shape (e.g. pineconeIndex, qdrantCollection, supabaseTableName).
   * const knowledgeBase = tool({
   *   type: '@n8n/n8n-nodes-langchain.vectorStoreXxx',
   *   config: {
   *     name: 'Knowledge Base',
   *     parameters: {
   *       mode: 'retrieve-as-tool',
   *       toolDescription: 'Search the product knowledge base',
   *       // ...provider-specific parameters
   *     },
   *     subnodes: { embedding: embeddingsOpenAi }
   *   }
   * });
   * 
   * const agent = node({
   *   type: '@n8n/n8n-nodes-langchain.agent',
   *   config: {
   *     name: 'Support Agent',
   *     parameters: { promptType: 'define', text: expr('{{ $json.question }}') },
   *     subnodes: { model: openAiModel, tools: [knowledgeBase] }
   *   }
   * });
   * </pattern>
   * </patterns>
   */
  mode: 'retrieve-as-tool';
/**
 * Name of the vector store
 */
    toolName: string | Expression<string>;
/**
 * Explain to the LLM what this tool does, a good, specific description would allow LLMs to produce expected results much more often
 */
    toolDescription: string | Expression<string>;
  milvusCollection?: { __rl: true; mode: 'list' | 'id'; value: string; cachedResultName?: string };
/**
 * Number of top results to fetch from vector store
 * @default 4
 */
    topK?: number | Expression<number>;
/**
 * Whether or not to include document metadata
 * @default true
 */
    includeDocumentMetadata?: boolean | Expression<boolean>;
/**
 * Whether or not to rerank results
 * @default false
 */
    useReranker?: boolean | Expression<boolean>;
};

export interface LcVectorStoreMilvusV12RetrieveAsToolSubnodeConfig {
  embedding: EmbeddingInstance | EmbeddingInstance[];
  /**
   * @displayOptions.show { useReranker: [true] }
   */
  reranker: RerankerInstance;
}

export type LcVectorStoreMilvusV12RetrieveAsToolNode = {
  type: '@n8n/n8n-nodes-langchain.vectorStoreMilvus';
  version: 1.2;
  credentials?: Credentials;
  config: NodeConfig<LcVectorStoreMilvusV12RetrieveAsToolParams> & { subnodes: LcVectorStoreMilvusV12RetrieveAsToolSubnodeConfig };
};