diff --git a/docs-website/reference/integrations-api/opensearch.md b/docs-website/reference/integrations-api/opensearch.md index 39f3969835..a173c0dc49 100644 --- a/docs-website/reference/integrations-api/opensearch.md +++ b/docs-website/reference/integrations-api/opensearch.md @@ -1492,6 +1492,8 @@ Deletes all documents in the document store. - **recreate_index** (bool) – If True, the index will be deleted and recreated with the original mappings and settings. If False, all documents will be deleted using the `delete_by_query` API. + `recreate_index=True` is not supported when the configured index name is an alias; a + :class:`haystack.document_stores.errors.DocumentStoreError` is raised in that case. - **refresh** (bool) – If True, OpenSearch refreshes all shards involved in the delete by query after the request completes. If False, no refresh is performed. For more details, see the [OpenSearch delete_by_query refresh documentation](https://opensearch.org/docs/latest/api-reference/document-apis/delete-by-query/). @@ -1510,6 +1512,8 @@ Asynchronously deletes all documents in the document store. - **recreate_index** (bool) – If True, the index will be deleted and recreated with the original mappings and settings. If False, all documents will be deleted using the `delete_by_query` API. + `recreate_index=True` is not supported when the configured index name is an alias; a + :class:`haystack.document_stores.errors.DocumentStoreError` is raised in that case. - **refresh** (bool) – If True, OpenSearch refreshes all shards involved in the delete by query after the request completes. If False, no refresh is performed. For more details, see the [OpenSearch delete_by_query refresh documentation](https://opensearch.org/docs/latest/api-reference/document-apis/delete-by-query/). diff --git a/docs-website/reference_versioned_docs/version-2.18/integrations-api/opensearch.md b/docs-website/reference_versioned_docs/version-2.18/integrations-api/opensearch.md index 39f3969835..a173c0dc49 100644 --- a/docs-website/reference_versioned_docs/version-2.18/integrations-api/opensearch.md +++ b/docs-website/reference_versioned_docs/version-2.18/integrations-api/opensearch.md @@ -1492,6 +1492,8 @@ Deletes all documents in the document store. - **recreate_index** (bool) – If True, the index will be deleted and recreated with the original mappings and settings. If False, all documents will be deleted using the `delete_by_query` API. + `recreate_index=True` is not supported when the configured index name is an alias; a + :class:`haystack.document_stores.errors.DocumentStoreError` is raised in that case. - **refresh** (bool) – If True, OpenSearch refreshes all shards involved in the delete by query after the request completes. If False, no refresh is performed. For more details, see the [OpenSearch delete_by_query refresh documentation](https://opensearch.org/docs/latest/api-reference/document-apis/delete-by-query/). @@ -1510,6 +1512,8 @@ Asynchronously deletes all documents in the document store. - **recreate_index** (bool) – If True, the index will be deleted and recreated with the original mappings and settings. If False, all documents will be deleted using the `delete_by_query` API. + `recreate_index=True` is not supported when the configured index name is an alias; a + :class:`haystack.document_stores.errors.DocumentStoreError` is raised in that case. - **refresh** (bool) – If True, OpenSearch refreshes all shards involved in the delete by query after the request completes. If False, no refresh is performed. For more details, see the [OpenSearch delete_by_query refresh documentation](https://opensearch.org/docs/latest/api-reference/document-apis/delete-by-query/). diff --git a/docs-website/reference_versioned_docs/version-2.19/integrations-api/opensearch.md b/docs-website/reference_versioned_docs/version-2.19/integrations-api/opensearch.md index 39f3969835..a173c0dc49 100644 --- a/docs-website/reference_versioned_docs/version-2.19/integrations-api/opensearch.md +++ b/docs-website/reference_versioned_docs/version-2.19/integrations-api/opensearch.md @@ -1492,6 +1492,8 @@ Deletes all documents in the document store. - **recreate_index** (bool) – If True, the index will be deleted and recreated with the original mappings and settings. If False, all documents will be deleted using the `delete_by_query` API. + `recreate_index=True` is not supported when the configured index name is an alias; a + :class:`haystack.document_stores.errors.DocumentStoreError` is raised in that case. - **refresh** (bool) – If True, OpenSearch refreshes all shards involved in the delete by query after the request completes. If False, no refresh is performed. For more details, see the [OpenSearch delete_by_query refresh documentation](https://opensearch.org/docs/latest/api-reference/document-apis/delete-by-query/). @@ -1510,6 +1512,8 @@ Asynchronously deletes all documents in the document store. - **recreate_index** (bool) – If True, the index will be deleted and recreated with the original mappings and settings. If False, all documents will be deleted using the `delete_by_query` API. + `recreate_index=True` is not supported when the configured index name is an alias; a + :class:`haystack.document_stores.errors.DocumentStoreError` is raised in that case. - **refresh** (bool) – If True, OpenSearch refreshes all shards involved in the delete by query after the request completes. If False, no refresh is performed. For more details, see the [OpenSearch delete_by_query refresh documentation](https://opensearch.org/docs/latest/api-reference/document-apis/delete-by-query/). diff --git a/docs-website/reference_versioned_docs/version-2.20/integrations-api/opensearch.md b/docs-website/reference_versioned_docs/version-2.20/integrations-api/opensearch.md index 39f3969835..a173c0dc49 100644 --- a/docs-website/reference_versioned_docs/version-2.20/integrations-api/opensearch.md +++ b/docs-website/reference_versioned_docs/version-2.20/integrations-api/opensearch.md @@ -1492,6 +1492,8 @@ Deletes all documents in the document store. - **recreate_index** (bool) – If True, the index will be deleted and recreated with the original mappings and settings. If False, all documents will be deleted using the `delete_by_query` API. + `recreate_index=True` is not supported when the configured index name is an alias; a + :class:`haystack.document_stores.errors.DocumentStoreError` is raised in that case. - **refresh** (bool) – If True, OpenSearch refreshes all shards involved in the delete by query after the request completes. If False, no refresh is performed. For more details, see the [OpenSearch delete_by_query refresh documentation](https://opensearch.org/docs/latest/api-reference/document-apis/delete-by-query/). @@ -1510,6 +1512,8 @@ Asynchronously deletes all documents in the document store. - **recreate_index** (bool) – If True, the index will be deleted and recreated with the original mappings and settings. If False, all documents will be deleted using the `delete_by_query` API. + `recreate_index=True` is not supported when the configured index name is an alias; a + :class:`haystack.document_stores.errors.DocumentStoreError` is raised in that case. - **refresh** (bool) – If True, OpenSearch refreshes all shards involved in the delete by query after the request completes. If False, no refresh is performed. For more details, see the [OpenSearch delete_by_query refresh documentation](https://opensearch.org/docs/latest/api-reference/document-apis/delete-by-query/). diff --git a/docs-website/reference_versioned_docs/version-2.21/integrations-api/opensearch.md b/docs-website/reference_versioned_docs/version-2.21/integrations-api/opensearch.md index 39f3969835..a173c0dc49 100644 --- a/docs-website/reference_versioned_docs/version-2.21/integrations-api/opensearch.md +++ b/docs-website/reference_versioned_docs/version-2.21/integrations-api/opensearch.md @@ -1492,6 +1492,8 @@ Deletes all documents in the document store. - **recreate_index** (bool) – If True, the index will be deleted and recreated with the original mappings and settings. If False, all documents will be deleted using the `delete_by_query` API. + `recreate_index=True` is not supported when the configured index name is an alias; a + :class:`haystack.document_stores.errors.DocumentStoreError` is raised in that case. - **refresh** (bool) – If True, OpenSearch refreshes all shards involved in the delete by query after the request completes. If False, no refresh is performed. For more details, see the [OpenSearch delete_by_query refresh documentation](https://opensearch.org/docs/latest/api-reference/document-apis/delete-by-query/). @@ -1510,6 +1512,8 @@ Asynchronously deletes all documents in the document store. - **recreate_index** (bool) – If True, the index will be deleted and recreated with the original mappings and settings. If False, all documents will be deleted using the `delete_by_query` API. + `recreate_index=True` is not supported when the configured index name is an alias; a + :class:`haystack.document_stores.errors.DocumentStoreError` is raised in that case. - **refresh** (bool) – If True, OpenSearch refreshes all shards involved in the delete by query after the request completes. If False, no refresh is performed. For more details, see the [OpenSearch delete_by_query refresh documentation](https://opensearch.org/docs/latest/api-reference/document-apis/delete-by-query/). diff --git a/docs-website/reference_versioned_docs/version-2.22/integrations-api/opensearch.md b/docs-website/reference_versioned_docs/version-2.22/integrations-api/opensearch.md index 39f3969835..a173c0dc49 100644 --- a/docs-website/reference_versioned_docs/version-2.22/integrations-api/opensearch.md +++ b/docs-website/reference_versioned_docs/version-2.22/integrations-api/opensearch.md @@ -1492,6 +1492,8 @@ Deletes all documents in the document store. - **recreate_index** (bool) – If True, the index will be deleted and recreated with the original mappings and settings. If False, all documents will be deleted using the `delete_by_query` API. + `recreate_index=True` is not supported when the configured index name is an alias; a + :class:`haystack.document_stores.errors.DocumentStoreError` is raised in that case. - **refresh** (bool) – If True, OpenSearch refreshes all shards involved in the delete by query after the request completes. If False, no refresh is performed. For more details, see the [OpenSearch delete_by_query refresh documentation](https://opensearch.org/docs/latest/api-reference/document-apis/delete-by-query/). @@ -1510,6 +1512,8 @@ Asynchronously deletes all documents in the document store. - **recreate_index** (bool) – If True, the index will be deleted and recreated with the original mappings and settings. If False, all documents will be deleted using the `delete_by_query` API. + `recreate_index=True` is not supported when the configured index name is an alias; a + :class:`haystack.document_stores.errors.DocumentStoreError` is raised in that case. - **refresh** (bool) – If True, OpenSearch refreshes all shards involved in the delete by query after the request completes. If False, no refresh is performed. For more details, see the [OpenSearch delete_by_query refresh documentation](https://opensearch.org/docs/latest/api-reference/document-apis/delete-by-query/). diff --git a/docs-website/reference_versioned_docs/version-2.23/integrations-api/opensearch.md b/docs-website/reference_versioned_docs/version-2.23/integrations-api/opensearch.md index 39f3969835..a173c0dc49 100644 --- a/docs-website/reference_versioned_docs/version-2.23/integrations-api/opensearch.md +++ b/docs-website/reference_versioned_docs/version-2.23/integrations-api/opensearch.md @@ -1492,6 +1492,8 @@ Deletes all documents in the document store. - **recreate_index** (bool) – If True, the index will be deleted and recreated with the original mappings and settings. If False, all documents will be deleted using the `delete_by_query` API. + `recreate_index=True` is not supported when the configured index name is an alias; a + :class:`haystack.document_stores.errors.DocumentStoreError` is raised in that case. - **refresh** (bool) – If True, OpenSearch refreshes all shards involved in the delete by query after the request completes. If False, no refresh is performed. For more details, see the [OpenSearch delete_by_query refresh documentation](https://opensearch.org/docs/latest/api-reference/document-apis/delete-by-query/). @@ -1510,6 +1512,8 @@ Asynchronously deletes all documents in the document store. - **recreate_index** (bool) – If True, the index will be deleted and recreated with the original mappings and settings. If False, all documents will be deleted using the `delete_by_query` API. + `recreate_index=True` is not supported when the configured index name is an alias; a + :class:`haystack.document_stores.errors.DocumentStoreError` is raised in that case. - **refresh** (bool) – If True, OpenSearch refreshes all shards involved in the delete by query after the request completes. If False, no refresh is performed. For more details, see the [OpenSearch delete_by_query refresh documentation](https://opensearch.org/docs/latest/api-reference/document-apis/delete-by-query/). diff --git a/docs-website/reference_versioned_docs/version-2.24/integrations-api/opensearch.md b/docs-website/reference_versioned_docs/version-2.24/integrations-api/opensearch.md index 39f3969835..a173c0dc49 100644 --- a/docs-website/reference_versioned_docs/version-2.24/integrations-api/opensearch.md +++ b/docs-website/reference_versioned_docs/version-2.24/integrations-api/opensearch.md @@ -1492,6 +1492,8 @@ Deletes all documents in the document store. - **recreate_index** (bool) – If True, the index will be deleted and recreated with the original mappings and settings. If False, all documents will be deleted using the `delete_by_query` API. + `recreate_index=True` is not supported when the configured index name is an alias; a + :class:`haystack.document_stores.errors.DocumentStoreError` is raised in that case. - **refresh** (bool) – If True, OpenSearch refreshes all shards involved in the delete by query after the request completes. If False, no refresh is performed. For more details, see the [OpenSearch delete_by_query refresh documentation](https://opensearch.org/docs/latest/api-reference/document-apis/delete-by-query/). @@ -1510,6 +1512,8 @@ Asynchronously deletes all documents in the document store. - **recreate_index** (bool) – If True, the index will be deleted and recreated with the original mappings and settings. If False, all documents will be deleted using the `delete_by_query` API. + `recreate_index=True` is not supported when the configured index name is an alias; a + :class:`haystack.document_stores.errors.DocumentStoreError` is raised in that case. - **refresh** (bool) – If True, OpenSearch refreshes all shards involved in the delete by query after the request completes. If False, no refresh is performed. For more details, see the [OpenSearch delete_by_query refresh documentation](https://opensearch.org/docs/latest/api-reference/document-apis/delete-by-query/). diff --git a/docs-website/reference_versioned_docs/version-2.25/integrations-api/opensearch.md b/docs-website/reference_versioned_docs/version-2.25/integrations-api/opensearch.md index 39f3969835..a173c0dc49 100644 --- a/docs-website/reference_versioned_docs/version-2.25/integrations-api/opensearch.md +++ b/docs-website/reference_versioned_docs/version-2.25/integrations-api/opensearch.md @@ -1492,6 +1492,8 @@ Deletes all documents in the document store. - **recreate_index** (bool) – If True, the index will be deleted and recreated with the original mappings and settings. If False, all documents will be deleted using the `delete_by_query` API. + `recreate_index=True` is not supported when the configured index name is an alias; a + :class:`haystack.document_stores.errors.DocumentStoreError` is raised in that case. - **refresh** (bool) – If True, OpenSearch refreshes all shards involved in the delete by query after the request completes. If False, no refresh is performed. For more details, see the [OpenSearch delete_by_query refresh documentation](https://opensearch.org/docs/latest/api-reference/document-apis/delete-by-query/). @@ -1510,6 +1512,8 @@ Asynchronously deletes all documents in the document store. - **recreate_index** (bool) – If True, the index will be deleted and recreated with the original mappings and settings. If False, all documents will be deleted using the `delete_by_query` API. + `recreate_index=True` is not supported when the configured index name is an alias; a + :class:`haystack.document_stores.errors.DocumentStoreError` is raised in that case. - **refresh** (bool) – If True, OpenSearch refreshes all shards involved in the delete by query after the request completes. If False, no refresh is performed. For more details, see the [OpenSearch delete_by_query refresh documentation](https://opensearch.org/docs/latest/api-reference/document-apis/delete-by-query/). diff --git a/docs-website/reference_versioned_docs/version-2.26/integrations-api/opensearch.md b/docs-website/reference_versioned_docs/version-2.26/integrations-api/opensearch.md index 39f3969835..a173c0dc49 100644 --- a/docs-website/reference_versioned_docs/version-2.26/integrations-api/opensearch.md +++ b/docs-website/reference_versioned_docs/version-2.26/integrations-api/opensearch.md @@ -1492,6 +1492,8 @@ Deletes all documents in the document store. - **recreate_index** (bool) – If True, the index will be deleted and recreated with the original mappings and settings. If False, all documents will be deleted using the `delete_by_query` API. + `recreate_index=True` is not supported when the configured index name is an alias; a + :class:`haystack.document_stores.errors.DocumentStoreError` is raised in that case. - **refresh** (bool) – If True, OpenSearch refreshes all shards involved in the delete by query after the request completes. If False, no refresh is performed. For more details, see the [OpenSearch delete_by_query refresh documentation](https://opensearch.org/docs/latest/api-reference/document-apis/delete-by-query/). @@ -1510,6 +1512,8 @@ Asynchronously deletes all documents in the document store. - **recreate_index** (bool) – If True, the index will be deleted and recreated with the original mappings and settings. If False, all documents will be deleted using the `delete_by_query` API. + `recreate_index=True` is not supported when the configured index name is an alias; a + :class:`haystack.document_stores.errors.DocumentStoreError` is raised in that case. - **refresh** (bool) – If True, OpenSearch refreshes all shards involved in the delete by query after the request completes. If False, no refresh is performed. For more details, see the [OpenSearch delete_by_query refresh documentation](https://opensearch.org/docs/latest/api-reference/document-apis/delete-by-query/). diff --git a/docs-website/reference_versioned_docs/version-2.27/integrations-api/opensearch.md b/docs-website/reference_versioned_docs/version-2.27/integrations-api/opensearch.md index 39f3969835..a173c0dc49 100644 --- a/docs-website/reference_versioned_docs/version-2.27/integrations-api/opensearch.md +++ b/docs-website/reference_versioned_docs/version-2.27/integrations-api/opensearch.md @@ -1492,6 +1492,8 @@ Deletes all documents in the document store. - **recreate_index** (bool) – If True, the index will be deleted and recreated with the original mappings and settings. If False, all documents will be deleted using the `delete_by_query` API. + `recreate_index=True` is not supported when the configured index name is an alias; a + :class:`haystack.document_stores.errors.DocumentStoreError` is raised in that case. - **refresh** (bool) – If True, OpenSearch refreshes all shards involved in the delete by query after the request completes. If False, no refresh is performed. For more details, see the [OpenSearch delete_by_query refresh documentation](https://opensearch.org/docs/latest/api-reference/document-apis/delete-by-query/). @@ -1510,6 +1512,8 @@ Asynchronously deletes all documents in the document store. - **recreate_index** (bool) – If True, the index will be deleted and recreated with the original mappings and settings. If False, all documents will be deleted using the `delete_by_query` API. + `recreate_index=True` is not supported when the configured index name is an alias; a + :class:`haystack.document_stores.errors.DocumentStoreError` is raised in that case. - **refresh** (bool) – If True, OpenSearch refreshes all shards involved in the delete by query after the request completes. If False, no refresh is performed. For more details, see the [OpenSearch delete_by_query refresh documentation](https://opensearch.org/docs/latest/api-reference/document-apis/delete-by-query/). diff --git a/docs-website/reference_versioned_docs/version-2.28/integrations-api/opensearch.md b/docs-website/reference_versioned_docs/version-2.28/integrations-api/opensearch.md index 39f3969835..a173c0dc49 100644 --- a/docs-website/reference_versioned_docs/version-2.28/integrations-api/opensearch.md +++ b/docs-website/reference_versioned_docs/version-2.28/integrations-api/opensearch.md @@ -1492,6 +1492,8 @@ Deletes all documents in the document store. - **recreate_index** (bool) – If True, the index will be deleted and recreated with the original mappings and settings. If False, all documents will be deleted using the `delete_by_query` API. + `recreate_index=True` is not supported when the configured index name is an alias; a + :class:`haystack.document_stores.errors.DocumentStoreError` is raised in that case. - **refresh** (bool) – If True, OpenSearch refreshes all shards involved in the delete by query after the request completes. If False, no refresh is performed. For more details, see the [OpenSearch delete_by_query refresh documentation](https://opensearch.org/docs/latest/api-reference/document-apis/delete-by-query/). @@ -1510,6 +1512,8 @@ Asynchronously deletes all documents in the document store. - **recreate_index** (bool) – If True, the index will be deleted and recreated with the original mappings and settings. If False, all documents will be deleted using the `delete_by_query` API. + `recreate_index=True` is not supported when the configured index name is an alias; a + :class:`haystack.document_stores.errors.DocumentStoreError` is raised in that case. - **refresh** (bool) – If True, OpenSearch refreshes all shards involved in the delete by query after the request completes. If False, no refresh is performed. For more details, see the [OpenSearch delete_by_query refresh documentation](https://opensearch.org/docs/latest/api-reference/document-apis/delete-by-query/). diff --git a/docs-website/reference_versioned_docs/version-2.29/integrations-api/opensearch.md b/docs-website/reference_versioned_docs/version-2.29/integrations-api/opensearch.md index 39f3969835..a173c0dc49 100644 --- a/docs-website/reference_versioned_docs/version-2.29/integrations-api/opensearch.md +++ b/docs-website/reference_versioned_docs/version-2.29/integrations-api/opensearch.md @@ -1492,6 +1492,8 @@ Deletes all documents in the document store. - **recreate_index** (bool) – If True, the index will be deleted and recreated with the original mappings and settings. If False, all documents will be deleted using the `delete_by_query` API. + `recreate_index=True` is not supported when the configured index name is an alias; a + :class:`haystack.document_stores.errors.DocumentStoreError` is raised in that case. - **refresh** (bool) – If True, OpenSearch refreshes all shards involved in the delete by query after the request completes. If False, no refresh is performed. For more details, see the [OpenSearch delete_by_query refresh documentation](https://opensearch.org/docs/latest/api-reference/document-apis/delete-by-query/). @@ -1510,6 +1512,8 @@ Asynchronously deletes all documents in the document store. - **recreate_index** (bool) – If True, the index will be deleted and recreated with the original mappings and settings. If False, all documents will be deleted using the `delete_by_query` API. + `recreate_index=True` is not supported when the configured index name is an alias; a + :class:`haystack.document_stores.errors.DocumentStoreError` is raised in that case. - **refresh** (bool) – If True, OpenSearch refreshes all shards involved in the delete by query after the request completes. If False, no refresh is performed. For more details, see the [OpenSearch delete_by_query refresh documentation](https://opensearch.org/docs/latest/api-reference/document-apis/delete-by-query/).