Update Evaluation SDK README (#37527)

* Update README

* update readme

* add sample link

* updates to readme

* Update README.md

* Update README.md

* add product documentation link

Author: needuv

sdk/evaluation/azure-ai-evaluation/README.md

@@ -1,10 +1,26 @@
 # Azure AI Evaluation client library for Python
 
+We are excited to introduce the public preview of the Azure AI Evaluation SDK. 
+
+[Source code][source_code]
+| [Package (PyPI)][evaluation_pypi]
+| [API reference documentation][evaluation_ref_docs]
+| [Product documentation][product_documentation]
+| [Samples][evaluation_samples]
+
+This package has been tested with Python 3.8, 3.9, 3.10, 3.11, and 3.12.
+
+For a more complete set of Azure libraries, see https://aka.ms/azsdk/python/all
+
 ## Getting started
 
+### Prerequisites
+
+- Python 3.8 or later is required to use this package.
+
 ### Install the package
 
-Install the Azure AI Evaluation library for Python with:
+Install the Azure AI Evaluation library for Python with [pip][pip_link]::
 
 ```bash
 pip install azure-ai-evaluation
@@ -16,6 +32,8 @@ Evaluators are custom or prebuilt classes or functions that are designed to meas
 
 ## Examples
 
+### Evaluators
+
 Users can create evaluator runs on the local machine as shown in the example below:
 
 ```python
@@ -87,9 +105,13 @@ if __name__ == "__main__":
 
     pprint(result)
 ```
-## Simulator
+### Simulator
+
+
+Simulators allow users to generate synthentic data using their application. Simulator expects the user to have a callback method that invokes
+their AI application.
 
-Sample application prompty
+#### Simulating with a Prompty
 
 ```yaml
 ---
@@ -213,8 +235,7 @@ if __name__ == "__main__":
     print("done!")
 ```
 
-Simulators allow users to generate synthentic data using their application. Simulator expects the user to have a callback method that invokes
-their AI application. Here's a sample of a callback which invokes AsyncAzureOpenAI:
+#### Adversarial Simulator
 
 ```python
 from from azure.ai.evaluation.simulator import AdversarialSimulator, AdversarialScenario
@@ -282,9 +303,9 @@ async def callback(
     }
 
 ```
-## Adversarial Simulator
 
-### Adversarial QA:
+#### Adversarial QA
+
 ```python
 scenario = AdversarialScenario.ADVERSARIAL_QA
 simulator = AdversarialSimulator(azure_ai_project=azure_ai_project, credential=DefaultAzureCredential())
@@ -300,7 +321,7 @@ outputs = asyncio.run(
 
 print(outputs.to_eval_qa_json_lines())
 ```
-### Direct Attack Simulator
+#### Direct Attack Simulator
 
 ```python
 scenario = AdversarialScenario.ADVERSARIAL_QA
@@ -319,6 +340,50 @@ print(outputs)
 ```
 ## Troubleshooting
 
+### General
+
+Azure ML clients raise exceptions defined in [Azure Core][azure_core_readme].
+
+### Logging
+
+This library uses the standard
+[logging][python_logging] library for logging.
+Basic information about HTTP sessions (URLs, headers, etc.) is logged at INFO
+level.
+
+Detailed DEBUG level logging, including request/response bodies and unredacted
+headers, can be enabled on a client with the `logging_enable` argument.
+
+See full SDK logging documentation with examples [here][sdk_logging_docs].
+
 ## Next steps
 
+- View our [samples][evaluation_samples].
+- View our [documentation][product_documentation]
+
 ## Contributing
+
+This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit [cla.microsoft.com][cla].
+
+When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
+
+This project has adopted the [Microsoft Open Source Code of Conduct][code_of_conduct]. For more information see the [Code of Conduct FAQ][coc_faq] or contact [[email protected]][coc_contact] with any additional questions or comments.
+
+<!-- LINKS -->
+
+[source_code]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/evaluation/azure-ai-evaluation
+[evaluation_pypi]: https://pypi.org/project/azure-ai-evaluation/
+[evaluation_ref_docs]: https://learn.microsoft.com/python/api/azure-ai-evaluation/azure.ai.evaluation?view=azure-python-preview
+[evaluation_samples]: https://github.com/Azure-Samples/azureai-samples/tree/main/scenarios
+[product_documentation]: https://learn.microsoft.com/azure/ai-studio/how-to/develop/evaluate-sdk
+[python_logging]: https://docs.python.org/3/library/logging.html
+[sdk_logging_docs]: https://docs.microsoft.com/azure/developer/python/azure-sdk-logging
+[azure_core_readme]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/README.md
+[pip_link]: https://pypi.org/project/pip/
+[azure_core_ref_docs]: https://aka.ms/azsdk-python-core-policies
+[azure_core]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/README.md
+[azure_identity]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity
+[cla]: https://cla.microsoft.com
+[code_of_conduct]: https://opensource.microsoft.com/codeofconduct/
+[coc_faq]: https://opensource.microsoft.com/codeofconduct/faq/
+[coc_contact]: mailto:[email protected]