Merge pull request #258302 from mrbullwinkle/mrb_11_09_2023_ask_mode_request

[Azure OpenAI] ASK Mode Request [Ship during feeze]

Author: v-dirichards

articles/ai-services/openai/how-to/function-calling.md

@@ -6,7 +6,7 @@ author: mrbullwinkle #dereklegenzoff
 ms.author: mbullwin #delegenz
 ms.service: azure-ai-openai
 ms.topic: how-to
-ms.date: 11/06/2023
+ms.date: 11/09/2023
 manager: nitinme
 ---
 
@@ -103,7 +103,7 @@ from openai import AzureOpenAI
 client = AzureOpenAI(
   api_key=os.getenv("AZURE_OPENAI_KEY"),  
   api_version="2023-10-01-preview",
-  azure_endpoint = os.getenv("AZURE_OPENAI_ENDPOINT"
+  azure_endpoint = os.getenv("AZURE_OPENAI_ENDPOINT")
 )
 
 messages= [

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

@@ -7,13 +7,13 @@ ms.author: mbullwin
 ms.service: azure-ai-openai
 ms.custom: 
 ms.topic: how-to
-ms.date: 11/06/2023
+ms.date: 11/10/2023
 manager: nitinme
 ---
 
 # Migrating to the OpenAI Python API library 1.x
 
-OpenAI has just released a new version of the [OpenAI Python API library](https://github.com/openai/openai-python/). This guide is supplemental to [OpenAI's migration guide](https://github.com/openai/openai-python/discussions/631) and will help bring you up to speed on the changes specific to Azure OpenAI.
+OpenAI has just released a new version of the [OpenAI Python API library](https://github.com/openai/openai-python/). This guide is supplemental to [OpenAI's migration guide](https://github.com/openai/openai-python/discussions/742) and will help bring you up to speed on the changes specific to Azure OpenAI.
 
 ## Updates
 
@@ -30,7 +30,7 @@ OpenAI has just released a new version of the [OpenAI Python API library](https:
 
 - The latest release of the [OpenAI Python library](https://pypi.org/project/openai/) doesn't currently support DALL-E when used with Azure OpenAI. DALL-E with Azure OpenAI is still supported with `0.28.1`. For those who can't wait for native support for DALL-E and Azure OpenAI we're providing [two code examples](#dall-e-fix) which can be used as a workaround.
 - `embeddings_utils.py` which was used to provide functionality like cosine similarity for semantic text search is [no longer part of the OpenAI Python API library](https://github.com/openai/openai-python/issues/676).
-- You should also check the active [GitHub Issues](https://github.com/openai/openai-python/issues/703) for the OpenAI Python library.
+- You should also check the active [GitHub Issues](https://github.com/openai/openai-python/issues/) for the OpenAI Python library.
 
 ## Test before you migrate
 
@@ -252,6 +252,114 @@ completion = client.chat.completions.create(
 print(completion.model_dump_json(indent=2))
 ```
 
+## Use your data
+
+For the full configuration steps that are required to make these code examples work, please consult the [use your data quickstart](../use-your-data-quickstart.md).
+# [OpenAI Python 0.28.1](#tab/python)
+
+```python
+import os
+import openai
+import dotenv
+import requests
+
+dotenv.load_dotenv()
+
+openai.api_base = os.environ.get("AOAIEndpoint")
+openai.api_version = "2023-08-01-preview"
+openai.api_type = 'azure'
+openai.api_key = os.environ.get("AOAIKey")
+
+def setup_byod(deployment_id: str) -> None:
+    """Sets up the OpenAI Python SDK to use your own data for the chat endpoint.
+
+    :param deployment_id: The deployment ID for the model to use with your own data.
+
+    To remove this configuration, simply set openai.requestssession to None.
+    """
+
+    class BringYourOwnDataAdapter(requests.adapters.HTTPAdapter):
+
+     def send(self, request, **kwargs):
+         request.url = f"{openai.api_base}/openai/deployments/{deployment_id}/extensions/chat/completions?api-version={openai.api_version}"
+         return super().send(request, **kwargs)
+
+    session = requests.Session()
+
+    # Mount a custom adapter which will use the extensions endpoint for any call using the given `deployment_id`
+    session.mount(
+        prefix=f"{openai.api_base}/openai/deployments/{deployment_id}",
+        adapter=BringYourOwnDataAdapter()
+    )
+
+    openai.requestssession = session
+
+aoai_deployment_id = os.environ.get("AOAIDeploymentId")
+setup_byod(aoai_deployment_id)
+
+completion = openai.ChatCompletion.create(
+    messages=[{"role": "user", "content": "What are the differences between Azure Machine Learning and Azure AI services?"}],
+    deployment_id=os.environ.get("AOAIDeploymentId"),
+    dataSources=[  # camelCase is intentional, as this is the format the API expects
+        {
+            "type": "AzureCognitiveSearch",
+            "parameters": {
+                "endpoint": os.environ.get("SearchEndpoint"),
+                "key": os.environ.get("SearchKey"),
+                "indexName": os.environ.get("SearchIndex"),
+            }
+        }
+    ]
+)
+print(completion)
+```
+
+# [OpenAI Python 1.x](#tab/python-new)
+
+```python
+import os
+import openai
+import dotenv
+
+dotenv.load_dotenv()
+
+endpoint = os.environ.get("AOAIEndpoint")
+api_key = os.environ.get("AOAIKey")
+deployment = os.environ.get("AOAIDeploymentId")
+
+client = openai.AzureOpenAI(
+    base_url=f"{endpoint}/openai/deployments/{deployment}/extensions",
+    api_key=api_key,
+    api_version="2023-08-01-preview",
+)
+
+completion = client.chat.completions.create(
+    model=deployment,
+    messages=[
+        {
+            "role": "user",
+            "content": "How is Azure machine learning different than Azure OpenAI?",
+        },
+    ],
+    extra_body={
+        "dataSources": [
+            {
+                "type": "AzureCognitiveSearch",
+                "parameters": {
+                    "endpoint": os.environ["SearchEndpoint"],
+                    "key": os.environ["SearchKey"],
+                    "indexName": os.environ["SearchIndex"]
+                }
+            }
+        ]
+    }
+)
+
+print(completion.model_dump_json(indent=2))
+```
+
+---
+
 ## DALL-E fix
 
 # [DALLE-Fix](#tab/dalle-fix)
@@ -417,6 +525,7 @@ asyncio.run(dall_e())
 ```
 
 ---
+
 ## Name changes
 
 > [!NOTE]

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

@@ -1,11 +1,11 @@
 ---
 services: cognitive-services
 manager: nitinme
-author: travisw
-ms.author: travisw
+author: mrbullwinkle #travisw
+ms.author: mbullwin #travisw
 ms.service: azure-ai-openai
 ms.topic: include
-ms.date: 08/29/2023
+ms.date: 11/09/2023
 ---
 
 [!INCLUDE [Set up required variables](./use-your-data-common-variables.md)]
@@ -14,22 +14,35 @@ ms.date: 08/29/2023
 
 1. Create a new folder named *openai-python* for your project and a new Python code file named *main.py*. Change into that directory:
 
-   ```cmd
-   mkdir openai-python
-   cd openai-python
-   ```
+```cmd
+mkdir openai-python
+cd openai-python
+```
 
-1. Install the following Python Libraries:
+2. Install the following Python Libraries:
 
-   ```cmd
-   pip install openai==0.28.1
-   pip install python-dotenv
-   ```
+# [OpenAI Python 0.28.1](#tab/python)
+
+```console
+pip install openai==0.28.1
+pip install python-dotenv
+```
 
+# [OpenAI Python 1.x](#tab/python-new)
+
+```console
+pip install openai
+pip install python-dotenv
+```
+
+---
+  
 ## Create the Python app
 
 1. From the project directory, open the *main.py* file and add the following code:
 
+# [OpenAI Python 0.28.1](#tab/python)
+
    ```python
    import os
    import openai
@@ -89,16 +102,62 @@ ms.date: 08/29/2023
    print(completion)
    ```
 
-   > [!IMPORTANT]
-   > For production, use a secure way of storing and accessing your credentials like [Azure Key Vault](../../../key-vault/general/overview.md). For more information about credential security, see the Azure AI services [security](../../security-features.md) article.
+# [OpenAI Python 1.x](#tab/python-new)
+
+```python
+import os
+import openai
+import dotenv
+
+dotenv.load_dotenv()
+
+endpoint = os.environ.get("AOAIEndpoint")
+api_key = os.environ.get("AOAIKey")
+deployment = os.environ.get("AOAIDeploymentId")
+
+client = openai.AzureOpenAI(
+    base_url=f"{endpoint}/openai/deployments/{deployment}/extensions",
+    api_key=api_key,
+    api_version="2023-08-01-preview",
+)
+
+completion = client.chat.completions.create(
+    model=deployment,
+    messages=[
+        {
+            "role": "user",
+            "content": "How is Azure machine learning different than Azure OpenAI?",
+        },
+    ],
+    extra_body={
+        "dataSources": [
+            {
+                "type": "AzureCognitiveSearch",
+                "parameters": {
+                    "endpoint": os.environ["SearchEndpoint"],
+                    "key": os.environ["SearchKey"],
+                    "indexName": os.environ["SearchIndex"]
+                }
+            }
+        ]
+    }
+)
+
+print(completion.model_dump_json(indent=2))
+```
 
-1. Execute the following command:
+---
 
-   ```cmd
-   python main.py
-   ```
+> [!IMPORTANT]
+> For production, use a secure way of storing and accessing your credentials like [Azure Key Vault](../../../key-vault/general/overview.md). For more information about credential security, see the Azure AI services [security](../../security-features.md) article.
+
+2. Execute the following command:
+
+```cmd
+python main.py
+```
 
-   The application prints the response in a JSON format suitable for use in many scenarios. It includes both answers to your query and citations from your uploaded files.
+The application prints the response in a JSON format suitable for use in many scenarios. It includes both answers to your query and citations from your uploaded files.
 
 > [!div class="nextstepaction"]
 > [I ran into an issue when running the code samples.](https://microsoft.qualtrics.com/jfe/form/SV_0Cl5zkG3CnDjq6O?PLanguage=dotnet&Pillar=AOAI&Product=ownData&Page=quickstart&Section=Create-dotnet-application)

articles/ai-services/openai/toc.yml

@@ -80,6 +80,8 @@ items:
     items:
       - name: Fine-tuning your model
         href: ./how-to/fine-tuning.md
+  - name: Migrate to OpenAI Python v1.x
+    href: ./how-to/migration.md
   - name: Models
     items:
       - name: Manage models
@@ -100,8 +102,6 @@ items:
         href: ./how-to/switching-endpoints.md
       - name: Manage quota
         href: ./how-to/quota.md
-      - name: Migrate to OpenAI Python v1.x
-        href: ./how-to/migration.md
       - name: Monitor Azure OpenAI
         href: ./how-to/monitoring.md
       - name: Plan and manage costs
@@ -148,7 +148,7 @@ items:
     - name: REST API (completions & embeddings)
       href: reference.md
     - name: REST API (fine-tuning)
-      href: /rest/api/azureopenai/fine-tuning?view=rest-azureopenai-2023-10-01-preview
+      href: /rest/api/azureopenai/fine-tuning?view=rest-azureopenai-2023-10-01-preview&preserve-view=true 
     - name: REST API (resource creation & deployment)
       href: /rest/api/cognitiveservices/accountmanagement/deployments/create-or-update?tabs=HTTP
 - name: Resources