Skip to content

Commit a24a839

Browse files
update per comments
1 parent 142d7a9 commit a24a839

File tree

6 files changed

+17
-16
lines changed

6 files changed

+17
-16
lines changed

articles/communication-services/quickstarts/router/job-router-azure-open-ai-integration.md renamed to articles/communication-services/quickstarts/router/job-router-azure-openai-integration.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Quickstart - Integrating Azure OpenAI with Job Router
2+
title: Quickstart - Integrate Azure OpenAI with Job Router
33
titleSuffix: An Azure Communication Services quickstart
44
description: In this quickstart, you learn how to integrate Azure OpenAI with ACS Job Router using an Azure Function App to match workers to jobs based on worker's performance.
55
author: nabennet
@@ -13,7 +13,7 @@ ms.service: azure-communication-services
1313

1414
# Quick Start: Integrating Azure OpenAI with ACS Job Router
1515

16-
Integrate ACS Job Router with Azure Open AI. Use Azure Open AI to pair your jobs to agents.
16+
Integrate ACS Job Router with Azure OpenAI. Use Azure OpenAI to pair your jobs to agents.
1717

1818
### Prerequisites
1919
- Create an Azure OpenAI resource. [Setup Guide](../../../ai-services/openai/how-to/create-resource.md)
@@ -24,7 +24,7 @@ Integrate ACS Job Router with Azure Open AI. Use Azure Open AI to pair your jobs
2424

2525
### Overview
2626

27-
This quick start demonstrates how to integrate Azure Open AI with ACS Job Router to intelligently choose the best-suited worker based on performance indicators for an incoming job.
27+
This quick start demonstrates how to integrate Azure OpenAI with ACS Job Router to intelligently choose the best-suited worker based on performance indicators for an incoming job.
2828

2929
### Console application
3030
- Manages ACS resources including policies and queues.
@@ -44,15 +44,16 @@ This quick start demonstrates how to integrate Azure Open AI with ACS Job Router
4444
- Five workers that are registered to a queue with three chosen performance indicator values populated as labels.
4545
- Creates a Job in ACS Job Router and lets the user know which worker Azure OpenAI scored the highest based on the performance indicator labels.
4646

47-
:::image type="content" source="./media/overview-sequence-diagram.png" alt-text="Screenshot of Job Router with Azure Open AI integration SequenceDiagram.":::
47+
:::image type="content" source="./media/overview-sequence-diagram.png" alt-text="Screenshot of Job Router with Azure OpenAI integration SequenceDiagram."
48+
lightbox="./media/overview-sequence-diagram-expanded.png":::
4849

49-
#### The Azure Function project is set up to interact with a deployed Azure OpenAI model.
50+
#### The Azure Function project is set up to interact with a deployed Azure OpenAI model:
5051
- The Azure function receives a request from ACS Job Router with a payload containing the worker's labels (performance indicators).
5152
- The Azure function extracts those values from the request.
52-
- The Azure function was preconfigured with a prompt to explain to the Azure Open AI model how to interpret each one of these performance indicators and to ask Azure OpenAI to score each worker based on these values to find the most suitable agent for a new job.
53+
- The Azure function was preconfigured with a prompt to explain to the Azure OpenAI model how to interpret each one of these performance indicators and to ask Azure OpenAI to score each worker based on these values to find the most suitable agent for a new job.
5354
> [!NOTE]
5455
> The prompt can be updated for any desired outcome. For example, you could modify the prompt to weigh the Average Handling Time as the most important data point or ask the model to optimize for customer satisfaction.
55-
- The Azure Function sends a request with the configured prompts and worker performance indicators, and Azure OpenAI responds back with a JSON Object containing the scores generated by Azure Open AI.
56+
- The Azure Function sends a request with the configured prompts and worker performance indicators, and Azure OpenAI responds back with a JSON Object containing the scores generated by Azure OpenAI.
5657
- The Azure Function then sends these scores back to ACS Job Router.
5758
- ACS Job Router then sends an offer to the worker that was scored the highest by Azure OpenAI.
5859

@@ -72,17 +73,17 @@ Workers are evaluated based on:
7273
- Learn about Azure Function Deployments. [Azure Function Deployments](../../../azure-functions/functions-deployment-technologies.md)
7374

7475
## Understanding Azure OpenAI prompts
75-
- Learn about Azure Open AI prompt Engineering Techniques. [Prompt Engineering Techniques](../../../ai-services/openai/concepts/advanced-prompt-engineering.md)
76+
- Learn about Azure OpenAI prompt Engineering Techniques. [Prompt Engineering Techniques](../../../ai-services/openai/concepts/advanced-prompt-engineering.md)
7677

7778
## Deployment and execution
7879

7980
1. Open the OpenAiScoringFunction project in Visual Studio Code with the Azure Function Extension installed. Select 'Create Function App in Azure...'
8081

81-
:::image type="content" source="./media/create-azure-function-from-code.png" alt-text="Screenshot of CreateFunctionApp in VS Code.":::
82+
:::image type="content" source="./media/create-azure-function-from-code.png" alt-text="Screenshot of CreateFunctionApp in VS Code.":::
8283

8384
2. After selecting your Subscription, enter a unique name for your function app.
8485

85-
:::image type="content" source="./media/function-select-subscription.png" alt-text="Screenshot of selecting subscription in VS Code.":::
86+
:::image type="content" source="./media/function-select-subscription.png" alt-text="Screenshot of selecting subscription in VS Code.":::
8687

8788
3. Once your Function App is created, right-click on your App and select 'Deploy Function App...'
8889
4. Open the Azure portal and go to your Azure OpenAI resource, then go to Azure AI Studio. From here, navigate to the Deployments tab and select "+ Create new deployment"
@@ -91,15 +92,15 @@ Workers are evaluated based on:
9192
[Azure OpenAI Service models](../../../ai-services/openai/concepts/models.md)
9293
- b. Give your model a Deployment name and select “Create”
9394

94-
:::image type="content" source="./media/azure-open-ai-model-creation.png" alt-text="Screenshot of creating azure open ai model.":::
95+
:::image type="content" source="./media/azure-openai-model-creation.png" alt-text="Screenshot of creating azure OpenAI model.":::
9596

9697
5. Once your Azure OpenAI Model is created, copy down the 'Endpoint', 'Keys', and 'Region'
9798

98-
:::image type="content" source="./media/azure-open-ai-keys-and-endpoints.png" alt-text="Screenshot of of key and endpoint page for Azure Open AU.":::
99+
:::image type="content" source="./media/azure-openai-keys-and-endpoints.png" alt-text="Screenshot of key and endpoint page for Azure OpenAI.":::
99100

100101
6. In the Azure portal, navigate to your newly created Function App Environmental Variables blade and create the following variables:
101102

102-
:::image type="content" source="./media/azure-function-enviornment-settings.png" alt-text="Screenshot of of Azure function enviornment settings example.":::
103+
:::image type="content" source="./media/azure-function-environment-settings.png" alt-text="Screenshot of Azure function environment settings example.":::
103104

104105
| Name | Value | Description |
105106
|-----------------|------------------|--------------------------------------------------------------------|
@@ -117,7 +118,7 @@ Workers are evaluated based on:
117118
8. Navigate to your ACS resource and copy down your connection string.
118119
9. Open the JR_AOAI_Integration Console application and open the `appsettings.json` file to update the following config settings.
119120

120-
:::image type="content" source="./media/appsettings-configuration.png" alt-text="Screenshot of AppSettings.":::
121+
:::image type="content" source="./media/appsettings-configuration.png" alt-text="Screenshot of AppSettings.":::
121122

122123
10. Run the application and follow the on-screen instructions to Create a Job.
123124

260 KB
Loading

articles/communication-services/toc.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -199,8 +199,8 @@ items:
199199
items:
200200
- name: Submit a job for queuing and routing
201201
href: quickstarts/router/get-started-router.md
202-
- name: Integrating Azure OpenAI with Job Router
203-
href: quickstarts/router/job-router-azure-open-ai-integration.md
202+
- name: Integrate Azure OpenAI with Job Router
203+
href: quickstarts/router/job-router-azure-openai-integration.md
204204
- name: Network Traversal
205205
items:
206206
- name: Access TURN relays

0 commit comments

Comments
 (0)