Skip to content

Commit 6db77cb

Browse files
authored
Merge pull request #66 from aahill/ai-studio-update
AOAI studio updates
2 parents 880c2e3 + 29d6036 commit 6db77cb

File tree

11 files changed

+113
-47
lines changed

11 files changed

+113
-47
lines changed

articles/ai-services/openai/assistants-quickstart.md

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ manager: nitinme
66
ms.service: azure-ai-openai
77
ms.custom: devx-track-python, devx-track-dotnet, devx-track-extended-java, devx-track-js
88
ms.topic: quickstart
9-
author: mrbullwinkle
10-
ms.author: mbullwin
11-
ms.date: 07/18/2024
9+
author: aahill
10+
ms.author: aahi
11+
ms.date: 09/18/2024
1212
zone_pivot_groups: openai-quickstart-assistants
1313
recommendations: false
1414
---
@@ -18,15 +18,9 @@ recommendations: false
1818

1919
Azure OpenAI Assistants (Preview) allows you to create AI assistants tailored to your needs through custom instructions and augmented by advanced tools like code interpreter, and custom functions.
2020

21-
::: zone pivot="programming-language-studio"
22-
23-
[!INCLUDE [Azure OpenAI Studio quickstart](includes/assistants-studio.md)]
24-
25-
::: zone-end
26-
2721
::: zone pivot="programming-language-ai-studio"
2822

29-
[!INCLUDE [AI Studio (Preview)](includes/assistants-ai-studio.md)]
23+
[!INCLUDE [AI Studio](includes/assistants-ai-studio.md)]
3024

3125
::: zone-end
3226

articles/ai-services/openai/includes/assistants-ai-studio.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,9 @@ author: mrbullwinkle
2222

2323
## Go to the Azure AI Studio (Preview)
2424

25+
> [!NOTE]
26+
> While you can use [Azure OpenAI Studio](https://oai.azure.com/), we recommend using the steps here to use [Azure AI Studio](https://ai.azure.com). AI Studio lets you use Assistants v2 which provides several upgrades such as the [file search](../how-to/file-search.md) tool which is faster and supports more files.
27+
2528
1. Sign in to [Azure AI Studio](https://ai.azure.com).
2629
1. Go to your project or [create a new project](../../../ai-studio//how-to/create-projects.md) in Azure AI Studio.
2730
1. From your project overview, select **Assistants**, located under **Project playground**.

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,10 @@ Navigate to [Azure OpenAI Studio](https://oai.azure.com/) and sign-in with crede
2121

2222
:::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":::
2323

24+
1. In the **Chat playground**, Select **Add your data** and then **Add a data source**
25+
26+
:::image type="content" source="../media/use-your-data/chat-playground.png" alt-text="A screenshot of the chat playground in OpenAI Studio." lightbox="../media/use-your-data/chat-playground.png":::
27+
2428
1. In the pane that appears, select **Upload files (preview)** under **Select data source**. Azure OpenAI needs both a storage resource and a search resource to access and index your data.
2529

2630
> [!TIP]
Binary file not shown.
Binary file not shown.
Binary file not shown.
27.4 KB
Loading
220 KB
Loading
245 KB
Loading

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

Lines changed: 102 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -16,33 +16,71 @@ zone_pivot_groups: openai-use-your-data
1616

1717
# Quickstart: Chat with Azure OpenAI models using your own data
1818

19-
::: zone pivot="programming-language-spring"
19+
In this quickstart, you can use your own data with Azure OpenAI models. Using Azure OpenAI's models on your data can provide you with a powerful conversational AI platform that enables faster and more accurate communication.
2020

21-
[Source code](https://github.com/spring-projects-experimental/spring-ai)| [Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/openai/openai) | [Sample](https://github.com/rd-1-2022/ai-azure-retrieval-augmented-generation)
21+
::: zone pivot="programming-language-studio"
2222

23-
::: zone-end
2423

25-
::: zone pivot="programming-language-javascript"
24+
## Prerequisites
2625

27-
[Reference documentation](https://platform.openai.com/docs/api-reference/chat) | [Source code](https://github.com/openai/openai-node) | [Package (npm)](https://www.npmjs.com/package/openai) | [Samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/openai/openai/samples)
26+
The following resources:
27+
- [Azure OpenAI](https://portal.azure.com/#create/Microsoft.CognitiveServicesOpenAI)
28+
- [Azure Blob Storage](https://portal.azure.com/#create/Microsoft.StorageAccount-ARM)
29+
- [Azure AI Search](https://portal.azure.com/#create/Microsoft.Search)
30+
- An [Azure OpenAI resource](https://portal.azure.com/#create/Microsoft.CognitiveServicesOpenAI) deployed in a [supported region and with a supported model](./concepts/use-your-data.md#regional-availability-and-model-support).
31+
- Be sure that you're assigned at least the [Cognitive Services Contributor](./how-to/role-based-access-control.md#cognitive-services-contributor) role for the Azure OpenAI resource.
32+
- Download the example data from [GitHub](https://github.com/Azure-Samples/cognitive-services-sample-data-files/blob/master/openai/contoso_benefits_document_example.pdf) if you don't have your own data.
33+
34+
> [!div class="nextstepaction"]
35+
> [I ran into an issue with the prerequisites.](https://microsoft.qualtrics.com/jfe/form/SV_0Cl5zkG3CnDjq6O?PLanguage=OVERVIEW&Pillar=AOAI&Product=ownData&Page=quickstart&Section=Prerequisites)
36+
37+
38+
[!INCLUDE [Connect your data to OpenAI](includes/connect-your-data-studio.md)]
39+
40+
[!INCLUDE [Studio quickstart](includes/use-your-data-studio.md)]
2841

2942
::: zone-end
3043

31-
::: zone pivot="programming-language-python"
44+
::: zone pivot="programming-language-csharp"
3245

33-
[Reference](https://platform.openai.com/docs/api-reference?lang=python) | [Source code](https://github.com/openai/openai-python) | [Package (pypi)](https://pypi.org/project/openai/) | [Samples](https://github.com/openai/openai-cookbook/)
46+
## Prerequisites
3447

35-
These links reference the OpenAI API for Python. There's no Azure-specific OpenAI Python SDK. [Learn how to switch between the OpenAI services and Azure OpenAI services](/azure/ai-services/openai/how-to/switching-endpoints).
48+
The following resources:
49+
- [Azure OpenAI](https://portal.azure.com/#create/Microsoft.CognitiveServicesOpenAI)
50+
- [Azure Blob Storage](https://portal.azure.com/#create/Microsoft.StorageAccount-ARM)
51+
- [Azure AI Search](https://portal.azure.com/#create/Microsoft.Search)
52+
- An [Azure OpenAI resource](https://portal.azure.com/#create/Microsoft.CognitiveServicesOpenAI) deployed in a [supported region and with a supported model](./concepts/use-your-data.md#regional-availability-and-model-support).
53+
- Be sure that you're assigned at least the [Cognitive Services Contributor](./how-to/role-based-access-control.md#cognitive-services-contributor) role for the Azure OpenAI resource.
54+
- Download the example data from [GitHub](https://github.com/Azure-Samples/cognitive-services-sample-data-files/blob/master/openai/contoso_benefits_document_example.pdf) if you don't have your own data.
55+
- The [.NET 8 SDK](https://dotnet.microsoft.com/download/dotnet/8.0)
56+
57+
[!INCLUDE [Connect your data to OpenAI](includes/connect-your-data-studio.md)]
58+
59+
[!INCLUDE [Csharp quickstart](includes/use-your-data-dotnet.md)]
3660

3761
::: zone-end
3862

39-
::: zone pivot="programming-language-go"
63+
::: zone pivot="programming-language-spring"
4064

41-
[Reference](https://pkg.go.dev/github.com/Azure/azure-sdk-for-go) | [Source code](https://github.com/Azure/azure-sdk-for-go) | [Package (Go)](https://pkg.go.dev/github.com/azure/azure-dev) | [Samples](https://github.com/azure-samples/azure-sdk-for-go-samples)
65+
[Source code](https://github.com/spring-projects-experimental/spring-ai)| [Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/openai/openai) | [Sample](https://github.com/rd-1-2022/ai-azure-retrieval-augmented-generation)
66+
67+
## Prerequisites
68+
69+
The following resources:
70+
- [Azure OpenAI](https://portal.azure.com/#create/Microsoft.CognitiveServicesOpenAI)
71+
- [Azure Blob Storage](https://portal.azure.com/#create/Microsoft.StorageAccount-ARM)
72+
- [Azure AI Search](https://portal.azure.com/#create/Microsoft.Search)
73+
- An [Azure OpenAI resource](https://portal.azure.com/#create/Microsoft.CognitiveServicesOpenAI) deployed in a [supported region and with a supported model](./concepts/use-your-data.md#regional-availability-and-model-support).
74+
- Be sure that you're assigned at least the [Cognitive Services Contributor](./how-to/role-based-access-control.md#cognitive-services-contributor) role for the Azure OpenAI resource.
75+
- Download the example data from [GitHub](https://github.com/Azure-Samples/cognitive-services-sample-data-files/blob/master/openai/contoso_benefits_document_example.pdf) if you don't have your own data.
76+
77+
[!INCLUDE [Connect your data to OpenAI](includes/connect-your-data-studio.md)]
78+
79+
[!INCLUDE [Spring quickstart](includes/use-your-data-spring.md)]
4280

4381
::: zone-end
4482

45-
In this quickstart, you can use your own data with Azure OpenAI models. Using Azure OpenAI's models on your data can provide you with a powerful conversational AI platform that enables faster and more accurate communication.
83+
::: zone pivot="programming-language-javascript"
4684

4785
## Prerequisites
4886

@@ -59,6 +97,7 @@ In this quickstart, you can use your own data with Azure OpenAI models. Using Az
5997

6098
- Download the example data from [GitHub](https://github.com/Azure-Samples/cognitive-services-sample-data-files/blob/master/openai/contoso_benefits_document_example.pdf) if you don't have your own data.
6199

100+
62101
#### [JavaScript](#tab/javascript)
63102

64103
- An Azure subscription - <a href="https://azure.microsoft.com/free/cognitive-services" target="_blank">Create one for free</a>.
@@ -71,64 +110,92 @@ In this quickstart, you can use your own data with Azure OpenAI models. Using Az
71110

72111
---
73112

74-
::: zone pivot="programming-language-javascript"
113+
[Reference documentation](https://platform.openai.com/docs/api-reference/chat) | [Source code](https://github.com/openai/openai-node) | [Package (npm)](https://www.npmjs.com/package/openai) | [Samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/openai/openai/samples)
75114

76115

116+
[!INCLUDE [Connect your data to OpenAI](includes/connect-your-data-studio.md)]
77117

78-
- [Long Term Support (LTS) versions of Node.js](https://github.com/nodejs/release#release-schedule)
118+
[!INCLUDE [JavaScript quickstart](includes/use-your-data-javascript.md)]
79119

80120
::: zone-end
81121

82-
> [!div class="nextstepaction"]
83-
> [I ran into an issue with the prerequisites.](https://microsoft.qualtrics.com/jfe/form/SV_0Cl5zkG3CnDjq6O?PLanguage=OVERVIEW&Pillar=AOAI&Product=ownData&Page=quickstart&Section=Prerequisites)
84-
122+
::: zone pivot="programming-language-python"
85123

86-
[!INCLUDE [Connect your data to OpenAI](includes/connect-your-data-studio.md)]
124+
## Prerequisites
87125

88-
::: zone pivot="programming-language-studio"
126+
The following resources:
127+
- [Azure OpenAI](https://portal.azure.com/#create/Microsoft.CognitiveServicesOpenAI)
128+
- [Azure Blob Storage](https://portal.azure.com/#create/Microsoft.StorageAccount-ARM)
129+
- [Azure AI Search](https://portal.azure.com/#create/Microsoft.Search)
130+
- An [Azure OpenAI resource](https://portal.azure.com/#create/Microsoft.CognitiveServicesOpenAI) deployed in a [supported region and with a supported model](./concepts/use-your-data.md#regional-availability-and-model-support).
131+
- Be sure that you're assigned at least the [Cognitive Services Contributor](./how-to/role-based-access-control.md#cognitive-services-contributor) role for the Azure OpenAI resource.
132+
- Download the example data from [GitHub](https://github.com/Azure-Samples/cognitive-services-sample-data-files/blob/master/openai/contoso_benefits_document_example.pdf) if you don't have your own data.
89133

90-
[!INCLUDE [Studio quickstart](includes/use-your-data-studio.md)]
134+
[Reference](https://platform.openai.com/docs/api-reference?lang=python) | [Source code](https://github.com/openai/openai-python) | [Package (pypi)](https://pypi.org/project/openai/) | [Samples](https://github.com/openai/openai-cookbook/)
91135

92-
::: zone-end
136+
These links reference the OpenAI API for Python. There's no Azure-specific OpenAI Python SDK. [Learn how to switch between the OpenAI services and Azure OpenAI services](/azure/ai-services/openai/how-to/switching-endpoints).
93137

94-
::: zone pivot="programming-language-csharp"
138+
[!INCLUDE [Connect your data to OpenAI](includes/connect-your-data-studio.md)]
95139

96-
[!INCLUDE [Csharp quickstart](includes/use-your-data-dotnet.md)]
140+
[!INCLUDE [Python quickstart](includes/use-your-data-python.md)]
97141

98142
::: zone-end
99143

100-
::: zone pivot="programming-language-spring"
144+
::: zone pivot="programming-language-powershell"
101145

102-
[!INCLUDE [Spring quickstart](includes/use-your-data-spring.md)]
103146

104-
::: zone-end
147+
## Prerequisites
105148

106-
::: zone pivot="programming-language-javascript"
149+
The following resources:
150+
- [Azure OpenAI](https://portal.azure.com/#create/Microsoft.CognitiveServicesOpenAI)
151+
- [Azure Blob Storage](https://portal.azure.com/#create/Microsoft.StorageAccount-ARM)
152+
- [Azure AI Search](https://portal.azure.com/#create/Microsoft.Search)
153+
- An [Azure OpenAI resource](https://portal.azure.com/#create/Microsoft.CognitiveServicesOpenAI) deployed in a [supported region and with a supported model](./concepts/use-your-data.md#regional-availability-and-model-support).
154+
- Be sure that you're assigned at least the [Cognitive Services Contributor](./how-to/role-based-access-control.md#cognitive-services-contributor) role for the Azure OpenAI resource.
155+
- Download the example data from [GitHub](https://github.com/Azure-Samples/cognitive-services-sample-data-files/blob/master/openai/contoso_benefits_document_example.pdf) if you don't have your own data.
107156

108-
[!INCLUDE [JavaScript quickstart](includes/use-your-data-javascript.md)]
157+
[!INCLUDE [Connect your data to OpenAI](includes/connect-your-data-studio.md)]
109158

110-
::: zone-end
159+
[!INCLUDE [PowerShell quickstart](includes/use-your-data-powershell.md)]
111160

112-
::: zone pivot="programming-language-python"
161+
::: zone-end
113162

114-
[!INCLUDE [Python quickstart](includes/use-your-data-python.md)]
163+
::: zone pivot="programming-language-go"
115164

116-
::: zone-end
117165

118-
::: zone pivot="programming-language-powershell"
166+
## Prerequisites
119167

120-
[!INCLUDE [PowerShell quickstart](includes/use-your-data-powershell.md)]
168+
The following resources:
169+
- [Azure OpenAI](https://portal.azure.com/#create/Microsoft.CognitiveServicesOpenAI)
170+
- [Azure Blob Storage](https://portal.azure.com/#create/Microsoft.StorageAccount-ARM)
171+
- [Azure AI Search](https://portal.azure.com/#create/Microsoft.Search)
172+
- An [Azure OpenAI resource](https://portal.azure.com/#create/Microsoft.CognitiveServicesOpenAI) deployed in a [supported region and with a supported model](./concepts/use-your-data.md#regional-availability-and-model-support).
173+
- Be sure that you're assigned at least the [Cognitive Services Contributor](./how-to/role-based-access-control.md#cognitive-services-contributor) role for the Azure OpenAI resource.
174+
- Download the example data from [GitHub](https://github.com/Azure-Samples/cognitive-services-sample-data-files/blob/master/openai/contoso_benefits_document_example.pdf) if you don't have your own data.
121175

122-
::: zone-end
176+
[Reference](https://pkg.go.dev/github.com/Azure/azure-sdk-for-go) | [Source code](https://github.com/Azure/azure-sdk-for-go) | [Package (Go)](https://pkg.go.dev/github.com/azure/azure-dev) | [Samples](https://github.com/azure-samples/azure-sdk-for-go-samples)
123177

124-
::: zone pivot="programming-language-go"
178+
[!INCLUDE [Connect your data to OpenAI](includes/connect-your-data-studio.md)]
125179

126180
[!INCLUDE [Go quickstart](includes/use-your-data-go.md)]
127181

128182
::: zone-end
129183

130184
::: zone pivot="rest-api"
131185

186+
187+
## Prerequisites
188+
189+
The following resources:
190+
- [Azure OpenAI](https://portal.azure.com/#create/Microsoft.CognitiveServicesOpenAI)
191+
- [Azure Blob Storage](https://portal.azure.com/#create/Microsoft.StorageAccount-ARM)
192+
- [Azure AI Search](https://portal.azure.com/#create/Microsoft.Search)
193+
- An [Azure OpenAI resource](https://portal.azure.com/#create/Microsoft.CognitiveServicesOpenAI) deployed in a [supported region and with a supported model](./concepts/use-your-data.md#regional-availability-and-model-support).
194+
- Be sure that you're assigned at least the [Cognitive Services Contributor](./how-to/role-based-access-control.md#cognitive-services-contributor) role for the Azure OpenAI resource.
195+
- Download the example data from [GitHub](https://github.com/Azure-Samples/cognitive-services-sample-data-files/blob/master/openai/contoso_benefits_document_example.pdf) if you don't have your own data.
196+
197+
[!INCLUDE [Connect your data to OpenAI](includes/connect-your-data-studio.md)]
198+
132199
[!INCLUDE [REST API quickstart](includes/use-your-data-rest.md)]
133200

134201
::: zone-end

0 commit comments

Comments
 (0)