Skip to content

Commit 0a9c390

Browse files
authored
Merge pull request #271275 from eric-urban/eur/createvectorindex
cohere index creation changes
2 parents dd5faef + 65f3e15 commit 0a9c390

File tree

9 files changed

+45
-47
lines changed

9 files changed

+45
-47
lines changed

articles/ai-studio/how-to/index-add.md

Lines changed: 45 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ ms.service: azure-ai-studio
77
ms.custom:
88
- ignite-2023
99
ms.topic: how-to
10-
ms.date: 2/24/2024
10+
ms.date: 4/5/2024
1111
ms.reviewer: eur
1212
ms.author: eur
1313
author: eric-urban
@@ -25,7 +25,7 @@ You must have:
2525
- An Azure AI project
2626
- An Azure AI Search resource
2727

28-
## Create an index
28+
## Create an index from the Indexes tab
2929

3030
1. Sign in to [Azure AI Studio](https://ai.azure.com).
3131
1. Go to your project or [create a new project](../how-to/create-projects.md) in Azure AI Studio.
@@ -34,7 +34,7 @@ You must have:
3434
:::image type="content" source="../media/index-retrieve/project-left-menu.png" alt-text="Screenshot of Project Left Menu." lightbox="../media/index-retrieve/project-left-menu.png":::
3535

3636
1. Select **+ New index**
37-
1. Choose your **Source data**. You can choose source data from a list of your recent data sources, a storage URL on the cloud or even upload files and folders from the local machine. You can also add a connection to another data source such as Azure Blob Storage.
37+
1. Choose your **Source data**. You can choose source data from a list of your recent data sources, a storage URL on the cloud, or upload files and folders from the local machine. You can also add a connection to another data source such as Azure Blob Storage.
3838

3939
:::image type="content" source="../media/index-retrieve/select-source-data.png" alt-text="Screenshot of select source data." lightbox="../media/index-retrieve/select-source-data.png":::
4040

@@ -51,16 +51,26 @@ You must have:
5151

5252
1. Select **Next** after choosing index storage
5353
1. Configure your **Search Settings**
54-
1. The search type defaults to **Hybrid + Semantic**, which is a combination of keyword search, vector search and semantic search to give the best possible search results.
55-
1. For the hybrid option to work, you need an embedding model. Choose the Azure OpenAI resource, which has the embedding model
54+
1. The ***Vector settings*** defaults to true for Add vector search to this search resource. As noted, this enables Hybrid and Hybrid + Semantic search options. Disabling this limits vector search options to Keyword and Semantic.
55+
1. For the hybrid option to work, you need an embedding model. Choose an embedding model from the dropdown.
5656
1. Select the acknowledgment to deploy an embedding model if it doesn't already exist in your resource
57-
57+
5858
:::image type="content" source="../media/index-retrieve/search-settings.png" alt-text="Screenshot of configure search settings." lightbox="../media/index-retrieve/search-settings.png":::
59+
60+
If a non-Azure OpenAI model isn't appearing in the dropdown follow these steps:
61+
1. Navigate to the Project settings in [Azure AI Studio](https://ai.azure.com).
62+
1. Navigate to connections section in the settings tab and select New connection.
63+
1. Select **Serverless Model**.
64+
1. Type in the name of your embedding model deployment and select Add connection. If the model doesn't appear in the dropdown, select the **Enter manually** option.
65+
1. Enter the deployment API endpoint, model name, and API key in the corresponding fields. Then add connection.
66+
1. The embedding model should now appear in the dropdown.
67+
68+
:::image type="content" source="../media/index-retrieve/serverless-connection.png" alt-text="Screenshot of connect a serverless model." lightbox="../media/index-retrieve/serverless-connection.png":::
5969

60-
1. Use the prefilled name or type your own name for New Vector index name
6170
1. Select **Next** after configuring search settings
6271
1. In the **Index settings**
6372
1. Enter a name for your index or use the autopopulated name
73+
1. Schedule updates. You can choose to update the index hourly or daily.
6474
1. Choose the compute where you want to run the jobs to create the index. You can
6575
- Auto select to allow Azure AI to choose an appropriate VM size that is available
6676
- Choose a VM size from a list of recommended options
@@ -70,48 +80,35 @@ You must have:
7080

7181
1. Select **Next** after configuring index settings
7282
1. Review the details you entered and select **Create**
73-
74-
> [!NOTE]
75-
> If you see a **DeploymentNotFound** error, you need to assign more permissions. See [mitigate DeploymentNotFound error](#mitigate-deploymentnotfound-error) for more details.
76-
7783
1. You're taken to the index details page where you can see the status of your index creation.
7884

85+
## Create an index from the Playground
86+
1. Open your AI Studio project.
87+
1. Navigate to the Playground tab.
88+
1. The Select available project index is displayed for existing indexes in the project. If an existing index isn't being used, continue to the next steps.
89+
1. Select the Add your data dropdown.
90+
91+
:::image type="content" source="../media/index-retrieve/add-data-dropdown.png" alt-text="Screenshot of the playground add your data dropdown." lightbox="../media/index-retrieve/add-data-dropdown.png":::
7992

80-
### Mitigate DeploymentNotFound error
81-
82-
When you try to create a vector index, you might see the following error at the **Review + Finish** step:
83-
84-
**Failed to create vector index. DeploymentNotFound: A valid deployment for the model=text-embedding-ada-002 was not found in the workspace connection=Default_AzureOpenAI provided.**
85-
86-
This can happen if you are trying to create an index using an **Owner**, **Contributor**, or **Azure AI Developer** role at the project level. To mitigate this error, you might need to assign more permissions using either of the following methods.
87-
88-
> [!NOTE]
89-
> You need to be assigned the **Owner** role of the resource group or higher scope (like Subscription) to perform the operation in the next steps. This is because only the Owner role can assign roles to others. See details [here](/azure/role-based-access-control/built-in-roles).
90-
91-
#### Method 1: Assign more permissions to the user on the Azure AI hub resource
92-
93-
If the Azure AI hub resource the project uses was created through Azure AI Studio:
94-
1. Sign in to [Azure AI Studio](https://aka.ms/azureaistudio) and select your project via **Build** > **Projects**.
95-
1. Select **AI project settings** from the collapsible left menu.
96-
1. From the **Resource Configuration** section, select the link for your resource group name that takes you to the Azure portal.
97-
1. In the Azure portal under **Overview** > **Resources** select the Azure AI service type. It's named similar to "YourAzureAIResourceName-aiservices."
98-
99-
:::image type="content" source="../media/roles-access/resource-group-azure-ai-service.png" alt-text="Screenshot of Azure AI service in a resource group." lightbox="../media/roles-access/resource-group-azure-ai-service.png":::
100-
101-
1. Select **Access control (IAM)** > **+ Add** to add a role assignment.
102-
1. Add the **Cognitive Services OpenAI User** role to the user who wants to make an index. `Cognitive Services OpenAI Contributor` and `Cognitive Services Contributor` also work, but they assign more permissions than needed for creating an index in Azure AI Studio.
103-
104-
> [!NOTE]
105-
> You can also opt to assign more permissions [on the resource group](#method-2-assign-more-permissions-on-the-resource-group). However, that method assigns more permissions than needed to mitigate the **DeploymentNotFound** error.
106-
107-
#### Method 2: Assign more permissions on the resource group
93+
1. If a new index is being created, select the ***Add your data*** option. Then follow the steps from ***Create an index from the Indexes tab*** to navigate through the wizard to create an index.
94+
1. If there's an external index that is being used, select the ***Connect external index*** option.
95+
1. In the **Index Source**
96+
1. Select your data source
97+
1. Select your AI Search Service
98+
1. Select the index to be used.
10899

109-
If the Azure AI hub resource the project uses was created through Azure portal:
110-
1. Sign in to [Azure AI Studio](https://aka.ms/azureaistudio) and select your project via **Build** > **Projects**.
111-
1. Select **AI project settings** from the collapsible left menu.
112-
1. From the **Resource Configuration** section, select the link for your resource group name that takes you to the Azure portal.
113-
1. Select **Access control (IAM)** > **+ Add** to add a role assignment.
114-
1. Add the **Cognitive Services OpenAI User** role to the user who wants to make an index. `Cognitive Services OpenAI Contributor` and `Cognitive Services Contributor` also work, but they assign more permissions than needed for creating an index in Azure AI Studio.
100+
:::image type="content" source="../media/index-retrieve/connect-external-index.png" alt-text="Screenshot of the page where you select an index." lightbox="../media/index-retrieve/connect-external-index.png":::
101+
102+
1. Select **Next** after configuring search settings.
103+
1. In the **Index settings**
104+
1. Enter a name for your index or use the autopopulated name
105+
1. Schedule updates. You can choose to update the index hourly or daily.
106+
1. Choose the compute where you want to run the jobs to create the index. You can
107+
- Auto select to allow Azure AI to choose an appropriate VM size that is available
108+
- Choose a VM size from a list of recommended options
109+
- Choose a VM size from a list of all possible options
110+
1. Review the details you entered and select **Create.**
111+
1. The index is now ready to be used in the Playground.
115112

116113

117114
## Use an index in prompt flow
@@ -126,8 +123,9 @@ If the Azure AI hub resource the project uses was created through Azure portal:
126123
1. Provide a name for your Index Lookup Tool and select **Add**.
127124
1. Select the **mlindex_content** value box, and select your index. After completing this step, enter the queries and **query_types** to be performed against the index.
128125

129-
:::image type="content" source="../media/index-retrieve/configure-index-lookup-tool.png" alt-text="Screenshot of Configure Index Lookup." lightbox="../media/index-retrieve/configure-index-lookup-tool.png":::
126+
:::image type="content" source="../media/index-retrieve/configure-index-lookup-tool.png" alt-text="Screenshot of the prompt flow node to configure index lookup." lightbox="../media/index-retrieve/configure-index-lookup-tool.png":::
127+
130128

131129
## Next steps
132130

133-
- [Learn more about RAG](../concepts/retrieval-augmented-generation.md)
131+
- [Learn more about RAG](../concepts/retrieval-augmented-generation.md)
32 KB
Loading
58.9 KB
Loading
3.5 KB
Loading
54.7 KB
Loading
189 Bytes
Loading
4.09 KB
Loading
72.8 KB
Loading
67.8 KB
Loading

0 commit comments

Comments
 (0)