Skip to content

Commit 49c1e78

Browse files
Merge pull request #266559 from aahill/aoai-ga
image updates and feedback
2 parents 249c043 + cb390fe commit 49c1e78

File tree

12 files changed

+36
-54
lines changed

12 files changed

+36
-54
lines changed

articles/ai-services/openai/concepts/use-your-data.md

Lines changed: 26 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -15,18 +15,18 @@ ms.custom: references_regions
1515

1616
# Azure OpenAI On Your Data
1717

18-
Use this article to learn about Azure OpenAI On Your Data, which makes it easier for developers to connect, ingest and ground their enterprise data to create personalized copilots easily and rapidly. It enhances user comprehension, expedites task completion, improves operational efficiency, and aids decision-making.
18+
Use this article to learn about Azure OpenAI On Your Data, which makes it easier for developers to connect, ingest and ground their enterprise data to create personalized copilots rapidly. It enhances user comprehension, expedites task completion, improves operational efficiency, and aids decision-making.
1919

2020
## What is Azure OpenAI On Your Data
2121

22-
Azure OpenAI On Your Data enables you to run advanced AI models such as GPT-35-Turbo and GPT-4 on your own enterprise data without needing to train or fine-tune models. You can chat on top of and analyze your data with greater accuracy. You can specify sources to support the responses based on the latest information available in your designated data sources. You can access Azure OpenAI On Your Data using a REST API, via the SDK or the web-based interface in the [Azure OpenAI Studio](https://oai.azure.com/). You can also create a web app that connects to your data to enable an enhanced chat solution or deploy it directly as a copilot in the Microsoft Copilot Studio.
22+
Azure OpenAI On Your Data enables you to run advanced AI models such as GPT-35-Turbo and GPT-4 on your own enterprise data without needing to train or fine-tune models. You can chat on top of and analyze your data with greater accuracy. You can specify sources to support the responses based on the latest information available in your designated data sources. You can access Azure OpenAI On Your Data using a REST API, via the SDK or the web-based interface in the [Azure OpenAI Studio](https://oai.azure.com/). You can also create a web app that connects to your data to enable an enhanced chat solution or deploy it directly as a copilot in the Microsoft Copilot Studio (preview).
2323

2424
## Get started
2525

2626
To get started, [connect your data source](../use-your-data-quickstart.md) using Azure OpenAI Studio and start asking questions and chatting on your data.
2727

2828
> [!NOTE]
29-
> To get started, you need to already have been approved for [Azure OpenAI access](../overview.md#how-do-i-get-access-to-azure-openai) and have an [Azure OpenAI Service resource](../how-to/create-resource.md) deployed in a [supported region](#azure-openai-on-your-data-regional-availability) with either the gpt-35-turbo or the gpt-4 models.
29+
> To get started, you need to already have been approved for [Azure OpenAI access](../overview.md#how-do-i-get-access-to-azure-openai) and have an [Azure OpenAI Service resource](../how-to/create-resource.md) deployed in a [supported region](#regional-availability-and-model-support) with either the gpt-35-turbo or the gpt-4 models.
3030
3131
## Azure Role-based access controls (Azure RBAC) for adding data sources
3232

@@ -64,10 +64,14 @@ When you choose the following data sources, your data is ingested into an Azure
6464

6565
|Data source | Description |
6666
|---------|---------|
67-
|Upload files (preview) | Upload files from your local machine to be stored in an Azure Blob Storage database, and ingested into Azure AI Search. |
68-
|URL/Web address (preview) | Web content from the URLs is stored in an Azure Blob Storage account. |
69-
|Azure Blob Storage account (preview) | Upload files from an Azure Blob Storage account to be ingested into an Azure AI Search index. |
7067
| [Azure AI Search](/azure/search/search-what-is-azure-search) | Use an existing Azure AI Search index with Azure OpenAI On Your Data. |
68+
| [Azure Cosmos DB for MongoDB vCore](/azure/search/search-what-is-azure-search) | Use an existing Azure Cosmos DB for MongoDB vCore database with Azure OpenAI On Your Data. |
69+
|Upload files (preview) | Upload files from your local machine to be stored in an Azure Blob Storage database, and ingested into Azure AI Search. |
70+
|URL/Web address (preview) | Web content from the URLs is stored in Azure Blob Storage. |
71+
|Azure Blob Storage (preview) | Upload files from Azure Blob Storage to be ingested into an Azure AI Search index. |
72+
73+
74+
* [Azure Cosmos DB for MongoDB vCore](/azure/cosmos-db/mongodb/vcore/introduction) account
7175

7276

7377
# [Azure AI Search](#tab/ai-search)
@@ -90,7 +94,7 @@ Azure OpenAI On Your Data provides the following search types you can use when y
9094

9195
To enable vector search, you need an existing embedding model deployed in your Azure OpenAI resource. Select your embedding deployment when connecting your data, then select one of the vector search types under **Data management**. If you're using Azure AI Search as a data source, make sure you have a vector column in the index.
9296

93-
If you're using your own index, you can customize the [field mapping](#index-field-mapping) when you add your data source to define the fields that will mapped when answering questions. To customize field mapping, select **Use custom field mapping** on the **Data Source** page when adding your data source.
97+
If you're using your own index, you can customize the [field mapping](#index-field-mapping) when you add your data source to define the fields that will get mapped when answering questions. To customize field mapping, select **Use custom field mapping** on the **Data Source** page when adding your data source.
9498

9599

96100

@@ -106,11 +110,11 @@ If you're using your own index, you can customize the [field mapping](#index-fie
106110
| *hybrid (vector + keyword)* | A hybrid of vector search and keyword search | [Additional pricing](https://azure.microsoft.com/pricing/details/cognitive-services/openai-service/) on your Azure OpenAI account from calling the embedding model. |Performs similarity search over vector fields using vector embeddings, while also supporting flexible query parsing and full text search over alphanumeric fields using term queries.|
107111
| *hybrid (vector + keyword) + semantic* | A hybrid of vector search, semantic search, and keyword search. | [Additional pricing](https://azure.microsoft.com/pricing/details/cognitive-services/openai-service/) on your Azure OpenAI account from calling the embedding model, and additional pricing for [semantic search](/azure/search/semantic-search-overview#availability-and-pricing) usage. |Uses vector embeddings, language understanding, and flexible query parsing to create rich search experiences and generative AI apps that can handle complex and diverse information retrieval scenarios. |
108112

109-
## Intelligent search
113+
### Intelligent search
110114

111115
Azure OpenAI On Your Data has intelligent search enabled for your data. Semantic search is enabled by default if you have both semantic search and keyword search. If you have embedding models, intelligent search will default to hybrid + semantic search.
112116

113-
## Document-level access control
117+
### Document-level access control
114118

115119
> [!NOTE]
116120
> Document-level access control is supported when you select Azure AI Search as your data source.
@@ -208,7 +212,7 @@ To modify the schedule, you can use the [Azure portal](https://portal.azure.com/
208212

209213
# [Upload files (preview)](#tab/file-upload)
210214

211-
Using Azure OpenAI Studio, you can upload files from your machine to try Azure OpenAI On Your Data, and optionally creating a new Azure Blob Storage account and Azure AI Search resource. The service then stores the files to an Azure storage container and performs ingestion from the container.
215+
Using Azure OpenAI Studio, you can upload files from your machine to try Azure OpenAI On Your Data, and optionally creating a new Azure Blob Storage account and Azure AI Search resource. The service then stores the files to an Azure storage container and performs ingestion from the container. You can use the [quickstart](../use-your-data-quickstart.md) article to learn how to use this data source option.
212216

213217
# [URL/Web address (preview)](#tab/web-pages)
214218

@@ -222,17 +226,7 @@ You can paste URLs and the service will store the webpage content, using it when
222226

223227
<!--:::image type="content" source="../media/use-your-data/url.png" alt-text="A screenshot of the Azure OpenAI use your data url/webpage studio configuration page." lightbox="../media/use-your-data/url.png":::-->
224228

225-
Once you have added the URL/web address for data ingestion, the web pages from your URL are fetched and saved to your Azure Blob Storage account with a container name: `webpage-<index name>`. Each URL will be saved into a different container within the account. Then the files are indexed into an Azure AI Search index, which is used for retrieval when you’re chatting with the model.
226-
227-
### Search options
228-
229-
Azure OpenAI On Your Data provides keyword search if you add URL as a data source.
230-
231-
* [Keyword search](/azure/search/search-lucene-query-architecture)
232-
233-
| Search option | Retrieval type | Additional pricing? |Benefits|
234-
|---------------------|------------------------|---------------------| -------- |
235-
| *keyword* | Keyword search | No additional pricing. |Performs fast and flexible query parsing and matching over searchable fields, using terms or phrases in any supported language, with or without operators.|
229+
Once you have added the URL/web address for data ingestion, the web pages from your URL are fetched and saved to Azure Blob Storage with a container name: `webpage-<index name>`. Each URL will be saved into a different container within the account. Then the files are indexed into an Azure AI Search index, which is used for retrieval when you’re chatting with the model.
236230

237231
---
238232

@@ -246,19 +240,18 @@ Data is ingested into Azure AI search using the following process:
246240

247241
3. The preprocessed data is loaded from the chunks container, and indexed in the Azure AI Search index.
248242

249-
## Deployment
243+
## Deploy to a copilot (preview) or web app
250244

251245
After you connect Azure OpenAI to your data, you can deploy it using the **Deploy to** button in Azure OpenAI studio.
252246

253247
:::image type="content" source="../media/use-your-data/deploy-model.png" alt-text="A screenshot showing the model deployment button in Azure OpenAI Studio." lightbox="../media/use-your-data/deploy-model.png":::
254248

255249
This gives you the option of deploying a standalone web app for you and your users to interact with chat models using a graphical user interface. See [Use the Azure OpenAI web app](../how-to/use-web-app.md) for more information.
256250

257-
You can also deploy to a copilot in [Copilot Studio](/microsoft-copilot-studio/fundamentals-what-is-copilot-studio) directly from Azure OpenAI studio, enabling you to bring conversational experiences to various channels such as: Microsoft Teams, websites, Dynamics 365, and other [Azure Bot Service channels](/microsoft-copilot-studio/publication-connect-bot-to-azure-bot-service-channels). The tenant used in the Azure OpenAI service and Copilot Studio should be the same. For more information, see [Use a connection to Azure OpenAI On Your Data](/microsoft-copilot-studio/nlu-generative-answers-azure-openai).
251+
You can also deploy to a copilot in [Copilot Studio](/microsoft-copilot-studio/fundamentals-what-is-copilot-studio) (preview) directly from Azure OpenAI studio, enabling you to bring conversational experiences to various channels such as: Microsoft Teams, websites, Dynamics 365, and other [Azure Bot Service channels](/microsoft-copilot-studio/publication-connect-bot-to-azure-bot-service-channels). The tenant used in the Azure OpenAI service and Copilot Studio (preview) should be the same. For more information, see [Use a connection to Azure OpenAI On Your Data](/microsoft-copilot-studio/nlu-generative-answers-azure-openai).
258252

259253
> [!NOTE]
260-
> * Deploying to a copilot in Copilot Studio is only available to US regions in preview.
261-
> * Copilot Studio supports Azure AI Search indexes with keyword or semantic search only. Other data sources and advanced features might not be supported.
254+
> Deploying to a copilot in Copilot Studio (preview) is only available in US regions.
262255
263256
## Use Azure OpenAI On Your Data securely
264257

@@ -426,12 +419,12 @@ When you chat with a model, providing a history of the chat will help the model
426419

427420

428421

429-
| Model | Total tokens available | Max tokens for system message | Max tokens for model response |
430-
|-------------------------|------------------------|------------------------------------|------------------------------------|
431-
| GPT-35-0301 | 8000 | 400 | 1500 |
432-
| GPT-35-0613-16K | 16000 | 1000 | 3200 |
433-
| GPT-4-0613-8K | 8000 | 400 | 1500 |
434-
| GPT-4-0613-32K | 32000 | 2000 | 6400 |
422+
| Model | Max tokens for system message | Max tokens for model response |
423+
|--|--|--|
424+
| GPT-35-0301 | 400 | 1500 |
425+
| GPT-35-0613-16K | 1000 | 3200 |
426+
| GPT-4-0613-8K | 400 | 1500 |
427+
| GPT-4-0613-32K | 2000 | 6400 |
435428

436429
The table above shows the total number of tokens available for each model type. It also determines the maximum number of tokens that can be used for the [system message](#system-message) and the model response. Additionally, the following also consume tokens:
437430

@@ -491,18 +484,7 @@ Resolution:
491484

492485
This means the storage account isn't accessible with the given credentials. In this case, please review the storage account credentials passed to the API and ensure the storage account isn't hidden behind a private endpoint (if a private endpoint isn't configured for this resource).
493486

494-
## Programming language support
495-
496-
Along with deploying a model from Azure OpenAI Studio, you can also chat with it programmatically. You can find a number of available
497-
* [REST API](../reference.md#azure-ai-search)
498-
* [C#](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/openai/Azure.AI.OpenAI/tests/Samples/AzureOnYourData.cs)
499-
* [Java](https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/openai/azure-ai-openai/src/samples/java/com/azure/ai/openai/ChatCompletionsWithYourData.java)
500-
* [JavaScript](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/openai/openai/samples/v1-beta/javascript/bringYourOwnData.js)
501-
* [PowerShell](../use-your-data-quickstart.md?tabs=command-line%2Cpowershell&pivots=programming-language-powershell#example-powershell-commands)
502-
* [Python](https://github.com/openai/openai-cookbook/blob/main/examples/azure/chat_with_your_own_data.ipynb)
503-
504-
505-
## Azure OpenAI On Your Data regional availability
487+
## Regional availability and model support
506488

507489
You can use Azure OpenAI On Your Data with an Azure OpenAI resource in the following regions:
508490
* Australia East
@@ -523,7 +505,7 @@ You can use Azure OpenAI On Your Data with an Azure OpenAI resource in the follo
523505
* West Europe
524506
* West US
525507

526-
## Supported models
508+
### Supported models
527509

528510
* `gpt-4` (0314)
529511
* `gpt-4` (0613)

articles/ai-services/openai/includes/connect-your-data-studio.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ recommendations: false
1414

1515
Navigate to [Azure OpenAI Studio](https://oai.azure.com/) and sign-in with credentials that have access to your Azure OpenAI resource. During or after the sign-in workflow, select the appropriate directory, Azure subscription, and Azure OpenAI resource.
1616

17-
1. Select the **Bring your own data - ground your own data on advanced AI models to create conversational copilots** tile
17+
1. Select the **Bring your own data** tile
1818

1919
:::image type="content" source="../media/use-your-data/bring-your-data-card.png" alt-text="A screenshot of the Azure OpenAI Studio landing page." lightbox="../media/use-your-data/bring-your-data-card.png":::
2020

@@ -35,7 +35,7 @@ Navigate to [Azure OpenAI Studio](https://oai.azure.com/) and sign-in with crede
3535

3636
1. On the **Upload files** pane, select **Browse for a file** and select the files you want to upload. Then select **Upload files**. Then select **Next**.
3737

38-
1. On the **Data management** pane, you can choose whether to enable [semantic search or vector search](../concepts/use-your-data.md#search-options) for your index.
38+
1. On the **Data management** pane, you can choose whether to enable [semantic search or vector search](../concepts/use-your-data.md#search-types) for your index.
3939

4040
> [!IMPORTANT]
4141
> * [Semantic search](/azure/search/semantic-search-overview#availability-and-pricing) and [vector search](https://azure.microsoft.com/pricing/details/cognitive-services/openai-service/) are subject to additional pricing. You need to choose **Basic or higher SKU** to enable semantic search or vector search. See [pricing tier difference](/azure/search/search-sku-tier) and [service limits](/azure/search/search-limits-quotas-capacity) for more information.

articles/ai-services/openai/includes/deploy-web-app.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Studio by selecting the **Deploy to** button.
1515

1616
:::image type="content" source="../media/use-your-data/deploy-model.png" alt-text="A screenshot showing the model deployment button in Azure OpenAI Studio." lightbox="../media/use-your-data/deploy-model.png":::
1717

18-
This gives you the option to either deploy to a standalone web application, or a copilot in Copilot Studio if you're [using your own data](../concepts/use-your-data.md#deployment) on the model.
18+
This gives you the option to either deploy to a standalone web application, or a copilot in Copilot Studio (preview) if you're [using your own data](../concepts/use-your-data.md#deploy-to-a-copilot-preview-or-web-app) on the model.
1919

2020
As an example, if you choose to deploy a web app:
2121

articles/ai-services/openai/includes/use-your-data-powershell.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,4 +80,4 @@ To query a RESTful web service using PowerShell, you can use the `Invoke-RestMet
8080
8181
## Chat with your model using a web app
8282

83-
To start chatting with the Azure OpenAI model that uses your data, you can deploy a web app using [Azure OpenAI studio](../concepts/use-your-data.md#deployment) or example code we [provide on GitHub](https://go.microsoft.com/fwlink/?linkid=2244395). This app deploys using Azure app service, and provides a user interface for sending queries. This app can be used Azure OpenAI models that use your data, or models that don't use your data. See the readme file in the repo for instructions on requirements, setup, and deployment. You can optionally customize the [frontend and backend logic](../how-to/use-web-app.md#web-app-customization) of the web app by making changes to the source code.
83+
To start chatting with the Azure OpenAI model that uses your data, you can deploy a web app using [Azure OpenAI studio](../concepts/use-your-data.md#deploy-to-a-copilot-preview-or-web-app) or example code we [provide on GitHub](https://go.microsoft.com/fwlink/?linkid=2244395). This app deploys using Azure app service, and provides a user interface for sending queries. This app can be used Azure OpenAI models that use your data, or models that don't use your data. See the readme file in the repo for instructions on requirements, setup, and deployment. You can optionally customize the [frontend and backend logic](../how-to/use-web-app.md#web-app-customization) of the web app by making changes to the source code.

0 commit comments

Comments
 (0)