-
Notifications
You must be signed in to change notification settings - Fork 107
Hyperscale Vector Indexes and Composite Vector Indexes support for couchbase #372
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?
Conversation
bilgeyucel
left a comment
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.
Thank you for the PR @shyam-cb! I left some comments on formatting
| - [More Examples](#more-examples) | ||
| - [License](#license) | ||
|
|
||
| ## Breaking Changes in Version 2.0.0 |
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.
| ## Breaking Changes in Version 2.0.0 | |
| ### Breaking Changes in Version 2.0.0 |
| An integration of [Couchbase](https://www.couchbase.com) NoSQL database with [Haystack v2.0](https://docs.haystack.deepset.ai/docs/intro) | ||
| by [deepset](https://www.deepset.ai). In Couchbase [Vector search index](https://docs.couchbase.com/server/current/vector-search/vector-search.html) | ||
| is being used for indexing document embeddings and dense retrievals. | ||
| An integration of [Couchbase](https://www.couchbase.com) NoSQL database with [Haystack v2.0](https://docs.haystack.deepset.ai/v2.0/docs/intro) |
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.
| An integration of [Couchbase](https://www.couchbase.com) NoSQL database with [Haystack v2.0](https://docs.haystack.deepset.ai/v2.0/docs/intro) | |
| An integration of [Couchbase](https://www.couchbase.com) NoSQL database with [Haystack](https://docs.haystack.deepset.ai/docs/intro) |
| ## Breaking Changes in Version 2.0.0 | ||
|
|
||
| > **Important Note:** | ||
| > In version 2.0.0, the following component names have been changed: |
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.
Is this Couchbase version or Haystack version?
| ### Retrievers | ||
|
|
||
| - **CouchbaseSearchEmbeddingRetriever**: A typical [retriever component](https://docs.haystack.deepset.ai/docs/retrievers) which can be used to query the vector store index and find related Documents. The component uses `CouchbaseSearchDocumentStore` to query embeddings. | ||
| In addition to the document stores, the library includes the following [retriever components](https://docs.haystack.deepset.ai/v2.0/docs/retrievers): |
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.
| In addition to the document stores, the library includes the following [retriever components](https://docs.haystack.deepset.ai/v2.0/docs/retrievers): | |
| In addition to the document stores, the library includes the following [retriever components](https://docs.haystack.deepset.ai/docs/retrievers): |
|
|
||
| Both document stores store Documents as JSON documents in Couchbase. Embeddings are stored as part of the document, with indexing and querying managed by different Couchbase services depending on the document store type. | ||
|
|
||
| ## Choosing the Right Document Store |
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.
| ## Choosing the Right Document Store | |
| ### Choosing the Right Document Store |
| --- | ||
|
|
||
| **Table of Contents** | ||
| # Table of Contents |
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.
Let's revert this change
| **Table of Contents** | ||
| # Table of Contents | ||
|
|
||
| - [Breaking Changes in Version 2.0.0](#breaking-changes-in-version-200) |
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.
The only valid items for ToC are Overview, Installation, Usage and License
| - [Breaking Changes in Version 2.0.0](#breaking-changes-in-version-200) |
|
|
||
| - [Breaking Changes in Version 2.0.0](#breaking-changes-in-version-200) | ||
| - [Overview](#overview) | ||
| - [Choosing the Right Document Store](#choosing-the-right-document-store) |
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.
| - [Choosing the Right Document Store](#choosing-the-right-document-store) |
| #### Indexing Documents with CouchbaseSearchDocumentStore | ||
|
|
||
| With Haystack you can use [DocumentWriter](https://docs.haystack.deepset.ai/docs/documentwriter) component to write Documents into a Document Store. In the example below we construct pipeline to write documents to Couchbase using `CouchbaseDocumentStore`: | ||
| With Haystack you can use [DocumentWriter](https://docs.haystack.deepset.ai/v2.0/docs/documentwriter) component to write Documents into a Document Store. In the example below we construct pipeline to write documents to Couchbase using `CouchbaseSearchDocumentStore`: |
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.
| With Haystack you can use [DocumentWriter](https://docs.haystack.deepset.ai/v2.0/docs/documentwriter) component to write Documents into a Document Store. In the example below we construct pipeline to write documents to Couchbase using `CouchbaseSearchDocumentStore`: | |
| With Haystack you can use [DocumentWriter](https://docs.haystack.deepset.ai/docs/documentwriter) component to write Documents into a Document Store. In the example below we construct pipeline to write documents to Couchbase using `CouchbaseSearchDocumentStore`: |
No description provided.