Skip to content

Commit 3a976ab

Browse files
docs: sync Haystack API reference on Docusaurus (#11881)
Co-authored-by: julian-risch <4181769+julian-risch@users.noreply.github.com>
1 parent 4dd5af9 commit 3a976ab

4 files changed

Lines changed: 20 additions & 11 deletions

File tree

docs-website/reference/haystack-api/joiners_api.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -299,7 +299,9 @@ It supports different join modes:
299299

300300
```python
301301
from haystack import Pipeline, Document
302-
from haystack.components.embedders import SentenceTransformersTextEmbedder, SentenceTransformersDocumentEmbedder
302+
# Requires: pip install sentence-transformers-haystack
303+
from haystack_integrations.components.embedders.sentence_transformers import SentenceTransformersTextEmbedder
304+
from haystack_integrations.components.embedders.sentence_transformers import SentenceTransformersDocumentEmbedder
303305
from haystack.components.joiners import DocumentJoiner
304306
from haystack.components.retrievers import InMemoryBM25Retriever
305307
from haystack.components.retrievers import InMemoryEmbeddingRetriever

docs-website/reference/haystack-api/preprocessors_api.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -488,7 +488,8 @@ This component is inspired by [5 Levels of Text Splitting](https://github.com/Fu
488488

489489
```python
490490
from haystack import Document
491-
from haystack.components.embedders import SentenceTransformersDocumentEmbedder
491+
# Requires: pip install sentence-transformers-haystack
492+
from haystack_integrations.components.embedders.sentence_transformers import SentenceTransformersDocumentEmbedder
492493
from haystack.components.preprocessors import EmbeddingBasedDocumentSplitter
493494

494495
# Create a document with content that has a clear topic shift

docs-website/reference/haystack-api/retrievers_api.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -408,7 +408,9 @@ In query pipelines, use a TextEmbedder to embed queries and send them to the ret
408408

409409
```python
410410
from haystack import Document
411-
from haystack.components.embedders import SentenceTransformersDocumentEmbedder, SentenceTransformersTextEmbedder
411+
# Requires: pip install sentence-transformers-haystack
412+
from haystack_integrations.components.embedders.sentence_transformers import SentenceTransformersDocumentEmbedder
413+
from haystack_integrations.components.embedders.sentence_transformers import SentenceTransformersTextEmbedder
412414
from haystack.components.retrievers.in_memory import InMemoryEmbeddingRetriever
413415
from haystack.document_stores.in_memory import InMemoryDocumentStore
414416

@@ -575,8 +577,9 @@ The results are combined and sorted by relevance score.
575577
from haystack import Document
576578
from haystack.document_stores.in_memory import InMemoryDocumentStore
577579
from haystack.document_stores.types import DuplicatePolicy
578-
from haystack.components.embedders import SentenceTransformersTextEmbedder
579-
from haystack.components.embedders import SentenceTransformersDocumentEmbedder
580+
# Requires: pip install sentence-transformers-haystack
581+
from haystack_integrations.components.embedders.sentence_transformers import SentenceTransformersTextEmbedder
582+
from haystack_integrations.components.embedders.sentence_transformers import SentenceTransformersDocumentEmbedder
580583
from haystack.components.retrievers import InMemoryEmbeddingRetriever
581584
from haystack.components.writers import DocumentWriter
582585
from haystack.components.retrievers import MultiQueryEmbeddingRetriever
@@ -878,7 +881,9 @@ from haystack.document_stores.in_memory import InMemoryDocumentStore
878881
from haystack.document_stores.types import DuplicatePolicy
879882
from haystack.components.retrievers import InMemoryBM25Retriever, InMemoryEmbeddingRetriever
880883
from haystack.components.retrievers import TextEmbeddingRetriever, MultiRetriever
881-
from haystack.components.embedders import SentenceTransformersTextEmbedder, SentenceTransformersDocumentEmbedder
884+
# Requires: pip install sentence-transformers-haystack
885+
from haystack_integrations.components.embedders.sentence_transformers import SentenceTransformersTextEmbedder
886+
from haystack_integrations.components.embedders.sentence_transformers import SentenceTransformersDocumentEmbedder
882887
from haystack.components.writers import DocumentWriter
883888

884889
documents = [
@@ -1249,7 +1254,9 @@ The results are sorted by relevance score.
12491254
from haystack import Document
12501255
from haystack.document_stores.in_memory import InMemoryDocumentStore
12511256
from haystack.document_stores.types import DuplicatePolicy
1252-
from haystack.components.embedders import SentenceTransformersTextEmbedder, SentenceTransformersDocumentEmbedder
1257+
# Requires: pip install sentence-transformers-haystack
1258+
from haystack_integrations.components.embedders.sentence_transformers import SentenceTransformersTextEmbedder
1259+
from haystack_integrations.components.embedders.sentence_transformers import SentenceTransformersDocumentEmbedder
12531260
from haystack.components.retrievers import InMemoryEmbeddingRetriever, TextEmbeddingRetriever
12541261
from haystack.components.writers import DocumentWriter
12551262

docs-website/reference/haystack-api/tools_api.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -446,10 +446,9 @@ Below is an example of creating a PipelineTool
446446
from haystack import Document, Pipeline
447447
from haystack.dataclasses import ChatMessage
448448
from haystack.document_stores.in_memory import InMemoryDocumentStore
449-
from haystack.components.embedders.sentence_transformers_text_embedder import SentenceTransformersTextEmbedder
450-
from haystack.components.embedders.sentence_transformers_document_embedder import (
451-
SentenceTransformersDocumentEmbedder
452-
)
449+
# Requires: pip install sentence-transformers-haystack
450+
from haystack_integrations.components.embedders.sentence_transformers import SentenceTransformersTextEmbedder
451+
from haystack_integrations.components.embedders.sentence_transformers import SentenceTransformersDocumentEmbedder
453452
from haystack.components.generators.chat import OpenAIChatGenerator
454453
from haystack.components.retrievers import InMemoryEmbeddingRetriever
455454
from haystack.components.agents import Agent

0 commit comments

Comments
 (0)