Skip to content

Commit 0a35bb3

Browse files
authored
Merge pull request #260767 from MicrosoftDocs/main
12/8/2023 PM Publish
2 parents 19e52c7 + fe91de7 commit 0a35bb3

File tree

155 files changed

+1328
-2824
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

155 files changed

+1328
-2824
lines changed

articles/ai-services/language-service/personally-identifiable-information/includes/identification-entities.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -684,7 +684,7 @@ The following entities are grouped and listed by country/region:
684684
:::row:::
685685
:::column span="":::
686686

687-
EU GPU coordinates
687+
EU GPS coordinates
688688

689689
:::column-end:::
690690
:::column span="2":::

articles/ai-services/language-service/summarization/includes/regional-availability.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ ms.custom:
1313
---
1414

1515
> [!IMPORTANT]
16-
> One preview region, Sweden Central, showcases our latest and continually evolving LLM fine tuning techniques, where all summarization capabilities are available. We welcome customers to join our early adopter community by filling out the [access request form](https://aka.ms/applyforgatedsummarizationfeatures).
17-
. Your valuable feedback is vital to our continuous enhancement.
16+
> One preview region, Sweden Central, showcases our latest and continually evolving LLM fine tuning techniques, where all summarization capabilities are available. We welcome customers to join our early adopter community by filling out the [access request form](https://aka.ms/applyforgatedsummarizationfeatures). Your valuable feedback is vital to our continuous enhancement.
17+
>
1818
> Conversation summarization is only available using:
1919
> - REST API
2020
> - Python

articles/ai-services/language-service/summarization/language-support.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,11 @@ Conversation summarization supports the following languages:
4848
| English | `en` | |
4949
| French | `fr` | |
5050
| German | `de` | |
51+
| Hebrew | `he` | |
5152
| Italian | `it` | |
5253
| Japanese | `ja` | |
5354
| Korean | `ko` | |
55+
| Polish | `pl` | |
5456
| Portuguese | `pt` | |
5557
| Spanish | `es` | |
5658

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

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Azure OpenAI on your data supports the following filetypes:
3737

3838
* `.txt`
3939
* `.md`
40-
* `.html`
40+
* `.html`
4141
* Microsoft Word files
4242
* Microsoft PowerPoint files
4343
* PDF
@@ -134,8 +134,7 @@ Azure OpenAI on your data provides several search options you can use when you a
134134

135135
> [!IMPORTANT]
136136
> * [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.
137-
> * To help improve the quality of the information retrieval and model response, we recommend enabling [semantic search](/azure/search/semantic-search-overview) for the following languages: English, French, Spanish, Portuguese, Italian, Germany, Chinese(Zh), Japanese, Korean, Russian, Arabic
138-
> * If you enable vector search, you need to enable public network access for your Azure OpenAI resources.
137+
> * To help improve the quality of the information retrieval and model response, we recommend enabling [semantic search](/azure/search/semantic-search-overview) for the following languages: English, French, Spanish, Portuguese, Italian, Germany, Chinese(Zh), Japanese, Korean, Russian, and Arabic.
139138
140139
| Search option | Retrieval type | Additional pricing? |Benefits|
141140
|---------------------|------------------------|---------------------| -------- |
@@ -209,6 +208,27 @@ To add Azure Cosmos DB for MongoDB vCore as a data source, you will need an exis
209208
After ingesting your data, you can start chatting with the model on your data using the chat playground in Azure OpenAI studio, or the following methods:
210209
* [Web app](#using-the-web-app)
211210
* [REST API](../reference.md#azure-cosmos-db-for-mongodb-vcore)
211+
212+
# [URL/web address](#tab/url-web)
213+
214+
Currently, you can add your data from a URL/web address. Your data from a URL/web address needs to have the following characteristics to be properly ingested:
215+
216+
* A public website, such as [Using your data with Azure OpenAI Service - Azure OpenAI | Microsoft Learn](/azure/ai-services/openai/concepts/use-your-data?tabs=ai-search). Note that you cannot add a URL/Web address with access control, such as with password.
217+
218+
* A HTTPS website.
219+
220+
* The size of content in each URL is smaller than 5MB.
221+
222+
* The website can be downloaded as one of the [supported file types](#data-formats-and-file-types).
223+
224+
You can use URL as a data source in both the Azure OpenAI Studio and the [ingestion API](../reference.md#start-an-ingestion-job). To use URL/web address as a data source, you need to have an Azure AI Search resource and an Azure Blob Storage resource. When using the Ingestion API you need to create a container first. Only one layer of nested links is supported. Only up to 20 links, on the web page will be fetched.
225+
226+
:::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":::
227+
228+
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.
229+
230+
When you want to reuse the same URL/web address, you can select [Azure AI Search](/azure/ai-services/openai/concepts/use-your-data?tabs=ai-search) as your data source and select the index you created with your URL previously. Then you can use the already indexed files instead of having the system crawl your URL again. You can use the Azure AI Search index directly and delete the storage container to free up your storage space.
231+
212232
---
213233

214234

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

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,11 +42,9 @@ Navigate to [Azure OpenAI Studio](https://oai.azure.com/) and sign-in with crede
4242

4343
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.
4444

45-
> [!IMPORTANT]
46-
> * Semantic search and vector search are subject to [additional pricing](../concepts/use-your-data.md#search-options).
47-
> * You can use *keyword* search as the search type for no additional cost.
48-
> * To enable vector search, you will need a `text-embedding-ada-002` deployment in your Azure OpenAI resource.
49-
> * Currently Azure OpenAI on your data supports semantic search for English data only. Only enable semantic search if both your documents and use case are in English.
45+
> [!IMPORTANT]
46+
> * [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.
47+
> * To help improve the quality of the information retrieval and model response, we recommend enabling [semantic search](/azure/search/semantic-search-overview) for the following languages: English, French, Spanish, Portuguese, Italian, Germany, Chinese(Zh), Japanese, Korean, Russian, and Arabic.
5048
5149
1. Review the details you entered, and select **Save and close**. You can now chat with the model and it will use information from your data to construct the response.
5250

281 KB
Loading

articles/ai-services/openai/reference.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -530,16 +530,25 @@ curl -i -X PUT https://YOUR_RESOURCE_NAME.openai.azure.com/openai/extensions/on-
530530
}
531531
```
532532

533+
**Header Parameters**
534+
533535
| Parameters | Type | Required? | Default | Description |
534536
|---|---|---|---|---|
535-
| `dataRefreshIntervalInMinutes` | string | Required | 0 | The data refresh interval in minutes. If you want to run a single ingestion job without a schedule, set this parameter to `0`. |
536-
| `completionAction` | string | Optional | `cleanUpAssets` | What should happen to the assets created during the ingestion process upon job completion. Valid values are `cleanUpAssets` or `keepAllAssets`. `keepAllAssets` leaves all the intermediate assets for users interested in reviewing the intermediate results, which can be helpful for debugging assets. `cleanUpAssets` removes the assets after job completion. |
537-
| `searchServiceEndpoint` | string | Required |null | The endpoint of the search resource in which the data will be ingested. |
537+
| `searchServiceEndpoint` | string | Required |null | The endpoint of the search resource in which the data will be ingested.|
538538
| `searchServiceAdminKey` | string | Optional | null | If provided, the key will be used to authenticate with the `searchServiceEndpoint`. If not provided, the system-assigned identity of the Azure OpenAI resource will be used. In this case, the system-assigned identity must have "Search Service Contributor" role assignment on the search resource. |
539539
| `storageConnectionString` | string | Required | null | The connection string for the storage account where the input data is located. An account key has to be provided in the connection string. It should look something like `DefaultEndpointsProtocol=https;AccountName=<your storage account>;AccountKey=<your account key>` |
540540
| `storageContainer` | string | Required | null | The name of the container where the input data is located. |
541541
| `embeddingEndpoint` | string | Optional | null | Not required if you use semantic or only keyword search. It is required if you use vector, hybrid, or hybrid + semantic search |
542542
| `embeddingKey` | string | Optional | null | The key of the embedding endpoint. This is required if the embedding endpoint is not empty. |
543+
| `url` | string | Optional | null | If URL is not null, the provided url will be crawled into the provided storage container and then ingested accordingly.|
544+
545+
**Body Parameters**
546+
547+
| Parameters | Type | Required? | Default | Description |
548+
|---|---|---|---|---|
549+
| `dataRefreshIntervalInMinutes` | string | Required | 0 | The data refresh interval in minutes. If you want to run a single ingestion job without a schedule, set this parameter to `0`. |
550+
| `completionAction` | string | Optional | `cleanUpAssets` | What should happen to the assets created during the ingestion process upon job completion. Valid values are `cleanUpAssets` or `keepAllAssets`. `keepAllAssets` leaves all the intermediate assets for users interested in reviewing the intermediate results, which can be helpful for debugging assets. `cleanUpAssets` removes the assets after job completion. |
551+
| `chunkSize` | int | Optional |1024 |This number defines the maximum number of tokens in each chunk produced by the ingestion flow. |
543552

544553

545554
### List ingestion jobs

articles/ai-studio/how-to/cli-install.md

Lines changed: 32 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ ms.author: eur
1818

1919
The Azure AI command-line interface (CLI) is a cross-platform command-line tool to connect to Azure AI services and execute control-plane and data-plane operations without having to write any code. The Azure AI CLI allows the execution of commands through a terminal using interactive command-line prompts or via script.
2020

21-
You can easily use the Azure AI CLI to experiment with key Azure AI service features and see how they work with your use cases. Within minutes, you can set up all the required Azure resources needed, and build a customized Copilot using OpenAI's chat completions APIs and your own data. You can try it out interactively, or script larger processes to automate your own workflows and evaluations as part of your CI/CD system.
21+
You can easily use the Azure AI CLI to experiment with key Azure AI features and see how they work with your use cases. Within minutes, you can set up all the required Azure resources needed, and build a customized copilot using Azure OpenAI chat completions APIs and your own data. You can try it out interactively, or script larger processes to automate your own workflows and evaluations as part of your CI/CD system.
2222

2323
## Prerequisites
2424

@@ -36,29 +36,52 @@ The following set of commands are provided for a few popular operating systems.
3636

3737
# [Windows](#tab/windows)
3838

39-
To install the .NET SDK, Azure CLI, and Azure AI CLI, run the following commands in a PowerShell terminal. Skip any that you don't need.
39+
To install the .NET SDK, Azure CLI, and Azure AI CLI, run the following command.
4040

4141
```bash
4242
dotnet tool install --prerelease --global Azure.AI.CLI
4343
```
4444

45+
To update the Azure AI CLI, run the following command:
46+
47+
```bash
48+
dotnet tool update --prerelease --global Azure.AI.CLI
49+
```
50+
4551
# [Linux](#tab/linux)
4652

47-
On Debian and Ubuntu, run:
53+
To install the .NET SDK, Azure CLI, and Azure AI CLI on Debian and Ubuntu, run the following command:
4854

4955
```
5056
curl -sL https://aka.ms/InstallAzureAICLIDeb | bash
5157
```
5258

53-
# [macOS](#tab/macos)
59+
Alternatively, you can run the following command:
60+
61+
```bash
62+
dotnet tool install --prerelease --global Azure.AI.CLI
63+
```
5464

55-
On macOS, you can use *homebrew* and *wget*. For example, run the following commands in a terminal:
65+
To update the Azure AI CLI, run the following command:
5666

67+
```bash
68+
dotnet tool update --prerelease --global Azure.AI.CLI
69+
```
70+
71+
# [macOS](#tab/macos)
72+
73+
To install the .NET SDK, Azure CLI, and Azure AI CLI on macOS 10.14 or later, run the following command:
5774

5875
```bash
5976
dotnet tool install --prerelease --global Azure.AI.CLI
6077
```
6178

79+
To update the Azure AI CLI, run the following command:
80+
81+
```bash
82+
dotnet tool update --prerelease --global Azure.AI.CLI
83+
```
84+
6285
---
6386

6487
## Run the Azure AI CLI without installing it
@@ -109,8 +132,8 @@ The following table describes the scenarios for each flow.
109132

110133
| Scenario | Description |
111134
| --- | --- |
112-
| Initialize a new AI project | Choose if you don't have an existing AI project that you have been working with in the Azure AI Studio. `ai init` walks you through creating or attaching resources. |
113-
| Initialize an existing AI project | Choose if you have an existing AI project you want to work with. `ai init` checks your existing linked resources, and ask you to set anything that hasn't been set before. |
135+
| Initialize a new AI project | Choose if you don't have an existing AI project that you have been working with in the Azure AI Studio. The `ai init` command walks you through creating or attaching resources. |
136+
| Initialize an existing AI project | Choose if you have an existing AI project you want to work with. The `ai init` command checks your existing linked resources, and ask you to set anything that hasn't been set before. |
114137
| Initialize standalone resources| Choose if you're building a simple solution connected to a single AI service, or if you want to attach more resources to your development environment |
115138

116139
Working with an AI project is recommended when using the Azure AI Studio and/or connecting to multiple AI services. Projects come with an AI Resource that houses related projects and shareable resources like compute and connections to services. Projects also allow you to connect code to cloud resources (storage and model deployments), save evaluation results, and host code behind online endpoints. You're prompted to create and/or attach Azure AI Services to your project.
@@ -151,11 +174,11 @@ The following resources can be initialized standalone, or attached to projects:
151174

152175
## Project connections
153176

154-
When working the Azure AI CLI, you'll want to use your project's connections. Connections are established to attached resources and allow you to integrate services with your project. You can have project-specific connections, or connections shared at the Azure AI resource level. For more information, see [Azure AI resources](../concepts/ai-resources.md) and [connections](../concepts/connections.md).
177+
When working the Azure AI CLI, you want to use your project's connections. Connections are established to attached resources and allow you to integrate services with your project. You can have project-specific connections, or connections shared at the Azure AI resource level. For more information, see [Azure AI resources](../concepts/ai-resources.md) and [connections](../concepts/connections.md).
155178

156179
When you run `ai init` your project connections get set in your development environment, allowing seamless integration with AI services. You can view these connections by running `ai service connection list`, and further manage these connections with `ai service connection` subcommands.
157180

158-
Any updates you make to connections in the AI CLI will be reflected in the AI Studio, and vice versa.
181+
Any updates you make to connections in the Azure AI CLI is reflected in [Azure AI Studio](https://ai.azure.com), and vice versa.
159182

160183
## ai dev
161184

0 commit comments

Comments
 (0)