Skip to content

Commit 95c6ef1

Browse files
docs(embeddings): fix links, model names, and search interface (#1641)
* docs(embeddings): fix links, model names, and search interface - 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 * Update docs/configure-rails/other-configurations/embedding-search-providers.md Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com> Signed-off-by: Pouyan <13303554+Pouyanpi@users.noreply.github.com> --------- Signed-off-by: Pouyan <13303554+Pouyanpi@users.noreply.github.com> Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
1 parent 877af25 commit 95c6ef1

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/configure-rails/other-configurations/embedding-search-providers.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ content:
1414

1515
# Embedding Search Providers
1616

17-
NeMo Guardrails utilizes embedding search, also known as vector databases, for implementing the [guardrails process](../../architecture/README.md#the-guardrails-process) and for the [knowledge base](../configuration-guide.md#knowledge-base-documents) functionality.
17+
NeMo Guardrails utilizes embedding search, also known as vector databases, for implementing the [guardrails process](../../reference/colang-architecture-guide.md#the-guardrails-process) and for the [knowledge base](knowledge-base.md) functionality.
1818

1919
To enhance the efficiency of the embedding search process, NeMo Guardrails can employ a caching mechanism for embeddings. This mechanism stores computed embeddings, thereby reducing the need for repeated computations and accelerating the search process. By default, the caching mechanism is disabled.
2020

@@ -62,7 +62,7 @@ core:
6262
name: default
6363
parameters:
6464
embedding_engine: openai
65-
embedding_model: text-embedding-ada-002
65+
embedding_model: text-embedding-3-small
6666
cache:
6767
enabled: False
6868
key_generator: sha256
@@ -74,7 +74,7 @@ knowledge_base:
7474
name: default
7575
parameters:
7676
embedding_engine: openai
77-
embedding_model: text-embedding-ada-002
77+
embedding_model: text-embedding-3-small
7878
cache:
7979
enabled: False
8080
key_generator: sha256
@@ -124,7 +124,7 @@ class EmbeddingsIndex:
124124
This is optional, might not be needed for all implementations."""
125125
pass
126126
127-
async def search(self, text: str, max_results: int) -> List[IndexItem]:
127+
async def search(self, text: str, max_results: int, threshold: Optional[float]) -> List[IndexItem]:
128128
"""Searches the index for the closest matches to the provided text."""
129129
raise NotImplementedError()
130130

0 commit comments

Comments
 (0)