Skip to content

Commit 226cc7e

Browse files
committed
Roll out prepare models for other tutorils + integrate search endpoint info into set up rest client
1 parent 0800d72 commit 226cc7e

4 files changed

+68
-23
lines changed

articles/search/tutorial-document-extraction-image-verbalization.md

Lines changed: 23 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -83,18 +83,28 @@ The following instructions apply to Azure Storage which provides the sample data
8383
}
8484
```
8585

86-
### Copy a search service URL and API key
86+
## Prepare models
8787

88-
For this tutorial, your local REST client connection to Azure AI Search requires an endpoint and an API key. You can get these values from the Azure portal. For alternative connection methods, see [Connect to a search service](search-get-started-rbac.md).
88+
This tutorial assumes you have an existing Azure OpenAI resource through which the skills call the text embedding model and chat completion models. The search service connects to the models during skillset processing and during query execution using its managed identity. This section gives you guidance and links for assigning roles for authorized access.
8989

90-
1. Sign in to the [Azure portal](https://portal.azure.com), navigate to the search service **Overview** page, and copy the URL. An example endpoint might look like `https://mydemo.search.windows.net`.
90+
1. Sign in to the Azure portal (not the Foundry portal) and find the Azure OpenAI resource.
9191

92-
1. Under **Settings** > **Keys**, copy an admin key. Admin keys are used to add, modify, and delete objects. There are two interchangeable admin keys. Copy either one.
92+
1. Select **Access control (IAM)**.
9393

94-
:::image type="content" source="media/search-get-started-rest/get-url-key.png" alt-text="Screenshot of the URL and API keys in the Azure portal.":::
94+
1. Select **Add** and then **Add role assignment**.
95+
96+
1. Search for **Cognitive Services OpenAI User** and then select it.
97+
98+
1. Choose **Managed identity** and then assign your [search service managed identity](search-howto-managed-identities-data-sources.md).
99+
100+
For more information, see [Role-based access control for Azure OpenAI in Azure AI Foundry Models](/azure/ai-foundry/openai/how-to/role-based-access-control).
95101

96102
## Set up your REST file
97103

104+
For this tutorial, your local REST client connection to Azure AI Search requires an endpoint and an API key. You can get these values from the Azure portal. For alternative connection methods, see [Connect to a search service](search-get-started-rbac.md).
105+
106+
For other authenticated connections, the search service uses the role assignments you previously defined.
107+
98108
1. Start Visual Studio Code and create a new file.
99109

100110
1. Provide values for variables used in the request.
@@ -110,9 +120,15 @@ For this tutorial, your local REST client connection to Azure AI Search requires
110120
@imageProjectionContainer=PUT-YOUR-IMAGE-PROJECTION-CONTAINER-HERE (Azure AI Search creates this container for you during skills processing)
111121
```
112122

113-
1. Save the file using a `.rest` or `.http` file extension.
123+
1. Save the file using a `.rest` or `.http` file extension. For help with the REST client, see [Quickstart: Full-text search using REST](search-get-started-text.md).
124+
125+
To get the Azure AI Search endpoint and API key:
126+
127+
1. Sign in to the [Azure portal](https://portal.azure.com), navigate to the search service **Overview** page, and copy the URL. An example endpoint might look like `https://mydemo.search.windows.net`.
128+
129+
1. Under **Settings** > **Keys**, copy an admin key. Admin keys are used to add, modify, and delete objects. There are two interchangeable admin keys. Copy either one.
114130

115-
For help with the REST client, see [Quickstart: Full-text search using REST](search-get-started-text.md).
131+
:::image type="content" source="media/search-get-started-rest/get-url-key.png" alt-text="Screenshot of the URL and API keys in the Azure portal.":::
116132

117133
## Create a data source
118134

articles/search/tutorial-document-extraction-multimodal-embeddings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ This tutorial assumes you have an existing Azure AI multiservice account through
101101

102102
For this tutorial, your local REST client connection to Azure AI Search requires an endpoint and an API key. You can get these values from the Azure portal. For alternative connection methods, see [Connect to a search service](search-get-started-rbac.md).
103103

104-
For other connections, the search service uses the role assignments you previously defined.
104+
For other authenticated connections, the search service uses the role assignments you previously defined.
105105

106106
1. Start Visual Studio Code and create a new file.
107107

articles/search/tutorial-document-layout-image-verbalization.md

Lines changed: 23 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -82,22 +82,31 @@ The following instructions apply to Azure Storage which provides the sample data
8282
}
8383
```
8484

85-
### Copy a search service URL and API key
85+
## Prepare models
8686

87-
For this tutorial, your local REST client connection to Azure AI Search requires an endpoint and an API key. You can get these values from the Azure portal. For alternative connection methods, see [Connect to a search service](search-get-started-rbac.md).
87+
This tutorial assumes you have an existing Azure OpenAI resource through which the skills call the text embedding model and chat completion models. The search service connects to the models during skillset processing and during query execution using its managed identity. This section gives you guidance and links for assigning roles for authorized access.
8888

89-
1. Sign in to the [Azure portal](https://portal.azure.com), navigate to the search service **Overview** page, and copy the URL. An example endpoint might look like `https://mydemo.search.windows.net`.
89+
1. Sign in to the Azure portal (not the Foundry portal) and find the Azure OpenAI resource.
9090

91-
1. Under **Settings** > **Keys**, copy an admin key. Admin keys are used to add, modify, and delete objects. There are two interchangeable admin keys. Copy either one.
91+
1. Select **Access control (IAM)**.
9292

93-
:::image type="content" source="media/search-get-started-rest/get-url-key.png" alt-text="Screenshot of the URL and API keys in the Azure portal.":::
93+
1. Select **Add** and then **Add role assignment**.
94+
95+
1. Search for **Cognitive Services OpenAI User** and then select it.
96+
97+
1. Choose **Managed identity** and then assign your [search service managed identity](search-howto-managed-identities-data-sources.md).
98+
99+
For more information, see [Role-based access control for Azure OpenAI in Azure AI Foundry Models](/azure/ai-foundry/openai/how-to/role-based-access-control).
94100

95101
## Set up your REST file
96102

103+
For this tutorial, your local REST client connection to Azure AI Search requires an endpoint and an API key. You can get these values from the Azure portal. For alternative connection methods, see [Connect to a search service](search-get-started-rbac.md).
104+
105+
For other authenticated connections, the search service uses the role assignments you previously defined.
106+
97107
1. Start Visual Studio Code and create a new file.
98108

99109
1. Provide values for variables used in the request.
100-
101110
```http
102111
@searchUrl = PUT-YOUR-SEARCH-SERVICE-ENDPOINT-HERE
103112
@searchApiKey = PUT-YOUR-ADMIN-API-KEY-HERE
@@ -109,9 +118,15 @@ For this tutorial, your local REST client connection to Azure AI Search requires
109118
@imageProjectionContainer=PUT-YOUR-IMAGE-PROJECTION-CONTAINER-HERE (Azure AI Search creates this container for you during skills processing)
110119
```
111120

112-
1. Save the file using a `.rest` or `.http` file extension.
121+
1. Save the file using a `.rest` or `.http` file extension. For help with the REST client, see [Quickstart: Full-text search using REST](search-get-started-text.md).
122+
123+
To get the Azure AI Search endpoint and API key:
124+
125+
1. Sign in to the [Azure portal](https://portal.azure.com), navigate to the search service **Overview** page, and copy the URL. An example endpoint might look like `https://mydemo.search.windows.net`.
126+
127+
1. Under **Settings** > **Keys**, copy an admin key. Admin keys are used to add, modify, and delete objects. There are two interchangeable admin keys. Copy either one.
113128

114-
For help with the REST client, see [Quickstart: Full-text search using REST](search-get-started-text.md).
129+
:::image type="content" source="media/search-get-started-rest/get-url-key.png" alt-text="Screenshot of the URL and API keys in the Azure portal.":::
115130

116131
## Create a data source
117132

articles/search/tutorial-document-layout-multimodal-embeddings.md

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -80,18 +80,26 @@ The following instructions apply to Azure Storage which provides the sample data
8080
}
8181
```
8282

83-
### Copy a search service URL and API key
83+
## Prepare models
8484

85-
For this tutorial, your local REST client connection to Azure AI Search requires an endpoint and an API key. You can get these values from the Azure portal. For alternative connection methods, see [Connect to a search service](search-get-started-rbac.md).
85+
This tutorial assumes you have an existing Azure AI multiservice account through which the skill calls the Azure AI Vision multimodal 4.0 embedding model. The search service connects to the model during skillset processing using its managed identity. This section gives you guidance and links for assigning roles for authorized access.
8686

87-
1. Sign in to the [Azure portal](https://portal.azure.com), navigate to the search service **Overview** page, and copy the URL. An example endpoint might look like `https://mydemo.search.windows.net`.
87+
1. Sign in to the Azure portal (not the Foundry portal) and find the Azure AI multiservice account. Make sure it's in a region that provides the [multimodal 4.0 API](/azure/ai-services/computer-vision/overview-image-analysis#region-availability).
8888

89-
1. Under **Settings** > **Keys**, copy an admin key. Admin keys are used to add, modify, and delete objects. There are two interchangeable admin keys. Copy either one.
89+
1. Select **Access control (IAM)**.
9090

91-
:::image type="content" source="media/search-get-started-rest/get-url-key.png" alt-text="Screenshot of the URL and API keys in the Azure portal.":::
91+
1. Select **Add** and then **Add role assignment**.
92+
93+
1. Search for **Cognitive Services User** and then select it.
94+
95+
1. Choose **Managed identity** and then assign your [search service managed identity](search-howto-managed-identities-data-sources.md).
9296

9397
## Set up your REST file
9498

99+
For this tutorial, your local REST client connection to Azure AI Search requires an endpoint and an API key. You can get these values from the Azure portal. For alternative connection methods, see [Connect to a search service](search-get-started-rbac.md).
100+
101+
For other authenticated connections, the search service uses the role assignments you previously defined.
102+
95103
1. Start Visual Studio Code and create a new file.
96104

97105
1. Provide values for variables used in the request.
@@ -106,9 +114,15 @@ For this tutorial, your local REST client connection to Azure AI Search requires
106114
@imageProjectionContainer=PUT-YOUR-IMAGE-PROJECTION-CONTAINER-HERE (Azure AI Search creates this container for you during skills processing)
107115
```
108116

109-
1. Save the file using a `.rest` or `.http` file extension.
117+
1. Save the file using a `.rest` or `.http` file extension. For help with the REST client, see [Quickstart: Full-text search using REST](search-get-started-text.md).
118+
119+
To get the Azure AI Search endpoint and API key:
120+
121+
1. Sign in to the [Azure portal](https://portal.azure.com), navigate to the search service **Overview** page, and copy the URL. An example endpoint might look like `https://mydemo.search.windows.net`.
110122

111-
For help with the REST client, see [Quickstart: Full-text search using REST](search-get-started-text.md).
123+
1. Under **Settings** > **Keys**, copy an admin key. Admin keys are used to add, modify, and delete objects. There are two interchangeable admin keys. Copy either one.
124+
125+
:::image type="content" source="media/search-get-started-rest/get-url-key.png" alt-text="Screenshot of the URL and API keys in the Azure portal.":::
112126

113127
## Create a data source
114128

0 commit comments

Comments
 (0)