Merge pull request #273028 from MicrosoftDocs/main

4/23 11:00 AM IST Publish

Author: Saisang

articles/ai-services/openai/assistants-reference-messages.md

@@ -14,6 +14,8 @@ ms.custom: devx-track-python
 
 # Assistants API (Preview) messages reference
 
+[!INCLUDE [Assistants v2 note](includes/assistants-v2-note.md)]
+
 This article provides reference documentation for Python and REST for the new Assistants API (Preview). More in-depth step-by-step guidance is provided in the [getting started guide](./how-to/assistant.md).
 
 ## Create message

articles/ai-services/openai/assistants-reference-runs.md

@@ -14,6 +14,8 @@ ms.custom: devx-track-python
 
 # Assistants API (Preview) runs reference
 
+[!INCLUDE [Assistants v2 note](includes/assistants-v2-note.md)]
+
 This article provides reference documentation for Python and REST for the new Assistants API (Preview). More in-depth step-by-step guidance is provided in the [getting started guide](./how-to/assistant.md).
 
 ## Create run

articles/ai-services/openai/assistants-reference-threads.md

@@ -14,6 +14,8 @@ ms.custom: devx-track-python
 
 # Assistants API (Preview) threads reference
 
+[!INCLUDE [Assistants v2 note](includes/assistants-v2-note.md)]
+
 This article provides reference documentation for Python and REST for the new Assistants API (Preview). More in-depth step-by-step guidance is provided in the [getting started guide](./how-to/assistant.md).
 
 ## Create a thread

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

@@ -14,6 +14,9 @@ ms.custom: devx-track-python
 
 # Assistants API (Preview) reference
 
+
+[!INCLUDE [Assistants v2 note](includes/assistants-v2-note.md)]
+
 This article provides reference documentation for Python and REST for the new Assistants API (Preview). More in-depth step-by-step guidance is provided in the [getting started guide](./how-to/assistant.md).
 
 ## Create an assistant
@@ -497,7 +500,7 @@ curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/assistants/{assistant_id
 
 ## File upload API reference
 
-Assistants use the [same API for file upload as fine-tuning](/rest/api/azureopenai/files/upload?view=rest-azureopenai-2024-02-15-preview&tabs=HTTP). When uploading a file you have to specify an appropriate value for the [purpose parameter](/rest/api/azureopenai/files/upload?view=rest-azureopenai-2024-02-15-preview&tabs=HTTP#purpose).
+Assistants use the [same API for file upload as fine-tuning](/rest/api/azureopenai/files/upload?view=rest-azureopenai-2024-02-15-preview&tabs=HTTP&preserve-view=true). When uploading a file you have to specify an appropriate value for the [purpose parameter](/rest/api/azureopenai/files/upload?view=rest-azureopenai-2024-02-15-preview&tabs=HTTP#purpose&preserve-view=true).
 
 
 ## Assistant object

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

@@ -150,9 +150,10 @@ If you want to implement additional value-based criteria for query execution, yo
 * The search type is limited to [Integrated Vector Database in Azure Cosmos DB for MongoDB](/azure/cosmos-db/mongodb/vcore/vector-search) with an Azure OpenAI embedding model.
 * This implementation works best on unstructured and spatial data.
 
+  
 ### Data preparation
 
-Use the script provided on [GitHub](https://github.com/microsoft/sample-app-aoai-chatGPT/blob/feature/2023-9/scripts/cosmos_mongo_vcore_data_preparation.py) to prepare your data.
+Use the script provided on [GitHub](https://github.com/microsoft/sample-app-aoai-chatGPT/tree/main/scripts#data-preparation) to prepare your data.
 
 <!--### Add your data source in Azure OpenAI Studio
 

articles/ai-services/openai/how-to/assistant-functions.md

@@ -17,6 +17,8 @@ recommendations: false
 
 The Assistants API supports function calling, which allows you to describe the structure of functions to an Assistant and then return the functions that need to be called along with their arguments.
 
+[!INCLUDE [Assistants v2 note](../includes/assistants-v2-note.md)]
+
 ## Function calling support
 
 ### Supported models

articles/ai-services/openai/how-to/assistant.md

@@ -1,7 +1,7 @@
 ---
 title: 'How to create Assistants with Azure OpenAI Service'
 titleSuffix: Azure OpenAI
-description: Learn how to create helpful AI Assistants with tools like Code Interpreter
+description: Learn how to create helpful AI Assistants with tools like Code Interpreter.
 services: cognitive-services
 manager: nitinme
 ms.service: azure-ai-openai
@@ -16,7 +16,9 @@ recommendations: false
 
 # Getting started with Azure OpenAI Assistants (Preview)
 
-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. In this article we'll provide an in-depth walkthrough of getting started with the Assistants API.
+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. In this article, we provide an in-depth walkthrough of getting started with the Assistants API.
+
+[!INCLUDE [Assistants v2 note](../includes/assistants-v2-note.md)]
 
 ## Assistants support
 
@@ -149,7 +151,7 @@ print(assistant.model_dump_json(indent=2))
 
 ### Create a thread
 
-Now let's create a thread
+Now let's create a thread.
 
 ```python
 # Create a thread
@@ -161,9 +163,9 @@ print(thread)
 Thread(id='thread_6bunpoBRZwNhovwzYo7fhNVd', created_at=1705972465, metadata={}, object='thread')
 ```
 
-A thread is essentially the record of the conversation session between the assistant and the user. It's similar to the messages array/list in a typical chat completions API call. One of the key differences, is unlike a chat completions messages array, you don't need to track tokens with each call to make sure that you're remaining below the context length of the model. Threads abstract away this management detail and will compress the thread history as needed in order to allow the conversation to continue. The ability for threads to accomplish this with larger conversations is enhanced when using the latest models, which have larger context lengths as well as support for the latest features.
+A thread is essentially the record of the conversation session between the assistant and the user. It's similar to the messages array/list in a typical chat completions API call. One of the key differences, is unlike a chat completions messages array, you don't need to track tokens with each call to make sure that you're remaining below the context length of the model. Threads abstract away this management detail and will compress the thread history as needed in order to allow the conversation to continue. The ability for threads to accomplish this with larger conversations is enhanced when using the latest models, which have larger context lengths and support for the latest features.
 
-Next create the first user question to add to the thread
+Next create the first user question to add to the thread.
 
 ```python
 # Add a user question to the thread
@@ -388,7 +390,7 @@ image = Image.open("sinewave.png")
 image.show()
 ```
 
-:::image type="content" source="../media/how-to/assistants/sine-wave.png" alt-text="Screenshot of code interpreter generated sinewave." lightbox="../media/how-to/assistants/sine-wave.png":::
+:::image type="content" source="../media/how-to/assistants/sine-wave.png" alt-text="Screenshot of code interpreter generated sine wave." lightbox="../media/how-to/assistants/sine-wave.png":::
 
 ### Ask a follow-up question on the thread
 
@@ -840,7 +842,7 @@ image = Image.open("dark_sine.png")
 image.show()
 ```
 
-:::image type="content" source="../media/how-to/assistants/dark-mode.png" alt-text="Screenshot of code interpreter generated sinewave in darkmode." lightbox="../media/how-to/assistants/dark-mode.png":::
+:::image type="content" source="../media/how-to/assistants/dark-mode.png" alt-text="Screenshot of code interpreter generated sine wave in dark mode." lightbox="../media/how-to/assistants/dark-mode.png":::
 
 ## Additional reference
 

articles/ai-services/openai/how-to/code-interpreter.md

@@ -20,6 +20,8 @@ Code Interpreter allows the Assistants API to write and run Python code in a san
 > [!IMPORTANT]
 > Code Interpreter has [additional charges](https://azure.microsoft.com/pricing/details/cognitive-services/openai-service/) beyond the token based fees for Azure OpenAI usage. If your Assistant calls Code Interpreter simultaneously in two different threads, two code interpreter sessions are created. Each session is active by default for one hour.
 
+[!INCLUDE [Assistants v2 note](../includes/assistants-v2-note.md)]
+
 ## Code interpreter support
 
 ### Supported models
@@ -66,7 +68,7 @@ We recommend using assistants with the latest models to take advantage of the ne
 
 ### File upload API reference
 
-Assistants use the [same API for file upload as fine-tuning](/rest/api/azureopenai/files/upload?view=rest-azureopenai-2024-02-15-preview&tabs=HTTP). When uploading a file you have to specify an appropriate value for the [purpose parameter](/rest/api/azureopenai/files/upload?view=rest-azureopenai-2024-02-15-preview&tabs=HTTP#purpose).
+Assistants use the [same API for file upload as fine-tuning](/rest/api/azureopenai/files/upload?view=rest-azureopenai-2024-02-15-preview&tabs=HTTP&preserve-view=true). When uploading a file you have to specify an appropriate value for the [purpose parameter](/rest/api/azureopenai/files/upload?view=rest-azureopenai-2024-02-15-preview&tabs=HTTP&preserve-view=true#purpose).
 
 ## Enable Code Interpreter
 
@@ -256,7 +258,7 @@ curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/files/<YOUR-FILE-ID>/con
 
 ## See also
 
-* [File Upload API reference](/rest/api/azureopenai/files/upload?view=rest-azureopenai-2024-02-15-preview&tabs=HTTP)
+* [File Upload API reference](/rest/api/azureopenai/files/upload?view=rest-azureopenai-2024-02-15-preview&tabs=HTTP&preserve-view=true)
 * [Assistants API Reference](../assistants-reference.md)
 * Learn more about how to use Assistants with our [How-to guide on Assistants](../how-to/assistant.md).
 * [Azure OpenAI Assistants API samples](https://github.com/Azure-Samples/azureai-samples/tree/main/scenarios/Assistants)

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

@@ -33,8 +33,7 @@ Install the OpenAI Python client library with:
 pip install openai==v1.20.0
 ```
 
-> [!NOTE]
-> Azure OpenAI does not yet support Assistants V2. Please use the v1.20.0 release of the OpenAI Python library until V2 support is available.
+[!INCLUDE [Assistants v2 note](./assistants-v2-note.md)]
 
 > [!NOTE]
 > This library is maintained by OpenAI. Refer to the [release history](https://github.com/openai/openai-python/releases) to track the latest updates to the library.

articles/ai-services/openai/includes/assistants-v2-note.md

@@ -0,0 +1,11 @@
+---
+manager: nitinme
+author: aahill
+ms.author: aahi
+ms.service: azure-ai-openai
+ms.topic: include
+ms.date: 04/22/2024
+---
+
+> [!NOTE]
+> Azure OpenAI does not yet support Assistants V2. Please use the v1.20.0 release of the OpenAI Python library until V2 support is available.