Skip to content

Commit 176fd87

Browse files
HaystackBotdavidsbatista
HaystackBot
and
davidsbatista
authored
Sync Core Integrations API reference (faiss) on Docusaurus (#10897)
Co-authored-by: davidsbatista <7937824+davidsbatista@users.noreply.github.com>
1 parent 8dc90d6 commit 176fd87

10 files changed

Lines changed: 60 additions & 40 deletions

File tree

  • docs-website

‎docs-website/reference/integrations-api/faiss.md‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,9 +56,11 @@ __init__(
5656
filters: dict[str, Any] | None = None,
5757
top_k: int = 10,
5858
filter_policy: str | FilterPolicy = FilterPolicy.REPLACE
59-
)
59+
) -> None
6060
```
6161

62+
Initialize FAISSEmbeddingRetriever.
63+
6264
**Parameters:**
6365

6466
- **document_store** (<code>FAISSDocumentStore</code>) – An instance of `FAISSDocumentStore`.
@@ -169,7 +171,7 @@ __init__(
169171
index_path: str | None = None,
170172
index_string: str = "Flat",
171173
embedding_dim: int = 768,
172-
)
174+
) -> None
173175
```
174176

175177
Initializes the FAISSDocumentStore.
@@ -398,7 +400,7 @@ Returns all unique values for a specific metadata field.
398400

399401
```python
400402
count_unique_metadata_by_filter(
401-
filters: dict[str, Any], fields: list[str]
403+
filters: dict[str, Any], metadata_fields: list[str]
402404
) -> dict[str, int]
403405
```
404406

@@ -407,7 +409,7 @@ Returns a count of unique values for multiple metadata fields, optionally scoped
407409
**Parameters:**
408410

409411
- **filters** (<code>dict\[str, Any\]</code>) – A dictionary of filters to apply.
410-
- **fields** (<code>list\[str\]</code>) – A list of metadata field names to count unique values for.
412+
- **metadata_fields** (<code>list\[str\]</code>) – A list of metadata field names to count unique values for.
411413

412414
**Returns:**
413415

‎docs-website/reference_versioned_docs/version-2.18/integrations-api/faiss.md‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,9 +56,11 @@ __init__(
5656
filters: dict[str, Any] | None = None,
5757
top_k: int = 10,
5858
filter_policy: str | FilterPolicy = FilterPolicy.REPLACE
59-
)
59+
) -> None
6060
```
6161

62+
Initialize FAISSEmbeddingRetriever.
63+
6264
**Parameters:**
6365

6466
- **document_store** (<code>FAISSDocumentStore</code>) – An instance of `FAISSDocumentStore`.
@@ -169,7 +171,7 @@ __init__(
169171
index_path: str | None = None,
170172
index_string: str = "Flat",
171173
embedding_dim: int = 768,
172-
)
174+
) -> None
173175
```
174176

175177
Initializes the FAISSDocumentStore.
@@ -398,7 +400,7 @@ Returns all unique values for a specific metadata field.
398400

399401
```python
400402
count_unique_metadata_by_filter(
401-
filters: dict[str, Any], fields: list[str]
403+
filters: dict[str, Any], metadata_fields: list[str]
402404
) -> dict[str, int]
403405
```
404406

@@ -407,7 +409,7 @@ Returns a count of unique values for multiple metadata fields, optionally scoped
407409
**Parameters:**
408410

409411
- **filters** (<code>dict\[str, Any\]</code>) – A dictionary of filters to apply.
410-
- **fields** (<code>list\[str\]</code>) – A list of metadata field names to count unique values for.
412+
- **metadata_fields** (<code>list\[str\]</code>) – A list of metadata field names to count unique values for.
411413

412414
**Returns:**
413415

‎docs-website/reference_versioned_docs/version-2.19/integrations-api/faiss.md‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,9 +56,11 @@ __init__(
5656
filters: dict[str, Any] | None = None,
5757
top_k: int = 10,
5858
filter_policy: str | FilterPolicy = FilterPolicy.REPLACE
59-
)
59+
) -> None
6060
```
6161

62+
Initialize FAISSEmbeddingRetriever.
63+
6264
**Parameters:**
6365

6466
- **document_store** (<code>FAISSDocumentStore</code>) – An instance of `FAISSDocumentStore`.
@@ -169,7 +171,7 @@ __init__(
169171
index_path: str | None = None,
170172
index_string: str = "Flat",
171173
embedding_dim: int = 768,
172-
)
174+
) -> None
173175
```
174176

175177
Initializes the FAISSDocumentStore.
@@ -398,7 +400,7 @@ Returns all unique values for a specific metadata field.
398400

399401
```python
400402
count_unique_metadata_by_filter(
401-
filters: dict[str, Any], fields: list[str]
403+
filters: dict[str, Any], metadata_fields: list[str]
402404
) -> dict[str, int]
403405
```
404406

@@ -407,7 +409,7 @@ Returns a count of unique values for multiple metadata fields, optionally scoped
407409
**Parameters:**
408410

409411
- **filters** (<code>dict\[str, Any\]</code>) – A dictionary of filters to apply.
410-
- **fields** (<code>list\[str\]</code>) – A list of metadata field names to count unique values for.
412+
- **metadata_fields** (<code>list\[str\]</code>) – A list of metadata field names to count unique values for.
411413

412414
**Returns:**
413415

‎docs-website/reference_versioned_docs/version-2.20/integrations-api/faiss.md‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,9 +56,11 @@ __init__(
5656
filters: dict[str, Any] | None = None,
5757
top_k: int = 10,
5858
filter_policy: str | FilterPolicy = FilterPolicy.REPLACE
59-
)
59+
) -> None
6060
```
6161

62+
Initialize FAISSEmbeddingRetriever.
63+
6264
**Parameters:**
6365

6466
- **document_store** (<code>FAISSDocumentStore</code>) – An instance of `FAISSDocumentStore`.
@@ -169,7 +171,7 @@ __init__(
169171
index_path: str | None = None,
170172
index_string: str = "Flat",
171173
embedding_dim: int = 768,
172-
)
174+
) -> None
173175
```
174176

175177
Initializes the FAISSDocumentStore.
@@ -398,7 +400,7 @@ Returns all unique values for a specific metadata field.
398400

399401
```python
400402
count_unique_metadata_by_filter(
401-
filters: dict[str, Any], fields: list[str]
403+
filters: dict[str, Any], metadata_fields: list[str]
402404
) -> dict[str, int]
403405
```
404406

@@ -407,7 +409,7 @@ Returns a count of unique values for multiple metadata fields, optionally scoped
407409
**Parameters:**
408410

409411
- **filters** (<code>dict\[str, Any\]</code>) – A dictionary of filters to apply.
410-
- **fields** (<code>list\[str\]</code>) – A list of metadata field names to count unique values for.
412+
- **metadata_fields** (<code>list\[str\]</code>) – A list of metadata field names to count unique values for.
411413

412414
**Returns:**
413415

‎docs-website/reference_versioned_docs/version-2.21/integrations-api/faiss.md‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,9 +56,11 @@ __init__(
5656
filters: dict[str, Any] | None = None,
5757
top_k: int = 10,
5858
filter_policy: str | FilterPolicy = FilterPolicy.REPLACE
59-
)
59+
) -> None
6060
```
6161

62+
Initialize FAISSEmbeddingRetriever.
63+
6264
**Parameters:**
6365

6466
- **document_store** (<code>FAISSDocumentStore</code>) – An instance of `FAISSDocumentStore`.
@@ -169,7 +171,7 @@ __init__(
169171
index_path: str | None = None,
170172
index_string: str = "Flat",
171173
embedding_dim: int = 768,
172-
)
174+
) -> None
173175
```
174176

175177
Initializes the FAISSDocumentStore.
@@ -398,7 +400,7 @@ Returns all unique values for a specific metadata field.
398400

399401
```python
400402
count_unique_metadata_by_filter(
401-
filters: dict[str, Any], fields: list[str]
403+
filters: dict[str, Any], metadata_fields: list[str]
402404
) -> dict[str, int]
403405
```
404406

@@ -407,7 +409,7 @@ Returns a count of unique values for multiple metadata fields, optionally scoped
407409
**Parameters:**
408410

409411
- **filters** (<code>dict\[str, Any\]</code>) – A dictionary of filters to apply.
410-
- **fields** (<code>list\[str\]</code>) – A list of metadata field names to count unique values for.
412+
- **metadata_fields** (<code>list\[str\]</code>) – A list of metadata field names to count unique values for.
411413

412414
**Returns:**
413415

‎docs-website/reference_versioned_docs/version-2.22/integrations-api/faiss.md‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,9 +56,11 @@ __init__(
5656
filters: dict[str, Any] | None = None,
5757
top_k: int = 10,
5858
filter_policy: str | FilterPolicy = FilterPolicy.REPLACE
59-
)
59+
) -> None
6060
```
6161

62+
Initialize FAISSEmbeddingRetriever.
63+
6264
**Parameters:**
6365

6466
- **document_store** (<code>FAISSDocumentStore</code>) – An instance of `FAISSDocumentStore`.
@@ -169,7 +171,7 @@ __init__(
169171
index_path: str | None = None,
170172
index_string: str = "Flat",
171173
embedding_dim: int = 768,
172-
)
174+
) -> None
173175
```
174176

175177
Initializes the FAISSDocumentStore.
@@ -398,7 +400,7 @@ Returns all unique values for a specific metadata field.
398400

399401
```python
400402
count_unique_metadata_by_filter(
401-
filters: dict[str, Any], fields: list[str]
403+
filters: dict[str, Any], metadata_fields: list[str]
402404
) -> dict[str, int]
403405
```
404406

@@ -407,7 +409,7 @@ Returns a count of unique values for multiple metadata fields, optionally scoped
407409
**Parameters:**
408410

409411
- **filters** (<code>dict\[str, Any\]</code>) – A dictionary of filters to apply.
410-
- **fields** (<code>list\[str\]</code>) – A list of metadata field names to count unique values for.
412+
- **metadata_fields** (<code>list\[str\]</code>) – A list of metadata field names to count unique values for.
411413

412414
**Returns:**
413415

‎docs-website/reference_versioned_docs/version-2.23/integrations-api/faiss.md‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,9 +56,11 @@ __init__(
5656
filters: dict[str, Any] | None = None,
5757
top_k: int = 10,
5858
filter_policy: str | FilterPolicy = FilterPolicy.REPLACE
59-
)
59+
) -> None
6060
```
6161

62+
Initialize FAISSEmbeddingRetriever.
63+
6264
**Parameters:**
6365

6466
- **document_store** (<code>FAISSDocumentStore</code>) – An instance of `FAISSDocumentStore`.
@@ -169,7 +171,7 @@ __init__(
169171
index_path: str | None = None,
170172
index_string: str = "Flat",
171173
embedding_dim: int = 768,
172-
)
174+
) -> None
173175
```
174176

175177
Initializes the FAISSDocumentStore.
@@ -398,7 +400,7 @@ Returns all unique values for a specific metadata field.
398400

399401
```python
400402
count_unique_metadata_by_filter(
401-
filters: dict[str, Any], fields: list[str]
403+
filters: dict[str, Any], metadata_fields: list[str]
402404
) -> dict[str, int]
403405
```
404406

@@ -407,7 +409,7 @@ Returns a count of unique values for multiple metadata fields, optionally scoped
407409
**Parameters:**
408410

409411
- **filters** (<code>dict\[str, Any\]</code>) – A dictionary of filters to apply.
410-
- **fields** (<code>list\[str\]</code>) – A list of metadata field names to count unique values for.
412+
- **metadata_fields** (<code>list\[str\]</code>) – A list of metadata field names to count unique values for.
411413

412414
**Returns:**
413415

‎docs-website/reference_versioned_docs/version-2.24/integrations-api/faiss.md‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,9 +56,11 @@ __init__(
5656
filters: dict[str, Any] | None = None,
5757
top_k: int = 10,
5858
filter_policy: str | FilterPolicy = FilterPolicy.REPLACE
59-
)
59+
) -> None
6060
```
6161

62+
Initialize FAISSEmbeddingRetriever.
63+
6264
**Parameters:**
6365

6466
- **document_store** (<code>FAISSDocumentStore</code>) – An instance of `FAISSDocumentStore`.
@@ -169,7 +171,7 @@ __init__(
169171
index_path: str | None = None,
170172
index_string: str = "Flat",
171173
embedding_dim: int = 768,
172-
)
174+
) -> None
173175
```
174176

175177
Initializes the FAISSDocumentStore.
@@ -398,7 +400,7 @@ Returns all unique values for a specific metadata field.
398400

399401
```python
400402
count_unique_metadata_by_filter(
401-
filters: dict[str, Any], fields: list[str]
403+
filters: dict[str, Any], metadata_fields: list[str]
402404
) -> dict[str, int]
403405
```
404406

@@ -407,7 +409,7 @@ Returns a count of unique values for multiple metadata fields, optionally scoped
407409
**Parameters:**
408410

409411
- **filters** (<code>dict\[str, Any\]</code>) – A dictionary of filters to apply.
410-
- **fields** (<code>list\[str\]</code>) – A list of metadata field names to count unique values for.
412+
- **metadata_fields** (<code>list\[str\]</code>) – A list of metadata field names to count unique values for.
411413

412414
**Returns:**
413415

‎docs-website/reference_versioned_docs/version-2.25/integrations-api/faiss.md‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,9 +56,11 @@ __init__(
5656
filters: dict[str, Any] | None = None,
5757
top_k: int = 10,
5858
filter_policy: str | FilterPolicy = FilterPolicy.REPLACE
59-
)
59+
) -> None
6060
```
6161

62+
Initialize FAISSEmbeddingRetriever.
63+
6264
**Parameters:**
6365

6466
- **document_store** (<code>FAISSDocumentStore</code>) – An instance of `FAISSDocumentStore`.
@@ -169,7 +171,7 @@ __init__(
169171
index_path: str | None = None,
170172
index_string: str = "Flat",
171173
embedding_dim: int = 768,
172-
)
174+
) -> None
173175
```
174176

175177
Initializes the FAISSDocumentStore.
@@ -398,7 +400,7 @@ Returns all unique values for a specific metadata field.
398400

399401
```python
400402
count_unique_metadata_by_filter(
401-
filters: dict[str, Any], fields: list[str]
403+
filters: dict[str, Any], metadata_fields: list[str]
402404
) -> dict[str, int]
403405
```
404406

@@ -407,7 +409,7 @@ Returns a count of unique values for multiple metadata fields, optionally scoped
407409
**Parameters:**
408410

409411
- **filters** (<code>dict\[str, Any\]</code>) – A dictionary of filters to apply.
410-
- **fields** (<code>list\[str\]</code>) – A list of metadata field names to count unique values for.
412+
- **metadata_fields** (<code>list\[str\]</code>) – A list of metadata field names to count unique values for.
411413

412414
**Returns:**
413415

‎docs-website/reference_versioned_docs/version-2.26/integrations-api/faiss.md‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,9 +56,11 @@ __init__(
5656
filters: dict[str, Any] | None = None,
5757
top_k: int = 10,
5858
filter_policy: str | FilterPolicy = FilterPolicy.REPLACE
59-
)
59+
) -> None
6060
```
6161

62+
Initialize FAISSEmbeddingRetriever.
63+
6264
**Parameters:**
6365

6466
- **document_store** (<code>FAISSDocumentStore</code>) – An instance of `FAISSDocumentStore`.
@@ -169,7 +171,7 @@ __init__(
169171
index_path: str | None = None,
170172
index_string: str = "Flat",
171173
embedding_dim: int = 768,
172-
)
174+
) -> None
173175
```
174176

175177
Initializes the FAISSDocumentStore.
@@ -398,7 +400,7 @@ Returns all unique values for a specific metadata field.
398400

399401
```python
400402
count_unique_metadata_by_filter(
401-
filters: dict[str, Any], fields: list[str]
403+
filters: dict[str, Any], metadata_fields: list[str]
402404
) -> dict[str, int]
403405
```
404406

@@ -407,7 +409,7 @@ Returns a count of unique values for multiple metadata fields, optionally scoped
407409
**Parameters:**
408410

409411
- **filters** (<code>dict\[str, Any\]</code>) – A dictionary of filters to apply.
410-
- **fields** (<code>list\[str\]</code>) – A list of metadata field names to count unique values for.
412+
- **metadata_fields** (<code>list\[str\]</code>) – A list of metadata field names to count unique values for.
411413

412414
**Returns:**
413415

0 commit comments

Comments
 (0)