Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 65 additions & 1 deletion docs-website/reference/integrations-api/qdrant.md
Original file line number Diff line number Diff line change
Expand Up @@ -778,13 +778,29 @@ count_documents() -> int

Returns the number of documents present in the Document Store.

**Returns:**

- <code>int</code> – The number of documents in the collection.

**Raises:**

- <code>QdrantStoreError</code> – Counting documents fails.

#### count_documents_async

```python
count_documents_async() -> int
```

Asynchronously returns the number of documents present in the document dtore.
Asynchronously returns the number of documents present in the document store.

**Returns:**

- <code>int</code> – The number of documents in the collection.

**Raises:**

- <code>QdrantStoreError</code> – Counting documents fails.

#### filter_documents

Expand Down Expand Up @@ -983,6 +999,10 @@ Deletes all documents from the document store.

- **recreate_index** (<code>bool</code>) – Whether to recreate the index after deleting all documents.

**Raises:**

- <code>QdrantStoreError</code> – Deleting documents or recreating the collection fails.

#### delete_all_documents_async

```python
Expand All @@ -995,6 +1015,10 @@ Asynchronously deletes all documents from the document store.

- **recreate_index** (<code>bool</code>) – Whether to recreate the index after deleting all documents.

**Raises:**

- <code>QdrantStoreError</code> – Deleting documents or recreating the collection fails.

#### count_documents_by_filter

```python
Expand All @@ -1012,6 +1036,10 @@ Returns the number of documents that match the provided filters.

- <code>int</code> – The number of documents that match the filters.

**Raises:**

- <code>QdrantStoreError</code> – Counting documents matching the filters fails.

#### count_documents_by_filter_async

```python
Expand All @@ -1029,6 +1057,10 @@ Asynchronously returns the number of documents that match the provided filters.

- <code>int</code> – The number of documents that match the filters.

**Raises:**

- <code>QdrantStoreError</code> – Counting documents matching the filters fails.

#### get_metadata_fields_info

```python
Expand All @@ -1049,6 +1081,10 @@ payload["meta"].
{"category": {"type": "keyword"}, "priority": {"type": "long"}}
```

**Raises:**

- <code>QdrantStoreError</code> – Retrieving or processing metadata field information fails.

#### get_metadata_fields_info_async

```python
Expand All @@ -1069,6 +1105,10 @@ payload["meta"].
{"category": {"type": "keyword"}, "priority": {"type": "long"}}
```

**Raises:**

- <code>QdrantStoreError</code> – Retrieving or processing metadata field information fails.

#### get_metadata_field_min_max

```python
Expand All @@ -1087,6 +1127,10 @@ Returns the minimum and maximum values for the given metadata field.
metadata field across all documents. Returns `{"min": None, "max": None}` if no documents have
the field.

**Raises:**

- <code>QdrantStoreError</code> – Retrieving or computing the metadata bounds fails.

#### get_metadata_field_min_max_async

```python
Expand All @@ -1105,6 +1149,10 @@ Asynchronously returns the minimum and maximum values for the given metadata fie
metadata field across all documents. Returns `{"min": None, "max": None}` if no documents have
the field.

**Raises:**

- <code>QdrantStoreError</code> – Retrieving or computing the metadata bounds fails.

#### count_unique_metadata_by_filter

```python
Expand All @@ -1126,6 +1174,10 @@ Returns the number of unique values for each specified metadata field among docu
- <code>dict\[str, int\]</code> – A dictionary mapping each metadata field name to the count of its unique values among the filtered
documents.

**Raises:**

- <code>QdrantStoreError</code> – Retrieving or counting unique metadata values fails.

#### count_unique_metadata_by_filter_async

```python
Expand All @@ -1149,6 +1201,10 @@ Only documents that match the filters are considered.
- <code>dict\[str, int\]</code> – A dictionary mapping each metadata field name to the count of its unique values among the filtered
documents.

**Raises:**

- <code>QdrantStoreError</code> – Retrieving or counting unique metadata values fails.

#### get_metadata_field_unique_values

```python
Expand Down Expand Up @@ -1181,6 +1237,10 @@ matching documents must be scrolled through to compute the total count.

- <code>tuple\[list\[Any\], int\]</code> – A tuple containing (list of unique values, total count of unique matching values).

**Raises:**

- <code>QdrantStoreError</code> – Retrieving or processing unique metadata values fails.

#### get_metadata_field_unique_values_async

```python
Expand Down Expand Up @@ -1213,6 +1273,10 @@ matching documents must be scrolled through to compute the total count.

- <code>tuple\[list\[Any\], int\]</code> – A tuple containing (list of unique values, total count of unique matching values).

**Raises:**

- <code>QdrantStoreError</code> – Retrieving or processing unique metadata values fails.

#### from_dict

```python
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -778,13 +778,29 @@ count_documents() -> int

Returns the number of documents present in the Document Store.

**Returns:**

- <code>int</code> – The number of documents in the collection.

**Raises:**

- <code>QdrantStoreError</code> – Counting documents fails.

#### count_documents_async

```python
count_documents_async() -> int
```

Asynchronously returns the number of documents present in the document dtore.
Asynchronously returns the number of documents present in the document store.

**Returns:**

- <code>int</code> – The number of documents in the collection.

**Raises:**

- <code>QdrantStoreError</code> – Counting documents fails.

#### filter_documents

Expand Down Expand Up @@ -983,6 +999,10 @@ Deletes all documents from the document store.

- **recreate_index** (<code>bool</code>) – Whether to recreate the index after deleting all documents.

**Raises:**

- <code>QdrantStoreError</code> – Deleting documents or recreating the collection fails.

#### delete_all_documents_async

```python
Expand All @@ -995,6 +1015,10 @@ Asynchronously deletes all documents from the document store.

- **recreate_index** (<code>bool</code>) – Whether to recreate the index after deleting all documents.

**Raises:**

- <code>QdrantStoreError</code> – Deleting documents or recreating the collection fails.

#### count_documents_by_filter

```python
Expand All @@ -1012,6 +1036,10 @@ Returns the number of documents that match the provided filters.

- <code>int</code> – The number of documents that match the filters.

**Raises:**

- <code>QdrantStoreError</code> – Counting documents matching the filters fails.

#### count_documents_by_filter_async

```python
Expand All @@ -1029,6 +1057,10 @@ Asynchronously returns the number of documents that match the provided filters.

- <code>int</code> – The number of documents that match the filters.

**Raises:**

- <code>QdrantStoreError</code> – Counting documents matching the filters fails.

#### get_metadata_fields_info

```python
Expand All @@ -1049,6 +1081,10 @@ payload["meta"].
{"category": {"type": "keyword"}, "priority": {"type": "long"}}
```

**Raises:**

- <code>QdrantStoreError</code> – Retrieving or processing metadata field information fails.

#### get_metadata_fields_info_async

```python
Expand All @@ -1069,6 +1105,10 @@ payload["meta"].
{"category": {"type": "keyword"}, "priority": {"type": "long"}}
```

**Raises:**

- <code>QdrantStoreError</code> – Retrieving or processing metadata field information fails.

#### get_metadata_field_min_max

```python
Expand All @@ -1087,6 +1127,10 @@ Returns the minimum and maximum values for the given metadata field.
metadata field across all documents. Returns `{"min": None, "max": None}` if no documents have
the field.

**Raises:**

- <code>QdrantStoreError</code> – Retrieving or computing the metadata bounds fails.

#### get_metadata_field_min_max_async

```python
Expand All @@ -1105,6 +1149,10 @@ Asynchronously returns the minimum and maximum values for the given metadata fie
metadata field across all documents. Returns `{"min": None, "max": None}` if no documents have
the field.

**Raises:**

- <code>QdrantStoreError</code> – Retrieving or computing the metadata bounds fails.

#### count_unique_metadata_by_filter

```python
Expand All @@ -1126,6 +1174,10 @@ Returns the number of unique values for each specified metadata field among docu
- <code>dict\[str, int\]</code> – A dictionary mapping each metadata field name to the count of its unique values among the filtered
documents.

**Raises:**

- <code>QdrantStoreError</code> – Retrieving or counting unique metadata values fails.

#### count_unique_metadata_by_filter_async

```python
Expand All @@ -1149,6 +1201,10 @@ Only documents that match the filters are considered.
- <code>dict\[str, int\]</code> – A dictionary mapping each metadata field name to the count of its unique values among the filtered
documents.

**Raises:**

- <code>QdrantStoreError</code> – Retrieving or counting unique metadata values fails.

#### get_metadata_field_unique_values

```python
Expand Down Expand Up @@ -1181,6 +1237,10 @@ matching documents must be scrolled through to compute the total count.

- <code>tuple\[list\[Any\], int\]</code> – A tuple containing (list of unique values, total count of unique matching values).

**Raises:**

- <code>QdrantStoreError</code> – Retrieving or processing unique metadata values fails.

#### get_metadata_field_unique_values_async

```python
Expand Down Expand Up @@ -1213,6 +1273,10 @@ matching documents must be scrolled through to compute the total count.

- <code>tuple\[list\[Any\], int\]</code> – A tuple containing (list of unique values, total count of unique matching values).

**Raises:**

- <code>QdrantStoreError</code> – Retrieving or processing unique metadata values fails.

#### from_dict

```python
Expand Down
Loading