docs(embeddings): fix links, model names, and search interface

[Pouyanpi]

Description

• Fix broken links to guardrails process and knowledge base docs
• Update text-embedding-ada-002 to text-embedding-3-small
• Add threshold parameter to EmbeddingsIndex.search signature

[github-actions]

Documentation preview

https://nvidia-nemo.github.io/Guardrails/review/pr-1641

[greptile-apps]

Greptile Summary

This PR fixes documentation in the embedding search providers guide:

• Broken links fixed: Updates two broken links to ../../architecture/README.md#the-guardrails-process and ../configuration-guide.md#knowledge-base-documents that no longer exist, pointing them to the correct ../../reference/colang-architecture-guide.md#the-guardrails-process and knowledge-base.md respectively. Both new targets verified to exist.
• Model name updated: Changes text-embedding-ada-002 to text-embedding-3-small in the OpenAI embedding examples, reflecting OpenAI's newer recommended model.
• threshold parameter added to search interface: Adds threshold: Optional[float] = None to the documented EmbeddingsIndex.search signature, however the default value = None does not match the actual base class source code in nemoguardrails/embeddings/index.py:65, which has threshold: Optional[float] without a default.

Confidence Score: 4/5

• Documentation-only change that is safe to merge; the link and model fixes are correct, with one minor inaccuracy in the interface signature.
• This is a documentation-only PR with no runtime code changes. The broken link fixes and model name updates are verified correct. The only issue is a minor discrepancy between the documented EmbeddingsIndex.search signature (with = None default) and the actual base class source code (no default). This won't break anything but could confuse users implementing custom embedding providers.
• docs/configure-rails/other-configurations/embedding-search-providers.md — the EmbeddingsIndex.search signature at line 127 has a default value mismatch with the actual source.

Important Files Changed

Filename	Overview
docs/configure-rails/other-configurations/embedding-search-providers.md	Documentation fixes for broken links, model name updates, and search interface. Links and model name changes are correct, but the threshold default value in the EmbeddingsIndex.search signature doesn't match the actual base class source code.

Class Diagram

classDiagram
    class EmbeddingsIndex {
        +embedding_size: int
        +cache_config
        +_get_embeddings(texts: List~str~)
        +add_item(item: IndexItem)
        +add_items(items: List~IndexItem~)
        +build()
        +search(text: str, max_results: int, threshold: Optional~float~) List~IndexItem~
    }
    class BasicEmbeddingsIndex {
        +search(text: str, max_results: int, threshold: Optional~float~ = None) List~IndexItem~
    }
    class IndexItem {
        +text: str
        +meta: Dict
    }
    EmbeddingsIndex <|-- BasicEmbeddingsIndex : extends
    EmbeddingsIndex ..> IndexItem : returns
    note for EmbeddingsIndex "Base class: threshold is REQUIRED\n(no default value)"
    note for BasicEmbeddingsIndex "Subclass: threshold defaults to None"

Loading

_{Last reviewed commit: dc49aca}

[greptile-apps]

_{1 file reviewed, 1 comment}

_{Edit Code Review Agent Settings | Greptile}