shield_lock
JinDaGe
← Back to skills
extension
Category: Content & MediaNo API key required

Embedding Models

Comprehensive guide for text embedding models and usage. This skill covers

personAuthor: jakexiaohubgithub
open_in_newRepositorydownloadDownload package

Embedding Models

Skill Profile

(Select at least one profile to enable specific modules)

  • [ ] DevOps
  • [x] Backend
  • [ ] Frontend
  • [ ] AI-RAG
  • [ ] Security Critical

Overview

Comprehensive guide for text embedding models and usage. This skill covers embedding concepts (dense vectors, semantic similarity, distance metrics), popular models (OpenAI, Sentence Transformers, Cohere, BGE), model selection criteria, embedding generation (batch processing, caching), dimensionality reduction (PCA, t-SNE), fine-tuning, evaluation metrics (precision, recall, F1), storage strategies (numpy, pickle, HDF5), production optimization, and use cases (semantic search, clustering, classification).

Why This Matters

Embedding models are fundamental to modern AI applications because:

  • Semantic Understanding: Capture meaning beyond keyword matching
  • Vector Search: Enable efficient similarity search at scale
  • Cross-Lingual: Handle multilingual semantic similarity
  • Feature Extraction: Provide dense representations for ML tasks
  • RAG Foundation: Essential for retrieval-augmented generation

Core Concepts & Rules

1. Core Principles

  • Follow established patterns and conventions
  • Maintain consistency across codebase
  • Document decisions and trade-offs

2. Implementation Guidelines

  • Start with the simplest viable solution
  • Iterate based on feedback and requirements
  • Test thoroughly before deployment

Inputs / Outputs / Contracts

Skill Composition

  • Depends on: None
  • Compatible with: None
  • Conflicts with: None
  • Related Skills: None

Quick Start / Implementation Example

  1. Review requirements and constraints
  2. Set up development environment
  3. Implement core functionality following patterns
  4. Write tests for critical paths
  5. Run tests and fix issues
  6. Document any deviations or decisions
# Example implementation following best practices
def example_function():
    # Your implementation here
    pass

Assumptions

  • Text is in a supported language (typically English)
  • Sufficient memory for loading models
  • Network connectivity for API-based models
  • GPU available for faster inference (optional)

Compatibility

  • Python 3.8+
  • NumPy 1.20+
  • Scikit-learn 1.0+
  • PyTorch 2.0+ (for Sentence Transformers)
  • OpenAI API 1.0+
  • Cohere API 4.0+

Test Scenario Matrix (QA Strategy)

| Type | Focus Area | Required Scenarios / Mocks | | :--- | :--- | :--- | | Unit | Core Logic | Must cover primary logic and at least 3 edge/error cases. Target minimum 80% coverage | | Integration | DB / API | All external API calls or database connections must be mocked during unit tests | | E2E | User Journey | Critical user flows to test | | Performance | Latency / Load | Benchmark requirements | | Security | Vuln / Auth | SAST/DAST or dependency audit | | Frontend | UX / A11y | Accessibility checklist (WCAG), Performance Budget (Lighthouse score) |

Technical Guardrails & Security Threat Model

1. Security & Privacy (Threat Model)

  • Top Threats: Injection attacks, authentication bypass, data exposure
  • [ ] Data Handling: Sanitize all user inputs to prevent Injection attacks. Never log raw PII
  • [ ] Secrets Management: No hardcoded API keys. Use Env Vars/Secrets Manager
  • [ ] Authorization: Validate user permissions before state changes

2. Performance & Resources

  • [ ] Execution Efficiency: Consider time complexity for algorithms
  • [ ] Memory Management: Use streams/pagination for large data
  • [ ] Resource Cleanup: Close DB connections/file handlers in finally blocks

3. Architecture & Scalability

  • [ ] Design Pattern: Follow SOLID principles, use Dependency Injection
  • [ ] Modularity: Decouple logic from UI/Frameworks

4. Observability & Reliability

  • [ ] Logging Standards: Structured JSON, include trace IDs request_id
  • [ ] Metrics: Track error_rate, latency, queue_depth
  • [ ] Error Handling: Standardized error codes, no bare except
  • [ ] Observability Artifacts:
    • Log Fields: timestamp, level, message, request_id
    • Metrics: request_count, error_count, response_time
    • Dashboards/Alerts: High Error Rate > 5%

Agent Directives & Error Recovery

(ข้อกำหนดสำหรับ AI Agent ในการคิดและแก้ปัญหาเมื่อเกิดข้อผิดพลาด)

  • Thinking Process: Analyze root cause before fixing. Do not brute-force.
  • Fallback Strategy: Stop after 3 failed test attempts. Output root cause and ask for human intervention/clarification.
  • Self-Review: Check against Guardrails & Anti-patterns before finalizing.
  • Output Constraints: Output ONLY the modified code block. Do not explain unless asked.

Definition of Done (DoD) Checklist

  • [ ] Tests passed + coverage met
  • [ ] Lint/Typecheck passed
  • [ ] Logging/Metrics/Trace implemented
  • [ ] Security checks passed
  • [ ] Documentation/Changelog updated
  • [ ] Accessibility/Performance requirements met (if frontend)

Anti-patterns

  1. No Normalization: Embeddings without normalization break similarity
  2. Wrong Distance Metric: Using Euclidean when cosine is appropriate
  3. Ignoring Batch Size: Processing one item at a time is inefficient
  4. No Caching: Re-computing same embeddings wastes resources
  5. Wrong Model Choice: Using large models for simple tasks
  6. Ignoring Drift: Not monitoring embedding quality over time

Reference Links & Examples

  • Internal documentation and examples
  • Official documentation and best practices
  • Community resources and discussions

Versioning & Changelog

  • Version: 1.0.0
  • Changelog:
    • 2026-02-22: Initial version with complete template structure