Skip to content

Commit d79762b

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

16 files changed

Lines changed: 336 additions & 64 deletions

File tree

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

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,9 @@ Usage example:
2828
from haystack.document_stores.types import DuplicatePolicy
2929
from haystack import Document
3030
from haystack import Pipeline
31-
from haystack.components.embedders import SentenceTransformersTextEmbedder, SentenceTransformersDocumentEmbedder
31+
# Requires: pip install sentence-transformers-haystack
32+
from haystack_integrations.components.embedders.sentence_transformers import SentenceTransformersTextEmbedder
33+
from haystack_integrations.components.embedders.sentence_transformers import SentenceTransformersDocumentEmbedder
3234
from haystack_integrations.components.retrievers.valkey import ValkeyEmbeddingRetriever
3335
from haystack_integrations.document_stores.valkey import ValkeyDocumentStore
3436

@@ -39,7 +41,6 @@ documents = [Document(content="There are over 7,000 languages spoken around the
3941
Document(content="In certain places, you can witness the phenomenon of bioluminescent waves.")]
4042

4143
document_embedder = SentenceTransformersDocumentEmbedder()
42-
document_embedder.warm_up()
4344
documents_with_embeddings = document_embedder.run(documents)
4445

4546
document_store.write_documents(documents_with_embeddings.get("documents"), policy=DuplicatePolicy.OVERWRITE)
@@ -108,6 +109,22 @@ Deserializes the component from a dictionary.
108109

109110
- <code>ValkeyEmbeddingRetriever</code> – Deserialized component.
110111

112+
#### close
113+
114+
```python
115+
close() -> None
116+
```
117+
118+
Release the synchronous resources of the underlying Document Store.
119+
120+
#### close_async
121+
122+
```python
123+
close_async() -> None
124+
```
125+
126+
Release the asynchronous resources of the underlying Document Store.
127+
111128
#### run
112129

113130
```python
@@ -274,15 +291,15 @@ Creates a new ValkeyDocumentStore instance.
274291
close() -> None
275292
```
276293

277-
Close the synchronous Valkey client connection.
294+
Release the associated synchronous resources.
278295

279296
#### close_async
280297

281298
```python
282299
close_async() -> None
283300
```
284301

285-
Close the asynchronous Valkey client connection.
302+
Release the associated asynchronous resources.
286303

287304
#### to_dict
288305

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

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,9 @@ Usage example:
2828
from haystack.document_stores.types import DuplicatePolicy
2929
from haystack import Document
3030
from haystack import Pipeline
31-
from haystack.components.embedders import SentenceTransformersTextEmbedder, SentenceTransformersDocumentEmbedder
31+
# Requires: pip install sentence-transformers-haystack
32+
from haystack_integrations.components.embedders.sentence_transformers import SentenceTransformersTextEmbedder
33+
from haystack_integrations.components.embedders.sentence_transformers import SentenceTransformersDocumentEmbedder
3234
from haystack_integrations.components.retrievers.valkey import ValkeyEmbeddingRetriever
3335
from haystack_integrations.document_stores.valkey import ValkeyDocumentStore
3436

@@ -39,7 +41,6 @@ documents = [Document(content="There are over 7,000 languages spoken around the
3941
Document(content="In certain places, you can witness the phenomenon of bioluminescent waves.")]
4042

4143
document_embedder = SentenceTransformersDocumentEmbedder()
42-
document_embedder.warm_up()
4344
documents_with_embeddings = document_embedder.run(documents)
4445

4546
document_store.write_documents(documents_with_embeddings.get("documents"), policy=DuplicatePolicy.OVERWRITE)
@@ -108,6 +109,22 @@ Deserializes the component from a dictionary.
108109

109110
- <code>ValkeyEmbeddingRetriever</code> – Deserialized component.
110111

112+
#### close
113+
114+
```python
115+
close() -> None
116+
```
117+
118+
Release the synchronous resources of the underlying Document Store.
119+
120+
#### close_async
121+
122+
```python
123+
close_async() -> None
124+
```
125+
126+
Release the asynchronous resources of the underlying Document Store.
127+
111128
#### run
112129

113130
```python
@@ -274,15 +291,15 @@ Creates a new ValkeyDocumentStore instance.
274291
close() -> None
275292
```
276293

277-
Close the synchronous Valkey client connection.
294+
Release the associated synchronous resources.
278295

279296
#### close_async
280297

281298
```python
282299
close_async() -> None
283300
```
284301

285-
Close the asynchronous Valkey client connection.
302+
Release the associated asynchronous resources.
286303

287304
#### to_dict
288305

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

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,9 @@ Usage example:
2828
from haystack.document_stores.types import DuplicatePolicy
2929
from haystack import Document
3030
from haystack import Pipeline
31-
from haystack.components.embedders import SentenceTransformersTextEmbedder, SentenceTransformersDocumentEmbedder
31+
# Requires: pip install sentence-transformers-haystack
32+
from haystack_integrations.components.embedders.sentence_transformers import SentenceTransformersTextEmbedder
33+
from haystack_integrations.components.embedders.sentence_transformers import SentenceTransformersDocumentEmbedder
3234
from haystack_integrations.components.retrievers.valkey import ValkeyEmbeddingRetriever
3335
from haystack_integrations.document_stores.valkey import ValkeyDocumentStore
3436

@@ -39,7 +41,6 @@ documents = [Document(content="There are over 7,000 languages spoken around the
3941
Document(content="In certain places, you can witness the phenomenon of bioluminescent waves.")]
4042

4143
document_embedder = SentenceTransformersDocumentEmbedder()
42-
document_embedder.warm_up()
4344
documents_with_embeddings = document_embedder.run(documents)
4445

4546
document_store.write_documents(documents_with_embeddings.get("documents"), policy=DuplicatePolicy.OVERWRITE)
@@ -108,6 +109,22 @@ Deserializes the component from a dictionary.
108109

109110
- <code>ValkeyEmbeddingRetriever</code> – Deserialized component.
110111

112+
#### close
113+
114+
```python
115+
close() -> None
116+
```
117+
118+
Release the synchronous resources of the underlying Document Store.
119+
120+
#### close_async
121+
122+
```python
123+
close_async() -> None
124+
```
125+
126+
Release the asynchronous resources of the underlying Document Store.
127+
111128
#### run
112129

113130
```python
@@ -274,15 +291,15 @@ Creates a new ValkeyDocumentStore instance.
274291
close() -> None
275292
```
276293

277-
Close the synchronous Valkey client connection.
294+
Release the associated synchronous resources.
278295

279296
#### close_async
280297

281298
```python
282299
close_async() -> None
283300
```
284301

285-
Close the asynchronous Valkey client connection.
302+
Release the associated asynchronous resources.
286303

287304
#### to_dict
288305

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

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,9 @@ Usage example:
2828
from haystack.document_stores.types import DuplicatePolicy
2929
from haystack import Document
3030
from haystack import Pipeline
31-
from haystack.components.embedders import SentenceTransformersTextEmbedder, SentenceTransformersDocumentEmbedder
31+
# Requires: pip install sentence-transformers-haystack
32+
from haystack_integrations.components.embedders.sentence_transformers import SentenceTransformersTextEmbedder
33+
from haystack_integrations.components.embedders.sentence_transformers import SentenceTransformersDocumentEmbedder
3234
from haystack_integrations.components.retrievers.valkey import ValkeyEmbeddingRetriever
3335
from haystack_integrations.document_stores.valkey import ValkeyDocumentStore
3436

@@ -39,7 +41,6 @@ documents = [Document(content="There are over 7,000 languages spoken around the
3941
Document(content="In certain places, you can witness the phenomenon of bioluminescent waves.")]
4042

4143
document_embedder = SentenceTransformersDocumentEmbedder()
42-
document_embedder.warm_up()
4344
documents_with_embeddings = document_embedder.run(documents)
4445

4546
document_store.write_documents(documents_with_embeddings.get("documents"), policy=DuplicatePolicy.OVERWRITE)
@@ -108,6 +109,22 @@ Deserializes the component from a dictionary.
108109

109110
- <code>ValkeyEmbeddingRetriever</code> – Deserialized component.
110111

112+
#### close
113+
114+
```python
115+
close() -> None
116+
```
117+
118+
Release the synchronous resources of the underlying Document Store.
119+
120+
#### close_async
121+
122+
```python
123+
close_async() -> None
124+
```
125+
126+
Release the asynchronous resources of the underlying Document Store.
127+
111128
#### run
112129

113130
```python
@@ -274,15 +291,15 @@ Creates a new ValkeyDocumentStore instance.
274291
close() -> None
275292
```
276293

277-
Close the synchronous Valkey client connection.
294+
Release the associated synchronous resources.
278295

279296
#### close_async
280297

281298
```python
282299
close_async() -> None
283300
```
284301

285-
Close the asynchronous Valkey client connection.
302+
Release the associated asynchronous resources.
286303

287304
#### to_dict
288305

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

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,9 @@ Usage example:
2828
from haystack.document_stores.types import DuplicatePolicy
2929
from haystack import Document
3030
from haystack import Pipeline
31-
from haystack.components.embedders import SentenceTransformersTextEmbedder, SentenceTransformersDocumentEmbedder
31+
# Requires: pip install sentence-transformers-haystack
32+
from haystack_integrations.components.embedders.sentence_transformers import SentenceTransformersTextEmbedder
33+
from haystack_integrations.components.embedders.sentence_transformers import SentenceTransformersDocumentEmbedder
3234
from haystack_integrations.components.retrievers.valkey import ValkeyEmbeddingRetriever
3335
from haystack_integrations.document_stores.valkey import ValkeyDocumentStore
3436

@@ -39,7 +41,6 @@ documents = [Document(content="There are over 7,000 languages spoken around the
3941
Document(content="In certain places, you can witness the phenomenon of bioluminescent waves.")]
4042

4143
document_embedder = SentenceTransformersDocumentEmbedder()
42-
document_embedder.warm_up()
4344
documents_with_embeddings = document_embedder.run(documents)
4445

4546
document_store.write_documents(documents_with_embeddings.get("documents"), policy=DuplicatePolicy.OVERWRITE)
@@ -108,6 +109,22 @@ Deserializes the component from a dictionary.
108109

109110
- <code>ValkeyEmbeddingRetriever</code> – Deserialized component.
110111

112+
#### close
113+
114+
```python
115+
close() -> None
116+
```
117+
118+
Release the synchronous resources of the underlying Document Store.
119+
120+
#### close_async
121+
122+
```python
123+
close_async() -> None
124+
```
125+
126+
Release the asynchronous resources of the underlying Document Store.
127+
111128
#### run
112129

113130
```python
@@ -274,15 +291,15 @@ Creates a new ValkeyDocumentStore instance.
274291
close() -> None
275292
```
276293

277-
Close the synchronous Valkey client connection.
294+
Release the associated synchronous resources.
278295

279296
#### close_async
280297

281298
```python
282299
close_async() -> None
283300
```
284301

285-
Close the asynchronous Valkey client connection.
302+
Release the associated asynchronous resources.
286303

287304
#### to_dict
288305

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

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,9 @@ Usage example:
2828
from haystack.document_stores.types import DuplicatePolicy
2929
from haystack import Document
3030
from haystack import Pipeline
31-
from haystack.components.embedders import SentenceTransformersTextEmbedder, SentenceTransformersDocumentEmbedder
31+
# Requires: pip install sentence-transformers-haystack
32+
from haystack_integrations.components.embedders.sentence_transformers import SentenceTransformersTextEmbedder
33+
from haystack_integrations.components.embedders.sentence_transformers import SentenceTransformersDocumentEmbedder
3234
from haystack_integrations.components.retrievers.valkey import ValkeyEmbeddingRetriever
3335
from haystack_integrations.document_stores.valkey import ValkeyDocumentStore
3436

@@ -39,7 +41,6 @@ documents = [Document(content="There are over 7,000 languages spoken around the
3941
Document(content="In certain places, you can witness the phenomenon of bioluminescent waves.")]
4042

4143
document_embedder = SentenceTransformersDocumentEmbedder()
42-
document_embedder.warm_up()
4344
documents_with_embeddings = document_embedder.run(documents)
4445

4546
document_store.write_documents(documents_with_embeddings.get("documents"), policy=DuplicatePolicy.OVERWRITE)
@@ -108,6 +109,22 @@ Deserializes the component from a dictionary.
108109

109110
- <code>ValkeyEmbeddingRetriever</code> – Deserialized component.
110111

112+
#### close
113+
114+
```python
115+
close() -> None
116+
```
117+
118+
Release the synchronous resources of the underlying Document Store.
119+
120+
#### close_async
121+
122+
```python
123+
close_async() -> None
124+
```
125+
126+
Release the asynchronous resources of the underlying Document Store.
127+
111128
#### run
112129

113130
```python
@@ -274,15 +291,15 @@ Creates a new ValkeyDocumentStore instance.
274291
close() -> None
275292
```
276293

277-
Close the synchronous Valkey client connection.
294+
Release the associated synchronous resources.
278295

279296
#### close_async
280297

281298
```python
282299
close_async() -> None
283300
```
284301

285-
Close the asynchronous Valkey client connection.
302+
Release the associated asynchronous resources.
286303

287304
#### to_dict
288305

0 commit comments

Comments
 (0)