Struct VectorStoreBuilder 

pub struct VectorStoreBuilder { /* private fields */ }

Builder for creating a new vector store.

Vector stores are collections of files that can be searched through using semantic similarity. They’re commonly used for RAG applications.

Implementations

impl VectorStoreBuilder

pub fn new() -> Self

Create a new vector store builder.

Examples

use openai_ergonomic::builders::vector_stores::VectorStoreBuilder;

let builder = VectorStoreBuilder::new()
    .name("My Knowledge Base")
    .file_ids(vec!["file-123".to_string(), "file-456".to_string()]);

Examples found in repository

examples/vector_stores.rs (line 468)

fn run_advanced_search_patterns_example() -> Result<(), Error> {
    println!("\n Example 6: Advanced Search Patterns and Optimization");
    println!("{}", "=".repeat(60));

    // Create optimized search store
    let optimized_store = VectorStoreBuilder::new()
        .name("Advanced Search Optimization Store")
        .add_file("file-technical-docs-001")
        .add_file("file-user-feedback-002")
        .add_file("file-performance-data-003")
        .add_file("file-best-practices-004")
        .metadata("search_optimized", "true")
        .metadata("indexing", "enhanced")
        .metadata("caching", "enabled");

    println!(" Created advanced search store:");
    println!("   Optimization: Enhanced indexing");
    println!("   Caching: Enabled");
    println!("   Files: {} documents", optimized_store.file_count());

    // Demonstrate advanced search patterns
    println!("\n Advanced Search Patterns:");

    // Multi-stage search
    println!("   1.  Multi-stage Search:");
    println!("      Stage 1: Broad semantic search (100 results)");
    println!("      Stage 2: Filtered refinement (20 results)");
    println!("      Stage 3: Relevance re-ranking (5 top results)");

    let multi_stage_search =
        VectorStoreSearchBuilder::new("advanced-store-789", "machine learning best practices")
            .limit(100)
            .filter("category", "best_practices")
            .filter("verified", "true");

    println!("      Query: '{}'", multi_stage_search.query());
    println!(
        "      Initial limit: {}",
        multi_stage_search.limit_ref().unwrap()
    );

    // Contextual search
    println!("   2.  Contextual Search:");
    println!("      Context: User role, project phase, domain expertise");
    println!("      Adaptation: Results tailored to user context");

    let _contextual_search =
        search_vector_store_with_limit("advanced-store-789", "deployment strategies", 15)
            .filter("audience", "senior_engineer")
            .filter("complexity", "advanced")
            .filter("domain", "cloud_infrastructure");

    println!("      Audience: senior_engineer");
    println!("      Complexity: advanced");
    println!("      Domain: cloud_infrastructure");

    // Hybrid search approaches
    println!("   3.  Hybrid Search Approaches:");
    println!("      Semantic similarity + keyword matching");
    println!("      Vector search + traditional full-text search");
    println!("      AI-enhanced query understanding");

    // Search performance optimization
    println!("\n Search Performance Optimization:");
    println!("    Query optimization and caching");
    println!("    Result pre-computation for common queries");
    println!("    Incremental index updates");
    println!("    Load balancing across vector stores");
    println!("    Machine learning-based relevance tuning");

    // Quality metrics and monitoring
    println!("\n Search Quality Metrics:");
    println!("    Relevance scores and user feedback");
    println!("   ⏱ Query response time analysis");
    println!("    Search success rate tracking");
    println!("    Usage pattern analysis");
    println!("    Continuous improvement recommendations");

    Ok(())
}

/// Helper function to create enterprise knowledge base structure
fn create_enterprise_knowledge_base() -> Result<Vec<(String, VectorStoreBuilder)>, Error> {
    let departments = vec![
        ("Engineering".to_string(), create_engineering_store()),
        ("Legal".to_string(), create_legal_store()),
        ("HR".to_string(), create_hr_store()),
        ("Marketing".to_string(), create_marketing_store()),
        ("Finance".to_string(), create_finance_store()),
        ("Operations".to_string(), create_operations_store()),
    ];

    Ok(departments)
}

fn create_engineering_store() -> VectorStoreBuilder {
    VectorStoreBuilder::new()
        .name("Engineering Knowledge Base")
        .add_file("file-architecture-docs-001")
        .add_file("file-coding-standards-002")
        .add_file("file-deployment-guides-003")
        .add_file("file-api-documentation-004")
        .metadata("department", "engineering")
        .metadata("access_level", "engineering_team")
        .metadata("update_frequency", "weekly")
        .expires_after_days(365)
}

fn create_legal_store() -> VectorStoreBuilder {
    VectorStoreBuilder::new()
        .name("Legal Documentation Store")
        .add_file("file-contracts-templates-001")
        .add_file("file-compliance-guides-002")
        .add_file("file-policy-documents-003")
        .metadata("department", "legal")
        .metadata("access_level", "legal_team")
        .metadata("confidentiality", "high")
        .expires_after_days(2555) // 7 years for legal retention
}

fn create_hr_store() -> VectorStoreBuilder {
    VectorStoreBuilder::new()
        .name("Human Resources Knowledge Base")
        .add_file("file-employee-handbook-001")
        .add_file("file-benefits-guide-002")
        .add_file("file-performance-templates-003")
        .metadata("department", "hr")
        .metadata("access_level", "hr_managers")
        .metadata("privacy", "employee_data")
        .expires_after_days(1095) // 3 years
}

fn create_marketing_store() -> VectorStoreBuilder {
    VectorStoreBuilder::new()
        .name("Marketing Materials Store")
        .add_file("file-brand-guidelines-001")
        .add_file("file-campaign-templates-002")
        .add_file("file-market-research-003")
        .metadata("department", "marketing")
        .metadata("access_level", "marketing_team")
        .metadata("content_type", "creative_assets")
        .expires_after_days(365)
}

fn create_finance_store() -> VectorStoreBuilder {
    VectorStoreBuilder::new()
        .name("Finance Documentation Store")
        .add_file("file-budget-templates-001")
        .add_file("file-financial-policies-002")
        .add_file("file-audit-procedures-003")
        .metadata("department", "finance")
        .metadata("access_level", "finance_team")
        .metadata("compliance", "required")
        .expires_after_days(2555) // 7 years for financial records
}

fn create_operations_store() -> VectorStoreBuilder {
    VectorStoreBuilder::new()
        .name("Operations Procedures Store")
        .add_file("file-standard-procedures-001")
        .add_file("file-incident-response-002")
        .add_file("file-vendor-management-003")
        .metadata("department", "operations")
        .metadata("access_level", "operations_team")
        .metadata("criticality", "high")
        .expires_after_days(730) // 2 years
}

examples/assistants_file_search.rs (line 222)

fn run_research_assistant_example() -> Result<(), Error> {
    println!("\n Example 3: Research Assistant with Advanced RAG");
    println!("{}", "=".repeat(60));

    // Create research-focused assistant
    let _research_assistant = assistant_with_instructions(
        "gpt-4-1106-preview",
        "Research Assistant",
        "You are a research assistant specializing in literature review and analysis. Help researchers find relevant information, identify patterns across documents, synthesize findings, and suggest research directions. Always provide comprehensive citations and acknowledge research limitations."
    )
    .add_tool(tool_file_search());

    println!(" Created research assistant:");
    println!("   Focus: Literature review and cross-document analysis");

    // Create a comprehensive research vector store
    let _research_store = VectorStoreBuilder::new()
        .name("Research Literature Database")
        .add_file("file-paper-ai-ethics-001")
        .add_file("file-paper-ml-bias-002")
        .add_file("file-paper-fairness-003")
        .add_file("file-survey-responsible-ai-004")
        .add_file("file-whitepaper-governance-005")
        .metadata("domain", "AI Ethics")
        .metadata("papers_count", "50")
        .metadata("date_range", "2020-2024");

    println!("\n Research Literature Database:");
    println!("   Domain: AI Ethics and Responsible AI");
    println!("   Papers: 5 documents loaded (representing 50 papers)");
    println!("   Date range: 2020-2024");

    println!("\n Research Query:");
    println!(
        "   'What are the current approaches to addressing algorithmic bias in machine learning?'"
    );
    println!("   'Please provide a comprehensive overview with citations.'");

    println!("\n Advanced RAG Research Workflow:");
    println!("   1.  Query analysis and decomposition");
    println!("   2.  Multi-faceted search across all documents");
    println!("   3.  Semantic clustering of results");
    println!("   4.  Cross-reference analysis between papers");
    println!("   5.  Identify trends and patterns");
    println!("   6.  Synthesize comprehensive overview");
    println!("   7.  Provide detailed citations and references");

    // Demonstrate search refinement
    let refined_search =
        search_vector_store_with_limit("research-db-123", "algorithmic bias mitigation", 20)
            .filter("category", "methodology")
            .filter("confidence", "high");

    println!("\n Search Refinement:");
    println!("   Query: algorithmic bias mitigation");
    println!("   Limit: {} results", refined_search.limit_ref().unwrap());
    println!("   Filters: category=methodology, confidence=high");

    println!("\n Expected Research Response:");
    println!("    Executive Summary:");
    println!("      • Overview of current bias mitigation approaches");
    println!("      • Key methodological categories identified");
    println!("      • Emerging trends and best practices");
    println!("   ");
    println!("    Detailed Analysis:");
    println!("      • Pre-processing techniques (data augmentation, sampling)");
    println!("      • In-processing methods (fairness constraints, adversarial training)");
    println!("      • Post-processing approaches (threshold optimization, calibration)");
    println!("   ");
    println!("    Comprehensive Citations:");
    println!("      • [Smith et al., 2023] - Fairness constraints in ML training");
    println!("      • [Johnson & Lee, 2024] - Bias detection in neural networks");
    println!("      • [Research Survey, 2024] - Comprehensive bias mitigation review");
    println!("   ");
    println!("    Future Research Directions:");
    println!("      • Intersectional bias analysis");
    println!("      • Real-time bias monitoring");
    println!("      • Domain-specific mitigation strategies");

    Ok(())
}

/// Example 4: Citation and Source Attribution
fn run_citation_example() -> Result<(), Error> {
    println!("\n Example 4: Citation and Source Attribution");
    println!("{}", "=".repeat(60));

    // Create citation-focused assistant
    let _citation_assistant = AssistantBuilder::new("gpt-4-1106-preview")
        .name("Citation Specialist")
        .description("Provides detailed source attribution and citation management")
        .instructions(
            "You are a citation specialist. Always provide accurate, detailed citations for any information retrieved from documents. Use proper academic citation formats, include page numbers when available, and distinguish between direct quotes and paraphrased content."
        )
        .add_tool(tool_file_search());

    println!(" Created citation specialist assistant:");
    println!("   Focus: Accurate source attribution and citation formatting");

    // Create thread for citation-heavy work
    let _citation_thread = simple_thread()
        .metadata("citation_style", "APA")
        .metadata("requirement", "academic_standards")
        .metadata("verification", "enabled");

    println!("\n Citation Requirements:");
    println!("   Style: APA format");
    println!("   Standards: Academic-level accuracy");
    println!("   Verification: Enabled for all sources");

    println!("\n Citation Query:");
    println!("   'Provide a summary of the key arguments about privacy in AI systems,'");
    println!("   'with detailed citations for each point made.'");

    println!("\n Citation-Focused RAG Workflow:");
    println!("   1.  Search for relevant content across documents");
    println!("   2.  Extract content with precise location data");
    println!("   3.  Generate response with inline citations");
    println!("   4.  Verify citation accuracy and completeness");
    println!("   5.  Format citations according to specified style");
    println!("   6.  Cross-check for citation consistency");

    // Demonstrate different citation formats
    println!("\n Citation Format Examples:");
    println!("    Direct Quote:");
    println!(
        "      \"Privacy-preserving AI requires careful balance between utility and protection\""
    );
    println!("      (Johnson, 2024, p. 15)");
    println!("   ");
    println!("    Paraphrased Content:");
    println!("      Recent research indicates that differential privacy methods show promise");
    println!("      for protecting individual data in ML training (Smith & Lee, 2023).");
    println!("   ");
    println!("    Multiple Source Synthesis:");
    println!("      Several studies have demonstrated the effectiveness of federated learning");
    println!("      approaches (Chen et al., 2023; Rodriguez, 2024; Brown & Wilson, 2023).");

    println!("\n Expected Citation Response:");
    println!("    Structured Summary with Citations:");
    println!("      • Privacy challenges in AI systems (Anderson, 2024, pp. 23-25)");
    println!("      • Technical solutions: differential privacy (Johnson et al., 2023)");
    println!("      • Regulatory considerations (Privacy Commission Report, 2024, §3.2)");
    println!("   ");
    println!("    Reference List:");
    println!(
        "      Anderson, M. (2024). AI Privacy Challenges. Tech Ethics Journal, 15(3), 20-30."
    );
    println!("      Johnson, P., Smith, R., & Lee, K. (2023). Differential privacy in practice.");
    println!("      Privacy Commission. (2024). AI governance guidelines (Report #2024-AI-001).");

    Ok(())
}

/// Example 5: Multi-Document Analysis and Synthesis
fn run_multi_document_analysis_example() -> Result<(), Error> {
    println!("\n Example 5: Multi-Document Analysis and Synthesis");
    println!("{}", "=".repeat(60));

    // Create multi-document analysis assistant
    let _analysis_assistant = assistant_with_instructions(
        "gpt-4-1106-preview",
        "Document Analysis Specialist",
        "You are a document analysis expert. Compare and contrast information across multiple documents, identify contradictions or gaps, synthesize information from diverse sources, and provide comprehensive analysis that considers multiple perspectives."
    )
    .add_tool(tool_file_search());

    println!(" Created document analysis assistant:");
    println!("   Specialty: Cross-document comparison and synthesis");

    // Create comprehensive document store for analysis
    let _analysis_store = VectorStoreBuilder::new()
        .name("Multi-Document Analysis Store")
        .add_file("file-policy-proposal-v1")
        .add_file("file-policy-proposal-v2")
        .add_file("file-stakeholder-feedback-001")
        .add_file("file-legal-review-002")
        .add_file("file-technical-assessment-003")
        .add_file("file-cost-benefit-analysis-004")
        .metadata("analysis_type", "policy_comparison")
        .metadata("documents", "6")
        .metadata("perspectives", "multiple");

    println!("\n Multi-Document Analysis Setup:");
    println!("   Documents: 6 files representing different perspectives");
    println!("   Analysis type: Policy proposal comparison");
    println!("   Perspectives: Technical, legal, financial, stakeholder");

    println!("\n Multi-Document Analysis Query:");
    println!("   'Compare the two policy proposals and analyze how stakeholder feedback'");
    println!("   'has been incorporated. Identify any conflicts between the legal review'");
    println!("   'and technical assessment.'");

    println!("\n Multi-Document RAG Analysis Workflow:");
    println!("   1.  Identify key comparison dimensions");
    println!("   2.  Search each document type systematically");
    println!("   3.  Create comparison matrix across documents");
    println!("   4.  Identify conflicts and contradictions");
    println!("   5.  Find connections and dependencies");
    println!("   6.  Synthesize comprehensive analysis");
    println!("   7.  Provide recommendations based on synthesis");

    // Demonstrate advanced search patterns
    let _comparative_search =
        search_vector_store_with_limit("analysis-store-456", "risk assessment comparison", 15)
            .filter("document_type", "technical,legal")
            .filter("section", "risks");

    println!("\n Advanced Search Pattern:");
    println!("   Query: risk assessment comparison");
    println!("   Target documents: technical + legal reviews");
    println!("   Focus section: risk analysis sections");

    println!("\n Expected Multi-Document Analysis:");
    println!("    Comparative Analysis:");
    println!("      Policy Proposal Comparison:");
    println!("      • V1 focuses on immediate implementation (Technical Assessment)");
    println!("      • V2 incorporates phased approach (Stakeholder Feedback)");
    println!("   ");
    println!("    Identified Conflicts:");
    println!("      • Legal review flags compliance issues with V1 approach");
    println!("      • Technical assessment questions feasibility of V2 timeline");
    println!("      • Cost analysis shows budget misalignment between proposals");
    println!("   ");
    println!("    Stakeholder Integration:");
    println!("      • 73% of feedback incorporated in V2 (Stakeholder Feedback doc)");
    println!("      • Privacy concerns addressed through technical modifications");
    println!("      • Cost concerns partially resolved via phased implementation");
    println!("   ");
    println!("    Synthesis Recommendations:");
    println!("      • Hybrid approach combining V1 technical framework with V2 timeline");
    println!("      • Address legal compliance through additional technical review");
    println!("      • Require budget revision to align with stakeholder expectations");

    Ok(())
}

pub fn name(self, name: impl Into<String>) -> Self

Set the vector store’s name.

Examples found in repository

examples/vector_stores.rs (line 469)

fn run_advanced_search_patterns_example() -> Result<(), Error> {
    println!("\n Example 6: Advanced Search Patterns and Optimization");
    println!("{}", "=".repeat(60));

    // Create optimized search store
    let optimized_store = VectorStoreBuilder::new()
        .name("Advanced Search Optimization Store")
        .add_file("file-technical-docs-001")
        .add_file("file-user-feedback-002")
        .add_file("file-performance-data-003")
        .add_file("file-best-practices-004")
        .metadata("search_optimized", "true")
        .metadata("indexing", "enhanced")
        .metadata("caching", "enabled");

    println!(" Created advanced search store:");
    println!("   Optimization: Enhanced indexing");
    println!("   Caching: Enabled");
    println!("   Files: {} documents", optimized_store.file_count());

    // Demonstrate advanced search patterns
    println!("\n Advanced Search Patterns:");

    // Multi-stage search
    println!("   1.  Multi-stage Search:");
    println!("      Stage 1: Broad semantic search (100 results)");
    println!("      Stage 2: Filtered refinement (20 results)");
    println!("      Stage 3: Relevance re-ranking (5 top results)");

    let multi_stage_search =
        VectorStoreSearchBuilder::new("advanced-store-789", "machine learning best practices")
            .limit(100)
            .filter("category", "best_practices")
            .filter("verified", "true");

    println!("      Query: '{}'", multi_stage_search.query());
    println!(
        "      Initial limit: {}",
        multi_stage_search.limit_ref().unwrap()
    );

    // Contextual search
    println!("   2.  Contextual Search:");
    println!("      Context: User role, project phase, domain expertise");
    println!("      Adaptation: Results tailored to user context");

    let _contextual_search =
        search_vector_store_with_limit("advanced-store-789", "deployment strategies", 15)
            .filter("audience", "senior_engineer")
            .filter("complexity", "advanced")
            .filter("domain", "cloud_infrastructure");

    println!("      Audience: senior_engineer");
    println!("      Complexity: advanced");
    println!("      Domain: cloud_infrastructure");

    // Hybrid search approaches
    println!("   3.  Hybrid Search Approaches:");
    println!("      Semantic similarity + keyword matching");
    println!("      Vector search + traditional full-text search");
    println!("      AI-enhanced query understanding");

    // Search performance optimization
    println!("\n Search Performance Optimization:");
    println!("    Query optimization and caching");
    println!("    Result pre-computation for common queries");
    println!("    Incremental index updates");
    println!("    Load balancing across vector stores");
    println!("    Machine learning-based relevance tuning");

    // Quality metrics and monitoring
    println!("\n Search Quality Metrics:");
    println!("    Relevance scores and user feedback");
    println!("   ⏱ Query response time analysis");
    println!("    Search success rate tracking");
    println!("    Usage pattern analysis");
    println!("    Continuous improvement recommendations");

    Ok(())
}

/// Helper function to create enterprise knowledge base structure
fn create_enterprise_knowledge_base() -> Result<Vec<(String, VectorStoreBuilder)>, Error> {
    let departments = vec![
        ("Engineering".to_string(), create_engineering_store()),
        ("Legal".to_string(), create_legal_store()),
        ("HR".to_string(), create_hr_store()),
        ("Marketing".to_string(), create_marketing_store()),
        ("Finance".to_string(), create_finance_store()),
        ("Operations".to_string(), create_operations_store()),
    ];

    Ok(departments)
}

fn create_engineering_store() -> VectorStoreBuilder {
    VectorStoreBuilder::new()
        .name("Engineering Knowledge Base")
        .add_file("file-architecture-docs-001")
        .add_file("file-coding-standards-002")
        .add_file("file-deployment-guides-003")
        .add_file("file-api-documentation-004")
        .metadata("department", "engineering")
        .metadata("access_level", "engineering_team")
        .metadata("update_frequency", "weekly")
        .expires_after_days(365)
}

fn create_legal_store() -> VectorStoreBuilder {
    VectorStoreBuilder::new()
        .name("Legal Documentation Store")
        .add_file("file-contracts-templates-001")
        .add_file("file-compliance-guides-002")
        .add_file("file-policy-documents-003")
        .metadata("department", "legal")
        .metadata("access_level", "legal_team")
        .metadata("confidentiality", "high")
        .expires_after_days(2555) // 7 years for legal retention
}

fn create_hr_store() -> VectorStoreBuilder {
    VectorStoreBuilder::new()
        .name("Human Resources Knowledge Base")
        .add_file("file-employee-handbook-001")
        .add_file("file-benefits-guide-002")
        .add_file("file-performance-templates-003")
        .metadata("department", "hr")
        .metadata("access_level", "hr_managers")
        .metadata("privacy", "employee_data")
        .expires_after_days(1095) // 3 years
}

fn create_marketing_store() -> VectorStoreBuilder {
    VectorStoreBuilder::new()
        .name("Marketing Materials Store")
        .add_file("file-brand-guidelines-001")
        .add_file("file-campaign-templates-002")
        .add_file("file-market-research-003")
        .metadata("department", "marketing")
        .metadata("access_level", "marketing_team")
        .metadata("content_type", "creative_assets")
        .expires_after_days(365)
}

fn create_finance_store() -> VectorStoreBuilder {
    VectorStoreBuilder::new()
        .name("Finance Documentation Store")
        .add_file("file-budget-templates-001")
        .add_file("file-financial-policies-002")
        .add_file("file-audit-procedures-003")
        .metadata("department", "finance")
        .metadata("access_level", "finance_team")
        .metadata("compliance", "required")
        .expires_after_days(2555) // 7 years for financial records
}

fn create_operations_store() -> VectorStoreBuilder {
    VectorStoreBuilder::new()
        .name("Operations Procedures Store")
        .add_file("file-standard-procedures-001")
        .add_file("file-incident-response-002")
        .add_file("file-vendor-management-003")
        .metadata("department", "operations")
        .metadata("access_level", "operations_team")
        .metadata("criticality", "high")
        .expires_after_days(730) // 2 years
}

examples/assistants_file_search.rs (line 223)

fn run_research_assistant_example() -> Result<(), Error> {
    println!("\n Example 3: Research Assistant with Advanced RAG");
    println!("{}", "=".repeat(60));

    // Create research-focused assistant
    let _research_assistant = assistant_with_instructions(
        "gpt-4-1106-preview",
        "Research Assistant",
        "You are a research assistant specializing in literature review and analysis. Help researchers find relevant information, identify patterns across documents, synthesize findings, and suggest research directions. Always provide comprehensive citations and acknowledge research limitations."
    )
    .add_tool(tool_file_search());

    println!(" Created research assistant:");
    println!("   Focus: Literature review and cross-document analysis");

    // Create a comprehensive research vector store
    let _research_store = VectorStoreBuilder::new()
        .name("Research Literature Database")
        .add_file("file-paper-ai-ethics-001")
        .add_file("file-paper-ml-bias-002")
        .add_file("file-paper-fairness-003")
        .add_file("file-survey-responsible-ai-004")
        .add_file("file-whitepaper-governance-005")
        .metadata("domain", "AI Ethics")
        .metadata("papers_count", "50")
        .metadata("date_range", "2020-2024");

    println!("\n Research Literature Database:");
    println!("   Domain: AI Ethics and Responsible AI");
    println!("   Papers: 5 documents loaded (representing 50 papers)");
    println!("   Date range: 2020-2024");

    println!("\n Research Query:");
    println!(
        "   'What are the current approaches to addressing algorithmic bias in machine learning?'"
    );
    println!("   'Please provide a comprehensive overview with citations.'");

    println!("\n Advanced RAG Research Workflow:");
    println!("   1.  Query analysis and decomposition");
    println!("   2.  Multi-faceted search across all documents");
    println!("   3.  Semantic clustering of results");
    println!("   4.  Cross-reference analysis between papers");
    println!("   5.  Identify trends and patterns");
    println!("   6.  Synthesize comprehensive overview");
    println!("   7.  Provide detailed citations and references");

    // Demonstrate search refinement
    let refined_search =
        search_vector_store_with_limit("research-db-123", "algorithmic bias mitigation", 20)
            .filter("category", "methodology")
            .filter("confidence", "high");

    println!("\n Search Refinement:");
    println!("   Query: algorithmic bias mitigation");
    println!("   Limit: {} results", refined_search.limit_ref().unwrap());
    println!("   Filters: category=methodology, confidence=high");

    println!("\n Expected Research Response:");
    println!("    Executive Summary:");
    println!("      • Overview of current bias mitigation approaches");
    println!("      • Key methodological categories identified");
    println!("      • Emerging trends and best practices");
    println!("   ");
    println!("    Detailed Analysis:");
    println!("      • Pre-processing techniques (data augmentation, sampling)");
    println!("      • In-processing methods (fairness constraints, adversarial training)");
    println!("      • Post-processing approaches (threshold optimization, calibration)");
    println!("   ");
    println!("    Comprehensive Citations:");
    println!("      • [Smith et al., 2023] - Fairness constraints in ML training");
    println!("      • [Johnson & Lee, 2024] - Bias detection in neural networks");
    println!("      • [Research Survey, 2024] - Comprehensive bias mitigation review");
    println!("   ");
    println!("    Future Research Directions:");
    println!("      • Intersectional bias analysis");
    println!("      • Real-time bias monitoring");
    println!("      • Domain-specific mitigation strategies");

    Ok(())
}

/// Example 4: Citation and Source Attribution
fn run_citation_example() -> Result<(), Error> {
    println!("\n Example 4: Citation and Source Attribution");
    println!("{}", "=".repeat(60));

    // Create citation-focused assistant
    let _citation_assistant = AssistantBuilder::new("gpt-4-1106-preview")
        .name("Citation Specialist")
        .description("Provides detailed source attribution and citation management")
        .instructions(
            "You are a citation specialist. Always provide accurate, detailed citations for any information retrieved from documents. Use proper academic citation formats, include page numbers when available, and distinguish between direct quotes and paraphrased content."
        )
        .add_tool(tool_file_search());

    println!(" Created citation specialist assistant:");
    println!("   Focus: Accurate source attribution and citation formatting");

    // Create thread for citation-heavy work
    let _citation_thread = simple_thread()
        .metadata("citation_style", "APA")
        .metadata("requirement", "academic_standards")
        .metadata("verification", "enabled");

    println!("\n Citation Requirements:");
    println!("   Style: APA format");
    println!("   Standards: Academic-level accuracy");
    println!("   Verification: Enabled for all sources");

    println!("\n Citation Query:");
    println!("   'Provide a summary of the key arguments about privacy in AI systems,'");
    println!("   'with detailed citations for each point made.'");

    println!("\n Citation-Focused RAG Workflow:");
    println!("   1.  Search for relevant content across documents");
    println!("   2.  Extract content with precise location data");
    println!("   3.  Generate response with inline citations");
    println!("   4.  Verify citation accuracy and completeness");
    println!("   5.  Format citations according to specified style");
    println!("   6.  Cross-check for citation consistency");

    // Demonstrate different citation formats
    println!("\n Citation Format Examples:");
    println!("    Direct Quote:");
    println!(
        "      \"Privacy-preserving AI requires careful balance between utility and protection\""
    );
    println!("      (Johnson, 2024, p. 15)");
    println!("   ");
    println!("    Paraphrased Content:");
    println!("      Recent research indicates that differential privacy methods show promise");
    println!("      for protecting individual data in ML training (Smith & Lee, 2023).");
    println!("   ");
    println!("    Multiple Source Synthesis:");
    println!("      Several studies have demonstrated the effectiveness of federated learning");
    println!("      approaches (Chen et al., 2023; Rodriguez, 2024; Brown & Wilson, 2023).");

    println!("\n Expected Citation Response:");
    println!("    Structured Summary with Citations:");
    println!("      • Privacy challenges in AI systems (Anderson, 2024, pp. 23-25)");
    println!("      • Technical solutions: differential privacy (Johnson et al., 2023)");
    println!("      • Regulatory considerations (Privacy Commission Report, 2024, §3.2)");
    println!("   ");
    println!("    Reference List:");
    println!(
        "      Anderson, M. (2024). AI Privacy Challenges. Tech Ethics Journal, 15(3), 20-30."
    );
    println!("      Johnson, P., Smith, R., & Lee, K. (2023). Differential privacy in practice.");
    println!("      Privacy Commission. (2024). AI governance guidelines (Report #2024-AI-001).");

    Ok(())
}

/// Example 5: Multi-Document Analysis and Synthesis
fn run_multi_document_analysis_example() -> Result<(), Error> {
    println!("\n Example 5: Multi-Document Analysis and Synthesis");
    println!("{}", "=".repeat(60));

    // Create multi-document analysis assistant
    let _analysis_assistant = assistant_with_instructions(
        "gpt-4-1106-preview",
        "Document Analysis Specialist",
        "You are a document analysis expert. Compare and contrast information across multiple documents, identify contradictions or gaps, synthesize information from diverse sources, and provide comprehensive analysis that considers multiple perspectives."
    )
    .add_tool(tool_file_search());

    println!(" Created document analysis assistant:");
    println!("   Specialty: Cross-document comparison and synthesis");

    // Create comprehensive document store for analysis
    let _analysis_store = VectorStoreBuilder::new()
        .name("Multi-Document Analysis Store")
        .add_file("file-policy-proposal-v1")
        .add_file("file-policy-proposal-v2")
        .add_file("file-stakeholder-feedback-001")
        .add_file("file-legal-review-002")
        .add_file("file-technical-assessment-003")
        .add_file("file-cost-benefit-analysis-004")
        .metadata("analysis_type", "policy_comparison")
        .metadata("documents", "6")
        .metadata("perspectives", "multiple");

    println!("\n Multi-Document Analysis Setup:");
    println!("   Documents: 6 files representing different perspectives");
    println!("   Analysis type: Policy proposal comparison");
    println!("   Perspectives: Technical, legal, financial, stakeholder");

    println!("\n Multi-Document Analysis Query:");
    println!("   'Compare the two policy proposals and analyze how stakeholder feedback'");
    println!("   'has been incorporated. Identify any conflicts between the legal review'");
    println!("   'and technical assessment.'");

    println!("\n Multi-Document RAG Analysis Workflow:");
    println!("   1.  Identify key comparison dimensions");
    println!("   2.  Search each document type systematically");
    println!("   3.  Create comparison matrix across documents");
    println!("   4.  Identify conflicts and contradictions");
    println!("   5.  Find connections and dependencies");
    println!("   6.  Synthesize comprehensive analysis");
    println!("   7.  Provide recommendations based on synthesis");

    // Demonstrate advanced search patterns
    let _comparative_search =
        search_vector_store_with_limit("analysis-store-456", "risk assessment comparison", 15)
            .filter("document_type", "technical,legal")
            .filter("section", "risks");

    println!("\n Advanced Search Pattern:");
    println!("   Query: risk assessment comparison");
    println!("   Target documents: technical + legal reviews");
    println!("   Focus section: risk analysis sections");

    println!("\n Expected Multi-Document Analysis:");
    println!("    Comparative Analysis:");
    println!("      Policy Proposal Comparison:");
    println!("      • V1 focuses on immediate implementation (Technical Assessment)");
    println!("      • V2 incorporates phased approach (Stakeholder Feedback)");
    println!("   ");
    println!("    Identified Conflicts:");
    println!("      • Legal review flags compliance issues with V1 approach");
    println!("      • Technical assessment questions feasibility of V2 timeline");
    println!("      • Cost analysis shows budget misalignment between proposals");
    println!("   ");
    println!("    Stakeholder Integration:");
    println!("      • 73% of feedback incorporated in V2 (Stakeholder Feedback doc)");
    println!("      • Privacy concerns addressed through technical modifications");
    println!("      • Cost concerns partially resolved via phased implementation");
    println!("   ");
    println!("    Synthesis Recommendations:");
    println!("      • Hybrid approach combining V1 technical framework with V2 timeline");
    println!("      • Address legal compliance through additional technical review");
    println!("      • Require budget revision to align with stakeholder expectations");

    Ok(())
}

pub fn file_ids(self, file_ids: Vec<String>) -> Self

Set the file IDs to include in the vector store.

pub fn add_file(self, file_id: impl Into<String>) -> Self

Add a single file ID to the vector store.

Examples found in repository

examples/vector_stores.rs (line 101)

fn run_basic_vector_store_example() -> Result<(), Error> {
    println!(" Example 1: Basic Vector Store Operations");
    println!("{}", "=".repeat(60));

    // Create a simple vector store
    let basic_store = simple_vector_store("Getting Started Vector Store")
        .metadata("purpose", "tutorial")
        .metadata("created_by", "openai_ergonomic_example");

    println!(" Created basic vector store:");
    println!("   Name: {}", basic_store.name_ref().unwrap());
    println!(
        "   Purpose: {}",
        basic_store.metadata_ref().get("purpose").unwrap()
    );
    println!("   Files: {}", basic_store.file_count());

    // Add files to the vector store
    let store_with_files = basic_store
        .add_file("file-welcome-doc-001")
        .add_file("file-getting-started-002")
        .add_file("file-basic-examples-003");

    println!("\n Added files to vector store:");
    for (i, file_id) in store_with_files.file_ids_ref().iter().enumerate() {
        println!("   {}. {}", i + 1, file_id);
    }
    println!("   Total files: {}", store_with_files.file_count());

    // Demonstrate vector store properties
    println!("\n Vector Store Properties:");
    println!("   Has files: {}", store_with_files.has_files());
    println!(
        "   Metadata entries: {}",
        store_with_files.metadata_ref().len()
    );
    println!(
        "   Expires: {}",
        if store_with_files.expires_after_ref().is_some() {
            "Yes"
        } else {
            "No"
        }
    );

    println!("\n Basic Operations:");
    println!("    Create vector store");
    println!("    Add metadata");
    println!("    Add files");
    println!("    Query properties");
    println!("    Ready for search operations");

    Ok(())
}

/// Example 2: Document Management and Batch Operations
fn run_document_management_example() -> Result<(), Error> {
    println!("\n Example 2: Document Management and Batch Operations");
    println!("{}", "=".repeat(60));

    // Simulate a large document collection
    let document_collection = vec![
        "file-product-docs-001",
        "file-product-docs-002",
        "file-api-reference-003",
        "file-user-guide-004",
        "file-troubleshooting-005",
        "file-changelog-006",
        "file-best-practices-007",
        "file-integration-guide-008",
    ];

    // Create vector store with batch file addition
    let doc_store = vector_store_with_files(
        "Product Documentation Store",
        document_collection.iter().map(|s| s.to_string()).collect(),
    )
    .metadata("category", "documentation")
    .metadata("product", "api_platform")
    .metadata("version", "v2.1")
    .expires_after_days(180); // 6 months retention

    println!(" Created documentation vector store:");
    println!("   Name: {}", doc_store.name_ref().unwrap());
    println!("   Documents: {} files", doc_store.file_count());
    println!(
        "   Category: {}",
        doc_store.metadata_ref().get("category").unwrap()
    );
    println!("   Retention: 180 days");

    // Demonstrate individual file operations
    let individual_file_op = add_file_to_vector_store("doc-store-123", "file-new-feature-009");

    println!("\n Individual File Operations:");
    println!("   Adding file: {}", individual_file_op.file_id());
    println!("   To store: {}", individual_file_op.vector_store_id());

    // Simulate file organization strategies
    println!("\n Document Organization Strategies:");

    let categorized_stores = vec![
        (
            "API Documentation",
            vec!["file-api-ref", "file-endpoints", "file-auth"],
        ),
        (
            "User Guides",
            vec!["file-quickstart", "file-tutorials", "file-howtos"],
        ),
        (
            "Technical Specs",
            vec!["file-architecture", "file-protocols", "file-security"],
        ),
        (
            "Release Notes",
            vec!["file-changelog", "file-migration", "file-breaking-changes"],
        ),
    ];

    for (category, files) in &categorized_stores {
        let category_store = vector_store_with_files(
            format!("{} Vector Store", category),
            files.iter().map(|s| s.to_string()).collect(),
        )
        .metadata("category", category.to_lowercase().replace(" ", "_"))
        .metadata("auto_managed", "true");

        println!("    {}: {} files", category, category_store.file_count());
    }

    println!("\n Document Management Workflow:");
    println!("   1.  Batch upload documents by category");
    println!("   2.  Apply consistent metadata tagging");
    println!("   3. ⏰ Set appropriate retention policies");
    println!("   4.  Enable automatic organization");
    println!("   5.  Monitor storage usage and performance");

    Ok(())
}

/// Example 3: Semantic Search and Similarity Queries
fn run_semantic_search_example() -> Result<(), Error> {
    println!("\n Example 3: Semantic Search and Similarity Queries");
    println!("{}", "=".repeat(60));

    // Create a search-optimized vector store
    let search_store = simple_vector_store("Semantic Search Demo Store")
        .add_file("file-ml-concepts-001")
        .add_file("file-nlp-techniques-002")
        .add_file("file-deep-learning-003")
        .add_file("file-computer-vision-004")
        .add_file("file-ai-ethics-005")
        .metadata("domain", "machine_learning")
        .metadata("search_optimized", "true");

    println!(" Created search-optimized vector store:");
    println!("   Name: {}", search_store.name_ref().unwrap());
    println!("   Domain: Machine Learning");
    println!("   Documents: {} files", search_store.file_count());

    // Demonstrate various search patterns
    println!("\n Search Query Examples:");

    // Basic semantic search
    let basic_search = search_vector_store("search-store-123", "neural network architectures");
    println!("   1. Basic Search:");
    println!("      Query: '{}'", basic_search.query());
    println!("      Store: {}", basic_search.vector_store_id());

    // Limited result search
    let limited_search = search_vector_store_with_limit(
        "search-store-123",
        "natural language processing techniques",
        5,
    );
    println!("   2. Limited Results:");
    println!("      Query: '{}'", limited_search.query());
    println!(
        "      Limit: {} results",
        limited_search.limit_ref().unwrap()
    );

    // Advanced filtered search
    let filtered_search =
        search_vector_store_with_limit("search-store-123", "computer vision applications", 10)
            .filter("category", "practical_applications")
            .filter("difficulty", "intermediate");

    println!("   3. Filtered Search:");
    println!("      Query: '{}'", filtered_search.query());
    println!(
        "      Filters: {} applied",
        filtered_search.filter_ref().len()
    );
    for (key, value) in filtered_search.filter_ref() {
        println!("         {}={}", key, value);
    }

    // Demonstrate search result processing
    println!("\n Search Result Processing:");
    println!("    Semantic similarity ranking");
    println!("    Document excerpt extraction");
    println!("    Relevance score calculation");
    println!("    Source location identification");
    println!("    Related content suggestions");

    // Show different query types
    println!("\n Query Type Examples:");
    let query_examples = vec![
        (
            "Conceptual",
            "What is machine learning?",
            "Broad conceptual understanding",
        ),
        (
            "Technical",
            "How to implement backpropagation?",
            "Specific technical implementation",
        ),
        (
            "Comparative",
            "LSTM vs Transformer architectures",
            "Comparative analysis",
        ),
        (
            "Problem-solving",
            "Overfitting in neural networks",
            "Problem identification and solutions",
        ),
        (
            "Application",
            "Computer vision in healthcare",
            "Domain-specific applications",
        ),
    ];

    for (query_type, query, description) in query_examples {
        println!("    {}: '{}'", query_type, query);
        println!("      Purpose: {}", description);
    }

    Ok(())
}

/// Example 4: Enterprise Knowledge Base
fn run_enterprise_knowledge_base_example() -> Result<(), Error> {
    println!("\n Example 4: Enterprise Knowledge Base");
    println!("{}", "=".repeat(60));

    // Create enterprise-scale vector stores
    let enterprise_stores = create_enterprise_knowledge_base()?;

    println!(" Enterprise Knowledge Base Architecture:");
    for (department, store) in enterprise_stores {
        println!("    {}", department);
        println!("      Files: {} documents", store.file_count());
        println!(
            "      Retention: {} days",
            store
                .expires_after_ref()
                .map_or("permanent".to_string(), |exp| exp.days.to_string())
                .as_str()
        );

        // Show metadata structure
        for (key, value) in store.metadata_ref() {
            println!("      {}: {}", key, value);
        }
        println!();
    }

    // Demonstrate cross-departmental search
    println!(" Cross-Departmental Search Examples:");

    let cross_searches = vec![
        (
            "Security Compliance",
            "GDPR data handling procedures",
            vec!["legal", "engineering", "hr"],
        ),
        (
            "Product Launch",
            "Q4 release planning and coordination",
            vec!["product", "engineering", "marketing"],
        ),
        (
            "Budget Planning",
            "Annual technology investment strategy",
            vec!["finance", "engineering", "executive"],
        ),
        (
            "Process Improvement",
            "Remote work productivity guidelines",
            vec!["hr", "operations", "it"],
        ),
    ];

    for (topic, query, departments) in cross_searches {
        println!("    {}: '{}'", topic, query);
        println!("      Search scope: {}", departments.join(", "));
    }

    println!("\n Enterprise Features:");
    println!("    Role-based access control");
    println!("    Usage analytics and monitoring");
    println!("    Automated content lifecycle management");
    println!("    Search performance optimization");
    println!("    Backup and disaster recovery");
    println!("    Compliance and audit trails");

    Ok(())
}

/// Example 5: Vector Store Lifecycle Management
fn run_vector_store_lifecycle_example() -> Result<(), Error> {
    println!("\n Example 5: Vector Store Lifecycle Management");
    println!("{}", "=".repeat(60));

    // Demonstrate different lifecycle patterns
    println!("⏰ Vector Store Lifecycle Patterns:");

    // Temporary stores for sessions
    let session_store = temporary_vector_store("User Session Store", 1)
        .add_file("file-session-context-001")
        .metadata("session_id", "sess_12345")
        .metadata("user_id", "user_67890");

    println!("    Session-based (1 day):");
    println!("      Purpose: Temporary user context");
    println!("      Files: {}", session_store.file_count());
    println!("      Auto-cleanup: ");

    // Project stores
    let project_store = temporary_vector_store("Project Alpha Documentation", 90)
        .add_file("file-project-spec-001")
        .add_file("file-meeting-notes-002")
        .add_file("file-progress-reports-003")
        .metadata("project_id", "proj_alpha_2024")
        .metadata("phase", "development");

    println!("    Project-based (90 days):");
    println!("      Purpose: Project lifecycle documentation");
    println!("      Files: {}", project_store.file_count());
    println!("      Cleanup: After project completion");

    // Long-term knowledge stores
    let knowledge_store = simple_vector_store("Institutional Knowledge Base")
        .add_file("file-company-history-001")
        .add_file("file-best-practices-002")
        .add_file("file-lessons-learned-003")
        .metadata("retention", "permanent")
        .metadata("backup", "enabled")
        .metadata("compliance", "required");

    println!("    Institutional (permanent):");
    println!("      Purpose: Long-term organizational knowledge");
    println!("      Files: {}", knowledge_store.file_count());
    println!("      Cleanup: Manual review only");

    // Demonstrate lifecycle events
    println!("\n Lifecycle Event Handling:");
    println!("    Creation: Automatic indexing and optimization");
    println!("    Updates: Incremental re-indexing of modified files");
    println!("    Monitoring: Usage tracking and performance metrics");
    println!("    Warnings: Expiration notifications and alerts");
    println!("    Cleanup: Automatic or manual deletion processes");
    println!("    Archival: Long-term storage for compliance");

    // Show cost optimization strategies
    println!("\n Cost Optimization Strategies:");
    println!("    Smart expiration policies based on usage");
    println!("    Analytics-driven storage optimization");
    println!("    Automatic compression for archived content");
    println!("    Tiered storage (hot, warm, cold)");
    println!("    Usage-based scaling recommendations");

    Ok(())
}

/// Example 6: Advanced Search Patterns and Optimization
fn run_advanced_search_patterns_example() -> Result<(), Error> {
    println!("\n Example 6: Advanced Search Patterns and Optimization");
    println!("{}", "=".repeat(60));

    // Create optimized search store
    let optimized_store = VectorStoreBuilder::new()
        .name("Advanced Search Optimization Store")
        .add_file("file-technical-docs-001")
        .add_file("file-user-feedback-002")
        .add_file("file-performance-data-003")
        .add_file("file-best-practices-004")
        .metadata("search_optimized", "true")
        .metadata("indexing", "enhanced")
        .metadata("caching", "enabled");

    println!(" Created advanced search store:");
    println!("   Optimization: Enhanced indexing");
    println!("   Caching: Enabled");
    println!("   Files: {} documents", optimized_store.file_count());

    // Demonstrate advanced search patterns
    println!("\n Advanced Search Patterns:");

    // Multi-stage search
    println!("   1.  Multi-stage Search:");
    println!("      Stage 1: Broad semantic search (100 results)");
    println!("      Stage 2: Filtered refinement (20 results)");
    println!("      Stage 3: Relevance re-ranking (5 top results)");

    let multi_stage_search =
        VectorStoreSearchBuilder::new("advanced-store-789", "machine learning best practices")
            .limit(100)
            .filter("category", "best_practices")
            .filter("verified", "true");

    println!("      Query: '{}'", multi_stage_search.query());
    println!(
        "      Initial limit: {}",
        multi_stage_search.limit_ref().unwrap()
    );

    // Contextual search
    println!("   2.  Contextual Search:");
    println!("      Context: User role, project phase, domain expertise");
    println!("      Adaptation: Results tailored to user context");

    let _contextual_search =
        search_vector_store_with_limit("advanced-store-789", "deployment strategies", 15)
            .filter("audience", "senior_engineer")
            .filter("complexity", "advanced")
            .filter("domain", "cloud_infrastructure");

    println!("      Audience: senior_engineer");
    println!("      Complexity: advanced");
    println!("      Domain: cloud_infrastructure");

    // Hybrid search approaches
    println!("   3.  Hybrid Search Approaches:");
    println!("      Semantic similarity + keyword matching");
    println!("      Vector search + traditional full-text search");
    println!("      AI-enhanced query understanding");

    // Search performance optimization
    println!("\n Search Performance Optimization:");
    println!("    Query optimization and caching");
    println!("    Result pre-computation for common queries");
    println!("    Incremental index updates");
    println!("    Load balancing across vector stores");
    println!("    Machine learning-based relevance tuning");

    // Quality metrics and monitoring
    println!("\n Search Quality Metrics:");
    println!("    Relevance scores and user feedback");
    println!("   ⏱ Query response time analysis");
    println!("    Search success rate tracking");
    println!("    Usage pattern analysis");
    println!("    Continuous improvement recommendations");

    Ok(())
}

/// Helper function to create enterprise knowledge base structure
fn create_enterprise_knowledge_base() -> Result<Vec<(String, VectorStoreBuilder)>, Error> {
    let departments = vec![
        ("Engineering".to_string(), create_engineering_store()),
        ("Legal".to_string(), create_legal_store()),
        ("HR".to_string(), create_hr_store()),
        ("Marketing".to_string(), create_marketing_store()),
        ("Finance".to_string(), create_finance_store()),
        ("Operations".to_string(), create_operations_store()),
    ];

    Ok(departments)
}

fn create_engineering_store() -> VectorStoreBuilder {
    VectorStoreBuilder::new()
        .name("Engineering Knowledge Base")
        .add_file("file-architecture-docs-001")
        .add_file("file-coding-standards-002")
        .add_file("file-deployment-guides-003")
        .add_file("file-api-documentation-004")
        .metadata("department", "engineering")
        .metadata("access_level", "engineering_team")
        .metadata("update_frequency", "weekly")
        .expires_after_days(365)
}

fn create_legal_store() -> VectorStoreBuilder {
    VectorStoreBuilder::new()
        .name("Legal Documentation Store")
        .add_file("file-contracts-templates-001")
        .add_file("file-compliance-guides-002")
        .add_file("file-policy-documents-003")
        .metadata("department", "legal")
        .metadata("access_level", "legal_team")
        .metadata("confidentiality", "high")
        .expires_after_days(2555) // 7 years for legal retention
}

fn create_hr_store() -> VectorStoreBuilder {
    VectorStoreBuilder::new()
        .name("Human Resources Knowledge Base")
        .add_file("file-employee-handbook-001")
        .add_file("file-benefits-guide-002")
        .add_file("file-performance-templates-003")
        .metadata("department", "hr")
        .metadata("access_level", "hr_managers")
        .metadata("privacy", "employee_data")
        .expires_after_days(1095) // 3 years
}

fn create_marketing_store() -> VectorStoreBuilder {
    VectorStoreBuilder::new()
        .name("Marketing Materials Store")
        .add_file("file-brand-guidelines-001")
        .add_file("file-campaign-templates-002")
        .add_file("file-market-research-003")
        .metadata("department", "marketing")
        .metadata("access_level", "marketing_team")
        .metadata("content_type", "creative_assets")
        .expires_after_days(365)
}

fn create_finance_store() -> VectorStoreBuilder {
    VectorStoreBuilder::new()
        .name("Finance Documentation Store")
        .add_file("file-budget-templates-001")
        .add_file("file-financial-policies-002")
        .add_file("file-audit-procedures-003")
        .metadata("department", "finance")
        .metadata("access_level", "finance_team")
        .metadata("compliance", "required")
        .expires_after_days(2555) // 7 years for financial records
}

fn create_operations_store() -> VectorStoreBuilder {
    VectorStoreBuilder::new()
        .name("Operations Procedures Store")
        .add_file("file-standard-procedures-001")
        .add_file("file-incident-response-002")
        .add_file("file-vendor-management-003")
        .metadata("department", "operations")
        .metadata("access_level", "operations_team")
        .metadata("criticality", "high")
        .expires_after_days(730) // 2 years
}

examples/assistants_file_search.rs (line 164)

fn run_document_qa_example() -> Result<(), Error> {
    println!("\n Example 2: Document Q&A Assistant");
    println!("{}", "=".repeat(60));

    // Create specialized document Q&A assistant
    let _qa_assistant = AssistantBuilder::new("gpt-4-1106-preview")
        .name("Document Q&A Specialist")
        .description("Answers questions based on uploaded documents with high accuracy")
        .instructions(
            "You are a document Q&A specialist. Answer questions by searching through the provided documents. Always cite your sources, indicate confidence levels, and acknowledge when information is not available in the documents."
        )
        .add_tool(tool_file_search());

    println!(" Created Document Q&A assistant:");
    println!("   Specialty: Precise question answering from documents");

    // Create a temporary vector store for this Q&A session
    let qa_store = temporary_vector_store("Q&A Session Store", 7) // Expires in 7 days
        .add_file("file-research-paper-001")
        .add_file("file-user-manual-002")
        .add_file("file-technical-spec-003")
        .metadata("session_id", "qa-session-123")
        .metadata("user", "researcher-001");

    println!("\n Q&A Document Store:");
    println!("   Files: {} documents loaded", qa_store.file_count());
    println!("   Expiration: 7 days (temporary session)");
    println!("   Session ID: qa-session-123");

    println!("\n Example Q&A Queries:");
    let queries = vec![
        "What is the maximum throughput mentioned in the technical specifications?",
        "How do I configure the authentication system according to the user manual?",
        "What are the key findings from the research paper regarding performance?",
        "Are there any known limitations discussed in these documents?",
    ];

    for (i, query) in queries.iter().enumerate() {
        println!("   {}. {}", i + 1, query);
    }

    println!("\n Document Q&A RAG Workflow:");
    println!("   1.  Process user question");
    println!("   2.  Generate search queries for vector store");
    println!("   3.  Retrieve relevant document sections");
    println!("   4.  Rank and filter results by relevance");
    println!("   5.  Generate answer from retrieved context");
    println!("   6.  Add citations and confidence indicators");

    println!("\n Expected Q&A Response Format:");
    println!("    Direct answer to the question");
    println!("    Citations: [technical-spec-003.pdf, page 15]");
    println!("    Confidence: High (90%)");
    println!("    Related information: See also user-manual-002.pdf, section 4.3");
    println!("     Limitations: No information found about edge cases");

    Ok(())
}

/// Example 3: Research Assistant with Advanced RAG
fn run_research_assistant_example() -> Result<(), Error> {
    println!("\n Example 3: Research Assistant with Advanced RAG");
    println!("{}", "=".repeat(60));

    // Create research-focused assistant
    let _research_assistant = assistant_with_instructions(
        "gpt-4-1106-preview",
        "Research Assistant",
        "You are a research assistant specializing in literature review and analysis. Help researchers find relevant information, identify patterns across documents, synthesize findings, and suggest research directions. Always provide comprehensive citations and acknowledge research limitations."
    )
    .add_tool(tool_file_search());

    println!(" Created research assistant:");
    println!("   Focus: Literature review and cross-document analysis");

    // Create a comprehensive research vector store
    let _research_store = VectorStoreBuilder::new()
        .name("Research Literature Database")
        .add_file("file-paper-ai-ethics-001")
        .add_file("file-paper-ml-bias-002")
        .add_file("file-paper-fairness-003")
        .add_file("file-survey-responsible-ai-004")
        .add_file("file-whitepaper-governance-005")
        .metadata("domain", "AI Ethics")
        .metadata("papers_count", "50")
        .metadata("date_range", "2020-2024");

    println!("\n Research Literature Database:");
    println!("   Domain: AI Ethics and Responsible AI");
    println!("   Papers: 5 documents loaded (representing 50 papers)");
    println!("   Date range: 2020-2024");

    println!("\n Research Query:");
    println!(
        "   'What are the current approaches to addressing algorithmic bias in machine learning?'"
    );
    println!("   'Please provide a comprehensive overview with citations.'");

    println!("\n Advanced RAG Research Workflow:");
    println!("   1.  Query analysis and decomposition");
    println!("   2.  Multi-faceted search across all documents");
    println!("   3.  Semantic clustering of results");
    println!("   4.  Cross-reference analysis between papers");
    println!("   5.  Identify trends and patterns");
    println!("   6.  Synthesize comprehensive overview");
    println!("   7.  Provide detailed citations and references");

    // Demonstrate search refinement
    let refined_search =
        search_vector_store_with_limit("research-db-123", "algorithmic bias mitigation", 20)
            .filter("category", "methodology")
            .filter("confidence", "high");

    println!("\n Search Refinement:");
    println!("   Query: algorithmic bias mitigation");
    println!("   Limit: {} results", refined_search.limit_ref().unwrap());
    println!("   Filters: category=methodology, confidence=high");

    println!("\n Expected Research Response:");
    println!("    Executive Summary:");
    println!("      • Overview of current bias mitigation approaches");
    println!("      • Key methodological categories identified");
    println!("      • Emerging trends and best practices");
    println!("   ");
    println!("    Detailed Analysis:");
    println!("      • Pre-processing techniques (data augmentation, sampling)");
    println!("      • In-processing methods (fairness constraints, adversarial training)");
    println!("      • Post-processing approaches (threshold optimization, calibration)");
    println!("   ");
    println!("    Comprehensive Citations:");
    println!("      • [Smith et al., 2023] - Fairness constraints in ML training");
    println!("      • [Johnson & Lee, 2024] - Bias detection in neural networks");
    println!("      • [Research Survey, 2024] - Comprehensive bias mitigation review");
    println!("   ");
    println!("    Future Research Directions:");
    println!("      • Intersectional bias analysis");
    println!("      • Real-time bias monitoring");
    println!("      • Domain-specific mitigation strategies");

    Ok(())
}

/// Example 4: Citation and Source Attribution
fn run_citation_example() -> Result<(), Error> {
    println!("\n Example 4: Citation and Source Attribution");
    println!("{}", "=".repeat(60));

    // Create citation-focused assistant
    let _citation_assistant = AssistantBuilder::new("gpt-4-1106-preview")
        .name("Citation Specialist")
        .description("Provides detailed source attribution and citation management")
        .instructions(
            "You are a citation specialist. Always provide accurate, detailed citations for any information retrieved from documents. Use proper academic citation formats, include page numbers when available, and distinguish between direct quotes and paraphrased content."
        )
        .add_tool(tool_file_search());

    println!(" Created citation specialist assistant:");
    println!("   Focus: Accurate source attribution and citation formatting");

    // Create thread for citation-heavy work
    let _citation_thread = simple_thread()
        .metadata("citation_style", "APA")
        .metadata("requirement", "academic_standards")
        .metadata("verification", "enabled");

    println!("\n Citation Requirements:");
    println!("   Style: APA format");
    println!("   Standards: Academic-level accuracy");
    println!("   Verification: Enabled for all sources");

    println!("\n Citation Query:");
    println!("   'Provide a summary of the key arguments about privacy in AI systems,'");
    println!("   'with detailed citations for each point made.'");

    println!("\n Citation-Focused RAG Workflow:");
    println!("   1.  Search for relevant content across documents");
    println!("   2.  Extract content with precise location data");
    println!("   3.  Generate response with inline citations");
    println!("   4.  Verify citation accuracy and completeness");
    println!("   5.  Format citations according to specified style");
    println!("   6.  Cross-check for citation consistency");

    // Demonstrate different citation formats
    println!("\n Citation Format Examples:");
    println!("    Direct Quote:");
    println!(
        "      \"Privacy-preserving AI requires careful balance between utility and protection\""
    );
    println!("      (Johnson, 2024, p. 15)");
    println!("   ");
    println!("    Paraphrased Content:");
    println!("      Recent research indicates that differential privacy methods show promise");
    println!("      for protecting individual data in ML training (Smith & Lee, 2023).");
    println!("   ");
    println!("    Multiple Source Synthesis:");
    println!("      Several studies have demonstrated the effectiveness of federated learning");
    println!("      approaches (Chen et al., 2023; Rodriguez, 2024; Brown & Wilson, 2023).");

    println!("\n Expected Citation Response:");
    println!("    Structured Summary with Citations:");
    println!("      • Privacy challenges in AI systems (Anderson, 2024, pp. 23-25)");
    println!("      • Technical solutions: differential privacy (Johnson et al., 2023)");
    println!("      • Regulatory considerations (Privacy Commission Report, 2024, §3.2)");
    println!("   ");
    println!("    Reference List:");
    println!(
        "      Anderson, M. (2024). AI Privacy Challenges. Tech Ethics Journal, 15(3), 20-30."
    );
    println!("      Johnson, P., Smith, R., & Lee, K. (2023). Differential privacy in practice.");
    println!("      Privacy Commission. (2024). AI governance guidelines (Report #2024-AI-001).");

    Ok(())
}

/// Example 5: Multi-Document Analysis and Synthesis
fn run_multi_document_analysis_example() -> Result<(), Error> {
    println!("\n Example 5: Multi-Document Analysis and Synthesis");
    println!("{}", "=".repeat(60));

    // Create multi-document analysis assistant
    let _analysis_assistant = assistant_with_instructions(
        "gpt-4-1106-preview",
        "Document Analysis Specialist",
        "You are a document analysis expert. Compare and contrast information across multiple documents, identify contradictions or gaps, synthesize information from diverse sources, and provide comprehensive analysis that considers multiple perspectives."
    )
    .add_tool(tool_file_search());

    println!(" Created document analysis assistant:");
    println!("   Specialty: Cross-document comparison and synthesis");

    // Create comprehensive document store for analysis
    let _analysis_store = VectorStoreBuilder::new()
        .name("Multi-Document Analysis Store")
        .add_file("file-policy-proposal-v1")
        .add_file("file-policy-proposal-v2")
        .add_file("file-stakeholder-feedback-001")
        .add_file("file-legal-review-002")
        .add_file("file-technical-assessment-003")
        .add_file("file-cost-benefit-analysis-004")
        .metadata("analysis_type", "policy_comparison")
        .metadata("documents", "6")
        .metadata("perspectives", "multiple");

    println!("\n Multi-Document Analysis Setup:");
    println!("   Documents: 6 files representing different perspectives");
    println!("   Analysis type: Policy proposal comparison");
    println!("   Perspectives: Technical, legal, financial, stakeholder");

    println!("\n Multi-Document Analysis Query:");
    println!("   'Compare the two policy proposals and analyze how stakeholder feedback'");
    println!("   'has been incorporated. Identify any conflicts between the legal review'");
    println!("   'and technical assessment.'");

    println!("\n Multi-Document RAG Analysis Workflow:");
    println!("   1.  Identify key comparison dimensions");
    println!("   2.  Search each document type systematically");
    println!("   3.  Create comparison matrix across documents");
    println!("   4.  Identify conflicts and contradictions");
    println!("   5.  Find connections and dependencies");
    println!("   6.  Synthesize comprehensive analysis");
    println!("   7.  Provide recommendations based on synthesis");

    // Demonstrate advanced search patterns
    let _comparative_search =
        search_vector_store_with_limit("analysis-store-456", "risk assessment comparison", 15)
            .filter("document_type", "technical,legal")
            .filter("section", "risks");

    println!("\n Advanced Search Pattern:");
    println!("   Query: risk assessment comparison");
    println!("   Target documents: technical + legal reviews");
    println!("   Focus section: risk analysis sections");

    println!("\n Expected Multi-Document Analysis:");
    println!("    Comparative Analysis:");
    println!("      Policy Proposal Comparison:");
    println!("      • V1 focuses on immediate implementation (Technical Assessment)");
    println!("      • V2 incorporates phased approach (Stakeholder Feedback)");
    println!("   ");
    println!("    Identified Conflicts:");
    println!("      • Legal review flags compliance issues with V1 approach");
    println!("      • Technical assessment questions feasibility of V2 timeline");
    println!("      • Cost analysis shows budget misalignment between proposals");
    println!("   ");
    println!("    Stakeholder Integration:");
    println!("      • 73% of feedback incorporated in V2 (Stakeholder Feedback doc)");
    println!("      • Privacy concerns addressed through technical modifications");
    println!("      • Cost concerns partially resolved via phased implementation");
    println!("   ");
    println!("    Synthesis Recommendations:");
    println!("      • Hybrid approach combining V1 technical framework with V2 timeline");
    println!("      • Address legal compliance through additional technical review");
    println!("      • Require budget revision to align with stakeholder expectations");

    Ok(())
}

pub fn add_files<I, S>(self, file_ids: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Add multiple file IDs to the vector store.

pub fn clear_files(self) -> Self

Clear all file IDs from the vector store.

pub fn expires_after_days(self, days: i32) -> Self

Set expiration policy for the vector store.

Examples found in repository

examples/assistants_file_search.rs (line 90)

fn run_knowledge_base_example() -> Result<(), Error> {
    println!(" Example 1: Building a Knowledge Base Assistant");
    println!("{}", "=".repeat(60));

    // Create a knowledge base vector store
    let knowledge_store = simple_vector_store("Company Knowledge Base")
        .metadata("type", "internal_docs")
        .metadata("department", "engineering")
        .expires_after_days(365); // Expire after 1 year

    println!(" Created knowledge base vector store:");
    println!("   Name: {}", knowledge_store.name_ref().unwrap());
    println!("   Type: Internal documentation");
    println!("   Expiration: 365 days");

    // Simulate adding documents to the knowledge base
    let file_ids = vec![
        "file-api-docs-123".to_string(),
        "file-coding-standards-456".to_string(),
        "file-deployment-guide-789".to_string(),
        "file-troubleshooting-101".to_string(),
    ];

    let populated_store = vector_store_with_files("Engineering Knowledge Base", file_ids.clone());

    println!("\n Knowledge Base Contents:");
    for (i, file_id) in populated_store.file_ids_ref().iter().enumerate() {
        println!("   {}. {}", i + 1, file_id);
    }
    println!("   Total files: {}", populated_store.file_count());

    // Create an assistant with file search capabilities
    let kb_assistant = assistant_with_instructions(
        "gpt-4-1106-preview",
        "Engineering Knowledge Assistant",
        "You are an engineering knowledge assistant. Help developers find relevant information from our internal documentation, coding standards, and deployment guides. Always provide accurate citations and suggest related resources when appropriate."
    )
    .description("Internal knowledge base assistant for engineering teams")
    .add_tool(tool_file_search());

    println!("\n Created knowledge base assistant:");
    println!("   Name: {}", kb_assistant.name_ref().unwrap());
    println!("   Capability: File search through engineering documents");

    println!("\n Example Knowledge Base Query:");
    println!("   'What are our coding standards for API documentation?'");

    println!("\n RAG Workflow for Knowledge Base:");
    println!("   1.  Search vector store for relevant documents");
    println!("   2.  Retrieve matching sections from coding standards");
    println!("   3.  Generate response based on retrieved content");
    println!("   4.  Provide citations to specific documents");
    println!("   5.  Suggest related topics or documents");

    println!("\n Expected Knowledge Base Response:");
    println!("   • Specific coding standards for API documentation");
    println!("   • Citations: 'coding-standards-456.md, section 3.2'");
    println!("   • Examples from deployment guide");
    println!("   • Related resources: troubleshooting guide");

    Ok(())
}

examples/vector_stores.rs (line 162)

fn run_document_management_example() -> Result<(), Error> {
    println!("\n Example 2: Document Management and Batch Operations");
    println!("{}", "=".repeat(60));

    // Simulate a large document collection
    let document_collection = vec![
        "file-product-docs-001",
        "file-product-docs-002",
        "file-api-reference-003",
        "file-user-guide-004",
        "file-troubleshooting-005",
        "file-changelog-006",
        "file-best-practices-007",
        "file-integration-guide-008",
    ];

    // Create vector store with batch file addition
    let doc_store = vector_store_with_files(
        "Product Documentation Store",
        document_collection.iter().map(|s| s.to_string()).collect(),
    )
    .metadata("category", "documentation")
    .metadata("product", "api_platform")
    .metadata("version", "v2.1")
    .expires_after_days(180); // 6 months retention

    println!(" Created documentation vector store:");
    println!("   Name: {}", doc_store.name_ref().unwrap());
    println!("   Documents: {} files", doc_store.file_count());
    println!(
        "   Category: {}",
        doc_store.metadata_ref().get("category").unwrap()
    );
    println!("   Retention: 180 days");

    // Demonstrate individual file operations
    let individual_file_op = add_file_to_vector_store("doc-store-123", "file-new-feature-009");

    println!("\n Individual File Operations:");
    println!("   Adding file: {}", individual_file_op.file_id());
    println!("   To store: {}", individual_file_op.vector_store_id());

    // Simulate file organization strategies
    println!("\n Document Organization Strategies:");

    let categorized_stores = vec![
        (
            "API Documentation",
            vec!["file-api-ref", "file-endpoints", "file-auth"],
        ),
        (
            "User Guides",
            vec!["file-quickstart", "file-tutorials", "file-howtos"],
        ),
        (
            "Technical Specs",
            vec!["file-architecture", "file-protocols", "file-security"],
        ),
        (
            "Release Notes",
            vec!["file-changelog", "file-migration", "file-breaking-changes"],
        ),
    ];

    for (category, files) in &categorized_stores {
        let category_store = vector_store_with_files(
            format!("{} Vector Store", category),
            files.iter().map(|s| s.to_string()).collect(),
        )
        .metadata("category", category.to_lowercase().replace(" ", "_"))
        .metadata("auto_managed", "true");

        println!("    {}: {} files", category, category_store.file_count());
    }

    println!("\n Document Management Workflow:");
    println!("   1.  Batch upload documents by category");
    println!("   2.  Apply consistent metadata tagging");
    println!("   3. ⏰ Set appropriate retention policies");
    println!("   4.  Enable automatic organization");
    println!("   5.  Monitor storage usage and performance");

    Ok(())
}

/// Example 3: Semantic Search and Similarity Queries
fn run_semantic_search_example() -> Result<(), Error> {
    println!("\n Example 3: Semantic Search and Similarity Queries");
    println!("{}", "=".repeat(60));

    // Create a search-optimized vector store
    let search_store = simple_vector_store("Semantic Search Demo Store")
        .add_file("file-ml-concepts-001")
        .add_file("file-nlp-techniques-002")
        .add_file("file-deep-learning-003")
        .add_file("file-computer-vision-004")
        .add_file("file-ai-ethics-005")
        .metadata("domain", "machine_learning")
        .metadata("search_optimized", "true");

    println!(" Created search-optimized vector store:");
    println!("   Name: {}", search_store.name_ref().unwrap());
    println!("   Domain: Machine Learning");
    println!("   Documents: {} files", search_store.file_count());

    // Demonstrate various search patterns
    println!("\n Search Query Examples:");

    // Basic semantic search
    let basic_search = search_vector_store("search-store-123", "neural network architectures");
    println!("   1. Basic Search:");
    println!("      Query: '{}'", basic_search.query());
    println!("      Store: {}", basic_search.vector_store_id());

    // Limited result search
    let limited_search = search_vector_store_with_limit(
        "search-store-123",
        "natural language processing techniques",
        5,
    );
    println!("   2. Limited Results:");
    println!("      Query: '{}'", limited_search.query());
    println!(
        "      Limit: {} results",
        limited_search.limit_ref().unwrap()
    );

    // Advanced filtered search
    let filtered_search =
        search_vector_store_with_limit("search-store-123", "computer vision applications", 10)
            .filter("category", "practical_applications")
            .filter("difficulty", "intermediate");

    println!("   3. Filtered Search:");
    println!("      Query: '{}'", filtered_search.query());
    println!(
        "      Filters: {} applied",
        filtered_search.filter_ref().len()
    );
    for (key, value) in filtered_search.filter_ref() {
        println!("         {}={}", key, value);
    }

    // Demonstrate search result processing
    println!("\n Search Result Processing:");
    println!("    Semantic similarity ranking");
    println!("    Document excerpt extraction");
    println!("    Relevance score calculation");
    println!("    Source location identification");
    println!("    Related content suggestions");

    // Show different query types
    println!("\n Query Type Examples:");
    let query_examples = vec![
        (
            "Conceptual",
            "What is machine learning?",
            "Broad conceptual understanding",
        ),
        (
            "Technical",
            "How to implement backpropagation?",
            "Specific technical implementation",
        ),
        (
            "Comparative",
            "LSTM vs Transformer architectures",
            "Comparative analysis",
        ),
        (
            "Problem-solving",
            "Overfitting in neural networks",
            "Problem identification and solutions",
        ),
        (
            "Application",
            "Computer vision in healthcare",
            "Domain-specific applications",
        ),
    ];

    for (query_type, query, description) in query_examples {
        println!("    {}: '{}'", query_type, query);
        println!("      Purpose: {}", description);
    }

    Ok(())
}

/// Example 4: Enterprise Knowledge Base
fn run_enterprise_knowledge_base_example() -> Result<(), Error> {
    println!("\n Example 4: Enterprise Knowledge Base");
    println!("{}", "=".repeat(60));

    // Create enterprise-scale vector stores
    let enterprise_stores = create_enterprise_knowledge_base()?;

    println!(" Enterprise Knowledge Base Architecture:");
    for (department, store) in enterprise_stores {
        println!("    {}", department);
        println!("      Files: {} documents", store.file_count());
        println!(
            "      Retention: {} days",
            store
                .expires_after_ref()
                .map_or("permanent".to_string(), |exp| exp.days.to_string())
                .as_str()
        );

        // Show metadata structure
        for (key, value) in store.metadata_ref() {
            println!("      {}: {}", key, value);
        }
        println!();
    }

    // Demonstrate cross-departmental search
    println!(" Cross-Departmental Search Examples:");

    let cross_searches = vec![
        (
            "Security Compliance",
            "GDPR data handling procedures",
            vec!["legal", "engineering", "hr"],
        ),
        (
            "Product Launch",
            "Q4 release planning and coordination",
            vec!["product", "engineering", "marketing"],
        ),
        (
            "Budget Planning",
            "Annual technology investment strategy",
            vec!["finance", "engineering", "executive"],
        ),
        (
            "Process Improvement",
            "Remote work productivity guidelines",
            vec!["hr", "operations", "it"],
        ),
    ];

    for (topic, query, departments) in cross_searches {
        println!("    {}: '{}'", topic, query);
        println!("      Search scope: {}", departments.join(", "));
    }

    println!("\n Enterprise Features:");
    println!("    Role-based access control");
    println!("    Usage analytics and monitoring");
    println!("    Automated content lifecycle management");
    println!("    Search performance optimization");
    println!("    Backup and disaster recovery");
    println!("    Compliance and audit trails");

    Ok(())
}

/// Example 5: Vector Store Lifecycle Management
fn run_vector_store_lifecycle_example() -> Result<(), Error> {
    println!("\n Example 5: Vector Store Lifecycle Management");
    println!("{}", "=".repeat(60));

    // Demonstrate different lifecycle patterns
    println!("⏰ Vector Store Lifecycle Patterns:");

    // Temporary stores for sessions
    let session_store = temporary_vector_store("User Session Store", 1)
        .add_file("file-session-context-001")
        .metadata("session_id", "sess_12345")
        .metadata("user_id", "user_67890");

    println!("    Session-based (1 day):");
    println!("      Purpose: Temporary user context");
    println!("      Files: {}", session_store.file_count());
    println!("      Auto-cleanup: ");

    // Project stores
    let project_store = temporary_vector_store("Project Alpha Documentation", 90)
        .add_file("file-project-spec-001")
        .add_file("file-meeting-notes-002")
        .add_file("file-progress-reports-003")
        .metadata("project_id", "proj_alpha_2024")
        .metadata("phase", "development");

    println!("    Project-based (90 days):");
    println!("      Purpose: Project lifecycle documentation");
    println!("      Files: {}", project_store.file_count());
    println!("      Cleanup: After project completion");

    // Long-term knowledge stores
    let knowledge_store = simple_vector_store("Institutional Knowledge Base")
        .add_file("file-company-history-001")
        .add_file("file-best-practices-002")
        .add_file("file-lessons-learned-003")
        .metadata("retention", "permanent")
        .metadata("backup", "enabled")
        .metadata("compliance", "required");

    println!("    Institutional (permanent):");
    println!("      Purpose: Long-term organizational knowledge");
    println!("      Files: {}", knowledge_store.file_count());
    println!("      Cleanup: Manual review only");

    // Demonstrate lifecycle events
    println!("\n Lifecycle Event Handling:");
    println!("    Creation: Automatic indexing and optimization");
    println!("    Updates: Incremental re-indexing of modified files");
    println!("    Monitoring: Usage tracking and performance metrics");
    println!("    Warnings: Expiration notifications and alerts");
    println!("    Cleanup: Automatic or manual deletion processes");
    println!("    Archival: Long-term storage for compliance");

    // Show cost optimization strategies
    println!("\n Cost Optimization Strategies:");
    println!("    Smart expiration policies based on usage");
    println!("    Analytics-driven storage optimization");
    println!("    Automatic compression for archived content");
    println!("    Tiered storage (hot, warm, cold)");
    println!("    Usage-based scaling recommendations");

    Ok(())
}

/// Example 6: Advanced Search Patterns and Optimization
fn run_advanced_search_patterns_example() -> Result<(), Error> {
    println!("\n Example 6: Advanced Search Patterns and Optimization");
    println!("{}", "=".repeat(60));

    // Create optimized search store
    let optimized_store = VectorStoreBuilder::new()
        .name("Advanced Search Optimization Store")
        .add_file("file-technical-docs-001")
        .add_file("file-user-feedback-002")
        .add_file("file-performance-data-003")
        .add_file("file-best-practices-004")
        .metadata("search_optimized", "true")
        .metadata("indexing", "enhanced")
        .metadata("caching", "enabled");

    println!(" Created advanced search store:");
    println!("   Optimization: Enhanced indexing");
    println!("   Caching: Enabled");
    println!("   Files: {} documents", optimized_store.file_count());

    // Demonstrate advanced search patterns
    println!("\n Advanced Search Patterns:");

    // Multi-stage search
    println!("   1.  Multi-stage Search:");
    println!("      Stage 1: Broad semantic search (100 results)");
    println!("      Stage 2: Filtered refinement (20 results)");
    println!("      Stage 3: Relevance re-ranking (5 top results)");

    let multi_stage_search =
        VectorStoreSearchBuilder::new("advanced-store-789", "machine learning best practices")
            .limit(100)
            .filter("category", "best_practices")
            .filter("verified", "true");

    println!("      Query: '{}'", multi_stage_search.query());
    println!(
        "      Initial limit: {}",
        multi_stage_search.limit_ref().unwrap()
    );

    // Contextual search
    println!("   2.  Contextual Search:");
    println!("      Context: User role, project phase, domain expertise");
    println!("      Adaptation: Results tailored to user context");

    let _contextual_search =
        search_vector_store_with_limit("advanced-store-789", "deployment strategies", 15)
            .filter("audience", "senior_engineer")
            .filter("complexity", "advanced")
            .filter("domain", "cloud_infrastructure");

    println!("      Audience: senior_engineer");
    println!("      Complexity: advanced");
    println!("      Domain: cloud_infrastructure");

    // Hybrid search approaches
    println!("   3.  Hybrid Search Approaches:");
    println!("      Semantic similarity + keyword matching");
    println!("      Vector search + traditional full-text search");
    println!("      AI-enhanced query understanding");

    // Search performance optimization
    println!("\n Search Performance Optimization:");
    println!("    Query optimization and caching");
    println!("    Result pre-computation for common queries");
    println!("    Incremental index updates");
    println!("    Load balancing across vector stores");
    println!("    Machine learning-based relevance tuning");

    // Quality metrics and monitoring
    println!("\n Search Quality Metrics:");
    println!("    Relevance scores and user feedback");
    println!("   ⏱ Query response time analysis");
    println!("    Search success rate tracking");
    println!("    Usage pattern analysis");
    println!("    Continuous improvement recommendations");

    Ok(())
}

/// Helper function to create enterprise knowledge base structure
fn create_enterprise_knowledge_base() -> Result<Vec<(String, VectorStoreBuilder)>, Error> {
    let departments = vec![
        ("Engineering".to_string(), create_engineering_store()),
        ("Legal".to_string(), create_legal_store()),
        ("HR".to_string(), create_hr_store()),
        ("Marketing".to_string(), create_marketing_store()),
        ("Finance".to_string(), create_finance_store()),
        ("Operations".to_string(), create_operations_store()),
    ];

    Ok(departments)
}

fn create_engineering_store() -> VectorStoreBuilder {
    VectorStoreBuilder::new()
        .name("Engineering Knowledge Base")
        .add_file("file-architecture-docs-001")
        .add_file("file-coding-standards-002")
        .add_file("file-deployment-guides-003")
        .add_file("file-api-documentation-004")
        .metadata("department", "engineering")
        .metadata("access_level", "engineering_team")
        .metadata("update_frequency", "weekly")
        .expires_after_days(365)
}

fn create_legal_store() -> VectorStoreBuilder {
    VectorStoreBuilder::new()
        .name("Legal Documentation Store")
        .add_file("file-contracts-templates-001")
        .add_file("file-compliance-guides-002")
        .add_file("file-policy-documents-003")
        .metadata("department", "legal")
        .metadata("access_level", "legal_team")
        .metadata("confidentiality", "high")
        .expires_after_days(2555) // 7 years for legal retention
}

fn create_hr_store() -> VectorStoreBuilder {
    VectorStoreBuilder::new()
        .name("Human Resources Knowledge Base")
        .add_file("file-employee-handbook-001")
        .add_file("file-benefits-guide-002")
        .add_file("file-performance-templates-003")
        .metadata("department", "hr")
        .metadata("access_level", "hr_managers")
        .metadata("privacy", "employee_data")
        .expires_after_days(1095) // 3 years
}

fn create_marketing_store() -> VectorStoreBuilder {
    VectorStoreBuilder::new()
        .name("Marketing Materials Store")
        .add_file("file-brand-guidelines-001")
        .add_file("file-campaign-templates-002")
        .add_file("file-market-research-003")
        .metadata("department", "marketing")
        .metadata("access_level", "marketing_team")
        .metadata("content_type", "creative_assets")
        .expires_after_days(365)
}

fn create_finance_store() -> VectorStoreBuilder {
    VectorStoreBuilder::new()
        .name("Finance Documentation Store")
        .add_file("file-budget-templates-001")
        .add_file("file-financial-policies-002")
        .add_file("file-audit-procedures-003")
        .metadata("department", "finance")
        .metadata("access_level", "finance_team")
        .metadata("compliance", "required")
        .expires_after_days(2555) // 7 years for financial records
}

fn create_operations_store() -> VectorStoreBuilder {
    VectorStoreBuilder::new()
        .name("Operations Procedures Store")
        .add_file("file-standard-procedures-001")
        .add_file("file-incident-response-002")
        .add_file("file-vendor-management-003")
        .metadata("department", "operations")
        .metadata("access_level", "operations_team")
        .metadata("criticality", "high")
        .expires_after_days(730) // 2 years
}

pub fn metadata(self, key: impl Into<String>, value: impl Into<String>) -> Self

Add metadata to the vector store.

Examples found in repository

examples/vector_stores.rs (line 88)

fn run_basic_vector_store_example() -> Result<(), Error> {
    println!(" Example 1: Basic Vector Store Operations");
    println!("{}", "=".repeat(60));

    // Create a simple vector store
    let basic_store = simple_vector_store("Getting Started Vector Store")
        .metadata("purpose", "tutorial")
        .metadata("created_by", "openai_ergonomic_example");

    println!(" Created basic vector store:");
    println!("   Name: {}", basic_store.name_ref().unwrap());
    println!(
        "   Purpose: {}",
        basic_store.metadata_ref().get("purpose").unwrap()
    );
    println!("   Files: {}", basic_store.file_count());

    // Add files to the vector store
    let store_with_files = basic_store
        .add_file("file-welcome-doc-001")
        .add_file("file-getting-started-002")
        .add_file("file-basic-examples-003");

    println!("\n Added files to vector store:");
    for (i, file_id) in store_with_files.file_ids_ref().iter().enumerate() {
        println!("   {}. {}", i + 1, file_id);
    }
    println!("   Total files: {}", store_with_files.file_count());

    // Demonstrate vector store properties
    println!("\n Vector Store Properties:");
    println!("   Has files: {}", store_with_files.has_files());
    println!(
        "   Metadata entries: {}",
        store_with_files.metadata_ref().len()
    );
    println!(
        "   Expires: {}",
        if store_with_files.expires_after_ref().is_some() {
            "Yes"
        } else {
            "No"
        }
    );

    println!("\n Basic Operations:");
    println!("    Create vector store");
    println!("    Add metadata");
    println!("    Add files");
    println!("    Query properties");
    println!("    Ready for search operations");

    Ok(())
}

/// Example 2: Document Management and Batch Operations
fn run_document_management_example() -> Result<(), Error> {
    println!("\n Example 2: Document Management and Batch Operations");
    println!("{}", "=".repeat(60));

    // Simulate a large document collection
    let document_collection = vec![
        "file-product-docs-001",
        "file-product-docs-002",
        "file-api-reference-003",
        "file-user-guide-004",
        "file-troubleshooting-005",
        "file-changelog-006",
        "file-best-practices-007",
        "file-integration-guide-008",
    ];

    // Create vector store with batch file addition
    let doc_store = vector_store_with_files(
        "Product Documentation Store",
        document_collection.iter().map(|s| s.to_string()).collect(),
    )
    .metadata("category", "documentation")
    .metadata("product", "api_platform")
    .metadata("version", "v2.1")
    .expires_after_days(180); // 6 months retention

    println!(" Created documentation vector store:");
    println!("   Name: {}", doc_store.name_ref().unwrap());
    println!("   Documents: {} files", doc_store.file_count());
    println!(
        "   Category: {}",
        doc_store.metadata_ref().get("category").unwrap()
    );
    println!("   Retention: 180 days");

    // Demonstrate individual file operations
    let individual_file_op = add_file_to_vector_store("doc-store-123", "file-new-feature-009");

    println!("\n Individual File Operations:");
    println!("   Adding file: {}", individual_file_op.file_id());
    println!("   To store: {}", individual_file_op.vector_store_id());

    // Simulate file organization strategies
    println!("\n Document Organization Strategies:");

    let categorized_stores = vec![
        (
            "API Documentation",
            vec!["file-api-ref", "file-endpoints", "file-auth"],
        ),
        (
            "User Guides",
            vec!["file-quickstart", "file-tutorials", "file-howtos"],
        ),
        (
            "Technical Specs",
            vec!["file-architecture", "file-protocols", "file-security"],
        ),
        (
            "Release Notes",
            vec!["file-changelog", "file-migration", "file-breaking-changes"],
        ),
    ];

    for (category, files) in &categorized_stores {
        let category_store = vector_store_with_files(
            format!("{} Vector Store", category),
            files.iter().map(|s| s.to_string()).collect(),
        )
        .metadata("category", category.to_lowercase().replace(" ", "_"))
        .metadata("auto_managed", "true");

        println!("    {}: {} files", category, category_store.file_count());
    }

    println!("\n Document Management Workflow:");
    println!("   1.  Batch upload documents by category");
    println!("   2.  Apply consistent metadata tagging");
    println!("   3. ⏰ Set appropriate retention policies");
    println!("   4.  Enable automatic organization");
    println!("   5.  Monitor storage usage and performance");

    Ok(())
}

/// Example 3: Semantic Search and Similarity Queries
fn run_semantic_search_example() -> Result<(), Error> {
    println!("\n Example 3: Semantic Search and Similarity Queries");
    println!("{}", "=".repeat(60));

    // Create a search-optimized vector store
    let search_store = simple_vector_store("Semantic Search Demo Store")
        .add_file("file-ml-concepts-001")
        .add_file("file-nlp-techniques-002")
        .add_file("file-deep-learning-003")
        .add_file("file-computer-vision-004")
        .add_file("file-ai-ethics-005")
        .metadata("domain", "machine_learning")
        .metadata("search_optimized", "true");

    println!(" Created search-optimized vector store:");
    println!("   Name: {}", search_store.name_ref().unwrap());
    println!("   Domain: Machine Learning");
    println!("   Documents: {} files", search_store.file_count());

    // Demonstrate various search patterns
    println!("\n Search Query Examples:");

    // Basic semantic search
    let basic_search = search_vector_store("search-store-123", "neural network architectures");
    println!("   1. Basic Search:");
    println!("      Query: '{}'", basic_search.query());
    println!("      Store: {}", basic_search.vector_store_id());

    // Limited result search
    let limited_search = search_vector_store_with_limit(
        "search-store-123",
        "natural language processing techniques",
        5,
    );
    println!("   2. Limited Results:");
    println!("      Query: '{}'", limited_search.query());
    println!(
        "      Limit: {} results",
        limited_search.limit_ref().unwrap()
    );

    // Advanced filtered search
    let filtered_search =
        search_vector_store_with_limit("search-store-123", "computer vision applications", 10)
            .filter("category", "practical_applications")
            .filter("difficulty", "intermediate");

    println!("   3. Filtered Search:");
    println!("      Query: '{}'", filtered_search.query());
    println!(
        "      Filters: {} applied",
        filtered_search.filter_ref().len()
    );
    for (key, value) in filtered_search.filter_ref() {
        println!("         {}={}", key, value);
    }

    // Demonstrate search result processing
    println!("\n Search Result Processing:");
    println!("    Semantic similarity ranking");
    println!("    Document excerpt extraction");
    println!("    Relevance score calculation");
    println!("    Source location identification");
    println!("    Related content suggestions");

    // Show different query types
    println!("\n Query Type Examples:");
    let query_examples = vec![
        (
            "Conceptual",
            "What is machine learning?",
            "Broad conceptual understanding",
        ),
        (
            "Technical",
            "How to implement backpropagation?",
            "Specific technical implementation",
        ),
        (
            "Comparative",
            "LSTM vs Transformer architectures",
            "Comparative analysis",
        ),
        (
            "Problem-solving",
            "Overfitting in neural networks",
            "Problem identification and solutions",
        ),
        (
            "Application",
            "Computer vision in healthcare",
            "Domain-specific applications",
        ),
    ];

    for (query_type, query, description) in query_examples {
        println!("    {}: '{}'", query_type, query);
        println!("      Purpose: {}", description);
    }

    Ok(())
}

/// Example 4: Enterprise Knowledge Base
fn run_enterprise_knowledge_base_example() -> Result<(), Error> {
    println!("\n Example 4: Enterprise Knowledge Base");
    println!("{}", "=".repeat(60));

    // Create enterprise-scale vector stores
    let enterprise_stores = create_enterprise_knowledge_base()?;

    println!(" Enterprise Knowledge Base Architecture:");
    for (department, store) in enterprise_stores {
        println!("    {}", department);
        println!("      Files: {} documents", store.file_count());
        println!(
            "      Retention: {} days",
            store
                .expires_after_ref()
                .map_or("permanent".to_string(), |exp| exp.days.to_string())
                .as_str()
        );

        // Show metadata structure
        for (key, value) in store.metadata_ref() {
            println!("      {}: {}", key, value);
        }
        println!();
    }

    // Demonstrate cross-departmental search
    println!(" Cross-Departmental Search Examples:");

    let cross_searches = vec![
        (
            "Security Compliance",
            "GDPR data handling procedures",
            vec!["legal", "engineering", "hr"],
        ),
        (
            "Product Launch",
            "Q4 release planning and coordination",
            vec!["product", "engineering", "marketing"],
        ),
        (
            "Budget Planning",
            "Annual technology investment strategy",
            vec!["finance", "engineering", "executive"],
        ),
        (
            "Process Improvement",
            "Remote work productivity guidelines",
            vec!["hr", "operations", "it"],
        ),
    ];

    for (topic, query, departments) in cross_searches {
        println!("    {}: '{}'", topic, query);
        println!("      Search scope: {}", departments.join(", "));
    }

    println!("\n Enterprise Features:");
    println!("    Role-based access control");
    println!("    Usage analytics and monitoring");
    println!("    Automated content lifecycle management");
    println!("    Search performance optimization");
    println!("    Backup and disaster recovery");
    println!("    Compliance and audit trails");

    Ok(())
}

/// Example 5: Vector Store Lifecycle Management
fn run_vector_store_lifecycle_example() -> Result<(), Error> {
    println!("\n Example 5: Vector Store Lifecycle Management");
    println!("{}", "=".repeat(60));

    // Demonstrate different lifecycle patterns
    println!("⏰ Vector Store Lifecycle Patterns:");

    // Temporary stores for sessions
    let session_store = temporary_vector_store("User Session Store", 1)
        .add_file("file-session-context-001")
        .metadata("session_id", "sess_12345")
        .metadata("user_id", "user_67890");

    println!("    Session-based (1 day):");
    println!("      Purpose: Temporary user context");
    println!("      Files: {}", session_store.file_count());
    println!("      Auto-cleanup: ");

    // Project stores
    let project_store = temporary_vector_store("Project Alpha Documentation", 90)
        .add_file("file-project-spec-001")
        .add_file("file-meeting-notes-002")
        .add_file("file-progress-reports-003")
        .metadata("project_id", "proj_alpha_2024")
        .metadata("phase", "development");

    println!("    Project-based (90 days):");
    println!("      Purpose: Project lifecycle documentation");
    println!("      Files: {}", project_store.file_count());
    println!("      Cleanup: After project completion");

    // Long-term knowledge stores
    let knowledge_store = simple_vector_store("Institutional Knowledge Base")
        .add_file("file-company-history-001")
        .add_file("file-best-practices-002")
        .add_file("file-lessons-learned-003")
        .metadata("retention", "permanent")
        .metadata("backup", "enabled")
        .metadata("compliance", "required");

    println!("    Institutional (permanent):");
    println!("      Purpose: Long-term organizational knowledge");
    println!("      Files: {}", knowledge_store.file_count());
    println!("      Cleanup: Manual review only");

    // Demonstrate lifecycle events
    println!("\n Lifecycle Event Handling:");
    println!("    Creation: Automatic indexing and optimization");
    println!("    Updates: Incremental re-indexing of modified files");
    println!("    Monitoring: Usage tracking and performance metrics");
    println!("    Warnings: Expiration notifications and alerts");
    println!("    Cleanup: Automatic or manual deletion processes");
    println!("    Archival: Long-term storage for compliance");

    // Show cost optimization strategies
    println!("\n Cost Optimization Strategies:");
    println!("    Smart expiration policies based on usage");
    println!("    Analytics-driven storage optimization");
    println!("    Automatic compression for archived content");
    println!("    Tiered storage (hot, warm, cold)");
    println!("    Usage-based scaling recommendations");

    Ok(())
}

/// Example 6: Advanced Search Patterns and Optimization
fn run_advanced_search_patterns_example() -> Result<(), Error> {
    println!("\n Example 6: Advanced Search Patterns and Optimization");
    println!("{}", "=".repeat(60));

    // Create optimized search store
    let optimized_store = VectorStoreBuilder::new()
        .name("Advanced Search Optimization Store")
        .add_file("file-technical-docs-001")
        .add_file("file-user-feedback-002")
        .add_file("file-performance-data-003")
        .add_file("file-best-practices-004")
        .metadata("search_optimized", "true")
        .metadata("indexing", "enhanced")
        .metadata("caching", "enabled");

    println!(" Created advanced search store:");
    println!("   Optimization: Enhanced indexing");
    println!("   Caching: Enabled");
    println!("   Files: {} documents", optimized_store.file_count());

    // Demonstrate advanced search patterns
    println!("\n Advanced Search Patterns:");

    // Multi-stage search
    println!("   1.  Multi-stage Search:");
    println!("      Stage 1: Broad semantic search (100 results)");
    println!("      Stage 2: Filtered refinement (20 results)");
    println!("      Stage 3: Relevance re-ranking (5 top results)");

    let multi_stage_search =
        VectorStoreSearchBuilder::new("advanced-store-789", "machine learning best practices")
            .limit(100)
            .filter("category", "best_practices")
            .filter("verified", "true");

    println!("      Query: '{}'", multi_stage_search.query());
    println!(
        "      Initial limit: {}",
        multi_stage_search.limit_ref().unwrap()
    );

    // Contextual search
    println!("   2.  Contextual Search:");
    println!("      Context: User role, project phase, domain expertise");
    println!("      Adaptation: Results tailored to user context");

    let _contextual_search =
        search_vector_store_with_limit("advanced-store-789", "deployment strategies", 15)
            .filter("audience", "senior_engineer")
            .filter("complexity", "advanced")
            .filter("domain", "cloud_infrastructure");

    println!("      Audience: senior_engineer");
    println!("      Complexity: advanced");
    println!("      Domain: cloud_infrastructure");

    // Hybrid search approaches
    println!("   3.  Hybrid Search Approaches:");
    println!("      Semantic similarity + keyword matching");
    println!("      Vector search + traditional full-text search");
    println!("      AI-enhanced query understanding");

    // Search performance optimization
    println!("\n Search Performance Optimization:");
    println!("    Query optimization and caching");
    println!("    Result pre-computation for common queries");
    println!("    Incremental index updates");
    println!("    Load balancing across vector stores");
    println!("    Machine learning-based relevance tuning");

    // Quality metrics and monitoring
    println!("\n Search Quality Metrics:");
    println!("    Relevance scores and user feedback");
    println!("   ⏱ Query response time analysis");
    println!("    Search success rate tracking");
    println!("    Usage pattern analysis");
    println!("    Continuous improvement recommendations");

    Ok(())
}

/// Helper function to create enterprise knowledge base structure
fn create_enterprise_knowledge_base() -> Result<Vec<(String, VectorStoreBuilder)>, Error> {
    let departments = vec![
        ("Engineering".to_string(), create_engineering_store()),
        ("Legal".to_string(), create_legal_store()),
        ("HR".to_string(), create_hr_store()),
        ("Marketing".to_string(), create_marketing_store()),
        ("Finance".to_string(), create_finance_store()),
        ("Operations".to_string(), create_operations_store()),
    ];

    Ok(departments)
}

fn create_engineering_store() -> VectorStoreBuilder {
    VectorStoreBuilder::new()
        .name("Engineering Knowledge Base")
        .add_file("file-architecture-docs-001")
        .add_file("file-coding-standards-002")
        .add_file("file-deployment-guides-003")
        .add_file("file-api-documentation-004")
        .metadata("department", "engineering")
        .metadata("access_level", "engineering_team")
        .metadata("update_frequency", "weekly")
        .expires_after_days(365)
}

fn create_legal_store() -> VectorStoreBuilder {
    VectorStoreBuilder::new()
        .name("Legal Documentation Store")
        .add_file("file-contracts-templates-001")
        .add_file("file-compliance-guides-002")
        .add_file("file-policy-documents-003")
        .metadata("department", "legal")
        .metadata("access_level", "legal_team")
        .metadata("confidentiality", "high")
        .expires_after_days(2555) // 7 years for legal retention
}

fn create_hr_store() -> VectorStoreBuilder {
    VectorStoreBuilder::new()
        .name("Human Resources Knowledge Base")
        .add_file("file-employee-handbook-001")
        .add_file("file-benefits-guide-002")
        .add_file("file-performance-templates-003")
        .metadata("department", "hr")
        .metadata("access_level", "hr_managers")
        .metadata("privacy", "employee_data")
        .expires_after_days(1095) // 3 years
}

fn create_marketing_store() -> VectorStoreBuilder {
    VectorStoreBuilder::new()
        .name("Marketing Materials Store")
        .add_file("file-brand-guidelines-001")
        .add_file("file-campaign-templates-002")
        .add_file("file-market-research-003")
        .metadata("department", "marketing")
        .metadata("access_level", "marketing_team")
        .metadata("content_type", "creative_assets")
        .expires_after_days(365)
}

fn create_finance_store() -> VectorStoreBuilder {
    VectorStoreBuilder::new()
        .name("Finance Documentation Store")
        .add_file("file-budget-templates-001")
        .add_file("file-financial-policies-002")
        .add_file("file-audit-procedures-003")
        .metadata("department", "finance")
        .metadata("access_level", "finance_team")
        .metadata("compliance", "required")
        .expires_after_days(2555) // 7 years for financial records
}

fn create_operations_store() -> VectorStoreBuilder {
    VectorStoreBuilder::new()
        .name("Operations Procedures Store")
        .add_file("file-standard-procedures-001")
        .add_file("file-incident-response-002")
        .add_file("file-vendor-management-003")
        .metadata("department", "operations")
        .metadata("access_level", "operations_team")
        .metadata("criticality", "high")
        .expires_after_days(730) // 2 years
}

examples/assistants_file_search.rs (line 88)

fn run_knowledge_base_example() -> Result<(), Error> {
    println!(" Example 1: Building a Knowledge Base Assistant");
    println!("{}", "=".repeat(60));

    // Create a knowledge base vector store
    let knowledge_store = simple_vector_store("Company Knowledge Base")
        .metadata("type", "internal_docs")
        .metadata("department", "engineering")
        .expires_after_days(365); // Expire after 1 year

    println!(" Created knowledge base vector store:");
    println!("   Name: {}", knowledge_store.name_ref().unwrap());
    println!("   Type: Internal documentation");
    println!("   Expiration: 365 days");

    // Simulate adding documents to the knowledge base
    let file_ids = vec![
        "file-api-docs-123".to_string(),
        "file-coding-standards-456".to_string(),
        "file-deployment-guide-789".to_string(),
        "file-troubleshooting-101".to_string(),
    ];

    let populated_store = vector_store_with_files("Engineering Knowledge Base", file_ids.clone());

    println!("\n Knowledge Base Contents:");
    for (i, file_id) in populated_store.file_ids_ref().iter().enumerate() {
        println!("   {}. {}", i + 1, file_id);
    }
    println!("   Total files: {}", populated_store.file_count());

    // Create an assistant with file search capabilities
    let kb_assistant = assistant_with_instructions(
        "gpt-4-1106-preview",
        "Engineering Knowledge Assistant",
        "You are an engineering knowledge assistant. Help developers find relevant information from our internal documentation, coding standards, and deployment guides. Always provide accurate citations and suggest related resources when appropriate."
    )
    .description("Internal knowledge base assistant for engineering teams")
    .add_tool(tool_file_search());

    println!("\n Created knowledge base assistant:");
    println!("   Name: {}", kb_assistant.name_ref().unwrap());
    println!("   Capability: File search through engineering documents");

    println!("\n Example Knowledge Base Query:");
    println!("   'What are our coding standards for API documentation?'");

    println!("\n RAG Workflow for Knowledge Base:");
    println!("   1.  Search vector store for relevant documents");
    println!("   2.  Retrieve matching sections from coding standards");
    println!("   3.  Generate response based on retrieved content");
    println!("   4.  Provide citations to specific documents");
    println!("   5.  Suggest related topics or documents");

    println!("\n Expected Knowledge Base Response:");
    println!("   • Specific coding standards for API documentation");
    println!("   • Citations: 'coding-standards-456.md, section 3.2'");
    println!("   • Examples from deployment guide");
    println!("   • Related resources: troubleshooting guide");

    Ok(())
}

/// Example 2: Document Q&A Assistant
fn run_document_qa_example() -> Result<(), Error> {
    println!("\n Example 2: Document Q&A Assistant");
    println!("{}", "=".repeat(60));

    // Create specialized document Q&A assistant
    let _qa_assistant = AssistantBuilder::new("gpt-4-1106-preview")
        .name("Document Q&A Specialist")
        .description("Answers questions based on uploaded documents with high accuracy")
        .instructions(
            "You are a document Q&A specialist. Answer questions by searching through the provided documents. Always cite your sources, indicate confidence levels, and acknowledge when information is not available in the documents."
        )
        .add_tool(tool_file_search());

    println!(" Created Document Q&A assistant:");
    println!("   Specialty: Precise question answering from documents");

    // Create a temporary vector store for this Q&A session
    let qa_store = temporary_vector_store("Q&A Session Store", 7) // Expires in 7 days
        .add_file("file-research-paper-001")
        .add_file("file-user-manual-002")
        .add_file("file-technical-spec-003")
        .metadata("session_id", "qa-session-123")
        .metadata("user", "researcher-001");

    println!("\n Q&A Document Store:");
    println!("   Files: {} documents loaded", qa_store.file_count());
    println!("   Expiration: 7 days (temporary session)");
    println!("   Session ID: qa-session-123");

    println!("\n Example Q&A Queries:");
    let queries = vec![
        "What is the maximum throughput mentioned in the technical specifications?",
        "How do I configure the authentication system according to the user manual?",
        "What are the key findings from the research paper regarding performance?",
        "Are there any known limitations discussed in these documents?",
    ];

    for (i, query) in queries.iter().enumerate() {
        println!("   {}. {}", i + 1, query);
    }

    println!("\n Document Q&A RAG Workflow:");
    println!("   1.  Process user question");
    println!("   2.  Generate search queries for vector store");
    println!("   3.  Retrieve relevant document sections");
    println!("   4.  Rank and filter results by relevance");
    println!("   5.  Generate answer from retrieved context");
    println!("   6.  Add citations and confidence indicators");

    println!("\n Expected Q&A Response Format:");
    println!("    Direct answer to the question");
    println!("    Citations: [technical-spec-003.pdf, page 15]");
    println!("    Confidence: High (90%)");
    println!("    Related information: See also user-manual-002.pdf, section 4.3");
    println!("     Limitations: No information found about edge cases");

    Ok(())
}

/// Example 3: Research Assistant with Advanced RAG
fn run_research_assistant_example() -> Result<(), Error> {
    println!("\n Example 3: Research Assistant with Advanced RAG");
    println!("{}", "=".repeat(60));

    // Create research-focused assistant
    let _research_assistant = assistant_with_instructions(
        "gpt-4-1106-preview",
        "Research Assistant",
        "You are a research assistant specializing in literature review and analysis. Help researchers find relevant information, identify patterns across documents, synthesize findings, and suggest research directions. Always provide comprehensive citations and acknowledge research limitations."
    )
    .add_tool(tool_file_search());

    println!(" Created research assistant:");
    println!("   Focus: Literature review and cross-document analysis");

    // Create a comprehensive research vector store
    let _research_store = VectorStoreBuilder::new()
        .name("Research Literature Database")
        .add_file("file-paper-ai-ethics-001")
        .add_file("file-paper-ml-bias-002")
        .add_file("file-paper-fairness-003")
        .add_file("file-survey-responsible-ai-004")
        .add_file("file-whitepaper-governance-005")
        .metadata("domain", "AI Ethics")
        .metadata("papers_count", "50")
        .metadata("date_range", "2020-2024");

    println!("\n Research Literature Database:");
    println!("   Domain: AI Ethics and Responsible AI");
    println!("   Papers: 5 documents loaded (representing 50 papers)");
    println!("   Date range: 2020-2024");

    println!("\n Research Query:");
    println!(
        "   'What are the current approaches to addressing algorithmic bias in machine learning?'"
    );
    println!("   'Please provide a comprehensive overview with citations.'");

    println!("\n Advanced RAG Research Workflow:");
    println!("   1.  Query analysis and decomposition");
    println!("   2.  Multi-faceted search across all documents");
    println!("   3.  Semantic clustering of results");
    println!("   4.  Cross-reference analysis between papers");
    println!("   5.  Identify trends and patterns");
    println!("   6.  Synthesize comprehensive overview");
    println!("   7.  Provide detailed citations and references");

    // Demonstrate search refinement
    let refined_search =
        search_vector_store_with_limit("research-db-123", "algorithmic bias mitigation", 20)
            .filter("category", "methodology")
            .filter("confidence", "high");

    println!("\n Search Refinement:");
    println!("   Query: algorithmic bias mitigation");
    println!("   Limit: {} results", refined_search.limit_ref().unwrap());
    println!("   Filters: category=methodology, confidence=high");

    println!("\n Expected Research Response:");
    println!("    Executive Summary:");
    println!("      • Overview of current bias mitigation approaches");
    println!("      • Key methodological categories identified");
    println!("      • Emerging trends and best practices");
    println!("   ");
    println!("    Detailed Analysis:");
    println!("      • Pre-processing techniques (data augmentation, sampling)");
    println!("      • In-processing methods (fairness constraints, adversarial training)");
    println!("      • Post-processing approaches (threshold optimization, calibration)");
    println!("   ");
    println!("    Comprehensive Citations:");
    println!("      • [Smith et al., 2023] - Fairness constraints in ML training");
    println!("      • [Johnson & Lee, 2024] - Bias detection in neural networks");
    println!("      • [Research Survey, 2024] - Comprehensive bias mitigation review");
    println!("   ");
    println!("    Future Research Directions:");
    println!("      • Intersectional bias analysis");
    println!("      • Real-time bias monitoring");
    println!("      • Domain-specific mitigation strategies");

    Ok(())
}

/// Example 4: Citation and Source Attribution
fn run_citation_example() -> Result<(), Error> {
    println!("\n Example 4: Citation and Source Attribution");
    println!("{}", "=".repeat(60));

    // Create citation-focused assistant
    let _citation_assistant = AssistantBuilder::new("gpt-4-1106-preview")
        .name("Citation Specialist")
        .description("Provides detailed source attribution and citation management")
        .instructions(
            "You are a citation specialist. Always provide accurate, detailed citations for any information retrieved from documents. Use proper academic citation formats, include page numbers when available, and distinguish between direct quotes and paraphrased content."
        )
        .add_tool(tool_file_search());

    println!(" Created citation specialist assistant:");
    println!("   Focus: Accurate source attribution and citation formatting");

    // Create thread for citation-heavy work
    let _citation_thread = simple_thread()
        .metadata("citation_style", "APA")
        .metadata("requirement", "academic_standards")
        .metadata("verification", "enabled");

    println!("\n Citation Requirements:");
    println!("   Style: APA format");
    println!("   Standards: Academic-level accuracy");
    println!("   Verification: Enabled for all sources");

    println!("\n Citation Query:");
    println!("   'Provide a summary of the key arguments about privacy in AI systems,'");
    println!("   'with detailed citations for each point made.'");

    println!("\n Citation-Focused RAG Workflow:");
    println!("   1.  Search for relevant content across documents");
    println!("   2.  Extract content with precise location data");
    println!("   3.  Generate response with inline citations");
    println!("   4.  Verify citation accuracy and completeness");
    println!("   5.  Format citations according to specified style");
    println!("   6.  Cross-check for citation consistency");

    // Demonstrate different citation formats
    println!("\n Citation Format Examples:");
    println!("    Direct Quote:");
    println!(
        "      \"Privacy-preserving AI requires careful balance between utility and protection\""
    );
    println!("      (Johnson, 2024, p. 15)");
    println!("   ");
    println!("    Paraphrased Content:");
    println!("      Recent research indicates that differential privacy methods show promise");
    println!("      for protecting individual data in ML training (Smith & Lee, 2023).");
    println!("   ");
    println!("    Multiple Source Synthesis:");
    println!("      Several studies have demonstrated the effectiveness of federated learning");
    println!("      approaches (Chen et al., 2023; Rodriguez, 2024; Brown & Wilson, 2023).");

    println!("\n Expected Citation Response:");
    println!("    Structured Summary with Citations:");
    println!("      • Privacy challenges in AI systems (Anderson, 2024, pp. 23-25)");
    println!("      • Technical solutions: differential privacy (Johnson et al., 2023)");
    println!("      • Regulatory considerations (Privacy Commission Report, 2024, §3.2)");
    println!("   ");
    println!("    Reference List:");
    println!(
        "      Anderson, M. (2024). AI Privacy Challenges. Tech Ethics Journal, 15(3), 20-30."
    );
    println!("      Johnson, P., Smith, R., & Lee, K. (2023). Differential privacy in practice.");
    println!("      Privacy Commission. (2024). AI governance guidelines (Report #2024-AI-001).");

    Ok(())
}

/// Example 5: Multi-Document Analysis and Synthesis
fn run_multi_document_analysis_example() -> Result<(), Error> {
    println!("\n Example 5: Multi-Document Analysis and Synthesis");
    println!("{}", "=".repeat(60));

    // Create multi-document analysis assistant
    let _analysis_assistant = assistant_with_instructions(
        "gpt-4-1106-preview",
        "Document Analysis Specialist",
        "You are a document analysis expert. Compare and contrast information across multiple documents, identify contradictions or gaps, synthesize information from diverse sources, and provide comprehensive analysis that considers multiple perspectives."
    )
    .add_tool(tool_file_search());

    println!(" Created document analysis assistant:");
    println!("   Specialty: Cross-document comparison and synthesis");

    // Create comprehensive document store for analysis
    let _analysis_store = VectorStoreBuilder::new()
        .name("Multi-Document Analysis Store")
        .add_file("file-policy-proposal-v1")
        .add_file("file-policy-proposal-v2")
        .add_file("file-stakeholder-feedback-001")
        .add_file("file-legal-review-002")
        .add_file("file-technical-assessment-003")
        .add_file("file-cost-benefit-analysis-004")
        .metadata("analysis_type", "policy_comparison")
        .metadata("documents", "6")
        .metadata("perspectives", "multiple");

    println!("\n Multi-Document Analysis Setup:");
    println!("   Documents: 6 files representing different perspectives");
    println!("   Analysis type: Policy proposal comparison");
    println!("   Perspectives: Technical, legal, financial, stakeholder");

    println!("\n Multi-Document Analysis Query:");
    println!("   'Compare the two policy proposals and analyze how stakeholder feedback'");
    println!("   'has been incorporated. Identify any conflicts between the legal review'");
    println!("   'and technical assessment.'");

    println!("\n Multi-Document RAG Analysis Workflow:");
    println!("   1.  Identify key comparison dimensions");
    println!("   2.  Search each document type systematically");
    println!("   3.  Create comparison matrix across documents");
    println!("   4.  Identify conflicts and contradictions");
    println!("   5.  Find connections and dependencies");
    println!("   6.  Synthesize comprehensive analysis");
    println!("   7.  Provide recommendations based on synthesis");

    // Demonstrate advanced search patterns
    let _comparative_search =
        search_vector_store_with_limit("analysis-store-456", "risk assessment comparison", 15)
            .filter("document_type", "technical,legal")
            .filter("section", "risks");

    println!("\n Advanced Search Pattern:");
    println!("   Query: risk assessment comparison");
    println!("   Target documents: technical + legal reviews");
    println!("   Focus section: risk analysis sections");

    println!("\n Expected Multi-Document Analysis:");
    println!("    Comparative Analysis:");
    println!("      Policy Proposal Comparison:");
    println!("      • V1 focuses on immediate implementation (Technical Assessment)");
    println!("      • V2 incorporates phased approach (Stakeholder Feedback)");
    println!("   ");
    println!("    Identified Conflicts:");
    println!("      • Legal review flags compliance issues with V1 approach");
    println!("      • Technical assessment questions feasibility of V2 timeline");
    println!("      • Cost analysis shows budget misalignment between proposals");
    println!("   ");
    println!("    Stakeholder Integration:");
    println!("      • 73% of feedback incorporated in V2 (Stakeholder Feedback doc)");
    println!("      • Privacy concerns addressed through technical modifications");
    println!("      • Cost concerns partially resolved via phased implementation");
    println!("   ");
    println!("    Synthesis Recommendations:");
    println!("      • Hybrid approach combining V1 technical framework with V2 timeline");
    println!("      • Address legal compliance through additional technical review");
    println!("      • Require budget revision to align with stakeholder expectations");

    Ok(())
}

pub fn name_ref(&self) -> Option<&str>

Get the name of this vector store.

Examples found in repository

examples/vector_stores.rs (line 92)

fn run_basic_vector_store_example() -> Result<(), Error> {
    println!(" Example 1: Basic Vector Store Operations");
    println!("{}", "=".repeat(60));

    // Create a simple vector store
    let basic_store = simple_vector_store("Getting Started Vector Store")
        .metadata("purpose", "tutorial")
        .metadata("created_by", "openai_ergonomic_example");

    println!(" Created basic vector store:");
    println!("   Name: {}", basic_store.name_ref().unwrap());
    println!(
        "   Purpose: {}",
        basic_store.metadata_ref().get("purpose").unwrap()
    );
    println!("   Files: {}", basic_store.file_count());

    // Add files to the vector store
    let store_with_files = basic_store
        .add_file("file-welcome-doc-001")
        .add_file("file-getting-started-002")
        .add_file("file-basic-examples-003");

    println!("\n Added files to vector store:");
    for (i, file_id) in store_with_files.file_ids_ref().iter().enumerate() {
        println!("   {}. {}", i + 1, file_id);
    }
    println!("   Total files: {}", store_with_files.file_count());

    // Demonstrate vector store properties
    println!("\n Vector Store Properties:");
    println!("   Has files: {}", store_with_files.has_files());
    println!(
        "   Metadata entries: {}",
        store_with_files.metadata_ref().len()
    );
    println!(
        "   Expires: {}",
        if store_with_files.expires_after_ref().is_some() {
            "Yes"
        } else {
            "No"
        }
    );

    println!("\n Basic Operations:");
    println!("    Create vector store");
    println!("    Add metadata");
    println!("    Add files");
    println!("    Query properties");
    println!("    Ready for search operations");

    Ok(())
}

/// Example 2: Document Management and Batch Operations
fn run_document_management_example() -> Result<(), Error> {
    println!("\n Example 2: Document Management and Batch Operations");
    println!("{}", "=".repeat(60));

    // Simulate a large document collection
    let document_collection = vec![
        "file-product-docs-001",
        "file-product-docs-002",
        "file-api-reference-003",
        "file-user-guide-004",
        "file-troubleshooting-005",
        "file-changelog-006",
        "file-best-practices-007",
        "file-integration-guide-008",
    ];

    // Create vector store with batch file addition
    let doc_store = vector_store_with_files(
        "Product Documentation Store",
        document_collection.iter().map(|s| s.to_string()).collect(),
    )
    .metadata("category", "documentation")
    .metadata("product", "api_platform")
    .metadata("version", "v2.1")
    .expires_after_days(180); // 6 months retention

    println!(" Created documentation vector store:");
    println!("   Name: {}", doc_store.name_ref().unwrap());
    println!("   Documents: {} files", doc_store.file_count());
    println!(
        "   Category: {}",
        doc_store.metadata_ref().get("category").unwrap()
    );
    println!("   Retention: 180 days");

    // Demonstrate individual file operations
    let individual_file_op = add_file_to_vector_store("doc-store-123", "file-new-feature-009");

    println!("\n Individual File Operations:");
    println!("   Adding file: {}", individual_file_op.file_id());
    println!("   To store: {}", individual_file_op.vector_store_id());

    // Simulate file organization strategies
    println!("\n Document Organization Strategies:");

    let categorized_stores = vec![
        (
            "API Documentation",
            vec!["file-api-ref", "file-endpoints", "file-auth"],
        ),
        (
            "User Guides",
            vec!["file-quickstart", "file-tutorials", "file-howtos"],
        ),
        (
            "Technical Specs",
            vec!["file-architecture", "file-protocols", "file-security"],
        ),
        (
            "Release Notes",
            vec!["file-changelog", "file-migration", "file-breaking-changes"],
        ),
    ];

    for (category, files) in &categorized_stores {
        let category_store = vector_store_with_files(
            format!("{} Vector Store", category),
            files.iter().map(|s| s.to_string()).collect(),
        )
        .metadata("category", category.to_lowercase().replace(" ", "_"))
        .metadata("auto_managed", "true");

        println!("    {}: {} files", category, category_store.file_count());
    }

    println!("\n Document Management Workflow:");
    println!("   1.  Batch upload documents by category");
    println!("   2.  Apply consistent metadata tagging");
    println!("   3. ⏰ Set appropriate retention policies");
    println!("   4.  Enable automatic organization");
    println!("   5.  Monitor storage usage and performance");

    Ok(())
}

/// Example 3: Semantic Search and Similarity Queries
fn run_semantic_search_example() -> Result<(), Error> {
    println!("\n Example 3: Semantic Search and Similarity Queries");
    println!("{}", "=".repeat(60));

    // Create a search-optimized vector store
    let search_store = simple_vector_store("Semantic Search Demo Store")
        .add_file("file-ml-concepts-001")
        .add_file("file-nlp-techniques-002")
        .add_file("file-deep-learning-003")
        .add_file("file-computer-vision-004")
        .add_file("file-ai-ethics-005")
        .metadata("domain", "machine_learning")
        .metadata("search_optimized", "true");

    println!(" Created search-optimized vector store:");
    println!("   Name: {}", search_store.name_ref().unwrap());
    println!("   Domain: Machine Learning");
    println!("   Documents: {} files", search_store.file_count());

    // Demonstrate various search patterns
    println!("\n Search Query Examples:");

    // Basic semantic search
    let basic_search = search_vector_store("search-store-123", "neural network architectures");
    println!("   1. Basic Search:");
    println!("      Query: '{}'", basic_search.query());
    println!("      Store: {}", basic_search.vector_store_id());

    // Limited result search
    let limited_search = search_vector_store_with_limit(
        "search-store-123",
        "natural language processing techniques",
        5,
    );
    println!("   2. Limited Results:");
    println!("      Query: '{}'", limited_search.query());
    println!(
        "      Limit: {} results",
        limited_search.limit_ref().unwrap()
    );

    // Advanced filtered search
    let filtered_search =
        search_vector_store_with_limit("search-store-123", "computer vision applications", 10)
            .filter("category", "practical_applications")
            .filter("difficulty", "intermediate");

    println!("   3. Filtered Search:");
    println!("      Query: '{}'", filtered_search.query());
    println!(
        "      Filters: {} applied",
        filtered_search.filter_ref().len()
    );
    for (key, value) in filtered_search.filter_ref() {
        println!("         {}={}", key, value);
    }

    // Demonstrate search result processing
    println!("\n Search Result Processing:");
    println!("    Semantic similarity ranking");
    println!("    Document excerpt extraction");
    println!("    Relevance score calculation");
    println!("    Source location identification");
    println!("    Related content suggestions");

    // Show different query types
    println!("\n Query Type Examples:");
    let query_examples = vec![
        (
            "Conceptual",
            "What is machine learning?",
            "Broad conceptual understanding",
        ),
        (
            "Technical",
            "How to implement backpropagation?",
            "Specific technical implementation",
        ),
        (
            "Comparative",
            "LSTM vs Transformer architectures",
            "Comparative analysis",
        ),
        (
            "Problem-solving",
            "Overfitting in neural networks",
            "Problem identification and solutions",
        ),
        (
            "Application",
            "Computer vision in healthcare",
            "Domain-specific applications",
        ),
    ];

    for (query_type, query, description) in query_examples {
        println!("    {}: '{}'", query_type, query);
        println!("      Purpose: {}", description);
    }

    Ok(())
}

examples/assistants_file_search.rs (line 93)

fn run_knowledge_base_example() -> Result<(), Error> {
    println!(" Example 1: Building a Knowledge Base Assistant");
    println!("{}", "=".repeat(60));

    // Create a knowledge base vector store
    let knowledge_store = simple_vector_store("Company Knowledge Base")
        .metadata("type", "internal_docs")
        .metadata("department", "engineering")
        .expires_after_days(365); // Expire after 1 year

    println!(" Created knowledge base vector store:");
    println!("   Name: {}", knowledge_store.name_ref().unwrap());
    println!("   Type: Internal documentation");
    println!("   Expiration: 365 days");

    // Simulate adding documents to the knowledge base
    let file_ids = vec![
        "file-api-docs-123".to_string(),
        "file-coding-standards-456".to_string(),
        "file-deployment-guide-789".to_string(),
        "file-troubleshooting-101".to_string(),
    ];

    let populated_store = vector_store_with_files("Engineering Knowledge Base", file_ids.clone());

    println!("\n Knowledge Base Contents:");
    for (i, file_id) in populated_store.file_ids_ref().iter().enumerate() {
        println!("   {}. {}", i + 1, file_id);
    }
    println!("   Total files: {}", populated_store.file_count());

    // Create an assistant with file search capabilities
    let kb_assistant = assistant_with_instructions(
        "gpt-4-1106-preview",
        "Engineering Knowledge Assistant",
        "You are an engineering knowledge assistant. Help developers find relevant information from our internal documentation, coding standards, and deployment guides. Always provide accurate citations and suggest related resources when appropriate."
    )
    .description("Internal knowledge base assistant for engineering teams")
    .add_tool(tool_file_search());

    println!("\n Created knowledge base assistant:");
    println!("   Name: {}", kb_assistant.name_ref().unwrap());
    println!("   Capability: File search through engineering documents");

    println!("\n Example Knowledge Base Query:");
    println!("   'What are our coding standards for API documentation?'");

    println!("\n RAG Workflow for Knowledge Base:");
    println!("   1.  Search vector store for relevant documents");
    println!("   2.  Retrieve matching sections from coding standards");
    println!("   3.  Generate response based on retrieved content");
    println!("   4.  Provide citations to specific documents");
    println!("   5.  Suggest related topics or documents");

    println!("\n Expected Knowledge Base Response:");
    println!("   • Specific coding standards for API documentation");
    println!("   • Citations: 'coding-standards-456.md, section 3.2'");
    println!("   • Examples from deployment guide");
    println!("   • Related resources: troubleshooting guide");

    Ok(())
}

pub fn file_ids_ref(&self) -> &[String]

Get the file IDs for this vector store.

Examples found in repository

examples/vector_stores.rs (line 106)

fn run_basic_vector_store_example() -> Result<(), Error> {
    println!(" Example 1: Basic Vector Store Operations");
    println!("{}", "=".repeat(60));

    // Create a simple vector store
    let basic_store = simple_vector_store("Getting Started Vector Store")
        .metadata("purpose", "tutorial")
        .metadata("created_by", "openai_ergonomic_example");

    println!(" Created basic vector store:");
    println!("   Name: {}", basic_store.name_ref().unwrap());
    println!(
        "   Purpose: {}",
        basic_store.metadata_ref().get("purpose").unwrap()
    );
    println!("   Files: {}", basic_store.file_count());

    // Add files to the vector store
    let store_with_files = basic_store
        .add_file("file-welcome-doc-001")
        .add_file("file-getting-started-002")
        .add_file("file-basic-examples-003");

    println!("\n Added files to vector store:");
    for (i, file_id) in store_with_files.file_ids_ref().iter().enumerate() {
        println!("   {}. {}", i + 1, file_id);
    }
    println!("   Total files: {}", store_with_files.file_count());

    // Demonstrate vector store properties
    println!("\n Vector Store Properties:");
    println!("   Has files: {}", store_with_files.has_files());
    println!(
        "   Metadata entries: {}",
        store_with_files.metadata_ref().len()
    );
    println!(
        "   Expires: {}",
        if store_with_files.expires_after_ref().is_some() {
            "Yes"
        } else {
            "No"
        }
    );

    println!("\n Basic Operations:");
    println!("    Create vector store");
    println!("    Add metadata");
    println!("    Add files");
    println!("    Query properties");
    println!("    Ready for search operations");

    Ok(())
}

examples/assistants_file_search.rs (line 108)

fn run_knowledge_base_example() -> Result<(), Error> {
    println!(" Example 1: Building a Knowledge Base Assistant");
    println!("{}", "=".repeat(60));

    // Create a knowledge base vector store
    let knowledge_store = simple_vector_store("Company Knowledge Base")
        .metadata("type", "internal_docs")
        .metadata("department", "engineering")
        .expires_after_days(365); // Expire after 1 year

    println!(" Created knowledge base vector store:");
    println!("   Name: {}", knowledge_store.name_ref().unwrap());
    println!("   Type: Internal documentation");
    println!("   Expiration: 365 days");

    // Simulate adding documents to the knowledge base
    let file_ids = vec![
        "file-api-docs-123".to_string(),
        "file-coding-standards-456".to_string(),
        "file-deployment-guide-789".to_string(),
        "file-troubleshooting-101".to_string(),
    ];

    let populated_store = vector_store_with_files("Engineering Knowledge Base", file_ids.clone());

    println!("\n Knowledge Base Contents:");
    for (i, file_id) in populated_store.file_ids_ref().iter().enumerate() {
        println!("   {}. {}", i + 1, file_id);
    }
    println!("   Total files: {}", populated_store.file_count());

    // Create an assistant with file search capabilities
    let kb_assistant = assistant_with_instructions(
        "gpt-4-1106-preview",
        "Engineering Knowledge Assistant",
        "You are an engineering knowledge assistant. Help developers find relevant information from our internal documentation, coding standards, and deployment guides. Always provide accurate citations and suggest related resources when appropriate."
    )
    .description("Internal knowledge base assistant for engineering teams")
    .add_tool(tool_file_search());

    println!("\n Created knowledge base assistant:");
    println!("   Name: {}", kb_assistant.name_ref().unwrap());
    println!("   Capability: File search through engineering documents");

    println!("\n Example Knowledge Base Query:");
    println!("   'What are our coding standards for API documentation?'");

    println!("\n RAG Workflow for Knowledge Base:");
    println!("   1.  Search vector store for relevant documents");
    println!("   2.  Retrieve matching sections from coding standards");
    println!("   3.  Generate response based on retrieved content");
    println!("   4.  Provide citations to specific documents");
    println!("   5.  Suggest related topics or documents");

    println!("\n Expected Knowledge Base Response:");
    println!("   • Specific coding standards for API documentation");
    println!("   • Citations: 'coding-standards-456.md, section 3.2'");
    println!("   • Examples from deployment guide");
    println!("   • Related resources: troubleshooting guide");

    Ok(())
}

pub fn expires_after_ref(&self) -> Option<&VectorStoreExpirationPolicy>

Get the expiration policy for this vector store.

Examples found in repository

examples/vector_stores.rs (line 120)

fn run_basic_vector_store_example() -> Result<(), Error> {
    println!(" Example 1: Basic Vector Store Operations");
    println!("{}", "=".repeat(60));

    // Create a simple vector store
    let basic_store = simple_vector_store("Getting Started Vector Store")
        .metadata("purpose", "tutorial")
        .metadata("created_by", "openai_ergonomic_example");

    println!(" Created basic vector store:");
    println!("   Name: {}", basic_store.name_ref().unwrap());
    println!(
        "   Purpose: {}",
        basic_store.metadata_ref().get("purpose").unwrap()
    );
    println!("   Files: {}", basic_store.file_count());

    // Add files to the vector store
    let store_with_files = basic_store
        .add_file("file-welcome-doc-001")
        .add_file("file-getting-started-002")
        .add_file("file-basic-examples-003");

    println!("\n Added files to vector store:");
    for (i, file_id) in store_with_files.file_ids_ref().iter().enumerate() {
        println!("   {}. {}", i + 1, file_id);
    }
    println!("   Total files: {}", store_with_files.file_count());

    // Demonstrate vector store properties
    println!("\n Vector Store Properties:");
    println!("   Has files: {}", store_with_files.has_files());
    println!(
        "   Metadata entries: {}",
        store_with_files.metadata_ref().len()
    );
    println!(
        "   Expires: {}",
        if store_with_files.expires_after_ref().is_some() {
            "Yes"
        } else {
            "No"
        }
    );

    println!("\n Basic Operations:");
    println!("    Create vector store");
    println!("    Add metadata");
    println!("    Add files");
    println!("    Query properties");
    println!("    Ready for search operations");

    Ok(())
}

/// Example 2: Document Management and Batch Operations
fn run_document_management_example() -> Result<(), Error> {
    println!("\n Example 2: Document Management and Batch Operations");
    println!("{}", "=".repeat(60));

    // Simulate a large document collection
    let document_collection = vec![
        "file-product-docs-001",
        "file-product-docs-002",
        "file-api-reference-003",
        "file-user-guide-004",
        "file-troubleshooting-005",
        "file-changelog-006",
        "file-best-practices-007",
        "file-integration-guide-008",
    ];

    // Create vector store with batch file addition
    let doc_store = vector_store_with_files(
        "Product Documentation Store",
        document_collection.iter().map(|s| s.to_string()).collect(),
    )
    .metadata("category", "documentation")
    .metadata("product", "api_platform")
    .metadata("version", "v2.1")
    .expires_after_days(180); // 6 months retention

    println!(" Created documentation vector store:");
    println!("   Name: {}", doc_store.name_ref().unwrap());
    println!("   Documents: {} files", doc_store.file_count());
    println!(
        "   Category: {}",
        doc_store.metadata_ref().get("category").unwrap()
    );
    println!("   Retention: 180 days");

    // Demonstrate individual file operations
    let individual_file_op = add_file_to_vector_store("doc-store-123", "file-new-feature-009");

    println!("\n Individual File Operations:");
    println!("   Adding file: {}", individual_file_op.file_id());
    println!("   To store: {}", individual_file_op.vector_store_id());

    // Simulate file organization strategies
    println!("\n Document Organization Strategies:");

    let categorized_stores = vec![
        (
            "API Documentation",
            vec!["file-api-ref", "file-endpoints", "file-auth"],
        ),
        (
            "User Guides",
            vec!["file-quickstart", "file-tutorials", "file-howtos"],
        ),
        (
            "Technical Specs",
            vec!["file-architecture", "file-protocols", "file-security"],
        ),
        (
            "Release Notes",
            vec!["file-changelog", "file-migration", "file-breaking-changes"],
        ),
    ];

    for (category, files) in &categorized_stores {
        let category_store = vector_store_with_files(
            format!("{} Vector Store", category),
            files.iter().map(|s| s.to_string()).collect(),
        )
        .metadata("category", category.to_lowercase().replace(" ", "_"))
        .metadata("auto_managed", "true");

        println!("    {}: {} files", category, category_store.file_count());
    }

    println!("\n Document Management Workflow:");
    println!("   1.  Batch upload documents by category");
    println!("   2.  Apply consistent metadata tagging");
    println!("   3. ⏰ Set appropriate retention policies");
    println!("   4.  Enable automatic organization");
    println!("   5.  Monitor storage usage and performance");

    Ok(())
}

/// Example 3: Semantic Search and Similarity Queries
fn run_semantic_search_example() -> Result<(), Error> {
    println!("\n Example 3: Semantic Search and Similarity Queries");
    println!("{}", "=".repeat(60));

    // Create a search-optimized vector store
    let search_store = simple_vector_store("Semantic Search Demo Store")
        .add_file("file-ml-concepts-001")
        .add_file("file-nlp-techniques-002")
        .add_file("file-deep-learning-003")
        .add_file("file-computer-vision-004")
        .add_file("file-ai-ethics-005")
        .metadata("domain", "machine_learning")
        .metadata("search_optimized", "true");

    println!(" Created search-optimized vector store:");
    println!("   Name: {}", search_store.name_ref().unwrap());
    println!("   Domain: Machine Learning");
    println!("   Documents: {} files", search_store.file_count());

    // Demonstrate various search patterns
    println!("\n Search Query Examples:");

    // Basic semantic search
    let basic_search = search_vector_store("search-store-123", "neural network architectures");
    println!("   1. Basic Search:");
    println!("      Query: '{}'", basic_search.query());
    println!("      Store: {}", basic_search.vector_store_id());

    // Limited result search
    let limited_search = search_vector_store_with_limit(
        "search-store-123",
        "natural language processing techniques",
        5,
    );
    println!("   2. Limited Results:");
    println!("      Query: '{}'", limited_search.query());
    println!(
        "      Limit: {} results",
        limited_search.limit_ref().unwrap()
    );

    // Advanced filtered search
    let filtered_search =
        search_vector_store_with_limit("search-store-123", "computer vision applications", 10)
            .filter("category", "practical_applications")
            .filter("difficulty", "intermediate");

    println!("   3. Filtered Search:");
    println!("      Query: '{}'", filtered_search.query());
    println!(
        "      Filters: {} applied",
        filtered_search.filter_ref().len()
    );
    for (key, value) in filtered_search.filter_ref() {
        println!("         {}={}", key, value);
    }

    // Demonstrate search result processing
    println!("\n Search Result Processing:");
    println!("    Semantic similarity ranking");
    println!("    Document excerpt extraction");
    println!("    Relevance score calculation");
    println!("    Source location identification");
    println!("    Related content suggestions");

    // Show different query types
    println!("\n Query Type Examples:");
    let query_examples = vec![
        (
            "Conceptual",
            "What is machine learning?",
            "Broad conceptual understanding",
        ),
        (
            "Technical",
            "How to implement backpropagation?",
            "Specific technical implementation",
        ),
        (
            "Comparative",
            "LSTM vs Transformer architectures",
            "Comparative analysis",
        ),
        (
            "Problem-solving",
            "Overfitting in neural networks",
            "Problem identification and solutions",
        ),
        (
            "Application",
            "Computer vision in healthcare",
            "Domain-specific applications",
        ),
    ];

    for (query_type, query, description) in query_examples {
        println!("    {}: '{}'", query_type, query);
        println!("      Purpose: {}", description);
    }

    Ok(())
}

/// Example 4: Enterprise Knowledge Base
fn run_enterprise_knowledge_base_example() -> Result<(), Error> {
    println!("\n Example 4: Enterprise Knowledge Base");
    println!("{}", "=".repeat(60));

    // Create enterprise-scale vector stores
    let enterprise_stores = create_enterprise_knowledge_base()?;

    println!(" Enterprise Knowledge Base Architecture:");
    for (department, store) in enterprise_stores {
        println!("    {}", department);
        println!("      Files: {} documents", store.file_count());
        println!(
            "      Retention: {} days",
            store
                .expires_after_ref()
                .map_or("permanent".to_string(), |exp| exp.days.to_string())
                .as_str()
        );

        // Show metadata structure
        for (key, value) in store.metadata_ref() {
            println!("      {}: {}", key, value);
        }
        println!();
    }

    // Demonstrate cross-departmental search
    println!(" Cross-Departmental Search Examples:");

    let cross_searches = vec![
        (
            "Security Compliance",
            "GDPR data handling procedures",
            vec!["legal", "engineering", "hr"],
        ),
        (
            "Product Launch",
            "Q4 release planning and coordination",
            vec!["product", "engineering", "marketing"],
        ),
        (
            "Budget Planning",
            "Annual technology investment strategy",
            vec!["finance", "engineering", "executive"],
        ),
        (
            "Process Improvement",
            "Remote work productivity guidelines",
            vec!["hr", "operations", "it"],
        ),
    ];

    for (topic, query, departments) in cross_searches {
        println!("    {}: '{}'", topic, query);
        println!("      Search scope: {}", departments.join(", "));
    }

    println!("\n Enterprise Features:");
    println!("    Role-based access control");
    println!("    Usage analytics and monitoring");
    println!("    Automated content lifecycle management");
    println!("    Search performance optimization");
    println!("    Backup and disaster recovery");
    println!("    Compliance and audit trails");

    Ok(())
}

pub fn metadata_ref(&self) -> &HashMap<String, String>

Get the metadata for this vector store.

Examples found in repository

examples/vector_stores.rs (line 95)

fn run_basic_vector_store_example() -> Result<(), Error> {
    println!(" Example 1: Basic Vector Store Operations");
    println!("{}", "=".repeat(60));

    // Create a simple vector store
    let basic_store = simple_vector_store("Getting Started Vector Store")
        .metadata("purpose", "tutorial")
        .metadata("created_by", "openai_ergonomic_example");

    println!(" Created basic vector store:");
    println!("   Name: {}", basic_store.name_ref().unwrap());
    println!(
        "   Purpose: {}",
        basic_store.metadata_ref().get("purpose").unwrap()
    );
    println!("   Files: {}", basic_store.file_count());

    // Add files to the vector store
    let store_with_files = basic_store
        .add_file("file-welcome-doc-001")
        .add_file("file-getting-started-002")
        .add_file("file-basic-examples-003");

    println!("\n Added files to vector store:");
    for (i, file_id) in store_with_files.file_ids_ref().iter().enumerate() {
        println!("   {}. {}", i + 1, file_id);
    }
    println!("   Total files: {}", store_with_files.file_count());

    // Demonstrate vector store properties
    println!("\n Vector Store Properties:");
    println!("   Has files: {}", store_with_files.has_files());
    println!(
        "   Metadata entries: {}",
        store_with_files.metadata_ref().len()
    );
    println!(
        "   Expires: {}",
        if store_with_files.expires_after_ref().is_some() {
            "Yes"
        } else {
            "No"
        }
    );

    println!("\n Basic Operations:");
    println!("    Create vector store");
    println!("    Add metadata");
    println!("    Add files");
    println!("    Query properties");
    println!("    Ready for search operations");

    Ok(())
}

/// Example 2: Document Management and Batch Operations
fn run_document_management_example() -> Result<(), Error> {
    println!("\n Example 2: Document Management and Batch Operations");
    println!("{}", "=".repeat(60));

    // Simulate a large document collection
    let document_collection = vec![
        "file-product-docs-001",
        "file-product-docs-002",
        "file-api-reference-003",
        "file-user-guide-004",
        "file-troubleshooting-005",
        "file-changelog-006",
        "file-best-practices-007",
        "file-integration-guide-008",
    ];

    // Create vector store with batch file addition
    let doc_store = vector_store_with_files(
        "Product Documentation Store",
        document_collection.iter().map(|s| s.to_string()).collect(),
    )
    .metadata("category", "documentation")
    .metadata("product", "api_platform")
    .metadata("version", "v2.1")
    .expires_after_days(180); // 6 months retention

    println!(" Created documentation vector store:");
    println!("   Name: {}", doc_store.name_ref().unwrap());
    println!("   Documents: {} files", doc_store.file_count());
    println!(
        "   Category: {}",
        doc_store.metadata_ref().get("category").unwrap()
    );
    println!("   Retention: 180 days");

    // Demonstrate individual file operations
    let individual_file_op = add_file_to_vector_store("doc-store-123", "file-new-feature-009");

    println!("\n Individual File Operations:");
    println!("   Adding file: {}", individual_file_op.file_id());
    println!("   To store: {}", individual_file_op.vector_store_id());

    // Simulate file organization strategies
    println!("\n Document Organization Strategies:");

    let categorized_stores = vec![
        (
            "API Documentation",
            vec!["file-api-ref", "file-endpoints", "file-auth"],
        ),
        (
            "User Guides",
            vec!["file-quickstart", "file-tutorials", "file-howtos"],
        ),
        (
            "Technical Specs",
            vec!["file-architecture", "file-protocols", "file-security"],
        ),
        (
            "Release Notes",
            vec!["file-changelog", "file-migration", "file-breaking-changes"],
        ),
    ];

    for (category, files) in &categorized_stores {
        let category_store = vector_store_with_files(
            format!("{} Vector Store", category),
            files.iter().map(|s| s.to_string()).collect(),
        )
        .metadata("category", category.to_lowercase().replace(" ", "_"))
        .metadata("auto_managed", "true");

        println!("    {}: {} files", category, category_store.file_count());
    }

    println!("\n Document Management Workflow:");
    println!("   1.  Batch upload documents by category");
    println!("   2.  Apply consistent metadata tagging");
    println!("   3. ⏰ Set appropriate retention policies");
    println!("   4.  Enable automatic organization");
    println!("   5.  Monitor storage usage and performance");

    Ok(())
}

/// Example 3: Semantic Search and Similarity Queries
fn run_semantic_search_example() -> Result<(), Error> {
    println!("\n Example 3: Semantic Search and Similarity Queries");
    println!("{}", "=".repeat(60));

    // Create a search-optimized vector store
    let search_store = simple_vector_store("Semantic Search Demo Store")
        .add_file("file-ml-concepts-001")
        .add_file("file-nlp-techniques-002")
        .add_file("file-deep-learning-003")
        .add_file("file-computer-vision-004")
        .add_file("file-ai-ethics-005")
        .metadata("domain", "machine_learning")
        .metadata("search_optimized", "true");

    println!(" Created search-optimized vector store:");
    println!("   Name: {}", search_store.name_ref().unwrap());
    println!("   Domain: Machine Learning");
    println!("   Documents: {} files", search_store.file_count());

    // Demonstrate various search patterns
    println!("\n Search Query Examples:");

    // Basic semantic search
    let basic_search = search_vector_store("search-store-123", "neural network architectures");
    println!("   1. Basic Search:");
    println!("      Query: '{}'", basic_search.query());
    println!("      Store: {}", basic_search.vector_store_id());

    // Limited result search
    let limited_search = search_vector_store_with_limit(
        "search-store-123",
        "natural language processing techniques",
        5,
    );
    println!("   2. Limited Results:");
    println!("      Query: '{}'", limited_search.query());
    println!(
        "      Limit: {} results",
        limited_search.limit_ref().unwrap()
    );

    // Advanced filtered search
    let filtered_search =
        search_vector_store_with_limit("search-store-123", "computer vision applications", 10)
            .filter("category", "practical_applications")
            .filter("difficulty", "intermediate");

    println!("   3. Filtered Search:");
    println!("      Query: '{}'", filtered_search.query());
    println!(
        "      Filters: {} applied",
        filtered_search.filter_ref().len()
    );
    for (key, value) in filtered_search.filter_ref() {
        println!("         {}={}", key, value);
    }

    // Demonstrate search result processing
    println!("\n Search Result Processing:");
    println!("    Semantic similarity ranking");
    println!("    Document excerpt extraction");
    println!("    Relevance score calculation");
    println!("    Source location identification");
    println!("    Related content suggestions");

    // Show different query types
    println!("\n Query Type Examples:");
    let query_examples = vec![
        (
            "Conceptual",
            "What is machine learning?",
            "Broad conceptual understanding",
        ),
        (
            "Technical",
            "How to implement backpropagation?",
            "Specific technical implementation",
        ),
        (
            "Comparative",
            "LSTM vs Transformer architectures",
            "Comparative analysis",
        ),
        (
            "Problem-solving",
            "Overfitting in neural networks",
            "Problem identification and solutions",
        ),
        (
            "Application",
            "Computer vision in healthcare",
            "Domain-specific applications",
        ),
    ];

    for (query_type, query, description) in query_examples {
        println!("    {}: '{}'", query_type, query);
        println!("      Purpose: {}", description);
    }

    Ok(())
}

/// Example 4: Enterprise Knowledge Base
fn run_enterprise_knowledge_base_example() -> Result<(), Error> {
    println!("\n Example 4: Enterprise Knowledge Base");
    println!("{}", "=".repeat(60));

    // Create enterprise-scale vector stores
    let enterprise_stores = create_enterprise_knowledge_base()?;

    println!(" Enterprise Knowledge Base Architecture:");
    for (department, store) in enterprise_stores {
        println!("    {}", department);
        println!("      Files: {} documents", store.file_count());
        println!(
            "      Retention: {} days",
            store
                .expires_after_ref()
                .map_or("permanent".to_string(), |exp| exp.days.to_string())
                .as_str()
        );

        // Show metadata structure
        for (key, value) in store.metadata_ref() {
            println!("      {}: {}", key, value);
        }
        println!();
    }

    // Demonstrate cross-departmental search
    println!(" Cross-Departmental Search Examples:");

    let cross_searches = vec![
        (
            "Security Compliance",
            "GDPR data handling procedures",
            vec!["legal", "engineering", "hr"],
        ),
        (
            "Product Launch",
            "Q4 release planning and coordination",
            vec!["product", "engineering", "marketing"],
        ),
        (
            "Budget Planning",
            "Annual technology investment strategy",
            vec!["finance", "engineering", "executive"],
        ),
        (
            "Process Improvement",
            "Remote work productivity guidelines",
            vec!["hr", "operations", "it"],
        ),
    ];

    for (topic, query, departments) in cross_searches {
        println!("    {}: '{}'", topic, query);
        println!("      Search scope: {}", departments.join(", "));
    }

    println!("\n Enterprise Features:");
    println!("    Role-based access control");
    println!("    Usage analytics and monitoring");
    println!("    Automated content lifecycle management");
    println!("    Search performance optimization");
    println!("    Backup and disaster recovery");
    println!("    Compliance and audit trails");

    Ok(())
}

pub fn has_files(&self) -> bool

Check if the vector store has any files.

Examples found in repository

examples/vector_stores.rs (line 113)

fn run_basic_vector_store_example() -> Result<(), Error> {
    println!(" Example 1: Basic Vector Store Operations");
    println!("{}", "=".repeat(60));

    // Create a simple vector store
    let basic_store = simple_vector_store("Getting Started Vector Store")
        .metadata("purpose", "tutorial")
        .metadata("created_by", "openai_ergonomic_example");

    println!(" Created basic vector store:");
    println!("   Name: {}", basic_store.name_ref().unwrap());
    println!(
        "   Purpose: {}",
        basic_store.metadata_ref().get("purpose").unwrap()
    );
    println!("   Files: {}", basic_store.file_count());

    // Add files to the vector store
    let store_with_files = basic_store
        .add_file("file-welcome-doc-001")
        .add_file("file-getting-started-002")
        .add_file("file-basic-examples-003");

    println!("\n Added files to vector store:");
    for (i, file_id) in store_with_files.file_ids_ref().iter().enumerate() {
        println!("   {}. {}", i + 1, file_id);
    }
    println!("   Total files: {}", store_with_files.file_count());

    // Demonstrate vector store properties
    println!("\n Vector Store Properties:");
    println!("   Has files: {}", store_with_files.has_files());
    println!(
        "   Metadata entries: {}",
        store_with_files.metadata_ref().len()
    );
    println!(
        "   Expires: {}",
        if store_with_files.expires_after_ref().is_some() {
            "Yes"
        } else {
            "No"
        }
    );

    println!("\n Basic Operations:");
    println!("    Create vector store");
    println!("    Add metadata");
    println!("    Add files");
    println!("    Query properties");
    println!("    Ready for search operations");

    Ok(())
}

pub fn file_count(&self) -> usize

Get the number of files in the vector store.

Examples found in repository

examples/vector_stores.rs (line 97)

fn run_basic_vector_store_example() -> Result<(), Error> {
    println!(" Example 1: Basic Vector Store Operations");
    println!("{}", "=".repeat(60));

    // Create a simple vector store
    let basic_store = simple_vector_store("Getting Started Vector Store")
        .metadata("purpose", "tutorial")
        .metadata("created_by", "openai_ergonomic_example");

    println!(" Created basic vector store:");
    println!("   Name: {}", basic_store.name_ref().unwrap());
    println!(
        "   Purpose: {}",
        basic_store.metadata_ref().get("purpose").unwrap()
    );
    println!("   Files: {}", basic_store.file_count());

    // Add files to the vector store
    let store_with_files = basic_store
        .add_file("file-welcome-doc-001")
        .add_file("file-getting-started-002")
        .add_file("file-basic-examples-003");

    println!("\n Added files to vector store:");
    for (i, file_id) in store_with_files.file_ids_ref().iter().enumerate() {
        println!("   {}. {}", i + 1, file_id);
    }
    println!("   Total files: {}", store_with_files.file_count());

    // Demonstrate vector store properties
    println!("\n Vector Store Properties:");
    println!("   Has files: {}", store_with_files.has_files());
    println!(
        "   Metadata entries: {}",
        store_with_files.metadata_ref().len()
    );
    println!(
        "   Expires: {}",
        if store_with_files.expires_after_ref().is_some() {
            "Yes"
        } else {
            "No"
        }
    );

    println!("\n Basic Operations:");
    println!("    Create vector store");
    println!("    Add metadata");
    println!("    Add files");
    println!("    Query properties");
    println!("    Ready for search operations");

    Ok(())
}

/// Example 2: Document Management and Batch Operations
fn run_document_management_example() -> Result<(), Error> {
    println!("\n Example 2: Document Management and Batch Operations");
    println!("{}", "=".repeat(60));

    // Simulate a large document collection
    let document_collection = vec![
        "file-product-docs-001",
        "file-product-docs-002",
        "file-api-reference-003",
        "file-user-guide-004",
        "file-troubleshooting-005",
        "file-changelog-006",
        "file-best-practices-007",
        "file-integration-guide-008",
    ];

    // Create vector store with batch file addition
    let doc_store = vector_store_with_files(
        "Product Documentation Store",
        document_collection.iter().map(|s| s.to_string()).collect(),
    )
    .metadata("category", "documentation")
    .metadata("product", "api_platform")
    .metadata("version", "v2.1")
    .expires_after_days(180); // 6 months retention

    println!(" Created documentation vector store:");
    println!("   Name: {}", doc_store.name_ref().unwrap());
    println!("   Documents: {} files", doc_store.file_count());
    println!(
        "   Category: {}",
        doc_store.metadata_ref().get("category").unwrap()
    );
    println!("   Retention: 180 days");

    // Demonstrate individual file operations
    let individual_file_op = add_file_to_vector_store("doc-store-123", "file-new-feature-009");

    println!("\n Individual File Operations:");
    println!("   Adding file: {}", individual_file_op.file_id());
    println!("   To store: {}", individual_file_op.vector_store_id());

    // Simulate file organization strategies
    println!("\n Document Organization Strategies:");

    let categorized_stores = vec![
        (
            "API Documentation",
            vec!["file-api-ref", "file-endpoints", "file-auth"],
        ),
        (
            "User Guides",
            vec!["file-quickstart", "file-tutorials", "file-howtos"],
        ),
        (
            "Technical Specs",
            vec!["file-architecture", "file-protocols", "file-security"],
        ),
        (
            "Release Notes",
            vec!["file-changelog", "file-migration", "file-breaking-changes"],
        ),
    ];

    for (category, files) in &categorized_stores {
        let category_store = vector_store_with_files(
            format!("{} Vector Store", category),
            files.iter().map(|s| s.to_string()).collect(),
        )
        .metadata("category", category.to_lowercase().replace(" ", "_"))
        .metadata("auto_managed", "true");

        println!("    {}: {} files", category, category_store.file_count());
    }

    println!("\n Document Management Workflow:");
    println!("   1.  Batch upload documents by category");
    println!("   2.  Apply consistent metadata tagging");
    println!("   3. ⏰ Set appropriate retention policies");
    println!("   4.  Enable automatic organization");
    println!("   5.  Monitor storage usage and performance");

    Ok(())
}

/// Example 3: Semantic Search and Similarity Queries
fn run_semantic_search_example() -> Result<(), Error> {
    println!("\n Example 3: Semantic Search and Similarity Queries");
    println!("{}", "=".repeat(60));

    // Create a search-optimized vector store
    let search_store = simple_vector_store("Semantic Search Demo Store")
        .add_file("file-ml-concepts-001")
        .add_file("file-nlp-techniques-002")
        .add_file("file-deep-learning-003")
        .add_file("file-computer-vision-004")
        .add_file("file-ai-ethics-005")
        .metadata("domain", "machine_learning")
        .metadata("search_optimized", "true");

    println!(" Created search-optimized vector store:");
    println!("   Name: {}", search_store.name_ref().unwrap());
    println!("   Domain: Machine Learning");
    println!("   Documents: {} files", search_store.file_count());

    // Demonstrate various search patterns
    println!("\n Search Query Examples:");

    // Basic semantic search
    let basic_search = search_vector_store("search-store-123", "neural network architectures");
    println!("   1. Basic Search:");
    println!("      Query: '{}'", basic_search.query());
    println!("      Store: {}", basic_search.vector_store_id());

    // Limited result search
    let limited_search = search_vector_store_with_limit(
        "search-store-123",
        "natural language processing techniques",
        5,
    );
    println!("   2. Limited Results:");
    println!("      Query: '{}'", limited_search.query());
    println!(
        "      Limit: {} results",
        limited_search.limit_ref().unwrap()
    );

    // Advanced filtered search
    let filtered_search =
        search_vector_store_with_limit("search-store-123", "computer vision applications", 10)
            .filter("category", "practical_applications")
            .filter("difficulty", "intermediate");

    println!("   3. Filtered Search:");
    println!("      Query: '{}'", filtered_search.query());
    println!(
        "      Filters: {} applied",
        filtered_search.filter_ref().len()
    );
    for (key, value) in filtered_search.filter_ref() {
        println!("         {}={}", key, value);
    }

    // Demonstrate search result processing
    println!("\n Search Result Processing:");
    println!("    Semantic similarity ranking");
    println!("    Document excerpt extraction");
    println!("    Relevance score calculation");
    println!("    Source location identification");
    println!("    Related content suggestions");

    // Show different query types
    println!("\n Query Type Examples:");
    let query_examples = vec![
        (
            "Conceptual",
            "What is machine learning?",
            "Broad conceptual understanding",
        ),
        (
            "Technical",
            "How to implement backpropagation?",
            "Specific technical implementation",
        ),
        (
            "Comparative",
            "LSTM vs Transformer architectures",
            "Comparative analysis",
        ),
        (
            "Problem-solving",
            "Overfitting in neural networks",
            "Problem identification and solutions",
        ),
        (
            "Application",
            "Computer vision in healthcare",
            "Domain-specific applications",
        ),
    ];

    for (query_type, query, description) in query_examples {
        println!("    {}: '{}'", query_type, query);
        println!("      Purpose: {}", description);
    }

    Ok(())
}

/// Example 4: Enterprise Knowledge Base
fn run_enterprise_knowledge_base_example() -> Result<(), Error> {
    println!("\n Example 4: Enterprise Knowledge Base");
    println!("{}", "=".repeat(60));

    // Create enterprise-scale vector stores
    let enterprise_stores = create_enterprise_knowledge_base()?;

    println!(" Enterprise Knowledge Base Architecture:");
    for (department, store) in enterprise_stores {
        println!("    {}", department);
        println!("      Files: {} documents", store.file_count());
        println!(
            "      Retention: {} days",
            store
                .expires_after_ref()
                .map_or("permanent".to_string(), |exp| exp.days.to_string())
                .as_str()
        );

        // Show metadata structure
        for (key, value) in store.metadata_ref() {
            println!("      {}: {}", key, value);
        }
        println!();
    }

    // Demonstrate cross-departmental search
    println!(" Cross-Departmental Search Examples:");

    let cross_searches = vec![
        (
            "Security Compliance",
            "GDPR data handling procedures",
            vec!["legal", "engineering", "hr"],
        ),
        (
            "Product Launch",
            "Q4 release planning and coordination",
            vec!["product", "engineering", "marketing"],
        ),
        (
            "Budget Planning",
            "Annual technology investment strategy",
            vec!["finance", "engineering", "executive"],
        ),
        (
            "Process Improvement",
            "Remote work productivity guidelines",
            vec!["hr", "operations", "it"],
        ),
    ];

    for (topic, query, departments) in cross_searches {
        println!("    {}: '{}'", topic, query);
        println!("      Search scope: {}", departments.join(", "));
    }

    println!("\n Enterprise Features:");
    println!("    Role-based access control");
    println!("    Usage analytics and monitoring");
    println!("    Automated content lifecycle management");
    println!("    Search performance optimization");
    println!("    Backup and disaster recovery");
    println!("    Compliance and audit trails");

    Ok(())
}

/// Example 5: Vector Store Lifecycle Management
fn run_vector_store_lifecycle_example() -> Result<(), Error> {
    println!("\n Example 5: Vector Store Lifecycle Management");
    println!("{}", "=".repeat(60));

    // Demonstrate different lifecycle patterns
    println!("⏰ Vector Store Lifecycle Patterns:");

    // Temporary stores for sessions
    let session_store = temporary_vector_store("User Session Store", 1)
        .add_file("file-session-context-001")
        .metadata("session_id", "sess_12345")
        .metadata("user_id", "user_67890");

    println!("    Session-based (1 day):");
    println!("      Purpose: Temporary user context");
    println!("      Files: {}", session_store.file_count());
    println!("      Auto-cleanup: ");

    // Project stores
    let project_store = temporary_vector_store("Project Alpha Documentation", 90)
        .add_file("file-project-spec-001")
        .add_file("file-meeting-notes-002")
        .add_file("file-progress-reports-003")
        .metadata("project_id", "proj_alpha_2024")
        .metadata("phase", "development");

    println!("    Project-based (90 days):");
    println!("      Purpose: Project lifecycle documentation");
    println!("      Files: {}", project_store.file_count());
    println!("      Cleanup: After project completion");

    // Long-term knowledge stores
    let knowledge_store = simple_vector_store("Institutional Knowledge Base")
        .add_file("file-company-history-001")
        .add_file("file-best-practices-002")
        .add_file("file-lessons-learned-003")
        .metadata("retention", "permanent")
        .metadata("backup", "enabled")
        .metadata("compliance", "required");

    println!("    Institutional (permanent):");
    println!("      Purpose: Long-term organizational knowledge");
    println!("      Files: {}", knowledge_store.file_count());
    println!("      Cleanup: Manual review only");

    // Demonstrate lifecycle events
    println!("\n Lifecycle Event Handling:");
    println!("    Creation: Automatic indexing and optimization");
    println!("    Updates: Incremental re-indexing of modified files");
    println!("    Monitoring: Usage tracking and performance metrics");
    println!("    Warnings: Expiration notifications and alerts");
    println!("    Cleanup: Automatic or manual deletion processes");
    println!("    Archival: Long-term storage for compliance");

    // Show cost optimization strategies
    println!("\n Cost Optimization Strategies:");
    println!("    Smart expiration policies based on usage");
    println!("    Analytics-driven storage optimization");
    println!("    Automatic compression for archived content");
    println!("    Tiered storage (hot, warm, cold)");
    println!("    Usage-based scaling recommendations");

    Ok(())
}

/// Example 6: Advanced Search Patterns and Optimization
fn run_advanced_search_patterns_example() -> Result<(), Error> {
    println!("\n Example 6: Advanced Search Patterns and Optimization");
    println!("{}", "=".repeat(60));

    // Create optimized search store
    let optimized_store = VectorStoreBuilder::new()
        .name("Advanced Search Optimization Store")
        .add_file("file-technical-docs-001")
        .add_file("file-user-feedback-002")
        .add_file("file-performance-data-003")
        .add_file("file-best-practices-004")
        .metadata("search_optimized", "true")
        .metadata("indexing", "enhanced")
        .metadata("caching", "enabled");

    println!(" Created advanced search store:");
    println!("   Optimization: Enhanced indexing");
    println!("   Caching: Enabled");
    println!("   Files: {} documents", optimized_store.file_count());

    // Demonstrate advanced search patterns
    println!("\n Advanced Search Patterns:");

    // Multi-stage search
    println!("   1.  Multi-stage Search:");
    println!("      Stage 1: Broad semantic search (100 results)");
    println!("      Stage 2: Filtered refinement (20 results)");
    println!("      Stage 3: Relevance re-ranking (5 top results)");

    let multi_stage_search =
        VectorStoreSearchBuilder::new("advanced-store-789", "machine learning best practices")
            .limit(100)
            .filter("category", "best_practices")
            .filter("verified", "true");

    println!("      Query: '{}'", multi_stage_search.query());
    println!(
        "      Initial limit: {}",
        multi_stage_search.limit_ref().unwrap()
    );

    // Contextual search
    println!("   2.  Contextual Search:");
    println!("      Context: User role, project phase, domain expertise");
    println!("      Adaptation: Results tailored to user context");

    let _contextual_search =
        search_vector_store_with_limit("advanced-store-789", "deployment strategies", 15)
            .filter("audience", "senior_engineer")
            .filter("complexity", "advanced")
            .filter("domain", "cloud_infrastructure");

    println!("      Audience: senior_engineer");
    println!("      Complexity: advanced");
    println!("      Domain: cloud_infrastructure");

    // Hybrid search approaches
    println!("   3.  Hybrid Search Approaches:");
    println!("      Semantic similarity + keyword matching");
    println!("      Vector search + traditional full-text search");
    println!("      AI-enhanced query understanding");

    // Search performance optimization
    println!("\n Search Performance Optimization:");
    println!("    Query optimization and caching");
    println!("    Result pre-computation for common queries");
    println!("    Incremental index updates");
    println!("    Load balancing across vector stores");
    println!("    Machine learning-based relevance tuning");

    // Quality metrics and monitoring
    println!("\n Search Quality Metrics:");
    println!("    Relevance scores and user feedback");
    println!("   ⏱ Query response time analysis");
    println!("    Search success rate tracking");
    println!("    Usage pattern analysis");
    println!("    Continuous improvement recommendations");

    Ok(())
}

examples/assistants_file_search.rs (line 111)

fn run_knowledge_base_example() -> Result<(), Error> {
    println!(" Example 1: Building a Knowledge Base Assistant");
    println!("{}", "=".repeat(60));

    // Create a knowledge base vector store
    let knowledge_store = simple_vector_store("Company Knowledge Base")
        .metadata("type", "internal_docs")
        .metadata("department", "engineering")
        .expires_after_days(365); // Expire after 1 year

    println!(" Created knowledge base vector store:");
    println!("   Name: {}", knowledge_store.name_ref().unwrap());
    println!("   Type: Internal documentation");
    println!("   Expiration: 365 days");

    // Simulate adding documents to the knowledge base
    let file_ids = vec![
        "file-api-docs-123".to_string(),
        "file-coding-standards-456".to_string(),
        "file-deployment-guide-789".to_string(),
        "file-troubleshooting-101".to_string(),
    ];

    let populated_store = vector_store_with_files("Engineering Knowledge Base", file_ids.clone());

    println!("\n Knowledge Base Contents:");
    for (i, file_id) in populated_store.file_ids_ref().iter().enumerate() {
        println!("   {}. {}", i + 1, file_id);
    }
    println!("   Total files: {}", populated_store.file_count());

    // Create an assistant with file search capabilities
    let kb_assistant = assistant_with_instructions(
        "gpt-4-1106-preview",
        "Engineering Knowledge Assistant",
        "You are an engineering knowledge assistant. Help developers find relevant information from our internal documentation, coding standards, and deployment guides. Always provide accurate citations and suggest related resources when appropriate."
    )
    .description("Internal knowledge base assistant for engineering teams")
    .add_tool(tool_file_search());

    println!("\n Created knowledge base assistant:");
    println!("   Name: {}", kb_assistant.name_ref().unwrap());
    println!("   Capability: File search through engineering documents");

    println!("\n Example Knowledge Base Query:");
    println!("   'What are our coding standards for API documentation?'");

    println!("\n RAG Workflow for Knowledge Base:");
    println!("   1.  Search vector store for relevant documents");
    println!("   2.  Retrieve matching sections from coding standards");
    println!("   3.  Generate response based on retrieved content");
    println!("   4.  Provide citations to specific documents");
    println!("   5.  Suggest related topics or documents");

    println!("\n Expected Knowledge Base Response:");
    println!("   • Specific coding standards for API documentation");
    println!("   • Citations: 'coding-standards-456.md, section 3.2'");
    println!("   • Examples from deployment guide");
    println!("   • Related resources: troubleshooting guide");

    Ok(())
}

/// Example 2: Document Q&A Assistant
fn run_document_qa_example() -> Result<(), Error> {
    println!("\n Example 2: Document Q&A Assistant");
    println!("{}", "=".repeat(60));

    // Create specialized document Q&A assistant
    let _qa_assistant = AssistantBuilder::new("gpt-4-1106-preview")
        .name("Document Q&A Specialist")
        .description("Answers questions based on uploaded documents with high accuracy")
        .instructions(
            "You are a document Q&A specialist. Answer questions by searching through the provided documents. Always cite your sources, indicate confidence levels, and acknowledge when information is not available in the documents."
        )
        .add_tool(tool_file_search());

    println!(" Created Document Q&A assistant:");
    println!("   Specialty: Precise question answering from documents");

    // Create a temporary vector store for this Q&A session
    let qa_store = temporary_vector_store("Q&A Session Store", 7) // Expires in 7 days
        .add_file("file-research-paper-001")
        .add_file("file-user-manual-002")
        .add_file("file-technical-spec-003")
        .metadata("session_id", "qa-session-123")
        .metadata("user", "researcher-001");

    println!("\n Q&A Document Store:");
    println!("   Files: {} documents loaded", qa_store.file_count());
    println!("   Expiration: 7 days (temporary session)");
    println!("   Session ID: qa-session-123");

    println!("\n Example Q&A Queries:");
    let queries = vec![
        "What is the maximum throughput mentioned in the technical specifications?",
        "How do I configure the authentication system according to the user manual?",
        "What are the key findings from the research paper regarding performance?",
        "Are there any known limitations discussed in these documents?",
    ];

    for (i, query) in queries.iter().enumerate() {
        println!("   {}. {}", i + 1, query);
    }

    println!("\n Document Q&A RAG Workflow:");
    println!("   1.  Process user question");
    println!("   2.  Generate search queries for vector store");
    println!("   3.  Retrieve relevant document sections");
    println!("   4.  Rank and filter results by relevance");
    println!("   5.  Generate answer from retrieved context");
    println!("   6.  Add citations and confidence indicators");

    println!("\n Expected Q&A Response Format:");
    println!("    Direct answer to the question");
    println!("    Citations: [technical-spec-003.pdf, page 15]");
    println!("    Confidence: High (90%)");
    println!("    Related information: See also user-manual-002.pdf, section 4.3");
    println!("     Limitations: No information found about edge cases");

    Ok(())
}

Trait Implementations

impl Clone for VectorStoreBuilder

fn clone(&self) -> VectorStoreBuilder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for VectorStoreBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for VectorStoreBuilder

fn default() -> Self

Returns the “default value” for a type.