From c039d0f7ccba943b39065afa2eaa315ae2d53328 Mon Sep 17 00:00:00 2001 From: Paul Cornell Date: Mon, 23 Feb 2026 16:34:38 -0800 Subject: [PATCH 1/3] OpenSearch connectors: support for Amazon OpenSearch Serverless --- snippets/general-shared-text/opensearch.mdx | 88 ++++++++++++++++++++- 1 file changed, 85 insertions(+), 3 deletions(-) diff --git a/snippets/general-shared-text/opensearch.mdx b/snippets/general-shared-text/opensearch.mdx index cda9542d..0eff0313 100644 --- a/snippets/general-shared-text/opensearch.mdx +++ b/snippets/general-shared-text/opensearch.mdx @@ -1,7 +1,7 @@ - For the [Unstructured UI](/ui/overview) or the [Unstructured API](/api-reference/overview), local OpenSearch instances are not supported. - For [Unstructured Ingest](/open-source/ingestion/overview), local and non-local OpenSearch instances are supported. - For example, to set up an [AWS OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html) instance, complete steps similar to the following: + For example, to set up an [Amazon OpenSearch Service managed cluster](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html) instance, complete steps similar to the following: 1. Sign in to your AWS account, and then open your AWS Management Console. 2. Open your Amazon OpenSearch Service console. @@ -34,6 +34,88 @@ d. Click **Clear policy**.
e. Click **Save changes**. + To set up an [Amazon OpenSearch Serverless collection](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-create-console.html), complete steps similar to the following: + + 1. Sign in to your AWS account, and then open your AWS Management Console. + 2. Open your Amazon OpenSearch Service console. + 3. On the sidebar, expand **Serverless**, and then click **Dashboard**. + 4. Click **Create collection**. + 5. In the **Collection details** tile, for **Collection name**, enter some unique name for your new OpenSearch Serverless collection. + Optionally, for **Description**, enter some meaningful description for your new collection. + 6. For **Collection type**, select **Search**. + + + Unstructured does not support the **Vector search** collection type. If you need vector search support, you can either continue + with these steps to use the **Search** collection type, or you can follow the preceding steps to set up set up an Amazon OpenSearch Service managed cluster instead. + However, note that vector search capabilities are less optimal for either of these options. + + + 7. In the **Collection creation method** tile, select **Standard create**. + 8. For **Encryption**, choose an AWS KMS key type. + 9. For **Network access settings**, choose an **Access type**. + 10. For **Resource type**, select both **Enable access to OpenSearch endpoint** and **Enable access to OpenSearch Dashboards**. + 11. Click **Next**. + 12. In the **Definition method** tile, select **JSON**. + 13. In the **JSON editor** box, enter the following JSON, replacing the following placeholders: + + - Replace `` with the name of the new OpenSearch Serverless collection. + - Replace `` with the target AWS account ID. + - Replace `` with the ID of the target AWS IAM user. + + ```json + [ + { + "Rules": [ + { + "Resource": ["collection/"], + "Permission": [ + "aoss:CreateCollectionItems", + "aoss:UpdateCollectionItems", + "aoss:DescribeCollectionItems" + ], + "ResourceType": "collection" + }, + { + "Resource": ["index//*"], + "Permission": [ + "aoss:CreateIndex", + "aoss:DescribeIndex", + "aoss:ReadDocument", + "aoss:WriteDocument", + "aoss:UpdateIndex", + "aoss:DeleteIndex" + ], + "ResourceType": "index" + }, + { + "Resource": ["model//*"], + "Permission": [ + "aoss:DescribeMLResource", + "aoss:CreateMLResource", + "aoss:UpdateMLResource", + "aoss:DeleteMLResource", + "aoss:ExecuteMLResource" + ], + "ResourceType": "model" + } + ], + "Principal": ["arn:aws:iam:::user/"] + } + ] + ``` + + 14. Click **Next**. + 15. For **Data access policy settings**, select **Create as a new data access policy**. + 16. In the **Name and description** tile, enter some unique name and an optional description for the new data access policy. + 17. Click **Next**. + 18. Enter any desired index details, and click **Next** again. For example: + + a. For **Index name**, enter the name of the new index in the collection.
+ b. For **Automatic Semantic Enrichment fields**, click **Add**, enter `embeddings` for **Automatic Semantic Enrichment field name**, click **Add**, and click ***Confirm**.
+ c. For **Lexical search fields**, click **Add**, enter `text` for **Field name** and select **Text** for **Data type**, click **Add**, and click ***Confirm**.
+ + 19. Click **Submit**. + The following video shows how to set up a [local OpenSearch](https://opensearch.org/downloads.html) instance.