Merge pull request #225824 from aahill/studio-format

Text format update for conversational features

Author: American-Dipper

articles/cognitive-services/language-service/language-studio.md

@@ -57,6 +57,31 @@ When you're ready to use Language Studio features on your own text data, you wil
 
 4. Select **Done**. Your resource will be created, and you will be able to use the different features offered by the Language service with your own text.
 
+
+### Valid text formats for conversation features
+
+> [!NOTE]
+> This section applies to the following features:
+> * [PII detection for conversation](./personally-identifiable-information/overview.md)
+> * [Conversation summarization](./summarization/overview.md?tabs=conversation-summarization)
+
+If you're sending conversational text to supported features in Language Studio, be aware of the following input requirements: 
+* The text you send must be a conversational dialog between two or more participants.
+* Each line must start with the name of the participant, followed by a `:`, and followed by what they say.
+* Each participant must be on a new line. If multiple participants' utterances are on the same line, it will be processed as one line of the conversation.
+
+See the following example for how you should structure conversational text you want to send.
+
+*Agent: Hello, you're chatting with Rene. How may I help you?*
+
+*Customer: Hi, I tried to set up wifi connection for Smart Brew 300 espresso machine, but it didn't work.*
+
+*Agent: I’m sorry to hear that. Let’s see what we can do to fix this issue.*
+
+Note that the names of the two participants in the conversation (*Agent* and *Customer*) begin each line, and that there is only one participant per line of dialog. 
+
+:::image type="content" source="./media/language-studio-conversation-example.png" alt-text="A screenshot showing an example conversation input in Language Studio." lightbox="./media/language-studio-conversation-example.png":::
+
 ## Clean up resources
 
 If you want to clean up and remove a Cognitive Services subscription, you can delete the resource or resource group. Deleting the resource group also deletes any other resources associated with it.

articles/cognitive-services/language-service/media/language-studio-conversation-example.png

@@ -8,7 +8,7 @@ manager: nitinme
 ms.service: cognitive-services
 ms.subservice: language-service
 ms.topic: how-to
-ms.date: 05/10/2022
+ms.date: 01/31/2023
 ms.author: jboback
 ms.reviewer: bidishac
 ---
@@ -35,6 +35,9 @@ Currently the conversational PII preview API supports all Azure regions supporte
 
 ## Submitting data
 
+> [!NOTE]
+> See the [Language Studio](../language-studio.md#valid-text-formats-for-conversation-features) article for information on formatting conversational text to submit using Language Studio. 
+
 You can submit the input to the API as list of conversation items. Analysis is performed upon receipt of the request. Because the API is asynchronous, there may be a delay between sending an API request, and receiving the results. For information on the size and number of requests you can send per minute and second, see the data limits below.
 
 When using the async feature, the API results are available for 24 hours from the time the request was ingested, and is indicated in the response. After this time period, the results are purged and are no longer available for retrieval.
@@ -59,7 +62,7 @@ When you get results from PII detection, you can stream the results to an applic
 
 1. Go to your resource overview page in the [Azure portal](https://portal.azure.com/#home)
 
-2. From the menu on the left side, select **Keys and Endpoint**. You will need one of the keys and the endpoint to authenticate your API requests.
+2. From the menu on the left side, select **Keys and Endpoint**. You'll need one of the keys and the endpoint to authenticate your API requests.
 
 3. Download and install the client library package for your language of choice:
 

articles/cognitive-services/language-service/personally-identifiable-information/how-to-call-for-conversations.md

@@ -8,7 +8,7 @@ manager: nitinme
 ms.service: cognitive-services
 ms.subservice: language-service
 ms.topic: how-to
-ms.date: 09/26/2022
+ms.date: 01/31/2023
 ms.author: jboback
 ms.custom: language-service-summarization, ignite-fall-2021, event-tier1-build-2022, ignite-2022
 ---
@@ -40,6 +40,9 @@ There's another feature in Azure Cognitive Service for Language named [document
 
 ## Submitting data
 
+> [!NOTE]
+> See the [Language Studio](../../language-studio.md#valid-text-formats-for-conversation-features) article for information on formatting conversational text to submit using Language Studio. 
+
 You submit documents to the API as strings of text. Analysis is performed upon receipt of the request. Because the API is [asynchronous](../../concepts/use-asynchronously.md), there may be a delay between sending an API request and receiving the results.  For information on the size and number of requests you can send per minute and second, see the data limits below.
 
 When you use this feature, the API results are available for 24 hours from the time the request was ingested, and is indicated in the response. After this time period, the results are purged and are no longer available for retrieval.