Skip to content

Commit 350ce12

Browse files
wchigitwchigit
committed
fix naming and wording
1 parent e173314 commit 350ce12

23 files changed

+129
-129
lines changed

‎articles/service-connector/how-to-integrate-cognitive-services.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
---
2-
title: Integrate Azure Multi-service Cognitive Services with Service Connector
3-
description: In this document, learn how to integrate Azure Multi-service Cognitive Services into your application with Service Connector
2+
title: Integrate a multi-service resource for Azure AI services with Service Connector
3+
description: In this document, learn how to integrate a multi-service resource for Azure AI services into your application with Service Connector
44
author: wchigit
55
ms.author: wchi
66
ms.service: service-connector
77
ms.topic: how-to
88
ms.date: 06/14/2024
99
---
1010

11-
# Integrate Azure Multi-service Cognitive Services with Service Connector
11+
# Integrate a multi-service resource for Azure AI services with Service Connector
1212

13-
This page shows supported authentication methods and clients, and shows sample code you can use to connect Azure Multi-service Cognitive Services to other cloud services using Service Connector. You might still be able to connect to Azure Multi-service Cognitive Services using other methods. This page also shows default environment variable names and values you get when you create the service connection.
13+
This page shows supported authentication methods and clients, and shows sample code you can use to connect a multi-service resource for Azure AI services to other cloud services using Service Connector. You might still be able to connect to a multi-service resource for Azure AI services using other methods. This page also shows default environment variable names and values you get when you create the service connection.
1414

1515
## Supported compute services
1616

17-
Service Connector can be used to connect the following compute services to Azure Multi-service Cognitive Services:
17+
Service Connector can be used to connect the following compute services to a multi-service resource for Azure AI services:
1818

1919
- Azure App Service
2020
- Azure Functions
@@ -23,7 +23,7 @@ Service Connector can be used to connect the following compute services to Azure
2323

2424
## Supported authentication types and client types
2525

26-
The table below shows which combinations of authentication methods and clients are supported for connecting your compute service to Azure Multi-service Cognitive Services using Service Connector. A “Yes” indicates that the combination is supported, while a “No” indicates that it is not supported.
26+
The table below shows which combinations of authentication methods and clients are supported for connecting your compute service to a multi-service resource for Azure AI services using Service Connector. A “Yes” indicates that the combination is supported, while a “No” indicates that it is not supported.
2727

2828

2929
| Client type | System-assigned managed identity | User-assigned managed identity | Secret/connection string | Service principal |
@@ -34,11 +34,11 @@ The table below shows which combinations of authentication methods and clients a
3434
| Python | Yes | Yes | Yes | Yes |
3535
| None | Yes | Yes | Yes | Yes |
3636

37-
This table indicates that all combinations of client types and authentication methods in the table are supported. All client types can use any of the authentication methods to connect to Azure Multi-service Cognitive Services using Service Connector.
37+
This table indicates that all combinations of client types and authentication methods in the table are supported. All client types can use any of the authentication methods to connect to a multi-service resource for Azure AI services using Service Connector.
3838

3939
## Default environment variable names or application properties and sample code
4040

41-
Use the connection details below to connect compute services to Azure Multi-service Cognitive Services. For more information about naming conventions, check the [Service Connector internals](concept-service-connector-internals.md#configuration-naming-convention) article.
41+
Use the connection details below to connect compute services to a multi-service resource for Azure AI services. For more information about naming conventions, check the [Service Connector internals](concept-service-connector-internals.md#configuration-naming-convention) article.
4242

4343
### System-assigned managed identity
4444

@@ -47,8 +47,8 @@ Use the connection details below to connect compute services to Azure Multi-serv
4747
| AZURE_COGNITIVESERVICES_ENDPOINT | Azure Cognitive Services token provider service | `https://<cognitive-service-name>.cognitiveservices.azure.com/` |
4848

4949
#### Sample code
50-
Refer to the steps and code below to connect to Azure Multi-service Cognitive Services using a system-assigned managed identity.
51-
[!INCLUDE [code sample for app config](./includes/code-cognitive-me-id.md)]
50+
Refer to the steps and code below to connect to a multi-service resource for Azure AI services using a system-assigned managed identity.
51+
[!INCLUDE [code sample for a multi-service resource for Azure AI services](./includes/code-cognitive-me-id.md)]
5252

5353
### User-assigned managed identity
5454

@@ -58,20 +58,20 @@ Refer to the steps and code below to connect to Azure Multi-service Cognitive Se
5858
| AZURE_COGNITIVESERVICES_CLIENTID | Your client ID | `<client-ID>` |
5959

6060
#### Sample code
61-
Refer to the steps and code below to connect to Azure Multi-service Cognitive Services using a user-assigned managed identity.
62-
[!INCLUDE [code sample for Azure Multi-service Cognitive Services](./includes/code-cognitive-me-id.md)]
61+
Refer to the steps and code below to connect to a multi-service resource for Azure AI services using a user-assigned managed identity.
62+
[!INCLUDE [code sample for a multi-service resource for Azure AI services](./includes/code-cognitive-me-id.md)]
6363

6464
### Connection string
6565

6666
> [!div class="mx-tdBreakAll"]
6767
> | Default environment variable name | Description | Sample value |
6868
> | --------------------------------- | ------------| ------------ |
69-
> | AZURE_COGNITIVESERVICES_ENDPOINT | Azure Cognitive Services token provider service | `https://<cognitive-service-name>.cognitiveservices.azure.com/` |
70-
> | AZURE_COGNITIVESERVICES_KEY | Azure Multi-service Cognitive Services API key | `<api-key>` |
69+
> | AZURE_COGNITIVESERVICES_ENDPOINT | endpoint of a multi-service resource for Azure AI services | `https://<cognitive-service-name>.cognitiveservices.azure.com/` |
70+
> | AZURE_COGNITIVESERVICES_KEY | API key of a multi-service resource for Azure AI services | `<api-key>` |
7171
7272
#### Sample Code
73-
Refer to the steps and code below to connect to Azure Multi-service Cognitive Services using a connection string.
74-
[!INCLUDE [code sample for Azure Multi-service Cognitive Services](./includes/code-cognitive-secret.md)]
73+
Refer to the steps and code below to connect to a multi-service resource for Azure AI services using a connection string.
74+
[!INCLUDE [code sample for a multi-service resource for Azure AI services](./includes/code-cognitive-secret.md)]
7575

7676

7777
### Service principal
@@ -84,8 +84,8 @@ Refer to the steps and code below to connect to Azure Multi-service Cognitive Se
8484
| AZURE_COGNITIVESERVICES_TENANTID | Your tenant ID | `<tenant-ID>` |
8585

8686
#### Sample code
87-
Refer to the steps and code below to connect to Azure Multi-service Cognitive Services using a service principaL.
88-
[!INCLUDE [code sample for Azure Multi-service Cognitive Services](./includes/code-cognitive-me-id.md)]
87+
Refer to the steps and code below to connect to a multi-service resource for Azure AI services using a service principaL.
88+
[!INCLUDE [code sample for a multi-service resource for Azure AI services](./includes/code-cognitive-me-id.md)]
8989

9090
## Next steps
9191

‎articles/service-connector/how-to-integrate-openai.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
---
2-
title: Integrate Azure OpenAI with Service Connector
3-
description: In this document, learn how to integrate Azure OpenAI into your application with Service Connector
2+
title: Integrate Azure OpenAI Service with Service Connector
3+
description: In this document, learn how to integrate Azure OpenAI Service into your application with Service Connector
44
author: wchigit
55
ms.author: wchi
66
ms.service: service-connector
77
ms.topic: how-to
88
ms.date: 06/14/2024
99
---
1010

11-
# Integrate Azure OpenAI with Service Connector
11+
# Integrate Azure OpenAI Service with Service Connector
1212

13-
This page shows supported authentication methods and clients, and shows sample code you can use to connect Azure OpenAI to other cloud services using Service Connector. You might still be able to connect to Azure OpenAI using other methods. This page also shows default environment variable names and values you get when you create the service connection.
13+
This page shows supported authentication methods and clients, and shows sample code you can use to connect Azure OpenAI Service to other cloud services using Service Connector. You might still be able to connect to Azure OpenAI Service using other methods. This page also shows default environment variable names and values you get when you create the service connection.
1414

1515
## Supported compute services
1616

17-
Service Connector can be used to connect the following compute services to Azure OpenAI:
17+
Service Connector can be used to connect the following compute services to Azure OpenAI Service:
1818

1919
- Azure App Service
2020
- Azure Functions
@@ -23,7 +23,7 @@ Service Connector can be used to connect the following compute services to Azure
2323

2424
## Supported authentication types and client types
2525

26-
The table below shows which combinations of authentication methods and clients are supported for connecting your compute service to Azure OpenAI using Service Connector. A “Yes” indicates that the combination is supported, while a “No” indicates that it is not supported.
26+
The table below shows which combinations of authentication methods and clients are supported for connecting your compute service to Azure OpenAI Service using Service Connector. A “Yes” indicates that the combination is supported, while a “No” indicates that it is not supported.
2727

2828

2929
| Client type | System-assigned managed identity | User-assigned managed identity | Secret/connection string | Service principal |
@@ -34,58 +34,58 @@ The table below shows which combinations of authentication methods and clients a
3434
| Python | Yes | Yes | Yes | Yes |
3535
| None | Yes | Yes | Yes | Yes |
3636

37-
This table indicates that all combinations of client types and authentication methods in the table are supported. All client types can use any of the authentication methods to connect to Azure OpenAI using Service Connector.
37+
This table indicates that all combinations of client types and authentication methods in the table are supported. All client types can use any of the authentication methods to connect to Azure OpenAI Service using Service Connector.
3838

3939
## Default environment variable names or application properties and sample code
4040

41-
Use the connection details below to connect compute services to Azure OpenAI. For more information about naming conventions, check the [Service Connector internals](concept-service-connector-internals.md#configuration-naming-convention) article.
41+
Use the connection details below to connect compute services to Azure OpenAI Service. For more information about naming conventions, check the [Service Connector internals](concept-service-connector-internals.md#configuration-naming-convention) article.
4242

4343
### System-assigned managed identity
4444

4545
| Default environment variable name | Description | Sample value |
4646
| --------------------------------- | ---------------------------- | ------------------------------------------------ |
47-
| AZURE_OPENAI_BASE | Azure OpenAI endpoint | `https://<Azure-OpenAI-name>.openai.azure.com/` |
47+
| AZURE_OPENAI_BASE | Azure OpenAI Service endpoint | `https://<Azure-OpenAI-name>.openai.azure.com/` |
4848

4949
#### Sample code
50-
Refer to the steps and code below to connect to Azure OpenAI using a system-assigned managed identity.
50+
Refer to the steps and code below to connect to Azure OpenAI Service using a system-assigned managed identity.
5151
[!INCLUDE [code sample for app config](./includes/code-openai-me-id.md)]
5252

5353
### User-assigned managed identity
5454

5555
| Default environment variable name | Description | Sample value |
5656
| --------------------------------- | -------------------------- | ----------------------------------------------- |
57-
| AZURE_OPENAI_BASE | Azure OpenAI Endpoint | `https://<Azure-OpenAI-name>.openai.azure.com/` |
57+
| AZURE_OPENAI_BASE | Azure OpenAI Service Endpoint | `https://<Azure-OpenAI-name>.openai.azure.com/` |
5858
| AZURE_OPENAI_CLIENTID | Your client ID | `<client-ID>` |
5959

6060
#### Sample code
61-
Refer to the steps and code below to connect to Azure OpenAI using a user-assigned managed identity.
62-
[!INCLUDE [code sample for azure openai](./includes/code-openai-me-id.md)]
61+
Refer to the steps and code below to connect to Azure OpenAI Service using a user-assigned managed identity.
62+
[!INCLUDE [code sample for azure openai service](./includes/code-openai-me-id.md)]
6363

6464
### Connection string
6565

6666
> [!div class="mx-tdBreakAll"]
6767
> | Default environment variable name | Description | Sample value |
6868
> | --------------------------------- | ------------| ------------ |
69-
> | AZURE_OPENAI_BASE | Azure OpenAI Endpoint | `https://<Azure-OpenAI-name>.openai.azure.com/` |
70-
> | AZURE_OPENAI_KEY | Azure OpenAI API key | `<api-key>` |
69+
> | AZURE_OPENAI_BASE | Azure OpenAI Service Endpoint | `https://<Azure-OpenAI-name>.openai.azure.com/` |
70+
> | AZURE_OPENAI_KEY | Azure OpenAI Service API key | `<api-key>` |
7171
7272
#### Sample Code
73-
Refer to the steps and code below to connect to Azure OpenAI using a connection string.
74-
[!INCLUDE [code sample for azure openai](./includes/code-openai-secret.md)]
73+
Refer to the steps and code below to connect to Azure OpenAI Service using a connection string.
74+
[!INCLUDE [code sample for azure openai service](./includes/code-openai-secret.md)]
7575

7676

7777
### Service principal
7878

7979
| Default environment variable name | Description | Sample value |
8080
| ----------------------------------- | -------------------------- | ---------------------------------------------- |
81-
| AZURE_OPENAI_BASE | Azure OpenAI Endpoint | `https://<Azure-OpenAI-name>.openai.azure.com/` |
81+
| AZURE_OPENAI_BASE | Azure OpenAI Service Endpoint | `https://<Azure-OpenAI-name>.openai.azure.com/` |
8282
| AZURE_OPENAI_CLIENTID | Your client ID | `<client-ID>` |
8383
| AZURE_OPENAI_CLIENTSECRET | Your client secret | `<client-secret>` |
8484
| AZURE_OPENAI_TENANTID | Your tenant ID | `<tenant-ID>` |
8585

8686
#### Sample code
87-
Refer to the steps and code below to connect to Azure OpenAI using a service principaL.
88-
[!INCLUDE [code sample for azure openai](./includes/code-openai-me-id.md)]
87+
Refer to the steps and code below to connect to Azure OpenAI Service using a service principaL.
88+
[!INCLUDE [code sample for azure openai service](./includes/code-openai-me-id.md)]
8989

9090
## Next steps
9191

‎articles/service-connector/includes/code-aiservices-me-id.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ ms.date: 10/20/2023
66
ms.author: wchi
77
---
88

9-
You can use the Azure client library to access various cognitive APIs that Azure AI Services support. We use the language service as an example in this sample. Refer to [Authenticate requests to Azure AI services](/azure/ai-services/authentication#authenticate-with-azure-active-directory) to call the cognitive APIs directly.
9+
You can use the Azure client library to access various cognitive APIs that Azure AI Services support. We use Azure AI Text Analytics as an example in this sample. Refer to [Authenticate requests to Azure AI services](/azure/ai-services/authentication#authenticate-with-azure-active-directory) to call the cognitive APIs directly.
1010

1111
### [.NET](#tab/dotnet)
1212

@@ -15,15 +15,15 @@ You can use the Azure client library to access various cognitive APIs that Azure
1515
dotnet add package Azure.AI.TextAnalytics
1616
dotnet add package Azure.Identity
1717
```
18-
1. Authenticate using Azure Identity library and get the Azure AI Services endpoint from the environment variables added by Service Connector. When using the code below, uncomment the part of the code snippet for the authentication type you want to use.
18+
1. Authenticate using the Azure Identity library and get the Azure AI Services endpoint from the environment variables added by Service Connector. When using the code below, uncomment the part of the code snippet for the authentication type you want to use.
1919

2020
```csharp
2121
using Azure.AI.TextAnalytics;
2222
using Azure.Identity;
2323
2424
string endpoint = Environment.GetEnvironmentVariable("AZURE_AISERVICES_COGNITIVESERVICES_ENDPOINT");
2525
26-
// Uncomment the following lines according to the authentication type.
26+
// Uncomment the following lines corresponding to the authentication type you want to use.
2727
// system-assigned managed identity
2828
// var credential = new DefaultAzureCredential();
2929
@@ -63,7 +63,7 @@ You can use the Azure client library to access various cognitive APIs that Azure
6363
1. Authenticate using `azure-identity` and get the Azure AI Services endpoint from the environment variables added by Service Connector. When using the code below, uncomment the part of the code snippet for the authentication type you want to use.
6464
6565
```java
66-
// Uncomment the following lines according to the authentication type.
66+
// Uncomment the following lines corresponding to the authentication type you want to use.
6767
// for system-managed identity
6868
// DefaultAzureCredential credential = new DefaultAzureCredentialBuilder().build();
6969
@@ -100,7 +100,7 @@ You can use the Azure client library to access various cognitive APIs that Azure
100100
from azure.ai.textanalytics import TextAnalyticsClient
101101
from azure.identity import ManagedIdentityCredential, ClientSecretCredential
102102
103-
# Uncomment the following lines according to the authentication type.
103+
# Uncomment the following lines corresponding to the authentication type you want to use.
104104
# system-assigned managed identity
105105
# cred = ManagedIdentityCredential()
106106
@@ -133,7 +133,7 @@ You can use the Azure client library to access various cognitive APIs that Azure
133133
import { DefaultAzureCredential,ClientSecretCredential } from "@azure/identity";
134134
const { TextAnalyticsClient } = require("@azure/ai-text-analytics");
135135
136-
// Uncomment the following lines according to the authentication type.
136+
// Uncomment the following lines corresponding to the authentication type you want to use.
137137
// for system-assigned managed identity
138138
// const credential = new DefaultAzureCredential();
139139

‎articles/service-connector/includes/code-aiservices-secret.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ ms.date: 06/19/2024
66
ms.author: wchi
77
---
88

9-
You can use the Azure client library to access various cognitive APIs that Azure AI Services support. We use the language service as an example in this sample. Refer to [Authenticate requests to Azure AI services](/azure/ai-services/authentication#authenticate-with-a-multi-service-resource-key) to call the cognitive APIs directly.
9+
You can use the Azure client library to access various cognitive APIs that Azure AI Services support. We use Azure AI Text Analytics as an example in this sample. Refer to [Authenticate requests to Azure AI services](/azure/ai-services/authentication#authenticate-with-a-multi-service-resource-key) to call the cognitive APIs directly.
1010

1111
### [.NET](#tab/dotnet)
1212

0 commit comments

Comments
 (0)