Skip to content

Commit 73c9c30

Browse files
authored
Document update for bhive and composite docstore (#18)
1 parent 65016f7 commit 73c9c30

5 files changed

Lines changed: 71 additions & 9 deletions

File tree

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,15 @@
1-
# CouchbaseSearchEmbeddingRetriever
1+
# Embedding Retrievers
2+
3+
## CouchbaseSearchEmbeddingRetriever
24

35
::: couchbase_haystack.components.retrievers.embedding_retriever.CouchbaseSearchEmbeddingRetriever
46
options:
57
show_root_heading: false
6-
heading_level: 2
8+
heading_level: 3
9+
10+
## CouchbaseQueryEmbeddingRetriever
11+
12+
::: couchbase_haystack.components.retrievers.embedding_retriever.CouchbaseQueryEmbeddingRetriever
13+
options:
14+
show_root_heading: false
15+
heading_level: 3
Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,22 @@
11
# Authentication
22

33
## CouchbaseAuthenticator
4+
45
::: couchbase_haystack.document_stores.auth.CouchbaseAuthenticator
56
options:
67
show_root_heading: false
78
heading_level: 3
89

910
## CouchbasePasswordAuthenticator
11+
1012
::: couchbase_haystack.document_stores.auth.CouchbasePasswordAuthenticator
1113
options:
1214
show_root_heading: false
1315
heading_level: 3
1416

1517
## CouchbaseCertificateAuthenticator
18+
1619
::: couchbase_haystack.document_stores.auth.CouchbaseCertificateAuthenticator
1720
options:
1821
show_root_heading: false
19-
heading_level: 3
22+
heading_level: 3

docs/reference/document_stores/cluster_options.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@
33
::: couchbase_haystack.document_stores.cluster_options.CouchbaseClusterOptions
44
options:
55
show_root_heading: false
6-
heading_level: 2
6+
heading_level: 2
Lines changed: 41 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,45 @@
1-
# CouchbaseSearchDocumentStore
1+
# Document Stores
2+
3+
## CouchbaseDocumentStore
4+
5+
::: couchbase_haystack.document_stores.document_store.CouchbaseDocumentStore
6+
options:
7+
show_root_heading: false
8+
heading_level: 3
9+
10+
## CouchbaseSearchDocumentStore
211

312
::: couchbase_haystack.document_stores.document_store.CouchbaseSearchDocumentStore
413
options:
514
show_root_heading: false
6-
heading_level: 2
15+
heading_level: 3
16+
17+
## CouchbaseQueryDocumentStore
18+
19+
::: couchbase_haystack.document_stores.document_store.CouchbaseQueryDocumentStore
20+
options:
21+
show_root_heading: false
22+
heading_level: 3
23+
24+
## Supporting Classes
25+
26+
### QueryVectorSearchType
27+
28+
::: couchbase_haystack.document_stores.document_store.QueryVectorSearchType
29+
options:
30+
show_root_heading: false
31+
heading_level: 4
32+
33+
### QueryVectorSearchSimilarity
34+
35+
::: couchbase_haystack.document_stores.document_store.QueryVectorSearchSimilarity
36+
options:
37+
show_root_heading: false
38+
heading_level: 4
39+
40+
### CouchbaseQueryOptions
41+
42+
::: couchbase_haystack.document_stores.document_store.CouchbaseQueryOptions
43+
options:
44+
show_root_heading: false
45+
heading_level: 4
Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,21 @@
11
# Filters
22

3-
::: couchbase_haystack.document_stores.filters
3+
## Search Filters
4+
5+
::: couchbase_haystack.document_stores.search_filters
46
options:
57
show_root_heading: false
6-
heading_level: 2
8+
heading_level: 3
79
members:
810
- DateRangeQuery
911
- NumericRangeQuery
10-
- _normalize_filters
12+
- _normalize_filters
13+
14+
## SQL Filters
15+
16+
::: couchbase_haystack.document_stores.sql_filters
17+
options:
18+
show_root_heading: false
19+
heading_level: 3
20+
members:
21+
- normalize_sql_filters

0 commit comments

Comments
 (0)