Skip to content

Commit d7ba8d7

Browse files
docs: sync Core Integrations API reference (arcadedb) on Docusaurus (#12130)
Co-authored-by: anakin87 <44616784+anakin87@users.noreply.github.com>
1 parent c04e322 commit d7ba8d7

16 files changed

Lines changed: 384 additions & 32 deletions

File tree

docs-website/reference/integrations-api/arcadedb.md

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,14 @@ Usage example:
1616

1717
```python
1818
from haystack import Document
19-
from haystack.components.embedders import SentenceTransformersTextEmbedder
20-
from haystack_integrations.components.retrievers.arcadedb import ArcadeDBEmbeddingRetriever
19+
20+
# Requires: pip install sentence-transformers-haystack
21+
from haystack_integrations.components.embedders.sentence_transformers import (
22+
SentenceTransformersTextEmbedder,
23+
)
24+
from haystack_integrations.components.retrievers.arcadedb import (
25+
ArcadeDBEmbeddingRetriever,
26+
)
2127
from haystack_integrations.document_stores.arcadedb import ArcadeDBDocumentStore
2228

2329
store = ArcadeDBDocumentStore(database="mydb")
@@ -96,6 +102,14 @@ Serializes the component to a dictionary.
96102

97103
- <code>dict\[str, Any\]</code> – Dictionary with serialized data.
98104

105+
#### close
106+
107+
```python
108+
close() -> None
109+
```
110+
111+
Release the synchronous resources of the underlying Document Store.
112+
99113
#### from_dict
100114

101115
```python
@@ -199,6 +213,14 @@ Deserializes the DocumentStore from a dictionary.
199213

200214
- <code>ArcadeDBDocumentStore</code> – The deserialized DocumentStore.
201215

216+
#### close
217+
218+
```python
219+
close() -> None
220+
```
221+
222+
Release the associated synchronous resources.
223+
202224
#### count_documents
203225

204226
```python

docs-website/reference_versioned_docs/version-2.18/integrations-api/arcadedb.md

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,14 @@ Usage example:
1616

1717
```python
1818
from haystack import Document
19-
from haystack.components.embedders import SentenceTransformersTextEmbedder
20-
from haystack_integrations.components.retrievers.arcadedb import ArcadeDBEmbeddingRetriever
19+
20+
# Requires: pip install sentence-transformers-haystack
21+
from haystack_integrations.components.embedders.sentence_transformers import (
22+
SentenceTransformersTextEmbedder,
23+
)
24+
from haystack_integrations.components.retrievers.arcadedb import (
25+
ArcadeDBEmbeddingRetriever,
26+
)
2127
from haystack_integrations.document_stores.arcadedb import ArcadeDBDocumentStore
2228

2329
store = ArcadeDBDocumentStore(database="mydb")
@@ -96,6 +102,14 @@ Serializes the component to a dictionary.
96102

97103
- <code>dict\[str, Any\]</code> – Dictionary with serialized data.
98104

105+
#### close
106+
107+
```python
108+
close() -> None
109+
```
110+
111+
Release the synchronous resources of the underlying Document Store.
112+
99113
#### from_dict
100114

101115
```python
@@ -199,6 +213,14 @@ Deserializes the DocumentStore from a dictionary.
199213

200214
- <code>ArcadeDBDocumentStore</code> – The deserialized DocumentStore.
201215

216+
#### close
217+
218+
```python
219+
close() -> None
220+
```
221+
222+
Release the associated synchronous resources.
223+
202224
#### count_documents
203225

204226
```python

docs-website/reference_versioned_docs/version-2.19/integrations-api/arcadedb.md

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,14 @@ Usage example:
1616

1717
```python
1818
from haystack import Document
19-
from haystack.components.embedders import SentenceTransformersTextEmbedder
20-
from haystack_integrations.components.retrievers.arcadedb import ArcadeDBEmbeddingRetriever
19+
20+
# Requires: pip install sentence-transformers-haystack
21+
from haystack_integrations.components.embedders.sentence_transformers import (
22+
SentenceTransformersTextEmbedder,
23+
)
24+
from haystack_integrations.components.retrievers.arcadedb import (
25+
ArcadeDBEmbeddingRetriever,
26+
)
2127
from haystack_integrations.document_stores.arcadedb import ArcadeDBDocumentStore
2228

2329
store = ArcadeDBDocumentStore(database="mydb")
@@ -96,6 +102,14 @@ Serializes the component to a dictionary.
96102

97103
- <code>dict\[str, Any\]</code> – Dictionary with serialized data.
98104

105+
#### close
106+
107+
```python
108+
close() -> None
109+
```
110+
111+
Release the synchronous resources of the underlying Document Store.
112+
99113
#### from_dict
100114

101115
```python
@@ -199,6 +213,14 @@ Deserializes the DocumentStore from a dictionary.
199213

200214
- <code>ArcadeDBDocumentStore</code> – The deserialized DocumentStore.
201215

216+
#### close
217+
218+
```python
219+
close() -> None
220+
```
221+
222+
Release the associated synchronous resources.
223+
202224
#### count_documents
203225

204226
```python

docs-website/reference_versioned_docs/version-2.20/integrations-api/arcadedb.md

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,14 @@ Usage example:
1616

1717
```python
1818
from haystack import Document
19-
from haystack.components.embedders import SentenceTransformersTextEmbedder
20-
from haystack_integrations.components.retrievers.arcadedb import ArcadeDBEmbeddingRetriever
19+
20+
# Requires: pip install sentence-transformers-haystack
21+
from haystack_integrations.components.embedders.sentence_transformers import (
22+
SentenceTransformersTextEmbedder,
23+
)
24+
from haystack_integrations.components.retrievers.arcadedb import (
25+
ArcadeDBEmbeddingRetriever,
26+
)
2127
from haystack_integrations.document_stores.arcadedb import ArcadeDBDocumentStore
2228

2329
store = ArcadeDBDocumentStore(database="mydb")
@@ -96,6 +102,14 @@ Serializes the component to a dictionary.
96102

97103
- <code>dict\[str, Any\]</code> – Dictionary with serialized data.
98104

105+
#### close
106+
107+
```python
108+
close() -> None
109+
```
110+
111+
Release the synchronous resources of the underlying Document Store.
112+
99113
#### from_dict
100114

101115
```python
@@ -199,6 +213,14 @@ Deserializes the DocumentStore from a dictionary.
199213

200214
- <code>ArcadeDBDocumentStore</code> – The deserialized DocumentStore.
201215

216+
#### close
217+
218+
```python
219+
close() -> None
220+
```
221+
222+
Release the associated synchronous resources.
223+
202224
#### count_documents
203225

204226
```python

docs-website/reference_versioned_docs/version-2.21/integrations-api/arcadedb.md

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,14 @@ Usage example:
1616

1717
```python
1818
from haystack import Document
19-
from haystack.components.embedders import SentenceTransformersTextEmbedder
20-
from haystack_integrations.components.retrievers.arcadedb import ArcadeDBEmbeddingRetriever
19+
20+
# Requires: pip install sentence-transformers-haystack
21+
from haystack_integrations.components.embedders.sentence_transformers import (
22+
SentenceTransformersTextEmbedder,
23+
)
24+
from haystack_integrations.components.retrievers.arcadedb import (
25+
ArcadeDBEmbeddingRetriever,
26+
)
2127
from haystack_integrations.document_stores.arcadedb import ArcadeDBDocumentStore
2228

2329
store = ArcadeDBDocumentStore(database="mydb")
@@ -96,6 +102,14 @@ Serializes the component to a dictionary.
96102

97103
- <code>dict\[str, Any\]</code> – Dictionary with serialized data.
98104

105+
#### close
106+
107+
```python
108+
close() -> None
109+
```
110+
111+
Release the synchronous resources of the underlying Document Store.
112+
99113
#### from_dict
100114

101115
```python
@@ -199,6 +213,14 @@ Deserializes the DocumentStore from a dictionary.
199213

200214
- <code>ArcadeDBDocumentStore</code> – The deserialized DocumentStore.
201215

216+
#### close
217+
218+
```python
219+
close() -> None
220+
```
221+
222+
Release the associated synchronous resources.
223+
202224
#### count_documents
203225

204226
```python

docs-website/reference_versioned_docs/version-2.22/integrations-api/arcadedb.md

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,14 @@ Usage example:
1616

1717
```python
1818
from haystack import Document
19-
from haystack.components.embedders import SentenceTransformersTextEmbedder
20-
from haystack_integrations.components.retrievers.arcadedb import ArcadeDBEmbeddingRetriever
19+
20+
# Requires: pip install sentence-transformers-haystack
21+
from haystack_integrations.components.embedders.sentence_transformers import (
22+
SentenceTransformersTextEmbedder,
23+
)
24+
from haystack_integrations.components.retrievers.arcadedb import (
25+
ArcadeDBEmbeddingRetriever,
26+
)
2127
from haystack_integrations.document_stores.arcadedb import ArcadeDBDocumentStore
2228

2329
store = ArcadeDBDocumentStore(database="mydb")
@@ -96,6 +102,14 @@ Serializes the component to a dictionary.
96102

97103
- <code>dict\[str, Any\]</code> – Dictionary with serialized data.
98104

105+
#### close
106+
107+
```python
108+
close() -> None
109+
```
110+
111+
Release the synchronous resources of the underlying Document Store.
112+
99113
#### from_dict
100114

101115
```python
@@ -199,6 +213,14 @@ Deserializes the DocumentStore from a dictionary.
199213

200214
- <code>ArcadeDBDocumentStore</code> – The deserialized DocumentStore.
201215

216+
#### close
217+
218+
```python
219+
close() -> None
220+
```
221+
222+
Release the associated synchronous resources.
223+
202224
#### count_documents
203225

204226
```python

docs-website/reference_versioned_docs/version-2.23/integrations-api/arcadedb.md

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,14 @@ Usage example:
1616

1717
```python
1818
from haystack import Document
19-
from haystack.components.embedders import SentenceTransformersTextEmbedder
20-
from haystack_integrations.components.retrievers.arcadedb import ArcadeDBEmbeddingRetriever
19+
20+
# Requires: pip install sentence-transformers-haystack
21+
from haystack_integrations.components.embedders.sentence_transformers import (
22+
SentenceTransformersTextEmbedder,
23+
)
24+
from haystack_integrations.components.retrievers.arcadedb import (
25+
ArcadeDBEmbeddingRetriever,
26+
)
2127
from haystack_integrations.document_stores.arcadedb import ArcadeDBDocumentStore
2228

2329
store = ArcadeDBDocumentStore(database="mydb")
@@ -96,6 +102,14 @@ Serializes the component to a dictionary.
96102

97103
- <code>dict\[str, Any\]</code> – Dictionary with serialized data.
98104

105+
#### close
106+
107+
```python
108+
close() -> None
109+
```
110+
111+
Release the synchronous resources of the underlying Document Store.
112+
99113
#### from_dict
100114

101115
```python
@@ -199,6 +213,14 @@ Deserializes the DocumentStore from a dictionary.
199213

200214
- <code>ArcadeDBDocumentStore</code> – The deserialized DocumentStore.
201215

216+
#### close
217+
218+
```python
219+
close() -> None
220+
```
221+
222+
Release the associated synchronous resources.
223+
202224
#### count_documents
203225

204226
```python

docs-website/reference_versioned_docs/version-2.24/integrations-api/arcadedb.md

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,14 @@ Usage example:
1616

1717
```python
1818
from haystack import Document
19-
from haystack.components.embedders import SentenceTransformersTextEmbedder
20-
from haystack_integrations.components.retrievers.arcadedb import ArcadeDBEmbeddingRetriever
19+
20+
# Requires: pip install sentence-transformers-haystack
21+
from haystack_integrations.components.embedders.sentence_transformers import (
22+
SentenceTransformersTextEmbedder,
23+
)
24+
from haystack_integrations.components.retrievers.arcadedb import (
25+
ArcadeDBEmbeddingRetriever,
26+
)
2127
from haystack_integrations.document_stores.arcadedb import ArcadeDBDocumentStore
2228

2329
store = ArcadeDBDocumentStore(database="mydb")
@@ -96,6 +102,14 @@ Serializes the component to a dictionary.
96102

97103
- <code>dict\[str, Any\]</code> – Dictionary with serialized data.
98104

105+
#### close
106+
107+
```python
108+
close() -> None
109+
```
110+
111+
Release the synchronous resources of the underlying Document Store.
112+
99113
#### from_dict
100114

101115
```python
@@ -199,6 +213,14 @@ Deserializes the DocumentStore from a dictionary.
199213

200214
- <code>ArcadeDBDocumentStore</code> – The deserialized DocumentStore.
201215

216+
#### close
217+
218+
```python
219+
close() -> None
220+
```
221+
222+
Release the associated synchronous resources.
223+
202224
#### count_documents
203225

204226
```python

0 commit comments

Comments
 (0)