-
Notifications
You must be signed in to change notification settings - Fork 1.9k
DOC: Fix Documentation Typo #5748
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -21,7 +21,7 @@ export default withChroma(nextConfig); | |
|
|
||
| ## Cannot return the results in a contiguous 2D array. Probably ef or M is too small | ||
|
|
||
| This error happens when the HNSW index fails to retrieve the requested number of results for a query, given its structure and your data. he way to resolve this is to either decrease the number of results you request from a query (n_result), or increase the HNSW parameters `M`, `ef_construction`, and `ef_search`. You can read more about HNSW configurations [here](/docs/collections/configure). | ||
| This error happens when the HNSW index fails to retrieve the requested number of results for a query, given its structure and your data. The way to resolve this is to either decrease the number of results you request from a query (n_result), or increase the HNSW parameters `M`, `ef_construction`, and `ef_search`. You can read more about HNSW configurations [here](/docs/collections/configure). | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [Documentation] Parameter name appears incorrect: use Note: The ChromaDB query API consistently uses Context for Agents |
||
|
|
||
| ## Using .get or .query, embeddings say `None` | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -1937,7 +1937,7 @@ These components operate differently depending on the deployment mode, particula | |
| - In Local and Single Node mode, all components share a process and use the local filesystem for durability. | ||
| - In **Distributed** mode, components are deployed as independent services. | ||
| - The log and built indexes are stored in cloud object storage. | ||
| - The system catalog is backed by a SQL database. | ||
| - The system catalog is backed by an SQL database. | ||
| - All services use local SSDs as caches to reduce object storage latency and cost. | ||
|
|
||
| ## Request Sequences | ||
|
|
@@ -3041,7 +3041,7 @@ export default withChroma(nextConfig); | |
|
|
||
| ## Cannot return the results in a contiguous 2D array. Probably ef or M is too small | ||
|
|
||
| This error happens when the HNSW index fails to retrieve the requested number of results for a query, given its structure and your data. he way to resolve this is to either decrease the number of results you request from a query (n_result), or increase the HNSW parameters `M`, `ef_construction`, and `ef_search`. You can read more about HNSW configurations [here](/docs/collections/configure). | ||
| This error happens when the HNSW index fails to retrieve the requested number of results for a query, given its structure and your data. The way to resolve this is to either decrease the number of results you request from a query (n_result), or increase the HNSW parameters `M`, `ef_construction`, and `ef_search`. You can read more about HNSW configurations [here](/docs/collections/configure). | ||
|
|
||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [Documentation] Parameter name appears incorrect: use Note: The ChromaDB query API consistently uses Context for Agents |
||
| ## Using .get or .query, embeddings say `None` | ||
|
|
||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[Documentation]
Parameter name appears incorrect: use
n_results(plural) instead ofn_result.Note: The ChromaDB query API consistently uses
n_results(plural) across all implementations. This parameter specifies the number of nearest neighbors to return for each query, with a default value of 10.Context for Agents