Skip to content

Commit 4c83c80

Browse files
docs: sync Core Integrations API reference (elasticsearch) on Docusaurus (#12008)
Co-authored-by: anakin87 <44616784+anakin87@users.noreply.github.com>
1 parent 83b84d7 commit 4c83c80

15 files changed

Lines changed: 165 additions & 60 deletions

File tree

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

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -156,9 +156,17 @@ Usage example:
156156

157157
```python
158158
from haystack import Document
159-
from haystack.components.embedders import SentenceTransformersTextEmbedder
160-
from haystack_integrations.document_stores.elasticsearch import ElasticsearchDocumentStore
161-
from haystack_integrations.components.retrievers.elasticsearch import ElasticsearchEmbeddingRetriever
159+
160+
# Requires: pip install sentence-transformers-haystack
161+
from haystack_integrations.components.embedders.sentence_transformers import (
162+
SentenceTransformersTextEmbedder,
163+
)
164+
from haystack_integrations.document_stores.elasticsearch import (
165+
ElasticsearchDocumentStore,
166+
)
167+
from haystack_integrations.components.retrievers.elasticsearch import (
168+
ElasticsearchEmbeddingRetriever,
169+
)
162170

163171
document_store = ElasticsearchDocumentStore(hosts="http://localhost:9200")
164172
retriever = ElasticsearchEmbeddingRetriever(document_store=document_store)
@@ -173,7 +181,6 @@ documents = [
173181
document_store.write_documents(documents)
174182

175183
te = SentenceTransformersTextEmbedder()
176-
te.warm_up()
177184
query_embeddings = te.run("Who lives in Berlin?")["embedding"]
178185

179186
result = retriever.run(query=query_embeddings)

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

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -156,9 +156,17 @@ Usage example:
156156

157157
```python
158158
from haystack import Document
159-
from haystack.components.embedders import SentenceTransformersTextEmbedder
160-
from haystack_integrations.document_stores.elasticsearch import ElasticsearchDocumentStore
161-
from haystack_integrations.components.retrievers.elasticsearch import ElasticsearchEmbeddingRetriever
159+
160+
# Requires: pip install sentence-transformers-haystack
161+
from haystack_integrations.components.embedders.sentence_transformers import (
162+
SentenceTransformersTextEmbedder,
163+
)
164+
from haystack_integrations.document_stores.elasticsearch import (
165+
ElasticsearchDocumentStore,
166+
)
167+
from haystack_integrations.components.retrievers.elasticsearch import (
168+
ElasticsearchEmbeddingRetriever,
169+
)
162170

163171
document_store = ElasticsearchDocumentStore(hosts="http://localhost:9200")
164172
retriever = ElasticsearchEmbeddingRetriever(document_store=document_store)
@@ -173,7 +181,6 @@ documents = [
173181
document_store.write_documents(documents)
174182

175183
te = SentenceTransformersTextEmbedder()
176-
te.warm_up()
177184
query_embeddings = te.run("Who lives in Berlin?")["embedding"]
178185

179186
result = retriever.run(query=query_embeddings)

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

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -156,9 +156,17 @@ Usage example:
156156

157157
```python
158158
from haystack import Document
159-
from haystack.components.embedders import SentenceTransformersTextEmbedder
160-
from haystack_integrations.document_stores.elasticsearch import ElasticsearchDocumentStore
161-
from haystack_integrations.components.retrievers.elasticsearch import ElasticsearchEmbeddingRetriever
159+
160+
# Requires: pip install sentence-transformers-haystack
161+
from haystack_integrations.components.embedders.sentence_transformers import (
162+
SentenceTransformersTextEmbedder,
163+
)
164+
from haystack_integrations.document_stores.elasticsearch import (
165+
ElasticsearchDocumentStore,
166+
)
167+
from haystack_integrations.components.retrievers.elasticsearch import (
168+
ElasticsearchEmbeddingRetriever,
169+
)
162170

163171
document_store = ElasticsearchDocumentStore(hosts="http://localhost:9200")
164172
retriever = ElasticsearchEmbeddingRetriever(document_store=document_store)
@@ -173,7 +181,6 @@ documents = [
173181
document_store.write_documents(documents)
174182

175183
te = SentenceTransformersTextEmbedder()
176-
te.warm_up()
177184
query_embeddings = te.run("Who lives in Berlin?")["embedding"]
178185

179186
result = retriever.run(query=query_embeddings)

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

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -156,9 +156,17 @@ Usage example:
156156

157157
```python
158158
from haystack import Document
159-
from haystack.components.embedders import SentenceTransformersTextEmbedder
160-
from haystack_integrations.document_stores.elasticsearch import ElasticsearchDocumentStore
161-
from haystack_integrations.components.retrievers.elasticsearch import ElasticsearchEmbeddingRetriever
159+
160+
# Requires: pip install sentence-transformers-haystack
161+
from haystack_integrations.components.embedders.sentence_transformers import (
162+
SentenceTransformersTextEmbedder,
163+
)
164+
from haystack_integrations.document_stores.elasticsearch import (
165+
ElasticsearchDocumentStore,
166+
)
167+
from haystack_integrations.components.retrievers.elasticsearch import (
168+
ElasticsearchEmbeddingRetriever,
169+
)
162170

163171
document_store = ElasticsearchDocumentStore(hosts="http://localhost:9200")
164172
retriever = ElasticsearchEmbeddingRetriever(document_store=document_store)
@@ -173,7 +181,6 @@ documents = [
173181
document_store.write_documents(documents)
174182

175183
te = SentenceTransformersTextEmbedder()
176-
te.warm_up()
177184
query_embeddings = te.run("Who lives in Berlin?")["embedding"]
178185

179186
result = retriever.run(query=query_embeddings)

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

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -156,9 +156,17 @@ Usage example:
156156

157157
```python
158158
from haystack import Document
159-
from haystack.components.embedders import SentenceTransformersTextEmbedder
160-
from haystack_integrations.document_stores.elasticsearch import ElasticsearchDocumentStore
161-
from haystack_integrations.components.retrievers.elasticsearch import ElasticsearchEmbeddingRetriever
159+
160+
# Requires: pip install sentence-transformers-haystack
161+
from haystack_integrations.components.embedders.sentence_transformers import (
162+
SentenceTransformersTextEmbedder,
163+
)
164+
from haystack_integrations.document_stores.elasticsearch import (
165+
ElasticsearchDocumentStore,
166+
)
167+
from haystack_integrations.components.retrievers.elasticsearch import (
168+
ElasticsearchEmbeddingRetriever,
169+
)
162170

163171
document_store = ElasticsearchDocumentStore(hosts="http://localhost:9200")
164172
retriever = ElasticsearchEmbeddingRetriever(document_store=document_store)
@@ -173,7 +181,6 @@ documents = [
173181
document_store.write_documents(documents)
174182

175183
te = SentenceTransformersTextEmbedder()
176-
te.warm_up()
177184
query_embeddings = te.run("Who lives in Berlin?")["embedding"]
178185

179186
result = retriever.run(query=query_embeddings)

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

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -156,9 +156,17 @@ Usage example:
156156

157157
```python
158158
from haystack import Document
159-
from haystack.components.embedders import SentenceTransformersTextEmbedder
160-
from haystack_integrations.document_stores.elasticsearch import ElasticsearchDocumentStore
161-
from haystack_integrations.components.retrievers.elasticsearch import ElasticsearchEmbeddingRetriever
159+
160+
# Requires: pip install sentence-transformers-haystack
161+
from haystack_integrations.components.embedders.sentence_transformers import (
162+
SentenceTransformersTextEmbedder,
163+
)
164+
from haystack_integrations.document_stores.elasticsearch import (
165+
ElasticsearchDocumentStore,
166+
)
167+
from haystack_integrations.components.retrievers.elasticsearch import (
168+
ElasticsearchEmbeddingRetriever,
169+
)
162170

163171
document_store = ElasticsearchDocumentStore(hosts="http://localhost:9200")
164172
retriever = ElasticsearchEmbeddingRetriever(document_store=document_store)
@@ -173,7 +181,6 @@ documents = [
173181
document_store.write_documents(documents)
174182

175183
te = SentenceTransformersTextEmbedder()
176-
te.warm_up()
177184
query_embeddings = te.run("Who lives in Berlin?")["embedding"]
178185

179186
result = retriever.run(query=query_embeddings)

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

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -156,9 +156,17 @@ Usage example:
156156

157157
```python
158158
from haystack import Document
159-
from haystack.components.embedders import SentenceTransformersTextEmbedder
160-
from haystack_integrations.document_stores.elasticsearch import ElasticsearchDocumentStore
161-
from haystack_integrations.components.retrievers.elasticsearch import ElasticsearchEmbeddingRetriever
159+
160+
# Requires: pip install sentence-transformers-haystack
161+
from haystack_integrations.components.embedders.sentence_transformers import (
162+
SentenceTransformersTextEmbedder,
163+
)
164+
from haystack_integrations.document_stores.elasticsearch import (
165+
ElasticsearchDocumentStore,
166+
)
167+
from haystack_integrations.components.retrievers.elasticsearch import (
168+
ElasticsearchEmbeddingRetriever,
169+
)
162170

163171
document_store = ElasticsearchDocumentStore(hosts="http://localhost:9200")
164172
retriever = ElasticsearchEmbeddingRetriever(document_store=document_store)
@@ -173,7 +181,6 @@ documents = [
173181
document_store.write_documents(documents)
174182

175183
te = SentenceTransformersTextEmbedder()
176-
te.warm_up()
177184
query_embeddings = te.run("Who lives in Berlin?")["embedding"]
178185

179186
result = retriever.run(query=query_embeddings)

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

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -156,9 +156,17 @@ Usage example:
156156

157157
```python
158158
from haystack import Document
159-
from haystack.components.embedders import SentenceTransformersTextEmbedder
160-
from haystack_integrations.document_stores.elasticsearch import ElasticsearchDocumentStore
161-
from haystack_integrations.components.retrievers.elasticsearch import ElasticsearchEmbeddingRetriever
159+
160+
# Requires: pip install sentence-transformers-haystack
161+
from haystack_integrations.components.embedders.sentence_transformers import (
162+
SentenceTransformersTextEmbedder,
163+
)
164+
from haystack_integrations.document_stores.elasticsearch import (
165+
ElasticsearchDocumentStore,
166+
)
167+
from haystack_integrations.components.retrievers.elasticsearch import (
168+
ElasticsearchEmbeddingRetriever,
169+
)
162170

163171
document_store = ElasticsearchDocumentStore(hosts="http://localhost:9200")
164172
retriever = ElasticsearchEmbeddingRetriever(document_store=document_store)
@@ -173,7 +181,6 @@ documents = [
173181
document_store.write_documents(documents)
174182

175183
te = SentenceTransformersTextEmbedder()
176-
te.warm_up()
177184
query_embeddings = te.run("Who lives in Berlin?")["embedding"]
178185

179186
result = retriever.run(query=query_embeddings)

docs-website/reference_versioned_docs/version-2.25/integrations-api/elasticsearch.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -156,9 +156,17 @@ Usage example:
156156

157157
```python
158158
from haystack import Document
159-
from haystack.components.embedders import SentenceTransformersTextEmbedder
160-
from haystack_integrations.document_stores.elasticsearch import ElasticsearchDocumentStore
161-
from haystack_integrations.components.retrievers.elasticsearch import ElasticsearchEmbeddingRetriever
159+
160+
# Requires: pip install sentence-transformers-haystack
161+
from haystack_integrations.components.embedders.sentence_transformers import (
162+
SentenceTransformersTextEmbedder,
163+
)
164+
from haystack_integrations.document_stores.elasticsearch import (
165+
ElasticsearchDocumentStore,
166+
)
167+
from haystack_integrations.components.retrievers.elasticsearch import (
168+
ElasticsearchEmbeddingRetriever,
169+
)
162170

163171
document_store = ElasticsearchDocumentStore(hosts="http://localhost:9200")
164172
retriever = ElasticsearchEmbeddingRetriever(document_store=document_store)
@@ -173,7 +181,6 @@ documents = [
173181
document_store.write_documents(documents)
174182

175183
te = SentenceTransformersTextEmbedder()
176-
te.warm_up()
177184
query_embeddings = te.run("Who lives in Berlin?")["embedding"]
178185

179186
result = retriever.run(query=query_embeddings)

docs-website/reference_versioned_docs/version-2.26/integrations-api/elasticsearch.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -156,9 +156,17 @@ Usage example:
156156

157157
```python
158158
from haystack import Document
159-
from haystack.components.embedders import SentenceTransformersTextEmbedder
160-
from haystack_integrations.document_stores.elasticsearch import ElasticsearchDocumentStore
161-
from haystack_integrations.components.retrievers.elasticsearch import ElasticsearchEmbeddingRetriever
159+
160+
# Requires: pip install sentence-transformers-haystack
161+
from haystack_integrations.components.embedders.sentence_transformers import (
162+
SentenceTransformersTextEmbedder,
163+
)
164+
from haystack_integrations.document_stores.elasticsearch import (
165+
ElasticsearchDocumentStore,
166+
)
167+
from haystack_integrations.components.retrievers.elasticsearch import (
168+
ElasticsearchEmbeddingRetriever,
169+
)
162170

163171
document_store = ElasticsearchDocumentStore(hosts="http://localhost:9200")
164172
retriever = ElasticsearchEmbeddingRetriever(document_store=document_store)
@@ -173,7 +181,6 @@ documents = [
173181
document_store.write_documents(documents)
174182

175183
te = SentenceTransformersTextEmbedder()
176-
te.warm_up()
177184
query_embeddings = te.run("Who lives in Berlin?")["embedding"]
178185

179186
result = retriever.run(query=query_embeddings)

0 commit comments

Comments
 (0)