Skip to content

Commit 4765635

Browse files
committed
Incorporated feedback
1 parent 9a58e55 commit 4765635

File tree

1 file changed

+18
-14
lines changed

1 file changed

+18
-14
lines changed

articles/search/cognitive-search-skill-genai-prompt.md

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -17,35 +17,37 @@ ms.date: 05/27/2025
1717

1818
The **GenAI (Generative AI) Prompt** skill executes a *chat completion* request against a Large Language Model (LLM) deployed in Azure AI Foundry or Azure OpenAI in Azure AI Foundry Models.
1919

20-
Use this capability to create new information that can be indexed and stored as searchable content. Examples include verbalize images, summarize larger passages, simplify complex content, or any other task that an LLM can perform. You can target text-only content, images, or multimodal (text and images) content. It's common to use this skill combined with a data chunking skill. The following tutorials demonstrate the image verbalization scenarios with two different data chunking techniques:
20+
Use this capability to create new information that can be indexed and stored as searchable content. Examples include verbalize images, summarize larger passages, simplify complex content, or any other task that an LLM can perform. The skill supports text, image, and multimodal content such as a PDF that contains text and images. It's common to use this skill combined with a data chunking skill. The following tutorials demonstrate the image verbalization scenarios with two different data chunking techniques:
2121

22-
+ [Tutorial: Index mixed content using image verbalizations and the Document Layout skill](tutorial-multimodal-index-image-verbalization-skill.md)
22+
- [Tutorial: Index mixed content using image verbalizations and the Document Layout skill](tutorial-multimodal-index-image-verbalization-skill.md)
2323

24-
+ [Tutorial: Index mixed content using image verbalizations and the Document Extraction skill](tutorial-multimodal-indexing-with-image-verbalization-and-doc-extraction.md)
24+
- [Tutorial: Index mixed content using image verbalizations and the Document Extraction skill](tutorial-multimodal-indexing-with-image-verbalization-and-doc-extraction.md)
2525

2626
The GenAI Prompt skill is available in the [2025-05-01-preview REST API](/rest/api/searchservice/skillsets/create?view=rest-searchservice-2025-05-01-preview&preserve-view=true) only.
2727

28-
<!-- ## Region Availability
28+
## Supported models
2929

30-
- Your Azure AI Search service must be deployed in a [supported region](search-region-support.md).
30+
You can use any [chat completion inference model](/azure/ai-foundry/model-inference/concepts/models) deployed in AI Foundry, such as GPT models, Deepseek R#, Llama-4-Mavericj, Cohere-command-r, and so forth.
3131

32-
- The availability of the GenAI Prompt skill depends on the region availability of the chat completions model you choose. If you're using [Azure OpenAI](/azure/ai-services/openai/overview), refer to the [Azure OpenAI region availability](/azure/ai-services/openai/concepts/models) to check which regions support the specific model you selected. For other AI Foundry chat completions models, consult the region availability documentation provided for the respective model to ensure compatibility. -->
32+
Billing is based on the pricing of the model you use.
3333

3434
> [!NOTE]
35-
> The search service connects to your model over a public endpoint, so there are no region location requirements, but you should check the [Azure AI Search regions](search-region-support.md) and the [Azure OpenAI model regions](/azure/ai-services/openai/concepts/models) to find suitable pairs, especially if you have data residency requirements.
35+
> The search service connects to your model over a public endpoint, so there are no region location requirements, but if you're using an all-up Azure solution, you should check the [Azure AI Search regions](search-region-support.md) and the [Azure OpenAI model regions](/azure/ai-services/openai/concepts/models) to find suitable pairs, especially if you have data residency requirements.
3636
>
37-
> This skill is bound to your Azure OpenAI model and is charged at the existing [Azure OpenAI Standard price](https://azure.microsoft.com/pricing/details/cognitive-services/openai-service/#pricing).
38-
3937
4038
## Prerequisites
4139

42-
- A deployed chat-completion model (for example *gpt-4o* or any compatible Open Source Software (OSS) model) in Azure AI Foundry or Azure OpenAI.
40+
- A deployed chat completion model (for example *gpt-4o* or any compatible Open Source Software (OSS) model) in Azure AI Foundry or Azure OpenAI.
4341

4442
- Copy the endpoint from **Models + Endpoints** in the Foundry portal or from the Azure OpenAI resource subdomain (`*.openai.azure.com`).
4543

4644
- Provide this endpoint in the `Uri` parameter of your skill definition.
4745

48-
- Authentication can be key-based with an API key from your Azure AI Foundry or Azure OpenAI resource. However, we recommend role-based access using a [search service managed identity](search-howto-managed-identities-data-sources.md) assigned to [**Cognitive Services OpenAI User**](/azure/ai-services/openai/how-to/role-based-access-control) on Azure OpenAI.
46+
- Authentication can be key-based with an API key from your Azure AI Foundry or Azure OpenAI resource. However, we recommend role-based access using a [search service managed identity](search-howto-managed-identities-data-sources.md) assigned to a role.
47+
48+
- On Azure OpenAI, assign [**Cognitive Services OpenAI User**](/azure/ai-services/openai/how-to/role-based-access-control) to the managed identity.
49+
50+
- For AI Foundry models, assign [**Azure AI User**](/azure/ai-foundry/concepts/rbac-azure-ai-foundry#azure-ai-user).
4951

5052
## @odata.type
5153

@@ -126,6 +128,7 @@ The GenAI Prompt skill is available in the [2025-05-01-preview REST API](/rest/a
126128
```
127129

128130
### Text + image description
131+
129132
```json
130133
{
131134
"@odata.type": "#Microsoft.Skills.Custom.ChatCompletionSkill",
@@ -145,6 +148,7 @@ The GenAI Prompt skill is available in the [2025-05-01-preview REST API](/rest/a
145148
```
146149

147150
### Structured numerical fact-finder
151+
148152
```json
149153
{
150154
"@odata.type": "#Microsoft.Skills.Custom.ChatCompletionSkill",
@@ -187,6 +191,7 @@ The GenAI Prompt skill is available in the [2025-05-01-preview REST API](/rest/a
187191
```
188192

189193
### Sample output (truncated)
194+
190195
```json
191196
{
192197
"response": {
@@ -204,6 +209,7 @@ The GenAI Prompt skill is available in the [2025-05-01-preview REST API](/rest/a
204209
}
205210
}
206211
```
212+
207213
### Best practices
208214

209215
- Chunk long documents with the **Text Split** skill to stay within the model’s context window.
@@ -212,8 +218,6 @@ The GenAI Prompt skill is available in the [2025-05-01-preview REST API](/rest/a
212218
- Use `responseFormat.json_schema` with **GPT-4o** for reliable structured extraction and easier mapping to index fields.
213219
- Monitor token usage and submit **quota-increase requests** if the indexer saturates your Tokens per Minute (TPM) limits.
214220

215-
---
216-
217221
### Errors and warnings
218222

219223
| Condition | Result |
@@ -225,9 +229,9 @@ The GenAI Prompt skill is available in the [2025-05-01-preview REST API](/rest/a
225229
| Input exceeds model token limit | **Error** |
226230
| Model returns invalid JSON for `json_schema` | **Warning** – raw string returned in `response` |
227231

228-
---
229232

230233
### See also
234+
231235
- [Azure AI Search built-in indexers](search-indexer-overview.md)
232236
- [Integrated vectorization](vector-search-integrated-vectorization.md)
233237
- [How to define a skillset](cognitive-search-defining-skillset.md)

0 commit comments

Comments
 (0)