Skip to content

[docs-scanner] Incomplete sentence in RAG semantic-embeddings description #24571

@docker-agent

Description

@docker-agent

File: content/manuals/ai/docker-agent/reference/config.md

Issue

The description of the semantic-embeddings RAG strategy contains an incomplete thought:

Semantic-embeddings

LLM-enhanced semantic search. Uses a language model to generate rich semantic summaries of each chunk before embedding, capturing deeper meaning.

The description explains what it does but doesn't complete the comparison implied by the section structure. The chunked-embeddings section says "Best for understanding intent, synonyms, and paraphrasing" but semantic-embeddings doesn't have a corresponding "Best for..." statement.

This leaves readers unclear about when to choose semantic-embeddings over chunked-embeddings.

Suggested fix

Add a "Best for..." statement to the semantic-embeddings description that clarifies its use case, similar to the other strategy descriptions. For example:

LLM-enhanced semantic search. Uses a language model to generate rich semantic summaries of each chunk before embedding, capturing deeper meaning. Best for complex documents where context and relationships between concepts matter more than exact keyword matches.

Or provide guidance on when to use semantic-embeddings vs chunked-embeddings vs BM25.


Found by nightly documentation freshness scanner

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions