Rename Azure Cognitive Search -> Azure AI Search (#335)

Paul-Cornell · MKhalusova · web-flow · commit d09548dce63a · 2024-11-20T13:06:48.000-05:00
Co-authored-by: Maria Khalusova &lt;kafooster@gmail.com&gt;
diff --git a/api-reference/ingest/destination-connector/azure-ai-search.mdx b/api-reference/ingest/destination-connector/azure-ai-search.mdx
@@ -0,0 +1,21 @@
+---
+title: Azure AI Search
+---
+
+import SharedAzureAIS from '/snippets/dc-shared-text/azure-ai-search-cli-api.mdx';
+import SharedAPIKeyURL from '/snippets/general-shared-text/api-key-url.mdx';
+
+<SharedAzureAIS />
+<SharedAPIKeyURL/>
+
+Now call the Unstructured CLI or Python SDK. The source connector can be any of the ones supported. This example uses the local source connector:
+
+import AzureAISAPISh from '/snippets/destination_connectors/azure_ai_search.sh.mdx';
+import AzureAISAPIPyV2 from '/snippets/destination_connectors/azure_ai_search.v2.py.mdx';
+import AzureAISAPIPyV1 from '/snippets/destination_connectors/azure_ai_search.v1.py.mdx';
+
+<CodeGroup>
+  <AzureAISAPISh />
+  <AzureAISAPIPyV2 />
+  <AzureAISAPIPyV1 />
+</CodeGroup>
diff --git a/api-reference/ingest/destination-connector/azure-cognitive-search.mdx b/api-reference/ingest/destination-connector/azure-cognitive-search.mdx
diff --git a/api-reference/ingest/ingest-dependencies.mdx b/api-reference/ingest/ingest-dependencies.mdx
@@ -49,7 +49,7 @@ To add support for additional connectors, run the following:
 | `pip install "unstructured-ingest[airtable]"` | Airtable |
 | `pip install "unstructured-ingest[astra]"` | Astra DB |
 | `pip install "unstructured-ingest[azure]"` | Azure Blob Storage |
-| `pip install "unstructured-ingest[azure-cognitive-search]"` | Azure Cognitive Search Service |
+| `pip install "unstructured-ingest[azure-ai-search]"` | Azure AI Search |
 | `pip install "unstructured-ingest[biomed]"` | Biomed |
 | `pip install "unstructured-ingest[box]"` | Box |
 | `pip install "unstructured-ingest[chroma]"` | Chroma |
diff --git a/mint.json b/mint.json
@@ -187,7 +187,7 @@
               "open-source/ingest/destination-connectors/overview",
               "open-source/ingest/destination-connectors/astradb",
               "open-source/ingest/destination-connectors/azure",
-              "open-source/ingest/destination-connectors/azure-cognitive-search",
+              "open-source/ingest/destination-connectors/azure-ai-search",
               "open-source/ingest/destination-connectors/box",
               "open-source/ingest/destination-connectors/chroma",
               "open-source/ingest/destination-connectors/clarifai",
@@ -345,7 +345,7 @@
               "api-reference/ingest/destination-connector/overview",
               "api-reference/ingest/destination-connector/astradb",
               "api-reference/ingest/destination-connector/azure",
-              "api-reference/ingest/destination-connector/azure-cognitive-search",
+              "api-reference/ingest/destination-connector/azure-ai-search",
               "api-reference/ingest/destination-connector/box",
               "api-reference/ingest/destination-connector/chroma",
               "api-reference/ingest/destination-connector/clarifai",
@@ -464,7 +464,7 @@
             "pages": [
               "platform/destinations/overview",
               "platform/destinations/astradb",
-              "platform/destinations/azure-cognitive-search",
+              "platform/destinations/azure-ai-search",
               "platform/destinations/couchbase",
               "platform/destinations/databricks-volumes",
               "platform/destinations/delta-table",
diff --git a/open-source/ingest/destination-connectors/azure-ai-search.mdx b/open-source/ingest/destination-connectors/azure-ai-search.mdx
@@ -1,27 +1,27 @@
 ---
-title: Azure Cognitive Search
+title: Azure AI Search
 ---
 
 import NewDocument from '/snippets/general-shared-text/new-document.mdx';
 
 <NewDocument />
 
-import SharedAzureCS from '/snippets/dc-shared-text/azure-cognitive-search-cli-api.mdx';
+import SharedAzureAIS from '/snippets/dc-shared-text/azure-ai-search-cli-api.mdx';
 
-<SharedAzureCS />
+<SharedAzureAIS />
 
 Now call the Unstructured CLI or Python. The source connector can be any of the ones supported. This example uses the local source connector.
 
 This example sends files to Unstructured API services for processing by default. To process files locally instead, see the instructions at the end of this page.
 
-import AzureCSAPISh from '/snippets/destination_connectors/azure_cognitive_search.sh.mdx';
-import AzureCSAPIPyV2 from '/snippets/destination_connectors/azure_cognitive_search.v2.py.mdx';
-import AzureCSAPIPyV1 from '/snippets/destination_connectors/azure_cognitive_search.v1.py.mdx';
+import AzureAISAPISh from '/snippets/destination_connectors/azure_ai_search.sh.mdx';
+import AzureAISAPIPyV2 from '/snippets/destination_connectors/azure_ai_search.v2.py.mdx';
+import AzureAISAPIPyV1 from '/snippets/destination_connectors/azure_ai_search.v1.py.mdx';
 
 <CodeGroup>
-  <AzureCSAPISh />
-  <AzureCSAPIPyV2 />
-  <AzureCSAPIPyV1 />
+  <AzureAISAPISh />
+  <AzureAISAPIPyV2 />
+  <AzureAISAPIPyV1 />
 </CodeGroup>
 
 import SharedPartitionByAPIOSS from '/snippets/ingest-configuration-shared/partition-by-api-oss.mdx';
diff --git a/open-source/installation/full-installation.mdx b/open-source/installation/full-installation.mdx
@@ -53,6 +53,6 @@ pip install "unstructured-ingest[s3]"
 _Available data connectors:_
 
 ```bash
-"airtable", "azure", "azure-cognitive-search", "biomed", "box", "confluence", "couchbase", "delta-table", "discord", "dropbox", "elasticsearch", "gcs", "github", "gitlab", "google-drive", "jira", "mongodb", "notion", "opensearch", "onedrive", "outlook", "reddit", "s3", "sharepoint", "salesforce", "slack", "wikipedia"
+"airtable", "azure", "azure-ai-search", "biomed", "box", "confluence", "couchbase", "delta-table", "discord", "dropbox", "elasticsearch", "gcs", "github", "gitlab", "google-drive", "jira", "mongodb", "notion", "opensearch", "onedrive", "outlook", "reddit", "s3", "sharepoint", "salesforce", "slack", "wikipedia"
 
 ```
diff --git a/platform/connectors.mdx b/platform/connectors.mdx
@@ -27,7 +27,7 @@ If your source is not listed here, you might still be able to connect Unstructur
 ## Destinations
 
 - [Astra DB](/platform/destinations/astradb)
-- [Azure Cognitive Search](/platform/destinations/azure-cognitive-search)
+- [Azure AI Search](/platform/destinations/azure-ai-search)
 - [Couchbase](/platform/destinations/couchbase)
 - [Databricks Volumes](/platform/destinations/databricks-volumes)
 - [Delta Table](/platform/destinations/delta-table)
diff --git a/platform/destinations/azure-ai-search.mdx b/platform/destinations/azure-ai-search.mdx
@@ -0,0 +1,26 @@
+---
+title: Azure AI Search 
+---
+
+Send processed data from Unstructured to Azure AI Search.
+
+You'll need:
+
+import AzureAISPrerequisites from '/snippets/general-shared-text/azure-ai-search.mdx';
+
+<AzureAISPrerequisites />
+
+To create the destination connector:
+
+1. On the sidebar, click **Connectors**.
+2. Click **Destinations**.
+3. Click **Add new**.
+4. Give the connector some unique **Name**.
+5. In the **Provider** area, click **Azure AI Search**.
+6. Click **Continue**. 
+7. Follow the on-screen instructions to fill in the fields as described later on this page.
+8. Click **Save and Test**.
+
+import AzureAISFields from '/snippets/general-shared-text/azure-ai-search-platform.mdx';
+
+<AzureAISFields />
diff --git a/platform/destinations/azure-cognitive-search.mdx b/platform/destinations/azure-cognitive-search.mdx
diff --git a/platform/destinations/overview.mdx b/platform/destinations/overview.mdx
@@ -18,7 +18,7 @@ To create a destination connector:
 7. Fill in the fields according to your connector type. To learn how, click your connector type in the following list:
 
    - [Astra DB](/platform/destinations/astradb)
-   - [Azure Cognitive Search](/platform/destinations/azure-cognitive-search)
+   - [Azure AI Search](/platform/destinations/azure-ai-search)
    - [Couchbase](/platform/destinations/couchbase)
    - [Delta Table](/platform/destinations/delta-table)
    - [Elasticsearch](/platform/destinations/elasticsearch)
diff --git a/snippets/dc-shared-text/azure-ai-search-cli-api.mdx b/snippets/dc-shared-text/azure-ai-search-cli-api.mdx
@@ -0,0 +1,11 @@
+Batch process all your records to store structured outputs in an Azure AI Search account.
+
+You will need:
+
+import AzureAISShared from '/snippets/general-shared-text/azure-ai-search.mdx';
+import AzureAISSharedCLIAPI from '/snippets/general-shared-text/azure-ai-search-cli-api.mdx';
+
+<AzureAISShared />
+<AzureAISSharedCLIAPI />
+
+
diff --git a/snippets/dc-shared-text/azure-cognitive-search-cli-api.mdx b/snippets/dc-shared-text/azure-cognitive-search-cli-api.mdx
diff --git a/snippets/destination_connectors/azure_ai_search.sh.mdx b/snippets/destination_connectors/azure_ai_search.sh.mdx
@@ -16,7 +16,7 @@ unstructured-ingest \
     --partition-endpoint $UNSTRUCTURED_API_URL \
     --strategy hi_res \
     --additional-partition-args="{\"split_pdf_page\":\"true\", \"split_pdf_allow_failed\":\"true\", \"split_pdf_concurrency_level\": 15}" \
-  azure-cognitive-search \
+  azure-ai-search \
     --key $AZURE_SEARCH_API_KEY \
     --endpoint $AZURE_SEARCH_ENDPOINT \
     --index $AZURE_SEARCH_INDEX
diff --git a/snippets/destination_connectors/azure_ai_search.v1.py.mdx b/snippets/destination_connectors/azure_ai_search.v1.py.mdx
@@ -1,10 +1,10 @@
 ```python Python Ingest v1
 import os
 
-from unstructured_ingest.connector.azure_cognitive_search import (
-    AzureCognitiveSearchAccessConfig,
-    AzureCognitiveSearchWriteConfig,
-    SimpleAzureCognitiveSearchStorageConfig,
+from unstructured_ingest.connector.azure_ai_search import (
+    AzureAISearchAccessConfig,
+    AzureAISearchWriteConfig,
+    SimpleAzureAISearchStorageConfig,
 )
 from unstructured_ingest.connector.local import SimpleLocalConfig
 from unstructured_ingest.interfaces import (
@@ -15,19 +15,19 @@ from unstructured_ingest.interfaces import (
     ReadConfig,
 )
 from unstructured_ingest.runner import LocalRunner
-from unstructured_ingest.runner.writers.azure_cognitive_search import (
-    AzureCognitiveSearchWriter,
+from unstructured_ingest.runner.writers.azure_ai_search import (
+    AzureAISearchWriter,
 )
 from unstructured_ingest.runner.writers.base_writer import Writer
 
 
 def get_writer() -> Writer:
-    return AzureCognitiveSearchWriter(
-        connector_config=SimpleAzureCognitiveSearchStorageConfig(
-            access_config=AzureCognitiveSearchAccessConfig(key=os.getenv("AZURE_SEARCH_API_KEY")),
+    return AzureAISearchWriter(
+        connector_config=SimpleAzureAISearchStorageConfig(
+            access_config=AzureAISearchAccessConfig(key=os.getenv("AZURE_SEARCH_API_KEY")),
             endpoint=os.getenv("AZURE_SEARCH_ENDPOINT"),
         ),
-        write_config=AzureCognitiveSearchWriteConfig(index=os.getenv("AZURE_SEARCH_INDEX")),
+        write_config=AzureAISearchWriteConfig(index=os.getenv("AZURE_SEARCH_INDEX")),
     )
 
 # Chunking and embedding are optional.
diff --git a/snippets/destination_connectors/azure_ai_search.v2.py.mdx b/snippets/destination_connectors/azure_ai_search.v2.py.mdx
@@ -3,11 +3,11 @@ import os
 
 from unstructured_ingest.v2.pipeline.pipeline import Pipeline
 from unstructured_ingest.v2.interfaces import ProcessorConfig
-from unstructured_ingest.v2.processes.connectors.azure_cognitive_search import (
-    AzureCognitiveSearchAccessConfig,
-    AzureCognitiveSearchConnectionConfig,
-    AzureCognitiveSearchUploadStagerConfig,
-    AzureCognitiveSearchUploaderConfig
+from unstructured_ingest.v2.processes.connectors.azure_ai_search import (
+    AzureAISearchAccessConfig,
+    AzureAISearchConnectionConfig,
+    AzureAISearchUploadStagerConfig,
+    AzureAISearchUploaderConfig
 )
 from unstructured_ingest.v2.processes.connectors.local import (
     LocalIndexerConfig,
@@ -39,14 +39,14 @@ if __name__ == "__main__":
         ),
         chunker_config=ChunkerConfig(chunking_strategy="by_title"),
         embedder_config=EmbedderConfig(embedding_provider="huggingface"),
-        destination_connection_config=AzureCognitiveSearchConnectionConfig(
-            access_config=AzureCognitiveSearchAccessConfig(
+        destination_connection_config=AzureAISearchConnectionConfig(
+            access_config=AzureAISearchAccessConfig(
                 key=os.getenv("AZURE_SEARCH_API_KEY")
             ),
             endpoint=os.getenv("AZURE_SEARCH_ENDPOINT"),
             index=os.getenv("AZURE_SEARCH_INDEX")
         ),
-        stager_config=AzureCognitiveSearchUploadStagerConfig(),
-        uploader_config=AzureCognitiveSearchUploaderConfig()
+        stager_config=AzureAISearchUploadStagerConfig(),
+        uploader_config=AzureAISearchUploaderConfig()
     ).run()
 ```
diff --git a/snippets/general-shared-text/azure-ai-search-cli-api.mdx b/snippets/general-shared-text/azure-ai-search-cli-api.mdx
@@ -1,7 +1,7 @@
-The Azure Cognitive Search connector dependencies:
+The Azure AI Search connector dependencies:
 
 ```bash CLI, Python
-pip install "unstructured-ingest[azure-cognitive-search]"
+pip install "unstructured-ingest[azure-ai-search]"
 ```
 
 import AdditionalIngestDependencies from '/snippets/general-shared-text/ingest-dependencies.mdx';
@@ -10,6 +10,6 @@ import AdditionalIngestDependencies from '/snippets/general-shared-text/ingest-d
 
 These environment variables:
 
-- `AZURE_SEARCH_ENDPOINT` - The endpoint URL for Azure AI Search (formerly Azure Cognitive Search), represented by `--endpoint` (CLI) or `endpoint` (Python).
+- `AZURE_SEARCH_ENDPOINT` - The endpoint URL for Azure AI Search, represented by `--endpoint` (CLI) or `endpoint` (Python).
 - `AZURE_SEARCH_API_KEY` - The API key for Azure AI Search, represented by `--key` (CLI) or `key` (Python).
 - `AZURE_SEARCH_INDEX` - The name of the index for Azure AI Search, represented by `--index` (CLI) or `index` (Python).
diff --git a/snippets/general-shared-text/azure-ai-search-platform.mdx b/snippets/general-shared-text/azure-ai-search-platform.mdx
@@ -1,6 +1,6 @@
 Fill in the following fields:
 
 - **Name** (_required_): A unique name for this connector.
-- **Endpoint** (_required_): The endpoint URL for Azure AI Search (formerly Azure Cognitive Search).
+- **Endpoint** (_required_): The endpoint URL for Azure AI Search.
 - **API Key** (_required_): The API key for Azure AI Search.
 - **Index Name** (_required_): The name of the index for Azure AI Search.
diff --git a/snippets/general-shared-text/azure-ai-search.mdx b/snippets/general-shared-text/azure-ai-search.mdx
@@ -1,11 +1,11 @@
-The Azure AI Search (formerly Azure Cognitive Search) prerequisites:
+The Azure AI Search prerequisites:
 
 The following video shows how to fulfill the minimum set of Azure AI Search prerequisites:
 
 <iframe
 width="560"
 height="315"
-src="https://www.youtube.com/embed/G_YqjOhSG7M"
+src="https://www.youtube.com/embed/6ZjU5OupWE8"
 title="YouTube video player"
 frameborder="0"
 allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
@@ -36,7 +36,7 @@ Here are some more details about these prerequisites:
 
   ```json
   {
-    "@odata.context": "https://ingest-test-azure-cognitive-search.search.windows.net/$metadata#indexes/$entity",
+    "@odata.context": "https://ingest-test-azure-ai-search.search.windows.net/$metadata#indexes/$entity",
     "@odata.etag": "\"0x8DCED5D96393CA9\"",
     "name": "<my-index-name>",
     "defaultScoringProfile": null,
