Skip to content

Commit b9f29cc

Browse files
docs: sync Core Integrations API reference (qdrant) on Docusaurus (#12040)
Co-authored-by: julian-risch <4181769+julian-risch@users.noreply.github.com>
1 parent 36fd147 commit b9f29cc

15 files changed

Lines changed: 165 additions & 90 deletions

File tree

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

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -357,8 +357,9 @@ Asynchronously run the Sparse Embedding Retriever on the given input data.
357357

358358
### QdrantHybridRetriever
359359

360-
A component for retrieving documents from an QdrantDocumentStore using both dense and sparse vectors
361-
and fusing the results using Reciprocal Rank Fusion.
360+
A component for retrieving documents from a QdrantDocumentStore using both dense and sparse vectors.
361+
362+
Fuses the results using Reciprocal Rank Fusion.
362363

363364
Usage example:
364365

@@ -550,8 +551,9 @@ Batch elements of an iterable into fixed-length chunks or blocks.
550551

551552
### QdrantDocumentStore
552553

553-
A QdrantDocumentStore implementation that you can use with any Qdrant instance: in-memory, disk-persisted,
554-
Docker-based, and Qdrant Cloud Cluster deployments.
554+
A QdrantDocumentStore implementation that you can use with any Qdrant instance.
555+
556+
Supports in-memory, disk-persisted, Docker-based, and Qdrant Cloud Cluster deployments.
555557

556558
Usage example by creating an in-memory instance:
557559

@@ -736,6 +738,7 @@ write_documents(
736738
```
737739

738740
Writes documents to Qdrant using the specified policy.
741+
739742
The QdrantDocumentStore can handle duplicate documents based on the given policy.
740743
The available policies are:
741744

@@ -761,6 +764,7 @@ write_documents_async(
761764
```
762765

763766
Asynchronously writes documents to Qdrant using the specified policy.
767+
764768
The QdrantDocumentStore can handle duplicate documents based on the given policy.
765769
The available policies are:
766770

@@ -1042,8 +1046,9 @@ count_unique_metadata_by_filter_async(
10421046
) -> dict[str, int]
10431047
```
10441048

1045-
Asynchronously returns the number of unique values for each specified metadata field among documents that
1046-
match the filters.
1049+
Asynchronously returns the number of unique values for each specified metadata field among documents.
1050+
1051+
Only documents that match the filters are considered.
10471052

10481053
**Parameters:**
10491054

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

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -357,8 +357,9 @@ Asynchronously run the Sparse Embedding Retriever on the given input data.
357357

358358
### QdrantHybridRetriever
359359

360-
A component for retrieving documents from an QdrantDocumentStore using both dense and sparse vectors
361-
and fusing the results using Reciprocal Rank Fusion.
360+
A component for retrieving documents from a QdrantDocumentStore using both dense and sparse vectors.
361+
362+
Fuses the results using Reciprocal Rank Fusion.
362363

363364
Usage example:
364365

@@ -550,8 +551,9 @@ Batch elements of an iterable into fixed-length chunks or blocks.
550551

551552
### QdrantDocumentStore
552553

553-
A QdrantDocumentStore implementation that you can use with any Qdrant instance: in-memory, disk-persisted,
554-
Docker-based, and Qdrant Cloud Cluster deployments.
554+
A QdrantDocumentStore implementation that you can use with any Qdrant instance.
555+
556+
Supports in-memory, disk-persisted, Docker-based, and Qdrant Cloud Cluster deployments.
555557

556558
Usage example by creating an in-memory instance:
557559

@@ -736,6 +738,7 @@ write_documents(
736738
```
737739

738740
Writes documents to Qdrant using the specified policy.
741+
739742
The QdrantDocumentStore can handle duplicate documents based on the given policy.
740743
The available policies are:
741744

@@ -761,6 +764,7 @@ write_documents_async(
761764
```
762765

763766
Asynchronously writes documents to Qdrant using the specified policy.
767+
764768
The QdrantDocumentStore can handle duplicate documents based on the given policy.
765769
The available policies are:
766770

@@ -1042,8 +1046,9 @@ count_unique_metadata_by_filter_async(
10421046
) -> dict[str, int]
10431047
```
10441048

1045-
Asynchronously returns the number of unique values for each specified metadata field among documents that
1046-
match the filters.
1049+
Asynchronously returns the number of unique values for each specified metadata field among documents.
1050+
1051+
Only documents that match the filters are considered.
10471052

10481053
**Parameters:**
10491054

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

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -357,8 +357,9 @@ Asynchronously run the Sparse Embedding Retriever on the given input data.
357357

358358
### QdrantHybridRetriever
359359

360-
A component for retrieving documents from an QdrantDocumentStore using both dense and sparse vectors
361-
and fusing the results using Reciprocal Rank Fusion.
360+
A component for retrieving documents from a QdrantDocumentStore using both dense and sparse vectors.
361+
362+
Fuses the results using Reciprocal Rank Fusion.
362363

363364
Usage example:
364365

@@ -550,8 +551,9 @@ Batch elements of an iterable into fixed-length chunks or blocks.
550551

551552
### QdrantDocumentStore
552553

553-
A QdrantDocumentStore implementation that you can use with any Qdrant instance: in-memory, disk-persisted,
554-
Docker-based, and Qdrant Cloud Cluster deployments.
554+
A QdrantDocumentStore implementation that you can use with any Qdrant instance.
555+
556+
Supports in-memory, disk-persisted, Docker-based, and Qdrant Cloud Cluster deployments.
555557

556558
Usage example by creating an in-memory instance:
557559

@@ -736,6 +738,7 @@ write_documents(
736738
```
737739

738740
Writes documents to Qdrant using the specified policy.
741+
739742
The QdrantDocumentStore can handle duplicate documents based on the given policy.
740743
The available policies are:
741744

@@ -761,6 +764,7 @@ write_documents_async(
761764
```
762765

763766
Asynchronously writes documents to Qdrant using the specified policy.
767+
764768
The QdrantDocumentStore can handle duplicate documents based on the given policy.
765769
The available policies are:
766770

@@ -1042,8 +1046,9 @@ count_unique_metadata_by_filter_async(
10421046
) -> dict[str, int]
10431047
```
10441048

1045-
Asynchronously returns the number of unique values for each specified metadata field among documents that
1046-
match the filters.
1049+
Asynchronously returns the number of unique values for each specified metadata field among documents.
1050+
1051+
Only documents that match the filters are considered.
10471052

10481053
**Parameters:**
10491054

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

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -357,8 +357,9 @@ Asynchronously run the Sparse Embedding Retriever on the given input data.
357357

358358
### QdrantHybridRetriever
359359

360-
A component for retrieving documents from an QdrantDocumentStore using both dense and sparse vectors
361-
and fusing the results using Reciprocal Rank Fusion.
360+
A component for retrieving documents from a QdrantDocumentStore using both dense and sparse vectors.
361+
362+
Fuses the results using Reciprocal Rank Fusion.
362363

363364
Usage example:
364365

@@ -550,8 +551,9 @@ Batch elements of an iterable into fixed-length chunks or blocks.
550551

551552
### QdrantDocumentStore
552553

553-
A QdrantDocumentStore implementation that you can use with any Qdrant instance: in-memory, disk-persisted,
554-
Docker-based, and Qdrant Cloud Cluster deployments.
554+
A QdrantDocumentStore implementation that you can use with any Qdrant instance.
555+
556+
Supports in-memory, disk-persisted, Docker-based, and Qdrant Cloud Cluster deployments.
555557

556558
Usage example by creating an in-memory instance:
557559

@@ -736,6 +738,7 @@ write_documents(
736738
```
737739

738740
Writes documents to Qdrant using the specified policy.
741+
739742
The QdrantDocumentStore can handle duplicate documents based on the given policy.
740743
The available policies are:
741744

@@ -761,6 +764,7 @@ write_documents_async(
761764
```
762765

763766
Asynchronously writes documents to Qdrant using the specified policy.
767+
764768
The QdrantDocumentStore can handle duplicate documents based on the given policy.
765769
The available policies are:
766770

@@ -1042,8 +1046,9 @@ count_unique_metadata_by_filter_async(
10421046
) -> dict[str, int]
10431047
```
10441048

1045-
Asynchronously returns the number of unique values for each specified metadata field among documents that
1046-
match the filters.
1049+
Asynchronously returns the number of unique values for each specified metadata field among documents.
1050+
1051+
Only documents that match the filters are considered.
10471052

10481053
**Parameters:**
10491054

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

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -357,8 +357,9 @@ Asynchronously run the Sparse Embedding Retriever on the given input data.
357357

358358
### QdrantHybridRetriever
359359

360-
A component for retrieving documents from an QdrantDocumentStore using both dense and sparse vectors
361-
and fusing the results using Reciprocal Rank Fusion.
360+
A component for retrieving documents from a QdrantDocumentStore using both dense and sparse vectors.
361+
362+
Fuses the results using Reciprocal Rank Fusion.
362363

363364
Usage example:
364365

@@ -550,8 +551,9 @@ Batch elements of an iterable into fixed-length chunks or blocks.
550551

551552
### QdrantDocumentStore
552553

553-
A QdrantDocumentStore implementation that you can use with any Qdrant instance: in-memory, disk-persisted,
554-
Docker-based, and Qdrant Cloud Cluster deployments.
554+
A QdrantDocumentStore implementation that you can use with any Qdrant instance.
555+
556+
Supports in-memory, disk-persisted, Docker-based, and Qdrant Cloud Cluster deployments.
555557

556558
Usage example by creating an in-memory instance:
557559

@@ -736,6 +738,7 @@ write_documents(
736738
```
737739

738740
Writes documents to Qdrant using the specified policy.
741+
739742
The QdrantDocumentStore can handle duplicate documents based on the given policy.
740743
The available policies are:
741744

@@ -761,6 +764,7 @@ write_documents_async(
761764
```
762765

763766
Asynchronously writes documents to Qdrant using the specified policy.
767+
764768
The QdrantDocumentStore can handle duplicate documents based on the given policy.
765769
The available policies are:
766770

@@ -1042,8 +1046,9 @@ count_unique_metadata_by_filter_async(
10421046
) -> dict[str, int]
10431047
```
10441048

1045-
Asynchronously returns the number of unique values for each specified metadata field among documents that
1046-
match the filters.
1049+
Asynchronously returns the number of unique values for each specified metadata field among documents.
1050+
1051+
Only documents that match the filters are considered.
10471052

10481053
**Parameters:**
10491054

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

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -357,8 +357,9 @@ Asynchronously run the Sparse Embedding Retriever on the given input data.
357357

358358
### QdrantHybridRetriever
359359

360-
A component for retrieving documents from an QdrantDocumentStore using both dense and sparse vectors
361-
and fusing the results using Reciprocal Rank Fusion.
360+
A component for retrieving documents from a QdrantDocumentStore using both dense and sparse vectors.
361+
362+
Fuses the results using Reciprocal Rank Fusion.
362363

363364
Usage example:
364365

@@ -550,8 +551,9 @@ Batch elements of an iterable into fixed-length chunks or blocks.
550551

551552
### QdrantDocumentStore
552553

553-
A QdrantDocumentStore implementation that you can use with any Qdrant instance: in-memory, disk-persisted,
554-
Docker-based, and Qdrant Cloud Cluster deployments.
554+
A QdrantDocumentStore implementation that you can use with any Qdrant instance.
555+
556+
Supports in-memory, disk-persisted, Docker-based, and Qdrant Cloud Cluster deployments.
555557

556558
Usage example by creating an in-memory instance:
557559

@@ -736,6 +738,7 @@ write_documents(
736738
```
737739

738740
Writes documents to Qdrant using the specified policy.
741+
739742
The QdrantDocumentStore can handle duplicate documents based on the given policy.
740743
The available policies are:
741744

@@ -761,6 +764,7 @@ write_documents_async(
761764
```
762765

763766
Asynchronously writes documents to Qdrant using the specified policy.
767+
764768
The QdrantDocumentStore can handle duplicate documents based on the given policy.
765769
The available policies are:
766770

@@ -1042,8 +1046,9 @@ count_unique_metadata_by_filter_async(
10421046
) -> dict[str, int]
10431047
```
10441048

1045-
Asynchronously returns the number of unique values for each specified metadata field among documents that
1046-
match the filters.
1049+
Asynchronously returns the number of unique values for each specified metadata field among documents.
1050+
1051+
Only documents that match the filters are considered.
10471052

10481053
**Parameters:**
10491054

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

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -357,8 +357,9 @@ Asynchronously run the Sparse Embedding Retriever on the given input data.
357357

358358
### QdrantHybridRetriever
359359

360-
A component for retrieving documents from an QdrantDocumentStore using both dense and sparse vectors
361-
and fusing the results using Reciprocal Rank Fusion.
360+
A component for retrieving documents from a QdrantDocumentStore using both dense and sparse vectors.
361+
362+
Fuses the results using Reciprocal Rank Fusion.
362363

363364
Usage example:
364365

@@ -550,8 +551,9 @@ Batch elements of an iterable into fixed-length chunks or blocks.
550551

551552
### QdrantDocumentStore
552553

553-
A QdrantDocumentStore implementation that you can use with any Qdrant instance: in-memory, disk-persisted,
554-
Docker-based, and Qdrant Cloud Cluster deployments.
554+
A QdrantDocumentStore implementation that you can use with any Qdrant instance.
555+
556+
Supports in-memory, disk-persisted, Docker-based, and Qdrant Cloud Cluster deployments.
555557

556558
Usage example by creating an in-memory instance:
557559

@@ -736,6 +738,7 @@ write_documents(
736738
```
737739

738740
Writes documents to Qdrant using the specified policy.
741+
739742
The QdrantDocumentStore can handle duplicate documents based on the given policy.
740743
The available policies are:
741744

@@ -761,6 +764,7 @@ write_documents_async(
761764
```
762765

763766
Asynchronously writes documents to Qdrant using the specified policy.
767+
764768
The QdrantDocumentStore can handle duplicate documents based on the given policy.
765769
The available policies are:
766770

@@ -1042,8 +1046,9 @@ count_unique_metadata_by_filter_async(
10421046
) -> dict[str, int]
10431047
```
10441048

1045-
Asynchronously returns the number of unique values for each specified metadata field among documents that
1046-
match the filters.
1049+
Asynchronously returns the number of unique values for each specified metadata field among documents.
1050+
1051+
Only documents that match the filters are considered.
10471052

10481053
**Parameters:**
10491054

0 commit comments

Comments
 (0)