Azure / Azure/azure-sdk-for-python
Typo in docs related with opentelemetry-sdk installation
- Dominant language
- Python
- Stars
- 5.6k
- Forks
- 3.4k
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 193
Description
### Type of issue
Typo
### Description
In the [Trace an agent](https://learn.microsoft.com/en-us/azure/ai-services/agents/concepts/tracing#trace-an-agent) section of the AI Agent Service documentation, the following instructions are listed:
```
pip install opentelemetry
pip install azure-core-tracing-opentelemetry
```
However, 'opentelemetry' is not a valid package. I believe what is being attempted to install at this point is the 'opentelemetry-sdk' package, therefore the correct instruction would be:
```
pip install opentelemetry-sdk
```
(See [OpenTelemetry docs](https://opentelemetry.io/docs/languages/python/))
A similar error appears in section [Tracing](https://learn.microsoft.com/en-us/python/api/overview/azure/ai-projects-readme?view=azure-python-preview#installation) section of the Python SDK documentation, where the first line of the instructions is not necessary, since the correct package is installed in the second line:
```
pip install opentelemetry
pip install azure-ai-projects azure-identity opentelemetry-sdk azure-core-tracing-opentelemetry
```
I hope this explanation clearly identifies the inconsistency for your review. Thank you!
### Page URL
https://learn.microsoft.com/en-us/python/api/overview/azure/ai-projects-readme?view=azure-python-preview
### Content source URL
https://github.com/MicrosoftDocs/azure-docs-sdk-python/blob/main/docs-ref-services/preview/ai-projects-readme.md
### Document Version Independent Id
cbce1de4-1962-d40e-dc99-230e62d876f7
### Platform Id
d6057e52-faa6-3d36-81a9-6ed154db32d3
### Article author
@azure-sdk
### Metadata
* ID: cc6e78de-3a52-894f-4a3f-4298ba475c16
* PlatformId: d6057e52-faa6-3d36-81a9-6ed154db32d3
* Service: **ai**
Contributor guide
Assessment
This issue has not been assessed yet.