Fixed the wrong similarity_threshold documentation

zilliztech / GPTCache

Semantic cache for LLMs. Fully integrated with LangChain and llama_index.

https://gptcache.readthedocs.io

MIT License

6.89k stars 480 forks source link

Fixed the wrong similarity_threshold documentation #590

Closed sahusiddharth closed 6 months ago

sahusiddharth commented 6 months ago

Signed-off-by: sahusiddharth

fixes: #578

The documentation incorrectly states that when similarity_threshold is set to 1, all search results will be returned as hits. However, in practice, with similarity_threshold=1 does not yield any hits.

Describe the Changes Made:

Updated the documentation to accurately reflect the behavior of similarity_threshold.
Removed the misleading information about setting similarity_threshold to 1 resulting in all search results being returned as hits.

sre-ci-robot commented 6 months ago

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: sahusiddharth To complete the pull request process, please assign xiaofan-luan after the PR has been reviewed. You can assign the PR to them by writing /assign @xiaofan-luan in a comment when ready.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files: - **[OWNERS](https://github.com/zilliztech/GPTCache/blob/dev/OWNERS)** Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment

sre-ci-robot commented 6 months ago

Welcome @sahusiddharth! It looks like this is your first PR to zilliztech/GPTCache 🎉