Skip to content

Commit 2908b9f

Browse files
Sync Core Integrations API reference (qdrant) on Docusaurus (#10054)
Co-authored-by: davidsbatista <[email protected]>
1 parent 538e483 commit 2908b9f

File tree

4 files changed

+136
-16
lines changed
  • docs-website

4 files changed

+136
-16
lines changed

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

Lines changed: 34 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -584,9 +584,8 @@ Batch elements of an iterable into fixed-length chunks or blocks.
584584

585585
### QdrantDocumentStore
586586

587-
A QdrantDocumentStore implementation that you
588-
can use with any Qdrant instance: in-memory, disk-persisted, Docker-based,
589-
and Qdrant Cloud Cluster deployments.
587+
A QdrantDocumentStore implementation that you can use with any Qdrant instance: in-memory, disk-persisted,
588+
Docker-based, and Qdrant Cloud Cluster deployments.
590589

591590
Usage example by creating an in-memory instance:
592591

@@ -596,7 +595,8 @@ from haystack_integrations.document_stores.qdrant import QdrantDocumentStore
596595

597596
document_store = QdrantDocumentStore(
598597
":memory:",
599-
recreate_index=True
598+
recreate_index=True,
599+
embedding_dim=5
600600
)
601601
document_store.write_documents([
602602
Document(content="This is first", embedding=[0.0]*5),
@@ -662,6 +662,8 @@ def __init__(location: Optional[str] = None,
662662
payload_fields_to_index: Optional[List[dict]] = None) -> None
663663
```
664664

665+
Initializes a QdrantDocumentStore.
666+
665667
**Arguments**:
666668

667669
- `location`: If `":memory:"` - use in-memory Qdrant instance.
@@ -850,6 +852,34 @@ Asynchronously deletes documents that match the provided `document_ids` from the
850852
851853
- `document_ids`: the document ids to delete
852854
855+
<a id="haystack_integrations.document_stores.qdrant.document_store.QdrantDocumentStore.delete_all_documents"></a>
856+
857+
#### QdrantDocumentStore.delete\_all\_documents
858+
859+
```python
860+
def delete_all_documents(recreate_index: bool = False) -> None
861+
```
862+
863+
Deletes all documents from the document store.
864+
865+
**Arguments**:
866+
867+
- `recreate_index`: Whether to recreate the index after deleting all documents.
868+
869+
<a id="haystack_integrations.document_stores.qdrant.document_store.QdrantDocumentStore.delete_all_documents_async"></a>
870+
871+
#### QdrantDocumentStore.delete\_all\_documents\_async
872+
873+
```python
874+
async def delete_all_documents_async(recreate_index: bool = False) -> None
875+
```
876+
877+
Asynchronously deletes all documents from the document store.
878+
879+
**Arguments**:
880+
881+
- `recreate_index`: Whether to recreate the index after deleting all documents.
882+
853883
<a id="haystack_integrations.document_stores.qdrant.document_store.QdrantDocumentStore.from_dict"></a>
854884
855885
#### QdrantDocumentStore.from\_dict

docs-website/reference_versioned_docs/version-2.17/integrations-api/qdrant.md

Lines changed: 34 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -584,9 +584,8 @@ Batch elements of an iterable into fixed-length chunks or blocks.
584584

585585
### QdrantDocumentStore
586586

587-
A QdrantDocumentStore implementation that you
588-
can use with any Qdrant instance: in-memory, disk-persisted, Docker-based,
589-
and Qdrant Cloud Cluster deployments.
587+
A QdrantDocumentStore implementation that you can use with any Qdrant instance: in-memory, disk-persisted,
588+
Docker-based, and Qdrant Cloud Cluster deployments.
590589

591590
Usage example by creating an in-memory instance:
592591

@@ -596,7 +595,8 @@ from haystack_integrations.document_stores.qdrant import QdrantDocumentStore
596595

597596
document_store = QdrantDocumentStore(
598597
":memory:",
599-
recreate_index=True
598+
recreate_index=True,
599+
embedding_dim=5
600600
)
601601
document_store.write_documents([
602602
Document(content="This is first", embedding=[0.0]*5),
@@ -662,6 +662,8 @@ def __init__(location: Optional[str] = None,
662662
payload_fields_to_index: Optional[List[dict]] = None) -> None
663663
```
664664

665+
Initializes a QdrantDocumentStore.
666+
665667
**Arguments**:
666668

667669
- `location`: If `":memory:"` - use in-memory Qdrant instance.
@@ -850,6 +852,34 @@ Asynchronously deletes documents that match the provided `document_ids` from the
850852
851853
- `document_ids`: the document ids to delete
852854
855+
<a id="haystack_integrations.document_stores.qdrant.document_store.QdrantDocumentStore.delete_all_documents"></a>
856+
857+
#### QdrantDocumentStore.delete\_all\_documents
858+
859+
```python
860+
def delete_all_documents(recreate_index: bool = False) -> None
861+
```
862+
863+
Deletes all documents from the document store.
864+
865+
**Arguments**:
866+
867+
- `recreate_index`: Whether to recreate the index after deleting all documents.
868+
869+
<a id="haystack_integrations.document_stores.qdrant.document_store.QdrantDocumentStore.delete_all_documents_async"></a>
870+
871+
#### QdrantDocumentStore.delete\_all\_documents\_async
872+
873+
```python
874+
async def delete_all_documents_async(recreate_index: bool = False) -> None
875+
```
876+
877+
Asynchronously deletes all documents from the document store.
878+
879+
**Arguments**:
880+
881+
- `recreate_index`: Whether to recreate the index after deleting all documents.
882+
853883
<a id="haystack_integrations.document_stores.qdrant.document_store.QdrantDocumentStore.from_dict"></a>
854884
855885
#### QdrantDocumentStore.from\_dict

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

Lines changed: 34 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -584,9 +584,8 @@ Batch elements of an iterable into fixed-length chunks or blocks.
584584

585585
### QdrantDocumentStore
586586

587-
A QdrantDocumentStore implementation that you
588-
can use with any Qdrant instance: in-memory, disk-persisted, Docker-based,
589-
and Qdrant Cloud Cluster deployments.
587+
A QdrantDocumentStore implementation that you can use with any Qdrant instance: in-memory, disk-persisted,
588+
Docker-based, and Qdrant Cloud Cluster deployments.
590589

591590
Usage example by creating an in-memory instance:
592591

@@ -596,7 +595,8 @@ from haystack_integrations.document_stores.qdrant import QdrantDocumentStore
596595

597596
document_store = QdrantDocumentStore(
598597
":memory:",
599-
recreate_index=True
598+
recreate_index=True,
599+
embedding_dim=5
600600
)
601601
document_store.write_documents([
602602
Document(content="This is first", embedding=[0.0]*5),
@@ -662,6 +662,8 @@ def __init__(location: Optional[str] = None,
662662
payload_fields_to_index: Optional[List[dict]] = None) -> None
663663
```
664664

665+
Initializes a QdrantDocumentStore.
666+
665667
**Arguments**:
666668

667669
- `location`: If `":memory:"` - use in-memory Qdrant instance.
@@ -850,6 +852,34 @@ Asynchronously deletes documents that match the provided `document_ids` from the
850852
851853
- `document_ids`: the document ids to delete
852854
855+
<a id="haystack_integrations.document_stores.qdrant.document_store.QdrantDocumentStore.delete_all_documents"></a>
856+
857+
#### QdrantDocumentStore.delete\_all\_documents
858+
859+
```python
860+
def delete_all_documents(recreate_index: bool = False) -> None
861+
```
862+
863+
Deletes all documents from the document store.
864+
865+
**Arguments**:
866+
867+
- `recreate_index`: Whether to recreate the index after deleting all documents.
868+
869+
<a id="haystack_integrations.document_stores.qdrant.document_store.QdrantDocumentStore.delete_all_documents_async"></a>
870+
871+
#### QdrantDocumentStore.delete\_all\_documents\_async
872+
873+
```python
874+
async def delete_all_documents_async(recreate_index: bool = False) -> None
875+
```
876+
877+
Asynchronously deletes all documents from the document store.
878+
879+
**Arguments**:
880+
881+
- `recreate_index`: Whether to recreate the index after deleting all documents.
882+
853883
<a id="haystack_integrations.document_stores.qdrant.document_store.QdrantDocumentStore.from_dict"></a>
854884
855885
#### QdrantDocumentStore.from\_dict

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

Lines changed: 34 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -584,9 +584,8 @@ Batch elements of an iterable into fixed-length chunks or blocks.
584584

585585
### QdrantDocumentStore
586586

587-
A QdrantDocumentStore implementation that you
588-
can use with any Qdrant instance: in-memory, disk-persisted, Docker-based,
589-
and Qdrant Cloud Cluster deployments.
587+
A QdrantDocumentStore implementation that you can use with any Qdrant instance: in-memory, disk-persisted,
588+
Docker-based, and Qdrant Cloud Cluster deployments.
590589

591590
Usage example by creating an in-memory instance:
592591

@@ -596,7 +595,8 @@ from haystack_integrations.document_stores.qdrant import QdrantDocumentStore
596595

597596
document_store = QdrantDocumentStore(
598597
":memory:",
599-
recreate_index=True
598+
recreate_index=True,
599+
embedding_dim=5
600600
)
601601
document_store.write_documents([
602602
Document(content="This is first", embedding=[0.0]*5),
@@ -662,6 +662,8 @@ def __init__(location: Optional[str] = None,
662662
payload_fields_to_index: Optional[List[dict]] = None) -> None
663663
```
664664

665+
Initializes a QdrantDocumentStore.
666+
665667
**Arguments**:
666668

667669
- `location`: If `":memory:"` - use in-memory Qdrant instance.
@@ -850,6 +852,34 @@ Asynchronously deletes documents that match the provided `document_ids` from the
850852
851853
- `document_ids`: the document ids to delete
852854
855+
<a id="haystack_integrations.document_stores.qdrant.document_store.QdrantDocumentStore.delete_all_documents"></a>
856+
857+
#### QdrantDocumentStore.delete\_all\_documents
858+
859+
```python
860+
def delete_all_documents(recreate_index: bool = False) -> None
861+
```
862+
863+
Deletes all documents from the document store.
864+
865+
**Arguments**:
866+
867+
- `recreate_index`: Whether to recreate the index after deleting all documents.
868+
869+
<a id="haystack_integrations.document_stores.qdrant.document_store.QdrantDocumentStore.delete_all_documents_async"></a>
870+
871+
#### QdrantDocumentStore.delete\_all\_documents\_async
872+
873+
```python
874+
async def delete_all_documents_async(recreate_index: bool = False) -> None
875+
```
876+
877+
Asynchronously deletes all documents from the document store.
878+
879+
**Arguments**:
880+
881+
- `recreate_index`: Whether to recreate the index after deleting all documents.
882+
853883
<a id="haystack_integrations.document_stores.qdrant.document_store.QdrantDocumentStore.from_dict"></a>
854884
855885
#### QdrantDocumentStore.from\_dict

0 commit comments

Comments
 (0)