Skip to content

Commit 09ba51c

Browse files
Merge pull request #2046 from soophiac/sophiac/update-aiservicesbykey
Update documentation with AIServicesByKey
2 parents a866aaa + 89c3413 commit 09ba51c

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

articles/search/cognitive-search-attach-cognitive-services.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,9 @@ POST https://[service-name].search.windows.net/skillsets/[skillset-name]?api-ver
110110

111111
Azure AI Search can also charge for transaction using the Azure AI multi-service resource key. This approach is the default and is generally available. You can use the Azure portal, REST API, or an Azure SDK to add the key to a skillset.
112112

113-
You only need to add the key, not the subdomain or endpoint. If you leave the `cognitiveServices` property unspecified, your search service attempts to use the free enrichments available to your indexer on a daily basis. Execution of billable skills stops at 20 transactions per indexer invocation and a "Time Out" message appears in indexer execution history.
113+
There are two supported key types: `#Microsoft.Azure.Search.CognitiveServicesByKey` which calls the regional endpoint and `"#Microsoft.Azure.Search.AIServicesByKey` which calls the subdomain. We recommend using `AIServicesByKey` for its shared private link support and ability to function with no regional requirements relative to the search service.
114+
115+
If you leave the `cognitiveServices` property unspecified, your search service attempts to use the free enrichments available to your indexer on a daily basis. Execution of billable skills stops at 20 transactions per indexer invocation and a "Time Out" message appears in indexer execution history.
114116

115117
### [**Azure portal**](#tab/portal)
116118

@@ -128,12 +130,15 @@ You only need to add the key, not the subdomain or endpoint. If you leave the `c
128130

129131
:::image type="content" source="media/cognitive-search-attach-cognitive-services/attach-existing2.png" alt-text="Screenshot of the key page." border="true":::
130132

133+
> [!NOTE]
134+
> Azure portal currently automatically attaches key of type `#Microsoft.Azure.Search.CognitiveServicesByKey`.
135+
131136
### [**REST**](#tab/cogkey-rest)
132137

133138
1. Use the [Create or Update Skillset](/rest/api/searchservice/skillsets/create-or-update) API, specifying `cognitiveServices` section in the body of the request:
134139

135140
```http
136-
PUT https://[servicename].search.windows.net/skillsets/[skillset name]?api-version=2024-07-01
141+
PUT https://[servicename].search.windows.net/skillsets/[skillset name]?api-version=2024-11-01-Preview
137142
api-key: [admin key]
138143
Content-Type: application/json
139144
{
@@ -157,8 +162,9 @@ Content-Type: application/json
157162
}
158163
],
159164
"cognitiveServices": {
160-
"@odata.type": "#Microsoft.Azure.Search.CognitiveServicesByKey",
165+
"@odata.type": "#Microsoft.Azure.Search.AIServicesByKey",
161166
"description": "mycogsvcs",
167+
"subdomainUrl": “https://[subdomain-name].cognitiveservices.azure.com",
162168
"key": "<your key goes here>"
163169
}
164170
}

0 commit comments

Comments
 (0)