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
17 changes: 16 additions & 1 deletion docs-website/reference/integrations-api/opensearch.md
Original file line number Diff line number Diff line change
Expand Up @@ -1220,6 +1220,7 @@ __init__(
use_ssl: bool | None = None,
verify_certs: bool | None = None,
timeout: int | None = None,
nested_fields: list[str] | Literal["*"] | None = None,
**kwargs: Any
) -> None
```
Expand Down Expand Up @@ -1259,6 +1260,12 @@ For more information on connection parameters, see the [official OpenSearch docu
- **use_ssl** (<code>bool | None</code>) – Whether to use SSL. Defaults to None
- **verify_certs** (<code>bool | None</code>) – Whether to verify certificates. Defaults to None
- **timeout** (<code>int | None</code>) – Timeout in seconds. Defaults to None
- **nested_fields** (<code>list\[str\] | Literal['\*'] | None</code>) – List of metadata field paths (without the `meta.` prefix) that should be mapped
as OpenSearch `nested` type, enabling multi-condition filtering on array-of-objects fields.
Pass `"*"` to auto-detect `list[dict]` fields and map them as nested from
the first `write_documents` batch.
When the index already exists, nested fields are discovered from the live mapping.
Defaults to None (no nested support).
- \*\***kwargs** (<code>Any</code>) – Optional arguments that `OpenSearch` takes. For the full list of supported kwargs,
see the [official OpenSearch reference](https://opensearch-project.github.io/opensearch-py/api-ref/clients/opensearch_client.html)

Expand Down Expand Up @@ -1837,7 +1844,15 @@ Uses composite aggregations for proper pagination beyond 10k results.
### normalize_filters

```python
normalize_filters(filters: dict[str, Any]) -> dict[str, Any]
normalize_filters(
filters: dict[str, Any], nested_fields: set[str] | None = None
) -> dict[str, Any]
```

Converts Haystack filters in OpenSearch compatible filters.

**Parameters:**

- **filters** (<code>dict\[str, Any\]</code>) – Haystack filter dictionary.
- **nested_fields** (<code>set\[str\] | None</code>) – Set of metadata field paths that are mapped as `nested` type in OpenSearch.
When provided, conditions targeting sub-fields of these paths are wrapped in `nested` queries.
Original file line number Diff line number Diff line change
Expand Up @@ -1220,6 +1220,7 @@ __init__(
use_ssl: bool | None = None,
verify_certs: bool | None = None,
timeout: int | None = None,
nested_fields: list[str] | Literal["*"] | None = None,
**kwargs: Any
) -> None
```
Expand Down Expand Up @@ -1259,6 +1260,12 @@ For more information on connection parameters, see the [official OpenSearch docu
- **use_ssl** (<code>bool | None</code>) – Whether to use SSL. Defaults to None
- **verify_certs** (<code>bool | None</code>) – Whether to verify certificates. Defaults to None
- **timeout** (<code>int | None</code>) – Timeout in seconds. Defaults to None
- **nested_fields** (<code>list\[str\] | Literal['\*'] | None</code>) – List of metadata field paths (without the `meta.` prefix) that should be mapped
as OpenSearch `nested` type, enabling multi-condition filtering on array-of-objects fields.
Pass `"*"` to auto-detect `list[dict]` fields and map them as nested from
the first `write_documents` batch.
When the index already exists, nested fields are discovered from the live mapping.
Defaults to None (no nested support).
- \*\***kwargs** (<code>Any</code>) – Optional arguments that `OpenSearch` takes. For the full list of supported kwargs,
see the [official OpenSearch reference](https://opensearch-project.github.io/opensearch-py/api-ref/clients/opensearch_client.html)

Expand Down Expand Up @@ -1837,7 +1844,15 @@ Uses composite aggregations for proper pagination beyond 10k results.
### normalize_filters

```python
normalize_filters(filters: dict[str, Any]) -> dict[str, Any]
normalize_filters(
filters: dict[str, Any], nested_fields: set[str] | None = None
) -> dict[str, Any]
```

Converts Haystack filters in OpenSearch compatible filters.

**Parameters:**

- **filters** (<code>dict\[str, Any\]</code>) – Haystack filter dictionary.
- **nested_fields** (<code>set\[str\] | None</code>) – Set of metadata field paths that are mapped as `nested` type in OpenSearch.
When provided, conditions targeting sub-fields of these paths are wrapped in `nested` queries.
Original file line number Diff line number Diff line change
Expand Up @@ -1220,6 +1220,7 @@ __init__(
use_ssl: bool | None = None,
verify_certs: bool | None = None,
timeout: int | None = None,
nested_fields: list[str] | Literal["*"] | None = None,
**kwargs: Any
) -> None
```
Expand Down Expand Up @@ -1259,6 +1260,12 @@ For more information on connection parameters, see the [official OpenSearch docu
- **use_ssl** (<code>bool | None</code>) – Whether to use SSL. Defaults to None
- **verify_certs** (<code>bool | None</code>) – Whether to verify certificates. Defaults to None
- **timeout** (<code>int | None</code>) – Timeout in seconds. Defaults to None
- **nested_fields** (<code>list\[str\] | Literal['\*'] | None</code>) – List of metadata field paths (without the `meta.` prefix) that should be mapped
as OpenSearch `nested` type, enabling multi-condition filtering on array-of-objects fields.
Pass `"*"` to auto-detect `list[dict]` fields and map them as nested from
the first `write_documents` batch.
When the index already exists, nested fields are discovered from the live mapping.
Defaults to None (no nested support).
- \*\***kwargs** (<code>Any</code>) – Optional arguments that `OpenSearch` takes. For the full list of supported kwargs,
see the [official OpenSearch reference](https://opensearch-project.github.io/opensearch-py/api-ref/clients/opensearch_client.html)

Expand Down Expand Up @@ -1837,7 +1844,15 @@ Uses composite aggregations for proper pagination beyond 10k results.
### normalize_filters

```python
normalize_filters(filters: dict[str, Any]) -> dict[str, Any]
normalize_filters(
filters: dict[str, Any], nested_fields: set[str] | None = None
) -> dict[str, Any]
```

Converts Haystack filters in OpenSearch compatible filters.

**Parameters:**

- **filters** (<code>dict\[str, Any\]</code>) – Haystack filter dictionary.
- **nested_fields** (<code>set\[str\] | None</code>) – Set of metadata field paths that are mapped as `nested` type in OpenSearch.
When provided, conditions targeting sub-fields of these paths are wrapped in `nested` queries.
Original file line number Diff line number Diff line change
Expand Up @@ -1220,6 +1220,7 @@ __init__(
use_ssl: bool | None = None,
verify_certs: bool | None = None,
timeout: int | None = None,
nested_fields: list[str] | Literal["*"] | None = None,
**kwargs: Any
) -> None
```
Expand Down Expand Up @@ -1259,6 +1260,12 @@ For more information on connection parameters, see the [official OpenSearch docu
- **use_ssl** (<code>bool | None</code>) – Whether to use SSL. Defaults to None
- **verify_certs** (<code>bool | None</code>) – Whether to verify certificates. Defaults to None
- **timeout** (<code>int | None</code>) – Timeout in seconds. Defaults to None
- **nested_fields** (<code>list\[str\] | Literal['\*'] | None</code>) – List of metadata field paths (without the `meta.` prefix) that should be mapped
as OpenSearch `nested` type, enabling multi-condition filtering on array-of-objects fields.
Pass `"*"` to auto-detect `list[dict]` fields and map them as nested from
the first `write_documents` batch.
When the index already exists, nested fields are discovered from the live mapping.
Defaults to None (no nested support).
- \*\***kwargs** (<code>Any</code>) – Optional arguments that `OpenSearch` takes. For the full list of supported kwargs,
see the [official OpenSearch reference](https://opensearch-project.github.io/opensearch-py/api-ref/clients/opensearch_client.html)

Expand Down Expand Up @@ -1837,7 +1844,15 @@ Uses composite aggregations for proper pagination beyond 10k results.
### normalize_filters

```python
normalize_filters(filters: dict[str, Any]) -> dict[str, Any]
normalize_filters(
filters: dict[str, Any], nested_fields: set[str] | None = None
) -> dict[str, Any]
```

Converts Haystack filters in OpenSearch compatible filters.

**Parameters:**

- **filters** (<code>dict\[str, Any\]</code>) – Haystack filter dictionary.
- **nested_fields** (<code>set\[str\] | None</code>) – Set of metadata field paths that are mapped as `nested` type in OpenSearch.
When provided, conditions targeting sub-fields of these paths are wrapped in `nested` queries.
Original file line number Diff line number Diff line change
Expand Up @@ -1220,6 +1220,7 @@ __init__(
use_ssl: bool | None = None,
verify_certs: bool | None = None,
timeout: int | None = None,
nested_fields: list[str] | Literal["*"] | None = None,
**kwargs: Any
) -> None
```
Expand Down Expand Up @@ -1259,6 +1260,12 @@ For more information on connection parameters, see the [official OpenSearch docu
- **use_ssl** (<code>bool | None</code>) – Whether to use SSL. Defaults to None
- **verify_certs** (<code>bool | None</code>) – Whether to verify certificates. Defaults to None
- **timeout** (<code>int | None</code>) – Timeout in seconds. Defaults to None
- **nested_fields** (<code>list\[str\] | Literal['\*'] | None</code>) – List of metadata field paths (without the `meta.` prefix) that should be mapped
as OpenSearch `nested` type, enabling multi-condition filtering on array-of-objects fields.
Pass `"*"` to auto-detect `list[dict]` fields and map them as nested from
the first `write_documents` batch.
When the index already exists, nested fields are discovered from the live mapping.
Defaults to None (no nested support).
- \*\***kwargs** (<code>Any</code>) – Optional arguments that `OpenSearch` takes. For the full list of supported kwargs,
see the [official OpenSearch reference](https://opensearch-project.github.io/opensearch-py/api-ref/clients/opensearch_client.html)

Expand Down Expand Up @@ -1837,7 +1844,15 @@ Uses composite aggregations for proper pagination beyond 10k results.
### normalize_filters

```python
normalize_filters(filters: dict[str, Any]) -> dict[str, Any]
normalize_filters(
filters: dict[str, Any], nested_fields: set[str] | None = None
) -> dict[str, Any]
```

Converts Haystack filters in OpenSearch compatible filters.

**Parameters:**

- **filters** (<code>dict\[str, Any\]</code>) – Haystack filter dictionary.
- **nested_fields** (<code>set\[str\] | None</code>) – Set of metadata field paths that are mapped as `nested` type in OpenSearch.
When provided, conditions targeting sub-fields of these paths are wrapped in `nested` queries.
Original file line number Diff line number Diff line change
Expand Up @@ -1220,6 +1220,7 @@ __init__(
use_ssl: bool | None = None,
verify_certs: bool | None = None,
timeout: int | None = None,
nested_fields: list[str] | Literal["*"] | None = None,
**kwargs: Any
) -> None
```
Expand Down Expand Up @@ -1259,6 +1260,12 @@ For more information on connection parameters, see the [official OpenSearch docu
- **use_ssl** (<code>bool | None</code>) – Whether to use SSL. Defaults to None
- **verify_certs** (<code>bool | None</code>) – Whether to verify certificates. Defaults to None
- **timeout** (<code>int | None</code>) – Timeout in seconds. Defaults to None
- **nested_fields** (<code>list\[str\] | Literal['\*'] | None</code>) – List of metadata field paths (without the `meta.` prefix) that should be mapped
as OpenSearch `nested` type, enabling multi-condition filtering on array-of-objects fields.
Pass `"*"` to auto-detect `list[dict]` fields and map them as nested from
the first `write_documents` batch.
When the index already exists, nested fields are discovered from the live mapping.
Defaults to None (no nested support).
- \*\***kwargs** (<code>Any</code>) – Optional arguments that `OpenSearch` takes. For the full list of supported kwargs,
see the [official OpenSearch reference](https://opensearch-project.github.io/opensearch-py/api-ref/clients/opensearch_client.html)

Expand Down Expand Up @@ -1837,7 +1844,15 @@ Uses composite aggregations for proper pagination beyond 10k results.
### normalize_filters

```python
normalize_filters(filters: dict[str, Any]) -> dict[str, Any]
normalize_filters(
filters: dict[str, Any], nested_fields: set[str] | None = None
) -> dict[str, Any]
```

Converts Haystack filters in OpenSearch compatible filters.

**Parameters:**

- **filters** (<code>dict\[str, Any\]</code>) – Haystack filter dictionary.
- **nested_fields** (<code>set\[str\] | None</code>) – Set of metadata field paths that are mapped as `nested` type in OpenSearch.
When provided, conditions targeting sub-fields of these paths are wrapped in `nested` queries.
Original file line number Diff line number Diff line change
Expand Up @@ -1220,6 +1220,7 @@ __init__(
use_ssl: bool | None = None,
verify_certs: bool | None = None,
timeout: int | None = None,
nested_fields: list[str] | Literal["*"] | None = None,
**kwargs: Any
) -> None
```
Expand Down Expand Up @@ -1259,6 +1260,12 @@ For more information on connection parameters, see the [official OpenSearch docu
- **use_ssl** (<code>bool | None</code>) – Whether to use SSL. Defaults to None
- **verify_certs** (<code>bool | None</code>) – Whether to verify certificates. Defaults to None
- **timeout** (<code>int | None</code>) – Timeout in seconds. Defaults to None
- **nested_fields** (<code>list\[str\] | Literal['\*'] | None</code>) – List of metadata field paths (without the `meta.` prefix) that should be mapped
as OpenSearch `nested` type, enabling multi-condition filtering on array-of-objects fields.
Pass `"*"` to auto-detect `list[dict]` fields and map them as nested from
the first `write_documents` batch.
When the index already exists, nested fields are discovered from the live mapping.
Defaults to None (no nested support).
- \*\***kwargs** (<code>Any</code>) – Optional arguments that `OpenSearch` takes. For the full list of supported kwargs,
see the [official OpenSearch reference](https://opensearch-project.github.io/opensearch-py/api-ref/clients/opensearch_client.html)

Expand Down Expand Up @@ -1837,7 +1844,15 @@ Uses composite aggregations for proper pagination beyond 10k results.
### normalize_filters

```python
normalize_filters(filters: dict[str, Any]) -> dict[str, Any]
normalize_filters(
filters: dict[str, Any], nested_fields: set[str] | None = None
) -> dict[str, Any]
```

Converts Haystack filters in OpenSearch compatible filters.

**Parameters:**

- **filters** (<code>dict\[str, Any\]</code>) – Haystack filter dictionary.
- **nested_fields** (<code>set\[str\] | None</code>) – Set of metadata field paths that are mapped as `nested` type in OpenSearch.
When provided, conditions targeting sub-fields of these paths are wrapped in `nested` queries.
Original file line number Diff line number Diff line change
Expand Up @@ -1220,6 +1220,7 @@ __init__(
use_ssl: bool | None = None,
verify_certs: bool | None = None,
timeout: int | None = None,
nested_fields: list[str] | Literal["*"] | None = None,
**kwargs: Any
) -> None
```
Expand Down Expand Up @@ -1259,6 +1260,12 @@ For more information on connection parameters, see the [official OpenSearch docu
- **use_ssl** (<code>bool | None</code>) – Whether to use SSL. Defaults to None
- **verify_certs** (<code>bool | None</code>) – Whether to verify certificates. Defaults to None
- **timeout** (<code>int | None</code>) – Timeout in seconds. Defaults to None
- **nested_fields** (<code>list\[str\] | Literal['\*'] | None</code>) – List of metadata field paths (without the `meta.` prefix) that should be mapped
as OpenSearch `nested` type, enabling multi-condition filtering on array-of-objects fields.
Pass `"*"` to auto-detect `list[dict]` fields and map them as nested from
the first `write_documents` batch.
When the index already exists, nested fields are discovered from the live mapping.
Defaults to None (no nested support).
- \*\***kwargs** (<code>Any</code>) – Optional arguments that `OpenSearch` takes. For the full list of supported kwargs,
see the [official OpenSearch reference](https://opensearch-project.github.io/opensearch-py/api-ref/clients/opensearch_client.html)

Expand Down Expand Up @@ -1837,7 +1844,15 @@ Uses composite aggregations for proper pagination beyond 10k results.
### normalize_filters

```python
normalize_filters(filters: dict[str, Any]) -> dict[str, Any]
normalize_filters(
filters: dict[str, Any], nested_fields: set[str] | None = None
) -> dict[str, Any]
```

Converts Haystack filters in OpenSearch compatible filters.

**Parameters:**

- **filters** (<code>dict\[str, Any\]</code>) – Haystack filter dictionary.
- **nested_fields** (<code>set\[str\] | None</code>) – Set of metadata field paths that are mapped as `nested` type in OpenSearch.
When provided, conditions targeting sub-fields of these paths are wrapped in `nested` queries.
Original file line number Diff line number Diff line change
Expand Up @@ -1220,6 +1220,7 @@ __init__(
use_ssl: bool | None = None,
verify_certs: bool | None = None,
timeout: int | None = None,
nested_fields: list[str] | Literal["*"] | None = None,
**kwargs: Any
) -> None
```
Expand Down Expand Up @@ -1259,6 +1260,12 @@ For more information on connection parameters, see the [official OpenSearch docu
- **use_ssl** (<code>bool | None</code>) – Whether to use SSL. Defaults to None
- **verify_certs** (<code>bool | None</code>) – Whether to verify certificates. Defaults to None
- **timeout** (<code>int | None</code>) – Timeout in seconds. Defaults to None
- **nested_fields** (<code>list\[str\] | Literal['\*'] | None</code>) – List of metadata field paths (without the `meta.` prefix) that should be mapped
as OpenSearch `nested` type, enabling multi-condition filtering on array-of-objects fields.
Pass `"*"` to auto-detect `list[dict]` fields and map them as nested from
the first `write_documents` batch.
When the index already exists, nested fields are discovered from the live mapping.
Defaults to None (no nested support).
- \*\***kwargs** (<code>Any</code>) – Optional arguments that `OpenSearch` takes. For the full list of supported kwargs,
see the [official OpenSearch reference](https://opensearch-project.github.io/opensearch-py/api-ref/clients/opensearch_client.html)

Expand Down Expand Up @@ -1837,7 +1844,15 @@ Uses composite aggregations for proper pagination beyond 10k results.
### normalize_filters

```python
normalize_filters(filters: dict[str, Any]) -> dict[str, Any]
normalize_filters(
filters: dict[str, Any], nested_fields: set[str] | None = None
) -> dict[str, Any]
```

Converts Haystack filters in OpenSearch compatible filters.

**Parameters:**

- **filters** (<code>dict\[str, Any\]</code>) – Haystack filter dictionary.
- **nested_fields** (<code>set\[str\] | None</code>) – Set of metadata field paths that are mapped as `nested` type in OpenSearch.
When provided, conditions targeting sub-fields of these paths are wrapped in `nested` queries.
Loading
Loading