You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: integrations/amazon_s3_vectors/src/haystack_integrations/components/retrievers/amazon_s3_vectors/embedding_retriever.py
+5-5Lines changed: 5 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,7 @@
15
15
@component
16
16
classS3VectorsEmbeddingRetriever:
17
17
"""
18
-
Retrieve documents from an ``S3VectorsDocumentStore`` based on their dense embeddings.
18
+
Retrieve documents from an `S3VectorsDocumentStore` based on their dense embeddings.
19
19
20
20
Usage example:
21
21
```python
@@ -64,11 +64,11 @@ def __init__(
64
64
"""
65
65
Initialize the S3VectorsEmbeddingRetriever.
66
66
67
-
:param document_store: An instance of ``S3VectorsDocumentStore``.
67
+
:param document_store: An instance of `S3VectorsDocumentStore`.
68
68
:param filters: Filters applied to the retrieved Documents.
69
69
:param top_k: Maximum number of Documents to return.
70
70
:param filter_policy: Policy to determine how filters are applied.
71
-
:raises ValueError: If ``document_store`` is not an ``S3VectorsDocumentStore``.
71
+
:raises ValueError: If `document_store` is not an `S3VectorsDocumentStore`.
Copy file name to clipboardExpand all lines: integrations/amazon_s3_vectors/src/haystack_integrations/document_stores/amazon_s3_vectors/document_store.py
+14-14Lines changed: 14 additions & 14 deletions
Original file line number
Diff line number
Diff line change
@@ -56,12 +56,12 @@ class S3VectorsDocumentStore:
56
56
57
57
**Service limits:**
58
58
59
-
- Maximum ``top_k``: 100 results per query
59
+
- Maximum `top_k`: 100 results per query
60
60
- Maximum vector dimension: 4,096
61
61
- Metadata per vector: 40 KB total, 2 KB filterable
62
-
- All documents must have embeddings (``float32`` only)
63
-
- Distance metrics: ``cosine`` or ``euclidean`` (set at index creation, immutable)
64
-
- ``filter_documents()`` is client-side — prefer ``S3VectorsEmbeddingRetriever`` with filters
62
+
- All documents must have embeddings (`float32` only)
63
+
- Distance metrics: `cosine` or `euclidean` (set at index creation, immutable)
64
+
- `filter_documents()` is client-side — prefer `S3VectorsEmbeddingRetriever` with filters
65
65
66
66
Usage example:
67
67
```python
@@ -95,13 +95,13 @@ def __init__(
95
95
:param vector_bucket_name: Name of the S3 vector bucket.
96
96
:param index_name: Name of the vector index within the bucket.
97
97
:param dimension: Dimensionality of the embeddings (e.g. 768, 1536).
98
-
:param distance_metric: Distance metric for similarity search: ``"cosine"`` or ``"euclidean"``.
98
+
:param distance_metric: Distance metric for similarity search: `"cosine"` or `"euclidean"`.
99
99
:param region_name: AWS region. If not provided, uses the default from the environment/config.
100
100
:param aws_access_key_id: AWS access key ID. If not provided, uses the default credential chain.
0 commit comments